123456789_123456789_123456789_123456789_123456789_

Class: ActiveStorage::FixtureSet

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, ::ActiveRecord::SecureToken, ::ActiveSupport::Testing::FileFixtures
Inherits: Object
Defined in: activestorage/lib/active_storage/fixture_set.rb

Overview

Fixtures are a way of organizing data that you want to test against; in short, sample data.

To learn more about fixtures, read the ::ActiveRecord::FixtureSet documentation.

YAML

Like other Active Record-backed models, ActiveStorage::Attachment and ActiveStorage::Blob records inherit from ::ActiveRecord::Base instances and therefore can be populated by fixtures.

Consider a hypothetical Article model class, its related fixture data, as well as fixture data for related ActiveStorage::Attachment and ActiveStorage::Blob records:

# app/models/article.rb
class Article < ApplicationRecord
  has_one_attached :thumbnail
end

# fixtures/active_storage/blobs.yml
first_thumbnail_blob: <%= ActiveStorage::FixtureSet.blob filename: "first.png" %>

# fixtures/active_storage/attachments.yml
first_thumbnail_attachment:
  name: thumbnail
  record: first (Article)
  blob: first_thumbnail_blob

When processed, Active Record will insert database records for each fixture entry and will ensure the Active Storage relationship is intact.

Constant Summary

::ActiveRecord::SecureToken - Included

MINIMUM_TOKEN_LENGTH

::ActiveSupport::Testing::FileFixtures - Attributes & Methods

Class Method Summary

  • .blob(filename:, **attributes)

    Generate a YAML-encoded representation of an ActiveStorage::Blob instance’s attributes, resolve the file relative to the directory mentioned by ActiveSupport::Testing::FileFixtures.file_fixture, and upload the file to the Service.

Instance Method Summary

::ActiveSupport::Testing::FileFixtures - Included

#file_fixture

Returns a ::Pathname to the fixture file named fixture_name.

Class Attribute Details

.file_fixture_path (rw)

[ GitHub ] 

  


# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20



class_attribute :file_fixture_path, instance_writer: false


  








  

    .file_fixture_path?  ⇒ Boolean  (rw)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20



class_attribute :file_fixture_path, instance_writer: false


  







Class Method Details



  

    .blob(filename:, **attributes)  
  



  

    

Generate a YAML-encoded representation of an ActiveStorage::Blob instance’s attributes, resolve the file relative to the directory mentioned by ActiveSupport::Testing::FileFixtures.file_fixture, and upload the file to the Service



Examples



# tests/fixtures/active_storage/blobs.yml
second_thumbnail_blob: <%= ActiveStorage::FixtureSet.blob(
  filename: "second.svg",
) %>

third_thumbnail_blob: <%= ActiveStorage::FixtureSet.blob(
  filename: "third.svg",
  content_type: "image/svg+xml",
  service_name: "public"
) %>


  



  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/fixture_set.rb', line 66



def self.blob(filename:, **attributes)
  new.prepare Blob.new(filename: filename, key: generate_unique_secure_token), **attributes
end


  







Instance Attribute Details



  

    #file_fixture_path   (readonly)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20



class_attribute :file_fixture_path, instance_writer: false


  








  

    #file_fixture_path?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20



class_attribute :file_fixture_path, instance_writer: false


  







Instance Method Details



  

    #prepare(instance, **attributes)  
  

  [ GitHub ]


  

  


# File 'activestorage/lib/active_storage/fixture_set.rb', line 70



def prepare(instance, **attributes)
  io = file_fixture(instance.filename.to_s).open
  instance.unfurl(io)
  instance.assign_attributes(attributes)
  instance.upload_without_unfurling(io)

  instance.attributes.transform_values { |value| value.is_a?(Hash) ? value.to_json : value }.compact.to_json
end