roda 3.45.0 → 3.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dbdf55425a681a0cb32fa0b4a44cd50bf5be6f85c78c1ea1adbdd19e28c2d61
-  data.tar.gz: e91ee695e5f8648f4269a2c229b794ef2ee921f4291102519d4ca2cadd9bf13a
+  metadata.gz: 5fd9ea4a9be8072ffc96e5bab91a845e99cc9a9d6641571167badd4146c93318
+  data.tar.gz: ed062be1d4b922ba39456f3868e599e3c6134fecfedaa3bfc780667bfec5c5f2
 SHA512:
-  metadata.gz: aa46429e09091c3cf0112c251a9863845c69d4245674dcaddaec030244213d8b9ac1aae96cfa6093680c33f87c732ee4464e4cbe2572d192eb0a9f7e09acd43b
-  data.tar.gz: 57cf84f7db6e6334918f0c01f7308c4c48db7e0ba9f2a14fe87420c3b2bd17471a229ec02a2ad9242ec6fd4aa67848f6dff04b319fea361a985dd264b52252ab
+  metadata.gz: 59e5677db771776107744f2438505b467363b410d6b2c8d19b1b11e802bfd15b22974997b20185e9ba3a1c9a7b8721bb5e3dbc1481a575f0812300c9c3241cac
+  data.tar.gz: 6233ec5251cfbeeaabdb44a7cba75d4831910215ae8239ec19873f58a62f14722bb6b57059f0814ae07e7ccc50977e3a2fbf74bb3b423a253b7dace5773c6887

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.46.0 (2021-07-12)
+
+* Automatically optimize r.on/r.is/r.get/r.post methods with a single string, String, Integer, or regexp argument (jeremyevans)
+
 = 3.45.0 (2021-06-14)
 
 * Make typecast_params plugin check for null bytes in strings by default, with :allow_null_bytes option for previous behavior (jeremyevans)

data/README.rdoc

@@ -13,7 +13,6 @@ Website :: http://roda.jeremyevans.net
 Source :: http://github.com/jeremyevans/roda
 Bugs :: http://github.com/jeremyevans/roda/issues
 Google Group :: http://groups.google.com/group/ruby-roda
-IRC :: irc://chat.freenode.net/#roda
 
 == Goals
 

data/doc/release_notes/3.46.0.txt

@@ -0,0 +1,19 @@
+= Improvements
+
+* The r.on, r.is, r.get and r.post methods (and other verb methods
+  if using the all_verbs plugin) have now been optimized when using
+  a single string or regexp matcher, or the String or Integer class
+  matcher.  Since those four matchers are the most common types of
+  matchers passed to the methods, this can significantly improve
+  routing performance (about 50% in the r10k benchmark).
+
+  This optimization is automatically applied when freezing
+  applications, if the related methods have not been modified by
+  plugins.
+
+  This optimization does come at the expense of a small decrease
+  in routing performance (3-4%) for unoptimized cases, but the
+  majority of applications will see a overall performance benefit
+  from this change.
+
+* Other minor performance improvements have been made.

data/lib/roda.rb

@@ -212,6 +212,10 @@ class Roda
             if @middleware.empty? && use_new_dispatch_api?
               plugin :direct_call
             end
+
+            if ([:on, :is, :_verb, :_match_class_String, :_match_class_Integer, :_match_string, :_match_regexp, :empty_path?]).all?{|m| self::RodaRequest.instance_method(m).owner == RequestMethods}
+              plugin :_optimized_matching
+            end
           end
 
           build_rack_app

data/lib/roda/plugins/_optimized_matching.rb

