Renamed 'include' and 'includes' helpers to 'mkInclude' and 'mkIncludes'

Wsiegenthaler · Jan 19, 2018 · 3646664 · 3646664
1 parent 33a9005
commit 3646664
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -92,13 +92,13 @@ Order.Items = Order.hasMany(Item, { as: 'items', foreignKey: 'orderId' })
 Item.Department = Item.belongsTo(Department, { as: 'department', foreignKey: 'deptId' })`
 ```
 
-Use the `embed.util.helpers.include` helper to define the associations we wish to include. Here `itemsOnly` will update `Items` while `itemsAndDept` will update `Items` *and* `Departments`.
+Use the `mkInclude` helper to define the associations we wish to include. Here `itemsOnly` will update `Items` while `itemsAndDept` will update `Items` *and* `Departments`.
 
 ```javascript
-var include = embed.util.helpers.include
+var { mkInclude } = embed.util.helpers
 
-var itemsAndDept = [ include(Order.Items, include(Item.Department)) ]
-var itemsOnly = [ include(Order.Items) ]
+var itemsAndDept = [ mkInclude(Order.Items, mkInclude(Item.Department)) ]
+var itemsOnly = [ mkInclude(Order.Items) ]
 ```
 
 Insert an order, it's items, and departments by including `itemsAndDept`:

diff --git a/src/include-helpers.js b/src/include-helpers.js
@@ -2,8 +2,8 @@
 
 const lo = require('lodash');
 
-const includez = (...args) => lo.flatten(args).filter(e => e !== null);
-const include = (association, ...includes) => ({ model: association.target, include: includez(...includes), association });
+const mkIncludes = (...args) => lo.flatten(args).filter(e => e !== null);
+const mkInclude = (association, ...includes) => ({ model: association.target, include: mkIncludes(...includes), association });
 const when = (condition, ...includes) => !condition ? [] : includes;
 
-module.exports = { includes: includez, include, when };
+module.exports = { mkIncludes, mkInclude, when };
diff --git a/test/belongsToSpec.js b/test/belongsToSpec.js
@@ -5,8 +5,7 @@ var { sequelize, models, sync, clear } = require('./common');
 var { Customer, Item, ItemType, Order, Audit } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */

diff --git a/test/hasManySpec.js b/test/hasManySpec.js
@@ -5,8 +5,7 @@ var { sequelize, models, sync, clear } = require('./common');
 var { Customer, Item, ItemType, Order, Item } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */

diff --git a/test/hasOneSpec.js b/test/hasOneSpec.js
@@ -5,8 +5,7 @@ var { sequelize, models, sync, clear } = require('./common');
 var { Customer, Item, ItemType, Order, Audit } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */

diff --git a/test/issues/4-spec.js b/test/issues/4-spec.js
@@ -4,8 +4,7 @@ var Bluebird = require('bluebird');
 var { Sequelize, sequelize, sync } = require('../common');
 
 var embed = require('../../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */

diff --git a/test/miscSpec.js b/test/miscSpec.js
@@ -3,8 +3,7 @@ var { sequelize, models, sync, clear } = require('./common');
 var { Customer, Note, Item, ItemType, Order, Audit } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */

diff --git a/test/nestedSpec.js b/test/nestedSpec.js
@@ -5,8 +5,7 @@ var { sequelize, models, sync, clear } = require('./common');
 var { Customer, Region, Item, ItemType, Order, Audit, Note, Flag } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- tests --- */

diff --git a/test/optimisticLockSpec.js b/test/optimisticLockSpec.js
@@ -4,8 +4,7 @@ var Sequelize = sequelize.Sequelize;
 var { Customer, Item, ItemType, Audit } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */

diff --git a/test/simpleSpec.js b/test/simpleSpec.js
@@ -3,8 +3,7 @@ var { sequelize, models, sync, clear } = require('./common');
 var { Customer, Item, ItemType, Order, Audit } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */

diff --git a/test/transactionSpec.js b/test/transactionSpec.js
@@ -3,8 +3,7 @@ var { sequelize, models, sync, clear } = require('./common');
 var { Customer, Item, ItemType, Order, Audit } = models;
 
 var embed = require('../src/index')(sequelize);
-var helpers = embed.util.helpers;
-var mkIncludes = helpers.includes, mkInclude = helpers.include;
+var { mkIncludes, mkInclude } = embed.util.helpers;
 
 
 /* --- setup --- */