RubyGems - hanami-view - Versions diffs - 0.6.1 → 0.7.0 - Mend

hanami-view 0.6.1 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +13 -0
data/README.md +21 -5
data/hanami-view.gemspec +3 -3
data/lib/hanami/layout.rb +9 -1
data/lib/hanami/presenter.rb +2 -30
data/lib/hanami/view/configuration.rb +3 -3
data/lib/hanami/view/dsl.rb +2 -1
data/lib/hanami/view/escape.rb +50 -3
data/lib/hanami/view/rendering.rb +26 -1
data/lib/hanami/view/rendering/layout_scope.rb +60 -1
data/lib/hanami/view/rendering/null_local.rb +74 -0
data/lib/hanami/view/rendering/partial_file.rb +2 -2
data/lib/hanami/view/rendering/partial_finder.rb +1 -1
data/lib/hanami/view/rendering/partial_templates_finder.rb +6 -6
data/lib/hanami/view/rendering/scope.rb +4 -1
data/lib/hanami/view/rendering/templates_finder.rb +16 -1
data/lib/hanami/view/version.rb +1 -1
metadata +9 -9

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2814a76015d67720fc54b6aab3acb54cce7f65a4
-  data.tar.gz: db8a5cb5b152d93e837d7a3bddd7e755d85db277
+  metadata.gz: b6a48a9095b6dda0e7238dd8f80aedb4b0aaa8df
+  data.tar.gz: b36841002e5ed8e5145a1dbd23adb32b0612fecf
 SHA512:
-  metadata.gz: 2132c9ae9e477ee2f99bdd71e7596946bb4fa69d1d6dde525b325df11e2859bfe0186f5b972a0942c21acb5f4e1d7e64b2c7d84ca761600f2af29e78db7490d1
-  data.tar.gz: b9de16d5e18f760165b367b042b69a0a21a079d61d9b894512295f9fd5192cd65a5df9c4d243242a59352267fa818f04005d52f76c5cf918200c943740fde20c
+  metadata.gz: 57e9f5bc86fa2416826ae4a705ae0367d70b635f62ab1382e085f04cc3273d184212e45810aad3b53a5dcd82c1381f040e552ea97f06f48b6e6c6acd8b18e84a
+  data.tar.gz: b8973574e56dfe4380d55bca46db9542b7bd559f2bd2e5591c8cb1a79b6b3dceb778ebb9f0d72c0b0a92f8ad1090392af421b40ae1536acb87a3152395b634d7

data/CHANGELOG.md CHANGED Viewed

@@ -1,6 +1,19 @@
 # Hanami::View
 View layer for Hanami
+## v0.7.0 - 2016-07-22
+### Added
+- [Luca Guidi] Introduced `#local` for views, layouts and templates. It allows to safely access locals without raising errors in case the referenced local is missing.
+### Fixed
+- [nessur] Find the correct partial in case of deeply nested templates.
+- [Marcello Rocha] Ensure `Hanami::Presenter` to respect method visibility of wrapped object.
+- [Luca Guidi] Ensure to use new registry when loading the framework
+### Changed
+– [Luca Guidi] Drop support for Ruby 2.0 and 2.1. Official support for JRuby 9.0.5.0+.
+– [Luca Guidi] Deprecate `#content` in favor of `#local`.
 ## v0.6.1 - 2016-02-05
 ### Changed
 - [Steve Hook] Preload partial templates in order to boost performances for partials rendering (2x faster)

data/README.md CHANGED Viewed

@@ -472,10 +472,12 @@ As per convention, layout templates are located under `Hanami::View.root` or `Ap
 ### Optional Content
-If we want to render optional contents such as sidebar links or page specific javascripts, we can use `#content`
+#### Optional View Methods
+If we want to render optional contents such as sidebar links or page specific javascripts, we can use `#local`
 It accepts a key that represents a method that should be available within the rendering context.
 That context is made of the locals, and the methods that view and layout respond to.
-If the context can't dispatch that method, it returns `nil`.
+If the context can't dispatch that method, it returns returns a null object (`Hanami::View::Rendering::NullLocal`).
 Given the following layout template.
@@ -485,14 +487,14 @@ Given the following layout template.
   <!-- ... -->
   <body>
     <!-- ... -->
-    <%= content :footer %>
+    <%= local :footer %>
   </body>
 </html>
 ```
 We have two views, one responds to `#footer` (`Products::Show`) and the other doesn't (`Products::Index`).
