Merge lp:~nik90/ubuntu-clock-app/remember-clock-mode into lp:ubuntu-clock-app

[Nekhelesh Ramananthan]

Clock mode is now saved in u1db to remember the user preference

Remember the clock mode chosen by the user by saving it U1db. This same u1db database will also be used for other purposes such as saving the world clocks, settings etc. Hence the database file is appropriately named "user-preference".

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

FAILED: Continuous integration, rev:43
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/42/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1022/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-utopic-amd64-ci/42/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/42/rebuild

review: Needs Fixing (continuous-integration)

[Victor Thompson (vthompson)]

Echoing inline comments:

1. Could we rename the "clockMode" variable as part of this? It really should be something like "isDigital", "digitalMode" or similar since it is a bool variable.

2. Consider loading all the U1db.Documents in the main QML file so they are all co-located. Otherwise, in the future finding settings defaults, etc, might be difficult.

review: Needs Fixing

[Victor Thompson (vthompson)]

Also, I was going to suggest using the StateSaver [1] for this, but alas, it seems that it only saves the state when the app crashes and not when closed normally--which is how it originally appeared to be designed [2]:

bzr diff
=== modified file 'app/clock/ClockPage.qml'
--- app/clock/ClockPage.qml 2014-07-13 11:18:31 +0000
+++ app/clock/ClockPage.qml 2014-07-16 00:53:40 +0000
@@ -63,6 +63,8 @@
             anchors.verticalCenter: parent.top
             anchors.verticalCenterOffset: units.gu(20)
             anchors.horizontalCenter: parent.horizontalCenter
+
+ StateSaver.properties: "clockMode"
         }

[1] http://developer.ubuntu.com/api/qml/sdk-14.10/Ubuntu.Components.StateSaver/
[2] http://www.kryogenix.org/days/2014/01/23/saving-the-current-state-of-your-ubuntu-sdk-app-with-no-effort/

[lp:~nik90/ubuntu-clock-app/remember-clock-mode]

44. By Nekhelesh Ramananthan on 2014-07-16

Fixed reviewer comments

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

FAILED: Continuous integration, rev:44
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/43/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1034/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-utopic-amd64-ci/43/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/43/rebuild

review: Needs Fixing (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

> Echoing inline comments:
>
> 1. Could we rename the "clockMode" variable as part of this? It really should
> be something like "isDigital", "digitalMode" or similar since it is a bool
> variable.
>
> 2. Consider loading all the U1db.Documents in the main QML file so they are
> all co-located. Otherwise, in the future finding settings defaults, etc, might
> be difficult.

Fixed in the latest rev

[Nekhelesh Ramananthan (nik90)]

> Also, I was going to suggest using the StateSaver [1] for this, but alas, it
> seems that it only saves the state when the app crashes and not when closed
> normally--which is how it originally appeared to be designed [2]:
>
> bzr diff
> === modified file 'app/clock/ClockPage.qml'
> --- app/clock/ClockPage.qml 2014-07-13 11:18:31 +0000
> +++ app/clock/ClockPage.qml 2014-07-16 00:53:40 +0000
> @@ -63,6 +63,8 @@
> anchors.verticalCenter: parent.top
> anchors.verticalCenterOffset: units.gu(20)
> anchors.horizontalCenter: parent.horizontalCenter
> +
> + StateSaver.properties: "clockMode"
> }
>
> [1]
> http://developer.ubuntu.com/api/qml/sdk-14.10/Ubuntu.Components.StateSaver/
> [2] http://www.kryogenix.org/days/2014/01/23/saving-the-current-state-of-your-
> ubuntu-sdk-app-with-no-effort/

Ideally I would like to use this as well, however as you mentioned above statesaver only saves the state in case of an app crash. However I believe they are planning to add an option to save data permanently even when the app closes normally. Until that lands in the SDK, I am afraid we will have to use u1db.

Actually it would be even better if we could use the new Settings API which was designed to store app settings. But that hasn't landed either :/

[lp:~nik90/ubuntu-clock-app/remember-clock-mode]

45. By Nekhelesh Ramananthan on 2014-07-16

Fixed incorrect comment

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

FAILED: Continuous integration, rev:45
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/44/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/1035/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-utopic-amd64-ci/44/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/44/rebuild

review: Needs Fixing (continuous-integration)

[Victor Thompson (vthompson)]

Looks great!

review: Approve

[Nekhelesh Ramananthan (nik90)]

Thnx for the review. Top Approving and merging.

=== modified file 'app/clock/Clock.qml'
--- app/clock/Clock.qml	2014-07-12 00:01:23 +0000
+++ app/clock/Clock.qml	2014-07-16 14:07:22 +0000
@@ -32,7 +32,7 @@
     property bool isStartup: true
 
     // Property to keep track of the clock mode
-    property alias clockMode: clockModeFlipable.isDigital
+    property alias isDigital: clockModeFlipable.isDigital
 
     Component.onCompleted: {
         clockOpenAnimation.start()
@@ -112,7 +112,9 @@
 
         MouseArea {
             anchors.fill: parent
-            onClicked: clockFlipAnimation.start()
+            onClicked: {
+                clockFlipAnimation.start()
+            }
         }
     }
 
@@ -191,6 +193,10 @@
                 }
 
                 analogShadow.source = digitalShadow.source = ""
+
+                var isDigitalSetting = JSON.parse(JSON.stringify(clockModeDocument.contents))
+                isDigitalSetting.digitalMode = isDigital
+                clockModeDocument.contents = isDigitalSetting
             }
         }
     }

=== modified file 'app/clock/ClockPage.qml'
--- app/clock/ClockPage.qml	2014-07-13 11:18:31 +0000
+++ app/clock/ClockPage.qml	2014-07-16 14:07:22 +0000
@@ -15,6 +15,7 @@
  */
 
 import QtQuick 2.0
+import U1db 1.0 as U1db
 import Ubuntu.Components 1.1
 import "../components"
 import "../components/Utils.js" as Utils
@@ -29,7 +30,7 @@
     property int _minThreshold: addCityButton.maxThreshold + units.gu(2)
 
     // Property to keep track of the clock mode
-    property alias isDigital: clock.clockMode
+    property alias isDigital: clock.isDigital
 
     flickable: null
 
@@ -60,9 +61,12 @@
 
         Clock {
             id: clock
+
             anchors.verticalCenter: parent.top
             anchors.verticalCenterOffset: units.gu(20)
             anchors.horizontalCenter: parent.horizontalCenter
+
+            isDigital: clockModeDocument.contents.digitalMode ? true : false
         }
 
         Label {

=== modified file 'app/ubuntu-clock-app.qml'
--- app/ubuntu-clock-app.qml	2014-07-11 19:11:24 +0000
+++ app/ubuntu-clock-app.qml	2014-07-16 14:07:22 +0000
@@ -15,6 +15,7 @@
  */
 
 import QtQuick 2.0
+import U1db 1.0 as U1db
 import Ubuntu.Components 1.1
 import "clock"
 import "alarm"
@@ -74,6 +75,21 @@
         onTriggered: clockPage.updateTime()
     }
 
+    // Database to store the user preferences locally
+    U1db.Database {
+        id: clockDB
+        path: "user-preferences"
+    }
+
+    // Document to store clock mode chosen by user
+    U1db.Document {
+        id: clockModeDocument
+        create: true
+        database: clockDB
+        docId: "clockModeDocument"
+        defaults: { "digitalMode": false }
+    }
+
     AlarmModel {
         id: alarmModel
         Component.onCompleted: Utils.log(debugMode, "Alarm Database loaded")