hanami-controller 2.0.0.alpha8 → 2.0.0.beta1

data/lib/hanami/action/params.rb

@@ -1,5 +1,7 @@
-require 'hanami/action/base_params'
-require 'hanami/validations/form'
+# frozen_string_literal: true
+
+require "hanami/action/base_params"
+require "hanami/validations/form"
 
 module Hanami
   class Action
@@ -48,45 +50,41 @@ module Hanami
         # @example Basic usage
         #   require "hanami/controller"
         #
-        #   class MyAction
-        #     include Hanami::Action
-        #
+        #   class MyAction < Hanami::Action
         #     params do
         #       required(:book).schema do
         #         required(:isbn).filled(:str?)
         #       end
         #     end
         #
-        #     def call(params)
+        #     def handle(req, res)
         #       # 1. Don't try to save the record if the params aren't valid
-        #       return unless params.valid?
+        #       return unless req.params.valid?
         #
-        #       BookRepository.new.create(params[:book])
+        #       BookRepository.new.create(req.params[:book])
         #     rescue Hanami::Model::UniqueConstraintViolationError
         #       # 2. Add an error in case the record wasn't unique
-        #       params.errors.add(:book, :isbn, "is not unique")
+        #       req.params.errors.add(:book, :isbn, "is not unique")
         #     end
         #   end
         #
         # @example Invalid argument
         #   require "hanami/controller"
         #
-        #   class MyAction
-        #     include Hanami::Action
-        #
+        #   class MyAction < Hanami::Action
         #     params do
         #       required(:book).schema do
         #         required(:title).filled(:str?)
         #       end
         #     end
         #
-        #     def call(params)
-        #       puts params.to_h   # => {}
-        #       puts params.valid? # => false
-        #       puts params.error_messages # => ["Book is missing"]
-        #       puts params.errors         # => {:book=>["is missing"]}
+        #     def handle(req, *)
+        #       puts req.params.to_h   # => {}
+        #       puts req.params.valid? # => false
+        #       puts req.params.error_messages # => ["Book is missing"]
+        #       puts req.params.errors         # => {:book=>["is missing"]}
         #
-        #       params.errors.add(:book, :isbn, "is not unique") # => ArgumentError
+        #       req.params.errors.add(:book, :isbn, "is not unique") # => ArgumentError
         #     end
         #   end
         def add(*args)
@@ -129,9 +127,8 @@ module Hanami
       # @see https://guides.hanamirb.org/validations/overview
       #
       # @example
-      #   class Signup
+      #   class Signup < Hanami::Action
       #     MEGABYTE = 1024 ** 2
-      #     include Hanami::Action
       #
       #     params do
       #       required(:first_name).filled(:str?)
@@ -143,13 +140,13 @@ module Hanami
       #       optional(:avatar).filled(size?: 1..(MEGABYTE * 3))
       #     end
       #
-      #     def call(params)
-      #       halt 400 unless params.valid?
+      #     def handle(req, *)
+      #       halt 400 unless req.params.valid?
       #       # ...
       #     end
       #   end
       def self.params(&blk)
-        validations(&blk || ->() {})
+        validations(&blk || -> {})
       end
 
       # Initialize the params and freeze them.
@@ -186,7 +183,13 @@ module Hanami
       #
       # @example
       #   params.errors
-      #     # => {:email=>["is missing", "is in invalid format"], :name=>["is missing"], :tos=>["is missing"], :age=>["is missing"], :address=>["is missing"]}
+      #     # => {
+      #            :email=>["is missing", "is in invalid format"],
+      #            :name=>["is missing"],
+      #            :tos=>["is missing"],
+      #            :age=>["is missing"],
+      #            :address=>["is missing"]
+      #          }
       attr_reader :errors
 
       # Returns flat collection of full error messages
@@ -197,18 +200,25 @@ module Hanami
       #
       # @example
       #   params.error_messages
-      #     # => ["Email is missing", "Email is in invalid format", "Name is missing", "Tos is missing", "Age is missing", "Address is missing"]
+      #     # => [
+      #            "Email is missing",
+      #            "Email is in invalid format",
+      #            "Name is missing",
+      #            "Tos is missing",
+      #            "Age is missing",
+      #            "Address is missing"
+      #          ]
       def error_messages(error_set = errors)
         error_set.each_with_object([]) do |(key, messages), result|
           k = Utils::String.titleize(key)
 
