hanami-view 2.1.0.rc1 → 2.1.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae3eed9f786bf94040d22363976ef28f957fb05ca8d91d0cb2f68510c0da09d
-  data.tar.gz: f9619a535228de48ebd401597faae311f7c66acaface839b10530623ca2147b9
+  metadata.gz: 1f2fe4be0c1444d008d0a1f263b665469931fc7446ef53a581e40b9903b3d59b
+  data.tar.gz: 530f9ef13f2c7f30e31c6f47276dfb5b63280167b237af607616138216d5d47a
 SHA512:
-  metadata.gz: 57141a4749d8bdc68066fc1a182cc193a1a032f04288e9de0c197c0f426a3ffa57cef7af90fef25a5994a79711cd669d29ca20e1376c1036b0ed39c0f544689e
-  data.tar.gz: f2b295fa290d9e898fd924d9a1ef39cb73e986a1efe3df4bbbfa2b24ef3cea7bff298ca811c9e5a5948adafd1a84bab7644530b33099d21ecba9ed9a8b12cfaa
+  metadata.gz: 632c35a2934a68d891a6adafa04bf77692242c118c97ef67f67729047915ea2322e6d3d95a31fb56f207367d66f4dae844278caf3d3d98184ee8339d3762eb73
+  data.tar.gz: 7657dac57505121f31eea7f7c3a6dfaac22e157094353bcd5ad9baa62d52e32a687b7d697512fe99aef4baa500e37ea7fb6f053b872b9d3f08c28a17b3e49b60

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 View layer for Hanami
 
+## v2.1.0.rc2 - 2023-11-08
+
+### Changed
+- [Tim Riley] Remove `LayoutNotFoundError` and raise `TemplateNotFoundError` for all kinds of missing templates, including layouts.
+
 ## v2.1.0.rc1 - 2023-11-01
 
 ### Fixed

data/hanami-view.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 3.0"
 
-  spec.add_runtime_dependency "concurrent-ruby", "~> 1.0"
   spec.add_runtime_dependency "dry-configurable", "~> 1.0"
   spec.add_runtime_dependency "dry-core", "~> 1.0"
   spec.add_runtime_dependency "dry-inflector", "~> 1.0", "< 2"

data/lib/hanami/view/cache.rb

@@ -4,10 +4,17 @@ require "dry/core/cache"
 
 module Hanami
   class View
-    # @api private
+    # Shared cache for views.
+    #
+    # @api public
+    # @since 2.1.0
     class Cache
       extend Dry::Core::Cache
 
+      # Clears the view cache.
+      #
+      # @api public
+      # @since 2.1.0
       def self.clear
         cache.clear
       end

data/lib/hanami/view/context.rb

@@ -9,13 +9,16 @@ module Hanami
     #   `#initialize` if you wish to inject dependencies)
     #
     # @api public
+    # @since 2.1.0
     class Context
       include DecoratedAttributes
 
       # @api private
+      # @since 2.1.0
       attr_reader :_rendering
 
       # @api private
+      # @since 2.1.0
       def self.new(rendering: RenderingMissing.new, **args)
         allocate.tap do |obj|
           obj.instance_variable_set(:@_rendering, rendering)
@@ -26,10 +29,12 @@ module Hanami
       # Returns a new instance of Context
       #
       # @api public
+      # @since 2.1.0
       def initialize(**)
       end
 
       # @api private
+      # @since 2.1.0
       def dup_for_rendering(rendering)
         dup.tap do |obj|
           obj.instance_variable_set(:@_rendering, rendering)

data/lib/hanami/view/decorated_attributes.rb

@@ -5,13 +5,20 @@ require "set"
 module Hanami
   class View
     # Decorates attributes in Parts.
+    #
+    # @api public
+    # @since 2.1.0
     module DecoratedAttributes
       # @api private
+      # @since 2.1.0
       def self.included(klass)
         klass.extend ClassInterface
       end
 
       # Decorated attributes class-level interface.
+      #
+      # @api public
+      # @since 2.1.0
       module ClassInterface
         # @api private
         MODULE_NAME = :DecoratedAttributes
@@ -31,6 +38,7 @@ module Hanami
         #   matching Part
         #
         # @api public
+        # @since 2.1.0
         def decorate(*names, **options)
           decorated_attributes.decorate(*names, **options)
         end

data/lib/hanami/view/erb/engine.rb

@@ -8,7 +8,7 @@ module Hanami
       # Hanami::View ERB engine.
       #
       # @api private
-      # @since 2.0.0
+      # @since 2.1.0
       class Engine < Temple::Engine
         define_options capture_generator: Hanami::View::HTMLSafeStringBuffer
 

data/lib/hanami/view/erb/filters/block.rb

