compound-ex4/lib/server/generators/app_generator.js

Compound-ex4 - MVC framework for NodeJS (ExpressJs 4 version), fork compoundjs(https://github.com/1602/compound)

/**
 * lib/generators/app_generator.js
 *
 * @defines {AppGenerator}
 * @since {1.1.4}
 * @creator {Sascha Gehlich <sascha@gehlich.us>}
 * @description {
 *   Generates an entirely new CompoundJS application
 * }
 */

/**
 * Module dependencies
 */
var util = require('util');
var BaseGenerator = require('./base_generator');
var path = require('path');

/**
 * Generates an entirely new CompoundJS application
 *
 * @constructor
 */
function AppGenerator() {
  AppGenerator.super_.call(this);
};
util.inherits(AppGenerator, BaseGenerator);

/**
 * Command line aliases
 */
AppGenerator.aliases = ['app', 'a', 'init'];

/**
 * Default key name (first command line argument is stored in options[defaultKeyName])
 */
AppGenerator.prototype.defaultKeyName = 'appName';

/**
 * Performs the generator action
 *
 * @param {Array} arguments
 */
AppGenerator.prototype.perform = function (args) {
  BaseGenerator.prototype.perform.apply(this, [].slice.call(arguments));

  if (this.options.appName) {
    this.baseDir = path.join(this.baseDir, this.options.appName);
  }
  if (this.isBaseDirExists()) {
    return;
  }
  this.createDirectoryStructure();
  this.copyFiles();
};

/**
 * Creates the basic directory structure
 */
AppGenerator.prototype.createDirectoryStructure = function () {
  var self = this;
  [
    'app/',
    'app/models/',
    'app/controllers/',
    'app/helpers/',
    'app/tools/',
    'app/views/',
    'app/views/layouts/',
    'app/views/partials/',
    'db/',
    'db/seeds/',
    'db/seeds/development/',
    'log/',
    'public/',
    'public/images',
    'public/fonts/',
    'public/bundle/',
    'public/vendor/',
    'node_modules/',
    'config/',
    'test/',
    'config/locales/',
    'config/initializers/',
    'config/environments/'
  ].forEach(function (dir) {
    self.createDirectory(dir);
  });
};

/**
 * Copy files from templates directory
 */
AppGenerator.prototype.copyFiles = function () {
  var self = this;
  var templateVariables = {
    ENGINE:             this.getEngine(),
    STYLE:              this.getCSSEngineExtension(),
    CODE:               this.getCodeExtension(),
    TPL:                this.getTemplateExtension(),
    DATA:               this.getDataExtension(),
    VIEWENGINE:         this.getTemplateEngine(),
    CSSENGINE:          this.getCSSEngine(),
    APPNAME:            this.getAppName(),
    SECRET:             this.generateSecret(),
    DBDRIVER:           this.getDatabaseDriver(),
    SUFFIX:             this.isEvalAllowed() ? '_controller' : '',
    EVAL:               this.isEvalAllowed() ? '_eval' : '',
    DBDEPENDENCY:       this.getDatabaseDependency()
  };

  [
    'app/tools/database.{{ CODE }}',
    'config/environment.{{ CODE }}',
    'config/environments/development.{{ CODE }}',
    'config/environments/production.{{ CODE }}',
    'config/environments/test.{{ CODE }}',
    'config/routes.{{ CODE }}',
    'config/autoload.{{ CODE }}',
    'db/schema.{{ CODE }}',
    'public/favicon.ico',
    'Procfile',
    'README.md',
    'package.json',
    'config.jscs.json',
    'server.{{ CODE }}'
  ].forEach(function (file) {
    self.copyFile(file, templateVariables);
  });

  self.copyFile('gitignore-example', '.gitignore', {});

  self.copyFile('config/database_{{ DBDRIVER }}.{{ CODE }}', 'config/database.{{ CODE }}', templateVariables);
  self.copyTemplate('application_layout', 'app/views/layouts/application_layout.{{ TPL }}', templateVariables);
  self.copyController('application_controller{{ EVAL }}.{{ CODE }}', 'app/controllers/application{{ SUFFIX }}.{{ CODE }}', templateVariables);
};

/**
 * Helper methods for renaming / replacing template variables
 */

module.exports = AppGenerator;