actionpack 4.2.10 → 7.2.0.rc1

data/lib/action_dispatch/testing/request_encoder.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "nokogiri"
+
+module ActionDispatch
+  class RequestEncoder # :nodoc:
+    class IdentityEncoder
+      def content_type; end
+      def accept_header; end
+      def encode_params(params); params; end
+      def response_parser; -> body { body }; end
+    end
+
+    @encoders = { identity: IdentityEncoder.new }
+
+    attr_reader :response_parser
+
+    def initialize(mime_name, param_encoder, response_parser)
+      @mime = Mime[mime_name]
+
+      unless @mime
+        raise ArgumentError, "Can't register a request encoder for " \
+          "unregistered MIME Type: #{mime_name}. See `Mime::Type.register`."
+      end
+
+      @response_parser = response_parser || -> body { body }
+      @param_encoder   = param_encoder   || :"to_#{@mime.symbol}".to_proc
+    end
+
+    def content_type
+      @mime.to_s
+    end
+
+    def accept_header
+      @mime.to_s
+    end
+
+    def encode_params(params)
+      @param_encoder.call(params) if params
+    end
+
+    def self.parser(content_type)
+      type = Mime::Type.lookup(content_type).ref if content_type
+      encoder(type).response_parser
+    end
+
+    def self.encoder(name)
+      @encoders[name] || @encoders[:identity]
+    end
+
+    def self.register_encoder(mime_name, param_encoder: nil, response_parser: nil)
+      @encoders[mime_name] = new(mime_name, param_encoder, response_parser)
+    end
+
+    register_encoder :html, response_parser: -> body { Rails::Dom::Testing.html_document.parse(body) }
+    register_encoder :json, response_parser: -> body { JSON.parse(body, object_class: ActiveSupport::HashWithIndifferentAccess) }
+  end
+end

data/lib/action_dispatch/testing/test_helpers/page_dump_helper.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module TestHelpers
+    module PageDumpHelper
+      class InvalidResponse < StandardError; end
+
+      # Saves the content of response body to a file and tries to open it in your browser.
+      # Launchy must be present in your Gemfile for the page to open automatically.
+      def save_and_open_page(path = html_dump_default_path)
+        save_page(path).tap { |s_path| open_file(s_path) }
+      end
+
+      private
+        def save_page(path = html_dump_default_path)
+          raise InvalidResponse.new("Response is a redirection!") if response.redirection?
+          path = Pathname.new(path)
+          path.dirname.mkpath
+          File.write(path, response.body)
+          path
+        end
+
+        def open_file(path)
+          require "launchy"
+          Launchy.open(path)
+        rescue LoadError
+          warn "File saved to #{path}.\nPlease install the launchy gem to open the file automatically."
+        end
+
+        def html_dump_default_path
+          Rails.root.join("tmp/html_dump", "#{method_name}_#{DateTime.current.to_i}.html").to_s
+        end
+    end
+  end
+end

data/lib/action_dispatch/testing/test_process.rb

@@ -1,13 +1,41 @@
-require 'action_dispatch/middleware/cookies'
-require 'action_dispatch/middleware/flash'
-require 'active_support/core_ext/hash/indifferent_access'
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "action_dispatch/middleware/cookies"
+require "action_dispatch/middleware/flash"
 
 module ActionDispatch
   module TestProcess
+    module FixtureFile
+      # Shortcut for
+      # `Rack::Test::UploadedFile.new(File.join(ActionDispatch::IntegrationTest.file_f
+      # ixture_path, path), type)`:
+      #
+      #     post :change_avatar, params: { avatar: file_fixture_upload('david.png', 'image/png') }
+      #
+      # Default fixture files location is `test/fixtures/files`.
+      #
+      # To upload binary files on Windows, pass `:binary` as the last parameter. This
+      # will not affect other platforms:
+      #
+      #     post :change_avatar, params: { avatar: file_fixture_upload('david.png', 'image/png', :binary) }
+      def file_fixture_upload(path, mime_type = nil, binary = false)
+        if self.class.file_fixture_path && !File.exist?(path)
+          path = file_fixture(path)
+        end
+
+        Rack::Test::UploadedFile.new(path, mime_type, binary)
+      end
+      alias_method :fixture_file_upload, :file_fixture_upload
+    end
+
+    include FixtureFile
+
     def assigns(key = nil)
-      assigns = {}.with_indifferent_access
-      @controller.view_assigns.each { |k, v| assigns.regular_writer(k, v) }
-      key.nil? ? assigns : assigns[key]
+      raise NoMethodError,
+        'assigns has been extracted to a gem. To continue using it,
+        add `gem "rails-controller-testing"` to your Gemfile.'
     end
 
     def session
