hanami-controller 1.3.3 → 2.0.0.alpha1

data/lib/hanami/action/base_params.rb

@@ -2,7 +2,7 @@ require 'rack/request'
 require 'hanami/utils/hash'
 
 module Hanami
-  module Action
+  class Action
     class BaseParams
       # The key that returns raw input from the Rack env
       #
@@ -173,7 +173,7 @@ module Hanami
       def _router_params(fallback = {})
         env.fetch(ROUTER_PARAMS) do
           if session = fallback.delete(RACK_SESSION) # rubocop:disable Lint/AssignmentInCondition
-            fallback[RACK_SESSION] = Utils::Hash.new(session).symbolize!.to_hash
+            fallback[RACK_SESSION] = Utils::Hash.deep_symbolize(session)
           end
 
           fallback

data/lib/hanami/action/cache.rb

@@ -3,7 +3,7 @@ require 'hanami/action/cache/expires'
 require 'hanami/action/cache/conditional_get'
 
 module Hanami
-  module Action
+  class Action
     # Cache type API
     #
     # @since 0.3.0
@@ -26,144 +26,6 @@ module Hanami
           include CacheControl, Expires
         end
       end
-
-      protected
-
-      # Specify response freshness policy for HTTP caches (Cache-Control header).
-      # Any number of non-value directives (:public, :private, :no_cache,
-      # :no_store, :must_revalidate, :proxy_revalidate) may be passed along with
-      # a Hash of value directives (:max_age, :min_stale, :s_max_age).
-      #
-      # See RFC 2616 / 14.9 for more on standard cache control directives:
-      # http://tools.ietf.org/html/rfc2616#section-14.9.1
-      #
-      # @param values [Array<Symbols, Hash>] mapped to cache_control directives
-      # @option values [Symbol] :public
-      # @option values [Symbol] :private
-      # @option values [Symbol] :no_cache
-      # @option values [Symbol] :no_store
-      # @option values [Symbol] :must_validate
-      # @option values [Symbol] :proxy_revalidate
-      # @option values [Hash] :max_age
-      # @option values [Hash] :min_stale
-      # @option values [Hash] :s_max_age
-      #
-      # @return void
-      #
-      # @since 0.3.0
-      #
-      # @example
-      #   require 'hanami/controller'
-      #   require 'hanami/action/cache'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #     include Hanami::Action::Cache
-      #
-      #     def call(params)
-      #       # ...
-      #
-      #       # set Cache-Control directives
-      #       cache_control :public, max_age: 900, s_maxage: 86400
-      #
-      #       # overwrite previous Cache-Control directives
-      #       cache_control :private, :no_cache, :no_store
-      #
-      #       => Cache-Control: private, no-store, max-age=900
-      #
-      #     end
-      #   end
-      def cache_control(*values)
-        cache_control = CacheControl::Directives.new(*values)
-        headers.merge!(cache_control.headers)
-      end
-
-      # Set the Expires header and Cache-Control/max-age directive. Amount
-      # can be an integer number of seconds in the future or a Time object
-      # indicating when the response should be considered "stale". The remaining
-      # "values" arguments are passed to the #cache_control helper:
-      #
-      # @param amount [Integer,Time] number of seconds or point in time
-      # @param values [Array<Symbols>] mapped to cache_control directives
-      #
-      # @return void
-      #
-      # @since 0.3.0
-      #
-      # @example
-      #   require 'hanami/controller'
-      #   require 'hanami/action/cache'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #     include Hanami::Action::Cache
-      #
-      #     def call(params)
-      #       # ...
-      #
-      #       # set Cache-Control directives and Expires
-      #       expires 900, :public
-      #
-      #       # overwrite Cache-Control directives and Expires
-      #       expires 300, :private, :no_cache, :no_store
-      #
-      #       => Expires: Thu, 26 Jun 2014 12:00:00 GMT
-      #       => Cache-Control: private, no-cache, no-store max-age=300
-      #
-      #     end
-      #   end
-      def expires(amount, *values)
-        expires = Expires::Directives.new(amount, *values)
-        headers.merge!(expires.headers)
-      end
-
-      # Set the etag, last_modified, or both headers on the response
-      # and halts a 304 Not Modified if the request is still fresh
-      # respecting IfNoneMatch and IfModifiedSince request headers
-      #
-      # @param options [Hash]
-      # @option options [Integer] :etag for testing IfNoneMatch conditions
-      # @option options [Date] :last_modified for testing IfModifiedSince conditions
-      #
-      # @return void
-      #
-      # @since 0.3.0
-      #
-      # @example
-      #   require 'hanami/controller'
-      #   require 'hanami/action/cache'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #     include Hanami::Action::Cache
-      #
-      #     def call(params)
-      #       # ...
-      #
-      #       # set etag response header and halt 304
-      #       # if request matches IF_NONE_MATCH header
-      #       fresh etag: @resource.updated_at.to_i
-      #
-      #       # set last_modified response header and halt 304
-      #       # if request matches IF_MODIFIED_SINCE
-      #       fresh last_modified: @resource.updated_at
-      #
-      #       # set etag and last_modified response header,
-      #       # halt 304 if request matches IF_MODIFIED_SINCE
-      #       # and IF_NONE_MATCH
-      #       fresh last_modified: @resource.updated_at
-      #
-      #     end
-      #   end
-      def fresh(options)
-        conditional_get = ConditionalGet.new(@_env, options)
-
-        headers.merge!(conditional_get.headers)
-
-        conditional_get.fresh? do
-          halt 304
-        end
-      end
     end
   end
 end

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

