Merge lp:~mhr3/libunity/fix-1212307 into lp:libunity

[Michal Hruby]

Add a few methods to allow python bindings to correctly create a SearchMetadata instance.

Add a few methods to allow python bindings to correctly create a SearchMetadata instance.

See the linked bug for a testcase.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:292
http://jenkins.qa.ubuntu.com/job/libunity-ci/118/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-amd64-ci/103
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-armhf-ci/103
    SUCCESS: http://jenkins.qa.ubuntu.com/job/libunity-saucy-i386-ci/103

Click here to trigger a rebuild:
http://s-jenkins:8080/job/libunity-ci/118/rebuild

review: Approve (continuous-integration)

[Paweł Stołowski (stolowski)]

LGTM. +1

review: Approve

=== modified file 'bindings/python/Unity.py'
--- bindings/python/Unity.py	2013-08-20 10:20:01 +0000
+++ bindings/python/Unity.py	2013-09-18 11:20:49 +0000
@@ -86,7 +86,6 @@
                 if isinstance(value, unicode):
                     metadata[col_name] = GLib.Variant("s", value)
 
-
     result = GLib.Variant("(ssuussssa{sv})", (uri, icon, category,
                                               result_type, mimetype,
                                               title, comment, dnd_uri,
@@ -94,6 +93,24 @@
     return result
 
 
+def dict_to_variant(metadata_dict):
+    metadata = {}
+
+    for name, value in metadata_dict.items():
+        if isinstance(value, GLib.Variant):
+            metadata[name] = value
+        elif isinstance(value, str):
+            metadata[name] = GLib.Variant("s", value)
+        elif isinstance(value, int):
+            metadata[name] = GLib.Variant("i", value)
+        elif sys.version_info < (3, 0, 0):
+            # unicode is not defined in py3
+            if isinstance(value, unicode):
+                metadata[name] = GLib.Variant("s", value)
+
+    return GLib.Variant("a{sv}", metadata)
+
+
 class ScopeResult(Unity.ScopeResult):
 
     @staticmethod
@@ -104,6 +121,17 @@
         return Unity.ScopeResult.create(*args)
 
 
+class SearchContext(Unity.SearchContext):
+
+    @staticmethod
+    def create(search_query, search_type, filter_state, metadata_dict, result_set, cancellable):
+        context = Unity.SearchContext.create(search_query, search_type, filter_state, None, result_set, cancellable)
+        if len(metadata_dict) > 0:
+            metadata_variant = dict_to_variant(metadata_dict)
+            context.set_search_metadata(Unity.SearchMetadata.create_from_variant(metadata_variant))
+
+        return context
+
 ScopeSearchBase = override(ScopeSearchBase)
 __all__.append('ScopeSearchBase')
 ResultPreviewer = override(ResultPreviewer)
@@ -112,3 +140,5 @@
 __all__.append('ResultSet')
 ScopeResult = override(ScopeResult)
 __all__.append('ScopeResult')
+SearchContext = override(SearchContext)
+__all__.append('SearchContext')

=== modified file 'debian/libunity9.symbols'
--- debian/libunity9.symbols	2013-08-28 13:23:27 +0000
+++ debian/libunity9.symbols	2013-09-18 11:20:49 +0000
@@ -621,8 +621,10 @@
  unity_search_context_dup@Base 7.0.0daily13.05.31ubuntu.unity.next
  unity_search_context_free@Base 7.0.0daily13.05.31ubuntu.unity.next
  unity_search_context_get_type@Base 7.0.0daily13.05.31ubuntu.unity.next
+ unity_search_context_set_search_metadata@Base 0replaceme
  unity_search_metadata_construct@Base 7.0.0daily13.05.31ubuntu.unity.next
  unity_search_metadata_create@Base 7.0.0daily13.05.31ubuntu.unity.next
+ unity_search_metadata_create_from_variant@Base 0replaceme
  unity_search_metadata_get_form_factor@Base 7.0.9+13.10.20130723
  unity_search_metadata_get_locale@Base 7.0.0daily13.05.31ubuntu.unity.next
  unity_search_metadata_get_location@Base 7.1.0+13.10.20130828.1

=== modified file 'src/unity-scope-interface.vala'
--- src/unity-scope-interface.vala	2013-08-27 15:36:13 +0000
+++ src/unity-scope-interface.vala	2013-09-18 11:20:49 +0000
@@ -277,6 +277,7 @@
    * This method will add a new result to the result set from a variant.
    * The default implementation will transform the variant into a ScopeResult
    * and invoke the add_result() method.
+   * The expected type of the variant is '(ssuussssa{sv})'.
    * It is primarily meant for low-level language bindings.
    */
   public virtual void add_result_from_variant (Variant variant)
@@ -411,6 +412,28 @@
 
     return m;
   }
+
+  /**
+   * Create a new SearchMetadata from a variant
+   *
+   * This method will create a new heap-allocated SearchMetadata.
+   * The expected type for the variant is 'a{sv}'.
+   * It is primarily meant for low-level language bindings.
+   */
+  public static SearchMetadata create_from_variant (Variant metadata)
+  {
+    var m = new SearchMetadata ();
+    if (!metadata.is_of_type (VariantType.VARDICT))
+    {
+      warning ("Incorrect variant type for SearchMetadata.create_from_variant. "
+               + "Expected %s, but got %s", VariantType.VARDICT.dup_string (),
+               metadata.get_type_string ());
+      return m;
+    }
+    m.all_metadata = (HashTable<string, Variant>) metadata;
+
+    return m;
+  }
 }
 
 public class GeoCoordinate: Object
@@ -481,6 +504,18 @@
 
     return ctx;
   }
+
+  /**
+   * Set search_metadata
+   *
+   * This method will create a new heap-allocated SearchContext.
+   * It is primarily meant for low-level language bindings, to ensure correct
+   * memory management of the individual fields in the struct.
+   */
+  public void set_search_metadata (SearchMetadata metadata)
+  {
+    this.search_metadata = metadata;
+  }
 }
 
 public abstract class AbstractScope : GLib.Object

=== modified file 'test/vala/test-scope-base.vala'
--- test/vala/test-scope-base.vala	2013-08-27 15:36:13 +0000
+++ test/vala/test-scope-base.vala	2013-09-18 11:20:49 +0000
@@ -26,6 +26,12 @@
   {
     public ScopeSuite ()
     {
+      GLib.Test.add_data_func ("/Unit/SearchContext/Create",
+        Fixture.create<SearchContextTester> (SearchContextTester.test_create));
+      GLib.Test.add_data_func ("/Unit/SearchContext/SetMetadata",
+        Fixture.create<SearchContextTester> (SearchContextTester.test_metadata));
+      GLib.Test.add_data_func ("/Unit/ScopeResult/CreateFromVariant",
+        Fixture.create<ScopeResultTester> (ScopeResultTester.test_create_from_variant));
       GLib.Test.add_data_func ("/Unit/AbstractScope/AddResult",
         Fixture.create<AbstractScopeTester> (AbstractScopeTester.test_add_result));
       GLib.Test.add_data_func ("/Unit/AbstractScope/AddResultFromVariant",
@@ -34,8 +40,69 @@
         Fixture.create<AbstractScopeTester> (AbstractScopeTester.test_metadata_with_location));
       GLib.Test.add_data_func ("/Unit/Cancellable/GetGCancellable",
         Fixture.create<CancellableTester> (CancellableTester.test_get_gcancellable));
-      GLib.Test.add_data_func ("/Unit/ScopeResult/CreateFromVariant",
-        Fixture.create<ScopeResultTester> (ScopeResultTester.test_create_from_variant));
+    }
+
+    class ResultSetTestImpl: ResultSet
+    {
+      public GenericArray<ScopeResult?> results;
+
+      construct
+      {
+        results = new GenericArray<ScopeResult?> ();
+      }
+      protected override void add_result (ScopeResult result)
+      {
+        results.add (result);
+      }
+    }
+
+    class SearchContextTester: Object, Fixture
+    {
+      public void test_create ()
+      {
+        var metadata_ht = new HashTable<string, Variant> (str_hash, str_equal);
+        metadata_ht["locale"] = new Variant.string ("en_GB");
+        var result_set =  new ResultSetTestImpl ();
+        var context = Unity.SearchContext.create ("query",
+                                                  Unity.SearchType.GLOBAL,
+                                                  null,
+                                                  metadata_ht,
+                                                  result_set,
+                                                  null);
+
+        assert (context.search_query == "query");
+        assert (context.search_type == Unity.SearchType.GLOBAL);
+        assert (context.filter_state == null);
+        assert (context.result_set == result_set);
+        assert (context.cancellable == null);
+        assert (context.search_metadata.locale == "en_GB");
+      }
+
+      public void test_metadata ()
+      {
+        var result_set =  new ResultSetTestImpl ();
+        var context = Unity.SearchContext.create ("query",
+                                                  Unity.SearchType.GLOBAL,
+                                                  null,
+                                                  null,
+                                                  result_set,
+                                                  null);
+        assert (context.search_metadata.locale == null);
+
+        // set metadata after creation
+        var metadata_ht = new HashTable<string, Variant> (str_hash, str_equal);
+        metadata_ht["locale"] = new Variant.string ("en_AU");
+        context.set_search_metadata (SearchMetadata.create (metadata_ht));
+        assert (context.search_metadata.locale == "en_AU");
+
+        // set metadata from variant
+        var locale_v = new Variant.dict_entry ("locale", new Variant.variant ("en_NZ"));
+        var metadata_v = new Variant.array (VariantType.VARDICT.element (),
+                                            {locale_v});
+        var metadata = Unity.SearchMetadata.create_from_variant (metadata_v);
+        context.set_search_metadata (metadata);
+        assert (context.search_metadata.locale == "en_NZ");
+      }
     }
 
     class AbstractScopeTester: Object, Fixture
@@ -112,20 +179,6 @@
       {
       }
 
-      class ResultSetTestImpl: ResultSet
-      {
-        public GenericArray<ScopeResult?> results;
-
-        construct
-        {
-          results = new GenericArray<ScopeResult?> ();
-        }
-        protected override void add_result (ScopeResult result)
-        {
-          results.add (result);
-        }
-      }
-
       public void test_add_result ()
       {
         bool runner_invoked = false;