@@ -19,26 +47,11 @@ module ActionDispatch
     end
 
     def cookies
-      @request.cookie_jar
+      @cookie_jar ||= Cookies::CookieJar.build(@request, @request.cookies)
     end
 
     def redirect_to_url
       @response.redirect_url
     end
-
-    # Shortcut for <tt>Rack::Test::UploadedFile.new(File.join(ActionController::TestCase.fixture_path, path), type)</tt>:
-    #
-    #   post :change_avatar, avatar: fixture_file_upload('files/spongebob.png', 'image/png')
-    #
-    # To upload binary files on Windows, pass <tt>:binary</tt> as the last parameter.
-    # This will not affect other platforms:
-    #
-    #   post :change_avatar, avatar: fixture_file_upload('files/spongebob.png', 'image/png', :binary)
-    def fixture_file_upload(path, mime_type = nil, binary = false)
-      if self.class.respond_to?(:fixture_path) && self.class.fixture_path
-        path = File.join(self.class.fixture_path, path)
-      end
-      Rack::Test::UploadedFile.new(path, mime_type, binary)
-    end
   end
 end

data/lib/action_dispatch/testing/test_request.rb

@@ -1,41 +1,48 @@
-require 'active_support/core_ext/hash/indifferent_access'
-require 'rack/utils'
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "active_support/core_ext/hash/indifferent_access"
+require "rack/utils"
 
 module ActionDispatch
   class TestRequest < Request
-    DEFAULT_ENV = Rack::MockRequest.env_for('/',
-      'HTTP_HOST'       => 'test.host',
-      'REMOTE_ADDR'     => '0.0.0.0',
-      'HTTP_USER_AGENT' => 'Rails Testing'
+    DEFAULT_ENV = Rack::MockRequest.env_for("/",
+      "HTTP_HOST"                => "test.host".b,
+      "REMOTE_ADDR"              => "0.0.0.0".b,
+      "HTTP_USER_AGENT"          => "Rails Testing".b,
     )
 
-    def self.new(env = {})
-      super
+    # Create a new test request with default `env` values.
+    def self.create(env = {})
+      env = Rails.application.env_config.merge(env) if defined?(Rails.application) && Rails.application
+      env["rack.request.cookie_hash"] ||= {}.with_indifferent_access
+      new(default_env.merge(env))
     end
 
-    def initialize(env = {})
-      env = Rails.application.env_config.merge(env) if defined?(Rails.application) && Rails.application
-      super(default_env.merge(env))
+    def self.default_env
+      DEFAULT_ENV
     end
+    private_class_method :default_env
 
     def request_method=(method)
-      @env['REQUEST_METHOD'] = method.to_s.upcase
+      super(method.to_s.upcase)
     end
 
     def host=(host)
-      @env['HTTP_HOST'] = host
+      set_header("HTTP_HOST", host)
     end
 
     def port=(number)
-      @env['SERVER_PORT'] = number.to_i
+      set_header("SERVER_PORT", number)
     end
 
     def request_uri=(uri)
-      @env['REQUEST_URI'] = uri
+      set_header("REQUEST_URI", uri)
     end
 
     def path=(path)
-      @env['PATH_INFO'] = path
+      set_header("PATH_INFO", path)
     end
 
     def action=(action_name)
@@ -43,36 +50,24 @@ module ActionDispatch
     end
 
     def if_modified_since=(last_modified)
-      @env['HTTP_IF_MODIFIED_SINCE'] = last_modified
+      set_header("HTTP_IF_MODIFIED_SINCE", last_modified)
     end
 
     def if_none_match=(etag)
-      @env['HTTP_IF_NONE_MATCH'] = etag
+      set_header("HTTP_IF_NONE_MATCH", etag)
     end
 
     def remote_addr=(addr)
-      @env['REMOTE_ADDR'] = addr
+      set_header("REMOTE_ADDR", addr)
     end
 
     def user_agent=(user_agent)
-      @env['HTTP_USER_AGENT'] = user_agent
+      set_header("HTTP_USER_AGENT", user_agent)
     end
 
     def accept=(mime_types)
-      @env.delete('action_dispatch.request.accepts')
-      @env['HTTP_ACCEPT'] = Array(mime_types).collect { |mime_type| mime_type.to_s }.join(",")
-    end
-
-    alias :rack_cookies :cookies
-
-    def cookies
-      @cookies ||= {}.with_indifferent_access
-    end
-
-    private
-
-    def default_env
-      DEFAULT_ENV
+      delete_header("action_dispatch.request.accepts")
+      set_header("HTTP_ACCEPT", Array(mime_types).collect(&:to_s).join(","))
     end
   end
 end

data/lib/action_dispatch/testing/test_response.rb

@@ -1,25 +1,58 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "action_dispatch/testing/request_encoder"
+
 module ActionDispatch
-  # Integration test methods such as ActionDispatch::Integration::Session#get
-  # and ActionDispatch::Integration::Session#post return objects of class
-  # TestResponse, which represent the HTTP response results of the requested
-  # controller actions.
+  # Integration test methods such as Integration::RequestHelpers#get and
+  # Integration::RequestHelpers#post return objects of class TestResponse, which
+  # represent the HTTP response results of the requested controller actions.
   #
   # See Response for more information on controller response objects.
   class TestResponse < Response
     def self.from_response(response)
-      new response.status, response.headers, response.body, default_headers: nil
+      new response.status, response.headers, response.body
     end
 
-    # Was the response successful?
-    alias_method :success?, :successful?
-
-    # Was the URL not found?
-    alias_method :missing?, :not_found?
-
-    # Were we redirected?
-    alias_method :redirect?, :redirection?
+    # Returns a parsed body depending on the response MIME type. When a parser
+    # corresponding to the MIME type is not found, it returns the raw body.
+    #
+    # #### Examples
+    #     get "/posts"
+    #     response.content_type         # => "text/html; charset=utf-8"
+    #     response.parsed_body.class    # => Nokogiri::HTML5::Document
+    #     response.parsed_body.to_html  # => "<!DOCTYPE html>\n<html>\n..."
+    #
+    #     assert_pattern { response.parsed_body.at("main") => { content: "Hello, world" } }
+    #
+    #     response.parsed_body.at("main") => {name:, content:}
+    #     assert_equal "main", name
+    #     assert_equal "Some main content", content
+    #
+    #     get "/posts.json"
+    #     response.content_type         # => "application/json; charset=utf-8"
+    #     response.parsed_body.class    # => Array
+    #     response.parsed_body          # => [{"id"=>42, "title"=>"Title"},...
+    #
+    #     assert_pattern { response.parsed_body => [{ id: 42 }] }
+    #
+    #     get "/posts/42.json"
+    #     response.content_type         # => "application/json; charset=utf-8"
+    #     response.parsed_body.class    # => ActiveSupport::HashWithIndifferentAccess
+    #     response.parsed_body          # => {"id"=>42, "title"=>"Title"}
+    #
+    #     assert_pattern { response.parsed_body => [{ title: /title/i }] }
+    #
+    #     response.parsed_body => {id:, title:}
+    #     assert_equal 42, id
+    #     assert_equal "Title", title
+    def parsed_body
+      @parsed_body ||= response_parser.call(body)
+    end
 
-    # Was there a server-side error?
-    alias_method :error?, :server_error?
+    def response_parser
+      @response_parser ||= RequestEncoder.parser(media_type)
+    end
   end
 end

data/lib/action_dispatch.rb

@@ -1,68 +1,89 @@
+# frozen_string_literal: true
+
 #--
-# Copyright (c) 2004-2014 David Heinemeier Hansson
+# Copyright (c) David Heinemeier Hansson
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
 #++
 
-require 'active_support'
-require 'active_support/rails'
-require 'active_support/core_ext/module/attribute_accessors'
+# :markup: markdown
+
+require "active_support"
+require "active_support/rails"
+require "active_support/core_ext/module/attribute_accessors"
 
-require 'action_pack'
-require 'rack'
+require "action_pack"
+require "rack"
+require "action_dispatch/deprecator"
 
-module Rack
-  autoload :Test, 'rack/test'
+module Rack # :nodoc:
+  autoload :Test, "rack/test"
 end
 
+# # Action Dispatch
+#
+# Action Dispatch is a module of Action Pack.
+#
+# Action Dispatch parses information about the web request, handles routing as
+# defined by the user, and does advanced processing related to HTTP such as
+# MIME-type negotiation, decoding parameters in POST, PATCH, or PUT bodies,
+# handling HTTP caching logic, cookies and sessions.
 module ActionDispatch
   extend ActiveSupport::Autoload
 
-  class IllegalStateError < StandardError
+  class MissingController < NameError
   end
 
   eager_autoload do
-    autoload_under 'http' do
+    autoload_under "http" do
+      autoload :ContentSecurityPolicy
+      autoload :PermissionsPolicy
       autoload :Request
       autoload :Response
     end
   end
 
-  autoload_under 'middleware' do
+  autoload_under "middleware" do
+    autoload :AssumeSSL
+    autoload :HostAuthorization
     autoload :RequestId
     autoload :Callbacks
     autoload :Cookies
+    autoload :ActionableExceptions
     autoload :DebugExceptions
+    autoload :DebugLocks
+    autoload :DebugView
     autoload :ExceptionWrapper
+    autoload :Executor
     autoload :Flash
-    autoload :ParamsParser
     autoload :PublicExceptions
     autoload :Reloader
     autoload :RemoteIp
+    autoload :ServerTiming
     autoload :ShowExceptions
     autoload :SSL
     autoload :Static
   end
 
+  autoload :Constants
   autoload :Journey
-  autoload :MiddlewareStack, 'action_dispatch/middleware/stack'
+  autoload :MiddlewareStack, "action_dispatch/middleware/stack"
   autoload :Routing
 
   module Http
@@ -72,34 +93,55 @@ module ActionDispatch
     autoload :Headers
     autoload :MimeNegotiation
     autoload :Parameters
-    autoload :ParameterFilter
-    autoload :Upload
-    autoload :UploadedFile, 'action_dispatch/http/upload'
+    autoload :UploadedFile, "action_dispatch/http/upload"
     autoload :URL
   end
 
   module Session
-    autoload :AbstractStore,     'action_dispatch/middleware/session/abstract_store'
-    autoload :CookieStore,       'action_dispatch/middleware/session/cookie_store'
-    autoload :MemCacheStore,     'action_dispatch/middleware/session/mem_cache_store'
-    autoload :CacheStore,        'action_dispatch/middleware/session/cache_store'
+    autoload :AbstractStore,       "action_dispatch/middleware/session/abstract_store"
+    autoload :AbstractSecureStore, "action_dispatch/middleware/session/abstract_store"
+    autoload :CookieStore,         "action_dispatch/middleware/session/cookie_store"
+    autoload :MemCacheStore,       "action_dispatch/middleware/session/mem_cache_store"
+    autoload :CacheStore,          "action_dispatch/middleware/session/cache_store"
+
+    def self.resolve_store(session_store) # :nodoc:
+      self.const_get(session_store.to_s.camelize)
+    rescue NameError
+      raise <<~ERROR
+        Unable to resolve session store #{session_store.inspect}.
+
+        #{session_store.inspect} resolves to ActionDispatch::Session::#{session_store.to_s.camelize},
+        but that class is undefined.
+
+        Is #{session_store.inspect} spelled correctly, and are any necessary gems installed?
+      ERROR
+    end
   end
 
   mattr_accessor :test_app
 
-  autoload_under 'testing' do
+  autoload_under "testing" do
     autoload :Assertions
     autoload :Integration
-    autoload :IntegrationTest, 'action_dispatch/testing/integration'
+    autoload :IntegrationTest, "action_dispatch/testing/integration"
     autoload :TestProcess
     autoload :TestRequest
     autoload :TestResponse
+    autoload :AssertionResponse
+  end
+
+  autoload :SystemTestCase, "action_dispatch/system_test_case"
+
+  def eager_load!
+    super
+    Routing.eager_load!
   end
 end
 
-autoload :Mime, 'action_dispatch/http/mime_type'
+autoload :Mime, "action_dispatch/http/mime_type"
 
 ActiveSupport.on_load(:action_view) do
   ActionView::Base.default_formats ||= Mime::SET.symbols
-  ActionView::Template::Types.delegate_to Mime
+  ActionView::Template.mime_types_implementation = Mime
+  ActionView::LookupContext::DetailsKey.clear
 end

data/lib/action_pack/gem_version.rb

@@ -1,14 +1,18 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
 module ActionPack
-  # Returns the version of the currently loaded Action Pack as a <tt>Gem::Version</tt>
+  # Returns the currently loaded version of Action Pack as a `Gem::Version`.
   def self.gem_version
     Gem::Version.new VERSION::STRING
   end
 
   module VERSION
-    MAJOR = 4
+    MAJOR = 7
     MINOR = 2
-    TINY  = 10
-    PRE   = nil
+    TINY  = 0
+    PRE   = "rc1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/action_pack/version.rb

@@ -1,7 +1,11 @@
-require_relative 'gem_version'
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require_relative "gem_version"
 
 module ActionPack
-  # Returns the version of the currently loaded ActionPack as a <tt>Gem::Version</tt>
+  # Returns the currently loaded version of Action Pack as a `Gem::Version`.
   def self.version
     gem_version
   end

data/lib/action_pack.rb

@@ -1,24 +1,27 @@
+# frozen_string_literal: true
+
 #--
-# Copyright (c) 2004-2014 David Heinemeier Hansson
+# Copyright (c) David Heinemeier Hansson
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
 #
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
 #++
 
-require 'action_pack/version'
+# :markup: markdown
+
+require "action_pack/version"