hanami-view 2.3.0 → 3.0.0.rc1

data/lib/hanami/view.rb

@@ -22,7 +22,6 @@ module Hanami
   # @since 2.1.0
   class View
     # @api private
-    # @since 2.1.0
     def self.gem_loader
       @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
         root = File.expand_path("..", __dir__)
@@ -31,13 +30,13 @@ module Hanami
         loader.ignore(
           "#{root}/hanami-view.rb",
           "#{root}/hanami/view/version.rb",
-          "#{root}/hanami/view/errors.rb",
+          "#{root}/hanami/view/errors.rb"
         )
         loader.inflector = Zeitwerk::GemInflector.new("#{root}/hanami-view.rb")
         loader.inflector.inflect(
           "erb" => "ERB",
           "html" => "HTML",
-          "html_safe_string_buffer" => "HTMLSafeStringBuffer",
+          "html_safe_string_buffer" => "HTMLSafeStringBuffer"
         )
       end
     end
@@ -45,7 +44,6 @@ module Hanami
     gem_loader.setup
 
     # @api private
-    # @since 2.1.0
     DEFAULT_RENDERER_OPTIONS = {default_encoding: "utf-8"}.freeze
 
     include Dry::Equalizer(:config, :exposures)
@@ -235,6 +233,23 @@ module Hanami
     # @!scope class
     setting :inflector, default: Dry::Inflector.new
 
+    # @overload config.decorate_exposures=(value)
+    #   Controls whether exposures are decorated by default.
+    #
+    #   When set to `true`, all exposures will be decorated with matching Parts unless explicitly
+    #   marked with `decorate: false`.
+    #
+    #   When set to `false` (the default), exposures will not be decorated unless explicitly marked
+    #   with `decorate: true`, or declared with `decorate`.
+    #
+    #   Defaults to `false`.
+    #
+    #   @param value [Boolean] whether to decorate exposures by default
+    #   @api public
+    #   @since x.x.x
+    # @!scope class
+    setting :decorate_exposures, default: false
+
     # @overload config.renderer_options=(options)
     #   A hash of options to pass to the template engine. Template engines are
     #   provided by Tilt; see Tilt's documentation for what options your
@@ -273,7 +288,6 @@ module Hanami
     # @!endgroup
 
     # @api private
-    # @since 2.1.0
     def self.inherited(klass)
       super
 
@@ -288,13 +302,13 @@ module Hanami
     #   @param options [Hash] the exposure's options
     #   @option options [Boolean] :layout expose this value to the layout (defaults to false)
     #   @option options [Boolean] :decorate decorate this value in a matching Part (defaults to
-    #     true)
+    #     false, or the value of `config.decorate_exposures`)
     #   @option options [Symbol, Class] :as an alternative name or class to use when finding a
     #     matching Part
 
     # @overload expose(name, **options, &block)
     #   Define a value to be passed to the template. The return value of the
-    #   block will be decorated by a matching Part and passed to the template.
+    #   block will be passed to the template.
     #
     #   The block will be evaluated with the view instance as its `self`. The
     #   block's parameters will determine what it is given:
@@ -329,8 +343,8 @@ module Hanami
     #
     # @overload expose(name, **options)
     #   Define a value to be passed to the template, provided by an instance
-    #   method matching the name. The method's return value will be decorated by
-    #   a matching Part and passed to the template.
+    #   method matching the name. The method's return value will be passed to
+    #   the template.
     #
     #   The method's parameters will determine what it is given:
     #
@@ -342,7 +356,7 @@ module Hanami
     #     default values for these parameters to make the corresponding input
     #     keys optional
     #   - To receive the Context object, provide a `context:` keyword parameter
-    #   - To receive the view's input arguments in their entirey, provide a
+    #   - To receive the view's input arguments in their entirety, provide a
     #     keywords splat parameter (i.e. `**input`)
     #
     #   @example Accessing input arguments
@@ -369,8 +383,8 @@ module Hanami
     #
     # @overload expose(name, **options)
     #   Define a single value to pass through from the input data (when there is
-    #   no instance method matching the `name`). This value will be decorated by
-    #   a matching Part and passed to the template.
+    #   no instance method matching the `name`). This value will be passed to
+    #   the template.
     #
     #   @param name [Symbol] name for the exposure
     #   @macro exposure_options
@@ -380,7 +394,7 @@ module Hanami
     # @overload expose(*names, **options)
     #   Define multiple values to pass through from the input data (when there
     #   is no instance methods matching their names). These values will be
-    #   decorated by matching Parts and passed through to the template.
+    #   passed through to the template.
     #
     #   The provided options will be applied to all the exposures.
     #
@@ -411,12 +425,23 @@ module Hanami
       expose(*names, **options, private: true, &block)
     end
 
