Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Add implicit to path conversion to uploaded file #28676
Ruby has a few implicit conversion protocols (e.g.
a_file_path = 'some/path/file.ext' File.write a_file_path, 'String Path Content' File.read a_file_path # => "String Path Content" a_pathname = Pathname(a_file_path) File.write a_pathname, 'Pathname Content' File.read a_pathname # => "Pathname Content" core_file = File.new(a_pathname) File.write core_file, 'File Content' File.read core_file # => "File Content" tmp_file = Tempfile.new('example') File.write tmp_file, 'Tempfile Content' File.read tmp_file # => "Tempfile Content"
So how does an uploaded file work in such cases?
tmp_file = Tempfile.new('example') File.write tmp_file, 'Uploaded Content' uploaded_file = ActionDispatch::Http::UploadedFile.new(tempfile: tmp_file) File.read uploaded_file # => TypeError: no implicit conversion of ActionDispatch::Http::UploadedFile into String
It fails with a
In order to make an uploaded file work it must be explicitly converted to a file path using
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
Since an uploaded file already has a path it makes sense to implement the implicit "path" conversion protocol (just like
For the example above would now read the file content:
tmp_file = Tempfile.new('example') File.write tmp_file, 'Uploaded Content' uploaded_file = ActionDispatch::Http::UploadedFile.new(tempfile: tmp_file) File.read uploaded_file # => "Uploaded Content"
Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @rafaelfranca (or someone else) soon.
If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.
This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.
Please see the contribution instructions for more information.
Still reproducible in
6.0.0.alpha. While its worth noting that
ActionDispatch::Http::UploadedFile all have a
#read method, I agree that
File.read should also work with
ActionDispatch::Http::UploadedFile objects to stay consistent.