Merge lp:~robru/libfriends/exceptions into lp:libfriends

[Robert Bruce Park]

Make libfriends throw exceptions, so we can catch and test for them in the testsuite.

Ok Ken, I massaged this to get rid of as many compiler warnings as I could.

[Ken VanDine (ken-vandine)]

My previous branch was missing descriptions in the docstrings for all the throws I added. I've fixed that in lp:~ken-vandine/friends/exceptions

Please merge that into your branch.

[lp:~robru/libfriends/exceptions]

54. By Robert Bruce Park on 2013-01-14

Add descriptions for @throws documentation.

[Ken VanDine (ken-vandine)]

thanks!

review: Approve

=== modified file 'examples/example-vala.vala'
--- examples/example-vala.vala	2013-01-09 19:30:53 +0000
+++ examples/example-vala.vala	2013-01-14 19:51:21 +0000
@@ -29,7 +29,12 @@
 
   public Example (MainLoop loop)
   {
-    service = new Friends.Service();
+      try {
+          service = new Friends.Service();
+      } catch (GLib.IOError e) {
+          warning (e.message);
+          service = null;
+      }
   }
 
   public void run_example (string[] args)
@@ -41,7 +46,11 @@
     switch (args[1]) {
         case "--refresh":
             stdout.printf("Refreshing friends\n");
-            service.refresh();
+            try {
+                service.refresh();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+            }
             return;
         case "--features":
             if (args.length < 3) {
@@ -49,13 +58,21 @@
                 return;
             }
             stdout.printf("Getting features for %s\n", args[2]);
-            var features = service.features(args[2]);
-            foreach(string feature in features)
-                stdout.printf("%s\n", feature);
+            try {
+                var features = service.features(args[2]);
+                foreach(string feature in features)
+                    stdout.printf("%s\n", feature);
+            } catch (GLib.IOError e) {
+                warning (e.message);
+            }
             return;
         case "--shutdown":
             stdout.printf("Shutting down the friends service\n");
-            service.quit();
+            try {
+                service.quit();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+            }
             return;
 
         case "--like":
@@ -69,7 +86,11 @@
                         uint acct = int.parse(args[i+1]);
                         string id = args[i+2];
                         stdout.printf("Liked...\n");
-                        service.like(acct, id);
+                        try {
+                            service.like(acct, id);
+                        } catch (GLib.IOError e) {
+                            warning (e.message);
+                        }
                     } else {
                         PrintUsage ();
                     }
@@ -82,7 +103,11 @@
                         uint acct = int.parse(args[i+1]);
                         string id = args[i+2];
                         stdout.printf("Unliked...\n");
-                        service.unlike(acct, id);
+                        try {
+                            service.unlike(acct, id);
+                        } catch (GLib.IOError e) {
+                            warning (e.message);
+                        }
                     } else {
                         PrintUsage ();
                     }
@@ -95,7 +120,11 @@
                         uint acct = int.parse(args[i+1]);
                         string id = args[i+2];
                         stdout.printf("Retweet...\n");
-                        service.retweet(acct, id);
+                        try {
+                            service.retweet(acct, id);
+                        } catch (GLib.IOError e) {
+                            warning (e.message);
+                        }
                     } else {
                         PrintUsage ();
                     }
@@ -132,7 +161,11 @@
                         string message = args[i+2];
                         stdout.printf("Posting...\n");
                         stdout.printf ("message: %s\n account: %u\n", message, acct);
-                        service.send_message(acct, message);
+                        try {
+                            service.send_message(acct, message);
+                        } catch (GLib.IOError e) {
+                            warning (e.message);
+                        }
                     } else {
                         PrintUsage ();
                     }
@@ -151,7 +184,11 @@
                         string message_id = args[i+2];
                         string message = args[i+3];
                         stdout.printf("Replying...\n");
-                        service.send_reply(acct, message_id, message);
+                        try {
+                            service.send_reply(acct, message_id, message);
+                        } catch (GLib.IOError e) {
+                            warning (e.message);
+                        }
                     } else {
                         PrintUsage ();
                     }
 
=== modified file 'gtk/account.vala'
--- gtk/account.vala	2013-01-11 17:25:44 +0000
+++ gtk/account.vala	2013-01-14 19:51:21 +0000
@@ -82,8 +82,15 @@
             }
             set {
               GLib.Value t = value;
-              _account.set_value("friends/color", t);
-              _account.store_blocking();
+              try
+              {
+                  _account.set_value("friends/color", t);
+                  _account.store_blocking();
+              }
+              catch (Ag.AccountsError e)
+              {
+                  warning (e.message);
+              }
             }
         }
 
