Merge lp:~nik90/ubuntu-clock-app/onetime-alarms into lp:ubuntu-clock-app

[Nekhelesh Ramananthan]

Added support for one-time alarms

Added support for one-time alarms

===== Testing =====
1. Try creating an alarm that doesn't repeat.

2. Try editing an existing saved repeating alarm and change it into a one-time alarm and vice-versa.

3. Check if when you save a one-time alarm it appears in the indicator-datetime.

4. Check if when you create a one-time alarm for a time in the past, it is automatically scheduled for tomorrow. For instance if current local time is 15:00, create an alarm for 09:00 AM and see if it set to ring tomorrow.

5. Edit the alarm in step 4, and change the time to 20:00 and see if it is set to ring today at 20:00.

What doesn't work
=================

1. When a one-time alarm rings, it is not disabled automatically thereafter. (known bug https://bugs.launchpad.net/indicator-datetime/+bug/1362341)

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

PASSED: Continuous integration, rev:62
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/405/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/52

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

review: Approve (continuous-integration)

[lp:~nik90/ubuntu-clock-app/onetime-alarms]

63. By Nekhelesh Ramananthan on 2014-08-28

Small code cleanups

64. By Nekhelesh Ramananthan on 2014-08-28

Disable alarm save button if the date is in the past

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

PASSED: Continuous integration, rev:64
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/406/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/53

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

review: Approve (continuous-integration)

[Alan Pope 🍺🐧🐱 🦄 (popey)]

1) non-repeating alarm creation works
2) It's now 11:04, I can't set an alarm for 11:01, but equally I can't set one for midnight tonight either but can set one for 23:59
3) Works fine.
4) It does
5) On one occasions the OSK failed to come up when editing the alarm name. I had to swipe out of the app, use the dash search to wake the OSK then come back in and it would appear.

Still takes ~5s to save an alarm which is disconcerting.

[Nekhelesh Ramananthan (nik90)]

Nothing much I can do about this since it was the designer's decision to make the clock app create one-time alarms for today. If you want to set a non-repeating alarm for tomorrow or any other day, the user is supposed to use the calendar app. I personally disagree, but that's what design wants. I will create a bug report on this after the MP lands and then check up on what design would like to do.

> 2) It's now 11:04, I can't set an alarm for 11:01, but equally I can't set one
> for midnight tonight either but can set one for 23:59

Awesome. I will start fixing the QML tests which needs to be adjusted.

> 1) non-repeating alarm creation works
> 3) Works fine.
> 4) It does

Looks like a random osk bug.

> 5) On one occasions the OSK failed to come up when editing the alarm name. I
> had to swipe out of the app, use the dash search to wake the OSK then come
> back in and it would appear.
>

I have reported bug 1362548 to track this. I am pretty sure that the alarms backend EDS needs to improve and is not due to clock app.

> Still takes ~5s to save an alarm which is disconcerting.

[lp:~nik90/ubuntu-clock-app/onetime-alarms]

65. By Nekhelesh Ramananthan on 2014-08-28

Updated changelog

66. By Nekhelesh Ramananthan on 2014-08-28

Fixed qml tests

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

PASSED: Continuous integration, rev:66
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/408/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/55

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

review: Approve (continuous-integration)

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

PASSED: Continuous integration, rev:66
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/409/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/127
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/127/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/56

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

review: Approve (continuous-integration)

[lp:~nik90/ubuntu-clock-app/onetime-alarms]

67. By Nekhelesh Ramananthan on 2014-09-01

Small changed

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

FAILED: Continuous integration, rev:67
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/415/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/133/console
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/133/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/62

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

review: Needs Fixing (continuous-integration)

[lp:~nik90/ubuntu-clock-app/onetime-alarms]

68. By Nekhelesh Ramananthan on 2014-09-01

Fixed one-time alarm functionality

69. By Nekhelesh Ramananthan on 2014-09-01

Added function get_alarm_day() to AlarmUtils

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

FAILED: Continuous integration, rev:69
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/416/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/134/console
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/134/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/63

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

review: Needs Fixing (continuous-integration)

[lp:~nik90/ubuntu-clock-app/onetime-alarms]

70. By Nekhelesh Ramananthan on 2014-09-01

merged trunk

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

FAILED: Continuous integration, rev:70
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/417/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/135/console
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/135/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/64

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

review: Needs Fixing (continuous-integration)

[Alan Pope 🍺🐧🐱 🦄 (popey)]

Tested latest build and this works as expected.

review: Approve

[Riccardo Padovani (rpadovani)]

Read all the code, done all tests, ringed a lot of alarms: looks good to me :-)

review: Approve

[lp:~nik90/ubuntu-clock-app/onetime-alarms]

71. By Nekhelesh Ramananthan on 2014-09-02

qml unit test update

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

FAILED: Continuous integration, rev:71
http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-ci/262/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/145/console
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/145/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-dev-ubuntu-clock-app-utopic-3.0-utopic-amd64-ci/262

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:71
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/428/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/75

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

review: Needs Fixing (continuous-integration)

[lp:~nik90/ubuntu-clock-app/onetime-alarms]

72. By Nekhelesh Ramananthan on 2014-09-03

merged trunk

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'app/alarm/AlarmDelegate.qml'
--- app/alarm/AlarmDelegate.qml	2014-08-24 12:47:50 +0000
+++ app/alarm/AlarmDelegate.qml	2014-09-03 22:15:02 +0000
@@ -68,8 +68,9 @@
 
             fontSize: "xx-small"
             width: parent.width
+            visible: type === Alarm.Repeating
             wrapMode: Text.WrapAtWordBoundaryOrAnywhere
-            text: alarmUtils.format_day_string(daysOfWeek)
+            text: alarmUtils.format_day_string(daysOfWeek, type)
         }
     }
 

=== modified file 'app/alarm/AlarmRepeat.qml'
--- app/alarm/AlarmRepeat.qml	2014-08-24 12:47:50 +0000
+++ app/alarm/AlarmRepeat.qml	2014-09-03 22:15:02 +0000
@@ -24,11 +24,28 @@
     id: _alarmRepeatPage
     objectName: "alarmRepeatPage"
 
+    // Property to set the alarm days of the week in the edit alarm page
+    property var alarm
+
     visible: false
     title: i18n.tr("Repeat")
 
-    // Property to set the alarm days of the week in the edit alarm page
-    property var alarm
+    /*
+     By Default, the alarm is set to Today. However if it is a one-time alarm,
+     this should be set to none, since this page shows the days the alarm
+     repeats on and a one-time alarm shoudn't repeat on any day. While exiting
+     the page, if the alarm is still a one-time alarm, then the alarm is set
+     back to its original value (Today).
+    */
+    Component.onCompleted: {
+        if (alarm.type === Alarm.OneTime)
+            alarm.daysOfWeek = 0
+    }
+
+    Component.onDestruction: {
+        if (alarm.type === Alarm.OneTime)
+            alarm.daysOfWeek = Alarm.AutoDetect
+    }
 
     ListModel {
         id: daysModel
@@ -101,14 +118,19 @@
                 control: Switch {
                     objectName: 'daySwitch' + index
                     checked: (alarm.daysOfWeek & flag) == flag
+                             && alarm.type === Alarm.Repeating
                     onCheckedChanged: {
                         if (checked) {
                             alarm.daysOfWeek |= flag
-                        }
-
-                        else {
+                        } else {
                             alarm.daysOfWeek &= ~flag
                         }
+
+                        if (alarm.daysOfWeek > 0) {
+                            alarm.type = Alarm.Repeating
+                        } else {
+                            alarm.type = Alarm.OneTime
+                        }
                     }
                 }
             }

=== modified file 'app/alarm/AlarmUtils.qml'
--- app/alarm/AlarmUtils.qml	2014-08-24 12:47:50 +0000
+++ app/alarm/AlarmUtils.qml	2014-09-03 22:15:02 +0000
@@ -26,7 +26,11 @@
     id: alarmUtils
 
     // Function to format the alarm days accordingly to their occurance
