roda 2.20.0 → 2.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eef2a8e61f61ef63c53b1086d69a56ebfe6d8634
-  data.tar.gz: 9803c11eb51c8588d8ba7c8b8c9026045ee769f4
+  metadata.gz: 9e6b3cac6d9da3a5df41af141588ad921d4708d8
+  data.tar.gz: 345a82534b2994081e0fde6e7e9552d1d28af295
 SHA512:
-  metadata.gz: 82c6579b2995baf018e9115ce50dc32bb672cf9ecf7b26c82b895062e5cf86537ac2c07cd978936d64a5421989e332dfb24f2fea7fd45d07a8a5953b8eba93e6
-  data.tar.gz: c41e5dcc24f4dc2c5528556fb4c583f486e64eb7c04f988a9851d72e53ec99ea760782637084e9d83369db27a7cc3e83a37a3622e4c248654a639472ffdbc76c
+  metadata.gz: 44fa6264003e578c1d694737d9658d9b78a7d26274542ddc1fe8057e42684cd2f6dae884cccda81ddcebf0e76310f3ee9b5f283fe48cafd4c5256bb529b0a0b7
+  data.tar.gz: d3b536a7846bd36832d58968192f2bc031215dae669eb09b8351d135aa3ccaffa195032dd429315d40b564c5b61f1e9540678637c6ef57db351e9a8b1c5cfc3c

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 2.21.0 (2016-12-16)
+
+* Add handle_stream_error method to streaming plugin, for handling errors when using stream(:loop=>true) (jeremyevans)
+
 = 2.20.0 (2016-11-13)
 
 * Support :escape=>:erubi option in the render plugin to use the erubi template engine (jeremyevans)

data/Rakefile

@@ -86,9 +86,10 @@ end
   
 desc "Run specs with -w, some warnings filtered"
 task "spec_w" do
-  ENV['RUBYOPT'] ? (ENV['RUBYOPT'] += " -w") : (ENV['RUBYOPT'] = '-w')
-  rake = ENV['RAKE'] || "#{FileUtils::RUBY} -S rake"
-  sh %{#{rake} 2>&1 | egrep -v \": warning: instance variable @.* not initialized|: warning: method redefined; discarding old|: warning: previous definition of|: warning: statement not reached"}
+  rubyopt = ENV['RUBYOPT']
+  ENV['RUBYOPT'] = "#{rubyopt} -w"
+  spec.call('WARNING'=>'1')
+  ENV['RUBYOPT'] = rubyopt
 end
 
 ### Other

data/doc/release_notes/2.21.0.txt

@@ -0,0 +1,17 @@
+= New Features
+
+* The streaming plugin now supports a handle_stream_error method to
+  handle exceptions when using stream(:loop=>true).  This method
+  takes the exception and the stream object, and can be used to log
+  errors, output errors into the stream, close the stream, ignore
+  errors, or any other error handling.
+
+= Other Improvements
+
+* A couple of unused variable assignments have been removed, providing
+  a minor speedup.
+
+* The specs no longer produce deprecation warnings when using Minitest
+  5.10.
+
+* Some verbose warnings have been removed from the specs.

data/lib/roda/plugins/assets.rb

@@ -616,7 +616,7 @@ class Roda
 
           url_prefix = request.script_name if self.class.opts[:add_script_name]
 
-          if compiled = o[:compiled]
+          if o[:compiled]
             if ukey = _compiled_assets_hash(type, true)
               ["#{o[:compiled_asset_host]}#{url_prefix}/#{o[:"compiled_#{stype}_prefix"]}.#{ukey}.#{stype}"]
             else

data/lib/roda/plugins/indifferent_params.rb

@@ -35,6 +35,7 @@ class Roda
       INDIFFERENT_PROC = lambda{|h,k| h[k.to_s] if k.is_a?(Symbol)}
 
       if Rack.release > '2'
+        # :nocov:
         class QueryParser < Rack::QueryParser
           # Work around for invalid optimization in rack
           def parse_nested_query(qs, d=nil)
@@ -65,6 +66,7 @@ class Roda
             @_request.params
           end
         end
+        # :nocov:
       else
         module InstanceMethods
           # A copy of the request params that will automatically

data/lib/roda/plugins/static_routing.rb

@@ -106,7 +106,6 @@ class Roda
         # instead having the routing tree handle the request.
         def call
           r = @_request
-          path_info = r.env['PATH_INFO']
           if route = self.class.static_route_for(r.request_method, r.path_info)
             catch(:halt){r.static_route(&route)}
           else

data/lib/roda/plugins/streaming.rb

@@ -26,6 +26,25 @@ class Roda
     # :loop :: Whether to call the stream block continuously until
     #          the connection is closed.
     #
+    # If the :loop option is used, you can override the
+    # handle_stream_error method to change how exceptions
+    # are handled during streaming. This method is passed the
+    # exception and the stream.  By default, this method
+    # just reraises the exception, but you can choose to output
+    # the an error message to the stream, before raising:
+    #
+    #   def handle_stream_error(e, out)
+    #     out << 'ERROR!'
+    #     raise e
+    #   end
+    #
+    # Ignore errors completely while streaming:
+    #
+    #   def handle_stream_error(e, out)
+    #   end
+    #
+    # or handle the errors in some other way.
+    #
     # The implementation was originally taken from Sinatra,
     # which is also released under the MIT License:
     #
@@ -159,13 +178,22 @@ class Roda
           if opts[:loop]
             block = proc do |out|
               until out.closed?
-                yield(out)
+                begin
+                  yield(out)
+                rescue => e
+                  handle_stream_error(e, out)
+                end
               end
             end
           end
 
           throw :halt, @_response.finish_with_body(Stream.new(opts, &block))
         end
+
+        # Handle exceptions raised while streaming when using :loop
+        def handle_stream_error(e, out)
+          raise e
+        end
       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 = 20
+  RodaMinorVersion = 21
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/integration_spec.rb

@@ -174,7 +174,7 @@ describe "integration" do
   end
 
   it "should have app return the rack application to call" do
-    app(:bare){}.app.must_equal nil
+    app(:bare){}.app.must_be_nil
     app.route{|r|}
     app.app.must_be_kind_of(Proc)
     c = Class.new{def initialize(app) @app = app end; def call(env) @app.call(env) end} 

data/spec/plugin/caching_spec.rb

@@ -12,7 +12,7 @@ describe 'response.cache_control' do
     app(:caching) do |r|
       response.cache_control({})
     end
-    header('Cache-Control').must_equal nil
+    header('Cache-Control').must_be_nil
   end
 end
 
@@ -39,8 +39,8 @@ describe 'response.finish' do
     app(:caching) do |r|
       response.status = 304
     end
-    header('Content-Type').must_equal nil
-    header('Content-Length').must_equal nil
+    header('Content-Type').must_be_nil
+    header('Content-Length').must_be_nil
   end
 
   it 'does not change non-304 responses' do
@@ -57,7 +57,7 @@ describe 'request.last_modified' do
     app(:caching) do |r|
       r.last_modified nil
     end
-    header('Last-Modified').must_equal nil
+    header('Last-Modified').must_be_nil
   end
 
   it 'does not change a status other than 200' do

data/spec/plugin/chunked_spec.rb

@@ -31,6 +31,7 @@ describe "chunked plugin" do
 
   it "accepts a block that is called after layout yielding but before content when streaming" do
     app(:chunked) do |r|
+      @h = nil
       chunked(:inline=>'m<%= @h %>', :layout=>{:inline=>'<%= @h %><%= yield %>t'}) do
         @h = 'h'
       end
@@ -113,7 +114,7 @@ describe "chunked plugin" do
       response.write chunked(:inline=>'m', :layout=>{:inline=>'h<%= yield %>t'})
     end
 
-    header('Content-Length', 'HTTP_VERSION'=>'HTTP/1.1').must_equal nil
+    header('Content-Length', 'HTTP_VERSION'=>'HTTP/1.1').must_be_nil
     header('Content-Length', 'HTTP_VERSION'=>'HTTP/1.0').must_equal '4'
   end
 
@@ -135,7 +136,7 @@ describe "chunked plugin" do
     end
 
     header('Transfer-Encoding', 'HTTP_VERSION'=>'HTTP/1.1').must_equal 'chunked'
-    header('Transfer-Encoding', 'HTTP_VERSION'=>'HTTP/1.0').must_equal nil
+    header('Transfer-Encoding', 'HTTP_VERSION'=>'HTTP/1.0').must_be_nil
   end
 
   it "uses given :headers when chunking" do
@@ -147,7 +148,7 @@ describe "chunked plugin" do
     end
 
     header('Foo', 'HTTP_VERSION'=>'HTTP/1.1').must_equal 'bar'
-    header('Foo', 'HTTP_VERSION'=>'HTTP/1.0').must_equal nil
+    header('Foo', 'HTTP_VERSION'=>'HTTP/1.0').must_be_nil
   end
 
   it "handles multiple arguments to chunked" do

data/spec/plugin/delay_build_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
 describe "delay_build plugin" do 
   it "does not build rack app until app is called" do
     app(:delay_build){"a"}
-    app.instance_variable_get(:@app).must_equal nil
+    app.instance_variable_get(:@app).must_be_nil
     body.must_equal "a"
     # Work around minitest bug
     refute_equal app.instance_variable_get(:@app), nil

data/spec/plugin/drop_body_spec.rb

@@ -9,8 +9,8 @@ describe "drop_body plugin" do
 
     [101, 102, 204, 205, 304].each do  |i|
       body(i.to_s).must_equal ''
-      header('Content-Type', i.to_s).must_equal nil
-      header('Content-Length', i.to_s).must_equal nil
+      header('Content-Type', i.to_s).must_be_nil
+      header('Content-Length', i.to_s).must_be_nil
     end
 
     body('200').must_equal 'a'

data/spec/plugin/error_handler_spec.rb

@@ -115,7 +115,7 @@ describe "error_handler plugin" do
     end
 
     header('Content-Type').must_equal 'text/html'
-    header('Foo').must_equal nil
+    header('Foo').must_be_nil
   end
 
   it "can set error via the plugin block" do

data/spec/plugin/hooks_spec.rb

@@ -57,7 +57,7 @@ describe "hooks plugin" do
 
     proc{req}.must_raise(Roda::RodaError)
     a.pop.must_be_kind_of(Roda::RodaError)
-    a.pop.must_equal nil
+    a.pop.must_be_nil
   end
 
   it "handles multiple before and after blocks correctly" do

data/spec/plugin/mailer_spec.rb

@@ -84,8 +84,8 @@ describe "mailer plugin" do
       end
     end
 
-    app.mail('/foo', 1, 2).must_equal nil
-    app.sendmail('/foo', 1, 2).must_equal nil
+    app.mail('/foo', 1, 2).must_be_nil
+    app.sendmail('/foo', 1, 2).must_be_nil
     deliveries.must_equal []
   end
 

data/spec/plugin/not_found_spec.rb

@@ -64,7 +64,7 @@ describe "not_found plugin" do
     end
 
     header('Content-Type').must_equal 'text/html'
-    header('Foo').must_equal nil
+    header('Foo').must_be_nil
   end
 
   it "does not modify behavior if not_found is not called" do

data/spec/plugin/precompile_templates_spec.rb

@@ -16,7 +16,7 @@ describe "precompile_templates plugin" do
       end
     end
 
-    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].must_equal nil
+    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].must_be_nil
     app.precompile_templates 'spec/views/iv.erb'
     app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].wont_equal nil
     app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].instance_variable_get(:@compiled_method)[[]].wont_equal nil
