actionpack 4.2.10 → 7.2.0.rc1

data/lib/action_dispatch/routing/routes_proxy.rb

@@ -1,16 +1,21 @@
-require 'active_support/core_ext/array/extract_options'
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "active_support/core_ext/array/extract_options"
 
 module ActionDispatch
   module Routing
-    class RoutesProxy #:nodoc:
+    class RoutesProxy # :nodoc:
       include ActionDispatch::Routing::UrlFor
 
       attr_accessor :scope, :routes
       alias :_routes :routes
 
-      def initialize(routes, scope, helpers)
+      def initialize(routes, scope, helpers, script_namer = nil)
         @routes, @scope = routes, scope
         @helpers = helpers
+        @script_namer = script_namer
       end
 
       def url_options
@@ -19,24 +24,43 @@ module ActionDispatch
         end
       end
 
-      def respond_to?(method, include_private = false)
+    private
+      def respond_to_missing?(method, _)
         super || @helpers.respond_to?(method)
       end
 
       def method_missing(method, *args)
         if @helpers.respond_to?(method)
-          self.class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def #{method}(*args)
-              options = args.extract_options!
-              args << url_options.merge((options || {}).symbolize_keys)
-              @helpers.#{method}(*args)
-            end
-          RUBY
-          send(method, *args)
+          options = args.extract_options!
+          options = url_options.merge((options || {}).symbolize_keys)
+
+          if @script_namer
+            options[:script_name] = merge_script_names(
+              options[:script_name],
+              @script_namer.call(options)
+            )
+          end
+
+          args << options
+          @helpers.public_send(method, *args)
         else
           super
         end
       end
+
+      # Keeps the part of the script name provided by the global context via
+      # [ENV]("SCRIPT_NAME"), which `mount` doesn't know about since it depends on the
+      # specific request, but use our script name resolver for the mount point
+      # dependent part.
+      def merge_script_names(previous_script_name, new_script_name)
+        return new_script_name unless previous_script_name
+
+        resolved_parts = new_script_name.count("/")
+        previous_parts = previous_script_name.count("/")
+        context_parts = previous_parts - resolved_parts + 1
+
+        (previous_script_name.split("/").slice(0, context_parts).join("/")) + new_script_name
+      end
     end
   end
 end

data/lib/action_dispatch/routing/url_for.rb

@@ -1,84 +1,93 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
 module ActionDispatch
   module Routing
-    # In <tt>config/routes.rb</tt> you define URL-to-controller mappings, but the reverse
-    # is also possible: an URL can be generated from one of your routing definitions.
-    # URL generation functionality is centralized in this module.
-    #
-    # See ActionDispatch::Routing for general information about routing and routes.rb.
-    #
-    # <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. 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
-    #
-    # As you may know, some functions, such as ActionController::Base#url_for
-    # and ActionView::Helpers::UrlHelper#link_to, can generate URLs given a set
-    # 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!') %>
-    #   # => <a href="/users/new?message=Welcome%21">Click here</a>
-    #
-    # link_to, and all other functions that require URL generation functionality,
-    # actually use ActionController::UrlFor under the hood. And in particular,
-    # they use the ActionController::UrlFor#url_for method. One can generate
-    # 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)
-    #   # => "/users/new?message=Welcome%21"
-    #
-    # 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')
-    #   # => "http://www.example.com/users/new?message=Welcome%21"
-    #
-    # By default, all controllers and views have access to a special version of url_for,
-    # that already knows what the current hostname is. So if you use url_for in your
-    # controllers or your views, then you don't need to explicitly pass the <tt>:host</tt>
-    # argument.
-    #
-    # For convenience reasons, mailers provide a shortcut for ActionController::UrlFor#url_for.
-    # So within mailers, you only have to type 'url_for' instead of 'ActionController::UrlFor#url_for'
-    # in full. However, mailers don't have hostname information, and that's why you'll still
-    # have to specify the <tt>:host</tt> argument when generating URLs in mailers.
+    # # Action Dispatch Routing UrlFor
     #
+    # In `config/routes.rb` you define URL-to-controller mappings, but the reverse
+    # is also possible: a URL can be generated from one of your routing definitions.
+    # URL generation functionality is centralized in this module.
     #
