Merge lp:~nik90/ubuntu-clock-app/engine-fixes into lp:~gang65/ubuntu-clock-app/ubuntu-clock-stopwatch-runtime-timezone-fix

[Nekhelesh Ramananthan]

Engines fixes which include,
- Ensure get() functions only return the variable value and nothing else
- Renamed property isRunning to Running to match upstream Qt property naming
- Added a updateStopwatch() public slot

[Bartosz Kosiorek (gang65)]

Looks ok to me.

review: Approve

[lp:~nik90/ubuntu-clock-app/engine-fixes]

386. By Nekhelesh Ramananthan on 2015-09-10

Do not emit change signal in setter functions if the value hasn't changed. Also renamed getter functions as per coding convention

387. By Nekhelesh Ramananthan on 2015-09-10

Fixed invalid variable name being used

=== modified file 'app/MainPage.qml'
--- app/MainPage.qml	2015-09-10 08:50:16 +0000
+++ app/MainPage.qml	2015-09-10 22:58:17 +0000
@@ -58,7 +58,7 @@
 
     ScreenSaver {
         // Disable screen dimming/off when stopwatch is running
-        screenSaverEnabled: !stopwatchEngine.isRunning
+        screenSaverEnabled: !stopwatchEngine.running
     }
 
     StopwatchEngine {
@@ -97,7 +97,7 @@
 
         // Show the stopwatch page on app startup if it is running
         Component.onCompleted: {
-            if (stopwatchEngine.isRunning) {
+            if (stopwatchEngine.running) {
                 positionViewAtIndex(1, ListView.SnapPosition)
             }
         }

=== modified file 'app/stopwatch/StopwatchPage.qml'
--- app/stopwatch/StopwatchPage.qml	2015-09-10 08:11:37 +0000
+++ app/stopwatch/StopwatchPage.qml	2015-09-10 22:58:17 +0000
@@ -31,9 +31,9 @@
         id: refreshTimer
         interval: 45
         repeat: true
-        running: stopwatchEngine.isRunning
+        running: stopwatchEngine.running
         onTriggered: {
-             stopwatch.milliseconds = stopwatchEngine.totalTimeOfStopwatch
+             stopwatchEngine.updateStopwatch();
         }
     }
 
@@ -64,11 +64,11 @@
 
         Button {
             id: stopButton
-            width: stopwatchEngine.previousTimeOfStopwatch !== 0 || stopwatchEngine.isRunning ? (parent.width - parent.spacing) / 2 : parent.width
-            color: !stopwatchEngine.isRunning ? UbuntuColors.green : UbuntuColors.red
-            text: stopwatchEngine.isRunning ? i18n.tr("Stop") : (stopwatchEngine.previousTimeOfStopwatch === 0 ? i18n.tr("Start") : i18n.tr("Resume"))
+            width: stopwatchEngine.previousTimeOfStopwatch !== 0 || stopwatchEngine.running ? (parent.width - parent.spacing) / 2 : parent.width
+            color: !stopwatchEngine.running ? UbuntuColors.green : UbuntuColors.red
+            text: stopwatchEngine.running ? i18n.tr("Stop") : (stopwatchEngine.previousTimeOfStopwatch === 0 ? i18n.tr("Start") : i18n.tr("Resume"))
             onClicked: {
-                if (stopwatchEngine.isRunning) {
+                if (stopwatchEngine.running) {
                     stopwatchEngine.pauseStopwatch();
                 } else {
                     stopwatchEngine.startStopwatch();
@@ -83,12 +83,12 @@
 
         Button {
             id: lapButton
-            text: stopwatchEngine.isRunning ? i18n.tr("Lap") : i18n.tr("Clear")
-            width:  stopwatchEngine.previousTimeOfStopwatch !== 0 || stopwatchEngine.isRunning ? (parent.width - parent.spacing) / 2 : 0
+            text: stopwatchEngine.running ? i18n.tr("Lap") : i18n.tr("Clear")
+            width:  stopwatchEngine.previousTimeOfStopwatch !== 0 || stopwatchEngine.running ? (parent.width - parent.spacing) / 2 : 0
             strokeColor: UbuntuColors.lightGrey
-            visible:  stopwatchEngine.previousTimeOfStopwatch !== 0 || stopwatchEngine.isRunning
+            visible:  stopwatchEngine.previousTimeOfStopwatch !== 0 || stopwatchEngine.running
             onClicked: {
-                if (stopwatchEngine.isRunning) {
+                if (stopwatchEngine.running) {
                     stopwatchEngine.addLap()
                 } else {
                     stopwatchEngine.clearStopwatch()
@@ -116,7 +116,7 @@
         Loader {
             id: lapListViewLoader
             anchors.fill: parent
-            sourceComponent: !stopwatchEngine.isRunning && stopwatchEngine.totalTimeOfStopwatch === 0 ? undefined : lapListViewComponent
+            sourceComponent: !stopwatchEngine.running && stopwatchEngine.totalTimeOfStopwatch === 0 ? undefined : lapListViewComponent
         }
     }
 

=== modified file 'backend/modules/Stopwatch/engine.cpp'
--- backend/modules/Stopwatch/engine.cpp	2015-09-10 01:09:57 +0000
+++ backend/modules/Stopwatch/engine.cpp	2015-09-10 22:58:17 +0000
@@ -28,7 +28,9 @@
      when Ubuntu Touch moves over to Qt 5.5. AppConfigLocation will directly return
      /home/phablet/.config/com.ubuntu.clock path.
     */
-    m_settings(QStandardPaths::standardLocations(QStandardPaths::ConfigLocation).first() + "/com.ubuntu.clock/com.ubuntu.clock.conf", QSettings::IniFormat)
+    m_settings(QStandardPaths::standardLocations(QStandardPaths::ConfigLocation).first() + "/com.ubuntu.clock/com.ubuntu.clock.conf", QSettings::IniFormat),
+    m_previousTimeInmsecs(0),
+    m_totalTimeInmsecs(0)
 {
     qDebug() << "[LOG] Loading laps from " << m_settings.fileName();
     QDateTime startTime = m_settings.value("Stopwatch/startDateTime").toDateTime();
@@ -36,13 +38,13 @@
     {
         m_stopwatchStartDateTime = startTime;
     }
-    else
-    {
-        startStopwatch();
-    }
 
     m_isStopwatchRunning = m_settings.value("Stopwatch/isStopwatchRunning").toBool();
     m_previousTimeInmsecs = m_settings.value("Stopwatch/previousTimeInmsecs").toInt();
+
+    if(m_previousTimeInmsecs != 0) {
+        setTotalTimeOfStopwatch(m_previousTimeInmsecs);
+    }
 }
 
 int StopwatchEngine::rowCount(const QModelIndex &parent) const
@@ -87,7 +89,7 @@
 {
     QVariantList laps = m_settings.value("Stopwatch/laps").toList();
     beginInsertRows(QModelIndex(), 0, 0);
-    int timeDiff = getTotalTimeOfStopwatch();
+    int timeDiff = m_totalTimeInmsecs;
     laps.prepend(timeDiff);
     m_settings.setValue("Stopwatch/laps", laps);
     endInsertRows();
@@ -102,67 +104,74 @@
     endRemoveRows();
 }
 
+void StopwatchEngine::setStopwatchStartDateTime()
+{
+    m_stopwatchStartDateTime = QDateTime::currentDateTimeUtc();
+    m_settings.setValue("Stopwatch/startDateTime", m_stopwatchStartDateTime);
+}
+
 void StopwatchEngine::startStopwatch()
 {
-    if(m_isStopwatchRunning == false)
-    {
-        m_stopwatchStartDateTime = QDateTime::currentDateTimeUtc();
-        m_settings.setValue("Stopwatch/startDateTime", m_stopwatchStartDateTime);
+    setStopwatchStartDateTime();
+    setRunning(true);
+}
 
-        setIsRunning(true);
-    }
+void StopwatchEngine::updateStopwatch()
+{
+    setTotalTimeOfStopwatch(m_previousTimeInmsecs + m_stopwatchStartDateTime.msecsTo(QDateTime::currentDateTimeUtc()));
 }
 
 void StopwatchEngine::pauseStopwatch()
 {
     setPreviousTimeOfStopwatch(m_previousTimeInmsecs + m_stopwatchStartDateTime.msecsTo(QDateTime::currentDateTimeUtc()));
-    setIsRunning(false);
+    setTotalTimeOfStopwatch(m_previousTimeInmsecs);
+    setRunning(false);
 }
 
 void StopwatchEngine::clearStopwatch()
 {
+    setPreviousTimeOfStopwatch(0);
     setTotalTimeOfStopwatch(0);
-    setPreviousTimeOfStopwatch(0);
 
     beginResetModel();
     m_settings.setValue("Stopwatch/laps", QVariantList());
     endResetModel();
-
-    setIsRunning(false);
 }
 
-bool StopwatchEngine::getIsRunning()
+bool StopwatchEngine::running() const
 {
     return m_isStopwatchRunning;
 }
 
-int StopwatchEngine::getPreviousTimeOfStopwatch()
+int StopwatchEngine::previousTimeOfStopwatch() const
 {
     return m_previousTimeInmsecs;
 }
 
-int StopwatchEngine::getTotalTimeOfStopwatch()
+int StopwatchEngine::totalTimeOfStopwatch() const
 {
-    if(m_isStopwatchRunning == false)
-    {
-        m_totalTimeInmsecs = m_previousTimeInmsecs;
-    }
-    else
-    {
-        m_totalTimeInmsecs = m_previousTimeInmsecs + m_stopwatchStartDateTime.msecsTo(QDateTime::currentDateTimeUtc());
-    }
     return m_totalTimeInmsecs;
 }
 
-void StopwatchEngine::setIsRunning(bool value)
+void StopwatchEngine::setRunning(bool value)
 {
+    if(value == m_isStopwatchRunning)
+    {
+        return;
+    }
+
     m_isStopwatchRunning = value;
     m_settings.setValue("Stopwatch/isStopwatchRunning", m_isStopwatchRunning);
-    emit isRunningChanged();
+    emit runningChanged();
 }
 
 void StopwatchEngine::setPreviousTimeOfStopwatch(int value)
 {
+    if(value == m_previousTimeInmsecs)
+    {
+        return;
+    }
+
     m_previousTimeInmsecs = value;
     m_settings.setValue("Stopwatch/previousTimeInmsecs", m_previousTimeInmsecs);
     emit previousTimeOfStopwatchChanged();
@@ -170,6 +179,11 @@
 
 void StopwatchEngine::setTotalTimeOfStopwatch(int value)
 {
+    if(value == m_totalTimeInmsecs)
+    {
+        return;
+    }
+
     m_totalTimeInmsecs = value;
     emit totalTimeOfStopwatchChanged();
 }

=== modified file 'backend/modules/Stopwatch/engine.h'
--- backend/modules/Stopwatch/engine.h	2015-09-10 10:58:51 +0000
+++ backend/modules/Stopwatch/engine.h	2015-09-10 22:58:17 +0000
@@ -27,21 +27,21 @@
 {
     Q_OBJECT
 
-    Q_PROPERTY( bool isRunning
-                READ getIsRunning
-                NOTIFY isRunningChanged)
+    Q_PROPERTY( bool running
+                READ running
+                NOTIFY runningChanged)
 
     Q_PROPERTY( int totalTimeOfStopwatch
-                READ getTotalTimeOfStopwatch
+                READ totalTimeOfStopwatch
                 NOTIFY totalTimeOfStopwatchChanged)
 
     Q_PROPERTY( int previousTimeOfStopwatch
-                READ getPreviousTimeOfStopwatch
+                READ previousTimeOfStopwatch
                 NOTIFY previousTimeOfStopwatchChanged)
 
 signals:
     // Signal to notify the running status change to QML
-    void isRunningChanged();
+    void runningChanged();
 
     // Signal to notify the total time change to QML
     void totalTimeOfStopwatchChanged();
@@ -71,34 +71,30 @@
     QHash<int, QByteArray> roleNames() const override;
 
 public slots:
-    // Function to add a stopwatch lap
     void addLap();
-
-    // Function to remove a stopwatch lap
     void removeLap(int lapIndex);
 
     void startStopwatch();
-
     void pauseStopwatch();
-
     void clearStopwatch();
-
-    bool getIsRunning();
-
-    int getTotalTimeOfStopwatch();
-
-    int getPreviousTimeOfStopwatch();
+    void updateStopwatch();
+
+    // Getter functions for the properties
+    bool running() const;
+    int totalTimeOfStopwatch() const;
+    int previousTimeOfStopwatch() const;
 
 private:
-    void setIsRunning(bool value);
+    void setStopwatchStartDateTime();
 
+    void setRunning(bool value);
     void setTotalTimeOfStopwatch(int value);
-
     void setPreviousTimeOfStopwatch(int value);
 
     QSettings m_settings;
 
     QDateTime m_stopwatchStartDateTime;
+
     bool m_isStopwatchRunning;
     int m_previousTimeInmsecs;
     int m_totalTimeInmsecs;