roda 2.28.0 → 2.29.0

data/spec/plugin/render_locals_spec.rb

@@ -0,0 +1,114 @@
+require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+
+begin
+  require 'tilt/erb'
+rescue LoadError
+  warn "tilt not installed, skipping render_locals plugin test"  
+else
+describe "render_locals plugin with :merge option" do
+  before do
+    app(:bare) do
+      plugin :render_locals, :render=>{:a=>1, :b=>2, :c=>3, :d=>4, :e=>5}, :layout=>{:a=>-1, :f=>6}, :merge=>true
+      plugin :render, :views=>"./spec/views", :check_paths=>true, :layout_opts=>{:inline=>'<%= a %>|<%= b %>|<%= c %>|<%= d %>|<%= e %>|<%= f %>|<%= yield %>'}
+
+      route do |r|
+        r.on "base" do
+          view(:inline=>'(<%= a %>|<%= b %>|<%= c %>|<%= d %>|<%= e %>)')
+        end
+        r.on "override" do
+          view(:inline=>'(<%= a %>|<%= b %>|<%= c %>|<%= d %>|<%= e %>)', :locals=>{:b=>-2, :d=>-4, :f=>-6}, :layout_opts=>{:locals=>{:d=>0, :c=>-3, :e=>-5}})
+        end
+        r.on "no_merge" do
+          view(:inline=>'(<%= a %>|<%= b %>|<%= c %>|<%= d %>|<%= e %>)', :locals=>{:b=>-2, :d=>-4, :f=>-6}, :layout_opts=>{:merge_locals=>false, :locals=>{:d=>0, :c=>-3, :e=>-5}})
+        end
+      end
+    end
+  end
+
+  it "should choose method opts before plugin opts, and layout specific before locals" do
+    body("/base").must_equal '-1|2|3|4|5|6|(1|2|3|4|5)'
+    body("/override").must_equal '-1|-2|-3|0|-5|-6|(1|-2|3|-4|5)'
+    body("/no_merge").must_equal '-1|2|-3|0|-5|6|(1|-2|3|-4|5)'
+  end
+end
+
+describe "render_locals plugin" do
+  it "locals overrides" do
+    app(:bare) do
+      plugin :render, :views=>"./spec/views", :layout_opts=>{:template=>'multiple-layout'}
+      plugin :render_locals, :render=>{:title=>'Home', :b=>'B'}, :layout=>{:title=>'Roda', :a=>'A'}
+      
+      route do |r|
+        view("multiple", :locals=>{:b=>"BB"}, :layout_opts=>{:locals=>{:a=>'AA'}})
+      end
+    end
+
+    body.strip.must_equal "Roda:AA::Home:BB"
+  end
+
+  it ":layout=>true/false/string/hash/not-present respects plugin layout switch and template" do
+    app(:bare) do
+      plugin :render, :views=>"./spec/views", :layout_opts=>{:template=>'layout-yield'}
+      plugin :render_locals, :layout=>{:title=>'a'}
+      
+      route do |r|
+        opts = {:content=>'bar'}
+        opts[:layout] = true if r.path == '/'
+        opts[:layout] = false if r.path == '/f'
+        opts[:layout] = 'layout' if r.path == '/s'
+        opts[:layout] = {:template=>'layout'} if r.path == '/h'
+        view(opts)
+      end
+    end
+
+    body.gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/a').gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/f').gsub("\n", '').must_equal "bar"
+    body('/s').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+    body('/h').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+
+    app.plugin :render
+    body.gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/a').gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/f').gsub("\n", '').must_equal "bar"
+    body('/s').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+    body('/h').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+
+    app.plugin :render, :layout=>true
+    body.gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/a').gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/f').gsub("\n", '').must_equal "bar"
+    body('/s').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+    body('/h').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+
+    app.plugin :render, :layout=>'layout-alternative'
+    body.gsub("\n", '').must_equal "<title>Alternative Layout: a</title>bar"
+    body('/a').gsub("\n", '').must_equal "<title>Alternative Layout: a</title>bar"
+    body('/f').gsub("\n", '').must_equal "bar"
+    body('/s').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+    body('/h').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+
+    app.plugin :render, :layout=>nil
+    body.gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/a').gsub("\n", '').must_equal "bar"
+    body('/f').gsub("\n", '').must_equal "bar"
+    body('/s').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+    body('/h').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+
+    app.plugin :render, :layout=>false
+    body.gsub("\n", '').must_equal "HeaderbarFooter"
+    body('/a').gsub("\n", '').must_equal "bar"
+    body('/f').gsub("\n", '').must_equal "bar"
+    body('/s').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+    body('/h').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+
+    app.plugin :render, :layout_opts=>{:template=>'layout-alternative'}
+    app.plugin :render_locals, :layout=>{:title=>'a'}
+    body.gsub("\n", '').must_equal "<title>Alternative Layout: a</title>bar"
+    body('/a').gsub("\n", '').must_equal "bar"
+    body('/f').gsub("\n", '').must_equal "bar"
+    body('/s').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+    body('/h').gsub("\n", '').must_equal "<title>Roda: a</title>bar"
+  end
+end
+end

