hanami-controller 2.0.1 → 2.1.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19de4a7e13f8845b766110c62f3fafef0d600cdc7e2ae12c0083f73f91fa0224
-  data.tar.gz: fe8adf8eaff82024d6dcdfaff5e7e0a41c210e138419807af89a74babc10a6d4
+  metadata.gz: 58299df4276e04c035c82a7afcf6c012bd5059213d5fcc375ecc2e001900aa9b
+  data.tar.gz: 9c7d4d3a80766da72364f2eee2d6909785a70ef9c63f6e1739d46af11bd9e49b
 SHA512:
-  metadata.gz: 85493e28f9f323982bffd69c89e2ffeceaed9d284f21776f118e36cfc6b52ce7355e450c37d67212fc2bc135d60925a2bb7287f123892fabc81148fba076e1ec
-  data.tar.gz: 37a1e25fd2ea272ef88f203f001830729c40102462be05681a3669c38ece703827948f08d901f2ad93092739b546a23b8714dd79452466be49619e72bf3e9fe3
+  metadata.gz: 63d21bbd06003cac35e8b12d94fb829bdaf9a95164b948a7059aab745cb49ca8b9f100b7ac27a244a9cd9c4e9c1db6a1c7cb0c279859e6bf56eb75aa846bfd1c
+  data.tar.gz: a04360570cf34f82caff342a04a2d46ca55c951c3aa718c1c15d0ff723f79b9b87b56e8e8ec57489a9f4d06a10ec35ad7f1681b9e6695aa393943a97c191fc99

data/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 Complete, fast and testable actions for Rack
 
