hanami-view 1.3.2 → 2.0.0.alpha5

data/lib/hanami/view/rendering/options.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Hanami
-  module View
-    module Rendering
-      # Rendering options
-      #
-      # @since 1.1.1
-      # @api private
-      class Options
-        # @since 1.1.1
-        # @api private
-        def self.build(options, locals, format)
-          options.dup.tap do |opts|
-            opts[:format] ||= format
-            opts[:locals] = locals
-            opts[:locals].merge!(options.fetch(:locals) { ::Hash.new })
-            opts[:locals].merge!(format: opts.fetch(:format, format))
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/partial.rb

@@ -1,31 +0,0 @@
-require 'hanami/view/rendering/partial_finder'
-
-module Hanami
-  module View
-    module Rendering
-      # Rendering partial
-      #
-      # It's used when a template wants to render a partial.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View::Rendering::Template
-      # @see Hanami::View::Rendering::LayoutScope#render
-      #
-      # @example
-      #   # We have an application template (templates/application.html.erb)
-      #   # that uses the following line:
-      #
-      #   <%= render partial: 'shared/sidebar' %>
-      class Partial < Template
-        protected
-        # @api private
-        # @since 0.1.0
-        def template
-          PartialFinder.new(@view.class, @options).find
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/partial_file.rb

@@ -1,29 +0,0 @@
-module Hanami
-  module View
-    module Rendering
-      # @since 0.7.0
-      # @api private
-      class PartialFile
-        # @since 0.7.0
-        # @api private
-        attr_reader :key
-
-        # @since 0.7.0
-        # @api private
-        attr_reader :format
-
-        # @since 0.7.0
-        # @api private
-        attr_reader :template
-
-        # @since 0.7.0
-        # @api private
-        def initialize(key, format, template)
-          @key      = key
-          @format   = format
-          @template = template
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/partial_finder.rb

@@ -1,75 +0,0 @@
-require 'hanami/view/rendering/template_finder'
-
-module Hanami
-  module View
-    module Rendering
-      # Find a partial for the current view context.
-      # It's used when a template wants to render a partial.
-      #
-      # @see Hanami::View::Rendering::Partial
-      # @see Hanami::View::Rendering::TemplateFinder
-      #
-      # @api private
-      # @since 0.1.0
-      class PartialFinder < TemplateFinder
-        # Template file name prefix.
-        # By convention a partial file name starts with this prefix.
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @example
-        #   "_sidebar.html.erb"
-        PREFIX = '_'.freeze
-
-        # Find a template for a partial. Initially it will look for the
-        # partial template in the framework configuration where it may
-        # already be cached. Failing that it will look under the
-        # directory of the parent directory view template, if not found
-        # it will search recursively from the view root.
-        #
-        # @return [Hanami::View::Template] the requested template
-        #
-        # @see Hanami::View::Rendering::TemplateFinder#find
-        #
-        # @since 0.4.3
-        # @api private
-        def find
-          Hanami::View::Configuration.for(@view).
-            find_partial(relative_partial_path, template_name, format)
-        end
-
-        protected
-
-        # @since 0.7.0
-        # @api private
-        def relative_partial_path
-          [view_template_dir, template_name].join(separator)
-        end
-
-        # @since 0.4.3
-        # @api private
-        def view_template_dir
-          *all, _ = @view.template.split(separator)
-          all.join(separator)
-        end
-
-        # @api private
-        def template_name
-          *all, last = partial_name.split(separator)
-          all.push( last.prepend(prefix) ).join(separator)
-        end
-
-        # @api private
-        def partial_name
-          @options[:partial]
-        end
-
-        # @api private
-        def prefix
-          PREFIX
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/partial_templates_finder.rb

@@ -1,73 +0,0 @@
-require 'hanami/view/template'
-require 'hanami/view/rendering/partial_file'
-
-module Hanami
-  module View
-    module Rendering
-      # Find partial templates in the file system
-      #
-      # @api private
-      # @since 0.7.0
-      #
-      # @see View::Template
-      class PartialTemplatesFinder
-        # Search pattern for partial file names
-        #
-        # @api private
-        # @since 0.7.0
-        PARTIAL_PATTERN = '_*'.freeze
-
-        # @api private
-        # @since 0.7.0
-        PARTIAL_PARTS_SEPARATOR = '.'.freeze
-
-        # @api private
-        # @since 0.7.0
-        attr_reader :configuration
-
-        # Initializes a new PartialTemplatesFinder
-        #
-        # @param configuration [Configuration] the configuration object
-        #
-        # @since 0.7.0
-        # @api private
-        def initialize(configuration)
-          @configuration = configuration
-        end
-
-        # Find partials under the given path
-        #
-        # @return [Array] array of PartialFinder objects
-        #
-        # @since 0.7.0
-        # @api private
-        def find
-          _find_partials(configuration.root).map do |template|
-            partial_path, partial_base_name = Pathname(template).relative_path_from(configuration.root).split
-            partial_base_parts              = partial_base_name.to_s.split(PARTIAL_PARTS_SEPARATOR)
-
-            PartialFile.new(
-              "#{partial_path}#{::File::SEPARATOR}#{partial_base_parts[0]}",
-              partial_base_parts[1],
-              View::Template.new(template, configuration.default_encoding)
-            )
-          end
-        end
-
-        private
-
-        # Find partial template file paths
-        #
-        # @param path [String] the path under which we should search for partials
-        #
-        # @return [Array] an array of strings for each matching partial template file found
-        #
-        # @since 0.7.0
-        # @api private
-        def _find_partials(path)
-          Dir.glob("#{ [path, TemplatesFinder::RECURSIVE, PARTIAL_PATTERN].join(::File::SEPARATOR) }.#{TemplatesFinder::FORMAT}.#{TemplatesFinder::ENGINES}")
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/registry.rb

@@ -1,134 +0,0 @@
-require 'hanami/view/rendering/layout_registry'
-require 'hanami/view/rendering/view_finder'
-
-module Hanami
-  module View
-    module Rendering
-      # Holds all the references of all the registered subclasses of a view.
-      # We have one registry for each superclass view.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View::Rendering::LayoutRegistry
-      # @see Hanami::View::Rendering#registry
-      #
-      # @example
-      #   require 'hanami/view'
-      #
-      #   module Articles
-      #     class Index
-      #       include Hanami::View
-      #     end
-      #
-      #     class Show
-      #       include Hanami::View
-      #     end
-      #
-      #     class JsonShow < Show
-      #       format :json
-      #     end
-      #
-      #     class XmlShow < Show
-      #       format :xml
-      #
-      #       def render
-      #         ArticleSerializer.new(article).to_xml
-      #       end
-      #     end
-      #   end
-      #
-      #   # We have the following templates:
-      #   #
-      #   #  * articles/index.html.erb
-      #   #  * articles/index.atom.erb
-      #   #  * articles/show.html.erb
-      #   #  * articles/show.json.erb
-      #
-      #   # One registry per superclass view
-      #   Articles::Index.send(:registry).object_id     # => 70135342862240
-      #
-      #   Articles::Show.send(:registry).object_id      # => 70135342110540
-      #   Articles::XmlShow.send(:registry).object_id   # => 70135342110540
-      #   Articles::JsonShow.send(:registry).object_id  # => 70135342110540
-      #
-      #
-      #
-      #   # It holds the references for all the templates and the views
-      #   Articles::Index.send(:registry).inspect
-      #     # => { :all  => [Articles::Index, nil],
-      #     #      :atom => [Articles::Index, #<Hanami::View::Template ... @file="/path/to/templates/articles/index.atom.erb"],
-      #     #      :html => [Articles::Index, #<Hanami::View::Template ... @file="/path/to/templates/articles/index.html.erb"] }
-      #
-      #   Articles::Show.send(:registry).inspect
-      #     # => { :all  => [Articles::Show, nil],
-      #     #      :html => [Articles::Show,     #<Hanami::View::Template ... @file="/path/to/templates/articles/show.html.erb"],
-      #     #      :json => [Articles::JsonShow, #<Hanami::View::Template ... @file="/path/to/templates/articles/show.json.erb"],
-      #     #      :xml  => [Articles::XmlShow, nil] }
-      class Registry < LayoutRegistry
-        # Default format for views without an explicit format.
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @see Hanami::View::Dsl#format
-        DEFAULT_FORMAT = :all
-
-        # Returns the view for the given context.
-        #
-        # @param context [Hash] the rendering context
-        # @option context [Symbol] :format the requested format
-        #
-        # @return [Hanami::View] the view associated with the given context
-        #
-        # @raise [Hanami::View::MissingFormatError] if the given context doesn't
-        #   have the :format key
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @see Hanami::View::Rendering#render
-        def resolve(context)
-          view, template = @registry.fetch(format(context)) { @registry[DEFAULT_FORMAT] }
-          view.new(template, context)
-        end
-
-        private
-        # @api private
-        def prepare!
-          prepare_views!
-          prepare_templates!
-        end
-
-        # @api private
-        def prepare_views!
-          views.each do |view|
-            @registry.merge! view.format || DEFAULT_FORMAT => [ view, template_for(view) ]
-          end
-        end
-
-        # @api private
-        def prepare_templates!
-          templates.each do |template|
-            @registry.merge! template.format => [ view_for(template), template ]
-          end
-        end
-
-        # @api private
-        def views
-          @view.subclasses + [ @view ]
-        end
-
-        # @api private
-        def view_for(template)
-          ViewFinder.new(@view).find(template)
-        end
-
-        # @api private
-        def template_for(view)
-          templates.find {|template| template.format == view.format }
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/scope.rb