+    # Defines an exposure that will be decorated with a matching Part.
+    #
+    # This is a shorthand for `expose(..., decorate: true)`.
+    #
+    # @see expose
+    #
+    # @api public
+    # @since 2.1.0
+    def self.decorate(*names, **options, &block)
+      expose(*names, **options, decorate: true, &block)
+    end
+
     # Returns the defined exposures. These are unbound, since bound exposures
     # are only created when initializing a View instance.
     #
     # @return [Exposures]
     # @api private
-    # @since 2.1.0
     def self.exposures
       @exposures ||= Exposures.new
     end
@@ -512,13 +537,6 @@ module Hanami
     # @!endgroup
 
     # @api private
-    # @since 2.1.0
-    def self.layout_path(layout)
-      File.join(*[config.layouts_dir, layout].compact)
-    end
-
-    # @api private
-    # @since 2.1.0
     def self.cache
       Cache
     end
@@ -534,6 +552,7 @@ module Hanami
       self.class.config.finalize!
       ensure_config
 
+      @config_data = config.to_data
       @exposures = self.class.exposures.bind(self)
     end
 
@@ -550,8 +569,7 @@ module Hanami
     # @return [Exposures]
     #
     # @api private
-    # @since 2.1.0
-    def exposures
+    def exposures # rubocop:disable Style/TrivialAccessors
       @exposures
     end
 
@@ -566,16 +584,20 @@ module Hanami
     #
     # @api public
     # @since 2.1.0
-    def call(format: config.default_format, context: config.default_context, layout: config.layout, **input)
+    def call(format: config_data.default_format,
+             context: config_data.default_context,
+             layout: config_data.layout,
+             **input)
       rendering = self.rendering(format: format, context: context)
+      scope_class = config_data.scope
 
       locals = locals(rendering, input)
-      output = rendering.template(config.template, rendering.scope(config.scope, locals))
+      output = rendering.template(config_data.template, rendering.scope(scope_class, locals))
 
       if layout
         output = rendering.template(
-          self.class.layout_path(layout),
-          rendering.scope(config.scope, layout_locals(locals))
+          layout_path(layout),
+          rendering.scope(scope_class, layout_locals(locals))
         ) { output }
       end
 
@@ -583,13 +605,18 @@ module Hanami
     end
 
     # @api private
-    # @since 2.1.0
-    def rendering(format: config.default_format, context: config.default_context)
-      Rendering.new(config: config, format: format, context: context)
+    def rendering(format: config_data.default_format, context: config_data.default_context)
+      Rendering.new(config_data:, format:, context:)
     end
 
     private
 
+    # Frozen Data snapshot of the view's resolved configuration values.
+    # Used for fast hot-path reads during rendering.
+    #
+    # @api private
+    attr_reader :config_data
+
     def ensure_config
       raise UndefinedConfigError, :paths unless Array(config.paths).any?
       raise UndefinedConfigError, :template unless config.template
@@ -597,7 +624,7 @@ module Hanami
 
     def locals(rendering, input)
       exposures.(context: rendering.context, **input) do |value, exposure|
-        if exposure.decorate? && value
+        if exposure.decorate?(default: config_data.decorate_exposures) && value
           rendering.part(exposure.name, value, as: exposure.options[:as])
         else
           value
@@ -605,6 +632,11 @@ module Hanami
       end
     end
 
+    # @api private
+    def layout_path(layout)
+      File.join(*[config_data.layouts_dir, layout].compact)
+    end
+
     def layout_locals(locals)
       locals.each_with_object({}) do |(key, value), layout_locals|
         layout_locals[key] = value if exposures[key].for_layout?

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: hanami-view
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Hanakai team
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -105,57 +105,19 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A complete, standalone view rendering system that gives you everything
   you need to write well-factored view code
 email:
 - info@hanakai.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 files:
 - CHANGELOG.md
+- LICENSE
 - README.md
 - hanami-view.gemspec
 - lib/hanami-view.rb
@@ -194,11 +156,10 @@ homepage: https://hanamirb.org
 licenses:
 - MIT
 metadata:
-  rubygems_mfa_required: 'true'
-  allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/hanami/view/blob/main/CHANGELOG.md
-  source_code_uri: https://github.com/hanami/view
-  bug_tracker_uri: https://github.com/hanami/view/issues
+  changelog_uri: https://github.com/hanami/hanami-view/blob/main/CHANGELOG.md
+  source_code_uri: https://github.com/hanami/hanami-view
+  bug_tracker_uri: https://github.com/hanami/hanami-view/issues
+  funding_uri: https://github.com/sponsors/hanami
 rdoc_options: []
 require_paths:
 - lib
@@ -206,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="