roda 3.36.0 → 3.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abd198c51a38d272c8601fb367c12b9ad244f8383bcfb2f0583e7c7e23744eca
-  data.tar.gz: 75cee1c957032abd4144f01fbd720794d2f66e7422514fa6e58b8bd5f8087b6e
+  metadata.gz: de8c769572875e477058b48557b22861b9de731fa3b00b20a3022a67c929609d
+  data.tar.gz: 5cacc0d7b988bd3dc5bafbc30fcac145f6f67ddcc0e7809e1fc9cd60d8a16273
 SHA512:
-  metadata.gz: e3b7fed2ed29b869b205114d3bf644bb81f1f8d3a267682976aa4eef019e9ca015ade6526d75a99d5f6f1128991f70ba692e1c527acdc62874fbd39e49c24dba
-  data.tar.gz: 341da7749e2432b1a3139f29b09f6a219480bb6984a74e121fc2b30bc4f7c4f7c6e51b1be01fb836ef85399cef1cfd15249495d335c80b44eed75a1a657960c7
+  metadata.gz: 1bf7df28d82f31820cd19c29b5a3f0f3afbbae2c41cf05974b16698c7ffb1725e924491874ddbb3f355a88990d4aab6d5b5b38f2d9c7612a548bfe0e3701ac2e
+  data.tar.gz: 32fca636d6324d29958cbcdf5c949c413eaeda7b74a701032d5766a60ec6b3f2db7ec262268dac697c3b3f5f9b183e127ddf265c7ba5015578969bc7f8be02a2

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.37.0 (2020-10-16)
+
+* Add custom_matchers plugin, for supporting arbitrary objects as matchers (jeremyevans)
+
 = 3.36.0 (2020-09-14)
 
 * Add multi_public plugin, for serving files from multiple public directories (jeremyevans)

data/doc/release_notes/3.37.0.txt

@@ -0,0 +1,42 @@
+= New Features
+
+* A custom_matchers plugin has been added, which allows using
+  arbitrary objects as matchers, as long as the matcher has been
+  registered.  You can register matchers using the custom_matcher
+  class method, which takes the class of the matcher, and a block
+  which is yielded the matcher object.  The block should return
+  nil or false if the matcher doesn't match, and any other value
+  if the matcher does match.  Example:
+
+    plugin :custom_matchers
+    method_segment = Struct.new(:request_method, :next_segment)
+    custom_matcher(method_segment) do |matcher|
+      # self is the request instance ("r" yielded in the route block below)
+      if matcher.request_method == self.request_method
+        match(matcher.next_segment)
+      end
+    end
+ 
+    get_foo = method_segment.new('GET', 'foo')
+    post_any = method_segment.new('POST', String)
+    route do |r|
+      r.on('baz') do
+        r.on(get_foo) do
+          # GET method, /baz/foo prefix
+        end
+ 
+        r.is(post_any) do |seg|
+          # for POST /baz/bar, seg is "bar"
+        end
+      end
+ 
+      r.on('quux') do
+        r.is(get_foo) do
+          # GET method, /quux/foo route
+        end
+ 
+        r.on(post_any) do |seg|
+          # for POST /quux/xyz, seg is "xyz"
+        end
+      end
+    end

data/lib/roda/plugins/custom_matchers.rb

@@ -0,0 +1,87 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The custom_matchers plugin supports using arbitrary objects
+    # as matchers, as long as the application has been configured
+    # to accept such objects.
+    #
+    # After loading the plugin, support for custom matchers can be
+    # configured using the +custom_matcher+ class method.  This
+    # method is generally passed the class of the object you want
+    # to use as a custom matcher, as well as a block.  The block
+    # will be called in the context of the request instance
+    # with the specific matcher used in the match method.
+    #
+    # Blocks can append to the captures in order to yield the appropriate
+    # values to match blocks, or call request methods that append to the
+    # captures.
+    #
+    # Example:
+    #
+    #   plugin :custom_matchers
+    #   method_segment = Struct.new(:request_method, :next_segment)
+    #   custom_matcher(method_segment) do |matcher|
+    #     # self is the request instance ("r" yielded in the route block below)
+    #     if matcher.request_method == self.request_method
+    #       match(matcher.next_segment)
+    #     end
+    #   end
+    #
+    #   get_foo = method_segment.new('GET', 'foo') 
+    #   post_any = method_segment.new('POST', String) 
+    #   route do |r|
+    #     r.on('baz') do
+    #       r.on(get_foo) do
+    #         # GET method, /baz/foo prefix
+    #       end
+    #
+    #       r.is(post_any) do |seg|
+    #         # for POST /baz/bar, seg is "bar"
+    #       end
+    #     end
+    #
+    #     r.on('quux') do
+    #       r.is(get_foo) do
+    #         # GET method, /quux/foo route
+    #       end
+    #
+    #       r.on(post_any) do |seg|
+    #         # for POST /quux/xyz, seg is "xyz"
+    #       end
+    #     end
+    #   end
+    module CustomMatchers
+      def self.configure(app)
+        app.opts[:custom_matchers] ||= OPTS
+      end
+
+      module ClassMethods
+        def custom_matcher(match_class, &block)
+          custom_matchers = Hash[opts[:custom_matchers]]
+          meth = custom_matchers[match_class] = custom_matchers[match_class] || :"_custom_matcher_#{match_class}"
+          opts[:custom_matchers] = custom_matchers.freeze
+          self::RodaRequest.send(:define_method, meth, &block)
+          nil
+        end
+      end
+
+      module RequestMethods
+        # Try custom matchers before calling super
+        def unsupported_matcher(matcher)
+          roda_class.opts[:custom_matchers].each do |match_class, meth|
+            if match_class === matcher
+              return send(meth, matcher)
+            end
+          end
+
+          super
+        end
+      end
+    end
+
+    register_plugin(:custom_matchers, CustomMatchers)
+  end
+end
+

data/lib/roda/plugins/typecast_params.rb

@@ -609,10 +609,9 @@ class Roda
             when nil
               keys = (0...@obj.length)
 
-              valid = case @obj
-              when Array
+              valid = if @obj.is_a?(Array)
                 true
-              when Hash
+              else
                 keys = keys.map(&:to_s)
                 keys.all?{|k| @obj.has_key?(k)}
               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 = 36
+  RodaMinorVersion = 37
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.36.0
+  version: 3.37.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-14 00:00:00.000000000 Z
+date: 2020-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -212,6 +212,7 @@ extra_rdoc_files:
 - doc/release_notes/3.34.0.txt
 - doc/release_notes/3.35.0.txt
 - doc/release_notes/3.36.0.txt
+- doc/release_notes/3.37.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -249,6 +250,7 @@ files:
 - doc/release_notes/3.34.0.txt
 - doc/release_notes/3.35.0.txt
 - doc/release_notes/3.36.0.txt
+- doc/release_notes/3.37.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt
@@ -275,6 +277,7 @@ files:
 - lib/roda/plugins/content_security_policy.rb
 - lib/roda/plugins/cookies.rb
 - lib/roda/plugins/csrf.rb
+- lib/roda/plugins/custom_matchers.rb
 - lib/roda/plugins/default_headers.rb
 - lib/roda/plugins/default_status.rb
 - lib/roda/plugins/delay_build.rb
@@ -387,7 +390,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit