roda 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc5d44e8586188ebb590d75d204b22fdd5b547c35e8631d31cf184ef5bfc0908
-  data.tar.gz: 03f023b11296d7cdebe72229d47988f3cf644ef3e80f243030e3b678c0ee9cb3
+  metadata.gz: 6f0422791db9ddee07b535f5429fd17ae5f312c7e5c7519dfbe0288e1d285919
+  data.tar.gz: 905f19053a3997fc7c3c4e4b942b73cd2400cb59df641cb4a86b23191cab873c
 SHA512:
-  metadata.gz: 942fb33ceeb0faef69467fa5b705bfd8b73f92bfb27557f58c9d459a9c1f1d4447eec1ac10c5cbf4eacf09293f20a4562e997125a41a226c5fb673154b85524d
-  data.tar.gz: e5d5f9533bed9c0c126a1203a9715bda8461b587bfb647a70a8aae1dd0a951cb5512d189c2e205ccbc1d67086afaa4e2a8c7104c741824c0ab3f8003fe999a98
+  metadata.gz: 10aff2c1df661f7cb2699cb3f49bf521587813017ca5cc5c1117c629f04805075e185170305cc012cbbdc2c4ecae59902f73efab1ff39806d3f9548acc918d8b
+  data.tar.gz: d6b70c570f4e198b743ecb4f216f600ad09b8010d6e1df1c202873b843846d1fac3c817dfd848fc7509efc4ba8f41d5907c4273187871ab8293810dc307018e5

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 3.5.0 (2018-02-14)
+
+* Add request_aref plugin for configuring behavior of request [] and []= methods (jeremyevans)
+
+* Make public plugin not add Content-Type header when serving 304 response for gzipped file (jeremyevans)
+
+* Make content_for call with block convert block result to string before passing to tilt (jeremyevans) (#135)
+
 = 3.4.0 (2018-01-12)
 
 * Add middleware_stack plugin for removing middleware and inserting middleware before the end of the stack (jeremyevans)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2017 Jeremy Evans
+Copyright (c) 2014-2018 Jeremy Evans
 Copyright (c) 2010-2014 Michel Martens, Damian Janowski and Cyril David
 Copyright (c) 2008-2009 Christian Neukirchen
 

data/README.rdoc

@@ -274,7 +274,7 @@ The +/+ here is considered the empty segment.
 
 === String
 
-If a string does not contain a colon or slash, it matches a single segment
+If a string does not contain a slash, it matches a single segment
 containing the text of the string, preceded by a slash.
 
   ""    # matches "/"

data/doc/release_notes/3.5.0.txt

@@ -0,0 +1,31 @@
+= New Features
+
+* A request_aref plugin has been added for configuring the behavior
+  of the [] and []= request methods.  These methods are deprecated
+  in the current version of Rack, but Rack will only print a
+  deprecation warning in verbose mode.  With this plugin, you can
+  choose to never warn, always warn, or raise an exception:
+
+    # Don't emit a warning, allowing for the historical Rack
+    # behavior
+    plugin :request_aref, :allow
+
+    # Always emit a warning when the method is called
+    plugin :request_aref, :warn
+
+    # Raise an exception if the method is called
+    plugin :request_aref, :raise
+
+= Other Improvements
+
+* When using the content_for plugin and calling content_for with a
+  block, convert the result of the block to a string before passing
+  the result to Tilt.  This can fix issues when the template class
+  that Tilt uses does not handle non-String input.
+
+* When using the public plugin with the :gzip option, do not add the
+  Content-Type or Content-Encoding headers if a 304 response is
+  returned.
+
+* Add the spec/views/about directory to the gem, allowing the specs
+  to run correctly using just the files in the gem.

data/lib/roda/plugins/content_for.rb

@@ -52,17 +52,17 @@ class Roda
         # under the given key.  If called without a block, retrieve
         # stored content with the given key, or return nil if there
         # is no content stored with that key.
-        def content_for(key, value=nil, &block)
+        def content_for(key, value=nil)
           append = opts[:append_content_for]
 
-          if block || value
-            if block
+          if block_given? || value
+            if block_given?
               outvar = render_opts[:template_opts][:outvar]
               buf_was = instance_variable_get(outvar)
 
               # Use temporary output buffer for ERB-based rendering systems
               instance_variable_set(outvar, String.new)
-              value = Tilt[render_opts[:engine]].new(&block).render
+              value = Tilt[render_opts[:engine]].new{yield.to_s}.render
               instance_variable_set(outvar, buf_was)
             end
 

data/lib/roda/plugins/public.rb

@@ -72,10 +72,12 @@ class Roda
                 res = public_serve(server, gzip_path)
                 headers = res[1]
 
-                if mime_type = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
-                  headers['Content-Type'] = mime_type
+                unless res[0] == 304
+                  if mime_type = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
+                    headers['Content-Type'] = mime_type
+                  end
+                  headers['Content-Encoding'] = 'gzip'
                 end
-                headers['Content-Encoding'] = 'gzip'
 
                 halt res
               end

data/lib/roda/plugins/request_aref.rb

@@ -0,0 +1,77 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The request_aref plugin allows for custom handling of the r[] and r[]=
+    # methods (where r is the Request instance).  In the current version of
+    # rack, these methods are deprecated, but the deprecation message is only
+    # printed in verbose mode.  This plugin can allow for handling calls to
+    # these methods in one of three ways:
+    #
+    # :allow :: Allow the method calls without a deprecation, which is the
+    #           historical behavior
+    # :warn :: Always issue a deprecation message by calling +warn+, not just
+    #          in verbose mode.
+    # :raise :: Raise an error if either method is called
+    module RequestAref
+      # Make #[] and #[]= methods work as configured by aliasing the appropriate
+      # request_a(ref|set)_* methods to them.
+      def self.configure(app, setting)
+        case setting
+        when :allow, :raise, :warn
+          app::RodaRequest.class_eval do
+            alias_method(:[],  :"request_aref_#{setting}")
+            alias_method(:[]=, :"request_aset_#{setting}")
+            public :[], :[]=
+          end
+        else
+          raise RodaError, "Unsupport request_aref plugin setting: #{setting.inspect}"
+        end
+      end
+
+      # Exception class raised when #[] or #[]= are called when the
+      # :raise setting is used.
+      class Error < RodaError
+      end
+
+      module RequestMethods
+        private
+
+        # Allow #[] calls
+        def request_aref_allow(k)
+          params[k.to_s]
+        end
+
+        # Always warn on #[] calls
+        def request_aref_warn(k)
+          warn("#{self.class}#[] is deprecated, use #params.[] instead")
+          params[k.to_s]
+        end
+
+        # Raise error on #[] calls
+        def request_aref_raise(k)
+          raise Error, "#{self.class}#[] has been removed, use #params.[] instead"
+        end
+
+        # Allow #[]= calls
+        def request_aset_allow(k, v)
+          params[k.to_s] = v
+        end
+
+        # Always warn on #[]= calls
+        def request_aset_warn(k, v)
+          warn("#{self.class}#[]= is deprecated, use #params.[]= instead")
+          params[k.to_s] = v
+        end
+
+        # Raise error on #[]= calls
+        def request_aset_raise(k, v)
+          raise Error, "#{self.class}#[]= has been removed, use #params.[]= instead"
+        end
+      end
+    end
+
+    register_plugin(:request_aref, RequestAref)
+  end
+end

data/lib/roda/version.rb

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

data/lib/roda.rb

@@ -722,9 +722,9 @@ class Roda
           consume(self.class.cached_matcher(re){re})
         end
 
-        # Match the given string to the request path.  Regexp escapes the
-        # string so that regexp metacharacters are not matched, and recognizes
-        # colon tokens for placeholders.
+        # Match the given string to the request path.  Matches only if the
+        # request path ends with the string or if the next character in the
+        # request path is a slash (indicating a new segment).
         def _match_string(str)
           rp = @remaining_path
           if rp.start_with?("/#{str}")

data/spec/plugin/content_for_spec.rb

@@ -21,6 +21,9 @@ describe "content_for plugin with erb" do
         r.get 'b' do
           view(:inline => '<% content_for(:foo, "foo") %>bar', :layout => { :inline => '<%= yield %> <%= content_for(:foo) %>' })
         end
+        r.get 'e' do
+          view(:inline => 'a<% content_for :foo do %><% end %>b', :layout => { :inline => 'c<%= yield %>d<%= content_for(:foo) %>e' })
+        end
       end
     end
   end
@@ -36,6 +39,10 @@ describe "content_for plugin with erb" do
   it "should work if a raw string is set" do
     body('/b').strip.must_equal "bar foo"
   end
+
+  it "should work for an empty content_for" do
+    body('/e').strip.must_equal "cabde"
+  end
 end
 
 describe "content_for plugin with multiple calls to the same key" do

data/spec/plugin/public_spec.rb

@@ -75,5 +75,11 @@ describe "public plugin" do
     h = req('/about/_test.css', 'HTTP_ACCEPT_ENCODING'=>'deflate, gzip')[1]
     h['Content-Encoding'].must_equal 'gzip'
     h['Content-Type'].must_equal 'text/css'
+
+    s, h, b = req('/about/_test.css', 'HTTP_IF_MODIFIED_SINCE'=>h["Last-Modified"], 'HTTP_ACCEPT_ENCODING'=>'deflate, gzip')
+    s.must_equal 304
+    h['Content-Encoding'].must_be_nil
+    h['Content-Type'].must_be_nil
+    b.must_equal []
   end
 end

data/spec/plugin/request_aref_spec.rb

@@ -0,0 +1,51 @@
+require_relative "../spec_helper"
+
+describe "request_aref plugin" do 
+  def request_aref_app(value)
+    warning = @warning = String.new('')
+    app(:bare) do
+      plugin :request_aref, value
+      self::RodaRequest.send(:define_method, :warn){|s| warning.replace(s)}
+      route do |r|
+        r.get('set'){r['b'] = 'c'; r.params['b']}
+        r['a']
+      end
+    end
+  end
+
+  def aref_body
+    body("QUERY_STRING" => 'a=d', 'rack.input'=>StringIO.new)
+  end
+
+  def aset_body
+    body('/set', "QUERY_STRING" => 'a=d', 'rack.input'=>StringIO.new)
+  end
+
+  it "allows if given the :allow option" do
+    request_aref_app(:allow)
+    aref_body.must_equal 'd'
+    @warning.must_equal ''
+    aset_body.must_equal 'c'
+    @warning.must_equal ''
+  end
+
+  it "warns if given the :warn option" do
+    request_aref_app(:warn)
+    aref_body.must_equal 'd'
+    @warning.must_include('#[] is deprecated, use #params.[] instead')
+    aset_body.must_equal 'c'
+    @warning.must_include('#[]= is deprecated, use #params.[]= instead')
+  end
+
+  it "raises if given the :raise option" do
+    request_aref_app(:raise)
+    proc{aref_body}.must_raise Roda::RodaPlugins::RequestAref::Error
+    @warning.must_equal ''
+    proc{aset_body}.must_raise Roda::RodaPlugins::RequestAref::Error
+    @warning.must_equal ''
+  end
+
+  it "raises when loading plugin if given other option" do
+    proc{request_aref_app(:r)}.must_raise Roda::RodaError
+  end
+end

data/spec/views/about/_test.erb

@@ -0,0 +1 @@
+<h1>Subdir: <%= title %></h1>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -200,6 +200,7 @@ extra_rdoc_files:
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
+- doc/release_notes/3.5.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -246,6 +247,7 @@ files:
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
+- doc/release_notes/3.5.0.txt
 - lib/roda.rb
 - lib/roda/plugins/_symbol_regexp_matchers.rb
 - lib/roda/plugins/all_verbs.rb
@@ -309,6 +311,7 @@ files:
 - lib/roda/plugins/render.rb
 - lib/roda/plugins/render_each.rb
 - lib/roda/plugins/render_locals.rb
+- lib/roda/plugins/request_aref.rb
 - lib/roda/plugins/request_headers.rb
 - lib/roda/plugins/response_request.rb
 - lib/roda/plugins/run_append_slash.rb
@@ -403,6 +406,7 @@ files:
 - spec/plugin/render_each_spec.rb
 - spec/plugin/render_locals_spec.rb
 - spec/plugin/render_spec.rb
+- spec/plugin/request_aref_spec.rb
 - spec/plugin/request_headers_spec.rb
 - spec/plugin/response_request_spec.rb
 - spec/plugin/run_append_slash_spec.rb
@@ -435,6 +439,9 @@ files:
 - spec/views/a.erb
 - spec/views/about.erb
 - spec/views/about.str
+- spec/views/about/_test.css.gz
+- spec/views/about/_test.erb
+- spec/views/about/_test.erb.gz
 - spec/views/b.erb
 - spec/views/c.erb
 - spec/views/content-yield.erb