lotusrb 0.5.0 → 0.6.0

data/lib/lotus/commands/new/container.rb

@@ -0,0 +1,102 @@
+require 'lotus/commands/generate/app'
+require 'lotus/commands/new/abstract'
+
+module Lotus
+  module Commands
+    class New
+      class Container < Abstract
+
+        DEFAULT_APPLICATION_NAME = 'web'.freeze
+
+        def map_templates
+          add_application_templates
+          add_empty_directories
+          add_test_templates
+          add_sql_templates
+          add_git_templates
+        end
+
+        def template_options
+          {
+            app_name:              app_name,
+            lotus_head:            lotus_head?,
+            test:                  test_framework.framework,
+            database:              database_config.type,
+            database_config:       database_config.to_hash,
+            lotus_model_version:   lotus_model_version,
+          }
+        end
+
+        def post_process_templates
+          init_git
+          generate_app
+        end
+
+        private
+
+        def add_application_templates
+          add_mapping('lotusrc.tt', '.lotusrc')
+          add_mapping('.env.tt', '.env')
+          add_mapping('.env.development.tt', '.env.development')
+          add_mapping('.env.test.tt', '.env.test')
+          add_mapping('Gemfile.tt', 'Gemfile')
+          add_mapping('config.ru.tt', 'config.ru')
+          add_mapping('config/environment.rb.tt', 'config/environment.rb')
+          add_mapping('lib/app_name.rb.tt', "lib/#{ app_name }.rb")
+          add_mapping('lib/config/mapping.rb.tt', 'lib/config/mapping.rb')
+        end
+
+        def add_test_templates
+          if test_framework.rspec?
+            add_mapping('Rakefile.rspec.tt', 'Rakefile')
+            add_mapping('rspec.rspec.tt', '.rspec')
+            add_mapping('spec_helper.rb.rspec.tt', 'spec/spec_helper.rb')
+            add_mapping('features_helper.rb.rspec.tt', 'spec/features_helper.rb')
+            add_mapping('capybara.rb.rspec.tt', 'spec/support/capybara.rb')
+          else # minitest (default)
+            add_mapping('Rakefile.minitest.tt', 'Rakefile')
+            add_mapping('spec_helper.rb.minitest.tt', 'spec/spec_helper.rb')
+            add_mapping('features_helper.rb.minitest.tt', 'spec/features_helper.rb')
+          end
+        end
+
+        def add_empty_directories
+          add_mapping('.gitkeep', 'public/.gitkeep')
+          add_mapping('.gitkeep', 'config/initializers/.gitkeep')
+          add_mapping('.gitkeep', "lib/#{ app_name }/entities/.gitkeep")
+          add_mapping('.gitkeep', "lib/#{ app_name }/repositories/.gitkeep")
+          add_mapping('.gitkeep', "lib/#{ app_name }/mailers/.gitkeep")
+          add_mapping('.gitkeep', "lib/#{ app_name }/mailers/templates/.gitkeep")
+          add_mapping('.gitkeep', "spec/#{ app_name }/entities/.gitkeep")
+          add_mapping('.gitkeep', "spec/#{ app_name }/repositories/.gitkeep")
+          add_mapping('.gitkeep', "spec/#{ app_name }/mailers/.gitkeep")
+          add_mapping('.gitkeep', 'spec/support/.gitkeep')
+
+          if database_config.sql?
+            add_mapping('.gitkeep', 'db/migrations/.gitkeep')
+          else
+            add_mapping('.gitkeep', 'db/.gitkeep')
+          end
+        end
+
+        def generate_app
+          Lotus::Commands::Generate::App.new(app_options, app_slice_name).start
+        end
+
+        def app_options
+          {
+            application_base_url: application_base_url
+          }
+        end
+
+        def app_slice_name
+          options.fetch(:application_name, DEFAULT_APPLICATION_NAME)
+        end
+
+        def template_source_path
+          Pathname.new(::File.dirname(__FILE__)).join('..', '..', 'generators', 'application', 'container').realpath
+        end
+      end
+    end
+  end
+end

data/lib/lotus/commands/routes.rb

