Jordan/optimize utils (#231)

jordangarcia · web-flow · commit 7626b7c6dce8 · 2019-02-22T17:05:32.000-08:00
* Add license headers, add sprintf to utils

* Bump logging/utils to 0.1.2 and use internal sprintf function
diff --git a/packages/logging/package-lock.json b/packages/logging/package-lock.json
diff --git a/packages/logging/package.json b/packages/logging/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@optimizely/js-sdk-logging",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Optimizely Full Stack Core Logging",
   "author": "jordangarcia <jordan@optimizely.com>",
   "homepage": "https://github.com/optimizely/javascript-sdk",
@@ -20,12 +20,10 @@
     "prepublishOnly": "jest && npm run tsc"
   },
   "dependencies": {
-    "@optimizely/js-sdk-utils": "^0.1.1",
-    "sprintf-js": "^1.1.1"
+    "@optimizely/js-sdk-utils": "^0.1.2"
   },
   "devDependencies": {
     "@types/jest": "^23.3.12",
-    "@types/sprintf-js": "^1.1.1",
     "jest": "^23.6.0",
     "ts-jest": "^23.10.5"
   }
diff --git a/packages/logging/src/errorHandler.ts b/packages/logging/src/errorHandler.ts
@@ -1,3 +1,18 @@
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 /**
  * @export
  * @interface ErrorHandler
diff --git a/packages/logging/src/index.ts b/packages/logging/src/index.ts
@@ -1,3 +1,18 @@
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export * from './errorHandler'
 export * from './models'
 export * from './logger'
diff --git a/packages/logging/src/logger.ts b/packages/logging/src/logger.ts
@@ -1,6 +1,20 @@
-import { sprintf } from 'sprintf-js'
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 import { getErrorHandler } from './errorHandler'
-import { isValidEnum } from '@optimizely/js-sdk-utils'
+import { isValidEnum, sprintf } from '@optimizely/js-sdk-utils'
 
 import { LogLevel, LoggerFacade, LogManager, LogHandler } from './models'
 
diff --git a/packages/logging/src/models.ts b/packages/logging/src/models.ts
@@ -1,3 +1,18 @@
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export enum LogLevel {
   NOTSET = 0,
   DEBUG = 1,
diff --git a/packages/optimizely-sdk/package-lock.json b/packages/optimizely-sdk/package-lock.json
diff --git a/packages/utils/__tests__/utils.spec.ts b/packages/utils/__tests__/utils.spec.ts
@@ -1,5 +1,5 @@
 /// <reference types="jest" />
-import { isValidEnum, groupBy, objectValues, find, keyBy } from '../src/utils'
+import { isValidEnum, groupBy, objectValues, find, keyBy, sprintf } from '../src'
 
 describe('utils', () => {
   describe('isValidEnum', () => {
@@ -84,4 +84,34 @@ describe('utils', () => {
       })
     })
   })
+
+  describe('sprintf', () => {
+    it('sprintf(msg)', () => {
+      expect(sprintf('this is my message')).toBe('this is my message')
+    })
+
+    it('sprintf(msg, arg1)', () => {
+      expect(sprintf('hi %s', 'jordan')).toBe('hi jordan')
+    })
+
+    it('sprintf(msg, arg1, arg2)', () => {
+      expect(sprintf('hi %s its %s', 'jordan', 'jon')).toBe('hi jordan its jon')
+    })
+
+    it('should print undefined if an argument is missing', () => {
+      expect(sprintf('hi %s its %s', 'jordan')).toBe('hi jordan its undefined')
+    })
+
+    it('should evaluate a function', () => {
+      expect(sprintf('hi %s its %s', 'jordan', () => 'a function')).toBe('hi jordan its a function')
+    })
+
+    it('should work with numbers', () => {
+      expect(sprintf('hi %s', 123)).toBe('hi 123')
+    })
+
+    it('should not error when passed an object', () => {
+      expect(sprintf('hi %s', { foo: 'bar' })).toBe('hi [object Object]')
+    })
+  })
 })
diff --git a/packages/utils/package-lock.json b/packages/utils/package-lock.json
diff --git a/packages/utils/package.json b/packages/utils/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@optimizely/js-sdk-utils",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Optimizely Full Stack Utils",
   "author": "jordangarcia <jordan@optimizely.com>",
   "homepage": "https://github.com/optimizely/javascript-sdk",
diff --git a/packages/utils/src/index.ts b/packages/utils/src/index.ts
@@ -1 +1,100 @@
-export * from './utils'
+/**
+ * Copyright 2019, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { v4 } from 'uuid'
+
+export type Omit<T, K> = Pick<T, Exclude<keyof T, K>>
+
+export function getTimestamp(): number {
+  return new Date().getTime()
+}
+
+export function generateUUID(): string {
+  return v4()
+}
+
+/**
+ * Validates a value is a valid TypeScript enum
+ *
+ * @export
+ * @param {object} enumToCheck
+ * @param {*} value
+ * @returns {boolean}
+ */
+export function isValidEnum(enumToCheck: { [key: string]: any }, value: any): boolean {
+  let found = false
+
+  const keys = Object.keys(enumToCheck)
+  for (let index = 0; index < keys.length; index++) {
+    if (value === enumToCheck[keys[index]]) {
+      found = true
+      break
+    }
+  }
+  return found
+}
+
+export function groupBy<K>(arr: K[], grouperFn: (item: K) => string): Array<K[]> {
+  const grouper: { [key: string]: K[] } = {}
+
+  arr.forEach(item => {
+    const key = grouperFn(item)
+    grouper[key] = grouper[key] || []
+    grouper[key].push(item)
+  })
+
+  return objectValues(grouper)
+}
+
+export function objectValues<K>(obj: { [key: string]: K }): K[] {
+  return Object.keys(obj).map(key => obj[key])
+}
+
+export function find<K>(arr: K[], cond: (arg: K) => boolean): K | undefined {
+  let found
+
+  for (let item of arr) {
+    if (cond(item)) {
+      found = item
+      break
+    }
+  }
+
+  return found
+}
+
+export function keyBy<K>(arr: K[], keyByFn: (item: K) => string): { [key: string]: K } {
+  let map: { [key: string]: K } = {}
+  arr.forEach(item => {
+    const key = keyByFn(item)
+    map[key] = item
+  })
+  return map
+}
+
+export function sprintf(format: string, ...args: any[]): string {
+  var i = 0
+  return format.replace(/%s/g, function() {
+    const arg = args[i++]
+    const type = typeof arg
+    if (type === 'function') {
+      return arg()
+    } else if (type === 'string') {
+      return arg
+    } else {
+      return String(arg)
+    }
+  })
+}
diff --git a/packages/utils/src/utils.ts b/packages/utils/src/utils.ts

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@optimizely/js-sdk-utils",`
`3`		`- "version": "0.1.1",`
	`3`	`+ "version": "0.1.2",`
`4`	`4`	`"description": "Optimizely Full Stack Utils",`
`5`	`5`	`"author": "jordangarcia <[email protected]>",`
`6`	`6`	`"homepage": "https://github.com/optimizely/javascript-sdk",`