actionpack 3.2.19 → 4.0.0

data/lib/action_dispatch/routing/url_for.rb

@@ -8,7 +8,8 @@ module ActionDispatch
     #
     # <b>Tip:</b> If you need to generate URLs from your models or some other place,
     # then ActionController::UrlFor is what you're looking for. Read on for
-    # an introduction.
+    # an introduction. In general, this module should not be included on its own,
+    # as it is usually included by url_helpers (as in Rails.application.routes.url_helpers).
     #
     # == URL generation from parameters
     #
@@ -17,8 +18,8 @@ module ActionDispatch
     # of parameters. For example, you've probably had the chance to write code
     # like this in one of your views:
     #
-    #   <%= link_to('Click here', :controller => 'users',
-    #           :action => 'new', :message => 'Welcome!') %>
+    #   <%= link_to('Click here', controller: 'users',
+    #           action: 'new', message: 'Welcome!') %>
     #   # => "/users/new?message=Welcome%21"
     #
     # link_to, and all other functions that require URL generation functionality,
@@ -27,22 +28,22 @@ module ActionDispatch
     # the same path as the above example by using the following code:
     #
     #   include UrlFor
-    #   url_for(:controller => 'users',
-    #           :action => 'new',
-    #           :message => 'Welcome!',
-    #           :only_path => true)
+    #   url_for(controller: 'users',
+    #           action: 'new',
+    #           message: 'Welcome!',
+    #           only_path: true)
     #   # => "/users/new?message=Welcome%21"
     #
-    # Notice the <tt>:only_path => true</tt> part. This is because UrlFor has no
+    # Notice the <tt>only_path: true</tt> part. This is because UrlFor has no
     # information about the website hostname that your Rails app is serving. So if you
     # want to include the hostname as well, then you must also pass the <tt>:host</tt>
     # argument:
     #
     #   include UrlFor
-    #   url_for(:controller => 'users',
-    #           :action => 'new',
-    #           :message => 'Welcome!',
-    #           :host => 'www.example.com')
+    #   url_for(controller: 'users',
+    #           action: 'new',
+    #           message: 'Welcome!',
+    #           host: 'www.example.com')
     #   # => "http://www.example.com/users/new?message=Welcome%21"
     #
     # By default, all controllers and views have access to a special version of url_for,
@@ -67,7 +68,7 @@ module ActionDispatch
     # This generates, among other things, the method <tt>users_path</tt>. By default,
     # this method is accessible from your controllers, views and mailers. If you need
     # to access this auto-generated method from other places (such as a model), then
-    # you can do that by including ActionController::UrlFor in your class:
+    # you can do that by including Rails.application.routes.url_helpers in your class:
     #
     #   class User < ActiveRecord::Base
     #     include Rails.application.routes.url_helpers
@@ -84,18 +85,18 @@ module ActionDispatch
       include PolymorphicRoutes
 
       included do
-        # TODO: with_routing extends @controller with url_helpers, trickling down to including this module which overrides its default_url_options
         unless method_defined?(:default_url_options)
           # Including in a class uses an inheritable hash. Modules get a plain hash.
           if respond_to?(:class_attribute)
             class_attribute :default_url_options
           else
-            mattr_accessor :default_url_options
-            remove_method :default_url_options
+            mattr_writer :default_url_options
           end
 
           self.default_url_options = {}
         end
+
+        include(*_url_for_modules) if respond_to?(:_url_for_modules)
       end
 
       def initialize(*)
@@ -103,6 +104,9 @@ module ActionDispatch
         super
       end
 
+      # Hook overridden in controller to add request information
+      # with `default_url_options`. Application logic should not
+      # go into url_options.
       def url_options
         default_url_options
       end
@@ -126,42 +130,53 @@ module ActionDispatch
       # * <tt>:port</tt> - Optionally specify the port to connect to.
       # * <tt>:anchor</tt> - An anchor name to be appended to the path.
       # * <tt>:trailing_slash</tt> - If true, adds a trailing slash, as in "/archive/2009/"
