hanami-view 1.3.3 → 2.0.0.alpha2

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

@@ -1,83 +0,0 @@
-module Hanami
-  module View
-    module Rendering
-      # Null Object pattern for layout template
-      #
-      # It's used when a layout doesn't have an associated template.
-      #
-      # A common scenario is for non-html requests.
-      # Usually we have a template for the application layout
-      # (eg `templates/application.html.erb`), but we don't use to have the
-      # template for JSON requests (eg `templates/application.json.erb`).
-      # Because most of the times, we only return the output of the view.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/view'
-      #
-      #   # We have an ApplicationLayout (views/application_layout.rb):
-      #   class ApplicationLayout
-      #     include Hanami::Layout
-      #   end
-      #
-      #   # Our layout has a template for HTML requests, located at:
-      #   # templates/application.html.erb
-      #
-      #   # We set it as global layout
-      #   Hanami::View.layout = :application
-      #
-      #   # We have two views for HTML and JSON articles.
-      #   # They have a template each:
-      #   #
-      #   #   * templates/articles/show.html.erb
-      #   #   * templates/articles/show.json.erb
-      #   module Articles
-      #     class Show
-      #       include Hanami::View
-      #       format :html
-      #     end
-      #
-      #     class JsonShow < Show
-      #       format :json
-      #     end
-      #   end
-      #
-      #   # We initialize the framework
-      #   Hanami::View.load!
-      #
-      #
-      #
-      #   # When we ask for a HTML rendering, it will use `Articles::Show` and
-      #   # ApplicationLayout. The output will be a composition of:
-      #   #
-      #   #   * templates/articles/show.html.erb
-      #   #   * templates/application.html.erb
-      #
-      #   # When we ask for a JSON rendering, it will use `Articles::JsonShow`
-      #   # and ApplicationLayout. Since, the layout doesn't have any associated
-      #   # template for JSON, the output will be a composition of:
-      #   #
-      #   #   * templates/articles/show.json.erb
-      class NullTemplate
-        # Render the layout template
-        #
-        # @param scope [Hanami::View::Scope] the rendering scope
-        # @param locals [Hash] a set of objects available during the rendering
-        # @yield [Proc] yields the given block
-        #
-        # @return [String] the output of the rendering process
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @see Hanami::Layout#render
-        # @see Hanami::View::Rendering#render
-        def render(scope, locals = {})
-          yield
-        end
-      end
-    end
-  end
-end

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

@@ -1,26 +0,0 @@
-module Hanami
-  module View
-    module Rendering
-      # Null Object pattern for view
-      #
-      # It's used when a layout is rendered direcly for testing purposes
-      #
-      # @api private
-      # @since 1.2.1
-      class NullView
-        # Render the layout template
-        #
-        # @return [String] an empty string
-        #
-        # @api private
-        # @since 1.2.1
-        #
-        # @see Hanami::Layout#render
-        # @see Hanami::View::Rendering#render
-        def render
-          ""
-        end
-      end
-    end
-  end
-end

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