lotusrb 0.5.0 → 0.6.0

data/lib/lotus/commands/db/abstract.rb

@@ -2,8 +2,12 @@ module Lotus
   module Commands
     class DB
       class Abstract
-        def initialize(environment)
-          environment.require_application_environment
+        attr_reader :environment
+
+        def initialize(options)
+          @options = options
+          @environment = Lotus::Environment.new(options)
+          @environment.require_application_environment
         end
 
         def start

data/lib/lotus/commands/db/console.rb

@@ -1,16 +1,16 @@
 require 'lotus/utils/class'
+require 'lotus/commands/db/abstract'
 
 module Lotus
   module Commands
     class DB
-      class Console
-        attr_reader :name, :env_options, :environment
+      class Console < Abstract
+        attr_reader :name, :env_options
 
-        def initialize(name, environment)
+        def initialize(options, name)
+          super(options)
           @name        = name
-          @environment = environment
           @env_options = environment.to_options
-          @environment.require_application_environment
         end
 
         def start

data/lib/lotus/commands/generate/abstract.rb

@@ -0,0 +1,63 @@
+require 'lotus/environment'
+require 'lotus/generators/generatable'
+require 'lotus/generators/test_framework'
+require 'lotus/version'
+require 'lotus/utils/string'
+
+module Lotus
+  module Commands
+    class Generate
+      class Abstract
+
+        include Lotus::Generators::Generatable
+
+        attr_reader :options, :target_path
+
+        def initialize(options)
+          @options = Lotus::Utils::Hash.new(options).symbolize!
+          assert_options!
+
+          @target_path = Pathname.pwd
+        end
+
+        def template_source_path
+          generator = self.class.name.split('::').last.downcase
+          Pathname.new(::File.dirname(__FILE__) + "/../../generators/#{generator}/").realpath
+        end
+
+        private
+
+        def test_framework
+          @test_framework ||= Lotus::Generators::TestFramework.new(lotusrc, options[:test])
+        end
+
+        def lotusrc_options
+          lotusrc.options
+        end
+
+        def lotusrc
+          @lotusrc ||= Lotusrc.new(target_path)
+        end
+
+        def environment
+          @environment ||= Lotus::Environment.new(options)
+        end
+
+        def template_engine
+          options.fetch(:template, default_template_engine)
+        end
+
+        def default_template_engine
+          lotusrc_options.fetch(:template)
+        end
+
+        def assert_options!
+          if options.nil?
+            raise ArgumentError.new('options must not be nil')
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/lotus/commands/generate/action.rb

