hanami 1.0.0.beta2 → 1.0.0.beta3

data/lib/hanami/cli_sub_commands/destroy.rb

@@ -3,6 +3,7 @@ require 'hanami/commands/generate/action'
 
 module Hanami
   class CliSubCommands
+    # @api private
     class Destroy < Thor
       extend CliBase
       include Thor::Actions
@@ -25,6 +26,7 @@ module Hanami
       method_option :url, desc: 'Relative URL for action, will be used for the route', default: nil
       method_option :template, desc: 'Extension used when the template was generated. Default is defined through your .hanamirc file.'
 
+      # @api private
       def actions(application_name = nil, controller_and_action_name)
         if Hanami::Environment.new(options).container? && application_name.nil?
           msg = "ERROR: \"hanami destroy action\" was called with arguments [\"#{controller_and_action_name}\"]\n" \
@@ -46,6 +48,7 @@ module Hanami
       > $ hanami destroy migration create_books
       EOS
 
+      # @api private
       def migration(name)
         if options[:help]
           invoke :help, ['migration']
@@ -63,6 +66,7 @@ module Hanami
         > $ hanami destroy model car
       EOS
 
+      # @api private
       def model(name)
         if options[:help]
           invoke :help, ['model']
@@ -78,6 +82,7 @@ module Hanami
 
       > $ hanami destroy application api
       EOS
+      # @api private
       def application(name)
         if options[:help]
           invoke :help, ['app']
@@ -94,6 +99,7 @@ module Hanami
       > $ hanami destroy mailer forgot_password
       EOS
 
+      # @api private
       def mailer(name)
         if options[:help]
           invoke :help, ['mailer']

data/lib/hanami/cli_sub_commands/generate.rb

@@ -18,8 +18,6 @@ module Hanami
 
       namespace :generate
 
-      # @since 0.6.0
-      # @api private
       desc 'action APPLICATION_NAME CONTROLLER_NAME#ACTION_NAME', 'Generate a hanami action'
       long_desc <<-EOS
         `hanami generate action` generates an an action, view and template along with specs and a route.
@@ -37,6 +35,8 @@ module Hanami
       method_option :test, desc: 'Defines the testing Framework to be used. Default is defined through your .hanamirc file.'
       method_option :skip_view, desc: 'Skip the generation of the view. Also skips template generation.', default: false, type: :boolean
       method_option :template, desc: 'Extension to be used for the generated template. Default is defined through your .hanamirc file.'
+      # @since 0.6.0
+      # @api private
       def actions(application_name = nil, controller_and_action_name)
         if Hanami::Environment.new(options).container? && application_name.nil?
           msg = "ERROR: \"hanami generate action\" was called with arguments [\"#{controller_and_action_name}\"]\n" \
@@ -57,6 +57,7 @@ module Hanami
 
       > $ hanami generate migration do_something
       EOS
+      # @api private
       def migration(name)
         if options[:help]
           invoke :help, ['migration']
@@ -78,6 +79,7 @@ module Hanami
       EOS
       method_option :test, desc: 'Defines the testing Framework to be used. Default is defined through your .hanamirc file.'
       method_option :skip_migration, desc: 'Skips the generation of a migration to create the model\'s table', default: false, type: :boolean
+      # @api private
       def model(name)
         if options[:help]
           invoke :help, ['model']
@@ -97,6 +99,7 @@ module Hanami
       method_option :to, desc: 'Sender email', default: Hanami::Commands::Generate::Mailer::DEFAULT_TO
       method_option :from, desc: 'Sendee email', default: Hanami::Commands::Generate::Mailer::DEFAULT_FROM
       method_option :subject, desc: 'Email subject', default: Hanami::Commands::Generate::Mailer::DEFAULT_SUBJECT
+      # @api private
       def mailer(name)
         if options[:help]
           invoke :help, ['mailer']
@@ -116,6 +119,7 @@ module Hanami
         > $ hanami generate app reporting --application_base_url=/reports
       EOS
       method_option :application_base_url, desc: 'Base URL for the new app. If missing, then it is inferred from APPLICATION_NAME'
+      # @api private
       def app(application_name)
         if options[:help]
           invoke :help, ['app']
@@ -132,6 +136,7 @@ module Hanami
         > $ hanami generate secret web
 
       EOS
+      # @api private
       def secret(application_name = nil)
         if options[:help]
           invoke :help, ['secret']

data/lib/hanami/commands/assets/precompile.rb

@@ -3,16 +3,20 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class Assets
+      # @api private
       class Precompile < Command
         requires 'apps.assets.configurations'
 
+        # @api private
         def start
           Hanami::Assets.precompile(configurations)
         end
 
         private
 
+        # @api private
         def configurations
           requirements['apps.assets.configurations']
         end

data/lib/hanami/commands/command.rb

