Merge lp:~kalikiana/u1db-qt/indexRoles into lp:u1db-qt

[Cris Dywan]

Expose index fields as role names

This is aimed to work with lp:~kalikiana/ubuntu-ui-toolkit/sortFilterModel.
TODO: Before merging we should have a unit test for it.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:117
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/47/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-precise-amd64-ci/47
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-saucy-amd64-ci/49
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-amd64-ci/27
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-trusty-armhf-ci/27

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

review: Approve (continuous-integration)

[Andrew Hayzen (ahayzen)]

FYI the branch which I was having issues sorting can be found here [0].

0 - https://code.launchpad.net/~andrew-hayzen/+junk/u1db-sortfiltermodel-recent-test

[lp:~kalikiana/u1db-qt/indexRoles]

118. By Cris Dywan on 2014-05-21

Add sort and filter unit test cases and movies example

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:118
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/48/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-precise-amd64-ci/48/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-saucy-amd64-ci/50/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-utopic-amd64-ci/1/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-utopic-armhf-ci/1/console

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

review: Needs Fixing (continuous-integration)

[lp:~kalikiana/u1db-qt/indexRoles]

119. By Cris Dywan on 2014-05-22

Build and examples should depend on UI toolkit plugin

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:119
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/49/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-precise-amd64-ci/49/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-saucy-amd64-ci/51/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-utopic-amd64-ci/2
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-utopic-armhf-ci/2

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

review: Needs Fixing (continuous-integration)

[lp:~kalikiana/u1db-qt/indexRoles]

120. By Cris Dywan on 2014-11-12

Merge lp:u1db-qt

121. By Cris Dywan on 2014-11-12

Add C++ unit test checking role names of Query

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:121
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/55/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-vivid-amd64-ci/2
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-vivid-armhf-ci/2

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

review: Approve (continuous-integration)

[lp:~kalikiana/u1db-qt/indexRoles]

122. By Cris Dywan on 2014-11-12

Work-around for sort.property not correctly re-sorting

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:122
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/56/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-vivid-amd64-ci/3
    SUCCESS: http://jenkins.qa.ubuntu.com/job/u1db-qt-vivid-armhf-ci/3

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

review: Approve (continuous-integration)

Unmerged revisions

122. By Cris Dywan on 2014-11-12

Work-around for sort.property not correctly re-sorting

121. By Cris Dywan on 2014-11-12

Add C++ unit test checking role names of Query

120. By Cris Dywan on 2014-11-12

Merge lp:u1db-qt

119. By Cris Dywan on 2014-05-22

Build and examples should depend on UI toolkit plugin

118. By Cris Dywan on 2014-05-21

Add sort and filter unit test cases and movies example

117. By Cris Dywan on 2014-03-19

Expose index fields as role names

=== modified file 'debian/control'
--- debian/control	2014-01-22 13:14:22 +0000
+++ debian/control	2014-11-12 17:08:18 +0000
@@ -14,6 +14,7 @@
                qtdeclarative5-qtquick2-plugin,
                qtdeclarative5-test-plugin,
                qttools5-dev-tools,
+               qtdeclarative5-ubuntu-ui-toolkit-plugin,
                ubuntu-ui-toolkit-doc,
                xvfb,
                libgl1-mesa-dri,
@@ -65,6 +66,7 @@
 Section: doc
 Architecture: all
 Depends: libu1db-qt5-3 (>= ${source:Version}),
+         qtdeclarative5-ubuntu-ui-toolkit-plugin,
          ${misc:Depends},
 Description: Qt5 binding and QtQuick2 plugin for U1DB - examples
  Simple Qt5 binding and QtQuick2 plugin for U1DB (https://launchpad.net/u1db).

=== modified file 'examples/bookmarks/bookmarks.qml'
--- examples/bookmarks/bookmarks.qml	2014-02-17 17:40:42 +0000
+++ examples/bookmarks/bookmarks.qml	2014-11-12 17:08:18 +0000
@@ -123,8 +123,8 @@
                 property string detailsDocId: ""
                 property string detailsContents: ""
                 delegate: ListItem.Subtitled {
-                    text: contents.title || '[title:%1]'.arg(docId)
-                    subText: contents.uri || '[uri:%1]'.arg(docId)
+                    text: title
+                    subText: uri
                     // iconSource: contents.uri + "/favicon.ico"
                     fallbackIconName: "favorite-unselected,text-html"
                     iconFrame: false
@@ -147,7 +147,7 @@
                     ListElement { label: 'Ubuntu'; expression: "[ 'uri' ]"; query: "[ 'http://www.ubuntu*' ]" }
                     ListElement { label: 'Search'; expression: "[ 'meta.title' ]"; query: "[ 'Search*' ]" }
                     ListElement { label: 'Engine'; expression: "[ 'meta.tags' ]"; query: "[ 'engine' ]" }
-                    ListElement { label: 'All'; expression: "[ 'meta.visits', 'meta.title' ]"; query: "[ '*', '*' ]" }
+                    ListElement { label: 'All'; expression: "[ 'meta.visits', 'meta.title', 'uri' ]"; query: "[ '*', '*', '*' ]" }
                 }
                 delegate: OptionSelectorDelegate {
                     text: i18n.tr(label)
@@ -156,8 +156,11 @@
                 onSelectedIndexChanged: {
                     var d = model.get(selectedIndex)
                     text = '%1 - %2'.arg(d.expression).arg(d.query)
+                    bookmarksList.model = null
                     allBookmarks.index.expression = eval(d.expression)
                     allBookmarks.query = eval(d.query)
+                    // Force update of delegates and role names
+                    bookmarksList.model = allBookmarks
                 }
             }
         }