@@ -0,0 +1,262 @@
+require 'lotus/commands/generate/abstract'
+require 'lotus/routing/route'
+
+module Lotus
+  module Commands
+    class Generate
+      class Action < Abstract
+
+        # @since 0.5.0
+        # @api private
+        ACTION_SEPARATOR = /[\/,#]/
+
+        # @since 0.5.0
+        # @api private
+        ROUTE_ENDPOINT_SEPARATOR = '#'.freeze
+
+        # @since 0.5.0
+        # @api private
+        QUOTED_NAME = /(\"|\'|\\)/
+
+        # Default HTTP method used when generating an action.
+        #
+        # @since 0.5.0
+        # @api private
+        DEFAULT_HTTP_METHOD = 'GET'.freeze
+
+        # HTTP methods used when generating resourceful actions.
+        #
+        # @since 0.6.0
+        # @api private
+        RESOURCEFUL_HTTP_METHODS = {
+          'Create'  => 'POST',
+          'Update'  => 'PATCH',
+          'Destroy' => 'DELETE'
+        }.freeze
+
+        # For resourceful actions, what to add to the end of the base URL
+        #
+        # @since 0.6.0
+        # @api private
+        RESOURCEFUL_ROUTE_URL_SUFFIXES = {
+          'Show'    => '/:id',
+          'Update'  => '/:id',
+          'Destroy' => '/:id',
+          'New'     => '/new',
+          'Edit'    => '/:id/edit',
+        }.freeze
+
+        def initialize(options, application_name, controller_and_action_name)
+          super(options)
+          if !environment.container?
+            application_name = File.basename(Dir.pwd)
+          end
+
+          controller_and_action_name = Utils::String.new(controller_and_action_name).underscore.gsub(QUOTED_NAME, '')
+
+          *controller_name, action_name = controller_and_action_name.split(ACTION_SEPARATOR)
+
+          @application_name = Utils::String.new(application_name).classify
+          @controller_name = Utils::String.new(controller_name.join("/")).classify
+          @action_name = Utils::String.new(action_name).classify
+          @controller_pathname = Utils::String.new(@controller_name).underscore
+
+          assert_application_name!
+          assert_controller_name!
+          assert_action_name!
+          assert_http_method!
+        end
+
+        def map_templates
+          add_mapping("action_spec.#{test_framework.framework}.tt", action_spec_path)
+
+          if skip_view?
+            add_mapping('action_without_view.rb.tt', action_path)
+          else
+            add_mapping('action.rb.tt', action_path)
+            add_mapping('view.rb.tt', view_path)
+            add_mapping('template.tt', template_path)
+            add_mapping("view_spec.#{test_framework.framework}.tt", view_spec_path)
+          end
+        end
+
+        def post_process_templates
+          generate_route
+        end
+
+        # @since 0.5.0
+        # @api private
+        def template_options
+          {
+            app:                  @application_name,
+            controller:           @controller_name,
+            action:               @action_name,
+            relative_action_path: relative_action_path,
+            relative_view_path:   relative_view_path,
+            template_path:        template_path,
+          }
+        end
+
+        private
+
+        # @since 0.5.0
+        # @api private
+        def generate_route
+          routes_path.dirname.mkpath
+          FileUtils.touch(routes_path)
+
+          generator.prepend_to_file(routes_path, "#{ http_method } '#{ route_url }', to: '#{ route_endpoint }'\n")
+        end
+
+        def skip_view?
+          options.fetch(:skip_view, false)
+        end
+
+        # @since 0.5.0
+        # @api private
+        def http_method
+          options.fetch(:method, resourceful_http_method).downcase
+        end
+
+        # @since 0.6.0
+        # @api private
+        def resourceful_http_method
+          RESOURCEFUL_HTTP_METHODS.fetch(@action_name, DEFAULT_HTTP_METHOD)
+        end
+
+        # @since 0.5.0
+        # @api private
+        def route_url
+          options.fetch(:url, "/#{ @controller_pathname }#{ resourceful_route_url_suffix }")
+        end
+
+        # @since 0.6.0
+        # @api private
+        def resourceful_route_url_suffix
+          RESOURCEFUL_ROUTE_URL_SUFFIXES.fetch(@action_name, "")
+        end
+
+        # @since 0.5.0
+        # @api private
+        def route_endpoint
+          "#{ @controller_pathname }#{ ROUTE_ENDPOINT_SEPARATOR }#{ @action_name }".downcase
+        end
+
+        # @since 0.5.0
+        # @api private
+        def known_application_names
+          Dir.glob(applications_path.join('/*')).map do |name|
+            File.basename(name)
+          end
+        end
+
+        # @since 0.5.0
+        # @api private
+        def assert_controller_name!
+          if @controller_name.nil? || @controller_name.empty?
+            raise ArgumentError.new("Unknown controller, please add controllers name with this syntax controller_name#action_name")
+          end
+        end
+
+        # @since 0.5.0
+        # @api private
+        def assert_action_name!
+          if @action_name.nil? || @action_name.strip == ''
+            raise ArgumentError.new("Unknown action, please add actions name with this syntax controller_name#action_name")
+          end
+        end
+
+        # @since 0.5.0
+        # @api private
+        def assert_application_name!
+          return if !environment.container?
+          if @application_name.nil? || @application_name.strip == '' || !application_path.exist?
+            existing_apps = known_application_names.join('/')
+            raise ArgumentError.new("Unknown app: `#{ @application_name.downcase }'. Please specify one of (#{ existing_apps }) as application name")
+          end
+        end
+
+        # @since 0.5.0
+        # @api private
+        def assert_http_method!
+          if !Lotus::Routing::Route::VALID_HTTP_VERBS.include?(http_method.upcase)
+            existing_http_methods = Lotus::Routing::Route::VALID_HTTP_VERBS
+            raise ArgumentError.new("Unknown HTTP method '#{http_method}', please use one of #{ existing_http_methods.join('/') }.")
+          end
+        end
+
+        def routes_path
+          if environment.container?
+            application_path.join('config', 'routes.rb')
+          else
+            application_path.join('..', 'config', 'routes.rb')
+          end
+        end
+
+        # The directory of the application
+        # ./app for 'app' architecture
+        # ./apps/APPLICATION_NAME for 'container'
+        def application_path
+          if environment.container?
+            applications_path.join(application_name_as_snake_case)
+          else
+            Pathname.new('app')
+          end
+        end
+
+        # The parent dir of the application directory.
+        def applications_path
+          Pathname.new('apps')
+        end
+
+        def view_path
+          application_path.join('views', @controller_pathname, "#{@action_name.downcase}.rb")
+        end
+
+        def view_spec_path
+          spec_root.join('views', @controller_pathname, "#{@action_name.downcase}_spec.rb")
+        end
+
+        def template_path
+          application_path.join('templates', @controller_pathname, "#{@action_name.downcase}.html.#{template_engine}")
+        end
+
+        def action_path
+          application_path.join('controllers', @controller_pathname, "#{@action_name.downcase}.rb")
+        end
+
+        def action_spec_path
+          spec_root.join('controllers', @controller_pathname, "#{ @action_name.downcase}_spec.rb")
+        end
+
+        def spec_root
+          Pathname.new('spec').join(app_base_dir)
+        end
+
+        def relative_action_path
+          path = Pathname.new('.').join('..', '..', '..')
+          path = path.join('..') if environment.container?
+          path.join(application_path, 'controllers', @controller_pathname, @action_name.downcase)
+        end
+
+        def relative_view_path
+          path = Pathname.new('.').join('..', '..', '..')
+          path = path.join('..') if environment.container?
+          path.join(application_path, 'views', @controller_pathname, @action_name.downcase)
+        end
+
+        def app_base_dir
+          if environment.container?
+            application_name_as_snake_case
+          else
+            ''
+          end
+        end
+
+        def application_name_as_snake_case
+          @application_name.gsub(/(.)([A-Z])/,'\1_\2').downcase
+        end
+      end
+    end
+  end
+end

data/lib/lotus/commands/generate/app.rb

@@ -0,0 +1,116 @@
+require 'lotus/commands/generate/abstract'
+require 'lotus/application_name'
+require 'securerandom'
+
+module Lotus
+  module Commands
+    class Generate
+      class App < Abstract
+
+        attr_reader :base_path
+
+        def initialize(options, application_name)
+          super(options)
+
+          assert_application_name!(application_name)
+          assert_architecture!
+
+          @application_name = ApplicationName.new(application_name)
+          @base_path = Pathname.pwd
+        end
+
+        def map_templates
+          add_mapping('application.rb.tt', 'application.rb')
+          add_mapping('config/routes.rb.tt', 'config/routes.rb')
+          add_mapping('views/application_layout.rb.tt', 'views/application_layout.rb')
+          add_mapping('templates/application.html.erb.tt', 'templates/application.html.erb')
+          add_mapping('favicon.ico', 'assets/favicon.ico')
+
+          add_mapping('.gitkeep', 'controllers/.gitkeep')
+          add_mapping('.gitkeep', 'assets/images/.gitkeep')
+          add_mapping('.gitkeep', 'assets/javascripts/.gitkeep')
+          add_mapping('.gitkeep', 'assets/stylesheets/.gitkeep')
+          add_mapping('.gitkeep', "../../spec/#{ app_name }/features/.gitkeep")
+          add_mapping('.gitkeep', "../../spec/#{ app_name }/controllers/.gitkeep")
+          add_mapping('.gitkeep', "../../spec/#{ app_name }/views/.gitkeep")
+        end
+
+        def template_options
+          {
+            app_name:            app_name,
+            upcase_app_name:     upcase_app_name,
+            classified_app_name: classified_app_name,
+            app_base_url:        application_base_url,
+            app_base_path:       application_base_path,
+          }
+        end
+
+        def post_process_templates
+          add_require_app
+          add_mount_app
+          add_web_session_secret
+        end
+
+        private
+
+        def application_base_url
+          options.fetch(:application_base_url, "/#{app_name}")
+        end
+
+        def add_require_app
+          # Add "require_relative '../apps/web/application'"
+          generator.inject_into_file base_path.join('config/environment.rb'), after: /require_relative '\.\.\/lib\/(.*)'/ do
+            "\nrequire_relative '../apps/#{ app_name }/application'"
+          end
+        end
+
+        def add_mount_app
+          generator.inject_into_file base_path.join('config/environment.rb'), after: /Lotus::Container.configure do/ do |match|
+            "\n  mount #{ classified_app_name }::Application, at: '#{ application_base_url }'"
+          end
+        end
+
+        def add_web_session_secret
+          ['development', 'test'].each do |environment|
+            # Add WEB_SESSIONS_SECRET="abc123" (random hex)
+            generator.append_to_file base_path.join(".env.#{ environment }") do
+              %(#{ upcase_app_name }_SESSIONS_SECRET="#{ SecureRandom.hex(32) }"\n)
+            end
+          end
+        end
+
+        def target_path
+          base_path.join(application_base_path)
+        end
+
+        def app_name
+          @application_name.to_s
+        end
+
+        def upcase_app_name
+          @application_name.to_env_s
+        end
+
+        def application_base_path
+          ["apps", @application_name].join(::File::SEPARATOR)
+        end
+
+        def classified_app_name
+          Utils::String.new(app_name).classify
+        end
+
+        def assert_application_name!(value)
+          if value.nil? || value.strip.empty?
+            raise ArgumentError.new('Application name is nil or empty')
+          end
+        end
+
+        def assert_architecture!
+          if !environment.container?
+            raise ArgumentError.new('App generator is only available for container architecture.')
+          end
+        end
+      end
+    end
+  end
+end