@@ -9,6 +9,8 @@ module Hanami
     #
     # @since 0.9.0
     class Command
+      # @since 0.9.0
+      # @api private
       def self.inherited(component)
         super
 
@@ -21,15 +23,22 @@ module Hanami
       # Class level interface
       #
       # @since 0.9.0
+      # @api private
       module ClassMethods
+        # @since 0.9.0
+        # @api private
         def register_as(name)
           Hanami::Components.register(name, self)
         end
 
+        # @since 0.9.0
+        # @api private
         def requires(*names)
           requirements.concat(names)
         end
 
+        # @since 0.9.0
+        # @api private
         def requirements
           @_requirements
         end
@@ -38,6 +47,7 @@ module Hanami
       # @param options [Hash] Environment's options
       #
       # @since 0.9.0
+      # @api private
       def initialize(options)
         @environment = Hanami::Environment.new(options)
         @environment.require_project_environment
@@ -50,12 +60,15 @@ module Hanami
       private
 
       # @since 0.9.0
+      # @api private
       attr_reader :environment
 
       # @since 0.9.0
+      # @api private
       attr_reader :configuration
 
       # @since 0.9.0
+      # @api private
       def requirements
         Hanami::Components
       end

data/lib/hanami/commands/console.rb

@@ -1,6 +1,7 @@
 require 'hanami/commands/command'
 
 module Hanami
+  # @api private
   module Commands
     # REPL that supports different engines.
     #
@@ -34,14 +35,18 @@ module Hanami
         'irb'  => 'IRB'
       }.freeze
 
+      # @api private
       DEFAULT_ENGINE = ['irb'].freeze
 
       # @since 0.1.0
+      # @api private
       attr_reader :options
 
       # @param options [Hash] Environment's options
       #
       # @since 0.1.0
+      # @api private
+      #
       # @see Hanami::Environment#initialize
       def initialize(options)
         super(options)
@@ -50,6 +55,7 @@ module Hanami
       end
 
       # @since 0.1.0
+      # @api private
       def start
         prepare
         engine.start

data/lib/hanami/commands/db/apply.rb

@@ -2,10 +2,13 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class DB
+      # @api private
       class Apply < Command
         requires 'model.sql'
 
+        # @api private
         def start
           require 'hanami/model/migrator'
           Hanami::Model::Migrator.apply

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

@@ -3,27 +3,34 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class DB
+      # @api private
       class Console < Command
         requires 'model.sql'
 
+        # @api private
         def initialize(options, name)
           super(options)
           @name = name
         end
 
+        # @api private
         def start
           exec console.connection_string
         end
 
         private
 
+        # @api private
         attr_reader :name
 
+        # @api private
         def configuration
           Hanami::Components['model.configuration']
         end
 
+        # @api private
         def console
           require 'hanami/model/sql/console'
           Hanami::Model::Sql::Console.new(configuration.url)

data/lib/hanami/commands/db/create.rb

@@ -2,10 +2,13 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class DB
+      # @api private
       class Create < Command
         requires 'model.configuration'
 
+        # @api private
         def start
           require 'hanami/model/migrator'
           Hanami::Model::Migrator.create

data/lib/hanami/commands/db/drop.rb

@@ -2,10 +2,13 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class DB
+      # @api private
       class Drop < Command
         requires 'model.configuration'
 
+        # @api private
         def start
           require 'hanami/model/migrator'
           Hanami::Model::Migrator.drop

data/lib/hanami/commands/db/migrate.rb

@@ -2,15 +2,19 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class DB
+      # @api private
       class Migrate < Command
         requires 'model.sql'
 
+        # @api private
         def initialize(options, version)
           super(options)
           @version = version
         end
 
+        # @api private
         def start
           require 'hanami/model/migrator'
           Hanami::Model::Migrator.migrate(version: version)
@@ -18,6 +22,7 @@ module Hanami
 
         private
 
+        # @api private
         attr_reader :version
       end
     end

data/lib/hanami/commands/db/prepare.rb

@@ -2,10 +2,13 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class DB
+      # @api private
       class Prepare < Command
         requires 'model.sql'
 
+        # @api private
         def start
           require 'hanami/model/migrator'
           Hanami::Model::Migrator.prepare

data/lib/hanami/commands/db/version.rb

@@ -2,10 +2,13 @@ require 'hanami/commands/command'
 
 module Hanami
   module Commands
+    # @api private
     class DB
+      # @api private
       class Version < Command
         requires 'model.configuration'
 
+        # @api private
         def start
           require 'hanami/model/migrator'
           puts Hanami::Model::Migrator.version

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

@@ -8,13 +8,19 @@ require 'hanami/utils/string'
 
 module Hanami
   module Commands
+    # @api private
     class Generate
+      # @api private
       class Abstract < Commands::Command
 
         include Hanami::Generators::Generatable
 
-        attr_reader :options, :target_path
+        # @api private
+        attr_reader :options
+        # @api private
+        attr_reader :target_path
 
+        # @api private
         def initialize(options)
           super
 
@@ -24,6 +30,7 @@ module Hanami
           @target_path = Hanami.root
         end
 
+        # @api private
         def template_source_path
           generator = self.class.name.split('::').last.downcase
           Pathname.new(::File.dirname(__FILE__) + "/../../generators/#{generator}/").realpath
@@ -31,22 +38,27 @@ module Hanami
 
         private
 
+        # @api private
         def test_framework
           @test_framework ||= Hanami::Generators::TestFramework.new(hanamirc, options[:test])
         end
 
+        # @api private
         def hanamirc_options
           hanamirc.options
         end
 
+        # @api private
         def hanamirc
           @hanamirc ||= Hanamirc.new(target_path)
         end
 
+        # @api private
         def template_engine
           @template_engine ||= Hanami::Generators::TemplateEngine.new(hanamirc, options[:template])
         end
 
+        # @api private
         def assert_options!
           if options.nil?
             raise ArgumentError.new('options must not be nil')

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

@@ -4,7 +4,9 @@ require 'hanami/utils/blank'
 
 module Hanami
   module Commands
+    # @api private
     class Generate
+      # @api private
       class Action < Abstract
 
         # @since 0.8.0
@@ -59,6 +61,7 @@ module Hanami
           'Edit'    => '/:id/edit',
         }.freeze
 
+        # @api private
         def initialize(options, application_name, controller_and_action_name)
           super(options)
           if !environment.container?
@@ -86,6 +89,7 @@ module Hanami
           assert_http_method!
         end
 
+        # @api private
         def map_templates
           add_mapping("action_spec.#{test_framework.framework}.tt", action_spec_path)
 
@@ -99,6 +103,7 @@ module Hanami
           end
         end
 
+        # @api private
         def post_process_templates
           generate_route
         end
@@ -116,6 +121,7 @@ module Hanami
           }
         end
 
+        # @api private
         def destroy
           generator.gsub_file(routes_path, /^.*#{@controller_and_action_name}.*\n/, '', verbose: false)
           super
@@ -132,6 +138,7 @@ module Hanami
           generator.prepend_after_leading_comments(routes_path, "#{ http_method } '#{ route_url }', to: '#{ route_endpoint }'\n")
         end
 
+        # @api private
         def skip_view?
           options.fetch(:skip_view, false)
         end
@@ -219,6 +226,7 @@ module Hanami
           end
         end
 
+        # @api private
         def routes_path
           if environment.container?
             application_path.join('config', 'routes.rb')
@@ -230,6 +238,7 @@ module Hanami
         # The directory of the application
         # ./app for 'app' architecture
         # ./apps/APPLICATION_NAME for 'container'
+        # @api private
         def application_path
           if environment.container?
             applications_path.join(application_name_as_snake_case)
@@ -239,42 +248,52 @@ module Hanami
         end
 
         # The parent dir of the application directory.
+        # @api private
         def applications_path
           Pathname.new('apps')
         end
 
+        # @api private
         def view_path
           application_path.join('views', *@controller_directory, "#{@action_name}.rb")
         end
 
+        # @api private
         def view_spec_path
           spec_root.join('views', *@controller_directory, "#{@action_name}_spec.rb")
         end
 
+        # @api private
         def template_path
           application_path.join('templates', *@controller_directory, "#{@action_name}.html.#{template_engine.name}")
         end
 
+        # @api private
         def action_path
           application_path.join('controllers', *@controller_directory, "#{@action_name}.rb")
         end
 
+        # @api private
         def action_spec_path
           spec_root.join('controllers', *@controller_directory, "#{@action_name}_spec.rb")
         end
 
+        # @api private
         def spec_root
           Pathname.new('spec').join(app_base_dir)
         end
 
+        # @api private
         def relative_action_path
           relative_base_path.join(application_path, 'controllers', *@controller_directory, @action_name)
         end
 
+        # @api private
         def relative_view_path
           relative_base_path.join(application_path, 'views', *@controller_directory, @action_name)
         end
 
+        # @api private
         def relative_base_path
           nestings = [UP_DIRECTORY] * @controller_name.count(CONTROLLER_SEPARATOR)
           nestings << UP_DIRECTORY if environment.container?
@@ -284,6 +303,7 @@ module Hanami
           )
         end
 
+        # @api private
         def app_base_dir
           if environment.container?
             application_name_as_snake_case
@@ -292,6 +312,7 @@ module Hanami
           end
         end
 
+        # @api private
         def application_name_as_snake_case
           @application_name.gsub(/(.)([A-Z])/,'\1_\2').downcase
         end