Merge lp:~zsombi/ubuntu-ui-toolkit/stateSaverWithRepeater into lp:ubuntu-ui-toolkit

[Zsombor Egri]

StateSaver failure with Repeater fixed. Indirectly fixes StateSaver with ListView and GridView.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:915
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-ci/1571/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2249
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2134/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-ci/519
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/519
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-ci/519/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/1972
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2251
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2251/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2134
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2134/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/4593/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/2992

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-ui-toolkit-ci/1571/rebuild

review: Needs Fixing (continuous-integration)

[Florian Boucault (fboucault)]

Seems good to me.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-autolanding/558/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2257/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2142
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-amd64-autolanding/161
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-autolanding/161
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-ui-toolkit-trusty-armhf-autolanding/161/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/1980/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2259
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2259/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2142
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2142/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/4602
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3005

review: Needs Fixing (continuous-integration)

[Francis Ginther (fginther)]

The autopilot-testrunner-otto-trusty job failed due to a transient problem with lxc.

[Francis Ginther (fginther)]

> The autopilot-testrunner-otto-trusty job failed due to a transient problem
> with lxc.

This MP should be re-approved to retry the build.

review: Approve

[Francis Ginther (fginther)]

> The autopilot-testrunner-otto-trusty job failed due to a transient problem
> with lxc.

