roda 3.14.1 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32418c43dd47ff54b3e1d3d79b295735d7218e51aa902303bf01bef035aeb049
-  data.tar.gz: 45ea8f26e268865fc8d958496782f0bf23e02a2168e32edb29229840a80de99c
+  metadata.gz: 3a3a695566853202815ee8857b9f2276b06d97204c98b06985d2a78c1a535dab
+  data.tar.gz: 700b5fbd7c73c2ed9a3f758ddae5476f1428659a39142ab2ce6b155c1cab197d
 SHA512:
-  metadata.gz: 1b0e1b07e0e163a1557800e3d5023f05c84e3e80d39f90fba944ec8a147a0edb4bc411100a069a5f52d498603a8b22955793b56ac676c0e8d02d246f4870f7dd
-  data.tar.gz: 446371d8436c08d79cb4947f005877514471f02bfa700c519715fd64f1e5c851c9865b281bbf24e267cf03cbfd7d3670601b72b8d4fcabc44dbb4a23b0e4549b
+  metadata.gz: cc207cd02ca21544f435e6a6d22420915087c1418ede8fe5a5468267e1df070354199c5d13b41a41c7900a20608b7ce020bb1af8bdcb495a2751b34a3826254b
+  data.tar.gz: 2685a3c79454feb84de1c58137f8488f82f8b17f89f9f61973bd62ed0ce62ea460f91d871b4b80b83dca21ecb0e0cc073d6a54a148f098e845e8250f92d583cf

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 3.15.0 (2018-12-14)
+
+* Support render plugin :escape option to be a string or array of strings and only add :escape option for those template engines (jeremyevans) (#158)
+
+* Add :skip_missing option to convert!/convert_each! in the typecast_params plugin to support not storing keys not present in params (jeremyevans)
+
 = 3.14.1 (2018-11-29)
 
 * SECURITY: content_for plugin no longer post-processes block result with template engine (jeremyevans)

data/doc/release_notes/3.15.0.txt

@@ -0,0 +1,21 @@
+= New Features
+
+* The render plugin :escape option value can now be a string or an
+  array of strings, and then the plugin will will only add the
+  :escape template option for those specific template engines given.
+  By default, the :escape plugin option adds the :escape template
+  option for all engines, which breaks the usage with some engines
+  (such as the rcsv engine).
+
+* The convert! and convert_each! methods in the typecast_params plugin
+  now support a :skip_missing option to support not storing missing
+  parameters:
+
+    typecast_params.convert! do |tp|
+      tp.int('missing')
+    end
+    # => {'missing'=>nil}
+    typecast_params.convert!(skip_missing: false) do |tp|
+      tp.int('missing')
+    end
+    # => {}

data/lib/roda/plugins/render.rb

@@ -56,6 +56,10 @@ class Roda
     #            templates, defaults to 'erb'.
     # :escape :: Use Erubi as the ERB template engine, and enable escaping by default,
     #            which makes <tt><%= %></tt> escape output and  <tt><%== %></tt> not escape output.
+    #            If given, sets the <tt>:escape=>true</tt> option for all template engines, which
+    #            can break some non-ERB template engines.  You can use a string or array of strings
+    #            as the value for this option to only set the <tt>:escape=>true</tt> option for those
+    #            specific template engines.
     # :layout :: The base name of the layout file, defaults to 'layout'.  This can be provided as a hash
     #            with the :template or :inline options.
     # :layout_opts :: The options to use when rendering the layout, if different from the default options.
@@ -184,18 +188,26 @@ class Roda
           template_opts[:default_encoding] = Encoding.default_external
         end
 
-        if opts[:escape]
-          require 'tilt/erubi'
-          template_opts[:escape] = true
-        end
-        template_opts.freeze
-
         engine_opts = opts[:engine_opts] = (opts[:engine_opts] || {}).dup
         engine_opts.to_a.each do |k,v|
           engine_opts[k] = v.dup.freeze
         end
-        engine_opts.freeze
 
+        if escape = opts[:escape]
+          require 'tilt/erubi'
+
+          case escape
+          when String, Array
+            Array(escape).each do |engine|
+              engine_opts[engine] = (engine_opts[engine] || {}).merge(:escape => true).freeze
+            end
+          else
+            template_opts[:escape] = true
+          end
+        end
+
+        template_opts.freeze
+        engine_opts.freeze
         opts.freeze
       end
 

data/lib/roda/plugins/typecast_params.rb

@@ -557,7 +557,7 @@ class Roda
           end
 
           @subs[key] = sub
-          sub.sub_capture(@capture, @symbolize)
+          sub.sub_capture(@capture, @symbolize, @skip_missing)
           sub
         end
 
@@ -573,6 +573,8 @@ class Roda
         # the options hash. Options:
         #
         # :raise :: If set to false, do not raise errors for missing keys
+        # :skip_missing :: If set to true, does not store values if the key is not
+        #                  present in the params.
         # :symbolize :: Convert any string keys in the resulting hash and for any
         #               conversions below
         def convert!(keys=nil, opts=OPTS)
@@ -748,9 +750,10 @@ class Roda
         end
 
         # Inherit given capturing and symbolize setting from parent object.
-        def sub_capture(capture, symbolize)
+        def sub_capture(capture, symbolize, skip_missing)
           if @capture = capture
             @symbolize = symbolize
+            @skip_missing = skip_missing
             @params = @obj.class.new
           end
         end
@@ -766,6 +769,7 @@ class Roda
         # Internals of convert! and convert_each!.
         def _capture!(ret, opts)
           previous_symbolize = @symbolize
+          previous_skip_missing = @skip_missing
 
           unless cap = @capture
             @params = @obj.class.new
@@ -777,6 +781,9 @@ class Roda
           if opts.has_key?(:symbolize)
             @symbolize = !!opts[:symbolize]
           end
+          if opts.has_key?(:skip_missing)
+            @skip_missing = !!opts[:skip_missing]
+          end
 
           begin
             v = yield
@@ -810,6 +817,7 @@ class Roda
           end
 
           @symbolize = previous_symbolize
+          @skip_missing = previous_skip_missing
         end
 
         # Raise an error if the array given does contains nil values.
@@ -906,7 +914,9 @@ class Roda
 
             if @capture
               key = key.to_sym if symbolize?
-              @params[key] = v
+              if !@skip_missing || @obj.has_key?(key)
+                @params[key] = v
+              end
             end
 
             v

data/lib/roda/version.rb

@@ -4,11 +4,11 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 14
+  RodaMinorVersion = 15
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.
-  RodaPatchVersion = 1
+  RodaPatchVersion = 0
 
   # The full version of Roda as a string.
   RodaVersion = "#{RodaMajorVersion}.#{RodaMinorVersion}.#{RodaPatchVersion}".freeze

data/spec/plugin/render_spec.rb

@@ -632,7 +632,7 @@ describe ":render plugin :escape option" do
 
   it "should escape inside <%= %> and not inside <%== %>, and handle postfix conditionals" do
     app(:bare) do
-      plugin :render, :escape=>:erubi
+      plugin :render, :escape=>true
 
       route do |r|
         render(:inline=>'<%= "<>" %> <%== "<>" %><%= "<>" if false %>')
@@ -644,7 +644,7 @@ describe ":render plugin :escape option" do
 
   it "should allow for per-branch escaping via set_view options" do
     app(:bare) do
-      plugin :render, :escape=>:erubi
+      plugin :render, :escape=>true
       plugin :view_options
 
       route do |r|
@@ -660,5 +660,41 @@ describe ":render plugin :escape option" do
     body('/a').must_equal '&lt;&gt;'
     body.must_equal '<>'
   end
+
+  it "should accept :escape=>String to only escape for that template engine" do
+    app(:bare) do
+      plugin :render, :escape=>'erb'
+
+      route do |r|
+        r.is 'a' do
+          render(:inline=>'<%= "<>" %> <%== "<>" %><%= "<>" if false %>', :engine=>'unescaped.erb')
+        end
+        render(:inline=>'<%= "<>" %> <%== "<>" %><%= "<>" if false %>')
+      end
+    end
+
+    body.must_equal '&lt;&gt; <>'
+    body('/a').must_equal '<> &lt;&gt;'
+  end
+
+  it "should accept :escape=>Array to only escape for those template engines" do
+    app(:bare) do
+      plugin :render, :escape=>%w'erb erubi', :engine_opts=>{'erubi'=>{:bufvar=>'_buf'}}
+
+      route do |r|
+        r.is 'a' do
+          render(:inline=>'<%= "<>" %> <%== "<>" %><%= "<>" if false %>', :engine=>'unescaped.erb')
+        end
+        r.is 'b' do
+          render(:inline=>'<%= _buf.length %><%= "<>" %> <%== "<>" %><%= "<>" if false %>', :engine=>'erubi')
+        end
+        render(:inline=>'<%= "<>" %> <%== "<>" %><%= "<>" if false %>')
+      end
+    end
+
+    body.must_equal '&lt;&gt; <>'
+    body('/a').must_equal '<> &lt;&gt;'
+    body('/b').must_equal '0&lt;&gt; <>'
+  end
 end
 end

data/spec/plugin/typecast_params_spec.rb

@@ -616,6 +616,44 @@ describe "typecast_params plugin" do
     end.must_equal(:a=>{:b=>1}, :c=>{:d=>2})
   end
 
+  it "#convert! should include missing values as nil" do
+    tp = tp()
+    tp.convert! do |ptp|
+      ptp.int('x')
+      ptp.array(:int, 'y')
+      ptp['c'].convert! do |stp|
+        stp.int(%w'x z')
+      end
+    end.must_equal("x"=>nil, "y"=>nil, "c"=>{"x"=>nil, "z"=>nil})
+  end
+
+  it "#convert! with :missing=>:skip should not include missing values" do
+    tp = tp()
+    tp.convert!(:skip_missing=>true) do |ptp|
+      ptp.int('x')
+      ptp.array(:int, 'y')
+      ptp['c'].convert! do |stp|
+        stp.int(%w'x z')
+      end
+    end.must_equal("c"=>{})
+
+    tp.convert! do |ptp|
+      ptp.int('x')
+      ptp.array(:int, 'y')
+      ptp['c'].convert!(:skip_missing=>true) do |stp|
+        stp.int(%w'x z')
+      end
+    end.must_equal("x"=>nil, "y"=>nil, "c"=>{})
+
+    tp.convert!(:skip_missing=>true) do |ptp|
+      ptp.int('x')
+      ptp.array(:int, 'y')
+      ptp['c'].convert!(:skip_missing=>false) do |stp|
+        stp.int(%w'x z')
+      end
+    end.must_equal("c"=>{"x"=>nil, "z"=>nil})
+  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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.14.1
+  version: 3.15.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-29 00:00:00.000000000 Z
+date: 2018-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -211,6 +211,7 @@ extra_rdoc_files:
 - doc/release_notes/3.13.0.txt
 - doc/release_notes/3.14.0.txt
 - doc/release_notes/3.14.1.txt
+- doc/release_notes/3.15.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -260,6 +261,7 @@ files:
 - doc/release_notes/3.13.0.txt
 - doc/release_notes/3.14.0.txt
 - doc/release_notes/3.14.1.txt
+- doc/release_notes/3.15.0.txt
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
@@ -493,7 +495,12 @@ files:
 homepage: http://roda.jeremyevans.net
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/jeremyevans/roda/issues
+  changelog_uri: http://roda.jeremyevans.net/rdoc/files/CHANGELOG.html
+  documentation_uri: http://roda.jeremyevans.net/documentation.html
+  mailing_list_uri: https://groups.google.com/forum/#!forum/ruby-roda
+  source_code_uri: https://github.com/jeremyevans/roda
 post_install_message: 
 rdoc_options: []
 require_paths: