1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
rails--rails/actionpack/lib/action_dispatch/testing/test_process.rb
Vitalii Khustochka 1ab0e6b6d8
Update fixture_file_upload documentation to reflect recent changes. (#39340)
* Update `fixture_file_upload` documentation to reflect recent changes. [ci skip]

* Friendlier deprecation message for `fixture_file_upload`.

Suggested change now can be copied and pasted into the code without modification.
2020-05-18 23:14:33 +02:00

75 lines
2.6 KiB
Ruby

# frozen_string_literal: true
require "action_dispatch/middleware/cookies"
require "action_dispatch/middleware/flash"
module ActionDispatch
module TestProcess
module FixtureFile
# Shortcut for <tt>Rack::Test::UploadedFile.new(File.join(ActionDispatch::IntegrationTest.file_fixture_path, path), type)</tt>:
#
# post :change_avatar, params: { avatar: fixture_file_upload('spongebob.png', 'image/png') }
#
# Default fixture files location is <tt>test/fixtures/files</tt>.
#
# To upload binary files on Windows, pass <tt>:binary</tt> as the last parameter.
# This will not affect other platforms:
#
# post :change_avatar, params: { avatar: fixture_file_upload('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 &&
!File.exist?(path)
original_path = path
path = Pathname.new(self.class.fixture_path).join(path)
if !self.class.file_fixture_path
ActiveSupport::Deprecation.warn(<<~EOM)
Passing a path to `fixture_file_upload` relative to `fixture_path` is deprecated.
In Rails 6.2, the path needs to be relative to `file_fixture_path` which you
haven't set yet. Set `file_fixture_path` to discard this warning.
EOM
elsif path.exist?
non_deprecated_path = path.relative_path_from(Pathname(self.class.file_fixture_path))
ActiveSupport::Deprecation.warn(<<~EOM)
Passing a path to `fixture_file_upload` relative to `fixture_path` is deprecated.
In Rails 6.2, the path needs to be relative to `file_fixture_path`.
Please modify the call from
`fixture_file_upload("#{original_path}")` to `fixture_file_upload("#{non_deprecated_path}")`.
EOM
else
path = file_fixture(original_path)
end
elsif self.class.file_fixture_path && !File.exist?(path)
path = file_fixture(path)
end
Rack::Test::UploadedFile.new(path, mime_type, binary)
end
end
include FixtureFile
def assigns(key = nil)
raise NoMethodError,
"assigns has been extracted to a gem. To continue using it,
add `gem 'rails-controller-testing'` to your Gemfile."
end
def session
@request.session
end
def flash
@request.flash
end
def cookies
@cookie_jar ||= Cookies::CookieJar.build(@request, @request.cookies)
end
def redirect_to_url
@response.redirect_url
end
end
end