hanami-controller 2.0.0.beta4 → 2.0.0

data/lib/hanami/action/{error.rb → errors.rb}

@@ -2,22 +2,51 @@
 
 module Hanami
   class Action
+    # Base class for all Action errors.
+    #
+    # @api public
     # @since 2.0.0
     class Error < ::StandardError
     end
 
-    # Missing session error
+    # Unknown format error
     #
-    # This error is raised when `session` or `flash` is accessed/set on request/response objects
-    # in actions which do not include `Hanami::Action::Session`.
+    # This error is raised when a action sets a format that it isn't recognized
+    # both by `Hanami::Action::Configuration` and the list of Rack mime types
     #
     # @since 2.0.0
     #
+    # @see Hanami::Action::Mime#format=
+    class UnknownFormatError < Error
+      # @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
+
+        super(msg)
+      end
+    end
+
+    # Error raised when session is accessed but not enabled.
+    #
+    # This error is raised when `session` or `flash` is accessed/set on request/response objects
+    # in actions which do not include `Hanami::Action::Session`.
+    #
     # @see Hanami::Action::Session
     # @see Hanami::Action::Request#session
     # @see Hanami::Action::Response#session
     # @see Hanami::Action::Response#flash
+    #
+    # @api public
+    # @since 2.0.0
     class MissingSessionError < Error
+      # @api private
+      # @since 2.0.0
       def initialize(session_method)
         super(<<~TEXT)
           Sessions are not enabled. To use `#{session_method}`:
@@ -37,5 +66,11 @@ module Hanami
         TEXT
       end
     end
+
+    # Invalid CSRF Token
+    #
+    # @since 0.4.0
+    class InvalidCSRFTokenError < Error
+    end
   end
 end

data/lib/hanami/action/flash.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
+# The Hanami::Action::Flash implementation is derived from Roda's FlashHash, also released under the
+# MIT Licence:
+#
+# Copyright (c) 2014-2020 Jeremy Evans
+# Copyright (c) 2010-2014 Michel Martens, Damian Janowski and Cyril David
+# Copyright (c) 2008-2009 Christian Neukirchen
+
 module Hanami
   class Action
-    # A container to transport data with the HTTP session, with a lifespan of
-    # just one HTTP request or redirect.
-    #
-    # Behaves like a hash, returning entries for the current request, except for
-    # {#[]=}, which updates the hash for the next request.
+    # A container to transport data with the HTTP session, with a lifespan of just one HTTP request
+    # or redirect.
     #
-    # This implementation is derived from Roda's FlashHash, also released under
-    # the MIT Licence:
-    #
-    # Copyright (c) 2014-2020 Jeremy Evans
-    # Copyright (c) 2010-2014 Michel Martens, Damian Janowski and Cyril David
-    # Copyright (c) 2008-2009 Christian Neukirchen
+    # Behaves like a hash, returning entries for the current request, except for {#[]=}, which
+    # updates the hash for the next request.
     #
     # @since 0.3.0
     # @api public
@@ -30,9 +30,9 @@ module Hanami
       # @api public
       attr_reader :next
 
-      # Initializes a new flash instance
+      # Returns a new flash object.
       #
-      # @param hash [Hash, nil] the flash hash for the current request. nil will become an empty hash.
+      # @param hash [Hash, nil] the flash hash for the current request; `nil` will become an empty hash.
       #
       # @since 0.3.0
       # @api public
@@ -41,7 +41,9 @@ module Hanami
         @next = {}
       end
 
-      # @return [Hash] The flash hash for the current request
+      # Returns the flash hash for the current request.
+      #
+      # @return [Hash] the flash hash for the current request
       #
       # @since 2.0.0
       # @api public
@@ -49,7 +51,7 @@ module Hanami
         @flash
       end
 
-      # Returns the value for the given key in the current hash
+      # Returns the value for the given key in the current hash.
       #
       # @param key [Object] the key
       #
@@ -61,7 +63,7 @@ module Hanami
         @flash[key]
       end
 
-      # Updates the next hash with the given key and value
+      # Updates the next hash with the given key and value.
       #
       # @param key [Object] the key
       # @param value [Object] the value
@@ -72,9 +74,12 @@ module Hanami
         @next[key] = value
       end
 
-      # Calls the given block once for each element in the current hash
+      # Calls the given block once for each element in the current hash.
       #
-      # @param block [Proc]
+      # @yieldparam element [Array<(Object, Object)>] array containing the key and value from the
+      #   hash
+      #
+      # @return [now]
       #
       # @since 1.2.0
       # @api public
@@ -82,10 +87,12 @@ module Hanami
         @flash.each(&block)
       end
 
-      # Returns a new array with the results of running block once for every
-      # element in the current hash
+      # Returns an array of objects returned by the block, called once for each element in the
+      # current hash.
+      #
+      # @yieldparam element [Array<(Object, Object)>] array containing the key and value from the
+      #   hash
       #
-      # @param block [Proc]
       # @return [Array]
       #
       # @since 1.2.0
@@ -114,7 +121,7 @@ module Hanami
         @flash.key?(key)
       end
 
-      # Removes entries from the next hash
+      # Removes entries from the next hash.
       #
       # @overload discard(key)
       #   Removes the given key from the next hash

data/lib/hanami/action/halt.rb

@@ -4,9 +4,11 @@ require "hanami/http/status"
 
 module Hanami
   class Action
+    # @api private
+    # @since 2.0.0
     module Halt
-      # @since 2.0.0
       # @api private
+      # @since 2.0.0
       def self.call(status, body = nil)
         body ||= Http::Status.message_for(status)
         throw :halt, [status, body]

data/lib/hanami/action/mime/request_mime_weight.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Action
+    module Mime
+      # @since 1.0.1
+      # @api private
+      class RequestMimeWeight
+        # @since 2.0.0
+        # @api private
+        MIME_SEPARATOR = "/"
+        private_constant :MIME_SEPARATOR
+
+        # @since 2.0.0
+        # @api private
+        MIME_WILDCARD = "*"
+        private_constant :MIME_WILDCARD
+
+        include Comparable
+
+        # @since 1.0.1
+        # @api private
+        attr_reader :quality
+
+        # @since 1.0.1
+        # @api private
+        attr_reader :index
+
+        # @since 1.0.1
+        # @api private
+        attr_reader :mime
+
+        # @since 1.0.1
+        # @api private
+        attr_reader :format
+
+        # @since 1.0.1
+        # @api private
+        attr_reader :priority
+
+        # @since 1.0.1
+        # @api private
+        def initialize(mime, quality, index, format = mime)
+          @quality, @index, @format = quality, index, format
+          calculate_priority(mime)
+        end
+
+        # @since 1.0.1
+        # @api private
+        def <=>(other)
+          return priority <=> other.priority unless priority == other.priority
+
+          other.index <=> index
+        end
+
+        private
+
+        # @since 1.0.1
+        # @api private
+        def calculate_priority(mime)
+          @priority ||= (mime.split(MIME_SEPARATOR, 2).count(MIME_WILDCARD) * -10) + quality
+        end
+      end
+    end
+  end
+end