hanami 2.0.0.beta4 → 2.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afcc32f5e8f7ba0a0acb001c4c36ea5a654f73e705b22e73cfc2a2835858af3e
-  data.tar.gz: d183f4cdec177426f339eeae371320880927d15463982d82daeffacd632fe09f
+  metadata.gz: 6a1a430f511f0bda44248e88d4fb2c87d10dc3d8fbabf092b895ff2a3bbb78db
+  data.tar.gz: 75c6e767584d34103505eb3637fc0fb72dde6118b35fa5f4a76a186681031e7a
 SHA512:
-  metadata.gz: a1cca2e0e675ba87e678c14d4733bc172af135ea8fbf751fb1d1749faef2cf9a96629eae77fac339c5d435f6d3744dc6da1f1c32bf63881563ceb435337725bb
-  data.tar.gz: 5a466e081c89ded4a30f4ba8655c2981ba26f9cbb16a5f5e8deb6034f806f4ec203a62556c4ad372b8fd4619e959eb8beb3781a6e8e0451e04aaa0dc2099129f
+  metadata.gz: 306e3261fb72d114ddcb9128de3a3c9a499bff57f1b2c51fd3cee54e644248c3bd981f54b626d7e5549e1fa9c467d86156a7c2c3e4c14c869501e698d07f6423
+  data.tar.gz: a59bf43bf07700e282abe6e83919fd53a5e277b7efa5706b743a25537006eef76b49409bedf0af49cae8122bd39d5c396f705f1e148a01367565e1accb46d9a6

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 The web, with simplicity.
 
+## v2.0.0.rc1 - 2022-11-08
+
+### Added
+
+- [Piotr Solnica] Use Zeitwerk to auto-load Hanami
+- [Tim Riley] Introduce `Hanami::Slice.stop` to properly shutdown all the application slices
+
+### Fixed
+
+- [Luca Guidi] Ensure to properly mount Rack middleware in routing scope and slice
+- [Tim Riley] Simplify and clarify usage of `Hanami::Config#enviroment`
+- [Tim Riley] Improve error message for missing action class
+- [Tim Riley] Expect nested slices to use parent’s namespace
+
+### Changed
+
+- [Piotr Solnica] Replace `Hanami::Logger` with `Dry::Logger`
+- [Tim Riley] Remove duplicated configuration `config.session` and keep `config.actions.sessions`
+
 ## v2.0.0.beta4 - 2022-10-24
 
 ### Added

data/hanami.gemspec

@@ -32,13 +32,14 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.add_dependency "bundler",          ">= 1.16", "< 3"
-  spec.add_dependency "dry-configurable", "~> 0.16", ">= 0.16.1"
-  spec.add_dependency "dry-core",         "~> 0.9", ">= 0.9.1"
-  spec.add_dependency "dry-inflector",    "~> 0.2", ">= 0.2.1"
-  spec.add_dependency "dry-system",       "~> 0.27", ">= 0.27.2"
-  spec.add_dependency "dry-monitor",      "~> 0.7", ">= 0.7"
-  spec.add_dependency "hanami-cli",       "~> 2.0.beta"
-  spec.add_dependency "hanami-utils",     "~> 2.0.beta"
+  spec.add_dependency "dry-configurable", "~> 1.0", "< 2"
+  spec.add_dependency "dry-core",         "~> 1.0", "< 2"
+  spec.add_dependency "dry-inflector",    "~> 1.0", "< 2"
+  spec.add_dependency "dry-monitor",      "~> 1.0", "< 2"
+  spec.add_dependency "dry-system",       "~> 1.0.rc"
+  spec.add_dependency "dry-logger",       "~> 1.0.rc"
+  spec.add_dependency "hanami-cli",       "~> 2.0.rc"
+  spec.add_dependency "hanami-utils",     "~> 2.0.rc"
   spec.add_dependency "zeitwerk",         "~> 2.6"
 
   spec.add_development_dependency "rspec",     "~> 3.8"

data/lib/hanami/app.rb

@@ -1,17 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "config"
 require_relative "constants"
-require_relative "slice"
-require_relative "slice_name"
 
 module Hanami
-  # The Hanami app is a singular slice tasked with managing the core components of
-  # the app and coordinating overall app boot.
+  # The Hanami app is a singular slice tasked with managing the core components of the app and
+  # coordinating overall app boot.
   #
-  # For smaller apps, the app may be the only slice present, whereas larger apps
-  # may consist of many slices, with the app reserved for holding a small number
-  # of shared components only.
+  # For smaller apps, the app may be the only slice present, whereas larger apps may consist of many
+  # slices, with the app reserved for holding a small number of shared components only.
   #
   # @see Slice
   #
@@ -20,6 +16,8 @@ module Hanami
   class App < Slice
     @_mutex = Mutex.new
 
+    # @api private
+    # @since 2.0.0
     def self.inherited(subclass)
       super
 
@@ -31,9 +29,9 @@ module Hanami
         subclass.class_eval do
           @config = Hanami::Config.new(app_name: slice_name, env: Hanami.env)
 
-          # Prepare the load path (based on the default root of `Dir.pwd`) as early as
-          # possible, so you can make a `require` inside the body of an `App` subclass,
-          # which may be useful for certain kinds of app configuration.
+          # Prepare the load path (based on the default root of `Dir.pwd`) as early as possible, so
+          # you can make a `require` inside the body of an `App` subclass, which may be useful for
+          # certain kinds of app configuration.
           prepare_load_path
 
           load_dotenv
@@ -43,29 +41,41 @@ module Hanami
 
     # App class interface
     module ClassMethods
+      # Returns the app's config.
+      #
+      # @return [Hanami::Config]
+      #
+      # @api public
+      # @since 2.0.0
       attr_reader :config
 
+      # Returns the app's {SliceName}.
+      #
+      # @return [Hanami::SliceName]
+      #
+      # @see Slice::ClassMethods#slice_name
+      #
+      # @api public
+      # @since 2.0.0
       def app_name
         slice_name
       end
 
-      # Prepares the $LOAD_PATH based on the app's configured root, prepending the `lib/`
-      # directory if it exists. If the lib directory is already added, this will do
-      # nothing.
+      # Prepares the $LOAD_PATH based on the app's configured root, prepending the `lib/` directory
+      # if it exists. If the lib directory is already added, this will do nothing.
       #
-      # In ordinary circumstances, you should never have to call this method: this method
-      # is called immediately upon subclassing {Hanami::App}, as a convenicence to put
-      # lib/ (under the default root of `Dir.pwd`) on the load path automatically. This is
-      # helpful if you need to require files inside the subclass body for performing
-      # certain app configuration steps.
+      # In ordinary circumstances, you should never have to call this method: this method is called
+      # immediately upon subclassing {Hanami::App}, as a convenicence to put lib/ (under the default
+      # root of `Dir.pwd`) on the load path automatically. This is helpful if you need to require
+      # files inside the subclass body for performing certain app configuration steps.
       #
-      # If you change your app's `config.root` and you need to require files from its
-      # `lib/` directory within your {App} subclass body, you should call
-      # {.prepare_load_path} explicitly after setting the new root.
+      # If you change your app's `config.root` and you need to require files from its `lib/`
+      # directory within your {App} subclass body, you should call {.prepare_load_path} explicitly
+      # after setting the new root.
       #
-      # Otherwise, this method is called again as part of the app {.prepare} step, so if
-      # you've changed your app's root and do _not_ need to require files within your {App}
-      # subclass body, then you don't need to call this method.
+      # Otherwise, this method is called again as part of the app {.prepare} step, so if you've
+      # changed your app's root and do _not_ need to require files within your {App} subclass body,
+      # then you don't need to call this method.
       #
       # @example
       #   module MyApp
@@ -124,12 +134,12 @@ module Hanami
         # Make app-wide notifications available as early as possible
         container.use(:notifications)
 
-        # Ensure all basic slice preparation is complete before we make adjustments below
-        # (which rely on the basic prepare steps having already run)
+        # Ensure all basic slice preparation is complete before we make adjustments below (which
+        # rely on the basic prepare steps having already run)
         super
 
-        # Run specific prepare steps for the app slice. Note also that some
-        # standard steps have been skipped via the empty method overrides below.
+        # Run specific prepare steps for the app slice. Note also that some standard steps have been
+        # skipped via the empty method overrides below.
         prepare_app_component_dirs
         prepare_app_providers
       end
@@ -150,8 +160,8 @@ module Hanami
           end
         end
 
-        # When auto-registering components in app/, ignore files in `app/lib/` (these will
-        # be auto-registered as above), as well as the configured no_auto_register_paths
+        # When auto-registering components in app/, ignore files in `app/lib/` (these will be
+        # auto-registered as above), as well as the configured no_auto_register_paths
         no_auto_register_paths = ([LIB_DIR] + config.no_auto_register_paths)
           .map { |path|
             path.end_with?(File::SEPARATOR) ? path : "#{path}#{File::SEPARATOR}"
@@ -178,14 +188,15 @@ module Hanami
           register_provider(:logger, source: Hanami::Providers::Logger)
         end
 
-        require_relative "providers/rack"
-        register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)
+        if Hanami.bundled?("rack")
+          require_relative "providers/rack"
+          register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)
+        end
       end
 
       def prepare_autoloader
-        # Component dirs are automatically pushed to the autoloader by dry-system's
-        # zeitwerk plugin. This method adds other dirs that are not otherwise configured
-        # as component dirs.
+        # Component dirs are automatically pushed to the autoloader by dry-system's zeitwerk plugin.
+        # This method adds other dirs that are not otherwise configured as component dirs.
 
         # Autoload classes from `lib/[app_namespace]/`
         if root.join(LIB_DIR, app_name.name).directory?

data/lib/hanami/assets/app_config.rb

@@ -1,28 +1,27 @@
 # frozen_string_literal: true
 
 require "dry/configurable"
-require_relative "config"
 
 module Hanami
+  # @api private
   module Assets
-    # @since 2.0.0
-    # @api public
+    # App config for assets.
+    #
+    # This is NOT RELEASED as of 2.0.0.
+    #
+    # @api private
     class AppConfig
       include Dry::Configurable
 
-      # @since 2.0.0
-      # @api private
       attr_reader :base_config
       protected :base_config
 
       setting :server_url, default: "http://localhost:8080"
 
-      # @since 2.0.0
-      # @api private
       def initialize(*)
         super
 
-        @base_config = Config.new
+        @base_config = Assets::Config.new
       end
 
       def initialize_copy(source)
@@ -30,8 +29,6 @@ module Hanami
         @base_config = source.base_config.dup
       end
 
-      # @since 2.0.0
-      # @api private
       def finalize!
       end
 
@@ -39,7 +36,6 @@ module Hanami
       #
       # @return [Set]
       #
-      # @since 2.0.0
       # @api private
       def settings
         base_config.settings + self.class.settings
@@ -47,8 +43,6 @@ module Hanami
 
       private
 
-      # @since 2.0.0
-      # @api private
       def method_missing(name, *args, &block)
         if config.respond_to?(name)
           config.public_send(name, *args, &block)
@@ -59,8 +53,6 @@ module Hanami
         end
       end
 
-      # @since 2.0.0
-      # @api private
       def respond_to_missing?(name, _incude_all = false)
         config.respond_to?(name) || base_config.respond_to?(name) || super
       end

data/lib/hanami/assets/config.rb

@@ -4,8 +4,11 @@ require "dry/configurable"
 
 module Hanami
   module Assets
-    # @since 2.0.0
-    # @api public
+    # App config for assets.
+    #
+    # This is NOT RELEASED as of 2.0.0.
+    #
+    # @api private
     class Config
       include Dry::Configurable
 
@@ -34,8 +37,6 @@ module Hanami
 
       private
 
-      # @since 2.0.0
-      # @api private
       def method_missing(name, *args, &block)
         if config.respond_to?(name)
           config.public_send(name, *args, &block)
