hanami-view 1.3.2 → 2.0.0.alpha5

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

@@ -1,128 +0,0 @@
-require 'hanami/utils/string'
-require 'hanami/utils/class'
-require 'hanami/view/rendering/null_layout'
-
-module Hanami
-  module View
-    module Rendering
-      # Defines the logic to find a layout
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::Layout
-      class LayoutFinder
-        # Layout class name suffix
-        #
-        # @api private
-        # @since 0.1.0
-        SUFFIX = 'Layout'.freeze
-
-        # Find a layout from the given name.
-        #
-        # @param layout [Symbol,String,NilClass] layout name or nil if you want
-        #   to fallback to the framework defaults (see `Hanami::View.layout`).
-        #
-        # @param namespace [Class,Module] a Ruby namespace where to lookup
-        #
-        # @return [Hanami::Layout] the layout for the given name or
-        #   `Hanami::View.layout`
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @example With given name
-        #   require 'hanami/view'
-        #
-        #   Hanami::View::Rendering::LayoutFinder.find(:article) # =>
-        #     ArticleLayout
-        #
-        # @example With a class
-        #   require 'hanami/view'
-        #
-        #   Hanami::View::Rendering::LayoutFinder.find(ArticleLayout) # =>
-        #     ArticleLayout
-        #
-        # @example With namespace
-        #   require 'hanami/view'
-        #
-        #   Hanami::View::Rendering::LayoutFinder.find(:application, CardDeck) # =>
-        #     CardDeck::ApplicationLayout
-        #
-        # @example With nil
-        #   require 'hanami/view'
-        #
-        #   Hanami::View::Rendering::LayoutFinder.find(nil) # =>
-        #     Hanami::View::Rendering::NullLayout
-        #
-        # @example With unknown layout
-        #   require 'hanami/view'
-        #
-        #   Hanami::View::Rendering::LayoutFinder.find(:unknown) # =>
-        #     Hanami::View::Rendering::NullLayout
-        #
-        def self.find(layout, namespace = Object)
-          case layout
-          when Symbol, String
-            # TODO Move this low level logic into a Hanami::Utils solution
-            class_name = "#{ Utils::String.classify(layout) }#{ SUFFIX }"
-            namespace  = Utils::Class.load!(namespace)
-            namespace.const_get(class_name)
-          when Class
-            layout
-          end || NullLayout
-        end
-
-        # Initialize the finder
-        #
-        # @param view [Class, #layout]
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(view)
-          @view = view
-        end
-
-        # Find the layout for the view
-        #
-        # @return [Hanami::Layout] the layout associated to the view
-        #
-        # @see Hanami::View::Rendering::LayoutFinder.find
-        # @see Hanami::View::Rendering::LayoutFinder#initialize
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @example With layout
-        #   require 'hanami/view'
-        #
-        #   module Articles
-        #     class Show
-        #       include Hanami::View
-        #       layout :article
-        #     end
-        #   end
-        #
-        #   Hanami::View::Rendering::LayoutFinder.new(Articles::Show) # =>
-        #     ArticleLayout
-        #
-        # @example Without layout
-        #   require 'hanami/view'
-        #
-        #   module Dashboard
-        #     class Index
-        #       include Hanami::View
-        #     end
-        #   end
-        #
-        #   Hanami::View.layout # => :application
-        #
-        #   Hanami::View::Rendering::LayoutFinder.new(Dashboard::Index) # =>
-        #     ApplicationLayout
-        def find
-          self.class.find(@view.layout)
-        end
-      end
-    end
-  end
-end

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

@@ -1,69 +0,0 @@
-require 'hanami/view/rendering/null_template'
-require 'hanami/view/rendering/templates_finder'
-
-module Hanami
-  module View
-    module Rendering
-      # Holds the references of all the registered layouts.
-      # As now the registry is unique at the level of the framework.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::Layout::ClassMethods#registry
-      class LayoutRegistry
-        # Initialize the registry
-        #
-        # @param view [Class] the view
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(view)
-          @registry = {}
-          @view = view
-          prepare!
-        end
-
-        # Returns the layout for the given context.
-        #
-        # @param context [Hash] the rendering context
-        # @option context [Symbol] :format the requested format
-        #
-        # @return [Hanami::Layout, Hanami::View::Rendering::NullTemplate]
-        #   the layout associated with the given context or a `NullTemplate` if
-        #   it can't be found.
-        #
-        # @raise [Hanami::View::MissingFormatError] if the given context doesn't
-        #   have the :format key
-        #
-        # @api private
-        # @since 0.1.0
-        def resolve(context)
-          @registry.fetch(format(context)) { NullTemplate.new }
-        end
-
-        protected
-        # @api private
-        # @since 0.1.0
-        def prepare!
-          templates.each do |template|
-            @registry.merge! template.format => template
-          end
-          @registry.any? or raise MissingTemplateLayoutError.new(@view)
-        end
-
-        # @api private
-        # @since 0.1.0
-        def templates
-          TemplatesFinder.new(@view).find
-        end
-
-        # @api private
-        # @since 0.1.0
-        def format(context)
-          context.fetch(:format) { raise MissingFormatError }
-        end
-      end
-    end
-  end
-end

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