-    function format_day_string(value) {
+    function format_day_string(value, type) {
+        if (type === Alarm.OneTime) {
+            return i18n.tr("Never")
+        }
+
         var occurs = _get_day(value)
 
         if (value === _get_weekdays()) {
@@ -46,6 +50,19 @@
         }
     }
 
+    // Function return the alarm dayOfWeek according to the day provided
+    function get_alarm_day(day) {
+        switch(day) {
+        case 0: return Alarm.Sunday
+        case 1: return Alarm.Monday
+        case 2: return Alarm.Tuesday
+        case 3: return Alarm.Wednesday
+        case 4: return Alarm.Thursday
+        case 5: return Alarm.Friday
+        case 6: return Alarm.Saturday
+        }
+    }
+
     /*
       INTERNAL FUNCTIONS
     */

=== modified file 'app/alarm/EditAlarmPage.qml'
--- app/alarm/EditAlarmPage.qml	2014-08-24 12:47:50 +0000
+++ app/alarm/EditAlarmPage.qml	2014-09-03 22:15:02 +0000
@@ -49,6 +49,7 @@
         }
 
         actions: Action {
+            id: saveAlarmButton
             iconName: "ok"
             objectName: "saveAlarmAction"
             text: i18n.tr("Alarm")
@@ -74,12 +75,13 @@
         var alarmTime = new Date()
         alarmTime.setHours(_timePicker.hours, _timePicker.minutes, 0)
 
+        validateDate(alarmTime)
+
         /*
-          _alarm.sound, _alarm.message and _alarm.daysOfWeek have been set in
+          _alarm.sound, _alarm.daysOfWeek and _alarm.message have been set in
           the respective individual pages already.
         */
         _alarm.date = alarmTime
-        _alarm.type = Alarm.Repeating
         _alarm.enabled = true
         _alarm.save()
     }
@@ -113,9 +115,11 @@
         var alarmTime = new Date()
         alarmTime.setHours(_timePicker.hours, _timePicker.minutes, 0)
 
+        validateDate(alarmTime)
+
         tempAlarm.message = _alarm.message
         tempAlarm.date = alarmTime
-        tempAlarm.type = Alarm.Repeating
+        tempAlarm.type = _alarm.type
         tempAlarm.enabled = _alarm.enabled
         tempAlarm.sound = _alarm.sound
         tempAlarm.daysOfWeek = _alarm.daysOfWeek
@@ -154,8 +158,27 @@
         }
     }
 
+    function validateDate(date) {
+        if (_alarm.type === Alarm.OneTime) {
+            _alarm.daysOfWeek = Alarm.AutoDetect
+
+            if (date < new Date()) {
+                var tomorrow = new Date()
+                tomorrow.setDate(tomorrow.getDate() + 1)
+                _alarm.daysOfWeek = alarmUtils.get_alarm_day(tomorrow.getDay())
+            }
+        }
+    }
+
     Alarm {
         id: _alarm
+
+        onErrorChanged: {
+            if (error !== Alarm.NoError) {
+                Utils.log(debugMode, "Error saving alarm, code: " + error)
+            }
+        }
+
         onStatusChanged: {
             if (status !== Alarm.Ready)
                 return;
@@ -164,9 +187,15 @@
                 mainStack.pop();
             }
         }
+
+        onTypeChanged: {
+            _alarmRepeat.subText = alarmUtils.format_day_string(_alarm.daysOfWeek, type)
+        }
+
         onDaysOfWeekChanged: {
-            _alarmRepeat.subText = alarmUtils.format_day_string(_alarm.daysOfWeek)
+            _alarmRepeat.subText = alarmUtils.format_day_string(_alarm.daysOfWeek, type)
         }
+
         onDateChanged: {
             _timePicker.date = _alarm.date
         }
@@ -241,7 +270,7 @@
                                                    .split(":")[1]/5))*5,
                                 0,
                                 0
-                            )
+                                )
                 }
             }
 
@@ -256,7 +285,7 @@
             objectName: "alarmRepeat"
 
             text: i18n.tr("Repeat")
-            subText: alarmUtils.format_day_string(_alarm.daysOfWeek)
+            subText: alarmUtils.format_day_string(_alarm.daysOfWeek, _alarm.type)
             onClicked: mainStack.push(Qt.resolvedUrl("AlarmRepeat.qml"),
                                       {"alarm": _alarm})
         }

=== modified file 'debian/changelog'
--- debian/changelog	2014-09-02 17:14:39 +0000
+++ debian/changelog	2014-09-03 22:15:02 +0000
@@ -19,6 +19,7 @@
   * Updated QtQuick library imports to v2.3
   * Switched bzr branch to lp:ubuntu-clock-app
   * Updated pot file name
+  * Enabled one-time alarms in the UI (LP: #1358320)
   * Fixed the transition animation to alarms to be more smoother (LP: #1362081)
 
   [Zsombor Egri]

=== modified file 'tests/unit/tst_alarmRepeat.qml'
--- tests/unit/tst_alarmRepeat.qml	2014-08-19 20:33:48 +0000
+++ tests/unit/tst_alarmRepeat.qml	2014-09-03 22:15:02 +0000
@@ -15,9 +15,18 @@
         id: _alarm
     }
 
-    AlarmRepeat {
+    Component {
         id: alarmRepeatPage
-        alarm: _alarm
+        AlarmRepeat {
+            alarm: _alarm
+        }
+    }
+
+    Loader {
+        id: alarmRepeatPageLoader
+        anchors.left: parent.left
+        anchors.right: parent.right
+        anchors.bottom: parent.bottom
     }
 
     UbuntuTestCase {
@@ -30,46 +39,67 @@
         property var backButton
         property var repeater
         property var today: Qt.locale().standaloneDayName(
-        new Date().getDay(), Locale.LongFormat)
+                                new Date().getDay(), Locale.LongFormat)
 
-        function initTestCase() {
-            alarmRepeatPage.visible = true
+        function init() {
+            alarmRepeatPageLoader.sourceComponent = alarmRepeatPage
+            alarmRepeatPageLoader.item.visible = true
             header = findChild(mainView, "MainView_Header")
             backButton = findChild(header, "customBackButton")
-            repeater = findChild(alarmRepeatPage, "alarmDays")
+            repeater = findChild(alarmRepeatPageLoader.item, "alarmDays")
         }
 
         function cleanup() {
-            for(var i=0; i<repeater.count; i++) {
-                var currentDaySwitch = findChild(alarmRepeatPage, "daySwitch"+i)
-                var currentDayLabel = findChild(alarmRepeatPage, "alarmDay"+i)
-
-                if(today === currentDayLabel.text) {
-                    currentDaySwitch.checked = true
-                }
-
-                else {
-                    currentDaySwitch.checked = false
-                }
-            }
-        }
-
-        /*
-         Test to check if the checkbox for today is checked by default
-        */
-        function test_todaySwitchIsChecked() {
-            for(var i=0; i<repeater.count; i++) {
-                var currentDayLabel = findChild(alarmRepeatPage, "alarmDay"+i)
-                var currentDaySwitch = findChild(alarmRepeatPage, "daySwitch"+i)
-
-                if(today === currentDayLabel.text) {
-                    compare(currentDaySwitch.checked, true, "Today's Switch is not checked by default")
-                }
-
-                else {
-                    compare(currentDaySwitch.checked, false, "Switch for days other than today are checked incorrectly")
-                }
-            }
+            alarmRepeatPageLoader.sourceComponent = undefined
+            _alarm.reset()
+            tryCompare(_alarm, "status", Alarm.Ready)
+        }
+
+        /*
+         Test to check if none of the switches are checked by default since by
+         default an alarm is an one-time alarm and in the repeat page none of
+         the days must be checked
+        */
+        function test_allSwitchesAreUncheckedByDefault() {
+            waitForRendering(alarmRepeatPageLoader.item);
+
+            tryCompare(_alarm, "daysOfWeek", 0, 3000, "Alarm days of weeks is not 0 by default")
+
+            for(var i=0; i<repeater.count; i++) {
+                var currentDayLabel = findChild(alarmRepeatPageLoader.item, "alarmDay"+i)
+                var currentDaySwitch = findChild(alarmRepeatPageLoader.item, "daySwitch"+i)
+
+                compare(currentDaySwitch.checked, false, "All switches are not disabled by default")
+            }
+        }
+
+        /*
+         Test to check if the alarm types are being correctly changed when
+         toggling some of the swtiches. So if a switch is toggle, the alarm
+         should become a repeating alarm. if no switches are enabled then
+         it should be a one time alarm.
+        */
+        function test_alarmTypeSwitch() {
+            waitForRendering(alarmRepeatPageLoader.item);
+
+            // TEST FAILS HERE //
+            // Alarm should be one-time by default. By the test before this
+            // changed the value and the alarm.reset() in the cleanup doesn't
+            // seem to do its job.
+
+            // test_alarmObjectSetsSwitchStatus() is run before this test. And in
+            // that test I set the alarm type to repeating. However the cleanup
+            // should reset back to one-time when calling the alarm.reset() function.
+
+            tryCompare(_alarm, "type", Alarm.OneTime, 3000, "Alarm type is not OneTime by default")
+
+            var dayListItem = findChild(alarmRepeatPageLoader.item, "alarmDay"+3)
+
+            mouseClick(dayListItem, centerOf(dayListItem).x, centerOf(dayListItem).y)
+            tryCompare(_alarm, "type", Alarm.Repeating, 3000, "Alarm type did not change to Repeating despite enabling a switch")
+
+            mouseClick(dayListItem, centerOf(dayListItem).x, centerOf(dayListItem).y)
+            tryCompare(_alarm, "type", Alarm.OneTime, 3000, "Alarm type is not OneTime despite all switches disabled")
         }
 
         /*
@@ -77,18 +107,18 @@
          updated correctly
         */
         function test_switchStatusUpdatesAlarmObject() {
-            waitForRendering(alarmRepeatPage);
+            waitForRendering(alarmRepeatPageLoader.item);
 
             for(var i=0; i<repeater.count; i++) {
-                var dayListItem = findChild(alarmRepeatPage, "alarmDayHolder"+i)
-                var currentDaySwitch = findChild(alarmRepeatPage, "daySwitch"+i)
+                var dayListItem = findChild(alarmRepeatPageLoader.item, "alarmDayHolder"+i)
+                var currentDaySwitch = findChild(alarmRepeatPageLoader.item, "daySwitch"+i)
 
                 if(!currentDaySwitch.checked) {
                     mouseClick(dayListItem, dayListItem.width/2, dayListItem.height/2)
                 }
             }
 
-            compare(alarmRepeatPage.alarm.daysOfWeek, 127, "Alarm Object daysOfWeek value is incorrect w.r.t to the UI")
+            compare(alarmRepeatPageLoader.item.alarm.daysOfWeek, 127, "Alarm Object daysOfWeek value is incorrect w.r.t to the UI")
         }
 
         /*
@@ -97,11 +127,12 @@
          should properly show the days previously selected by the user.
         */
         function test_alarmObjectSetsSwitchStatus() {
+            _alarm.type = Alarm.Repeating
             _alarm.daysOfWeek = 96 // Enabled saturday and sunday
 
             for(var i=0; i<repeater.count; i++) {
-                var currentDayLabel = findChild(alarmRepeatPage, "alarmDay"+i)
-                var currentDaySwitch = findChild(alarmRepeatPage, "daySwitch"+i)
+                var currentDayLabel = findChild(alarmRepeatPageLoader.item, "alarmDay"+i)
+                var currentDaySwitch = findChild(alarmRepeatPageLoader.item, "daySwitch"+i)
 
                 if(currentDayLabel.text === Qt.locale().standaloneDayName(6, Locale.LongFormat) ||
                         currentDayLabel.text === Qt.locale().standaloneDayName(0, Locale.LongFormat)) {