модуль ActiveStorage::Attached::Model

Предоставляет DSL-интерфейс на уровне класса для объявления прикрепленных файлов модели Active Record.

Открытые методы экземпляра

has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false) Показать исходный код

# File activestorage/lib/active_storage/attached/model.rb, line 128
      def has_many_attached(name, dependent: :purge_later, service: nil, strict_loading: false)
        validate_service_configuration(name, service)

        generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1
          # frozen_string_literal: true
          def #{name}
            @active_storage_attached ||= {}
            @active_storage_attached[:#{name}] ||= ActiveStorage::Attached::Many.new("#{name}", self)
          end

          def #{name}=(attachables)
            if ActiveStorage.replace_on_assign_to_many
              attachment_changes["#{name}"] =
                if Array(attachables).none?
                  ActiveStorage::Attached::Changes::DeleteMany.new("#{name}", self)
                else
                  ActiveStorage::Attached::Changes::CreateMany.new("#{name}", self, attachables)
                end
            else
              if Array(attachables).any?
                attachment_changes["#{name}"] =
                  ActiveStorage::Attached::Changes::CreateMany.new("#{name}", self, #{name}.blobs + attachables)
              end
            end
          end
        CODE

        has_many :"#{name}_attachments", -> { where(name: name) }, as: :record, class_name: "ActiveStorage::Attachment", inverse_of: :record, dependent: :destroy, strict_loading: strict_loading do
          def purge
            each(&:purge)
            reset
          end

          def purge_later
            each(&:purge_later)
            reset
          end
        end
        has_many :"#{name}_blobs", through: :"#{name}_attachments", class_name: "ActiveStorage::Blob", source: :blob, strict_loading: strict_loading

        scope :"with_attached_#{name}", -> { includes("#{name}_attachments": :blob) }

        after_save { attachment_changes[name.to_s]&.save }

        after_commit(on: %i[ create update ]) { attachment_changes.delete(name.to_s).try(:upload) }

        reflection = ActiveRecord::Reflection.create(
          :has_many_attached,
          name,
          nil,
          { dependent: dependent, service_name: service },
          self
        )
        ActiveRecord::Reflection.add_attachment_reflection(self, name, reflection)
      end

Определяет отношение между несколькими прикрепленными файлами и моделью.

class Gallery < ApplicationRecord
  has_many_attached :photos
end

В модели нет определенных столбцов; Active Storage позаботится о сопоставлении ваших записей и прикрепленных файлов.

Чтобы избежать запросов N+1, вы можете включить прикрепленные файлы в свой запрос следующим образом:

Gallery.where(user: Current.user).with_attached_photos

Под капотом это отношение реализовано как has_many отношение к записи ActiveStorage::Attachment и has_many-through отношение к записи ActiveStorage::Blob. Эти отношения доступны как photos_attachments и photos_blobs. Однако в большинстве случаев вам не нужно работать с этими отношениями напрямую.

Система разработана таким образом, чтобы вы работали через прокси ActiveStorage::Attached::Many, который предоставляет динамический прокси для отношений и методов фабрики, таких как #attach.

Если опция :dependent не установлена, все прикреплённые файлы будут удалены (т. е. уничтожены) при уничтожении записи.

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

class Gallery < ActiveRecord::Base
  has_many_attached :photos, service: :s3
end

Если вам нужно включить strict_loading, чтобы предотвратить ленивую загрузку прикреплённых файлов, передайте опцию :strict_loading. Вы можете сделать так:

class Gallery < ApplicationRecord
  has_many_attached :photos, strict_loading: true
end

has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false) Показать исходный код

# File activestorage/lib/active_storage/attached/model.rb, line 50
      def has_one_attached(name, dependent: :purge_later, service: nil, strict_loading: false)
        validate_service_configuration(name, service)

        generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1
          # frozen_string_literal: true
          def #{name}
            @active_storage_attached ||= {}
            @active_storage_attached[:#{name}] ||= ActiveStorage::Attached::One.new("#{name}", self)
          end

          def #{name}=(attachable)
            attachment_changes["#{name}"] =
              if attachable.nil?
                ActiveStorage::Attached::Changes::DeleteOne.new("#{name}", self)
              else
                ActiveStorage::Attached::Changes::CreateOne.new("#{name}", self, attachable)
              end
          end
        CODE

        has_one :"#{name}_attachment", -> { where(name: name) }, class_name: "ActiveStorage::Attachment", as: :record, inverse_of: :record, dependent: :destroy, strict_loading: strict_loading
        has_one :"#{name}_blob", through: :"#{name}_attachment", class_name: "ActiveStorage::Blob", source: :blob, strict_loading: strict_loading

        scope :"with_attached_#{name}", -> { includes("#{name}_attachment": :blob) }

        after_save { attachment_changes[name.to_s]&.save }

        after_commit(on: %i[ create update ]) { attachment_changes.delete(name.to_s).try(:upload) }

        reflection = ActiveRecord::Reflection.create(
          :has_one_attached,
          name,
          nil,
          { dependent: dependent, service_name: service },
          self
        )
        ActiveRecord::Reflection.add_attachment_reflection(self, name, reflection)
      end

Определяет отношение между одним прикреплённым файлом и моделью.

class User < ApplicationRecord
  has_one_attached :avatar
end

В модели нет определенного столбца; Active Storage позаботится о сопоставлении ваших записей и прикреплённого файла.

Чтобы избежать запросов N+1, вы можете включить прикрепленный файл в свой запрос следующим образом:

User.with_attached_avatar

Под капотом это отношение реализовано как has_one отношение к записи ActiveStorage::Attachment и has_one-through отношение к записи ActiveStorage::Blob. Эти отношения доступны как avatar_attachment и avatar_blob. Но в большинстве случаев вам не нужно работать с этими отношениями напрямую.

Система разработана так, чтобы вы работали через прокси ActiveStorage::Attached::One, который предоставляет динамический прокси для отношений и методов фабрики, таких как attach.

Если опция :dependent не установлена, прикреплённый файл будет удалён (т. е. уничтожен) при уничтожении записи.

class User < ActiveRecord::Base
  has_one_attached :avatar, service: :s3
end

Если вам нужно включить strict_loading, чтобы предотвратить ленивую загрузку прикрепленного файла, передайте опцию :strict_loading. Вы можете сделать так:

class User < ApplicationRecord
  has_one_attached :avatar, strict_loading: true
end

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

# File activestorage/lib/active_storage/attached/model.rb, line 156
def purge
  each(&:purge)
  reset
end

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

# File activestorage/lib/active_storage/attached/model.rb, line 161
def purge_later
  each(&:purge_later)
  reset
end

validate_service_configuration(association_name, service) Показать исходный код

# File activestorage/lib/active_storage/attached/model.rb, line 185
def validate_service_configuration(association_name, service)
  if service.present?
    ActiveStorage::Blob.services.fetch(service) do
      raise ArgumentError, "Cannot configure service :#{service} for #{name}##{association_name}"
    end
  end
end