-    # == URL generation for named routes
+    # See ActionDispatch::Routing for general information about routing and
+    # `config/routes.rb`.
+    #
+    # **Tip:** If you need to generate URLs from your models or some other place,
+    # then ActionDispatch::Routing::UrlFor is what you're looking for. Read on for
+    # 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
+    #
+    # As you may know, some functions, such as `ActionController::Base#url_for` and
+    # ActionView::Helpers::UrlHelper#link_to, can generate URLs given a set 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!') %>
+    #     # => <a href="/users/new?message=Welcome%21">Click here</a>
+    #
+    # `link_to`, and all other functions that require URL generation functionality,
+    # actually use ActionDispatch::Routing::UrlFor under the hood. And in
+    # particular, they use the ActionDispatch::Routing::UrlFor#url_for method. One
+    # can generate the same path as the above example by using the following code:
+    #
+    #     include ActionDispatch::Routing::UrlFor
+    #     url_for(controller: 'users',
+    #             action: 'new',
+    #             message: 'Welcome!',
+    #             only_path: true)
+    #     # => "/users/new?message=Welcome%21"
+    #
+    # Notice the `only_path: true` 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 `:host` argument:
+    #
+    #     include UrlFor
+    #     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`, that already knows what the current hostname is. So if you use
+    # `url_for` in your controllers or your views, then you don't need to explicitly
+    # pass the `:host` argument.
+    #
+    # For convenience, mailers also include ActionDispatch::Routing::UrlFor. So
+    # within mailers, you can use url_for. However, mailers cannot access incoming
+    # web requests in order to derive hostname information, so you have to provide
+    # the `:host` option or set the default host using `default_url_options`. For
+    # more information on url_for in mailers see the ActionMailer::Base
+    # documentation.
+    #
+    # ## URL generation for named routes
     #
     # UrlFor also allows one to access methods that have been auto-generated from
     # named routes. For example, suppose that you have a 'users' resource in your
-    # <tt>config/routes.rb</tt>:
+    # `config/routes.rb`:
     #
-    #   resources :users
+    #     resources :users
     #
-    # 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 Rails.application.routes.url_helpers in your class:
+    # This generates, among other things, the method `users_path`. 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 `Rails.application.routes.url_helpers` in your
+    # class:
     #
-    #   class User < ActiveRecord::Base
-    #     include Rails.application.routes.url_helpers
+    #     class User < ActiveRecord::Base
+    #       include Rails.application.routes.url_helpers
     #
-    #     def base_uri
-    #       user_path(self)
+    #       def base_uri
+    #         user_path(self)
+    #       end
     #     end
-    #   end
     #
-    #   User.find(1).base_uri # => "/users/1"
+    #     User.find(1).base_uri # => "/users/1"
     #
     module UrlFor
       extend ActiveSupport::Concern
@@ -99,62 +108,85 @@ module ActionDispatch
         include(*_url_for_modules) if respond_to?(:_url_for_modules)
       end
 
-      def initialize(*)
+      def initialize(...)
         @_routes = nil
         super
       end
 
-      # Hook overridden in controller to add request information
-      # with `default_url_options`. Application logic should not
-      # go into url_options.
+      # 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
 
-      # Generate a url based on the options provided, default_url_options and the
-      # routes defined in routes.rb. The following options are supported:
+      # Generate a URL based on the options provided, `default_url_options`, and the
+      # routes defined in `config/routes.rb`. The following options are supported:
+      #
+      # *   `:only_path` - If true, the relative URL is returned. Defaults to `false`.
+      # *   `:protocol` - The protocol to connect to. Defaults to `"http"`.
+      # *   `:host` - Specifies the host the link should be targeted at. If
+      #     `:only_path` is false, this option must be provided either explicitly, or
+      #     via `default_url_options`.
+      # *   `:subdomain` - Specifies the subdomain of the link, using the `tld_length`
+      #     to split the subdomain from the host. If false, removes all subdomains
+      #     from the host part of the link.
+      # *   `:domain` - Specifies the domain of the link, using the `tld_length` to
+      #     split the domain from the host.
+      # *   `:tld_length` - Number of labels the TLD id composed of, only used if
+      #     `:subdomain` or `:domain` are supplied. Defaults to
+      #     `ActionDispatch::Http::URL.tld_length`, which in turn defaults to 1.
+      # *   `:port` - Optionally specify the port to connect to.
+      # *   `:anchor` - An anchor name to be appended to the path.
+      # *   `:params` - The query parameters to be appended to the path.
+      # *   `:path_params` - The query parameters that will only be used for the named
+      #     dynamic segments of path. If unused, they will be discarded.
+      # *   `:trailing_slash` - If true, adds a trailing slash, as in
+      #     `"/archive/2009/"`.
+      # *   `:script_name` - Specifies application path relative to domain root. If
+      #     provided, prepends application path.
+      #
+      #
+      # Any other key (`:controller`, `:action`, etc.) given to `url_for` is forwarded
+      # to the Routes module.
       #
-      # * <tt>:only_path</tt> - If true, the relative url is returned. Defaults to +false+.
-      # * <tt>:protocol</tt> - The protocol to connect to. Defaults to 'http'.
-      # * <tt>:host</tt> - Specifies the host the link should be targeted at.
-      #   If <tt>:only_path</tt> is false, this option must be
-      #   provided either explicitly, or via +default_url_options+.
-      # * <tt>:subdomain</tt> - Specifies the subdomain of the link, using the +tld_length+
-      #   to split the subdomain from the host.
-      #   If false, removes all subdomains from the host part of the link.
-      # * <tt>:domain</tt> - Specifies the domain of the link, using the +tld_length+
-      #   to split the domain from the host.
-      # * <tt>:tld_length</tt> - Number of labels the TLD id composed of, only used if
-      #   <tt>:subdomain</tt> or <tt>:domain</tt> are supplied. Defaults to
-      #   <tt>ActionDispatch::Http::URL.tld_length</tt>, which in turn defaults to 1.
-      # * <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.
+      #     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
+      #     # => '/tasks/testing#ok'
+      #     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'
+      #     # => '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'
       #
-      # Any other key (<tt>:controller</tt>, <tt>:action</tt>, etc.) given to
-      # +url_for+ is forwarded to the Routes module.
+      # Missing routes keys may be filled in from the current request's parameters
+      # (e.g. `:controller`, `:action`, `:id`, and any other parameters that are
+      # placed in the path). Given that the current action has been reached through
+      # `GET /users/1`:
       #
-      #    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
-      #    # => '/tasks/testing#ok'
-      #    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'
-      #    # => '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'
+      #     url_for(only_path: true)                        # => '/users/1'
+      #     url_for(only_path: true, action: 'edit')        # => '/users/1/edit'
+      #     url_for(only_path: true, action: 'edit', id: 2) # => '/users/2/edit'
+      #
+      # Notice that no `:id` parameter was provided to the first `url_for` call and
+      # the helper used the one from the route's path. Any path parameter implicitly
+      # used by `url_for` can always be overwritten like shown on the last `url_for`
+      # calls.
       def url_for(options = nil)
+        full_url_for(options)
+      end
+
+      def full_url_for(options = nil) # :nodoc:
         case options
         when nil
           _routes.url_for(url_options.symbolize_keys)
-        when Hash
+        when Hash, ActionController::Parameters
           route_name = options.delete :use_route
-          _routes.url_for(options.symbolize_keys.reverse_merge!(url_options),
-                         route_name)
+          merged_url_options = options.to_h.symbolize_keys.reverse_merge!(url_options)
+          _routes.url_for(merged_url_options, route_name)
         when String
           options
         when Symbol
@@ -169,27 +201,43 @@ module ActionDispatch
         end
       end
 
-      protected
-
-      def optimize_routes_generation?
-        _routes.optimize_routes_generation? && default_url_options.empty?
-      end
-
-      def _with_routes(routes)
-        old_routes, @_routes = @_routes, routes
-        yield
-      ensure
-        @_routes = old_routes
+      # Allows calling direct or regular named route.
+      #
+      #     resources :buckets
+      #
+      #     direct :recordable do |recording|
+      #       route_for(:bucket, recording.bucket)
+      #     end
+      #
+      #     direct :threadable do |threadable|
+      #       route_for(:recordable, threadable.parent)
+      #     end
+      #
+      # This maintains the context of the original caller on whether to return a path
+      # or full URL, e.g:
+      #
+      #     threadable_path(threadable)  # => "/buckets/1"
+      #     threadable_url(threadable)   # => "http://example.com/buckets/1"
+      #
+      def route_for(name, *args)
+        public_send(:"#{name}_url", *args)
       end
 
-      def _routes_context
-        self
-      end
+      protected
+        def optimize_routes_generation?
+          _routes.optimize_routes_generation? && default_url_options.empty?
+        end
 
       private
+        def _with_routes(routes) # :doc:
+          old_routes, @_routes = @_routes, routes
+          yield
+        ensure
+          @_routes = old_routes
+        end
 
-        def _generate_paths_by_default
-          true
+        def _routes_context # :doc:
+          self
         end
     end
   end