roda 2.29.0 → 3.0.0

data/lib/roda/plugins/strip_path_prefix.rb

@@ -7,7 +7,7 @@ class Roda
     # turning them to relative paths.  Roda by default stores internal paths as absolute paths.
     # The main reason to use this plugin is when the internal absolute path could change at
     # runtime, either due to a symlink change or chroot call, or you really want to use
-    # relative links instead of absolute links.
+    # relative paths instead of absolute paths.
     # 
     # Examples:
     #

data/lib/roda/plugins/symbol_matchers.rb

@@ -46,32 +46,14 @@ class Roda
         app.symbol_matcher(:d, /(\d+)/)
         app.symbol_matcher(:w, /(\w+)/)
         app.symbol_matcher(:rest, /(.*)/)
-
-        if !app.opts[:verbatim_string_matcher]
-          # 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
 
       module ClassMethods
         # Set the regexp to use for the given symbol, instead of the default.
         def symbol_matcher(s, re)
-          self::RodaRequest.send(:define_method, :"match_symbol_#{s}"){re}
+          meth = :"match_symbol_#{s}"
+          self::RodaRequest.send(:define_method, meth){re}
+          self::RodaRequest.send(:private, meth)
         end
       end
 
@@ -83,7 +65,8 @@ class Roda
         # behavior.
         def _match_symbol(s)
           meth = :"match_symbol_#{s}"
-          if respond_to?(meth)
+          if respond_to?(meth, true)
+            # Allow calling private match methods
             re = send(meth)
             consume(self.class.cached_matcher(re){re})
           else
@@ -95,7 +78,8 @@ class Roda
         # Otherwise, call super for the default behavior.
         def _match_symbol_regexp(s)
           meth = :"match_symbol_#{s}"
-          if respond_to?(meth)
+          if respond_to?(meth, true)
+            # Allow calling private match methods
             send(meth)
           else
             super

data/lib/roda/plugins/type_routing.rb

@@ -3,7 +3,7 @@
 #
 class Roda
   module RodaPlugins
-    # Allows to respond to specific request data types. User agents can request
+    # This plugin makes it easier to to respond to specific request data types. User agents can request
     # specific data types by either supplying an appropriate +Accept+ header
     # or by appending it as file extension to the path.
     #
@@ -48,9 +48,9 @@ class Roda
     #
     # To match custom extensions, use the :types option:
     #
-    #   plugin :type_routing, :types => {
-    #     :yaml => 'application/x-yaml',
-    #     :js => 'application/javascript; charset=utf-8',
+    #   plugin :type_routing, types: {
+    #     yaml: 'application/x-yaml',
+    #     js: 'application/javascript; charset=utf-8'
     #   }
     #
     #   route do |r|
@@ -81,11 +81,6 @@ class Roda
     # :use_header :: Whether to take the +Accept+ header into account.
     #                Default is +true+.
     module TypeRouting
-      ACCEPT_HEADER = 'HTTP_ACCEPT'.freeze
-      RodaPlugins.deprecate_constant(self, :ACCEPT_HEADER)
-      CONTENT_TYPE_HEADER = 'Content-Type'.freeze
-      RodaPlugins.deprecate_constant(self, :CONTENT_TYPE_HEADER)
-
       CONFIGURATION = {
         :mimes => {
           'text/json' => :json,

data/lib/roda/plugins/view_options.rb

@@ -11,8 +11,8 @@ class Roda
     #
     #   route do |r|
     #     r.on "users" do
-    #       set_layout_options :template=>'users_layout'
-    #       set_view_options :engine=>'haml'
+    #       set_layout_options template: 'users_layout'
+    #       set_view_options engine: 'haml'
     #
     #       # ...
     #     end
@@ -31,7 +31,7 @@ class Roda
     # use, and template names that do not contain a slash will
     # automatically use that view subdirectory.  Example:
     #
-    #   plugin :render, :layout=>'./layout'
+    #   plugin :render, layout: './layout'
     #   plugin :view_options
     #
     #   route do |r|
@@ -59,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=>:erubi option, but you want to switch to
-    # using the :escape option, you can now do so without making
+    # render plugin's +:escape+ 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=>:erubi
+    #   plugin :render, escape: true
     #   plugin :view_options
     #
     #   route do |r|
     #     # Don't escape <%= %> by default
-    #     set_view_options :template_opts=>{:escape=>false}
+    #     set_view_options template_opts: {escape: false}
     #
     #     r.on "users" do
     #       # Escape <%= %> in this branch
-    #       set_view_options :template_opts=>{:escape=>true}
+    #       set_view_options template_opts: {escape: true}
     #     end
     #   end
     module ViewOptions
@@ -122,63 +122,16 @@ class Roda
           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.
         def parse_template_opts(template, opts)
           t_opts = super
 
-          unless t_opts[:_is_layout]
-            if v_opts = @_view_options
-              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)
-              else
-                v_locals
-              end
-            end
+          if !t_opts[:_is_layout] && (v_opts = @_view_options)
+            t_opts.merge!(v_opts)
           end
 
           t_opts
@@ -193,15 +146,6 @@ 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)
-            else
-              l_locals
-            end
-          end
-
           opts
         end
 

data/lib/roda/version.rb

@@ -1,10 +1,10 @@
 class Roda
   # The major version of Roda, updated only for major changes that are
   # likely to require modification to Roda apps.
-  RodaMajorVersion = 2
+  RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 29
+  RodaMinorVersion = 0
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/all.rb

@@ -1,3 +1 @@
-$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
-require 'rubygems'
 (Dir['./spec/*_spec.rb'] + Dir['./spec/plugin/*_spec.rb']).each{|f| require f}

data/spec/composition_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative "spec_helper"
 
 describe "r.run" do
   it "should allow composition of apps" do

data/spec/env_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative "spec_helper"
 
 describe "Roda#env" do
   it "should return the environment" do

data/spec/freeze_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative "spec_helper"
 
 describe "Roda.freeze" do
   before do

data/spec/integration_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative "spec_helper"
 
 describe "integration" do 
   before do

data/spec/matchers_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative "spec_helper"
 
 describe "capturing" do
   it "doesn't yield the verb for verb matcher" do
@@ -87,7 +87,7 @@ describe "capturing" do
     body("/user/a").must_equal 'b'
   end
 
-  it "yields the segment for symbol matcher" do
+  it "yields the segment for String class matcher" do
     app do |r|
       r.get "user", String do |id|
         id
@@ -96,6 +96,16 @@ describe "capturing" do
 
     body("/user/johndoe").must_equal 'johndoe'
   end
+
+  it "raises error for unsupported class matcher" do
+    app do |r|
+      r.get Hash do |id|
+        id
+      end
+    end
+
+    proc{status}.must_raise Roda::RodaError
+  end
 end
 
 describe "r.is" do 
@@ -145,36 +155,31 @@ describe "r.is" do
     status("/123/").must_equal 404
   end
 
-  it "matches segments" do
+  it "matches regexps" do
     app do |r|
-      r.is :id do |id|
-        id
+      r.on(/foo/) do |id|
+        'a'
       end
     end
 
-    body("/123").must_equal '123'
-    status("/123/").must_equal 404
+    body("/foo").must_equal 'a'
+    body("/foo/").must_equal 'a'
+    status("/food").must_equal 404
   end
-end
 
-describe "matchers" do
-  deprecated "should handle string with embedded param" do
+  it "matches segments" do
     app do |r|
-      r.on "posts/:id" do |id|
-        id
-      end
-
-      r.on "responses-:id" do |id|
+      r.is :id do |id|
         id
       end
     end
-    app.opts[:verbatim_string_matcher] = false
 
-    body('/posts/123').must_equal '123'
-    status('/post/123').must_equal 404
-    body('/responses-123').must_equal '123'
+    body("/123").must_equal '123'
+    status("/123/").must_equal 404
   end
+end
 
+describe "matchers" do
   it "should not handle string with embedded param if :verbatim_string_matcher option is set" do
     app do |r|
       r.on "posts/:id" do
@@ -185,8 +190,6 @@ describe "matchers" do
         '2'
       end
     end
-    # RODA3: remove option
-    app.opts[:verbatim_string_matcher] = true
 
     status('/post/123').must_equal 404
     status('/posts/123').must_equal 404
@@ -195,42 +198,6 @@ describe "matchers" do
     body('/responses-:id').must_equal '2'
   end
 
-  deprecated "should handle multiple params in single string" do
-    app do |r|
-      r.on "u/:uid/posts/:id" do |uid, id|
-        uid + id
-      end
-    end
-    app.opts[:verbatim_string_matcher] = false
-
-    body("/u/jdoe/posts/123").must_equal 'jdoe123'
-    status("/u/jdoe/pots/123").must_equal 404
-  end
-
-  deprecated "should escape regexp metacharaters in string" do
-    app do |r|
-      r.on "u/:uid/posts?/:id" do |uid, id|
-        uid + id
-      end
-    end
-    app.opts[:verbatim_string_matcher] = false
-
-    body("/u/jdoe/posts?/123").must_equal 'jdoe123'
-    status("/u/jdoe/post/123").must_equal 404
-  end
-
-  deprecated "should handle colons by themselves" do
-    app do |r|
-      r.on "u/:/:uid/posts/::id" do |uid, id|
-        uid + id
-      end
-    end
-    app.opts[:verbatim_string_matcher] = false
-
-    body("/u/:/jdoe/posts/:123").must_equal 'jdoe123'
-    status("/u/a/jdoe/post/b123").must_equal 404
-  end
-
   it "should handle regexes and nesting" do
     app do |r|
       r.on(/u\/(\w+)/) do |uid|
@@ -332,7 +299,7 @@ describe "matchers" do
 
   it "should allow regexp to match optional segments with separate arguments" do
     app do |r|
-      r.on /(\d+)(?:\/(\d+))?/ do |f, b|
+      r.on(/(\d+)(?:\/(\d+))?/) do |f, b|
         [f, b].inspect
       end
     end
@@ -395,19 +362,8 @@ describe "r.on" do
     status.must_equal 404
   end
 
-  deprecated "executes on arbitrary object" do
-    app do |r|
-      r.on Object.new do
-        "+1"
-      end
-    end
-
-    body.must_equal '+1'
-  end
-
-  it "raises on arbitrary object if :unsupported_matcher => :raise" do
+  it "raises on arbitrary object" do
     app(:bare) do 
-      opts[:unsupported_matcher] = :raise
       route do |r|
         r.on Object.new do
           "+1"

data/spec/opts_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(__FILE__))
+require_relative "spec_helper"
 
 describe "opts" do
   it "is inheritable and allows overriding" do

data/spec/plugin/all_verbs_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+require_relative "../spec_helper"
 
 describe "all_verbs plugin" do 
   it "adds method for each http verb" do