hanami 1.0.0.beta2 → 1.0.0.beta3

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

@@ -4,12 +4,17 @@ require 'hanami/utils/blank'
 require 'securerandom'
 
 module Hanami
+  # @api private
   module Commands
+    # @api private
     class Generate
+      # @api private
       class App < Abstract
 
+        # @api private
         attr_reader :base_path
 
+        # @api private
         def initialize(options, application_name)
           @environment = Hanami::Environment.new(options)
           @options = Hanami::Utils::Hash.new(options).symbolize!
@@ -24,6 +29,7 @@ module Hanami
           @base_path = Pathname.pwd
         end
 
+        # @api private
         def map_templates
           add_mapping('application.rb.tt', 'application.rb')
           add_mapping('config/routes.rb.tt', 'config/routes.rb')
@@ -40,6 +46,7 @@ module Hanami
           add_mapping('.gitkeep', "../../spec/#{ app_name }/views/.gitkeep")
         end
 
+        # @api private
         def template_options
           {
             app_name:            app_name,
@@ -51,6 +58,7 @@ module Hanami
           }
         end
 
+        # @api private
         def post_process_templates
           add_require_app
           add_mount_app
@@ -59,10 +67,12 @@ module Hanami
 
         private
 
+        # @api private
         def application_base_url
           options.fetch(:application_base_url, "/#{app_name}")
         end
 
+        # @api private
         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
@@ -70,12 +80,14 @@ module Hanami
           end
         end
 
+        # @api private
         def add_mount_app
           generator.inject_into_file base_path.join('config/environment.rb'), after: /Hanami.configure do/ do |match|
             "\n  mount #{ classified_app_name }::Application, at: '#{ application_base_url }'"
           end
         end
 
+        # @api private
         def add_web_session_secret
           ['development', 'test'].each do |environment|
             # Add WEB_SESSIONS_SECRET="abc123" (random hex)
@@ -85,42 +97,51 @@ module Hanami
           end
         end
 
+        # @api private
         def hanamirc
           @hanamirc ||= Hanamirc.new(base_path)
         end
 
+        # @api private
         def target_path
           base_path.join(application_base_path)
         end
 
+        # @api private
         def app_name
           @application_name.to_s
         end
 
+        # @api private
         def upcase_app_name
           @application_name.to_env_s
         end
 
+        # @api private
         def application_base_path
           ["apps", @application_name].join(::File::SEPARATOR)
         end
 
+        # @api private
         def classified_app_name
           Utils::String.new(app_name).classify.tr('::', '')
         end
 
+        # @api private
         def assert_application_name!(value)
           if argument_blank?(value)
             raise ArgumentError.new('Application name is missing')
           end
         end
 
+        # @api private
         def assert_architecture!
           if !environment.container?
             raise ArgumentError.new('App generator is only available for container architecture.')
           end
         end
 
+        # @api private
         def assert_application_base_url!
           if options.key?(:application_base_url) && Utils::Blank.blank?(options[:application_base_url])
             warn "`' is not a valid URL"

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

@@ -1,13 +1,23 @@
 require "hanami/commands/generate/abstract"
 
 module Hanami
+  # @api private
   module Commands
+    # @api private
     class Generate
       # @since 0.5.0
       # @api private
       class Mailer < Abstract
-
-        attr_reader :name, :name_underscored, :from, :to, :subject
+        # @api private
+        attr_reader :name
+        # @api private
+        attr_reader :name_underscored
+        # @api private
+        attr_reader :from
+        # @api private
+        attr_reader :to
+        # @api private
+        attr_reader :subject
 
         # @since 0.5.0
         # @api private
@@ -47,7 +57,7 @@ module Hanami
           assert_name!
         end
 
-        # @since 0.x.x
+        # @since 0.5.0
         # @api private
         def map_templates
           add_mapping("mailer_spec.rb.#{test_framework.framework}.tt", mailer_spec_path)
@@ -56,6 +66,7 @@ module Hanami
           add_mapping("template.html.tt", html_template_path)
         end
 
+        # @api private
         def template_options
           {
             mailer:  name,
@@ -105,10 +116,12 @@ module Hanami
           core_root.join("mailers", "templates", "#{ name_underscored }#{ format }.#{ DEFAULT_ENGINE }")
         end
 
+        # @api private
         def spec_root
           Pathname.new("spec")
         end
 
+        # @api private
         def core_root
           Pathname.new("lib").join(project_name)
         end

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

@@ -2,11 +2,16 @@ require 'hanami/commands/generate/abstract'
 require 'hanami/utils/file_list'
 
 module Hanami
+  # @api private
   module Commands
+    # @api private
     class Generate
+      # @api private
       class Migration < Abstract
-
-        attr_reader :name, :underscored_name
+        # @api private
+        attr_reader :name
+        # @api private
+        attr_reader :underscored_name
 
         # @since 0.6.0
         # @api private
@@ -22,6 +27,7 @@ module Hanami
         #   20150612160502_create_books.rb
         FILENAME_PATTERN = '%{timestamp}_%{name}.rb'.freeze
 
+        # @api private
         def initialize(options, name)
           super(options)
 
@@ -32,20 +38,24 @@ module Hanami
           assert_migration_name!
         end
 
+        # @api private
         def map_templates
           add_mapping('migration.rb.tt', destination_path)
         end
 
         private
 
+        # @api private
         def destination_path
           existing_migration_path || new_migration_path
         end
 
+        # @api private
         def existing_migration_path
           Utils::FileList["#{Hanami::Model.configuration.migrations}/[0-9]*_#{underscored_name}.rb"].first
         end
 
+        # @api private
         def new_migration_path
           timestamp = Time.now.utc.strftime(TIMESTAMP_FORMAT)
           filename = FILENAME_PATTERN % { timestamp: timestamp, name: underscored_name}
@@ -53,6 +63,7 @@ module Hanami
           Hanami::Model.configuration.migrations.join(filename)
         end
 
+        # @api private
         def assert_migration_name!
           if argument_blank?(name)
             raise ArgumentError.new('Migration name is missing')

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

@@ -2,12 +2,21 @@ require 'hanami/commands/generate/abstract'
 require 'hanami/commands/generate/migration'
 
 module Hanami
+  # @api private
   module Commands
+    # @api private
     class Generate
+      # @api private
       class Model < Abstract
 
-        attr_reader :input, :model_name, :table_name
+        # @api private
+        attr_reader :input
+        # @api private
+        attr_reader :model_name
+        # @api private
+        attr_reader :table_name
 
+        # @api private
         def initialize(options, model_name)
           super(options)
           @input      = Utils::String.new(model_name).underscore
@@ -21,6 +30,7 @@ module Hanami
           assert_model_name!
         end
 
+        # @api private
         def map_templates
           add_mapping('entity.rb.tt', entity_path)
           add_mapping('repository.rb.tt', repository_path)
@@ -31,6 +41,7 @@ module Hanami
           add_mapping("repository_spec.#{ test_framework.framework }.tt", repository_spec_path)
         end
 
+        # @api private
         def template_options
           {
             model_name: model_name,
@@ -67,10 +78,12 @@ module Hanami
           end
         end
 
+        # @api private
         def skip_migration?
           options.fetch(:skip_migration, false)
         end
 
+        # @api private
         def model_root
           Pathname.new('lib').join(project_name)
         end

data/lib/hanami/commands/generate/secret_token.rb

@@ -3,14 +3,19 @@ require 'hanami/application_name'
 require 'securerandom'
 
 module Hanami
+  # @api private
   module Commands
+    # @api private
     class Generate
+      # @api private
       class SecretToken
 
+        # @api private
         def initialize(application_name)
           @application_name = application_name
         end
 
+        # @api private
         def start
           if Hanami::Utils::Blank.blank?(@application_name)
             puts SecureRandom.hex(32)
@@ -21,6 +26,7 @@ module Hanami
         end
 
         private
+        # @api private
         def upcase_app_name
           @application_name.upcase
         end

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

@@ -8,18 +8,34 @@ require 'hanami/utils'
 require 'hanami/utils/hash'
 
 module Hanami
+  # @api private
   module Commands
+    # @api private
     class New
+      # @api private
       class Abstract
 
         include Hanami::Generators::Generatable
 
+        # @api private
         DEFAULT_ARCHITECTURE = 'container'.freeze
+        # @api private
         DEFAULT_APPLICATION_BASE_URL = '/'.freeze
 
-        attr_reader :options, :target_path, :database_config,
-          :test_framework, :hanami_model_version, :template_engine
-
+        # @api private
+        attr_reader :options
+        # @api private
+        attr_reader :target_path
+        # @api private
+        attr_reader :database_config
+        # @api private
+        attr_reader :test_framework
+        # @api private
+        attr_reader :hanami_model_version
+        # @api private
+        attr_reader :template_engine
+
+        # @api private
         def initialize(options, name)
           @options = Hanami::Utils::Hash.new(options).symbolize!
           @name = name
@@ -29,12 +45,13 @@ module Hanami
           assert_name!
           assert_architecture!
 
-          @hanami_model_version = '~> 1.0.0.beta2'
+          @hanami_model_version = '~> 1.0.0.beta3'
           @database_config = Hanami::Generators::DatabaseConfig.new(options[:database], project_name)
           @test_framework = Hanami::Generators::TestFramework.new(hanamirc, @options[:test])
           @template_engine = Hanami::Generators::TemplateEngine.new(hanamirc, @options[:template])
         end
 
+        # @api private
         def start
           FileUtils.mkdir_p(project_directory)
           Dir.chdir(project_directory) do
@@ -46,20 +63,24 @@ module Hanami
 
         private
 
+        # @api private
         def hanamirc
           @hanamirc ||= Hanamirc.new(Pathname.new('.'))
         end
 
+        # @api private
         def start_in_app_dir
           raise NotImplementedError
         end
 
+        # @api private
         def add_sql_templates
           return if !database_config.sql?
 
           add_mapping('schema.sql.tt', 'db/schema.sql')
         end
 
+        # @api private
         def add_git_templates
           return if git_dir_present?
 
@@ -68,64 +89,78 @@ module Hanami
           add_mapping(source, target)
         end
 
+        # @api private
         def real_project_name
           @name == '.' ? ::File.basename(Dir.getwd) : @name
         end
 
+        # @api private
         def project_name
           ApplicationName.new(real_project_name)
         end
 
+        # @api private
         def project_directory
           @name == '.' ? '.' : project_name
         end
 
+        # @api private
         def target
           Pathname.new('.')
         end
 
+        # @api private
         def init_git
           return if git_dir_present?
 
           generator.run("git init #{Shellwords.escape(target)}", capture: true)
         end
 
+        # @api private
         def git_dir_present?
           File.directory?(target.join('.git'))
         end
 
+        # @api private
         def hanami_version
           Hanami::Version.gem_requirement
         end
 
+        # @api private
         def hanami_head?
           options.fetch(:hanami_head, false)
         end
 
+        # @api private
         def code_reloading?
           !Hanami::Utils.jruby?
         end
 
+        # @api private
         def architecture
           options.fetch(:architecture, DEFAULT_ARCHITECTURE)
         end
 
+        # @api private
         def assert_name!
           if argument_blank?(@name) || @name.include?(File::SEPARATOR)
             raise ArgumentError.new("APPLICATION_NAME is required and must not contain #{File::SEPARATOR}.")
           end
         end
 
+        # @api private
         def assert_architecture!
           if !['app', 'container'].include?(architecture)
             raise ArgumentError.new("Architecture must be one of 'app', 'container' but was '#{architecture}'")
           end
         end
 
+        # @api private
         def application_base_url
           options[:application_base_url] || DEFAULT_APPLICATION_BASE_URL
         end
 
+        # @api private
         def assert_options!
           if options.nil?
             raise ArgumentError.new('options must not be nil')