Merge lp:~uonedb-qt/u1db-qt/apiFile into lp:u1db-qt

[Cris Dywan]

Verify and ship QML API description

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:132
http://jenkins.qa.ubuntu.com/job/u1db-qt-ci/70/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-vivid-amd64-ci/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/u1db-qt-vivid-armhf-ci/17/console

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

review: Needs Fixing (continuous-integration)

[Zoltan Balogh (bzoltan)]

I wonder if we want to change the ubuntu-ui-toolkit-tools to a more generic name

review: Needs Information

[Zoltan Balogh (bzoltan)]

Inline comments.

review: Needs Fixing

[Cris Dywan (kalikiana)]

> I wonder if we want to change the ubuntu-ui-toolkit-tools
> to a more generic name

Note that *this* branch is merely using apicheck with U1db. Your feedback would make more sense on https://code.launchpad.net/~ubuntu-sdk-team/ubuntu-ui-toolkit/firstClassApiCheck/+merge/287004 where -tools package providing apicheck lives.

Unmerged revisions

132. By Cris Dywan on 2016-03-01

Verify and ship QML API description

=== modified file 'debian/control'
--- debian/control	2014-01-22 13:14:22 +0000
+++ debian/control	2016-03-01 13:02:26 +0000
@@ -14,6 +14,7 @@
                qtdeclarative5-qtquick2-plugin,
                qtdeclarative5-test-plugin,
                qttools5-dev-tools,
+               ubuntu-ui-toolkit-tools,
                ubuntu-ui-toolkit-doc,
                xvfb,
                libgl1-mesa-dri,
 
=== added file 'debian/libu1db-qt5-api.install'
--- debian/libu1db-qt5-api.install	1970-01-01 00:00:00 +0000
+++ debian/libu1db-qt5-api.install	2016-03-01 13:02:26 +0000
@@ -0,0 +1,1 @@
+usr/share/click/api/qml/*
 
=== modified file 'modules/U1db/CMakeLists.txt'
--- modules/U1db/CMakeLists.txt	2013-08-08 10:11:39 +0000
+++ modules/U1db/CMakeLists.txt	2016-03-01 13:02:26 +0000
@@ -57,3 +57,14 @@
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/plugins.qmltypes
     DESTINATION ${QT_IMPORTS_DIR}/U1db
     )
+
+add_custom_command(OUTPUT U1db.api
+    COMMAND "ubuntu-ui-toolkit-apicheck" "U1db" "${CMAKE_CURRENT_SOURCE_DIR}/U1db.api" ">" "${CMAKE_CURRENT_BINARY_DIR}/U1db.api.new"
+    WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
+    DEPENDS U1DBPlugin
+    )
+add_custom_target(api "ALL" DEPENDS U1db.api)
+install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/U1db.api
+    DESTINATION ${CMAKE_INSTALL_PREFIX}/share/click/api/qml
+    )
+
 
=== added file 'modules/U1db/U1db.api'
--- modules/U1db/U1db.api	1970-01-01 00:00:00 +0000
+++ modules/U1db/U1db.api	2016-03-01 13:02:26 +0000
@@ -0,0 +1,56 @@
+U1db.Database 1.0 U1db::Database: QAbstractListModel
+    readonly property string error
+    signal pathChanged(string path)
+    signal errorChanged(string error)
+    signal docChanged(string docId, var content)
+    signal docLoaded(string docId, var content)
+    function var getDoc(string docId)
+    function string putDoc(var newDoc, string docID)
+    function string putDoc(var newDoc)
+    function deleteDoc(string docID)
+    function list<string> listDocs()
+    function string lastError()
+    function string putIndex(string index_name, QStringList expressions)
+    function QStringList getIndexExpressions(string indexName)
+    function QStringList getIndexKeys(string indexName)
+    property string path
+U1db.Document 1.0 U1db::Document: QtObject
+    property var contents
+    property bool create
+    property U1db.Database database
+    property var defaults
+    property string docId
+    signal databaseChanged(Database database)
+    signal docIdChanged(string docId)
+    signal createChanged(bool create)
+    signal defaultsChanged(var defaults)
+    signal contentsChanged(var contents)
+U1db.Index 1.0 U1db::Index: QtObject
+    property U1db.Database database
+    property QStringList expression
+    signal databaseChanged(Database database)
+    signal nameChanged(string name)
+    signal expressionChanged(var expression)
+    signal dataInvalidated()
+    property string name
+U1db.Query 1.0 U1db::Query: QAbstractListModel
+    readonly property QStringList documents
+    property U1db.Index index
+    signal indexChanged(Index index)
+    signal queryChanged(var query)
+    signal documentsChanged(QStringList documents)
+    signal resultsChanged(QVariantList results)
+    property var query
+    readonly property QVariantList results
+U1db.Synchronizer 1.0 U1db::Synchronizer: QAbstractListModel
+    signal sourceChanged(Database source)
+    signal targetsChanged(var targets)
+    signal syncChanged(bool synchronize)
+    signal resolveToSourceChanged(bool resolve_to_source)
+    signal syncOutputChanged(QVariantList sync_output)
+    signal syncCompleted()
+    property bool resolve_to_source
+    property U1db.Database source
+    readonly property QVariantList sync_output
+    property bool synchronize
+    property var targets