@@ -0,0 +1,137 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The _optimized_matching plugin is automatically used internally to speed
+    # up matching when a single argument String instance, String class, Integer
+    # class, or Regexp matcher is passed to +r.on+, +r.is_+, or a verb method
+    # such as +r.get+ or +r.post+.
+    # 
+    # The optimization works by avoiding the +if_match+ method if possible.
+    # Instead of clearing the captures array on every call, and having the
+    # matching append to the captures, it checks directly for the match,
+    # and on succesful match, it yields directly to the block without using
+    # the captures array.
+    module OptimizedMatching 
+      TERM = Base::RequestMethods::TERM
+
+      module RequestMethods
+        # Optimize the r.is method handling of a single string, String, Integer,
+        # regexp, or true, argument.
+        def is(*args, &block)
+          case args.length
+          when 1
+            _is1(args, &block)
+          when 0
+            always(&block) if @remaining_path.empty?
+          else
+            if_match(args << TERM, &block)
+          end
+        end
+
+        # Optimize the r.on method handling of a single string, String, Integer,
+        # or regexp argument.  Inline the related matching code to avoid the
+        # need to modify @captures.
+        def on(*args, &block)
+          case args.length
+          when 1
+            case matcher = args[0]
+            when String
+              always{yield} if _match_string(matcher)
+            when Class
+              if matcher == String
+                rp = @remaining_path
+                if rp.getbyte(0) == 47
+                  if last = rp.index('/', 1)
+                    @remaining_path = rp[last, rp.length]
+                    always{yield rp[1, last-1]}
+                  elsif (len = rp.length) > 1
+                    @remaining_path = ""
+                    always{yield rp[1, len]}
+                  end
+                end
+              elsif matcher == Integer
+                if matchdata = @remaining_path.match(/\A\/(\d+)(?=\/|\z)/)
+                  @remaining_path = matchdata.post_match
+                  always{yield(matchdata[1].to_i)}
+                end
+              else
+                if_match(args, &block)
+              end
+            when Regexp
+              if matchdata = @remaining_path.match(self.class.cached_matcher(matcher){matcher})
+                @remaining_path = matchdata.post_match
+                always{yield(*matchdata.captures)}
+              end
+            else
+              if_match(args, &block)
+            end
+          when 0
+            always(&block)
+          else
+            if_match(args, &block)
+          end
+        end
+
+        private
+
+        # Optimize the r.get/r.post method handling of a single string, String, Integer,
+        # regexp, or true, argument.
+        def _verb(args, &block)
+          case args.length
+          when 0
+            always(&block)
+          when 1
+            _is1(args, &block)
+          else
+            if_match(args << TERM, &block)
+          end
+        end
+
+        # Internals of r.is/r.get/r.post optimization.  Inline the related matching
+        # code to avoid the need to modify @captures.
+        def _is1(args, &block)
+          case matcher = args[0]
+          when String
+            rp = @remaining_path
+            if _match_string(matcher)
+              if @remaining_path.empty?
+                always{yield}
+              else
+                @remaining_path = rp
+                nil
+              end
+            end
+          when Class
+            if matcher == String
+              rp = @remaining_path
+              if rp.getbyte(0) == 47 && !rp.index('/', 1) && (len = rp.length) > 1
+                @remaining_path = ''
+                always{yield rp[1, len]}
+              end
+            elsif matcher == Integer
+              if matchdata = @remaining_path.match(/\A\/(\d+)\z/)
+                @remaining_path = ''
+                always{yield(matchdata[1].to_i)}
+              end
+            else
+              if_match(args << TERM, &block)
+            end
+          when Regexp
+            if (matchdata = @remaining_path.match(self.class.cached_matcher(matcher){matcher})) && (post_match = matchdata.post_match).empty?
+              @remaining_path = ''
+              always{yield(*matchdata.captures)}
+            end
+          when true
+            always(&block) if @remaining_path.empty?
+          else
+            if_match(args << TERM, &block)
+          end
+        end
+      end
+    end
+
+    register_plugin(:_optimized_matching, OptimizedMatching)
+  end
+end

data/lib/roda/plugins/content_for.rb

@@ -62,8 +62,7 @@ class Roda
       end
 
       # Configure whether to append or overwrite if content_for
-      # is called multiple times to set data. Overwrite is default, use
-      # the :append option to append.
+      # is called multiple times with the same key.
       def self.configure(app, opts = OPTS)
         app.opts[:append_content_for] = opts.fetch(:append, true)
       end

data/lib/roda/request.rb

@@ -24,7 +24,7 @@ class Roda
 
         # Return the cached pattern for the given object.  If the object is
         # not already cached, yield to get the basic pattern, and convert the
-        # basic pattern to a pattern that does not partial segments.
+        # basic pattern to a pattern that does not match partial segments.
         def cached_matcher(obj)
           cache = @match_pattern_cache
 
@@ -234,9 +234,7 @@ class Roda
 
         # An alias of remaining_path. If a plugin changes remaining_path then
         # it should override this method to return the untouched original.
-        def real_remaining_path
-          remaining_path
-        end
+        alias real_remaining_path remaining_path
 
         # Match POST requests.  If no arguments are provided, matches all POST
         # requests, otherwise, matches only POST requests where the arguments
@@ -336,7 +334,7 @@ class Roda
         # Use <tt>r.get true</tt> to handle +GET+ requests where the current
         # path is empty.
         def root(&block)
-          if remaining_path == "/" && is_get?
+          if @remaining_path == "/" && is_get?
             always(&block)
           end
         end
@@ -519,7 +517,7 @@ class Roda
         # SCRIPT_NAME to include the matched path, removes the matched
         # path from PATH_INFO, and updates captures with any regex captures.
         def consume(pattern)
-          if matchdata = remaining_path.match(pattern)
+          if matchdata = @remaining_path.match(pattern)
             @remaining_path = matchdata.post_match
             captures = matchdata.captures
             captures = yield(*captures) if block_given?
@@ -548,7 +546,7 @@ class Roda
 
         # Whether the current path is considered empty.
         def empty_path?
-          remaining_path.empty?
+          @remaining_path.empty?
         end
 
         # If all of the arguments match, yields to the match block and

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 = 45
+  RodaMinorVersion = 46
 
   # 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.45.0
+  version: 3.46.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-14 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -216,6 +216,7 @@ extra_rdoc_files:
 - doc/release_notes/3.43.0.txt
 - doc/release_notes/3.44.0.txt
 - doc/release_notes/3.45.0.txt
+- doc/release_notes/3.46.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt
 - doc/release_notes/3.7.0.txt
@@ -268,6 +269,7 @@ files:
 - doc/release_notes/3.43.0.txt
 - doc/release_notes/3.44.0.txt
 - doc/release_notes/3.45.0.txt
+- doc/release_notes/3.46.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt
 - doc/release_notes/3.7.0.txt
@@ -278,6 +280,7 @@ files:
 - lib/roda/plugins.rb
 - lib/roda/plugins/_after_hook.rb
 - lib/roda/plugins/_before_hook.rb
+- lib/roda/plugins/_optimized_matching.rb
 - lib/roda/plugins/_symbol_regexp_matchers.rb
 - lib/roda/plugins/all_verbs.rb
 - lib/roda/plugins/assets.rb
@@ -409,7 +412,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Routing tree web toolkit