@@ -32,7 +32,7 @@ describe "precompile_templates plugin" do
       end
     end
 
-    app.render_opts[:cache][File.expand_path('spec/views/about.erb')].must_equal nil
+    app.render_opts[:cache][File.expand_path('spec/views/about.erb')].must_be_nil
     app.precompile_templates 'spec/views/about.erb', :locals=>[:title]
     app.render_opts[:cache][File.expand_path('spec/views/about.erb')].wont_equal nil
     app.render_opts[:cache][File.expand_path('spec/views/about.erb')].instance_variable_get(:@compiled_method)[[:title]].wont_equal nil
@@ -48,7 +48,7 @@ describe "precompile_templates plugin" do
       end
     end
 
-    app.render_opts[:cache][File.expand_path('spec/views/home.erb')].must_equal nil
+    app.render_opts[:cache][File.expand_path('spec/views/home.erb')].must_be_nil
     app.precompile_templates 'spec/views/h*.erb', :locals=>[:title, :name]
     app.render_opts[:cache][File.expand_path('spec/views/home.erb')].wont_equal nil
     app.render_opts[:cache][File.expand_path('spec/views/home.erb')].instance_variable_get(:@compiled_method)[[:name, :title]].wont_equal nil
@@ -64,7 +64,7 @@ describe "precompile_templates plugin" do
       end
     end
 
-    app.render_opts[:cache]['a'].must_equal nil
+    app.render_opts[:cache]['a'].must_be_nil
     app.precompile_templates :inline=>'a', :cache_key=>'a'
     app.render_opts[:cache]['a'].wont_equal nil
     app.render_opts[:cache]['a'].instance_variable_get(:@compiled_method)[[]].wont_equal nil

data/spec/plugin/public_spec.rb

@@ -43,10 +43,10 @@ describe "public plugin" do
     end
 
     body('/about/_test.erb').must_equal File.read('spec/views/about/_test.erb')
-    header('Content-Encoding', '/about/_test.erb').must_equal nil
+    header('Content-Encoding', '/about/_test.erb').must_be_nil
 
     body('/about.erb').must_equal File.read('spec/views/about.erb')
-    header('Content-Encoding', '/about.erb').must_equal nil
+    header('Content-Encoding', '/about.erb').must_be_nil
 
     meth = RUBY_VERSION >= '1.9' ? :binread : :read
     body('/about/_test.erb', 'HTTP_ACCEPT_ENCODING'=>'deflate, gzip').must_equal File.send(meth, 'spec/views/about/_test.erb.gz')

data/spec/plugin/render_spec.rb

@@ -69,8 +69,6 @@ describe "render plugin" do
 end
 
 describe "render plugin with :layout_opts=>{:merge_locals=>true}" do
-  h = {:a=>1, :b=>2, :c=>3, :d=>4}
-
   before 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}}
@@ -269,6 +267,7 @@ describe "render plugin" do
     app(:bare) do
       plugin :render, :engine_opts=>{'a.erb'=>{:outvar=>'@a'}}
       route do |r|
+        @a = nil
         r.is('a') do
           render(:inline=>'<%= @a.class.name %>', :engine=>'a.erb')
         end
@@ -344,6 +343,7 @@ describe "render plugin" do
         render(:inline=>template.dup, :locals=>{:b=>2, :c=>4})
       end
       r.is "c" do
+        @a = nil
         render(:inline=>template.dup, :locals=>{:c=>3})
       end
     end
@@ -357,7 +357,7 @@ describe "render plugin" do
     with_rack_env('development') do
       app(:render){}
     end
-    app.render_opts[:cache].must_equal nil
+    app.render_opts[:cache].must_be_nil
     app(:render){}
     app.render_opts[:cache].wont_equal nil
   end
@@ -374,7 +374,7 @@ describe "render plugin" do
     end
 
     body('/a').strip.must_equal "a"
-    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].must_equal nil
+    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].must_be_nil
     body('/b').strip.must_equal "a"
     app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].wont_equal nil
   end
@@ -403,7 +403,7 @@ describe "render plugin" do
     end
 
     body('/a').strip.must_equal "iv-a"
-    app.render_opts[:cache][['iv', c, nil, nil, proca]].must_equal nil
+    app.render_opts[:cache][['iv', c, nil, nil, proca]].must_be_nil
     body('/b').strip.must_equal "iv-a"
     app.render_opts[:cache][['iv', c, nil, nil, proca]].wont_equal nil
   end

data/spec/plugin/sinatra_helpers_spec.rb

@@ -378,7 +378,7 @@ describe "sinatra_helpers plugin" do
     end
 
     it "does not set the Content-Disposition header by default" do
-      header('Content-Disposition').must_equal nil
+      header('Content-Disposition').must_be_nil
     end
 
     it "sets the Content-Disposition header when :disposition set to 'attachment'" do

data/spec/plugin/status_handler_spec.rb

@@ -68,7 +68,7 @@ describe "status_handler plugin" do
     end
 
     header('Content-Type').must_equal 'text/html'
-    header('Foo').must_equal nil
+    header('Foo').must_be_nil
   end
 
   it "does not modify behavior if status_handler is not called" do

data/spec/plugin/streaming_spec.rb

@@ -49,4 +49,73 @@ describe "streaming plugin" do
     proc{b.each{|v| a << v}}.must_raise(Roda::RodaError)
     a.must_equal %w'a b e d'
   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')
+    b.callback{a << 'd'}
+    proc{b.each{|v| a << v}}.must_raise(Roda::RodaError)
+    a.must_equal %w'a b 1 e d'
+  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.callback{a << 'd'}
+    b.each{|v| a << v}
+    a.must_equal %w'a b e d'
+  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.callback{a << 'd'}
+    b.each{|v| a << v}
+    a.must_equal %w'a 1 b 1 c 1 e d'
+  end
 end

data/spec/plugin/type_routing_spec.rb

@@ -52,7 +52,6 @@ describe "type_routing plugin" do
 
   it "works correctly in sub apps" do
     sup_app = app
-    b = sup_app.route_block
     @app = Class.new(sup_app)
     app.route do |r|
       r.run(sup_app)

data/spec/plugin/unescape_path_spec.rb

@@ -4,7 +4,7 @@ describe "unescape_path_path plugin" do
   it "decodes URL-encoded routing path" do
     app(:unescape_path) do |r|
       r.on 'b' do
-        r.get /(.)/ do |a|
+        r.get(/(.)/) do |a|
           "#{a}-b"
         end
       end

data/spec/plugin_spec.rb

@@ -48,7 +48,7 @@ describe "plugins" do
     end
 
     app(:bare) do
-      plugin(c, "Foo ").must_equal nil
+      plugin(c, "Foo ").must_be_nil
 
       route do |r|
         r.hello do

data/spec/response_spec.rb

@@ -58,7 +58,7 @@ describe "response #finish" do
   it "should set Content-Length header" do
     app do |r|
       response.write 'a'
-      response['Content-Length'].must_equal nil
+      response['Content-Length'].must_be_nil
       throw :halt, response.finish
     end
 
@@ -71,8 +71,8 @@ describe "response #finish" do
       throw :halt, response.finish
     end
 
-    header('Content-Type').must_equal nil
-    header('Content-Length').must_equal nil
+    header('Content-Type').must_be_nil
+    header('Content-Length').must_be_nil
   end
 
   it "should not overwrite existing status" do
@@ -106,11 +106,11 @@ describe "response #finish_with_body" do
   it "should not set Content-Length header" do
     app do |r|
       response.write 'a'
-      response['Content-Length'].must_equal nil
+      response['Content-Length'].must_be_nil
       throw :halt, response.finish_with_body(['123'])
     end
 
-    header('Content-Length').must_equal nil
+    header('Content-Length').must_be_nil
   end
 
   it "should not overwrite existing status" do

data/spec/spec_helper.rb

@@ -2,6 +2,11 @@ $:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 
 require "rubygems"
 
+if ENV['WARNING']
+  require 'warning'
+  Warning.ignore([:missing_ivar, :method_redefined, :not_reached], File.dirname(File.dirname(__FILE__)))
+end
+
 if ENV['COVERAGE']
   require 'coverage'
   require 'simplecov'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 2.20.0
+  version: 2.21.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-13 00:00:00.000000000 Z
+date: 2016-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -200,6 +200,7 @@ extra_rdoc_files:
 - doc/release_notes/2.18.0.txt
 - doc/release_notes/2.19.0.txt
 - doc/release_notes/2.20.0.txt
+- doc/release_notes/2.21.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -224,6 +225,7 @@ files:
 - doc/release_notes/2.19.0.txt
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.20.0.txt
+- doc/release_notes/2.21.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
 - doc/release_notes/2.5.0.txt
@@ -438,7 +440,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit