🔨 Remove core namespace fix #26 (#34)

* 🚚 Move Consts at top level
* 🚚 Move using into util namespace
* 🚚 Move set, unset and update into object namespace
* 🔥 Remove core namespace

Author: nlepage

.gitignore

@@ -1,9 +1,5 @@
 /node_modules/
 yarn-error.log
-/*.js
-/array/
-/collection/
-/core/
-/lang/
-/math/
-/seq/
+**/*.js
+!.*.js
+!/src/**/*.js

.npmignore

@@ -4,3 +4,4 @@
 circle.yml
 jsdoc.json
 yarn.lock
+.*.js

.test.setup.js

@@ -0,0 +1,3 @@
+import { should } from 'chai'
+
+should()

package.json

@@ -23,21 +23,22 @@
   "devDependencies": {
     "babel-cli": "^6.24.1",
     "babel-eslint": "^7.2.3",
-    "babel-preset-env": "^1.4.0",
+    "babel-preset-env": "^1.5.2",
     "babel-preset-stage-0": "^6.24.1",
-    "chai": "^3.5.0",
-    "eslint": "^3.19.0",
+    "chai": "^4.0.2",
+    "eslint": "^4.0.0",
     "hotdoc": "^0.7.2",
     "jsdoc": "^3.4.3",
-    "mocha": "^3.2.0"
+    "mocha": "^3.4.2"
   },
   "peerDependencies": {
     "lodash": "^4.17.4"
   },
   "scripts": {
     "build": "babel src -d .",
     "lint": "eslint src",
-    "test": "mocha --compilers js:babel-register src/**/*.spec.js",
-    "docs": "jsdoc -c jsdoc.json"
+    "test": "mocha --compilers js:babel-register --require .test.setup.js src/**/*.spec.js",
+    "docs": "jsdoc -c jsdoc.json",
+    "docs:private": "jsdoc -c jsdoc.json -p"
   }
 }

src/array/push.js

@@ -1,5 +1,5 @@
 import toArray from 'lodash/toArray'
-import update from '../core/update'
+import update from '../object/update'
 
 /**
  * Replaces by a new array containing the elements of the former array and one or more elements added to the end.
@@ -15,7 +15,7 @@ import update from '../core/update'
  * push({ nested: { prop: [1, 2] } }, 'nested.prop', 3, 4) // => { nested: { prop: [1, 2, 3, 4] } }
  * @see {@link https://lodash.com/docs#toArray|lodash.toArray} for more information.
  * @see {@link https://mdn.io/Array.prototype.push|Array.prototype.push} for more information.
- * @see {@link core.update|update} for more information.
+ * @see {@link object.update|update} for more information.
  * @since 0.1.7
  */
 export default update((value, ...values) => {

src/array/push.spec.js

@@ -1,5 +1,4 @@
 /* eslint-env node, mocha */
-import { expect } from 'chai'
 import push from './push'
 
 describe('Push', () => {
@@ -9,15 +8,15 @@ describe('Push', () => {
 
     const final = push(original, 'nested.prop', 3)
 
-    expect(final).to.be.deep.equal({ nested: { prop: [1, 2, 3] } })
-    expect(original).to.be.deep.equal({ nested: { prop: [1, 2] } })
+    final.should.deep.equal({ nested: { prop: [1, 2, 3] } })
+    original.should.deep.equal({ nested: { prop: [1, 2] } })
   })
 
   it('should add several elements', () => {
-    expect(push({ nested: { prop: [1, 2] } }, 'nested.prop', 3, 4)).to.be.deep.equal({ nested: { prop: [1, 2, 3, 4] } })
+    push({ nested: { prop: [1, 2] } }, 'nested.prop', 3, 4).should.deep.equal({ nested: { prop: [1, 2, 3, 4] } })
   })
 
   it('should replace deep undefined with array', () => {
-    expect(push(undefined, 'nested.prop', 1)).to.be.deep.equal({ nested: { prop: [1] } })
+    push(undefined, 'nested.prop', 1).should.deep.equal({ nested: { prop: [1] } })
   })
 })

src/array/xor.js

@@ -1,4 +1,4 @@
-import update from '../core/update'
+import update from '../object/update'
 import xor from 'lodash/xor'
 
 /**
@@ -11,7 +11,7 @@ import xor from 'lodash/xor'
  * @return {Array} Returns the new array of filtered values.
  * @example xor({ nested: { prop: [1, 2] } }, 'nested.prop', [2, 3]) // => { nested: { prop: [1, 3] } }
  * @see {@link https://lodash.com/docs#xor|lodash.xor} for more information.
- * @see {@link core.update|update} for more information.
+ * @see {@link object.update|update} for more information.
  * @since 0.1.6
  */
 export default update(xor)

src/array/xor.spec.js

@@ -1,5 +1,4 @@
 /* eslint-env node, mocha */
-import { expect } from 'chai'
 import xor from './xor'
 
 describe('Xor', () => {
@@ -11,12 +10,12 @@ describe('Xor', () => {
   const withTwoAndThree = { nested: { prop: twoAndThree } }
 
   it('should xor arrays', () => {
-    expect(xor(withOneAndTwo, 'nested.prop', twoAndThree)).to.be.deep.equal(withOneAndThree)
-    expect(xor(withOneAndTwo, 'nested.prop', oneAndThree)).to.be.deep.equal(withTwoAndThree)
+    xor(withOneAndTwo, 'nested.prop', twoAndThree).should.deep.equal(withOneAndThree)
+    xor(withOneAndTwo, 'nested.prop', oneAndThree).should.deep.equal(withTwoAndThree)
   })
 
   it('should xor deep undefined to array', () => {
-    expect(xor({}, 'nested.prop', oneAndThree)).to.be.deep.equal(withOneAndThree)
-    expect(xor(undefined, 'nested.prop', oneAndThree)).to.be.deep.equal(withOneAndThree)
+    xor({}, 'nested.prop', oneAndThree).should.deep.equal(withOneAndThree)
+    xor(undefined, 'nested.prop', oneAndThree).should.deep.equal(withOneAndThree)
   })
 })

src/collection/map.js

@@ -1,5 +1,5 @@
 import map from 'lodash/map'
-import update from '../core/update'
+import update from '../object/update'
 
 /**
  * Replaces by an array of values by running each element in the former collection thru iteratee.
@@ -12,7 +12,7 @@ import update from '../core/update'
  * @return {Object} Returns the updated object.
  * @see {@link https://lodash.com/docs#map|lodash.map} for more information.
  * @see {@link https://lodash.com/docs#identity|lodash.identity} for more information.
- * @see {@link core.update|update} for more information.
+ * @see {@link object.update|update} for more information.
  * @since 0.1.8
  */
 export default update(map)

src/collection/map.spec.js

@@ -1,15 +1,13 @@
 /* eslint-env node, mocha */
-import { expect } from 'chai'
-
 import map from './map'
 
 describe('Map', () => {
 
   it('should map an array', () => {
-    expect(map({ nested: { prop: [1, 2] } }, 'nested.prop', v => v * 2)).to.be.deep.equal({ nested: { prop: [2, 4] } })
+    map({ nested: { prop: [1, 2] } }, 'nested.prop', v => v * 2).should.deep.equal({ nested: { prop: [2, 4] } })
   })
 
   it('should replace deep undefined with empty array', () => {
-    expect(map(undefined, 'nested.prop')).to.be.deep.equal({ nested: { prop: [] } })
+    map(undefined, 'nested.prop').should.deep.equal({ nested: { prop: [] } })
   })
 })

src/consts/index.js

@@ -0,0 +1,10 @@
+/**
+ * Lodash FP conversion options.
+ * @constant {Object}
+ * @since 0.1.5
+ * @private
+ */
+export const lodashFpConvertOptions = {
+  rearg: false,
+  curry: false,
+}

src/core/consts.js

@@ -1,7 +1,7 @@
 export * from './array'
 export * from './collection'
-export * from './core'
 export * from './lang'
 export * from './math'
 export * from './object'
 export * from './seq'
+export * from './util'

src/core/index.js

@@ -1,4 +1,4 @@
-import update from '../core/update'
+import update from '../object/update'
 
 /**
  * Applies <code>!</code> to the property.
@@ -8,7 +8,7 @@ import update from '../core/update'
  * @param {Array|string} path The path of the property to set.
  * @return {Object} Returns the updated object.
  * @example toggle({ nested: { prop: true } }, 'nested.prop') // { nested: { prop: false } }
- * @see {@link core.update|update} for more information.
+ * @see {@link object.update|update} for more information.
  * @since 0.1.5
  */
 export default update(v => !v)

src/core/set.spec.js

@@ -1,5 +1,4 @@
 /* eslint-env node, mocha */
-import { expect } from 'chai'
 import toggle from './toggle'
 
 describe('Toggle', () => {
@@ -8,29 +7,29 @@ describe('Toggle', () => {
   const withFalse = { nested: { prop: false } }
 
   it('should toggle false to true', () => {
-    expect(toggle(withFalse, 'nested.prop')).to.be.deep.equal(withTrue)
+    toggle(withFalse, 'nested.prop').should.deep.equal(withTrue)
   })
 
   it('should toggle falsy to true', () => {
-    expect(toggle({ nested: {} }, 'nested.prop')).to.be.deep.equal(withTrue)
-    expect(toggle({ nested: { prop: null } }, 'nested.prop')).to.be.deep.equal(withTrue)
-    expect(toggle({ nested: { prop: '' } }, 'nested.prop')).to.be.deep.equal(withTrue)
-    expect(toggle({ nested: { prop: 0 } }, 'nested.prop')).to.be.deep.equal(withTrue)
+    toggle({ nested: {} }, 'nested.prop').should.deep.equal(withTrue)
+    toggle({ nested: { prop: null } }, 'nested.prop').should.deep.equal(withTrue)
+    toggle({ nested: { prop: '' } }, 'nested.prop').should.deep.equal(withTrue)
+    toggle({ nested: { prop: 0 } }, 'nested.prop').should.deep.equal(withTrue)
   })
 
   it('should toggle deep undefined to true', () => {
-    expect(toggle({}, 'nested.prop')).to.be.deep.equal(withTrue)
-    expect(toggle(undefined, 'nested.prop')).to.be.deep.equal(withTrue)
+    toggle({}, 'nested.prop').should.deep.equal(withTrue)
+    toggle(undefined, 'nested.prop').should.deep.equal(withTrue)
   })
 
   it('should toggle true to false', () => {
-    expect(toggle(withTrue, 'nested.prop')).to.be.deep.equal(withFalse)
+    toggle(withTrue, 'nested.prop').should.deep.equal(withFalse)
   })
 
   it('should toggle truthy to false', () => {
-    expect(toggle({ nested: { prop: 'a' } }, 'nested.prop')).to.be.deep.equal(withFalse)
-    expect(toggle({ nested: { prop: {} } }, 'nested.prop')).to.be.deep.equal(withFalse)
-    expect(toggle({ nested: { prop: [] } }, 'nested.prop')).to.be.deep.equal(withFalse)
-    expect(toggle({ nested: { prop: 1 } }, 'nested.prop')).to.be.deep.equal(withFalse)
+    toggle({ nested: { prop: 'a' } }, 'nested.prop').should.deep.equal(withFalse)
+    toggle({ nested: { prop: {} } }, 'nested.prop').should.deep.equal(withFalse)
+    toggle({ nested: { prop: [] } }, 'nested.prop').should.deep.equal(withFalse)
+    toggle({ nested: { prop: 1 } }, 'nested.prop').should.deep.equal(withFalse)
   })
 })

src/core/update.spec.js

@@ -1,5 +1,5 @@
 import add from 'lodash/add'
-import update from '../core/update'
+import update from '../object/update'
 
 /**
  * Replaces by the addition of the former number and the given number.
@@ -11,7 +11,7 @@ import update from '../core/update'
  * @return {Object} Returns the updated object.
  * @example add({ nested: { prop: 2 } }, 'nested.prop', 4) // => { nested: { prop: 6 } }
  * @see {@link https://lodash.com/docs#add|lodash.add} for more information.
- * @see {@link core.update|update} for more information.
+ * @see {@link object.update|update} for more information.
  * @since 0.1.7
  */
 export default update(add)

src/index.js

@@ -1,10 +1,9 @@
 /* eslint-env node, mocha */
 import add from './add'
-import { expect } from 'chai'
 
 describe('Add', () => {
 
   it('should add two numbers', () => {
-    expect(add({ nested: { prop: 2 } }, 'nested.prop', 4)).to.be.deep.equal({ nested: { prop: 6 } })
+    add({ nested: { prop: 2 } }, 'nested.prop', 4).should.deep.equal({ nested: { prop: 6 } })
   })
 })

src/lang/toggle.js

@@ -1,6 +1,6 @@
 import assign from 'lodash/fp/assign'
-import { lodashFpConvertOptions } from '../core/consts'
-import update from '../core/update'
+import { lodashFpConvertOptions } from '../consts'
+import update from '../object/update'
 
 const rawAssign = assign.convert(lodashFpConvertOptions)
 
@@ -15,7 +15,7 @@ const rawAssign = assign.convert(lodashFpConvertOptions)
  * @param {...Object} [sources] The source objects.
  * @return {Object} Returns the updated object.
  * @example assign({ nested: { a: 1, b: 2 } }, 'nested', { b: 3, c: 4 }) // => { nested: { a:1, b: 3, c: 4 } }
- * @see {@link core.update|update} for more information.
+ * @see {@link object.update|update} for more information.
  * @see {@link https://lodash.com/docs#assign|lodash.assign} for more information.
  * @since 0.1.12
  */

src/lang/toggle.spec.js

@@ -1,6 +1,5 @@
 /* eslint-env node, mocha */
 import assign from './assign'
-import { expect } from 'chai'
 
 describe('Assign', () => {
 
@@ -23,6 +22,6 @@ describe('Assign', () => {
   }
 
   it('should assign objects', () => {
-    expect(assign(objectOne, 'nested', objectTwo)).to.be.deep.equal(output)
+    assign(objectOne, 'nested', objectTwo).should.deep.equal(output)
   })
 })