Skip to content

Commit

Permalink
Refactoring and cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@mikermcneil
mikermcneil committed Aug 14, 2014
1 parent eea3b43 commit de4c140
Show file tree
Hide file tree
Showing 2 changed files with 177 additions and 171 deletions.
2 changes: 1 addition & 1 deletion lib/app/configuration/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ module.exports = function(sails) {
hooks: _.reduce(DEFAULT_HOOKS, function (memo, hookName) {
memo[hookName] = require('../../hooks/'+hookName);
return memo;
}, {}),
}, {}) || {},

// Save appPath in implicit defaults
// appPath is passed from above in case `sails lift` was used
Expand Down
346 changes: 176 additions & 170 deletions lib/hooks/index.js
View file
Original file line number Diff line number Diff line change
@@ -1,212 +1,218 @@
module.exports = function (sails) {
/**
* Module dependencies.
*/

var _ = require('lodash');
var defaultsDeep = require('merge-defaults');
var async = require('async');

/**
* Module dependencies.
*/

var util = require( 'sails-util'),
async = require( 'async' );


/**
* Expose hook constructor
*
* @api private
*/
module.exports = function(sails) {

return Hook;

/**
* Expose hook constructor
*
* @api private
*/

function Hook (definition) {
return Hook;


function Hook(definition) {

/**
* Load the hook asynchronously
*
* @api private
*/

this.load = function (cb) {

var self = this;
/**
* Load the hook asynchronously
*
* @api private
*/

// Determine if this hook should load based on Sails environment & hook config
if ( this.config.envs &&
this.config.envs.length > 0 &&
this.config.envs.indexOf(sails.config.environment) === -1) {
return cb();
}

// Convenience config to bind routes before any of the static app routes
sails.on('router:before', function () {
util.each(self.routes.before, function (middleware, route) {
middleware._middlewareType = self.identity.toUpperCase() + ' HOOK' + (middleware.name ? (': ' + middleware.name): '');
sails.router.bind(route, middleware);
});
});

// Convenience config to bind routes after the static app routes
sails.on('router:after', function () {
util.each(self.routes.after, function (middleware, route) {
middleware._middlewareType = self.identity.toUpperCase() + ' HOOK' + (middleware.name ? (': ' + middleware.name): '');
sails.router.bind(route, middleware);
});
});

/**
* Apply hook default configuration to sails.config
*
* @api private
*/
function applyDefaults () {
util.defaultsDeep(sails.config,
util.isFunction(self.defaults) ?
self.defaults(sails.config) :
self.defaults);
}
this.load = function(cb) {

var self = this;

// Run configure and loadModules methods
async.auto({

// If the `userconfig` hook is enabled, always wait for it
// (unless of course, THIS IS `userconfig`)
configuration: function (cb) {

if ( sails.config.hooks.userconfig ) {

// Can't wait for `userconfig` if this IS `userconfig`!!
// Also, `moduleloader` cannot wait for userconfig.
if ( self.identity === 'userconfig' || self.identity === 'moduleloader' ) {
// Determine if this hook should load based on Sails environment & hook config
if (this.config.envs &&
this.config.envs.length > 0 &&
this.config.envs.indexOf(sails.config.environment) === -1) {
return cb();
}

applyDefaults();
self.configure();
return cb();
}
// Convenience config to bind routes before any of the static app routes
sails.on('router:before', function() {
_.each(self.routes.before, function(middleware, route) {
middleware._middlewareType = self.identity.toUpperCase() + ' HOOK' + (middleware.name ? (': ' + middleware.name) : '');
sails.router.bind(route, middleware);
});
});

sails.after('hook:userconfig:loaded', function () {
applyDefaults();
self.configure();
return cb();
});
return;
}
// Convenience config to bind routes after the static app routes
sails.on('router:after', function() {
_.each(self.routes.after, function(middleware, route) {
middleware._middlewareType = self.identity.toUpperCase() + ' HOOK' + (middleware.name ? (': ' + middleware.name) : '');
sails.router.bind(route, middleware);
});
});

/**
* Apply hook default configuration to sails.config
*
* @api private
*/
function applyDefaults() {
defaultsDeep(sails.config,
_.isFunction(self.defaults) ?
self.defaults(sails.config) :
self.defaults);
}

applyDefaults();
self.configure();
return cb();
},

// If the `moduleloader` hook is enabled, always wait for it
// (unless of course, THIS IS `moduleloader`)
modules: ['configuration', function (cb) {
// Run configure and loadModules methods
async.auto({

// Can't wait for moduleloader if this IS moduleloader!!
if ( self.identity === 'moduleloader' ) {
return cb();
}
// If the `userconfig` hook is enabled, always wait for it
// (unless of course, THIS IS `userconfig`)
configuration: function(cb) {

if (sails.config.hooks.userconfig) {

// Can't wait for `userconfig` if this IS `userconfig`!!
// Also, `moduleloader` cannot wait for userconfig.
if (self.identity === 'userconfig' || self.identity === 'moduleloader') {

if (sails.config.hooks.moduleloader) {
applyDefaults();
self.configure();
return cb();
}

// Load modules
sails.after('hook:moduleloader:loaded', function moduleloaderReady () {
return self.loadModules(cb);
});
return;
}
sails.after('hook:userconfig:loaded', function() {
applyDefaults();
self.configure();
return cb();
});
return;
}

return cb();
}]
}, function (err) {
if (err) return cb(err);

// Call initialize() method if one provided
if (self.initialize) { self.initialize(cb); }
else cb();
});

};



/**
* Default configuration for this hook
* (should be overiden by hook definition)
*
* @returns {}
*/
this.defaults = function (config) {
return {};
};

/**
* `configure`
*
* Normalize and validate configuration for this hook.
* Then fold modifications back into `sails.config`
*
* Hooks may override this function.
*/
this.configure = function () {
return;
};

/**
* Hooks should override this function
*/
this.loadModules = function (cb) {
return cb();
};
applyDefaults();
self.configure();
return cb();
},

// If the `moduleloader` hook is enabled, always wait for it
// (unless of course, THIS IS `moduleloader`)
modules: ['configuration',
function(cb) {

// Can't wait for moduleloader if this IS moduleloader!!
if (self.identity === 'moduleloader') {
return cb();
}

/////// TODO: most of the following could be replaced by taking advantage of lodash "merge"
if (sails.config.hooks.moduleloader) {

// Load modules
sails.after('hook:moduleloader:loaded', function moduleloaderReady() {
return self.loadModules(cb);
});
return;
}

return cb();
}
]
}, function(err) {
if (err) return cb(err);

// Call initialize() method if one provided
if (self.initialize) {
self.initialize(cb);
} else cb();
});

};



/**
* Default configuration for this hook
* (should be overiden by hook definition)
*
* @returns {}
*/
this.defaults = function(config) {
return {};
};

/**
* `configure`
*
* Normalize and validate configuration for this hook.
* Then fold modifications back into `sails.config`
*
* Hooks may override this function.
*/
this.configure = function() {
return;
};

/**
* Hooks should override this function
*/
this.loadModules = function(cb) {
return cb();
};

// Ensure that the hook definition has valid properties
_normalize( this );
definition = _normalize( definition );

// Merge default definition with overrides in the definition passed in
util.extend( definition.config, this.config, definition.config );
util.extend( definition.middleware, this.middleware, definition.middleware );
util.extend( definition.routes.before, this.routes.before, definition.routes.before );
util.extend( definition.routes.after, this.routes.after, definition.routes.after );
util.extend( this, definition );

// Bind context of new methods from definition
util.bindAll(this);
/////// TODO: most of the following could be replaced by taking advantage of lodash "merge"

// Ensure that the hook definition has valid properties
_normalize(this);
definition = _normalize(definition);

// Merge default definition with overrides in the definition passed in
_.extend(definition.config, this.config, definition.config);
_.extend(definition.middleware, this.middleware, definition.middleware);
_.extend(definition.routes.before, this.routes.before, definition.routes.before);
_.extend(definition.routes.after, this.routes.after, definition.routes.after);
_.extend(this, definition);

// Bind context of new methods from definition
_.bindAll(this);

/**
* Ensure that a hook definition has the required properties
* @api private
*/

function _normalize ( def ) {

def = def || {};
/**
* Ensure that a hook definition has the required properties
* @api private
*/

function _normalize(def) {

def = def || {};

// Default hook config
def.config = def.config || {};

// Default hook config
def.config = def.config || {};
// list of environments to run in, if empty defaults to all
def.config.envs = def.config.envs || [];

// list of environments to run in, if empty defaults to all
def.config.envs = def.config.envs || [];
def.middleware = def.middleware || {};

def.middleware = def.middleware || {};
// Default hook routes
def.routes = def.routes || {};
def.routes.before = def.routes.before || {};
def.routes.after = def.routes.after || {};

// Default hook routes
def.routes = def.routes || {};
def.routes.before = def.routes.before || {};
def.routes.after = def.routes.after || {};
// Always set ready to true-- doesn't need to do anything asynchronous
def.ready = true;

// Always set ready to true-- doesn't need to do anything asynchronous
def.ready = true;

return def;
}
}
return def;
}
}

};

0 comments on commit de4c140

Please sign in to comment.