Merge lp:~nataliabidart/magicicada-gui/expand-status into lp:magicicada-gui

[Natalia Bidart]

Status label tweaks: added connection status, added ellipsize, added initial status.

[lp:~nataliabidart/magicicada-gui/expand-status]

28. By Natalia Bidart on 2010-05-24

Merged trunk in.

=== modified file 'data/ui/gui.glade'
--- data/ui/gui.glade	2010-05-16 21:43:51 +0000
+++ data/ui/gui.glade	2010-05-24 16:14:33 +0000
@@ -199,13 +199,14 @@
               </object>
               <packing>
                 <property name="expand">False</property>
+                <property name="padding">3</property>
                 <property name="position">0</property>
               </packing>
             </child>
             <child>
               <object class="GtkLabel" id="status_label">
                 <property name="visible">True</property>
-                <property name="label" translatable="yes">Service not started, click Start to continue.</property>
+                <property name="ellipsize">end</property>
               </object>
               <packing>
                 <property name="position">1</property>

=== modified file 'magicicada/__init__.py'
--- magicicada/__init__.py	2010-05-23 10:23:35 +0000
+++ magicicada/__init__.py	2010-05-24 16:14:33 +0000
@@ -29,16 +29,16 @@
 gtk2reactor.install()
 
 from magicicada import syncdaemon
-from magicicada.helpers import get_data_file, get_builder, NO_OP, print_debug
+from magicicada.helpers import get_data_file, get_builder, NO_OP
 
 CONTENT_QUEUE = 'content'
 META_QUEUE = 'meta'
 
 class MagicicadaUI(object):
 
+    STATUS_JOINER = " - "
     STATUS = {
-        'started': _('Service started, click Connect to continue.'),
-        'connected': _('Service connected. Doing internal synchronization...'),
+        'initial': _('Service is not started, click Start to continue.'),
     }
 
     def __init__(self, launchpad_available=False, on_destroy=NO_OP,
@@ -142,7 +142,6 @@
         self.disconnect.set_sensitive(False)
         self.sd.disconnect()
 
-    @print_debug
     def on_status_icon_activate(self, widget, data=None):
         """Systray icon was clicked."""
         if self.main_window.get_property('visible'):
@@ -171,6 +170,11 @@
         self._activate_indicator(self.is_connected, sensitive=False)
         self._activate_indicator(self.is_online, sensitive=False)
 
+        cs = self.sd.current_state
+        self.on_status_changed(cs.name, cs.description)
+        self.on_meta_queue_changed(self.sd.meta_queue)
+        self.on_content_queue_changed(self.sd.content_queue)
+
     def on_connected(self, *args, **kwargs):
         """Callback'ed when syncadaemon is connected."""
         self.connect.hide()
@@ -199,12 +203,14 @@
         self._activate_indicator(self.is_online, sensitive=False)
 
     def on_status_changed(self, name=None, description=None,
-                          is_error=False, is_connected=True,
-                          is_online=True, queues=None, connection=None):
+                          is_error=False, is_connected=True, is_online=True,
+                          queues=None, connection=None):
         """Callback'ed when the SD status changed."""
-        if description is None:
-            description = ''
-        self.status_label.set_text(description)
+        values = (v for v in (name, description, connection) if v)
+        text = self.STATUS_JOINER.join(values)
+        if not (text or self.sd.current_state.is_started):
+            text = self.STATUS['initial']
+        self.status_label.set_text(text)
 
     def _on_queue_changed(self, queue_name, items, *args, **kwargs):
         """Callback'ed when a queue changed."""
@@ -257,4 +263,6 @@
 
         self.on_meta_queue_changed(self.sd.meta_queue)
         self.on_content_queue_changed(self.sd.content_queue)
-        self.on_status_changed(description=current_state.description)
+        self.on_status_changed(name=current_state.name,
+                               description=current_state.description,
+                               connection=current_state.connection)

=== modified file 'magicicada/tests/test_magicicada.py'
--- magicicada/tests/test_magicicada.py	2010-05-23 10:23:35 +0000
+++ magicicada/tests/test_magicicada.py	2010-05-24 16:14:33 +0000
@@ -18,6 +18,8 @@
 
 """Tests for magicicada."""
 
+import pango
+
 from twisted.trial.unittest import TestCase
 
 from magicicada import MagicicadaUI, CONTENT_QUEUE, META_QUEUE, syncdaemon
@@ -28,6 +30,10 @@
     """A faked syncdaemon."""
 
     def __init__(self):
+        self.current_state = syncdaemon.State()
+        self.meta_queue = []
+        self.content_queue = []
+
         self.on_started_callback = NO_OP
         self.on_stopped_callback = NO_OP
         self.on_connected_callback = NO_OP
@@ -38,14 +44,11 @@
         self.content_queue_changed_callback = NO_OP
         self.meta_queue_changed_callback = NO_OP
         self.shutdown = NO_OP
-        self.start = NO_OP
-        self.quit = NO_OP
-        self.connect = NO_OP
-        self.disconnect = NO_OP
-
-        self.current_state = syncdaemon.State()
-        self.meta_queue = []
-        self.content_queue = []
+        self.start = lambda: setattr(self.current_state, 'is_started', True)
+        self.quit = lambda: setattr(self.current_state, 'is_started', False)
+        self.connect = lambda: setattr(self.current_state, 'is_connected', True)
+        self.disconnect = \
+                    lambda: setattr(self.current_state, 'is_connected', False)
 
 
 class MagicicadaUITestCase(TestCase):
@@ -62,6 +65,17 @@
         self.ui.on_main_window_destroy(self.ui.main_window)
         self._called = False
 
+    def do_start(self):
+        """Simulate that start fully happened."""
+        self.ui.on_start_clicked(self.ui.start)
+        self.ui.on_started()
+
+    def do_connect(self):
+        """Simulate that connect fully happened."""
+        self.do_start()
+        self.ui.on_connect_clicked(self.ui.connect)
+        self.ui.on_connected()
+
     def assert_indicator_disabled(self, indicator):
         """Test that 'indicator' is not sensitive."""
         self.assertFalse(indicator.is_sensitive(), 'indicator is not sensitive')
@@ -150,8 +164,7 @@
 
     def test_on_connect_clicked(self):
         """Test on_connect_clicked."""
-        self.ui.on_start_clicked(self.ui.start) # need to be started
-        self.ui.on_started()
+        self.do_start() # need to be started
         self.ui.on_connect_clicked(self.ui.connect)
 
         self.assertTrue(self.ui.connect.get_property('visible'))
@@ -170,8 +183,7 @@
 
     def test_on_stop_clicked(self):
         """Test on_stop_clicked."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
+        self.do_start()
         assert not self.ui.widget_enabled(self.ui.disconnect)
         self.patch(self.ui, 'on_disconnect_clicked', self.set_called)
         self.ui.on_stop_clicked(self.ui.stop)
@@ -188,10 +200,7 @@
 
     def test_on_stop_clicked_if_connected(self):
         """Test on_stop_clicked."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
-        self.ui.on_connect_clicked(self.ui.connect)
-        self.ui.on_connected()
+        self.do_connect()
         self.patch(self.ui, 'on_disconnect_clicked', self.set_called)
         self.ui.on_stop_clicked(self.ui.stop)
 
@@ -205,10 +214,7 @@
 
     def test_on_disconnect_clicked(self):
         """Test on_disconnect_clicked."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
-        self.ui.on_connect_clicked(self.ui.connect)
-        self.ui.on_connected()
+        self.do_connect()
         self.ui.on_disconnect_clicked(self.ui.disconnect)
 
         self.assertFalse(self.ui.connect.get_property('visible'))
@@ -329,6 +335,14 @@
 
         self.assert_queue_store_correct(self.queue_store, data)
 
+    def test_on_stopped_updates_queue(self):
+        """On SD stoppped, the UI updates the queue state."""
+        cb = 'on_%s_queue_changed' % self.queue
+        self.patch(self.ui, cb, self.set_called)
+        self.ui.on_stopped()
+        self.assertTrue(self._called,
+                        '%s was called on_stopped.' % cb)
+
 
 class MagicicadaUIContentQueueTestCase(_MagicicadaUIQueueTestCase):
     """UI test cases for content queue view."""
@@ -345,28 +359,91 @@
 class MagicicadaUIStatusTestCase(MagicicadaUITestCase):
     """UI test cases for the status label."""
 
+    def assert_status_label_correct(self, name=None, description=None,
+                                    connection=None, expected=None):
+        """Test that the status label is of the form name: description."""
+        if expected is None:
+            assert name is not None
+            assert description is not None
+            assert connection is not None
+            values = (name, description, connection)
+            expected = self.ui.STATUS_JOINER.join(values)
+
+        actual = self.ui.status_label.get_text()
+        msg = 'status label test must be "%s" (got "%s" instead).'
+        self.assertEqual(expected, actual, msg % (expected, actual))
+
     def test_callback_is_connected(self):
         """Status callback is connected."""
         self.assertEqual(self.ui.sd.status_changed_callback,
                          self.ui.on_status_changed,
                          'status_changed callback must be set')
 
+    def test_status_label_ellipsizes(self):
+        """The status label ellipsizes."""
+        expected = pango.ELLIPSIZE_END
+        actual = self.ui.status_label.get_ellipsize()
+        self.assertEqual(expected, actual, 'label ellipsizes is ELLIPSIZE_END.')
+
     def test_on_status_changed_updates_status_label(self):
-        """On status changed the status label is updated."""
-        kwargs = dict(name='test', description='the status for testing',
-                      is_error=False, is_connected=True, is_online=False,
-                      queues=None, connection=None)
+        """On status changed, the status label is updated."""
+        name = 'TEST'
+        description = 'the status for testing'
+        connection = 'funny funny connection'
+        kwargs = dict(name=name, description=description, connection=connection)
+
+        # usual case, all values are defined
         self.ui.on_status_changed(**kwargs)
-        self.assertEqual(self.ui.status_label.get_text(), kwargs['description'])
+        self.assert_status_label_correct(**kwargs)
+
+    def test_on_status_changed_updates_status_label_even_on_weird_cases(self):
+        """On status changed, the status label is updated."""
+        name = 'TEST'
+        description = 'the status for testing'
+        connection = 'funny funny connection'
+        kwargs = dict(name=name, description=description, connection=connection)
+
+        keywords = ('name', 'description', 'connection') # need ordering
+        for attr in keywords:
+            old_value = kwargs[attr]
+
+            # some weird cases: attr is '' or None
+            for value in ('', None):
+                kwargs[attr] = value
+                self.ui.on_status_changed(**kwargs)
+                others = (kwargs[k] for k in keywords if k != attr)
+                expected = self.ui.STATUS_JOINER.join(others)
+                self.assert_status_label_correct(expected=expected)
+
+            kwargs[attr] = old_value
 
     def test_update_is_correct_for_status_label(self):
         """Correctly updates the status label."""
-        expected = 'dummy test'
-        self.ui.sd.current_state._set(description=expected)
+        name = 'TEST'
+        description = 'the status for testing'
+        connection = 'funny funny connection'
+        kwargs = dict(name=name, description=description, connection=connection)
+        self.ui.sd.current_state._set(**kwargs)
 
         self.ui.update()
-
-        self.assertEqual(expected, self.ui.status_label.get_text())
+        self.assert_status_label_correct(**kwargs)
+
+    def test_on_stopped_updates_status_label(self):
+        """On SD stoppped, the UI updates the status label."""
+        self.patch(self.ui, 'on_status_changed', self.set_called)
+        self.ui.on_stopped()
+        self.assertTrue(self._called,
+                        'on_status_changed was called on_stopped.')
+
+    def test_status_label_default_if_not_started(self):
+        """Status label is the default if not started."""
+        self.assert_status_label_correct(expected=self.ui.STATUS['initial'])
+
+    def test_status_label_empty_if_started_and_no_name_nor_desc(self):
+        """Status label is empty if started but no name and no description."""
+        self.do_start()
+        self.ui.on_status_changed(name=None, description=None)
+        self.assert_status_label_correct(expected='')
 
 
 class MagicicadaUIConnectionTestCase(MagicicadaUITestCase):
@@ -425,10 +502,7 @@
 
     def test_on_started_is_correct(self):
         """On SD started, the UI enables connect and indicator."""
-        # must have click start first
-        self.ui.on_start_clicked(self.ui.start)
-
-        self.ui.on_started()
+        self.do_start()
 
         self.assertTrue(self.ui.widget_enabled(self.ui.stop))
         self.assertTrue(self.ui.widget_enabled(self.ui.connect))
@@ -438,11 +512,7 @@
 
     def test_on_connected_is_correct(self):
         """On SD connected, the UI enables indicator."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
-        self.ui.on_connect_clicked(self.ui.start)
-
-        self.ui.on_connected()
+        self.do_connect()
 
         self.assertTrue(self.ui.widget_enabled(self.ui.disconnect))
         self.assert_indicator_ready(self.ui.is_started)
@@ -451,10 +521,7 @@
 
     def test_on_online_is_correct(self):
         """On SD online, the UI enables indicator."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
-        self.ui.on_connect_clicked(self.ui.connect)
-        self.ui.on_connected()
+        self.do_connect()
 
         self.ui.on_online()
 
@@ -464,8 +531,7 @@
 
     def test_on_stopped_is_correct(self):
         """On SD stopped, the UI disables stop and indicator."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
+        self.do_start()
         self.ui.on_stop_clicked(self.ui.stop)
 
         self.ui.on_stopped()
@@ -478,10 +544,7 @@
 
     def test_on_disconnected_is_correct(self):
         """On SD disconnected, the UI disables connect and indicator."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
-        self.ui.on_connect_clicked(self.ui.connect)
-        self.ui.on_connected()
+        self.do_connect()
         self.ui.on_disconnect_clicked(self.ui.disconnect)
 
         self.ui.on_disconnected()
@@ -493,10 +556,7 @@
 
     def test_on_offline_is_correct(self):
         """On SD offline, the UI disables indicator."""
-        self.ui.on_start_clicked(self.ui.start)
-        self.ui.on_started()
-        self.ui.on_connect_clicked(self.ui.connect)
-        self.ui.on_connected()
+        self.do_connect()
 
         self.ui.on_offline()