roda 2.29.0 → 3.0.0

data/lib/roda/plugins/match_affix.rb

@@ -28,11 +28,6 @@ class Roda
     #
     # This plugin automatically loads the placeholder_string_matchers plugin.
     module MatchAffix
-      PREFIX = "/".freeze
-      RodaPlugins.deprecate_constant(self, :PREFIX)
-      SUFFIX = "(?=\/|\z)".freeze
-      RodaPlugins.deprecate_constant(self, :SUFFIX)
-
       def self.load_dependencies(app, _prefix, _suffix)
         app.plugin :placeholder_string_matchers
       end

data/lib/roda/plugins/middleware.rb

@@ -34,7 +34,8 @@ class Roda
     #   run App
     #
     # It is possible to use the Roda app as a regular app even when using
-    # the middleware plugin.
+    # the middleware plugin.  Using an app as middleware automatically creates
+    # a subclass of the app for the middleware.
     #
     # You can support configurable middleware by passing a block when loading
     # the plugin:
@@ -60,11 +61,6 @@ class Roda
     #
     #   # Request to App for /mid returns
     #   # "foo bar baz"
-    #
-    # Note that when supporting configurable middleware via a block, the middleware
-    # used is a subclass of the class loading the plugin, instead of the class itself.
-    # This is done so the same class can be used as middleware with multiple separate
-    # configurations.
     module Middleware
       # Configure the middleware plugin.  Options:
       # :env_var :: Set the environment variable to use to indicate to the roda
@@ -77,17 +73,16 @@ class Roda
         app.opts[:middleware_configure] = block if block
       end
 
-      # Forward instances are what is actually used as middleware.
+      # Forwarder instances are what is actually used as middleware.
       class Forwarder
-        # Store the current middleware and the next middleware to call.
+        # Make a subclass of +mid+ to use as the current middleware,
+        # and store +app+ as the next middleware to call.
         def initialize(mid, app, *args, &block)
-          @mid = if configure = mid.opts[:middleware_configure]
-            mid = Class.new(mid)
-            configure.call(mid, *args, &block)
-            mid
-          else
-            raise RodaError, "cannot provide middleware args or block unless loading middleware plugin with a block" if block || !args.empty?
-            mid
+          @mid = Class.new(mid)
+          if configure = @mid.opts[:middleware_configure]
+            configure.call(@mid, *args, &block)
+          elsif block || !args.empty?
+            raise RodaError, "cannot provide middleware args or block unless loading middleware plugin with a block"
           end
           @app = app
         end

data/lib/roda/plugins/multi_route.rb

@@ -133,10 +133,13 @@ class Roda
       end
 
       module ClassMethods
-        # Freeze the namespaced routes so that there can be no thread safety issues at runtime.
+        # Freeze the namespaced routes and setup the regexp matchers so that there can be no thread safety issues at runtime.
         def freeze
-          opts[:namespaced_routes].freeze
-          opts[:namespaced_routes].each_value(&:freeze)
+          opts[:namespaced_routes].freeze.each do |k,v|
+            v.freeze
+            self::RodaRequest.named_route_regexp(k)
+          end
+          self::RodaRequest.instance_variable_get(:@namespaced_route_regexps).freeze
           super
         end
 
@@ -151,9 +154,9 @@ class Roda
         # The names for the currently stored named routes
         def named_routes(namespace=nil)
           unless routes = opts[:namespaced_routes][namespace]
-            RodaPlugins.warn "Attempt to access multi_route namespace for which no routes have been defined: #{namespace}"
+            raise RodaError, "unsupported multi_route namespace used: #{namespace.inspect}"
           end
-          routes ? routes.keys : []
+          routes.keys
         end
 
         # Return the named route with the given name.

data/lib/roda/plugins/multi_run.rb

@@ -55,6 +55,7 @@ class Roda
         # Freeze the multi_run apps so that there can be no thread safety issues at runtime.
         def freeze
           opts[:multi_run_apps].freeze
