hanami 2.1.0.rc1 → 2.1.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ba29263713547809e78df051e0138f202d947ce6e9cf2bc9d06c5bf79438cb7
-  data.tar.gz: 0677ae36e85bbb92ed1bdde4ae48e92ac062ccf89f6d77b86b85578fd8975a06
+  metadata.gz: f126bd2f756323d71dfe0eedd34a45f998882fd1ef2e0afcc8d05c27de224e3a
+  data.tar.gz: c9b360c13dbb7ce88e935df753a4d9ec4234f02bc625c403664fb44617ff6261
 SHA512:
-  metadata.gz: f24d67421d88e019d3fdf1d282fd55cff3a303e59fa7195fc8b152a6b85d1990aafe1cf3c583eeb2b561cfcae4b76e4120ef9863f12cee424c8372526cfb178a
-  data.tar.gz: 8e9ab011e12426e7d2e03ed784858309f7ca33fa8aa84d23ae84cd7d9435563998f38cb9d53322e2631c017334465cec10e0b2f65a58d8dcb0290c360dff5b1c
+  metadata.gz: ef015d93dfbd94b0f0617cc0966f1d081e06859b2559de39c3b180dc9afc9d0e9034d53dc66117ea7305e80afd8f643a4204246dcba202da8f3c49b59c108426
+  data.tar.gz: bced4c311fbcf6ee66e3036cb70fd9f9edc7cb897f6ff26eca660b30a94629297ec5abc3dfb5c849d04f682f66d45e0c2aa55b46829b9ce7b5edeef80a3e9247

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 The web, with simplicity.
 
+## v2.1.0.rc3 - 2024-02-16
+
+### Changed
+
+- [Tim Riley] Return `nil` when setting content via `#content_for` on the app's view context. This
+  allows it to be used with tempalte output tags (such as ERB's `<%=`) that capture a block for the
+  given content. (#1369)
+
+## Fixed
+
+- [Tim Riley] Ensure assets Rake task for Heroku works (#1368)
+
+## v2.1.0.rc2 - 2023-11-08
+
+### 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

data/hanami.gemspec

@@ -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.0.rc3"
+  spec.add_dependency "hanami-utils",     "~> 2.1.rc"
   spec.add_dependency "zeitwerk",         "~> 2.6"
 
   spec.add_development_dependency "rspec",     "~> 3.8"

data/lib/hanami/app.rb

@@ -161,11 +161,6 @@ module Hanami
           require_relative "providers/rack"
           register_provider(:rack, source: Hanami::Providers::Rack, namespace: true)
         end
-
-        if Hanami.bundled?("hanami-assets")
-          require_relative "providers/assets"
-          register_provider(:assets, source: Providers::Assets.for_slice(self))
-        end
       end
 
       def prepare_autoloader

data/lib/hanami/config/actions.rb

@@ -88,20 +88,19 @@ module Hanami
       #   @since 2.1.0
       setting :method_override, default: true
 
-      # 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
+      #   @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

@@ -99,7 +99,6 @@ module Hanami
       rack.monitor
       routes
       settings
-      assets
     ]
 
     # @!attribute [rw] no_auto_register_paths
@@ -251,16 +250,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 +285,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)
@@ -295,15 +308,7 @@ 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")
-        )
+        Hanami::Config::Assets.new
       }
 
       yield self if block_given?

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,22 +133,54 @@ module Hanami
               @content_for = source.instance_variable_get(:@content_for).dup
             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"
+                msg =
+                  if Hanami.bundled?("hanami-assets")
+                    "Have you put files into your assets directory?"
+                  else
+                    "The hanami-assets gem is required to access assets."
+                  end
+
+                raise Hanami::ComponentLoadError, "Assets not available. #{msg}"
               end
 
               @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"
+                raise Hanami::ComponentLoadError, "Request not available. Only views rendered from Hanami::Action instances have a request."
               end
 
               @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"
@@ -128,28 +189,79 @@ 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
+                nil
               elsif value
                 @content_for[key] = value
+                nil
               else
                 @content_for[key]
               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,9 +3,11 @@
 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
 
@@ -13,7 +15,11 @@ module Hanami
           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 SliceConfiguredPart.new(slice)
 
@@ -28,7 +34,7 @@ module Hanami
         #
         # Use this when you need to access helpers inside your part classes.
         #
-        # @return PartHelpers
+        # @return [Object] the helpers object
         #
         # @api public
         # @since 2.1.0
@@ -50,10 +56,16 @@ module Hanami
 
         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

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`

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

@@ -3,19 +3,30 @@
 module Hanami
   module Extensions
     module View
-      # @api private
+      # Provides slice-specific helper methods any view object requiring access to helpers.
+      #
+      # @api public
+      # @since 2.1.0
       class SliceConfiguredHelpers < 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(klass)
           include_helpers(klass)
         end
 
+        # @return [String]
+        #
+        # @api public
+        # @since 2.1.0
         def inspect
           "#<#{self.class.name}[#{slice.name}]>"
         end

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

@@ -6,7 +6,7 @@ module Hanami
       # Provides slice-specific configuration and behavior for any view part class defined within a
       # slice's module namespace.
       #
-      # @api private
+      # @api public
       # @since 2.1.0
       class SliceConfiguredPart < Module
         attr_reader :slice
@@ -24,7 +24,9 @@ module Hanami
           define_new
         end
 
-        # @api private
+        # @return [String]
+        #
+        # @api public
         # @since 2.1.0
         def inspect
           "#<#{self.class.name}[#{slice.name}]>"
@@ -49,9 +51,6 @@ module Hanami
         #   # Useful when unit testing parts
         #   part = MyApp::Views::Parts::Post.new(value: hello_world_post)
         #   part.title_tag # => "<h1>Hello world</h1>"
-        #
-        # @api private
-        # @since 2.1.0
         def define_new
           slice = self.slice
 

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

@@ -3,11 +3,11 @@
 module Hanami
   module Extensions
     module View
-      # Provides slice-specific configuration and behavior for any view class defined
-      # within a slice's module namespace.
+      # Provides slice-specific configuration and behavior for any view class defined within a
+      # slice's module namespace.
       #
-      # @api private
-      # @since 2.0.0
+      # @api public
+      # @since 2.1.0
       class SliceConfiguredView < Module
         TEMPLATES_DIR = "templates"
         VIEWS_DIR = "views"
@@ -16,17 +16,25 @@ module Hanami
 
         attr_reader :slice
 
+        # @api private
+        # @since 2.1.0
         def initialize(slice)
           super()
           @slice = slice
         end
 
+        # @api private
+        # @since 2.1.0
         def extended(view_class)
           load_app_view
           configure_view(view_class)
           define_inherited
         end
 
+        # @return [String]
+        #
+        # @api public
+        # @since 2.1.0
         def inspect
           "#<#{self.class.name}[#{slice.name}]>"
         end

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

@@ -3,6 +3,10 @@
 module Hanami
   module Extensions
     module View
+      # Module including the standard library of Hanami helpers
+      #
+      # @api public
+      # @since 2.1.0
       module StandardHelpers
         include Hanami::View::Helpers::EscapeHelper
         include Hanami::View::Helpers::NumberFormattingHelper