+      # * <tt>:script_name</tt> - Specifies application path relative to domain root. If provided, prepends application path.
       #
       # Any other key (<tt>:controller</tt>, <tt>:action</tt>, etc.) given to
       # +url_for+ is forwarded to the Routes module.
       #
-      # Examples:
-      #
-      #    url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :port => '8080'
+      #    url_for controller: 'tasks', action: 'testing', host: 'somehost.org', port: '8080'
       #    # => 'http://somehost.org:8080/tasks/testing'
-      #    url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :anchor => 'ok', :only_path => true
+      #    url_for controller: 'tasks', action: 'testing', host: 'somehost.org', anchor: 'ok', only_path: true
       #    # => '/tasks/testing#ok'
-      #    url_for :controller => 'tasks', :action => 'testing', :trailing_slash => true
+      #    url_for controller: 'tasks', action: 'testing', trailing_slash: true
       #    # => 'http://somehost.org/tasks/testing/'
-      #    url_for :controller => 'tasks', :action => 'testing', :host => 'somehost.org', :number => '33'
+      #    url_for controller: 'tasks', action: 'testing', host: 'somehost.org', number: '33'
       #    # => 'http://somehost.org/tasks/testing?number=33'
+      #    url_for controller: 'tasks', action: 'testing', host: 'somehost.org', script_name: "/myapp"
+      #    # => 'http://somehost.org/myapp/tasks/testing'
+      #    url_for controller: 'tasks', action: 'testing', host: 'somehost.org', script_name: "/myapp", only_path: true
+      #    # => '/myapp/tasks/testing'
       def url_for(options = nil)
         case options
+        when nil
+          _routes.url_for(url_options.symbolize_keys)
+        when Hash
+          _routes.url_for(options.symbolize_keys.reverse_merge!(url_options))
         when String
           options
-        when nil, Hash
-          _routes.url_for((options || {}).symbolize_keys.reverse_merge!(url_options))
         else
           polymorphic_url(options)
         end
       end
 
       protected
-        def _with_routes(routes)
-          old_routes, @_routes = @_routes, routes
-          yield
-        ensure
-          @_routes = old_routes
-        end
 
-        def _routes_context
-          self
-        end
+      def optimize_routes_generation?
+        return @_optimized_routes if defined?(@_optimized_routes)
+        @_optimized_routes = _routes.optimize_routes_generation? && default_url_options.empty?
+      end
+
+      def _with_routes(routes)
+        old_routes, @_routes = @_routes, routes
+        yield
+      ensure
+        @_routes = old_routes
+      end
+
+      def _routes_context
+        self
+      end
     end
   end
 end

data/lib/action_dispatch/routing.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'active_support/core_ext/object/to_param'
 require 'active_support/core_ext/regexp'
 
@@ -60,7 +61,7 @@ module ActionDispatch
   # directory by using +scope+. +scope+ takes additional options which
   # apply to all enclosed routes.
   #
-  #   scope :path => "/cpanel", :as => 'admin' do
+  #   scope path: "/cpanel", as: 'admin' do
   #     resources :posts, :comments
   #   end
   #
@@ -68,6 +69,22 @@ module ActionDispatch
   # <tt>Routing::Mapper::Scoping#namespace</tt>, and
   # <tt>Routing::Mapper::Scoping#scope</tt>.
   #
+  # == Non-resourceful routes
+  #
+  # For routes that don't fit the <tt>resources</tt> mold, you can use the HTTP helper
+  # methods <tt>get</tt>, <tt>post</tt>, <tt>patch</tt>, <tt>put</tt> and <tt>delete</tt>.
+  #
+  #   get 'post/:id' => 'posts#show'
+  #   post 'post/:id' => 'posts#create_comment'
+  #
+  # If your route needs to respond to more than one HTTP method (or all methods) then using the
+  # <tt>:via</tt> option on <tt>match</tt> is preferable.
+  #
+  #   match 'post/:id' => 'posts#show', via: [:get, :post]
+  #
+  # Now, if you POST to <tt>/posts/:id</tt>, it will route to the <tt>create_comment</tt> action. A GET on the same
+  # URL will route to the <tt>show</tt> action.
+  #
   # == Named routes
   #
   # Routes can be named by passing an <tt>:as</tt> option,
@@ -77,22 +94,22 @@ module ActionDispatch
   # Example:
   #
   #   # In routes.rb
-  #   match '/login' => 'accounts#login', :as => 'login'
+  #   get '/login' => 'accounts#login', as: 'login'
   #
   #   # With render, redirect_to, tests, etc.
   #   redirect_to login_url
   #
   # Arguments can be passed as well.
   #
-  #   redirect_to show_item_path(:id => 25)
+  #   redirect_to show_item_path(id: 25)
   #
   # Use <tt>root</tt> as a shorthand to name a route for the root path "/".
   #
   #   # In routes.rb
-  #   root :to => 'blogs#index'
+  #   root to: 'blogs#index'
   #
   #   # would recognize http://www.example.com/ as
-  #   params = { :controller => 'blogs', :action => 'index' }
+  #   params = { controller: 'blogs', action: 'index' }
   #
   #   # and provide these named routes
   #   root_url   # => 'http://www.example.com/'
@@ -103,117 +120,70 @@ module ActionDispatch
   #
   #   # In routes.rb
   #   controller :blog do
-  #     match 'blog/show'     => :list
-  #     match 'blog/delete'   => :delete
-  #     match 'blog/edit/:id' => :edit
+  #     get 'blog/show'     => :list
+  #     get 'blog/delete'   => :delete
+  #     get 'blog/edit/:id' => :edit
   #   end
   #
   #   # provides named routes for show, delete, and edit
-  #   link_to @article.title, show_path(:id => @article.id)
+  #   link_to @article.title, show_path(id: @article.id)
   #
   # == Pretty URLs
   #
   # Routes can generate pretty URLs. For example:
   #
-  #   match '/articles/:year/:month/:day' => 'articles#find_by_id', :constraints => {
-  #     :year       => /\d{4}/,
-  #     :month      => /\d{1,2}/,
-  #     :day        => /\d{1,2}/
+  #   get '/articles/:year/:month/:day' => 'articles#find_by_id', constraints: {
+  #     year:       /\d{4}/,
+  #     month:      /\d{1,2}/,
+  #     day:        /\d{1,2}/
   #   }
   #
   # Using the route above, the URL "http://localhost:3000/articles/2005/11/06"
   # maps to
   #
-  #   params = {:year => '2005', :month => '11', :day => '06'}
+  #   params = {year: '2005', month: '11', day: '06'}
   #
   # == Regular Expressions and parameters
   # You can specify a regular expression to define a format for a parameter.
   #
   #   controller 'geocode' do
-  #     match 'geocode/:postalcode' => :show, :constraints => {
-  #       :postalcode => /\d{5}(-\d{4})?/
+  #     get 'geocode/:postalcode' => :show, constraints: {
+  #       postalcode: /\d{5}(-\d{4})?/
   #     }
   #
   # Constraints can include the 'ignorecase' and 'extended syntax' regular
   # expression modifiers:
   #
   #   controller 'geocode' do
-  #     match 'geocode/:postalcode' => :show, :constraints => {
-  #       :postalcode => /hx\d\d\s\d[a-z]{2}/i
+  #     get 'geocode/:postalcode' => :show, constraints: {
+  #       postalcode: /hx\d\d\s\d[a-z]{2}/i
   #     }
   #   end
   #
   #   controller 'geocode' do
-  #     match 'geocode/:postalcode' => :show, :constraints => {
-  #       :postalcode => /# Postcode format
+  #     get 'geocode/:postalcode' => :show, constraints: {
+  #       postalcode: /# Postcode format
   #          \d{5} #Prefix
   #          (-\d{4})? #Suffix
   #          /x
   #     }
   #   end
   #
