hanami-view 2.1.0.rc1 → 2.1.0.rc2

data/lib/hanami/view/rendering.rb

@@ -3,13 +3,22 @@
 module Hanami
   class View
     # @api private
+    # @since 2.1.0
     class Rendering
+      # @api private
+      # @since 2.1.0
       attr_reader :config, :format
 
+      # @api private
+      # @since 2.1.0
       attr_reader :inflector, :part_builder, :scope_builder
 
+      # @api private
+      # @since 2.1.0
       attr_reader :context, :renderer
 
+      # @api private
+      # @since 2.1.0
       def initialize(config:, format:, context:)
         @config = config
         @format = format
@@ -22,18 +31,26 @@ module Hanami
         @renderer = Renderer.new(config)
       end
 
+      # @api private
+      # @since 2.1.0
       def template(name, scope, &block)
         renderer.template(name, format, scope, &block)
       end
 
+      # @api private
+      # @since 2.1.0
       def partial(name, scope, &block)
         renderer.partial(name, format, scope, &block)
       end
 
+      # @api private
+      # @since 2.1.0
       def part(name, value, as: nil)
         part_builder.(name, value, as: as, rendering: self)
       end
 
+      # @api private
+      # @since 2.1.0
       def scope(name = nil, locals) # rubocop:disable Style/OptionalArguments
         scope_builder.(name, locals: locals, rendering: self)
       end

data/lib/hanami/view/rendering_missing.rb

@@ -6,31 +6,46 @@ require_relative "errors"
 module Hanami
   class View
     # @api private
+    # @since 2.1.0
     class RenderingMissing
+      # @api private
+      # @since 2.1.0
       def format
         raise RenderingMissingError
       end
 
+      # @api private
+      # @since 2.1.0
       def context
         raise RenderingMissingError
       end
 
+      # @api private
+      # @since 2.1.0
       def part(_name, _value, **_options)
         raise RenderingMissingError
       end
 
+      # @api private
+      # @since 2.1.0
       def scope(_name = nil, _locals) # rubocop:disable Style/OptionalArguments
         raise RenderingMissingError
       end
 
+      # @api private
+      # @since 2.1.0
       def template(_name, _scope)
         raise RenderingMissingError
       end
 
+      # @api private
+      # @since 2.1.0
       def partial(_name, _scope)
         raise RenderingMissingError
       end
 
+      # @api private
+      # @since 2.1.0
       def inflector
         @inflector ||= Dry::Inflector.new
       end

data/lib/hanami/view/scope.rb

@@ -16,40 +16,43 @@ module Hanami
     # @see https://dry-rb.org/gems/dry-view/scopes/
     #
     # @api public
+    # @since 2.1.0
     class Scope
       # @api private
       CONVENIENCE_METHODS = %i[format context locals].freeze
 
       include Dry::Equalizer(:_name, :_locals, :_rendering)
 
-      # The scope's name
+      # Returns the scope's name.
       #
       # @return [Symbol]
       #
       # @api public
+      # @since 2.1.0
       attr_reader :_name
 
-      # The scope's locals
+      # Returns the scope's locals
       #
       # @overload _locals
-      #   Returns the locals
+      #   Returns the locals.
       # @overload locals
-      #   A convenience alias for `#_locals.` Is available unless there is a
-      #   local named `locals`
+      #   A convenience alias for `#_locals.` Is available unless there is a local named `locals`
       #
       # @return [Hash[<Symbol, Object>]
       #
       # @api public
+      # @since 2.1.0
       attr_reader :_locals
 
-      # The current rendering
+      # Returns the current rendering.
       #
       # @return [Rendering]
       #
       # @api private
+      # @since 2.1.0
       attr_reader :_rendering
 
-      # Returns a new Scope instance
+      # Returns a new Scope instance.
       #
       # @param name [Symbol, nil] scope name
       # @param locals [Hash<Symbol, Object>] template locals
@@ -58,6 +61,7 @@ module Hanami
       # @return [Scope]
       #
       # @api public
+      # @since 2.1.0
       def initialize(
         name: nil,
         locals: Dry::Core::Constants::EMPTY_HASH,
@@ -69,14 +73,14 @@ module Hanami
       end
 
       # @overload render(partial_name, **locals, &block)
-      #   Renders a partial using the scope
+      #   Renders a partial using the scope.
       #
       #   @param partial_name [Symbol, String] partial name
       #   @param locals [Hash<Symbol, Object>] partial locals
       #   @yieldreturn [String] string content to include where the partial calls `yield`
       #
       # @overload render(**locals, &block)
-      #   Renders a partial (named after the scope's own name) using the scope
+      #   Renders a partial (named after the scope's own name) using the scope.
       #
       #   @param locals[Hash<Symbol, Object>] partial locals
       #   @yieldreturn [String] string content to include where the partial calls `yield`
@@ -84,6 +88,7 @@ module Hanami
       # @return [String] the rendered partial output
       #
       # @api public
+      # @since 2.1.0
       def render(partial_name = nil, **locals, &block)
         partial_name ||= _name
 
@@ -98,7 +103,7 @@ module Hanami
         _rendering.partial(partial_name, _render_scope(**locals), &block)
       end
 
-      # Build a new scope using a scope class matching the provided name
+      # Builds a new scope using a scope class matching the provided name.
       #
       # @param name [Symbol, Class] scope name (or class)
       # @param locals [Hash<Symbol, Object>] scope locals
@@ -106,11 +111,12 @@ module Hanami
       # @return [Scope]
       #
       # @api public
+      # @since 2.1.0
       def scope(name = nil, **locals)
         _rendering.scope(name, locals)
       end
 
-      # The template format for the current render environment.
+      # Returns the template format for the current render environment.
       #
       # @overload _format
       #   Returns the format.
@@ -121,11 +127,12 @@ module Hanami
       # @return [Symbol] format
       #
       # @api public
+      # @since 2.1.0
       def _format
         _rendering.format
       end
 
-      # The context object for the current render environment
+      # Returns the context object for the current render environment.
       #
       # @overload _context
       #   Returns the context.
@@ -136,6 +143,7 @@ module Hanami
       # @return [Context] context
       #
       # @api public
+      # @since 2.1.0
       def _context
         _rendering.context
       end
@@ -144,10 +152,9 @@ module Hanami
 
       # Handles missing methods, according to the following rules:
       #
-      # 1. If there is a local with a name matching the method, it returns the
-      #    local.
-      # 2. If the `context` responds to the method, then it will be sent the
-      #    method and all its arguments.
+      # 1. If there is a local with a name matching the method, it returns the local.
+      # 2. If the `context` responds to the method, then it will be sent the method and all its
+      #    arguments.
       def method_missing(name, *args, &block)
         if _locals.key?(name)
           _locals[name]

data/lib/hanami/view/scope_builder.rb

@@ -4,17 +4,19 @@ module Hanami
   class View
     # Builds scope objects via matching classes
     #
-    # @api private
+    # @api public
+    # @since 2.1.0
     class ScopeBuilder
       class << self
-        # Returns a new scope using a class matching the name
+        # Returns a new scope using a class matching the name.
         #
         # @param name [Symbol, Class] scope name
         # @param locals [Hash<Symbol, Object>] locals hash
         #
         # @return [Hanami::View::Scope]
         #
-        # @api private
+        # @api public
+        # @since 2.1.0
         def call(name = nil, locals:, rendering:) # rubocop:disable Style/OptionalArguments
           klass = scope_class(name, rendering: rendering)
 

data/lib/hanami/view/tilt/haml_adapter.rb

@@ -6,6 +6,7 @@ module Hanami
   class View
     module Tilt
       # @api private
+      # @since 2.1.0
       module HamlAdapter
         # Add options to Haml::Engine to match the options from its default generator.
         #
@@ -29,6 +30,7 @@ module Hanami
         #
         # @see Hanami::View::Tilt
         # @api private
+        # @since 2.1.0
         Template = Temple::Templates::Tilt(
           ::Haml::Engine,
           use_html_safe: true,

data/lib/hanami/view/tilt/slim_adapter.rb

@@ -6,6 +6,7 @@ module Hanami
   class View
     module Tilt
       # @api private
+      # @since 2.1.0
       module SlimAdapter
         # Add options to Slim::Engine to match the options from its default generator.
         #
@@ -29,6 +30,7 @@ module Hanami
         #
         # @see Hanami::View::Tilt
         # @api private
+        # @since 2.1.0
         Template = Temple::Templates::Tilt(
           ::Slim::Engine,
           use_html_safe: true,

data/lib/hanami/view/tilt.rb

@@ -5,7 +5,10 @@ require "tilt"
 module Hanami
   class View
     # @api private
+    # @since 2.1.0
     module Tilt
+      # @api private
+      # @since 2.1.0
       Mapping = ::Tilt.default_mapping.dup.tap { |mapping|
         # If "slim" has been required before "hanami/view", unregister Slim's non-lazy registered
         # template, so our own template adapter (using register_lazy below) can take precedence.
@@ -25,6 +28,8 @@ module Hanami
       }
 
       class << self
+        # @api private
+        # @since 2.1.0
         def [](path, mapping, options)
           with_mapping(mapping).new(path, options)
         end

data/lib/hanami/view/version.rb

@@ -2,7 +2,8 @@
 
 module Hanami
   class View
-    # @api private
-    VERSION = "2.1.0.rc1"
+    # @api public
+    # @since 2.1.0
+    VERSION = "2.1.0.rc2"
   end
 end

data/lib/hanami/view.rb

@@ -9,22 +9,20 @@ require_relative "view/errors"
 require_relative "view/html"
 
 module Hanami
-  # A standalone, template-based view rendering system that offers everything
-  # you need to write well-factored view code.
+  # A standalone, template-based view rendering system that offers everything you need to write
+  # well-factored view code.
   #
-  # This represents a single view, holding the configuration and exposures
-  # necessary for rendering its template.
+  # This represents a single view, holding the configuration and exposures necessary for rendering
+  # its template.
   #
-  # @abstract Subclass this and provide your own configuration and exposures to
-  #   define your own view (along with a custom `#initialize` if you wish to
-  #   inject dependencies into your subclass)
-  #
-  # @see https://dry-rb.org/gems/dry-view/
+  # @abstract Subclass this and provide your own configuration and exposures to define your own view
+  #   (along with a custom `#initialize` if you wish to inject dependencies into your subclass)
   #
   # @api public
+  # @since 2.1.0
   class View
-    # @since 2.1.0
     # @api private
+    # @since 2.1.0
     def self.gem_loader
       @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
         root = File.expand_path("..", __dir__)
@@ -47,6 +45,7 @@ module Hanami
     gem_loader.setup
 
     # @api private
+    # @since 2.1.0
     DEFAULT_RENDERER_OPTIONS = {default_encoding: "utf-8"}.freeze
 
     include Dry::Equalizer(:config, :exposures)
@@ -67,6 +66,7 @@ module Hanami
     #   @param paths [String, Path, Array<String, Path>] the paths
     #
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :paths, constructor: -> paths {
       Array(paths).map { |path| Path[path] }
@@ -80,6 +80,7 @@ module Hanami
     #
     #   @param name [String] template name
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :template
 
@@ -95,6 +96,7 @@ module Hanami
     #
     #   @param base_path [String, nil] base templates path
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :template_inference_base
 
@@ -107,6 +109,7 @@ module Hanami
     #
     #   @param name [String, FalseClass, nil] layout name, or false to indicate no layout
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :layout, default: false
 
@@ -116,6 +119,7 @@ module Hanami
     #
     #   @param dir [String] directory name
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :layouts_dir, default: "layouts"
 
@@ -129,6 +133,7 @@ module Hanami
     #
     #   @param scope_class [Class] scope class (inheriting from `Hanami::View::Scope`)
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :scope
 
@@ -142,6 +147,7 @@ module Hanami
     #
     #   @param context [Hanami::View::Context] context object
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :default_context, default: Context.new.freeze
 
@@ -152,9 +158,17 @@ module Hanami
     #
     #   @param format [Symbol]
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :default_format, default: :html
 
+    # @overload config.part_class=(part_class)
+    #   Set a custom default part class.
+    #
+    #   @param part_class [Class]
+    #   @api public
+    #   @since 2.1.0
+    # @!scope class
     setting :part_class, default: Part
 
     # @overload config.scope_namespace=(namespace)
@@ -165,19 +179,26 @@ module Hanami
     #   @see Scope
     #
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :part_namespace
 
     # @overload config.part_builder=(part_builder)
     #   Set a custom part builder class
     #
-    #   @see https://dry-rb.org/gems/dry-view/parts/
-    #
     #   @param part_builder [Class]
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :part_builder, default: PartBuilder
 
+    # @overload config.scope_class=(scope_class)
+    #   Set a custom default scope class.
+    #
+    #   @param scope_class [Class]
+    #   @api public
+    #   @since 2.1.0
+    # @!scope class
     setting :scope_class, default: Scope
 
     # @overload config.scope_namespace=(namespace)
@@ -188,6 +209,7 @@ module Hanami
     #   @see Scope
     #
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :scope_namespace
 
@@ -198,6 +220,7 @@ module Hanami
     #
     #   @param scope_builder [Class]
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :scope_builder, default: ScopeBuilder
 
@@ -208,6 +231,7 @@ module Hanami
     #
     #   @param inflector
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :inflector, default: Dry::Inflector.new
 
@@ -223,6 +247,7 @@ module Hanami
     #
     #   @param options [Hash] renderer options
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :renderer_options, default: DEFAULT_RENDERER_OPTIONS, constructor: -> options {
       DEFAULT_RENDERER_OPTIONS.merge(options.to_h).freeze
@@ -241,12 +266,14 @@ module Hanami
     #
     #   @param mapping [Hash<Symbol, Class>] engine mapping
     #   @api public
+    #   @since 2.1.0
     # @!scope class
     setting :renderer_engine_mapping, default: {}
 
     # @!endgroup
 
     # @api private
+    # @since 2.1.0
     def self.inherited(klass)
       super
 
@@ -365,6 +392,7 @@ module Hanami
     # @see https://dry-rb.org/gems/dry-view/exposures/
     #
     # @api public
+    # @since 2.1.0
     def self.expose(*names, **options, &block)
       if names.length == 1
         exposures.add(names.first, block, **options)
@@ -375,7 +403,10 @@ module Hanami
       end
     end
 
+    # @see expose
+    #
     # @api public
+    # @since 2.1.0
     def self.private_expose(*names, **options, &block)
       expose(*names, **options, private: true, &block)
     end
@@ -385,6 +416,7 @@ module Hanami
     #
     # @return [Exposures]
     # @api private
+    # @since 2.1.0
     def self.exposures
       @exposures ||= Exposures.new
     end
@@ -467,7 +499,10 @@ module Hanami
     #   # <%= greeting %>
     #   # <%= copyright(Time.now.utc) %>
     #
-    #   MyView.new.(message: "Hello") # => "HELLO!"
+    #   MyView.new.call(message: "Hello") # => "HELLO!"
+    #
+    # @api public
+    # @since 2.1.0
     def self.scope(scope_class = nil, &block)
       scope_class ||= config.scope || config.scope_class
 
@@ -477,23 +512,24 @@ 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
 
-    # Returns an instance of the view. This binds the defined exposures to the
-    # view instance.
+    # Returns an instance of the view. This binds the defined exposures to the view instance.
     #
-    # Subclasses can define their own `#initialize` to accept injected
-    # dependencies, but must call `super()` to ensure the standard view
-    # initialization can proceed.
+    # Subclasses can define their own `#initialize` to accept injected dependencies, but must call
+    # `super()` to ensure the standard view initialization can proceed.
     #
     # @api public
+    # @since 2.1.0
     def initialize
       self.class.config.finalize!
       ensure_config
@@ -501,22 +537,25 @@ module Hanami
       @exposures = self.class.exposures.bind(self)
     end
 
-    # The view's configuration
+    # Returns the view's configuration.
     #
-    # @api private
+    # @api public
+    # @since 2.1.0
     def config
       self.class.config
     end
 
-    # The view's bound exposures
+    # Returns the view's bound exposures.
     #
     # @return [Exposures]
+    #
     # @api private
+    # @since 2.1.0
     def exposures
       @exposures
     end
 
-    # Render the view
+    # Renders the view.
     #
     # @param format [Symbol] template format to use
     # @param context [Context] context object to use
@@ -524,7 +563,9 @@ module Hanami
     # @param input input data for preparing exposure values
     #
     # @return [Rendered] rendered view object
+    #
     # @api public
+    # @since 2.1.0
     def call(format: config.default_format, context: config.default_context, layout: config.layout, **input)
       rendering = self.rendering(format: format, context: context)
 
@@ -532,19 +573,17 @@ module Hanami
       output = rendering.template(config.template, rendering.scope(config.scope, locals))
 
       if layout
-        begin
-          output = rendering.template(
-            self.class.layout_path(layout),
-            rendering.scope(config.scope, layout_locals(locals))
-          ) { output }
-        rescue TemplateNotFoundError
-          raise LayoutNotFoundError.new(layout, config.paths)
-        end
+        output = rendering.template(
+          self.class.layout_path(layout),
+          rendering.scope(config.scope, layout_locals(locals))
+        ) { output }
       end
 
       Rendered.new(output: output, locals: locals)
     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)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-view
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc1
+  version: 2.1.0.rc2
 platform: ruby
 authors:
 - Tim Riley
@@ -9,22 +9,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-01 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: concurrent-ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -177,7 +163,6 @@ files:
 - hanami-view.gemspec
 - lib/hanami-view.rb
 - lib/hanami/view.rb
-- lib/hanami/view/application_view.rb
 - lib/hanami/view/cache.rb
 - lib/hanami/view/context.rb
 - lib/hanami/view/context_helpers/content_helpers.rb
@@ -233,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: A complete, standalone view rendering system that gives you everything you