@@ -1,108 +0,0 @@
-require 'hanami/utils/escape'
-require 'hanami/view/rendering/layout_scope'
-require 'hanami/view/rendering/template'
-require 'hanami/view/rendering/partial'
-
-module Hanami
-  module View
-    module Rendering
-      # Rendering view scope
-      #
-      # @since 0.1.0
-      #
-      # @see Hanami::View::Rendering::LayoutScope
-      class Scope < LayoutScope
-        # Initialize the scope
-        #
-        # @param view [Class] the view
-        # @param locals [Hash] a set of objects available during the rendering
-        # @option locals [Symbol] :format the requested format
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(view, locals = {})
-          @view   = view
-          @locals = locals
-          @layout = layout
-          @scope  = nil
-        end
-
-        # Returns an inspect String
-        #
-        # @return [String] inspect String (contains classname, objectid in hex, available ivars)
-        #
-        # @since 0.3.0
-        def inspect
-          base = "#<#{ self.class }: #{'%x' % (self.object_id << 1)}"
-          base << " @view=\"#{@view}\"" if @view
-          base << " @locals=\"#{@locals}\"" if @locals
-          base << ">"
-        end
-
-        # Returns the requested format.
-        #
-        # @return [Symbol] the requested format (eg. :html, :json, :xml, etc..)
-        #
-        # @since 0.1.0
-        def format
-          locals[:format]
-        end
-
-        # Implements "respond to" logic
-        #
-        # @return [TrueClass,FalseClass]
-        #
-        # @since 0.3.0
-        # @api private
-        #
-        # @see http://ruby-doc.org/core/Object.html#method-i-respond_to_missing-3F
-        def respond_to_missing?(m, include_all)
-          # FIXME: this isn't compatible with Hanami 2.0, as it extends a view
-          # that we want to be frozen in the future
-          #
-          # See https://github.com/hanami/view/issues/130#issuecomment-319326236
-          @view.respond_to?(m, include_all) ||
-            @locals.key?(m)
-        end
-
-        protected
-
-        # @api private
-        def method_missing(m, *args, &block)
-          ::Hanami::View::Escape.html(
-            # FIXME: this isn't compatible with Hanami 2.0, as it extends a view
-            # that we want to be frozen in the future
-            #
-            # See https://github.com/hanami/view/issues/130#issuecomment-319326236
-            if @view.respond_to?(m, true)
-              @view.__send__ m, *args, &block
-            elsif @locals.key?(m)
-              @locals[m]
-            else
-              super
-            end
-          )
-        end
-
-        private
-
-        # @since 1.1.1
-        # @api private
-        def _options(options)
-          current_locals = locals.reject { |key, _| @view.respond_to?(key) }
-          Options.build(options, current_locals, format)
-        end
-
-        # @since 0.4.2
-        # @api private
-        def layout
-          if @view.class.respond_to?(:layout)
-            @view.class.layout.new(self, "")
-          else
-            nil
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/subscope.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-require "hanami/view/rendering/scope"
-require "hanami/view/rendering/options"
-
-module Hanami
-  module View
-    module Rendering
-      # Rendering subscope
-      #
-      # @since 1.1.1
-      # @api private
-      #
-      # @see Hanami::View::Rendering::Scope
-      class Subscope < Scope
-        # Implements "respond to" logic
-        #
-        # @return [TrueClass,FalseClass]
-        #
-        # @since 1.1.1
-        # @api private
-        #
-        # @see http://ruby-doc.org/core/Object.html#method-i-respond_to_missing-3F
-        def respond_to_missing?(m, _include_all)
-          @locals.key?(m)
-        end
-
-        protected
-
-        # @since 1.1.1
-        # @api private
-        def method_missing(m, *args, &block)
-          ::Hanami::View::Escape.html(
-            # FIXME: this isn't compatible with Hanami 2.0, as it extends a view
-            # that we want to be frozen in the future
-            #
-            # See https://github.com/hanami/view/issues/130#issuecomment-319326236
-            if @locals.key?(m)
-              @locals[m]
-            else
-              super
-            end
-          )
-        end
-
-        private
-
-        # @since 1.1.1
-        # @api private
-        def _options(options)
-          Options.build(options, locals, format)
-        end
-      end
-    end
-  end
-end

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

@@ -1,69 +0,0 @@
-require 'hanami/view/rendering/template_finder'
-
-module Hanami
-  module View
-    module Rendering
-      # Rendering template
-      #
-      # It's used when a template wants to render another template.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View::Rendering::LayoutScope#render
-      #
-      # @example
-      #   # We have an application template (templates/application.html.erb)
-      #   # that uses the following line:
-      #
-      #   <%= render template: 'articles/show' %>
-      class Template
-        # Initialize a template
-        #
-        # @param view [Hanami::View] the current view
-        # @param options [Hash] the rendering informations
-        # @option options [Symbol] :format the current format
-        # @option options [Hash] :locals the set of objects available within
-        #   the rendering context
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(view, options)
-          @view, @options = view, options
-        end
-
-        # Render the template.
-        #
-        # @return [String] the output of the rendering process.
-        #
-        # @raise [Hanami::View::MissingTemplateError] if template can't be found
-        #
-        # @api private
-        # @since 0.1.0
-        def render
-          (template or raise_missing_template_error).render(scope)
-        end
-
-        protected
-        # @api private
-        def template
-          TemplateFinder.new(@view.class, @options).find
-        end
-
-        # @api private
-        def scope
-          Subscope.new(@view, @options[:locals])
-        end
-
-        # @since 0.5.0
-        # @api private
-        def raise_missing_template_error
-          raise MissingTemplateError.new(
-            @options.fetch(:template) { @options.fetch(:partial, nil) },
-            @options[:format]
-          )
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering/template_finder.rb

@@ -1,55 +0,0 @@
-require 'hanami/view/rendering/templates_finder'
-
-module Hanami
-  module View
-    module Rendering
-      # Find a template for the current view context.
-      # It's used when a template wants to render another template.
-      #
-      # @see Hanami::View::Rendering::Template
-      # @see Hanami::View::Rendering::TemplatesFinder
-      #
-      # @api private
-      # @since 0.1.0
-      class TemplateFinder < TemplatesFinder
-        # Initialize a finder
-        #
-        # @param view [Class] a view
-        # @param options [Hash] the informations about the context
-        # @option options [String] :template the template file name
-        # @option options [Symbol] :format the requested format
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(view, options)
-          super(view)
-          @options = options
-        end
-
-        # Find a template for the current view context
-        #
-        # @return [Hanami::View::Template] the requested template
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @see Hanami::View::Rendering::TemplatesFinder#find
-        # @see Hanami::View::Rendering::Template#render
-        def find
-          super.first
-        end
-
-        protected
-        # @api private
-        def template_name
-          @options[:template]
-        end
-
-        # @api private
-        def format
-          @options[:format]
-        end
-      end
-    end
-  end
-end