data/spec/plugin/render_spec.rb

@@ -50,7 +50,7 @@ describe "render plugin" do
     body("/inline").strip.must_equal "Hello <%= name %>"
   end
 
-  it "with str as ext" do
+  deprecated "with str as ext" do
     app.plugin :render, :ext => "str"
     body("/about").strip.must_equal "<h1>About Roda</h1>"
     body("/home").strip.must_equal "<title>Roda: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"
@@ -69,7 +69,7 @@ describe "render plugin" do
 end
 
 describe "render plugin with :layout_opts=>{:merge_locals=>true}" do
-  before do
+  deprecated "should choose method opts before plugin opts, and layout specific before locals" do
     app(:bare) do
       plugin :render, :views=>"./spec/views", :check_paths=>true, :locals=>{:a=>1, :b=>2, :c=>3, :d=>4, :e=>5}, :layout_opts=>{:inline=>'<%= a %>|<%= b %>|<%= c %>|<%= d %>|<%= e %>|<%= f %>|<%= yield %>', :merge_locals=>true, :locals=>{:a=>-1, :f=>6}}
 
@@ -85,9 +85,7 @@ describe "render plugin with :layout_opts=>{:merge_locals=>true}" do
         end
       end
     end
-  end
 
-  it "should choose method opts before plugin opts, and layout specific before locals" do
     body("/base").must_equal '-1|2|3|4|5|6|(1|2|3|4|5)'
     body("/override").must_equal '-1|-2|-3|0|-5|-6|(1|-2|3|-4|5)'
     body("/no_merge").must_equal '-1|2|-3|0|-5|6|(1|-2|3|-4|5)'
@@ -109,6 +107,19 @@ describe "render plugin" do
     body.gsub(/\n+/, "\n").must_equal "Header\nThis is the actual content.\nFooter\n"
   end
 
+  it "should have :layout_opts=>:views plugin option respect :root app option" do
+    app(:bare) do
+      self.opts[:root] = 'spec'
+      plugin :render, :layout_opts=>{:views=>"views"}, :allowed_paths=>["spec/views"]
+
+      route do |r|
+        view(:content=>'a', :layout_opts=>{:locals=>{:title=>"Home"}})
+      end
+    end
+
+    body.strip.must_equal "<title>Roda: Home</title>\na"
+  end
+
   it "views without default layouts" do
     app(:bare) do
       plugin :render, :views=>"./spec/views", :layout=>false
@@ -133,7 +144,7 @@ describe "render plugin" do
     body.strip.must_equal "<title>Alternative Layout: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>"
   end
 
-  it "locals overrides" do
+  deprecated "locals overrides" do
     app(:bare) do
       plugin :render, :views=>"./spec/views", :locals=>{:title=>'Home', :b=>'B'}, :layout_opts=>{:template=>'multiple-layout', :locals=>{:title=>'Roda', :a=>'A'}}
       
@@ -145,7 +156,7 @@ describe "render plugin" do
     body.strip.must_equal "Roda:AA::Home:BB"
   end
 
-  it ":layout=>true/false/string/hash/not-present respects plugin layout switch and template" do
+  deprecated ":layout=>true/false/string/hash/not-present respects plugin layout switch and template" do
     app(:bare) do
       plugin :render, :views=>"./spec/views", :layout_opts=>{:template=>'layout-yield', :locals=>{:title=>'a'}}
       
@@ -362,6 +373,26 @@ describe "render plugin" do
     app.render_opts[:explicit_cache].must_equal false
   end
 