-          _messages = if messages.is_a?(::Hash)
-            error_messages(messages)
-          else
-            messages.map { |message| "#{k} #{message}" }
-          end
+          msgs = if messages.is_a?(::Hash)
+                   error_messages(messages)
+                 else
+                   messages.map { |message| "#{k} #{message}" }
+                 end
 
-          result.concat(_messages)
+          result.concat(msgs)
         end
       end
 

data/lib/hanami/action/rack/file.rb

@@ -1,4 +1,6 @@
-require 'rack/file'
+# frozen_string_literal: true
+
+require "rack/file"
 
 module Hanami
   class Action
@@ -10,12 +12,6 @@ module Hanami
       #
       # @see Hanami::Action::Rack#send_file
       class File
-        # The key that returns path info from the Rack env
-        #
-        # @since 1.0.0
-        # @api private
-        PATH_INFO = "PATH_INFO".freeze
-
         # @param path [String,Pathname] file path
         #
         # @since 0.4.3
@@ -29,11 +25,11 @@ module Hanami
         # @api private
         def call(env)
           env = env.dup
-          env[PATH_INFO] = @path
+          env[Action::PATH_INFO] = @path
 
           @file.get(env)
         rescue Errno::ENOENT
-          [404, {}, nil]
+          [Action::NOT_FOUND, {}, nil]
         end
       end
     end

data/lib/hanami/action/request.rb

@@ -1,5 +1,9 @@
-require 'rack/request'
-require 'securerandom'
+# frozen_string_literal: true
+
+require "rack/utils"
+require "rack/mime"
+require "rack/request"
+require "securerandom"
 
 module Hanami
   class Action
@@ -10,11 +14,6 @@ module Hanami
     #
     # @see http://www.rubydoc.info/gems/rack/Rack/Request
     class Request < ::Rack::Request
-      HTTP_ACCEPT = "HTTP_ACCEPT".freeze
-      REQUEST_ID  = "hanami.request_id".freeze
-      DEFAULT_ACCEPT = "*/*".freeze
-      DEFAULT_ID_LENGTH = 16
-
       attr_reader :params
 
       def initialize(env, params)
@@ -23,8 +22,8 @@ module Hanami
       end
 
       def id
-        # FIXME make this number configurable and document the probabilities of clashes
-        @id ||= @env[REQUEST_ID] = SecureRandom.hex(DEFAULT_ID_LENGTH)
+        # FIXME: make this number configurable and document the probabilities of clashes
+        @id ||= @env[Action::REQUEST_ID] = SecureRandom.hex(Action::DEFAULT_ID_LENGTH)
       end
 
       def accept?(mime_type)
@@ -34,61 +33,13 @@ module Hanami
       end
 
       def accept_header?
-        accept != DEFAULT_ACCEPT
+        accept != Action::DEFAULT_ACCEPT
       end
 
       # @since 0.1.0
       # @api private
       def accept
-        @accept ||= @env[HTTP_ACCEPT] || DEFAULT_ACCEPT
-      end
-
-      # @raise [NotImplementedError]
-      #
-      # @since 0.3.1
-      # @api private
-      def content_type
-        raise NotImplementedError, 'Please use Action#content_type'
-      end
-
-      # @raise [NotImplementedError]
-      #
-      # @since 0.3.1
-      # @api private
-      def update_param(*)
-        raise NotImplementedError, 'Please use params passed to Action#call'
-      end
-
-      # @raise [NotImplementedError]
-      #
-      # @since 0.3.1
-      # @api private
-      def delete_param(*)
-        raise NotImplementedError, 'Please use params passed to Action#call'
-      end
-
-      # @raise [NotImplementedError]
-      #
-      # @since 0.3.1
-      # @api private
-      def [](*)
-        raise NotImplementedError, 'Please use params passed to Action#call'
-      end
-
-      # @raise [NotImplementedError]
-      #
-      # @since 0.3.1
-      # @api private
-      def []=(*)
-        raise NotImplementedError, 'Please use params passed to Action#call'
-      end
-
-      # @raise [NotImplementedError]
-      #
-      # @since 0.3.1
-      # @api private
-      def values_at(*)
-        raise NotImplementedError, 'Please use params passed to Action#call'
+        @accept ||= @env[Action::HTTP_ACCEPT] || Action::DEFAULT_ACCEPT
       end
     end
   end

