Skip to content

Commit

Permalink
Convert Seeder to a class
Browse files Browse the repository at this point in the history
  • Loading branch information
@lorefnon
lorefnon committed Oct 12, 2019
1 parent 20bd04b commit ce81185
Showing 1 changed file with 158 additions and 160 deletions.
318 changes: 158 additions & 160 deletions lib/seed/Seeder.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,173 +18,171 @@ const {
// The new seeds we're performing, typically called from the `knex.seed`
// interface on the main `knex` object. Passes the `knex` instance performing
// the seeds.
function Seeder(knex) {
this.knex = knex;
this.config = this.setConfig(knex.client.config.seeds);
}
class Seeder {
constructor(knex) {
this.knex = knex;
this.config = this.setConfig(knex.client.config.seeds);
}

// Runs seed files for the given environment.
Seeder.prototype.run = async function(config) {
this.config = this.setConfig(config);
return this._seedData()
.bind(this)
.then(([all]) => {
const files =
config && config.specific
? all.filter((file) => file === config.specific)
: all;

return this._runSeeds(files);
});
};

// Creates a new seed file, with a given name.
Seeder.prototype.make = function(name, config) {
this.config = this.setConfig(config);
if (!name)
Bluebird.rejected(
new Error('A name must be specified for the generated seed')
);
return this._ensureFolder(config)
.bind(this)
.then(this._generateStubTemplate)
.then(this._writeNewSeed(name));
};

// Lists all available seed files as a sorted array.
Seeder.prototype._listAll = async function(config) {
this.config = this.setConfig(config);
const loadExtensions = this.config.loadExtensions;
return Bluebird.promisify(fs.readdir, { context: fs })(
this._absoluteConfigDir()
)
.bind(this)
.then((seeds) =>
filter(seeds, function(value) {
const extension = path.extname(value);
return includes(loadExtensions, extension);
}).sort()
// Runs seed files for the given environment.
async run(config) {
this.config = this.setConfig(config);
const [all] = await this._seedData();
const files =
config && config.specific
? all.filter((file) => file === config.specific)
: all;
return this._runSeeds(files);
}

// Creates a new seed file, with a given name.
async make(name, config) {
this.config = this.setConfig(config);
if (!name)
throw new Error('A name must be specified for the generated seed')
await this._ensureFolder(config);
const tmpl = await this._generateStubTemplate();
await this._writeNewSeed(name)(tmpl);
}

// Lists all available seed files as a sorted array.
async _listAll(config) {
this.config = this.setConfig(config);
const loadExtensions = this.config.loadExtensions;
return Bluebird.promisify(fs.readdir, { context: fs })(
this._absoluteConfigDir()
)
.bind(this)
.then((seeds) =>
filter(seeds, function(value) {
const extension = path.extname(value);
return includes(loadExtensions, extension);
}).sort()
);
}

// Gets the seed file list from the specified seed directory.
_seedData() {
return Bluebird.join(this._listAll());
}

// Ensures a folder for the seeds exist, dependent on the
// seed config settings.
_ensureFolder() {
const dir = this._absoluteConfigDir();
return Bluebird.promisify(fs.stat, { context: fs })(dir).catch(() =>
Bluebird.promisify(mkdirp)(dir)
);
};

// Gets the seed file list from the specified seed directory.
Seeder.prototype._seedData = function() {
return Bluebird.join(this._listAll());
};

// Ensures a folder for the seeds exist, dependent on the
// seed config settings.
Seeder.prototype._ensureFolder = function() {
const dir = this._absoluteConfigDir();
return Bluebird.promisify(fs.stat, { context: fs })(dir).catch(() =>
Bluebird.promisify(mkdirp)(dir)
);
};

// Run seed files, in sequence.
Seeder.prototype._runSeeds = function(seeds) {
return Bluebird.all(map(seeds, bind(this._validateSeedStructure, this)))
.bind(this)
.then(function(seeds) {
return Bluebird.bind(this).then(function() {
return this._waterfallBatch(seeds);
}

// Run seed files, in sequence.
_runSeeds(seeds) {
return Bluebird.all(map(seeds, bind(this._validateSeedStructure, this)))
.bind(this)
.then(function(seeds) {
return Bluebird.bind(this).then(function() {
return this._waterfallBatch(seeds);
});
});
});
};
}

// Validates seed files by requiring and checking for a `seed` function.
Seeder.prototype._validateSeedStructure = function(name) {
const seed = require(path.join(this._absoluteConfigDir(), name));
if (typeof seed.seed !== 'function') {
throw new Error(`Invalid seed file: ${name} must have a seed function`);
// Validates seed files by requiring and checking for a `seed` function.
_validateSeedStructure(name) {
const seed = require(path.join(this._absoluteConfigDir(), name));
if (typeof seed.seed !== 'function') {
throw new Error(`Invalid seed file: ${name} must have a seed function`);
}
return name;
}
return name;
};

// Generates the stub template for the current seed file, returning a compiled template.
Seeder.prototype._generateStubTemplate = function() {
const stubPath =
this.config.stub ||
_getStubPath() {
return this.config.stub ||
path.join(__dirname, 'stub', this.config.extension + '.stub');
return Bluebird.promisify(fs.readFile, { context: fs })(stubPath).then(
(stub) => template(stub.toString(), { variable: 'd' })
);
};

// Write a new seed to disk, using the config and generated filename,
// passing any `variables` given in the config to the template.
Seeder.prototype._writeNewSeed = function(name) {
const { config } = this;
const dir = this._absoluteConfigDir();
return function(tmpl) {
if (name[0] === '-') name = name.slice(1);
const filename = name + '.' + config.extension;
return Bluebird.promisify(fs.writeFile, { context: fs })(
path.join(dir, filename),
tmpl(config.variables || {})
).return(path.join(dir, filename));
};
};

// Runs a batch of seed files.
Seeder.prototype._waterfallBatch = function(seeds) {
const { knex } = this;
const seedDirectory = this._absoluteConfigDir();
let current = Bluebird.bind({ failed: false, failedOn: 0 });
const log = [];
each(seeds, (seed) => {
const name = path.join(seedDirectory, seed);
seed = require(name);

// Run each seed file.
current = current.then(() =>
// Nesting promise to prevent bubbling up of error on catch
Promise.resolve()
.then(() => seed.seed(knex))
.then(() => log.push(name))
.catch((originalError) => {
const error = new Error(
`Error while executing "${name}" seed: ${originalError.message}`
);
error.original = originalError;
error.stack =
error.stack
.split('\n')
.slice(0, 2)
.join('\n') +
'\n' +
originalError.stack;
throw error;
})
}

// Generates the stub template for the current seed file, returning a compiled template.
_generateStubTemplate() {
const stubPath = this._getStubPath();
return Bluebird.promisify(fs.readFile, { context: fs })(stubPath).then(
(stub) => template(stub.toString(), { variable: 'd' })
);
});

return current.then(() => [log]);
};

Seeder.prototype._absoluteConfigDir = function() {
return path.resolve(process.cwd(), this.config.directory);
};

Seeder.prototype.setConfig = function(config) {
return extend(
{
extension: 'js',
directory: './seeds',
loadExtensions: [
'.co',
'.coffee',
'.eg',
'.iced',
'.js',
'.litcoffee',
'.ls',
'.ts',
],
},
this.config || {},
config
);
};
}

// Write a new seed to disk, using the config and generated filename,
// passing any `variables` given in the config to the template.
_writeNewSeed(name) {
const { config } = this;
const dir = this._absoluteConfigDir();
return function(tmpl) {
if (name[0] === '-') name = name.slice(1);
const filename = name + '.' + config.extension;
return Bluebird.promisify(fs.writeFile, { context: fs })(
path.join(dir, filename),
tmpl(config.variables || {})
).return(path.join(dir, filename));
};
}

// Runs a batch of seed files.
_waterfallBatch(seeds) {
const { knex } = this;
const seedDirectory = this._absoluteConfigDir();
let current = Bluebird.bind({ failed: false, failedOn: 0 });
const log = [];
each(seeds, (seed) => {
const name = path.join(seedDirectory, seed);
seed = require(name);

// Run each seed file.
current = current.then(() =>
// Nesting promise to prevent bubbling up of error on catch
Promise.resolve()
.then(() => seed.seed(knex))
.then(() => log.push(name))
.catch((originalError) => {
const error = new Error(
`Error while executing "${name}" seed: ${originalError.message}`
);
error.original = originalError;
error.stack =
error.stack
.split('\n')
.slice(0, 2)
.join('\n') +
'\n' +
originalError.stack;
throw error;
})
);
});

return current.then(() => [log]);
}

_absoluteConfigDir() {
return path.resolve(process.cwd(), this.config.directory);
}

setConfig(config) {
return extend(
{
extension: 'js',
directory: './seeds',
loadExtensions: [
'.co',
'.coffee',
'.eg',
'.iced',
'.js',
'.litcoffee',
'.ls',
'.ts',
],
},
this.config || {},
config
);
}
}

module.exports = Seeder;

0 comments on commit ce81185

Please sign in to comment.