+          self::RodaRequest.refresh_multi_run_regexp!
           super
         end
 

data/lib/roda/plugins/named_templates.rb

@@ -24,7 +24,7 @@ class Roda
     # You can provide options for the template, for example to change the
     # engine that the template uses:
     #
-    #   template :index, :engine=>:str do
+    #   template :index, engine: :str do
     #     "<p>Hello #{@user}!</p>"
     #   end
     #   
@@ -37,7 +37,7 @@ class Roda
     #     "<p>#{greating} <%= @user %>!</p>"
     #   end
     #   
-    # This plugin also works with the view_subdirs plugin, as long as you
+    # This plugin also works with the view_options plugin, as long as you
     # prefix the template name with the view subdirectory:
     #
     #   template "main/index" do

data/lib/roda/plugins/optimized_string_matchers.rb

@@ -24,9 +24,6 @@ class Roda
     # correctly in such cases, but the captures will not be yielded to the
     # match blocks.
     module OptimizedStringMatchers
-      EMPTY_STRING = ''.freeze
-      RodaPlugins.deprecate_constant(self, :EMPTY_STRING)
-
       module RequestMethods
         # Optimized version of +on+ that only supports a single string.
         def on_branch(s)

data/lib/roda/plugins/padrino_render.rb

@@ -5,36 +5,33 @@ class Roda
   module RodaPlugins
     # The padrino_render plugin adds rendering support that is
     # similar to Padrino's.  While not everything Padrino's
-    # rendering supports is supported by this plugin (yet), it
+    # rendering supports is supported by this plugin, it
     # currently handles enough to be a drop in replacement for
     # some applications.
     # 
-    #   plugin :padrino_render, :views => 'path/2/views'
+    #   plugin :padrino_render, views: 'path/2/views'
     # 
     # Most notably, this makes the +render+ method default to
     # using the layout, similar to how the +view+ method works
     # in the render plugin.  If you want to call render and not
-    # use a layout, you can use the <tt>:layout=>false</tt>
+    # use a layout, you can use the <tt>layout: false</tt>
     # option:
     #
     #   render('test')                 # layout
-    #   render('test', :layout=>false) # no layout
+    #   render('test', layout: false)  # no layout
     #
     # Note that this plugin loads the :partials plugin.
     module PadrinoRender
-      OPTS = {}.freeze
-      RodaPlugins.deprecate_constant(self, :OPTS)
-
       # Depend on the render plugin, since this overrides
       # some of its methods.
-      def self.load_dependencies(app, opts=RodaPlugins::OPTS)
+      def self.load_dependencies(app, opts=OPTS)
         app.plugin :partials, opts
       end
 
       module InstanceMethods
         # Call view with the given arguments, so that render
         # uses a layout by default.
-        def render(template, opts=RodaPlugins::OPTS)
+        def render(template, opts=OPTS)
           view(template, opts)
         end
       end

data/lib/roda/plugins/param_matchers.rb

@@ -9,7 +9,7 @@ class Roda
     # It adds a :param matcher for matching on any param with the
     # same name, yielding the value of the param:
     #
-    #   r.on :param => 'foo' do |value|
+    #   r.on param: 'foo' do |value|
     #     # Matches '?foo=bar', '?foo='
     #     # Doesn't match '?bar=foo'
     #   end
@@ -17,7 +17,7 @@ class Roda
     # It adds a :param! matcher for matching on any non-empty param
     # with the same name, yielding the value of the param:
     #
-    #   r.on(:param! => 'foo') do |value|
+    #   r.on(param!: 'foo') do |value|
     #     # Matches '?foo=bar'
     #     # Doesn't match '?foo=', '?bar=foo'
     #   end
@@ -25,12 +25,12 @@ class Roda
     # It also adds :params and :params! matchers, for matching multiple
     # params at the same time:
     #
