sails-generate-dscontroller/lib/before.js

Generate a DS controller for Sails.

/**
 * Module dependencies
 */

var util = require('util');
var _ = require('lodash');
var fs = require('fs');
var path = require('path');
var pluralize = require('pluralize');
_.defaults = require('merge-defaults');
_.str = require('underscore.string');

// Fetch stub action template on initial load.
var ACTION_TEMPLATE = path.resolve(__dirname, '../templates/action.template');
ACTION_TEMPLATE = fs.readFileSync(ACTION_TEMPLATE, 'utf8');


/**
 * This `before()` function is run before generating targets.
 * It validates user input, configures defaults, gets extra
 * dependencies, etc.
 *
 * @param  {Object} scope
 * @param  {Function} cb    [callback]
 */

module.exports = function(scope, cb) {

    // scope.args are the raw command line arguments.
    //
    // e.g. if you run:
    // sails generate controlller user find create update
    // then:
    // scope.args = ['user', 'find', 'create', 'update']
    //
    _.defaults(scope, {
        id: scope.args[0],
        actions: scope.args.slice(1)
    });

    //
    // Validate custom scope variables which
    // are required by this generator.
    //
    if (!scope.rootPath) {
        return cb.invalid('Usage: sails generate dscontroller <controllername> [action ...]');
    }

    // Check that we're in a valid sails project
    // TODO: see if we can remove this-- I think it's already been done by
    // Sails core at this point
    var pathToPackageJSON = path.resolve(scope.rootPath, 'package.json');
    var package, invalidPackageJSON;
    try {
        package = require(pathToPackageJSON);
    } catch (e) {
        invalidPackageJSON = true;
    }

    if (invalidPackageJSON) {
        return cb.invalid('Sorry, this command can only be used in the root directory of a Sails project.');
    }

    if (!scope.id) {
        return cb.invalid('Usage: sails generate dscontroller <controllername> [action ...]');
    }

    // Validate optional action arguments
    var actions = scope.actions;
    var invalidActions = [];
    actions = _.map(actions, function(action, i) {

        // Validate action names
        var invalid = action.match(/[^a-zA-Z0-9_\$]+/);

        // Handle errors
        if (invalid) {
            return invalidActions.push(
                'Invalid action notation:   "' + action + '"');
        }
        return action;
    });

    // Handle invalid action arguments
    // Send back invalidActions
    if (invalidActions.length) {
        return cb.invalid(invalidActions);
    }

    // Make sure there aren't duplicates
    if ((_.uniq(actions)).length !== actions.length) {
        return cb.invalid('Duplicate actions not allowed!');
    }



    // Determine default values based on the
    // available scope.

    _.defaults(scope, {
        entity: _.str.capitalize(scope.id) + 'Controller',
        resourcePlural: pluralize(scope.id),
        ext: scope.coffee ? '.coffee' : '.js',
        actions: [],
        destDir: 'api/controllers/'
    });

    _.defaults(scope, {
        rootPath: scope.rootPath,
        filename: scope.entity + scope.ext,
        lang: scope.coffee ? 'coffee' : 'js'
    });



    //
    // Transforms
    //

    // Render some stringified code from the action template
    // and make it available in our scope for use later on.
    scope.actionFns = scope.actionFns || _.map(scope.actions, function(action) {
        var _compiled = _.template(ACTION_TEMPLATE);
        var _obj = {
            controllerName: _.str.capitalize(scope.id),
            actionName: action,
            lang: scope.coffee ? 'coffee' : 'js',
            commentHeading: util.format('`%s.%s()`', scope.entity, action)
        };
        return _.str.rtrim(_.unescape(_compiled(_obj)));

    });


    //
    // Trigger callback with no error to proceed.
    //

    return cb.success();
};