Merge lp:~didrocks/libunity/add-remote-disabling-support into lp:libunity

[Didier Roche]

Add remote search disabling option support to libunity for lenses to consume it.

Add remote search disabling option support to libunity for lenses to consume
it.

Tests included

[Michal Hruby (mhr3)]

146 + public class LensPreferencesManager : GLib.Object

Drop the Lens from the name pls.

159 + private LensPreferencesManager ()
160 + {
161 + gp_settings = new Settings ("com.canonical.Unity.Lenses");
162 + gp_settings.bind (REMOTE_CONTENT_KEY, this, "remote_content_search", SettingsBindFlags.GET);
163 + }

The binding should be in construct {} block. Constructor should be just:
private PreferencesManager ()
{
  Object ();
}

269 + Process.spawn_command_line_sync ("glib-compile-schemas " + gsettings_schema_dir);

Is this really necessary? Don't remember seeing it in other projects?

Otherwise looking good, thanks ;)

review: Needs Fixing

[Didier Roche (didrocks)]

1 & 2 -> done

for 3, you can want override the schema place as I'm doing. However, you still need the schema to be compiled for it being visible. Hence this call.

[Michal Hruby (mhr3)]

Looking great now! +1

review: Approve

[Unity Merger (unity-merger)]

The Jenkins job https://jenkins.qa.ubuntu.com/job/automerge-libunity/161/console reported an error when processing this lp:~didrocks/libunity/add-remote-disabling-support branch.
Not merging it.

[Didier Roche (didrocks)]

@Michael: I didn't push the packaging change before you acked me on IRC. doing now :)

[Didier Roche (didrocks)]

s/Michael/Michal :)

[Unity Merger (unity-merger)]

The Jenkins job https://jenkins.qa.ubuntu.com/job/automerge-libunity/162/console reported an error when processing this lp:~didrocks/libunity/add-remote-disabling-support branch.
Not merging it.

[Didier Roche (didrocks)]

We always need some intltool…

=== modified file 'Makefile.am'
--- Makefile.am	2012-08-20 17:44:32 +0000
+++ Makefile.am	2012-09-26 08:48:22 +0000
@@ -7,7 +7,8 @@
   doc \
   examples \
   test \
-  vapi
+  vapi \
+  po
 
 pkgconfigdir = $(libdir)/pkgconfig
 pkgconfig_DATA = unity.pc unity-protocol-private.pc

=== modified file 'configure.ac'
--- configure.ac	2012-09-24 13:30:51 +0000
+++ configure.ac	2012-09-26 08:48:22 +0000
@@ -121,6 +121,11 @@
 
 GOBJECT_INTROSPECTION_CHECK([0.10.0])
 
+#############################################
+# Gettext
+#############################################
+IT_PROG_INTLTOOL([0.40.0])
+
 #################################################
 # Docs
 #################################################
@@ -209,6 +214,12 @@
 AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal)
 AC_SUBST(GLIB_GENMARSHAL)
 
+#############################################
+# GSettings macros
+#############################################
+
+GLIB_GSETTINGS
+
 ######################################################################
 # Send directory information
 ######################################################################
@@ -220,10 +231,12 @@
 Makefile
 bindings/Makefile
 bindings/python/Makefile
+data/com.canonical.Unity.Lenses.gschema.xml.in
 data/Makefile
 doc/Makefile
 doc/reference/Makefile
 examples/Makefile
+po/Makefile.in
 protocol/Makefile
 src/Makefile
 tools/Makefile

=== modified file 'data/Makefile.am'
--- data/Makefile.am	2011-01-11 17:37:13 +0000
+++ data/Makefile.am	2012-09-26 08:48:22 +0000
@@ -0,0 +1,16 @@
+#############################################################
+# GSettings schemas
+#############################################################
+gsettings_SCHEMAS = com.canonical.Unity.Lenses.gschema.xml
+
+@GSETTINGS_RULES@
+
+@INTLTOOL_XML_NOMERGE_RULE@
+
+EXTRA_DIST = \
+  com.canonical.Unity.Lenses.gschema.xml.in.in
+
+CLEANFILES = \
+  gschemas.compiled \
+  $(gsettings_SCHEMAS)
+

