Merge lp:~jamesh/unity-scope-yelp/preview into lp:unity-scope-yelp

[James Henstridge]

Add a simple preview to the scope, and correctly discover documentation in the fallback "C" directory when there are localised manuals.

Add a preview to the Yelp scope.

I also updated the code that discovers installed documentation to not completely ignore the "C" fallback directory if there is any localised documentation (it now picks up any manuals from there that haven't been localised).

I also switched to using cElementTree for the parsing to speed things up a bit.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:29
http://jenkins.qa.ubuntu.com/job/unity-scope-yelp-ci/3/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scope-yelp-raring-amd64-ci/3

Click here to trigger a rebuild:
http://s-jenkins:8080/job/unity-scope-yelp-ci/3/rebuild

review: Approve (continuous-integration)

[David Callé (davidc3)]

LGTM

review: Approve

=== modified file 'src/unity_yelp_daemon.py'
--- src/unity_yelp_daemon.py	2013-04-02 11:09:28 +0000
+++ src/unity_yelp_daemon.py	2013-05-13 07:19:26 +0000
@@ -14,12 +14,14 @@
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from gi.repository import GLib, Gio
-from gi.repository import Unity
 import gettext
+import html
 import locale
 import os
-from xml.dom import minidom
+from xml.etree import cElementTree as ET
+
+from gi.repository import GLib, Gio
+from gi.repository import Unity
 
 APP_NAME = 'unity-scope-yelp'
 LOCAL_PATH = '/usr/share/locale/'
@@ -55,51 +57,71 @@
 EXTRA_METADATA = []
 
 
+def _get_manuals_in_dir(dir, manuals):
+    """Yield the manuals found in the given directory, omitting those
+    that have already been discovered."""
+    if not os.path.isdir(dir):
+        return
+    for manual in os.listdir(dir):
+        if manual in manuals:
+            continue
+        manualdir = os.path.join(dir, manual)
+        if os.path.isdir(manualdir):
+            manuals.add(manual)
+            yield manualdir
+
+
+def get_manuals(helpdir):
+    """Get the manuals found in the given directory according to the
+    user's locale."""
+    language, encoding = locale.getlocale()
+    manuals = set()
+    if language is not None:
+        languagedir = os.path.join(helpdir, language)
+        yield from _get_manuals_in_dir(languagedir, manuals)
+        # If the locale includes a country, look for manuals 
+        if language[:2] != language:
+            languagedir = os.path.join(helpdir, language[:2])
+            yield from _get_manuals_in_dir(languagedir, manuals)
+    # Now return untranslated versions of remaining manuals.
+    languagedir = os.path.join(helpdir, 'C')
+    yield from _get_manuals_in_dir(languagedir, manuals)
+
+
 def get_yelp_documents():
     '''
      Parses local help files for <desc> and 1st <title> tags and associates
     them with the page's uri in self.data as: {uri, page description, page title}
     If a help file has no <desc> or <title> tag, it is excluded.
     '''
-    language, encoding = locale.getlocale()
-    if language is None:
-        language = 'C'
-
     data = []
-    help_location = '%s%s' % (HELP_DIR, language)
-    if not os.path.exists(help_location):
-        help_location = '%s%s' % (HELP_DIR, language[:2])
-        if not os.path.exists(help_location):
-            help_location = '%s%s' % (HELP_DIR, "C")
-    for dirname in os.listdir(help_location):
-        directory = help_location + "/" + dirname
-        for filename in os.listdir(directory):
-            filename = directory + "/" + filename
-            if not os.path.isdir(filename):
-                if os.path.isfile(filename):
-                    xmldoc = minidom.parse(filename)
-                    try:
-                        pagenode = xmldoc.getElementsByTagName('page')[0]
-                        if pagenode.attributes["type"].value == "topic":
-                            desc = ""
-                            nodes = xmldoc.getElementsByTagName('desc').item(0).childNodes
-                            for node in nodes:
-                                try:
-                                    desc += str(node.wholeText)
-                                except:
-                                    desc += str(node.childNodes[0].wholeText)
-                            desc = desc.strip(' \t\n\r')
-                            title = xmldoc.getElementsByTagName('title').item(0).childNodes[0].data
-                            if desc == "":
-                                desc = title
-                            record = []
-                            record.append(filename)
-                            record.append(desc)
-                            record.append(title)
-                            record.append(dirname)
-                            data.append(record)
-                    except:
-                        pass
+    namespaces = {'m': 'http://projectmallard.org/1.0/'}
+    for manualdir in get_manuals(HELP_DIR):
+        for filename in os.listdir(manualdir):
+            filename = os.path.join(manualdir, filename)
+            if not (filename.endswith('page') and os.path.isfile(filename)):
+                continue
+            try:
+                tree = ET.parse(filename)
+            except ET.ParseError:
+                # Not an XML file
+                continue
+            if (tree.getroot().tag != '{http://projectmallard.org/1.0/}page' or
+                tree.getroot().get('type') != 'topic'):
+                # Not a Mallard documentation file.
+                continue
+            title = desc = ""
+            node = tree.find('m:title', namespaces)
+            if node is not None:
+                title = node.text
+            node = tree.find('m:info/m:desc', namespaces)
+            if node is not None:
+                desc = ''.join(node.itertext())
+            desc = desc.strip(' \t\n\r')
+            if desc == "":
+                desc = title
+
+            data.append((filename, title, desc, os.path.basename(manualdir)))
     return data
 
 
@@ -116,34 +138,40 @@
         YELP_CACHE = get_yelp_documents()
     help_data = YELP_CACHE
 
-    for data in help_data:
+    search = search.lower()
+
+    for (filename, title, desc, manual) in help_data:
         if len(results) >= MAX_RESULTS:
-            return results
+            break
         try:
-            if data[3] == "ubuntu-help":
+            if manual == "ubuntu-help":
                 icon_hint = Gio.ThemedIcon.new("distributor-logo").to_string()
             else:
-                icon_hint = Gio.ThemedIcon.new(data[3]).to_string()
+                icon_hint = Gio.ThemedIcon.new(manual).to_string()
         except:
             icon_hint = Gio.ThemedIcon.new("help").to_string()
 
-        if search.lower() in data[1].lower():
-            results.append({'uri': data[0],
-                            'icon': icon_hint,
-                            'title': data[1]})
-        elif search.lower() in data[2].lower():
-            results.append({'uri': data[0],
-                            'icon': icon_hint,
-                            'title': data[2]})
-        elif search.lower() in data[3].lower():
-            results.append({'uri': data[0],
-                            'icon': icon_hint,
-                            'title': data[1]})
-        else:
-            continue
+        if (search in title.lower() or
+            search in desc.lower() or
+            search in manual.lower()):
+            results.append({'uri': filename,
+                            'icon': icon_hint,
+                            'title': title,
+                            'comment': desc})
     return results
 
 
+class Previewer(Unity.ResultPreviewer):
+
+    def do_run(self):
+        image = Gio.ThemedIcon.new(self.result.icon_hint)
+        preview = Unity.GenericPreview.new(
+            self.result.title, html.escape(self.result.comment), image)
+        action = Unity.PreviewAction.new("open", _("Open"), None)
+        preview.add_action(action)
+        return preview
+
+
 # Classes below this point establish communication
 # with Unity, you probably shouldn't modify them.
 
@@ -245,6 +273,12 @@
         se = MySearch(search_context)
         return se
 
+    def do_create_previewer(self, result, metadata):
+        rp = Previewer()
+        rp.set_scope_result(result)
+        rp.set_search_metadata(metadata)
+        return rp
+
     def do_activate(self, result, metadata, id):
         parameters = [YELP_EXECUTABLE, result.uri]
         GLib.spawn_async(parameters)
 
=== renamed file 'tests/data/C/sample_help/mock_yelp_file' => 'tests/data/C/sample_help/mock_yelp_file.page'
=== modified file 'tests/test_yelp.py'
--- tests/test_yelp.py	2013-04-02 11:09:28 +0000
+++ tests/test_yelp.py	2013-05-13 07:19:26 +0000
@@ -44,24 +44,42 @@
 
     def test_questions_search(self):
         self.scope_module.HELP_DIR = 'tests/data/'
-        expected_results = ["tests/data/C/sample_help/mock_yelp_file",
-                            "A visual introduction to the Unity desktop."]
+        expected_results = ["tests/data/C/sample_help/mock_yelp_file.page",
+                            "Welcome to Ubuntu"]
         results = []
-        for s in ['unity']:
-            result_set = self.perform_query(s)
-            results.append(result_set.results[0]['uri'])
-            results.append(result_set.results[0]['title'])
-        self.assertEqual(results, expected_results)
+        result_set = self.perform_query('unity')
+        self.assertEqual(len(result_set.results), 1)
+        result = result_set.results[0]
+        self.assertEqual(
+            result['uri'], "tests/data/C/sample_help/mock_yelp_file.page")
+        self.assertEqual(result['title'], "Welcome to Ubuntu")
+        self.assertEqual(
+            result['comment'], "A visual introduction to the Unity desktop.")
+        self.assertEqual(result['icon'], 'sample_help')
 
     def test_questions_failing_search(self):
         self.scope_module.HELP_DIR = 'tests/data/'
-        for s in ['upnriitnyt']:
-            result_set = self.perform_query(s)
-            self.assertEqual(len(result_set.results), 0)
+        result_set = self.perform_query('upnriitnyt')
+        self.assertEqual(len(result_set.results), 0)
+
+    def test_preview(self):
+        result = Unity.ScopeResult()
+        result.uri = "tests/data/C/sample_help/mock_yelp_file.page"
+        result.title = "Welcome to Ubuntu"
+        result.comment = "A visual introduction to the Unity desktop."
+        result.icon_hint = 'sample_help'
+
+        previewer = self.scope.create_previewer(result, Unity.SearchMetadata())
+        preview = previewer.run()
+        self.assertEqual(preview.props.title, "Welcome to Ubuntu")
+        self.assertEqual(preview.props.description_markup,
+                         "A visual introduction to the Unity desktop.")
+        self.assertNotEqual(preview.props.image, None)
+        self.assertEqual(preview.props.image.get_names(), ['sample_help'])
 
     def test_activation(self):
         result = Unity.ScopeResult()
-        result.uri = "tests/data/C/sample_help/mock_yelp_file"
+        result.uri = "tests/data/C/sample_help/mock_yelp_file.page"
         activation = self.scope.activate(result, Unity.SearchMetadata(), None)
         self.assertEqual(activation.props.goto_uri, None)
         self.assertEqual(activation.props.handled, Unity.HandledType.HIDE_DASH)