@@ -117,8 +124,15 @@
               GLib.Value t = false;
               if (value == "1")
                 t = true;
-              _account.set_value("friends/send_enabled", t);
-              _account.store_blocking();
+              try
+              {
+                  _account.set_value("friends/send_enabled", t);
+                  _account.store_blocking();
+              }
+              catch (Ag.AccountsError e)
+              {
+                  warning (e.message);
+              }
             }
         }
 
 
=== modified file 'gtk/entry.vala'
--- gtk/entry.vala	2013-01-11 17:25:44 +0000
+++ gtk/entry.vala	2013-01-14 19:51:21 +0000
@@ -48,7 +48,12 @@
         construct
         {
             set_orientation (Gtk.Orientation.VERTICAL);
-            service = new Friends.Service ();
+            try {
+                service = new Friends.Service ();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+                return;
+            }
 
             text_view = new InputTextView (service);
             target_bar = new AccountTargetBar ();
@@ -97,7 +102,12 @@
 
         construct
         {
-            service = new Friends.Service ();
+            try {
+                service = new Friends.Service ();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+                return;
+            }
 
             text_view = new InputTextView (service);
             send_bar = new SendBar ();
@@ -124,14 +134,14 @@
         private Friends.Service service;
 
         /**
-         * The {@link Gdk.Color} for the foreground
+         * The {@link Gdk.RGBA} for the foreground
          */
-        public Gdk.Color fg_color;
+        public Gdk.RGBA fg_color;
 
         /**
-         * The {@link Gdk.Color} for the error state
+         * The {@link Gdk.RGBA} for the error state
          */
-        public Gdk.Color error_color;
+        public Gdk.RGBA error_color;
 
         bool last_was_shortened = false;
         private string _mid = null;
@@ -152,16 +162,25 @@
 
         construct
         {
-            service = new Friends.Service ();
+            try {
+                service = new Friends.Service ();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+                return;
+            }
 
             unowned Gtk.BindingSet binding_set;
             binding_set = Gtk.BindingSet.by_class (typeof (InputTextView).class_ref ());
             Gtk.BindingEntry.add_signal (binding_set, Gdk.keyval_from_name ("Return"), 0, "submit", 0);
             Gtk.BindingEntry.add_signal (binding_set, Gdk.keyval_from_name ("KP_Enter"), 0, "submit", 0);
             Gtk.BindingEntry.add_signal (binding_set, Gdk.keyval_from_name ("Escape"), 0, "clear", 0);
-            fg_color = get_style ().text[Gtk.StateType.NORMAL];
-
-            Gdk.Color.parse ("indianred", out error_color);
+
+            // FIXME: How do we tell this StyleContext to get the color from the right place?
+            Gtk.StyleContext context = new Gtk.StyleContext ();
+            fg_color = context.get_color (Gtk.StateFlags.NORMAL);
+
+            error_color = Gdk.RGBA ();
+            error_color.parse("indianred");
 
             get_buffer ().changed.connect (on_text_changed);
             get_buffer ().insert_text.connect (on_text_inserted);
@@ -232,8 +251,12 @@
               service.send_message(msg, null, null, null);
             }
             */
-            service.send_message(null, msg);
-            debug ("(submit) Message: %s posted", msg);
+            try {
+                service.send_message(null, msg);
+                debug ("(submit) Message: %s posted", msg);
+            } catch (GLib.IOError e) {
+                warning (e.message);
+            }
             reset();
         }
 
@@ -245,8 +268,10 @@
         private void on_text_changed ()
         {
             var chars = get_buffer ().get_char_count ();
-            modify_fg (Gtk.StateType.NORMAL,
-                        chars > MAX_MESSAGE_LENGTH ? error_color : fg_color);
+            override_color (
+                Gtk.StateFlags.NORMAL,
+                chars > MAX_MESSAGE_LENGTH ? error_color : fg_color
+                );
         }
 
         private void on_text_inserted (ref Gtk.TextIter iter, string text, int len)
@@ -258,9 +283,14 @@
             {
                 var buf = get_buffer ();
                 Signal.stop_emission_by_name (buf, "insert-text") ;
-                var shrt = service.shorten (text);
-                last_was_shortened = true;
-                buf.insert (ref iter, shrt, -1);
+                try {
+                    var shrt = service.shorten (text);
+                    last_was_shortened = true;
+                    buf.insert (ref iter, shrt, -1);
+                } catch (GLib.IOError e) {
+                    warning (e.message);
+                    return;
+                }
             }
             else
             {
@@ -300,9 +330,9 @@
             {
                 context.translate(-1, -1);
                 factor = 1.0;
-            } else if (get_state () == 2) {
+            } else if (get_state_flags () == Gtk.StateFlags.PRELIGHT) {
                 factor = 0.3;
-            } else if (get_state () == 1) {
+            } else if (get_state_flags () == Gtk.StateFlags.ACTIVE) {
                 factor = 0.5;
             }
 
@@ -354,10 +384,10 @@
         {
             Object (spacing:0);
         }
- 
+
         /*
          * The {@Ag.Account.id} of the account button to be displayed
-         * This is used in the case of replies or private messages 
+         * This is used in the case of replies or private messages
          * where the post will only go to a single account
          */
         public uint? selected {
@@ -402,7 +432,12 @@
             if (GLib.FileUtils.test (local_icon_path, GLib.FileTest.IS_DIR))
               icon_theme.prepend_search_path (local_icon_path);
 
-            service = new Friends.Service();
+            try {
+                service = new Friends.Service ();
+            } catch (GLib.IOError e) {
+                warning (e.message);
+                return;
+            }
             accounts_service = new FriendsAccounts();
 
             // Add buttons to button area at the bottom
@@ -490,7 +525,7 @@
             return account_button;
         }
 
-        /* 
+        /*
          * Set the number of remaining characters allowed to post
          * @param chars Number of characters remaining
          */
 
=== modified file 'src/service.vala'
--- src/service.vala	2013-01-11 18:53:44 +0000
+++ src/service.vala	2013-01-14 19:51:21 +0000
@@ -51,8 +51,10 @@
         /**
          * Establish a connection to the local Friends Service daemon.
          * @return a new Service
+         * @throws GLib.IOError if failed to connect to the
+         * Friends Service daemon.
          */
-        public Service ()
+        public Service () throws IOError
         {
             Object ();
             try
@@ -65,7 +67,8 @@
             }
             catch (GLib.IOError e)
             {
-                warning ("Unable to get Gwibber service: "+e.message);
+                warning ("Unable to get Friends service: "+e.message);
+                throw (e);
             }
         }
 
@@ -82,16 +85,17 @@
          * parameter and is rather arbitrary.
          *
          * @since 0.1
+         * @throws GLib.IOError if action failed.
          */
-        private bool do(string action, string account_id, string argument)
+        private bool do(string action, string account_id, string argument) throws IOError
         {
             try {
                 service.Do(action, account_id, argument);
                 return true;
-            } catch (GLib.Error e) {
+            } catch (GLib.IOError e) {
                 warning (e.message);
+                throw (e);
             }
-            return false;
         }
 
         /**
@@ -101,28 +105,22 @@
          * to exit, preventing any other clients from accessing it.
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Quit fails.
          */
-        public void quit()
+        public void quit() throws IOError
         {
-            try {
-                service.Quit();
-            } catch (GLib.IOError e) {
-                warning (e.message);
-            }
+            service.Quit();
         }
 
         /**
          * Perform a refresh of all enabled accounts.
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Refresh fails.
          */
-        public void refresh()
+        public void refresh() throws IOError
         {
-            try {
-                service.Refresh();
-            } catch (GLib.IOError e) {
-                warning (e.message);
-            }
+            service.Refresh();
         }
 
         /**
@@ -137,8 +135,9 @@
          * uploaded photo.
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Upload fails.
          */
-        public void upload(uint account_id, string uri, string description)
+        public void upload(uint account_id, string uri, string description) throws IOError
         {
             string result_url = null;
             service.Upload.begin(account_id.to_string(), uri, description, (obj, res) => {
@@ -146,6 +145,7 @@
                     service.Upload.end(res, out result_url);
                 } catch (IOError e) {
                     warning (e.message);
+                    throw (e);
                 }
             });
         }
@@ -161,16 +161,11 @@
          * uploaded file.
          *
          * @since 0.1
-         * @throws GLib.IOError if uploading the image failed.
+         * @throws GLib.IOError if the call to Friends.Service.Upload fails.
          */
         public async void upload_async(uint account_id, string uri, string description, out string result_url) throws IOError
         {
-            try {
-                yield service.Upload(account_id.to_string(), uri, description, out result_url);
-            } catch (IOError e) {
-                warning (e.message);
-                throw (e);
-            }
+            yield service.Upload(account_id.to_string(), uri, description, out result_url);
         }
 
 
@@ -189,16 +184,17 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.SendReply fails.
          */
-        public bool send_reply(uint account_id, string message_id, string message)
+        public bool send_reply(uint account_id, string message_id, string message) throws IOError
         {
             try {
                 service.SendReply(message, account_id.to_string(), message_id);
                 return true;
-            } catch (GLib.Error e) {
+            } catch (GLib.IOError e) {
                 warning (e.message);
+                throw (e);
             }
-            return false;
         }
 
 
@@ -210,19 +206,15 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.SendMessage fails.
          */
-        public bool send_message(uint? account_id, string message)
+        public bool send_message(uint? account_id, string message) throws IOError
         {
-            try {
-                if (account_id != null)
-                    return do("send", account_id.to_string(), message);
-                else
-                    service.SendMessage(message);
-                return true;
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            if (account_id != null)
+                return do("send", account_id.to_string(), message);
+            else
+                service.SendMessage(message);
+            return true;
         }
 
         /**
@@ -233,15 +225,11 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool retweet(uint account_id, string message_id)
+        public bool retweet(uint account_id, string message_id) throws IOError
         {
-            try {
-                return do("retweet", account_id.to_string(), message_id);
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            return do("retweet", account_id.to_string(), message_id);
         }
 
         /**
@@ -254,15 +242,11 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool home(uint account_id)
+        public bool home(uint account_id) throws IOError
         {
-            try {
-                return do("home", account_id.to_string(), "");
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            return do("home", account_id.to_string(), "");
         }
 
         /**
@@ -276,15 +260,11 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool wall(uint account_id)
+        public bool wall(uint account_id) throws IOError
         {
-            try {
-                return do("wall", account_id.to_string(), "");
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            return do("wall", account_id.to_string(), "");
         }
 
         /**
@@ -296,18 +276,14 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool search(uint? account_id, string query)
+        public bool search(uint? account_id, string query) throws IOError
         {
-            try {
-                if (account_id != null)
-                    return do("search", account_id.to_string(), query);
-                else
-                    return do("search", "", query);
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            if (account_id != null)
+                return do("search", account_id.to_string(), query);
+            else
+                return do("search", "", query);
         }
 
         /**
@@ -319,15 +295,11 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool like(uint account_id, string message_id)
+        public bool like(uint account_id, string message_id) throws IOError
         {
-            try {
-                return do("like", account_id.to_string(), message_id);
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            return do("like", account_id.to_string(), message_id);
         }
 
         /**
@@ -339,15 +311,11 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool unlike(uint account_id, string message_id)
+        public bool unlike(uint account_id, string message_id) throws IOError
         {
-            try {
-                return do("unlike", account_id.to_string(), message_id);
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            return do("unlike", account_id.to_string(), message_id);
         }
 
         /**
@@ -359,15 +327,11 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool delete(uint account_id, string message_id)
+        public bool delete(uint account_id, string message_id) throws IOError
         {
-            try {
-                return do("delete", account_id.to_string(), message_id);
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            return do("delete", account_id.to_string(), message_id);
         }
 
         /**
@@ -378,15 +342,11 @@
          * @return ``true`` for success, ``false`` otherwise
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.Do fails.
          */
-        public bool contacts(uint account_id)
+        public bool contacts(uint account_id) throws IOError
         {
-            try {
-                return do("contacts", account_id.to_string(), "");
-            } catch (GLib.Error e) {
-                warning (e.message);
-            }
-            return false;
+            return do("contacts", account_id.to_string(), "");
         }
 
         /**
@@ -396,25 +356,18 @@
          * @return The shortened URL.
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.URLShorten fails.
          */
-        public string shorten(string url)
+        public string shorten(string url) throws IOError
         {
-            try
-            {
-                return service.URLShorten(url);
-            }
-            catch (GLib.IOError e)
-            {
-                warning (e.message);
-                return url;
-            }
+            return service.URLShorten(url);
         }
 
         /**
          * This method returns a list of all the possible actions
          * supported by a given protocol. This can be used to
-         * determine what actions are available for the requested 
-         * protocol.  
+         * determine what actions are available for the requested
+         * protocol.
          *
          * @param protocol One of ``facebook``, ``flickr``,
          * ``foursquare``, ``identica``, or ``twitter``.
@@ -422,19 +375,16 @@
          * features) if there are no features found for ``protocol``.
          *
          * @since 0.1
+         * @throws GLib.Error if the call to Friends.Service.GetFeatures fails.
          */
-        public string[] features(string protocol)
+        public string[] features(string protocol) throws Error
         {
             string[] _features = null;
-            try {
                 var parser = new Json.Parser();
                 parser.load_from_data(service.GetFeatures(protocol), -1);
                 var nodes = parser.get_root().get_array().get_elements();
                 foreach(var node in nodes)
                    _features += node.dup_string ();
-            } catch(GLib.Error e) {
-                warning(e.message);
-            }
             return _features;
         }
 
@@ -442,14 +392,12 @@
          * Clear all notifications from the messaging menu.
          *
          * @since 0.1
+         * @throws GLib.IOError if the call to Friends.Service.ClearIndicators
+         * fails.
          */
-        public void messaging_menu_clear()
+        public void messaging_menu_clear() throws IOError
         {
-             try {
-                 service.ClearIndicators();
-             } catch (GLib.IOError e) {
-                 warning (e.message);
-             }
+             service.ClearIndicators();
         }
 
         private void connection_offline()
 
=== modified file 'src/utils.vala'
--- src/utils.vala	2013-01-09 18:50:08 +0000
+++ src/utils.vala	2013-01-14 19:51:21 +0000
@@ -54,7 +54,6 @@
         {
             string _avatar_cache_image = Path.build_path (Path.DIR_SEPARATOR_S, Environment.get_user_cache_dir(), "friends/avatars", GLib.Checksum.compute_for_string (GLib.ChecksumType.SHA1, url));
             debug ("AVATAR PATH: %s", _avatar_cache_image);
-            var file = File.new_for_path (_avatar_cache_image);
             return _avatar_cache_image;
         }
     }
 
=== modified file 'tests/vala/test-service.vala'
--- tests/vala/test-service.vala	2013-01-09 19:41:41 +0000
+++ tests/vala/test-service.vala	2013-01-14 19:51:21 +0000
@@ -61,9 +61,20 @@
                                      ServiceSuite.test_url_shorten);
         }
 
+        static Friends.Service? get_service ()
+        {
+            Friends.Service service = null;
+            try {
+                service = new Friends.Service ();
+            } catch (GLib.IOError e) {
+                warning(e.message);
+            }
+            return service;
+        }
+
         internal static void test_refresh ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             bool success = false;
             try
             {
@@ -80,7 +91,7 @@
 
         internal static void test_quit ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             bool success = false;
             try
             {
@@ -97,22 +108,23 @@
 
         internal static void test_features ()
         {
-            var service = new Friends.Service ();
-            string[] features;
+            var service = get_service ();
+            string[] features = null;
             try
             {
                 features = service.features ("twitter");
             }
-            catch (GLib.IOError e)
+            catch (GLib.Error e)
             {
                 warning ("Failed to get features - %s", e.message);
             }
+            assert (features != null);
             assert ("send" in features);
         }
 
         internal static void test_upload ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             uint acct = 1;
             string uri = "file:///tmp/foo.png";
             string desc = "Something interesting to say";
@@ -129,7 +141,7 @@
 
         internal static void test_send_message ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             uint? acct = null;
             string msg = "A message";
             bool success = false;
@@ -147,7 +159,7 @@
 
         internal static void test_send_message_with_account ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             uint acct = 1;
             string msg = "A message";
             bool success = false;
@@ -165,7 +177,7 @@
 
         internal static void test_send_reply ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             uint acct = 1;
             string msg = "A message";
             string msg_id = "100";
@@ -184,7 +196,7 @@
 
         internal static void test_clear_indicators ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             bool success = false;
             try
             {
@@ -200,7 +212,7 @@
 
         internal static void test_url_shorten ()
         {
-            var service = new Friends.Service ();
+            var service = get_service ();
             string result = "";
             try
             {