lotusrb 0.2.1 → 0.3.0

data/lib/lotus/configuration.rb

@@ -7,6 +7,8 @@ require 'lotus/config/routes'
 require 'lotus/config/mapping'
 require 'lotus/config/sessions'
 require 'lotus/config/configure'
+require 'lotus/config/security'
+require 'lotus/config/cookies'
 
 module Lotus
   # Configuration for a Lotus application
@@ -35,7 +37,6 @@ module Lotus
     # set a path for the specific environment.
     #
     # @param environment [Symbol,nil] the configuration environment name
-    # @param environment [String,nil] the configuration path of a specific environment
     # @param blk [Proc] the configuration block
     #
     # @return [self]
@@ -69,6 +70,44 @@ module Lotus
       self
     end
 
+    # Returns the security policy
+    #
+    # @return [Lotus::Config::Security]
+    #
+    # @since 0.3.0
+    #
+    # @see Lotus::Config::Security
+    #
+    # @example Getting values
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #       configure do
+    #         security.x_frame_options         "ALLOW ALL"
+    #         security.content_security_policy "script-src 'self' https://apis.example.com"
+    #       end
+    #     end
+    #   end
+    #
+    #   Bookshelf::Application.configuration.security.x_frame_options         # => "ALLOW ALL"
+    #   Bookshelf::Application.configuration.security.content_security_policy # => "script-src 'self' https://apis.example.com"
+    #
+    # @example Setting values
+    #   require 'lotus'
+    #
+    #   module Bookshelf
+    #     class Application < Lotus::Application
+    #       configure do
+    #         security.x_frame_options         "ALLOW ALL"
+    #         security.content_security_policy "script-src 'self' https://apis.example.com"
+    #       end
+    #     end
+    #   end
+    def security
+      @security ||= Config::Security.new
+    end
+
     # The root of the application
     #
     # By default it returns the current directory, for this reason, **all the
@@ -426,13 +465,14 @@ module Lotus
     # an argument, it will set the corresponding instance variable. When
     # called without, it will return the already set value, or the default.
     #
-    # @overload cookies(value)
-    #   Sets the given value.
+    # @overload cookies(value, options)
+    #   Sets the given value with their options.
     #   @param value [TrueClass, FalseClass]
+    #   @param options [Hash]
     #
     # @overload cookies
     #   Gets the value.
-    #   @return [TrueClass, FalseClass]
+    #   @return [Lotus::Config::Cookies]
     #
     # @example Getting the value
     #   require 'lotus'
@@ -443,7 +483,7 @@ module Lotus
     #   end
     #
     #   Bookshelf::Application.configuration.cookies
-    #     # => false
+    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @enabled=false, @default_options={:httponly=>true}>
     #
     # @example Setting the value
     #   require 'lotus'
@@ -451,13 +491,13 @@ module Lotus
     #   module Bookshelf
     #     class Application < Lotus::Application
     #       configure do
-    #         cookies true
+    #         cookies true, { domain: 'lotusrb.org' }
     #       end
     #     end
     #   end
     #
     #   Bookshelf::Application.configuration.cookies
-    #     # => true
+    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @enabled=true, @default_options={:domain=>'lotusrb.org', :httponly=>true}>
     #
     # @example Setting a new value after one is set.
     #   require 'lotus'
@@ -472,13 +512,13 @@ module Lotus
     #   end
     #
     #   Bookshelf::Application.configuration.cookies
-    #     # => true
+    #     # => #<Lotus::Config::Cookies:0x0000000329f880 @enabled=true, @default_options={:httponly=>true}>
     #
-    def cookies(value = nil)
+    def cookies(value = nil, options = {})
       if value.nil?
-        @cookies || false
+        @cookies ||= Config::Cookies.new
       else
-        @cookies = value
+        @cookies = Config::Cookies.new(value, options)
       end
     end
 
@@ -1134,14 +1174,15 @@ module Lotus
     # setting helps to understand the namespace where to find applications'
     # controllers and actions.
     #
-    # By default this equals to `"Controllers::%{controller}::%{action}"`
+    # By default this equals to <tt>"Controllers::%{controller}::%{action}"</tt>
     # That means controllers must be structured like this:
-    # `Bookshelf::Controllers::Dashboard::Index`, where `Bookshelf` is the
-    # application module, `Controllers` is the first value specified in the
-    # pattern, `Dashboard` the controller and `Index` the action.
+    # <tt>Bookshelf::Controllers::Dashboard::Index</tt>, where <tt>Bookshelf</tt>
+    # is the application module, <tt>Controllers</tt> is the first value
+    # specified in the pattern, <tt>Dashboard</tt> the controller and
+    # <tt>Index</tt> the action.
     #
-    # This pattern MUST always contain `"%{controller}"` and `%{action}`.
-    # This pattern SHOULD be used accordingly to `#view_pattern` value.
+    # This pattern MUST always contain <tt>"%{controller}"</tt> and <tt>%{action}</tt>.
+    # This pattern SHOULD be used accordingly to <tt>#view_pattern</tt> value.
     #
     # 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
@@ -1267,15 +1308,15 @@ module Lotus
     # setting helps to understand the namespace where to find applications'
     # views:.
     #
-    # By default this equals to `"Views::%{controller}::%{action}"`
+    # By default this equals to <tt>"Views::%{controller}::%{action}"</tt>
     # That means views must be structured like this:
-    # `Bookshelf::Views::Dashboard::Index`, where `Bookshelf` is the
-    # application module, `Views` is the first value specified in the
-    # pattern, `Dashboard` a module corresponding to the controller name
-    # and `Index` the view, corresponding to the action name.
+    # <tt>Bookshelf::Views::Dashboard::Index</tt>, where <tt>Bookshelf</tt> is
+    # the application module, <tt>Views</tt> is the first value specified in the
+    # pattern, <tt>Dashboard</tt> a module corresponding to the controller name
+    # and <tt>Index</tt> the view, corresponding to the action name.
     #
-    # This pattern MUST always contain `"%{controller}"` and `%{action}`.
-    # This pattern SHOULD be used accordingly to `#controller_pattern` value.
+    # This pattern MUST always contain <tt>"%{controller}"</tt> and <tt>%{action}</tt>.
+    # This pattern SHOULD be used accordingly to <tt>#controller_pattern</tt> value.
     #
     # 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

data/lib/lotus/environment.rb

@@ -2,6 +2,7 @@ require 'thread'
 require 'pathname'
 require 'dotenv'
 require 'lotus/utils/hash'
+require 'lotus/lotusrc'
 
 module Lotus
   # Define and expose information about the Lotus environment.
@@ -155,7 +156,8 @@ 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 = Utils::Hash.new(options).symbolize!.freeze
+      @options = Lotus::Lotusrc.new(root).read
+      @options.merge! Utils::Hash.new(options).symbolize!
       @mutex   = Mutex.new
       @mutex.synchronize { set_env_vars! }
     end

data/lib/lotus/generators/action/action.rb.tt

@@ -0,0 +1,8 @@
+module <%= config[:app] %>::Controllers::<%= config[:controller] %>
+  class <%= config[:action] %>
+    include <%= config[:app] %>::Action
+
+    def call(params)
+    end
+  end
+end

data/lib/lotus/generators/action/action_spec.minitest.tt

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require_relative '../../../../<%= config[:action_path] %>'
+
+describe <%= config[:app] %>::Controllers::<%= config[:controller] %>::<%= config[:action] %> do
+  let(:action) { <%= config[:app] %>::Controllers::<%= config[:controller] %>::<%= config[:action] %>.new }
+  let(:params) { Hash[] }
+
+  it "is successful" do
+    response = action.call(params)
+    response[0].must_equal 200
+  end
+end

data/lib/lotus/generators/action/action_spec.rspec.tt

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require_relative '../../../../<%= config[:action_path] %>'
+
+describe <%= config[:app] %>::Controllers::<%= config[:controller] %>::<%= config[:action] %> do
+  let(:action) { <%= config[:app] %>::Controllers::<%= config[:controller] %>::<%= config[:action] %>.new }
+  let(:params) { Hash[] }
+
+  it "is successful" do
+    response = action.call(params)
+    expect(response[0]).to eq 200
+  end
+end

