Merge lp:~dgadomski/ubuntu-calculator-app/relative-time-formatting into lp:~ubuntu-calculator-dev/ubuntu-calculator-app/old_trunk

[Dariusz Gadomski]

Reusing relative time formatting implemented for ubuntu-rssreader-app.

As agreed with David Planella I have prepared a common framework for relative time formatting for the rssreader-app (https://code.launchpad.net/~dgadomski/ubuntu-rssreader-app/relative-time-formatting/+merge/176435) and calculator-app.

Please take time to review it. Thanks.

[Riccardo Padovani (rpadovani)]

Looks good, thank you very much for your contribute Dariusz!

review: Approve

[Dariusz Gadomski (dgadomski)]

You're welcome. I'm glad to help.

I have just one question: this merge request remains in Needs Review state. Does it still need an approval from someone else?

Thanks.

[Mihir Soni (mihirsoni)]

Jenkins Bot will automatically merge your request..you don't need to do it manually :)

[Riccardo Padovani (rpadovani)]

Yes, someone (you?) asks explicitly to dpm to review it. As far as I know David will return next week, so we have to wait

[Dariusz Gadomski (dgadomski)]

Oh, I see. I added him because providing a consistent implementations for both: rssreader and calculator was his idea. Thanks for the info. Let's wait for him :)

[Gustavo Pichorim Boiko (boiko)]

I am verifying why the jenkins' continuous integration didn't run on this branch, after CI passes, I will approve (as the code looks good), and top approve it so that it gets merged.

[Gustavo Pichorim Boiko (boiko)]

So, CI won't run for this MR, and as the code looks good, I'll approve it.

review: Approve

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

review: Approve (continuous-integration)

=== modified file 'Simple/SimplePage.qml'
--- Simple/SimplePage.qml	2013-06-09 07:15:44 +0000
+++ Simple/SimplePage.qml	2013-07-30 17:09:30 +0000
@@ -20,6 +20,7 @@
 import Ubuntu.Components 0.1
 import "../engine.js" as CALC
 import "../formula.js" as F
+import "../dateutils.js" as DateUtils
 
 Page {
 
@@ -172,10 +173,10 @@
                 onDateUpdate: {
                     // If is in database
                     if (memory.get(index).dbId !== -1)
-                        memory.get(index).dateText = storage.fromDateToString(storage.fromIdToDate(memory.get(index).dbId));
+                        memory.get(index).dateText = DateUtils.formatRelativeTime(i18n, storage.fromIdToDate(memory.get(index).dbId));
                     // If is in memory but not in database
                     else if (memory.get(index).timeStamp)
-                        memory.get(index).dateText = storage.fromDateToString(memory.get(index).timeStamp);
+                        memory.get(index).dateText = DateUtils.formatRelativeTime(i18n, memory.get(index).timeStamp);
                 }
 
                 onLabelTextUpdated: {

=== modified file 'Storage.qml'
--- Storage.qml	2013-05-25 13:04:23 +0000
+++ Storage.qml	2013-07-30 17:09:30 +0000
@@ -18,6 +18,7 @@
 
 import QtQuick 2.0
 import QtQuick.LocalStorage 2.0
+import "./dateutils.js" as DateUtils
 
 Item {
 
@@ -53,7 +54,7 @@
                         for(var i=res.rows.length - 1; i >= 0; i--){
                             var obj = JSON.parse(res.rows.item(i).calc);
                             obj.dbId = res.rows.item(i).id;
-                            obj.dateText  = fromDateToString(res.rows.item(i).insertDate);
+                            obj.dateText  = DateUtils.formatRelativeTime(i18n, res.rows.item(i).insertDate);
 
                             if (!('mainLabel' in obj))
                                 obj.mainLabel = ''
@@ -88,63 +89,6 @@
         });
     }
 
-    /*
-     * Function fromDateToString
-     *
-     * Given an input object recovers its timestamp and
-     * returns a string based on how much time has passed
-     */
-    function fromDateToString(time) {
-        // TODO: see in settings if user wants AM/PM or 24h
-        // Now all strings are in AM/PM
-        // Below every string there is a comment with string in 24h
-        var then = new Date(time);
-        var now = new Date();
-        var daysElapsed = now.getDate() - then.getDate();
-        var hoursElapsed = now.getHours() - then.getHours();
-        var minutesElapsed = now.getMinutes() - then.getMinutes();
-        var issameMonth = (now.getMonth() === then.getMonth());
-        var relativeTime;
-
-        // Today
-        if (daysElapsed === 0 && issameMonth) {
-            // Between 0 & 59 minutes
-            if (hoursElapsed < 1 || (hoursElapsed === 1 && then.getMinutes() > now.getMinutes())) {
-                // This is for different hours e.g. datestamp 11:58 now 12:02 prints "4 minutes ago"
-                minutesElapsed = minutesElapsed > 0 ? minutesElapsed : minutesElapsed + 60;
-                relativeTime = i18n.tr("%1 minute ago", "%1 minutes ago", minutesElapsed).arg(minutesElapsed);
-
-                // Less than one minute
-                if (minutesElapsed < 1 && minutesElapsed >= 0 )
-                    relativeTime = i18n.tr("A few seconds ago...");
-
-                return relativeTime;
-            }
-
-            // > 1 hour ago
-            relativeTime = i18n.tr("%1 hour ago", "%1 hours ago", hoursElapsed).arg(hoursElapsed);
-        }
-
-        // Between two days and one week ago
-        else if (daysElapsed > 1 && daysElapsed < 7 && issameMonth) {
-            relativeTime = Qt.formatDateTime(then, "ddd, hh:mm AP");
-        }
-
-        // Yesterday
-        else if (daysElapsed === 1 && issameMonth) {
-            // FIXME: we need a way to not split this string
-            // TRANSLATORS: What comes after 'at' is a time, e.g. 'Yesterday at 05:55 PM'
-            relativeTime = i18n.tr("Yesterday at %1").arg(Qt.formatDateTime(then, "hh:mm AP"))
-        }
-
-        // More than one week ago
-        else {
-            relativeTime = Qt.formatDateTime(then, "MMM dd, hh:mm AP");
-        }
-
-        return relativeTime
-    }
-
     // Function to have time from an ID
     function fromIdToDate (dbId) {
         var time;

=== added file 'dateutils.js'
--- dateutils.js	1970-01-01 00:00:00 +0000
+++ dateutils.js	2013-07-30 17:09:30 +0000
@@ -0,0 +1,99 @@
+/*
+ * Copyright 2013 Canonical Ltd.
+ *
+ * This file is part of ubuntu-rssreader-app.
+ *
+ * ubuntu-calculator-app is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * ubuntu-calculator-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/>.
+ */
+
+.pragma library
+
+var SECONDS_LIMIT = 60 * 1000;             // used as reference
+var MINUTES_LIMIT = 60 * SECONDS_LIMIT;    // print minutes up to 1h
+var HOURS_LIMIT = 12 * MINUTES_LIMIT;      // print hours up to 12h
+var DAY_LIMIT = 24 * MINUTES_LIMIT;        // print '<val> days ago' up to 30 days back
+var DAYS_LIMIT = 30 * DAY_LIMIT;           // print '<val> days ago' up to 30 days back
+
+function parseDate(dateAsStr) {
+    return new Date(dateAsStr);
+}
+
+function formatRelativeTime(i18n, dateAsStr) {
+    // fallback if none of the other formatters matched
+    function defaultFallbackFormat(then) {
+        return Qt.formatDateTime(then, i18n.tr("MMMM d"))
+    }
+
+    // Simple matches all diffs < limit, formats using the format function.
+    function SimpleFormatter(limit, format) {
+        this.matches = function (now, then, diff) { return diff < limit }
+        this.format = format
+    }
+
+    // Matches yesterday date
+    function YesterdayFormatter() {
+        this.matches = function (now, then, diff) {
+            return diff < DAY_LIMIT && now.getDate() !== then.getDate();
+        }
+        this.format = function (now, then, diff) {
+            return i18n.tr("Yesterday at %1").arg(
+                        Qt.formatDateTime(then, i18n.tr("h:mm AP")))
+        }
+    }
+
+    // Matches up to 7 days ago (formats date as a weekday + time)
+    function WeekFormatter() {
+        this.matches = function (now, then, diff) {
+            return diff < 7 * DAY_LIMIT
+        }
+        this.format = function (now, then, diff) {
+            return Qt.formatDateTime(then, i18n.tr("ddd, h:mm AP"));
+        }
+    }
+
+    // An array of formatting object processed from 0 up to a matching object.
+    // If none of the object matches a default fallback formatter will be used.
+    var FORMATTERS = [
+                new SimpleFormatter(SECONDS_LIMIT, function (now, then, diff) { return i18n.tr("A few seconds ago...") }),
+                new SimpleFormatter(MINUTES_LIMIT, function (now, then, diff) {
+                    var val = Math.floor(diff / SECONDS_LIMIT)
+                    return i18n.tr("%1 minute ago", "%1 minutes ago", val).arg(val)
+                }),
+                new SimpleFormatter(HOURS_LIMIT, function (now, then, diff) {
+                    var val = Math.floor(diff / MINUTES_LIMIT)
+                    return i18n.tr("%1 hour ago", "%1 hours ago", val).arg(val)
+                }),
+                new YesterdayFormatter(),
+                new WeekFormatter(),
+                new SimpleFormatter(DAYS_LIMIT, function (now, then, diff) {
+                    var val = Math.floor(diff / DAY_LIMIT)
+                    return i18n.tr("%1 day ago", "%1 days ago", val).arg(val)
+                })
+            ]
+
+    function formatDiff(now, then, diff) {
+        for (var i=0; i<FORMATTERS.length; ++i) {
+            var formatter = FORMATTERS[i]
+            if (formatter.matches(now, then, diff)) {
+                return formatter.format(now, then, diff)
+            }
+        }
+        return defaultFallbackFormat(then)
+    }
+
+    var now = new Date();
+    var then = parseDate(dateAsStr);
+    var diff = now - then;
+    var formattedDiff = formatDiff(now, then, diff);
+    return formattedDiff;
+}