@@ -9,7 +9,7 @@ module Hanami
         #
         # Inspired by Slim's Slim::Controls::Filter#on_slim_output.
         #
-        # @since 2.0.0
+        # @since 2.1.0
         # @api private
         class Block < Temple::Filter
           END_LINE_RE = /\bend\b/

data/lib/hanami/view/erb/filters/trimming.rb

@@ -18,7 +18,7 @@ module Hanami
         # `:multi` sexps with their own nested content.
         #
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         class Trimming < Temple::Filter
           define_options trim: true
 

data/lib/hanami/view/erb/parser.rb

@@ -78,7 +78,7 @@ module Hanami
       # remain, which is the value returned.
       #
       # @api private
-      # @since 2.0.0
+      # @since 2.1.0
       class Parser < Temple::Parser
         ERB_PATTERN = /(\n|<%%|%%>)|<%(==?|\#)?(.*?)?-?%>/m
 

data/lib/hanami/view/erb/template.rb

@@ -21,7 +21,7 @@ module Hanami
     #   Hanami::View::ERB::Template.new { "<%= 'Hello, world!' %>" }.render
     #
     # @api private
-    # @since 2.0.0
+    # @since 2.1.0
     module ERB
       # ERB Template class
       Template = Temple::Templates::Tilt(Engine)

data/lib/hanami/view/errors.rb

@@ -2,24 +2,27 @@
 
 module Hanami
   class View
-    # @since 2.0.0
+    # Base error for views.
+    #
+    # @since 2.1.0
     # @api public
     class Error < StandardError
     end
 
-    # Error raised when critical settings are not configured
+    # Error raised when critical settings are not configured.
     #
-    # @api private
+    # @api public
+    # @since 2.1.0
     class UndefinedConfigError < StandardError
       def initialize(key)
         super("no +#{key}+ configured")
       end
     end
 
-    # Error raised when template could not be found within a view's configured
-    # paths
+    # Error raised when template could not be found within a view's configured paths.
     #
-    # @api private
+    # @api public
+    # @since 2.1.0
     class TemplateNotFoundError < StandardError
       def initialize(template_name, format, lookup_paths)
         msg = [
@@ -31,21 +34,10 @@ module Hanami
       end
     end
 
-    # Error raised when layout could not be found within a view's configured
-    # paths
+    # Error raised when a rendering is required but not given.
     #
-    # @api private
-    class LayoutNotFoundError < StandardError
-      def initialize(layout_name, lookup_paths)
-        msg = [
-          "Layout +#{layout_name}+ could not be found in paths:",
-          lookup_paths.map { |path| " - #{path}" }
-        ].join("\n\n")
-
-        super(msg)
-      end
-    end
-
+    # @api public
+    # @since 2.1.0
     class RenderingMissingError < Error
       def message
         "a +rendering+ must be provided"

data/lib/hanami/view/exposure.rb

@@ -7,17 +7,31 @@ module Hanami
     # An exposure defined on a view
     #
     # @api private
+    # @since 2.1.0
     class Exposure
       include Dry::Equalizer(:name, :proc, :object, :options)
 
       EXPOSURE_DEPENDENCY_PARAMETER_TYPES = %i[req opt].freeze
       INPUT_PARAMETER_TYPES = %i[key keyreq keyrest].freeze
 
+      # @api private
+      # @since 2.1.0
       attr_reader :name
+
+      # @api private
+      # @since 2.1.0
       attr_reader :proc
+
+      # @api private
+      # @since 2.1.0
       attr_reader :object
+
+      # @api private
+      # @since 2.1.0
       attr_reader :options
 
+      # @api private
+      # @since 2.1.0
       def initialize(name, proc = nil, object = nil, **options)
         @name = name
         @proc = prepare_proc(proc, object)
@@ -25,10 +39,14 @@ module Hanami
         @options = options
       end
 
+      # @api private
+      # @since 2.1.0
       def bind(obj)
         self.class.new(name, proc, obj, **options)
       end
 
+      # @api private
+      # @since 2.1.0
       def dependency_names
         @dependency_names ||=
           if proc
@@ -40,10 +58,14 @@ module Hanami
           end
       end
 
+      # @api private
+      # @since 2.1.0
       def dependencies?
         !dependency_names.empty?
       end
 
+      # @api private
+      # @since 2.1.0
       def input_keys
         @input_keys ||=
           if proc
@@ -55,22 +77,32 @@ module Hanami
           end
       end
 
+      # @api private
+      # @since 2.1.0
       def for_layout?
         options.fetch(:layout, false)
       end
 
+      # @api private
+      # @since 2.1.0
       def decorate?
         options.fetch(:decorate, true)
       end
 
+      # @api private
+      # @since 2.1.0
       def private?
         options.fetch(:private, false)
       end
 
+      # @api private
+      # @since 2.1.0
       def default_value
         options[:default]
       end
 
+      # @api private
+      # @since 2.1.0
       def call(input, locals = {})
         if proc
           call_proc(input, locals)

data/lib/hanami/view/exposures.rb

@@ -6,36 +6,53 @@ require "dry/core/equalizer"
 module Hanami
   class View
     # @api private
+    # @since 2.1.0
     class Exposures
       include Dry::Equalizer(:exposures)
       include TSort
 
+      # @api private
+      # @since 2.1.0
       attr_reader :exposures
 
+      # @api private
+      # @since 2.1.0
       def initialize(exposures = {})
         @exposures = exposures
       end
 
+      # @api private
+      # @since 2.1.0
       def key?(name)
         exposures.key?(name)
       end
 
+      # @api private
+      # @since 2.1.0
       def [](name)
         exposures[name]
       end
 
+      # @api private
+      # @since 2.1.0
       def each(&block)
         exposures.each(&block)
       end
 
+      # @api private
+      # @since 2.1.0
       def add(name, proc = nil, **options)
         exposures[name] = Exposure.new(name, proc, **options)
       end
 
+      # @api private
+      # @since 2.1.0
       def import(name, exposure)
         exposures[name] = exposure.dup
       end
 
+      # @api private
+      # @since 2.1.0
       def bind(obj)
         bound_exposures = exposures.each_with_object({}) { |(name, exposure), memo|
           memo[name] = exposure.bind(obj)
@@ -44,6 +61,8 @@ module Hanami
         self.class.new(bound_exposures)
       end
 
+      # @api private
+      # @since 2.1.0
       def call(input)
         # Avoid performance cost of tsorting when we don't need it
         names =

data/lib/hanami/view/helpers/escape_helper.rb

@@ -29,7 +29,7 @@ module Hanami
       #   end
       #
       # @api public
-      # @since 2.0.0
+      # @since 2.1.0
       module EscapeHelper
         extend self
 
@@ -56,13 +56,13 @@ module Hanami
         #   # => "<p>Not escaped</p>"
         #
         # @api public
-        # @since 2.0.0
+        # @since 2.1.0
         def escape_html(input)
           Temple::Utils.escape_html_safe(input)
         end
 
         # @api public
-        # @since 2.0.0
+        # @since 2.1.0
         alias_method :h, :escape_html
 
         # Returns an escaped string from joining the elements in a given array.
@@ -86,7 +86,7 @@ module Hanami
         # @see #escape_html
         #
         # @api public
-        # @since 2.0.0
+        # @since 2.1.0
         def escape_join(array, separator = $,)
           separator = escape_html(separator)
 
@@ -116,7 +116,7 @@ module Hanami
         #   # => "gemini://gemini.circumlunar.space/"
         #
         # @api public
-        # @since 2.0.0
+        # @since 2.1.0
         def sanitize_url(input, permitted_schemes = PERMITTED_URL_SCHEMES)
           return input if input.html_safe?
 
@@ -127,7 +127,7 @@ module Hanami
         end
 
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         PERMITTED_URL_SCHEMES = %w[http https mailto].freeze
         private_constant :PERMITTED_URL_SCHEMES
 
@@ -142,7 +142,7 @@ module Hanami
         #   escape_xml_name("1 < 2 & 3") # => "1___2___3"
         #
         # @api public
-        # @since 2.0.0
+        # @since 2.1.0
         def escape_xml_name(name)
           name = name.to_s
           return "" if name.match?(BLANK_STRING_REGEXP)
@@ -160,12 +160,12 @@ module Hanami
         end
 
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         BLANK_STRING_REGEXP = /\A\s*\z/
 
         # Following XML requirements: https://www.w3.org/TR/REC-xml/#NT-Name
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         TAG_NAME_START_CODEPOINTS = \
           "@:A-Z_a-z\u{C0}-\u{D6}\u{D8}-\u{F6}\u{F8}-\u{2FF}\u{370}-\u{37D}\u{37F}-\u{1FFF}" \
           "\u{200C}-\u{200D}\u{2070}-\u{218F}\u{2C00}-\u{2FEF}\u{3001}-\u{D7FF}\u{F900}-\u{FDCF}" \
@@ -173,27 +173,27 @@ module Hanami
         private_constant :TAG_NAME_START_CODEPOINTS
 
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         INVALID_TAG_NAME_START_REGEXP = /[^#{TAG_NAME_START_CODEPOINTS}]/
         private_constant :INVALID_TAG_NAME_START_REGEXP
 
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         TAG_NAME_FOLLOWING_CODEPOINTS = "#{TAG_NAME_START_CODEPOINTS}\\-.0-9\u{B7}\u{0300}-\u{036F}\u{203F}-\u{2040}"
         private_constant :TAG_NAME_FOLLOWING_CODEPOINTS
 
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         INVALID_TAG_NAME_FOLLOWING_REGEXP = /[^#{TAG_NAME_FOLLOWING_CODEPOINTS}]/
         private_constant :INVALID_TAG_NAME_FOLLOWING_REGEXP
 
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         SAFE_XML_TAG_NAME_REGEXP = /\A[#{TAG_NAME_START_CODEPOINTS}][#{TAG_NAME_FOLLOWING_CODEPOINTS}]*\z/
         private_constant :INVALID_TAG_NAME_FOLLOWING_REGEXP
 
         # @api private
-        # @since 2.0.0
+        # @since 2.1.0
         TAG_NAME_REPLACEMENT_CHAR = "_"
         private_constant :TAG_NAME_REPLACEMENT_CHAR
 
@@ -211,7 +211,7 @@ module Hanami
         #   raw(user.name).html_safe? # => true
         #
         # @api public
-        # @since 2.0.0
+        # @since 2.1.0
         def raw(input)
           input.to_s.html_safe
         end

data/lib/hanami/view/helpers/number_formatting_helper.rb

@@ -26,7 +26,7 @@ module Hanami
       #   end
       #
       # @api public
-      # @since 2.0.0
+      # @since 2.1.0
       module NumberFormattingHelper
         extend self
 
@@ -34,7 +34,7 @@ module Hanami
         #
         # @return [String] default delimiter
         #
-        # @since 2.0.0
+        # @since 2.1.0
         # @api private
         DEFAULT_DELIMITER = ","
         private_constant :DEFAULT_DELIMITER
@@ -43,7 +43,7 @@ module Hanami
         #
         # @return [String] default separator
         #
-        # @since 2.0.0
+        # @since 2.1.0
         # @api private
         DEFAULT_SEPARATOR = "."
         private_constant :DEFAULT_SEPARATOR
@@ -52,7 +52,7 @@ module Hanami
         #
         # @return [Integer] default rounding precision
         #
-        # @since 2.0.0
+        # @since 2.1.0
         # @api private
         DEFAULT_PRECISION = 2
         private_constant :DEFAULT_PRECISION
@@ -82,7 +82,7 @@ module Hanami
         #   format_number(1256.95, delimiter: ".", separator: ",") # => "1.256,95"
         #
         # @api public
-        # @since 2.0.0
+        # @since 2.1.0
         def format_number(number, delimiter: DEFAULT_DELIMITER, separator: DEFAULT_SEPARATOR, precision: DEFAULT_PRECISION) # rubocop:disable Layout/LineLength
           Formatter.call(number, delimiter: delimiter, separator: separator, precision: precision)
         end
@@ -91,26 +91,26 @@ module Hanami
 
         # Formatter
         #
-        # @since 2.0.0
+        # @since 2.1.0
         # @api private
         class Formatter
           # Regex to delimit the integer part of a number into groups of three digits.
           #
-          # @since 2.0.0
+          # @since 2.1.0
           # @api private
           DELIMITING_REGEX = /(\d)(?=(\d{3})+$)/
           private_constant :DELIMITING_REGEX
 
           # Regex to guess if the number is a integer.
           #
-          # @since 2.0.0
+          # @since 2.1.0
           # @api private
           INTEGER_REGEXP = /\A\d+\z/
           private_constant :INTEGER_REGEXP
 
           # @see NumberFormattingHelper#format_number
           #
-          # @since 2.0.0
+          # @since 2.1.0
           # @api private
           def self.call(number, delimiter:, separator:, precision:)
             number = coerce(number)
@@ -122,7 +122,7 @@ module Hanami
 
           # Coerces the given number or string into a number.
           #
-          # @since 2.0.0
+          # @since 2.1.0
           # @api private
           def self.coerce(number)
             case number
@@ -143,7 +143,7 @@ module Hanami
 
           # Formats the given number as a string.
           #
-          # @since 2.0.0
+          # @since 2.1.0
           # @api private
           def self.to_str(number, precision)
             case number
@@ -156,7 +156,7 @@ module Hanami
 
           # Returns the integer and fractional parts of the given number string.
           #
-          # @since 2.0.0
+          # @since 2.1.0
           # @api private
           def self.parts(string, delimiter)
             integer_part, fractional_part = string.split(DEFAULT_SEPARATOR)
@@ -170,7 +170,7 @@ module Hanami
           #
           # @return [String] delimited integer string
           #
-          # @since 2.0.0
+          # @since 2.1.0
           # @api private
           def self.delimit_integer(integer_part, delimiter)
             integer_part.gsub(DELIMITING_REGEX) { |digit| "#{digit}#{delimiter}" }