Merge lp:~mterry/unity8/pull-to-refresh-scope into lp:unity8

[Michael Terry]

Add pull-to-refresh functionality to scopes.

Add pull-to-refresh functionality to scopes.

I used a PullToRefresh object, though it did require a manual style override to avoid the default ActivityIndicator it uses.

== Checklist ==

 * Are there any related MPs required for this MP to build/function as expected? Please list.
 No

 * Did you perform an exploratory manual test run of your code change and any related functionality?
 Yes

 * Did you make sure that your branch does not contain spurious tags?
 Yes

 * If you changed the packaging (debian), did you subscribe the ubuntu-unity team to this MP?
 NA

 * If you changed the UI, has there been a design review?
 TBD

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1288
http://jenkins.qa.ubuntu.com/job/unity8-ci/4419/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/5248
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-utopic/1415
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-amd64-ci/1513
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-i386-ci/1513
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/4975
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6500
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6500/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/13843

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/4419/rebuild

review: Needs Fixing (continuous-integration)

[lp:~mterry/unity8/pull-to-refresh-scope]

1289. By Michael Terry on 2014-09-30

Merge from trunk

[Albert Astals Cid (aacid)]

As agreed on IRC keep the code with a TODO to evaluate the use of the standard style, file the bug to the standard style to fix it and move the style code to a different file to clutter GSV less

review: Needs Fixing

[lp:~mterry/unity8/pull-to-refresh-scope]

1290. By Michael Terry on 2014-09-30

Break out our custom PullToRefreshStyle into its own file and add a comment about what's keeping us from using the standard version

[Michael Terry (mterry)]

Updated!

[Albert Astals Cid (aacid)]

As discussed on irc should delay a bit the refresh call until the header has gone back to its position

review: Needs Fixing

[lp:~mterry/unity8/pull-to-refresh-scope]

1291. By Michael Terry on 2014-09-30

Don't refresh until scope is back in place to avoid a scope-settling bug

[Michael Terry (mterry)]

(And fixed that header-position-refreshing issue now too)

[lp:~mterry/unity8/pull-to-refresh-scope]

1292. By Michael Terry on 2014-09-30

Use Item not Rectangle

1293. By Michael Terry on 2014-09-30

Update pot

[Albert Astals Cid (aacid)]

* Did you perform an exploratory manual test run of the code change and any related functionality?
Yes

 * Did CI run pass? If not, please explain why.
Waiting for top approval

 * Did you make sure that the branch does not contain spurious tags?
Yes

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1289
http://jenkins.qa.ubuntu.com/job/unity8-ci/4444/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/5322
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/unity-phablet-qmluitests-utopic/1440
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-amd64-ci/1538
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity8-utopic-i386-ci/1538
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/5036
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6574
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6574/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/13927

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity8-ci/4444/rebuild

review: Needs Fixing (continuous-integration)

[lp:~mterry/unity8/pull-to-refresh-scope]

1294. By Michael Terry on 2014-10-03

Update from trunk

=== modified file 'po/unity8.pot'
--- po/unity8.pot	2014-10-02 08:46:22 +0000
+++ po/unity8.pot	2014-10-03 12:14:11 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: unity8\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2014-10-02 10:35+0200\n"
+"POT-Creation-Date: 2014-10-03 08:13-0400\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -160,7 +160,7 @@
 msgid "OK"
 msgstr ""
 
-#: qml/Dash/GenericScopeView.qml:411 qml/Dash/GenericScopeView.qml:533
+#: qml/Dash/GenericScopeView.qml:411 qml/Dash/GenericScopeView.qml:568
 msgid "See less"
 msgstr ""
 
@@ -205,6 +205,14 @@
 msgid "Send"
 msgstr ""
 
+#: qml/Dash/PullToRefreshScopeStyle.qml:55
+msgid "Pull to refresh…"
+msgstr ""
+
+#: qml/Dash/PullToRefreshScopeStyle.qml:60
+msgid "Release to refresh…"
+msgstr ""
+
 #: qml/Dash/ScopesOverview.qml:206
 msgid "Manage Scopes"
 msgstr ""

=== modified file 'qml/Dash/GenericScopeView.qml'
--- qml/Dash/GenericScopeView.qml	2014-09-18 21:23:55 +0000
+++ qml/Dash/GenericScopeView.qml	2014-10-03 12:14:11 +0000
@@ -15,7 +15,7 @@
  */
 
 import QtQuick 2.0
-import Ubuntu.Components 0.1
+import Ubuntu.Components 1.1
 import Utils 0.1
 import Unity 0.2
 import Dash 0.1
@@ -496,6 +496,41 @@
         }
     }
 