+  deprecated "Support :cache=>false plugin option to disable template caching, even when :cache=>true method option is given" do
+    app(:bare) do
+      plugin :render, :views=>"./spec/views", :cache=>false
+
+      route do |r|
+        @a = 'a'
+        r.is('a'){render('iv', :cache=>false)}
+        r.is('b'){render('iv', :cache=>true)}
+        render('iv')
+      end
+    end
+
+    body('/a').strip.must_equal "a"
+    app.render_opts[:cache].must_equal false
+    body('/b').strip.must_equal "a"
+    app.render_opts[:cache].must_equal false
+    body('/c').strip.must_equal "a"
+    app.render_opts[:cache].must_equal false
+  end
+
   it "Support :cache=>false option to disable template caching" do
     app(:bare) do
       plugin :render, :views=>"./spec/views"
@@ -459,7 +490,7 @@ describe "render plugin" do
     app.render_opts[:cache][['iv', c, nil, nil, proca]].wont_equal nil
   end
 
-  it "Support :cache_key option to force the key used when caching" do
+  it "Support :cache_key option to force the key used when caching, unless :cache=>false option is used" do
     app(:bare) do
       plugin :render, :views=>"./spec/views"
 
@@ -544,7 +575,7 @@ describe "render plugin" do
     Class.new(app).render_opts[:cache].must_equal false
   end
 
-  it "with :check_paths=>true" do
+  it "with :check_paths=>true plugin option used" do
     render_opts = {}
     app(:bare) do
       plugin :render, :views=>"./spec/views", :check_paths=>true
@@ -599,6 +630,50 @@ describe "render plugin" do
     req("/c")
   end
 
+  deprecated "with :check_paths plugin option not set" do
+    render_opts = {}
+    app(:bare) do
+      plugin :render, :views=>"./spec/views"
+      
+      route do |r|
+        r.get 'a' do
+          render("a", render_opts)
+        end
+
+        r.get 'c' do
+          render("about/_test", :locals=>{:title=>'a'})
+        end
+
+        render("b", render_opts)
+      end
+    end
+
+    body.strip.must_equal "b"
+    body("/a").strip.must_equal 'a'
+    body("/c").strip.must_equal "<h1>Subdir: a</h1>"
+
+    app.plugin :render, :allowed_paths=>[]
+    body.strip.must_equal "b"
+    body("/a").strip.must_equal 'a'
+    body("/c").strip.must_equal "<h1>Subdir: a</h1>"
+
+    app.plugin :render, :allowed_paths=>['spec/views/about']
+    body.strip.must_equal "b"
+    body("/a").strip.must_equal 'a'
+    body("/c").strip.must_equal "<h1>Subdir: a</h1>"
+
+    app.plugin :render, :allowed_paths=>%w'spec/views/about spec/views/b'
+    body.strip.must_equal "b"
+    body("/a").strip.must_equal 'a'
+    body("/c").strip.must_equal "<h1>Subdir: a</h1>"
+
+    render_opts[:check_paths] = true
+    app.plugin :render, :check_paths=>false
+    body.strip.must_equal "b"
+    proc{req("/a")}.must_raise Roda::RodaError
+    body("/c").strip.must_equal "<h1>Subdir: a</h1>"
+  end
+
   it "with a cache_class set" do
     app(:bare) do
       test_cache = Class.new(Roda::RodaCache) do

data/spec/plugin/streaming_spec.rb

@@ -24,6 +24,106 @@ describe "streaming plugin" do
       end
     end
 