-    #   r.on :params => ['foo', 'baz'] do |value|
+    #   r.on params: ['foo', 'baz'] do |value|
     #     # Matches '?foo=bar&baz=quuz', '?foo=&baz='
     #     # Doesn't match '?foo=bar', '?baz='
     #   end
     #
-    #   r.on :params! => ['foo', 'baz'] do |value|
+    #   r.on params!: ['foo', 'baz'] do |value|
     #     # Matches '?foo=bar&baz=quuz'
     #     # Doesn't match '?foo=bar', '?baz=', '?foo=&baz=', '?foo=bar&baz='
     #   end
@@ -40,7 +40,7 @@ class Roda
         # Match the given parameter if present, even if the parameter is empty.
         # Adds match to the captures.
         def match_param(key)
-          if v = self[key]
+          if v = params[key.to_s]
             @captures << v
           end
         end
@@ -48,7 +48,7 @@ class Roda
         # Match the given parameter if present and not empty.
         # Adds match to the captures.
         def match_param!(key)
-          if (v = self[key]) && !v.empty?
+          if (v = params[key.to_s]) && !v.empty?
             @captures << v
           end
         end

data/lib/roda/plugins/params_capturing.rb

@@ -12,9 +12,9 @@ class Roda
     #   route do |r|
     #     # GET /foo/123/abc/67
     #     r.on("foo", :bar, :baz, :quux) do
-    #       r[:bar] #=> '123'
-    #       r[:baz] #=> 'abc'
-    #       r[:quux] #=> '67'
+    #       r.params['bar'] #=> '123'
+    #       r.params['baz'] #=> 'abc'
+    #       r.params['quux'] #=> '67'
     #     end
     #   end
     #
@@ -26,9 +26,9 @@ class Roda
     # captured segments to the +captures+ key:
     #
     #   r.on(:x, /(\d+)\/(\w+)/, :y) do
-    #     r[:x] #=> nil
-    #     r[:y] #=> nil
-    #     r[:captures] #=> ["foo", "123", "abc", "67"]
+    #     r.params['x'] #=> nil
+    #     r.params['y'] #=> nil
+    #     r.params['captures'] #=> ["foo", "123", "abc", "67"]
     #   end
     #
     # Note that the request params +captures+ entry will be appended to with
@@ -38,7 +38,7 @@ class Roda
     #     r.on(:x) do
     #       r.on(:y) do
     #         r.on(:z) do
-    #           r[:captures] # => ["foo", "123", "abc", "67"]
+    #           r.params['captures'] # => ["foo", "123", "abc", "67"]
     #         end
     #       end
     #     end
@@ -48,10 +48,6 @@ class Roda
     # by this plugin.  You can use +r.GET+ or +r.POST+ to get the underlying
     # entry, depending on how it was submitted.
     #
-    # Also note that the param keys are actually stored in +r.params+ as
-    # strings and not symbols (<tt>r[]</tt> converts the argument
-    # to a string before looking it up in +r.params+).
-    #
     # This plugin will also handle string matchers with placeholders if
     # the placeholder_string_matchers plugin is loaded before this plugin.
     #
@@ -67,33 +63,17 @@ class Roda
 
         private
 
-        if RUBY_VERSION >= '1.9'
-          # Regexp to scan for capture names. Uses positive lookbehind
-          # so it is only valid on ruby 1.9+, hence the use of eval.
-          STRING_PARAM_CAPTURE_REGEXP = eval("/(?<=:)\\w+/")
+        # Add the capture names from this string to list of param
+        # capture names if param capturing.
+        def _match_string(str)
+          cap_len = @captures.length
 
-          # Add the capture names from this string to list of param
-          # capture names if param capturing.
-          def _match_string(str)
-            if (pc = @_params_captures) && placeholder_string_matcher?
-              pc.concat(str.scan(STRING_PARAM_CAPTURE_REGEXP))
-            end
-            super
+          if (ret = super) && (pc = @_params_captures) && (cap_len != @captures.length)
+            # Handle use with placeholder_string_matchers plugin
+            pc.concat(str.scan(/(?<=:)\w+/))
           end
