Merge lp:~twstd-dev/ubuntu-clock-app/next-alarm into lp:ubuntu-clock-app

[twstd]

Fix for Bug #1290793

A fix for Bug #1290793

[Nekhelesh Ramananthan (nik90)]

Here are some observations based on initial testing,
- When an alarm is set for several days later, it shows up "Next Alarm in 167h 20m". Would it be able to convert this into "Next Alarm in 3d 20h 20m" to make it more meaningful for the user.

- IMHO the string i18n.tr( "You have not set an alarm" ); is a bit too long to show in the bottom edge hint. I would prefer something like "No Active Alarms". However let me check with the designers tomorrow and update here what string they want to show.

- Comments style in this MP,

8 +/**
9 + * @brief A simple object that contains logic
10 + * to find and retrieve next alarm from the model.
11 + * We save only the date of an alarm, we don't need
12 + * other information.
13 + */

Please change to the format below. We are trying to maintain a consistency code style throughout the app.

/*
 A simple object that contains logic
 to find and retrieve next alarm from the model.
 We save only the date of an alarm, we don't need
 other information.
*/

Same thing applies to,

55 +/**
56 + * @brief Finds the time left to the provided date.
57 + *
58 + * @param[in] Date end_datetime is the date to find difference to
59 + * @return int - the amount of milliseconds left to the provided datetime
60 + */

Otherwise looks good. Nice work!

review: Needs Fixing

[Nekhelesh Ramananthan (nik90)]

oh btw, do add copyright license headers to NextAlarm.qml,

/*
 * Copyright (C) 2014 Canonical Ltd
 *
 * This file is part of Ubuntu Clock App
 *
 * Ubuntu Clock App is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 3 as
 * published by the Free Software Foundation.
 *
 * Ubuntu Clock App 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/>.
 */

[lp:~twstd-dev/ubuntu-clock-app/next-alarm]

60. By twstd on 2014-08-18

Adjust to the requested styling

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

FAILED: Continuous integration, rev:60
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~twstd-dev/ubuntu-clock-app/next-alarm/+merge/231243/+edit-commit-message

http://91.189.93.70:8080/job/ubuntu-clock-app-ci/407/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/54/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:60
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/421/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/139/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/68/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:60
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/429/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/76/console

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

review: Needs Fixing (continuous-integration)

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

FAILED: Continuous integration, rev:60
http://91.189.93.70:8080/job/ubuntu-clock-app-ci/436/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic-python3/157/console
    FAILURE: http://91.189.93.70:8080/job/ubuntu-clock-app-utopic-amd64-ci/83/console

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

review: Needs Fixing (continuous-integration)

[Alan Pope 🍺🐧🐱 🦄 (popey)]

What's going on here? Is the jenkins environment not clean?

Merging 'lp:ubuntu-clock-app' in to 'work'.
Not attempting to fix packaging branch ancestry, missing pristine tar data for version 3.1.
Text conflict in app/ubuntu-clock-app.qml
1 conflicts encountered.
bzr: ERROR: Conflicts from merge

[Nekhelesh Ramananthan (nik90)]

Jenkins is cool now. This branch requires updating as there are actual code conflicts with clock app trunk.

review: Needs Fixing

[lp:~twstd-dev/ubuntu-clock-app/next-alarm]

61. By twstd on 2014-09-06

Resolve merge conflict and update to the newset model signals

[twstd (twstd-dev)]

Resolved

[Nekhelesh Ramananthan (nik90)]

The fix for this landed in another MP sometime back. Hereby disapproving this MP.

review: Disapprove

Unmerged revisions

61. By twstd on 2014-09-06

Resolve merge conflict and update to the newset model signals

60. By twstd on 2014-08-18

Adjust to the requested styling

59. By twstd on 2014-08-18

Refactor current next alarm functionality

=== added file 'app/components/NextAlarm.qml'
--- app/components/NextAlarm.qml	1970-01-01 00:00:00 +0000
+++ app/components/NextAlarm.qml	2014-09-06 16:43:29 +0000
@@ -0,0 +1,60 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This file is part of Ubuntu Clock App
+ *
+ * Ubuntu Clock App is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * Ubuntu Clock App 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.0
+import Ubuntu.Components 1.1
+
+/*
+ A simple object that contains logic
+ to find and retrieve next alarm from the model.
+ We save only the date of an alarm, we don't need
+ other information.
+*/
+QtObject {
+    property AlarmModel currentAlarmModel
+    property var alarmDate
+
+    Component.onCompleted: {
+        getNextAlarm();
+        currentAlarmModel.onDataChanged.connect( getNextAlarm );
+        currentAlarmModel.onCountChanged.connect( getNextAlarm );
+    }
+
+    /*
+     Goes throgh the list of registered
+     alarams and gets the first enabled one.
+    */
+    function getNextAlarm() {
+        var are_alarms_available = currentAlarmModel && currentAlarmModel.count;
+
+        if ( are_alarms_available ) {
+            var alarms_count = currentAlarmModel.count;
+
+            for ( var index = 0; index < alarms_count; ++index ) {
+                var current_alarm = currentAlarmModel.get( index );
+
+                if ( current_alarm.enabled ) {
+                    alarmDate = current_alarm.date;
+                    return;
+                }
+            }
+        }
+
+        alarmDate = undefined;
+    }
+}

=== modified file 'app/components/Utils.js'
--- app/components/Utils.js	2014-07-17 12:21:45 +0000
+++ app/components/Utils.js	2014-09-06 16:43:29 +0000
@@ -23,3 +23,42 @@
         console.log("[LOG]" + message)
     }
 }
+
+/*
+ Finds the time left to the provided date.
+*/
+var get_time_left_to = ( function() {
+    // private scope
+    var m_current_datetime = null;
+
+    return function( end_datetime ) {
+        m_current_datetime = new Date();
+
+        // if the given date is ealrier than the current one
+        // just give back null instead of negative offset
+        return m_current_datetime < end_datetime ? ( end_datetime - m_current_datetime ) : 0;
+    };
+} )();
+
+/*
+ Converts the given amount of milliseconds to
+ a object representing hours and minutes.
+ NOTE: since we cannot reference Qt objects from JavaScript
+ object is a required step.
+*/
+var milliseconds_to_object = function( datetime_offset ) {
+    // increase by a minute, so we could make a nicer time
+    // to the next alarm, otherwise a minute always missing
+    // which makes it look odd
+    datetime_offset += 60000;
+
+    var days_in_offset = Math.floor( datetime_offset / ( 3600000 * 24 ) );
+    var hours_in_offset = Math.floor( datetime_offset / 3600000 % 24 );
+    var minutes_in_offset = Math.floor( datetime_offset / 60000 % 60 );
+
+    return {
+        days : days_in_offset,
+        hours : hours_in_offset,
+        minutes : minutes_in_offset
+    }
+};

=== modified file 'app/ubuntu-clock-app.qml'
--- app/ubuntu-clock-app.qml	2014-08-26 20:20:37 +0000
+++ app/ubuntu-clock-app.qml	2014-09-06 16:43:29 +0000
@@ -17,6 +17,7 @@
  */
 
 import QtQuick 2.3
+import DateTime 1.0
 import U1db 1.0 as U1db
 import Ubuntu.Components 1.1
 import "clock"
@@ -80,6 +81,15 @@
         Component.onCompleted: Utils.log(debugMode, "Alarm Database loaded")
     }
 
+    NextAlarm {
+        id: nextAlarm
+        currentAlarmModel: alarmModel
+    }
+
+    DateTime {
+        id: dateTime
+    }
+
     PageStack {
         id: mainStack
 
@@ -88,6 +98,17 @@
         ClockPage {
             id: clockPage
 
+            Connections {
+                target: nextAlarm
+                onAlarmDateChanged: clockPage.setEdgeTitle()
+            }
+
+            Connections {
+                target: dateTime
+                onLocalTimeStringChanged: clockPage.setEdgeTitle()
+            }
+
+
             /*
               #FIXME: When the SDK support hiding the header, then enable the
               clock page title. This will then set the correct window title on
@@ -97,10 +118,31 @@
             */
 
             /*
-              #TODO: The bottom edge title should reflect the time to the next
-              alarm. For instance it should read "Next alarm in 9h23m".
+             Sets the title according to the time left
+             until the next alarm to go off.
             */
-            bottomEdgeTitle: i18n.tr("Alarms")
+            function setEdgeTitle() {
+                var title_to_set = i18n.tr( "No active alarms" );
+
+                if ( nextAlarm.alarmDate ) {
+                    var time_left_to_first_alarm = Utils.get_time_left_to( nextAlarm.alarmDate );
+
+                    var time_object = Utils.milliseconds_to_object( time_left_to_first_alarm );
+
+                    title_to_set = i18n.tr( "Next alarm in" );
+
+                    if ( time_object.days ) {
+                        title_to_set += i18n.tr( " %1d" ).arg( time_object.days );
+                    }
+
+                    title_to_set += i18n.tr( " %1h %2m" )
+                        .arg( time_object.hours )
+                        .arg( time_object.minutes );
+                }
+
+                bottomEdgeTitle = title_to_set;
+            }
+
             bottomEdgePageComponent: AlarmPage {}
         }
     }