Merge lp:~nik90/ubuntu-clock-app/13-next-alarm-bottomedge into lp:ubuntu-clock-app

[Nekhelesh Ramananthan]

Dynamically sets the bottom edge title with the time to the next active alarm.

Dynamically sets the bottom edge title with the time to the next active alarm.

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

FAILED: Continuous integration, rev:109
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/521/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/699/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/168/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/521/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:110
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/523/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/701
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/701/artifact/work/output/*zip*/output.zip
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/170/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/523/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:112
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/525/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/706
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/706/artifact/work/output/*zip*/output.zip
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/172/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/525/rebuild

review: Needs Fixing (continuous-integration)

[Leo Arias (elopio)]

Please try to name the tests as test_someActionOrComponentMustDoOrDisplaySomething.

227 + function test_bottomEdgeTitle() {

In my opinion, that naming rule makes it clear that you have at least three tests there.

test_bottomEdgeTitleMustDisplayActiveAlarm

test_bottomEdgeTitleMustDisplayNoAlarm

test_bottomEdgeTitleMustDisplayNextAlarm

Spliting them will make the tests clearer and easier to maintain. You will also get better feedback when only one of the features is failing, because you will have one test per code path.

[Nekhelesh Ramananthan (nik90)]

> Please try to name the tests as
> test_someActionOrComponentMustDoOrDisplaySomething.
>
> 227 + function test_bottomEdgeTitle() {
>
> In my opinion, that naming rule makes it clear that you have at least three
> tests there.
>
> test_bottomEdgeTitleMustDisplayActiveAlarm
>
> test_bottomEdgeTitleMustDisplayNoAlarm
>
> test_bottomEdgeTitleMustDisplayNextAlarm
>
> Spliting them will make the tests clearer and easier to maintain. You will
> also get better feedback when only one of the features is failing, because you
> will have one test per code path.

Wholeheartedly agree :-). Implemented in latest rev as per your comment.

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

FAILED: Continuous integration, rev:113
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/527/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/733
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/733/artifact/work/output/*zip*/output.zip
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/174/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/527/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:114
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/529/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/736
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/736/artifact/work/output/*zip*/output.zip
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/176/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/529/rebuild

review: Needs Fixing (continuous-integration)

[Nekhelesh Ramananthan (nik90)]

#blocked on Jenkins. This requires a patch to the Jenkins environment since the xvfb package which is used to run the clock app tests takes input focus away from the clock app when it is launched. This is causing the AP tests to be pass. Francis and Nicholas have been informed. Once jenkins is fixed, we should be good to merge this branch.

review: Needs Fixing

[Riccardo Padovani (rpadovani)]

Looks good to me, but I left a inline comment about a better implementation of an if

review: Approve

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

FAILED: Continuous integration, rev:117
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/541/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/812
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/812/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/541/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:118
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/544/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/823
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/823/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/544/rebuild

review: Needs Fixing (continuous-integration)

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

FAILED: Autolanding.
More details in the following jenkins job:
http://91.189.93.70:8080/job/ubuntu-clock-app-autolanding/194/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/825
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/825/artifact/work/output/*zip*/output.zip

review: Needs Fixing (continuous-integration)

[lp:~nik90/ubuntu-clock-app/13-next-alarm-bottomedge]

119. By Nekhelesh Ramananthan on 2014-10-10

Fixed AP test

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

PASSED: Continuous integration, rev:119
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/545/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/828
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/828/artifact/work/output/*zip*/output.zip

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/545/rebuild

review: Approve (continuous-integration)

=== modified file 'app/alarm/AlarmList.qml'
--- app/alarm/AlarmList.qml	2014-10-05 00:01:42 +0000
+++ app/alarm/AlarmList.qml	2014-10-10 01:55:06 +0000
@@ -51,10 +51,6 @@
     clip: true
     anchors.fill: parent
 
-    AlarmUtils {
-        id: alarmUtils
-    }
-
     listDelegate: AlarmDelegate {
         id: alarmDelegate
         objectName: "alarm" + index

=== modified file 'app/alarm/AlarmPage.qml'
--- app/alarm/AlarmPage.qml	2014-10-05 00:01:42 +0000
+++ app/alarm/AlarmPage.qml	2014-10-10 01:55:06 +0000
@@ -23,6 +23,8 @@
 Page {
     id: alarmPage
 
+    property var alarmModel
+
     title: i18n.tr("Alarms")
     objectName: 'AlarmPage'
 

=== modified file 'app/alarm/AlarmUtils.qml'
--- app/alarm/AlarmUtils.qml	2014-10-05 00:25:25 +0000
+++ app/alarm/AlarmUtils.qml	2014-10-10 01:55:06 +0000
@@ -50,6 +50,29 @@
         }
     }
 
+    // Function to set the bottom edge title with "Next Active in..."
+    function set_bottom_edge_title(alarmModel, clockTime) {
+        var bottom_edge_title = i18n.tr("No active alarms")
+
+        /*
+         Check if alarm model received is valid and has saved alarms and only
+         then proceed to find the next active alarm.
+        */
+        if (!alarmModel || !alarmModel.count) {
+            return bottom_edge_title
+        }
+
+        var activeAlarmDate = _get_next_active_alarm(alarmModel, clockTime)
+
+        // Return immediately if there are no active alarms found
+        if (!activeAlarmDate)  {
+          return bottom_edge_title
+        }
+
+        bottom_edge_title = i18n.tr("Next Alarm %1").arg(get_time_to_next_alarm(activeAlarmDate - clockTime))
+        return bottom_edge_title
+    }
+
     // Function to format the time to next alarm into a string
     function get_time_to_next_alarm(totalTime) {
         if(totalTime < 0) {
@@ -103,6 +126,27 @@
       INTERNAL FUNCTIONS
     */
 
+    /*
+     Function to get the next active alarm. This function ignores alarms in the
+     past and also iteratively looks through every alarm since the alarm model
+     does not always list the active alarms in chronological order.
+    */
+    function _get_next_active_alarm(alarmModel, clockTime) {
+        var activeAlarmDate = undefined
+
+        for (var i=0; i<alarmModel.count; i++) {
+            var currentAlarm = alarmModel.get(i)
+            if (currentAlarm.enabled && currentAlarm.date > clockTime) {
+                if (activeAlarmDate === undefined ||
+                        currentAlarm.date < activeAlarmDate) {
+                    activeAlarmDate = currentAlarm.date
+                }
+            }
+        }
+
+        return activeAlarmDate
+    }
+
     // Function to split time (in ms) into days, hours and minutes
     function _split_time(totalTime) {
         // increase by a minute, so we could make a nicer time

=== modified file 'app/clock/ClockPage.qml'
--- app/clock/ClockPage.qml	2014-10-03 11:55:41 +0000
+++ app/clock/ClockPage.qml	2014-10-10 01:55:06 +0000
@@ -17,8 +17,8 @@
  */
 
 import QtQuick 2.3
-import U1db 1.0 as U1db
 import Ubuntu.Components 1.1
+import "../alarm"
 import "../components"
 import "../upstreamcomponents"
 import "../worldclock"
@@ -33,11 +33,18 @@
     // Property to keep track of the clock time
     property alias clockTime: clock.analogTime
 
+    property var alarmModel
+
     flickable: null
+    bottomEdgeTitle: alarmUtils.set_bottom_edge_title(alarmModel, clockTime)
 
     Component.onCompleted: {
         console.log("[LOG]: Clock Page loaded")
-        _clockPage.setBottomEdgePage(Qt.resolvedUrl("../alarm/AlarmPage.qml"), {})
+        _clockPage.setBottomEdgePage(Qt.resolvedUrl("../alarm/AlarmPage.qml"), { alarmModel: alarmModel })
+    }
+
+    AlarmUtils {
+        id: alarmUtils
     }
 
     Flickable {

=== modified file 'app/ubuntu-clock-app.qml'
--- app/ubuntu-clock-app.qml	2014-10-09 16:41:18 +0000
+++ app/ubuntu-clock-app.qml	2014-10-10 01:55:06 +0000
@@ -21,7 +21,6 @@
 import U1db 1.0 as U1db
 import Ubuntu.Components 1.1
 import "clock"
-import "alarm"
 import "components"
 
 MainView {
@@ -117,6 +116,7 @@
               possible to receive a datetime object directly instead of using this hack.
             */
 
+            alarmModel: alarmModel
             clockTime: new Date
                        (
                            localTimeSource.localDateString.split(":")[0],
@@ -127,12 +127,6 @@
                            localTimeSource.localTimeString.split(":")[2],
                            localTimeSource.localTimeString.split(":")[3]
                        )
-
-            /*
-              #TODO: The bottom edge title should reflect the time to the next
-              alarm. For instance it should read "Next alarm in 9h23m".
-            */
-            bottomEdgeTitle: i18n.tr("Alarms")
         }
     }
 }

=== modified file 'debian/changelog'
--- debian/changelog	2014-10-09 16:44:50 +0000
+++ debian/changelog	2014-10-10 01:55:06 +0000
@@ -8,6 +8,7 @@
   * Removed Unused Utils library.
   * Design tweak to always show the remaining time to an alarm for one-time alarms
     only. (LP: #1377538)
+  * Tweaked bottom edge to show the time to the next active alarm (LP: #1290793)
 
   [Akiva Shammai Avraham]
   * Improved the analog clock performance by updating the clock hands every second

=== modified file 'tests/autopilot/ubuntu_clock_app/emulators.py'
--- tests/autopilot/ubuntu_clock_app/emulators.py	2014-10-09 21:47:45 +0000
+++ tests/autopilot/ubuntu_clock_app/emulators.py	2014-10-10 01:55:06 +0000
@@ -54,7 +54,7 @@
         clockPage = self.open_clock()
         clockPage.reveal_bottom_edge_page()
         self.get_header().visible.wait_for(True)
-        return self.wait_select_single(Page11)
+        return self.wait_select_single(AlarmPage)
 
     def get_AlarmList(self):
         """ Get the AlarmList object. """
@@ -178,7 +178,7 @@
         self.pointing_device.click_object(deleteButton)
 
 
-class Page11(Page):
+class AlarmPage(Page):
     """Autopilot helper for the Alarm page."""
 
     @autopilot_logging.log_action(logger.info)

=== modified file 'tests/unit/tst_alarm.qml'
--- tests/unit/tst_alarm.qml	2014-10-05 00:10:34 +0000
+++ tests/unit/tst_alarm.qml	2014-10-10 01:55:06 +0000
@@ -45,6 +45,10 @@
         id: alarmModel
     }
 
+    AlarmUtils {
+        id: alarmUtils
+    }
+
     DateTime {
         id: localTimeSource
         updateInterval: 1000
@@ -57,6 +61,7 @@
 
     AlarmPage {
         id: alarmPage
+        alarmModel: alarmModel
     }
 
     UbuntuTestCase {

=== modified file 'tests/unit/tst_alarmUtils.qml'
--- tests/unit/tst_alarmUtils.qml	2014-10-06 21:19:45 +0000
+++ tests/unit/tst_alarmUtils.qml	2014-10-10 01:55:06 +0000
@@ -16,6 +16,7 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+import QtQuick 2.3
 import QtTest 1.0
 import Ubuntu.Components 1.1
 import "../../app/alarm"
@@ -24,10 +25,62 @@
     id: alarmUtilsTest
     name: "AlarmUtilsLibrary"
 
+    property var futureTime: new Date()
+    property var currentTime: new Date()
+
     AlarmUtils {
         id: alarmUtils
     }
 
+    ListModel {
+        id: mockAlarmDatabase
+    }
+
+    function initTestCase() {
+        /*
+         Here the alarm database is mocked by creating 2 alarms in the future.
+         The alarm list is as follows,
+
+         Alarm1, currentTime+2hrs, not enabled
+         Alarm2, currentTime+7hrs, enabled
+        */
+        futureTime.setHours((futureTime.getHours() + 2))
+        mockAlarmDatabase.append({"name": "Alarm1", "date": futureTime, "enabled": false})
+        futureTime.setHours((futureTime.getHours() + 5))
+        mockAlarmDatabase.append({"name": "Alarm2", "date": futureTime, "enabled": true})
+    }
+
+    /*
+     This test checks if the the bottom edge title is set correctly according
+     to the active alarms amongst other disabled alarms.
+    */
+    function test_bottomEdgeTitleMustDisplayActiveAlarm() {
+        var result = alarmUtils.set_bottom_edge_title(mockAlarmDatabase, currentTime)
+        compare(result, "Next Alarm in 7h 1m", "Bottom edge title is incorrect")
+    }
+
+    /*
+     This test checks if the bottom edge title is correctly set to "No Active
+     Alarms" where there are no enabled alarms"
+    */
+    function test_bottomEdgeTitleMustDisplayNoActiveAlarm() {
+        mockAlarmDatabase.set(1, {"enabled": false})
+        var result = alarmUtils.set_bottom_edge_title(mockAlarmDatabase, currentTime)
+        compare(result, "No active alarms", "Bottom edge title is not correctly set when there are no enabled alarms")
+        mockAlarmDatabase.set(1, {"enabled": true})
+    }
+
+    /*
+     This test checks if the bottom edge title is correctly set with the next
+     immediate active alarm amongst several active alarms"
+    */
+    function test_bottomEdgeTitleMustDisplayNextActiveAlarm() {
+        mockAlarmDatabase.set(0, {"enabled": true})
+        var result = alarmUtils.set_bottom_edge_title(mockAlarmDatabase, currentTime)
+        compare(result, "Next Alarm in 2h 1m", "Bottom edge title is not correctly set to the next immediate active alarm where there are multiple active alarms.")
+        mockAlarmDatabase.set(0, {"enabled": false})
+    }
+
     /*
      This test checks if the _split_time() function takes a time in milliseconds
      and is able to split it into days, hours and minutes correctly.