roda 3.68.0 → 3.69.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faad040bd1e251d705afbfe6ced40794aa2f135658168c85603a6c8a83a497be
-  data.tar.gz: 6e1d78ffdf0442835a754e54fc6216d8f668f3d0cb8e9c5635c1a582b17d5746
+  metadata.gz: 2871ec8db3a18a77238fdae1aeb786c7a7eb93f14b0827428fab1b07f6e7bee8
+  data.tar.gz: 75db2ec79978055f407c2270cfd9119782322402c2c536a504fbfc08f4fedac7
 SHA512:
-  metadata.gz: a663960b5f5c5391a44102b1b255fbb5546f241c2386b6fdbe8a5050f434407332f239eb0c862ab877de239ec1b4ea39c4f9202c488672a846c5f8eabaef6379
-  data.tar.gz: 508fa08ad66e1b11b5abc552345067fc2517aeb10ea060c6298a337b44db453c5daf35a0bbafe399dd9167286fd9ea35c07d75c340f640a6198beb52367352d5
+  metadata.gz: 1ca4fdcac9bcba88309b8ccb4315ea2243530b08313135f97a643b81600b98821521fbbe08e9c7ab757732887326e8af492f0f3e883a3f54e7be73f0811d19e6
+  data.tar.gz: 6b313eecbd4f62d07bca53fa23db2325b4f53f3faf55344c86d8f543ff92c5dcba94235f963582ce227d3602e3ea8633e981393ef6aedcbe20fb8152e6409c08

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.69.0 (2023-06-13)
+
+* Allow symbol_matcher in symbol_matchers plugin to take a block to allow type conversion (jeremyevans)
+
 = 3.68.0 (2023-05-11)
 
 * Make Roda.run in multi_run plugin accept blocks to allow autoloading the apps to dispatch to (jeremyevans)

data/doc/release_notes/3.69.0.txt

@@ -0,0 +1,33 @@
+= New Feature
+
+* The symbol_matcher method in the symbol_matchers plugin now
+  supports a block to allow for type conversion of matched
+  segments:
+
+    symbol_matcher(:date, /(\d\d\d\d)-(\d\d)-(\d\d)/) do |y, m, d|
+      [Date.new(y.to_i, m.to_i, d.to_i)]
+    end
+  
+    route do |r|
+      r.on :date do |date|
+        # date is an instance of Date
+      end
+    end
+
+  As shown above, the block should return an array of objects to yield
+  to the match block.
+ 
+  If you have a segment match the passed regexp, but decide during block
+  processing that you do not want to treat it as a match, you can have the
+  block return nil or false.  This is useful if you want to make sure you
+  are using valid data:
+  
+    symbol_matcher(:date, /(\d\d\d\d)-(\d\d)-(\d\d)/) do |y, m, d|
+      y = y.to_i
+      m = m.to_i
+      d = d.to_i
+      [Date.new(y, m, d)] if Date.valid_date?(y, m, d)
+    end
+  
+  When providing a block when using the symbol_matchers method, that
+  symbol may not work with the params_capturing plugin.

data/lib/roda/plugins/class_matchers.rb

@@ -33,7 +33,7 @@ class Roda
     # block return nil or false.  This is useful if you want to make sure you
     # are using valid data:
     #
-    #   class_matcher(Date, /(\dd\d)-(\d\d)-(\d\d)/) do |y, m, d|
+    #   class_matcher(Date, /(\d\d\d\d)-(\d\d)-(\d\d)/) do |y, m, d|
     #     y = y.to_i
     #     m = m.to_i
     #     d = d.to_i

data/lib/roda/plugins/symbol_matchers.rb

@@ -37,6 +37,35 @@ class Roda
     #
     # If using this plugin with the params_capturing plugin, this plugin should
     # be loaded first.
+    #
+    # You can provide a block when calling +symbol_matcher+, and it will be called
+    # for all matches to allow for type conversion.  The block must return an
+    # array:
+    #
+    #   symbol_matcher(:date, /(\d\d\d\d)-(\d\d)-(\d\d)/) do |y, m, d|
+    #     [Date.new(y.to_i, m.to_i, d.to_i)]
+    #   end
+    #
+    #   route do |r|
+    #     r.on :date do |date|
+    #       # date is an instance of Date
+    #     end
+    #   end
+    #
+    # If you have a segment match the passed regexp, but decide during block
+    # processing that you do not want to treat it as a match, you can have the
+    # block return nil or false.  This is useful if you want to make sure you
+    # are using valid data:
+    #
+    #   symbol_matcher(:date, /(\d\d\d\d)-(\d\d)-(\d\d)/) do |y, m, d|
+    #     y = y.to_i
+    #     m = m.to_i
+    #     d = d.to_i
+    #     [Date.new(y, m, d)] if Date.valid_date?(y, m, d)
+    #   end
+    #
+    # However, if providing a block to the symbol_matchers plugin, the symbol may 
+    # not work with the params_capturing plugin.
     module SymbolMatchers
       def self.load_dependencies(app)
         app.plugin :_symbol_regexp_matchers
@@ -50,9 +79,10 @@ class Roda
 
       module ClassMethods
         # Set the regexp to use for the given symbol, instead of the default.
-        def symbol_matcher(s, re)
+        def symbol_matcher(s, re, &block)
           meth = :"match_symbol_#{s}"
-          self::RodaRequest.send(:define_method, meth){re}
+          array = [re, block].freeze
+          self::RodaRequest.send(:define_method, meth){array}
           self::RodaRequest.send(:private, meth)
         end
       end
@@ -67,8 +97,8 @@ class Roda
           meth = :"match_symbol_#{s}"
           if respond_to?(meth, true)
             # Allow calling private match methods
-            re = send(meth)
-            consume(self.class.cached_matcher(re){re})
+            re, block = send(meth)
+            consume(self.class.cached_matcher(re){re}, &block)
           else
             super
           end
@@ -80,7 +110,8 @@ class Roda
           meth = :"match_symbol_#{s}"
           if respond_to?(meth, true)
             # Allow calling private match methods
-            send(meth)
+            re, = send(meth)
+            re
           else
             super
           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 = 68
+  RodaMinorVersion = 69
 
   # 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.68.0
+  version: 3.69.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -241,6 +241,7 @@ extra_rdoc_files:
 - doc/release_notes/3.66.0.txt
 - doc/release_notes/3.67.0.txt
 - doc/release_notes/3.68.0.txt
+- doc/release_notes/3.69.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
@@ -316,6 +317,7 @@ files:
 - doc/release_notes/3.66.0.txt
 - doc/release_notes/3.67.0.txt
 - doc/release_notes/3.68.0.txt
+- doc/release_notes/3.69.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt