hanami 2.1.0.beta2.1 → 2.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219f0622f399b1e3f94c77c5d7556b6bdd26122181929b444eb8fca436e9d0d2
-  data.tar.gz: 3dc2468f5561eb8d70fa62d3f5b7f755f096ab764cfbfd43fca93d6001061908
+  metadata.gz: 8a6835d72654251d1461ea2ad61c9fe56ad9b37b0ff333d23dc444e205b32ab1
+  data.tar.gz: 3daf6e28931aa6abf0c3579d95c8e403c1ba12bbcb5879549825e03ae8e81556
 SHA512:
-  metadata.gz: f38c4b54000182e7ab4fb63be367131c6580df35519f97d5fd171de016b4ec96590c5f7c0822044421e0efec64813a492d4e106a803ea6028ba6d6d105db2ee6
-  data.tar.gz: 8648d6b907fbc4a600a4561184631b2868a577a2280c6bade34af1726d3bd6458045268c8517956e52bc4e6b2a6dfc78b0bee938e254563cac3fbbae91afc6d2
+  metadata.gz: 4b79171920231066598260223766e9abaee75806c751bcf83ca9ddaa93ef2eabef1fabc3077674cb81f25e435fa8659a04f9c272200a4ed27fa02c271ac03531
+  data.tar.gz: 04072a74f320abda02874ace16c616db0f3db9bb63de4d3b00746f3c1898c1dc58a143abd47915c9ef0a32b0a5eda860bd9264bccd375779d87bb101e4686dc1

data/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 The web, with simplicity.
 
+## Changed
+
+- [Tim Riley] Enable `config.render_detailed_errors` in development mode only by default. (#1365)
+- [Tim Riley] Remove current_path from context (#1362)
+
+## v2.1.0.rc1 - 2023-11-01
+
+### Added
+
+- [Aaron Moodie & Tim Riley] Render a welcome page when no routes are defined (#1353)
+- [Luca Guidi] Allow _Method Override_ by default, by mounting `Rack::MethodOverride` middleware. (#1344)
+
+### Fixed
+
+- [Luca Guidi] Ensure compatibility with Ruby Logger from stdlib (#1352)
+
+### Changed
+
+- [Philip Arndt] Add support for a slice's class definition file to exist inside either `config/slices/[slice_name].rb` or `slices/[slice_name]/config/slice.rb`, in that order of precedence, so that a slice can provide its own definition which the app, or the slice's parent slice if that exists, can override if needed.
+- [Tim Riley] Use `helpers` prefix to access helper methods from view parts (e.g. `helpers.format_number`)
+- [Tim Riley] Make it possible to directly initialize view parts to ease their unit tests (#1357)
+- [Tim Riley] Remove short names for assets helpers (#1356):
+  - Keep `javascript_tag` (remove `javascript` and `js` aliases)
+  - Keep `stylesheet_tag` (renamed from `stylesheet_link_tag`; remove `stylesheet` and `css` aliases)
+  - Keep `favicon_tag` (renamed from `favicon_link_tag`; remove `favicon` alias)
+  - Keep `image_tag` (remove `image` alias)
+  - Keep `video_tag` (remove `video` alias)
+  - Keep `audio_tag` (remove `audio` alias)
+
+
 ## v2.1.0.beta2.1 - 2023-10-04
 
 ### Added

data/hanami.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$LOAD_PATH.prepend(lib) unless $LOAD_PATH.include?(lib)
 require "hanami/version"
 
 Gem::Specification.new do |spec|
@@ -38,8 +38,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-monitor",      "~> 1.0", ">= 1.0.1", "< 2"
   spec.add_dependency "dry-system",       "~> 1.0", "< 2"
   spec.add_dependency "dry-logger",       "~> 1.0", "< 2"
-  spec.add_dependency "hanami-cli",       "~> 2.1.beta"
-  spec.add_dependency "hanami-utils",     "~> 2.1.beta"
+  spec.add_dependency "hanami-cli",       "~> 2.1.rc"
+  spec.add_dependency "hanami-utils",     "~> 2.1.rc"
   spec.add_dependency "zeitwerk",         "~> 2.6"
 
   spec.add_development_dependency "rspec",     "~> 3.8"

data/lib/hanami/config/actions.rb

@@ -74,20 +74,33 @@ module Hanami
       # @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] method_override
+      #   Sets or returns whether HTTP method override should be enabled for action classes.
+      #
+      #   Defaults to true. You can override this by explicitly setting a
+      #   true or false value.
+      #
+      #   When true, this will mount `Rack::MethodOverride` in the Rack middleware stack of the App.
+      #
+      #   @return [Boolean]
+      #
+      #   @api public
+      #   @since 2.1.0
+      setting :method_override, default: true
 
       # @!attribute [rw] name_inference_base
       #   @api private
+      #   @since 2.1.0
       setting :name_inference_base, default: "actions"
 
       # @!attribute [rw] view_name_inferrer
       #   @api private
+      #   @since 2.1.0
       setting :view_name_inferrer, default: Slice::ViewNameInferrer
 
       # @!attribute [rw] view_name_inference_base
       #   @api private
+      #   @since 2.1.0
       setting :view_name_inference_base, default: "views"
 
       # @api private

data/lib/hanami/config/assets.rb

@@ -9,7 +9,7 @@ module Hanami
     #
     # This exposes all the settings from the standalone `Hanami::Assets` 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.
+    # for further integration of assets with other full stack app components.
     #
     # @since 2.1.0
     # @api public

data/lib/hanami/config/views.rb

@@ -7,16 +7,22 @@ module Hanami
   class Config
     # Hanami views config
     #
-    # This is NOT RELEASED as of 2.0.0.
+    # This exposes all the settings from the standalone `Hanami::View` class, pre-configured with
+    # sensible defaults for actions within a full Hanami app. It also provides additional settings
+    # for further integration of views with other full stack app components.
     #
-    # @api private
+    # @since 2.1.0
+    # @api public
     class Views
       include Dry::Configurable
 
+      # @api private
+      # @since 2.1.0
       attr_reader :base_config
       protected :base_config
 
       # @api private
+      # @since 2.1.0
       def initialize(*)
         super
 
@@ -26,6 +32,7 @@ module Hanami
       end
 
       # @api private
+      # @since 2.1.0
       def initialize_copy(source)
         super
         @base_config = source.base_config.dup
@@ -33,6 +40,7 @@ module Hanami
       private :initialize_copy
 
       # @api private
+      # @since 2.1.0
       def finalize!
         return self if frozen?
 

data/lib/hanami/config.rb

@@ -251,16 +251,30 @@ module Hanami
 
     # Returns the app's views config, or a null config if hanami-view is not bundled.
     #
-    # This is NOT RELEASED as of 2.0.0.
+    # @example When hanami-view is bundled
+    #   config.views.paths # => [...]
     #
-    # @api private
+    # @example When hanami-view is not bundled
+    #   config.views.paths # => NoMethodError
+    #
+    # @return [Hanami::Config::Views, Hanami::Config::NullConfig]
+    #
+    # @api public
+    # @since 2.1.0
     attr_reader :views
 
-    # Returns the app's assets config.
+    # Returns the app's views config, or a null config if hanami-view is not bundled.
     #
-    # This is NOT RELEASED as of 2.0.0.
+    # @example When hanami-view is bundled
+    #   config.views.paths # => [...]
     #
-    # @api private
+    # @example When hanami-view is not bundled
+    #   config.views.paths # => NoMethodError
+    #
+    # @return [Hanami::Config::Assets, Hanami::Config::NullConfig]
+    #
+    # @api public
+    # @since 2.1.0
     attr_reader :assets
 
     # @api private
@@ -272,7 +286,7 @@ module Hanami
       # Apply default values that are only knowable at initialize-time (vs require-time)
       self.root = Dir.pwd
       self.render_errors = (env == :production)
-      self.render_detailed_errors = (env != :production)
+      self.render_detailed_errors = (env == :development)
       load_from_env
 
       @logger = Config::Logger.new(env: env, app_name: app_name)
@@ -296,13 +310,8 @@ module Hanami
       @assets = load_dependent_config("hanami-assets") {
         require_relative "config/assets"
 
-        public_dir = root.join("public")
-
         Hanami::Config::Assets.new(
-          # TODO: check if `sources` are still needed
-          sources: root.join("app", "assets"),
-          destination: public_dir.join("assets"),
-          manifest_path: public_dir.join("assets.json")
+          manifest_path: root.join("public", "assets.json")
         )
       }
 

data/lib/hanami/extensions/action/slice_configured_action.rb

@@ -31,14 +31,14 @@ module Hanami
         # @see Hanami::Extensions::Action::InstanceMethods#initialize
         def define_new
           resolve_view = method(:resolve_paired_view)
-          resolve_view_context = method(:resolve_view_context)
+          view_context_class = method(:view_context_class)
           resolve_routes = method(:resolve_routes)
           resolve_rack_monitor = method(:resolve_rack_monitor)
 
           define_method(:new) do |**kwargs|
             super(
               view: kwargs.fetch(:view) { resolve_view.(self) },
-              view_context: kwargs.fetch(:view_context) { resolve_view_context.() },
+              view_context_class: kwargs.fetch(:view_context_class) { view_context_class.() },
               routes: kwargs.fetch(:routes) { resolve_routes.() },
               rack_monitor: kwargs.fetch(:rack_monitor) { resolve_rack_monitor.() },
               **kwargs,
@@ -128,9 +128,9 @@ module Hanami
           nil
         end
 
-        def resolve_view_context
+        def view_context_class
           if Hanami.bundled?("hanami-view")
-            return Extensions::View::Context.context_class(slice).new
+            return Extensions::View::Context.context_class(slice)
           end
 
           # If hanami-view isn't bundled, try and find a possible third party context class with the
@@ -139,7 +139,7 @@ module Hanami
             views_namespace = slice.namespace.const_get(:Views)
 
             if views_namespace.const_defined?(:Context)
-              views_namespace.const_get(:Context).new
+              views_namespace.const_get(:Context)
             end
           end
         end

data/lib/hanami/extensions/action.rb

@@ -40,7 +40,7 @@ module Hanami
         attr_reader :view
 
         # @api private
-        attr_reader :view_context
+        attr_reader :view_context_class
 
         # Returns the app or slice's {Hanami::Slice::RoutesHelper RoutesHelper} for use within
         # action instance methods.
@@ -70,9 +70,9 @@ module Hanami
         #
         #   @api public
         #   @since 2.0.0
-        def initialize(view: nil, view_context: nil, rack_monitor: nil, routes: nil, **kwargs)
+        def initialize(view: nil, view_context_class: nil, rack_monitor: nil, routes: nil, **kwargs)
           @view = view
-          @view_context = view_context
+          @view_context_class = view_context_class
           @routes = routes
           @rack_monitor = rack_monitor
 
@@ -104,7 +104,7 @@ module Hanami
 
         # @api private
         def view_options(request, response)
-          {context: view_context&.with(**view_context_options(request, response))}.compact
+          {context: view_context_class&.new(**view_context_options(request, response))}.compact
         end
 
         # @api private

data/lib/hanami/extensions/view/context.rb

@@ -7,15 +7,15 @@ module Hanami
     module View
       # View context for views in Hanami apps.
       #
-      # This is NOT RELEASED as of 2.0.0.
-      #
-      # @api private
+      # @api public
+      # @since 2.1.0
       module Context
         class << self
           # Returns a context class for the given slice. If a context class is not defined, defines
           # a class named `Views::Context` within the slice's namespace.
           #
           # @api private
+          # @since 2.1.0
           def context_class(slice)
             views_namespace = views_namespace(slice)
 
@@ -30,6 +30,8 @@ module Hanami
 
           private
 
+          # @api private
+          # @since 2.1.0
           def context_superclass(slice)
             return Hanami::View::Context if Hanami.app.equal?(slice)
 
@@ -44,8 +46,10 @@ module Hanami
             end
           end
 
-          # TODO: this could be moved into the top-level Extensions::View
+          # @api private
+          # @since 2.1.0
           def views_namespace(slice)
+            # TODO: this could be moved into the top-level Extensions::View
             if slice.namespace.const_defined?(:Views)
               slice.namespace.const_get(:Views)
             else
@@ -54,6 +58,8 @@ module Hanami
           end
         end
 
+        # @api private
+        # @since 2.1.0
         module ClassExtension
           def self.included(context_class)
             super
@@ -63,18 +69,39 @@ module Hanami
             context_class.prepend(InstanceMethods)
           end
 
+          # @api private
+          # @since 2.1.0
           module ClassMethods
+            # @api private
+            # @since 2.1.0
             def configure_for_slice(slice)
               extend SliceConfiguredContext.new(slice)
             end
           end
 
+          # @api public
+          # @since 2.1.0
           module InstanceMethods
+            # Returns the app's inflector.
+            #
+            # @return [Dry::Inflector] the inflector
+            #
+            # @api public
+            # @since 2.1.0
             attr_reader :inflector
 
+            # Returns the app's settings.
+            #
+            # @return [Hanami::Settings] the settings
+            #
+            # @api public
+            # @since 2.1.0
             attr_reader :settings
 
             # @see SliceConfiguredContext#define_new
+            #
+            # @api private
+            # @since 2.1.0
             def initialize( # rubocop:disable Metrics/ParameterLists
               inflector: nil,
               settings: nil,
@@ -94,6 +121,8 @@ module Hanami
               super(**args)
             end
 
+            # @api private
+            # @since 2.1.0
             def initialize_copy(source)
               # The standard implementation of initialize_copy will make shallow copies of all
               # instance variables from the source. This is fine for most of our ivars.
@@ -104,17 +133,14 @@ module Hanami
               @content_for = source.instance_variable_get(:@content_for).dup
             end
 
-            def with(**args)
-              self.class.new(
-                inflector: @inflector,
-                settings: @settings,
-                assets: @assets,
-                routes: @routes,
-                request: @request,
-                **args
-              )
-            end
-
+            # Returns the app's assets.
+            #
+            # @return [Hanami::Assets] the assets
+            #
+            # @raise [Hanami::ComponentLoadError] if the hanami-assets gem is not bundled
+            #
+            # @api public
+            # @since 2.1.0
             def assets
               unless @assets
                 raise Hanami::ComponentLoadError, "the hanami-assets gem is required to access assets"
@@ -123,6 +149,14 @@ module Hanami
               @assets
             end
 
+            # Returns the current request, if  the view is rendered from within an action.
+            #
+            # @return [Hanami::Action::Request] the request
+            #
+            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request
+            #
+            # @api public
+            # @since 2.1.0
             def request
               unless @request
                 raise Hanami::ComponentLoadError, "only views rendered from Hanami::Action instances have a request"
@@ -131,6 +165,15 @@ module Hanami
               @request
             end
 
+            # Returns the app's routes helper.
+            #
+            # @return [Hanami::Slice::RoutesHelper] the routes helper
+            #
+            # @raise [Hanami::ComponentLoadError] if the hanami-router gem is not bundled or routes
+            #   are not defined
+            #
+            # @api public
+            # @since 2.1.0
             def routes
               unless @routes
                 raise Hanami::ComponentLoadError, "the hanami-router gem is required to access routes"
@@ -139,6 +182,32 @@ module Hanami
               @routes
             end
 
+            # @overload content_for(key, value = nil, &block)
+            #   Stores a string or block of template markup for later use.
+            #
+            #   @param key [Symbol] the content key, for later retrieval
+            #   @param value [String, nil] the content, if no block is given
+            #
+            #   @return [String] the content
+            #
+            #   @example
+            #     content_for(:page_title, "Hello world")
+            #
+            #   @example In a template
+            #     <% content_for :page_title do %>
+            #       <h1>Hello world</h1>
+            #     <% end %>
+            #
+            # @overload content_for(key)
+            #   Returns the previously stored content for the given key.
+            #
+            #   @param key [Symbol] the content key
+            #
+            #   @return [String, nil] the content, or nil if no content previously stored with the
+            #     key
+            #
+            # @api public
+            # @since 2.1.0
             def content_for(key, value = nil)
               if block_given?
                 @content_for[key] = yield
@@ -149,18 +218,41 @@ module Hanami
               end
             end
 
-            def current_path
-              request.fullpath
-            end
-
+            # Returns the current request's CSRF token.
+            #
+            # @return [String] the token
+            #
+            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request
+            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled
+            #
+            # @api public
+            # @since 2.1.0
             def csrf_token
               request.session[Hanami::Action::CSRFProtection::CSRF_TOKEN]
             end
 
+            # Returns the session for the current request.
+            #
+            # @return [Rack::Session::Abstract::SessionHash] the session hash
+            #
+            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request
+            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled
+            #
+            # @api public
+            # @since 2.1.0
             def session
               request.session
             end
 
+            # Returns the flash hash for the current request.
+            #
+            # @return []
+            #
+            # @raise [Hanami::ComponentLoadError] if the view is not rendered from within a request
+            # @raise [Hanami::Action::MissingSessionError] if sessions are not enabled
+            #
+            # @api public
+            # @since 2.1.0
             def flash
               request.flash
             end

data/lib/hanami/extensions/view/part.rb

@@ -3,21 +3,82 @@
 module Hanami
   module Extensions
     module View
-      # @api private
+      # @api public
+      # @since 2.1.0
       module Part
+        # @api private
+        # @since 2.1.0
         def self.included(part_class)
           super
 
           part_class.extend(Hanami::SliceConfigurable)
-          part_class.include(StandardHelpers)
           part_class.extend(ClassMethods)
         end
 
+        # @api private
+        # @since 2.1.0
         module ClassMethods
+          # @api private
+          # @since 2.1.0
           def configure_for_slice(slice)
-            extend SliceConfiguredHelpers.new(slice)
+            extend SliceConfiguredPart.new(slice)
+
+            const_set :PartHelpers, Class.new(PartHelpers) { |klass|
+              klass.configure_for_slice(slice)
+            }
           end
         end
+
+        # Returns an object including the default Hanami helpers as well as the user-defined helpers
+        # for the part's slice.
+        #
+        # Use this when you need to access helpers inside your part classes.
+        #
+        # @return [Object] the helpers object
+        #
+        # @api public
+        # @since 2.1.0
+        def helpers
+          @helpers ||= self.class.const_get(:PartHelpers).new(context: _context)
+        end
+      end
+
+      # Standalone helpers class including both {StandardHelpers} as well as the user-defined
+      # helpers for the slice.
+      #
+      # Used used where helpers should be addressed via an intermediary object (i.e. in parts),
+      # rather than mixed into a class directly.
+      #
+      # @api private
+      # @since 2.1.0
+      class PartHelpers
+        extend Hanami::SliceConfigurable
+
+        include StandardHelpers
+
+        # @api private
+        # @since 2.1.0
+        def self.configure_for_slice(slice)
+          extend SliceConfiguredHelpers.new(slice)
+        end
+
+        # Returns the context for the current view rendering.
+        #
+        # @return [Hanami::View::Context] the context
+        #
+        # @api public
+        # @since 2.1.0
+        attr_reader :_context
+
+        # @api public
+        # @since 2.1.0
+        alias_method :context, :_context
+
+        # @api private
+        # @since 2.1.0
+        def initialize(context:)
+          @_context = context
+        end
       end
     end
   end

data/lib/hanami/extensions/view/scope.rb

@@ -4,7 +4,10 @@ module Hanami
   module Extensions
     module View
       # @api private
+      # @since 2.1.0
       module Scope
+        # @api private
+        # @since 2.1.0
         def self.included(scope_class)
           super
 
@@ -13,7 +16,11 @@ module Hanami
           scope_class.extend(ClassMethods)
         end
 
+        # @api private
+        # @since 2.1.0
         module ClassMethods
+          # @api private
+          # @since 2.1.0
           def configure_for_slice(slice)
             extend SliceConfiguredHelpers.new(slice)
           end

data/lib/hanami/extensions/view/slice_configured_context.rb

@@ -3,35 +3,39 @@
 module Hanami
   module Extensions
     module View
-      # Provides slice-specific configuration and behavior for any view context class
-      # defined within a slice's module namespace.
+      # Provides slice-specific configuration and behavior for any view context class defined within
+      # a slice's module namespace.
       #
-      # @api private
-      # @since 2.0.0
+      # @api public
+      # @since 2.1.0
       class SliceConfiguredContext < Module
         attr_reader :slice
 
+        # @api private
+        # @since 2.1.0
         def initialize(slice)
           super()
           @slice = slice
         end
 
+        # @api private
+        # @since 2.1.0
         def extended(_context_class)
           define_new
         end
 
+        # @api public
+        # @since 2.1.0
         def inspect
           "#<#{self.class.name}[#{slice.name}]>"
         end
 
         private
 
-        # Defines a {.new} method on the context class that resolves key components from
-        # the app container and provides them to {#initialize} as injected
-        # dependencies.
+        # Defines a {.new} method on the context class that resolves key components from the app
+        # container and provides them to {#initialize} as injected dependencies.
         #
         # This includes the following app components:
-        #
         #   - the configured inflector as `inflector`
         #   - "settings" from the app container as `settings`
         #   - "routes" from the app container as `routes`