Merge lp:~kevin-wright-1/u1db-qt/document-april-6-i into lp:u1db-qt

[Kevin Wright]

"Added a 'revise' property to Document and accompanying functionality that provides the abilty to modify existing documents in the database (if the docId already exists).

"Added a 'revise' property to Document and accompanying functionality that provides the ability to modify existing documents in the database (if the docId already exists).

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:64
http://91.189.93.125:8080/job/u1db-qt-ci/21/
Executed test runs:
    SUCCESS: http://91.189.93.125:8080/job/u1db-qt-quantal-amd64-ci/21
    SUCCESS: http://91.189.93.125:8080/job/u1db-qt-raring-amd64-ci/21

Click here to trigger a rebuild:
http://91.189.93.125:8080/job/u1db-qt-ci/21/rebuild

review: Approve (continuous-integration)

[Cris Dywan (kalikiana)]

I'm unsure of the 'revise' functionality, it looks to do mostly what I *intended* 'create' for, *maybe* hinting at a bug in existing code. I'll prefer to discuss this in detail before making a decision.

review: Needs Information

Unmerged revisions

64. By Kevin Wright on 2013-04-06

Added a 'revise' property to Document and accompanying functionality that provides the abilty to modify existing documents in the database (if the docId already exists).

=== modified file 'database.cpp'
--- database.cpp	2013-04-03 15:36:45 +0000
+++ database.cpp	2013-04-06 04:32:22 +0000
@@ -317,6 +317,7 @@
         query.bindValue(":docRev", newRev);
         // Parse Variant from QML as JsonDocument, fallback to string
         QString json(QJsonDocument::fromVariant(newDoc).toJson());
+
         query.bindValue(":docJson", json.isEmpty() ? newDoc : json);
         if (!query.exec())
             return setError(QString("Failed to put/ update document %1: %2\n%3").arg(docId).arg(query.lastError().text()).arg(query.lastQuery())) ? -1 : -1;
@@ -348,6 +349,11 @@
     beginInsertRows(QModelIndex(), rowCount(), 0);
     endInsertRows();
     */
+
+    QList<QString> documents = listDocs();
+
+    documentCount = documents.count();
+
     Q_EMIT docChanged(docId, newDoc);
 
     return newRev;

=== modified file 'database.h'
--- database.h	2013-03-20 17:10:45 +0000
+++ database.h	2013-04-06 04:32:22 +0000
@@ -37,6 +37,8 @@
     Database(QObject* parent = 0);
     ~Database() { }
 
+    int documentCount = 0;
+
     // QAbstractListModel
     QVariant data(const QModelIndex & index, int role = Qt::DisplayRole) const;
     QHash<int, QByteArray>roleNames() const;
@@ -57,6 +59,7 @@
     void errorChanged(const QString& error);
     void docChanged(const QString& docId, QVariant content);
     void docLoaded(const QString& docId, QVariant content) const;
+    void documentsAvailable();
 private:
     Q_DISABLE_COPY(Database)
     QString m_path;

=== modified file 'document.cpp'
--- document.cpp	2013-04-03 15:36:45 +0000
+++ document.cpp	2013-04-06 04:32:22 +0000
@@ -145,7 +145,36 @@
     Q_EMIT createChanged(create);
 
     if (m_create && m_database && m_defaults.isValid() && !m_database->getDocUnchecked(m_docId).isValid())
-        m_database->putDoc(m_defaults, m_docId);
+    {
+        m_database->putDoc(m_defaults, m_docId);
+    }
+
+}
+
+bool
+Document::getRevise()
+{
+    return m_revise;
+}
+
+/*!
+    If revise is true, docId is not empty and no document with the same docId
+    exists, defaults will be used to store the document.
+ */
+void
+Document::setRevise(bool revise)
+{
+    if (m_revise == revise)
+        return;
+
+    m_revise = revise;
+    Q_EMIT reviseChanged(revise);
+
+    if (m_revise && m_database && m_defaults.isValid() && m_database->getDocUnchecked(m_docId).isValid())
+    {
+        m_database->putDoc(m_defaults, m_docId);
+    }
+
 }
 
 QVariant
@@ -167,10 +196,17 @@
         return;
 
     m_defaults = defaults;
+
     Q_EMIT defaultsChanged(defaults);
 
     if (m_create && m_database && m_defaults.isValid() && !m_database->getDocUnchecked(m_docId).isValid())
