hanami-controller 1.3.2 → 2.0.0.alpha3

data/lib/hanami/action.rb

@@ -1,17 +1,5 @@
-require 'hanami/action/configurable'
-require 'hanami/action/rack'
-require 'hanami/action/mime'
-require 'hanami/action/redirect'
-require 'hanami/action/exposable'
-require 'hanami/action/throwable'
-require 'hanami/action/callbacks'
-begin
-  require 'hanami/validations'
-  require 'hanami/action/validatable'
-rescue LoadError
-end
-require 'hanami/action/head'
-require 'hanami/action/callable'
+require_relative 'action/application_action'
+require_relative 'action/standalone_action'
 
 module Hanami
   # An HTTP endpoint
@@ -28,84 +16,152 @@ module Hanami
   #       # ...
   #     end
   #   end
-  module Action
-    # Override Ruby's hook for modules.
-    # It includes basic Hanami::Action modules to the given class.
+  class Action
+    # Rack SPEC response code
     #
-    # @param base [Class] the target action
+    # @since 1.0.0
+    # @api private
+    RESPONSE_CODE = 0
+
+    # Rack SPEC response headers
     #
-    # @since 0.1.0
+    # @since 1.0.0
     # @api private
+    RESPONSE_HEADERS = 1
+
+    # Rack SPEC response body
     #
-    # @see http://www.ruby-doc.org/core-2.1.2/Module.html#method-i-included
-    #
-    # @see Hanami::Action::Rack
-    # @see Hanami::Action::Mime
-    # @see Hanami::Action::Http
-    # @see Hanami::Action::Redirect
-    # @see Hanami::Action::Exposable
-    # @see Hanami::Action::Throwable
-    # @see Hanami::Action::Callbacks
-    # @see Hanami::Action::Validatable
-    # @see Hanami::Action::Configurable
-    # @see Hanami::Action::Callable
-    def self.included(base)
-      base.class_eval do
-        include Rack
-        include Mime
-        include Redirect
-        include Exposable
-        include Throwable
-        include Callbacks
-        include Validatable if defined?(Validatable)
-        include Configurable
-        include Head
-        prepend Callable
-      end
-    end
+    # @since 1.0.0
+    # @api private
+    RESPONSE_BODY = 2
 
-    private
+    DEFAULT_ERROR_CODE = 500
 
-    # Raise error when `Hanami::Action::Session` isn't included.
+    # Status codes that by RFC must not include a message body
     #
-    # To use `session`, include `Hanami::Action::Session`.
+    # @since 0.3.2
+    # @api private
+    HTTP_STATUSES_WITHOUT_BODY = Set.new((100..199).to_a << 204 << 205 << 304).freeze
+
+    # Not Found
     #
-    # @raise [Hanami::Controller::MissingSessionError]
+    # @since 1.0.0
+    # @api private
+    NOT_FOUND = 404
+
+    # Entity headers allowed in blank body responses, according to
+    # RFC 2616 - Section 10 (HTTP 1.1).
     #
-    # @since 1.2.0
-    def session
-      raise Hanami::Controller::MissingSessionError.new(:session)
-    end
+    # "The response MAY include new or updated metainformation in the form
+    #   of entity-headers".
+    #
+    # @since 0.4.0
+    # @api private
+    #
+    # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5
+    # @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html
+    ENTITY_HEADERS = {
+      'Allow'            => true,
+      'Content-Encoding' => true,
+      'Content-Language' => true,
+      'Content-Location' => true,
+      'Content-MD5'      => true,
+      'Content-Range'    => true,
+      'Expires'          => true,
+      'Last-Modified'    => true,
+      'extension-header' => true
+    }.freeze
 
-    # Raise error when `Hanami::Action::Session` isn't included.
+    # The request method
     #
-    # To use `flash`, include `Hanami::Action::Session`.
+    # @since 0.3.2
+    # @api private
+    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
+
+    # The Content-Length HTTP header
     #
-    # @raise [Hanami::Controller::MissingSessionError]
+    # @since 1.0.0
+    # @api private
+    CONTENT_LENGTH = 'Content-Length'.freeze
+
+    # The non-standard HTTP header to pass the control over when a resource
+    # cannot be found by the current endpoint
     #
