hanami-view 2.0.0.alpha8 → 2.1.0.beta1

data/lib/hanami/view/tilt.rb

@@ -1,69 +1,48 @@
 # frozen_string_literal: true
 
-require "dry/core/cache"
 require "tilt"
 
 module Hanami
   class View
     # @api private
     module Tilt
-      extend Dry::Core::Cache
+      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.
+        mapping.unregister "slim"
+
+        # Register our own ERB template.
+        mapping.register_lazy "Hanami::View::ERB::Template", "hanami/view/erb/template", "erb", "rhtml"
+
+        # Register ERB templates for Haml and Slim that set the `use_html_safe: true` option.
+        #
+        # Our template namespaces below have the "Adapter" suffix to work around a bug in Tilt's
+        # `Mapping#const_defined?`, which (if slim was already required) would receive
+        # "Hanami::View::Slim::Template" and return `Slim::Template`, which is the opposite of what
+        # we want.
+        mapping.register_lazy "Hanami::View::Tilt::HamlAdapter::Template", "hanami/view/tilt/haml_adapter", "haml"
+        mapping.register_lazy "Hanami::View::Tilt::SlimAdapter::Template", "hanami/view/tilt/slim_adapter", "slim"
+      }
 
       class << self
-        def [](path, mapping, **options)
-          ext = File.extname(path).sub(/^./, "").to_sym
-          activate_adapter ext
-
-          with_mapping(mapping).new(path, **options)
-        end
-
-        def default_mapping
-          ::Tilt.default_mapping
-        end
-
-        def register_adapter(ext, adapter)
-          adapters[ext] = adapter
-        end
-
-        def deregister_adapter(ext)
-          adapters.delete(ext)
+        def [](path, mapping, options)
+          with_mapping(mapping).new(path, options)
         end
 
         private
 
-        def adapters
-          @adapters ||= {}
-        end
-
-        def activate_adapter(ext)
-          fetch_or_store(:adapter, ext) {
-            adapter = adapters[ext]
-            return unless adapter
-
-            *requires, error_message = adapter.requirements
-
-            begin
-              requires.each(&method(:require))
-            rescue LoadError => e
-              raise e, "#{e.message}\n\n#{error_message}"
-            end
-
-            adapter.activate
-          }
-        end
-
         def with_mapping(mapping)
