Merge lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/getYourCalculusRight into lp:ubuntu-ui-toolkit/staging

[Cris Dywan]

Add unit tests for MathUtils API

[Tim Peeters (tpeeters)]

Please also test the other functions in MathUtils besides clamp().

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/getYourCalculusRight]

1269. By Cris Dywan on 2014-10-02

Unit tests for lerp, project and clampAndProject

1270. By Cris Dywan on 2014-10-02

Don't use global variables for no reason

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1268
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1091/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/5415
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/923
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/923
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/923/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/923
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/5120
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6667
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6667/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/14050

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1091/rebuild

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1270
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1094/
Executed test runs:
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-utopic-touch/5419
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-amd64-ci/926
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/926
        deb: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-armhf-ci/926/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-utopic-i386-ci/926
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-runner-mako/5123
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6671
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/6671/artifact/work/output/*zip*/output.zip
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/14054

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1094/rebuild

review: Needs Fixing (continuous-integration)

[Tim Peeters (tpeeters)]

see (3) inline comments below

[lp:~ubuntu-sdk-team/ubuntu-ui-toolkit/getYourCalculusRight]

1271. By Cris Dywan on 2014-10-02

Better docs for MathUtils functions

1272. By Cris Dywan on 2014-10-02

Typo: s/clamed/clamped

1273. By Cris Dywan on 2014-10-02

Tweaks in the space time continuum

[Tim Peeters (tpeeters)]

thanks, all good!

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'modules/Ubuntu/Components/mathUtils.js'
--- modules/Ubuntu/Components/mathUtils.js	2013-01-31 20:37:32 +0000
+++ modules/Ubuntu/Components/mathUtils.js	2014-10-02 16:35:24 +0000
@@ -16,9 +16,7 @@
 
 .pragma library
 
-// FIXME(loicm) It would be better to have these functions available in a global
-//     set of common native C++ functions.
-
+// Ensure the value x is between min and max
 function clamp(x, min, max) {
     if (min <= max) {
         return Math.max(min, Math.min(x, max));
@@ -28,8 +26,9 @@
     }
 }
 
-function lerp(x, a, b) {
-    return ((1.0 - x) * a) + (x * b);
+// Get the linear interpolation
+function lerp(delta, from, to) {
+    return ((1.0 - delta) * from) + (delta * to);
 }
 
 // Linearly project a value x from [xmin, xmax] into [ymin, ymax]
@@ -37,6 +36,7 @@
     return ((x - xmin) * ymax - (x - xmax) * ymin) / (xmax - xmin)
 }
 
+// Linearly project a value x, but in addition to projectValue it's clamped to xmin/xmax first
 function clampAndProject(x, xmin, xmax, ymin, ymax) {
     return projectValue(clamp(x, xmin, xmax), xmin, xmax, ymin, ymax)
 }

=== added file 'tests/unit/tst_components/tst_math_utils.qml'
--- tests/unit/tst_components/tst_math_utils.qml	1970-01-01 00:00:00 +0000
+++ tests/unit/tst_components/tst_math_utils.qml	2014-10-02 16:35:24 +0000
@@ -0,0 +1,101 @@
+/*
+ * Copyright 2014 Canonical Ltd.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; version 3.
+ *
+ * This program 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 Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import QtQuick 2.0
+import QtTest 1.0
+import Ubuntu.Components 1.1
+
+TestCase {
+    name: "MathUtils"
+
+    function test_clamp_positive_lower() {
+        var minValue = 9
+        var maxValue = 42
+        var clampValue = -7
+
+        var clamped = MathUtils.clamp(clampValue, minValue, maxValue)
+        compare(clamped, minValue, "clamped value not within range")
+    }
+
+    function test_clamp_positive_greater() {
+        var minValue = 9
+        var maxValue = 42
+        var clampValue = 111
+
+        var clamped = MathUtils.clamp(clampValue, minValue, maxValue)
+        compare(clamped, maxValue, "clamped value not within range")
+    }
+
+    function test_clamp_positive_within() {
+        var minValue = 9
+        var maxValue = 53
+        var clampValue = 42
+
+        var clamped = MathUtils.clamp(clampValue, minValue, maxValue)
+        compare(clamped, clampValue, "clamped value changed even though it shouldn't have")
+    }
+
+    function test_clamp_positive_on_border() {
+        var minValue = 9
+        var maxValue = 42
+        var clampValue = 9
+
+        var clamped = MathUtils.clamp(clampValue, minValue, maxValue)
+        compare(clamped, clampValue, "clamped value changed even though it shouldn't have")
+    }
+
+    function test_clamp_negative_lower() {
+        var minValue = -42
+        var maxValue = -9
+        var clampValue = -50
+
+        var clamped = MathUtils.clamp(clampValue, minValue, maxValue)
+        compare(clamped, minValue, "clamped value not within range")
+    }
+
+    function test_clamp_negative_greater() {
+        var minValue = -42
+        var maxValue = -9
+        var clampValue = 50
+
+        var clamped = MathUtils.clamp(clampValue, minValue, maxValue)
+        compare(clamped, maxValue, "clamped value not within range")
+    }
+
+    function test_clamp_postive_and_negative_greater() {
+        var minValue = -42
+        var maxValue = 9
+        var clampValue = 50
+
+        var clamped = MathUtils.clamp(clampValue, minValue, maxValue)
+        compare(clamped, maxValue, "clamped value not within range")
+    }
+
+    function test_lerp() {
+        var lerped = MathUtils.lerp(0.25, 90, 0)
+        compare(lerped, 67.5)
+    }
+
+    function test_project_value() {
+        var projectedValue = MathUtils.projectValue(5, 1, 100, 2, 200)
+        compare(projectedValue, 10)
+    }
+
+    function test_clamp_and_project() {
+        var clampedAndProjectedValue = MathUtils.clampAndProject(5, 1, 10, 2, 200)
+        compare(clampedAndProjectedValue, 90)
+    }
+}