feat: add clone method (#238)

Closes #237

There seem to be lint fixes for other files as well. Hope won't be a problem.

Author: Tolsee

README.md

@@ -19,10 +19,13 @@ This repository exists as a resource for people to learn how to contribute to op
 ## Usage
 
 ```javascript
-import {flatten, snakeToCamel} from 'stack-overflow-copy-paste'
+import {flatten, snakeToCamel, clone} from 'stack-overflow-copy-paste'
 
 flatten([[1, 2,], 3]) // [1, 2, 3]
 snakeToCamel('snake-case-string') // 'snakeCaseString'
+
+const testObj = {a: 1, b: 2}
+const copyObj = clone(testObj)
 ```
 
 ## LICENSE

src/clone.js

@@ -0,0 +1,60 @@
+/**
+ * Handler functions
+ */
+const handlers = {
+  handleDate: date => {
+    // Handle Date
+    const copy = new Date()
+    copy.setTime(date.getTime())
+    return copy
+  },
+  handleArray: array => {
+    const {length} = array
+
+    // Init array
+    const copy = array.constructor(length)
+
+    for (let i = 0; i < length; i++) {
+      copy[i] = clone(array[i])
+    }
+
+    return copy
+  },
+  handleObject: object => {
+    // Also copy prototypes
+    const copy = Object.create(Object.getPrototypeOf(object))
+
+    for (const attr in object) {
+      if (object.hasOwnProperty(attr)) {
+        copy[attr] = clone(object[attr])
+      }
+    }
+    return copy
+  },
+  handle(object) {
+    if (object instanceof Date) {
+      return this.handleDate(object)
+    } else if (object instanceof Array) {
+      return this.handleArray(object)
+    } else {
+      return this.handleObject(object)
+    }
+  },
+}
+
+/**
+ * Original StackOverflow answer https://stackoverflow.com/a/728694/6880789
+ * This function will return cloned value
+ * It can handle primitive data-type, Date, Array and Object
+ * @param {null|undefined|number|string|function|object} object - any type
+ * @return {null|undefined|number|string|function|object} - any type
+ */
+function clone(object) {
+  // Handle primitive data-types, null and undefined
+  if (typeof object !== 'object' || object === null || typeof object === 'function') {
+    return object
+  }
+  return handlers.handle(object)
+}
+
+export default clone

src/index.js

@@ -89,6 +89,7 @@ import toPower from './to-power'
 import truncate from './truncate'
 import validateEmail from './validateEmail'
 import removeElementByIndex from './removeElementByIndex'
+import clone from './clone'
 
 export {
   reverseArrayInPlace,
@@ -182,4 +183,5 @@ export {
   largest,
   hex2hsl,
   removeElementByIndex,
+  clone,
 }

test/BitwiseAnd.test.js

@@ -2,9 +2,9 @@ import test from 'ava'
 import {BitwiseAnd} from '../src'
 
 test('Returns the Bitwise And of all the Array Elements', t => {
-  const name1=[1,3,5]
- const actual = BitwiseAnd(name1)
-  const expected=1
+  const name1 = [1, 3, 5]
+  const actual = BitwiseAnd(name1)
+  const expected = 1
   t.deepEqual(actual, expected)
 })
 

test/array-average.test.js

@@ -1,11 +1,11 @@
 import test from 'ava'
 import {
-  arrayAverage
+  arrayAverage,
 } from '../src'
 
 test('Calculates the average of an array', t => {
   const array = [1, 2, 3, 4]
   const expected = 2.5
   const actual = arrayAverage(array)
   t.deepEqual(actual, expected)
-})
+})

test/array-median.test.js

@@ -2,36 +2,36 @@ import test from 'ava'
 import {median} from '../src'
 
 test('accepts only typeof array param', t => {
-    const array = {}
-    const expected = `${array} is not an array.`
-    const actual = median(array)
-    t.deepEqual(actual, expected)
+  const array = {}
+  const expected = `${array} is not an array.`
+  const actual = median(array)
+  t.deepEqual(actual, expected)
 })
 
 test('accepts only arrays with numeric items', t => {
-    const array = ['hello', 'world', 5, false]
-    const expected = `${array} contains non-numeric items.`
-    const actual = median(array)
-    t.deepEqual(actual, expected)
+  const array = ['hello', 'world', 5, false]
+  const expected = `${array} contains non-numeric items.`
+  const actual = median(array)
+  t.deepEqual(actual, expected)
 })
 
 test('accepts only nonempty arrays', t => {
-    const array = []
-    const expected = `${array} has no items.`
-    const actual = median(array)
-    t.deepEqual(actual, expected)
+  const array = []
+  const expected = `${array} has no items.`
+  const actual = median(array)
+  t.deepEqual(actual, expected)
 })
 
 test('finds the median of an array with odd number of items', t => {
-    const array = [13, 2, 5]
-    const expected = 5
-    const actual = median(array)
-    t.deepEqual(actual, expected)
+  const array = [13, 2, 5]
+  const expected = 5
+  const actual = median(array)
+  t.deepEqual(actual, expected)
 })
 
 test('finds the median of an array with even number of items', t => {
   const array = [9, 25, 4, 1]
   const expected = 6.5
   const actual = median(array)
   t.deepEqual(actual, expected)
-})
+})

test/clone.test.js

@@ -0,0 +1,55 @@
+import test from 'ava'
+import {clone} from '../src'
+
+test('Clone number', t => {
+  const original = 1
+  const cloned = clone(original)
+  t.deepEqual(cloned, original)
+})
+
+test('Clone string', t => {
+  const original = 'test string'
+  const cloned = clone(original)
+  t.deepEqual(cloned, original)
+})
+
+test('Clone array', t => {
+  const original = [1, 2, 3]
+  const cloned = clone(original)
+  t.deepEqual(cloned, original)
+})
+
+test('Date', t => {
+  const original = new Date()
+  const cloned = clone(original)
+  t.deepEqual(cloned.getTime(), original.getTime())
+})
+
+test('Clone object', t => {
+  const original = {a: 'test', b: 'test'}
+  const cloned = clone(original)
+  t.deepEqual(cloned, original)
+})
+
+test('Clone object with prototype', t => {
+  const original = {a: 'test'}
+  Object.setPrototypeOf(original, {testprop: 4})
+  const cloned = clone(original)
+  t.deepEqual(cloned.testprop, original.testprop)
+})
+
+test('Clone function', t => {
+  function original() {
+    return 1
+  }
+  const cloned = clone(original)
+  t.deepEqual(cloned(), original())
+})
+
+test('Clone Map', t => {
+  const original = new Map([['key', 'test'], ['a', 'b']])
+  const cloned = clone(original)
+  t.deepEqual(cloned, original)
+})
+
+

test/convertToRoman.test.js

@@ -6,4 +6,4 @@ test('convert to roman numeral', t => {
   const expected = 'XXIV'
   const actual = convertToRoman(object)
   t.deepEqual(actual, expected)
-})
+})

test/cube.test.js

@@ -6,4 +6,4 @@ test('Cube a number ', t => {
   const expected = 5 * 5 * 5
   const actual = cube(number)
   t.deepEqual(actual, expected)
-})
+})

test/dec2bin.test.js

@@ -13,7 +13,7 @@ test('throws error if number is less than zero', t => {
   //const actual = dec2bin(original)
   const error = t.throws(() => {
     dec2bin(original)
-  },RangeError)
+  }, RangeError)
   t.is(error.message, 'Input must be a positive integer')
 })