Merge lp:~nataliabidart/magicicada-gui/multiple-prettier-metadata into lp:magicicada-gui

[Natalia Bidart]

Prettier metadata. Also, file chooser defaults to ~/Ubuntu One/.
Code internally changed so multiple metadata windows are supported, but that support will come on another branch.

[Facundo Batista (facundo)]

I like it!

review: Approve

=== modified file 'data/ui/gui.glade'
--- data/ui/gui.glade	2010-06-14 01:14:18 +0000
+++ data/ui/gui.glade	2010-06-26 14:17:28 +0000
@@ -1052,76 +1052,11 @@
       <action-widget response="0">shares_to_others_close</action-widget>
     </action-widgets>
   </object>
-  <object class="GtkDialog" id="raw_metadata_dialog">
-    <property name="width_request">600</property>
-    <property name="height_request">300</property>
-    <property name="border_width">5</property>
-    <property name="title" translatable="yes">Raw metadata</property>
-    <property name="window_position">center</property>
-    <property name="type_hint">normal</property>
-    <property name="has_separator">False</property>
-    <signal name="close" handler="on_raw_metadata_close_clicked"/>
-    <child internal-child="vbox">
-      <object class="GtkVBox" id="dialog-vbox9">
-        <property name="visible">True</property>
-        <property name="spacing">2</property>
-        <child>
-          <object class="GtkTextView" id="raw_metadata_view">
-            <property name="visible">True</property>
-            <property name="can_focus">True</property>
-            <property name="editable">False</property>
-            <property name="wrap_mode">word</property>
-          </object>
-          <packing>
-            <property name="position">1</property>
-          </packing>
-        </child>
-        <child>
-          <object class="GtkImage" id="raw_metadata_image">
-            <property name="visible">True</property>
-            <property name="stock">gtk-missing-image</property>
-          </object>
-          <packing>
-            <property name="position">2</property>
-          </packing>
-        </child>
-        <child internal-child="action_area">
-          <object class="GtkHButtonBox" id="dialog-action_area9">
-            <property name="visible">True</property>
-            <property name="layout_style">end</property>
-            <child>
-              <object class="GtkButton" id="raw_metadata_close">
-                <property name="label">gtk-close</property>
-                <property name="visible">True</property>
-                <property name="can_focus">True</property>
-                <property name="receives_default">True</property>
-                <property name="use_stock">True</property>
-                <signal name="clicked" handler="on_raw_metadata_close_clicked"/>
-                <signal name="activate" handler="on_raw_metadata_close_clicked"/>
-              </object>
-              <packing>
-                <property name="expand">False</property>
-                <property name="fill">False</property>
-                <property name="position">0</property>
-              </packing>
-            </child>
-          </object>
-          <packing>
-            <property name="expand">False</property>
-            <property name="pack_type">end</property>
-            <property name="position">0</property>
-          </packing>
-        </child>
-      </object>
-    </child>
-    <action-widgets>
-      <action-widget response="0">raw_metadata_close</action-widget>
-    </action-widgets>
-  </object>
   <object class="GtkFileChooserDialog" id="file_chooser">
     <property name="border_width">5</property>
     <property name="type_hint">normal</property>
     <property name="has_separator">False</property>
+    <property name="create_folders">False</property>
     <signal name="file_activated" handler="on_file_chooser_open_clicked"/>
     <child internal-child="vbox">
       <object class="GtkVBox" id="dialog-vbox7">
 
=== modified file 'magicicada/__init__.py'
--- magicicada/__init__.py	2010-06-21 17:10:41 +0000
+++ magicicada/__init__.py	2010-06-26 14:17:28 +0000
@@ -19,13 +19,15 @@
 """Magicicada."""
 
 import logging
-import gtk
+import os
 import sys
 
 import gettext
 from gettext import gettext as _
 gettext.textdomain('magicicada')
 
+import gtk
+
 # optional Launchpad integration
 # this shouldn't crash if not found as it is simply used for bug reporting
 try:
@@ -43,10 +45,14 @@
 
 CONTENT_QUEUE = 'content'
 META_QUEUE = 'meta'
+UBUNTU_ONE_ROOT = os.path.expanduser('~/Ubuntu One')
 
 # set up the logging for all the project
 logger_helper.set_up()
 logger = logging.getLogger('magicicada.ui')
+console = logging.StreamHandler()
+console.setLevel(logging.DEBUG)
+#logger.addHandler(console)
 
 
 class MagicicadaUI(object):
@@ -87,8 +93,7 @@
             'shares_to_me_store', 'shares_to_me_close',
             'shares_to_others', 'shares_to_others_dialog',  # shares_to_others
             'shares_to_others_store', 'shares_to_others_close',
-            'raw_metadata', 'raw_metadata_dialog',  # raw metadata
-            'raw_metadata_close', 'raw_metadata_view', 'raw_metadata_image',
+            'raw_metadata',  # raw metadata
             'is_started', 'is_connected', 'is_online',  # status bar images
             'status_label', 'status_icon',  # status label and systray icon
             'metaq_view', 'contentq_view',  # queues tree views
@@ -102,6 +107,7 @@
             setattr(self, widget, obj)
             assert obj is not None, '%s must not be None' % widget
 
+        self.raw_metadata_dialog = self._new_metadata_dialog()
         self.volumes = (self.folders, self.shares_to_me, self.shares_to_others)
         self.windows = (self.main_window, self.about_dialog,
                          self.folders_dialog)
@@ -130,9 +136,39 @@
         self.widget_is_visible = lambda w: w.get_property('visible')
         self.widget_enabled = lambda w: self.widget_is_visible(w) and \
                                         w.is_sensitive()
+        self.file_chooser.set_current_folder(UBUNTU_ONE_ROOT)
         self.last_metadata_path = None
         self.update()
 
+    def _new_metadata_dialog(self):
+        """Return a new metadata dialog."""
+        dialog = gtk.Dialog(title='Raw metadata', parent=self.main_window,
+                            flags=gtk.DIALOG_NO_SEPARATOR,
+                            buttons=(gtk.STOCK_CLOSE, gtk.RESPONSE_CLOSE))
+        dialog.set_size_request(600, 300)
+        dialog.set_position(gtk.WIN_POS_CENTER)
+        setattr(self, 'raw_metadata_dialog', dialog)
+
+        close_button = dialog.action_area.get_children()[-1]
+        close_button.connect('clicked', self.on_raw_metadata_close_clicked)
+        close_button.connect('activate', self.on_raw_metadata_close_clicked)
+        setattr(self, 'raw_metadata_close', close_button)
+
+        image = gtk.Image()
+        image.set_from_animation(self.loading_animation)
+        setattr(self, 'raw_metadata_image', image)
+
+        dialog.get_child().add(image)
+
+        text_view = gtk.TextView()
+        text_view.set_editable(False)
+        text_view.set_wrap_mode(gtk.WRAP_WORD)
+        dialog.get_child().add(text_view)
+        setattr(self, 'raw_metadata_view', text_view)
+
+        dialog.hide() # XXX to be fixed later
+        return dialog
+
     # GTK callbacks
 
     def on_main_window_destroy(self, widget, data=None):
@@ -374,11 +410,14 @@
     @log(logger)
     def on_metadata_ready(self, path, metadata):
         """Lower layer has the requested metadata for 'path'."""
+        logger.debug('on_metadata_ready: path: %r, last_metadata_path: %r',
+                     path, self.last_metadata_path)
         if path != self.last_metadata_path:
             return
         self.raw_metadata_image.hide()
         self.raw_metadata_view.show()
-        self.raw_metadata_view.get_buffer().set_text(str(metadata))
+        text = '\n'.join('%s: %s' % i for i in metadata.iteritems())
+        self.raw_metadata_view.get_buffer().set_text(text)
 
     # custom
 
 
=== modified file 'magicicada/tests/test_magicicada.py'
--- magicicada/tests/test_magicicada.py	2010-06-21 17:10:41 +0000
+++ magicicada/tests/test_magicicada.py	2010-06-26 14:17:28 +0000
@@ -29,7 +29,8 @@
 
 from twisted.trial.unittest import TestCase
 
-from magicicada import MagicicadaUI, CONTENT_QUEUE, META_QUEUE, syncdaemon
+from magicicada import MagicicadaUI, CONTENT_QUEUE, META_QUEUE, \
+                       UBUNTU_ONE_ROOT, syncdaemon
 from magicicada.dbusiface import QueueData, FolderData, ShareData
 from magicicada.helpers import NO_OP, humanize_bytes, get_data_file
 from magicicada.tests.helpers import MementoHandler
@@ -193,6 +194,30 @@
         self.assertTrue(sensitive if enabled else not sensitive,
                         msg % (widget_name, '' if enabled else 'not '))
 
+    def assert_dialog_properties(self, dialog_name, title, size=(600, 300),
+                                 modal=True):
+        """The dialog 'dialog_name' has correct properties."""
+        dialog = getattr(self.ui, dialog_name)
+        actual = dialog.size_request()
+        msg = 'size must be %s (got %s instead).'
+        self.assertEquals(size, actual, msg % (size, actual))
+
+        msg = '%s must %sbe modal.'
+        self.assertEqual(modal, dialog.get_modal(),
+                         msg % (dialog_name, '' if modal else 'not '))
+
+        position = dialog.get_property('window-position')
+        self.assertEqual(gtk.WIN_POS_CENTER, position,
+                        '%s must be centered.' % dialog_name)
+
+        actual = dialog.get_title()
+        msg = '%s title must be %s (got %s instead)'
+        self.assertEqual(title, actual, msg % (dialog_name, title, actual))
+
+        msg = '%s must have main_window as parent.'
+        #self.assertTrue(dialog.parent is self.ui.main_window,
+        #                msg % dialog_name)
+
 
 class MagicicadaUIBasicTestCase(MagicicadaUITestCase):
     """UI test cases for basic state."""
@@ -926,21 +951,9 @@
     @skip_abstract_class
     def test_volume_dialog_properties(self):
         """The volume dialog has correct properties."""
-        size = self.volume_dialog.size_request()
-        self.assertEquals((600, 300), size)
-
-        self.assertTrue(self.volume_dialog.get_modal(),
-                        '%s must be modal.' % self.volume_dialog_name)
-
-        position = self.volume_dialog.get_property('window-position')
-        self.assertEqual(gtk.WIN_POS_CENTER, position,
-                        '%s must be centered.' % self.volume_dialog_name)
-
-        actual = self.volume_dialog.get_title()
-        expected = self.name.replace('_', ' ').capitalize()
-        msg = '%s title must be %s (got %s instead)'
-        self.assertEqual(expected, actual,
-                         msg % (self.volume_dialog_name, expected, actual))
+        title = self.name.replace('_', ' ').capitalize()
+        self.assert_dialog_properties(dialog_name=self.volume_dialog_name,
+                                      title=title)
 
 
 class MagicicadaUIFoldersTestCase(_MagicicadaUIVolumeTestCase):
@@ -1116,21 +1129,9 @@
 
     def test_raw_metadata_dialog_properties(self):
         """The raw_metadata dialog has correct properties."""
-        dialog = 'raw_metadata_dialog'
-        size = self.ui.raw_metadata_dialog.size_request()
-        self.assertEquals((600, 300), size)
-
-        self.assertFalse(self.ui.raw_metadata_dialog.get_modal(),
-                         '%s must not be modal.' % dialog)
-
-        position = self.ui.raw_metadata_dialog.get_property('window-position')
-        self.assertEqual(gtk.WIN_POS_CENTER, position,
-                        '%s must be centered.' % dialog)
-
-        actual = self.ui.raw_metadata_dialog.get_title()
-        expected = self.name.replace('_', ' ').capitalize()
-        msg = '%s title must be %s (got %s instead)'
-        self.assertEqual(expected, actual, msg % (dialog, expected, actual))
+        title = self.name.replace('_', ' ').capitalize()
+        self.assert_dialog_properties(dialog_name='raw_metadata_dialog',
+                                      title=title, modal=False)
 
         actual = self.ui.raw_metadata_view.get_wrap_mode()
         msg = 'wrap mode for view must be gtk.WRAP_WORD (got %s instead).'
@@ -1147,6 +1148,14 @@
         self.assertFalse(self.ui.widget_is_visible(self.ui.file_chooser),
                          'file_chooser must be hidden by default.')
 
+    def test_file_chooser_current_folder_is_ubuntu_one_root(self):
+        """File chooser default folder is ~/Ubuntu One."""
+        process_gtk_pendings()  # WOW! Needed to get proper value below
+        actual = self.ui.file_chooser.get_current_folder()
+        msg = 'file_chooser default folder must be %s (got %s instead).'
+        self.assertEqual(actual, UBUNTU_ONE_ROOT,
+                         msg % (UBUNTU_ONE_ROOT, actual))
+
     def test_filename_is_used_only_if_open_clicked(self):
         """Filename is used only if user clicked open."""
         self.patch(self.ui.sd, 'get_metadata', self.set_called)
@@ -1178,10 +1187,12 @@
         buff = self.ui.raw_metadata_view.get_buffer()
         self.assertTrue(buff is not None,
                     'buffer for raw_metadata_view must not be None.')
+
+        expected = '\n'.join('%s: %s' % i for i in self.metadata.iteritems())
         actual = buff.get_text(*buff.get_bounds())
         msg = 'buffer content must be %s (got %s instead).'
-        self.assertEqual(actual, str(self.metadata),
-                         msg % (self.metadata, actual))
+        self.assertEqual(actual, expected,
+                         msg % (expected, actual))
 
     def test_on_metadata_ready_doesnt_update_if_last_path_doesnt_match(self):
         """Callback on_metadata_ready updates the raw_metadata_view."""
@@ -1224,10 +1235,6 @@
         logger = logging.getLogger('magicicada.ui')
         logger.addHandler(self.memento)
 
-        #console = logging.StreamHandler()
-        #console.setLevel(logging.DEBUG)
-        #logger.addHandler(console)
-
     def assert_function_logs(self, func, *args, **kwargs):
         """Check 'funcion' logs its inputs as DEBUG."""
         name = func.__name__