Class: ActiveStorage::Filename

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
app/models/active_storage/filename.rb

Overview

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.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filename) ⇒ Filename

Returns a new instance of Filename.



18
19
20
 
# File 'app/models/active_storage/filename.rb', line 18

def initialize(filename)
  @filename = filename
end

Class Method Details

.wrap(filename) ⇒ Object

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.



13
14
15
 
# File 'app/models/active_storage/filename.rb', line 13

def wrap(filename)
  filename.kind_of?(self) ? filename : new(filename)
end

Instance Method Details

#<=>(other) ⇒ Object 



76
77
78
 
# File 'app/models/active_storage/filename.rb', line 76

def <=>(other)
  to_s.downcase <=> other.to_s.downcase
end

#as_json ⇒ Object 



68
69
70
 
# File 'app/models/active_storage/filename.rb', line 68

def as_json(*)
  to_s
end

#base ⇒ Object

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"



27
28
29
 
# File 'app/models/active_storage/filename.rb', line 27

def base
  File.basename @filename, extension_with_delimiter
end

#extension_with_delimiter ⇒ Object

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  # => ""



37
38
39
 
# File 'app/models/active_storage/filename.rb', line 37

def extension_with_delimiter
  File.extname @filename
end

#extension_without_delimiter ⇒ Object Also known as: extension

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  # => ""



47
48
49
 
# File 'app/models/active_storage/filename.rb', line 47

def extension_without_delimiter
  extension_with_delimiter.from(1).to_s
end

#sanitized ⇒ Object

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.



59
60
61
 
# File '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

#to_json ⇒ Object 



72
73
74
 
# File 'app/models/active_storage/filename.rb', line 72

def to_json
  to_s
end

#to_s ⇒ Object

Returns the sanitized version of the filename.



64
65
66
 
# File 'app/models/active_storage/filename.rb', line 64

def to_s
  sanitized.to_s
end