lotusrb 0.5.0 → 0.6.0

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

@@ -0,0 +1,118 @@
+require "lotus/commands/generate/abstract"
+
+module Lotus
+  module Commands
+    class Generate
+      # @since 0.5.0
+      # @api private
+      class Mailer < Abstract
+
+        attr_reader :name, :name_underscored, :from, :to, :subject
+
+        # @since 0.5.0
+        # @api private
+        TXT_FORMAT  = ".txt".freeze
+
+        # @since 0.5.0
+        # @api private
+        HTML_FORMAT  = ".html".freeze
+
+        # @since 0.5.0
+        # @api private
+        DEFAULT_ENGINE = "erb".freeze
+
+        # @since 0.5.0
+        # @api private
+        DEFAULT_FROM = "'<from>'".freeze
+
+        # @since 0.5.0
+        # @api private
+        DEFAULT_TO = "'<to>'".freeze
+
+        # @since 0.5.0
+        # @api private
+        DEFAULT_SUBJECT = "'Hello'".freeze
+
+        # @since 0.5.0
+        # @api private
+        def initialize(options, name)
+          super(options)
+
+          @name_underscored = Utils::String.new(name).underscore
+          @name             = Utils::String.new(name_underscored).classify
+          @from             = options[:from] || DEFAULT_FROM
+          @to               = options[:to] || DEFAULT_TO
+          @subject          = options[:subject] || DEFAULT_SUBJECT
+
+          assert_name!
+        end
+
+        # @since 0.x.x
+        # @api private
+        def map_templates
+          add_mapping("mailer_spec.rb.tt", mailer_spec_path)
+          add_mapping("mailer.rb.tt", mailer_path)
+          add_mapping("template.txt.tt", txt_template_path)
+          add_mapping("template.html.tt", html_template_path)
+        end
+
+        def template_options
+          {
+            mailer:  name,
+            from:    from,
+            to:      to,
+            subject: subject,
+          }
+        end
+
+        private
+
+        # @since 0.5.0
+        # @api private
+        def assert_name!
+          if name.nil? || name.strip.empty?
+            raise ArgumentError.new("Missing mailer name")
+          end
+        end
+
+        # @since 0.5.0
+        # @api private
+        def mailer_path
+          core_root.join('mailers', "#{ name_underscored }.rb").to_s
+        end
+
+        # @since 0.5.0
+        # @api private
+        def mailer_spec_path
+          spec_root.join(::File.basename(Dir.getwd), "mailers", "#{ name_underscored }_spec.rb")
+        end
+
+        # @since 0.5.0
+        # @api private
+        def txt_template_path
+          template_path(TXT_FORMAT)
+        end
+
+        # @since 0.5.0
+        # @api private
+        def html_template_path
+          template_path(HTML_FORMAT)
+        end
+
+        # @since 0.5.0
+        # @api private
+        def template_path(format)
+          core_root.join("mailers", "templates", "#{ name_underscored }#{ format }.#{ DEFAULT_ENGINE }")
+        end
+
+        def spec_root
+          Pathname.new("spec")
+        end
+
+        def core_root
+          Pathname.new("lib").join(::File.basename(Dir.getwd))
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require 'lotus/commands/generate/abstract'
+
+module Lotus
+  module Commands
+    class Generate
+      class Migration < Abstract
+
+        attr_reader :name, :underscored_name
+
+        # @since 0.6.0
+        # @api private
+        #
+        # @example
+        #   20150612160502
+        TIMESTAMP_FORMAT = '%Y%m%d%H%M%S'.freeze
+
+        # @since 0.6.0
+        # @api private
+        #
+        # @example
+        #   20150612160502_create_books.rb
+        FILENAME_PATTERN = '%{timestamp}_%{name}.rb'.freeze
+
+        def initialize(options, name)
+          super(options)
+
+          @name = name
+          @underscored_name = Utils::String.new(@name).underscore
+
+          environment.require_application_environment
+          assert_migration_name!
+        end
+
+        def map_templates
+          add_mapping('migration.rb.tt', destination_path)
+        end
+
+        private
+
+        def destination_path
+          existing_migration_path || new_migration_path
+        end
+
+        def existing_migration_path
+          Dir.glob("#{Lotus::Model.configuration.migrations}/[0-9]*_#{underscored_name}.rb").first
+        end
+
+        def new_migration_path
+          timestamp = Time.now.utc.strftime(TIMESTAMP_FORMAT)
+          filename = FILENAME_PATTERN % { timestamp: timestamp, name: underscored_name}
+
+          Lotus::Model.configuration.migrations.join(filename)
+        end
+
+        def assert_migration_name!
+          if name.nil? || name.strip.empty?
+            raise ArgumentError.new('Migration name nil or empty')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require 'lotus/commands/generate/abstract'
+
+module Lotus
+  module Commands
+    class Generate
+      class Model < Abstract
+
+        attr_reader :model_name
+
+        def initialize(options, model_name)
+          super(options)
+          @model_name = Utils::String.new(model_name).classify
+
+          assert_model_name!
+        end
+
+        def map_templates
+          add_mapping('entity.rb.tt', entity_path)
+          add_mapping('repository.rb.tt', repository_path)
+          add_mapping("entity_spec.#{ test_framework.framework }.tt", entity_spec_path,)
+          add_mapping("repository_spec.#{ test_framework.framework }.tt", repository_spec_path)
+        end
+
+        def template_options
+          {
+            model_name: model_name
+          }
+        end
+
+        private
+
+        # @since 0.6.0
+        # @api private
+        def assert_model_name!
+          model_name_not_blank
+          model_name_valid
+        end
+
+        # Validates that a model name was provided
+        #
+        # @since 0.6.0
+        # @api private
+        def model_name_not_blank
+          if model_name.nil? || model_name.strip.empty?
+            raise ArgumentError.new('Model name nil or empty.')
+          end
+        end
+
+        # Validates that the provided model name doesn't start with numbers
+        #
+        # @since 0.6.0
+        # @api private
+        def model_name_valid
+          unless model_name.match(/^[a-z]/i)
+            raise ArgumentError.new("Invalid model name. The model name shouldn't begin with a number.")
+          end
+        end
+
+        def model_root
+          Pathname.new('lib').join(::File.basename(Dir.getwd))
+        end
+
+        # @since 0.5.0
+        # @api private
+        def entity_path
+          model_root.join('entities', "#{ model_name_underscored }.rb").to_s
+        end
+
+        # @since 0.5.0
+        # @api private
+        def repository_path
+          model_root.join('repositories', "#{ model_name_underscored }_repository.rb").to_s
+        end
+
+        # @since 0.5.0
+        # @api private
+        def entity_spec_path
+          target_path.join('spec', ::File.basename(Dir.getwd), 'entities', "#{ model_name_underscored }_spec.rb")
+        end
+
+        # @since 0.5.0
+        # @api private
+        def repository_spec_path
+          target_path.join('spec', ::File.basename(Dir.getwd), 'repositories',
+            "#{ model_name_underscored }_repository_spec.rb")
+        end
+
+        # @since 0.5.0
+        # @api private
+        def model_name_underscored
+          Utils::String.new(model_name).underscore
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,128 @@
+require 'shellwords'
+require 'lotus/application_name'
+require 'lotus/generators/database_config'
+require 'lotus/generators/generatable'
+require 'lotus/generators/test_framework'
+require 'lotus/utils/hash'
+
+module Lotus
+  module Commands
+    class New
+      class Abstract
+
+        include Lotus::Generators::Generatable
+
+        DEFAULT_ARCHITECTURE = 'container'.freeze
+        DEFAULT_APPLICATION_BASE_URL = '/'.freeze
+
+        attr_reader :options, :target_path, :database_config
+
+        def initialize(options, name)
+          @options = Lotus::Utils::Hash.new(options).symbolize!
+          @name = name
+          @options[:database] ||= Lotus::Generators::DatabaseConfig::DEFAULT_ENGINE
+
+          assert_options!
+          assert_name!
+          assert_architecture!
+
+          @lotus_model_version = '~> 0.5'
+          @database_config = Lotus::Generators::DatabaseConfig.new(options[:database], app_name)
+        end
+
+        def start
+          FileUtils.mkdir_p(@name)
+          Dir.chdir(@name) do
+            @target_path = Pathname.pwd
+
+            super
+          end
+        end
+
+        private
+
+        def test_framework
+          @test_framework ||= Lotus::Generators::TestFramework.new(lotusrc, options[:test])
+        end
+
+        def lotusrc
+          @lotusrc ||= Lotusrc.new(Pathname.new('.'))
+        end
+
+        def start_in_app_dir
+          raise NotImplementedError
+        end
+
+        def add_sql_templates
+          return if !database_config.sql?
+
+          add_mapping('schema.sql.tt', 'db/schema.sql')
+        end
+
+        def add_git_templates
+          return if git_dir_present?
+
+          source = database_config.filesystem? ? 'gitignore.tt' : '.gitignore'
+          target = '.gitignore'
+          add_mapping(source, target)
+        end
+
+        def real_app_name
+          @name == '.' ? ::File.basename(Dir.getwd) : @name
+        end
+
+        def app_name
+          ApplicationName.new(real_app_name)
+        end
+
+        def target
+          Pathname.new('.')
+        end
+
+        def init_git
+          return if git_dir_present?
+
+          generator.run("git init #{Shellwords.escape(target)}", capture: true)
+        end
+
+        def git_dir_present?
+          File.directory?(target.join('.git'))
+        end
+
+        def lotus_model_version
+          @lotus_model_version
+        end
+
+        def lotus_head?
+          options.fetch(:lotus_head, false)
+        end
+
+        def architecture
+          options.fetch(:architecture, DEFAULT_ARCHITECTURE)
+        end
+
+        def assert_name!
+          if @name.nil? || @name.strip == '' || @name.include?(File::SEPARATOR)
+            raise ArgumentError.new("APPLICATION_NAME is requried and must not contain #{File::SEPARATOR}.")
+          end
+        end
+
+        def assert_architecture!
+          if !['app', 'container'].include?(architecture)
+            raise ArgumentError.new("Architecture must be one of 'app', 'container' but was '#{architecture}'")
+          end
+        end
+
+        def application_base_url
+          options[:application_base_url] || DEFAULT_APPLICATION_BASE_URL
+        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/new/app.rb

@@ -0,0 +1,116 @@
+require 'lotus/commands/new/abstract'
+
+module Lotus
+  module Commands
+    class New
+      class App < Abstract
+
+        def initialize(options, name)
+          super(options, name)
+        end
+
+        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,
+            upcase_app_name:       upcase_app_name,
+            classified_app_name:   classified_app_name,
+            application_base_url:  application_base_url,
+            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
+        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')
+          add_mapping('config/application.rb.tt', 'config/application.rb')
+          add_mapping('config/routes.rb.tt', 'config/routes.rb')
+          add_mapping('views/application_layout.rb.tt', 'app/views/application_layout.rb')
+          add_mapping('templates/application.html.erb.tt', 'app/templates/application.html.erb')
+          add_mapping('favicon.ico', 'app/assets/favicon.ico')
+        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
+            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', 'config/initializers/.gitkeep')
+          add_mapping('.gitkeep', 'app/controllers/.gitkeep')
+          add_mapping('.gitkeep', 'app/views/.gitkeep')
+          add_mapping('.gitkeep', 'app/assets/images/.gitkeep')
+          add_mapping('.gitkeep', 'app/assets/javascripts/.gitkeep')
+          add_mapping('.gitkeep', 'app/assets/stylesheets/.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', 'public/.gitkeep')
+
+          add_mapping('.gitkeep', 'spec/features/.gitkeep')
+          add_mapping('.gitkeep', 'spec/controllers/.gitkeep')
+          add_mapping('.gitkeep', 'spec/views/.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 template_source_path
+          Pathname.new(::File.dirname(__FILE__)).join('..', '..', 'generators', 'application', 'app').realpath
+        end
+
+        def upcase_app_name
+          app_name.to_env_s
+        end
+
+        def classified_app_name
+          Utils::String.new(app_name).classify
+        end
+
+        # def application_base_path
+        #   [ 'apps', app_name ].join(::File::SEPARATOR)
+        # end
+      end
+    end
+  end
+end