-  # Using the multiline match modifier will raise an +ArgumentError+.
+  # Using the multiline modifier will raise an +ArgumentError+.
   # Encoding regular expression modifiers are silently ignored. The
   # match will always use the default encoding or ASCII.
   #
-  # == Default route
-  #
-  # Consider the following route, which you will find commented out at the
-  # bottom of your generated <tt>config/routes.rb</tt>:
-  #
-  #   match ':controller(/:action(/:id))(.:format)'
-  #
-  # This route states that it expects requests to consist of a
-  # <tt>:controller</tt> followed optionally by an <tt>:action</tt> that in
-  # turn is followed optionally by an <tt>:id</tt>, which in turn is followed
-  # optionally by a <tt>:format</tt>.
-  #
-  # Suppose you get an incoming request for <tt>/blog/edit/22</tt>, you'll end
-  # up with:
-  #
-  #   params = { :controller => 'blog',
-  #              :action     => 'edit',
-  #              :id         => '22'
-  #           }
-  #
-  # By not relying on default routes, you improve the security of your
-  # application since not all controller actions, which includes actions you
-  # might add at a later time, are exposed by default.
-  #
-  # == HTTP Methods
-  #
-  # Using the <tt>:via</tt> option when specifying a route allows you to restrict it to a specific HTTP method.
-  # Possible values are <tt>:post</tt>, <tt>:get</tt>, <tt>:put</tt>, <tt>:delete</tt> and <tt>:any</tt>.
-  # If your route needs to respond to more than one method you can use an array, e.g. <tt>[ :get, :post ]</tt>.
-  # The default value is <tt>:any</tt> which means that the route will respond to any of the HTTP methods.
-  #
-  # Examples:
-  #
-  #   match 'post/:id' => 'posts#show', :via => :get
-  #   match 'post/:id' => "posts#create_comment', :via => :post
-  #
-  # Now, if you POST to <tt>/posts/:id</tt>, it will route to the <tt>create_comment</tt> action. A GET on the same
-  # URL will route to the <tt>show</tt> action.
-  #
-  # === HTTP helper methods
-  #
-  # An alternative method of specifying which HTTP method a route should respond to is to use the helper
-  # methods <tt>get</tt>, <tt>post</tt>, <tt>put</tt> and <tt>delete</tt>.
-  #
-  # Examples:
+  # == External redirects
   #
-  #   get 'post/:id' => 'posts#show'
-  #   post 'post/:id' => "posts#create_comment'
+  # You can redirect any path to another path using the redirect helper in your router:
   #
-  # This syntax is less verbose and the intention is more apparent to someone else reading your code,
-  # however if your route needs to respond to more than one HTTP method (or all methods) then using the
-  # <tt>:via</tt> option on <tt>match</tt> is preferable.
+  #   get "/stories" => redirect("/posts")
   #
-  # == External redirects
+  # == Unicode character routes
   #
-  # You can redirect any path to another path using the redirect helper in your router:
+  # You can specify unicode character routes in your router:
   #
-  #   match "/stories" => redirect("/posts")
+  #   get "こんにちは" => "welcome#index"
   #
   # == Routing to Rack Applications
   #
@@ -221,7 +191,7 @@ module ActionDispatch
   # index action in the PostsController, you can specify any Rack application
   # as the endpoint for a matcher:
   #
-  #   match "/application.js" => Sprockets
+  #   get "/application.js" => Sprockets
   #
   # == Reloading routes
   #
@@ -239,7 +209,7 @@ module ActionDispatch
   # === +assert_routing+
   #
   #   def test_movie_route_properly_splits
-  #    opts = {:controller => "plugin", :action => "checkout", :id => "2"}
+  #    opts = {controller: "plugin", action: "checkout", id: "2"}
   #    assert_routing "plugin/checkout/2", opts
   #   end
   #
@@ -248,7 +218,7 @@ module ActionDispatch
   # === +assert_recognizes+
   #
   #   def test_route_has_options
-  #    opts = {:controller => "plugin", :action => "show", :id => "12"}
+  #    opts = {controller: "plugin", action: "show", id: "12"}
   #    assert_recognizes opts, "/plugins/show/12"
   #   end
   #
@@ -283,11 +253,6 @@ module ActionDispatch
     autoload :PolymorphicRoutes, 'action_dispatch/routing/polymorphic_routes'
 
     SEPARATORS = %w( / . ? ) #:nodoc:
-    HTTP_METHODS = [:get, :head, :post, :put, :delete, :options] #:nodoc:
-
-    # A helper module to hold URL related helpers.
-    module Helpers #:nodoc:
-      include PolymorphicRoutes
-    end
+    HTTP_METHODS = [:get, :head, :post, :patch, :put, :delete, :options] #:nodoc:
   end
 end

data/lib/action_dispatch/testing/assertions/dom.rb

@@ -1,36 +1,26 @@
-require 'action_controller/vendor/html-scanner'
+require 'action_view/vendor/html-scanner'
 
 module ActionDispatch
   module Assertions
     module DomAssertions
       # \Test two HTML strings for equivalency (e.g., identical up to reordering of attributes)
       #
-      # ==== Examples
-      #
       #   # assert that the referenced method generates the appropriate HTML string
       #   assert_dom_equal '<a href="http://www.example.com">Apples</a>', link_to("Apples", "http://www.example.com")
-      #
       def assert_dom_equal(expected, actual, message = "")
         expected_dom = HTML::Document.new(expected).root
         actual_dom   = HTML::Document.new(actual).root
-        full_message = build_message(message, "<?> expected to be == to\n<?>.", expected_dom.to_s, actual_dom.to_s)
-
-        assert_block(full_message) { expected_dom == actual_dom }
+        assert_equal expected_dom, actual_dom
       end
 
       # The negated form of +assert_dom_equivalent+.
       #
-      # ==== Examples
-      #
       #   # assert that the referenced method does not generate the specified HTML string
       #   assert_dom_not_equal '<a href="http://www.example.com">Apples</a>', link_to("Oranges", "http://www.example.com")
-      #
       def assert_dom_not_equal(expected, actual, message = "")
         expected_dom = HTML::Document.new(expected).root
         actual_dom   = HTML::Document.new(actual).root
-        full_message = build_message(message, "<?> expected to be != to\n<?>.", expected_dom.to_s, actual_dom.to_s)
-
-        assert_block(full_message) { expected_dom != actual_dom }
+        assert_not_equal expected_dom, actual_dom
       end
     end
   end

data/lib/action_dispatch/testing/assertions/response.rb

@@ -1,14 +1,11 @@
-require 'active_support/core_ext/object/inclusion'
 
 module ActionDispatch
   module Assertions
     # A small suite of assertions that test responses from \Rails applications.
     module ResponseAssertions
-      extend ActiveSupport::Concern
-
       # Asserts that the response is one of the following types:
       #
-      # * <tt>:success</tt>   - Status code was 200
+      # * <tt>:success</tt>   - Status code was in the 200-299 range
       # * <tt>:redirect</tt>  - Status code was in the 300-399 range
       # * <tt>:missing</tt>   - Status code was 404
       # * <tt>:error</tt>     - Status code was in the 500-599 range
@@ -17,36 +14,32 @@ module ActionDispatch
       # or its symbolic equivalent <tt>assert_response(:not_implemented)</tt>.
       # See Rack::Utils::SYMBOL_TO_STATUS_CODE for a full list.
       #
-      # ==== Examples
-      #
       #   # assert that the response was a redirection
       #   assert_response :redirect
       #
       #   # assert that the response code was status code 401 (unauthorized)
       #   assert_response 401
-      #
       def assert_response(type, message = nil)
