Merge pull request #36 from vicentelyrio/constructor-with-deps

Passing deps to builder

Author: albertossilva

README.md

@@ -92,7 +92,7 @@ console.log(fatherInstance.children[1].toJSON());
 //{ field: 'B', otherField: 3 }
 ```
 #### Builder
-When you need to create objects with custom verification like 
+When you need to create objects with custom verification like
 ```javascript
     const elementList = {
         elements: [{
@@ -111,15 +111,21 @@ class ElementList extends Speck {}
 ElementList.SCHEMA = {
   elements: {
     validator: noop,
-    builder: (dataList) => dataList.map(data => {
-      if (data.type === 'product') return new ProductEntity(data);
+    builder: (dataList, Type, dependencies) => dataList.map(data => {
+      if (data.type === 'product') return new ProductEntity(data, dependencies);
       if (data.type === 'default') return new FakeEntityWithBoolean(data);
     })
   }
 };
 ```
-By defining builder you tell Speck Entity that you take the responsibility of instansitating and 
-returning a new object of the type which suits you the best. 
+And use it like:
+```javascript
+new ElementList(elementList, someDependency)
+```
+(note that you can pass custom dependencies to your child entities and latter access them on the builder)
+
+By defining builder you tell Speck Entity that you take the responsibility of instansitating and
+returning a new object of the type which suits you the best.
 This is a powerful concept as it lets users dynamically create new types on the fly.
 #### Clean unexpected values
 ```javascript
@@ -230,4 +236,4 @@ To understand the validators [React PropTypes](https://facebook.github.io/react/
   const myEntity = new EntityWithHook({ fieldWithHook: 'foo', anotherFieldWithHook: 'bar', anotherField: null });
 
   myEntity.anotherFieldWithHook = 10 //according to the after set hook anotherField newValue will be 20
-```
+```

lib/Speck.js

@@ -67,8 +67,12 @@ var Speck = function () {
       enumerable: false
     });
 
+    for (var _len = arguments.length, dependencies = Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      dependencies[_key - 1] = arguments[_key];
+    }
+
     Object.defineProperty(this, 'data', {
-      value: this._mergeDefault(data),
+      value: this._mergeDefault.apply(this, [data].concat(dependencies)),
       enumerable: false
     });
 
@@ -97,11 +101,16 @@ var Speck = function () {
     value: function _mergeDefault(data) {
       var newData = {};
       var field = void 0;
+
+      for (var _len2 = arguments.length, dependencies = Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+        dependencies[_key2 - 1] = arguments[_key2];
+      }
+
       for (field in this.schema) {
         newData[field] = this.__initFieldValue(field, data);
 
         if (this.schema[field].type || this.schema[field].builder) {
-          newData[field] = this.applyEntityConstructor(this.schema[field], newData[field]);
+          newData[field] = this.applyEntityConstructor.apply(this, [this.schema[field], newData[field]].concat(dependencies));
         }
 
         Object.defineProperty(this, field, createGetterAndSetter(this, field));
@@ -171,7 +180,11 @@ var Speck = function () {
       var Type = field.type;
 
       if (isFunction(field.builder)) {
-        return field.builder(data, Type);
+        for (var _len3 = arguments.length, dependencies = Array(_len3 > 2 ? _len3 - 2 : 0), _key3 = 2; _key3 < _len3; _key3++) {
+          dependencies[_key3 - 2] = arguments[_key3];
+        }
+
+        return field.builder.apply(field, [data, Type].concat(dependencies));
       }
 
       if (!data) return;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "speck-entity",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Domain entities with reactive validation",
   "main": "lib/index.js",
   "scripts": {

spec/Speck.spec.js

@@ -11,8 +11,10 @@ const {
   ProductEntity,
   Validatable,
   ChildrenEntity,
+  ChildrenWithDependency,
   FatherEntity,
   FatherWithObjectEntity,
+  FatherWithDependencies,
   FakeEntityWithExcludeContext,
   FakeEntityWithIncludeContext,
   FakeEntityWithCustomValidationWithContext,
@@ -172,6 +174,17 @@ describe('Speck', () => {
       expect(father.children.tweet.constructor).to.equal(ChildrenEntity)
     })
 
+    it('builds automatically using the parameter builder and passing dependencies', () => {
+      const father = new FatherWithDependencies({
+        children: { foo: 'bar' }
+      }, {
+        dependency: true
+      })
+
+      expect(father.children.constructor).to.equal(ChildrenWithDependency)
+      expect(father.children.dependency).to.equal(true)
+    })
+
     it('includes errors of children', () => {
       const father = new FatherEntity({
         foo: 'test',

spec/fixtures/fakerClasses.js

@@ -73,6 +73,17 @@ ChildrenEntity.SCHEMA = {
   foo: fooValidator
 }
 
+class ChildrenWithDependency extends Speck {
+  constructor (props, dependencies) {
+    super(props, dependencies)
+
+    Object.assign(this, dependencies)
+  }
+}
+ChildrenWithDependency.SCHEMA = {
+  foo: fooValidator
+}
+
 FakeEntityWithDefault.SCHEMA = {
   [defaultField]: {
     validator: noop,
@@ -126,6 +137,17 @@ FatherWithObjectEntity.SCHEMA = {
   }
 }
 
+class FatherWithDependencies extends Speck { }
+FatherWithDependencies.SCHEMA = {
+  children: {
+    type: ChildrenWithDependency,
+    validator: alwaysTruth,
+    builder: (data, Type, dependencies) => {
+      return new Type(data, dependencies)
+    }
+  }
+}
+
 class FakeEntityWithExcludeContext extends Speck { }
 FakeEntityWithExcludeContext.SCHEMA = {
   id: joiAdapter(Joi.number().required()),
@@ -176,8 +198,10 @@ Object.assign(exports, {
   ProductEntity,
   Validatable,
   ChildrenEntity,
+  ChildrenWithDependency,
   FatherEntity,
   FatherWithObjectEntity,
+  FatherWithDependencies,
   FakeEntityWithExcludeContext,
   FakeEntityWithIncludeContext,
   FakeEntityWithCustomValidationWithContext,

src/Speck.js

@@ -27,7 +27,7 @@ function createGetterAndSetter (instance, field) {
 }
 
 class Speck {
-  constructor (data = {}) {
+  constructor (data = {}, ...dependencies) {
     Object.defineProperty(this, 'schema', {
       value: this.constructor.SCHEMA,
       enumerable: false
@@ -44,7 +44,7 @@ class Speck {
     })
 
     Object.defineProperty(this, 'data', {
-      value: this._mergeDefault(data),
+      value: this._mergeDefault(data, ...dependencies),
       enumerable: false
     })
 
@@ -66,14 +66,14 @@ class Speck {
     return isFunction ? defaultValue : clone(this.schema[field].defaultValue)
   }
 
-  _mergeDefault (data) {
+  _mergeDefault (data, ...dependencies) {
     const newData = {}
     let field
     for (field in this.schema) {
       newData[field] = this.__initFieldValue(field, data)
 
       if (this.schema[field].type || this.schema[field].builder) {
-        newData[field] = this.applyEntityConstructor(this.schema[field], newData[field])
+        newData[field] = this.applyEntityConstructor(this.schema[field], newData[field], ...dependencies)
       }
 
       Object.defineProperty(this, field, createGetterAndSetter(this, field))
@@ -132,11 +132,11 @@ class Speck {
     return children.reduce(this._includeChildErrors.bind(this, field), errors)
   }
 
-  applyEntityConstructor (field, data) {
+  applyEntityConstructor (field, data, ...dependencies) {
     const Type = field.type
 
     if (isFunction(field.builder)) {
-      return field.builder(data, Type)
+      return field.builder(data, Type, ...dependencies)
     }
 
     if (!data) return