lib/hanami/commands/generate/app.rb in hanami-1.0.0.beta2 vs lib/hanami/commands/generate/app.rb in hanami-1.0.0.beta3

@@ -2,16 +2,21 @@
 require 'hanami/application_name'
 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!
           assert_options!
 
@@ -22,10 +27,11 @@
 
           @application_name = ApplicationName.new(application_name)
           @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')
           add_mapping('views/application_layout.rb.tt', 'views/application_layout.rb')
           add_mapping("templates/application.html.#{ template_engine.name }.tt", "templates/application.html.#{ template_engine.name }")
@@ -38,10 +44,11 @@
           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
 
+        # @api private
         def template_options
           {
             app_name:            app_name,
             upcase_app_name:     upcase_app_name,
             classified_app_name: classified_app_name,
@@ -49,79 +56,93 @@
             app_base_path:       application_base_path,
             template:            template_engine.name
           }
         end
 
+        # @api private
         def post_process_templates
           add_require_app
           add_mount_app
           add_web_session_secret
         end
 
         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
             "\nrequire_relative '../apps/#{ app_name }/application'"
           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)
             generator.append_to_file base_path.join(".env.#{ environment }") do
               %(#{ upcase_app_name }_SESSIONS_SECRET="#{ SecureRandom.hex(32) }"\n)
             end
           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"
             exit(1)
           end