roda 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0422791db9ddee07b535f5429fd17ae5f312c7e5c7519dfbe0288e1d285919
-  data.tar.gz: 905f19053a3997fc7c3c4e4b942b73cd2400cb59df641cb4a86b23191cab873c
+  metadata.gz: f461d51ffcff3abee852c79773a13d87f2ffc5fea2c6a27346bfb2755b318e1e
+  data.tar.gz: c30fafc14125ef2b100bce74762193cb0f09776805732c284b7d7cd0472f07c5
 SHA512:
-  metadata.gz: 10aff2c1df661f7cb2699cb3f49bf521587813017ca5cc5c1117c629f04805075e185170305cc012cbbdc2c4ecae59902f73efab1ff39806d3f9548acc918d8b
-  data.tar.gz: d6b70c570f4e198b743ecb4f216f600ad09b8010d6e1df1c202873b843846d1fac3c817dfd848fc7509efc4ba8f41d5907c4273187871ab8293810dc307018e5
+  metadata.gz: 428d1c607d27a5f90b4c5c992e8f8f3ea33cf8dd7c49e2a0920e49e4b97de34532eb9177aae04ad1efa9a229d747a6e5a744334ae803edbaf60e1e51cf154552
+  data.tar.gz: dd85d32aedb8b2c09fc757bd1cbc0f92dce99849841e4ab2e78f47589de8670c87023eb9d6a144efd1c7ff06f08f705589e2510cb7c4383cba13b40020b2d489

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 3.6.0 (2018-03-26)
+
+* Add :wrap option to json_parser plugin, for whether/how to wrap the uploaded JSON object (jeremyevans) (#142)
+
+* Add :early_hints option to the assets plugin, for supporting sending early hints for calls to assets (jeremyevans)
+
+* Add early_hints plugin for sending 103 Early Hint responses, currently only working on puma (jeremyevans)
+
 = 3.5.0 (2018-02-14)
 
 * Add request_aref plugin for configuring behavior of request [] and []= methods (jeremyevans)

data/doc/release_notes/3.6.0.txt

@@ -0,0 +1,21 @@
+= New Features
+
+* An early_hints plugin has been added for senting 103 Early Hint
+  responses.  This is currently only supported on puma 3.11+, and
+  can allow for improved performance by letting the requestor know
+  which related files will be needed by the request.
+
+* An :early_hints option has been added to the assets plugin.  If
+  given, calling the assets method will also issue an early hint
+  for the related assets.
+
+* A :wrap option has been added to the json_parser plugin.  If set
+  to :always, all uploaded json data will be stored using a hash
+  with a "_json" key.  If set to :unless_hash, uploaded json data
+  will only be wrapped in such a matter if it is not already a hash.
+
+  Using the :wrap option can fix problems when using r.params when
+  the uploaded JSON data is an array and not a hash.  However, it
+  does change the behavior of r.POST.  It is possible to handle
+  uploaded JSON array data without the :wrap option by using r.GET
+  and r.POST directly instead of using r.params.

data/lib/roda/plugins/assets.rb

@@ -267,6 +267,7 @@ class Roda
     # :dependencies :: A hash of dependencies for your asset files.  Keys should be paths to asset files,
     #                  values should be arrays of paths your asset files depends on.  This is used to
     #                  detect changes in your asset files.
+    # :early_hints :: Automatically send early hints for all assets.  Requires the early_hints plugin.
     # :group_subdirs :: Whether a hash used in :css and :js options requires the assets for the
     #                   related group are contained in a subdirectory with the same name (default: true)
     # :gzip :: Store gzipped compiled assets files, and serve those to clients who accept gzip encoding.
@@ -307,6 +308,7 @@ class Roda
         :concat_only      => false,
         :compiled         => false,
         :add_suffix       => false,
+        :early_hints      => false,
         :timestamp_paths  => false,
         :group_subdirs    => true,
         :compiled_css_dir => nil,
@@ -369,6 +371,10 @@ class Roda
           opts[:compiled] = ::JSON.parse(::File.read(opts[:precompiled]))
         end
 
+        if opts[:early_hints]
+          app.plugin :early_hints
+        end
+
         DEFAULTS.each do |k, v|
           opts[k] = v unless opts.has_key?(k)
         end
@@ -661,7 +667,12 @@ class Roda
             tag_end = "\" />"
           end
 
-          assets_paths(type).map{|p| "#{tag_start}#{h(p)}#{tag_end}"}.join("\n")
+          paths = assets_paths(type)
+          if o[:early_hints]
+            early_hint_as = ltype == :js ? 'script' : 'style'
+            send_early_hints('Link'=>paths.map{|p| "<#{p}>; rel=preload; as=#{early_hint_as}"}.join("\n"))
+          end
+          paths.map{|p| "#{tag_start}#{h(p)}#{tag_end}"}.join("\n")
         end
 
         # Render the asset with the given filename.  When assets are compiled,

data/lib/roda/plugins/early_hints.rb

@@ -0,0 +1,26 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The early_hints plugin allows sending 103 Early Hints responses
+    # using the rack.early_hints environment variable.  Currently, this
+    # is only supported by puma 3.11+, and on other servers this is a no-op.
+    # Early hints allow clients to preload necessary files before receiving
+    # the response.
+    module EarlyHints
+      module InstanceMethods
+        # Send given hash of Early Hints using the rack.early_hints environment variable,
+        # currenly only supported by puma.  hash given should generally have the single
+        # key 'Link', and a string or array of strings for each of the early hints.
+        def send_early_hints(hash)
+          if eh_proc = env['rack.early_hints']
+            eh_proc.call(hash)
+          end
+        end
+      end
+    end
+
+    register_plugin(:early_hints, EarlyHints)
+  end
+end

data/lib/roda/plugins/json_parser.rb

@@ -25,10 +25,24 @@ class Roda
       # :include_request :: If true, the parser will be called with the request
       #                     object as the second argument, so the parser needs
       #                     to respond to +call(str, request)+.
+      # :wrap :: Whether to wrap uploaded JSON data in a hash with a "_json"
+      #          key.  Without this, calls to r.params will fail if a non-Hash
+      #          (such as an array) is uploaded in JSON format.  A value of
+      #          :always will wrap all values, and a value of :unless_hash will
+      #          only wrap values that are not already hashes.
       def self.configure(app, opts=OPTS)
         app.opts[:json_parser_error_handler] = opts[:error_handler] || app.opts[:json_parser_error_handler] || DEFAULT_ERROR_HANDLER
         app.opts[:json_parser_parser] = opts[:parser] || app.opts[:json_parser_parser] || DEFAULT_PARSER
         app.opts[:json_parser_include_request] = opts[:include_request] if opts.has_key?(:include_request)
+
+        case opts[:wrap]
+        when :unless_hash, :always
+          app.opts[:json_parser_wrap] = opts[:wrap]
+        when nil
+          # Nothing
+        else
+          raise RodaError, "unsupported option value for json_parser plugin :wrap option: #{opts[:wrap].inspect} (should be :unless_hash or :always)"
+        end
       end
 
       module RequestMethods
@@ -43,10 +57,16 @@ class Roda
             input.rewind
             return super if str.empty?
             begin
-              json_params = env["roda.json_params"] = parse_json(str)
+              json_params = parse_json(str)
             rescue
               roda_class.opts[:json_parser_error_handler].call(self)
             end
+
+            wrap = roda_class.opts[:json_parser_wrap]
+            if wrap == :always || (wrap == :unless_hash && !json_params.is_a?(Hash))
+              json_params = {"_json"=>json_params}
+            end
+            env["roda.json_params"] = json_params
             env["rack.request.form_input"] = input
             json_params
           else

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 = 5
+  RodaMinorVersion = 6
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/assets_spec.rb

@@ -196,6 +196,27 @@ if run_tests
       js.must_include('console.log')
     end
 
+    it 'should handle early hints if the :early_hints option is used' do
+      app.plugin :assets, :early_hints=>true
+      eh = []
+      html = body('/test', 'rack.early_hints'=>proc{|h| eh << h})
+      eh.must_equal [
+        {"Link"=>"</assets/css/app.scss>; rel=preload; as=style\n</assets/css/raw.css>; rel=preload; as=style"},
+        {"Link"=>"</assets/js/head/app.js>; rel=preload; as=script"}
+      ]
+      html.scan(/<link/).length.must_equal 2
+      html =~ %r{href="(/assets/css/app\.scss)"}
+      css = body($1)
+      html =~ %r{href="(/assets/css/raw\.css)"}
+      css2 = body($1)
+      html.scan(/<script/).length.must_equal 1
+      html =~ %r{src="(/assets/js/head/app\.js)"}
+      js = body($1)
+      css.must_match(/color: red;/)
+      css2.must_match(/color: blue;/)
+      js.must_include('console.log')
+    end
+
     it 'should handle rendering assets, linking to them, and accepting requests for them when :add_script_name app option is used' do
       app.opts[:add_script_name] = true
       app.plugin :assets

data/spec/plugin/early_hints_spec.rb

@@ -0,0 +1,19 @@
+require_relative "../spec_helper"
+
+describe "early_hints plugin" do 
+  it "allows sending early hints to rack.early_hints" do
+    queue = []
+    app(:early_hints) do |r|
+      send_early_hints('Link'=>'</foo.js>; rel=preload; as=script')
+      queue << 'OK'
+      'OK'
+    end
+
+    body.must_equal 'OK'
+    queue.must_equal ['OK']
+
+    queue = []
+    body('rack.early_hints'=>proc{|h| queue << h}).must_equal 'OK'
+    queue.must_equal [{'Link'=>'</foo.js>; rel=preload; as=script'}, 'OK']
+  end
+end

data/spec/plugin/json_parser_spec.rb

@@ -18,6 +18,12 @@ describe "json_parser plugin" do
   it "returns 400 for invalid json" do
     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')
+    end.must_raise
+  end
 end
 
 describe "json_parser plugin" do 
@@ -28,6 +34,45 @@ describe "json_parser plugin" do
     body('rack.input'=>StringIO.new(''), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal '0'
   end
 
+  it "handles arrays and other non-hash values using r.POST" do
+    app(:json_parser) do |r|
+      r.POST.inspect
+    end
+    body('rack.input'=>StringIO.new('[ 1 ]'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal '[1]'
+  end
+
+  it "supports :wrap=>:always option" do
+    app(:bare) do
+      plugin(:json_parser, :wrap=>:always)
+      route do |r|
+        r.post 'a' do r.params['_json']['a']['b'].to_s end
+        r.params['_json'][1].to_s
+      end
+    end
+    body('/a', 'rack.input'=>StringIO.new('{"a":{"b":1}}'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal '1'
+    body('rack.input'=>StringIO.new('[true, 2]'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal '2'
+  end
+
+  it "supports :wrap=>:unless_hash option" do
+    app(:bare) do
+      plugin(:json_parser, :wrap=>:unless_hash)
+      route do |r|
+        r.post 'a' do r.params['a']['b'].to_s end
+        r.params['_json'][1].to_s
+      end
+    end
+    body('/a', 'rack.input'=>StringIO.new('{"a":{"b":1}}'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal '1'
+    body('rack.input'=>StringIO.new('[true, 2]'), 'CONTENT_TYPE'=>'text/json', 'REQUEST_METHOD'=>'POST').must_equal '2'
+  end
+
+  it "raises for unsupported :wrap option" do
+    proc do 
+      app(:bare) do
+        plugin(:json_parser, :wrap=>:foo)
+      end
+    end.must_raise Roda::RodaError
+  end
+
   it "supports :error_handler option" do
     app(:bare) do
       plugin(:json_parser, :error_handler=>proc{|r| r.halt [401, {}, ['bad']]})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -201,6 +201,7 @@ extra_rdoc_files:
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
+- doc/release_notes/3.6.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -248,6 +249,7 @@ files:
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
+- doc/release_notes/3.6.0.txt
 - lib/roda.rb
 - lib/roda/plugins/_symbol_regexp_matchers.rb
 - lib/roda/plugins/all_verbs.rb
@@ -269,6 +271,7 @@ files:
 - lib/roda/plugins/delete_empty_headers.rb
 - lib/roda/plugins/disallow_file_uploads.rb
 - lib/roda/plugins/drop_body.rb
+- lib/roda/plugins/early_hints.rb
 - lib/roda/plugins/empty_root.rb
 - lib/roda/plugins/environments.rb
 - lib/roda/plugins/error_email.rb
@@ -364,6 +367,7 @@ files:
 - spec/plugin/delete_empty_headers_spec.rb
 - spec/plugin/disallow_file_uploads_spec.rb
 - spec/plugin/drop_body_spec.rb
+- spec/plugin/early_hints_spec.rb
 - spec/plugin/empty_root_spec.rb
 - spec/plugin/environments_spec.rb
 - spec/plugin/error_email_spec.rb