data/lib/lotus/generators/action/view.rb.tt

@@ -0,0 +1,5 @@
+module <%= config[:app] %>::Views::<%= config[:controller] %>
+  class <%= config[:action] %>
+    include <%= config[:app] %>::View
+  end
+end

data/lib/lotus/generators/action/view_spec.minitest.tt

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require_relative '../../../../<%= config[:view_path] %>'
+
+describe <%= config[:app] %>::Views::<%= config[:controller] %>::<%= config[:action] %> do
+  let(:exposures) { Hash[foo: 'bar'] }
+  let(:template)  { Lotus::View::Template.new('<%= config[:template_path] %>') }
+  let(:view)      { <%= config[:app] %>::Views::<%= config[:controller] %>::<%= config[:action] %>.new(template, exposures) }
+
+  it "exposes #foo" do
+    view.foo.must_equal exposures.fetch(:foo)
+  end
+end

data/lib/lotus/generators/action/view_spec.rspec.tt

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require_relative '../../../../<%= config[:view_path] %>'
+
+describe <%= config[:app] %>::Views::<%= config[:controller] %>::<%= config[:action] %> do
+  let(:exposures) { Hash[foo: 'bar'] }
+  let(:template)  { Lotus::View::Template.new('<%= config[:template_path] %>') }
+  let(:view)      { <%= config[:app] %>::Views::<%= config[:controller] %>::<%= config[:action] %>.new(template, exposures) }
+
+  it "exposes #foo" do
+    expect(view.foo).to eq exposures.fetch(:foo)
+  end
+end

data/lib/lotus/generators/action.rb

@@ -0,0 +1,149 @@
+require 'lotus/generators/abstract'
+require 'lotus/utils/string'
+
+module Lotus
+  module Generators
+    # @since 0.3.0
+    # @api private
+    class Action < Abstract
+      # @since 0.3.0
+      # @api private
+      ACTION_SEPARATOR = /\/|\#/
+
+      # @since 0.3.0
+      # @api private
+      SUFFIX           = '.rb'.freeze
+
+      # @since 0.3.0
+      # @api private
+      TEMPLATE_SUFFIX  = '.html.'.freeze
+
+      # @since 0.3.0
+      # @api private
+      DEFAULT_TEMPLATE = 'erb'.freeze
+
+      # @since 0.3.0
+      # @api private
+      def initialize(command)
+        super
+
+        @controller, @action = name.split(ACTION_SEPARATOR)
+        @controller_name     = Utils::String.new(@controller).classify
+        @action_name         = Utils::String.new(@action).classify
+
+        cli.class.source_root(source)
+      end
+
+      # @since 0.3.0
+      # @api private
+      def start
+        assert_existing_app!
+
+        opts = {
+          app:           app,
+          controller:    @controller_name,
+          action:        @action_name,
+          action_path:   _action_path_without_suffix,
+          view_path:     _view_path_without_suffix,
+          template_path: _template_path,
+        }
+
+        templates = {
+          'action.rb.tt' => _action_path,
+          'view.rb.tt'   => _view_path,
+          'template.tt'  => _template_path
+        }
+
+        case options[:test]
+        when 'rspec'
+          templates.merge!({
+            'action_spec.rspec.tt' => _action_spec_path,
+            'view_spec.rspec.tt'   => _view_spec_path,
+          })
+        else
+          templates.merge!({
+            'action_spec.minitest.tt' => _action_spec_path,
+            'view_spec.minitest.tt'   => _view_spec_path,
+          })
+        end
+
+        generate_route
+
+        templates.each do |src, dst|
+          cli.template(source.join(src), target.join(dst), opts)
+        end
+      end
+
+      private
+      # @since 0.3.0
+      # @api private
+      def assert_existing_app!
+        unless target.join(app_root).exist?
+          raise Lotus::Commands::Generate::Error.new("Unknown app: `#{ app_name }'")
+        end
+      end
+
+      # @since 0.3.0
+      # @api private
+      def generate_route
+        path = target.join(_routes_path)
+        path.dirname.mkpath
+
+        FileUtils.touch(path)
+
+        # Insert at the top of the file
+        cli.insert_into_file _routes_path, before: /\A(.*)/ do
+          "get '/#{ @controller }', to: '#{ name }'\n"
+        end
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _routes_path
+        app_root.join("config", "routes#{ SUFFIX }")
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _action_path
+        _action_path_without_suffix.to_s + SUFFIX
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _view_path
+        _view_path_without_suffix.to_s + SUFFIX
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _action_path_without_suffix
+        app_root.join("controllers", @controller, "#{ @action }")
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _view_path_without_suffix
+        app_root.join("views", @controller, "#{ @action }")
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _template_path
+        app_root.join("templates", @controller, "#{ @action }#{ TEMPLATE_SUFFIX }#{ options.fetch(:template) { DEFAULT_TEMPLATE } }")
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _action_spec_path
+        spec_root.join(app_name, 'controllers', @controller, "#{ @action }_spec#{ SUFFIX }")
+      end
+
+      # @since 0.3.0
+      # @api private
+      def _view_spec_path
+        spec_root.join(app_name, 'views', @controller, "#{ @action }_spec#{ SUFFIX }")
+      end
+    end
+  end
+end

data/lib/lotus/generators/application/container/Gemfile.tt

@@ -7,13 +7,18 @@ gem 'rake'
 gem 'lotus-utils',       require: false, github: 'lotus/utils'
 gem 'lotus-router',      require: false, github: 'lotus/router'
 gem 'lotus-validations', require: false, github: 'lotus/validations'
+gem 'lotus-helpers',     require: false, github: 'lotus/helpers'
 gem 'lotus-controller',  require: false, github: 'lotus/controller'
 gem 'lotus-view',        require: false, github: 'lotus/view'
 gem 'lotus-model',       require: false, github: 'lotus/model'
 gem 'lotusrb',                           github: 'lotus/lotus'
 <%- else -%>
-gem 'lotusrb',      '<%= Lotus::VERSION %>'
-gem 'lotus-model', '<%= config[:lotus_model_version] %>'
+gem 'lotusrb',       '<%= Lotus::VERSION %>'
+gem 'lotus-model',   '<%= config[:lotus_model_version] %>'
+<%- end -%>
+
+<%- if config[:database_config][:gem] %>
+gem '<%= config[:database_config][:gem] %>'
 <%- end -%>
 
 group :test do

data/lib/lotus/generators/application/container/config/.env.development.tt

@@ -1,2 +1,2 @@
 # Define ENV variables for development environment
-<%= config[:app_name].to_env_s %>_DATABASE_URL="file:///db/<%= config[:app_name] %>_development"
+<%= config[:app_name].to_env_s %>_DATABASE_URL="<%= config[:database_config][:uri][:development] %>"

data/lib/lotus/generators/application/container/config/.env.test.tt

@@ -1,2 +1,2 @@
 # Define ENV variables for test environment
-<%= config[:app_name].to_env_s %>_DATABASE_URL="file:///db/<%= config[:app_name] %>_test"
+<%= config[:app_name].to_env_s %>_DATABASE_URL="<%= config[:database_config][:uri][:test] %>"

data/lib/lotus/generators/application/container/gitignore.tt

@@ -0,0 +1,2 @@
+/db/<%= config[:app_name] %>_development
+/db/<%= config[:app_name] %>_test

data/lib/lotus/generators/application/container/lib/app_name.rb.tt

@@ -10,15 +10,17 @@ Lotus::Model.configure do
   #    adapter type: :memory, uri: 'memory://localhost/<%= config[:app_name] %>_development'
   #
   #  * SQL adapter
-  #    adapter type: :sql, uri: 'sqlite://db/<%= config[:app_name] %>_development.db'
+  #    adapter type: :sql, uri: 'sqlite://db/<%= config[:app_name] %>_development.sqlite3'
   #    adapter type: :sql, uri: 'postgres://localhost/<%= config[:app_name] %>_development'
   #    adapter type: :sql, uri: 'mysql://localhost/<%= config[:app_name] %>_development'
   #
