Merge lp:~ubuntu-clock-dev/ubuntu-clock-app/stopwatch-feature-extended into lp:~ubuntu-clock-dev/ubuntu-clock-app/stopwatch-feature-staging

[Nekhelesh Ramananthan]

Added stopwatch feature to keep working in the background even if clock app is closed / phone is switched off.

Added stopwatch feature to keep working in the background even if clock app is closed / phone is switched off.

[Nekhelesh Ramananthan (nik90)]

@bartosz I made the following changes to your MP,

1. Renamed plugin to Stopwatch.LapHistory. (Much before our discussion yesterday. We can get back to this in a MP during the weekend) For now let's leave it as such

2. Added comments, fixme to the plugin for better understandability.

3. Stopwatch laps are stored in com.ubuntu.clock.conf file itself in the [Stopwatch] category.

4. Removed the int count() function since we don't need it anymore in the QML side.

Personally I think this branch is ready and so I am approving. Feel free to go through it once more on your own, test it and then top-approve it. Then we merge it into the stopwatch-staging branch and the merge that branch to trunk tonight.

review: Approve (code review, testing)

[Nekhelesh Ramananthan (nik90)]

I tested the swipe delete feature and it works correctly. I tested on phone and desktop, with multiple clock app restarts to check the stopwatch running background feature and no errors. everything works as expected.

review: Approve

[Bartosz Kosiorek (gang65)]

It is working correctly for me

review: Approve

[Nekhelesh Ramananthan (nik90)]

* Does the MP add/remove user visible strings? If Yes, has the pot file been
    updated?

No strings changed.

* Does the MP change the UI? If Yes, has it been approved by design?

Minor UX change that was approved.

* Did you perform an exploratory manual test run of your code change and any
    related functionality?

Extensive testing done on desktop and phone

* If the MP fixes a bug or implements a feature, are there accompanying unit
    and autopilot tests?

Not required

* Is the clock app trunk buildable and runnable using Qtcreator?

Yes
* Was the debian changelog updated?

No!

* Was the copyright years updated if necessary?

Yes

[Nekhelesh Ramananthan (nik90)]

Please update debian changelog since you are fixing a bug/feature request. thnx

review: Needs Fixing

[lp:~ubuntu-clock-dev/ubuntu-clock-app/stopwatch-feature-extended]

382. By Bartosz Kosiorek on 2015-08-20

Keep running stopwatch even when the clock or phone is turned off (LP: #1484942)

[Nekhelesh Ramananthan (nik90)]

Approved!

review: Approve

=== modified file 'app/MainPage.qml'
--- app/MainPage.qml	2015-08-20 15:32:48 +0000
+++ app/MainPage.qml	2015-08-20 20:37:24 +0000
@@ -19,6 +19,7 @@
 import QtQuick 2.4
 import Ubuntu.Components 1.2
 import QtSystemInfo 5.0
+import Qt.labs.settings 1.0
 import "upstreamcomponents"
 import "alarm"
 import "clock"
@@ -59,6 +60,14 @@
         screenSaverEnabled: !stopwatchPage.running
     }
 
