roda 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba4bf20bc11b1e1d4482325c64d4ae439a7665dd
-  data.tar.gz: 2f17d46442001a41ba9223db2b71545d11e7ac3e
+  metadata.gz: 49da3db12f5573c87c6be816d293503ff794ea2f
+  data.tar.gz: 443753193002f7e346437cd50ed50eab168e8f25
 SHA512:
-  metadata.gz: 747c00137a2db4494558398d0e85a659c8d247ef330431239787d135cd7213c91ef5cfdb5585c315b76676b8a016a64f33ee4c6d711927e04ed95839e537430e
-  data.tar.gz: 930fd61e842f5ca4bbbbf19c9efcfb881e10651f2e2f9f7029388d9c0d84fc27d1cbae5f364e7248aa33edb011d8fbf82518a3a7074844990a58e818fb517fb6
+  metadata.gz: c0be145864376662bc858c903c9d4a1865b184b782b2b3f0494c0e85f168de74f44fe8c58f7398e6c1236cbbf9f280a22c3658bdf8a83f0018c6a9af45a1dc62
+  data.tar.gz: 79911454fded94aaf16e48ed958c0ebfaf7d0bb5e3be9e22e0740b71eb21f5acabf949eff65eba5314a0b67dfeca13b84e4037484efff44fbc7d6d382061115b

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 2.8.0 (2015-11-16)
+
+* Add multi_view plugin for easily setting up routing for rendering multiple views (jeremyevans)
+
+* Make content_for plugin work with haml and potentially other non-erb template engines (plukevdh) (#50)
+
 = 2.7.0 (2015-10-13)
 
 * Add run_handler plugin for modifying rack response arrays when using r.run, and continuing routing for 404 responses (jeremyevans)

data/doc/release_notes/2.8.0.txt

@@ -0,0 +1,44 @@
+= New Features
+
+* A multi_view plugin has been added, for easily setting up routing
+  for rendering multiple views:
+
+    plugin :multi_view
+
+    route do |r|
+      r.multi_view(['foo', 'bar', 'baz'])
+    end
+
+    # or:
+
+    route do |r|
+      r.multi_view(/(foo|bar|baz)/)
+    end
+
+    # or:
+
+    regexp = multi_view_compile(['foo', 'bar', 'baz'])
+    route do |r|
+      r.multi_view(regexp)
+    end
+
+    # all are equivalent to:
+
+    route do |r|
+      r.get 'foo' do
+        view('foo')
+      end
+ 
+      r.get 'bar' do
+        view('bar')
+      end
+
+      r.get 'baz' do
+        view('baz')
+      end
+    end
+
+= Other Improvements
+
+* The content_for plugin now supports haml templates.  Previous only
+  erb templates were supported.

data/lib/roda/plugins/content_for.rb

@@ -7,10 +7,8 @@ class Roda
     # can set content for the layout template to display outside
     # of the normal content pane.
     #
-    # The content_for template probably only works with erb
-    # templates, and requires that you don't override the
-    # +:outvar+ render option.  In the template in which you
-    # want to store content, call content_for with a block:
+    # In the template in which you want to store content, call
+    # content_for with a block:
     #
     #   <% content_for :foo do %>
     #     Some content here.
@@ -34,12 +32,15 @@ class Roda
         # is no content stored with that key.
         def content_for(key, &block)
           if block
+            outvar = render_opts[:template_opts][:outvar]
+            buf_was = instance_variable_get(outvar)
+            # clean the output buffer for ERB-based rendering systems
+            instance_variable_set(outvar, '')
+
             @_content_for ||= {}
-            buf_was = @_out_buf
-            @_out_buf = ''
-            yield
-            @_content_for[key] = @_out_buf
-            @_out_buf = buf_was
+            @_content_for[key] = Tilt[render_opts[:engine]].new(&block).render
+
+            instance_variable_set(outvar, buf_was)
           elsif @_content_for
             @_content_for[key]
           end

data/lib/roda/plugins/multi_view.rb

@@ -0,0 +1,80 @@
+class Roda
+  module RodaPlugins
+    # The multi_view plugin makes it easy to render multiple views, where the
+    # view template is the same as the matched element.  It adds an +r.multi_view+
+    # method, which takes an argument that is passed to +r.get+, and should
+    # capture a single argument, which is treated as the template name to pass
+    # to +view+.  This makes it possible to pass in an array of strings, or a
+    # regexp with a single capture.
+    #
+    # The advantage of using a regexp over an array of strings is that the regexp
+    # is generally faster and uses less memory.  However, constructing the regexps
+    # is more cumbersome.  To make it easier, the multi_view plugin also offers a
+    # +multi_view_compile+ class method that will take an array of view template
+    # names and construct a regexp that can be passed to +r.multi_view+.
+    #
+    # Example:
+    #
+    #   plugin :multi_view
+    #
+    #   route do |r|
+    #     r.multi_view(['foo', 'bar', 'baz'])
+    #   end
+    #
+    #   # or:
+    #
+    #   route do |r|
+    #     r.multi_view(/(foo|bar|baz)/)
+    #   end
+    #
+    #   # or:
+    #
+    #   regexp = multi_view_compile(['foo', 'bar', 'baz'])
+    #   route do |r|
+    #     r.multi_view(regexp)
+    #   end
+    #
+    #   # all are equivalent to:
+    #
+    #   route do |r|
+    #     r.get 'foo' do
+    #       view('foo')
+    #     end
+    #
+    #     r.get 'bar' do
+    #       view('bar')
+    #     end
+    #
+    #     r.get 'baz' do
+    #       view('baz')
+    #     end
+    #   end
+    module MultiView
+      # Depend on the render plugin, since this plugin only makes
+      # sense when the render plugin is used.
+      def self.load_dependencies(app)
+        app.plugin :render
+      end
+
+      module ClassMethods
+        # Given the array of view template names, return a regexp that will
+        # match on any of the names and capture the matched name.
+        def multi_view_compile(array)
+          /(#{Regexp.union(array)})/
+        end
+      end
+
+      module RequestMethods
+        # Pass the argument to +get+, and assume if the matchers match that
+        # there is one capture, and call view with that capture.
+        def multi_view(arg)
+          get(arg) do |page|
+            scope.view(page)
+          end
+        end
+      end
+    end
+
+    register_plugin(:multi_view, MultiView)
+  end
+end

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 2
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 7
+  RodaMinorVersion = 8
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/content_for_spec.rb

@@ -2,21 +2,22 @@ require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
 
 begin
   require 'tilt/erb'
+  require 'tilt/haml'
 rescue LoadError
-  warn "tilt not installed, skipping content_for plugin test"  
+  warn "tilt, erb, or haml not installed, skipping content_for plugin test"
 else
-describe "content_for plugin" do
+describe "content_for plugin with erb" do
   before do
     app(:bare) do
-      plugin :render, :views=>'./spec/views'
+      plugin :render, :views => './spec/views'
       plugin :content_for
 
       route do |r|
         r.root do
-          view(:inline=>"<% content_for :foo do %>foo<% end %>bar", :layout=>{:inline=>'<%= yield %> <%= content_for(:foo) %>'})
+          view(:inline => "<% content_for :foo do %>foo<% end %>bar", :layout => { :inline => '<%= yield %> <%= content_for(:foo) %>' })
         end
         r.get 'a' do
-          view(:inline=>"bar", :layout=>{:inline=>'<%= content_for(:foo) %> <%= yield %>'})
+          view(:inline => "bar", :layout => { :inline => '<%= content_for(:foo) %> <%= yield %>' })
         end
       end
     end
@@ -30,4 +31,61 @@ describe "content_for plugin" do
     body('/a').strip.must_equal "bar"
   end
 end
+
+describe "content_for plugin with haml" do
+  before do
+    app(:bare) do
+      plugin :render, :engine => 'haml'
+      plugin :content_for
+
+      route do |r|
+        r.root do
+          view(:inline => "- content_for :foo do\n  - capture_haml do\n    foo\nbar", :layout => { :inline => "= yield\n=content_for :foo" })
+        end
+      end
+    end
+  end
+
+  it "should work with alternate rendering engines" do
+    body.strip.must_equal "bar\nfoo"
+  end
+end
+
+describe "content_for plugin with mixed template engines" do
+  before do
+    app(:bare) do
+      plugin :render, :layout_opts=>{:engine => 'haml', :inline => "= yield\n=content_for :foo" }
+      plugin :content_for
+
+      route do |r|
+        r.root do
+          view(:inline => "<% content_for :foo do %>foo<% end %>bar")
+        end
+      end
+    end
+  end
+
+  it "should work with alternate rendering engines" do
+    body.strip.must_equal "bar\nfoo"
+  end
+end
+
+describe "content_for plugin when overriding :engine" do
+  before do
+    app(:bare) do
+      plugin :render, :engine => 'haml', :layout_opts=>{:inline => "= yield\n=content_for :foo" }
+      plugin :content_for
+
+      route do |r|
+        r.root do
+          view(:inline => "<% content_for :foo do %>foo<% end %>bar", :engine=>:erb)
+        end
+      end
+    end
+  end
+
+  it "should work with alternate rendering engines" do
+    body.strip.must_equal "bar\nfoo"
+  end
+end
 end

data/spec/plugin/multi_view_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+
+begin
+  require 'tilt/erb'
+rescue LoadError
+  warn "tilt not installed, skipping multi_view plugin test"  
+else
+describe "multi_view plugin" do 
+  before do
+    app(:bare) do
+      plugin :render, :views=>'spec/views', :layout=>'layout-yield'
+      plugin :multi_view
+
+      route do |r|
+        r.multi_view(['a', 'b', 'c'])
+      end
+    end
+  end
+
+  it "supports easy rendering of multiple views by name" do
+    body('/a').gsub(/\s+/, '').must_equal "HeaderaFooter"
+    body('/b').gsub(/\s+/, '').must_equal "HeaderbFooter"
+    body('/c').gsub(/\s+/, '').must_equal "HeadercFooter"
+    status('/d').must_equal 404
+    status('/a', 'REQUEST_METHOD'=>'POST').must_equal 404
+  end
+end
+
+describe "multi_view plugin multi_view_compile method " do 
+  before do
+    app(:bare) do
+      plugin :render, :views=>'spec/views', :layout=>'layout-yield'
+      plugin :multi_view
+      regexp = multi_view_compile(['a', 'b', 'c'])
+
+      route do |r|
+        r.multi_view(regexp)
+      end
+    end
+  end
+
+  it "supports easy rendering of multiple views by name" do
+    body('/a').gsub(/\s+/, '').must_equal "HeaderaFooter"
+    body('/b').gsub(/\s+/, '').must_equal "HeaderbFooter"
+    body('/c').gsub(/\s+/, '').must_equal "HeadercFooter"
+    status('/d').must_equal 404
+    status('/a', 'REQUEST_METHOD'=>'POST').must_equal 404
+  end
+end
+end

data/spec/views/a.erb

@@ -0,0 +1 @@
+a

data/spec/views/b.erb

@@ -0,0 +1 @@
+b

data/spec/views/c.erb

@@ -0,0 +1 @@
+c

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2015-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack_csrf
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +173,7 @@ extra_rdoc_files:
 - doc/release_notes/2.5.1.txt
 - doc/release_notes/2.6.0.txt
 - doc/release_notes/2.7.0.txt
+- doc/release_notes/2.8.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -164,6 +193,7 @@ files:
 - doc/release_notes/2.5.1.txt
 - doc/release_notes/2.6.0.txt
 - doc/release_notes/2.7.0.txt
+- doc/release_notes/2.8.0.txt
 - lib/roda.rb
 - lib/roda/plugins/_erubis_escaping.rb
 - lib/roda/plugins/all_verbs.rb
@@ -202,6 +232,7 @@ files:
 - lib/roda/plugins/module_include.rb
 - lib/roda/plugins/multi_route.rb
 - lib/roda/plugins/multi_run.rb
+- lib/roda/plugins/multi_view.rb
 - lib/roda/plugins/named_templates.rb
 - lib/roda/plugins/not_allowed.rb
 - lib/roda/plugins/not_found.rb
@@ -278,6 +309,7 @@ files:
 - spec/plugin/module_include_spec.rb
 - spec/plugin/multi_route_spec.rb
 - spec/plugin/multi_run_spec.rb
+- spec/plugin/multi_view_spec.rb
 - spec/plugin/named_templates_spec.rb
 - spec/plugin/not_allowed_spec.rb
 - spec/plugin/not_found_spec.rb
@@ -312,8 +344,11 @@ files:
 - spec/spec_helper.rb
 - spec/version_spec.rb
 - spec/views/_test.erb
+- spec/views/a.erb
 - spec/views/about.erb
 - spec/views/about.str
+- spec/views/b.erb
+- spec/views/c.erb
 - spec/views/content-yield.erb
 - spec/views/home.erb
 - spec/views/home.str