+## v2.1.0.beta1 - 2023-06-29
+
+### Added
+
+- [Tim Riley] Add `Request#session_enabled?` and `Response#session_enabled?` (#423)
+
+## v2.0.2 - 2023-02-01
+
+### Added
+
+- [Adam Lassek] Params Pattern Matching
+- [Adam Lassek, Luca Guidi] Allow to `halt` using a `Symbol`: `halt :unauthorized`
+- [Adam Lassek, Luca Guidi] Introduce `Hanami::Action::Response#status=` to accept an `Integer` or a `Symbol`
+
+### Fixed
+
+- [Pat Allan] Ensure action accepting the request with a custom MIME Type
+- [Luca Guidi] Halting with an unknown HTTP code will raise a `Hanami::Action::UnknownHttpStatusError`
+- [Luca Guidi] Fix error message for missing format (MIME Type)
+
 ## v2.0.1 - 2022-12-25
 
 ### Added

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright © 2014-2021 Luca Guidi
+Copyright © 2014 Hanami Team
 
 MIT License
 

data/README.md

@@ -961,4 +961,4 @@ __Hanami::Controller__ uses [Semantic Versioning 2.0.0](http://semver.org)
 
 ## Copyright
 
-Copyright © 2014-2022 Hanami Team – Released under MIT License
+Copyright © 2014 Hanami Team – Released under MIT License

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

@@ -88,9 +88,9 @@ module Hanami
           @directives = []
           values.each do |directive_key|
             if directive_key.is_a? Hash
-              directive_key.each { |name, value| self.<< ValueDirective.new(name, value) }
+              directive_key.each { |name, value| self << ValueDirective.new(name, value) }
             else
-              self.<< NonValueDirective.new(directive_key)
+              self << NonValueDirective.new(directive_key)
             end
           end
         end

data/lib/hanami/action/errors.rb

@@ -9,6 +9,20 @@ module Hanami
     class Error < ::StandardError
     end
 
+    # Unknown status HTTP Status error
+    #
+    # @since 2.0.2
+    #
+    # @see Hanami::Action::Response#status=
+    # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+    class UnknownHttpStatusError < Error
+      # @since 2.0.2
+      # @api private
+      def initialize(code)
+        super("unknown HTTP status: `#{code.inspect}'")
+      end
+    end
+
     # Unknown format error
     #
     # This error is raised when a action sets a format that it isn't recognized
@@ -21,14 +35,26 @@ module Hanami
       # @since 2.0.0
       # @api private
       def initialize(format)
-        msg =
-          if format.to_s != "" # rubocop:disable Style/NegatedIfElseCondition
-            "Cannot find a corresponding MIME type for format #{format.inspect}. Configure one via `config.formats.add(#{format}: \"MIME_TYPE_HERE\")`." # rubocop:disable Layout/LineLength
-          else
-            "Cannot find a corresponding MIME type for `nil` format."
-          end
+        message = <<~MSG
+          Cannot find a corresponding MIME type for format `#{format.inspect}'.
+        MSG
+
+        unless blank?(format)
+          message += <<~MSG
+
+            Configure one via: `config.actions.formats.add(:#{format}, "MIME_TYPE_HERE")' in `config/app.rb' to share between actions of a Hanami app.
+
+            Or make it available only in the current action: `config.formats.add(:#{format}, "MIME_TYPE_HERE")'.
+          MSG
+        end
+
+        super(message)
+      end
+
+      private
 
-        super(msg)
+      def blank?(format)
+        format.to_s.match(/\A[[:space:]]*\z/)
       end
     end
 

data/lib/hanami/action/halt.rb

@@ -10,8 +10,8 @@ module Hanami
       # @api private
       # @since 2.0.0
       def self.call(status, body = nil)
-        body ||= Http::Status.message_for(status)
-        throw :halt, [status, body]
+        code, message = Http::Status.for_code(status)
+        throw :halt, [code, body || message]
       end
     end
   end

data/lib/hanami/action/mime.rb

@@ -237,7 +237,7 @@ module Hanami
         # @api private
         def accepted_mime_type?(mime_type, config)
           accepted_mime_types(config).any? { |accepted_mime_type|
-            ::Rack::Mime.match?(accepted_mime_type, mime_type)
+            ::Rack::Mime.match?(mime_type, accepted_mime_type)
           }
         end
 

data/lib/hanami/action/params.rb

@@ -243,6 +243,15 @@ module Hanami
         @params
       end
       alias_method :to_hash, :to_h
+
+      # Pattern-matching support
+      #
+      # @return [::Hash]
+      #
+      # @since 2.0.2
+      def deconstruct_keys(*)
+        to_hash
+      end
     end
   end
 end

data/lib/hanami/action/request.rb

@@ -29,11 +29,11 @@ module Hanami
 
       # @since 2.0.0
       # @api private
-      def initialize(env:, params:, sessions_enabled: false)
+      def initialize(env:, params:, session_enabled: false)
         super(env)
 
         @params = params
-        @sessions_enabled = sessions_enabled
+        @session_enabled = session_enabled
       end
 
       # Returns the request's ID
@@ -47,18 +47,29 @@ module Hanami
         @id ||= @env[Action::REQUEST_ID] = SecureRandom.hex(Action::DEFAULT_ID_LENGTH)
       end
 
+      # Returns true if the session is enabled for the request.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      # @since 2.1.0
+      def session_enabled?
+        @session_enabled
+      end
+
       # Returns the session for the request.
       #
       # @return [Hash] the session object
       #
-      # @raise [MissingSessionError] if sessions are not enabled
+      # @raise [MissingSessionError] if the session is not enabled
       #
+      # @see #session_enabled?
       # @see Response#session
       #
       # @since 2.0.0
       # @api public
       def session
-        unless @sessions_enabled
+        unless session_enabled?
           raise Hanami::Action::MissingSessionError.new("Hanami::Action::Request#session")
         end
 
@@ -76,7 +87,7 @@ module Hanami
       # @since 2.0.0
       # @api public
       def flash
-        unless @sessions_enabled
+        unless session_enabled?
           raise Hanami::Action::MissingSessionError.new("Hanami::Action::Request#flash")
         end
 

data/lib/hanami/action/response.rb

@@ -48,7 +48,7 @@ module Hanami
 
       # @since 2.0.0
       # @api private
-      def initialize(request:, config:, content_type: nil, env: {}, headers: {}, view_options: nil, sessions_enabled: false) # rubocop:disable Layout/LineLength, Metrics/ParameterLists
+      def initialize(request:, config:, content_type: nil, env: {}, headers: {}, view_options: nil, session_enabled: false) # rubocop:disable Layout/LineLength, Metrics/ParameterLists
         super([], 200, headers.dup)
         self.content_type = content_type if content_type
 
@@ -59,7 +59,7 @@ module Hanami
         @env = env
         @view_options = view_options || DEFAULT_VIEW_OPTIONS
 
-        @sessions_enabled = sessions_enabled
+        @session_enabled = session_enabled
         @sending_file = false
       end
 
@@ -81,6 +81,27 @@ module Hanami
         end
       end
 
+      # Set the response status
+      #
+      # @param code [Integer, Symbol] the status code
+      #
+      # @since 2.0.2
+      # @api public
+      #
+      # @raise [Hanami::Action::UnknownHttpStatusError] if the given code
+      #   cannot be associated to a known HTTP status
+      #
+      # @example
+      #   response.status = :unprocessable_entity
+      #
+      # @example
+      #   response.status = 422
+      #
+      # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+      def status=(code)
+        super(Http::Status.lookup(code))
+      end
+
       # This is NOT RELEASED with 2.0.0
       #
       # @api private
@@ -166,6 +187,16 @@ module Hanami
         @exposures[key] = value
       end
 
+      # Returns true if the session is enabled for the request.
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      # @since 2.1.0
+      def session_enabled?
+        @session_enabled
+      end
+
       # Returns the session for the response.
       #
       # This is the same session object as the {Request}.
@@ -179,7 +210,7 @@ module Hanami
       # @since 2.0.0
       # @api public
       def session
-        unless @sessions_enabled
+        unless session_enabled?
           raise Hanami::Action::MissingSessionError.new("Hanami::Action::Response#session")
         end
 
@@ -199,7 +230,7 @@ module Hanami
       # @since 2.0.0
       # @api public
       def flash
-        unless @sessions_enabled
+        unless session_enabled?
           raise Hanami::Action::MissingSessionError.new("Hanami::Action::Response#flash")
         end
 

data/lib/hanami/action/session.rb

@@ -21,7 +21,7 @@ module Hanami
 
       private
 
-      def sessions_enabled?
+      def session_enabled?
         true
       end
 

data/lib/hanami/action.rb

@@ -309,7 +309,7 @@ module Hanami
         request  = build_request(
           env: env,
           params: params,
-          sessions_enabled: sessions_enabled?
+          session_enabled: session_enabled?
         )
         response = build_response(
           request: request,
@@ -317,7 +317,7 @@ module Hanami
           content_type: Mime.response_content_type_with_charset(request, config),
           env: env,
           headers: config.default_headers,
-          sessions_enabled: sessions_enabled?
+          session_enabled: session_enabled?
         )
 
         enforce_accepted_mime_types(request)
@@ -424,10 +424,10 @@ module Hanami
       nil
     end
 
-    # @see Session#sessions_enabled?
+    # @see Session#session_enabled?
     # @since 2.0.0
     # @api private
-    def sessions_enabled?
+    def session_enabled?
       false
     end
 

data/lib/hanami/controller/version.rb

@@ -8,6 +8,6 @@ module Hanami
     #
     # @since 0.1.0
     # @api public
-    VERSION = "2.0.1"
+    VERSION = "2.1.0.beta1"
   end
 end

data/lib/hanami/http/status.rb

@@ -17,31 +17,127 @@ module Hanami
       # @api private
       ALL = ::Rack::Utils::HTTP_STATUS_CODES
 
+      # Symbolic names for status codes
+      #
+      # @since 2.0.2
+      # @api private
+      SYMBOLS = ::Rack::Utils::SYMBOL_TO_STATUS_CODE
+
       # Return a status for the given code
       #
-      # @param code [Integer] a valid HTTP code
+      # @param code [Integer, Symbol] a valid HTTP code
       #
       # @return [Array] a pair of code and message for an HTTP status
       #
+      # @raise [Hanami::Action::UnknownHttpStatusError] if the given code
+      #   cannot be associated to a known HTTP status
+      #
       # @since 0.1.0
       # @api private
       #
-      # @example
-      #   require 'hanami/http/status'
+      # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+      #
+      # @example Integer HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.for_code(401)
+      #     # => [401, "Unauthorized"]
+      #
+      # @example Symbol HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.for_code(:unauthorized)
+      #     # => [401, "Unauthorized"]
+      #
+      # @example Unknown HTTP Status
+      #   require "hanami/http/status"
       #
-      #   Hanami::Http::Status.for_code(418) # => [418, "I'm a teapot"]
+      #   Hanami::Http::Status.for_code(999)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      #
+      #   Hanami::Http::Status.for_code(:foo)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
       def self.for_code(code)
-        ALL.assoc(code)
+        case code
+        when Integer
+          ALL.assoc(code)
+        when Symbol
+          ALL.assoc(SYMBOLS[code])
+        end or raise ::Hanami::Action::UnknownHttpStatusError.new(code)
+      end
+
+      # Return a status code for the given code
+      #
+      # @param code [Integer,Symbol] a valid HTTP code
+      #
+      # @return [Integer] a message for the given status code
+      #
+      # @raise [Hanami::Action::UnknownHttpStatusError] if the given code
+      #   cannot be associated to a known HTTP status
+      #
+      # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+      #
+      # @since 2.0.2
+      # @api private
+      #
+      # @example Integer HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.lookup(401)
+      #     # => 401
+      #
+      # @example Symbol HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.lookup(:unauthorized)
+      #     # => 401
+      #
+      # @example Unknown HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.lookup(999)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      #
+      #   Hanami::Http::Status.lookup(:foo)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      def self.lookup(code)
+        for_code(code)[0]
       end
 
       # Return a message for the given status code
       #
-      # @param code [Integer] a valid HTTP code
+      # @param code [Integer,Symbol] a valid HTTP code
       #
       # @return [String] a message for the given status code
       #
+      # @raise [Hanami::Action::UnknownHttpStatusError] if the given code
+      #   cannot be associated to a known HTTP status
+      #
+      # @see https://guides.hanamirb.org/v2.0/actions/status-codes/
+      #
       # @since 0.3.2
       # @api private
+      #
+      # @example Integer HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.message_for(401)
+      #     # => "Unauthorized"
+      #
+      # @example Symbol HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.message_for(:unauthorized)
+      #     # => "Unauthorized"
+      #
+      # @example Unknown HTTP Status
+      #   require "hanami/http/status"
+      #
+      #   Hanami::Http::Status.message_for(999)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
+      #
+      #   Hanami::Http::Status.message_for(:foo)
+      #     # => raise Hanami::Action::UnknownHttpStatusError
       def self.message_for(code)
         for_code(code)[1]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-controller
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-25 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -218,11 +218,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Complete, fast and testable actions for Rack and Hanami