+    Settings {
+        id: stopwatchState
+        category: "Stopwatch"
+        property alias startTime: stopwatchPage.startTime
+        property alias running: stopwatchPage.running
+        property alias oldDiff: stopwatchPage.oldDiff
+    }
+
     VisualItemModel {
         id: navigationModel
         ClockPage {
@@ -89,6 +98,12 @@
     ListView {
         id: listview
 
+        // Show the stopwatch page on app startup if it is running
+        Component.onCompleted: {
+            if (stopwatchState.running)
+                positionViewAtIndex(1, ListView.SnapPosition)
+        }
+
         anchors {
             top: headerRow.bottom
             left: parent.left

=== modified file 'app/stopwatch/LapListView.qml'
--- app/stopwatch/LapListView.qml	2015-08-20 15:52:32 +0000
+++ app/stopwatch/LapListView.qml	2015-08-20 20:37:24 +0000
@@ -81,7 +81,7 @@
                 Action {
                     iconName: "delete"
                     onTriggered: {
-                        lapsModel.remove(index, 1)
+                        lapHistory.removeLap(index)
                     }
                 }
             ]

=== modified file 'app/stopwatch/StopwatchPage.qml'
--- app/stopwatch/StopwatchPage.qml	2015-08-17 12:14:10 +0000
+++ app/stopwatch/StopwatchPage.qml	2015-08-20 20:37:24 +0000
@@ -18,6 +18,7 @@
 
 import QtQuick 2.4
 import Ubuntu.Components 1.2
+import Stopwatch.LapHistory 1.0
 
 Item {
     id: _stopwatchPage
@@ -57,18 +58,7 @@
         oldDiff = 0
         startTime = new Date()
         snapshot = startTime
-        lapsModel.clear()
-    }
-
-    ListModel {
-        id: lapsModel
-        function addLap(totalTime) {
-            if (lapsModel.count === 0) {
-                append({"laptime": totalTime, "totaltime": totalTime})
-            } else {
-                insert(0, {"laptime": totalTime - lapsModel.get(0).totaltime, "totaltime": totalTime})
-            }
-        }
+        lapHistory.clear()
     }
 
     Timer {
@@ -134,7 +124,7 @@
             onClicked: {
                 if (_stopwatchPage.running) {
                     _stopwatchPage.update()
-                    lapsModel.addLap(_stopwatchPage.totalTimeDiff)
+                    lapHistory.addLap(_stopwatchPage.totalTimeDiff)
                 } else {
                     _stopwatchPage.clear()
                 }
@@ -165,11 +155,15 @@
         }
     }
 
+    LapHistory {
+        id: lapHistory
+    }
+
     Component {
         id: lapListViewComponent
         LapListView {
             id: lapListView
-            model: lapsModel
+            model: lapHistory
         }
     }
 }

=== modified file 'backend/CMakeLists.txt'
--- backend/CMakeLists.txt	2015-07-16 21:02:18 +0000
+++ backend/CMakeLists.txt	2015-08-20 20:37:24 +0000
@@ -34,6 +34,12 @@
     modules/GeoLocation/geolocation.cpp
 )
 
+set(
+    stopwatchlaphistory_SRCS
+    modules/Stopwatch/LapHistory/backend.cpp
+    modules/Stopwatch/LapHistory/history.cpp
+)
+
 add_library(timezone MODULE
     ${timezone_SRCS}
 )
@@ -50,6 +56,11 @@
     ${geolocation_SRCS}
 )
 
+add_library(stopwatchlaphistory MODULE
+    ${stopwatchlaphistory_SRCS}
+)
+
+
 set_target_properties(timezone PROPERTIES
     LIBRARY_OUTPUT_DIRECTORY Timezone
 )
@@ -66,10 +77,15 @@
     LIBRARY_OUTPUT_DIRECTORY GeoLocation
 )
 
+set_target_properties(stopwatchlaphistory PROPERTIES
+    LIBRARY_OUTPUT_DIRECTORY Stopwatch/LapHistory
+)
+
 qt5_use_modules(datetime Gui Qml Quick)
 qt5_use_modules(timezone Gui Qml Quick)
 qt5_use_modules(alarmsettings Gui Qml Quick DBus)
 qt5_use_modules(geolocation Gui Qml Quick)
+qt5_use_modules(stopwatchlaphistory Qml)
 
 # Copy qmldir file to build dir for running in QtCreator
 add_custom_target(timezone-qmldir ALL
@@ -92,6 +108,12 @@
     DEPENDS ${QMLFILES}
 )
 
+add_custom_target(stopwatchlaphistory-qmldir ALL
+    COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/modules/Stopwatch/LapHistory/qmldir ${CMAKE_CURRENT_BINARY_DIR}/Stopwatch/LapHistory
+    DEPENDS ${QMLFILES}
+)
+
+
 # Install plugin file
 install(TARGETS timezone DESTINATION ${MODULE_PATH}/Timezone/)
 install(FILES   modules/Timezone/qmldir DESTINATION ${MODULE_PATH}/Timezone/)
@@ -104,3 +126,6 @@
 
 install(TARGETS geolocation DESTINATION ${MODULE_PATH}/GeoLocation/)
 install(FILES   modules/GeoLocation/qmldir DESTINATION ${MODULE_PATH}/GeoLocation/)
