hanami 1.0.0.beta2 → 1.0.0.beta3

data/lib/hanami/generators/generatable.rb

@@ -1,52 +1,65 @@
 require 'hanami/generators/generator'
 
 module Hanami
+  # @api private
   module Generators
+    # @api private
     module Generatable
 
+      # @api private
       def start
         map_templates
         process_templates
       end
 
+      # @api private
       def destroy
         generator.behavior = :revoke
         self
       end
 
+      # @api private
       def generator
         @generator ||= Hanami::Generators::Generator.new(template_source_path, target_path)
       end
 
+      # @api private
       def map_templates
         raise NotImplementedError, "must implement the map_templates method"
       end
 
+      # @api private
       def add_mapping(source, target)
         generator.add_mapping(source, target)
       end
 
+      # @api private
       def process_templates
         generator.process_templates(template_options)
         post_process_templates
       end
 
+      # @api private
       def post_process_templates
         nil
       end
 
+      # @api private
       def template_options
         {}
       end
 
+      # @api private
       def template_source_path
         raise NotImplementedError, "must implement the template_source_path method"
       end
 
+      # @api private
       def target_path
         raise NotImplementedError, "must implement the target_path method"
       end
 
+      # @api private
       def argument_blank?(value)
         Hanami::Utils::Blank.blank?(value)
       end

data/lib/hanami/generators/generator.rb

@@ -2,17 +2,22 @@ require 'thor'
 require 'forwardable'
 
 module Hanami
+  # @api private
   module Generators
+    # @api private
     class Generator
 
       extend Forwardable
 
+      # @api private
       def_delegators :@processor, :run, :behavior=, :inject_into_file, :append_to_file, :prepend_to_file, :gsub_file
 
+      # @api private
       class Processor < Thor
         include Thor::Actions
       end
 
+      # @api private
       def initialize(template_source_path, target_path)
         @template_source_path = template_source_path
         @target_path = target_path
@@ -21,10 +26,12 @@ module Hanami
         @processor.class.source_root(@template_source_path)
       end
 
+      # @api private
       def add_mapping(source, target)
         @template_mappings << [source, target]
       end
 
+      # @api private
       def process_templates(options = {})
         @template_mappings.each do |src, dst|
           @processor.template(@template_source_path.join(src), @target_path.join(dst), options)
@@ -32,6 +39,7 @@ module Hanami
       end
 
       # Modelled after Thor's `inject_into_class`
+      # @api private
       def prepend_after_leading_comments(path, *args, &block)
         config = args.last.is_a?(Hash) ? args.pop : {}
         # Either prepend after the last comment line,

data/lib/hanami/generators/template_engine.rb

@@ -1,14 +1,20 @@
 module Hanami
+  # @api private
   module Generators
+    # @api private
     class TemplateEngine
       class UnsupportedTemplateEngine < ::StandardError
       end
 
+      # @api private
       SUPPORTED_ENGINES = %w(erb haml slim).freeze
+      # @api private
       DEFAULT_ENGINE = 'erb'.freeze
 
+      # @api private
       attr_reader :name
 
+      # @api private
       def initialize(hanamirc, engine)
         @name = (engine || hanamirc.options.fetch(:template))
         assert_engine!
@@ -16,6 +22,7 @@ module Hanami
 
       private
 
+      # @api private
       def assert_engine!
         if !supported_engine?
           warn "`#{name}' is not a valid template engine. Please use one of: #{valid_template_engines.join(', ')}"
@@ -23,10 +30,12 @@ module Hanami
         end
       end
 
+      # @api private
       def valid_template_engines
         SUPPORTED_ENGINES.map { |name| "`#{name}'"}
       end
 
+      # @api private
       def supported_engine?
         SUPPORTED_ENGINES.include?(@name.to_s)
       end

data/lib/hanami/generators/test_framework.rb

@@ -1,28 +1,38 @@
 require 'hanami/hanamirc'
 module Hanami
+  # @api private
   module Generators
+    # @api private
     class TestFramework
+      # @api private
       RSPEC = 'rspec'.freeze
+      # @api private
       MINITEST = 'minitest'.freeze
+      # @api private
       VALID_FRAMEWORKS = [MINITEST, RSPEC].freeze
 
+      # @api private
       attr_reader :framework
 
+      # @api private
       def initialize(hanamirc, framework)
         @framework = (framework || hanamirc.options.fetch(:test))
         assert_framework!
       end
 
