Add comparator

Author: axelrindle

packages/core/src/query/rest.ts

@@ -1,33 +1,8 @@
 import { Octokit } from '@octokit/core'
-import semver from 'semver'
 import { CheckOptions, ReleaseDescriptor, TagDescriptor } from '../types'
+import { compareReleases, compareTags } from '../util/comparator'
 import { release, tag } from '../util/scheme-mapper'
 
-/**
- * @param options The options for the version check.
- * @param json The json response from the api.
- */
-function compare(options: CheckOptions, json: any) {
-    let found = false
-    let version = null
-    for (let i = 0; i < json.length; i++) {
-        version = json[i]
-
-        if (options.excludePrereleases) {
-            if (version['prerelease'] !== undefined && version['prerelease']) {
-                continue
-            }
-        }
-
-        if (semver.gt(version[options.fetchTags ? 'name' : 'tag_name'], options.currentVersion)) {
-            found = true
-            break
-        }
-    }
-
-    return found ? version : null
-}
-
 /**
  * Executes an API call on the Github Rest API (v3) that should return the latest version.
  * The returned version is compared to the given version.
@@ -71,12 +46,10 @@ export default async function rest(options: CheckOptions): Promise<ReleaseDescri
         throw new Error(response.data.message)
     }
 
-    // Compare versions
-    const version = compare(options, response.data)
-    if (version) {
-        const mapper = options.fetchTags ? tag : release
-        return mapper(version)
-    } else {
-        return undefined
+    if (options.fetchTags) {
+        return tag(compareTags(options, response.data))
+    }
+    else {
+        return release(compareReleases(options, response.data))
     }
 }

packages/core/src/types.ts

@@ -92,3 +92,15 @@ export interface ReleaseDescriptor {
 export type CallbackFunction = (error?: Error|string, update?: ReleaseDescriptor | TagDescriptor) => void
 
 export type RestHandlerFunction = (res: IncomingMessage) => void
+
+export interface RestResponseTag {
+    name: string
+}
+
+export interface RestResponseRelease {
+    name: string
+    tag_name: string
+    prerelease: boolean
+    published_at: string
+    html_url: string
+}

packages/core/src/util/comparator.ts

@@ -0,0 +1,26 @@
+import { gt } from 'semver'
+import { CheckOptions, RestResponseRelease, RestResponseTag } from '../types'
+
+export function compareTags(options: CheckOptions, data: RestResponseTag[]): RestResponseTag|undefined {
+    for (const item of data) {
+        if (gt(item.name, options.currentVersion)) {
+            return item
+        }
+    }
+
+    return undefined
+}
+
+export function compareReleases(options: CheckOptions, data: RestResponseRelease[]): RestResponseRelease|undefined {
+    for (const item of data) {
+        if (options.excludePrereleases && item.prerelease) {
+            continue
+        }
+
+        if (gt(item.tag_name, options.currentVersion)) {
+            return item
+        }
+    }
+
+    return undefined
+}

packages/core/test/test-comparator.ts

@@ -0,0 +1,53 @@
+import test from 'ava'
+import { CheckOptions, RestResponseRelease, RestResponseTag } from '../src/types'
+import { compareReleases, compareTags } from '../src/util/comparator'
+
+const options: CheckOptions = {
+    owner: 'axelrindle',
+    repo: 'github-version-checker',
+    currentVersion: '1.0.0'
+}
+
+test('comparator returns newer release', t => {
+    const v1337: RestResponseRelease = {
+        name: 'A newer release',
+        html_url: 'https://example.org',
+        prerelease: false,
+        published_at: 'some day',
+        tag_name: 'v1.3.37'
+    }
+    const result = compareReleases(options, [v1337])
+    t.is(result, v1337)
+})
+
+test('comparator returns undefined release', t => {
+    const v1337: RestResponseRelease = {
+        name: 'A newer release',
+        html_url: 'https://example.org',
+        prerelease: false,
+        published_at: 'some day',
+        tag_name: 'v1.3.37'
+    }
+
+    const myOptions = Object.assign({}, options, { currentVersion: 'v2.0.0' })
+    const result = compareReleases(myOptions, [v1337])
+    t.is(result, undefined)
+})
+
+test('comparator returns newer tag', t => {
+    const v1337: RestResponseTag = {
+        name: 'v1.3.37'
+    }
+    const result = compareTags(options, [v1337])
+    t.is(result, v1337)
+})
+
+test('comparator returns undefined tag', t => {
+    const v1337: RestResponseTag = {
+        name: 'v1.3.37'
+    }
+
+    const myOptions = Object.assign({}, options, { currentVersion: 'v2.0.0' })
+    const result = compareTags(myOptions, [v1337])
+    t.is(result, undefined)
+})