-  adapter type: :file_system, uri: ENV['<%= config[:app_name].to_env_s %>_DATABASE_URL']
+  adapter type: :<%= config[:database_config][:type] %>, uri: ENV['<%= config[:app_name].to_env_s %>_DATABASE_URL']
 
   ##
   # Database mapping
   #
+  # Intended for specifying application wide mappings.
+  #
   # You can specify mapping file to load with:
   #
   # mapping "#{__dir__}/config/mapping"

data/lib/lotus/generators/application/container/lotusrc.tt

@@ -0,0 +1,3 @@
+architecture=container
+test=<%= config[:test] %>
+template=erb

data/lib/lotus/generators/application/container.rb

@@ -1,3 +1,4 @@
+require 'shellwords'
 require 'lotus/generators/abstract'
 require 'lotus/generators/slice'
 
@@ -8,10 +9,11 @@ module Lotus
         def initialize(command)
           super
 
-          @slice_generator     = Slice.new(command)
-          @lotus_head          = options.fetch(:lotus_head)
-          @test                = options[:test]
-          @lotus_model_version = '~> 0.2'
+          @slice_generator       = Slice.new(command)
+          @lotus_head            = options.fetch(:lotus_head)
+          @test                  = options[:test]
+          @database              = options[:database]
+          @lotus_model_version   = '~> 0.3'
 
           cli.class.source_root(source)
         end
@@ -19,13 +21,16 @@ module Lotus
         def start
 
           opts      = {
-            app_name:            app_name,
-            lotus_head:          @lotus_head,
-            test:                @test,
-            lotus_model_version: @lotus_model_version
+            app_name:              app_name,
+            lotus_head:            @lotus_head,
+            test:                  @test,
+            database:              @database,
+            database_config:       database_config,
+            lotus_model_version:   @lotus_model_version,
           }
 
           templates = {
+            'lotusrc.tt'                 => '.lotusrc',
             'Gemfile.tt'                 => 'Gemfile',
             'config.ru.tt'               => 'config.ru',
             'config/environment.rb.tt'   => 'config/environment.rb',
@@ -74,8 +79,73 @@ module Lotus
             cli.template(source.join(gitkeep), target.join(dir, gitkeep), opts)
           end
 
+          unless git_dir_present?
+            cli.template(source.join('gitignore.tt'), target.join('.gitignore'), opts)
+            cli.run("git init #{Shellwords.escape(target)}", capture: true)
+          end
+
           @slice_generator.start
         end
+
+        private
+
+        def git_dir_present?
+          File.directory?(source.join('.git'))
+        end
+
+        def database_config
+          {
+            gem: database_gem,
+            uri: database_uri,
+            type: database_type
+          }
+        end
+
+        def database_gem
+          {
+            'mysql'      => 'mysql',
+            'mysql2'     => 'mysql2',
+            'postgresql' => 'pg',
+            'postgres'   => 'pg',
+            'sqlite'     => 'sqlite3',
+            'sqlite3'    => 'sqlite3'
+          }[@database]
+        end
+
+        def database_type
+          case @database
+          when 'mysql', 'mysql2', 'postgresql', 'postgres', 'sqlite', 'sqlite3'
+            :sql
+          when 'filesystem'
+            :file_system
+          when 'memory'
+            :memory
+          end
+        end
+
+        def database_uri
+          {
+            development: "#{database_base_uri}_development",
+            test: "#{database_base_uri}_test"
+          }
+        end
+
+        def database_base_uri
+          case @database
+          when 'mysql'
+            "mysql://localhost/#{app_name}"
+          when 'mysql2'
+            "mysql2://localhost/#{app_name}"
+          when 'postgresql', 'postgres'
+            "postgres://localhost/#{app_name}"
+          when 'sqlite', 'sqlite3'
+            "sqlite://db/#{Shellwords.escape(app_name)}"
+          when 'memory'
+            "memory://localhost/#{app_name}"
+          else
+            "file:///db/#{app_name}"
+          end
+        end
       end
     end
   end