-        else
-          # :nocov:
-          # RODA3: Remove
-          # Ruby 1.8 doesn't support positive lookbehind, so include the
-          # colon in the scan, and strip it out later.
-          STRING_PARAM_CAPTURE_RANGE = 1..-1
 
-          def _match_string(str)
-            if (pc = @_params_captures) && placeholder_string_matcher?
-              pc.concat(str.scan(/:\w+/).map{|s| s[STRING_PARAM_CAPTURE_RANGE]})
-            end
-            super
-          end
-          # :nocov:
+          ret
         end
 
         # Add the symbol to the list of param capture names if param capturing.

data/lib/roda/plugins/partials.rb

@@ -6,7 +6,7 @@ class Roda
     # The partials plugin adds a +partial+ method, which renders 
     # templates without the layout.
     # 
-    #   plugin :partials, :views => 'path/2/views'
+    #   plugin :partials, views: 'path/2/views'
     # 
     # Template files are prefixed with an underscore:
     #
@@ -20,14 +20,9 @@ class Roda
     #
     # Note that this plugin automatically loads the :render plugin.
     module Partials
-      OPTS = {}.freeze
-      RodaPlugins.deprecate_constant(self, :OPTS)
-      SLASH = '/'.freeze
-      RodaPlugins.deprecate_constant(self, :SLASH)
-
       # Depend on the render plugin, since this overrides
       # some of its methods.
-      def self.load_dependencies(app, opts=RodaPlugins::OPTS)
+      def self.load_dependencies(app, opts=OPTS)
         app.plugin :render, opts
       end
 
@@ -35,7 +30,7 @@ class Roda
         # Renders the given template without a layout, but
         # prefixes the template filename to use with an 
         # underscore.
-        def partial(template, opts=RodaPlugins::OPTS)
+        def partial(template, opts=OPTS)
           opts = parse_template_opts(template, opts)
           if opts[:template]
             template = opts[:template].split('/')

data/lib/roda/plugins/path.rb

@@ -63,13 +63,10 @@ class Roda
     module Path
       DEFAULT_PORTS = {'http' => 80, 'https' => 443}.freeze
 
-      OPTS = {}.freeze
-      RodaPlugins.deprecate_constant(self, :OPTS)
-
       # Initialize the path classes when loading the plugin. Options:
       # :by_name :: Register classes by name, which is friendlier when reloading code (defaults to
       #             true in development mode)
-      def self.configure(app, opts=RodaPlugins::OPTS)
+      def self.configure(app, opts=OPTS)
         app.instance_eval do
           self.opts[:path_class_by_name] = opts.fetch(:by_name, ENV['RACK_ENV'] == 'development')
           self.opts[:path_classes] ||= {}
@@ -92,7 +89,7 @@ class Roda
         end
 
         # Create a new instance method for the named path.  See plugin module documentation for options.
-        def path(name, path=nil, opts=RodaPlugins::OPTS, &block)
+        def path(name, path=nil, opts=OPTS, &block)
           if name.is_a?(Class)
             raise RodaError, "can't provide path or options when calling path with a class" unless path.nil? && opts.empty?
             raise RodaError, "must provide a block when calling path with a class" unless block
@@ -124,11 +121,13 @@ class Roda
           if add_script_name || url || opts[:url_only]
             _meth = "_#{meth}"
             define_method(_meth, &block)
+            private _meth
           end
 
           unless opts[:url_only]
             if add_script_name
               define_method(meth) do |*a, &blk|
+                # Allow calling private _method to get path
                 request.script_name.to_s + send(_meth, *a, &blk)
               end
             else
