Merge lp:~mhr3/gsettings-qt/fix-1209235 into lp:gsettings-qt

[Michal Hruby]

Added API to check if a schema is installed.

Added API to check if a schema is installed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:47
http://jenkins.qa.ubuntu.com/job/gsettings-qt-ci/19/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gsettings-qt-trusty-amd64-ci/3
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gsettings-qt-trusty-armhf-ci/3
        deb: http://jenkins.qa.ubuntu.com/job/gsettings-qt-trusty-armhf-ci/3/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/gsettings-qt-trusty-i386-ci/3

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/gsettings-qt-ci/19/rebuild

review: Approve (continuous-integration)

[Lars Karlitski (larsu)]

Nice work, thanks!

I'm a bit worried that we're not even printing a warning anymore when an uninstalled schema is requested. I guess this is more consistent with how the rest of qml (and javascript) works though.

review: Approve

[Alberto Mardegan (mardy)]

A better name for the property would be "valid". Compare with QML Item's "enabled", "visible", etc.

=== modified file 'GSettings/gsettings-qml.cpp'
--- GSettings/gsettings-qml.cpp	2013-08-30 14:24:40 +0000
+++ GSettings/gsettings-qml.cpp	2014-04-08 09:43:29 +0000
@@ -23,6 +23,9 @@
 {
     QByteArray id;
     QByteArray path;
+    bool isValid;
+
+    GSettingsSchemaQmlPrivate() : isValid(false) {}
 };
 
 struct GSettingsQmlPrivate
@@ -71,6 +74,19 @@
     priv->path = path;
 }
 
+bool GSettingsSchemaQml::isValid() const
+{
+    return priv->isValid;
+}
+
+void GSettingsSchemaQml::setIsValid(bool valid)
+{
+    if (valid != priv->isValid) {
+        priv->isValid = valid;
+        Q_EMIT isValidChanged();
+    }
+}
+
 QVariantList GSettingsSchemaQml::choices(const QByteArray &key) const
 {
     GSettingsQml *parent = (GSettingsQml *) this->parent();
@@ -115,14 +131,19 @@
 
 void GSettingsQml::componentComplete()
 {
-    priv->settings = new QGSettings(priv->schema->id(), priv->schema->path(), this);
-
-    connect(priv->settings, SIGNAL(changed(const QString &)), this, SLOT(settingChanged(const QString &)));
-
-    Q_FOREACH(QString key, priv->settings->keys())
-        this->insert(key, priv->settings->get(key));
-
-    Q_EMIT(schemaChanged());
+    bool schemaValid = QGSettings::isSchemaInstalled(priv->schema->id());
+    if (schemaValid) {
+        priv->settings = new QGSettings(priv->schema->id(), priv->schema->path(), this);
+
+        connect(priv->settings, SIGNAL(changed(const QString &)), this, SLOT(settingChanged(const QString &)));
+
+        Q_FOREACH(QString key, priv->settings->keys())
+            this->insert(key, priv->settings->get(key));
+
+        Q_EMIT(schemaChanged());
+    }
+    // emit isValid notification only once everything is setup
+    priv->schema->setIsValid(schemaValid);
 }
 
 void GSettingsQml::settingChanged(const QString &key)

=== modified file 'GSettings/gsettings-qml.h'
--- GSettings/gsettings-qml.h	2013-08-28 17:29:34 +0000
+++ GSettings/gsettings-qml.h	2014-04-08 09:43:29 +0000
@@ -22,8 +22,9 @@
 class GSettingsSchemaQml: public QObject
 {
     Q_OBJECT
-    Q_PROPERTY(QByteArray id   READ id   WRITE setId)
-    Q_PROPERTY(QByteArray path READ path WRITE setPath)
+    Q_PROPERTY(QByteArray id      READ id      WRITE setId)
+    Q_PROPERTY(QByteArray path    READ path    WRITE setPath)
+    Q_PROPERTY(bool       isValid READ isValid NOTIFY isValidChanged)
 
 public:
     GSettingsSchemaQml(QObject *parent = NULL);
@@ -35,9 +36,15 @@
     QByteArray path() const;
     void setPath(const QByteArray &path);
 
+    bool isValid() const;
+    void setIsValid(bool valid);
+
     Q_INVOKABLE QVariantList choices(const QByteArray &key) const;
     Q_INVOKABLE void reset(const QByteArray &key);
 
+Q_SIGNALS:
+    void isValidChanged();
+
 private:
     struct GSettingsSchemaQmlPrivate *priv;
 };

=== modified file 'debian/changelog'
--- debian/changelog	2014-03-17 08:26:08 +0000
+++ debian/changelog	2014-04-08 09:43:29 +0000
@@ -1,3 +1,9 @@
+gsettings-qt (0.1-0ubuntu1) UNRELEASED; urgency=medium
+
+  * Added API to check if a schema is installed
+
+ -- Michal Hruby <[e-mail]>  Tue, 08 Apr 2014 10:30:43 +0100
+
 gsettings-qt (0.0+13.10.20130902.1-0ubuntu2) trusty; urgency=medium
 
   * Rebuild against Qt 5.2.1

=== modified file 'src/qgsettings.cpp'
--- src/qgsettings.cpp	2013-08-30 14:24:40 +0000
+++ src/qgsettings.cpp	2014-04-08 09:43:29 +0000
@@ -141,3 +141,15 @@
     g_settings_reset(priv->settings, key);
     g_free(key);
 }
+
+bool QGSettings::isSchemaInstalled(const QByteArray &schema_id)
+{
+    GSettingsSchemaSource *source = g_settings_schema_source_get_default ();
+    GSettingsSchema *schema = g_settings_schema_source_lookup (source, schema_id.constData(), TRUE);
+    if (schema) {
+        g_object_unref (schema);
+        return true;
+    } else {
+        return false;
+    }
+}

=== modified file 'src/qgsettings.h'
--- src/qgsettings.h	2013-08-30 14:24:40 +0000
+++ src/qgsettings.h	2014-04-08 09:43:29 +0000
@@ -96,6 +96,11 @@
      */
     void reset(const QString &key);
 
+    /**
+     * @brief Checks if a schema with the given id is installed.
+     */
+    static bool isSchemaInstalled(const QByteArray &schema_id);
+
 Q_SIGNALS:
     /**
      * \brief Emitted when the value associated with key has changed

=== modified file 'tests/tst_GSettings.qml'
--- tests/tst_GSettings.qml	2013-08-30 14:24:40 +0000
+++ tests/tst_GSettings.qml	2014-04-08 09:43:29 +0000
@@ -15,10 +15,17 @@
     onChanged: changes.push([key, value]);
   }
 
+  GSettings {
+    id: invalid_settings
+
+    schema.id: "com.canonical.gsettings.NonExisting"
+  }
+
   property string bindingTest: settings.testString
 
   // this test must run first (others overwrite keys), hence the 'aaa'
   function test_aaa_read_defaults() {
+    compare(settings.schema.isValid, true);
     compare(settings.testInteger, 42);
     compare(settings.testDouble, 1.5);
     compare(settings.testBoolean, false);
@@ -79,4 +86,9 @@
     settings.schema.reset('testInteger');
     compare(settings.testInteger, 42);
   }
+
+  function test_invalid_schema() {
+    compare(invalid_settings.schema.isValid, false);
+    compare(invalid_settings.schema.testInteger, undefined);
+  }
 }