@@ -44,8 +45,6 @@ module Hanami
         end
       end
 
-      # @since 2.0.0
-      # @api private
       def respond_to_missing?(name, _incude_all = false)
         config.respond_to?(name) || super
       end

data/lib/hanami/config/actions/content_security_policy.rb

@@ -99,7 +99,7 @@ module Hanami
 
         # @since 2.0.0
         # @api private
-        def to_str
+        def to_s
           @policy.map do |key, value|
             "#{dasherize(key)} #{value}"
           end.join(";\n")

data/lib/hanami/config/actions/cookies.rb

@@ -9,18 +9,45 @@ module Hanami
       # actions, and adds the `enabled?` method to allow app base action to determine whether to
       # include the `Action::Cookies` module.
       #
+      # @api public
       # @since 2.0.0
       class Cookies
+        # Returns the cookie options.
+        #
+        # @return [Hash]
+        #
+        # @api public
+        # @since 2.0.0
         attr_reader :options
 
+        # Returns a new `Cookies`.
+        #
+        # You should not need to initialize this class directly. Instead use
+        # {Hanami::Config::Actions#cookies}.
+        #
+        # @api private
+        # @since 2.0.0
         def initialize(options)
           @options = options
         end
 
+        # Returns true if any cookie options have been provided.
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        # @since 2.0.0
         def enabled?
           !options.nil?
         end
 
+        # Returns the cookie options.
+        #
+        # If no options have been provided, returns an empty hash.
+        #
+        # @return [Hash]
+        #
+        # @api public
         def to_h
           options.to_h
         end

data/lib/hanami/config/actions/sessions.rb

@@ -1,31 +1,68 @@
 # frozen_string_literal: true
 
-require "dry/core/constants"
 require "hanami/utils/string"
 require "hanami/utils/class"
 
 module Hanami
   class Config
     class Actions
-      # Config for HTTP sessions in Hanami actions
+      # Config for HTTP session middleware in Hanami actions.
       #
+      # @api public
       # @since 2.0.0
       class Sessions
-        attr_reader :storage, :options
+        # Returns the configured session storage
+        #
+        # @return [Symbol]
+        #
+        # @api public
+        # @since 2.0.0
+        attr_reader :storage
 
+        # Returns the configured session storage options
+        #
+        # @return [Array]
+        #
+        # @api public
+        # @since 2.0.0
+        attr_reader :options
+
+        # Returns a new `Sessions`.
+        #
+        # You should not need to initialize this class directly. Instead use
+        # {Hanami::Config::Actions#sessions=}.
+        #
+        # @example
+        #   config.actions.sessions = :cookie, {secret: "xyz"}
+        #
+        # @api private
+        # @since 2.0.0
         def initialize(storage = nil, *options)
           @storage = storage
           @options = options
         end
 
+        # Returns true if sessions have been enabled.
+        #
+        # @return [Boolean]
+        #
+        # @api public
+        # @since 2.0.0
         def enabled?
           !storage.nil?
         end
 
+        # Returns an array of the session storage middleware name and its options, or an empty array
+        # if sessions have not been enabled.
+        #
+        # @return [Array<(Symbol, Array)>]
+        #
+        # @api public
+        # @since 2.0.0
         def middleware
-          return [] if !enabled?
+          return [] unless enabled?
 
-          [[storage_middleware, options]]
+          [storage_middleware, options].flatten(1)
         end
 
         private

data/lib/hanami/config/actions.rb

@@ -1,33 +1,104 @@
 # frozen_string_literal: true
 
 require "dry/configurable"
-require_relative "actions/cookies"
-require_relative "actions/sessions"
-require_relative "actions/content_security_policy"
-require_relative "../slice/view_name_inferrer"
 
 module Hanami
   class Config
     # Hanami actions config
     #
+    # This exposes all the settings from the standalone `Hanami::Action` class, pre-configured with
+    # sensible defaults for actions within a full Hanami app. It also provides additional settings
+    # for further integration of actions with other full stack app components.
+    #
     # @since 2.0.0
