Merge lp:~davidc3/unity-scope-colourlovers/enhance-previews into lp:unity-scope-colourlovers

[David Callé]

Enhance previews, make search faster by only looking for patterns

Add more metadata to previews:
http://ubuntuone.com/2jTSUKoHkjg5e88iSyDfYZ

Only search for patterns (palettes and colours are useless without Gimp and Inkscape integration, which needs to be redone)

[lp:~davidc3/unity-scope-colourlovers/enhance-previews]

31. By David Callé on 2013-04-26

Don't use variants in results

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

+1

review: Approve

=== modified file 'data/colourlovers.scope.in'
--- data/colourlovers.scope.in	2013-04-26 14:37:19 +0000
+++ data/colourlovers.scope.in	2013-04-26 15:46:23 +0000
@@ -4,7 +4,7 @@
 Icon=/usr/share/icons/unity-icon-theme/places/svg/service-colourlovers.svg
 _Keywords=colourlovers;color;colors;patterns;pattern;palette;palettes;
 RequiredMetadata=
-OptionalMetadata=
+OptionalMetadata=description[s];comment_nb[s];date_created[s];rating[s];
 Loader=/usr/share/unity-scopes/colourlovers/unity_colourlovers_daemon.py
 RemoteContent=true
 Type=graphics

=== modified file 'src/unity_colourlovers_daemon.py'
--- src/unity_colourlovers_daemon.py	2013-03-25 06:53:01 +0000
+++ src/unity_colourlovers_daemon.py	2013-04-26 15:46:23 +0000
@@ -21,6 +21,7 @@
 import json
 import gettext
 import os
+import datetime
 
 APP_NAME = 'unity-scope-colourlovers'
 LOCAL_PATH = '/usr/share/locale/'
@@ -49,7 +50,19 @@
 
 FILTERS = []
 
-EXTRA_METADATA = []
+m1 = {'id'   :'description',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m2 = {'id'   :'comment_nb',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m3 = {'id'   :'rating',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+m4 = {'id'   :'date_created',
+      'type' :'s',
+      'field':Unity.SchemaFieldType.OPTIONAL}
+EXTRA_METADATA = [m1, m2, m3, m4]
 
 def search(search, filters):
     '''
@@ -66,10 +79,10 @@
     extras metadata fields (variant)
     '''
     results = []
-    if not search:
+    if not search or len(search) < 2:
         return results
     search = urllib.parse.quote(search)
-    for cat in ['patterns', 'palettes', 'colors']:
+    for cat in ['patterns']:
         uri = '%sapi/%s?format=json&keywords=%s' % (SEARCH_URI, cat,search)
         try:
             req = urllib.request.Request(uri, headers={'User-Agent' : "Magic Browser"})
@@ -84,7 +97,11 @@
             results.append({'uri':d['url'],
                             'icon':d['imageUrl'],
                             'title':d['title'],
-                            'comment':d['userName']})
+                            'comment':d['userName'],
+                            'description':d['description'],
+                            'rating':str(d['numHearts']),
+                            'date_created':str(d['dateCreated']),
+                            'comment_nb':str(d['numComments'])})
     return results
 
 
@@ -121,34 +138,40 @@
                     i['comment'] = ''
                 if not 'dnd_uri' in i or not i['dnd_uri'] or i['dnd_uri'] == '':
                     i['dnd_uri'] = i['uri']
-                i['metadata'] = {}
-                if EXTRA_METADATA:
-                    for e in i:
-                        for m in EXTRA_METADATA:
-                            if m['id'] == e:
-                                i['metadata'][e] = i[e]
-                i['metadata']['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
-                result = Unity.ScopeResult.create(str(i['uri']), str(i['icon']),
-                                                  i['category'], i['result_type'],
-                                                  str(i['mimetype']), str(i['title']),
-                                                  str(i['comment']), str(i['dnd_uri']),
-                                                  i['metadata'])
-                result_set.add_result(result)
+                i['provider_credits'] = GLib.Variant('s', PROVIDER_CREDITS)
+                result_set.add_result(**i)
         except Exception as error:
             print (error)
 
 class Preview (Unity.ResultPreviewer):
 
     def do_run(self):
-        preview = Unity.GenericPreview.new(self.result.title, '', None)
+        if self.result.metadata and 'description' in self.result.metadata and self.result.metadata['description'].get_string() != '':
+            description = self.result.metadata['description'].get_string()
+        else:
+            description = ''
+        preview = Unity.GenericPreview.new(self.result.title, description.strip(), None)
         preview.props.subtitle = _("By ") + self.result.comment
         preview.props.image_source_uri = self.result.icon_hint
+        if self.result.metadata and 'date_created' in self.result.metadata and self.result.metadata['date_created'].get_string() != '':
+            # Format date
+            date = datetime.datetime.strptime(self.result.metadata['date_created'].get_string(), '%Y-%m-%d %H:%M:%S')
+            translated_date = date.strftime('%x')
+            preview.add_info(Unity.InfoHint.new("date_created", _("Created"), None, translated_date))
+        if self.result.metadata and 'comment_nb' in self.result.metadata and self.result.metadata['comment_nb'].get_string() != '':
+            preview.add_info(Unity.InfoHint.new("comment_nb", _("Comments"), None, self.result.metadata['comment_nb'].get_string()))
+        if self.result.metadata and 'rating' in self.result.metadata and self.result.metadata['rating'].get_string() != '':
+            # Create hearts rating
+            fullhearts = int(float(self.result.metadata['rating'].get_string())) * "\u2665"
+            emptyhearts = (5 - int(float(self.result.metadata['rating'].get_string()))) * "\u2661"
+            if self.result.metadata['rating'].get_string() != '0':
+                preview.add_info(Unity.InfoHint.new("rating", _("Rating"), None, fullhearts+emptyhearts))
+        if "/patterns/" in self.result.icon_hint:
+            wallpaper_action = Unity.PreviewAction.new("wallpaper", _("Set as wallpaper"), None)
+            preview.add_action(wallpaper_action)
         icon = Gio.FileIcon.new (Gio.file_new_for_path(PROVIDER_ICON))
         view_action = Unity.PreviewAction.new("view", _("View"), icon)
         preview.add_action(view_action)
-        if "/patterns/" in self.result.icon_hint:
-            wallpaper_action = Unity.PreviewAction.new("wallpaper", _("Set as wallpaper"), None)
-            preview.add_action(wallpaper_action)
         return preview
 
 

=== modified file 'tests/test_colourlovers.py'
--- tests/test_colourlovers.py	2013-03-25 06:53:01 +0000
+++ tests/test_colourlovers.py	2013-04-26 15:46:23 +0000
@@ -5,7 +5,6 @@
 import shutil
 import tempfile
 from unittest import TestCase
-
 from gi.repository import Unity