roda 2.29.0 → 3.0.0

data/lib/roda/plugins/h.rb

@@ -17,8 +17,10 @@ class Roda
       begin
         require 'cgi/escape'
         unless CGI.respond_to?(:escapeHTML) # work around for JRuby 9.1
+          # :nocov:
           CGI = Object.new
           CGI.extend(defined?(::CGI::Escape) ? ::CGI::Escape : ::CGI::Util)
+          # :nocov:
         end
 
         module InstanceMethods
@@ -28,6 +30,8 @@ class Roda
           end
         end
       rescue LoadError
+        # :nocov:
+
         # A Hash of entities and their escaped equivalents,
         # to be escaped by h().
         ESCAPE_HTML = {
@@ -46,6 +50,7 @@ class Roda
             string.to_s.gsub(ESCAPE_HTML_PATTERN){|c| ESCAPE_HTML[c] }
           end
         end
+        # :nocov:
       end
     end
 

data/lib/roda/plugins/hash_matcher.rb

@@ -12,7 +12,7 @@ class Roda
     #     end
     #
     #     route do
-    #       r.on :foo=>'bar' do
+    #       r.on foo: 'bar' do
     #         # matches when param foo has value bar
     #       end
     #     end
@@ -25,7 +25,9 @@ class Roda
         # match, and anything else to match.  See the HashMatcher module
         # documentation for an example.
         def hash_matcher(key, &block)
-          self::RodaRequest.send(:define_method, :"match_#{key}", &block)
+          meth = :"match_#{key}"
+          self::RodaRequest.send(:define_method, meth, &block)
+          self::RodaRequest.send(:private, meth)
         end
       end
     end

data/lib/roda/plugins/head.rb

@@ -18,7 +18,7 @@ class Roda
     #       'a'
     #     end
     #
-    #     r.is 'b', :method=>[:get, :post] do
+    #     r.is 'b', method: [:get, :post] do
     #       'b'
     #     end
     #   end
@@ -31,21 +31,19 @@ class Roda
     # header options, then HEAD will be as well.
     #
     # NOTE: if you have a public facing website it is recommended that
-    # you enable this plugin. Search engines and other bots may send a
+    # you enable this plugin, or manually handle HEAD anywhere you would
+    # handle GET. Search engines and other bots may send a
     # HEAD request prior to crawling a page with a GET request. Without
     # this plugin those HEAD requests will return a 404 status, which
-    # may prevent search engine's from crawling your website.
+    # may prevent search engines 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
         # content length of 0.
         def call(*)
           res = super
           if @_request.head?
-            res[2] = RodaPlugins::EMPTY_ARRAY
+            res[2] = EMPTY_ARRAY
           end
           res
         end

data/lib/roda/plugins/header_matchers.rb

@@ -9,46 +9,34 @@ class Roda
     #   plugin :header_matchers
     #
     # It adds a +:header+ matcher for matching on arbitrary headers, which matches
-    # if the header is present:
+    # if the header is present, and yields the header value:
     #
-    #   r.on :header=>'HTTP-X-App-Token' do |header_value|
-    #     # Looks for env['HTTP_X_APP_TOKEN']
-    #   end
-    #
-    # For backwards compatibility, the header value is not automatically prefixed
-    # with HTTP_.  You can set the +:header_matcher_prefix+ option for the application,
-    # which will automatically prefix the header with HTTP_:
-    #
-    #   r.on :header=>'X-App-Token' do |header_value|
-    #     # Looks for env['HTTP_X_APP_TOKEN'] 
+    #   r.on header: 'HTTP-X-App-Token' do |header_value|
+    #     # Looks for env['HTTP_X_APP_TOKEN'] and yields it
     #   end
     #
     # It adds a +:host+ matcher for matching by the host of the request:
     #
-    #   r.on :host=>'foo.example.com' do
-    #   end
-    #   r.on :host=>/\A\w+.example.com\z/ do
+    #   r.on host: 'foo.example.com' do
     #   end
     #
-    # By default the +:host+ matcher does not yield matchers, but if you use a regexp
-    # and set the +:host_matcher_captures+ option for the application, it will
-    # yield regexp captures:
-    # 
-    #   r.on :host=>/\A(\w+).example.com\z/ do |subdomain|
+    # For regexp values of the +:host+ matcher, any captures are yielded to the block:
+    #
+    #   r.on host: /\A(\w+).example.com\z/ do |subdomain|
     #   end
     #
     # It adds a +:user_agent+ matcher for matching on a user agent patterns, which
     # yields the regexp captures to the block:
     #
-    #   r.on :user_agent=>/Chrome\/([.\d]+)/ do |chrome_version|
+    #   r.on user_agent: /Chrome\/([.\d]+)/ do |chrome_version|
     #   end
     #
     # It adds an +:accept+ matcher for matching based on the Accept header:
     #
-    #   r.on :accept=>'text/csv' do
+    #   r.on accept: 'text/csv' do
     #   end
     #
-    # Note that the accept matcher is very simple and cannot handle wildcards,
+    # Note that the +:accept+ matcher is very simple and cannot handle wildcards,
     # priorities, or anything but a simple comma separated list of mime types.
     module HeaderMatchers
       module RequestMethods
@@ -63,15 +51,7 @@ class Roda
 
         # Match if the given uppercase key is present inside the environment.
         def match_header(key)
-          key = key.upcase.tr("-","_")
-
-          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]
+          if v = @env["HTTP_#{key.upcase.tr("-","_")}"]
             @captures << v
           end
         end
@@ -79,12 +59,11 @@ class Roda
         # Match if the host of the request is the same as the hostname.  +hostname+
         # can be a regexp or a string.
         def match_host(hostname)
-          if hostname.is_a?(Regexp) && roda_class.opts[:host_matcher_captures]
+          if hostname.is_a?(Regexp)
             if match = hostname.match(host)
               @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

@@ -12,17 +12,12 @@ class Roda
     #
     # You can also specify a custom heartbeat path:
     #
-    #   plugin :heartbeat, :path=>'/status'
+    #   plugin :heartbeat, path: '/status'
     module Heartbeat
       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=RodaPlugins::OPTS)
+      def self.configure(app, opts=OPTS)
         app.opts[:heartbeat_path] = (opts[:path] || app.opts[:heartbeat_path] || "/heartbeat").dup.freeze
       end
 

data/lib/roda/plugins/indifferent_params.rb

@@ -35,7 +35,6 @@ class Roda
       INDIFFERENT_PROC = lambda{|h,k| h[k.to_s] if k.is_a?(Symbol)}
 
       if Rack.release > '2'
-        # :nocov:
         class QueryParser < Rack::QueryParser
           # Work around for invalid optimization in rack
           def parse_nested_query(qs, d=nil)
@@ -66,8 +65,8 @@ class Roda
             @_request.params
           end
         end
-        # :nocov:
       else
+        # :nocov:
         module InstanceMethods
           # A copy of the request params that will automatically
           # convert symbols to strings.
@@ -93,6 +92,7 @@ class Roda
             end
           end
         end
+        # :nocov:
       end  
     end
 

data/lib/roda/plugins/json.rb

@@ -33,35 +33,30 @@ class Roda
     # can specifically set the allowed classes to json by adding
     # using the :classes option when loading the plugin:
     #
-    #   plugin :json, :classes=>[Array, Hash, Sequel::Model]
+    #   plugin :json, classes: [Array, Hash, Sequel::Model]
     #
     # By default objects are serialized with +to_json+, but you
     # can pass in a custom serializer, which can be any object
     # that responds to +call(object)+.
     #
-    #   plugin :json, :serializer=>proc{|o| o.to_json(root: true)}
+    #   plugin :json, serializer: proc{|o| o.to_json(root: true)}
     #
     # If you need the request information during serialization, such
     # as HTTP headers or query parameters, you can pass in the
     # +:include_request+ option, which will pass in the request
     # object as the second argument when calling the serializer.
     #
-    #   plugin :json, :include_request=>true, :serializer=>proc{|o, request| ...}
+    #   plugin :json, include_request: true, serializer: proc{|o, request| ...}
     #
     # The default content-type is 'application/json', but you can change that
     # using the +:content_type+ option:
     #
-    #   plugin :json, :content_type=>'application/xml'
+    #   plugin :json, content_type: 'application/xml'
     module Json
       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=RodaPlugins::OPTS)
+      def self.configure(app, opts=OPTS)
         classes = opts[:classes] || [Array, Hash]
         app.opts[:json_result_classes] ||= []
         app.opts[:json_result_classes] += classes
@@ -70,7 +65,7 @@ class Roda
 
         app.opts[:json_result_serializer] = opts[:serializer] || app.opts[:json_result_serializer] || DEFAULT_SERIALIZER
 
-        app.opts[:json_result_include_request] = opts[:include_request] || app.opts[:json_result_include_request]
+        app.opts[:json_result_include_request] = opts[:include_request] if opts.has_key?(:include_request)
 
         app.opts[:json_result_content_type] = opts[:content_type] || 'application/json'.freeze
       end
@@ -83,9 +78,6 @@ class Roda
       end
 
       module RequestMethods
-        CONTENT_TYPE = 'Content-Type'.freeze
-        RodaPlugins.deprecate_constant(self, :CONTENT_TYPE)
-
         private
 
         # If the result is an instance of one of the json_result_classes,

data/lib/roda/plugins/json_parser.rb

@@ -14,17 +14,6 @@ class Roda
       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
-      RodaPlugins.deprecate_constant(self, :INPUT_KEY)
-      FORM_HASH_KEY = "rack.request.form_hash".freeze
-      RodaPlugins.deprecate_constant(self, :FORM_HASH_KEY)
-      FORM_INPUT_KEY = "rack.request.form_input".freeze
-      RodaPlugins.deprecate_constant(self, :FORM_INPUT_KEY)
-
       # Handle options for the json_parser plugin:
       # :error_handler :: A proc to call if an exception is raised when
       #                   parsing a JSON request body.  The proc is called
@@ -36,10 +25,10 @@ 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=RodaPlugins::OPTS)
+      def self.configure(app, opts=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]
+        app.opts[:json_parser_include_request] = opts[:include_request] if opts.has_key?(:include_request)
       end
 
       module RequestMethods

data/lib/roda/plugins/mailer.rb

@@ -7,14 +7,15 @@ class Roda
   module RodaPlugins
     # The mailer plugin allows your Roda application to send emails easily.
     #
-    #   class App < Roda
+    #   class Mailer < Roda
     #     plugin :render
     #     plugin :mailer
     #
     #     route do |r|
-    #       r.on "albums" do
-    #         r.mail "added" do |album|
-    #           @album = album
+    #       r.on "albums", Integer do |album_id|
+    #         @album = Album[album_id]
+    #
+    #         r.mail "added" do
     #           from 'from@example.com'
     #           to 'to@example.com'
     #           cc 'cc@example.com'
@@ -29,12 +30,12 @@ class Roda
     #
     # The default method for sending a mail is +sendmail+:
     #
-    #   App.sendmail("/albums/added", Album[1])
+    #   Mailer.sendmail("/albums/1/added")
     #
     # If you want to return the <tt>Mail::Message</tt> instance for further modification,
     # you can just use the +mail+ method:
     #
-    #   mail = App.mail("/albums/added", Album[1])
+    #   mail = Mailer.mail("/albums/1/added")
     #   mail.from 'from2@example.com'
     #   mail.deliver
     #
@@ -43,12 +44,12 @@ class Roda
     # more details):
     #
     #   Mail.defaults do
-    #     delivery_method :smtp, :address=>'smtp.example.com', :port=>587
+    #     delivery_method :smtp, address: 'smtp.example.com', port: 587
     #   end
     #
     # You can support multipart emails using +text_part+ and +html_part+:
     #
-    #   r.mail "added" do |album_added|
+    #   r.mail "added" do
     #     from 'from@example.com'
     #     to 'to@example.com'
     #     subject 'Album Added'
@@ -97,11 +98,22 @@ class Roda
     #    # ...
     #  end
     #