@@ -149,6 +148,7 @@ class Roda
               port = r.port
               uri = ["#{scheme}://#{r.host}#{":#{port}" unless DEFAULT_PORTS[scheme] == port}"]
               uri << request.script_name.to_s if add_script_name
+              # Allow calling private _method to get path
               uri << send(_meth, *a, &blk)
               File.join(uri)
             end

data/lib/roda/plugins/path_matchers.rb

@@ -9,7 +9,7 @@ class Roda
     # It adds a :prefix matcher for matching on the path's prefix,
     # yielding the rest of the matched segment:
     #
-    #   r.on :prefix=>'foo' do |suffix|
+    #   r.on prefix: 'foo' do |suffix|
     #     # Matches '/foo-bar', yielding '-bar'
     #     # Does not match bar-foo
     #   end
@@ -17,7 +17,7 @@ class Roda
     # It adds a :suffix matcher for matching on the path's suffix,
     # yielding the part of the segment before the suffix:
     #
-    #   r.on :suffix=>'bar' do |prefix|
+    #   r.on suffix: 'bar' do |prefix|
     #     # Matches '/foo-bar', yielding 'foo-'
     #     # Does not match bar-foo
     #   end
@@ -25,7 +25,7 @@ class Roda
     # It adds an :extension matcher for matching on the given file extension,
     # yielding the part of the segment before the extension:
     #
-    #   r.on :extension=>'bar' do |reset|
+    #   r.on extension: 'bar' do |reset|
     #     # Matches '/foo.bar', yielding 'foo'
     #     # Does not match bar.foo
     #   end

data/lib/roda/plugins/path_rewriter.rb

@@ -18,10 +18,10 @@ class Roda
     #
     # In some cases, you may want to override PATH_INFO for the rewritten
     # paths, such as when you are passing the request to another Rack app.
-    # For those cases, you can use the <tt>:path_info => true</tt> option to
+    # For those cases, you can use the <tt>path_info: true</tt> option to
     # +rewrite_path+.
     #
-    #   rewrite_path '/a', '/b', :path_info => true
+    #   rewrite_path '/a', '/b', path_info: true
     #   # PATH_INFO '/a' => PATH_INFO '/b'
     #   # PATH_INFO '/a/c' => PATH_INFO '/b/c'
     #
@@ -38,18 +38,13 @@ class Roda
     #
     #   rewrite_path(/\A\/a\/(\w+)/){|match| "/a/#{match[1].capitalize}"}
     #   # PATH_INFO '/a/moo' => remaining_path '/a/Moo'
-    #   rewrite_path(/\A\/a\/(\w+)/, :path_info => true){|match| "/a/#{match[1].capitalize}"}
+    #   rewrite_path(/\A\/a\/(\w+)/, path_info: true){|match| "/a/#{match[1].capitalize}"}
     #   # PATH_INFO '/a/moo' => PATH_INFO '/a/Moo'
     #
     # All path rewrites are applied in order, so if a path is rewritten by one rewrite,
     # it can be rewritten again by a later rewrite.  Note that PATH_INFO rewrites are
     # processed before remaining_path rewrites.
     module PathRewriter
-      OPTS={}.freeze
-      RodaPlugins.deprecate_constant(self, :OPTS)
-      PATH_INFO = 'PATH_INFO'.freeze
-      RodaPlugins.deprecate_constant(self, :PATH_INFO)
-
       def self.configure(app)
         app.instance_exec do
           app.opts[:remaining_path_rewrites] ||= []
@@ -67,7 +62,7 @@ class Roda
 
         # Record a path rewrite from path +was+ to path +is+.  Options:
         # :path_info :: Modify PATH_INFO, not just remaining path.
-        def rewrite_path(was, is = nil, opts=RodaPlugins::OPTS, &block)
+        def rewrite_path(was, is = nil, opts=OPTS, &block)
           if is.is_a? Hash
             raise RodaError, "cannot provide two hashes to rewrite_path" unless opts.empty?
             opts = is