roda 2.28.0 → 2.29.0

data/lib/roda/plugins/caching.rb

@@ -70,6 +70,7 @@ class Roda
     # OTHER DEALINGS IN THE SOFTWARE.
     module Caching
       OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
 
       module RequestMethods
         LAST_MODIFIED = 'Last-Modified'.freeze
@@ -130,7 +131,7 @@ class Roda
         #
         # When the current request includes an If-Match header with a
         # etag that doesn't match, immediately returns a response with a 412 status.
-        def etag(value, opts=OPTS)
+        def etag(value, opts=RodaPlugins::OPTS)
           # Before touching this code, please double check RFC 2616 14.24 and 14.26.
           weak = opts[:weak]
           new_resource = opts.fetch(:new_resource){post?}
@@ -174,12 +175,19 @@ class Roda
 
       module ResponseMethods
         UNDERSCORE = '_'.freeze
+        RodaPlugins.deprecate_constant(self, :UNDERSCORE)
         DASH = '-'.freeze
+        RodaPlugins.deprecate_constant(self, :DASH)
         COMMA = ', '.freeze
+        RodaPlugins.deprecate_constant(self, :COMMA)
         CACHE_CONTROL = 'Cache-Control'.freeze
+        RodaPlugins.deprecate_constant(self, :CACHE_CONTROL)
         EXPIRES = 'Expires'.freeze
+        RodaPlugins.deprecate_constant(self, :EXPIRES)
         CONTENT_TYPE = 'Content-Type'.freeze
+        RodaPlugins.deprecate_constant(self, :CONTENT_TYPE)
         CONTENT_LENGTH = 'Content-Length'.freeze
+        RodaPlugins.deprecate_constant(self, :CONTENT_LENGTH)
 
         # Specify response freshness policy for using the Cache-Control header.
         # Options can can any non-value directives (:public, :private, :no_cache,
@@ -195,20 +203,20 @@ class Roda
           values = []
           opts.each do |k, v|
             next unless v
-            k = k.to_s.tr(UNDERSCORE, DASH)
+            k = k.to_s.tr('_', '-')
             values << (v == true ? k : "#{k}=#{v}")
           end
 
-          self[CACHE_CONTROL] = values.join(COMMA) unless values.empty?
+          self['Cache-Control'] = values.join(', ') unless values.empty?
         end
 
         # Set Cache-Control header with the max_age given.  max_age should
         # be an integer number of seconds that the current request should be
         # cached for.  Also sets the Expires header, useful if you have
         # HTTP 1.0 clients (Cache-Control is an HTTP 1.1 header).
-        def expires(max_age, opts=OPTS)
+        def expires(max_age, opts=RodaPlugins::OPTS)
           cache_control(Hash[opts].merge!(:max_age=>max_age))
-          self[EXPIRES] = (Time.now + max_age).httpdate
+          self['Expires'] = (Time.now + max_age).httpdate
         end
 
         # Remove Content-Type and Content-Length for 304 responses.
@@ -216,8 +224,8 @@ class Roda
           a = super
           if a[0] == 304
             h = a[1]
-            h.delete(CONTENT_TYPE)
-            h.delete(CONTENT_LENGTH)
+            h.delete('Content-Type')
+            h.delete('Content-Length')
           end
           a
         end

data/lib/roda/plugins/chunked.rb

@@ -146,7 +146,7 @@ class Roda
     # rotated.
     module Chunked
       OPTS = {}.freeze
-
+      RodaPlugins.deprecate_constant(self, :OPTS)
       HTTP_VERSION = 'HTTP_VERSION'.freeze
       RodaPlugins.deprecate_constant(self, :HTTP_VERSION)
       HTTP11 = "HTTP/1.1".freeze
@@ -157,14 +157,14 @@ class Roda
       RodaPlugins.deprecate_constant(self, :CHUNKED)
 
       # Depend on the render plugin
-      def self.load_dependencies(app, opts=OPTS)
+      def self.load_dependencies(app, opts=RodaPlugins::OPTS)
         app.plugin :render
       end
 
       # Set plugin specific options.  Options:
       # :chunk_by_default :: chunk all calls to view by default
       # :headers :: Set default additional headers to use when calling view
-      def self.configure(app, opts=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         app.opts[:chunk_by_default] = opts[:chunk_by_default]
         if opts[:headers]
           app.opts[:chunk_headers] = (app.opts[:chunk_headers] || {}).merge(opts[:headers]).freeze
@@ -174,8 +174,11 @@ class Roda
       # Rack response body instance for chunked responses
       class Body
         CHUNK_SIZE = "%x\r\n".freeze
+        RodaPlugins.deprecate_constant(self, :CHUNK_SIZE)
         CRLF = "\r\n".freeze
+        RodaPlugins.deprecate_constant(self, :CRLF)
         FINISH = "0\r\n\r\n".freeze
+        RodaPlugins.deprecate_constant(self, :FINISH)
 
         # Save the scope of the current request handling.
         def initialize(scope)
@@ -190,12 +193,12 @@ class Roda
         def each
           @scope.each_chunk do |chunk|
             next if !chunk || chunk.empty?
-            yield(CHUNK_SIZE % chunk.bytesize)
+            yield("%x\r\n" % chunk.bytesize)
             yield(chunk)
-            yield(CRLF)
+            yield("\r\n")
           end
         ensure
-          yield(FINISH)
+          yield("0\r\n\r\n")
         end
       end
 
@@ -218,7 +221,7 @@ class Roda
 
         # Render a response to the user in chunks.  See Chunked for
         # an overview.  If a block is given, it is passed to #delay.
-        def chunked(template, opts=OPTS, &block)
+        def chunked(template, opts=RodaPlugins::OPTS, &block)
           unless defined?(@_chunked)
             @_chunked = env['HTTP_VERSION'] == "HTTP/1.1"
           end

data/lib/roda/plugins/content_for.rb

@@ -44,7 +44,7 @@ class Roda
       # is called multiple times to set data. Overwrite is default, use
       # the :append option to append.
       def self.configure(app, opts = {})
-        app.opts[:append_content_for] = opts.fetch(:append, false)
+        app.opts[:append_content_for] = opts.fetch(:append, nil)
       end
 
       module InstanceMethods
@@ -71,6 +71,9 @@ class Roda
             if append
               (@_content_for[key] ||= []) << value
             else
+              if @_content_for[key] && append.nil?
+                RodaPlugins.warn "Attempt to set content_for with same key.  This currently overwrites the existing content_for for #{key}.  In Roda 3, it will start appending to the existing content_for by default.  Use the :append => false option to the content_for plugin to keep the existing behavior."
+              end
               @_content_for[key] = value
             end
           elsif @_content_for && (value = @_content_for[key])

data/lib/roda/plugins/drop_body.rb

@@ -11,8 +11,9 @@ class Roda
     module DropBody
       module ResponseMethods
         DROP_BODY_STATUSES = [100, 101, 102, 204, 205, 304].freeze
-        EMPTY_BODY = [].freeze
 
+        EMPTY_BODY = [].freeze
+        RodaPlugins.deprecate_constant(self, :EMPTY_BODY)
         CONTENT_LENGTH = "Content-Length".freeze
         RodaPlugins.deprecate_constant(self, :CONTENT_LENGTH)
         CONTENT_TYPE = "Content-Type".freeze
@@ -24,7 +25,7 @@ class Roda
         def finish
           r = super
           if DROP_BODY_STATUSES.include?(r[0])
-            r[2] = EMPTY_BODY
+            r[2] = EMPTY_ARRAY
             h = r[1]
             h.delete("Content-Length")
             h.delete("Content-Type")

data/lib/roda/plugins/error_email.rb

@@ -38,8 +38,9 @@ class Roda
     # use an error reporting service instead of this plugin.
     module ErrorEmail
       OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
       DEFAULTS = {
-        :headers=>OPTS,
+        :headers=>RodaPlugins::OPTS,
         :host=>'localhost',
         # :nocov:
         :emailer=>lambda{|h| Net::SMTP.start(h[:host]){|s| s.send_message(h[:message], h[:from], h[:to])}},
@@ -97,7 +98,7 @@ END
       }#.freeze # RODA3
 
       # Set default opts for plugin.  See ErrorEmail module RDoc for options.
-      def self.configure(app, opts=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         email_opts = app.opts[:error_email] ||= DEFAULTS
         email_opts = email_opts.merge(opts)
         email_opts[:headers] = email_opts[:headers].dup

data/lib/roda/plugins/error_mail.rb

@@ -37,10 +37,11 @@ class Roda
     # use an error reporting service instead of this plugin.
     module ErrorMail
       OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
 
       # Set default opts for plugin.  See ErrorEmail module RDoc for options.
-      def self.configure(app, opts=OPTS)
-        app.opts[:error_mail] = email_opts = (app.opts[:error_mail] || OPTS).merge(opts).freeze
+      def self.configure(app, opts=RodaPlugins::OPTS)
+        app.opts[:error_mail] = email_opts = (app.opts[:error_mail] || RodaPlugins::OPTS).merge(opts).freeze
         unless email_opts[:to] && email_opts[:from]
           raise RodaError, "must provide :to and :from options to error_mail plugin"
         end

data/lib/roda/plugins/head.rb

@@ -37,6 +37,7 @@ class Roda
     # may prevent search engine's from crawling your website.
     module Head
       EMPTY_ARRAY = [].freeze
+      RodaPlugins.deprecate_constant(self, :EMPTY_ARRAY)
 
       module InstanceMethods
         # Always use an empty response body for head requests, with a
@@ -44,7 +45,7 @@ class Roda
         def call(*)
           res = super
           if @_request.head?
-            res[2] = EMPTY_ARRAY
+            res[2] = RodaPlugins::EMPTY_ARRAY
           end
           res
         end

data/lib/roda/plugins/header_matchers.rb

@@ -67,6 +67,8 @@ class Roda
 
           if roda_class.opts[:header_matcher_prefix]
             key = "HTTP_#{key}"
+          else
+            RodaPlugins.warn ":header matcher used without :header_matcher_prefix app option.  Currently this looks for the #{key} header, but in Roda 3 it will look for the HTTP_#{key} header.  You should set the :header_matcher_prefix app option and update your code if necessary to avoid this deprecation warning."
           end
 
           if v = @env[key]
@@ -82,6 +84,7 @@ class Roda
               @captures.concat(match.captures)
             end
           else
+            RodaPlugins.warn ":host matcher used with regexp value without :host_matcher_captures app option, no capturing will be done.  Starting in Roda 3, the :host matcher will automatically capture if the value is a Regexp.  Set :host_matcher_captures app option to enable capturing." if hostname.is_a?(Regexp)
             hostname === host
           end
         end

data/lib/roda/plugins/heartbeat.rb

@@ -14,14 +14,15 @@ class Roda
     #
     #   plugin :heartbeat, :path=>'/status'
     module Heartbeat
-      OPTS = {}.freeze
       HEARTBEAT_RESPONSE = [200, {'Content-Type'=>'text/plain'}.freeze, ['OK'.freeze].freeze].freeze
 
+      OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
       PATH_INFO = 'PATH_INFO'.freeze
       RodaPlugins.deprecate_constant(self, :PATH_INFO)
 
       # Set the heartbeat path to the given path.
-      def self.configure(app, opts=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         app.opts[:heartbeat_path] = (opts[:path] || app.opts[:heartbeat_path] || "/heartbeat").dup.freeze
       end
 

data/lib/roda/plugins/json.rb

@@ -53,14 +53,15 @@ class Roda
     #
     #   plugin :json, :content_type=>'application/xml'
     module Json
-      OPTS = {}.freeze
       DEFAULT_SERIALIZER = :to_json.to_proc
 
+      OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
       DEFAULT_CONTENT_TYPE = 'application/json'.freeze
       RodaPlugins.deprecate_constant(self, :DEFAULT_CONTENT_TYPE)
 
       # Set the classes to automatically convert to JSON, and the serializer to use.
-      def self.configure(app, opts=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         classes = opts[:classes] || [Array, Hash]
         app.opts[:json_result_classes] ||= []
         app.opts[:json_result_classes] += classes
@@ -83,6 +84,7 @@ class Roda
 
       module RequestMethods
         CONTENT_TYPE = 'Content-Type'.freeze
+        RodaPlugins.deprecate_constant(self, :CONTENT_TYPE)
 
         private
 
@@ -92,7 +94,7 @@ class Roda
         def block_result_body(result)
           case result
           when *roda_class.json_result_classes
-            response[CONTENT_TYPE] ||= roda_class.opts[:json_result_content_type]
+            response['Content-Type'] ||= roda_class.opts[:json_result_content_type]
             convert_to_json(result)
           else
             super

data/lib/roda/plugins/json_parser.rb

@@ -11,10 +11,11 @@ class Roda
     # This only parses the request body as JSON if the Content-Type
     # header for the request includes "json".
     module JsonParser
-      OPTS = {}.freeze
       DEFAULT_ERROR_HANDLER = proc{|r| r.halt [400, {}, []]}
       DEFAULT_PARSER = JSON.method(:parse)
 
+      OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
       JSON_PARAMS_KEY = "roda.json_params".freeze
       RodaPlugins.deprecate_constant(self, :JSON_PARAMS_KEY)
       INPUT_KEY = "rack.input".freeze
@@ -35,7 +36,7 @@ class Roda
       # :include_request :: If true, the parser will be called with the request
       #                     object as the second argument, so the parser needs
       #                     to respond to +call(str, request)+.
-      def self.configure(app, opts=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         app.opts[:json_parser_error_handler] = opts[:error_handler] || app.opts[:json_parser_error_handler] || DEFAULT_ERROR_HANDLER
         app.opts[:json_parser_parser] = opts[:parser] || app.opts[:json_parser_parser] || DEFAULT_PARSER
         app.opts[:json_parser_include_request] = opts[:include_request] || app.opts[:json_parser_include_request]

data/lib/roda/plugins/mailer.rb

@@ -111,7 +111,7 @@ class Roda
     # available in your email views.
     module Mailer
       OPTS = {}.freeze
-
+      RodaPlugins.deprecate_constant(self, :OPTS)
       REQUEST_METHOD = "REQUEST_METHOD".freeze
       RodaPlugins.deprecate_constant(self, :REQUEST_METHOD)
       PATH_INFO = "PATH_INFO".freeze
@@ -139,8 +139,8 @@ class Roda
 
       # Set the options for the mailer.  Options:
       # :content_type :: The default content type for emails (default: text/plain)
-      def self.configure(app, opts=OPTS)
-        app.opts[:mailer] = (app.opts[:mailer]||{}).merge(opts).freeze
+      def self.configure(app, opts=RodaPlugins::OPTS)
+        app.opts[:mailer] = (app.opts[:mailer]||RodaPlugins::OPTS).merge(opts).freeze
       end
 
       module ClassMethods

data/lib/roda/plugins/match_affix.rb

@@ -25,12 +25,18 @@ class Roda
     #
     # will not modify the prefix and will change the suffix so that it consumes a trailing slash
     # at the end of the path only.
+    #
+    # 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
+
       # Set the default prefix and suffix to use in match patterns, if a non-nil value
       # is given.
       def self.configure(app, prefix, suffix=nil)

data/lib/roda/plugins/multi_route.rb

@@ -150,7 +150,9 @@ class Roda
 
         # The names for the currently stored named routes
         def named_routes(namespace=nil)
-          routes = opts[:namespaced_routes][namespace]
+          unless routes = opts[:namespaced_routes][namespace]
+            RodaPlugins.warn "Attempt to access multi_route namespace for which no routes have been defined: #{namespace}"
+          end
           routes ? routes.keys : []
         end
 

data/lib/roda/plugins/padrino_render.rb

@@ -23,17 +23,18 @@ class Roda
     # 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=OPTS)
+      def self.load_dependencies(app, opts=RodaPlugins::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=OPTS)
+        def render(template, opts=RodaPlugins::OPTS)
           view(template, opts)
         end
       end

data/lib/roda/plugins/params_capturing.rb

@@ -52,8 +52,8 @@ class Roda
     # 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 if placeholders in
-    # string matchers are supported.
+    # This plugin will also handle string matchers with placeholders if
+    # the placeholder_string_matchers plugin is loaded before this plugin.
     #
     # Also note that this plugin will not work correctly if you are using
     # the symbol_matchers plugin with custom symbol matching and are using
@@ -82,7 +82,7 @@ class Roda
           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

data/lib/roda/plugins/partials.rb

@@ -21,13 +21,13 @@ 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=OPTS)
+      def self.load_dependencies(app, opts=RodaPlugins::OPTS)
         app.plugin :render, opts
       end
 
@@ -35,7 +35,7 @@ class Roda
         # Renders the given template without a layout, but
         # prefixes the template filename to use with an 
         # underscore.
-        def partial(template, opts=OPTS)
+        def partial(template, opts=RodaPlugins::OPTS)
           opts = parse_template_opts(template, opts)
           if opts[:template]
             template = opts[:template].split('/')

data/lib/roda/plugins/path.rb

@@ -62,12 +62,14 @@ class Roda
     # a block to a block that is instance_execed.
     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=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         app.instance_eval do
           self.opts[:path_class_by_name] = opts.fetch(:by_name, ENV['RACK_ENV'] == 'development')
           self.opts[:path_classes] ||= {}
@@ -90,7 +92,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=OPTS, &block)
+        def path(name, path=nil, opts=RodaPlugins::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