@@ -1,17 +1,34 @@
 module Lotus
   module Commands
+    # Display application/container routes.
+    #
+    # It is run with:
+    #
+    #   `bundle exec lotus routes`
+    #
+    # @since 0.1.0
+    # @api private
     class Routes
-      def initialize(environment)
-        @environment = environment
+      # @param options [Hash] Environment's options
+      #
+      # @since 0.1.0
+      # @see Lotus::Environment#initialize
+      def initialize(options)
+        @environment = Lotus::Environment.new(options)
         @environment.require_application_environment
       end
 
+      # Display to STDOUT application routes
+      #
+      # @since 0.1.0
       def start
         puts app.routes.inspector.to_s
       end
 
       private
 
+      # @since 0.1.0
+      # @api private
       def app
         if @environment.container?
           Lotus::Container.new

data/lib/lotus/commands/server.rb

@@ -19,8 +19,12 @@ module Lotus
     class Server < ::Rack::Server
       attr_reader :options
 
-      def initialize(env)
-        @_env    = env
+      # @param options [Hash] Environment's options
+      #
+      # @since 0.1.0
+      # @see Lotus::Environment#initialize
+      def initialize(options)
+        @_env    = Lotus::Environment.new(options)
         @options = _extract_options(@_env)
 
         if code_reloading?
@@ -31,6 +35,8 @@ module Lotus
 
       # Primarily this removes the ::Rack::Chunked middleware
       # which is the cause of Safari content-length bugs.
+      #
+      # @since 0.1.0
       def middleware
         mw = Hash.new { |e, m| e[m] = [] }
         mw["deployment"].concat([::Rack::ContentLength, ::Rack::CommonLogger])
@@ -38,6 +44,9 @@ module Lotus
         mw
       end
 
+      # Kickstart shotgun preloader if code reloading is supported
+      #
+      # @since 0.1.0
       def start
         if code_reloading?
           Shotgun.enable_copy_on_write
@@ -48,6 +57,9 @@ module Lotus
       end
 
       private
+
+      # @since 0.1.0
+      # @api private
       def _extract_options(env)
         env.to_options.merge(
           config:      env.rackup.to_s,
@@ -57,6 +69,8 @@ module Lotus
         )
       end
 
+      # @since 0.1.0
+      # @api private
       def code_reloading?
         @_env.code_reloading?
       end

data/lib/lotus/config/framework_configuration.rb

@@ -8,18 +8,30 @@ module Lotus
     class FrameworkConfiguration < BasicObject
       # @since 0.2.0
       # @api private
-      def initialize
+      def initialize(&blk)
+        @blocks   = [blk || ::Proc.new { }]
         @settings = []
       end
 
       # @since 0.2.0
       # @api private
       def __apply(configuration)
+        @blocks.compact.each do |blk|
+          configuration.instance_eval(&blk)
+        end
+
         @settings.each do |(m, args, blk)|
           configuration.public_send(m, *args, &blk)
         end
       end
 
+      # @since 0.6.0
+      # @api private
+      def __add(&blk)
+        @blocks << blk
+        self
+      end
+
       # @since 0.2.0
       # @api private
       def method_missing(m, *args, &blk)

data/lib/lotus/configuration.rb

@@ -3,7 +3,6 @@ require 'lotus/utils/deprecation'
 require 'lotus/environment'
 require 'lotus/config/framework_configuration'
 require 'lotus/config/load_paths'
-require 'lotus/config/assets'
 require 'lotus/config/routes'
 require 'lotus/config/mapping'
 require 'lotus/config/sessions'
@@ -389,8 +388,6 @@ module Lotus
     #
     # @since 0.1.0
     #
-    # @see Lotus::Configuration#serve_assets
-    #
     # @example Getting the value
     #   require 'lotus'
     #
@@ -408,69 +405,22 @@ module Lotus
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
-    #         serve_assets true
-    #         assets << [
-    #           'vendor/assets'
-    #         ]
+    #         assets do
+    #           sources << [
+    #             'vendor/assets'
+    #           ]
+    #         end
     #       end
     #     end
     #   end
     #
     #   Bookshelf::Application.configuration.assets
     #     # => #<Lotus::Config::Assets @root=#<Pathname:/root/path/assets>, @paths=["public"]>