-When the first is rendered, `content` gives back the returning value of `#footer`.
-In the other case, `content` returns `nil`.
+When the first is rendered, `local` gives back the returning value of `#footer`.
+In the other case, `local` returns a null object (`Hanami::View::Rendering::NullLocal`).
 ```ruby
 module Products
@@ -510,6 +512,20 @@ module Products
 end
 ```
+#### Optional Locals
+If we want to show announcements to our customers, but we want only load them from the database if there is something to show.
+This is an optional local.
+```erb
+<% if local(:announcement).show? %>
+  <h2><%= announcement.message %></h2>
+<% end %>
+```
+The first line is safely evaluated in all the cases: if announcement is present or not.
+In case we enter the `if` statement, we're sure we can safely reference that object.
 ### Presenters
 The goal of a presenter is to wrap and reuse presentational logic for an object.

data/hanami-view.gemspec CHANGED Viewed

@@ -17,12 +17,12 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.2.0'
   spec.add_runtime_dependency 'tilt',         '~> 2.0', '>= 2.0.1'
-  spec.add_runtime_dependency 'hanami-utils', '~> 0.7'
+  spec.add_runtime_dependency 'hanami-utils', '~> 0.8'
   spec.add_development_dependency 'bundler',  '~> 1.5'
   spec.add_development_dependency 'minitest', '~> 5'
-  spec.add_development_dependency 'rake',     '~> 10'
+  spec.add_development_dependency 'rake',     '~> 11'
 end

data/lib/hanami/layout.rb CHANGED Viewed

@@ -93,6 +93,7 @@ module Hanami
       end
       protected
       # Loading mechanism hook.
       #
       # @api private
@@ -100,9 +101,16 @@ module Hanami
       #
       # @see Hanami::View.load!
       def load!
-        registry.freeze
+        load_registry!
         configuration.freeze
       end
+      private
+      def load_registry!
+        @registry = nil
+        registry.freeze
+      end
     end
     # Initialize a layout

data/lib/hanami/presenter.rb CHANGED Viewed

@@ -90,37 +90,9 @@ module Hanami
     #
     # @see Hanami::View::Escape
     def self.included(base)
-      base.extend ::Hanami::View::Escape
-    end
-    # Initialize the presenter
-    #
-    # @param object [Object] the object to present
-    #
-    # @since 0.1.0
-    def initialize(object)
-      @object = object
-    end
-    protected
-    # Override Ruby's method_missing
-    #
-    # @api private
-    # @since 0.1.0
-    def method_missing(m, *args, &blk)
-      if @object.respond_to?(m)
-        ::Hanami::View::Escape.html(@object.__send__(m, *args, &blk))
-      else
-        super
+      base.class_eval do
+        include ::Hanami::View::Escape::Presentable
       end
     end
-    # Override Ruby's respond_to_missing? in order to support proper delegation
-    #
-    # @api private
-    # @since 0.3.0
-    def respond_to_missing?(m, include_private = false)
-      @object.respond_to?(m, include_private)
-    end
   end
 end

data/lib/hanami/view/configuration.rb CHANGED Viewed

@@ -427,7 +427,7 @@ module Hanami
       # Load partials for each partial template file found under the
       # given load paths
       #
-      # @since x.x.x
+      # @since 0.7.0
       # @api private
       def load_partials!
         Hanami::View::Rendering::PartialTemplatesFinder.new(self).find.each do |partial|
@@ -438,7 +438,7 @@ module Hanami
       # Load partials for each partial template file found under the
       # given load paths
       #
-      # @since x.x.x
+      # @since 0.7.0
       # @api private
       def find_partial(relative_partial_path, template_name, format)
         partials_for_view = partials.has_key?(relative_partial_path) ?  partials[relative_partial_path] : partials[template_name]
@@ -447,7 +447,7 @@ module Hanami
       # Add a partial to the registry
       #
-      # @since x.x.x
+      # @since 0.7.0
       # @api private
       def add_partial(partial)
         @partials[partial.key][partial.format.to_sym] = partial.template

data/lib/hanami/view/dsl.rb CHANGED Viewed

@@ -76,7 +76,7 @@ module Hanami
       #   Articles::JsonShow.format # => :json
       def format(value = nil)
         if value.nil?
-          @format
+          @format ||= nil
         else
           @format = value
         end