-          fetch_or_store(:mapping, mapping) {
+          View.cache.fetch_or_store(:tilt_mapping, mapping) {
             if mapping.any?
               build_mapping(mapping)
             else
-              default_mapping
+              Mapping
             end
           }
         end
 
         def build_mapping(mapping)
-          default_mapping.dup.tap do |new_mapping|
+          Mapping.dup.tap do |new_mapping|
             mapping.each do |extension, template_class|
               new_mapping.register template_class, extension
             end
@@ -73,6 +52,3 @@ module Hanami
     end
   end
 end
-
-require_relative "tilt/erb"
-require_relative "tilt/haml"

data/lib/hanami/view/version.rb

@@ -3,6 +3,6 @@
 module Hanami
   class View
     # @api private
-    VERSION = "2.0.0.alpha8"
+    VERSION = "2.1.0.beta1"
   end
 end

data/lib/hanami/view.rb

@@ -1,20 +1,12 @@
 # frozen_string_literal: true
 
 require "dry/configurable"
-require "dry/core/cache"
 require "dry/core/equalizer"
 require "dry/inflector"
+require "zeitwerk"
 
-require_relative "view/application_view"
-require_relative "view/context"
-require_relative "view/exposures"
 require_relative "view/errors"
-require_relative "view/part_builder"
-require_relative "view/path"
-require_relative "view/render_environment"
-require_relative "view/rendered"
-require_relative "view/renderer"
-require_relative "view/scope_builder"
+require_relative "view/html"
 
 module Hanami
   # A standalone, template-based view rendering system that offers everything
@@ -31,13 +23,34 @@ module Hanami
   #
   # @api public
   class View
+    # @since 2.1.0
+    # @api private
+    def self.gem_loader
+      @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+        loader.tag = "hanami-view"
+        loader.push_dir(root)
+        loader.ignore(
+          "#{root}/hanami-view.rb",
+          "#{root}/hanami/view/version.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",
+        )
+      end
+    end
+
+    gem_loader.setup
+
     # @api private
     DEFAULT_RENDERER_OPTIONS = {default_encoding: "utf-8"}.freeze
 
     include Dry::Equalizer(:config, :exposures)
 
-    extend Dry::Core::Cache
-
     extend Dry::Configurable
 
     # @!group Configuration
@@ -142,6 +155,8 @@ module Hanami
     # @!scope class
     setting :default_format, default: :html
 
+    setting :part_class, default: Part
+
     # @overload config.scope_namespace=(namespace)
     #   Set a namespace that will be searched when building scope classes.
     #
@@ -163,6 +178,8 @@ module Hanami
     # @!scope class
     setting :part_builder, default: PartBuilder
 
+    setting :scope_class, default: Scope
+
     # @overload config.scope_namespace=(namespace)
     #   Set a namespace that will be searched when building scope classes.
     #
@@ -225,7 +242,7 @@ module Hanami
     #   @param mapping [Hash<Symbol, Class>] engine mapping
     #   @api public
     # @!scope class
-    setting :renderer_engine_mapping
+    setting :renderer_engine_mapping, default: {}
 
     # @!endgroup
 
@@ -451,77 +468,23 @@ module Hanami
     #   # <%= copyright(Time.now.utc) %>
     #
     #   MyView.new.(message: "Hello") # => "HELLO!"
-    def self.scope(base: config.scope || Hanami::View::Scope, &block)
-      config.scope = Class.new(base, &block)
-    end
+    def self.scope(scope_class = nil, &block)
+      scope_class ||= config.scope || config.scope_class
 
-    # @!endgroup
-
-    # @!group Render environment
-
-    # Returns a render environment for the view and the given options. This
-    # environment isn't chdir'ed into any particular directory.
-    #
-    # @param format [Symbol] template format to use (defaults to the `default_format` setting)
-    # @param context [Context] context object to use (defaults to the `default_context` setting)
-    #
-    # @see View.template_env render environment for the view's template
-    # @see View.layout_env render environment for the view's layout
-    #
-    # @return [RenderEnvironment]
-    # @api public
-    def self.render_env(format: config.default_format, context: config.default_context)
-      RenderEnvironment.prepare(renderer(format), config, context)
-    end
-
-    # @overload template_env(format: config.default_format, context: config.default_context)
-    #   Returns a render environment for the view and the given options,
-    #   chdir'ed into the view's template directory. This is the environment
-    #   used when rendering the template, and is useful to to fetch
-    #   independently when unit testing Parts and Scopes.
-    #
-    #   @param format [Symbol] template format to use (defaults to the `default_format` setting)
-    #   @param context [Context] context object to use (defaults to the `default_context` setting)
-    #
-    #   @return [RenderEnvironment]
-    #   @api public
-    def self.template_env(**args)
-      render_env(**args).chdir(config.template)
+      config.scope = Class.new(scope_class, &block)
     end
 
-    # @overload layout_env(format: config.default_format, context: config.default_context)
-    #   Returns a render environment for the view and the given options,
-    #   chdir'ed into the view's layout directory. This is the environment used
-    #   when rendering the view's layout.
-    #
-    #   @param format [Symbol] template format to use (defaults to the `default_format` setting)
-    #   @param context [Context] context object to use (defaults to the `default_context` setting)
-    #
-    #   @return [RenderEnvironment] @api public
-    def self.layout_env(**args)
-      render_env(**args).chdir(layout_path)
-    end
-
-    # Returns renderer for the view and provided format
-    #
-    # @api private
-    def self.renderer(format)
-      fetch_or_store(:renderer, config, format) {
-        Renderer.new(
-          config.paths,
-          format: format,
-          engine_mapping: config.renderer_engine_mapping,
-          **config.renderer_options
-        )
-      }
-    end
+    # @!endgroup
 
     # @api private
     def self.layout_path
       File.join(*[config.layouts_dir, config.layout].compact)
     end
 
-    # @!endgroup
+    # @api private
+    def self.cache
+      Cache
+    end
 
     # Returns an instance of the view. This binds the defined exposures to the
     # view instance.
@@ -532,6 +495,9 @@ module Hanami
     #
     # @api public
     def initialize
+      self.class.config.finalize!
+      ensure_config
+
       @exposures = self.class.exposures.bind(self)
     end
 
@@ -559,20 +525,16 @@ module Hanami
     # @return [Rendered] rendered view object
     # @api public
     def call(format: config.default_format, context: config.default_context, **input)
-      ensure_config
-
-      env = self.class.render_env(format: format, context: context)
-      template_env = self.class.template_env(format: format, context: context)
+      rendering = self.rendering(format: format, context: context)
 
-      locals = locals(template_env, input)
-      output = env.template(config.template, template_env.scope(config.scope, locals))
+      locals = locals(rendering, input)
+      output = rendering.template(config.template, rendering.scope(config.scope, locals))
 
       if layout?
-        layout_env = self.class.layout_env(format: format, context: context)
         begin
-          output = env.template(
+          output = rendering.template(
             self.class.layout_path,
-            layout_env.scope(config.scope, layout_locals(locals))
+            rendering.scope(config.scope, layout_locals(locals))
           ) { output }
         rescue TemplateNotFoundError
           raise LayoutNotFoundError.new(config.layout, config.paths)
@@ -582,33 +544,33 @@ module Hanami
       Rendered.new(output: output, locals: locals)
     end
 
+    def rendering(format: config.default_format, context: config.default_context)
+      Rendering.new(config: config, format: format, context: context)
+    end
+
     private
 
-    # @api private
     def ensure_config
       raise UndefinedConfigError, :paths unless Array(config.paths).any?
       raise UndefinedConfigError, :template unless config.template
     end
 
-    # @api private
-    def locals(render_env, input)
-      exposures.(context: render_env.context, **input) do |value, exposure|
+    def locals(rendering, input)
+      exposures.(context: rendering.context, **input) do |value, exposure|
         if exposure.decorate? && value
-          render_env.part(exposure.name, value, **exposure.options)
+          rendering.part(exposure.name, value, as: exposure.options[:as])
         else
           value
         end
       end
     end
 
-    # @api private
     def layout_locals(locals)
       locals.each_with_object({}) do |(key, value), layout_locals|
         layout_locals[key] = value if exposures[key].for_layout?
       end
     end
 
-    # @api private
     def layout?
       !!config.layout # rubocop:disable Style/DoubleNegation
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-view
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha8
+  version: 2.1.0.beta1
 platform: ruby
 authors:
 - Tim Riley
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-19 00:00:00.000000000 Z
+date: 2023-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -31,54 +31,68 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
+        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-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '2'
 - !ruby/object:Gem::Dependency
-  name: dry-inflector
+  name: temple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.10.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +113,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.6
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,31 +179,41 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- LICENSE
 - README.md
 - 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
 - lib/hanami/view/decorated_attributes.rb
+- lib/hanami/view/erb/engine.rb
+- lib/hanami/view/erb/filters/block.rb
+- lib/hanami/view/erb/filters/trimming.rb
+- lib/hanami/view/erb/parser.rb
+- lib/hanami/view/erb/template.rb
 - lib/hanami/view/errors.rb
 - lib/hanami/view/exposure.rb
 - lib/hanami/view/exposures.rb
+- lib/hanami/view/helpers/escape_helper.rb
+- lib/hanami/view/helpers/number_formatting_helper.rb
+- lib/hanami/view/helpers/tag_helper.rb
+- lib/hanami/view/helpers/tag_helper/tag_builder.rb
+- lib/hanami/view/html.rb
+- lib/hanami/view/html_safe_string_buffer.rb
 - lib/hanami/view/part.rb
 - lib/hanami/view/part_builder.rb
 - lib/hanami/view/path.rb
-- lib/hanami/view/render_environment.rb
-- lib/hanami/view/render_environment_missing.rb
 - lib/hanami/view/rendered.rb
 - lib/hanami/view/renderer.rb
+- lib/hanami/view/rendering.rb
+- lib/hanami/view/rendering_missing.rb
 - lib/hanami/view/scope.rb
 - lib/hanami/view/scope_builder.rb
 - lib/hanami/view/tilt.rb
-- lib/hanami/view/tilt/erb.rb
-- lib/hanami/view/tilt/erbse.rb
-- lib/hanami/view/tilt/haml.rb
+- lib/hanami/view/tilt/haml_adapter.rb
+- lib/hanami/view/tilt/slim_adapter.rb
 - lib/hanami/view/version.rb
 homepage: https://dry-rb.org/gems/hanami-view
 licenses:
@@ -201,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: A complete, standalone view rendering system that gives you everything you

data/LICENSE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015-2020 dry-rb team
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
-the Software, and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
-COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
-IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/hanami/view/render_environment.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "dry/core/equalizer"
-
-module Hanami
-  class View
-    # @api private
-    class RenderEnvironment
-      def self.prepare(renderer, config, context)
-        new(
-          renderer: renderer,
-          inflector: config.inflector,
-          context: context,
-          scope_builder: config.scope_builder.new(namespace: config.scope_namespace),
-          part_builder: config.part_builder.new(namespace: config.part_namespace)
-        )
-      end
-
-      include Dry::Equalizer(:renderer, :inflector, :context, :scope_builder, :part_builder)
-
-      attr_reader :renderer, :inflector, :context, :scope_builder, :part_builder
-
-      def initialize(renderer:, inflector:, context:, scope_builder:, part_builder:)
-        @renderer = renderer
-        @inflector = inflector
-        @context = context.for_render_env(self)
-        @scope_builder = scope_builder.for_render_env(self)
-        @part_builder = part_builder.for_render_env(self)
-      end
-
-      def format
-        renderer.format
-      end
-
-      def part(name, value, **options)
-        part_builder.(name, value, **options)
-      end
-
-      def scope(name = nil, locals) # rubocop:disable Style/OptionalArguments
-        scope_builder.(name, locals)
-      end
-
-      def template(name, scope, &block)
-        renderer.template(name, scope, &block)
-      end
-
-      def partial(name, scope, &block)
-        renderer.partial(name, scope, &block)
-      end
-
-      def chdir(dirname)
-        self.class.new(
-          renderer: renderer.chdir(dirname),
-          inflector: inflector,
-          context: context,
-          scope_builder: scope_builder,
-          part_builder: part_builder
-        )
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Hanami
-  class View
-    module Tilt
-      module ERB
-        def self.requirements
-          ["hanami/view/tilt/erbse", <<~ERROR]
-            hanami-view requires erbse for full compatibility when rendering .erb templates (e.g. implicitly capturing block content when yielding)
-
-            To ignore this and use another engine for .erb templates, deregister this adapter before calling your views:
-
-            Hanami::View::Tilt.deregister_adapter(:erb)
-          ERROR
-        end
-
-        def self.activate
-          Tilt.default_mapping.register ErbseTemplate, "erb"
-          self
-        end
-      end
-
-      register_adapter :erb, ERB
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "tilt/template"
-require "erbse"
-
-module Hanami
-  class View
-    module Tilt
-      # Tilt template class copied from cells-erb gem
-      class ErbseTemplate < ::Tilt::Template
-        def prepare
-          @template = ::Erbse::Engine.new
-        end
-
-        def precompiled_template(_locals)
-          @template.call(data)
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Hanami
-  class View
-    module Tilt
-      module Haml
-        def self.requirements
-          ["hamlit/block", <<~ERROR]
-            hanami-view requires hamlit-block for full compatibility when rendering .haml templates (e.g. implicitly capturing block content when yielding)
-
-            To ignore this and use another engine for .haml templates, dereigster this adapter before calling your views:
-
-            Hanami::View::Tilt.deregister_adatper(:haml)
-          ERROR
-        end
-
-        def self.activate
-          # Requiring hamlit/block will register the engine with Tilt
-          self
-        end
-      end
-
-      register_adapter :haml, Haml
-    end
-  end
-end