Merge lp:~davidc3/unity-scope-github/use-mimetype-icons into lp:unity-scope-github

[David Callé]

Use the language used in a github result as its icon

Use the main language of a github project as its result icon

http://ubuntuone.com/4iDuWvr52DDG5yLT01q80u
http://ubuntuone.com/0oHJRkin0Qc1OyxS7CukDu

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

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

Fix tests for a theme-less setup

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:26
http://jenkins.qa.ubuntu.com/job/unity-scope-github-ci/4/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-github-raring-amd64-ci/4/console

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

review: Needs Fixing (continuous-integration)

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

27. By David Callé on 2013-04-29

Add gtk deps

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

28. By David Callé on 2013-04-29

Apply the same fix to people direct search

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

50 + icon_exists = THEME.lookup_icon(icon_ext, 64, 0)

This is a very expensive call, doing it for each result on each search is too much. A different way has to be found.

review: Needs Fixing

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

29. By David Callé on 2013-04-30

Don't use icon lookup for each result. Lookup the theme path and extension for mimetype icons only once at startup

[David Callé (davidc3)]

Trying something less expensive.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

78 + if os.path.isfile("%s/%s.%s" % (THEME_PATH, potential_icon, ICON_EXTENSION)):

This is still a fstat() for each result, and that's expensive. How about just having a static dict that would map the languages to a mimetype(/content type), doing a lookup in that dict and using g_content_type_get_icon().

review: Needs Fixing

[Michal Hruby (mhr3)]

Ie, as long as you need to import Gtk, it's probably not a fast solution.

[James Henstridge (jamesh)]

Rather than searching for icons in the same directory as the "text-x-python" one, why not have a dictionary mapping language => icon_name and cache the lookup_icon result?

While it might be expensive to perform the lookup on every search, it should be okay if you amortise the result over many requests (and will probably be faster than the stat system call os.path.isfile() does).

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

30. By David Callé on 2013-05-02

Generate icon map at scope startup

[David Callé (davidc3)]

Added icon map creation at scope startup with fallback on generic if icon not present and fallback on 'text' if language not mapped.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:30
http://jenkins.qa.ubuntu.com/job/unity-scope-github-ci/8/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scope-github-raring-amd64-ci/8/console

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

review: Needs Fixing (continuous-integration)

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

31. By David Callé on 2013-05-02

Don't forget to check for theme existence for builders

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Michal Hruby (mhr3)]

43 + 'php':{'mime':'text/x/php'},
44 + 'java':{'mime':'text/x/java'},
45 + 'javascript':{'mime':'text/x/javascript'},
46 + 'c#':{'mime':'text/x/csharp'},

These do not look like valid mimetypes, should be "text/x-java" etc.

63 + if theme.lookup_icon(icon, 64, 0):

Do we *really* need those lookups? The only thing they do is slow down startup of the scope.

[David Callé (davidc3)]

This was in a "work with any theme" spirit and avoid blank result icons in some cases, but we don't really need them.

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

32. By David Callé on 2013-05-08

Fix mimetypes, don't do extra checks for each specific icon. Unity does it and fallbacks for us

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

33. By David Callé on 2013-05-08

Remove GTK deps

[Michal Hruby (mhr3)]

8 - gir1.2-glib-2.0
9 + gir1.2-glib-2.0,

I guess the comma shouldn't be there.

21 +import os

Doesn't seem to be used anywhere

review: Needs Fixing

[lp:~davidc3/unity-scope-github/use-mimetype-icons]

34. By David Callé on 2013-05-08

Pyflakes fixes

[Michal Hruby (mhr3)]

review: Approve

=== modified file 'debian/control'
--- debian/control	2013-03-21 19:07:16 +0000
+++ debian/control	2013-05-08 13:25:29 +0000
@@ -26,7 +26,7 @@
          gir1.2-unity-5.0 (>= 6.91),
          gir1.2-dee-1.0,
          unity-scopes-runner,
-         gir1.2-glib-2.0
+         gir1.2-glib-2.0,
 Description: GitHub scope for Unity
  This package contains the "github" scope which allows Unity
  to search for GitHub content.

=== modified file 'src/unity_github_daemon.py'
--- src/unity_github_daemon.py	2013-04-25 13:41:34 +0000
+++ src/unity_github_daemon.py	2013-05-08 13:25:29 +0000
@@ -15,8 +15,8 @@
 # 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 Unity, UnityExtras
-from gi.repository import Gio, GLib
+from gi.repository import Unity
+from gi.repository import Gio
 import json
 import urllib.parse
 import urllib.request
@@ -39,6 +39,25 @@
 DEFAULT_RESULT_ICON = SVG_DIR+'result-developer.svg'
 DEFAULT_RESULT_MIMETYPE = 'text/html'
 DEFAULT_RESULT_TYPE = Unity.ResultType.DEFAULT
+ICON_MAP = {'python':{'mime':'text/x-python'},
+            'ruby':{'mime':'text/x-ruby'},
+            'php':{'mime':'text/x-php'},
+            'java':{'mime':'text/x-java'},
+            'javascript':{'mime':'text/x-javascript'},
+            'c#':{'mime':'text/x-csharp'},
+            'css':{'mime':'text/x-css'},
+            'html':{'mime':'text/x-html'},
+            'c':{'mime':'text/x-c'},
+            'shell':{'mime':'text/x-sh'},
+            'perl':{'mime':'text/x-perl'},
+            'lua':{'mime':'text/x-lua'},
+            'vala':{'mime':'text/x-vala'},
+            'html':{'mime':'text/html'},
+            'text':{'mime':'text', 'icon':'text'}}
+for i in ICON_MAP:
+    icon_list = Gio.content_type_get_icon(ICON_MAP[i]['mime'])
+    if icon_list:
+        ICON_MAP[i]['icon'] = icon_list.to_string()
 
 c1 = {'id'      :'code',
       'name'    :_('Projects'),
@@ -61,6 +80,7 @@
       'field':Unity.SchemaFieldType.OPTIONAL}
 EXTRA_METADATA = [m1, m2, m3]
 
+
 def search(search, filters, cancellable):
     '''
     Any search method returning results as a list of tuples.
@@ -105,22 +125,33 @@
     if 'repositories' in data:
         for d in data['repositories']:
             if len(results) < 25:
+                src = str(d['language']).lower()
+                icon = ICON_MAP['text']['icon']
+                if src in ICON_MAP:
+                    if 'icon' in ICON_MAP[src]:
+                        icon = ICON_MAP[src]['icon']
                 results.append({'uri':'https://github.com/%s/%s' % (d['owner'], d['name']),
                                 'title':d['name'],
                                 'comment':d['description'],
                                 'owner':d['owner'],
                                 'followers':d['watchers'],
-                                'language':str(d['language'])})
+                                'language':str(d['language']),
+                                'icon':icon})
     else:
         for d in data:
             if len(results) < 25:
+                src = str(d['language']).lower()
+                icon = ICON_MAP['text']['icon']
+                if src in ICON_MAP:
+                    if 'icon' in ICON_MAP[src]:
+                        icon = ICON_MAP[src]['icon']
                 results.append({'uri':d['html_url'],
-                                'icon':d['owner']['avatar_url'],
                                 'title':d['name'],
                                 'comment':d['description'],
                                 'owner':d['owner']['login'],
                                 'followers':d['watchers'],
-                                'language':str(d['language'])})
+                                'language':str(d['language']),
+                                'icon':icon})
     return results
 
 

=== modified file 'tests/test_github.py'
--- tests/test_github.py	2013-04-25 13:41:34 +0000
+++ tests/test_github.py	2013-05-08 13:25:29 +0000
@@ -49,8 +49,7 @@
         result = result_set.results[0]
         self.assertEqual(
             result['uri'], 'https://github.com/tualatrix/ubuntu-tweak')
-        self.assertEqual(result['icon'], '/usr/share/icons/unity-icon-theme'
-                         '/places/svg/result-developer.svg')
+        self.assertEqual(result['icon'], '. GThemedIcon text-x-python gnome-mime-text-x-python text-x-generic')
         self.assertEqual(result['title'], 'ubuntu-tweak')
         self.assertEqual(result['comment'], 'Ubuntu Tweak is a tool that '
                          'makes it easy to configure your system and '