+    # @api public
     class Actions
       include Dry::Configurable
 
+      # @!attribute [rw] cookies
+      #   Sets or returns a hash of cookie options for actions.
+      #
+      #   The hash is wrapped by {Hanami::Config::Actions::Cookies}, which also provides an
+      #   `enabled?` method, returning true in the case of any options provided.
+      #
+      #   @example
+      #     config.actions.cookies = {max_age: 300}
+      #
+      #   @return [Hanami::Config::Actions::Cookies]
+      #
+      #   @api public
+      #   @since 2.0.0
       setting :cookies, default: {}, constructor: -> options { Cookies.new(options) }
+
+      # @!attribute [rw] sessions
+      #   Sets or returns the session store (and its options) for actions.
+      #
+      #   The given values are taken as an argument list to be passed to {Config::Sessions#initialize}.
+      #
+      #   The configured session store is used when setting up the app or slice
+      #   {Slice::ClassMethods#router router}.
+      #
+      #   @example
+      #     config.actions.sessions = :cookie, {secret: "xyz"}
+      #
+      #   @return [Config::Sessions]
+      #
+      #   @see Config::Sessions
+      #   @see Slice::ClassMethods#router
+      #
+      #   @api public
+      #   @since 2.0.0
       setting :sessions, constructor: proc { |storage, *options| Sessions.new(storage, *options) }
+
+      # @!attribute [rw] csrf_protection
+      #   Sets or returns whether CSRF protection should be enabled for action classes.
+      #
+      #   Defaults to true if {#sessions} is enabled. You can override this by explicitly setting a
+      #   true or false value.
+      #
+      #   When true, this will include `Hanami::Action::CSRFProtection` in all action classes.
+      #
+      #   @return [Boolean]
+      #
+      #   @api public
+      #   @since 2.0.0
       setting :csrf_protection
 
+      # Returns the Content Security Policy config for actions.
+      #
+      # The resulting policy is set as a default `"Content-Security-Policy"` response header.
+      #
+      # @return [Hanami::Config::Actions::ContentSecurityPolicy]
+      #
+      # @api public
+      # @since 2.0.0
+      attr_accessor :content_security_policy
+
+      # The following settings are for view and assets integration with actions, and are NOT
+      # publicly released as of 2.0.0. We'll make full documentation available when these become
+      # public in a subsequent release.
+
+      # @!attribute [rw] name_inference_base
+      #   @api private
       setting :name_inference_base, default: "actions"
+
+      # @!attribute [rw] view_context_identifier
+      #   @api private
       setting :view_context_identifier, default: "views.context"
+
+      # @!attribute [rw] view_name_inferrer
+      #   @api private
       setting :view_name_inferrer, default: Slice::ViewNameInferrer
-      setting :view_name_inference_base, default: "views"
 
-      attr_accessor :content_security_policy
+      # @!attribute [rw] view_name_inference_base
+      #   @api private
+      setting :view_name_inference_base, default: "views"
 
+      # @api private
       attr_reader :base_config
       protected :base_config
 
+      # @api private
       def initialize(*, **options)
         super()
 
@@ -42,32 +113,25 @@ module Hanami
         configure_defaults
       end
 
+      # @api private
       def initialize_copy(source)
         super
         @base_config = source.base_config.dup
         @content_security_policy = source.content_security_policy.dup
       end
+      private :initialize_copy
 
+      # @api private
       def finalize!
         # A nil value for `csrf_protection` means it has not been explicitly configured
         # (neither true nor false), so we can default it to whether sessions are enabled
         self.csrf_protection = sessions.enabled? if csrf_protection.nil?
 
         if content_security_policy
-          default_headers["Content-Security-Policy"] = content_security_policy.to_str
+          default_headers["Content-Security-Policy"] = content_security_policy.to_s
         end
       end
 
-      # Returns the list of available settings
-      #
-      # @return [Set]
-      #
-      # @since 2.0.0
-      # @api private
-      def settings
-        Hanami::Action.settings + self.class.settings
-      end
-
       private
 
       # Apply defaults for base config