@@ -1,7 +1,7 @@
 require 'hanami/action/cache/directives'
 
 module Hanami
-  module Action
+  class Action
     module Cache
       # Module with Cache-Control logic
       #
@@ -37,7 +37,7 @@ module Hanami
           def cache_control_directives
             @cache_control_directives || Object.new.tap do |null_object|
               def null_object.headers
-                Hash.new
+                ::Hash.new
               end
             end
           end
@@ -49,9 +49,9 @@ module Hanami
         # @api private
         #
         # @see Hanami::Action#finish
-        def finish
+        def finish(_, res, _)
+          res.headers.merge!(self.class.cache_control_directives.headers) unless res.headers.include? HEADER
           super
-          headers.merge!(self.class.cache_control_directives.headers) unless headers.include? HEADER
         end
 
         # Class which stores CacheControl values

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

@@ -1,5 +1,7 @@
+require "hanami/utils/blank"
+
 module Hanami
-  module Action
+  class Action
     module Cache
       # @since 0.3.0
       # @api private
@@ -67,10 +69,7 @@ module Hanami
         # @since 0.3.0
         # @api private
         def fresh?
-          return false if Hanami::Utils::Blank.blank?(modified_since)
-          return false if Hanami::Utils::Blank.blank?(@value)
-
-          Time.httpdate(modified_since).to_i >= @value.to_time.to_i
+          !Hanami::Utils::Blank.blank?(modified_since) && Time.httpdate(modified_since).to_i >= @value.to_time.to_i
         end
 
         # @since 0.3.0

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

@@ -1,5 +1,5 @@
 module Hanami
-  module Action
+  class Action
     module Cache
       # Cache-Control directives which have values
       #

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

@@ -1,7 +1,7 @@
 require 'hanami/action/cache/cache_control'
 
 module Hanami
-  module Action
+  class Action
     module Cache
       # Module with Expires logic
       #
@@ -49,9 +49,9 @@ module Hanami
         # @api private
         #
         # @see Hanami::Action#finish
-        def finish
+        def finish(_, res, _)
+          res.headers.merge!(self.class.expires_directives.headers) unless res.headers.include? HEADER
           super
-          headers.merge!(self.class.expires_directives.headers) unless headers.include? HEADER
         end
 
         # Class which stores Expires directives

data/lib/hanami/action/cookie_jar.rb

@@ -1,7 +1,7 @@
 require 'hanami/utils/hash'
 
 module Hanami
-  module Action
+  class Action
     # A set of HTTP Cookies
     #
     # It acts as an Hash
@@ -55,7 +55,7 @@ module Hanami
       # @since 0.1.0
       def initialize(env, headers, default_options)
         @_headers        = headers
-        @cookies         = Utils::Hash.new(extract(env)).deep_symbolize!
+        @cookies         = Utils::Hash.deep_symbolize(extract(env))
         @default_options = default_options
       end
 
@@ -166,7 +166,7 @@ module Hanami
       # @since 0.4.0
       # @api private
       def _merge_default_values(value)
-        cookies_options = if value.is_a? Hash
+        cookies_options = if value.is_a?(::Hash)
           value.merge! _add_expires_option(value)
         else
           { value: value }

data/lib/hanami/action/cookies.rb

@@ -1,7 +1,5 @@
-require 'hanami/action/cookie_jar'
-
 module Hanami
-  module Action
+  class Action
     # Cookies API
     #
     # This module isn't included by default.
@@ -10,63 +8,6 @@ module Hanami
     #
     # @see Hanami::Action::Cookies#cookies
     module Cookies