data/lib/hanami/action/response.rb

@@ -1,61 +1,58 @@
 # frozen_string_literal: true
 
-require 'rack'
-require 'rack/response'
-require 'hanami/utils/kernel'
-require 'hanami/action/flash'
-require 'hanami/action/halt'
-require 'hanami/action/cookie_jar'
-require 'hanami/action/cache/cache_control'
-require 'hanami/action/cache/expires'
-require 'hanami/action/cache/conditional_get'
+require "rack"
+require "rack/response"
+require "hanami/utils/kernel"
+require "hanami/action/flash"
+require "hanami/action/halt"
+require "hanami/action/cookie_jar"
+require "hanami/action/cache/cache_control"
+require "hanami/action/cache/expires"
+require "hanami/action/cache/conditional_get"
 
 module Hanami
   class Action
     class Response < ::Rack::Response
-      DEFAULT_VIEW_OPTIONS = -> * { {} }.freeze
-
-      REQUEST_METHOD = "REQUEST_METHOD"
-      HTTP_ACCEPT = "HTTP_ACCEPT"
-      SESSION_KEY = "rack.session"
-      REQUEST_ID  = "hanami.request_id"
-      LOCATION    = "Location"
-
-      X_CASCADE = "X-Cascade"
-      CONTENT_LENGTH = "Content-Length"
-      NOT_FOUND = 404
-
-      RACK_STATUS  = 0
-      RACK_HEADERS = 1
-      RACK_BODY    = 2
-
-      HEAD = "HEAD"
-
-      FLASH_SESSION_KEY = "_flash"
+      # @since 2.0.0
+      # @api private
+      DEFAULT_VIEW_OPTIONS = -> (*) { {} }.freeze
 
+      # @since 2.0.0
+      # @api private
       EMPTY_BODY = [].freeze
 
+      # @since 2.0.0
+      # @api private
       FILE_SYSTEM_ROOT = Pathname.new("/").freeze
 
+      # @since 2.0.0
+      # @api private
       attr_reader :request, :action, :exposures, :format, :env, :view_options
+
+      # @since 2.0.0
+      # @api private
       attr_accessor :charset
 
+      # @since 2.0.0
+      # @api private
       def self.build(status, env)
-        new(action: "", configuration: nil, content_type: Mime.best_q_match(env[HTTP_ACCEPT]), env: env).tap do |r|
+        new(action: "", configuration: nil, content_type: Mime.best_q_match(env[Action::HTTP_ACCEPT]), env: env).tap do |r| # rubocop:disable Layout/LineLength
           r.status = status
           r.body   = Http::Status.message_for(status)
           r.set_format(Mime.format_for(r.content_type))
         end
       end
 
-      def initialize(request:, action:, configuration:, content_type: nil, env: {}, headers: {}, view_options: nil)
+      # @since 2.0.0
+      # @api private
+      def initialize(request:, action:, configuration:, content_type: nil, env: {}, headers: {}, view_options: nil) # rubocop:disable Metrics/ParameterLists
         super([], 200, headers.dup)
-        set_header("Content-Type", content_type)
+        set_header(Action::CONTENT_TYPE, content_type)
 
         @request = request
         @action = action
         @configuration = configuration
-        @charset = ::Rack::MediaType.params(content_type).fetch('charset', nil)
+        @charset = ::Rack::MediaType.params(content_type).fetch("charset", nil)
         @exposures = {}
         @env = env
         @view_options = view_options || DEFAULT_VIEW_OPTIONS
@@ -63,6 +60,8 @@ module Hanami
         @sending_file = false
       end
 
+      # @since 2.0.0
+      # @api public
       def body=(str)
         @length = 0
         @body   = EMPTY_BODY.dup
@@ -75,49 +74,69 @@ module Hanami
         end
       end
 
+      # @since 2.0.0
+      # @api public
       def render(view, **options)
         self.body = view.(**view_options.(request, self), **exposures.merge(options)).to_str
       end
 
