roda 3.13.0 → 3.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5b811d1ec0ddceb3a222c490b2af8e1488c6d454b637c7b6522962c149e6fd6
-  data.tar.gz: 0f3fad8d3d14f799fcc0e92a29bbc9210aadec3bade4bf68379409ce8780b29a
+  metadata.gz: fc2076279138faeeae9396e6cb397e5661de1ebe90517dc8bfcc0ab69c1c6a66
+  data.tar.gz: dbbd9323a8b414de60b4d2f4a6c5ca63ca7fbbf0cd4f9015fbbf82973500a8d6
 SHA512:
-  metadata.gz: 8de657deae4c712c6d18c329c1137e103b979d7c1c4e1f7a36fa9a72f3bd0c202610bc73e78b7ce30c80806adfcd19a67d42da0ce5ab4932e04a8df6aba7a54d
-  data.tar.gz: 66cc1c59eca2bc0fb7a5186fc353332ca630b255de48406429fbb1ecfb7a42253102d2616b98196c8e4bd608a335ea2ce7af973b5b15c6150fddfc124b7b7591
+  metadata.gz: ad3f3d6d15bdcf8d146a8f44f3f3a4e1599dd7ec15e0aa3b7a912e61fea72a7cb3d1d631f9c9943abf43a796bfd38c18a44184579f13456c2b943cdf3cf3f272
+  data.tar.gz: affb16c92264210bbbe62a4f059012a4242f821bef661c308050bb36815f5885eaa3c0dc0c59d312390330dcda91de511a8413be109608e1f39bce641d97c78b

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 3.14.0 (2018-11-16)
+
+* Add :raise option to convert!/convert_each! in the typecast_params plugin to support not raising for missing keys (celsworth) (#153)
+
+* Do not persist convert!/convert_each! :symbolize setting in the typecast_params plugin (jeremyevans)
+
 = 3.13.0 (2018-10-12)
 
 * Make Stream#write in streaming plugin return number of bytes written instead of self, so it works with IO.copy_stream (jeremyevans)

data/doc/release_notes/3.14.0.txt

@@ -0,0 +1,36 @@
+= New Features
+
+* The convert! and convert_each! methods in the typecast_params plugin
+  now support a :raise option for handling missing parameters specified
+  as arguments to the methods.
+  
+  If the :raise option is set to false for convert! and the parameter
+  argument is missing, then no conversion is done and an empty hash
+  is returned:
+
+    typecast_params.convert!('missing', raise: false) do |tp|
+      # ...
+    end
+    # => {}
+
+  If the :raise option is set to false for convert_each! and a :keys
+  option is given, any key not present is ignored and nil will be
+  returned for the converted value
+
+    typecast_params.convert_each!(:keys=>['present', 'missing'], raise: false) do |tp|
+      tp.int('b')
+    end
+    # => [{'b'=>1}, nil]
+
+= Other Improvements
+
+* The :symbolize setting to the convert! and convert_each! methods in
+  the typecast_params plugin is no longer persisted beyond the call
+  to the method.  This fixes unexpected behavior if you do:
+
+    typecast_params.convert!(:symbolize=>true) do |tp|
+      # ...
+    end
+    typecast_params.convert! do |tp|
+      # ...
+    end

data/lib/roda/plugins/typecast_params.rb

@@ -572,6 +572,7 @@ class Roda
         # or nil to convert the current object. If +keys+ is given as a hash, it is used as
         # the options hash. Options:
         #
+        # :raise :: If set to false, do not raise errors for missing keys
         # :symbolize :: Convert any string keys in the resulting hash and for any
         #               conversions below
         def convert!(keys=nil, opts=OPTS)
@@ -581,19 +582,19 @@ class Roda
           end
 
           _capture!(:nested_params, opts) do
-            if sub = subkey(Array(keys).dup, true)
+            if sub = subkey(Array(keys).dup, opts.fetch(:raise, true))
               yield sub
             end
           end
         end
 
-        # Runs convert! for each key specified by the :keys option.  If :keys option is not given
-        # and the object is an array, runs convert! for all entries in the array.  If the :keys
+        # Runs conversions similar to convert! for each key specified by the :keys option.  If :keys option is not given
+        # and the object is an array, runs conversions for all entries in the array.  If the :keys
         # option is not given and the object is a Hash with string keys '0', '1', ..., 'N' (with
-        # no skipped keys), runs convert! for all entries in the hash.  If :keys option is a Proc
+        # no skipped keys), runs conversions for all entries in the hash.  If :keys option is a Proc
         # or a Method, calls the proc/method with the current object, which should return an
         # array of keys to use.
-        # Passes any options given to #convert!.  Options:
+        # Supports options given to #convert!, and this additional option:
         #
         # :keys :: The keys to extract from the object. If a proc or method,
         #          calls the value with the current object, which should return the array of keys
@@ -628,7 +629,7 @@ class Roda
 
             keys.map do |i|
               begin
-                if v = subkey([i], true)
+                if v = subkey([i], opts.fetch(:raise, true))
                   yield v
                   v.nested_params if np 
                 end
@@ -692,6 +693,8 @@ class Roda
 
         # Recursively descendent into all known subkeys and get the converted params from each.
         def nested_params
+          return @nested_params if @nested_params
+
           params = @params
 
           if @subs
@@ -762,6 +765,8 @@ class Roda
 
         # Internals of convert! and convert_each!.
         def _capture!(ret, opts)
+          previous_symbolize = @symbolize
+
           unless cap = @capture
             @params = @obj.class.new
             @subs.clear if @subs
@@ -793,10 +798,18 @@ class Roda
             end
           end
         ensure
-          # Only unset capturing if capturing was not already started.
+          @nested_params = nil
+
           if capturing_started
+            # Unset capturing if capturing was not already started.
             @capture = nil
+          else
+            # If capturing was already started, update cached nested params
+            # before resetting symbolize setting. 
+            @nested_params = nested_params
           end
+
+          @symbolize = previous_symbolize
         end
 
         # Raise an error if the array given does contains nil values.

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

data/spec/plugin/mailer_spec.rb

@@ -102,7 +102,7 @@ describe "mailer plugin" do
     m.attachments.first.content_type.must_match(/mailer_spec\.rb/)
     m.content_type.must_match(/\Amultipart\/mixed/)
     m.parts.length.must_equal 1
-    m.parts.first.body.must_be :==, File.read(__FILE__)
+    m.parts.first.body.decoded.gsub("\r\n", "\n").must_equal File.read(__FILE__)
   end
 
   it "supports attachments with blocks" do
@@ -120,7 +120,7 @@ describe "mailer plugin" do
     m.attachments.first.content_type.must_equal 'text/foo'
     m.content_type.must_match(/\Amultipart\/mixed/)
     m.parts.length.must_equal 1
-    m.parts.first.body.must_be :==, File.read(__FILE__)
+    m.parts.first.body.decoded.gsub("\r\n", "\n").must_equal File.read(__FILE__)
   end
 
   it "supports plain-text attachments with an email body" do
@@ -242,7 +242,7 @@ describe "mailer plugin" do
     m.parts.first.content_type.must_match(/\Atext\/html/)
     m.parts.first.body.must_be :==, "a"
     m.parts.last.content_type.must_match(/\Atext\/css/)
-    m.parts.last.body.must_be :==, File.read('spec/assets/css/raw.css')
+    m.parts.last.body.decoded.gsub("\r\n", "\n").must_equal File.read('spec/assets/css/raw.css')
   end
 end
 end

data/spec/plugin/typecast_params_spec.rb

@@ -530,6 +530,24 @@ describe "typecast_params plugin" do
     end.must_equal('a'=>[{'b'=>[{'e'=>1}]}])
   end
 
+  it "#convert! should not raise errors for missing keys if :raise option is false" do
+    tp = tp('a[b]=1')
+    tp.convert! do |tp0|
+      tp0.convert!('a') do |tp1|
+        tp1.convert!('c', :raise=>false) do |tp2|
+          tp2.convert!('d') do |tp2|
+          end
+        end
+      end
+    end.must_equal('a'=>{})
+
+    tp.convert!('b', :raise=>false){}.must_equal({})
+
+    tp.convert!('b', :raise=>false) do |tp0|
+        tp1.convert!('c'){}
+    end.must_equal({})
+  end
+
   it "#convert! should handle #[] without #convert! at each level" do
     tp = tp('a[b][c][d][e]=1')
     tp.convert! do |tp0|
@@ -585,6 +603,19 @@ describe "typecast_params plugin" do
     end.must_equal('a'=>[1], 'd'=>[2], 'g'=>[nil])
   end
 
+  it "#convert! should handle multiple convert! calls inside" do
+    tp = tp('a[b]=1&c[d]=2')
+    tp.convert! do |tp0|
+      tp0.convert!('a'){|d| d.int('b')}
+      tp0.convert!('c'){|d| d.int('d')}
+    end.must_equal('a'=>{'b'=>1}, 'c'=>{'d'=>2})
+
+    tp.convert!(:symbolize=>true) do |tp0|
+      tp0.convert!('a'){|d| d.int('b')}
+      tp0.convert!('c'){|d| d.int('d')}
+    end.must_equal(:a=>{:b=>1}, :c=>{:d=>2})
+  end
+
   it "#convert_each! should convert each entry in an array" do
     tp = tp('a[][b]=1&a[][c]=2&a[][b]=3&a[][c]=4')
     tp['a'].convert_each! do |tp0|
@@ -652,6 +683,13 @@ describe "typecast_params plugin" do
     lambda{tp['b'].convert_each!{}}.must_raise @tp_error
   end
 
+  it "#convert_each! should not raise errors for missing keys if :raise option is false" do
+    tp = tp('a[0][b]=1&a[0][c]=2&a[1][b]=3&a[1][c]=4')
+    tp['a'].convert_each!(:keys=>%w'0 2', :raise=>false) do |tp0|
+      tp0.int(%w'b c')
+    end.must_equal [{'b'=>1, 'c'=>2}, nil]
+  end
+
   it "#convert! with :symbolize option should return a hash of converted parameters" do
     tp = tp()
     tp.convert!(:symbolize=>true) do |ptp|
@@ -663,6 +701,25 @@ describe "typecast_params plugin" do
     end.must_equal(:a=>1, :b=>[2, 3], :c=>{:d=>4, :e=>5})
   end
 
+  it "#convert! with :symbolize option should not persist" do
+    tp = tp()
+    tp.convert!(:symbolize=>true) do |ptp|
+      ptp.int!('a')
+      ptp.array!(:int, 'b')
+      ptp['c'].convert! do |stp|
+        stp.int!(%w'd e')
+      end
+    end.must_equal(:a=>1, :b=>[2, 3], :c=>{:d=>4, :e=>5})
+
+    tp.convert! do |ptp|
+      ptp.int!('a')
+      ptp.array!(:int, 'b')
+      ptp['c'].convert! do |stp|
+        stp.int!(%w'd e')
+      end
+    end.must_equal("a"=>1, "b"=>[2, 3], "c"=>{"d"=>4, "e"=>5})
+  end
+
   it "#convert! with :symbolize option hash should only include changes made inside block" do
     tp = tp()
     tp.convert!(:symbolize=>true) do |ptp|
@@ -782,6 +839,18 @@ describe "typecast_params plugin" do
     end.must_equal(:a=>{:'0'=>{:b=>1, :c=>2}, :'1'=>{:b=>3, :c=>4}})
   end
 
+  it "#convert_each! with :symbolize option should not persist" do
+    tp = tp('a[][b]=1&a[][c]=2&a[][b]=3&a[][c]=4')
+    tp['a'].convert_each!(:symbolize=>true) do |tp0|
+      tp0.int(%w'b c')
+    end.must_equal [{:b=>1, :c=>2}, {:b=>3, :c=>4}]
+
+    tp = tp('a[][b]=1&a[][c]=2&a[][b]=3&a[][c]=4')
+    tp['a'].convert_each! do |tp0|
+      tp0.int(%w'b c')
+    end.must_equal [{'b'=>1, 'c'=>2}, {'b'=>3, 'c'=>4}]
+  end
+
   it "#convert! with :symbolize options specified at different levels should work" do
     tp = tp('a[b][c][d][e]=1')
     tp.convert!(:symbolize=>true) do |tp0|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.13.0
+  version: 3.14.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-12 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -209,6 +209,7 @@ extra_rdoc_files:
 - doc/release_notes/3.11.0.txt
 - doc/release_notes/3.12.0.txt
 - doc/release_notes/3.13.0.txt
+- doc/release_notes/3.14.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -256,6 +257,7 @@ files:
 - doc/release_notes/3.11.0.txt
 - doc/release_notes/3.12.0.txt
 - doc/release_notes/3.13.0.txt
+- doc/release_notes/3.14.0.txt
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt