feat: Allow custom version comparison function (#57)

* Allow custom version comparison function

* Document updateNeeded in readme

Author: Subtletree

README.md

@@ -34,6 +34,7 @@ A convention-based version update notifier. Use it to notify users already on th
 * `showReload` - _true_ shows a reload button the user can click to refresh. _false_ hides the button. **default: true**
 * `reloadButtonText` - Sets the text for the default reload button. **default: "Reload"**
 * `onNewVersion(newVersion, oldVersion)` - a closure action that is called whenever a new version is detected. You can use this to track the version status elsewhere in your app (outside the component).
+* `updateNeeded(oldVersion, newVersion)` - a function that is called to check if an update message should be shown.   For example, a function could be passed that only shows a message on major version changes. **default: Always show message on any version change**
 
 ```handlebars
 {{new-version-notifier updateInterval=<value> versionFileName="<value>" updateMessage="<value>" showReload=true}}

addon/components/new-version-notifier/component.js

@@ -75,7 +75,7 @@ export default Component.extend({
           const currentVersion = this.get('version');
           const newVersion     = res && res.trim();
 
-          if (currentVersion && newVersion !== currentVersion) {
+          if (this.updateNeeded(currentVersion, newVersion)) {
             const message = this.get('updateMessage')
               .replace('{{oldVersion}}', currentVersion)
               .replace('{{newVersion}}', newVersion);
@@ -104,6 +104,9 @@ export default Component.extend({
     }
   }),
 
+  updateNeeded(currentVersion, newVersion) {
+    return currentVersion && newVersion !== currentVersion;
+  },
 
   actions: {
     reload() {

tests/integration/components/new-version-notifier-test.js

@@ -150,4 +150,58 @@ module('Integration | Component | new version notifier', function(hooks) {
     await waitUntil(() => called, { timeout: 150 });
     assert.ok(onErrorCalled, 'onError was called');
   });
+
+  test('it accepts a custom updateNeeded function', async function(assert) {
+    assert.expect(5);
+    let done = assert.async(2);
+
+    let callCount = 0;
+
+    this.server.get('/VERSION.txt', function(){
+      ++callCount
+      switch (callCount) {
+        case 0:
+          return 'v1.0.0';
+        case 1:
+          return 'v1.0.1';
+        case 2:
+          return 'v1.0.2';
+        case 3:
+          return 'v1.1.0';
+        default:
+          return null;
+      }
+    });
+
+    set(this, "onNewVersion", (newVersion, oldVersion) => {
+      assert.equal(newVersion, "v1.1.0", "newVersion v1.1.0 is sent to onNewVersion");
+      assert.equal(oldVersion, "v1.0.2", "oldVersion v1.0.2 is sent to onNewVersion");
+      done();
+    });
+    set(this, "enableInTests", true);
+
+    set(this, "updateNeeded", function(currentVersion, newVersion) {
+      if (!currentVersion) { return false }
+
+      // Only compare major and minor version number
+      let currentV = currentVersion.substr(0, currentVersion.lastIndexOf("."));
+      let newV = newVersion.substr(0, newVersion.lastIndexOf("."));
+
+      return newV !== currentV;
+    });
+
+    render(hbs`{{new-version-notifier updateNeeded=updateNeeded updateInterval=100 enableInTests=enableInTests onNewVersion=onNewVersion}}`);
+
+    await waitUntil(() => callCount === 1, { timeout: 95 });
+    assert.equal(callCount, 1, "1 call was made");
+
+    await waitUntil(() => callCount === 2, { timeout: 190 });
+    assert.equal(callCount, 2);
+
+    await waitUntil(() => callCount === 3, { timeout: 190 });
+    assert.equal(callCount, 3);
+
+    set(this, "enableInTests", false); // stop the loop from continuing
+    done();
+  });
 });