=== added directory 'examples/movies'
=== added file 'examples/movies/movies.qml'
--- examples/movies/movies.qml	1970-01-01 00:00:00 +0000
+++ examples/movies/movies.qml	2014-11-12 17:08:18 +0000
@@ -0,0 +1,196 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * Authors:
+ *  Christian Dywan <[e-mail]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import U1db 1.0 as U1db
+import Ubuntu.Components 1.1
+import Ubuntu.Components.ListItems 0.1 as ListItem
+import Ubuntu.Components.Popups 0.1
+
+MainView {
+    id: root
+    applicationName: "com.ubuntu.developer.foobar.movies"
+
+    width: units.gu(45)
+    height: units.gu(80)
+
+    /*
+        Movie database
+    */
+
+    U1db.Database {
+        id: db
+        // path: "movies.db"
+    }
+
+    // Defaults taken from http://archive.blender.org/features-gallery/movies/index.html
+
+    U1db.Document {
+        database: db
+        docId: 'yBigBuckBunny'
+        create: true
+        defaults: {
+            'title': 'Big Buck Bunny (Short film)',
+            producer: 'Blender Foundation',
+            year: 2008, duration: '10min', website: 'https://www.bigbugckbunny.org'
+        }
+    }
+
+    U1db.Document {
+        database: db
+        docId: 'zElephantsDream'
+        create: true
+        defaults: {
+            'title': 'Elephants Dream (Short film)',
+            producer: 'Blender Foundation',
+            year: 2006, duration: '10min', website: 'https://www.elephantsdream.org'
+        }
+    }
+
+    U1db.Document {
+        database: db
+        docId: 'cProjectLondon'
+        create: true
+        defaults: {
+            'title': 'Project London Trailer',
+            producer: 'Independent',
+            year: 2009, duration: '22sec', website: 'https://www.projectlondonmovie.com'
+        }
+    }
+
+    U1db.Document {
+        database: db
+        docId: 'aSoftBoy'
+        create: true
+        defaults: {
+            'title': 'Soft Boy (Animation)',
+            producer: 'Andy Goralczyk',
+            year: 2005, duration: '17sec'
+        }
+    }
+
+    U1db.Document {
+        database: db
+        docId: 'bEsign'
+        create: true
+        defaults: {
+            'title': 'Esign (Animation)',
+            producer: 'Chris Larkee',
+            year: 2005, duration: '4min'
+        }
+    }
+
+    U1db.Query {
+        id: allMovies
+        index: blacklist
+        query: [ { year: '*', producer: '*', duration: '*', title: '*' } ]
+    }
+
+    U1db.Index {
+        id: blacklist
+        database: db
+        expression: [ 'year', 'duration', 'title', 'producer' ]
+    }
+
+    SortFilterModel {
+        id: sortedMovies
+        model: allMovies
+        filter.pattern: RegExp(searchProducer.text)
+        filter.property: 'producer'
+        sort.property: sortBy.role
+        sort.order: Qt.DescendingOrder
+    }
+
+    /*
+        UI: list view, filters
+    */
+
+    Page {
+        id: page
+        title: i18n.tr('Movies')
+
+        Column {
+            id: container
+            anchors.margins: units.gu(1)
+            anchors.fill: parent
+
+            ListView {
+                id: movieList
+                width: parent.width
+                height: parent.height - pillar.height
+                model: sortedMovies
+                delegate: ListItem.Subtitled {
+                    text: '<b>%1</b> %2'.arg(title).arg(year)
+                    subText: '%1 <b>%2</b>'.arg(duration).arg(producer)
+                    fallbackIconName: "favorite-unselected,text-html"
+                    iconFrame: false
+                }
+            }
+
+            Column {
+                id: pillar
+                spacing: units.gu(1)
+                width: parent.width
+
+                Label {
+                    text: sortBy.role
+                }
+
+                OptionSelector {
+                    id: sortBy
+                    StateSaver.properties: 'selectedIndex'
+                    model: ListModel {
+                        ListElement { label: 'Title'; role: 'title' }
+                        ListElement { label: 'Year'; role: 'year' }
+                        ListElement { label: 'Length'; role: 'duration' }
+                    }
+                    delegate: OptionSelectorDelegate {
+                        text: i18n.tr(label)
+                    }
+                    property string role: 'title'
+                    onDelegateClicked: {
+                        var selectedIndex = index
+                        role = model.get(selectedIndex).role
+                        // Work-around for sort.property not correctly re-sorting
+                        var m = movieList.model
+                        movieList.model = null
+                        movieList.model = m
+                    }
+                }
+
+                TextField {
+                    id: searchProducer
+                    StateSaver.properties: 'text'
+                    placeholderText: i18n.tr('Search Producer…')
+                }
+
+                OptionSelector {
+                    id: selectYear
+                    StateSaver.properties: 'selectedIndex'
+                    model: [ '*', 2005, 2006, 2007, 2008, 2009 ]
+                    delegate: OptionSelectorDelegate {
+                        text: modelData == '*' ? 'All Years' : modelData
+                    }
+                    property var year: model[selectedIndex]
+                }
+            }
+        }
+    }
+}
+

