hanami-view 1.3.2 → 2.0.0.alpha5

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.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

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

@@ -1,37 +0,0 @@
-module Hanami
-  module View
-    module Rendering
-      # Find a view
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View::Rendering::Registry
-      class ViewFinder
-        # Initialize a finder
-        #
-        # @param view [Class] the superclass view
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(view)
-          @view = view
-        end
-
-        # Find a view for the given template.
-        # It looks up for the current view and its subclasses.
-        #
-        # @param template [Hanami::View::Template] a template to be associated
-        #   to a view
-        #
-        # @return [Class] a view associated with the given template
-        #
-        # @api private
-        # @since 0.1.0
-        def find(template)
-          @view.subclasses.find {|v| v.format == template.format } || @view
-        end
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering.rb

@@ -1,294 +0,0 @@
-require 'hanami/view/rendering/registry'
-require 'hanami/view/rendering/scope'
-require 'hanami/view/rendering/subscope'
-require 'hanami/view/rendering/null_local'
-
-module Hanami
-  module View
-    # Rendering methods
-    #
-    # @since 0.1.0
-    #
-    # @see Hanami::View::Rendering::InstanceMethods
-    module Rendering
-      # @since 0.1.0
-      # @api private
-      def self.extended(base)
-        base.class_eval do
-          include InstanceMethods
-        end
-      end
-
-      module InstanceMethods
-        # Initialize a view
-        #
-        # @param template [Hanami::View::Template] the template to render
-        # @param locals [Hash] a set of objects available during the rendering
-        #   process.
-        #
-        # @since 0.1.0
-        #
-        # @see Hanami::View::Template
-        #
-        # @example
-        #   require 'hanami/view'
-        #
-        #   class IndexView
-        #     include Hanami::View
-        #   end
-        #
-        #   template = Hanami::View::Template.new('index.html.erb')
-        #   view     = IndexView.new(template, {article: article})
-        def initialize(template, **locals)
-          @template = template
-          @locals   = locals
-          @scope    = Scope.new(self, @locals)
-        end
-
-        # Render the template by bounding the local scope.
-        # If it uses a layout, it renders the template first and then the
-        # control passes to the layout.
-        #
-        # Override this method for custom rendering policies.
-        # For instance, when a serializer is used and there isn't the need of
-        # a template.
-        #
-        # @return [String] the output of the rendering process
-        #
-        # @raise [Hanami::View::MissingTemplateError] if the template is nil
-        #
-        # @since 0.1.0
-        #
-        # @see Hanami::View::Layout
-        #
-        # @example with template
-        #   require 'hanami/view'
-        #
-        #   class IndexView
-        #     include Hanami::View
-        #   end
-        #
-        #   template = Hanami::View::Template.new('index.html.erb')
-        #   view     = IndexView.new(template, {article: article})
-        #
-        #   view.render # => <h1>Introducing Hanami::view</h1> ...
-        #
-        # @example with template and layout
-        #   require 'hanami/view'
-        #
-        #   class ApplicationLayout
-        #     include Hanami::View::Layout
-        #   end
-        #
-        #   class IndexView
-        #     include Hanami::View
-        #     layout :application
-        #   end
-        #
-        #   template = Hanami::View::Template.new('index.html.erb')
-        #   view     = IndexView.new(template, {article: article})
-        #
-        #   view.render # => <html> ... <h1>Introducing Hanami::view</h1> ...
-        #
-        # @example with custom rendering
-        #   require 'hanami/view'
-        #
-        #   class IndexView
-        #     include Hanami::View
-        #
-        #     def render
-        #       ArticleSerializer.new(article).render
-        #     end
-        #   end
-        #
-        #   view = IndexView.new(nil, {article: article})
-        #
-        #   view.render # => {title: ...}
-        def render
-          layout.render
-        end
-
-        # It tries to invoke a method for the view or a local for the given key.
-        # If the lookup fails, it returns a null object.
-        #
-        # @return [Object,Hanami::View::Rendering::NullLocal] the returning value
-        #
-        # @since 0.7.0
-        #
-        # @example
-        #   <% if local(:plan).overdue? %>
-        #     <h2>Your plan is overdue.</h2>
-        #   <% end %>
-        def local(key)
-          if respond_to?(key)
-            __send__(key)
-          else
-            locals.fetch(key) { NullLocal.new(key) }
-          end
-        end
-
-        protected
-        # The output of the template rendering process.
-        #
-        # @return [String] the rendering output
-        #
-        # @raise [Hanami::View::MissingTemplateError] if the template is nil
-        #
-        # @api private
-        # @since 0.1.0
-        def rendered
-          template.render @scope
-        end
-
-        # The layout.
-        #
-        # @return [Class, Hanami::View::Rendering::NullLayout]
-        #
-        # @see Hanami::View::Layout
-        # @see Hanami::View.layout
-        # @see Hanami::View::Dsl#layout
-        #
-        # @api private
-        # @since 0.1.0
-        def layout
-          @layout ||= self.class.layout.new(@scope, rendered)
-        end
-
-        # The template.
-        #
-        # @return [Hanami::View::Template] the template
-        #
-        # @raise [Hanami::View::MissingTemplateError] if the template is nil
-        #
-        # @api private
-        # @since 0.1.0
-        def template
-          @template or raise MissingTemplateError.new(self.class.template, @scope.format)
-        end
-
-        # A set of objects available during the rendering process.
-        #
-        # @return [Hash]
-        #
-        # @see Hanami::View#initialize
-        #
-        # @api private
-        # @since 0.1.0
-        def locals
-          @locals
-        end
-
-        # Delegates missing methods to the scope.
-        #
-        # @see Hanami::View::Rendering::Scope
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @example
-        #   require 'hanami/view'
-        #
-        #   class IndexView
-        #     include Hanami::View
-        #   end
-        #
-        #   template = Hanami::View::Template.new('index.html.erb')
-        #   view     = IndexView.new(template, {article: article})
-        #
-        #   view.article # => #<Article:0x007fb0bbd3b6e8>
-        def method_missing(m, *)
-          @scope.__send__ m
-        end
-      end
-
-      # Render the given context and locals with the appropriate template.
-      # If there are registered subclasses, it choose the right class, according
-      #   to the requested format.
-      #
-      # @param context [Hash] the context for the rendering process
-      # @option context [Symbol] :format the requested format
-      #
-      # @return [String] the output of the rendering process
-      #
-      # @raise [Hanami::View::MissingTemplateError] if it can't find a template
-      #   for the given context
-      #
-      # @raise [Hanami::View::MissingFormatError] if the given context doesn't
-      #   have the :format key
-      #
-      # @since 0.1.0
-      #
-      # @see Hanami::View#initialize
-      # @see Hanami::View#render
-      #
-      # @example
-      #   require 'hanami/view'
-      #
-      #   article = OpenStruct.new(title: 'Hello')
-      #
-      #   module Articles
-      #     class Show
-      #       include Hanami::View
-      #
-      #       def title
-      #         @title ||= article.title.upcase
-      #       end
-      #     end
-      #
-      #     class JsonShow < Show
-      #       format :json
-      #
-      #       def title
-      #         super.downcase
-      #       end
-      #     end
-      #   end
-      #
-      #   Hanami::View.root = '/path/to/templates'
-      #   Hanami::View.load!
-      #
-      #   Articles::Show.render(format: :html,  article: article)
-      #     # => renders `articles/show.html.erb`
-      #
-      #   Articles::Show.render(format: :json, article: article)
-      #     # => renders `articles/show.json.erb`
-      #
-      #   Articles::Show.render(format: :xml, article: article)
-      #     # => raises Hanami::View::MissingTemplateError
-      def render(context)
-        registry.resolve(context).render
-      end
-
-      protected
-
-      # Loading mechanism hook.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View.load!
-      def load!
-        super
-        load_registry!
-      end
-
-      private
-
-      # The registry that holds all the registered subclasses.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View::Rendering::Registry
-      def registry
-        @registry ||= Registry.new(self)
-      end
-
-      # @api private
-      def load_registry!
-        @registry = nil
-        registry.freeze
-      end
-    end
-  end
-end

data/lib/hanami/view/template.rb

@@ -1,57 +0,0 @@
-require 'tilt'
-
-module Hanami
-  module View
-    # A logic-less template.
-    #
-    # @since 0.1.0
-    class Template
-      def initialize(template, encoding = Encoding::UTF_8)
-        options = { default_encoding: encoding }
-
-        if slim?(template)
-          # NOTE disable_escape: true is for Slim compatibility
-          # See https://github.com/hanami/assets/issues/36
-          options[:disable_escape] = true
-        end
-
-        @_template = Tilt.new(template, nil, options)
-      end
-
-      # Returns the format that the template handles.
-      #
-      # @return [Symbol] the format name
-      #
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/view'
-      #
-      #   template = Hanami::View::Template.new('index.html.erb')
-      #   template.format # => :html
-      def format
-        @_template.basename.match(/\.([^.]+)/).captures.first.to_sym
-      end
-
-      # Render the template within the context of the given scope.
-      #
-      # @param scope [Hanami::View::Scope] the rendering scope
-      #
-      # @return [String] the output of the rendering process
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View::Scope
-      def render(scope, &blk)
-        @_template.render(scope, {}, &blk)
-      end
-
-      private
-
-      def slim?(template)
-        File.extname(template) == ".slim".freeze
-      end
-    end
-  end
-end