roger 1.6.1 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e748a2603852f67c6114ea94b36c1ef4568aaabc
-  data.tar.gz: 3be578652cca0187767f4635169b573a21a0012d
+  metadata.gz: bc5df3b7198a5c8ae6dca70a00e6a35416fa4056
+  data.tar.gz: 850c235b8f2426af1772cb02182e749d91557a95
 SHA512:
-  metadata.gz: 1c3e24c404cd8b0e1197b7f7b3bf9d3b90113e59262b231a58e23b2ec2f9d68dc687df143297c2f2904023bbd34926a4c1da7fb9945abdc3a812d9be8dd27362
-  data.tar.gz: 78eacce507b31d97738f5cace86d2ddbc5e77cf128c9118d10c16ca60d0548edd22e810df25c1218794f27508e0f70394ee70386a9bdb2a2be25d0272f5b14ec
+  metadata.gz: d4aabffaf1c231cdda88a03a4df296324abf857a9be70ad18273f7a2709ef9e33480e0aa0096bf18b0a377b695eceb629b8d4e1f18c18c57a592981121d95b89
+  data.tar.gz: 3151091868343c3aaeffa12903b5b331e78b2f7bf941e021c98b6110fa1ff5dd280a0253f0beacc9c15ab468e212907209ffa0cbe48b3fa7f5283f3e5b49c550

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 1.6.2
+* Allow for tempalte recursion for up to 10 levels.
+* Fix issue with missing partials that would screw up the current_template nesting stack.
+
 ## Version 1.6.1
 * No longer process partials in html directory on release.
 

data/doc/templating.md

@@ -157,10 +157,10 @@ A helper is nothing more than a plain old Ruby module containing a bunch of func
 Registering helpers can best be done in the Rogerfile. Register this module as following:
 
 ```ruby
-Roger::Template.register MyHelperModule
+Roger::Renderer.helper MyHelperModule
 ```
 
-After registration the helpers are available for use in all templates, partials, layouts, etc. See the [template helpers tests](../test/unit/template/template_helper_test.rb) for example usage.
+After registration the helpers are available for use in all templates, partials, layouts, etc. See the [template helpers tests](../test/unit/renderer/renderer_helper_test.rb) for example usage.
 
 ## Access to Project 
 

data/lib/roger/generators.rb

@@ -6,6 +6,7 @@ module Roger
   module Generators
     # Base Generator class
     class Base < Cli::Command
+      include Thor::Actions
     end
 
     def self.register(name, klass = nil)

data/lib/roger/renderer.rb

@@ -8,6 +8,8 @@ module Roger
   # The renderer will set up an environment so you can consistently render templates
   # within that environment
   class Renderer
+    MAX_ALLOWED_TEMPLATE_NESTING = 10
+
     class << self
       # Register a helper module that should be included in
       # every template context.
@@ -129,7 +131,9 @@ module Roger
         render_result
       end
     ensure
-      template_nesting.pop
+      # Only pop the template from the nesting if we actually
+      # put it on the nesting stack.
+      template_nesting.pop if template
     end
 
     # Render any file on disk. No magic. Just rendering.
@@ -142,22 +146,13 @@ module Roger
     #
     # @options options [Hash] :locals
     def render_file(path, options = {})
-      pn = Pathname.new(path)
-
-      if pn.relative?
-        # We're explicitly checking for source_path instead of real_source_path
-        # as you could also just have an inline template.
-        if current_template && current_template.source_path
-          pn = (Pathname.new(current_template.source_path).dirname + pn).realpath
-        else
-          err = "Only within another template you can use relative paths"
-          fail ArgumentError, err
-        end
-      else
-        pn = pn.realpath
-      end
+      pn = absolute_path_from_current_template(path)
 
       template = template(pn.to_s, nil)
+
+      # Track rendered file also on the rendered stack
+      template_nesting.push(template)
+
       template.render(options[:locals] || {})
     end
 
@@ -173,6 +168,23 @@ module Roger
 
     protected
 