This MP should be re-approved to retry the build.

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'modules/Ubuntu/Components/plugin/ucstatesaver.cpp'
--- modules/Ubuntu/Components/plugin/ucstatesaver.cpp	2013-11-19 17:26:04 +0000
+++ modules/Ubuntu/Components/plugin/ucstatesaver.cpp	2014-01-10 16:16:30 +0000
@@ -86,13 +86,20 @@
 
 QString UCStateSaverAttachedPrivate::absoluteId(const QString &id)
 {
-    QQmlContextData *cdata = QQmlContextData::get(qmlContext(m_attachee));
+    QQmlContext *attacheeContext = qmlContext(m_attachee);
+    QQmlContextData *cdata = QQmlContextData::get(attacheeContext);
     QQmlData *ddata = QQmlData::get(m_attachee);
     QString path = cdata->url.path().replace('/', '_') + ':'
             + QString::number(ddata->lineNumber) + ':'
             + QString::number(ddata->columnNumber) + ':' + id;
     QObject *parent = m_attachee->parent();
 
+    // check whether we have an "index" context property defined
+    QVariant indexValue = attacheeContext->contextProperty("index");
+    if (indexValue.isValid() && (indexValue.type() == QVariant::Int)) {
+        path += indexValue.toString();
+    }
+
     while (parent) {
         QString parentId = qmlContext(parent)->nameForObject(parent);
         QString className = QuickUtils::instance().className(parent);
@@ -233,6 +240,29 @@
  * }
  * \endqml
  *
+ * When used with Repeater, each created item from the Repeater's delegate will
+ * be saved separately. Note that due to the way Repeater works, Repeaters do not
+ * need to have id specified.
+ *
+ * \qml
+ * Item {
+ *     id: root
+ *     // [...]
+ *     Repeater {
+ *         model: 10
+ *         Rectangle {
+ *             id: rect
+ *             width: 50; height: 50
+ *             StateSaver.properties: "width, height"
+ *         }
+ *     }
+ *     // [...]
+ * }
+ * \endqml
+ *
+ * It can be used in the same way in ListView or GridView, except that both ListView
+ * and GridView must have an id set.
+ *
  * The StateSaver can save all \l{http://qt-project.org/doc/qt-5.0/qtqml/qtqml-typesystem-basictypes.html}{QML base types},
  * Objects, list of objects or variants containing any of these cannot be saved.
  */

=== added file 'tests/unit_x11/tst_statesaver/GridViewItems.qml'
--- tests/unit_x11/tst_statesaver/GridViewItems.qml	1970-01-01 00:00:00 +0000
+++ tests/unit_x11/tst_statesaver/GridViewItems.qml	2014-01-10 16:16:30 +0000
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * 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 Ubuntu.Components 0.1
+
+Item {
+    id: root
+    width: 100
+    height: 100
+
+    GridView {
+        id: listView
+        objectName: "grid"
+        anchors.fill: parent
+        model: 2
+        delegate: Rectangle {
+            id: listItem
+            objectName: "testItem"
+            width: 20
+            height: 20
+            StateSaver.properties: "height"
+        }
+    }
+}

=== added file 'tests/unit_x11/tst_statesaver/ListViewItems.qml'
--- tests/unit_x11/tst_statesaver/ListViewItems.qml	1970-01-01 00:00:00 +0000
+++ tests/unit_x11/tst_statesaver/ListViewItems.qml	2014-01-10 16:16:30 +0000
@@ -0,0 +1,38 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * 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 Ubuntu.Components 0.1
+
+Item {
+    id: root
+    width: 100
+    height: 100
+
+    ListView {
+        id: listView
+        objectName: "list"
+        anchors.fill: parent
+        model: 2
+        delegate: Rectangle {
+            id: listItem
+            objectName: "testItem"
+            width: parent.width
+            height: 20
+            StateSaver.properties: "height"
+        }
+    }
+}

=== added file 'tests/unit_x11/tst_statesaver/RepeaterStates.qml'
--- tests/unit_x11/tst_statesaver/RepeaterStates.qml	1970-01-01 00:00:00 +0000
+++ tests/unit_x11/tst_statesaver/RepeaterStates.qml	2014-01-10 16:16:30 +0000
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * 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 Ubuntu.Components 0.1
+
+Item {
+    id: root
+    width: 100
+    height: 100
+
+    Column {
+        id: column
+        objectName: "column"
+        Repeater {
+            id: repeater
+            model: 4
+            Rectangle {
+                id: rect
+                width: root.width
+                height: 20
+                objectName: "testItem"
+                StateSaver.properties: "height"
+            }
+        }
+    }
+}

=== modified file 'tests/unit_x11/tst_statesaver/tst_statesaver.cpp'
--- tests/unit_x11/tst_statesaver/tst_statesaver.cpp	2014-01-08 12:15:32 +0000
+++ tests/unit_x11/tst_statesaver/tst_statesaver.cpp	2014-01-10 16:16:30 +0000
@@ -28,6 +28,7 @@
 #include <QMatrix4x4>
 #include <QtQuick/QQuickItem>
 #include <QtQml/QQmlProperty>
+#include "quickutils.h"
 
 #define protected public
 #include "ucstatesaver.h"
@@ -435,6 +436,108 @@
         QVERIFY(testItem);
         delete view;
     }
+
+    void test_repeaterStates()
+    {
+        QScopedPointer<QQuickView> view(createView("RepeaterStates.qml"));
+        QVERIFY(view);
+        QQuickItem *column = view->rootObject()->findChild<QQuickItem*>("column");
+        QVERIFY(column);
+
+        QList<QQuickItem*> items = column->childItems();
+        QCOMPARE(items.count(), 5); // 4 Rectangles + 1 Repeater
+
+        Q_FOREACH(QQuickItem *item, items) {
+            if (QuickUtils::instance().className(item) == "QQuickRectangle") {
+                item->setHeight(25);
+            }
+        }
+        view.reset();
+
+        view.reset(createView("RepeaterStates.qml"));
+        QVERIFY(view);
+        column = view->rootObject()->findChild<QQuickItem*>("column");
+        QVERIFY(column);
+
+        items = column->childItems();
+        QCOMPARE(items.count(), 5); // 4 Rectangles + 1 Repeater
+
+        Q_FOREACH(QQuickItem *item, items) {
+            if (QuickUtils::instance().className(item) == "QQuickRectangle") {
+                QCOMPARE(item->height(), 25.0);
+            }
+        }
+    }
+
+    void test_ListViewItemStates()
+    {
+        QScopedPointer<QQuickView> view(createView("ListViewItems.qml"));
+        QVERIFY(view);
+        QQuickItem *list = view->rootObject()->findChild<QQuickItem*>("list");
+        QVERIFY(list);
+        QQuickItem *contentItem = list->property("contentItem").value<QQuickItem*>();
+        QVERIFY(contentItem);
+        QList<QQuickItem*> items = contentItem->childItems();
+
+        int testItemCount = 0;
+        Q_FOREACH(QQuickItem *item, items) {
+            if (item->objectName() == "testItem") {
+                item->setHeight(25);
+                testItemCount++;
+            }
+        }
+        QCOMPARE(testItemCount, 2);
+        view.reset();
+
+        view.reset(createView("ListViewItems.qml"));
+        QVERIFY(view);
+        list = view->rootObject()->findChild<QQuickItem*>("list");
+        QVERIFY(list);
+        contentItem = list->property("contentItem").value<QQuickItem*>();
+        QVERIFY(contentItem);
+        items = contentItem->childItems();
+
+        Q_FOREACH(QQuickItem *item, items) {
+            if (item->objectName() == "testItem") {
+                QCOMPARE(item->height(), 25.0);
+            }
+        }
+    }
+
+    void test_GridViewItemStates()
+    {
+        QScopedPointer<QQuickView> view(createView("GridViewItems.qml"));
+        QVERIFY(view);
+        QQuickItem *list = view->rootObject()->findChild<QQuickItem*>("grid");
+        QVERIFY(list);
+        QQuickItem *contentItem = list->property("contentItem").value<QQuickItem*>();
+        QVERIFY(contentItem);
+        QList<QQuickItem*> items = contentItem->childItems();
+
+        int testItemCount = 0;
+        Q_FOREACH(QQuickItem *item, items) {
+            if (item->objectName() == "testItem") {
+                item->setHeight(25);
+                testItemCount++;
+            }
+        }
+        QCOMPARE(testItemCount, 2);
+        view.reset();
+
+        view.reset(createView("GridViewItems.qml"));
+        QVERIFY(view);
+        list = view->rootObject()->findChild<QQuickItem*>("grid");
+        QVERIFY(list);
+        contentItem = list->property("contentItem").value<QQuickItem*>();
+        QVERIFY(contentItem);
+        items = contentItem->childItems();
+
+        Q_FOREACH(QQuickItem *item, items) {
+            if (item->objectName() == "testItem") {
+                QCOMPARE(item->height(), 25.0);
+            }
+        }
+    }
 };
 
 QTEST_MAIN(tst_StateSaverTest)

=== modified file 'tests/unit_x11/tst_statesaver/tst_statesaver.pro'
--- tests/unit_x11/tst_statesaver/tst_statesaver.pro	2014-01-08 10:22:46 +0000
+++ tests/unit_x11/tst_statesaver/tst_statesaver.pro	2014-01-10 16:16:30 +0000
@@ -22,4 +22,7 @@
     ComponentsWithStateSavers.qml \
     CustomControl.qml \
     ComponentsWithStateSaversNoId.qml \
-    NestedDynamics.qml
+    NestedDynamics.qml \
+    RepeaterStates.qml \
+    ListViewItems.qml \
+    GridViewItems.qml