pimm.js

(function() {
  'use strict';

  var keylime = require('keylime'),
      mach = require('mach'),
      _ = require('lodash'),
      p = require('path'),
      Promise = require('bluebird'),

      renderExtension = mach.extend(require('./mach/render_extension')),

      Path = require('./pimm/support/path'),
      Controller = require('./pimm/controller'),
      ControllerManager = require('./pimm/controller_manager'),
      ViewManager = require('./pimm/view_manager'),
      Router = require('./pimm/router'),

      Pimm = keylime('Pimm');

  Pimm
    .attr('dir', '.' + p.sep)
    .attr('port', 3000)
    .attr('static', false)
    .attr('session', false)
    .attr('caching', true)
    .attr('templating', 'jade')

    .attr('_stack', mach.stack)
    .attr('_controller_manager', ControllerManager.create.bind(ControllerManager))
    .attr('_view_manager', ViewManager.create.bind(ViewManager))
    .attr('_router', Router.create.bind(Router))
    .attr('_config', {})
    .attr('_middleware', [])
    .attr('_default_middleware', [
      {middleware: mach.logger},
      {middleware: mach.params},
      {middleware: mach.gzip}
    ])

    /**
     * Interface to a generic configuration storage. Pimm does not use
     * this config interface for determining behavior, but you can use
     * it for storing global configuration values.
     *
     *    // main application.js file
     *    app
     *      .config('redis', {host: 'localhost'})
     *      .config('debug', true);
     *
     *    // some other module.js
     *    var app = require('./application');
     *
     *    app.config('redis');   // => gets the redis conf
     *    app.config();          // => gets all config
     */
    .method('config', function config() {
      var args = [].slice.call(arguments);

      switch (_.size(args)) {
        case 2:
          this._config[args[0]] = args[1];
          return this;
        case 1:
          return this._config[args[0]];
        default:
          return this._config;
      }
    })

    /**
     * Adds middleware to the stack (chainable);
     */
    .method('use', function use() {
      var middleware = _.first(arguments),
          args = _.drop(arguments, 1);

      if (!_.isFunction(middleware)) {
        throw new Error('You must supply a function argument to the \'use\' method.');
      }

      this._middleware.push({
        middleware: middleware,
        args: args
      });
      return this;
    })

    /**
     * Add routes to the Pimm application. Use the `this` keyword
     * inside the function to add routes.
     *
     * (See router.js to see what routing methods are available)
     *
     *    app.routes(function() {
     *      this.resources('posts');
     *
     *      this.namespace('admin', function() {
     *        this.resources('users');
     *      });
     *    });
     */
    .method('routes', function routes(func) {
      if (_.isFunction(func)) {
        func.call(this._router);
      }
      return this;
    })

    /**
     * Starts the application.
     *
     *    app.start().then(function() {
     *      console.log('App started!');
     *    });
     */
    .method('start', function start() {
      return Promise.all([this._loadControllers(), this._loadViews()])
      .bind(this)
      .then(function() {
        this._addStaticMiddleware();
        this._addSessionMiddleware();
        this._loadMiddleware();
        this._normalizeRoutes();
        this._activateRoutes();
        mach.serve(this._stack, this.port);
        return true;
      });
    })

    /**
     * Adds and queued up middleware to the mach stack.
     */
    .method('_loadMiddleware', function loadMiddleware() {
      _.each(_.flatten([this._default_middleware, this._middleware]), _.bind(function(middleware) {
        this._stack.use.apply(this._stack, _.flatten([middleware.middleware, middleware.args]));
      }, this));
    })

    /**
     * Adds a static file server, if Pimm is configured.
     */
    .method('_addStaticMiddleware', function addStaticMiddleware() {
      var opts = {index: true};

      if (!this.static) {
        return;
      }

      if (_.isPlainObject(this.static)) {
        opts = _.extend(opts, this.static);
        opts.root = new Path({value: this.static.dir || './public'}).resolve();
      } else if (_.isString(this.static)) {
        opts.root = new Path({value: this.static || './public'}).resolve();
      }

      this._default_middleware.push({
        middleware: mach.file,
        args: [opts]
      });
    })

    /**
     * Adds session middleware.
     */
    .method('_addSessionMiddleware', function addSessionMiddleware() {
      var opts = {};

      if (!this.session) {
        return;
      }

      if (_.isPlainObject(this.session)) {
        opts = _.extend(opts, this.session);
      } else if (_.isString(this.session)) {
        opts.secret = this.session;
      }

      this._default_middleware.push({
        middleware: mach.session,
        args: [opts]
      });
    })

    /**
     * Delegates to the controller manager for loading up
     * controllers and mapping them to signatures for routing.
     */
    .method('_loadControllers', function loadControllers() {
      var controllerPath = new Path({value: this.dir}).resolve('controllers');

      this._controller_manager.dir = controllerPath;
      this._controller_manager._view_manager = this._view_manager;
      return this._controller_manager.load()
      .catch(function checkError(e) {
        return _.includes(e.message, 'ENOENT');
      }, function logError(e) {
        console.log('>> WARNING: No controllers directory found '+e.cause.path);
      });
    })

    /**
     * Delegates to the view manager for loading up views.
     */
    .method('_loadViews', function loadViews() {
      var viewPath = new Path({value: this.dir}).resolve('views');

      this._view_manager.engine = this.templating;
      this._view_manager.caching = this.caching;
      this._view_manager.dir = viewPath;
      this._view_manager.sharedData.Pimm = {
        config: this._config
      };
      return this._view_manager.load()
      .catch(function checkError(e) {
        return _.includes(e.message, 'ENOENT');
      }, function logError(e) {
        console.log('>> WARNING: No views directory found '+e.cause.path);
      });
    })

    /**
     * Removes any routes that don't have real controller
     * methods backing them up.
     */
    .method('_normalizeRoutes', function normalizeRoutes() {
      this._router.routes = _.filter(this._router.routes, _.bind(function checkRoute(route) {
        var handler = _.isFunction(route.action) ? route.action : this._controller_manager.methodForSignature(route.action);
        return _.isFunction(handler);
      }, this));
    })

    /**
     * Maps all the routes to controller handlers.
     */
    .method('_activateRoutes', function activateRoutes() {
      _.each(this._router.routes, _.bind(function activateRoute(route) {
        var handler = _.isFunction(route.action) ? route.action : this._controller_manager.methodForSignature(route.action);
        this._stack[route.method](route.path, handler);
      }, this));
    });

  module.exports = Pimm;
  module.exports.Controller = Controller;
}());