-        m_database->putDoc(m_defaults, m_docId);
+    {
+        m_database->putDoc(m_defaults, m_docId);
+    }
+    else if (m_revise && m_database && m_defaults.isValid() && m_database->getDocUnchecked(m_docId).isValid())
+    {
+        m_database->putDoc(m_defaults, m_docId);
+    }
 }
 
 /*!

=== modified file 'document.h'
--- document.h	2013-04-03 15:36:45 +0000
+++ document.h	2013-04-06 04:32:22 +0000
@@ -37,6 +37,7 @@
 #endif
     Q_PROPERTY(QString docId READ getDocId WRITE setDocId NOTIFY docIdChanged)
     Q_PROPERTY(bool create READ getCreate WRITE setCreate NOTIFY createChanged)
+    Q_PROPERTY(bool revise READ getRevise WRITE setRevise NOTIFY reviseChanged)
     Q_PROPERTY(QVariant defaults READ getDefaults WRITE setDefaults NOTIFY defaultsChanged)
     Q_PROPERTY(QVariant contents READ getContents WRITE setContents NOTIFY contentsChanged)
 public:
@@ -48,7 +49,9 @@
     QString getDocId();
     void setDocId(const QString& docId);
     bool getCreate();
+    bool getRevise();
     void setCreate(bool create);
+    void setRevise(bool revise);
     QVariant getDefaults();
     void setDefaults(QVariant defaults);
     QVariant getContents();
@@ -57,6 +60,7 @@
     void databaseChanged(Database* database);
     void docIdChanged(const QString& docId);
     void createChanged(bool create);
+    void reviseChanged(bool revise);
     void defaultsChanged(QVariant defaults);
     void contentsChanged(QVariant contents);
 private:
@@ -64,6 +68,7 @@
     Database* m_database;
     QString m_docId;
     bool m_create;
+    bool m_revise;
     QVariant m_defaults;
     QVariant m_contents;
 

=== modified file 'index.cpp'
--- index.cpp	2013-04-03 15:36:45 +0000
+++ index.cpp	2013-04-06 04:32:22 +0000
@@ -32,7 +32,6 @@
 
 /*!
     \class Index
-    \inmodule U1db
 
     \brief The Index class defines an index to be stored in the database and
     queried using Query. Changes in documents affected by the index also update
@@ -89,6 +88,7 @@
         QObject::connect(m_database, &Database::docChanged, this, &Index::onDocChanged);
         Q_EMIT dataInvalidated();
     }
+
 }
 
 QString
@@ -126,10 +126,14 @@
 /*!
     Sets the expression used. Both an expression and a name must be specified
     for an index to be created.
+
+    Also starts the process of creating the Index result list, which can then be queried or populate the Query model as is.
+
  */
 void
 Index::setExpression(QStringList expression)
 {
+
     if (m_expression == expression)
         return;
 
@@ -140,7 +144,159 @@
     }
 
     m_expression = expression;
+
     Q_EMIT expressionChanged(expression);
+    Q_EMIT dataIndexed();
+}
+
+/*!
+ * \brief Index::generateIndexResults
+ *
+ * Iterates through the documents stored in the database and creates the list of results based on the Index expressions.
+ */
+
+void Index::generateIndexResults()
+{
+
+    Database *db(getDatabase());
+
+    if(db){
+
+        QList<QString> documents = db->listDocs();
+
+        Q_FOREACH (QString docId, documents){
+
+            QVariant document = db->getDocUnchecked(docId);
+
+            QStringList fieldsList;
+
+            appendResultsFromMap(fieldsList, document.toMap(),"");
+
+        }
+
+    }
+
+}
+
+void Index::clearResults()
+{
+    m_results.clear();
+}
+
+
+/*!
+ * \brief Index::getAllResults
+ * \return
+ */
+
+QList<QVariantMap> Index::getAllResults(){
+    return m_results;
+}
+
+/*!
+ * \brief Index::getResult
+ * \param index
+ * \return
+ */
+QVariantMap Index::getResult(int index){
+    return m_results[index];
+}
+
+/*!
+ * \brief Index::appendResultsFromMap
+ * \param fieldsList
+ * \param current_section
+ * \param current_field
+ * \return
+ *
+ *This method is desinged to recursively iterate through a document, or section of a document, which represents a QVariantMap. As it iterates through the entire document, the method keeps track of the current index expression, and populates a local QVariantMap should the current expression be found in the Index's list of expressions.
+ *
+ *If that QVariantMap contains more than one entry it is added to the global results, which can then be utilized by a Query. This needs to be modified to ensure all expressions are found, whereas at the moment if more than one expressions are defined and any of them are found then the map is added to the results list.
+ *
+ */
+QStringList Index::appendResultsFromMap(QStringList fieldsList, QVariantMap current_section, QString current_field)
+{
+
+    QMapIterator<QString, QVariant> i(current_section);
+
+    QString original_field = current_field;
+
+    QVariantMap results_map;
+
+    while (i.hasNext()) {
+
+        i.next();
+
+        if(fieldsList.count()>0){
+            current_field = original_field + "." + i.key();
+        }
+        else{
+            current_field = i.key();
+        }
+
+        fieldsList.append(current_field);
+
+        QVariant value = i.value();
+
+        if(value.userType()==8) // QVariantMap
+        {
+            fieldsList = appendResultsFromMap(fieldsList, value.toMap(),current_field);
+        }
+        else if(value.userType()==9) // QVariantList
+        {
+            fieldsList = getFieldsFromList(fieldsList, value.toList(),current_field);
+        }
+        else
+        {
+            if(m_expression.contains(current_field)==true){
+                results_map.insert(i.key(),value);
+            }
+
+        }
+    }
+
+    if(results_map.count()>0){
+       m_results.append(results_map);
+    }
+
+    return fieldsList;
+}
+/*!
+ * \brief Index::getFieldsFromList
+ * \param fieldsList
+ * \param current_section
+ * \param current_field
+ * \return
+ *
+ *This recursive method is used in conjuntion with Index::appendResultsFromMap, to aid in iterating through a document when an embedded list is found.
+ *
+ */
+
+
+QStringList Index::getFieldsFromList(QStringList fieldsList, QVariantList current_section, QString current_field)
+{
+
+    QListIterator<QVariant> i(current_section);
+
+    while (i.hasNext()) {
+
+        QVariant value = i.next();
+
+        if(value.userType()==8) // QVariantMap
+        {
+            fieldsList = appendResultsFromMap(fieldsList, value.toMap(),current_field);
+        }
+        else if(value.userType()==9) // QVariantList
+        {
+            fieldsList = getFieldsFromList(fieldsList, value.toList(),current_field);
+        }
+        else
+        {
+
+        }
+    }
+
+    return fieldsList;
 }
 
 QT_END_NAMESPACE_U1DB

=== modified file 'index.h'
--- index.h	2013-04-03 15:36:45 +0000
+++ index.h	2013-04-06 04:32:22 +0000
@@ -47,17 +47,26 @@
     void setName(const QString& name);
     QStringList getExpression();
     void setExpression(QStringList expression);
+    void generateIndexResults();
+    QStringList appendResultsFromMap(QStringList fieldsList, QVariantMap current_section, QString current_field);
+    QStringList getFieldsFromList(QStringList fieldsList, QVariantList current_section, QString current_field);
+    void clearResults();
+    QVariantMap getResult(int index);
+    QList<QVariantMap> getAllResults();
+
 Q_SIGNALS:
     void databaseChanged(Database* database);
     void nameChanged(const QString& name);
     void expressionChanged(QVariant expression);
     // Either of the above has changed:
     void dataInvalidated();
+    void dataIndexed();
 private:
     Q_DISABLE_COPY(Index)
     Database* m_database;
     QString m_name;
     QStringList m_expression;
+    QList<QVariantMap> m_results;
 
     void onPathChanged(const QString& path);
     void onDocChanged(const QString& docId, QVariant content);

=== modified file 'query.cpp'
--- query.cpp	2013-04-03 15:36:45 +0000
+++ query.cpp	2013-04-06 04:32:22 +0000
@@ -47,27 +47,28 @@
 }
 
 /*!
-    Used to implement QAbstractListModel
-    Implements the variables exposed to the Delegate in a model
-    QVariant contents
-    QString docId
-    int index (built-in)
+ * \brief Query::data
+ * \param index
+ * \param role
+ * \return
+ *Used to implement QAbstractListModel
+ *Implements the variables exposed to the Delegate in a model
  */
 QVariant
 Query::data(const QModelIndex & index, int role) const
 {
-    QString docId(m_hash.value(index.row()));
+    QVariantMap result(m_hash.value(index.row()));
+
     if (role == 0) // contents
     {
         Database* db(m_index->getDatabase());
         if (db)
         {
-            qDebug() << "Query::getData" << docId;
-            return db->getDocUnchecked(docId);
+            return result;
         }
     }
     if (role == 1) // docId
-        return docId;
+        //return docId;
     return QVariant();
 }
 
@@ -105,10 +106,25 @@
 Query::onDataInvalidated()
 {
     m_hash.clear();
-    Database* db(m_index->getDatabase());
-    if (db)
-        ;
-    // TODO
+
+    Database *db = m_index->getDatabase();
+    if(db){
+        if(db->documentCount>0){
+            QObject::connect(db, &Database::documentsAvailable, this, &Query::onDataInvalidated);
+        }
+    }
+
+    m_index->clearResults();
+
+    m_index->generateIndexResults();
+
+    QListIterator<QVariantMap> i(m_index->getAllResults());
+
+    while (i.hasNext()) {
+        QVariantMap result = i.next();
+        m_hash.insert(m_hash.count(),result);
+    }
+
 }
 
 /*!
@@ -124,10 +140,15 @@
     if (m_index)
         QObject::disconnect(m_index, 0, this, 0);
     m_index = index;
-    if (m_index)
+    if (m_index){
         QObject::connect(m_index, &Index::dataInvalidated, this, &Query::onDataInvalidated);
+        QObject::connect(m_index, &Index::dataIndexed, this, &Query::onDataInvalidated);
+    }
     Q_EMIT indexChanged(index);
+
+
     onDataInvalidated();
+
 }
 
 QVariant

=== modified file 'query.h'
--- query.h	2013-04-03 15:36:45 +0000
+++ query.h	2013-04-06 04:32:22 +0000
@@ -58,7 +58,7 @@
 private:
     Q_DISABLE_COPY(Query)
     Index* m_index;
-    QHash<int, QString> m_hash;
+    QHash<int, QVariantMap> m_hash;
     QVariant m_query;
     QVariant m_range;