+    def absolute_path_from_current_template(path)
+      pn = Pathname.new(path)
+
+      if pn.relative?
+        # We're explicitly checking for source_path instead of real_source_path
+        # as you could also just have an inline template.
+        if current_template && current_template.source_path
+          (Pathname.new(current_template.source_path).dirname + pn).realpath
+        else
+          err = "Only within another template you can use relative paths"
+          fail ArgumentError, err
+        end
+      else
+        pn.realpath
+      end
+    end
+
     def template_and_layout_for_render(path, options = {})
       # A previous template has been set so it's a partial
       # If no previous template is set, we're
@@ -196,12 +208,12 @@ module Roger
       # If this template is not a real file it cannot ever conflict.
       return unless template.real_source_path
 
-      caller_template = template_nesting.detect do |t|
+      caller_templates = template_nesting.select do |t|
         t.real_source_path == template.real_source_path
       end
 
-      # We're good, no recursion!
-      return unless caller_template
+      # We're good, no deeper recursion then MAX_ALLOWED_TEMPLATE_NESTING
+      return if caller_templates.length <= MAX_ALLOWED_TEMPLATE_NESTING
 
       err = "Recursive render detected for '#{template.source_path}'"
       err += " in '#{current_template.source_path}'"

data/lib/roger/version.rb

@@ -1,4 +1,4 @@
 # Roger main namespace
 module Roger
-  VERSION = "1.6.1"
+  VERSION = "1.6.2"
 end

data/test/project/partials/test/max_depth.html.erb

@@ -0,0 +1,5 @@
+<% if depth < max_depth %>
+  <%= partial 'test/max_depth', locals: { depth: locals[:depth] + 1, max_depth: locals[:max_depth] } %>
+<% else %>
+  Stop! Hammertime!
+<% end %>

data/test/unit/renderer/renderer_partial_test.rb

@@ -81,6 +81,27 @@ module Roger
       end
     end
 
+    def test_partial_ten_max_depth_recursion
+      r = render_erb_template "<%= partial 'test/max_depth', locals: {depth: 0, max_depth: 10} %>"
+
+      assert_match(/Hammertime/, r)
+
+      assert_raise(ArgumentError) do
+        render_erb_template "<%= partial 'test/max_depth', locals: {depth: 0, max_depth: 11} %>"
+      end
+    end
+
+    def test_no_partial_state
+      r = render_erb_template '
+         <%= begin
+               partial "../html/bla/partials/dunno"
+               rescue ArgumentError
+         end %>
+         <%= partial "test/simple" %>'
+
+      assert_match(/ERB/, r)
+    end
+
     def render_erb_template(template)
       @renderer.render(@base + "html/partials/test.html.erb", source: template)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roger
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.2
 platform: ruby
 authors:
 - Flurin Egger
@@ -10,62 +10,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-17 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
@@ -86,98 +86,98 @@ dependencies:
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: test_construct
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.31.0
 description: See homepage for more information.
@@ -190,10 +190,10 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- .gitignore
-- .hound.yml
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - MIT_LICENSE
@@ -302,6 +302,7 @@ files:
 - test/project/partials/test/front_matter.html.erb
 - test/project/partials/test/json.json.erb
 - test/project/partials/test/markdown.md
+- test/project/partials/test/max_depth.html.erb
 - test/project/partials/test/recursive.html.erb
 - test/project/partials/test/simple.html.erb
 - test/project/partials/test/yield.html.erb
@@ -344,22 +345,22 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --charset=UTF-8
+- "--charset=UTF-8"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Roger is a set of tools to create self-containing HTML mockups.
@@ -407,6 +408,7 @@ test_files:
 - test/project/partials/test/front_matter.html.erb
 - test/project/partials/test/json.json.erb
 - test/project/partials/test/markdown.md
+- test/project/partials/test/max_depth.html.erb
 - test/project/partials/test/recursive.html.erb
 - test/project/partials/test/simple.html.erb
 - test/project/partials/test/yield.html.erb