+
+install(TARGETS stopwatchlaphistory DESTINATION ${MODULE_PATH}/Stopwatch/LapHistory/)
+install(FILES   modules/Stopwatch/LapHistory/qmldir DESTINATION ${MODULE_PATH}/Stopwatch/LapHistory/)

=== added directory 'backend/modules/Stopwatch'
=== added directory 'backend/modules/Stopwatch/LapHistory'
=== added file 'backend/modules/Stopwatch/LapHistory/backend.cpp'
--- backend/modules/Stopwatch/LapHistory/backend.cpp	1970-01-01 00:00:00 +0000
+++ backend/modules/Stopwatch/LapHistory/backend.cpp	2015-08-20 20:37:24 +0000
@@ -0,0 +1,34 @@
+/*
+ * Copyright (C) 2015 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/>.
+ */
+
+#include <QtQml>
+#include <QtQml/QQmlContext>
+#include "backend.h"
+#include "history.h"
+
+void BackendPlugin::registerTypes(const char *uri)
+{
+    Q_ASSERT(uri == QLatin1String("Stopwatch.LapHistory"));
+
+    qmlRegisterType<LapHistory>(uri, 1, 0, "LapHistory");
+}
+
+void BackendPlugin::initializeEngine(QQmlEngine *engine, const char *uri)
+{
+    QQmlExtensionPlugin::initializeEngine(engine, uri);
+}

=== added file 'backend/modules/Stopwatch/LapHistory/backend.h'
--- backend/modules/Stopwatch/LapHistory/backend.h	1970-01-01 00:00:00 +0000
+++ backend/modules/Stopwatch/LapHistory/backend.h	2015-08-20 20:37:24 +0000
@@ -0,0 +1,35 @@
+/*
+ * Copyright (C) 2015 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/>.
+ */
+
+#ifndef BACKEND_PLUGIN_H
+#define BACKEND_PLUGIN_H
+
+#include <QtQml/QQmlEngine>
+#include <QtQml/QQmlExtensionPlugin>
+
+class BackendPlugin : public QQmlExtensionPlugin
+{
+    Q_OBJECT
+    Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface")
+
+public:
+    void registerTypes(const char *uri);
+    void initializeEngine(QQmlEngine *engine, const char *uri);
+};
+#endif // BACKEND_PLUGIN_H
+

=== added file 'backend/modules/Stopwatch/LapHistory/history.cpp'
--- backend/modules/Stopwatch/LapHistory/history.cpp	1970-01-01 00:00:00 +0000
+++ backend/modules/Stopwatch/LapHistory/history.cpp	2015-08-20 20:37:24 +0000
@@ -0,0 +1,97 @@
+/*
+ * Copyright (C) 2015 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/>.
+ */
+
+#include "history.h"
+
+#include <QStandardPaths>
+#include <QDebug>
+
+LapHistory::LapHistory(QObject *parent) :
+    QAbstractListModel(parent),
+    /*
+     #FIXME: Change QStandardPaths::ConfigLocation to QStandardPaths::AppConfigLocation
+     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)
+{
+    qDebug() << "[LOG] Loading laps from " << m_settings.fileName();
+}
+
+int LapHistory::rowCount(const QModelIndex &parent) const
+{
+    /*
+     QT's models also handle tables and tree views, so the index is not just a
+     integer but consists of a parent, row and a column. Since we using a simple
+     list model, let's ignore the parent. Q_UNUSED(parent) gets rid of the
+     compiler warning about the unused variable.
+    */
+    Q_UNUSED(parent)
+
+    return m_settings.value("Stopwatch/laps").toList().count();
+}
+
+QVariant LapHistory::data(const QModelIndex &index, int role) const
+{
+    switch (role) {
+    case RoleTotalTime:
+        return m_settings.value("Stopwatch/laps").toList().at(index.row());
+    case RoleDiffToPrevious: {
+        int previous = 0;
+        if(index.row() != m_settings.value("Stopwatch/laps").toList().count() - 1)
+        {
+            previous = data(this->index(index.row() + 1), RoleTotalTime).toInt();
+        }
+        return m_settings.value("Stopwatch/laps").toList().at(index.row()).toInt() - previous;
+    }
+    }
+    return QVariant();
+}
+
+QHash<int, QByteArray> LapHistory::roleNames() const
+{
+    QHash< int, QByteArray> roles;
+    roles.insert(RoleTotalTime, "totaltime");
+    roles.insert(RoleDiffToPrevious, "laptime");
+    return roles;
+}
+
+void LapHistory::addLap(int timeDiff)
+{
+    QVariantList laps = m_settings.value("Stopwatch/laps").toList();
+    beginInsertRows(QModelIndex(), 0, 0);
+    laps.prepend(timeDiff);
+    m_settings.setValue("Stopwatch/laps", laps);
+    endInsertRows();
+}
+
+void LapHistory::removeLap(int lapIndex)
+{
+    QVariantList laps = m_settings.value("Stopwatch/laps").toList();
+    beginRemoveRows(QModelIndex(), lapIndex, lapIndex);
+    laps.removeAt(lapIndex);
+    m_settings.setValue("Stopwatch/laps", laps);
+    endRemoveRows();
+}
+
+void LapHistory::clear()
+{
+    beginResetModel();
+    m_settings.setValue("Stopwatch/laps", QVariantList());
+    endResetModel();
+}

=== added file 'backend/modules/Stopwatch/LapHistory/history.h'
--- backend/modules/Stopwatch/LapHistory/history.h	1970-01-01 00:00:00 +0000
+++ backend/modules/Stopwatch/LapHistory/history.h	2015-08-20 20:37:24 +0000
@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2015 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/>.
+ */
+
+#ifndef HISTORY_H
+#define HISTORY_H
+
+#include <QAbstractListModel>
+#include <QSettings>
+
+class LapHistory : public QAbstractListModel
+{
+    Q_OBJECT
+
+public:
+    enum Role {
+        RoleTotalTime,
+        RoleDiffToPrevious
+    };
+
+    explicit LapHistory(QObject *parent = 0);
+
+    /*
+     Let's override the pure virtual functions (the ones marked as
+     "virtual" and have "= 0" in the end.
+    */
+    int rowCount(const QModelIndex &parent) const;
+    QVariant data(const QModelIndex &index, int role) const;
+
+    /*
+     As QML can't really deal with the Roles enum above, we need a mapping
+     between the enum and strings
+    */
+    QHash<int, QByteArray> roleNames() const override;
+
+public slots:
+    // Function to add a stopwatch lap
+    void addLap(int timeDiff);
+
+    // Function to remove a stopwatch lap
+    void removeLap(int lapIndex);
+
+    // Function to clear all stopwatch laps
+    void clear();
+
+private:
+    QSettings m_settings;
+};
+
+#endif // HISTORY_H

=== added file 'backend/modules/Stopwatch/LapHistory/qmldir'
--- backend/modules/Stopwatch/LapHistory/qmldir	1970-01-01 00:00:00 +0000
+++ backend/modules/Stopwatch/LapHistory/qmldir	2015-08-20 20:37:24 +0000
@@ -0,0 +1,2 @@
+module Stopwatch.LapHistory
+plugin stopwatchlaphistory

=== modified file 'debian/changelog'
--- debian/changelog	2015-08-17 12:27:20 +0000
+++ debian/changelog	2015-08-20 20:37:24 +0000
@@ -7,6 +7,7 @@
   * Fix default alarm time issue (LP: #1484926)
   * Translate city and country names after language switch (LP: #1477492)
   * Fix issue when unable to add city/country with apostrophes (LP: #1473074)  
+  * Keep running stopwatch even when the clock or phone is turned off (LP: #1484942)
 
   [Nekhelesh Ramananthan]
   * Increase the height of times in the alarm screen (LP: #1365428)

=== modified file 'debian/control'
--- debian/control	2015-08-13 18:44:07 +0000
+++ debian/control	2015-08-20 20:37:24 +0000
@@ -10,7 +10,8 @@
                ubuntu-touch-sounds,
                suru-icon-theme | ubuntu-mobile-icons,
                qml-module-qttest,
-	       qml-module-qtsysteminfo,	
+	       qml-module-qtsysteminfo,
+	       qml-module-qt-labs-settings,	
                qtdeclarative5-u1db1.0,
                qtdeclarative5-qtmultimedia-plugin,
                qtdeclarative5-qtpositioning-plugin,