класс ActiveStorage::Preview

Родитель:: Объект

Предварительный просмотр Active Storage

Некоторые объекты, не являющиеся изображениями, могут быть предварительно просмотрены: то есть они могут быть представлены как изображения. Объект видео может быть предварительно просмотрен путём извлечения его первого кадра, а объект PDF — путём извлечения его первой страницы.

Предварительный просмотр извлекает предварительное изображение из объекта. Active Storage предоставляет предварительные просмотры для видео и PDF-файлов. ActiveStorage::Previewer::VideoPreviewer используется для видео, а ActiveStorage::Previewer::PopplerPDFPreviewer и ActiveStorage::Previewer::MuPDFPreviewer — для PDF-файлов. Разработайте пользовательские предварительные просмотры, наследуя от ActiveStorage::Previewer и реализуя необходимые методы. Обратитесь к документации ActiveStorage::Previewer для получения более подробной информации о требованиях к предварительным просмотрам.

Для выбора предварительного просмотра для объекта Active Storage вызывает accept? для каждого зарегистрированного предварительного просмотра в порядке. Он использует первый предварительный просмотр, для которого accept? возвращает true при передаче объекта. В приложении Rails добавляйте или удаляйте предварительные просмотры, изменяя Rails.application.config.active_storage.previewers в файле инициализации:

Rails.application.config.active_storage.previewers
# => [ ActiveStorage::Previewer::PopplerPDFPreviewer, ActiveStorage::Previewer::MuPDFPreviewer, ActiveStorage::Previewer::VideoPreviewer ]

# Add a custom previewer for Microsoft Office documents:
Rails.application.config.active_storage.previewers << DOCXPreviewer
# => [ ActiveStorage::Previewer::PopplerPDFPreviewer, ActiveStorage::Previewer::MuPDFPreviewer, ActiveStorage::Previewer::VideoPreviewer, DOCXPreviewer ]

Вне приложения Rails измените ActiveStorage.previewers вместо этого.

Встроенные предварительные просмотры полагаются на сторонние библиотеки систем. В частности, встроенный предварительный просмотр видео требует FFmpeg. Предоставляются два предварительных просмотра PDF: один требует Poppler, а другой — muPDF (версия 1.8 или новее). Для предварительного просмотра PDF-файлов установите либо Poppler, либо muPDF.

Эти библиотеки не предоставляются приложением Rails. Вы должны установить их самостоятельно, чтобы использовать встроенные предварительные просмотры. Перед установкой и использованием стороннего программного обеспечения убедитесь, что вы понимаете последствия лицензирования.

Атрибуты

blob[R]

variation[R]

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

new(blob, variation_or_variation_key) Показать исходный код

# File activestorage/app/models/active_storage/preview.rb, line 38
def initialize(blob, variation_or_variation_key)
  @blob, @variation = blob, ActiveStorage::Variation.wrap(variation_or_variation_key)
end

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

download(&block) Показать исходный код

# File activestorage/app/models/active_storage/preview.rb, line 85
def download(&block)
  if processed?
    variant.download(&block)
  else
    raise UnprocessedError
  end
end

Загружает файл, связанный с вариантом этого предварительного просмотра. Если блок не задан, весь файл считывается в память и возвращается. Это потребует много оперативной памяти для очень больших файлов. Если блок задан, загрузка ведётся по потокам и выдаётся частями. Выбрасывает исключение ActiveStorage::Preview::UnprocessedError, если предварительный просмотр ещё не обработан.

image() Показать исходный код

# File activestorage/app/models/active_storage/preview.rb, line 54
def image
  blob.preview_image
end

Возвращает прикреплённое предварительное изображение объекта.

key() Показать исходный код

# File activestorage/app/models/active_storage/preview.rb, line 72
def key
  if processed?
    variant.key
  else
    raise UnprocessedError
  end
end

Возвращает комбинированный ключ объекта и варианта, которые вместе идентифицируют конкретный вариант.

processed() Показать исходный код

# File activestorage/app/models/active_storage/preview.rb, line 48
def processed
  process unless processed?
  self
end

Обрабатывает предварительный просмотр, если он ещё не обработан. Возвращает экземпляр Preview для удобства:

blob.preview(resize_to_limit: [100, 100]).processed.url

Обработка предварительного просмотра создаёт изображение из объекта и прикрепляет предварительное изображение к объекту. Поскольку предварительное изображение хранится с объектом, оно генерируется только один раз.

url(**options) Показать исходный код

# File activestorage/app/models/active_storage/preview.rb, line 63
def url(**options)
  if processed?
    variant.url(**options)
  else
    raise UnprocessedError
  end
end

Возвращает URL-адрес варианта предварительного просмотра на сервере. Выбрасывает исключение ActiveStorage::Preview::UnprocessedError, если предварительный просмотр ещё не обработан.

Этот метод синхронно обрабатывает вариант изображения предварительного просмотра, поэтому не вызывайте его в представлениях. Вместо этого сгенерируйте стабильный URL-адрес, который перенаправляет на URL-адрес, возвращаемый этим методом.