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

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

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

# File activestorage/lib/active_storage/attached/model.rb, line 178
          def deprecate(action)
            reflection_name = proxy_association.reflection.name
            attached_name = reflection_name.to_s.partition("_").first
            ActiveSupport::Deprecation.warn(<<-MSG.squish)
              Calling `#{action}` from `#{reflection_name}` is deprecated and will be removed in Rails 7.1.
              To migrate to Rails 7.1's behavior call `#{action}` from `#{attached_name}` instead: `#{attached_name}.#{action}`.
            MSG
          end

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

# File activestorage/lib/active_storage/attached/model.rb, line 129
      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)
            attachables = Array(attachables).compact_blank

            if ActiveStorage.replace_on_assign_to_many
              attachment_changes["#{name}"] =
                if attachables.none?
                  ActiveStorage::Attached::Changes::DeleteMany.new("#{name}", self)
                else
                  ActiveStorage::Attached::Changes::CreateMany.new("#{name}", self, attachables)
                end
            else
              ActiveSupport::Deprecation.warn \
                "config.active_storage.replace_on_assign_to_many is deprecated and will be removed in Rails 7.1. " \
                "Make sure that your code works well with config.active_storage.replace_on_assign_to_many set to true before upgrading. " \
                "To append new attachables to the Active Storage association, prefer using `attach`. " \
                "Using association setter would result in purging the existing attached attachments and replacing them with new ones."

              if 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
            deprecate(:purge)
            each(&:purge)
            reset
          end

          def purge_later
            deprecate(:purge_later)
            each(&:purge_later)
            reset
          end

          private
          def deprecate(action)
            reflection_name = proxy_association.reflection.name
            attached_name = reflection_name.to_s.partition("_").first
            ActiveSupport::Deprecation.warn(<<-MSG.squish)
              Calling `#{action}` from `#{reflection_name}` is deprecated and will be removed in Rails 7.1.
              To migrate to Rails 7.1's behavior call `#{action}` from `#{attached_name}` instead: `#{attached_name}.#{action}`.
            MSG
          end
        end
        has_many :"#{name}_blobs", through: :"#{name}_attachments", class_name: "ActiveStorage::Blob", source: :blob, strict_loading: strict_loading

        scope :"with_attached_#{name}", -> {
          if ActiveStorage.track_variants
            includes("#{name}_attachments": { blob: :variant_records })
          else
            includes("#{name}_attachments": :blob)
          end
        }

        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
        )
        yield reflection if block_given?
        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) { |reflection| ... } Показать исходный код

# 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
        )
        yield reflection if block_given?
        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 165
def purge
  deprecate(:purge)
  each(&:purge)
  reset
end

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

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

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

# File activestorage/lib/active_storage/attached/model.rb, line 213
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