Active Storage Filename
Encapsulates a string representing a filename to provide convenient access to parts of it and sanitization. A Filename
instance is returned by ActiveStorage::Blob#filename
, and is comparable so it can be used for sorting.
Methods
- <=>
- as_json
- base
- extension
- extension_with_delimiter
- extension_without_delimiter
- new
- sanitized
- to_s
- wrap
Included Modules
- Comparable
Class Public methods
new(filename)
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 18
def initialize(filename)
@filename = filename
end
🔎 See on GitHub
wrap(filename)
Returns a Filename
instance based on the given filename. If the filename is a Filename
, it is returned unmodified. If it is a String
, it is passed to ActiveStorage::Filename.new
.
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 13
def wrap(filename)
filename.kind_of?(self) ? filename : new(filename)
end
🔎 See on GitHub
Instance Public methods
<=>(other)
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 72
def <=>(other)
to_s.downcase <=> other.to_s.downcase
end
🔎 See on GitHub
as_json(*)
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 68
def as_json(*)
to_s
end
🔎 See on GitHub
base()
Returns the part of the filename preceding any extension.
ActiveStorage::Filename.new("racecar.jpg").base # => "racecar"
ActiveStorage::Filename.new("racecar").base # => "racecar"
ActiveStorage::Filename.new(".gitignore").base # => ".gitignore"
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 27
def base
File.basename @filename, extension_with_delimiter
end
🔎 See on GitHub
extension_with_delimiter()
Returns the extension of the filename (i.e. the substring following the last dot, excluding a dot at the beginning) with the dot that precedes it. If the filename has no extension, an empty string is returned.
ActiveStorage::Filename.new("racecar.jpg").extension_with_delimiter # => ".jpg"
ActiveStorage::Filename.new("racecar").extension_with_delimiter # => ""
ActiveStorage::Filename.new(".gitignore").extension_with_delimiter # => ""
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 37
def extension_with_delimiter
File.extname @filename
end
🔎 See on GitHub
extension_without_delimiter()
Returns the extension of the filename (i.e. the substring following the last dot, excluding a dot at the beginning). If the filename has no extension, an empty string is returned.
ActiveStorage::Filename.new("racecar.jpg").extension_without_delimiter # => "jpg"
ActiveStorage::Filename.new("racecar").extension_without_delimiter # => ""
ActiveStorage::Filename.new(".gitignore").extension_without_delimiter # => ""
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 47
def extension_without_delimiter
extension_with_delimiter.from(1).to_s
end
🔎 See on GitHub
sanitized()
Returns the sanitized filename.
ActiveStorage::Filename.new("foo:bar.jpg").sanitized # => "foo-bar.jpg"
ActiveStorage::Filename.new("foo/bar.jpg").sanitized # => "foo-bar.jpg"
Characters considered unsafe for storage (e.g. , $, and the RTL override character) are replaced with a dash.
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 59
def sanitized
@filename.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "�").strip.tr("\u{202E}%$|:;/\t\r\n\\", "-")
end
🔎 See on GitHub
to_s()
Returns the sanitized version of the filename.
📝 Source code
# File activestorage/app/models/active_storage/filename.rb, line 64
def to_s
sanitized.to_s
end
🔎 See on GitHub