=== modified file 'src/query.cpp'
--- src/query.cpp	2014-03-13 19:31:58 +0000
+++ src/query.cpp	2014-11-12 17:08:18 +0000
@@ -17,7 +17,6 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#include <QDebug>
 #include <QSqlQuery>
 #include <QFile>
 #include <QSqlError>
@@ -64,7 +63,11 @@
         return m_results.at(index.row());
     if (role == 1) // docId
         return m_documents.at(index.row());
-    return QVariant();
+
+    int indexForRole = role - 2;
+    QVariantMap result(m_results.at(index.row()).toMap());
+    QString field(m_index->getExpression().at(indexForRole).split(".").last());
+    return result.value(field);
 }
 
 /*!
@@ -79,6 +82,13 @@
     QHash<int, QByteArray> roles;
     roles.insert(0, "contents");
     roles.insert(1, "docId");
+    if (!m_index)
+        return roles;
+
+    // A role name for each field in the index
+    uint fieldRole = 2;
+    Q_FOREACH(QString field, m_index->getExpression())
+        roles.insert(fieldRole++, field.split(".").last().toUtf8());
     return roles;
 }
 

=== modified file 'tests/test-database.cpp'
--- tests/test-database.cpp	2014-11-07 14:30:31 +0000
+++ tests/test-database.cpp	2014-11-12 17:08:18 +0000
@@ -82,6 +82,21 @@
         query.setQuery(QStringList() << "2014*" << "basketball" << "linux");
     }
 
+    void testRoleNames()
+    {
+        Database db;
+        Index index;
+        index.setDatabase(&db);
+        index.setExpression(QStringList() << "species" << "traits.spots");
+        Query query;
+        query.setIndex(&index);
+        QStringList expected(QStringList() << "docId" << "contents" << "species" << "spots");
+        Q_FOREACH(QString roleName, expected)
+            QVERIFY2(query.roleNames().values().contains(roleName.toUtf8()),
+                qPrintable(QString("Expected role name \"%1\" not in Query").arg(roleName)));
+        QVERIFY(db.lastError().isEmpty());
+    }
+
     void cleanupTestCase()
     {
     }

=== modified file 'tests/tst_query.qml'
--- tests/tst_query.qml	2014-03-13 19:31:58 +0000
+++ tests/tst_query.qml	2014-11-12 17:08:18 +0000
@@ -20,6 +20,8 @@
 import QtQuick 2.0
 import QtTest 1.0
 import U1db 1.0 as U1db
+import Ubuntu.Components 1.1
+import Ubuntu.Test 0.1
 
 Item {
     width: 200; height: 200
@@ -241,13 +243,79 @@
         signalName: "documentsChanged"
     }
 
-TestCase {
+    U1db.Database {
+        id: animals
+    }
+
+    // Note: docId's intentionally chosen for wrong alphabetic order
+    U1db.Document {
+        database: animals
+        docId: 'k_cow'
+        contents: { 'species': 'cow', 'traits': [ { 'spots': true } ] }
+    }
+    U1db.Document {
+        database: animals
+        docId: 'z_ant'
+        contents: { 'species': 'ant' }
+    }
+
+    U1db.Document {
+        database: animals
+        docId: 'a_bee'
+        contents: { 'species': 'bee' }
+    }
+
+    U1db.Document {
+        database: animals
+        docId: 'n_cat'
+        contents: { 'species': 'cat' }
+    }
+    U1db.Index {
+        id: bySpecies
+        database: animals
+        name: 'by-species'
+        expression: [ 'species' ]
+    }
+
+    U1db.Query {
+        id: allAnimals
+        index: bySpecies
+        query: [{ 'species': '*' }]
+    }
+
+    // To double-check failures aren't due to SortFilterModel itself
+    ListModel {
+        id: fakeAnimals
+        ListElement { species: 'cow'; docId: 'k_cow' }
+        ListElement { species: 'ant'; docId: 'z_ant' }
+        ListElement { species: 'bee'; docId: 'a_bee' }
+        ListElement { species: 'cat'; docId: 'n_cat' }
+    }
+
+    SortFilterModel {
+        id: mixedAnimals
+        model: allAnimals
+    }
+
+    SortFilterModel {
+        id: sortedAnimals
+        sort.property: 'species'
+        sort.order: Qt.AscendingOrder
+    }
+
+    SortFilterModel {
+        id: filteredAnimals
+        filter.property: 'species'
+        filter.pattern: /ant/
+    }
+
+UbuntuTestCase {
     name: "U1dbDatabase"
     when: windowShown
 
     function prettyJson(j) {
         var A = JSON.stringify(j)
-        if (A['0'] && A != '{}') {
+        if (A != undefined && A['0'] && A != '{}') {
             var A = '['
             for(var i in j)
                 A += JSON.stringify(j[i]) + ','
@@ -260,6 +328,8 @@
         compare(a, b, msg, true)
     }
 
+    TestUtil { id: util }
+
     function compare(a, b, msg, willFail) {
         /* Override built-in compare to:
            Match different JSON for identical values (number hash versus list)
@@ -273,7 +343,12 @@
                 console.log('Expected failure: %1%2 != %3'.arg(msg ? msg + ': ' : '').arg(A).arg(B))
                 return
             }
-            fail('%5%1 != %2 (%3 != %4)'.arg(A).arg(B).arg(JSON.stringify(a)).arg(JSON.stringify(b)).arg(msg ? msg + ': ' : ''))
+            if (!qtest_results.compare (false,
+                msg ? msg : "Comparison failed",
+                A + " ~ " + JSON.stringify(a),
+                B + " ~ " + JSON.stringify(b),
+                util.callerFile(), util.callerLine()))
+                throw new Error("QtQuickTest::fail")
         }
         if (willFail)
             fail('Expected to fail, but passed: %5%1 != %2 (%3 != %4)'.arg(A).arg(B).arg(JSON.stringify(a)).arg(JSON.stringify(b)).arg(msg ? msg + ': ' : ''))
@@ -359,5 +434,45 @@
         compare(allHeroesWithType.documents, ['dino', 'gokaiger', 'ooo', 'wizard'], 'go')
         compare(allHeroesWithType.documents, allHeroesSeriesOnly.documents, 'roku')
     }
+
+    function test_7_sort_data () {
+        return [ { tag: 'Reference ListModel', model: fakeAnimals },
+                 { tag: 'U1db.Query', model: allAnimals } ]
+    }
+
+    function test_7_sort (data) {
+        // Sanity checks
+        compare(allAnimals.documents, ["a_bee", "k_cow", "n_cat", "z_ant"])
+        tryCompareFunction(function(){return mixedAnimals.get(0).docId}, "a_bee")
+
+        sortedAnimals.model = data.model
+        compare(sortedAnimals.count, 4, "number of animals")
+        sortedAnimals.sort.property = 'species'
+        compare(sortedAnimals.get(0).docId, "z_ant", "ants document sorted first")
+        compare(sortedAnimals.get(0).species, "ant", "ants species sorted first")
+
+        sortedAnimals.sort.order = Qt.DescendingOrder
+        compare(sortedAnimals.get(0).species, "cow", "cow sorted first descending")
+
+        sortedAnimals.sort.property = 'docId'
+        sortedAnimals.sort.order = Qt.AscendingOrder
+        compare(sortedAnimals.get(0).docId, "a_bee", "bee sorted first by docId")
+    }
+
+    function test_8_filter_data () {
+        return [ { tag: 'Reference ListModel', model: fakeAnimals },
+                 { tag: 'U1db.Query', model: allAnimals } ]
+    }
+
+    function test_8_filter (data) {
+        // Sanity checks
+        compare(allAnimals.documents, ["a_bee", "k_cow", "n_cat", "z_ant"])
+        tryCompareFunction(function(){return mixedAnimals.get(0).docId}, "a_bee")
+
+        filteredAnimals.model = data.model
+        compare(filteredAnimals.count, 1, "number of animals")
+        compare(filteredAnimals.get(0).species, "ant", "ants species role available")
+        compare(filteredAnimals.get(0).docId, "z_ant", "ants included in filter")
+    }
 } }