Spec-Zone.ru › Ruby on Rails 7.2

class ActiveStorage::Filename

Parent:
Объект
Included modules:

Active Storage Имя файла

Инкапсулирует строку, представляющую имя файла, для удобного доступа к его частям и санитизации. Экземпляр Filename возвращается методом ActiveStorage::Blob#filename, и является сравнимым, поэтому может использоваться для сортировки.

Публичные методы класса

new(filename) Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 18
def initialize(filename)
  @filename = filename
end
wrap(filename) Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 13
def wrap(filename)
  filename.kind_of?(self) ? filename : new(filename)
end

Возвращает экземпляр Filename на основе заданного имени файла. Если имя файла является Filename, оно возвращается без изменений. Если это String, оно передаётся в метод ActiveStorage::Filename.new.

Публичные методы экземпляра

<=>(other) Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 72
def <=>(other)
  to_s.downcase <=> other.to_s.downcase
end
as_json(*) Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 68
def as_json(*)
  to_s
end
base() Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 27
def base
  File.basename @filename, extension_with_delimiter
end

Возвращает часть имени файла, предшествующую расширению.

ActiveStorage::Filename.new("racecar.jpg").base # => "racecar"
ActiveStorage::Filename.new("racecar").base     # => "racecar"
ActiveStorage::Filename.new(".gitignore").base  # => ".gitignore"
extension()
Псевдоним для: extension_without_delimiter
extension_with_delimiter() Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 37
def extension_with_delimiter
  File.extname @filename
end

Возвращает расширение имени файла (т.е. подстроку, следующую за последней точкой, без точки в начале) вместе с предшествующей точкой. Если расширение отсутствует, возвращается пустая строка.

ActiveStorage::Filename.new("racecar.jpg").extension_with_delimiter # => ".jpg"
ActiveStorage::Filename.new("racecar").extension_with_delimiter     # => ""
ActiveStorage::Filename.new(".gitignore").extension_with_delimiter  # => ""
extension_without_delimiter() Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 47
def extension_without_delimiter
  extension_with_delimiter.from(1).to_s
end

Возвращает расширение имени файла (т.е. подстроку, следующую за последней точкой, без точки в начале). Если расширение отсутствует, возвращается пустая строка.

ActiveStorage::Filename.new("racecar.jpg").extension_without_delimiter # => "jpg"
ActiveStorage::Filename.new("racecar").extension_without_delimiter     # => ""
ActiveStorage::Filename.new(".gitignore").extension_without_delimiter  # => ""
Также псевдоним для: extension
sanitized() Показать исходный код
# 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

Возвращает очищенное имя файла.

ActiveStorage::Filename.new("foo:bar.jpg").sanitized # => "foo-bar.jpg"
ActiveStorage::Filename.new("foo/bar.jpg").sanitized # => "foo-bar.jpg"

Символы, считающиеся небезопасными для хранения (например, ,, $, и символ перевода вправо), заменяются дефисом.

to_s() Показать исходный код
# File activestorage/app/models/active_storage/filename.rb, line 64
def to_s
  sanitized.to_s
end

Возвращает очищенную версию имени файла.

© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API