mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
20543c0496
* Add implicit to path conversion to uploaded file
Ruby has a few implicit conversion protocols (e.g. `to_hash`, `to_str`,
`to_path`, etc.). These are considered implicit conversion protocols
because in certain instances Ruby (MRI core objects) will check if an
argument responds to the appropriate protocol and automatically convert
it when it does; this is why you can provide a `Pathname` instance into
`File.read` without having to explicitly call `to_s`.
```ruby
a_file_path = 'some/path/file.ext'
File.write a_file_path, 'String Path Content'
File.read a_file_path
a_pathname = Pathname(a_file_path)
File.write core_file, 'Pathname Content'
File.read a_file_path
core_file = File.new(a_pathname)
File.write core_file, 'File Content'
File.read core_file
tmp_file = Tempfile.new('example')
File.write tmp_file, 'Tempfile Content'
File.read tmp_file
```
So how does an uploaded file work in such cases?
```ruby
tmp_file = Tempfile.new('example')
File.write tmp_file, 'Uploaded Content'
uploaded_file = ActionDispatch::Http::UploadedFile.new(tempfile: tmp_file)
File.read uploaded_file
```
It fails with a `TypeError`:
no implicit conversion of ActionDispatch::Http::UploadedFile into String
In order to make an uploaded file work it must be explicitly converted
to a file path using `path`.
```ruby
File.read uploaded_file.path
```
This requires any code that expects path/file like objects to either
special case an uploaded file, re-implement the path conversion protocol
to use `path`, or forces the developer to explicitly cast uploaded files
to paths. This last option can sometimes be difficult to do when such
calls are deep within the inner workings of libraries.
Since an uploaded file already has a path it makes sense to implement
the implicit "path" conversion protocol (just like `File` and
`Tempfile`). This change allows uploaded file content to be treated more
closely to regular file content, without requiring any special case
handling or explicit conversion for common file utilities.
* Note uploaded file path delegation in CHANGELOG
89 lines
2.2 KiB
Ruby
89 lines
2.2 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module ActionDispatch
|
|
module Http
|
|
# Models uploaded files.
|
|
#
|
|
# The actual file is accessible via the +tempfile+ accessor, though some
|
|
# of its interface is available directly for convenience.
|
|
#
|
|
# Uploaded files are temporary files whose lifespan is one request. When
|
|
# the object is finalized Ruby unlinks the file, so there is no need to
|
|
# clean them with a separate maintenance task.
|
|
class UploadedFile
|
|
# The basename of the file in the client.
|
|
attr_accessor :original_filename
|
|
|
|
# A string with the MIME type of the file.
|
|
attr_accessor :content_type
|
|
|
|
# A +Tempfile+ object with the actual uploaded file. Note that some of
|
|
# its interface is available directly.
|
|
attr_accessor :tempfile
|
|
alias :to_io :tempfile
|
|
|
|
# A string with the headers of the multipart request.
|
|
attr_accessor :headers
|
|
|
|
def initialize(hash) # :nodoc:
|
|
@tempfile = hash[:tempfile]
|
|
raise(ArgumentError, ":tempfile is required") unless @tempfile
|
|
|
|
if hash[:filename]
|
|
@original_filename = hash[:filename].dup
|
|
|
|
begin
|
|
@original_filename.encode!(Encoding::UTF_8)
|
|
rescue EncodingError
|
|
@original_filename.force_encoding(Encoding::UTF_8)
|
|
end
|
|
else
|
|
@original_filename = nil
|
|
end
|
|
|
|
@content_type = hash[:type]
|
|
@headers = hash[:head]
|
|
end
|
|
|
|
# Shortcut for +tempfile.read+.
|
|
def read(length = nil, buffer = nil)
|
|
@tempfile.read(length, buffer)
|
|
end
|
|
|
|
# Shortcut for +tempfile.open+.
|
|
def open
|
|
@tempfile.open
|
|
end
|
|
|
|
# Shortcut for +tempfile.close+.
|
|
def close(unlink_now = false)
|
|
@tempfile.close(unlink_now)
|
|
end
|
|
|
|
# Shortcut for +tempfile.path+.
|
|
def path
|
|
@tempfile.path
|
|
end
|
|
|
|
# Shortcut for +tempfile.to_path+.
|
|
def to_path
|
|
@tempfile.to_path
|
|
end
|
|
|
|
# Shortcut for +tempfile.rewind+.
|
|
def rewind
|
|
@tempfile.rewind
|
|
end
|
|
|
|
# Shortcut for +tempfile.size+.
|
|
def size
|
|
@tempfile.size
|
|
end
|
|
|
|
# Shortcut for +tempfile.eof?+.
|
|
def eof?
|
|
@tempfile.eof?
|
|
end
|
|
end
|
|
end
|
|
end
|