roda 2.28.0 → 2.29.0

data/lib/roda/plugins/run_append_slash.rb

@@ -22,11 +22,12 @@ class Roda
     #   # GET /a/ => App gets "/" as PATH_INFO
     module RunAppendSlash
       OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
 
       # Set plugin specific options.  Options:
       # :use_redirects :: Whether to issue 302 redirects when appending the
       #                   trailing slash.
-      def self.configure(app, opts=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         app.opts[:run_append_slash_redirect] = !!opts[:use_redirects]
       end
 

data/lib/roda/plugins/run_handler.rb

@@ -26,6 +26,7 @@ class Roda
     #   end
     module RunHandler
       OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
 
       module RequestMethods
         # If a block is given, yield the rack response array to it.  The response can
@@ -34,7 +35,7 @@ class Roda
         # If the <tt>:not_found=>:pass</tt> option is given, and the rack response
         # returned by the app is a 404 response, do not return the response, continue
         # routing normally.
-        def run(app, opts=OPTS)
+        def run(app, opts=RodaPlugins::OPTS)
           res = catch(:halt){super(app)}
           yield res if block_given?
           throw(:halt, res) unless opts[:not_found] == :pass && res[0] == 404

data/lib/roda/plugins/sinatra_helpers.rb

@@ -212,7 +212,7 @@ class Roda
     # OTHER DEALINGS IN THE SOFTWARE.
     module SinatraHelpers
       OPTS = {}.freeze
-
+      RodaPlugins.deprecate_constant(self, :OPTS)
       CONTENT_TYPE = "Content-Type".freeze
       RodaPlugins.deprecate_constant(self, :CONTENT_TYPE)
       CONTENT_DISPOSITION = "Content-Disposition".freeze
@@ -248,7 +248,7 @@ class Roda
       # Add delegate methods to the route block scope
       # calling request or response methods, unless the
       # :delegate option is false.
-      def self.configure(app, opts=OPTS)
+      def self.configure(app, opts=RodaPlugins::OPTS)
         app.send(:include, DelegateMethods) unless opts[:delegate] == false
       end
 
@@ -339,7 +339,7 @@ class Roda
         end
 
         # Use the contents of the file at +path+ as the response body.  See plugin documentation for options.
-        def send_file(path, opts = OPTS)
+        def send_file(path, opts = RodaPlugins::OPTS)
           res = response
           headers = res.headers
           if opts[:type] || !headers["Content-Type"]
@@ -441,7 +441,7 @@ class Roda
 
         # Set the Content-Type of the response body given a media type or file
         # extension.  See plugin documentation for options.
-        def content_type(type = (return @headers["Content-Type"]; nil), opts = OPTS)
+        def content_type(type = (return @headers["Content-Type"]; nil), opts = RodaPlugins::OPTS)
           unless (mime_type = mime_type(type) || opts[:default])
             raise RodaError, "Unknown media type: #{type}"
           end

data/lib/roda/plugins/static_path_info.rb

@@ -1,5 +1,7 @@
 class Roda
   module RodaPlugins
+    warn 'The static_path_info plugin is deprecated and will be removed in Roda 3.  It has been a no-op since Roda 2, and can just be removed from the application.'
+
     module StaticPathInfo
     end
 

data/lib/roda/plugins/static_routing.rb

@@ -47,7 +47,7 @@ class Roda
     # method call takes precedence over the static_route method call for /foo.
     # As shown above, you can use Roda's routing tree methods inside the
     # static_route block to have shared behavior for different request methods,
-    # while still having handling the request methods differently.
+    # while still handling the request methods differently.
     #
     # Note that if you want to use the static_routing plugin and the hooks
     # plugin at the same time, you should load the hooks plugin first.

data/lib/roda/plugins/streaming.rb

@@ -73,6 +73,7 @@ class Roda
     # OTHER DEALINGS IN THE SOFTWARE.
     module Streaming
       OPTS = {}.freeze
+      RodaPlugins.deprecate_constant(self, :OPTS)
 
       # Class of the response body in case you use #stream.
       #
@@ -109,7 +110,7 @@ class Roda
         end
 
         # Handle streaming options, see Streaming for details.
-        def initialize(opts=OPTS, &back)
+        def initialize(opts=RodaPlugins::OPTS, &back)
           @scheduler = opts[:scheduler] || Scheduler.new(self)
           @back = back.to_proc
           @keep_open = opts[:keep_open]
@@ -117,7 +118,7 @@ class Roda
           @closed = false
 
           if opts[:callback]
-            callback(&opts[:callback])
+            @callbacks << opts[:callback]
           end
         end
 
@@ -134,6 +135,7 @@ class Roda
 
         # Add the given block as a callback to call when the block closes.
         def callback(&block)
+          RodaPlugins.warn 'Stream#callback in the streaming plugin is deprecated and will be removed in Roda 3.  Specify callback at initialization using the stream method :callback option.'
           return yield if closed?
           @callbacks << block
         end
@@ -172,8 +174,11 @@ class Roda
         # Immediately return a streaming response using the current response
         # status and headers, calling the block to get the streaming response.
         # See Streaming for details.
-        def stream(opts=OPTS, &block)
-          opts = opts.merge(:scheduler=>EventMachine) if !opts.has_key?(:scheduler) && env['async.callback']
+        def stream(opts=RodaPlugins::OPTS, &block)
+          if !opts.has_key?(:scheduler) && env['async.callback']
+            RodaPlugins.warn 'The automatic support for EventMachine in the streaming plugin is deprecated and will be removed in Roda 3.'
+            opts = opts.merge(:scheduler=>EventMachine)
+          end
 
           if opts[:loop]
             block = proc do |out|

data/lib/roda/plugins/symbol_matchers.rb

@@ -25,8 +25,8 @@ class Roda
     # :rest :: <tt>/(.*)/</tt>, all remaining characters, if any
     # :w :: <tt>/(\w+)/</tt>, a alphanumeric segment
     #
-    # If placeholder string matchers are supported, this feature also applies to
-    # embedded colons in strings, so the following:
+    # If the placeholder_string_matchers plugin is loaded, this feature also applies to
+    # placeholders in strings, so the following:
     #
     #   r.on "users/:username" do
     #     # ...
@@ -35,33 +35,36 @@ class Roda
     # Would match +/users/foobar123+, but not +/users/foo+, +/users/FooBar123+,
     # or +/users/foobar_123+.
     #
-    # If placeholder string matchers are supported, it also adds the following
-    # symbol matchers:
-    #
-    # :format :: <tt>/(?:\.(\w+))?/</tt>, an optional format/extension
-    # :opt :: <tt>/(?:\/([^\/]+))?</tt>, an optional segment
-    # :optd :: <tt>/(?:\/(\d+))?</tt>, an optional decimal segment
-    #
-    # These are only added when placeholder string matchers are supported,
-    # because they only make sense when used inside of a string, due to how
-    # segment matching works.  Example:
-    #
-    #   r.is "album:opt" do |id| end
-    #   # matches /album (yielding nil) and /album/foo (yielding "foo")
-    #   # does not match /album/ or /album/foo/bar
-    #
     # If using this plugin with the params_capturing plugin, this plugin should
     # be loaded first.
     module SymbolMatchers
+      def self.load_dependencies(app)
+        app.plugin :_symbol_regexp_matchers
+      end
+
       def self.configure(app)
         app.symbol_matcher(:d, /(\d+)/)
         app.symbol_matcher(:w, /(\w+)/)
         app.symbol_matcher(:rest, /(.*)/)
 
         if !app.opts[:verbatim_string_matcher]
-          app.symbol_matcher(:format, /(?:\.(\w+))?/)
-          app.symbol_matcher(:opt, /(?:\/([^\/]+))?/)
-          app.symbol_matcher(:optd, /(?:\/(\d+))?/)
+          # RODA3: Remove
+          app::RodaRequest.class_eval do
+            def match_symbol_format
+              Roda::RodaPlugins.warn('Implicit use of the :format symbol matcher is deprecated and will be removed in Roda 3.  If you want to use the :format symbol matcher, add the following code to your Roda class: symbol_matcher(:format, /(?:\.(\w+))?/)')
+              /(?:\.(\w+))?/
+            end
+
+            def match_symbol_opt
+              Roda::RodaPlugins.warn('Implicit use of the :opt symbol matcher is deprecated and will be removed in Roda 3.  If you want to use the :opt symbol matcher, add the following code to your Roda class: symbol_matcher(:opt, /(?:\/([^\/]+))?/)')
+              /(?:\/([^\/]+))?/
+            end
+
+            def match_symbol_optd
+              Roda::RodaPlugins.warn('Implicit use of the :optd symbol matcher is deprecated and will be removed in Roda 3.  If you want to use the :optd symbol matcher, add the following code to your Roda class: symbol_matcher(:optd, /(?:\/(\d+))?/)')
+              /(?:\/(\d+))?/
+            end
+          end
         end
       end
 

data/lib/roda/plugins/view_options.rb

@@ -4,7 +4,7 @@
 class Roda
   module RodaPlugins
     # The view_options plugin allows you to override view and layout
-    # options and locals for specific branches and routes.
+    # options for specific branches and routes.
     #
     #   plugin :render
     #   plugin :view_options
@@ -12,15 +12,14 @@ class Roda
     #   route do |r|
     #     r.on "users" do
     #       set_layout_options :template=>'users_layout'
-    #       set_layout_locals :title=>'Users'
     #       set_view_options :engine=>'haml'
-    #       set_view_locals :footer=>'(c) Roda'
     #
     #       # ...
     #     end
     #   end
     #
-    # The options and locals you specify have higher precedence than
+    # The options you specify via the set_view_options and
+    # set_layout_options methods have higher precedence than
     # the render plugin options, but lower precedence than options
     # you directly pass to the view/render methods.
     #
@@ -60,22 +59,22 @@ class Roda
     #
     # If you have an existing Roda application that doesn't use
     # automatic HTML escaping for <tt><%= %></tt> tags via the
-    # :render plugin's :escape option, but you want to switch to
+    # :render plugin's :escape=>:erubi option, but you want to switch to
     # using the :escape option, you can now do so without making
     # all changes at once.  With set_view_options, you can now
     # specify escaping or not on a per branch basis in the routing
     # tree:
     #
-    #   plugin :render, :escape=>true
+    #   plugin :render, :escape=>:erubi
     #   plugin :view_options
     #
     #   route do |r|
     #     # Don't escape <%= %> by default
-    #     set_view_options :template_opts=>{:engine_class=>nil}
+    #     set_view_options :template_opts=>{:escape=>false}
     #
     #     r.on "users" do
     #       # Escape <%= %> in this branch
-    #       set_view_options :template_opts=>{:engine_class=>render_opts[:template_opts][:engine_class]}
+    #       set_view_options :template_opts=>{:escape=>true}
     #     end
     #   end
     module ViewOptions
@@ -85,27 +84,7 @@ class Roda
         app.plugin :render
       end
 
-      # The following methods are created via metaprogramming:
-      # set_layout_locals :: Set locals to use in the layout
-      # set_layout_options :: Set options to use when rendering the layout
-      # set_view_locals :: Set locals to use in the view
-      # set_view_options :: Set options to use when rendering the view
       module InstanceMethods
-        %w'layout view'.each do |type|
-          %w'locals options'.each do |var|
-            v = "_#{type}_#{var}"
-            module_eval(<<-END, __FILE__, __LINE__+1)
-              def set#{v}(opts)
-                if @#{v}
-                  @#{v} = Hash[@#{v}].merge!(opts)
-                else
-                  @#{v} = opts
-                end
-              end
-            END
-          end
-        end
-
         # Append a view subdirectory to use.  If there hasn't already
         # been a view subdirectory set, this just sets it to the argument.
         # If there has already been a view subdirectory set, this sets
@@ -125,8 +104,62 @@ class Roda
           @_view_subdir = v
         end
 
+        # Set branch/route options to use when rendering the layout
+        def set_layout_options(opts)
+          if options = @_layout_options
+            @_layout_options = Hash[options].merge!(opts)
+          else
+            @_layout_options = opts
+          end
+        end
+
+        # Set branch/route options to use when rendering the view
+        def set_view_options(opts)
+          if options = @_view_options
+            @_view_options = Hash[options].merge!(opts)
+          else
+            @_view_options = opts
+          end
+        end
+
+        # RODA3: Remove
+        def set_layout_locals(opts)
+          RodaPlugins.warn "The set_layout_locals method in the view_options plugin is deprecated and will be removed in Roda 3. This feature has been moved to the branch_locals plugin."
+          if locals = @_layout_locals
+            @_layout_locals = Hash[locals].merge!(opts)
+          else
+            @_layout_locals = opts
+          end
+        end
+
+        # RODA3: Remove
+        def set_view_locals(opts)
+          RodaPlugins.warn "The set_view_locals method in the view_options plugin is deprecated and will be removed in Roda 3. This feature has been moved to the branch_locals plugin."
+          if locals = @_view_locals
+            @_view_locals = Hash[locals].merge!(opts)
+          else
+            @_view_locals = opts
+          end
+        end
+
         private
 
+        def render_locals
+          locals = super
+          if @_view_locals
+            locals = Hash[locals].merge!(@_view_locals)
+          end
+          locals
+        end
+
+        def layout_locals
+          locals = super
+          if @_view_locals
+            locals = Hash[locals].merge!(@_layout_locals)
+          end
+          locals
+        end
+
         # If view options or locals have been set and this
         # template isn't a layout template, merge the options
         # and locals into the returned hash.
@@ -138,6 +171,7 @@ class Roda
               t_opts.merge!(v_opts)
             end
 
+            # RODA3: Remove
             if v_locals = @_view_locals
               t_opts[:locals] = if t_locals = t_opts[:locals]
                 Hash[v_locals].merge!(t_locals)
@@ -159,6 +193,7 @@ class Roda
             opts.merge!(l_opts)
           end
 
+          # RODA3: Remove
           if l_locals = @_layout_locals
             opts[:locals] = if o_locals = opts[:locals]
               Hash[o_locals].merge!(l_locals)

data/lib/roda/plugins/view_subdirs.rb

@@ -3,4 +3,5 @@
 # make attempts to load the view_subdirs plugin load the
 # view_options plugin instead.
 require 'roda/plugins/view_options'
+Roda::RodaPlugins.warn "The view_subdirs plugin is a deprecated alias for the view_options plugin that will be removed in Roda 3.  Use the view_options plugin instead."
 Roda::RodaPlugins.register_plugin(:view_subdirs, Roda::RodaPlugins::ViewOptions)

data/lib/roda/plugins/websockets.rb

@@ -4,6 +4,8 @@ require 'faye/websocket'
 
 class Roda
   module RodaPlugins
+    warn "The websockets plugin is deprecated and will be removed in Roda 3.  Consider maintaining the plugin as a separate gem if you would like to keep using it."
+
     # The websocket plugin adds integration support for websockets.
     # Currently, only 'faye-websocket' is supported, so eventmachine
     # is required for websockets.  See the

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 2
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 28
+  RodaMinorVersion = 29
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/composition_spec.rb

@@ -19,13 +19,13 @@ describe "r.run" do
 
   it "modifies SCRIPT_NAME/PATH_INFO when calling run" do
     a = app{|r| "#{r.script_name}|#{r.path_info}"}
-    app(:static_path_info){|r| r.on("a"){r.run a}}
+    app{|r| r.on("a"){r.run a}}
     body("/a/b").must_equal "/a|/b"
   end
 
   it "restores SCRIPT_NAME/PATH_INFO before returning from run" do
     a = app{|r| "#{r.script_name}|#{r.path_info}"}
-    app(:static_path_info){|r| s = catch(:halt){r.on("a"){r.run a}}; "#{s[2].join}%#{r.script_name}|#{r.path_info}"}
+    app{|r| s = catch(:halt){r.on("a"){r.run a}}; "#{s[2].join}%#{r.script_name}|#{r.path_info}"}
     body("/a/b").must_equal "/a|/b%|/a/b"
   end
 end

data/spec/matchers_spec.rb

@@ -158,7 +158,7 @@ describe "r.is" do
 end
 
 describe "matchers" do
-  it "should handle string with embedded param" do
+  deprecated "should handle string with embedded param" do
     app do |r|
       r.on "posts/:id" do |id|
         id
@@ -185,6 +185,7 @@ describe "matchers" do
         '2'
       end
     end
+    # RODA3: remove option
     app.opts[:verbatim_string_matcher] = true
 
     status('/post/123').must_equal 404
@@ -194,7 +195,7 @@ describe "matchers" do
     body('/responses-:id').must_equal '2'
   end
 
-  it "should handle multiple params in single string" do
+  deprecated "should handle multiple params in single string" do
     app do |r|
       r.on "u/:uid/posts/:id" do |uid, id|
         uid + id
@@ -206,7 +207,7 @@ describe "matchers" do
     status("/u/jdoe/pots/123").must_equal 404
   end
 
-  it "should escape regexp metacharaters in string" do
+  deprecated "should escape regexp metacharaters in string" do
     app do |r|
       r.on "u/:uid/posts?/:id" do |uid, id|
         uid + id
@@ -218,7 +219,7 @@ describe "matchers" do
     status("/u/jdoe/post/123").must_equal 404
   end
 
-  it "should handle colons by themselves" do
+  deprecated "should handle colons by themselves" do
     app do |r|
       r.on "u/:/:uid/posts/::id" do |uid, id|
         uid + id
@@ -394,7 +395,7 @@ describe "r.on" do
     status.must_equal 404
   end
 
-  it "executes on arbitrary object" do
+  deprecated "executes on arbitrary object" do
     app do |r|
       r.on Object.new do
         "+1"