-    #
-    def assets
-      @assets ||= Config::Assets.new(root)
-    end
-
-    # Configure serving of assets
-    # Enable static assets (disabled by default).
-    #
-    # This is part of a DSL, for this reason when this method is called with
-    # an argument, it will set the corresponding instance variable. When
-    # called without, it will return the already set value, or the default.
-    #
-    # @since 0.2.0
-    #
-    # @overload serve_assets(value)
-    #   Sets the given value.
-    #   @param value [TrueClass, FalseClass]
-    #
-    # @overload serve_assets
-    #   Gets the value.
-    #   @return [TrueClass, FalseClass]
-    #
-    # @see Lotus::Configuration#assets
-    #
-    # @example Getting serve assets configuration by default
-    #   require 'lotus'
-    #
-    #   module Bookshelf
-    #     class Application < Lotus::Application
-    #     end
-    #   end
-    #
-    #   Bookshelf::Application.configuration.serve_assets
-    #     # => false
-    #
-    # @example Enabling static assets
-    #   require 'lotus'
-    #
-    #   module Bookshelf
-    #     class Application < Lotus::Application
-    #       configure do
-    #         serve_assets true
-    #       end
-    #     end
-    #   end
-    #
-    #   Bookshelf::Application.configuration.serve_assets
-    #     # => true
-    def serve_assets(value = nil)
-      if value.nil?
-        @serve_assets || false
+    def assets(&blk)
+      if @assets
+        @assets.__add(&blk)
       else
-        @serve_assets = value
+        @assets ||= Config::FrameworkConfiguration.new(&blk)
       end
     end
 
@@ -1277,14 +1227,12 @@ module Lotus
     #       end
     #     end
     #
-    #     module Controllers
-    #       module Dashboard
-    #         include Bookshelf::Controller
+    #     module Controllers::Dashboard
+    #       class Index
+    #         include Bookshelf::Action
     #
-    #         action 'Index' do
-    #           def call(params)
-    #             # ...
-    #           end
+    #         def call(params)
+    #           # ...
     #         end
     #       end
     #     end
@@ -1312,9 +1260,9 @@ module Lotus
     #     end
     #
     #     module DashboardController
-    #       include Bookshelf::Controller
+    #       class Index
+    #         include Bookshelf::Action
     #
-    #       action 'Index' do
     #         def call(params)
     #         end
     #       end
@@ -1345,9 +1293,9 @@ module Lotus
     #   end
     #
     #   module DashboardController
-    #     include Bookshelf::Controller
+    #     class Index
+    #       incude Bookshelf::Action
     #
-    #     action 'Index' do
     #       def call(params)
     #       end
     #     end
@@ -1530,9 +1478,9 @@ module Lotus
     #     end
     #
     #     module Controllers::Error
-    #       include Bookshelf::Controller
+    #       class Index
+    #         include Bookshelf::Action
     #
-    #       action 'Index' do
     #         def call(params)
     #           raise ArgumentError
     #         end
@@ -1559,9 +1507,9 @@ module Lotus
     #     end
     #
     #     module Controllers::Error
-    #       include Bookshelf::Controller
+    #       class Index
+    #         include Bookshelf::Action
     #
-    #       action 'Index' do
     #         def call(params)
     #           raise ArgumentError
     #         end
@@ -1731,9 +1679,9 @@ module Lotus
     #     end
     #
     #     module Controllers::Error
-    #       include Bookshelf::Controller
+    #       class Index
+    #         include Bookshelf::Action
     #
-    #       action 'Index' do
     #         def call(params)
     #           Bookshelf::Logger.info "Logging to STDOUT"
     #         end

data/lib/lotus/container.rb

@@ -1,4 +1,5 @@
 require 'thread'
+require 'rack/builder'
 require 'lotus/router'
 
 module Lotus
@@ -28,12 +29,12 @@ module Lotus
     def initialize
       Mutex.new.synchronize do
         assert_configuration_presence!
-        @routes = Router.new(&@@configuration)
+        prepare_middleware_stack!
       end
     end
 
     def call(env)
