hanami 2.1.0.beta2.1 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219f0622f399b1e3f94c77c5d7556b6bdd26122181929b444eb8fca436e9d0d2
-  data.tar.gz: 3dc2468f5561eb8d70fa62d3f5b7f755f096ab764cfbfd43fca93d6001061908
+  metadata.gz: 3ba29263713547809e78df051e0138f202d947ce6e9cf2bc9d06c5bf79438cb7
+  data.tar.gz: 0677ae36e85bbb92ed1bdde4ae48e92ac062ccf89f6d77b86b85578fd8975a06
 SHA512:
-  metadata.gz: f38c4b54000182e7ab4fb63be367131c6580df35519f97d5fd171de016b4ec96590c5f7c0822044421e0efec64813a492d4e106a803ea6028ba6d6d105db2ee6
-  data.tar.gz: 8648d6b907fbc4a600a4561184631b2868a577a2280c6bade34af1726d3bd6458045268c8517956e52bc4e6b2a6dfc78b0bee938e254563cac3fbbae91afc6d2
+  metadata.gz: f24d67421d88e019d3fdf1d282fd55cff3a303e59fa7195fc8b152a6b85d1990aafe1cf3c583eeb2b561cfcae4b76e4120ef9863f12cee424c8372526cfb178a
+  data.tar.gz: 8e9ab011e12426e7d2e03ed784858309f7ca33fa8aa84d23ae84cd7d9435563998f38cb9d53322e2631c017334465cec10e0b2f65a58d8dcb0290c360dff5b1c

data/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 The web, with simplicity.
 
+## 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|

data/lib/hanami/config/actions.rb

@@ -74,6 +74,20 @@ module Hanami
       # @since 2.0.0
       attr_accessor :content_security_policy
 
+      # @!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
+
       # 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.

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

@@ -104,17 +104,6 @@ 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
-
             def assets
               unless @assets
                 raise Hanami::ComponentLoadError, "the hanami-assets gem is required to access assets"

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

@@ -4,20 +4,69 @@ module Hanami
   module Extensions
     module View
       # @api private
+      # @since 2.1.0
       module Part
         def self.included(part_class)
           super
 
           part_class.extend(Hanami::SliceConfigurable)
-          part_class.include(StandardHelpers)
           part_class.extend(ClassMethods)
         end
 
         module ClassMethods
           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 PartHelpers
+        #
+        # @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
+
+        def self.configure_for_slice(slice)
+          extend SliceConfiguredHelpers.new(slice)
+        end
+
+        # @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/slice_configured_part.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Hanami
+  module Extensions
+    module View
+      # Provides slice-specific configuration and behavior for any view part class defined within a
+      # slice's module namespace.
+      #
+      # @api private
+      # @since 2.1.0
+      class SliceConfiguredPart < 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)
+          define_new
+        end
+
+        # @api private
+        # @since 2.1.0
+        def inspect
+          "#<#{self.class.name}[#{slice.name}]>"
+        end
+
+        private
+
+        # Defines a `.new` method on the part class that provides a default `rendering:` argument of
+        # a rendering coming from a view configured for the slice. This means that any part can be
+        # initialized standalone (with a `value:` only) and still have access to all the integrated
+        # view facilities from the slice, such as helpers. This is helpful when unit testing parts.
+        #
+        # @example
+        #   module MyApp::Views::Parts
+        #     class Post < MyApp::View::Part
+        #       def title_tag
+        #         helpers.h1(value.title)
+        #       end
+        #     end
+        #   end
+        #
+        #   # 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
+
+          define_method(:new) do |**args|
+            return super(**args) if args.key?(:rendering)
+
+            slice_rendering = Class.new(Hanami::View)
+              .configure_for_slice(slice)
+              .new
+              .rendering
+
+            super(rendering: slice_rendering, **args)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -108,7 +108,7 @@ module Hanami
           #   - We are a slice, and the view's inherited `paths` is identical to the parent's config
           #     (which would result in the view in a slice erroneously trying to find templates in
           #     the app)
-          if (!slice.parent && view_class.config.paths.empty?) ||
+          if view_class.config.paths.empty? ||
              (slice.parent && view_class.config.paths.map(&:dir) == [templates_path(slice.parent)])
             view_class.config.paths = templates_path(slice)
           end
@@ -178,7 +178,7 @@ module Hanami
             else
               views_namespace.const_set(:Part, Class.new(part_superclass).tap { |klass|
                 # Give the slice to `configure_for_slice`, since it cannot be inferred when it is
-                # called via `.inherited`, since the class is anonymous at this point
+                # called via `.inherited`, because the class is anonymous at this point
                 klass.configure_for_slice(slice)
               })
             end

data/lib/hanami/helpers/assets_helper.rb

@@ -154,7 +154,7 @@ module Hanami
       #
       #   # <script src="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.js"
       #   #         type="text/javascript"></script>
-      def javascript(*source_paths, **options)
+      def javascript_tag(*source_paths, **options)
         options = options.reject { |k, _| k.to_sym == :src }
 
         _safe_tags(*source_paths) do |source|
@@ -173,14 +173,6 @@ module Hanami
         end
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :js, :javascript
-
-      # @api public
-      # @since 2.1.0
-      alias_method :javascript_tag, :javascript
-
       # Generate `link` tag for given source(s)
       #
       # It accepts one or more strings representing the name of the asset, if it
@@ -255,7 +247,7 @@ module Hanami
       #
       #   # <link href="https://assets.bookshelf.org/assets/application-28a6b886de2372ee3922fcaf3f78f2d8.css"
       #   #       type="text/css" rel="stylesheet">
-      def stylesheet(*source_paths, **options)
+      def stylesheet_tag(*source_paths, **options)
         options = options.reject { |k, _| k.to_sym == :href }
 
         _safe_tags(*source_paths) do |source_path|
@@ -275,14 +267,6 @@ module Hanami
         end
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :css, :stylesheet
-
-      # @api public
-      # @since 2.1.0
-      alias_method :stylesheet_link_tag, :stylesheet
-
       # Generate `img` tag for given source
       #
       # It accepts one string representing the name of the asset, if it comes
@@ -346,7 +330,7 @@ module Hanami
       #   <%= image "logo.png" %>
       #
       #   # <img src="https://assets.bookshelf.org/assets/logo-28a6b886de2372ee3922fcaf3f78f2d8.png" alt="Logo">
-      def image(source, options = {})
+      def image_tag(source, options = {})
         options = options.reject { |k, _| k.to_sym == :src }
         attributes = {
           src: asset_url(source),
@@ -357,10 +341,6 @@ module Hanami
         tag.img(**attributes)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :image_tag, :image
-
       # Generate `link` tag application favicon.
       #
       # If no argument is given, it assumes `favico.ico` from the application.
@@ -416,7 +396,7 @@ module Hanami
       #
       #   # <link href="https://assets.bookshelf.org/assets/favicon-28a6b886de2372ee3922fcaf3f78f2d8.ico"
       #           rel="shortcut icon" type="image/x-icon">
-      def favicon(source = DEFAULT_FAVICON, options = {})
+      def favicon_tag(source = DEFAULT_FAVICON, options = {})
         options = options.reject { |k, _| k.to_sym == :href }
 
         attributes = {
@@ -429,10 +409,6 @@ module Hanami
         tag.link(**attributes)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :favicon_link_tag, :favicon
-
       # Generate `video` tag for given source
       #
       # It accepts one string representing the name of the asset, if it comes
@@ -530,15 +506,11 @@ module Hanami
       #   <%= video "movie.mp4" %>
       #
       #   # <video src="https://assets.bookshelf.org/assets/movie-28a6b886de2372ee3922fcaf3f78f2d8.mp4"></video>
-      def video(source = nil, options = {}, &blk)
+      def video_tag(source = nil, options = {}, &blk)
         options = _source_options(source, options, &blk)
         tag.video(**options, &blk)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :video_tag, :video
-
       # Generate `audio` tag for given source
       #
       # It accepts one string representing the name of the asset, if it comes
@@ -636,15 +608,11 @@ module Hanami
       #   <%= audio "song.ogg" %>
       #
       #   # <audio src="https://assets.bookshelf.org/assets/song-28a6b886de2372ee3922fcaf3f78f2d8.ogg"></audio>
-      def audio(source = nil, options = {}, &blk)
+      def audio_tag(source = nil, options = {}, &blk)
         options = _source_options(source, options, &blk)
         tag.audio(**options, &blk)
       end
 
-      # @api public
-      # @since 2.1.0
-      alias_method :audio_tag, :audio
-
       # It generates the relative or absolute URL for the given asset.
       # It automatically decides if it has to use the relative or absolute
       # depending on the configuration and current environment.

data/lib/hanami/routes.rb

@@ -60,6 +60,35 @@ module Hanami
       end
     end
 
+    # Wrapper class for the (otherwise opaque) proc returned from {.routes}, adding an `#empty?`
+    # method that returns true if no routes were defined.
+    #
+    # This is useful when needing to determine behaviour based on the presence of user-defined
+    # routes, such as determining whether to show the Hanami welcome page in {Slice#load_router}.
+    #
+    # @api private
+    # @since 2.1.0
+    class RoutesProc < DelegateClass(Proc)
+      # @api private
+      # @since 2.1.0
+      def self.empty
+        new(proc {}, empty: true)
+      end
+
+      # @api private
+      # @since 2.1.0
+      def initialize(proc, empty: false)
+        @empty = empty
+        super(proc)
+      end
+
+      # @api private
+      # @since 2.1.0
+      def empty?
+        !!@empty
+      end
+    end
+
     # @api private
     def self.routes
       @routes ||= build_routes
@@ -68,9 +97,9 @@ module Hanami
     class << self
       # @api private
       def build_routes(definitions = self.definitions)
-        return if definitions.empty?
+        return RoutesProc.empty if definitions.empty?
 
-        proc do
+        routes_proc = proc do
           definitions.each do |(name, args, kwargs, block)|
             if block
               public_send(name, *args, **kwargs, &block)
@@ -79,6 +108,8 @@ module Hanami
             end
           end
         end
+
+        RoutesProc.new(routes_proc)
       end
 
       # @api private

data/lib/hanami/slice.rb

@@ -952,6 +952,7 @@ module Hanami
         config = self.config
         rack_monitor = self["rack.monitor"]
 
+        show_welcome = Hanami.env?(:development) && routes.empty?
         render_errors = render_errors?
         render_detailed_errors = render_detailed_errors?
 
@@ -971,6 +972,8 @@ module Hanami
         ) do
           use(rack_monitor)
 
+          use(Hanami::Web::Welcome) if show_welcome
+
           use(
             Hanami::Middleware::RenderErrors,
             config,
@@ -982,8 +985,15 @@ module Hanami
             use(Hanami::Webconsole::Middleware, config)
           end
 
-          if Hanami.bundled?("hanami-controller") && config.actions.sessions.enabled?
-            use(*config.actions.sessions.middleware)
+          if Hanami.bundled?("hanami-controller")
+            if config.actions.method_override
+              require "rack/method_override"
+              use(Rack::MethodOverride)
+            end
+
+            if config.actions.sessions.enabled?
+              use(*config.actions.sessions.middleware)
+            end
           end
 
           if Hanami.bundled?("hanami-assets") && config.assets.serve

data/lib/hanami/slice_registrar.rb

@@ -46,19 +46,16 @@ module Hanami
     end
 
     def load_slices
-      slice_configs = Dir[root.join(CONFIG_DIR, SLICES_DIR, "*#{RB_EXT}")]
-        .map { |file| File.basename(file, RB_EXT) }
+      slice_configs = root.join(CONFIG_DIR, SLICES_DIR).glob("*#{RB_EXT}")
+        .map { _1.basename(RB_EXT) }
 
-      slice_dirs = Dir[File.join(root, SLICES_DIR, "*")]
-        .select { |path| File.directory?(path) }
-        .map { |path| File.basename(path) }
+      slice_dirs = root.join(SLICES_DIR).glob("*")
+        .select(&:directory?)
+        .map { _1.basename }
 
-      slice_names = (slice_dirs + slice_configs).uniq.sort
+      (slice_dirs + slice_configs).uniq.sort
         .then { filter_slice_names(_1) }
-
-      slice_names.each do |slice_name|
-        load_slice(slice_name)
-      end
+        .each(&method(:load_slice))
 
       self
     end
@@ -97,21 +94,20 @@ module Hanami
       parent.eql?(parent.app) ? Object : parent.namespace
     end
 
-    # Runs when a slice file has been found at `config/slices/[slice_name].rb`, or a slice directory
-    # at `slices/[slice_name]`. Attempts to require the slice class, if defined, before registering
-    # the slice. If a slice class is not found, registering the slice will generate the slice class.
+    # Runs when a slice file has been found inside the app at `config/slices/[slice_name].rb`,
+    # or when a slice directory exists at `slices/[slice_name]`.
+    #
+    # If a slice definition file is found by `find_slice_require_path`, then `load_slice` will
+    # require the file before registering the slice class.
+    #
+    # If a slice class is not found, registering the slice will generate the slice class.
     def load_slice(slice_name)
-      slice_require_path = root.join(CONFIG_DIR, SLICES_DIR, slice_name).to_s
-      begin
-        require(slice_require_path)
-      rescue LoadError => e
-        raise e unless e.path == slice_require_path
-      end
+      slice_require_path = find_slice_require_path(slice_name)
+      require slice_require_path if slice_require_path
 
-      slice_module_name = inflector.camelize("#{parent_slice_namespace.name}#{PATH_DELIMITER}#{slice_name}")
       slice_class =
         begin
-          inflector.constantize("#{slice_module_name}#{MODULE_DELIMITER}Slice")
+          inflector.constantize("#{slice_module_name(slice_name)}#{MODULE_DELIMITER}Slice")
         rescue NameError => e
           raise e unless e.name.to_s == inflector.camelize(slice_name) || e.name.to_s == :Slice
         end
@@ -119,11 +115,36 @@ module Hanami
       register(slice_name, slice_class)
     end
 
+    # Finds the path to the slice's definition file, if it exists, in the following order:
+    #
+    # 1. `config/slices/[slice_name].rb`
+    # 2. `slices/[parent_slice_name]/config/[slice_name].rb` (unless parent is the app)
+    # 3. `slices/[slice_name]/config/slice.rb`
+    #
+    # If the slice is nested under another slice then it will look in the following order:
+    #
+    # 1. `config/slices/[parent_slice_name]/[slice_name].rb`
+    # 2. `slices/[parent_slice_name]/config/[slice_name].rb`
+    # 3. `slices/[parent_slice_name]/[slice_name]/config/slice.rb`
+    def find_slice_require_path(slice_name)
+      app_slice_file_path = [slice_name]
+      app_slice_file_path.prepend(parent.slice_name) unless parent.eql?(parent.app)
+      ancestors = [
+        parent.app.root.join(CONFIG_DIR, SLICES_DIR, app_slice_file_path.join(File::SEPARATOR)),
+        parent.root.join(CONFIG_DIR, SLICES_DIR, slice_name),
+        root.join(SLICES_DIR, slice_name, CONFIG_DIR, "slice")
+      ]
+
+      ancestors
+        .uniq
+        .find { _1.sub_ext(RB_EXT).file? }
+        &.to_s
+    end
+
     def build_slice(slice_name, &block)
-      slice_module_name = inflector.camelize("#{parent_slice_namespace.name}#{PATH_DELIMITER}#{slice_name}")
       slice_module =
         begin
-          inflector.constantize(slice_module_name)
+          inflector.constantize(slice_module_name(slice_name))
         rescue NameError
           parent_slice_namespace.const_set(inflector.camelize(slice_name), Module.new)
         end
@@ -131,6 +152,10 @@ module Hanami
       slice_module.const_set(:Slice, Class.new(Hanami::Slice, &block))
     end
 
+    def slice_module_name(slice_name)
+      inflector.camelize("#{parent_slice_namespace.name}#{PATH_DELIMITER}#{slice_name}")
+    end
+
     def configure_slice(slice_name, slice)
       slice.instance_variable_set(:@parent, parent)
 

data/lib/hanami/version.rb

@@ -7,7 +7,7 @@ module Hanami
   # @api private
   module Version
     # @api public
-    VERSION = "2.1.0.beta2.1"
+    VERSION = "2.1.0.rc1"
 
     # @since 0.9.0
     # @api private