hanami-controller 2.0.0.alpha8 → 2.0.0.beta1

data/lib/hanami/action/cache/cache_control.rb

@@ -1,4 +1,6 @@
-require 'hanami/action/cache/directives'
+# frozen_string_literal: true
+
+require "hanami/action/cache/directives"
 
 module Hanami
   class Action
@@ -8,12 +10,6 @@ module Hanami
       # @since 0.3.0
       # @api private
       module CacheControl
-        # The HTTP header for Cache-Control
-        #
-        # @since 0.3.0
-        # @api private
-        HEADER = 'Cache-Control'.freeze
-
         # @since 0.3.0
         # @api private
         def self.included(base)
@@ -37,7 +33,7 @@ module Hanami
           def cache_control_directives
             @cache_control_directives || Object.new.tap do |null_object|
               def null_object.headers
-                ::Hash.new
+                {}
               end
             end
           end
@@ -50,7 +46,10 @@ module Hanami
         #
         # @see Hanami::Action#finish
         def finish(_, res, _)
-          res.headers.merge!(self.class.cache_control_directives.headers) unless res.headers.include? HEADER
+          unless res.headers.include?(Action::CACHE_CONTROL)
+            res.headers.merge!(self.class.cache_control_directives.headers)
+          end
+
           super
         end
 
@@ -59,6 +58,11 @@ module Hanami
         # @since 0.3.0
         # @api private
         class Directives
+          # @since 2.0.0
+          # @api private
+          SEPARATOR = ", "
+          private_constant :SEPARATOR
+
           # @since 0.3.0
           # @api private
           def initialize(*values)
@@ -69,7 +73,7 @@ module Hanami
           # @api private
           def headers
             if @directives.any?
-              { HEADER => @directives.join(', ') }
+              {Action::CACHE_CONTROL => @directives.join(SEPARATOR)}
             else
               {}
             end

data/lib/hanami/action/cache/conditional_get.rb

@@ -1,28 +1,10 @@
+# frozen_string_literal: true
+
 require "hanami/utils/blank"
 
 module Hanami
   class Action
     module Cache
-      # @since 0.3.0
-      # @api private
-      IF_NONE_MATCH = 'HTTP_IF_NONE_MATCH'.freeze
-
-      # The HTTP header for ETag
-      #
-      # @since 0.3.0
-      # @api private
-      ETAG          = 'ETag'.freeze
-
-      # @since 0.3.0
-      # @api private
-      IF_MODIFIED_SINCE = 'HTTP_IF_MODIFIED_SINCE'.freeze
-
-      # The HTTP header for Last-Modified
-      #
-      # @since 0.3.0
-      # @api private
-      LAST_MODIFIED = 'Last-Modified'.freeze
-
       # ETag value object
       #
       # @since 0.3.0
@@ -43,7 +25,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def header
-          { ETAG => @value } if @value
+          {Action::ETAG => @value} if @value
         end
 
         private
@@ -51,7 +33,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def none_match
-          @env[IF_NONE_MATCH]
+          @env[Action::IF_NONE_MATCH]
         end
       end
 
@@ -78,7 +60,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def header
-          { LAST_MODIFIED => @value.httpdate } if @value && @value.respond_to?(:httpdate)
+          {Action::LAST_MODIFIED => @value.httpdate} if @value.respond_to?(:httpdate)
         end
 
         private
@@ -86,7 +68,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def modified_since
-          @env[IF_MODIFIED_SINCE]
+          @env[Action::IF_MODIFIED_SINCE]
         end
       end
 
@@ -99,7 +81,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def initialize(env, options)
-          @validations = [ ETag.new(env, options[:etag]), LastModified.new(env, options[:last_modified]) ]
+          @validations = [ETag.new(env, options[:etag]), LastModified.new(env, options[:last_modified])]
         end
 
         # @since 0.3.0
@@ -111,7 +93,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def headers
-          @validations.map(&:header).compact.reduce Hash.new, :merge
+          @validations.map(&:header).compact.reduce({}, :merge)
         end
       end
     end

data/lib/hanami/action/cache/directives.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Hanami
   class Action
     module Cache
@@ -5,13 +7,13 @@ module Hanami
       #
       # @since 0.3.0
       # @api private
-      VALUE_DIRECTIVES      = %i(max_age s_maxage min_fresh max_stale).freeze
+      VALUE_DIRECTIVES      = %i[max_age s_maxage min_fresh max_stale].freeze
 
       # Cache-Control directives which are implicitly true
       #
       # @since 0.3.0
       # @api private
-      NON_VALUE_DIRECTIVES  = %i(public private no_cache no_store no_transform must_revalidate proxy_revalidate).freeze
+      NON_VALUE_DIRECTIVES  = %i[public private no_cache no_store no_transform must_revalidate proxy_revalidate].freeze
 
       # Class representing value directives
       #
@@ -63,7 +65,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def to_str
-          @name.to_s.tr('_', '-')
+          @name.to_s.tr("_", "-")
         end
 
         # @since 0.3.0
@@ -85,7 +87,7 @@ module Hanami
         def initialize(*values)
           @directives = []
           values.each do |directive_key|
-            if directive_key.kind_of? Hash
+            if directive_key.is_a? Hash
               directive_key.each { |name, value| self.<< ValueDirective.new(name, value) }
             else
               self.<< NonValueDirective.new(directive_key)
@@ -95,8 +97,8 @@ module Hanami
 
         # @since 0.3.0
         # @api private
-        def each
-          @directives.each { |d| yield d }
+        def each(&block)
+          @directives.each(&block)
         end
 
         # @since 0.3.0

data/lib/hanami/action/cache/expires.rb

@@ -1,4 +1,6 @@
-require 'hanami/action/cache/cache_control'
+# frozen_string_literal: true
+
+require "hanami/action/cache/cache_control"
 
 module Hanami
   class Action
@@ -8,12 +10,6 @@ module Hanami
       # @since 0.3.0
       # @api private
       module Expires
-        # The HTTP header for Expires
-        #
-        # @since 0.3.0
-        # @api private
-        HEADER = 'Expires'.freeze
-
         # @since 0.3.0
         # @api private
         def self.included(base)
@@ -37,7 +33,7 @@ module Hanami
           def expires_directives
             @expires_directives || Object.new.tap do |null_object|
               def null_object.headers
-                Hash.new
+                {}
               end
             end
           end
@@ -50,7 +46,10 @@ module Hanami
         #
         # @see Hanami::Action#finish
         def finish(_, res, _)
-          res.headers.merge!(self.class.expires_directives.headers) unless res.headers.include? HEADER
+          unless res.headers.include?(Action::EXPIRES)
+            res.headers.merge!(self.class.expires_directives.headers)
+          end
+
           super
         end
 
@@ -63,13 +62,13 @@ module Hanami
           # @api private
           def initialize(amount, *values)
             @amount = amount
-            @cache_control = Hanami::Action::Cache::CacheControl::Directives.new(*(values << { max_age: amount }))
+            @cache_control = Hanami::Action::Cache::CacheControl::Directives.new(*(values << {max_age: amount}))
           end
 
           # @since 0.3.0
           # @api private
           def headers
-            { HEADER => time.httpdate }.merge(@cache_control.headers)
+            {Action::EXPIRES => time.httpdate}.merge(@cache_control.headers)
           end
 
           private

data/lib/hanami/action/cache.rb

@@ -1,6 +1,8 @@
-require 'hanami/action/cache/cache_control'
-require 'hanami/action/cache/expires'
-require 'hanami/action/cache/conditional_get'
+# frozen_string_literal: true
+
+require "hanami/action/cache/cache_control"
+require "hanami/action/cache/expires"
+require "hanami/action/cache/conditional_get"
 
 module Hanami
   class Action

data/lib/hanami/action/configuration.rb

@@ -90,9 +90,9 @@ module Hanami
       # @since 0.2.0
       # @api private
       DEFAULT_FORMATS = {
-        'application/octet-stream' => :all,
-        '*/*'                      => :all,
-        'text/html'                => :html
+        "application/octet-stream" => :all,
+        "*/*" => :all,
+        "text/html" => :html
       }.freeze
 
       # @!method formats=(formats)
@@ -211,7 +211,7 @@ module Hanami
       #   @see default_request_format=
       #
       #   @since 0.5.0
-      setting :default_request_format, constructor: -> format {
+      setting :default_request_format, constructor: -> (format) {
         Utils::Kernel.Symbol(format) unless format.nil?
       }
 
@@ -243,7 +243,7 @@ module Hanami
       #   @see default_request_format=
       #
       #   @since 0.5.0
-      setting :default_response_format, constructor: -> format {
+      setting :default_response_format, constructor: -> (format) {
         Utils::Kernel.Symbol(format) unless format.nil?
       }
 
@@ -288,7 +288,7 @@ module Hanami
       #   @see default_headers
       #
       #   @example
-      #     configuration.default_headers = {'X-Frame-Options' => 'DENY'}
+      #     configuration.default_headers = {"X-Frame-Options" => "DENY"}
       #
       # @!method default_headers
       #
@@ -299,7 +299,7 @@ module Hanami
       #   @since 0.4.0
       #
       #   @see default_headers=
-      setting :default_headers, default: {}, constructor: -> headers { headers.compact }
+      setting :default_headers, default: {}, constructor: -> (headers) { headers.compact }
 
       # @!method cookies=(cookie_options)
       #
@@ -315,8 +315,8 @@ module Hanami
       #
       #   @example
       #     configuration.cookies = {
-      #       domain: 'hanamirb.org',
-      #       path: '/controller',
+      #       domain: "hanamirb.org",
+      #       path: "/controller",
       #       secure: true,
       #       httponly: true
       #     }
@@ -330,7 +330,7 @@ module Hanami
       #   @since 0.4.0
       #
       #   @see cookies=
-      setting :cookies, default: {}, constructor: -> cookie_options {
+      setting :cookies, default: {}, constructor: -> (cookie_options) {
         # Call `to_h` here to permit `ApplicationConfiguration::Cookies` object to be
         # provided when application actions are configured
         cookie_options.to_h.compact
@@ -362,7 +362,7 @@ module Hanami
       #   @since 1.0.0
       #
       #   @api private
-      setting :root_directory, constructor: -> dir {
+      setting :root_directory, constructor: -> (dir) {
         dir ||= Dir.pwd
 
         Pathname(dir).realpath
@@ -375,7 +375,7 @@ module Hanami
       # @since 1.0.0
       #
       # @api private
-      DEFAULT_PUBLIC_DIRECTORY = 'public'.freeze
+      DEFAULT_PUBLIC_DIRECTORY = "public"
 
       # @!method public_directory=(directory)
       #
@@ -389,6 +389,8 @@ module Hanami
       #
       #   @return [void]
       #
+      #   @since 2.0.0
+      #
       #   @see root_directory
       #   @see public_directory
       setting :public_directory, default: DEFAULT_PUBLIC_DIRECTORY
@@ -403,6 +405,8 @@ module Hanami
       #   configuration.public_directory
       #   # => "/path/to/root/public"
       #
+      # @since 2.0.0
+      #
       # @see public_directory=
       # @see root_directory=
       def public_directory
@@ -412,6 +416,8 @@ module Hanami
 
       private
 
+      # @since 2.0.0
+      # @api private
       def method_missing(name, *args, &block)
         if config.respond_to?(name)
           config.public_send(name, *args, &block)
@@ -420,6 +426,8 @@ module Hanami
         end
       end
 
+      # @since 2.0.0
+      # @api private
       def respond_to_missing?(name, _incude_all = false)
         config.respond_to?(name) || super
       end

data/lib/hanami/action/constants.rb

@@ -0,0 +1,261 @@
+# frozen_string_literal: true
+
+require "rack"
+
+module Hanami
+  class Action
+    # Rack SPEC response code
+    #
+    # @since 1.0.0
+    # @api private
+    RESPONSE_CODE = 0
+
+    # Rack SPEC response headers
+    #
+    # @since 1.0.0
+    # @api private
+    RESPONSE_HEADERS = 1
+
+    # Rack SPEC response body
+    #
+    # @since 1.0.0
+    # @api private
+    RESPONSE_BODY = 2
+
+    # @since 1.0.0
+    # @api private
+    DEFAULT_ERROR_CODE = 500
+
+    # Status codes that by RFC must not include a message body
+    #
+    # @since 0.3.2
+    # @api private
+    HTTP_STATUSES_WITHOUT_BODY = Set.new((100..199).to_a << 204 << 205 << 304).freeze
+
+    # Not Found
+    #
+    # @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).
+    #
+    # "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
+
+    # The request relative path
+    #
+    # @since 2.0.0
+    # @api private
+    PATH_INFO = ::Rack::PATH_INFO
+
+    # The request method
+    #
+    # @since 0.3.2
+    # @api private
+    REQUEST_METHOD = ::Rack::REQUEST_METHOD
+
+    # The Content-Length HTTP header
+    #
+    # @since 1.0.0
+    # @api private
+    CONTENT_LENGTH = ::Rack::CONTENT_LENGTH
+
+    # The non-standard HTTP header to pass the control over when a resource
+    # cannot be found by the current endpoint
+    #
+    # @since 1.0.0
+    # @api private
+    X_CASCADE = "X-Cascade"
+
+    # HEAD request
+    #
+    # @since 0.3.2
+    # @api private
+    HEAD = ::Rack::HEAD
+
+    # GET request
+    #
+    # @since 2.0.0
+    # @api private
+    GET = ::Rack::GET
+
+    # TRACE request
+    #
+    # @since 2.0.0
+    # @api private
+    TRACE = ::Rack::TRACE
+
+    # OPTIONS request
+    #
+    # @since 2.0.0
+    # @api private
+    OPTIONS = ::Rack::OPTIONS
+
+    # The key that returns accepted mime types from the Rack env
+    #
+    # @since 0.1.0
+    # @api private
+    HTTP_ACCEPT          = "HTTP_ACCEPT"
+
+    # The header key to set the mime type of the response
+    #
+    # @since 0.1.0
+    # @api private
+    CONTENT_TYPE         = ::Rack::CONTENT_TYPE
+
+    # The default mime type for an incoming HTTP request
+    #
+    # @since 0.1.0
+    # @api private
+    DEFAULT_ACCEPT       = "*/*"
+
+    # The default mime type that is returned in the response
+    #
+    # @since 0.1.0
+    # @api private
+    DEFAULT_CONTENT_TYPE = "application/octet-stream"
+
+    # @since 0.2.0
+    # @api private
+    RACK_ERRORS = ::Rack::RACK_ERRORS
+
+    # The HTTP header for Cache-Control
+    #
+    # @since 2.0.0
+    # @api private
+    CACHE_CONTROL = ::Rack::CACHE_CONTROL
+
+    # @since 2.0.0
+    # @api private
+    IF_NONE_MATCH = "HTTP_IF_NONE_MATCH"
+
+    # The HTTP header for ETag
+    #
+    # @since 2.0.0
+    # @api private
+    ETAG          = ::Rack::ETAG
+
+    # @since 2.0.0
+    # @api private
+    IF_MODIFIED_SINCE = "HTTP_IF_MODIFIED_SINCE"
+
+    # The HTTP header for Expires
+    #
+    # @since 2.0.0
+    # @api private
+    EXPIRES = ::Rack::EXPIRES
+
+    # The HTTP header for Last-Modified
+    #
+    # @since 0.3.0
+    # @api private
+    LAST_MODIFIED = "Last-Modified"
+
+    # 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::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"
+
+    # The HTTP header for redirects
+    #
+    # @since 0.2.0
+    # @api private
+    LOCATION = "Location"
+
+    # The key that returns Rack session params from the Rack env
+    # Please note that this is used only when an action is unit tested.
+    #
+    # @since 2.0.0
+    # @api private
+    #
+    # @example
+    #   # action unit test
+    #   action.call("rack.session" => { "foo" => "bar" })
+    #   action.session[:foo] # => "bar"
+    #
+    # @api private
+    RACK_SESSION = ::Rack::RACK_SESSION
+
+    # @since 2.0.0
+    # @api private
+    REQUEST_ID = "hanami.request_id"
+
+    # @since 2.0.0
+    # @api private
+    DEFAULT_ID_LENGTH = 16
+
+    # The key that returns raw cookies from the Rack env
+    #
+    # @since 2.0.0
+    # @api private
+    HTTP_COOKIE = ::Rack::HTTP_COOKIE
+
+    # The key used by Rack to set the cookies as an Hash in the env
+    #
+    # @since 2.0.0
+    # @api private
+    COOKIE_HASH_KEY   = ::Rack::RACK_REQUEST_COOKIE_HASH
+
+    # The key used by Rack to set the cookies as a String in the env
+    #
+    # @since 2.0.0
+    # @api private
+    COOKIE_STRING_KEY = ::Rack::RACK_REQUEST_COOKIE_STRING
+
+    # The key that returns raw input from the Rack env
+    #
+    # @since 2.0.0
+    # @api private
+    RACK_INPUT    = ::Rack::RACK_INPUT
+
+    # The key that returns router params from the Rack env
+    # This is a builtin integration for Hanami::Router
+    #
+    # @since 2.0.0
+    # @api private
+    ROUTER_PARAMS = "router.params"
+
+    # Default HTTP request method for Rack env
+    #
+    # @since 2.0.0
+    # @api private
+    DEFAULT_REQUEST_METHOD = GET
+
+    # @since 2.0.0
+    # @api private
+    DEFAULT_CHARSET      = "utf-8"
+
+    # The key that returns content mime type from the Rack env
+    #
+    # @since 2.0.0
+    # @api private
+    HTTP_CONTENT_TYPE    = "CONTENT_TYPE"
+  end
+end