-      @routes.call(env)
+      @builder.call(env)
     end
 
     private
@@ -42,5 +43,17 @@ module Lotus
         raise ArgumentError.new("#{ self.class } doesn't have any application mounted.")
       end
     end
+
+    def prepare_middleware_stack!
+      @builder = ::Rack::Builder.new
+      @routes  = Router.new(&@@configuration)
+
+      if Lotus.environment.serve_static_assets?
+        require 'lotus/static'
+        @builder.use Lotus::Static
+      end
+
+      @builder.run @routes
+    end
   end
 end

data/lib/lotus/environment.rb

@@ -29,6 +29,18 @@ module Lotus
     # @api private
     DEFAULT_ENV    = 'development'.freeze
 
+    # Production environment
+    #
+    # @since 0.6.0
+    # @api private
+    PRODUCTION_ENV = 'production'.freeze
+
+    # Rack production environment (aka deployment)
+    #
+    # @since 0.6.0
+    # @api private
+    RACK_ENV_DEPLOYMENT = 'deployment'.freeze
+
     # Default `.env` file name
     #
     # @since 0.2.0
@@ -111,6 +123,14 @@ module Lotus
     # @api private
     APPLICATION_PATH = 'app'.freeze
 
+    # @since 0.4.0
+    # @api private
+    SERVE_STATIC_ASSETS = 'SERVE_STATIC_ASSETS'.freeze
+
+    # @since 0.4.0
+    # @api private
+    SERVE_STATIC_ASSETS_ENABLED = 'true'.freeze
+
     # Initialize a Lotus environment
     #
     # It accepts an optional set of configurations from the CLI commands.
@@ -173,7 +193,7 @@ module Lotus
     #   # the one defined in the parent (eg `FOO` is overwritten). All the
     #   # other settings (eg `XYZ`) will be left untouched.
     def initialize(options = {})
-      @options = Lotus::Lotusrc.new(root, options).read
+      @options = Lotus::Lotusrc.new(root).options
       @options.merge! Utils::Hash.new(options.clone).symbolize!
       @mutex   = Mutex.new
       @mutex.synchronize { set_env_vars! }
@@ -188,13 +208,15 @@ module Lotus
     #
     # If those are missing it falls back to the defalt one: `"development"`.
     #
+    # Rack environment `"deployment"` is translated to Lotus `"production"`.
+    #
     # @return [String] the current environment
     #
     # @since 0.1.0
     #
     # @see Lotus::Environment::DEFAULT_ENV
     def environment
-      @environment ||= ENV[LOTUS_ENV] || ENV[RACK_ENV] || DEFAULT_ENV
+      @environment ||= ENV[LOTUS_ENV] || rack_env || DEFAULT_ENV
     end
 
     # @since 0.3.1
@@ -213,7 +235,7 @@ module Lotus
     #
     # @see http://bundler.io/v1.7/groups.html
     def bundler_groups
-      [environment]
+      [:default, environment]
     end
 
     # Application's root
@@ -385,6 +407,12 @@ module Lotus
       architecture == CONTAINER
     end
 
+    # @since 0.6.0
+    # @api private
+    def serve_static_assets?
+      SERVE_STATIC_ASSETS_ENABLED == ENV[SERVE_STATIC_ASSETS]
+    end
+
     # @since 0.4.0
     # @api private
     def apps_path
@@ -418,8 +446,8 @@ module Lotus
     # @since 0.1.0
     # @api private
     def set_env_vars!
-      set_lotus_env_vars!
       set_application_env_vars!
+      set_lotus_env_vars!
     end
 
     # @since 0.2.0
@@ -442,5 +470,16 @@ module Lotus
     def default_host
       environment == DEFAULT_ENV ? DEFAULT_HOST : LISTEN_ALL_HOST
     end
+
+    # @since 0.6.0
+    # @api private
+    def rack_env
+      case ENV[RACK_ENV]
+      when RACK_ENV_DEPLOYMENT
+        PRODUCTION_ENV
+      else
+        ENV[RACK_ENV]
+      end
+    end
   end
 end