@@ -1,267 +0,0 @@
-require 'hanami/view/rendering/null_local'
-require 'hanami/view/rendering/options'
-require 'hanami/utils/escape'
-require 'hanami/utils/basic_object'
-
-module Hanami
-  module View
-    module Rendering
-      # List of render types that exactly one of must be included when calling `#render`.
-      # For example, when calling `<%= render something: 'my_thing', locals: {} %>`,
-      # 'something' must be one of the values listed here.
-      #
-      # @since 1.1.0
-      # @api private
-      KNOWN_RENDER_TYPES = [:partial, :template].freeze
-
-      # Scope for layout rendering
-      #
-      # @since 0.1.0
-      class LayoutScope < Utils::BasicObject
-        # Initialize the scope
-        #
-        # @param layout [Hanami::Layout] the layout to render
-        # @param scope [Hanami::View::Rendering::Scope] the scope of the current
-        #   view
-        #
-        # @api private
-        # @since 0.1.0
-        def initialize(layout, scope)
-          @layout = layout
-          @scope  = scope
-          @view   = nil
-          @locals = nil
-        end
-
-        # Render a partial or a template within a layout template.
-        #
-        # @param options [Hash]
-        # @option options [String] :partial the partial template to render
-        # @option options [String] :template the template to render
-        #
-        # @return [String] the output of the rendering process
-        #
-        # @raise [Hanami::Error::UnknownRenderTypeError] if the given type to
-        #   be rendered is unknown
-        #
-        # @since 0.1.0
-        #
-        # @example Rendering partial
-        #   # Given a partial under:
-        #   #   templates/shared/_sidebar.html.erb
-        #   #
-        #   # In the layout template:
-        #   #   templates/application.html.erb
-        #   #
-        #   # Use like this:
-        #   <%= render partial: 'shared/sidebar' %>
-        #
-        # @example Rendering template
-        #   # Given a template under:
-        #   #   templates/articles/index.html.erb
-        #   #
-        #   # In the layout template:
-        #   #   templates/application.html.erb
-        #   #
-        #   # Use like this:
-        #   <%= render template: 'articles/index' %>
-        #
-        # @example Rendering partial, using optional :locals
-        #   # Given a partial under:
-        #   #   templates/shared/_sidebar.html.erb
-        #   #
-        #   # In the layout template:
-        #   #   templates/application.html.erb
-        #   #
-        #   # Use like this:
-        #   <%= render partial: 'shared/sidebar', locals: { user: current_user } %>
-        #
-        #   #
-        #   # `user` will be available in the scope of the sidebar rendering
-        def render(options)
-          renderer(options).render
-        end
-
-        # Returns the requested format.
-        #
-        # @return [Symbol] the requested format (eg. :html, :json, :xml, etc..)
-        #
-        # @since 0.1.0
-        def format
-          @scope.format
-        end
-
-        # The current view.
-        #
-        # @return [Hanami::View] the current view
-        #
-        # @since 0.1.0
-        def view
-          @view || @scope.view
-        end
-
-        # The current locals.
-        #
-        # @return [Hash] the current locals
-        #
-        # @since 0.1.0
-        def locals
-          (@locals || @scope.locals).dup
-        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 Safe method navigation
-        #   <% if local(:plan).overdue? %>
-        #     <h2>Your plan is overdue.</h2>
-        #   <% end %>
-        #
-        # @example Optional Contents
-        #   # Given the following layout template
-        #
-        #   <!doctype HTML>
-        #   <html>
-        #     <!-- ... -->
-        #     <body>
-        #       <!-- ... -->
-        #       <%= local :footer %>
-        #     </body>
-        #   </html>
-        #
-        #   # Case 1:
-        #   #   Products::Index doesn't respond to #footer, local will return nil
-        #   #
-        #   # Case 2:
-        #   #   Products::Show responds to #footer, local will send back
-        #   #     #footer returning value
-        #
-        #   module Products
-        #     class Index
-        #       include Hanami::View
-        #     end
-        #
-        #     class Show
-        #       include Hanami::View
-        #
-        #       def footer
-        #         "contents for footer"
-        #       end
-        #     end
-        #   end
-        def local(key)
-          if respond_to?(key)
-            __send__(key)
-          else
-            locals.fetch(key) { NullLocal.new(key) }
-          end
-        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-3F
-        def respond_to?(m, include_all = false)
-          respond_to_missing?(m, include_all)
-        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)
-          @layout.respond_to?(m, include_all) ||
-            @scope.respond_to?(m, include_all)
-        end
-
-        protected
-
-        # Forward all the missing methods to the view scope or to the layout.
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @see Hanami::View::Rendering::Scope
-        # @see Hanami::Layout
-        #
-        # @example
-        #   # In the layout template:
-        #   #   templates/application.html.erb
-        #   #
-        #   # Use like this:
-        #   <title><%= article.title %></title>
-        #
-        #   # `article` will be looked up in the view scope first.
-        #   # If not found, it will be searched within the layout.
-        def method_missing(m, *args, &blk)
-          # 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 @scope.respond_to?(m, true) && @scope.locals.has_key?(m) && layout.respond_to?(m, true)
-            layout.__send__(m, *args, &blk)
-          elsif @scope.respond_to?(m, true)
-            @scope.__send__(m, *args, &blk)
-          elsif layout.respond_to?(m, true)
-            layout.__send__(m, *args, &blk)
-          else
-            ::Hanami::View::Escape.html(super)
-          end
-        end
-
-        # @api private
-        def renderer(options)
-          if options[:partial]
-            Rendering::Partial
-          elsif options[:template]
-            Rendering::Template
-          else
-            ::Kernel.raise UnknownRenderTypeError.new(KNOWN_RENDER_TYPES, options)
-          end.new(view, _options(options))
-        end
-
-        private
-
-        # Returns an inspect String
-        #
-        # @return [String] inspect String (contains classname, objectid in hex, available ivars)
-        #
-        # @since 1.3.2
-        # @api private
-        def __inspect
-          result = ""
-          result += %( @layout="#{@layout.inspect}") if @layout
-          result += %( @scope="#{@scope.inspect}") if @scope
-          result
-        end
-
-        # @api private
-        def _options(options)
-          current_locals = locals.reject do |key, _|
-            @scope.respond_to?(key, true) &&
-              (layout.respond_to?(key, true) || @scope.view.respond_to?(:name, true))
-          end
-          Options.build(options, current_locals, format)
-        end
-
-        # @since 0.4.2
-        # @api private
-        def layout
-          @layout || @layout.class.layout.new(@scope, "")
-        end
-      end
-    end
-  end
-end

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