@@ -314,6 +314,7 @@ module Hanami
       #   Articles::Show.layout # => Hanami::View::Rendering::NullLayout
       def layout(value = nil)
         if value.nil?
+          @layout  ||= nil
           @_layout ||= Rendering::LayoutFinder.find(@layout || configuration.layout, configuration.namespace)
         elsif !value
           @layout = Hanami::View::Rendering::NullLayout

data/lib/hanami/view/escape.rb CHANGED Viewed

@@ -1,5 +1,4 @@
 require 'hanami/utils/escape'
-require 'hanami/presenter'
 module Hanami
   module View
@@ -9,6 +8,7 @@ module Hanami
     module Escape
       module InstanceMethods
         private
         # Mark the given string as safe to render.
         #
         # !!! ATTENTION !!! This may open your application to XSS attacks.
@@ -119,6 +119,49 @@ module Hanami
         end
       end
+      module Presentable
+        # Inject escape logic into the given class.
+        #
+        # @since 0.7.0
+        # @api private
+        #
+        # @see Hanami::View::Escape
+        def self.included(base)
+          base.extend ::Hanami::View::Escape
+        end
+        # Initialize the presenter
+        #
+        # @param object [Object] the object to present
+        #
+        # @since 0.7.0
+        def initialize(object)
+          @object = object
+        end
+        protected
+        # Override Ruby's method_missing
+        #
+        # @api private
+        # @since 0.7.0
+        def method_missing(m, *args, &blk)
+          if @object.respond_to?(m)
+            ::Hanami::View::Escape.html(@object.__send__(m, *args, &blk))
+          else
+            super
+          end
+        end
+        # Override Ruby's respond_to_missing? in order to support proper delegation
+        #
+        # @api private
+        # @since 0.3.0
+        def respond_to_missing?(m, include_private = false)
+          @object.respond_to?(m, include_private)
+        end
+      end
       # Auto escape presenter
       #
       # @since 0.4.0
@@ -126,7 +169,7 @@ module Hanami
       #
       # @see Hanami::View::Escape::InstanceMethods#_escape
       class Presenter
-        include ::Hanami::Presenter
+        include Presentable
       end
       # Escape the given input if it's a string, otherwise return the oject as it is.
@@ -165,10 +208,14 @@ module Hanami
       # @since 0.4.0
       # @api private
       def method_added(method_name)
+        visibility = :public
+        visibility = :private if private_method_defined? method_name
+        visibility = :protected if protected_method_defined? method_name
         unless autoescape_methods[method_name]
           prepend Module.new {
             module_eval %{
-              def #{ method_name }(*args, &blk); ::Hanami::View::Escape.html super; end
+              #{ visibility } def #{ method_name }(*args, &blk); ::Hanami::View::Escape.html super; end
             }
           }

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

@@ -1,5 +1,6 @@
 require 'hanami/view/rendering/registry'
 require 'hanami/view/rendering/scope'
+require 'hanami/view/rendering/null_local'
 module Hanami
   module View
@@ -104,6 +105,25 @@ module Hanami
           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 [Objeect,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.
         #
@@ -246,7 +266,7 @@ module Hanami
       # @see Hanami::View.load!
       def load!
         super
-        registry.freeze
+        load_registry!
       end
       private
@@ -260,6 +280,11 @@ module Hanami
       def registry
         @registry ||= Registry.new(self)
       end
+      def load_registry!
+        @registry = nil
+        registry.freeze
+      end
     end
   end
 end

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

@@ -1,4 +1,6 @@
+require 'hanami/view/rendering/null_local'
 require 'hanami/utils/escape'
+require 'hanami/utils/deprecation'
 module Hanami
   module View
@@ -16,7 +18,10 @@ module Hanami
         # @api private
         # @since 0.1.0
         def initialize(layout, scope)
-          @layout, @scope = layout, scope
+          @layout = layout
+          @scope  = scope
+          @view   = nil
+          @locals = nil
         end
         # Returns the classname as string
@@ -122,6 +127,7 @@ module Hanami
         # @return [String,NilClass] returning content if scope respond to the
         #   requested method
         #
+        # @deprecated Use {#local} instead
         # @since 0.4.1
         #
         # @example
@@ -157,9 +163,62 @@ module Hanami
         #     end
         #   end
         def content(key)
+          Utils::Deprecation.new("#content is deprecated, please use #local")
           __send__(key) if respond_to?(key)
         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 [Objeect,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]

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

@@ -0,0 +1,74 @@
+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
+        def all?
+          false
+        end
+        # @since 0.7.0
+        def any?
+          false
+        end
+        # @since 0.7.0
+        def empty?
+          true
+        end
+        # @since 0.7.0
+        def nil?
+          true
+        end
+        # @since 0.7.0
+        # @api private
+        def to_str
+          TO_STR
+        end
+        # @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/partial_file.rb CHANGED Viewed

@@ -1,12 +1,12 @@
 module Hanami
   module View
     module Rendering
-      # @since x.x.x
+      # @since 0.7.0
       # @api private
       class PartialFile
         attr_reader :key, :format, :template
-        # @since x.x.x
+        # @since 0.7.0
         # @api private
         def initialize(key, format, template)
           @key      = key

data/lib/hanami/view/rendering/partial_finder.rb CHANGED Viewed

@@ -41,7 +41,7 @@ module Hanami
         protected
-        # @since x.x.x
+        # @since 0.7.0
         # @api private
         def relative_partial_path
           [view_template_dir, template_name].join(separator)

data/lib/hanami/view/rendering/partial_templates_finder.rb CHANGED Viewed

@@ -7,18 +7,18 @@ module Hanami
       # Find partial templates in the file system
       #
       # @api private
-      # @since x.x.x
+      # @since 0.7.0
       #
       # @see View::Template
       class PartialTemplatesFinder
         # Search pattern for partial file names
         #
         # @api private
-        # @since x.x.x
+        # @since 0.7.0
         PARTIAL_PATTERN = '_*'.freeze
         # @api private
-        # @since x.x.x
+        # @since 0.7.0
         PARTIAL_PARTS_SEPARATOR = '.'.freeze
         attr_reader :configuration
@@ -27,7 +27,7 @@ module Hanami
         #
         # @param configuration [Configuration] the configuration object
         #
-        # @since x.x.x
+        # @since 0.7.0
         def initialize(configuration)
           @configuration = configuration
         end
@@ -36,7 +36,7 @@ module Hanami
         #
         # @return [Array] array of PartialFinder objects
         #
-        # @since x.x.x
+        # @since 0.7.0
         def find
           _find_partials(configuration.root).map do |template|
             partial_path, partial_base_name = Pathname(template).relative_path_from(configuration.root).split
@@ -58,7 +58,7 @@ module Hanami
         #
         # @return [Array] an array of strings for each matching partial template file found
         #
-        # @since x.x.x
+        # @since 0.7.0
         # @api private
         def _find_partials(path)
           Dir.glob("#{ [path, TemplatesFinder::RECURSIVE, PARTIAL_PATTERN].join(::File::SEPARATOR) }.#{TemplatesFinder::FORMAT}.#{TemplatesFinder::ENGINES}")

data/lib/hanami/view/rendering/scope.rb CHANGED Viewed

@@ -21,7 +21,10 @@ module Hanami
         # @api private
         # @since 0.1.0
         def initialize(view, locals = {})
-          @view, @locals, @layout = view, locals, layout
+          @view   = view
+          @locals = locals
+          @layout = layout
+          @scope  = nil
         end
         # Returns an inspect String

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

@@ -78,8 +78,23 @@ module Hanami
         # @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)
-          Dir.glob( "#{ [root, lookup, template_name].join(separator) }.#{ format }.#{ engines }" )
+          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

data/lib/hanami/view/version.rb CHANGED Viewed

@@ -3,6 +3,6 @@ module Hanami
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = '0.6.1'.freeze
+    VERSION = '0.7.0'.freeze
   end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hanami-view
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Luca Guidi
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-02-05 00:00:00.000000000 Z
+date: 2016-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tilt
@@ -38,14 +38,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,14 +80,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '11'
 description: View layer for Hanami
 email:
 - me@lucaguidi.com
@@ -115,6 +115,7 @@ files:
 - lib/hanami/view/rendering/layout_registry.rb
 - lib/hanami/view/rendering/layout_scope.rb
 - lib/hanami/view/rendering/null_layout.rb
+- lib/hanami/view/rendering/null_local.rb
 - lib/hanami/view/rendering/null_template.rb
 - lib/hanami/view/rendering/partial.rb
 - lib/hanami/view/rendering/partial_file.rb
@@ -141,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -149,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key:
 specification_version: 4
 summary: View layer for Hanami, with a separation between views and templates
 test_files: []
-has_rdoc: