hanami-view 1.3.3 → 2.0.0.alpha2

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(&block)
-          (template or raise_missing_template_error).render(scope, &block)
-        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

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

@@ -1,50 +0,0 @@
-require 'hanami/utils/string'
-
-module Hanami
-  module View
-    module Rendering
-      # @since 0.2.0
-      # @api private
-      class TemplateName
-        # @since 0.2.0
-        # @api private
-        NAMESPACE_SEPARATOR = '::'.freeze
-
-        # @since 0.2.0
-        # @api private
-        def initialize(name, namespace)
-          @name = name
-          compile!(namespace)
-        end
-
-        # @since 0.2.0
-        # @api private
-        def to_s
-          @name
-        end
-
-        private
-        # @since 0.2.0
-        # @api private
-        def compile!(namespace)
-          tokens(namespace) {|token| replace!(token) }
-          @name = Utils::String.underscore(@name)
-        end
-
-        # @since 0.2.0
-        # @api private
-        def tokens(namespace)
-          namespace.to_s.split(NAMESPACE_SEPARATOR).each do |token|
-            yield token
-          end
-        end
-
-        # @since 0.2.0
-        # @api private
-        def replace!(token)
-          @name = @name.gsub(%r{\A#{ token }#{ NAMESPACE_SEPARATOR }}, '')
-        end
-      end
-    end
-  end
-end

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

@@ -1,144 +0,0 @@
-require 'hanami/view/template'
-
-module Hanami
-  module View
-    module Rendering
-      # Find templates for a view
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see View::Template
-      class TemplatesFinder
-        # Default format
-        #
-        # @api private
-        # @since 0.1.0
-        FORMAT    = '*'.freeze
-
-        # Default template engines
-        #
-        # @api private
-        # @since 0.1.0
-        ENGINES   = '*'.freeze
-
-        # Recursive pattern
-        #
-        # @api private
-        # @since 0.2.0
-        RECURSIVE = '**'.freeze
-
-        # Initialize a finder
-        #
-        # @param view [Class] the view
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(view)
-          @view = view
-        end
-
-        # Find all the associated templates to the view.
-        # It recursively looks for templates under the root path of the view,
-        # that are matching the template name
-        #
-        # @return [Array<Hanami::View::Template>] the templates
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @see Hanami::View::Dsl#root
-        # @see Hanami::View::Dsl#template
-        #
-        # @example
-        #   require 'hanami/view'
-        #
-        #   module Articles
-        #     class Show
-        #       include Hanami::View
-        #     end
-        #   end
-        #
-        #   Articles::Show.root     # => "/path/to/templates"
-        #   Articles::Show.template # => "articles/show"
-        #
-        #   # This view has a template:
-        #   #
-        #   #   "/path/to/templates/articles/show.html.erb"
-        #
-        #   Hanami::View::Rendering::TemplatesFinder.new(Articles::Show).find
-        #     # => [#<Hanami::View::Template:0x007f8a0a86a970 ... @file="/path/to/templates/articles/show.html.erb">]
-        def find
-          _find.map do |template|
-            View::Template.new(template, @view.configuration.default_encoding)
-          end
-        end
-
-        protected
-
-        # @api private
-        # @since 0.4.3
-        #
-        # Searches first for files at `../templates/articles/index.*.*`
-        # If none are found, falls back to recursive search in `../templates/**/articles/index.*.*`
-        #
-        def _find(lookup = search_path)
-          base_path = templates_path(root, template_name)
-          if base_path.none?
-            templates_path(root, lookup, template_name)
-          else
-            base_path
-          end
-        end
-
-        # @api private
-        # @since 0.7.0
-        def templates_path(*parts)
-          Dir.glob("#{ parts.join(separator) }.#{ format }.#{ engines }")
-        end
-
-        # @api private
-        # @since 0.1.0
-        def template_name
-          @view.template
-        end
-
-        # @api private
-        # @since 0.1.0
-        def root
-          @view.root
-        end
-
-        # @api private
-        # @since 0.4.3
-        def search_path
-          recursive
-        end
-
-        # @api private
-        # @since 0.2.0
-        def recursive
-          RECURSIVE
-        end
-
-        # @api private
-        # @since 0.1.0
-        def separator
-          ::File::SEPARATOR
-        end
-
-        # @api private
-        # @since 0.1.0
-        def format
-          FORMAT
-        end
-
-        # @api private
-        # @since 0.1.0
-        def engines
-          ENGINES
-        end
-      end
-    end
-  end
-end