roda 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ec447de1d1c9201190d3e05cddc9ca3aca957e4
-  data.tar.gz: fc6e061b744a3ed47259369907bb82e222d12515
+  metadata.gz: 035bdb54b566e77c48d1332fdd7ebf396a849193
+  data.tar.gz: 682a8a39b4dc9e25d1395102890f8650f750e12d
 SHA512:
-  metadata.gz: a5d0a587873870952a81b8df6a0828c76d68e2de2ff6d388f1ccbf82da5b45815722460ba51a540d1cf74f11fa7911b45d6e7928515901095eb08a8d76754ade
-  data.tar.gz: 33f7d3837fdf5b846169597868531493e00cf1089b2d68771e2b9ea1345603adb3462ca8283735ab393721ddb461467a0813cb9b05d13cdda869d8d62aaf143f
+  metadata.gz: c219eb5e94a58c04d90256d87cbe5a86c1dc8c972666cbf61d97a34c5f3b4bc8d6b7de56fdee7aa65ef01ba70d7f4052d479c80211f49201dc94705e17e69308
+  data.tar.gz: ba8d204672492c04de406eb87d276c59e92af57047c4cc6bb479e7fc9efb1785fd314df682e496bc905327450571497f77581fef04a29346159de747172f07bc

data/CHANGELOG

@@ -1,3 +1,27 @@
+= 2.0.0 (2015-02-13)
+
+* Allow Roda app to be used as a regular rack app even when using the middleware plugin (jeremyevans)
+
+* Make render plugin :layout option always be true or false (jeremyevans)
+
+* Make :layout=>true view option use the default layout (jeremyevans)
+
+* Make error_handler plugin rescue ScriptError in addition to StandardError (jeremyevans)
+
+* Make halt plugin integrate with symbol_views, json, and similar plugins (jeremyevans)
+
+* Add padrino_render plugin, adding render/partial methods that work similar to Padrino (jeremyevans)
+
+* Add Roda#render_template private method for template rendering, for use by plugins (jeremyevans)
+
+* Make Roda#initialize take env hash, #call take route_block, remove private #_route (jeremyevans)
+
+* Remove keep_remaining_path/update_remaining_path private request methods (jeremyevans)
+
+* Don't modify SCRIPT_NAME/PATH_INFO during routing, merging static_path_info plugin into core (jeremyevans)
+
+* Remove code deprecated in Roda 1.3.0 (jeremyevans)
+
 = 1.3.0 (2015-01-13)
 
 * Make static_path_info plugin restore original SCRIPT_NAME/PATH_INFO before returning from r.run (jeremyevans)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Jeremy Evans
+Copyright (c) 2014-2015 Jeremy Evans
 Copyright (c) 2010, 2011 Michel Martens, Damian Janowski and Cyril David
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

data/README.rdoc

@@ -292,7 +292,8 @@ Colons that are not followed by a <tt>\\w</tt> character are matched literally:
 
   ":/a" # matches "/:/a"
 
-Note that strings must be escaped before being used in a regular expression, so:
+Note that other than colons, strings do no handle regular expression syntax, the
+string is matched verbatim:
 
   "\\d+(/\\w+)?" # matches "/\d+(/\w+)?"
   "\\d+(/\\w+)?" # does not match "/123/abc"
@@ -499,12 +500,14 @@ you can use the module_include plugin.
 
 Roda tries very hard to avoid polluting the scope of the +route+ block.
 This should make it unlikely that Roda will cause namespace issues
-with your application code.  Some of the things Roda does
+with your application code.  Some of the things Roda does:
 
 - The only instance variables defined by default in the scope of the +route+ block
-  are <tt>@_request</tt> and <tt>@_response</tt>.
+  are <tt>@_request</tt> and <tt>@_response</tt>.  All instance variables in the
+  scope of the +route+ block used by plugins that ship with Roda are prefixed
+  with an underscore.
 - The only methods defined (beyond the default methods for +Object+) are:
-  +env+, +opts+, +request+, +response+, +call+, +session+, and +_route+ (private).
+  +call+, +env+, +opts+, +request+, +response+, and +session+.
 - Constants inside the Roda namespace are all prefixed with +Roda+
   (e.g., <tt>Roda::RodaRequest</tt>).
 

data/doc/release_notes/2.0.0.txt

@@ -0,0 +1,75 @@
+= Backwards Compatibility
+
+* RodaResponse#set_cookie and #delete_cookie have been removed.
+
+* Roda.request_module and .response_module have been removed.
+
+* Roda.hash_matcher has been removed.
+
+* The :extension hash matcher has been removed.
+
+* The :param and :param! hash matchers have been removed.
+
+* RodaRequest#full_path_info has been removed.
+
+* The :opts render plugin option is no longer respected, Use the
+  :template_opts option instead.
+
+* Plugin option hashes for the chunked, default_headers,
+  error_email, and render plugins are now frozen.
+
+* The :header hash matcher in the header_matchers plugin now
+  yields the header value to the block.
+
+* Roda.json_result_classes in the json plugin is now frozen.
+
+* The PATH_INFO and SCRIPT_NAME env variables are no longer modified
+  during routing.
+
+* Roda#initialize now takes an env hash, and #call now takes the
+  route block.  The private #_route method has been removed.
+  
+* RodaRequest#keep_remaining_path/#updating_remaining_path private
+  methods have been removed.
+
+* The render plugin's :layout option is now always set to true or
+  false, specifying whether a layout should be used by default.
+  The template used for a layout is now located as the :template
+  option inside :layout_opts.
+
+= New Plugins
+
+* A padrino_render plugin has been added, which adds render/partial
+  methods that work similarly to Padrino's.
+
+= Other New Features
+
+* A Roda#render_template private method has been added to the render
+  plugin.  All internal users of render should switch to calling
+  render_template.
+
+* The halt plugin now integrates with the symbol_views and json
+  plugins, allowing things like:
+
+    r.halt(:template)
+    r.halt('key'=>'value')
+
+= Other Improvements
+
+* The error_handler plugin now rescues ScriptError in addition to
+  StandardError.  This handles SyntaxError (raised by ERB),
+  LoadError (raised by require), and NotImplementedError (raised
+  by TSort).
+
+* Using a :layout=>true option to the render plugin's view method
+  now uses the default layout template, instead of a template named
+  'true'.  It can be used to force a layout even if the render
+  plugin has been configured to not use a layout by default.
+
+* Roda apps that use the middleware plugin can now be used as regular
+  rack apps.  Previously, using the middleware plugin made it
+  impossible to use the app as a regular rack app.
+
+* Roda#request and #response are now faster.
+
+* Roda avoids creating unnecessary hashes in more places now.

data/lib/roda/plugins/assets.rb

@@ -396,7 +396,7 @@ class Roda
         def compile_assets_files(files, type, dirs)
           dirs = nil if dirs && dirs.empty?
           o = assets_opts
-          app = new
+          app = allocate
 
           content = files.map do |file|
             file = "#{dirs.join('/')}/#{file}" if dirs && o[:group_subdirs]
@@ -548,7 +548,7 @@ class Roda
         # Render the given asset file using the render plugin, with the given options.
         # +file+ should be the relative path to the file from the current directory.
         def render_asset_file(file, options)
-          render({:path => file}, options)
+          render_template({:path => file}, options)
         end
       end
 

data/lib/roda/plugins/backtracking_array.rb

@@ -36,11 +36,7 @@ class Roda
         def _match_array(arg, rest=nil)
           return super unless rest
 
-          unless path = @remaining_path
-            e = @env
-            script = e[SCRIPT_NAME]
-            path = e[PATH_INFO]
-          end
+          path = @remaining_path
           captures = @captures
           caps = captures.dup
           arg.each do |v|
@@ -55,12 +51,7 @@ class Roda
 
               # Matching all remaining elements failed, reset state
               captures.replace(caps)
-              if @remaining_path
-                @remaining_path = path
-              else
-                e[SCRIPT_NAME] = script
-                e[PATH_INFO] = path
-              end
+              @remaining_path = path
             end
           end
           false

data/lib/roda/plugins/caching.rb

@@ -66,6 +66,8 @@ class Roda
     # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
     # OTHER DEALINGS IN THE SOFTWARE.
     module Caching
+      OPTS = {}.freeze
+
       module RequestMethods
         LAST_MODIFIED = 'Last-Modified'.freeze
         HTTP_IF_NONE_MATCH = 'HTTP_IF_NONE_MATCH'.freeze
@@ -118,7 +120,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={})
+        def etag(value, opts=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?}
@@ -194,7 +196,7 @@ class Roda
         # 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={})
+        def expires(max_age, opts=OPTS)
           cache_control(opts.merge(:max_age=>max_age))
           self[EXPIRES] = (Time.now + max_age).httpdate
         end