+    s, h, b = req
+    s.must_equal 200
+    h.must_equal('Content-Type'=>'text/html')
+    proc{b.each{|v| a << v}}.must_raise(Roda::RodaError)
+    a.must_equal %w'a b e'
+  end
+
+  it "should handle :loop option to loop" do
+    a = []
+    app(:streaming) do |r|
+      b = %w'a b c'
+      stream(:loop=>true, :callback=>proc{a << 'e'}) do |out|
+        out << b.shift
+        raise Roda::RodaError, 'foo' if b.length == 1
+      end
+    end
+
+    s, h, b = req
+    s.must_equal 200
+    h.must_equal('Content-Type'=>'text/html')
+    proc{b.each{|v| a << v}}.must_raise(Roda::RodaError)
+    a.must_equal %w'a b e'
+  end
+
+  it "uses handle_stream_error for handling errors when streaming" do
+    a = []
+    app(:streaming) do |r|
+      b = %w'a b c'
+      stream(:loop=>true, :callback=>proc{a << 'e'}) do |out|
+        out << b.shift
+        raise Roda::RodaError, 'foo' if b.length == 1
+      end
+    end
+
+    app.send(:define_method, :handle_stream_error) do |error, out|
+      out << '1'
+      raise error
+    end
+
+    s, h, b = req
+    s.must_equal 200
+    h.must_equal('Content-Type'=>'text/html')
+    proc{b.each{|v| a << v}}.must_raise(Roda::RodaError)
+    a.must_equal %w'a b 1 e'
+  end
+
+  it "should allow closing the stream when handling an error" do
+    a = []
+    app(:streaming) do |r|
+      b = %w'a b c'
+      stream(:loop=>true, :callback=>proc{a << 'e'}) do |out|
+        out << b.shift
+        raise Roda::RodaError, 'foo' if b.length == 1
+      end
+    end
+
+    app.send(:define_method, :handle_stream_error) do |error, out|
+      out.close
+    end
+
+    s, h, b = req
+    s.must_equal 200
+    h.must_equal('Content-Type'=>'text/html')
+    b.each{|v| a << v}
+    a.must_equal %w'a b e'
+  end
+
+  it "should allow ignoring errors when streaming" do
+    a = []
+    b2 = %w'a b c'
+
+    app(:streaming) do |r|
+      stream(:loop=>true, :callback=>proc{a << 'e'}) do |out|
+        out << b2.shift
+        raise Roda::RodaError
+      end
+    end
+
+    app.send(:define_method, :handle_stream_error) do |error, out|
+      out << '1'
+      out.close if b2.empty?
+    end
+
+    s, h, b = req
+    s.must_equal 200
+    h.must_equal('Content-Type'=>'text/html')
+    b.each{|v| a << v}
+    a.must_equal %w'a 1 b 1 c 1 e'
+  end
+
+  deprecated "should handle errors when streaming, and run callbacks" do
+    a = []
+    app(:streaming) do |r|
+      stream(:callback=>proc{a << 'e'}) do |out|
+        %w'a b'.each{|v| out << v}
+        raise Roda::RodaError, 'foo'
+        out << 'c'
+      end
+    end
+
     s, h, b = req
     s.must_equal 200
     h.must_equal('Content-Type'=>'text/html')
@@ -32,7 +132,7 @@ describe "streaming plugin" do
     a.must_equal %w'a b e d'
   end
 
-  it "should handle :loop option to loop" do
+  deprecated "should handle :loop option to loop" do
     a = []
     app(:streaming) do |r|
       b = %w'a b c'
@@ -50,7 +150,7 @@ describe "streaming plugin" do
     a.must_equal %w'a b e d'
   end
 
-  it "uses handle_stream_error for handling errors when streaming" do
+  deprecated "uses handle_stream_error for handling errors when streaming" do
     a = []
     app(:streaming) do |r|
       b = %w'a b c'
@@ -73,7 +173,7 @@ describe "streaming plugin" do
     a.must_equal %w'a b 1 e d'
   end
 
-  it "should allow closing the stream when handling an error" do
+  deprecated "should allow closing the stream when handling an error" do
     a = []
     app(:streaming) do |r|
       b = %w'a b c'
@@ -95,7 +195,7 @@ describe "streaming plugin" do
     a.must_equal %w'a b e d'
   end
 
-  it "should allow ignoring errors when streaming" do
+  deprecated "should allow ignoring errors when streaming" do
     a = []
     b2 = %w'a b c'
 

data/spec/plugin/symbol_matchers_spec.rb

@@ -49,7 +49,7 @@ describe "symbol_matchers plugin" do
     body('/thing2/q').must_equal 'thing2q'
   end
 
-  it "works with placeholder string matchers" do
+  deprecated "works with placeholder string matchers" do
     app(:bare) do
       opts[:verbatim_string_matcher] = false
       plugin :symbol_matchers

data/spec/plugin/view_options_spec.rb

@@ -45,7 +45,43 @@ describe "view_options plugin view subdirs" do
 end
 
 describe "view_options plugin" do
-  it "should set view and layout options and locals to use" do
+  it "should set view and layout options to use" do
+    app(:bare) do
+      plugin :render, :allowed_paths=>['spec/views']
+      plugin :view_options
+      plugin :render_locals, :render=>{:title=>'About Roda'}, :layout=>{:title=>'Home'}
+
+      route do
+        set_view_options :views=>'spec/views'
+        set_layout_options :views=>'spec/views', :template=>'layout-alternative'
+        view('about')
+      end
+    end
+
+    body.strip.must_equal "<title>Alternative Layout: Home</title>\n<h1>About Roda</h1>"
+  end
+
+  it "should merge multiple calls to set view and layout options" do
+    app(:bare) do
+      plugin :render, :allowed_paths=>['spec/views']
+      plugin :view_options
+      plugin :render_locals, :render=>{:title=>'Home', :b=>'B'}, :layout=>{:title=>'About Roda', :a=>'A'}
+
+      route do
+        set_layout_options :views=>'spec/views', :template=>'multiple-layout', :engine=>'str'
+        set_view_options :views=>'spec/views', :engine=>'str'
+
+        set_layout_options :engine=>'erb'
+        set_view_options :engine=>'erb'
+
+        view('multiple')
+      end
+    end
+
+    body.strip.must_equal "About Roda:A::Home:B"
+  end
+
+  deprecated "should set view and layout options and locals to use" do
     app(:view_options) do
       set_view_options :views=>'spec/views'
       set_view_locals :title=>'About Roda'
@@ -57,15 +93,15 @@ describe "view_options plugin" do
     body.strip.must_equal "<title>Alternative Layout: Home</title>\n<h1>About Roda</h1>"
   end
 
-  it "should merge multiple calls to set view and layout options and locals" do
+  deprecated "should merge multiple calls to set view and layout options and locals" do
     app(:view_options) do
-      set_layout_options :views=>'spec/views', :template=>'multiple-layout', :ext=>'str'
-      set_view_options :views=>'spec/views', :ext=>'str'
+      set_layout_options :views=>'spec/views', :template=>'multiple-layout', :engine=>'str'
+      set_view_options :views=>'spec/views', :engine=>'str'
       set_layout_locals :title=>'About Roda'
       set_view_locals :title=>'Home'
 
-      set_layout_options :ext=>'erb'
-      set_view_options :ext=>'erb'
+      set_layout_options :engine=>'erb'
+      set_view_options :engine=>'erb'
       set_layout_locals :a=>'A'
       set_view_locals :b=>'B'
 
@@ -75,7 +111,7 @@ describe "view_options plugin" do
     body.strip.must_equal "About Roda:A::Home:B"
   end
 
-  it "should have set_view_locals have more precedence than plugin options, but less than view/render method options" do
+  deprecated "should have set_view_locals have more precedence than plugin options, but less than view/render method options" do
     app(:bare) do 
       plugin :render, :views=>"./spec/views", :locals=>{:title=>'Home', :b=>'B'}, :layout_opts=>{:template=>'multiple-layout', :locals=>{:title=>'About Roda', :a=>'A'}}
       plugin :view_options
@@ -113,5 +149,45 @@ describe "view_options plugin" do
     body('/a').strip.must_equal "About Roda:AA::Home:BB"
     body.strip.must_equal "About Roda:AAA::Home:BBB"
   end
+
+  deprecated "should have set_view_locals have more precedence than plugin options, but less than view/render method options" do
+    app(:bare) do 
+      plugin :render, :views=>"./spec/views", :layout_opts=>{:template=>'multiple-layout'}
+      plugin :render_locals, :render=>{:title=>'Home', :b=>'B'}, :layout=>{:title=>'About Roda', :a=>'A'}
+      plugin :view_options
+
+      route do |r|
+        r.is 'c' do
+          view(:multiple)
+        end
+
+        set_view_locals :b=>'BB'
+        set_layout_locals :a=>'AA'
+
+        r.on 'b' do
+          set_view_locals :title=>'About'
+          set_layout_locals :title=>'Roda'
+
+          r.is 'a' do
+            view(:multiple)
+          end
+
+          view("multiple", :locals=>{:b => "BBB"}, :layout_opts=>{:locals=>{:a=>'AAA'}})
+        end
+
+        r.is 'a' do
+          view(:multiple)
+        end
+
+        view("multiple", :locals=>{:b => "BBB"}, :layout_opts=>{:locals=>{:a=>'AAA'}})
+      end
+    end
+
+    body('/c').strip.must_equal "About Roda:A::Home:B"
+    body('/b/a').strip.must_equal "Roda:AA::About:BB"
+    body('/b').strip.must_equal "Roda:AAA::About:BBB"
+    body('/a').strip.must_equal "About Roda:AA::Home:BB"
+    body.strip.must_equal "About Roda:AAA::Home:BBB"
+  end
 end
 end