Merge lp:~robru/friends/menus into lp:friends

[Robert Bruce Park]

Connect the menu management code into the dispatcher.

[Ken VanDine (ken-vandine)]

I made a few tweaks and merged, thanks!

review: Approve

=== modified file 'friends/main.py'
--- friends/main.py	2012-11-04 19:30:57 +0000
+++ friends/main.py	2012-11-04 20:53:18 +0000
@@ -38,7 +38,6 @@
 from friends.utils.avatar import Avatar
 from friends.utils.base import initialize_caches
 from friends.utils.logging import initialize
-from friends.utils.menus import MenuManager
 from friends.utils.model import prune_model
 from friends.utils.options import Options
 
@@ -110,7 +109,6 @@
     class services:
         connection = ConnectionMonitor()
         dispatcher = Dispatcher(loop, refresh_interval)
-        menus = MenuManager(dispatcher.Refresh, loop.quit)
         shorten = URLShorten(gsettings)
 
     if args.test:

=== modified file 'friends/service/dispatcher.py'
--- friends/service/dispatcher.py	2012-11-04 19:19:42 +0000
+++ friends/service/dispatcher.py	2012-11-04 20:53:18 +0000
@@ -32,7 +32,8 @@
 from friends.utils.account import AccountManager
 from friends.utils.manager import protocol_manager
 from friends.utils.signaler import signaler
-from friends.utils.model import persist_model
+from friends.utils.menus import MenuManager
+from friends.utils.model import persist_model, Model
 
 log = logging.getLogger(__name__)
 
@@ -50,6 +51,11 @@
         self.mainloop = mainloop
         self._interval = interval
         self.account_manager = AccountManager()
+
+        self._unread_count = 0
+        self.menu_manager = MenuManager(self.Refresh, self.mainloop.quit)
+        Model.connect('row-added', self._increment_unread_count)
+
         self._timer_id = None
         signaler.add_signal('ConnectionOnline', self._on_connection_online)
         signaler.add_signal('ConnectionOffline', self._on_connection_offline)
@@ -73,8 +79,14 @@
     def online(self):
         return self._timer_id is not None
 
+    def _increment_unread_count(self, model, itr):
+        self._unread_count += 1
+        self.menu_manager.update_unread_count(self._unread_count)
+
     @dbus.service.method(DBUS_INTERFACE)
     def Refresh(self):
+        self._unread_count = 0
+
         log.debug('Refresh requested')
         # Wait for all previous actions to complete before
         # starting a load of new ones.
@@ -106,18 +118,18 @@
         # Always return True, or else GLib mainloop will stop invoking it.
         return True
 
-    @dbus.service.method(DBUS_INTERFACE, in_signature='s')
-    def UpdateIndicators(self, stream):
-        """Update counts in messaging indicators.
+    @dbus.service.method(DBUS_INTERFACE)
+    def ClearIndicators(self):
+        """Indicate that messages have been read.
 
         example:
             import dbus
             obj = dbus.SessionBus().get_object(DBUS_INTERFACE,
                 '/com/canonical/Friends/Service')
             service = dbus.Interface(obj, DBUS_INTERFACE)
-            service.UpdateIndicators('stream')
+            service.ClearIndicators()
         """
-        pass #TODO
+        self.menu_manager.update_unread_count(0)
 
     @dbus.service.method(DBUS_INTERFACE, in_signature='sss')
     def Do(self, action, account_id='', arg=''):

=== modified file 'friends/tests/test_dispatcher.py'
--- friends/tests/test_dispatcher.py	2012-11-04 19:19:42 +0000
+++ friends/tests/test_dispatcher.py	2012-11-04 20:53:18 +0000
@@ -85,9 +85,10 @@
 
         self.assertEqual(self.log_mock.empty(), 'Refresh requested\n')
 
-    def test_update_indicators(self):
-        # TODO
-        self.assertIsNone(self.dispatcher.UpdateIndicators('stream'))
+    def test_clear_indicators(self):
+        self.dispatcher.menu_manager = mock.Mock()
+        self.dispatcher.ClearIndicators()
+        self.dispatcher.menu_manager.update_unread_count.assert_called_once_with(0)
 
     def test_do(self):
         account = mock.Mock()

=== modified file 'friends/tests/test_menu.py'
--- friends/tests/test_menu.py	2012-10-27 00:14:40 +0000
+++ friends/tests/test_menu.py	2012-11-04 20:53:18 +0000
@@ -35,20 +35,18 @@
 
     def setUp(self):
         self.menu = MenuManager(callback_stub, callback_stub)
-        self.menu.launcher = mock.Mock()
+        self.menu.messaging = mock.Mock()
 
     def test_unread_count_visible(self):
         # Calling update_unread_count() with a non-zero value will make the
         # count visible.
-        expected = [mock.call('count', 42), mock.call('count_visible', True)]
         self.menu.update_unread_count(42)
-        self.assertEqual(self.menu.launcher.set_property.call_args_list,
-                         expected)
+        self.menu.messaging.set_source_count.assert_called_once_with(
+            'unread', 42)
 
     def test_unread_count_invisible(self):
         # Calling update_unread_count() with a zero value will make the count
         # invisible.
-        expected = [mock.call('count', 0), mock.call('count_visible', False)]
         self.menu.update_unread_count(0)
-        self.assertEqual(self.menu.launcher.set_property.call_args_list,
-                         expected)
+        self.menu.messaging.set_source_count.assert_called_once_with(
+            'unread', 0)

=== modified file 'friends/utils/menus.py'
--- friends/utils/menus.py	2012-11-04 19:19:42 +0000
+++ friends/utils/menus.py	2012-11-04 20:53:18 +0000
@@ -19,13 +19,7 @@
 import subprocess
 
 from gettext import gettext as _
-
-Unity = None
-Dbusmenu = None
-try:
-    from gi.repository import Unity, Dbusmenu
-except ImportError:
-    pass
+from gi.repository import Gio
 
 
 MessagingMenu = None
@@ -35,7 +29,6 @@
     pass
 
 
-DESKTOP_ID = 'friends.desktop'
 log = logging.getLogger(__name__)
 
 
@@ -63,9 +56,8 @@
 
 
 class MenuManager:
-    """Manage the Unity and indicator menus over dbus."""
+    """Manage the indicator menus over dbus."""
     messaging = None
-    launcher = None
 
     def __init__(self, refresh_callback, shutdown_callback):
         self._refresh = refresh_callback
@@ -73,88 +65,19 @@
         # Only do the menu initializations if they are available.
         if MessagingMenu:
             self.init_messaging_menu()
-        if Unity and Dbusmenu:
-            self.init_dbus_menu()
 
     def init_messaging_menu(self):
-        self.messaging = MessagingMenu.App(desktop_id=DESKTOP_ID)
+        self.messaging = MessagingMenu.App(desktop_id='gwibber.desktop')
+        self.messaging.append_source(
+            'unread',
+            Gio.Icon.new_for_string(''),
+            'Unread')
         self.messaging.register()
-
-    def init_dbus_menu(self):
-        self.launcher = Unity.LauncherEntry.get_for_desktop_id(DESKTOP_ID)
-        quicklist = Dbusmenu.Menuitem.new()
-        # The update status menu item.
-        post_menu = Dbusmenu.Menuitem.new()
-        post_menu.property_set(Dbusmenu.MENUITEM_PROP_LABEL,
-                               _('Update Status'))
-        post_menu.connect('item-activated', helper('friends-poster'))
-        # The refresh menu item.
-        refresh_menu = Dbusmenu.Menuitem.new()
-        refresh_menu.property_set(Dbusmenu.MENUITEM_PROP_LABEL, _('Refresh'))
-        refresh_menu.connect('item-activated', self._refresh)
-        # The preferences menu item.
-        preferences_menu = Dbusmenu.Menuitem.new()
-        preferences_menu.property_set(Dbusmenu.MENUITEM_PROP_LABEL,
-                                      _('Preferences'))
-        preferences_menu.connect('item-activated',
-                                 helper('friends-preferences'))
-        # The quit menu item.
-        quit_menu = Dbusmenu.Menuitem.new()
-        quit_menu.property_set(Dbusmenu.MENUITEM_PROP_LABEL, _('Quit'))
-        quit_menu.connect('item-activated', self._shutdown)
-        # Make all the menu items visible.
-        for menu in (post_menu, refresh_menu, preferences_menu, quit_menu):
-            menu.property_set_bool(Dbusmenu.MENUITEM_PROP_VISIBLE, True)
-            quicklist.child_append(menu)
-        # Initialize the unread count to zero.
-        self.launcher.set_property('quicklist', quicklist)
-        self.update_unread_count(0)
+        # TODO add shortcuts for refresh and quit into this menu?
 
     def update_unread_count(self, count):
-        """Update the unread count.  If zoer, make it invisible."""
-        if self.launcher:
-            self.launcher.set_property('count', count)
-            self.launcher.set_property('count_visible', bool(count))
-
-
-# XXX This bit allows you to test this file by running it.  This doesn't fit
-# very well into the larger testsuite architecture so we could probably
-# improve this somehow, but I'm not sure how.
-#
-# In the meantime, run this like so (from the directory containing the
-# setup.py file):
-#
-#   $ python3 -m friends.utils.menus
-#
-# You should see the Friends icon in the launcher and switcher get the value
-# '20'.  If Friends is not running, pass in a second positional argument which
-# is the name of a desktop file for an application that is running, e.g.:
-#
-#   $ python3 -m friends.utils.menus gnome-terminal.desktop
-#
-# Pass in another argument to set some number other than 20.  If you pass in
-# 0, the count will not be visible.
-#
-# Hit C-c to quit.
-
-if __name__ == '__main__':
-    import sys
-    from gi.repository import GObject
-
-    if len(sys.argv) > 1:
-        DESKTOP_ID = sys.argv[1]
-    if len(sys.argv) > 2:
-        count = int(sys.argv[2])
-    else:
-        count = 20
-
-    def stub(*ignore):
-        pass
-
-    menu = MenuManager(stub, stub)
-    menu.update_unread_count(count)
-
-    try:
-        GObject.MainLoop().run()
-    except KeyboardInterrupt:
-        pass
+        """Update the unread count. If zero, make it invisible."""
+        if not self.messaging:
+            return
+
+        self.messaging.set_source_count('unread', count)