+      # @since 2.0.0
+      # @api public
       def format=(args)
         @format, content_type = *args
         content_type = Action::Mime.content_type_with_charset(content_type, charset)
         set_header("Content-Type", content_type)
       end
 
+      # @since 2.0.0
+      # @api public
       def [](key)
         @exposures.fetch(key)
       end
 
+      # @since 2.0.0
+      # @api public
       def []=(key, value)
         @exposures[key] = value
       end
 
+      # @since 2.0.0
+      # @api public
       def session
-        env[SESSION_KEY] ||= {}
+        env[Action::RACK_SESSION] ||= {}
       end
 
+      # @since 2.0.0
+      # @api public
       def cookies
         @cookies ||= CookieJar.new(env.dup, headers, @configuration.cookies)
       end
 
+      # @since 2.0.0
+      # @api public
       def flash
-        @flash ||= Flash.new(session[FLASH_SESSION_KEY])
+        @flash ||= Flash.new(session[Flash::KEY])
       end
 
+      # @since 2.0.0
+      # @api public
       def redirect_to(url, status: 302)
-        return unless renderable?
+        return unless allow_redirect?
 
         redirect(::String.new(url), status)
         Halt.call(status)
       end
 
+      # @since 2.0.0
+      # @api public
       def send_file(path)
         _send_file(
           Rack::File.new(path, @configuration.public_directory).call(env)
         )
       end
 
+      # @since 2.0.0
+      # @api public
       def unsafe_send_file(path)
         directory = if Pathname.new(path).relative?
                       @configuration.root_directory
@@ -130,16 +149,22 @@ module Hanami
         )
       end
 
+      # @since 2.0.0
+      # @api public
       def cache_control(*values)
         directives = Cache::CacheControl::Directives.new(*values)
         headers.merge!(directives.headers)
       end
 
+      # @since 2.0.0
+      # @api public
       def expires(amount, *values)
         directives = Cache::Expires::Directives.new(amount, *values)
         headers.merge!(directives.headers)
       end
 
+      # @since 2.0.0
+      # @api public
       def fresh(options)
         conditional_get = Cache::ConditionalGet.new(env, options)
 
@@ -150,41 +175,59 @@ module Hanami
         end
       end
 
+      # @since 2.0.0
       # @api private
       def request_id
-        env.fetch(REQUEST_ID) do
+        env.fetch(Action::REQUEST_ID) do
           # FIXME: raise a meaningful error, by inviting devs to include Hanami::Action::Session
           raise "Can't find request ID"
         end
       end
 
-      def set_format(value)
+      # @since 2.0.0
+      # @api public
+      def set_format(value) # rubocop:disable Naming/AccessorMethodName
         @format = value
       end
 
+      # @since 2.0.0
+      # @api private
       def renderable?
         return !head? && body.empty? if body.respond_to?(:empty?)
 
         !@sending_file && !head?
       end
 
-      alias to_ary to_a
+      # @since 2.0.0
+      # @api private
+      def allow_redirect?
+        return body.empty? if body.respond_to?(:empty?)
+
+        !@sending_file
+      end
+
+      # @since 2.0.0
+      # @api private
+      alias_method :to_ary, :to_a
 
+      # @since 2.0.0
+      # @api public
       def head?
-        env[REQUEST_METHOD] == HEAD
+        env[Action::REQUEST_METHOD] == Action::HEAD
       end
 
+      # @since 2.0.0
       # @api private
       def _send_file(send_file_response)
-        headers.merge!(send_file_response[RACK_HEADERS])
+        headers.merge!(send_file_response[Action::RESPONSE_HEADERS])
 
-        if send_file_response[RACK_STATUS] == NOT_FOUND
-          headers.delete(X_CASCADE)
-          headers.delete(CONTENT_LENGTH)
-          Halt.call(NOT_FOUND)
+        if send_file_response[Action::RESPONSE_CODE] == Action::NOT_FOUND
+          headers.delete(Action::X_CASCADE)
+          headers.delete(Action::CONTENT_LENGTH)
+          Halt.call(Action::NOT_FOUND)
         else
-          self.status = send_file_response[RACK_STATUS]
-          self.body = send_file_response[RACK_BODY]
+          self.status = send_file_response[Action::RESPONSE_CODE]
+          self.body = send_file_response[Action::RESPONSE_BODY]
           @sending_file = true
         end
       end

data/lib/hanami/action/session.rb

@@ -1,4 +1,6 @@
-require 'hanami/action/flash'
+# frozen_string_literal: true
+
+require "hanami/action/flash"
 
 module Hanami
   class Action
@@ -26,9 +28,9 @@ module Hanami
       # @see Hanami::Action#finish
       def finish(req, res, *)
         if (next_flash = res.flash.next).any?
-          res.session['_flash'] = next_flash
+          res.session[Flash::KEY] = next_flash
         else
-          res.session.delete('_flash')
+          res.session.delete(Flash::KEY)
         end
 
         super

data/lib/hanami/action/validatable.rb

@@ -1,4 +1,6 @@
-require 'hanami/action/params'
+# frozen_string_literal: true
+
+require "hanami/action/params"
 
 module Hanami
   class Action
@@ -7,7 +9,7 @@ module Hanami
       #
       # @api private
       # @since 0.3.0
-      PARAMS_CLASS_NAME = 'Params'.freeze
+      PARAMS_CLASS_NAME = "Params"
 
       # @api private
       # @since 0.1.0
@@ -53,28 +55,26 @@ module Hanami
         # @see https://guides.hanamirb.org//validations/overview
         #
         # @example Anonymous Block
-        #   require 'hanami/controller'
-        #
-        #   class Signup
-        #     include Hanami::Action
+        #   require "hanami/controller"
         #
+        #   class Signup < Hanami::Action
         #     params do
         #       required(:first_name)
         #       required(:last_name)
         #       required(:email)
         #     end
         #
-        #     def call(params)
-        #       puts params.class            # => Signup::Params
-        #       puts params.class.superclass # => Hanami::Action::Params
+        #     def handle(req, *)
+        #       puts req.params.class            # => Signup::Params
+        #       puts req.params.class.superclass # => Hanami::Action::Params
         #
-        #       puts params[:first_name]     # => "Luca"
-        #       puts params[:admin]          # => nil
+        #       puts req.params[:first_name]     # => "Luca"
+        #       puts req.params[:admin]          # => nil
         #     end
         #   end
         #
         # @example Concrete class
-        #   require 'hanami/controller'
+        #   require "hanami/controller"
         #
         #   class SignupParams < Hanami::Action::Params
         #     required(:first_name)
@@ -82,16 +82,15 @@ module Hanami
         #     required(:email)
         #   end
         #
-        #   class Signup
-        #     include Hanami::Action
+        #   class Signup < Hanami::Action
         #     params SignupParams
         #
-        #     def call(params)
-        #       puts params.class            # => SignupParams
-        #       puts params.class.superclass # => Hanami::Action::Params
+        #     def handle(req, *)
+        #       puts req.params.class            # => SignupParams
+        #       puts req.params.class.superclass # => Hanami::Action::Params
         #
-        #       params[:first_name]          # => "Luca"
-        #       params[:admin]               # => nil
+        #       req.params[:first_name]          # => "Luca"
+        #       req.params[:admin]               # => nil
         #     end
         #   end
         def params(klass = nil, &blk)

data/lib/hanami/action/view_name_inferrer.rb

@@ -2,13 +2,19 @@
 
 module Hanami
   class Action
+    # @since 2.0.0
+    # @api private
     class ViewNameInferrer
+      # @since 2.0.0
+      # @api private
       ALTERNATIVE_NAMES = {
         "create" => "new",
         "update" => "edit"
       }.freeze
 
       class << self
+        # @since 2.0.0
+        # @api private
         def call(action_name:, provider:)
           application = provider.respond_to?(:application) ? provider.application : Hanami.application
 
@@ -24,6 +30,8 @@ module Hanami
 
         private
 
+        # @since 2.0.0
+        # @api private
         def action_identifier_name(action_name, provider, name_base)
           provider
             .inflector
@@ -33,6 +41,8 @@ module Hanami
             .gsub("/", ".")
         end
 
+        # @since 2.0.0
+        # @api private
         def alternative_view_name(view_name)
           parts = view_name.split(".")