roda 3.106.0 → 3.107.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90404574f8af3e952feb444cabe5bb01430e2d7c3658daee9f22f0c22e25d5f6
-  data.tar.gz: 347ba47cf4c3b9e280848ba717a1a4a9f57f8ac0712d2aaa8e5942020c22cb29
+  metadata.gz: 84bb84bd98ebe0d00d48315d9036ae1c22d93c92715922a6dba297f225c9fec7
+  data.tar.gz: 7cf2abbe3656ec22aef206a4e895c2520a8f80dc0ed11ec058a8a5f4cf3194b5
 SHA512:
-  metadata.gz: 00e03ccebd8d48c4c1576ae0da2929d85a30430114b9a292bd8b9029fba31b4a7fa10767d7fb59a643c4280fb659e9afa90dacde27c7a5bdbc98fc5ee1df40a6
-  data.tar.gz: 7867f8da5bad9db4102f09fc692158feee7605c8021b5d01bb07ebfe57d3a82ca0b18d7fc1341d6e5cdf9ff534736a6c9c3ce2420b2078abe96209ad423bce92
+  metadata.gz: 874ed7d5065e77c593bccd1939d3742acf3e65a0b6ea6eb95e02cd6ce9ca55c9819cfafe6ecfc61ce548075832b91c68800e7f5ae35774efb60949f0a86cb1ae
+  data.tar.gz: 40a37368dfc79527849fec46d615c26680cad15dd590b8b6a3dba0fa2809c2b90bacefa70f65b78566f88c62485f97afd715494a214fcc87050125ac7743d519

data/lib/roda/plugins/assets.rb

@@ -159,6 +159,35 @@ class Roda
     #   plugin :assets,
     #     css_opts: {style: :compressed}
     #
+    # In Roda 4, automatic compression of assets will not be attempted. You will
+    # need to specify the compressor to use using a Proc or Method. Here are values
+    # that you can use.
+    # 
+    # ==== yui
+    #
+    #  require 'yuicompressor'
+    #   plugin :assets,
+    #     css_compressor: lambda{|v| ::YUICompressor.compress_css(v, munge: true) },
+    #     js_compressor: lambda{|v| ::YUICompressor.compress_js(v, munge: true) }
+    #
+    # ==== closure-compiler
+    #
+    #   require 'closure-compiler'
+    #   plugin :assets, js_compressor: ::Closure::Compiler.new.method(:compile)
+    #
+    # ==== uglifier
+    #
+    #   require 'uglifier'
+    #   plugin :assets, js_compressor: Uglifier.method(:compile)
+    #
+    # ==== minjs
+    #
+    #   require 'minjs'
+    #   plugin :assets,
+    #     js_compressor: proc { |content|
+    #       Minjs::Compressor::Compressor.new(debug: false).compress(content).to_js
+    #     }
+    #
     # === Source Maps (CSS)
     #
     # The assets plugin does not have direct support for source maps, so it is
@@ -274,7 +303,7 @@ class Roda
     # :compiled_path:: Path inside public folder in which compiled files are stored (default: :prefix)
     # :concat_only :: Whether to just concatenate instead of concatenating
     #                 and compressing files (default: false)
-    # :css_compressor :: Compressor to use for compressing CSS, either :yui, :none, or nil (the default, which will try
+    # :css_compressor :: Compressor to use for compressing CSS, either a Proc, Method, :yui, :none, or nil (the default, which will try
     #                    :yui if available, but not fail if it is not available)
     # :css_dir :: Directory name containing your css source, inside :path (default: 'css')
     # :css_headers :: A hash of additional headers for your rendered css files
@@ -288,7 +317,7 @@ class Roda
     #                   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.
     # :headers :: A hash of additional headers for both js and css rendered files
-    # :js_compressor :: Compressor to use for compressing javascript, either :yui, :closure, :uglifier, :minjs,
+    # :js_compressor :: Compressor to use for compressing javascript, either a Proc, Method, :yui, :closure, :uglifier, :minjs,
     #                   :none, or nil (the default, which will try :yui, :closure, :uglifier, then :minjs, but
     #                   not fail if any of them is not available)
     # :js_dir :: Directory name containing your javascript source, inside :path (default: 'js')
@@ -454,6 +483,17 @@ class Roda
         opts[:js_suffix]           = (opts[:add_suffix] ? '.js' : '').freeze
         opts[:css_suffix]          = (opts[:add_suffix] ? '.css' : '').freeze
 
+        unless opts[:concat_only]
+          [:css_compressor, :js_compressor].each do |s|
+            case v = opts[s]
+            when nil, :none, Proc, Method
+              nil
+            else
+              RodaPlugins.warn "Support for the assets plugin #{s}: #{v.inspect} option will be removed in Roda 4. See the assets plugin documentation for how to use an appropriate proc or method."
+            end
+          end
+        end
+
         opts.freeze
       end
 
@@ -535,6 +575,7 @@ class Roda
             app.read_asset_file(file, type)
           end.join("\n")
 
+          # RODA4: Remove :concat_only option
           unless o[:concat_only]
             content = compress_asset(content, type)
           end
@@ -564,6 +605,8 @@ class Roda
             return content
           when nil
             # default, try different compressors
+          when Proc, Method
+            return compressor.call(content)
           else
             # Allow calling private compress methods
             return send("compress_#{type}_#{compressor}", content)
@@ -579,6 +622,7 @@ class Roda
             begin
             # Allow calling private compress methods
               if c = send("compress_#{type}_#{comp}", content)
+                RodaPlugins.warn "Support for automatic compression of assets by trying common asset compressor libraries will be removed in Roda 4. The #{comp} #{type.to_s.upcase} compressor is currently used. See the assets plugin documentation for how to use an appropriate value for the assets plugin :#{type}_compressor option."
                 return c
               end
             rescue LoadError, CompressorNotFound

data/lib/roda/plugins/csrf.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+# RODA4: Remove plugin
+
 require 'rack/csrf'
 
 class Roda
@@ -7,6 +9,7 @@ class Roda
     # This plugin is no longer recommended for use, it exists only for
     # backwards compatibility.  Consider using the route_csrf plugin
     # instead, as that provides stronger CSRF protection.
+    # This plugin will no longer ship with Roda starting in Roda 4.
     #
     # The csrf plugin adds CSRF protection using rack_csrf, along with
     # some csrf helper methods to use in your views.  To use it, load

data/lib/roda/plugins/delay_build.rb

@@ -3,6 +3,8 @@
 #
 class Roda
   module RodaPlugins
+    warn("The delay_build plugin no longer has an effect. It will be removed in Roda 4.")
+
     module DelayBuild
       module ClassMethods
         # No-op for backwards compatibility

data/lib/roda/plugins/middleware.rb

@@ -125,6 +125,7 @@ class Roda
         app.opts[:middleware_configure] = block if block
         app.opts[:middleware_handle_result] = opts[:handle_result]
         app.opts[:middleware_forward_response_headers] = opts[:forward_response_headers]
+        # RODA4: Make next_if_not_found default to true
         app.opts[:middleware_next_if_not_found] = opts[:next_if_not_found]
       end
 

data/lib/roda/plugins/route_block_args.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+# RODA4: Remove plugin
+
 #
 class Roda
   module RodaPlugins
@@ -22,6 +24,10 @@ class Roda
     #       end
     #     end
     #   end
+    #
+    # This plugin will be no longer ship with Roda starting in Roda 4. Users
+    # are encouraged to switch to defining local variables at the top of the
+    # route block instead of using this plugin.
     module RouteBlockArgs
       def self.configure(app, &block)
         app.instance_exec do 

data/lib/roda/plugins/sessions.rb

@@ -67,7 +67,7 @@ class Roda
     #                    given, it will be merged into the default cookie options.
     # :env_key :: The key in `env` where the session should be located. Defaults to <tt>"rack.session"</tt>, the
     #             default key for sessions in Rack.
-    # :gzip_over :: For session data over this many bytes, compress it with the deflate algorithm (default: nil,
+    # :gzip_over (deprecated) :: For session data over this many bytes, compress it with the deflate algorithm (default: nil,
     #               so never compress).  Note that compression should not be enabled if you are storing data in
     #               the session derived from user input and also storing sensitive data in the session.
     # :key :: The cookie name to use (default: <tt>'roda.session'</tt>)
@@ -94,7 +94,7 @@ class Roda
     #                 (default: 3600).
     # :upgrade_from_rack_session_cookie_key :: The cookie name to use for transparently upgrading from
     #                                          Rack::Session:Cookie (defaults to <tt>'rack.session'</tt>).
-    # :upgrade_from_rack_session_cookie_secret :: The secret for the HMAC-SHA1 signature when allowing
+    # :upgrade_from_rack_session_cookie_secret (deprecated) :: The secret for the HMAC-SHA1 signature when allowing
     #                                             transparent upgrades from Rack::Session::Cookie. Using this
     #                                             option is only recommended during a short transition period,
     #                                             and is not enabled by default as it lowers security.
@@ -189,12 +189,17 @@ class Roda
         opts[:session_version_num] = opts[:per_cookie_cipher_secret] ? 1 : 0
 
         if opts[:upgrade_from_rack_session_cookie_secret]
+          RodaPlugins.warn("Support for upgrading rack session cookie sessions will be removed in Roda 4.")
           opts[:upgrade_from_rack_session_cookie_key] ||= 'rack.session'
           rsco = opts[:upgrade_from_rack_session_cookie_options] = Hash[opts[:upgrade_from_rack_session_cookie_options] || OPTS]
           rsco[:path] ||= co[:path]
           rsco[:domain] ||= co[:domain]
         end
 
+        if opts[:gzip_over]
+          RodaPlugins.warn("Support for compressing session data will be removed in Roda 4.")
+        end
+
         opts[:cipher_secret], opts[:hmac_secret] = split_secret(:secret, opts[:secret])
         opts[:old_cipher_secret], opts[:old_hmac_secret] = (split_secret(:old_secret, opts[:old_secret]) if opts[:old_secret])
 

data/lib/roda/plugins/static.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+# RODA4: Remove plugin
+
 require 'rack/static'
 
 #
@@ -26,6 +28,15 @@ class Roda
     #   plugin :static, ['/js', '/css'] # path: /path/to/app/public
     #   plugin :static, ['/images'], root: 'pub'  # path: /path/to/app/pub
     #   plugin :static, ['/media'], root: '/path/to/public' # path: /path/to/public
+    #
+    # This plugin will no longer ship with Roda starting in Roda 4. As the plugin only
+    # configures a middleware, you should switch to doing so directly. Translating
+    # the above example to direct middleware usage:
+    #
+    #   require 'rack/static'
+    #   use Rack::Static, urls: ['/js', '/css'], root: '/path/to/app/public'
+    #   use Rack::Static, urls: ['/images'], root: '/path/to/app/pub'
+    #   use Rack::Static, urls: ['/media'], root: '/path/to/public'
     module Static
       # Load the Rack::Static middleware.  Use the paths given as the :urls option,
       # and set the :root option to be relative to the application's :root option.

data/lib/roda/plugins/url_escape.rb

@@ -0,0 +1,39 @@
+# frozen-string-literal: true
+
+require 'rack/utils'
+
+#
+class Roda
+  module RodaPlugins
+    # The url_escape plugin add url_escape and url_unescape methods
+    # to the route block scope.
+    #
+    #   plugin :url_escape
+    #
+    #   route do |r|
+    #     link = "/path/q=#{url_escape(r.params["some_param"])}"
+    #     response_body(link)
+    #   end
+    module UrlEscape
+      module InstanceMethods
+        if RUBY_VERSION >= '2'
+          define_method(:url_escape, Rack::Utils.instance_method(:escape))
+          define_method(:url_unescape, Rack::Utils.instance_method(:unescape))
+        # :nocov:
+        else
+          def url_escape(v)
+            Rack::Utils.escape(v)
+          end
+
+          def url_unescape(v)
+            Rack::Utils.unescape(v)
+          end
+        end
+        # :nocov:
+      end
+    end
+
+    register_plugin(:url_escape, UrlEscape)
+  end
+end
+

data/lib/roda/request.rb

@@ -569,8 +569,9 @@ class Roda
             if meth
               return unless captures = scope.send(meth, *captures)
             # :nocov:
+            # RODA4: Remove elsif block
             elsif defined?(yield)
-              # RODA4: Remove
+              RodaPlugins.warn("Passing a block to RodaRequest#consume will be ignored in Roda 4. Update the code to pass a scope method symbol as the second argument.")
               return unless captures = yield(*captures)
             # :nocov:
             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 = 106
+  RodaMinorVersion = 107
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/lib/roda.rb

@@ -71,29 +71,34 @@ class Roda
         #
         # If the :check_arity app option is not set to false, Roda will check that
         # the arity of the block matches the expected arity, and compensate for
-        # cases where it does not.  If it is set to :warn, Roda will warn in the
-        # cases where the arity does not match what is expected.
+        # cases where it does not.  The :check_arity default app option setting is
+        # :warn, in which case Roda will warn in the cases where the arity does not
+        # match what is expected.
         #
         # If the expected arity is :any, Roda must perform a dynamic arity check
         # when the method is called, which can hurt performance even in the case
         # where the arity matches.  The :check_dynamic_arity app option can be
         # set to false to turn off the dynamic arity checks.  The
         # :check_dynamic_arity app option can be to :warn to warn if Roda needs
-        # to adjust arity dynamically.
+        # to adjust arity dynamically. The default value of the :check_dynamic_arity
+        # app option is to use the same value as the :check_arity app option.
         #
         # Roda only checks arity for regular blocks, not lambda blocks, as the
         # fixes Roda uses for regular blocks would not work for lambda blocks.
         #
         # Roda does not support blocks with required keyword arguments if the
         # expected arity is 0 or 1.
+        #
+        # Support for the :check_arity and :check_dynamic_arity options will be
+        # removed in Roda 4.
         def define_roda_method(meth, expected_arity, &block)
           if meth.is_a?(String)
             meth = roda_method_name(meth)
           end
           call_meth = meth
 
-          # RODA4: Switch to false # :warn in last Roda 3 version
-          if (check_arity = opts.fetch(:check_arity, true)) && !block.lambda?
+          # RODA4: Remove support for :check_arity, default to false behavior
+          if (check_arity = opts.fetch(:check_arity, :warn)) && !block.lambda?
             required_args, optional_args, rest, keyword = _define_roda_method_arg_numbers(block)
 
             if keyword == :required && (expected_arity == 0 || expected_arity == 1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.106.0
+  version: 3.107.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -310,6 +310,7 @@ files:
 - lib/roda/plugins/typecast_params.rb
 - lib/roda/plugins/typecast_params_sized_integers.rb
 - lib/roda/plugins/unescape_path.rb
+- lib/roda/plugins/url_escape.rb
 - lib/roda/plugins/view_options.rb
 - lib/roda/plugins/view_subdir_leading_slash.rb
 - lib/roda/request.rb
@@ -339,7 +340,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Routing tree web toolkit
 test_files: []