-        validate_request!
+        message ||= "Expected response to be a <#{type}>, but was <#{@response.response_code}>"
 
-        if type.in?([:success, :missing, :redirect, :error]) && @response.send("#{type}?")
-          assert_block("") { true } # to count the assertion
-        elsif type.is_a?(Fixnum) && @response.response_code == type
-          assert_block("") { true } # to count the assertion
-        elsif type.is_a?(Symbol) && @response.response_code == Rack::Utils::SYMBOL_TO_STATUS_CODE[type]
-          assert_block("") { true } # to count the assertion
+        if Symbol === type
+          if [:success, :missing, :redirect, :error].include?(type)
+            assert @response.send("#{type}?"), message
+          else
+            code = Rack::Utils::SYMBOL_TO_STATUS_CODE[type]
+            assert_equal code, @response.response_code, message
+          end
         else
-          flunk(build_message(message, "Expected response to be a <?>, but was <?>", type, @response.response_code))
+          assert_equal type, @response.response_code, message
         end
       end
 
       # Assert that the redirection options passed in match those of the redirect called in the latest action.
-      # This match can be partial, such that <tt>assert_redirected_to(:controller => "weblog")</tt> will also
-      # match the redirection of <tt>redirect_to(:controller => "weblog", :action => "show")</tt> and so on.
-      #
-      # ==== Examples
+      # This match can be partial, such that <tt>assert_redirected_to(controller: "weblog")</tt> will also
+      # match the redirection of <tt>redirect_to(controller: "weblog", action: "show")</tt> and so on.
       #
       #   # assert that the redirection was to the "index" action on the WeblogController
-      #   assert_redirected_to :controller => "weblog", :action => "index"
+      #   assert_redirected_to controller: "weblog", action: "index"
       #
       #   # assert that the redirection was to the named route login_url
       #   assert_redirected_to login_url
@@ -54,16 +47,17 @@ module ActionDispatch
       #   # assert that the redirection was to the url for @customer
       #   assert_redirected_to @customer
       #
+      #   # asserts that the redirection matches the regular expression
+      #   assert_redirected_to %r(\Ahttp://example.org)
       def assert_redirected_to(options = {}, message=nil)
         assert_response(:redirect, message)
-        return true if options == @response.location
+        return true if options === @response.location
 
         redirect_is       = normalize_argument_to_redirection(@response.location)
         redirect_expected = normalize_argument_to_redirection(options)
 
-        if redirect_is != redirect_expected
-          flunk(build_message(message, "Expected response to be a redirect to <?> but was a redirect to <?>", redirect_expected, redirect_is))
-        end
+        message ||= "Expected response to be a redirect to <#{redirect_expected}> but was a redirect to <#{redirect_is}>"
+        assert_operator redirect_expected, :===, redirect_is, message
       end
 
       private
@@ -73,23 +67,21 @@ module ActionDispatch
         end
 
         def normalize_argument_to_redirection(fragment)
-          case fragment
-          when %r{^\w[A-Za-z\d+.-]*:.*}
-            fragment
-          when String
-            @request.protocol + @request.host_with_port + fragment
-          when :back
-            raise RedirectBackError unless refer = @request.headers["Referer"]
-            refer
-          else
-            @controller.url_for(fragment)
-          end.gsub(/[\0\r\n]/, '')
-        end
+          normalized = case fragment
+            when Regexp
+              fragment
+            when %r{^\w[A-Za-z\d+.-]*:.*}
+              fragment
+            when String
+              @request.protocol + @request.host_with_port + fragment
+            when :back
+              raise RedirectBackError unless refer = @request.headers["Referer"]
+              refer
+            else
+              @controller.url_for(fragment)
+            end
 
-        def validate_request!
-          unless @request.is_a?(ActionDispatch::Request)
-            raise ArgumentError, "@request must be an ActionDispatch::Request"
-          end
+          normalized.respond_to?(:delete) ? normalized.delete("\0\r\n") : normalized
         end
     end
   end