=== added file 'data/com.canonical.Unity.Lenses.gschema.xml.in.in'
--- data/com.canonical.Unity.Lenses.gschema.xml.in.in	1970-01-01 00:00:00 +0000
+++ data/com.canonical.Unity.Lenses.gschema.xml.in.in	2012-09-26 08:48:22 +0000
@@ -0,0 +1,10 @@
+<schemalist>
+  <schema path="/com/canonical/unity/lenses/" id="com.canonical.Unity.Lenses" gettext-domain="libunity">
+    <key type="s" name="remote-content-search">
+      <default>'all'</default>
+      <choices><choice value='all'/><choice value='none'/></choices>
+      <summary>Content fetching from remote source preference.</summary>
+      <description>"all" is to enable the supported default lens to search from remote and commercial sources. "none" will indicate the lenses to not perform that remote search at all.</description>
+    </key>
+  </schema>
+</schemalist>

=== added directory 'po'
=== added file 'po/POTFILES.in'
--- po/POTFILES.in	1970-01-01 00:00:00 +0000
+++ po/POTFILES.in	2012-09-26 08:48:22 +0000
@@ -0,0 +1,4 @@
+[encoding: UTF-8]
+tools/dbus-lens-connect.ui
+tools/unity-tool.vala
+tools/unity-tool.ui

=== added file 'po/POTFILES.skip'
--- po/POTFILES.skip	1970-01-01 00:00:00 +0000
+++ po/POTFILES.skip	2012-09-26 08:48:22 +0000
@@ -0,0 +1,1 @@
+tools/unity-tool.c

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2012-08-20 17:44:32 +0000
+++ src/Makefile.am	2012-09-26 08:48:22 +0000
@@ -98,6 +98,7 @@
   unity-lens-category.vala \
   unity-lens-filters.vala \
   unity-lens-merge-strategy.vala \
+  unity-lens-preferences-manager.vala \
   unity-lens-private.vala \
   unity-lens-search.vala \
   unity-lens-tools.vala \

=== added file 'src/unity-lens-preferences-manager.vala'
--- src/unity-lens-preferences-manager.vala	1970-01-01 00:00:00 +0000
+++ src/unity-lens-preferences-manager.vala	2012-09-26 08:48:22 +0000
@@ -0,0 +1,68 @@
+/*
+ * Copyright (C) 2012 Canonical, Ltd.
+ *
+ * This library is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License
+ * version 3.0 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3.0 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Didier Roche <[e-mail]>
+ *
+ */
+
+using Gee;
+
+namespace Unity {
+
+  /**
+   * A singleton class that caches different gsettings settings.
+   *
+   */
+  public class PreferencesManager : GLib.Object
+  {
+    private static PreferencesManager singleton = null;
+
+    private Settings gp_settings;
+    private const string REMOTE_CONTENT_KEY = "remote-content-search";
+
+    public enum RemoteContent
+    {
+      ALL,
+      NONE,
+    }
+    
+    private PreferencesManager ()
+    {
+      Object();
+    }
+
+    construct
+    {
+      gp_settings = new Settings ("com.canonical.Unity.Lenses");
+      gp_settings.bind (REMOTE_CONTENT_KEY, this, "remote_content_search", SettingsBindFlags.GET);
+    }
+
+    public RemoteContent remote_content_search { get; set; default = RemoteContent.ALL; }
+    
+    /**
+     * Get a ref to the singleton PreferencesManager
+     */
+    public static PreferencesManager get_default ()
+    {
+      if (PreferencesManager.singleton == null)
+        PreferencesManager.singleton = new PreferencesManager();
+      
+      return PreferencesManager.singleton;
+    }
+    
+  } /* class PreferencesManager */
+
+} /* namespace */

=== modified file 'test/vala/Makefile.am'
--- test/vala/Makefile.am	2012-08-07 12:31:44 +0000
+++ test/vala/Makefile.am	2012-09-26 08:48:22 +0000
@@ -8,6 +8,7 @@
   -I$(top_srcdir) \
   -I$(top_builddir)/protocol \
   -I$(top_builddir)/src \
+  -DBUILDDIR=\"$(top_builddir)\" \
   -DTESTDIR=\"$(top_srcdir)/test\" \
   -DTESTVALADIR=\"$(top_srcdir)/test/vala\" \
   -DG_SETTINGS_ENABLE_BACKEND \
@@ -47,6 +48,7 @@
   test-filters.vala \
   test-io.vala \
   test-launcher.vala \
+  test-preferences.vala \
   test-previews.vala \
   test-scope-signals.vala \
   test-vala.vala \

=== added file 'test/vala/test-preferences.vala'
--- test/vala/test-preferences.vala	1970-01-01 00:00:00 +0000
+++ test/vala/test-preferences.vala	2012-09-26 08:48:22 +0000
@@ -0,0 +1,54 @@
+/* -*- Mode: vala; indent-tabs-mode: nil; c-basic-offset: 2; tab-width: 2 -*- */
+/*
+ * Copyright (C) 2012 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Didier Roche <[e-mail]>
+ *
+ */
+using Unity;
+
+namespace Unity.Test
+{
+  public class PreferencesSuite
+  {
+    public PreferencesSuite ()
+    {
+      GLib.Test.add_data_func ("/Unit/Preferences/GsettingsLoad",
+                               test_loading_remote_search_preference);
+      GLib.Test.add_data_func ("/Unit/Preferences/Singleton",
+                               test_singleton);
+    }
+
+    internal static void test_loading_remote_search_preference ()
+    {
+      var p = Unity.PreferencesManager.get_default ();
+      assert (p.remote_content_search == Unity.PreferencesManager.RemoteContent.ALL);
+
+      var gp_settings = new Settings ("com.canonical.Unity.Lenses");
+      gp_settings.set_string ("remote-content-search", "none");
+      assert (p.remote_content_search == Unity.PreferencesManager.RemoteContent.NONE);
+
+    }
+    
+    internal static void test_singleton ()
+    {
+      var p1 = Unity.PreferencesManager.get_default ();
+      var p2 = Unity.PreferencesManager.get_default ();
+
+      assert (p1 == p2);
+    }
+    
+  }
+}

=== modified file 'test/vala/test-vala.vala'
--- test/vala/test-vala.vala	2012-05-31 18:57:53 +0000
+++ test/vala/test-vala.vala	2012-09-26 08:48:22 +0000
@@ -27,10 +27,20 @@
     AppInfoManagerSuite appinfo_manager;
     LauncherSuite launcher;
     FilterSuite filter_suite;
+    PreferencesSuite preferences_suite;
     PreviewSuite preview_suite;
     ScopeSuite scope_suite;
+    string gsettings_schema_dir = Config.BUILDDIR+"/data";
     
     Environment.set_variable ("XDG_DATA_HOME", Config.TESTDIR+"/data", true);
+    Environment.set_variable ("GSETTINGS_SCHEMA_DIR", gsettings_schema_dir, true);
+    Environment.set_variable ("GSETTINGS_BACKEND", "memory", true);
+    try {
+      Process.spawn_command_line_sync ("glib-compile-schemas " + gsettings_schema_dir);
+    } catch (SpawnError e) {
+      stderr.printf ("%s\n", e.message);
+      return 1;
+    }
     Test.init (ref args);
      
     /* IO utility tests */
@@ -42,6 +52,9 @@
     /* Lens Filters */
     filter_suite = new FilterSuite ();
 
+    /* Lens Preferences */
+    preferences_suite = new PreferencesSuite ();
+
     /* Preview test suite */
     preview_suite = new PreviewSuite ();