data/lib/roda/plugins/chunked.rb

@@ -142,8 +142,7 @@ class Roda
       def self.configure(app, opts=OPTS)
         app.opts[:chunk_by_default] = opts[:chunk_by_default]
         if opts[:headers]
-          app.opts[:chunk_headers] = (app.opts[:chunk_headers] || {}).merge(opts[:headers])
-          app.opts[:chunk_headers].extend(RodaDeprecateMutation)
+          app.opts[:chunk_headers] = (app.opts[:chunk_headers] || {}).merge(opts[:headers]).freeze
         end
       end
 
@@ -241,15 +240,11 @@ class Roda
             @_out_buf = ''
           end
 
-          if layout =  opts.fetch(:layout, render_opts[:layout])
-            if layout_opts = opts[:layout_opts]
-              layout_opts = render_opts[:layout_opts].merge(layout_opts)
-            end
-
-            @_out_buf = render(layout, layout_opts||OPTS) do
+          if layout_opts  = view_layout_opts(opts)
+            @_out_buf = render_template(layout_opts) do
               flush
               block.call if block
-              yield opts[:content] || render(template, opts)
+              yield opts[:content] || render_template(template, opts)
               nil
             end
           else

data/lib/roda/plugins/class_level_routing.rb

@@ -70,11 +70,9 @@ class Roda
       end
 
       module InstanceMethods
-        private
-
         # If the normal routing tree doesn't handle an action, try each class level route
         # to see if it matches.
-        def _route(&block)
+        def call
           result = super
 
           if result[0] == 404 && (v = result[2]).is_a?(Array) && v.empty?

data/lib/roda/plugins/default_headers.rb

@@ -20,8 +20,7 @@ class Roda
     module DefaultHeaders
       # Merge the given headers into the existing default headers, if any.
       def self.configure(app, headers={})
-        app.opts[:default_headers] = (app.opts[:default_headers] || {}).merge(headers)
-        app.opts[:default_headers].extend(RodaDeprecateMutation)
+        app.opts[:default_headers] = (app.opts[:default_headers] || {}).merge(headers).freeze
       end 
 
       module ClassMethods

data/lib/roda/plugins/error_email.rb

@@ -28,6 +28,7 @@ class Roda
     # for low traffic web applications.  For high traffic web applications,
     # use an error reporting service instead of this plugin.
     module ErrorEmail
+      OPTS = {}.freeze
       DEFAULTS = {
         :headers=>{},
         :host=>'localhost',
@@ -74,7 +75,7 @@ END
       }
 
       # Set default opts for plugin.  See ErrorEmail module RDoc for options.
-      def self.configure(app, opts={})
+      def self.configure(app, opts=OPTS)
         email_opts = app.opts[:error_email] ||= DEFAULTS
         email_opts = email_opts.merge(opts)
         email_opts[:headers] = email_opts[:headers].dup
@@ -82,19 +83,8 @@ END
           raise RodaError, "must provide :to and :from options to error_email plugin"
         end
         app.opts[:error_email] = email_opts
-        app.opts[:error_email].extend(RodaDeprecateMutation)
-        app.opts[:error_email][:headers].extend(RodaDeprecateMutation)
-      end
-
-      module ClassMethods
-        # Dup the error email opts in the subclass so changes to the subclass do not affect
-        # the superclass.
-        def inherited(subclass)
-          super
-          opts = subclass.opts[:error_email].dup
-          opts[:headers] = opts[:headers].dup.extend(RodaDeprecateMutation)
-          subclass.opts[:error_email] = opts.extend(RodaDeprecateMutation)
-        end
+        app.opts[:error_email][:headers].freeze
+        app.opts[:error_email].freeze
       end
 
       module InstanceMethods

data/lib/roda/plugins/error_handler.rb

@@ -46,18 +46,18 @@ class Roda
       end
 
       module InstanceMethods
-        private
-
         # If an error occurs, set the response status to 500 and call
         # the error handler.
-        def _route
+        def call
           super
-        rescue => e
+        rescue StandardError, ScriptError => e
           res = @_response = self.class::RodaResponse.new
           res.status = 500
           super{handle_error(e)}
         end
 
+        private
+
         # By default, have the error handler reraise the error, so using
         # the plugin without installing an error handler doesn't change
         # behavior.

data/lib/roda/plugins/flash.rb

@@ -87,11 +87,9 @@ class Roda
           @_flash ||= FlashHash.new(session[KEY])
         end
 
-        private
-
         # If the routing doesn't raise an error, rotate the flash
         # hash in the session so the next request has access to it.
-        def _route
+        def call
           res = super
 
           if f = @_flash

data/lib/roda/plugins/halt.rb

@@ -35,6 +35,23 @@ class Roda
     # arguments and providing them as a single rack response array.  With a rack response array,
     # the values are used directly, while with 3 arguments, the headers given are merged into
     # the existing headers and the given body is written to the existing response body.
+    #
+    # If using other plugins that recognize additional types of match block responses, such
+    # as +symbol_views+ and +json+, you can pass those additional types to +r.halt+:
+    #
+    #   plugin :halt
+    #   plugin :symbol_views
+    #   plugin :json
+    #   route do |r|
+    #     r.halt(:template)
+    #     r.halt(500, [{'error'=>'foo'}])
+    #     r.halt(500, 'header=>'value', :other_template)
+    #   end
+    #
+    # Note that when using the +json+ plugin with the +halt+ plugin, you cannot return a
+    # array as a single argument and have it be converted to json, since it would be interpreted 
+    # as a rack response.  You must use call +r.halt+ with either two or three argument forms 
+    # in that case.
     module Halt
       module RequestMethods
         # Expand default halt method to handle status codes, headers, and bodies.  See Halt.
@@ -45,22 +62,24 @@ class Roda
             case v = res[0]
             when Integer
               response.status = v
-            when String
-              response.write v
             when Array
               throw :halt, v
             else
-              raise Roda::RodaError, "singular argument to #halt must be Integer, String, or Array"
+              if result = block_result_body(v)
+                response.write(result)
+              else
+                raise Roda::RodaError, "singular argument given to #halt not handled: #{v.inspect}"
+              end
             end
           when 2
             resp = response
             resp.status = res[0]
-            resp.write res[1]
+            resp.write(block_result_body(res[1]))
           when 3
             resp = response
             resp.status = res[0]
             resp.headers.merge!(res[1])
-            resp.write res[2]
+            resp.write(block_result_body(res[2]))
           else
             raise Roda::RodaError, "too many arguments given to #halt (accepts 0-3, received #{res.length})"
           end

data/lib/roda/plugins/header_matchers.rb

@@ -8,7 +8,7 @@ class Roda
     # It adds a +:header+ matcher for matching on arbitrary headers, which matches
     # if the header is present:
     #
-    #   r.on :header=>'X-App-Token' do
+    #   r.on :header=>'X-App-Token' do |header_value|
     #   end
     #
     # It adds a +:host+ matcher for matching by the host of the request:
@@ -45,13 +45,8 @@ class Roda
         # Match if the given uppercase key is present inside the environment.
         def match_header(key)
           if v = @env[key.upcase.tr("-","_")]
-            if roda_class.opts[:match_header_yield]
-              @captures << v
-            else
-              RodaPlugins.deprecate("The :header hash matcher will yield the header value in Roda 2.  To turn on the Roda 2 behavior, set opts[:match_header_yield] to true for your Roda class.")
-            end
+            @captures << v
           end
-          v
         end
 
         # Match if the host of the request is the same as the hostname.  +hostname+

data/lib/roda/plugins/hooks.rb

@@ -67,11 +67,9 @@ class Roda
       end
 
       module InstanceMethods
-        private
-
         # Before routing, execute the before hooks, and
         # execute the after hooks before returning.
-        def _route(*, &block)
+        def call
           if b = opts[:before_hook]
             instance_exec(&b)
           end

data/lib/roda/plugins/json.rb

@@ -33,13 +33,15 @@ class Roda
     #
     #   plugin :json, :classes=>[Array, Hash, Sequel::Model]
     module Json
+      OPTS = {}.freeze
+
       # Set the classes to automatically convert to JSON
-      def self.configure(app, opts={})
+      def self.configure(app, opts=OPTS)
         classes = opts[:classes] || [Array, Hash]
         app.opts[:json_result_classes] ||= []
         app.opts[:json_result_classes] += classes
         app.opts[:json_result_classes].uniq!
-        app.opts[:json_result_classes].extend(RodaDeprecateMutation)
+        app.opts[:json_result_classes].freeze
       end
 
       module ClassMethods

data/lib/roda/plugins/mailer.rb

@@ -74,7 +74,7 @@ class Roda
     #     end
     #   end
     #
-    # When sending a mail via +mail+ or +sendmail+, an Error will be raised
+    # When sending a mail via +mail+ or +sendmail+, a RodaError will be raised
     # if the mail object does not have a body.  This is similar to the 404
     # status that Roda uses by default for web requests that don't have
     # a body. If you want to specifically send an email with an empty body, you
@@ -110,6 +110,7 @@ class Roda
       MAIL = "MAIL".freeze
       CONTENT_TYPE = 'Content-Type'.freeze
       TEXT_PLAIN = "text/plain".freeze
+      OPTS = {}.freeze
 
       # Error raised when the using the mail class method, but the routing
       # tree doesn't return the mail object. 
@@ -117,7 +118,7 @@ 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={})
+      def self.configure(app, opts=OPTS)
         app.opts[:mailer] = (app.opts[:mailer]||{}).merge(opts).freeze
       end
 
@@ -127,7 +128,7 @@ class Roda
         # calling +deliver+ to send the mail.
         def mail(path, *args)
           mail = ::Mail.new
-          unless mail.equal?(allocate.call(PATH_INFO=>path, SCRIPT_NAME=>EMPTY_STRING, REQUEST_METHOD=>MAIL, RACK_INPUT=>StringIO.new, RODA_MAIL=>mail, RODA_MAIL_ARGS=>args, &route_block))
+          unless mail.equal?(new(PATH_INFO=>path, SCRIPT_NAME=>EMPTY_STRING, REQUEST_METHOD=>MAIL, RACK_INPUT=>StringIO.new, RODA_MAIL=>mail, RODA_MAIL_ARGS=>args).call(&route_block))
             raise Error, "route did not return mail instance for #{path.inspect}, #{args.inspect}"
           end
           mail
@@ -203,19 +204,19 @@ class Roda
           end
         end
 
-        private
-
         # If this is an email request, set the mail object in the response, as well
         # as the default content_type for the email.
-        def _route
+        def initialize(env)
+          super
           if mail = env[RODA_MAIL]
             res = @_response
             res.mail = mail
             res.headers.delete(CONTENT_TYPE)
           end
-          super
         end
 
+        private
+
         # 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)

data/lib/roda/plugins/middleware.rb

@@ -30,15 +30,14 @@ class Roda
     #
     #   run App
     #
-    # Note that once you use the middleware plugin, you can only use the
-    # Roda app as middleware, and you will get errors if you attempt to
-    # use it as a regular app.
+    # It is possible to use the Roda app as a regular app even when using
+    # the middleware plugin.
     module Middleware
       # Forward instances are what is actually used as middleware.
       class Forwarder
         # Store the current middleware and the next middleware to call.
         def initialize(mid, app)
-          @mid = mid.app
+          @mid = mid
           @app = app
         end
 
@@ -49,7 +48,9 @@ class Roda
           res = nil
 
           call_next = catch(:next) do
-            res = @mid.call(env)
+            scope = @mid.new(env)
+            scope.request.forward_next = true
+            res = scope.call(&@mid.route_block)
             false
           end
 
@@ -62,20 +63,31 @@ class Roda
       end
 
       module ClassMethods
-        # Create a Forwarder instead of a new instance.
+        # Create a Forwarder instead of a new instance if a non-Hash is given.
         def new(app)
-          Forwarder.new(self, app)
+          if app.is_a?(Hash)
+            super
+          else
+            Forwarder.new(self, app)
+          end
         end
 
         # Override the route block so that if no route matches, we throw so
         # that the next middleware is called.
         def route(&block)
           super do |r|
-            instance_exec(r, &block)
-            throw :next, true
+            res = instance_exec(r, &block)
+            throw :next, true if r.forward_next
+            res
           end
         end
       end
+
+      module RequestMethods
+        # Whether to forward the request to the next application.  Set only if
+        # this request is being performed for middleware.
+        attr_accessor :forward_next
+      end
     end
 
     register_plugin(:middleware, Middleware)

data/lib/roda/plugins/not_found.rb

@@ -40,11 +40,9 @@ class Roda
       end
 
       module InstanceMethods
-        private
-
         # If routing returns a 404 response with an empty body, call
         # the not_found handler.
-        def _route
+        def call
           result = super
 
           if result[0] == 404 && (v = result[2]).is_a?(Array) && v.empty?
@@ -55,6 +53,8 @@ class Roda
           end
         end
 
+        private
+
         # Use an empty not_found_handler by default, so that loading
         # the plugin without defining a not_found handler doesn't
         # break things.