+      # @api private
       def rspec?
         framework == RSPEC
       end
 
+      # @api private
       def minitest?
         framework == MINITEST
       end
 
       private
 
+      # @api private
       def assert_framework!
         if !supported_framework?
           warn "`#{framework}' is not a valid test framework. Please use one of: #{valid_test_frameworks.join(', ')}"
@@ -30,10 +40,12 @@ module Hanami
         end
       end
 
+      # @api private
       def valid_test_frameworks
         VALID_FRAMEWORKS.map { |name| "`#{name}'"}
       end
 
+      # @api private
       def supported_framework?
         VALID_FRAMEWORKS.include?(framework)
       end

data/lib/hanami/hanamirc.rb

@@ -135,10 +135,12 @@ module Hanami
 
     private
 
+    # @api private
     def symbolize(hash)
       Utils::Hash.new(hash).symbolize!
     end
 
+    # @api private
     def file_options
       symbolize(exists? ? parse_file(path_file) : {})
     end

data/lib/hanami/mailer/glue.rb

@@ -1,3 +1,4 @@
+# @api private
 module Hanami::Mailer
   # @since 0.5.0
   # @api private

data/lib/hanami/middleware.rb

@@ -63,6 +63,17 @@ module Hanami
     # @since 0.2.0
     #
     # @see Hanami::Middleware#prepend
+    #
+    # @example
+    #   # apps/web/application.rb
+    #   module Web
+    #     class Application < Hanami::Application
+    #       configure do
+    #         # ...
+    #         use MyRackMiddleware, foo: 'bar'
+    #       end
+    #     end
+    #   end
     def use(middleware, *args, &blk)
       stack.push [middleware, args, blk]
       stack.uniq!
@@ -79,6 +90,17 @@ module Hanami
     # @since 0.6.0
     #
     # @see Hanami::Middleware#use
+    #
+    # @example
+    #   # apps/web/application.rb
+    #   module Web
+    #     class Application < Hanami::Application
+    #       configure do
+    #         # ...
+    #         prepend MyRackMiddleware, foo: 'bar'
+    #       end
+    #     end
+    #   end
     def prepend(middleware, *args, &blk)
       stack.unshift [middleware, args, blk]
       stack.uniq!
@@ -109,6 +131,8 @@ module Hanami
       end
     end
 
+    # @api private
+    # @since 0.9.0
     def routes
       Components["#{configuration.app_name}.routes"]
     end

data/lib/hanami/rendering_policy.rb

@@ -8,16 +8,24 @@ module Hanami
   # @since 0.1.0
   # @api private
   class RenderingPolicy
+    # @api private
     STATUS  = 0
+    # @api private
     HEADERS = 1
+    # @api private
     BODY    = 2
 
+    # @api private
     HANAMI_ACTION = 'hanami.action'.freeze
+    # @api private
     RACK_EXCEPTION = 'rack.exception'.freeze
 
+    # @api private
     SUCCESSFUL_STATUSES = (200..201).freeze
+    # @api private
     RENDERABLE_FORMATS = [:all, :html].freeze
 
+    # @api private
     def initialize(configuration)
       @controller_pattern = %r{#{ configuration.controller_pattern.gsub(/\%\{(controller|action)\}/) { "(?<#{ $1 }>(.*))" } }}
       @view_pattern       = configuration.view_pattern
@@ -25,6 +33,7 @@ module Hanami
       @templates          = configuration.templates
     end
 
+    # @api private
     def render(env, response)
       body = _render(env, response)
 
@@ -33,6 +42,7 @@ module Hanami
     end
 
     private
+    # @api private
     def _render(env, response)
       if action = renderable?(env)
         _render_action(action, env, response) ||
@@ -40,6 +50,7 @@ module Hanami
       end
     end
 
+    # @api private
     def _render_action(action, env, response)
       begin
         view_for(action, response).render(
@@ -51,20 +62,24 @@ module Hanami
       end
     end
 
+    # @api private
     def _render_status_page(action, response)
       if render_status_page?(action, response)
         Hanami::Views::Default.render(@templates, response[STATUS], response: response, format: :html)
       end
     end
 
+    # @api private
     def renderable?(env)
       ((action = env.delete(HANAMI_ACTION)) && action.renderable?) and action
     end
 
+    # @api private
     def render_status_page?(action, response)
       RENDERABLE_FORMATS.include?(action.format) && !SUCCESSFUL_STATUSES.include?(response[STATUS])
     end
 
+    # @api private
     def view_for(action, response)
       view = if response[BODY].respond_to?(:empty?) && response[BODY].empty?
         captures = @controller_pattern.match(action.class.name)

data/lib/hanami/routes.rb

@@ -7,6 +7,7 @@ module Hanami
   # to the `Routes` constant, under the application namespace.
   #
   # @since 0.1.0
+  # @api private
   class Routes
     # Initialize the factory
     #
@@ -15,6 +16,7 @@ module Hanami
     # @return [Hanami::Routes] the factory
     #
     # @since 0.1.0
+    # @api private
     def initialize(routes)
       @routes = routes
     end
@@ -36,7 +38,7 @@ module Hanami
     # @example Basic example
     #   require 'hanami'
     #
-    #   module Bookshelf
+    #   module Web
     #     class Application < Hanami::Application
     #       configure do
     #         routes do
@@ -46,16 +48,16 @@ module Hanami
     #     end
     #   end
     #
-    #   Bookshelf::Routes.path(:login)
+    #   Web.routes.path(:login)
     #     # => '/login'
     #
-    #   Bookshelf::Routes.path(:login, return_to: '/dashboard')
+    #   Web.routes.path(:login, return_to: '/dashboard')
     #     # => '/login?return_to=%2Fdashboard'
     #
     # @example Dynamic finders
     #   require 'hanami'
     #
-    #   module Bookshelf
+    #   module Web
     #     class Application < Hanami::Application
     #       configure do
     #         routes do
@@ -65,10 +67,10 @@ module Hanami
     #     end
     #   end
     #
-    #   Bookshelf::Routes.login_path
+    #   Web.routes.login_path
     #     # => '/login'
     #
-    #   Bookshelf::Routes.login_path(return_to: '/dashboard')
+    #   Web.routes.login_path(return_to: '/dashboard')
     #     # => '/login?return_to=%2Fdashboard'
     def path(name, *args)
       Utils::Escape::SafeString.new(@routes.path(name, *args))
@@ -91,7 +93,7 @@ module Hanami
     # @example Basic example
     #   require 'hanami'
     #
-    #   module Bookshelf
+    #   module Web
     #     class Application < Hanami::Application
     #       configure do
     #         routes do
@@ -104,16 +106,16 @@ module Hanami
     #     end
     #   end
     #
-    #   Bookshelf::Routes.url(:login)
+    #   Web.routes.url(:login)
     #     # => 'https://bookshelf.org/login'
     #
-    #   Bookshelf::Routes.url(:login, return_to: '/dashboard')
+    #   Web.routes.url(:login, return_to: '/dashboard')
     #     # => 'https://bookshelf.org/login?return_to=%2Fdashboard'
     #
     # @example Dynamic finders
     #   require 'hanami'
     #
-    #   module Bookshelf
+    #   module Web
     #     class Application < Hanami::Application
     #       configure do
     #         routes do
@@ -126,10 +128,10 @@ module Hanami
     #     end
     #   end
     #
-    #   Bookshelf::Routes.login_url
+    #   Web.routes.login_url
     #     # => 'https://bookshelf.org/login'
     #
-    #   Bookshelf::Routes.login_url(return_to: '/dashboard')
+    #   Web.routes.login_url(return_to: '/dashboard')
     #     # => 'https://bookshelf.org/login?return_to=%2Fdashboard'
     def url(name, *args)
       Utils::Escape::SafeString.new(@routes.url(name, *args))

data/lib/hanami/routing/default.rb

@@ -1,21 +1,28 @@
 module Hanami
+  # @api private
   module Routing
     # The default Rack application that responds when a resource cannot be found.
     #
     # @since 0.1.0
     # @api private
     class Default
+      # @api private
       DEFAULT_CODE = 404
+      # @api private
       DEFAULT_BODY = ['Not Found'].freeze
+      # @api private
       CONTENT_TYPE = 'Content-Type'.freeze
 
+      # @api private
       class NullAction
         include Hanami::Action
 
+        # @api private
         def call(env)
         end
       end
 
+      # @api private
       def call(env)
         action = NullAction.new.tap { |a| a.call(env) }
         [ DEFAULT_CODE, {CONTENT_TYPE => action.content_type}, DEFAULT_BODY, action ]