hanami-controller 2.0.0.beta4 → 2.0.0

data/lib/hanami/action.rb

@@ -1,30 +1,16 @@
 # frozen_string_literal: true
 
-begin
-  require "dry/core"
-  require "dry/types"
-  require "hanami/validations"
-  require "hanami/action/validatable"
-rescue LoadError # rubocop:disable Lint/SuppressedException
-end
-
 require "dry/configurable"
-require "hanami/utils/callbacks"
 require "hanami/utils"
-require "hanami/utils/string"
+require "hanami/utils/callbacks"
 require "hanami/utils/kernel"
+require "hanami/utils/string"
 require "rack"
 require "rack/utils"
+require "zeitwerk"
 
-require_relative "action/config"
 require_relative "action/constants"
-require_relative "action/base_params"
-require_relative "action/halt"
-require_relative "action/mime"
-require_relative "action/rack/file"
-require_relative "action/request"
-require_relative "action/response"
-require_relative "action/error"
+require_relative "action/errors"
 
 module Hanami
   # An HTTP endpoint
@@ -42,18 +28,37 @@ module Hanami
   #
   # @api public
   class Action
+    # @since 2.0.0
+    # @api private
+    def self.gem_loader
+      @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+        loader.tag = "hanami-controller"
+        loader.inflector = Zeitwerk::GemInflector.new("#{root}/hanami-controller.rb")
+        loader.push_dir(root)
+        loader.ignore(
+          "#{root}/hanami-controller.rb",
+          "#{root}/hanami/controller/version.rb",
+          "#{root}/hanami/action/{constants,errors,params,validatable}.rb"
+        )
+        loader.inflector.inflect("csrf_protection" => "CSRFProtection")
+      end
+    end
+
+    gem_loader.setup
+
+    # Make conditional requires after Zeitwerk setup so any internal autoloading works as expected
+    begin
+      require "hanami/validations"
+      require_relative "action/validatable"
+    rescue LoadError # rubocop:disable Lint/SuppressedException
+    end
+
     extend Dry::Configurable(config_class: Config)
 
     # See {Config} for individual setting accessor API docs
     setting :handled_exceptions, default: {}
-    setting :formats, default: Config::DEFAULT_FORMATS
-    setting :default_request_format, constructor: -> (format) {
-      Utils::Kernel.Symbol(format) unless format.nil?
-    }
-    setting :default_response_format, constructor: -> (format) {
-      Utils::Kernel.Symbol(format) unless format.nil?
-    }
-    setting :accepted_formats, default: []
+    setting :formats, default: Config::Formats.new, mutable: true
     setting :default_charset
     setting :default_headers, default: {}, constructor: -> (headers) { headers.compact }
     setting :cookies, default: {}, constructor: -> (cookie_options) {
@@ -65,8 +70,8 @@ module Hanami
       Pathname(File.expand_path(dir || Dir.pwd)).realpath
     }
     setting :public_directory, default: Config::DEFAULT_PUBLIC_DIRECTORY
-    setting :before_callbacks, default: Utils::Callbacks::Chain.new, cloneable: true
-    setting :after_callbacks, default: Utils::Callbacks::Chain.new, cloneable: true
+    setting :before_callbacks, default: Utils::Callbacks::Chain.new, mutable: true
+    setting :after_callbacks, default: Utils::Callbacks::Chain.new, mutable: true
 
     # @!scope class
 
@@ -75,7 +80,7 @@ module Hanami
     #
     #   @example Access inside class body
     #     class Show < Hanami::Action
-    #       config.default_response_format = :json
+    #       config.format :json
     #     end
     #
     #   @return [Config]
@@ -126,71 +131,72 @@ module Hanami
     #
     # @raise [NoMethodError]
     #
-    # @api private
+    # @api public
     # @since 2.0.0
     def self.params(_klass = nil)
       raise NoMethodError,
             "To use `params`, please add 'hanami/validations' gem to your Gemfile"
     end
 
-    # Define a callback for an Action.
-    # The callback will be executed **before** the action is called, in the
-    # order they are added.
+    # @overload self.append_before(*callbacks, &block)
+    #   Define a callback for an Action.
+    #   The callback will be executed **before** the action is called, in the
+    #   order they are added.
     #
-    # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-    #   each of them is representing a name of a method available in the
-    #   context of the Action.
+    #   @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
+    #     each of them is representing a name of a method available in the
+    #     context of the Action.
     #
-    # @param blk [Proc] an anonymous function to be executed
+    #   @param blk [Proc] an anonymous function to be executed
     #
-    # @return [void]
+    #   @return [void]
     #
-    # @since 0.3.2
+    #   @since 0.3.2
     #
-    # @see Hanami::Action::Callbacks::ClassMethods#append_after
+    #   @see Hanami::Action::Callbacks::ClassMethods#append_after
     #
-    # @example Method names (symbols)
-    #   require "hanami/controller"
+    #   @example Method names (symbols)
+    #     require "hanami/controller"
     #
-    #   class Show < Hanami::Action
-    #     before :authenticate, :set_article
+    #     class Show < Hanami::Action
+    #       before :authenticate, :set_article
     #
-    #     def handle(req, res)
-    #     end
+    #       def handle(req, res)
+    #       end
     #
-    #     private
-    #     def authenticate
-    #       # ...
-    #     end
+    #       private
+    #       def authenticate
+    #         # ...
+    #       end
     #
-    #     # `params` in the method signature is optional
-    #     def set_article(params)
-    #       @article = Article.find params[:id]
+    #       # `params` in the method signature is optional
+    #       def set_article(params)
+    #         @article = Article.find params[:id]
+    #       end
     #     end
-    #   end
     #
-    #   # The order of execution will be:
-    #   #
-    #   # 1. #authenticate
-    #   # 2. #set_article
-    #   # 3. #call
+    #     # The order of execution will be:
+    #     #
+    #     # 1. #authenticate
+    #     # 2. #set_article
+    #     # 3. #call
     #
-    # @example Anonymous functions (Procs)
-    #   require "hanami/controller"
+    #   @example Anonymous functions (Procs)
+    #     require "hanami/controller"
     #
-    #   class Show < Hanami::Action
-    #     before { ... } # 1 do some authentication stuff
-    #     before {|req, res| @article = Article.find params[:id] } # 2
+    #     class Show < Hanami::Action
+    #       before { ... } # 1 do some authentication stuff
+    #       before {|req, res| @article = Article.find params[:id] } # 2
     #
-    #     def handle(req, res)
+    #       def handle(req, res)
+    #       end
     #     end
-    #   end
     #
-    #   # The order of execution will be:
-    #   #
-    #   # 1. authentication
-    #   # 2. set the article
-    #   # 3. `#handle`
+    #     # The order of execution will be:
+    #     #
+    #     # 1. authentication
+    #     # 2. set the article
+    #     # 3. `#handle`
     def self.append_before(...)
       config.before_callbacks.append(...)
     end
@@ -200,21 +206,22 @@ module Hanami
       alias_method :before, :append_before
     end
 
-    # Define a callback for an Action.
-    # The callback will be executed **after** the action is called, in the
-    # order they are added.
+    # @overload self.append_after(*callbacks, &block)
+    #   Define a callback for an Action.
+    #   The callback will be executed **after** the action is called, in the
+    #   order they are added.
     #
-    # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-    #   each of them is representing a name of a method available in the
-    #   context of the Action.
+    #   @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
+    #     each of them is representing a name of a method available in the
+    #     context of the Action.
     #
-    # @param blk [Proc] an anonymous function to be executed
+    #   @param blk [Proc] an anonymous function to be executed
     #
-    # @return [void]
+    #   @return [void]
     #
-    # @since 0.3.2
+    #   @since 0.3.2
     #
-    # @see Hanami::Action::Callbacks::ClassMethods#append_before
+    #   @see Hanami::Action::Callbacks::ClassMethods#append_before
     def self.append_after(...)
       config.after_callbacks.append(...)
     end
@@ -224,72 +231,52 @@ module Hanami
       alias_method :after, :append_after
     end
 
-    # Define a callback for an Action.
-    # The callback will be executed **before** the action is called.
-    # It will add the callback at the beginning of the callbacks' chain.
+    # @overload self.prepend_before(*callbacks, &block)
+    #   Define a callback for an Action.
+    #   The callback will be executed **before** the action is called.
+    #   It will add the callback at the beginning of the callbacks' chain.
     #
-    # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-    #   each of them is representing a name of a method available in the
-    #   context of the Action.
+    #   @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
+    #     each of them is representing a name of a method available in the
+    #     context of the Action.
     #
-    # @param blk [Proc] an anonymous function to be executed
+    #   @param blk [Proc] an anonymous function to be executed
     #
-    # @return [void]
+    #   @return [void]
     #
-    # @since 0.3.2
+    #   @since 0.3.2
     #
-    # @see Hanami::Action::Callbacks::ClassMethods#prepend_after
+    #   @see Hanami::Action::Callbacks::ClassMethods#prepend_after
     def self.prepend_before(...)
       config.before_callbacks.prepend(...)
     end
 
-    # Define a callback for an Action.
-    # The callback will be executed **after** the action is called.
-    # It will add the callback at the beginning of the callbacks' chain.
+    # @overload self.prepend_after(*callbacks, &block)
+    #   Define a callback for an Action.
+    #   The callback will be executed **after** the action is called.
+    #   It will add the callback at the beginning of the callbacks' chain.
     #
-    # @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
-    #   each of them is representing a name of a method available in the
-    #   context of the Action.
+    #   @param callbacks [Symbol, Array<Symbol>] a single or multiple symbol(s)
+    #     each of them is representing a name of a method available in the
+    #     context of the Action.
     #
-    # @param blk [Proc] an anonymous function to be executed
+    #   @param blk [Proc] an anonymous function to be executed
     #
-    # @return [void]
+    #   @return [void]
     #
-    # @since 0.3.2
+    #   @since 0.3.2
     #
-    # @see Hanami::Action::Callbacks::ClassMethods#prepend_before
+    #   @see Hanami::Action::Callbacks::ClassMethods#prepend_before
     def self.prepend_after(...)
       config.after_callbacks.prepend(...)
     end
 
-    # Restrict the access to the specified mime type symbols.
-    #
-    # @param formats[Array<Symbol>] one or more symbols representing mime type(s)
-    #
-    # @raise [Hanami::Controller::UnknownFormatError] if the symbol cannot
-    #   be converted into a mime type
-    #
-    # @since 0.1.0
-    #
     # @see Config#format
     #
-    # @example
-    #   require "hanami/controller"
-    #
-    #   class Show < Hanami::Action
-    #     accept :html, :json
-    #
-    #     def handle(req, res)
-    #       # ...
-    #     end
-    #   end
-    #
-    #   # When called with "*/*"              => 200
-    #   # When called with "text/html"        => 200
-    #   # When called with "application/json" => 200
-    #   # When called with "application/xml"  => 415
-    def self.accept(*formats)
-      config.accepted_formats = formats
+    # @since 2.0.0
+    # @api public
+    def self.format(...)
+      config.format(...)
     end
 
     # @see Config#handle_exception