-      protected
-
-      # Gets the cookies from the request and expose them as an Hash
-      #
-      # It automatically sets options from global configuration, but it allows to
-      # override values case by case.
-      #
-      # For a list of options please have a look at <tt>Hanami::Controller::Configuration</tt>,
-      # and <tt>Hanami::Action::CookieJar</tt>.
-      #
-      # @return [Hanami::Action::CookieJar] cookies
-      #
-      # @since 0.1.0
-      #
-      # @see Hanami::Controller::Configuration#cookies
-      # @see Hanami::Action::CookieJar#[]=
-      #
-      # @example Basic Usage
-      #   require 'hanami/controller'
-      #   require 'hanami/action/cookies'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #     include Hanami::Action::Cookies
-      #
-      #     def call(params)
-      #       # ...
-      #
-      #       # get a value
-      #       cookies[:user_id] # => '23'
-      #
-      #       # set a value
-      #       cookies[:foo] = 'bar'
-      #
-      #       # remove a value
-      #       cookies[:bax] = nil
-      #     end
-      #   end
-      #
-      # @example Cookies Options
-      #   require 'hanami/controller'
-      #   require 'hanami/action/cookies'
-      #
-      #   class Show
-      #     include Hanami::Action
-      #     include Hanami::Action::Cookies
-      #
-      #     def call(params)
-      #       # ...
-      #       # set a value
-      #       cookies[:foo] = { value: 'bar', max_age: 300, path: '/dashboard' }
-      #     end
-      #   end
-      def cookies
-        @cookies ||= CookieJar.new(@_env.dup, headers, configuration.cookies)
-      end
-
       private
 
       # Finalize the response by flushing cookies into the response
@@ -75,9 +16,9 @@ module Hanami
       # @api private
       #
       # @see Hanami::Action#finish
-      def finish
+      def finish(req, res, *)
+        res.cookies.finish
         super
-        cookies.finish
       end
     end
   end

data/lib/hanami/action/flash.rb

@@ -1,7 +1,7 @@
 require 'hanami/utils/json'
 
 module Hanami
-  module Action
+  class Action
     # Container useful to transport data with the HTTP session
     # It has a life span of one HTTP request or redirect.
     #
@@ -263,7 +263,7 @@ module Hanami
       # @since 1.3.0
       # @api private
       def is_hash?(data)
-        data && data.is_a?(Hash)
+        data && data.is_a?(::Hash)
       end
     end
   end

data/lib/hanami/action/glue.rb

@@ -1,5 +1,5 @@
 module Hanami
-  module Action
+  class Action
     # Glue code for full stack Hanami applications
     #
     # This includes missing rendering logic that it makes sense to include
@@ -14,43 +14,17 @@ module Hanami
       # @since 0.3.0
       ENV_KEY = 'hanami.action'.freeze
 
-      # @api private
-      # @since 0.3.2
-      ADDITIONAL_HTTP_STATUSES_WITHOUT_BODY = Set.new([301, 302]).freeze
-
-      # Override Ruby's Module#included
-      #
-      # @api private
-      # @since 0.3.0
-      def self.included(base)
-        base.class_eval { _expose(:format) if respond_to?(:_expose) }
-      end
-
-      # Check if the current HTTP request is renderable.
-      #
-      # It verifies if the verb isn't HEAD, if the status demands to omit
-      # the body and if it isn't sending a file.
-      #
-      # @return [TrueClass,FalseClass] the result of the check
-      #
-      # @api private
-      # @since 0.3.2
-      def renderable?
-        !_requires_no_body? &&
-          !sending_file?    &&
-          !ADDITIONAL_HTTP_STATUSES_WITHOUT_BODY.include?(@_status)
-      end
-
       protected
+
       # Put the current instance into the Rack environment
       #
       # @api private
       # @since 0.3.0
       #
       # @see Hanami::Action#finish
-      def finish
+      def finish(req, *)
+        req.env[ENV_KEY] = self
         super
-        @_env[ENV_KEY] = self
       end
 
       # Check if the request's body is a file
@@ -59,7 +33,7 @@ module Hanami
       #
       # @since 0.4.3
       def sending_file?
-        @_body.is_a?(::Rack::File::Iterator)
+        response.body.is_a?(::Rack::File::Iterator)
       end
     end
   end

data/lib/hanami/action/halt.rb

@@ -0,0 +1,12 @@
+require "hanami/http/status"
+
+module Hanami
+  class Action
+    module Halt
+      def self.call(status, body = nil)
+        body ||= Http::Status.message_for(status)
+        throw :halt, [status, body]
+      end
+    end
+  end
+end