+    Item {
+        id: pullToRefreshClippingItem
+        anchors.left: parent.left
+        anchors.right: parent.right
+        anchors.bottom: parent.bottom
+        height: parent.height - pullToRefresh.contentY + (pageHeaderLoader.item ? pageHeaderLoader.item.bottomItem[0].height - pageHeaderLoader.item.height : 0)
+        clip: true
+
+        PullToRefresh {
+            id: pullToRefresh
+            objectName: "pullToRefresh"
+            target: categoryView
+
+            readonly property real contentY: categoryView.contentY - categoryView.originY
+            y: -contentY - units.gu(5)
+
+            onRefresh: {
+                refreshing = true
+                scopeView.scope.refresh()
+            }
+            anchors.left: parent.left
+            anchors.right: parent.right
+
+            Connections {
+                target: scopeView
+                onProcessingChanged: if (!scopeView.processing) pullToRefresh.refreshing = false
+            }
+
+            style: PullToRefreshScopeStyle {
+                anchors.fill: parent
+                activationThreshold: units.gu(14)
+            }
+        }
+    }
+
     AbstractButton {
         id: floatingSeeLess
         objectName: "floatingSeeLess"

=== added file 'qml/Dash/PullToRefreshScopeStyle.qml'
--- qml/Dash/PullToRefreshScopeStyle.qml	1970-01-01 00:00:00 +0000
+++ qml/Dash/PullToRefreshScopeStyle.qml	2014-10-03 12:14:11 +0000
@@ -0,0 +1,82 @@
+/*
+ * Copyright (C) 2014 Canonical, Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.3
+import Ubuntu.Components 1.1
+import Ubuntu.Components.Styles 1.1
+
+/**
+ * TODO: Once the SDK version of PullToRefreshStyle doesn't have bug 1375799
+ * (https://launchpad.net/bugs/1375799) anymore, we should switch to using a
+ * a subclass of the Ambiance version with a hidden ActivityIndicator.
+ */
+PullToRefreshStyle {
+    releaseToRefresh: styledItem.target.originY - styledItem.target.contentY > activationThreshold
+
+    Connections {
+        property bool willRefresh: false
+
+        target: styledItem.target
+        onDraggingChanged: {
+            if (!styledItem.target.dragging && releaseToRefresh) {
+                willRefresh = true
+            }
+        }
+        onContentYChanged: {
+            if (styledItem.target.originY - styledItem.target.contentY == 0 && willRefresh) {
+                styledItem.refresh()
+                willRefresh = false
+            }
+        }
+    }
+
+    Label {
+        id: pullLabel
+        anchors.horizontalCenter: parent.horizontalCenter
+        horizontalAlignment: Text.AlignHCenter
+        verticalAlignment: Text.AlignVCenter
+        states: [
+            State {
+                name: "pulling"
+                when: styledItem.target.dragging && !releaseToRefresh
+                PropertyChanges { target: pullLabel; text: i18n.tr("Pull to refresh…") }
+            },
+            State {
+                name: "releasable"
+                when: styledItem.target.dragging && releaseToRefresh
+                PropertyChanges { target: pullLabel; text: i18n.tr("Release to refresh…") }
+            }
+        ]
+        transitions: Transition {
+            SequentialAnimation {
+                UbuntuNumberAnimation {
+                    target: pullLabel
+                    property: "opacity"
+                    to: 0.0
+                }
+                PropertyAction {
+                    target: pullLabel
+                    property: "text"
+                }
+                UbuntuNumberAnimation {
+                    target: pullLabel
+                    property: "opacity"
+                    to: 1.0
+                }
+            }
+        }
+    }
+}

=== modified file 'tests/mocks/Unity/fake_scope.cpp'
--- tests/mocks/Unity/fake_scope.cpp	2014-09-18 21:23:55 +0000
+++ tests/mocks/Unity/fake_scope.cpp	2014-10-03 12:14:11 +0000
@@ -266,7 +266,7 @@
 
 void Scope::refresh()
 {
-    qDebug() << "Scope::refresh is currently not implmented in the fake scopes plugin";
+    Q_EMIT refreshed();
 }
 
 unity::shell::scopes::NavigationInterface* Scope::getNavigation(const QString& id)

=== modified file 'tests/mocks/Unity/fake_scope.h'
--- tests/mocks/Unity/fake_scope.h	2014-09-18 21:23:55 +0000
+++ tests/mocks/Unity/fake_scope.h	2014-10-03 12:14:11 +0000
@@ -79,6 +79,9 @@
 
     Q_INVOKABLE void refresh() override;
 
+Q_SIGNALS:
+    void refreshed(); // This is not in the Interface, here for testing benefits
+
 protected:
 
     QString m_id;

=== modified file 'tests/qmltests/Dash/tst_GenericScopeView.qml'
--- tests/qmltests/Dash/tst_GenericScopeView.qml	2014-09-23 08:56:29 +0000
+++ tests/qmltests/Dash/tst_GenericScopeView.qml	2014-10-03 12:14:11 +0000
@@ -581,6 +581,27 @@
 
                 genericScopeView.scope = !genericScopeView.scope;
             }
+
+            function test_pullToRefresh() {
+                waitForRendering(genericScopeView)
+
+                mouseFlick(genericScopeView,
+                           genericScopeView.width/2, units.gu(10),
+                           genericScopeView.width/2, units.gu(80),
+                           true, false)
+
+                var pullToRefresh = findChild(genericScopeView, "pullToRefresh")
+                tryCompare(pullToRefresh, "releaseToRefresh", true)
+
+                spy.target = genericScopeView.scope
+                spy.signalName = "refreshed"
+
+                mouseRelease(genericScopeView)
+                tryCompare(pullToRefresh, "releaseToRefresh", false)
+
+                spy.wait()
+                compare(spy.count, 1)
+            }
         }
     }
 }