@@ -327,7 +314,7 @@ module Hanami
         response = build_response(
           request: request,
           config: config,
-          content_type: Mime.calculate_content_type_with_charset(config, request, config.accepted_mime_types),
+          content_type: Mime.response_content_type_with_charset(request, config),
           env: env,
           headers: config.default_headers,
           sessions_enabled: sessions_enabled?
@@ -421,7 +408,7 @@ module Hanami
     # @since 2.0.0
     # @api private
     def enforce_accepted_mime_types(request)
-      return if config.accepted_formats.empty?
+      return if config.formats.empty?
 
       Mime.enforce_accept(request, config) { return halt 406 }
       Mime.enforce_content_type(request, config) { return halt 415 }
@@ -586,20 +573,6 @@ module Hanami
       res.body = Response::EMPTY_BODY
     end
 
-    # @since 2.0.0
-    # @api private
-    def format(value)
-      case value
-      when Symbol
-        format = Utils::Kernel.Symbol(value)
-        [format, Action::Mime.format_to_mime_type(format, config)]
-      when String
-        [Action::Mime.detect_format(value, config), value]
-      else
-        raise Hanami::Controller::UnknownFormatError.new(value)
-      end
-    end
-
     # Finalize the response
     #
     # Prepare the data before the response will be returned to the webserver

data/lib/hanami/controller/version.rb

@@ -2,9 +2,12 @@
 
 module Hanami
   module Controller
-    # Defines the version
+    # The current hanami-controller version.
+    #
+    # @return [String]
     #
     # @since 0.1.0
-    VERSION = "2.0.0.beta4"
+    # @api public
+    VERSION = "2.0.0"
   end
 end

data/lib/hanami/controller.rb

@@ -2,7 +2,6 @@
 
 require "hanami/action"
 require "hanami/controller/version"
-require "hanami/controller/error"
 
 # Hanami
 #
@@ -10,37 +9,10 @@ require "hanami/controller/error"
 module Hanami
   # A set of logically grouped actions
   #
-  # @since 0.1.0
-  #
   # @see Hanami::Action
   #
-  # @example
-  #   require "hanami/controller"
-  #
-  #   module Articles
-  #     class Index < Hanami::Action
-  #       # ...
-  #     end
-  #
-  #     class Show < Hanami::Action
-  #       # ...
-  #     end
-  #   end
+  # @since 0.1.0
+  # @api public
   module Controller
-    # Unknown format error
-    #
-    # 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 0.2.0
-    #
-    # @see Hanami::Action::Mime#format=
-    class UnknownFormatError < Hanami::Controller::Error
-      # @since 0.2.0
-      # @api private
-      def initialize(format)
-        super("Cannot find a corresponding Mime type for '#{format}'. Please configure it with Hanami::Controller::Configuration#format.") # rubocop:disable Layout/LineLength
-      end
-    end
   end
 end

data/lib/hanami/http/status.rb

@@ -3,6 +3,8 @@
 require "rack/utils"
 
 module Hanami
+  # @since 0.1.0
+  # @api private
   module Http
     # An HTTP status
     #

data/lib/hanami-controller.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "hanami/controller"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-controller
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0
 platform: ruby
 authors:
 - Luca Guidi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -30,34 +30,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.beta
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.beta
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +173,7 @@ files:
 - LICENSE.md
 - README.md
 - hanami-controller.gemspec
+- lib/hanami-controller.rb
 - lib/hanami/action.rb
 - lib/hanami/action/base_params.rb
 - lib/hanami/action/cache.rb
@@ -153,14 +182,16 @@ files:
 - lib/hanami/action/cache/directives.rb
 - lib/hanami/action/cache/expires.rb
 - lib/hanami/action/config.rb
+- lib/hanami/action/config/formats.rb
 - lib/hanami/action/constants.rb
 - lib/hanami/action/cookie_jar.rb
 - lib/hanami/action/cookies.rb
 - lib/hanami/action/csrf_protection.rb
-- lib/hanami/action/error.rb
+- lib/hanami/action/errors.rb
 - lib/hanami/action/flash.rb
 - lib/hanami/action/halt.rb
 - lib/hanami/action/mime.rb
+- lib/hanami/action/mime/request_mime_weight.rb
 - lib/hanami/action/params.rb
 - lib/hanami/action/rack/file.rb
 - lib/hanami/action/request.rb
@@ -169,7 +200,6 @@ files:
 - lib/hanami/action/validatable.rb
 - lib/hanami/action/view_name_inferrer.rb
 - lib/hanami/controller.rb
-- lib/hanami/controller/error.rb
 - lib/hanami/controller/version.rb
 - lib/hanami/http/status.rb
 homepage: http://hanamirb.org
@@ -188,9 +218,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.7
 signing_key:

data/lib/hanami/controller/error.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Hanami
-  module Controller
-    # @since 0.5.0
-    class Error < ::StandardError
-    end
-  end
-end