RubyGems - hanami-view - Versions diffs - 1.3.3 → 2.0.0.alpha2 - Mend

hanami-view 1.3.3 → 2.0.0.alpha2

Files changed (61) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +3 -10
data/LICENSE +20 -0
data/README.md +20 -862
data/hanami-view.gemspec +26 -16
data/lib/hanami-view.rb +3 -1
data/lib/hanami/view.rb +208 -223
data/lib/hanami/view/application_configuration.rb +77 -0
data/lib/hanami/view/application_context.rb +35 -0
data/lib/hanami/view/application_view.rb +89 -0
data/lib/hanami/view/context.rb +97 -0
data/lib/hanami/view/context_helpers/content_helpers.rb +26 -0
data/lib/hanami/view/decorated_attributes.rb +82 -0
data/lib/hanami/view/errors.rb +19 -56
data/lib/hanami/view/exposure.rb +126 -0
data/lib/hanami/view/exposures.rb +74 -0
data/lib/hanami/view/part.rb +217 -0
data/lib/hanami/view/part_builder.rb +140 -0
data/lib/hanami/view/path.rb +68 -0
data/lib/hanami/view/render_environment.rb +62 -0
data/lib/hanami/view/render_environment_missing.rb +44 -0
data/lib/hanami/view/rendered.rb +55 -0
data/lib/hanami/view/renderer.rb +79 -0
data/lib/hanami/view/scope.rb +189 -0
data/lib/hanami/view/scope_builder.rb +98 -0
data/lib/hanami/view/standalone_view.rb +396 -0
data/lib/hanami/view/tilt.rb +78 -0
data/lib/hanami/view/tilt/erb.rb +26 -0
data/lib/hanami/view/tilt/erbse.rb +21 -0
data/lib/hanami/view/tilt/haml.rb +26 -0
data/lib/hanami/view/version.rb +5 -5
metadata +114 -70
data/LICENSE.md +0 -22
data/lib/hanami/layout.rb +0 -190
data/lib/hanami/presenter.rb +0 -98
data/lib/hanami/view/configuration.rb +0 -504
data/lib/hanami/view/dsl.rb +0 -347
data/lib/hanami/view/escape.rb +0 -225
data/lib/hanami/view/inheritable.rb +0 -54
data/lib/hanami/view/rendering.rb +0 -294
data/lib/hanami/view/rendering/layout_finder.rb +0 -128
data/lib/hanami/view/rendering/layout_registry.rb +0 -69
data/lib/hanami/view/rendering/layout_scope.rb +0 -281
data/lib/hanami/view/rendering/null_layout.rb +0 -52
data/lib/hanami/view/rendering/null_local.rb +0 -82
data/lib/hanami/view/rendering/null_template.rb +0 -83
data/lib/hanami/view/rendering/null_view.rb +0 -26
data/lib/hanami/view/rendering/options.rb +0 -24
data/lib/hanami/view/rendering/partial.rb +0 -31
data/lib/hanami/view/rendering/partial_file.rb +0 -29
data/lib/hanami/view/rendering/partial_finder.rb +0 -75
data/lib/hanami/view/rendering/partial_templates_finder.rb +0 -73
data/lib/hanami/view/rendering/registry.rb +0 -134
data/lib/hanami/view/rendering/scope.rb +0 -108
data/lib/hanami/view/rendering/subscope.rb +0 -56
data/lib/hanami/view/rendering/template.rb +0 -69
data/lib/hanami/view/rendering/template_finder.rb +0 -55
data/lib/hanami/view/rendering/template_name.rb +0 -50
data/lib/hanami/view/rendering/templates_finder.rb +0 -144
data/lib/hanami/view/rendering/view_finder.rb +0 -37
data/lib/hanami/view/template.rb +0 -57

data/lib/hanami/view/inheritable.rb DELETED Viewed

@@ -1,54 +0,0 @@
-module Hanami
-  module View
-    # Inheriting mechanisms
-    #
-    # @since 0.1.0
-    module Inheritable
-      # Register a view subclass
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @example
-      #   require 'hanami/view'
-      #
-      #   class IndexView
-      #     include Hanami::View
-      #   end
-      #
-      #   class JsonIndexView < IndexView
-      #   end
-      def inherited(base)
-        subclasses.add base
-      end
-      # Set of registered subclasses
-      #
-      # @api private
-      # @since 0.1.0
-      def subclasses
-        @subclasses ||= Set.new
-      end
-      protected
-      # Loading mechanism hook.
-      #
-      # @api private
-      # @since 0.1.0
-      #
-      # @see Hanami::View.load!
-      def load!
-        subclasses.freeze
-        views.freeze
-      end
-      # Registered views
-      #
-      # @api private
-      # @since 0.1.0
-      def views
-        @views ||= [ self ] + subclasses.to_a
-      end
-    end
-  end
-end

data/lib/hanami/view/rendering.rb DELETED Viewed

@@ -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/rendering/layout_finder.rb DELETED Viewed

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