actionpack 4.2.8 → 5.2.4.2

data/lib/action_dispatch/routing/routes_proxy.rb

@@ -1,4 +1,6 @@
-require 'active_support/core_ext/array/extract_options'
+# frozen_string_literal: true
+
+require "active_support/core_ext/array/extract_options"
 
 module ActionDispatch
   module Routing
@@ -8,9 +10,10 @@ module ActionDispatch
       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,7 +22,8 @@ module ActionDispatch
         end
       end
 
-      def respond_to?(method, include_private = false)
+    private
+      def respond_to_missing?(method, _)
         super || @helpers.respond_to?(method)
       end
 
@@ -28,15 +32,38 @@ module ActionDispatch
           self.class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
             def #{method}(*args)
               options = args.extract_options!
-              args << url_options.merge((options || {}).symbolize_keys)
+              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.#{method}(*args)
             end
           RUBY
-          send(method, *args)
+          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,7 +1,9 @@
+# frozen_string_literal: true
+
 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.
+    # is also possible: a 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.
@@ -52,9 +54,11 @@ module ActionDispatch
     # 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.
+    # 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 you still have to provide
+    # the +:host+ argument or set the default host that will be used in all mailers using the
+    # configuration option +config.action_mailer.default_url_options+. For more information on
+    # url_for in mailers read the ActionMailer#Base documentation.
     #
     #
     # == URL generation for named routes
@@ -105,16 +109,16 @@ module ActionDispatch
       end
 
       # Hook overridden in controller to add request information
-      # with `default_url_options`. Application logic should not
+      # 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
+      # Generate a URL based on the options provided, default_url_options and the
       # routes defined in routes.rb. The following options are supported:
       #
-      # * <tt>:only_path</tt> - If true, the relative url is returned. Defaults to +false+.
+      # * <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
@@ -147,14 +151,32 @@ module ActionDispatch
       #    # => 'http://somehost.org/myapp/tasks/testing'
       #    url_for controller: 'tasks', action: 'testing', host: 'somehost.org', script_name: "/myapp", only_path: true
       #    # => '/myapp/tasks/testing'
+      #
+      # 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 <tt>GET /users/1</tt>:
+      #
+      #   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 +191,45 @@ module ActionDispatch
         end
       end
 
-      protected
-
-      def optimize_routes_generation?
-        _routes.optimize_routes_generation? && default_url_options.empty?
+      # 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 _with_routes(routes)
-        old_routes, @_routes = @_routes, routes
-        yield
-      ensure
-        @_routes = old_routes
-      end
+      protected
 
-      def _routes_context
-        self
-      end
+        def optimize_routes_generation?
+          _routes.optimize_routes_generation? && default_url_options.empty?
+        end
 
       private
 
-        def _generate_paths_by_default
-          true
+        def _with_routes(routes) # :doc:
+          old_routes, @_routes = @_routes, routes
+          yield
+        ensure
+          @_routes = old_routes
+        end
+
+        def _routes_context # :doc:
+          self
         end
     end
   end