+    # You can pass arguments when calling +mail+ or +sendmail+, and they
+    # will be yielded as additional arguments to the appropriate +r.mail+ block:
+    # 
+    #  Mailer.sendmail('/welcome/1', 'foo@example.com')
+    #
+    #  r.mail 'welcome' do |user_id, mail_from| 
+    #    from mail_from
+    #    to User[user_id].email
+    #    # ...
+    #  end
+    #
     # By default, the mailer uses text/plain as the Content-Type for emails.
     # You can override the default by specifying a :content_type option when
     # loading the plugin:
     #
-    #   plugin :mailer, :content_type=>'text/html'
+    #   plugin :mailer, content_type: 'text/html'
     #
     # The mailer plugin does support being used inside a Roda application
     # that is handling web requests, where the routing block for mails and
@@ -110,43 +122,21 @@ class Roda
     # Roda application if you want your helper methods to automatically be
     # 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
-      RodaPlugins.deprecate_constant(self, :PATH_INFO)
-      SCRIPT_NAME = 'SCRIPT_NAME'.freeze
-      RodaPlugins.deprecate_constant(self, :SCRIPT_NAME)
-      EMPTY_STRING = ''.freeze
-      RodaPlugins.deprecate_constant(self, :EMPTY_STRING)
-      RACK_INPUT = 'rack.input'.freeze
-      RodaPlugins.deprecate_constant(self, :RACK_INPUT)
-      RODA_MAIL = 'roda.mail'.freeze
-      RodaPlugins.deprecate_constant(self, :RODA_MAIL)
-      RODA_MAIL_ARGS = 'roda.mail_args'.freeze
-      RodaPlugins.deprecate_constant(self, :RODA_MAIL_ARGS)
-      MAIL = "MAIL".freeze
-      RodaPlugins.deprecate_constant(self, :MAIL)
-      CONTENT_TYPE = 'Content-Type'.freeze
-      RodaPlugins.deprecate_constant(self, :CONTENT_TYPE)
-      TEXT_PLAIN = "text/plain".freeze
-      RodaPlugins.deprecate_constant(self, :TEXT_PLAIN)
-
       # Error raised when the using the mail class method, but the routing
       # tree doesn't return the mail object. 
       class Error < ::Roda::RodaError; end
 
       # Set the options for the mailer.  Options:
       # :content_type :: The default content type for emails (default: text/plain)
-      def self.configure(app, opts=RodaPlugins::OPTS)
-        app.opts[:mailer] = (app.opts[:mailer]||RodaPlugins::OPTS).merge(opts).freeze
+      def self.configure(app, opts=OPTS)
+        app.opts[:mailer] = (app.opts[:mailer]||OPTS).merge(opts).freeze
       end
 
       module ClassMethods
         # Return a Mail::Message instance for the email for the given request path
-        # and arguments.  You can further manipulate the returned mail object before
-        # calling +deliver+ to send the mail.
+        # and arguments.   Any arguments given are yielded to the appropriate +r.mail+
+        # block after any usual match block arguments. You can further manipulate the
+        #returned mail object before calling +deliver+ to send the mail.
         def mail(path, *args)
           mail = ::Mail.new
           catch(:no_mail) do
@@ -157,7 +147,7 @@ class Roda
           end
         end
 
-        # Calls +mail+ and immediately sends the resulting mail.
+        # Calls +mail+ with given arguments and immediately sends the resulting mail.
         def sendmail(*args)
           if m = mail(*args)
             m.deliver
@@ -228,7 +218,7 @@ class Roda
         # Add delegates for common email methods.
         [:from, :to, :cc, :bcc, :subject].each do |meth|
           define_method(meth) do |*args|
-            env['roda.mail'].send(meth, *args)
+            env['roda.mail'].public_send(meth, *args)
             nil
           end
         end
@@ -267,7 +257,7 @@ class Roda
         # Set the text_part or html_part (depending on the method) in the related email,
         # using the given body and optional headers.
         def _mail_part(meth, body, headers=nil)
-          env['roda.mail'].send(meth) do
+          env['roda.mail'].public_send(meth) do
             body(body)
             headers(headers) if headers
           end