rename polyfills -> utils. Improve utils documentation

ShMcK · ShMcK · commit 7726b7dac622 · 2016-09-14T21:48:42.000-07:00
diff --git a/lib/index.js b/lib/index.js
@@ -3,15 +3,15 @@ var ReactDOM = require('react-dom');
 var SidePanel_1 = require('./components/SidePanel');
 var StatusBar_1 = require('./components/StatusBar');
 var setup_1 = require('./modules/setup');
-var polyfills_1 = require('./polyfills');
 var store_1 = require('./store');
 var subscriptions_1 = require('./subscriptions');
+var utils_1 = require('./utils');
 var injectTapEventPlugin = require('react-tap-event-plugin');
 process.env.NODE_ENV = 'production';
 var Main = (function () {
     function Main() {
         injectTapEventPlugin();
-        polyfills_1.default();
+        utils_1.default();
         store_1.default.dispatch(setup_1.setupVerify());
         this.side = SidePanel_1.sideElement.init();
         this.subscriptions = new subscriptions_1.default();
diff --git a/lib/modules/tests/test-run/config-path.js b/lib/modules/tests/test-run/config-path.js
@@ -1,6 +1,6 @@
 "use strict";
 var path_1 = require('path');
-var system_1 = require('../../../polyfills/system');
+var system_1 = require('../../../utils/system');
 function configPath(_a) {
     var dir = _a.dir, tutorial = _a.tutorial, testPath = _a.testPath;
     if (system_1.isWindows) {
diff --git a/lib/modules/tutorial/utils/config-runner.js b/lib/modules/tutorial/utils/config-runner.js
@@ -1,6 +1,6 @@
 "use strict";
 var path_1 = require('path');
-var system_1 = require('../../../polyfills/system');
+var system_1 = require('../../../utils/system');
 var node_file_exists_1 = require('node-file-exists');
 function configRunner(name, runner, dir) {
     var flatDep = path_1.join(dir, 'node_modules', runner, 'package.json');
diff --git a/lib/modules/tutorials/latest-version.js b/lib/modules/tutorials/latest-version.js
@@ -0,0 +1,13 @@
+"use strict";
+var fetch_1 = require('../../utils/fetch');
+var apiCall = function (name) { return ("https://registry.npmjs.org/" + name); };
+function getLatestVersion(name, current) {
+    return fetch_1.default(apiCall(name))
+        .then(function (res) {
+        if (res) {
+            JSON.parse(res)['dist-tags'].latest;
+            return true;
+        }
+        return false;
+    });
+}
diff --git a/lib/utils/fetch.js b/lib/utils/fetch.js
@@ -0,0 +1,17 @@
+"use strict";
+var fetch = function (url) {
+    return new Promise(function (resolve, reject) {
+        var lib = url.startsWith('https') ? require('https') : require('http');
+        var request = lib.get(url, function (response) {
+            if (response.statusCode < 200 || response.statusCode > 299) {
+                reject(new Error('Failed to load page, status code: ' + response.statusCode));
+            }
+            var body = [];
+            response.on('data', function (chunk) { return body.push(chunk); });
+            response.on('end', function () { return resolve(body.join('')); });
+        });
+        request.on('error', function (err) { return reject(err); });
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = fetch;
diff --git a/lib/utils/index.js b/lib/utils/index.js
@@ -0,0 +1,7 @@
+"use strict";
+var object_values_1 = require('./object-values');
+function loadPolyfills() {
+    object_values_1.default();
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = loadPolyfills;
diff --git a/lib/utils/object-values.js b/lib/utils/object-values.js
@@ -0,0 +1,14 @@
+"use strict";
+function polyfillObjectValues() {
+    if (typeof Object.values !== 'function') {
+        Object.values = function (obj) {
+            var vals = new Set();
+            for (var key in obj) {
+                vals.add(obj[key]);
+            }
+            return Array.from(vals);
+        };
+    }
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = polyfillObjectValues;
diff --git a/lib/utils/system.js b/lib/utils/system.js
@@ -0,0 +1,2 @@
+"use strict";
+exports.isWindows = window.navigator.appVersion.indexOf('Win') > -1 || false;
diff --git a/src/index.ts b/src/index.ts
@@ -4,9 +4,9 @@ import * as ReactDOM from 'react-dom';
 import {SideRoot, sideElement} from './components/SidePanel';
 import addToStatusBar from './components/StatusBar';
 import {setupVerify} from './modules/setup';
-import loadPolyfills from './polyfills';
 import store from './store';
 import Subscriptions from './subscriptions';
+import loadPolyfills from './utils/polyfills';
 import * as injectTapEventPlugin from 'react-tap-event-plugin';
 
 // React optimization
diff --git a/src/modules/tests/test-run/config-path.ts b/src/modules/tests/test-run/config-path.ts
@@ -1,6 +1,6 @@
 import {join} from 'path';
 
-import {isWindows} from '../../../polyfills/system';
+import {isWindows} from '../../../utils/system';
 
 /**
  * set paths to tests as absolute paths 
diff --git a/src/modules/tutorial/utils/config-runner.ts b/src/modules/tutorial/utils/config-runner.ts
@@ -1,5 +1,5 @@
 import {join} from 'path';
-import {isWindows} from '../../../polyfills/system';
+import {isWindows} from '../../../utils/system';
 import fileExists from 'node-file-exists';
 
 /**
diff --git a/src/modules/tutorial/utils/config.ts b/src/modules/tutorial/utils/config.ts
@@ -2,7 +2,7 @@ import {join} from 'path';
 
 import {configIssuesPath, configRepo} from './config-repo';
 import configRunner from './config-runner';
-import {isWindows} from '../../../polyfills/system';
+import {isWindows} from '../../../utils/system';
 import fileExists from 'node-file-exists';
 
 /**
diff --git a/src/modules/tutorials/latest-version.ts b/src/modules/tutorials/latest-version.ts
@@ -0,0 +1,14 @@
+import fetch from '../../utils/fetch';
+
+const apiCall = name => `https://registry.npmjs.org/${name}`;
+
+function getLatestVersion(name: string, current: string): Promise<boolean> {
+  return fetch(apiCall(name))
+    .then((res: string) => {
+      if (res) {
+        JSON.parse(res)['dist-tags'].latest;
+        return true;
+      }
+      return false;
+    });
+}
diff --git a/src/utils/fetch.ts b/src/utils/fetch.ts
@@ -0,0 +1,25 @@
+/**
+ * fetch data from url
+ * @param  {string} url
+ * @returns Promise
+ */
+const fetch = function fetch (url: string): Promise<Object> {
+  return new Promise((resolve, reject) => {
+    const lib = url.startsWith('https') ? require('https') : require('http');
+    const request = lib.get(url, (response) => {
+      // handle http errors
+      if (response.statusCode < 200 || response.statusCode > 299) {
+         reject(new Error('Failed to load page, status code: ' + response.statusCode));
+       }
+      const body = [];
+      // on every content chunk, push it to the data array
+      response.on('data', (chunk) => body.push(chunk));
+      // we are done, resolve promise with those joined chunks
+      response.on('end', () => resolve(body.join('')));
+    });
+    // handle connection errors of the request
+    request.on('error', (err) => reject(err))
+    })
+};
+
+export default fetch;
diff --git a/src/utils/polyfills/index.ts b/src/utils/polyfills/index.ts
@@ -1,5 +1,9 @@
 import polyfillObjectValues from './object-values';
 
+/**
+ * calls list of polyfills
+ * @returns void
+ */
 export default function loadPolyfills(): void {
   polyfillObjectValues();
 }
diff --git a/src/utils/polyfills/object-values.ts b/src/utils/polyfills/object-values.ts
@@ -1,3 +1,8 @@
+/**
+ * Object.values polyfill
+ * https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_objects/Object/values
+ * @returns void
+ */
 export default function polyfillObjectValues(): void {
 // Object.values (ES7)
   if (typeof Object.values !== 'function') {
diff --git a/src/utils/system.ts b/src/utils/system.ts
@@ -1 +1,5 @@
+/**
+ * checks if system is Windows
+ * @returns boolean
+ */
 export const isWindows = window.navigator.appVersion.indexOf('Win') > -1 || false;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+"use strict";`
	`2`	`+exports.isWindows = window.navigator.appVersion.indexOf('Win') > -1 \|\| false;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`import polyfillObjectValues from './object-values';`
`2`	`2`
	`3`	`+/**`
	`4`	`+ * calls list of polyfills`
	`5`	`+ * @returns void`
	`6`	`+ */`
`3`	`7`	`export default function loadPolyfills(): void {`
`4`	`8`	`polyfillObjectValues();`
`5`	`9`	`}`