Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for mongoDb id's + make collection to lowercase work #56

Open
wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Add support for mongoDb id's + make collection to lowercase work #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
abefd6b
Collection to lowerCase not working
stuk88 Aug 16, 2017
edf17cf
Merge pull request #1 from bredikhin/master
stuk88 Aug 16, 2017
84c94b3
Add support for mongoDb id's
stuk88 Aug 16, 2017
37e2bc0
ver up
stuk88 Aug 16, 2017
f489814
Add assosiation to model only if the model exists
stuk88 Aug 16, 2017
527c5fb
Update package.json
stuk88 Aug 16, 2017
d6e6560
if no model found just skip adding assosiations
stuk88 Aug 16, 2017
e43dad9
adding myself as contributer
stuk88 Aug 16, 2017
7c86c82
Indentation
stuk88 Aug 27, 2017
e20e0a0
ver down
stuk88 Aug 27, 2017
db5e8d3
make associations work with mongo ids
stuk88 Aug 31, 2017
6a0942a
support numerical ids (zero were leading to false)
stuk88 Aug 31, 2017
ff4465a
fix bug with numeric ids
stuk88 Aug 31, 2017
2526aa9
add space between if and brackets
stuk88 Aug 31, 2017
b9ea6d3
Number.isInteger not support
stuk88 Aug 31, 2017
7b62923
Make models load in series (so we could test models)
stuk88 Apr 16, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
332 changes: 179 additions & 153 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,88 +20,96 @@ module.exports = Barrels;
* @param {string} sourceFolder defaults to <project root>/test/fixtures
*/
function Barrels(sourceFolder) {
if (!(this instanceof Barrels))
return new Barrels(sourceFolder);
if (!(this instanceof Barrels))
return new Barrels(sourceFolder);

// Fixture objects loaded from the JSON files
this.data = {};
// Fixture objects loaded from the JSON files
this.data = {};

// Map fixture positions in JSON files to the real DB IDs
this.idMap = {};
// Map fixture positions in JSON files to the real DB IDs
this.idMap = {};

// The list of associations by model
this.associations = {};
// The list of associations by model
this.associations = {};

// Load the fixtures
sourceFolder = sourceFolder || process.cwd() + '/test/fixtures';
var files = fs.readdirSync(sourceFolder);
// Load the fixtures
sourceFolder = sourceFolder || process.cwd() + '/test/fixtures';
var files = fs.readdirSync(sourceFolder);

for (var i = 0; i < files.length; i++) {
if (['.json', '.js'].indexOf(path.extname(files[i]).toLowerCase()) !== -1) {
var modelName = path.basename(files[i]).split('.')[0].toLowerCase();
this.data[modelName] = require(path.join(sourceFolder, files[i]));
for (var i = 0; i < files.length; i++) {
if (['.json', '.js'].indexOf(path.extname(files[i]).toLowerCase()) !== -1) {
var modelName = path.basename(files[i]).split('.')[0].toLowerCase();
this.data[modelName] = require(path.join(sourceFolder, files[i]));
}
}
}

// The list of the fixtures model names
this.modelNames = Object.keys(this.data);
// The list of the fixtures model names
this.modelNames = Object.keys(this.data);
}

/**
* Add associations
* @param {function} done callback
*/
Barrels.prototype.associate = function(collections, done) {
if (!_.isArray(collections)) {
done = collections;
collections = this.modelNames;
}
var that = this;

// Add associations whenever needed
async.each(collections, function(modelName, nextModel) {
var Model = sails.models[modelName];
if (Model) {
var fixtureObjects = _.cloneDeep(that.data[modelName]);
async.each(fixtureObjects, function(item, nextItem) {
// Item position in the file
var itemIndex = fixtureObjects.indexOf(item);

// Find and associate
Model.findOne(that.idMap[modelName][itemIndex]).exec(function(err, model) {
if (err)
return nextItem(err);

// Pick associations only
item = _.pick(item, Object.keys(that.associations[modelName]));
async.each(Object.keys(item), function(attr, nextAttr) {
var association = that.associations[modelName][attr];
// Required associations should have beed added earlier
if (association.required)
return nextAttr();
var joined = association[association.type];

if (!_.isArray(item[attr]))
model[attr] = that.idMap[joined][item[attr]-1];
else {
for (var j = 0; j < item[attr].length; j++) {
model[attr].add(that.idMap[joined][item[attr][j]-1]);
}
}

model.save(function(err) {
if (err)
return nextAttr(err);

nextAttr();
});
}, nextItem);
});
}, nextModel);
} else {
nextModel();
if (!_.isArray(collections)) {
done = collections;
collections = this.modelNames;
}
}, done);
var that = this;

// Add associations whenever needed
async.each(collections, function(modelName, nextModel) {
var Model = sails.models[modelName];
if (Model) {
var fixtureObjects = _.cloneDeep(that.data[modelName]);
async.each(fixtureObjects, function(item, nextItem) {
// Item position in the file
var itemIndex = fixtureObjects.indexOf(item);

// Find and associate
Model.findOne(that.idMap[modelName][itemIndex]).exec(function(err, model) {
if (err)
return nextItem(err);

if (!model)
return nextItem();

// Pick associations only
item = _.pick(item, Object.keys(that.associations[modelName]));
async.each(Object.keys(item), function(attr, nextAttr) {
var association = that.associations[modelName][attr];
// Required associations should have beed added earlier
if (association.required)
return nextAttr();
var joined = association[association.type];

if (!_.isArray(item[attr])) {
var id = getId(that.idMap[joined], item[attr]);
if (id !== false)
model[attr] = id;
}
else {
for (var j = 0; j < item[attr].length; j++) {
var id = getId(that.idMap[joined], item[attr][j]);
if (id !== false)
model[attr].add(id);
}
}

model.save(function(err) {
if (err)
return nextAttr(err);

nextAttr();
});
}, nextItem);
});
}, nextModel);
} else {
nextModel();
}
}, done);
};

/**
Expand All @@ -111,93 +119,111 @@ Barrels.prototype.associate = function(collections, done) {
* @param {boolean} autoAssociations automatically associate based on the order in the fixture files
*/
Barrels.prototype.populate = function(collections, done, autoAssociations) {
var preserveLoadOrder = true;
if (!_.isArray(collections)) {
autoAssociations = done;
done = collections;
collections = this.modelNames;
preserveLoadOrder = false;
}
else {
collections = _.map(collections, function(collection) {
return collection.toLowerCase();
});
}
autoAssociations = !(autoAssociations === false);
var that = this;

// Populate each table / collection
async[preserveLoadOrder ? 'eachSeries' : 'each'](collections, function(modelName, nextModel) {
var Model = sails.models[modelName];
if (Model) {
// Cleanup existing data in the table / collection
Model.destroy().exec(function(err) {
if (err)
return nextModel(err);

// Save model's association information
that.associations[modelName] = {};
for (var i = 0; i < Model.associations.length; i++) {
var alias = Model.associations[i].alias;
that.associations[modelName][alias] = Model.associations[i];
that.associations[modelName][alias].required = !!(Model._validator.validations[alias].required);
}

// Insert all the fixture items
that.idMap[modelName] = [];
var fixtureObjects = _.cloneDeep(that.data[modelName]);
async.each(fixtureObjects, function(item, nextItem) {
// Item position in the file
var itemIndex = fixtureObjects.indexOf(item);

for (var alias in that.associations[modelName]) {
if (that.associations[modelName][alias].required) {
// With required associations present, the associated fixtures
// must be already loaded, so we can map the ids
var collectionName = that.associations[modelName][alias].collection; // many-to-many
var associatedModelName = that.associations[modelName][alias].model; // one-to-many

if ((_.isArray(item[alias]))&&(collectionName)) {
if (!that.idMap[collectionName])
return nextItem(new Error('Please provide a loading order acceptable for required associations'));
for (var i = 0; i < item[alias].length; i++) {
item[alias][i] = that.idMap[collectionName][item[alias][i] - 1];
}
} else if (associatedModelName) {
if (!that.idMap[associatedModelName])
return nextItem(new Error('Please provide a loading order acceptable for required associations'));
item[alias] = that.idMap[associatedModelName][item[alias] - 1];
}
} else if (autoAssociations) {
// The order is not important, so we can strip
// associations data and associate later
item = _.omit(item, alias);
}
}

// Insert
Model.create(item).exec(function(err, model) {
if (err)
return nextItem(err);

// Primary key mapping
that.idMap[modelName][itemIndex] = model[Model.primaryKey];

nextItem();
});
}, nextModel);
});
} else {
nextModel();
var preserveLoadOrder = true;
if (!_.isArray(collections)) {
autoAssociations = done;
done = collections;
collections = this.modelNames;
preserveLoadOrder = false;
}
else {
collections = _.map(collections, function(collection) {
return collection.toLowerCase();
});
}
}, function(err) {
if (err)
return done(err);
autoAssociations = !(autoAssociations === false);
var that = this;

// Populate each table / collection
async[preserveLoadOrder ? 'eachSeries' : 'each'](collections, function(modelName, nextModel) {
var Model = sails.models[modelName];
if (Model) {
// Cleanup existing data in the table / collection
Model.destroy().exec(function(err) {
if (err)
return nextModel(err);

// Save model's association information
that.associations[modelName] = {};
for (var i = 0; i < Model.associations.length; i++) {
var alias = Model.associations[i].alias;
that.associations[modelName][alias] = Model.associations[i];
that.associations[modelName][alias].required = !!(Model._validator.validations[alias].required);
}

// Insert all the fixture items
that.idMap[modelName] = [];
var fixtureObjects = _.cloneDeep(that.data[modelName]);
async.eachSeries(fixtureObjects, function(item, nextItem) {
// Item position in the file
var itemIndex = fixtureObjects.indexOf(item);

for (var alias in that.associations[modelName]) {
if (that.associations[modelName][alias].required) {
// With required associations present, the associated fixtures
// must be already loaded, so we can map the ids
var collectionName = that.associations[modelName][alias].collection; // many-to-many
var associatedModelName = that.associations[modelName][alias].model; // one-to-many

if ((_.isArray(item[alias]))&&(collectionName)) {
if (!that.idMap[collectionName])
return nextItem(new Error('Please provide a loading order acceptable for required associations'));
for (var i = 0; i < item[alias].length; i++) {
var id = getId(that.idMap[collectionName], item[alias][i]);
if (id !== false)
item[alias][i] = id;
}
} else if (associatedModelName) {
if (!that.idMap[associatedModelName])
return nextItem(new Error('Please provide a loading order acceptable for required associations'));


var id = getId(that.idMap[associatedModelName], item[alias]);
if (id !== false)
item[alias] = id;
}
} else if (autoAssociations) {
// The order is not important, so we can strip
// associations data and associate later
item = _.omit(item, alias);
}
}

// Insert
Model.create(item).exec(function(item, err, model) {
if (err)
return nextItem(err);


// Primary key mapping
that.idMap[modelName][itemIndex] = model[Model.primaryKey];

nextItem();
}.bind(this, item));
}, nextModel);
});
} else {
nextModel();
}
}, function(err) {
if (err)
return done(err);

// Create associations if requested
if (autoAssociations)
return that.associate(collections, done);
// Create associations if requested
if (autoAssociations)
return that.associate(collections, done);

done();
});
done();
});
};


function getId(collection, id) {
if (!(collection && Array.isArray(collection)))
return false;
if (!isNaN(id))
return collection[id - 1];

if (collection.indexOf(id) !== -1 )
return collection[collection.indexOf(id)]
}
6 changes: 5 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "barrels",
"version": "1.6.5",
"version": "1.6.6",
"description": "Simple DB Fixtures for Sails.js with associations support",
"dependencies": {
"async": "^1.5.0",
Expand Down Expand Up @@ -44,6 +44,10 @@
{
"name": "Marnus Weststrate",
"email": "[email protected]"
},
{
"name": "Stanislav Arshanski",
"email": "[email protected]"
}
],
"license": "MIT"
Expand Down