roda 3.26.0 → 3.27.0

data/lib/roda/response.rb

@@ -0,0 +1,172 @@
+# frozen-string-literal: true
+
+class Roda
+  # Base class used for Roda responses.  The instance methods for this
+  # class are added by Roda::RodaPlugins::Base::ResponseMethods, the class
+  # methods are added by Roda::RodaPlugins::Base::ResponseClassMethods.
+  class RodaResponse
+    @roda_class = ::Roda
+  end
+
+  module RodaPlugins
+    module Base
+      # Class methods for RodaResponse
+      module ResponseClassMethods
+        # Reference to the Roda class related to this response class.
+        attr_accessor :roda_class
+
+        # Since RodaResponse is anonymously subclassed when Roda is subclassed,
+        # and then assigned to a constant of the Roda subclass, make inspect
+        # reflect the likely name for the class.
+        def inspect
+          "#{roda_class.inspect}::RodaResponse"
+        end
+      end
+
+      # Instance methods for RodaResponse
+      module ResponseMethods
+        DEFAULT_HEADERS = {"Content-Type" => "text/html".freeze}.freeze
+
+        # The body for the current response.
+        attr_reader :body
+
+        # The hash of response headers for the current response.
+        attr_reader :headers
+
+        # The status code to use for the response.  If none is given, will use 200
+        # code for non-empty responses and a 404 code for empty responses.
+        attr_accessor :status
+
+        # Set the default headers when creating a response.
+        def initialize
+          @headers = {}
+          @body    = []
+          @length  = 0
+        end
+
+        # Return the response header with the given key. Example:
+        #
+        #   response['Content-Type'] # => 'text/html'
+        def [](key)
+          @headers[key]
+        end
+
+        # Set the response header with the given key to the given value.
+        #
+        #   response['Content-Type'] = 'application/json'
+        def []=(key, value)
+          @headers[key] = value
+        end
+
+        # The default headers to use for responses.
+        def default_headers
+          DEFAULT_HEADERS
+        end
+
+        # Whether the response body has been written to yet.  Note
+        # that writing an empty string to the response body marks
+        # the response as not empty. Example:
+        #
+        #   response.empty? # => true
+        #   response.write('a')
+        #   response.empty? # => false
+        def empty?
+          @body.empty?
+        end
+
+        # Return the rack response array of status, headers, and body
+        # for the current response.  If the status has not been set,
+        # uses the return value of default_status if the body has
+        # been written to, otherwise uses a 404 status.
+        # Adds the Content-Length header to the size of the response body.
+        #
+        # Example:
+        #
+        #   response.finish
+        #   #  => [200,
+        #   #      {'Content-Type'=>'text/html', 'Content-Length'=>'0'},
+        #   #      []]
+        def finish
+          b = @body
+          set_default_headers
+          h = @headers
+
+          if b.empty?
+            s = @status || 404
+            if (s == 304 || s == 204 || (s >= 100 && s <= 199))
+              h.delete("Content-Type")
+            elsif s == 205
+              h.delete("Content-Type")
+              h["Content-Length"] = '0'
+            else
+              h["Content-Length"] ||= '0'
+            end
+          else
+            s = @status || default_status
+            h["Content-Length"] ||= @length.to_s
+          end
+
+          [s, h, b]
+        end
+
+        # Return the rack response array using a given body.  Assumes a
+        # 200 response status unless status has been explicitly set,
+        # and doesn't add the Content-Length header or use the existing
+        # body.
+        def finish_with_body(body)
+          set_default_headers
+          [@status || default_status, @headers, body]
+        end
+
+        # Return the default response status to be used when the body
+        # has been written to. This is split out to make overriding
+        # easier in plugins.
+        def default_status
+          200
+        end
+
+        # Show response class, status code, response headers, and response body
+        def inspect
+          "#<#{self.class.inspect} #{@status.inspect} #{@headers.inspect} #{@body.inspect}>"
+        end
+
+        # Set the Location header to the given path, and the status
+        # to the given status.  Example:
+        #
+        #   response.redirect('foo', 301)
+        #   response.redirect('bar')
+        def redirect(path, status = 302)
+          @headers["Location"] = path
+          @status  = status
+          nil
+        end
+
+        # Return the Roda class related to this response.
+        def roda_class
+          self.class.roda_class
+        end
+
+        # Write to the response body.  Returns nil.
+        #
+        #   response.write('foo')
+        def write(str)
+          s = str.to_s
+          @length += s.bytesize
+          @body << s
+          nil
+        end
+
+        private
+
+        # For each default header, if a header has not already been set for the
+        # response, set the header in the response.
+        def set_default_headers
+          h = @headers
+          default_headers.each do |k,v|
+            h[k] ||= v
+          end
+        end
+      end
+    end
+  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 = 26
+  RodaMinorVersion = 27
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/define_roda_method_spec.rb

@@ -2,7 +2,7 @@ require_relative "spec_helper"
 
 describe "Roda.define_roda_method" do
   before do
-    @scope = app.new({})
+    @scope = app.new({'PATH_INFO'=>'/'})
   end
 
   it "should define methods using block" do

data/spec/plugin/json_parser_spec.rb

@@ -19,6 +19,11 @@ describe "json_parser plugin" do
     req('rack.input'=>StringIO.new('{"a":{"b":1}'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal [400, {}, []]
   end
 
+  it "returns 400 for invalid json when using params_capturing plugin" do
+    @app.plugin :params_capturing
+    req('rack.input'=>StringIO.new('{"a":{"b":1}'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal [400, {}, []]
+  end
+
   it "raises by default if r.params is called and a non-hash is submitted" do
     proc do
       req('rack.input'=>StringIO.new('[1]'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST')

data/spec/plugin/multibyte_string_matcher_spec.rb

@@ -0,0 +1,44 @@
+require_relative "../spec_helper"
+
+describe "multibyte_string_matcher plugin" do 
+  it "uses multibyte safe string matching" do
+    str = "\xD0\xB8".dup.force_encoding('UTF-8')
+    app(:unescape_path) do |r|
+      r.is String do |s|
+        s
+      end
+
+      r.is(Integer, /(#{str})/u) do |_, a|
+        a
+      end
+
+      r.is(Integer, Integer, str) do
+        'm'
+      end
+
+      r.is(Integer, str, Integer) do
+        'n'
+      end
+    end
+
+    body('/%D0%B8').must_equal str
+    body('/1/%D0%B8').must_equal str
+    status('/1/2/%D0%B8').must_equal 404
+    status('/1/%D0%B8/2').must_equal 404
+
+    status('/1/%D0%B9').must_equal 404
+    status('/1/2/%D0%B9').must_equal 404
+    status('/1/%D0%B9/2').must_equal 404
+
+    @app.plugin :multibyte_string_matcher
+
+    body('/%D0%B8').must_equal str
+    body('/1/%D0%B8').must_equal str
+    body('/1/2/%D0%B8').must_equal 'm'
+    body('/1/%D0%B8/2').must_equal 'n'
+
+    status('/1/%D0%B9').must_equal 404
+    status('/1/2/%D0%B9').must_equal 404
+    status('/1/%D0%B9/2').must_equal 404
+  end
+end

data/spec/plugin/sinatra_helpers_spec.rb

@@ -228,7 +228,7 @@ describe "sinatra_helpers plugin" do
 
   describe 'mime_type' do
     before do
-      sin_app{|r| mime_type(r.path).to_s}
+      sin_app{|r| mime_type((r.path unless r.path.empty?)).to_s}
     end
 
     it "looks up mime types in Rack's MIME registry" do
@@ -238,7 +238,7 @@ describe "sinatra_helpers plugin" do
     end
 
     it 'returns nil when given nil' do
-      body('PATH_INFO'=>nil).must_equal ''
+      body('PATH_INFO'=>'').must_equal ''
     end
 
     it 'returns nil when media type not registered' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.26.0
+  version: 3.27.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-18 00:00:00.000000000 Z
+date: 2019-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -237,6 +237,7 @@ extra_rdoc_files:
 - doc/release_notes/3.24.0.txt
 - doc/release_notes/3.25.0.txt
 - doc/release_notes/3.26.0.txt
+- doc/release_notes/3.27.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -299,6 +300,7 @@ files:
 - doc/release_notes/3.24.0.txt
 - doc/release_notes/3.25.0.txt
 - doc/release_notes/3.26.0.txt
+- doc/release_notes/3.27.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
@@ -307,6 +309,8 @@ files:
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
 - lib/roda.rb
+- lib/roda/cache.rb
+- lib/roda/plugins.rb
 - lib/roda/plugins/_after_hook.rb
 - lib/roda/plugins/_before_hook.rb
 - lib/roda/plugins/_symbol_regexp_matchers.rb
@@ -361,6 +365,7 @@ files:
 - lib/roda/plugins/multi_route.rb
 - lib/roda/plugins/multi_run.rb
 - lib/roda/plugins/multi_view.rb
+- lib/roda/plugins/multibyte_string_matcher.rb
 - lib/roda/plugins/named_templates.rb
 - lib/roda/plugins/not_allowed.rb
 - lib/roda/plugins/not_found.rb
@@ -404,6 +409,8 @@ files:
 - lib/roda/plugins/typecast_params.rb
 - lib/roda/plugins/unescape_path.rb
 - lib/roda/plugins/view_options.rb
+- lib/roda/request.rb
+- lib/roda/response.rb
 - lib/roda/session_middleware.rb
 - lib/roda/version.rb
 - spec/all.rb
@@ -470,6 +477,7 @@ files:
 - spec/plugin/multi_route_spec.rb
 - spec/plugin/multi_run_spec.rb
 - spec/plugin/multi_view_spec.rb
+- spec/plugin/multibyte_string_matcher_spec.rb
 - spec/plugin/named_templates_spec.rb
 - spec/plugin/not_allowed_spec.rb
 - spec/plugin/not_found_spec.rb