-    # @since 1.2.0
-    def flash
-      raise Hanami::Controller::MissingSessionError.new(:flash)
-    end
+    # @since 1.0.0
+    # @api private
+    X_CASCADE = 'X-Cascade'.freeze
+
+    # HEAD request
+    #
+    # @since 0.3.2
+    # @api private
+    HEAD = 'HEAD'.freeze
+
+    # The key that returns accepted mime types from the Rack env
+    #
+    # @since 0.1.0
+    # @api private
+    HTTP_ACCEPT          = 'HTTP_ACCEPT'.freeze
 
-    # Finalize the response
+    # The header key to set the mime type of the response
     #
-    # This method is abstract and COULD be implemented by included modules in
-    # order to prepare their data before the response will be returned to the
-    # webserver.
+    # @since 0.1.0
+    # @api private
+    CONTENT_TYPE         = 'Content-Type'.freeze
+
+    # The default mime type for an incoming HTTP request
     #
     # @since 0.1.0
     # @api private
-    # @abstract
+    DEFAULT_ACCEPT       = '*/*'.freeze
+
+    # The default mime type that is returned in the response
+    #
+    # @since 0.1.0
+    # @api private
+    DEFAULT_CONTENT_TYPE = 'application/octet-stream'.freeze
+
+    # @since 0.2.0
+    # @api private
+    RACK_ERRORS = 'rack.errors'.freeze
+
+    # This isn't part of Rack SPEC
+    #
+    # Exception notifiers use <tt>rack.exception</tt> instead of
+    # <tt>rack.errors</tt>, so we need to support it.
+    #
+    # @since 0.5.0
+    # @api private
     #
-    # @see Hanami::Action::Mime#finish
-    # @see Hanami::Action::Exposable#finish
-    # @see Hanami::Action::Callable#finish
-    # @see Hanami::Action::Session#finish
-    # @see Hanami::Action::Cookies#finish
-    # @see Hanami::Action::Cache#finish
-    # @see Hanami::Action::Head#finish
-    def finish
+    # @see Hanami::Action::Throwable::RACK_ERRORS
+    # @see http://www.rubydoc.info/github/rack/rack/file/SPEC#The_Error_Stream
+    # @see https://github.com/hanami/controller/issues/133
+    RACK_EXCEPTION = 'rack.exception'.freeze
+
+    # The HTTP header for redirects
+    #
+    # @since 0.2.0
+    # @api private
+    LOCATION = 'Location'.freeze
+
+    include StandaloneAction
+
+    def self.inherited(subclass)
+      super
+
+      # When inheriting within an Hanami app, and the application provider has
+      # changed from the superclass, (re-)configure the action for the provider,
+      # i.e. for the slice and/or the application itself
+      if (provider = application_provider(subclass)) && provider != application_provider(subclass.superclass)
+        subclass.include ApplicationAction.new(provider)
+      end
+    end
+
+    def self.application_provider(subclass)
+      if Hanami.respond_to?(:application?) && Hanami.application?
+        Hanami.application.component_provider(subclass)
+      end
     end
+    private_class_method :application_provider
   end
 end

data/lib/hanami/controller/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '1.3.2'.freeze
+    VERSION = '2.0.0.alpha3'.freeze
   end
 end

data/lib/hanami/controller.rb

@@ -1,6 +1,4 @@
-require 'hanami/utils/class_attribute'
 require 'hanami/action'
-require 'hanami/controller/configuration'
 require 'hanami/controller/version'
 require 'hanami/controller/error'
 
@@ -46,230 +44,5 @@ module Hanami
         super("Cannot find a corresponding Mime type for '#{ format }'. Please configure it with Hanami::Controller::Configuration#format.")
       end
     end
-
-    # Missing session error
-    #
-    # This error is raised when an action sends either `session` or `flash` to
-    # itself and it does not include `Hanami::Action::Session`.
-    #
-    # @since 1.2.0
-    #
-    # @see Hanami::Action::Session
-    # @see Hanami::Action#session
-    # @see Hanami::Action#flash
-    class MissingSessionError < Hanami::Controller::Error
-      def initialize(session_method)
-        super("To use `#{session_method}', add `include Hanami::Action::Session`.")
-      end
-    end
-
-    include Utils::ClassAttribute
-
-    # Framework configuration
-    #
-    # @since 0.2.0
-    # @api private
-    class_attribute :configuration
-    self.configuration = Configuration.new
-
-    # Configure the framework.
-    # It yields the given block in the context of the configuration
-    #
-    # @param blk [Proc] the configuration block
-    #
-    # @since 0.2.0
-    #
-    # @see Hanami::Controller::Configuration
-    #
-    # @example
-    #   require 'hanami/controller'
-    #
-    #   Hanami::Controller.configure do
-    #     handle_exceptions false
-    #   end
-    def self.configure(&blk)
-      configuration.instance_eval(&blk)
-    end
-
-    # Duplicate Hanami::Controller in order to create a new separated instance
-    # of the framework.
-    #
-    # The new instance of the framework will be completely decoupled from the
-    # original. It will inherit the configuration, but all the changes that
-    # happen after the duplication, won't be reflected on the other copies.
-    #
-    # @return [Module] a copy of Hanami::Controller
-    #
-    # @since 0.2.0
-    # @api private
-    #
-    # @example Basic usage
-    #   require 'hanami/controller'
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.dupe
-    #   end
-    #
-    #   MyApp::Controller == Hanami::Controller # => false
-    #
-    #   MyApp::Controller.configuration ==
-    #     Hanami::Controller.configuration # => false
-    #
-    # @example Inheriting configuration
-    #   require 'hanami/controller'
-    #
-    #   Hanami::Controller.configure do
-    #     handle_exceptions false
-    #   end
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.dupe
-    #   end
-    #
-    #   module MyApi
-    #     Controller = Hanami::Controller.dupe
-    #     Controller.configure do
-    #       handle_exceptions true
-    #     end
-    #   end
-    #
-    #   Hanami::Controller.configuration.handle_exceptions # => false
-    #   MyApp::Controller.configuration.handle_exceptions # => false
-    #   MyApi::Controller.configuration.handle_exceptions # => true
-    def self.dupe
-      dup.tap do |duplicated|
-        duplicated.configuration = configuration.duplicate
-      end
-    end
-
-    # Duplicate the framework and generate modules for the target application
-    #
-    # @param mod [Module] the Ruby namespace of the application
-    # @param controllers [String] the optional namespace where the application's
-    #   controllers will live
-    # @param blk [Proc] an optional block to configure the framework
-    #
-    # @return [Module] a copy of Hanami::Controller
-    #
-    # @since 0.2.0
-    #
-    # @see Hanami::Controller#dupe
-    # @see Hanami::Controller::Configuration
-    # @see Hanami::Controller::Configuration#action_module
-    #
-    # @example Basic usage
-    #   require 'hanami/controller'
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.duplicate(self)
-    #   end
-    #
-    #   # It will:
-    #   #
-    #   # 1. Generate MyApp::Controller
-    #   # 2. Generate MyApp::Action
-    #   # 3. Generate MyApp::Controllers
-    #   # 4. Configure MyApp::Action as the default module for actions
-    #
-    #  module MyApp::Controllers::Dashboard
-    #    include MyApp::Controller
-    #
-    #    action 'Index' do # this will inject MyApp::Action
-    #      def call(params)
-    #        # ...
-    #      end
-    #    end
-    #  end
-    #
-    # @example Compare code
-    #   require 'hanami/controller'
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.duplicate(self) do
-    #       # ...
-    #     end
-    #   end
-    #
-    #   # it's equivalent to:
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.dupe
-    #     Action     = Hanami::Action.dup
-    #
-    #     module Controllers
-    #     end
-    #
-    #     Controller.configure do
-    #       action_module MyApp::Action
-    #     end
-    #
-    #     Controller.configure do
-    #       # ...
-    #     end
-    #   end
-    #
-    # @example Custom controllers module
-    #   require 'hanami/controller'
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.duplicate(self, 'Ctrls')
-    #   end
-    #
-    #   defined?(MyApp::Controllers) # => nil
-    #   defined?(MyApp::Ctrls)       # => "constant"
-    #
-    #   # Developers can namespace controllers under Ctrls
-    #   module MyApp::Ctrls::Dashboard
-    #     # ...
-    #   end
-    #
-    # @example Nil controllers module
-    #   require 'hanami/controller'
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.duplicate(self, nil)
-    #   end
-    #
-    #   defined?(MyApp::Controllers) # => nil
-    #
-    #   # Developers can namespace controllers under MyApp
-    #   module MyApp::DashboardController
-    #     # ...
-    #   end
-    #
-    # @example Block usage
-    #   require 'hanami/controller'
-    #
-    #   module MyApp
-    #     Controller = Hanami::Controller.duplicate(self) do
-    #       handle_exceptions false
-    #     end
-    #   end
-    #
-    #   Hanami::Controller.configuration.handle_exceptions # => true
-    #   MyApp::Controller.configuration.handle_exceptions # => false
-    def self.duplicate(mod, controllers = 'Controllers', &blk)
-      dupe.tap do |duplicated|
-        mod.module_eval %{ module #{ controllers }; end } if controllers
-        mod.module_eval %{ Action = Hanami::Action.dup }
-
-        duplicated.module_eval %{
-          configure do
-            action_module #{ mod }::Action
-          end
-        }
-
-        duplicated.configure(&blk) if block_given?
-      end
-    end
-
-    # Framework loading entry point
-    #
-    # @return [void]
-    #
-    # @since 0.3.0
-    def self.load!
-      configuration.load!
-    end
   end
 end

data/lib/hanami/http/status.rb

@@ -31,7 +31,7 @@ module Hanami
 
       # Return a status for the given code
       #
-      # @param code [Fixnum] a valid HTTP code
+      # @param code [Integer] a valid HTTP code
       #
       # @return [Array] a pair of code and message for an HTTP status
       #
@@ -48,7 +48,7 @@ module Hanami
 
       # Return a message for the given status code
       #
-      # @param code [Fixnum] a valid HTTP code
+      # @param code [Integer] a valid HTTP code
       #
       # @return [String] a message for the given status code
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-controller
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 2.0.0.alpha3
 platform: ruby
 authors:
 - Luca Guidi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-28 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,14 +30,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.0.alpha
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.0.alpha
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -78,28 +98,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 description: Complete, fast and testable actions for Rack
 email:
 - me@lucaguidi.com
@@ -111,36 +131,34 @@ files:
 - LICENSE.md
 - README.md
 - hanami-controller.gemspec
-- lib/hanami-controller.rb
 - lib/hanami/action.rb
+- lib/hanami/action/application_action.rb
+- lib/hanami/action/application_configuration.rb
+- lib/hanami/action/application_configuration/cookies.rb
+- lib/hanami/action/application_configuration/sessions.rb
 - lib/hanami/action/base_params.rb
 - lib/hanami/action/cache.rb
 - lib/hanami/action/cache/cache_control.rb
 - lib/hanami/action/cache/conditional_get.rb
 - lib/hanami/action/cache/directives.rb
 - lib/hanami/action/cache/expires.rb
-- lib/hanami/action/callable.rb
-- lib/hanami/action/callbacks.rb
-- lib/hanami/action/configurable.rb
+- lib/hanami/action/configuration.rb
 - lib/hanami/action/cookie_jar.rb
 - lib/hanami/action/cookies.rb
-- lib/hanami/action/exposable.rb
-- lib/hanami/action/exposable/guard.rb
+- lib/hanami/action/csrf_protection.rb
 - lib/hanami/action/flash.rb
 - lib/hanami/action/glue.rb
-- lib/hanami/action/head.rb
+- lib/hanami/action/halt.rb
 - lib/hanami/action/mime.rb
 - lib/hanami/action/params.rb
-- lib/hanami/action/rack.rb
-- lib/hanami/action/rack/callable.rb
 - lib/hanami/action/rack/file.rb
-- lib/hanami/action/redirect.rb
 - lib/hanami/action/request.rb
+- lib/hanami/action/response.rb
 - lib/hanami/action/session.rb
-- lib/hanami/action/throwable.rb
+- lib/hanami/action/standalone_action.rb
 - lib/hanami/action/validatable.rb
+- lib/hanami/action/view_name_inferrer.rb
 - lib/hanami/controller.rb
-- lib/hanami/controller/configuration.rb
 - lib/hanami/controller/error.rb
 - lib/hanami/controller/version.rb
 - lib/hanami/http/status.rb
@@ -148,7 +166,7 @@ homepage: http://hanamirb.org
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -156,15 +174,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Complete, fast and testable actions for Rack and Hanami
 test_files: []