dry-view 0.5.3 → 0.6.0

data/lib/dry/view/part_builder.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require "dry/core/cache"
+require "dry/equalizer"
+require_relative "part"
+
+module Dry
+  class View
+    # Decorates exposure values with matching parts
+    #
+    # @api private
+    class PartBuilder
+      extend Dry::Core::Cache
+      include Dry::Equalizer(:namespace)
+
+      attr_reader :namespace
+      attr_reader :render_env
+
+      # Returns a new instance of PartBuilder
+      #
+      # @api private
+      def initialize(namespace: nil, render_env: nil)
+        @namespace = namespace
+        @render_env = render_env
+      end
+
+      # @api private
+      def for_render_env(render_env)
+        return self if render_env == self.render_env
+
+        self.class.new(namespace: namespace, render_env: render_env)
+      end
+
+      # Decorates an exposure value
+      #
+      # @param name [Symbol] exposure name
+      # @param value [Object] exposure value
+      # @param options [Hash] exposure options
+      #
+      # @return [Dry::View::Part] decorated value
+      #
+      # @api private
+      def call(name, value, **options)
+        builder = value.respond_to?(:to_ary) ? :build_collection_part : :build_part
+
+        send(builder, name, value, **options)
+      end
+
+      private
+
+      def build_part(name, value, **options)
+        klass = part_class(name: name, **options)
+
+        klass.new(
+          name: name,
+          value: value,
+          render_env: render_env,
+        )
+      end
+
+      def build_collection_part(name, value, **options)
+        collection_as = collection_options(name: name, **options)[:as]
+        item_name, item_as = collection_item_options(name: name, **options).values_at(:name, :as)
+
+        arr = value.to_ary.map { |obj|
+          build_part(item_name, obj, **options.merge(as: item_as))
+        }
+
+        build_part(name, arr, **options.merge(as: collection_as))
+      end
+
+      def collection_options(name:, **options)
+        collection_as = options[:as].is_a?(Array) ? options[:as].first : nil
+
+        options.merge(as: collection_as)
+      end
+
+      def collection_item_options(name:, **options)
+        singular_name = inflector.singularize(name).to_sym
+        singular_as =
+          if options[:as].is_a?(Array)
+            options[:as].last if options[:as].length > 1
+          else
+            options[:as]
+          end
+
+        if singular_as && !singular_as.is_a?(Class)
+          singular_as = inflector.singularize(singular_as.to_s)
+        end
+
+        options.merge(
+          name: singular_name,
+          as: singular_as,
+        )
+      end
+
+      def part_class(name:, fallback_class: Part, **options)
+        name = options[:as] || name
+
+        if name.is_a?(Class)
+          name
+        else
+          fetch_or_store(namespace, name, fallback_class) do
+            resolve_part_class(name: name, fallback_class: fallback_class)
+          end
+        end
+      end
+
+      def resolve_part_class(name:, fallback_class:)
+        return fallback_class unless namespace
+
+        name = inflector.camelize(name.to_s)
+
+        # Give autoloaders a chance to act
+        begin
+          klass = namespace.const_get(name)
+        rescue NameError
+        end
+
+        if !klass && namespace.const_defined?(name, false)
+          klass = namespace.const_get(name)
+        end
+
+        if klass && klass < Part
+          klass
+        else
+          fallback_class
+        end
+      end
+
+      def inflector
+        render_env.inflector
+      end
+    end
+  end
+end

data/lib/dry/view/path.rb

@@ -1,19 +1,36 @@
+# frozen_string_literal: true
+
 require "pathname"
+require "dry/core/cache"
 
 module Dry
-  module View
+  class View
+    # @api private
     class Path
+      extend Dry::Core::Cache
       include Dry::Equalizer(:dir, :root)
 
       attr_reader :dir, :root
 
-      def initialize(dir, options = {})
+      def self.[](path)
+        if path.is_a?(self)
+          path
+        else
+          new(path)
+        end
+      end
+
+      def initialize(dir, root: dir)
         @dir = Pathname(dir)
-        @root = Pathname(options.fetch(:root, dir))
+        @root = root
       end
 
-      def lookup(name, format)
-        template?(name, format) || template?("shared/#{name}", format) || !root? && chdir('..').lookup(name, format)
+      def lookup(name, format, include_shared: true)
+        fetch_or_store(dir, root, name, format) do
+          template?(name, format) ||
+            (include_shared && template?("shared/#{name}", format)) ||
+            !root? && chdir("..").lookup(name, format)
+        end
       end
 
       def chdir(dirname)

data/lib/dry/view/render_environment.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "dry/equalizer"
+
+module Dry
+  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)
+        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/dry/view/render_environment_missing.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "dry/inflector"
+
+module Dry
+  class View
+    # @api private
+    class RenderEnvironmentMissing
+      class MissingEnvironmentError < StandardError
+        def message
+          "a +render_env+ must be provided"
+        end
+      end
+
+      def format
+        raise MissingEnvironmentError
+      end
+
+      def context
+        raise MissingEnvironmentError
+      end
+
+      def part(name, value, **options)
+        raise MissingEnvironmentError
+      end
+
+      def scope(name = nil, locals)
+        raise MissingEnvironmentError
+      end
+
+      def template(name, scope, &block)
+        raise MissingEnvironmentError
+      end
+
+      def partial(name, scope, &block)
+        raise MissingEnvironmentError
+      end
+
+      def inflector
+        @inflector ||= Dry::Inflector.new
+      end
+    end
+  end
+end

data/lib/dry/view/rendered.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "dry/equalizer"
+
+module Dry
+  class View
+    # Output of a View rendering
+    #
+    # @api public
+    class Rendered
+      include Dry::Equalizer(:output, :locals)
+
+      # Returns the rendered view
+      #
+      # @return [String]
+      #
+      # @api public
+      attr_reader :output
+
+      # Returns the hash of locals used to render the view
+      #
+      # @return [Hash[<Symbol, Dry::View::Part>] locals hash
+      #
+      # @api public
+      attr_reader :locals
+
+      # @api private
+      def initialize(output:, locals:)
+        @output = output
+        @locals = locals
+      end
+
+      # Returns the local corresponding to the key
+      #
+      # @param name [Symbol] local key
+      #
+      # @return [Dry::View::Part]
+      #
+      # @api public
+      def [](name)
+        locals[name]
+      end
+
+      # Returns the rendered view
+      #
+      # @return [String]
+      #
+      # @api public
+      def to_s
+        output
+      end
+      alias_method :to_str, :to_s
+    end
+  end
+end

data/lib/dry/view/renderer.rb

@@ -1,27 +1,29 @@
-require 'tilt'
-require 'dry-equalizer'
+# frozen_string_literal: true
+
+require "dry/core/cache"
+require "dry/equalizer"
+require_relative "tilt"
 
 module Dry
-  module View
+  class View
+    # @api private
     class Renderer
-      PARTIAL_PREFIX = "_".freeze
-      PATH_DELIMITER = "/".freeze
+      PARTIAL_PREFIX = "_"
+      PATH_DELIMITER = "/"
 
-      include Dry::Equalizer(:paths, :format, :options)
+      extend Dry::Core::Cache
 
-      TemplateNotFoundError = Class.new(StandardError)
+      include Dry::Equalizer(:paths, :format, :engine_mapping, :options)
 
-      attr_reader :paths, :format, :options, :tilts
+      TemplateNotFoundError = Class.new(StandardError)
 
-      def self.tilts
-        @__engines__ ||= {}
-      end
+      attr_reader :paths, :format, :engine_mapping, :options
 
-      def initialize(paths, format:, **options)
+      def initialize(paths, format:, engine_mapping: nil, **options)
         @paths = paths
         @format = format
+        @engine_mapping = engine_mapping || {}
         @options = options
-        @tilts = self.class.tilts
       end
 
       def template(name, scope, &block)
@@ -46,12 +48,13 @@ module Dry
       def chdir(dirname)
         new_paths = paths.map { |path| path.chdir(dirname) }
 
-        self.class.new(new_paths, format: format)
+        self.class.new(new_paths, format: format, **options)
       end
 
       def lookup(name)
-        paths.inject(false) { |result, path|
-          result || path.lookup(name, format)
+        paths.inject(false) { |_, path|
+          result = path.lookup(name, format, include_shared: false)
+          break result if result
         }
       end
 
@@ -59,12 +62,12 @@ module Dry
 
       def name_for_partial(name)
         name_segments = name.to_s.split(PATH_DELIMITER)
-        partial_name = name_segments[0..-2].push("#{PARTIAL_PREFIX}#{name_segments[-1]}").join(PATH_DELIMITER)
+        name_segments[0..-2].push("#{PARTIAL_PREFIX}#{name_segments[-1]}").join(PATH_DELIMITER)
       end
 
       def tilt(path)
-        tilts.fetch(path) {
-          tilts[path] = Tilt.new(path, nil, **options)
+        fetch_or_store(:engine, path, engine_mapping, options) {
+          Tilt[path, engine_mapping, **options]
         }
       end
     end

data/lib/dry/view/scope.rb

@@ -1,43 +1,175 @@
-require 'dry-equalizer'
+# frozen_string_literal: true
+
+require "dry/equalizer"
+require "dry/core/constants"
+require_relative "render_environment_missing"
 
 module Dry
-  module View
+  class View
+    # Evaluation context for templates (including layouts and partials) and
+    # provides a place to encapsulate view-specific behaviour alongside a
+    # template and its locals.
+    #
+    # @abstract Subclass this and provide your own methods adding view-specific
+    #   behavior. You should not override `#initialize`
+    #
+    # @see https://dry-rb.org/gems/dry-view/templates/
+    # @see https://dry-rb.org/gems/dry-view/scopes/
+    #
+    # @api public
     class Scope
-      include Dry::Equalizer(:_locals, :_context, :_renderer)
+      # @api private
+      CONVENIENCE_METHODS = %i[format context locals].freeze
+
+      include Dry::Equalizer(:_name, :_locals, :_render_env)
+
+      # The scope's name
+      #
+      # @return [Symbol]
+      #
+      # @api public
+      attr_reader :_name
 
+      # The scope's locals
+      #
+      # @overload _locals
+      #   Returns the locals
+      # @overload locals
+      #   A convenience alias for `#_format.` Is available unless there is a
+      #   local named `locals`
+      #
+      # @return [Hash[<Symbol, Object>]
+      #
+      # @api public
       attr_reader :_locals
-      attr_reader :_context
-      attr_reader :_renderer
 
-      def initialize(renderer:, context: nil, locals: {})
+      # The current render environment
+      #
+      # @return [RenderEnvironment] render environment
+      #
+      # @api private
+      attr_reader :_render_env
+
+      # Returns a new Scope instance
+      #
+      # @param name [Symbol, nil] scope name
+      # @param locals [Hash<Symbol, Object>] template locals
+      # @param render_env [RenderEnvironment] render environment
+      #
+      # @return [Scope]
+      #
+      # @api public
+      def initialize(name: nil, locals: Dry::Core::Constants::EMPTY_HASH, render_env: RenderEnvironmentMissing.new)
+        @_name = name
         @_locals = locals
-        @_context = context
-        @_renderer = renderer
+        @_render_env = render_env
+      end
+
+      # @overload render(partial_name, **locals, &block)
+      #   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
+      #
+      #   @param locals[Hash<Symbol, Object>] partial locals
+      #   @yieldreturn [String] string content to include where the partial calls `yield`
+      #
+      # @return [String] the rendered partial output
+      #
+      # @api public
+      def render(partial_name = nil, **locals, &block)
+        partial_name ||= _name
+        raise ArgumentError, "+partial_name+ must be provided for unnamed scopes" unless partial_name
+        partial_name = _inflector.underscore(_inflector.demodulize(partial_name.to_s)) if partial_name.is_a?(Class)
+
+        _render_env.partial(partial_name, _render_scope(locals), &block)
+      end
+
+      # Build 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
+      #
+      # @return [Scope]
+      #
+      # @api public
+      def scope(name = nil, **locals)
+        _render_env.scope(name, locals)
       end
 
-      def render(partial_name, **locals, &block)
-        _renderer.partial(partial_name, __render_scope(locals), &block)
+      # The template format for the current render environment.
+      #
+      # @overload _format
+      #   Returns the format.
+      # @overload format
+      #   A convenience alias for `#_format.` Is available unless there is a
+      #   local named `format`
+      #
+      # @return [Symbol] format
+      #
+      # @api public
+      def _format
+        _render_env.format
+      end
+
+      # The context object for the current render environment
+      #
+      # @overload _context
+      #   Returns the context.
+      # @overload context
+      #   A convenience alias for `#_context`. Is available unless there is a
+      #   local named `context`.
+      #
+      # @return [Context] context
+      #
+      # @api public
+      def _context
+        _render_env.context
       end
 
       private
 
+      # 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.
       def method_missing(name, *args, &block)
         if _locals.key?(name)
           _locals[name]
         elsif _context.respond_to?(name)
           _context.public_send(name, *args, &block)
+        elsif CONVENIENCE_METHODS.include?(name)
+          __send__(:"_#{name}", *args, &block)
         else
           super
         end
       end
 
-      def __render_scope(**locals)
-        if locals.any?
-          self.class.new(renderer: _renderer, context: _context, locals: locals)
-        else
+      def respond_to_missing?(name, include_private = false)
+        _locals.key?(name) || _render_env.context.respond_to?(name) || CONVENIENCE_METHODS.include?(name) || super
+      end
+
+      def _render_scope(**locals)
+        if locals.none?
           self
+        else
+          self.class.new(
+            # FIXME: what about `name`?
+            locals: locals,
+            render_env: _render_env,
+          )
         end
       end
+
+      def _inflector
+        _render_env.inflector
+      end
     end
   end
 end