lotusrb 0.3.2 → 0.4.0

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

@@ -1,10 +1,11 @@
 require 'spec_helper'
-require_relative '../../../../<%= config[:view_path] %>'
+require_relative '<%= config[:relative_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) }
+  let(:rendered)  { view.render }
 
   it "exposes #foo" do
     view.foo.must_equal exposures.fetch(:foo)

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

@@ -1,10 +1,11 @@
 require 'spec_helper'
-require_relative '../../../../<%= config[:view_path] %>'
+require_relative '<%= config[:relative_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) }
+  let(:rendered)  { view.render }
 
   it "exposes #foo" do
     expect(view.foo).to eq exposures.fetch(:foo)

data/lib/lotus/generators/app.rb

@@ -0,0 +1,39 @@
+require 'shellwords'
+require 'lotus/generators/abstract'
+require 'lotus/generators/slice'
+
+module Lotus
+  module Generators
+    class App < Abstract
+      def initialize(command)
+        super
+
+        options.merge!(app_name_options)
+        @slice_generator = Slice.new(command)
+
+        cli.class.source_root(source)
+      end
+
+      def start
+        @slice_generator.start
+      end
+
+      private
+
+      # @since 0.4.0
+      # @api private
+      def app_name_options
+        {
+          application: app_name,
+          application_base_url: application_base_url
+        }
+      end
+
+      # @since 0.4.0
+      # @api private
+      def application_base_url
+        options[:application_base_url] || "/#{app_name}"
+      end
+    end
+  end
+end

data/lib/lotus/generators/app/.gitkeep

@@ -0,0 +1 @@
+#

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

@@ -0,0 +1,184 @@
+require 'shellwords'
+require 'lotus/generators/abstract'
+
+module Lotus
+  module Generators
+    module Application
+      class App < Abstract
+        def initialize(command)
+          super
+
+          @upcase_app_name       = app_name.to_env_s
+          @classified_app_name   = Utils::String.new(app_name).classify
+          @lotus_head            = options.fetch(:lotus_head)
+          @test                  = options[:test]
+          @database              = options[:database]
+          @application_base_url  = options[:application_base_url]
+          @lotus_model_version   = '~> 0.4'
+
+          cli.class.source_root(source)
+        end
+
+        def start
+
+          opts      = {
+            app_name:              app_name,
+            upcase_app_name:       @upcase_app_name,
+            classified_app_name:   @classified_app_name,
+            application_base_url:  @application_base_url,
+            lotus_head:            @lotus_head,
+            test:                  @test,
+            database:              @database,
+            database_config:       database_config,
+            lotus_model_version:   @lotus_model_version,
+          }
+
+          templates = {
+            'lotusrc.tt'                        => '.lotusrc',
+            '.env.tt'                           => '.env',
+            '.env.development.tt'               => '.env.development',
+            '.env.test.tt'                      => '.env.test',
+            'Gemfile.tt'                        => 'Gemfile',
+            'config.ru.tt'                      => 'config.ru',
+            'config/environment.rb.tt'          => 'config/environment.rb',
+            'lib/app_name.rb.tt'                => "lib/#{ app_name }.rb",
+            'lib/config/mapping.rb.tt'          => 'lib/config/mapping.rb',
+            'config/application.rb.tt'          => 'config/application.rb',
+            'config/routes.rb.tt'               => 'config/routes.rb',
+            'views/application_layout.rb.tt'    => 'app/views/application_layout.rb',
+            'templates/application.html.erb.tt' => 'app/templates/application.html.erb',
+          }
+
+          empty_directories = [
+            "app/controllers",
+            "app/views",
+            "lib/#{ app_name }/entities",
+            "lib/#{ app_name }/repositories",
+            "public/javascripts",
+            "public/stylesheets"
+          ]
+
+          empty_directories << if sql_database?
+            "db/migrations"
+          else
+            "db"
+          end
+
+          # Add testing directories (spec/ is the default for both MiniTest and RSpec)
+          empty_directories << [
+            "spec/features",
+            "spec/controllers",
+            "spec/views"
+          ]
+
+          case options[:test]
+          when 'rspec'
+            templates.merge!(
+              'Rakefile.rspec.tt'           => 'Rakefile',
+              'rspec.rspec.tt'              => '.rspec',
+              'spec_helper.rb.rspec.tt'     => 'spec/spec_helper.rb',
+              'features_helper.rb.rspec.tt' => 'spec/features_helper.rb',
+              'capybara.rb.rspec.tt'        => 'spec/support/capybara.rb'
+            )
+          else # minitest (default)
+            templates.merge!(
+              'Rakefile.minitest.tt'           => 'Rakefile',
+              'spec_helper.rb.minitest.tt'     => 'spec/spec_helper.rb',
+              'features_helper.rb.minitest.tt' => 'spec/features_helper.rb'
+            )
+          end
+
+          empty_directories << [
+            "spec/#{ app_name }/entities",
+            "spec/#{ app_name }/repositories",
+            "spec/support"
+          ]
+
+          if sql_database?
+            templates.merge!(
+              'schema.sql.tt' => 'db/schema.sql'
+            )
+          end
+
+          templates.each do |src, dst|
+            cli.template(source.join(src), target.join(dst), opts)
+          end
+
+          empty_directories.flatten.each do |dir|
+            gitkeep = '.gitkeep'
+            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
+        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 sql_database?
+          database_type == :sql
+        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
+end

data/lib/lotus/generators/application/app/.env.development.tt

@@ -0,0 +1,3 @@
+# Define ENV variables for development environment
+<%= config[:upcase_app_name] %>_DATABASE_URL="<%= config[:database_config][:uri][:development] %>"
+<%= config[:upcase_app_name] %>_SESSIONS_SECRET="<% SecureRandom.hex(32) %>"

data/lib/lotus/generators/application/app/.env.test.tt

@@ -0,0 +1,3 @@
+# Define ENV variables for test environment
+<%= config[:app_name].to_env_s %>_DATABASE_URL="<%= config[:database_config][:uri][:test] %>"
+<%= config[:upcase_app_name] %>_SESSIONS_SECRET="<% SecureRandom.hex(32) %>"

data/lib/lotus/generators/application/app/.gitkeep

@@ -0,0 +1 @@
+#

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

@@ -0,0 +1,35 @@
+source 'https://rubygems.org'
+
+gem 'bundler'
+gem 'rake'
+
+<%- if config[:lotus_head] -%>
+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] %>'
+<%- end -%>
+
+<%- if config[:database_config][:gem] %>
+gem '<%= config[:database_config][:gem] %>'
+<%- end -%>
+
+group :test do
+<%- if config[:test] == 'rspec' -%>
+  gem 'rspec'
+<%- else -%>
+  gem 'minitest'
+<%- end -%>
+  gem 'capybara'
+end
+
+group :production do
+  # gem 'puma'
+end

data/lib/lotus/generators/application/app/Rakefile.minitest.tt

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs    << 'spec'
+end
+
+task default: :test
+task spec: :test

data/lib/lotus/generators/application/app/Rakefile.rspec.tt

@@ -0,0 +1,5 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/lotus/generators/application/app/apps/.gitkeep.tt

@@ -0,0 +1 @@
+#

data/lib/lotus/generators/application/app/capybara.rb.rspec.tt

@@ -0,0 +1,8 @@
+module RSpec
+  module FeatureExampleGroup
+    def self.included(group)
+      group.metadata[:type] = :feature
+      Capybara.app = <%= config[:classified_app_name] %>::Application.new
+    end
+  end
+end

data/lib/lotus/generators/application/app/config.ru.tt

@@ -0,0 +1,3 @@
+require './config/environment'
+
+run <%= config[:classified_app_name] %>::Application.new

data/lib/lotus/generators/application/app/config/application.rb.tt

@@ -0,0 +1,227 @@
+require 'lotus/helpers'
+
+module <%= config[:classified_app_name] %>
+  class Application < Lotus::Application
+    configure do
+      ##
+      # BASIC
+      #
+
+      # Define the root path of this application.
+      # All paths specified in this configuration are relative to path below.
+      #
+      root "#{ __dir__ }/.."
+
+      # Relative load paths where this application will recursively load the code.
+      # When you add new directories, remember to add them here.
+      #
+      load_paths << [
+        'app/controllers',
+        'app/views'
+      ]
+
+      # Handle exceptions with HTTP statuses (true) or don't catch them (false).
+      # Defaults to true.
+      # See: http://www.rubydoc.info/gems/lotus-controller/
+
+      # Exceptions_management
+      #
+      # handle_exceptions true
+
+      ##
+      # HTTP
+      #
+
+      # Routes definitions for this application
+      # See: http://www.rubydoc.info/gems/lotus-router#Usage
+      #
+      routes 'config/routes'
+
+      # URI scheme used by the routing system to generate absolute URLs
+      # Defaults to "http"
+      #
+      # scheme 'https'
+
+      # URI host used by the routing system to generate absolute URLs
+      # Defaults to "localhost"
+      #
+      # host 'example.org'
+
+      # URI port used by the routing system to generate absolute URLs
+      # Argument: An object coercible to integer, default to 80 if the scheme is http and 443 if it's https
+      # This SHOULD be configured only in case the application listens to that non standard ports
+      #
+      # port 443
+
+      # Enable cookies
+      # Argument: boolean to toggle the feature
+      #           A Hash with options
+      #
+      # Options: :domain   - The domain (String - nil by default, not required)
+      #          :path     - Restrict cookies to a relative URI (String - nil by default)
+      #          :max_age  - Cookies expiration expressed in seconds (Integer - nil by default)
+      #          :secure   - Restrict cookies to secure connections
+      #                      (Boolean - Automatically set on true if currenlty using a secure connection)
+      #                      See #scheme and #ssl?
+      #          :httponly - Prevent JavaScript access (Boolean - true by default)
+      #
+      # cookies true
+      # or
+      # cookies max_age: 300
+
+      # Enable sessions
+      # Argument: Symbol the Rack session adapter
+      #           A Hash with options
+      #
+      # See: http://www.rubydoc.info/gems/rack/Rack/Session/Cookie
+      #
+      # sessions :cookie, secret: ENV['<%= config[:upcase_app_name] %>_SESSIONS_SECRET']
+
+      # Configure Rack middleware for this application
+      #
+      # middleware.use Rack::Protection
+
+      # Default format for the requests that don't specify an HTTP_ACCEPT header
+      # Argument: A symbol representation of a mime type, default to :html
+      #
+      # default_format :html
+
+      # HTTP Body parsers
+      # Parse non GET responses body for a specific mime type
+      # Argument: Symbol, which represent the format of the mime type (only `:json` is supported)
+      #           Object, the parser
+      #
+      # body_parsers :json
+
+      ##
+      # TEMPLATES
+      #
+
+      # The layout to be used by all views
+      #
+      layout :application # It will load <%= config[:classified_app_name] %>::Views::ApplicationLayout
+
+      # The relative path to templates
+      #
+      templates 'app/templates'
+
+      ##
+      # ASSETS
+      #
+
+      # Specify sources for assets
+      # The directory `public/` is added by default
+      #
+      # assets << [
+      #   'vendor/javascripts'
+      # ]
+
+      # Enabling serving assets
+      # Defaults to false
+      #
+      # serve_assets false
+
+      ##
+      # SECURITY
+      #
+
+      # X-Frame-Options is a HTTP header supported by modern browsers.
+      # It determines if a web page can or cannot be included via <frame> and
+      # <iframe> tags by untrusted domains.
+      #
+      # Web applications can send this header to prevent Clickjacking attacks.
+      #
+      # Read more at:
+      #
+      #   * https://developer.mozilla.org/en-US/docs/Web/HTTP/X-Frame-Options
+      #   * https://www.owasp.org/index.php/Clickjacking
+      #
+      security.x_frame_options "DENY"
+
+      # Content-Security-Policy (CSP) is a HTTP header supported by modern browsers.
+      # It determines trusted sources of execution for dynamic contents
+      # (JavaScript) or other web related assets: stylesheets, images, fonts,
+      # plugins, etc.
+      #
+      # Web applications can send this header to mitigate Cross Site Scripting
+      # (XSS) attacks.
+      #
+      # The default value allows images, scripts, AJAX, and CSS from the same
+      # origin, and does not allow any other resources to load (eg object,
+      # frame, media, etc).
+      #
+      # Inline JavaScript is NOT allowed. To enable it, please use:
+      # "script-src 'unsafe-inline'".
+      #
+      # Content Security Policy introduction:
+      #
+      #  * http://www.html5rocks.com/en/tutorials/security/content-security-policy/
+      #  * https://www.owasp.org/index.php/Content_Security_Policy
+      #  * https://www.owasp.org/index.php/Cross-site_Scripting_%28XSS%29
+      #
+      # Inline and eval JavaScript risks:
+      #
+      #   * http://www.html5rocks.com/en/tutorials/security/content-security-policy/#inline-code-considered-harmful
+      #   * http://www.html5rocks.com/en/tutorials/security/content-security-policy/#eval-too
+      #
+      # Content Security Policy usage:
+      #
+      #  * http://content-security-policy.com/
+      #  * https://developer.mozilla.org/en-US/docs/Web/Security/CSP/Using_Content_Security_Policy
+      #
+      security.content_security_policy "default-src 'none'; script-src 'self'; connect-src 'self'; img-src 'self'; style-src 'self';"
+
+      ##
+      # FRAMEWORKS
+      #
+
+      # Configure the code that will yield each time <%= config[:classified_app_name] %>::Action is included
+      # This is useful for sharing common functionality
+      #
+      # See: http://www.rubydoc.info/gems/lotus-controller#Configuration
+      controller.prepare do
+        # include MyAuthentication # included in all the actions
+        # before :authenticate!    # run an authentication before callback
+      end
+
+      # Configure the code that will yield each time <%= config[:classified_app_name] %>::View is included
+      # This is useful for sharing common functionality
+      #
+      # See: http://www.rubydoc.info/gems/lotus-view#Configuration
+      view.prepare do
+        include Lotus::Helpers
+      end
+    end
+
+    ##
+    # DEVELOPMENT
+    #
+    configure :development do
+      # Don't handle exceptions, render the stack trace
+      handle_exceptions false
+
+      # Serve static assets during development
+      serve_assets      true
+    end
+
+    ##
+    # TEST
+    #
+    configure :test do
+      # Don't handle exceptions, render the stack trace
+      handle_exceptions false
+
+      # Serve static assets during development
+      serve_assets      true
+    end
+
+    ##
+    # PRODUCTION
+    #
+    configure :production do
+      # scheme 'https'
+      # host   'example.org'
+      # port   443
+    end
+  end
+end