@@ -1,52 +0,0 @@
-module Hanami
-  module View
-    module Rendering
-      # Null Object pattern for Layout.
-      # It's used when a view doesn't require a layout.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/view'
-      #
-      #   module Articles
-      #     class Show
-      #       include Hanami::View
-      #       layout false
-      #     end
-      #   end
-      #
-      #   # In this scenario we will use a `NullLayout`.
-      class NullLayout
-
-        # Initialize a layout
-        #
-        # @param scope [Hanami::View::Rendering::Scope] view rendering scope
-        # @param rendered [String] the output of the view rendering process
-        #
-        # @api private
-        # @since 0.1.0
-        #
-        # @see Hanami::Layout#initialize
-        # @see Hanami::View::Rendering#render
-        def initialize(scope, rendered)
-          @rendered = rendered
-        end
-
-        # Render the layout
-        #
-        # @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
-          @rendered
-        end
-      end
-    end
-  end
-end

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

@@ -1,82 +0,0 @@
-require 'hanami/utils/basic_object'
-
-module Hanami
-  module View
-    module Rendering
-      # Null local
-      #
-      # @since 0.7.0
-      #
-      # @see Hanami::View::Rendering#local
-      class NullLocal < Utils::BasicObject
-        # @since 0.7.0
-        # @api private
-        TO_STR = "".freeze
-
-        # @since 0.7.0
-        # @api private
-        def initialize(local)
-          @local = local
-        end
-
-        # @since 0.7.0
-        # @api private
-        def all?
-          false
-        end
-
-        # @since 0.7.0
-        # @api private
-        def any?
-          false
-        end
-
-        # @since 0.7.0
-        # @api private
-        def empty?
-          true
-        end
-
-        # @since 0.7.0
-        # @api private
-        def nil?
-          true
-        end
-
-        # @since 0.7.0
-        # @api private
-        def to_str
-          TO_STR
-        end
-
-        # @since 0.8.0
-        # @api private
-        alias to_s to_str
-
-        # @since 0.7.0
-        # @api private
-        def method_missing(m, *)
-          if m.match(/\?\z/)
-            false
-          else
-            self.class.new("#{ @local }.#{ m }")
-          end
-        end
-
-        private
-
-        # @since 0.7.0
-        # @api private
-        def respond_to_missing?(method_name, include_all)
-          true
-        end
-
-        # @since 0.7.0
-        # @api private
-        def __inspect
-          " :#{ @local }"
-        end
-      end
-    end
-  end
-end

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