data/lib/action_dispatch/system_test_case.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+gem "capybara", ">= 2.15"
+
+require "capybara/dsl"
+require "capybara/minitest"
+require "action_controller"
+require "action_dispatch/system_testing/driver"
+require "action_dispatch/system_testing/browser"
+require "action_dispatch/system_testing/server"
+require "action_dispatch/system_testing/test_helpers/screenshot_helper"
+require "action_dispatch/system_testing/test_helpers/setup_and_teardown"
+require "action_dispatch/system_testing/test_helpers/undef_methods"
+
+module ActionDispatch
+  # = System Testing
+  #
+  # System tests let you test applications in the browser. Because system
+  # tests use a real browser experience, you can test all of your JavaScript
+  # easily from your test suite.
+  #
+  # To create a system test in your application, extend your test class
+  # from <tt>ApplicationSystemTestCase</tt>. System tests use Capybara as a
+  # base and allow you to configure the settings through your
+  # <tt>application_system_test_case.rb</tt> file that is generated with a new
+  # application or scaffold.
+  #
+  # Here is an example system test:
+  #
+  #   require 'application_system_test_case'
+  #
+  #   class Users::CreateTest < ApplicationSystemTestCase
+  #     test "adding a new user" do
+  #       visit users_path
+  #       click_on 'New User'
+  #
+  #       fill_in 'Name', with: 'Arya'
+  #       click_on 'Create User'
+  #
+  #       assert_text 'Arya'
+  #     end
+  #   end
+  #
+  # When generating an application or scaffold, an +application_system_test_case.rb+
+  # file will also be generated containing the base class for system testing.
+  # This is where you can change the driver, add Capybara settings, and other
+  # configuration for your system tests.
+  #
+  #   require "test_helper"
+  #
+  #   class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  #     driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+  #   end
+  #
+  # By default, <tt>ActionDispatch::SystemTestCase</tt> is driven by the
+  # Selenium driver, with the Chrome browser, and a browser size of 1400x1400.
+  #
+  # Changing the driver configuration options is easy. Let's say you want to use
+  # the Firefox browser instead of Chrome. In your +application_system_test_case.rb+
+  # file add the following:
+  #
+  #   require "test_helper"
+  #
+  #   class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  #     driven_by :selenium, using: :firefox
+  #   end
+  #
+  # +driven_by+ has a required argument for the driver name. The keyword
+  # arguments are +:using+ for the browser and +:screen_size+ to change the
+  # size of the browser screen. These two options are not applicable for
+  # headless drivers and will be silently ignored if passed.
+  #
+  # Headless browsers such as headless Chrome and headless Firefox are also supported.
+  # You can use these browsers by setting the +:using+ argument to +:headless_chrome+ or +:headless_firefox+.
+  #
+  # To use a headless driver, like Poltergeist, update your Gemfile to use
+  # Poltergeist instead of Selenium and then declare the driver name in the
+  # +application_system_test_case.rb+ file. In this case, you would leave out
+  # the +:using+ option because the driver is headless, but you can still use
+  # +:screen_size+ to change the size of the browser screen, also you can use
+  # +:options+ to pass options supported by the driver. Please refer to your
+  # driver documentation to learn about supported options.
+  #
+  #   require "test_helper"
+  #   require "capybara/poltergeist"
+  #
+  #   class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  #     driven_by :poltergeist, screen_size: [1400, 1400], options:
+  #       { js_errors: true }
+  #   end
+  #
+  # Because <tt>ActionDispatch::SystemTestCase</tt> is a shim between Capybara
+  # and Rails, any driver that is supported by Capybara is supported by system
+  # tests as long as you include the required gems and files.
+  class SystemTestCase < IntegrationTest
+    include Capybara::DSL
+    include Capybara::Minitest::Assertions
+    include SystemTesting::TestHelpers::SetupAndTeardown
+    include SystemTesting::TestHelpers::ScreenshotHelper
+    include SystemTesting::TestHelpers::UndefMethods
+
+    def initialize(*) # :nodoc:
+      super
+      self.class.driver.use
+    end
+
+    def self.start_application # :nodoc:
+      Capybara.app = Rack::Builder.new do
+        map "/" do
+          run Rails.application
+        end
+      end
+
+      SystemTesting::Server.new.run
+    end
+
+    class_attribute :driver, instance_accessor: false
+
+    # System Test configuration options
+    #
+    # The default settings are Selenium, using Chrome, with a screen size
+    # of 1400x1400.
+    #
+    # Examples:
+    #
+    #   driven_by :poltergeist
+    #
+    #   driven_by :selenium, screen_size: [800, 800]
+    #
+    #   driven_by :selenium, using: :chrome
+    #
+    #   driven_by :selenium, using: :headless_chrome
+    #
+    #   driven_by :selenium, using: :firefox
+    #
+    #   driven_by :selenium, using: :headless_firefox
+    def self.driven_by(driver, using: :chrome, screen_size: [1400, 1400], options: {})
+      self.driver = SystemTesting::Driver.new(driver, using: using, screen_size: screen_size, options: options)
+    end
+
+    driven_by :selenium
+
+    ActiveSupport.run_load_hooks(:action_dispatch_system_test_case, self)
+  end
+
+  SystemTestCase.start_application
+end

data/lib/action_dispatch/system_testing/browser.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module SystemTesting
+    class Browser # :nodoc:
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def type
+        case name
+        when :headless_chrome
+          :chrome
+        when :headless_firefox
+          :firefox
+        else
+          name
+        end
+      end
+
+      def options
+        case name
+        when :headless_chrome
+          headless_chrome_browser_options
+        when :headless_firefox
+          headless_firefox_browser_options
+        end
+      end
+
+      private
+        def headless_chrome_browser_options
+          options = Selenium::WebDriver::Chrome::Options.new
+          options.args << "--headless"
+          options.args << "--disable-gpu" if Gem.win_platform?
+
+          options
+        end
+
+        def headless_firefox_browser_options
+          options = Selenium::WebDriver::Firefox::Options.new
+          options.args << "-headless"
+
+          options
+        end
+    end
+  end
+end

data/lib/action_dispatch/system_testing/driver.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module SystemTesting
+    class Driver # :nodoc:
+      def initialize(name, **options)
+        @name = name
+        @browser = Browser.new(options[:using])
+        @screen_size = options[:screen_size]
+        @options = options[:options]
+      end
+
+      def use
+        register if registerable?
+
+        setup
+      end
+
+      private
+        def registerable?
+          [:selenium, :poltergeist, :webkit].include?(@name)
+        end
+
+        def register
+          Capybara.register_driver @name do |app|
+            case @name
+            when :selenium then register_selenium(app)
+            when :poltergeist then register_poltergeist(app)
+            when :webkit then register_webkit(app)
+            end
+          end
+        end
+
+        def browser_options
+          @options.merge(options: @browser.options).compact
+        end
+
+        def register_selenium(app)
+          Capybara::Selenium::Driver.new(app, { browser: @browser.type }.merge(browser_options)).tap do |driver|
+            driver.browser.manage.window.size = Selenium::WebDriver::Dimension.new(*@screen_size)
+          end
+        end
+
+        def register_poltergeist(app)
+          Capybara::Poltergeist::Driver.new(app, @options.merge(window_size: @screen_size))
+        end
+
+        def register_webkit(app)
+          Capybara::Webkit::Driver.new(app, Capybara::Webkit::Configuration.to_hash.merge(@options)).tap do |driver|
+            driver.resize_window_to(driver.current_window_handle, *@screen_size)
+          end
+        end
+
+        def setup
+          Capybara.current_driver = @name
+        end
+    end
+  end
+end