fixture_farm 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 728eb6b44d1deb4df01e4bc03795758f3846e169f6dc07f0f5c7a6a799881976
-  data.tar.gz: 59fe50410c6fd317537dd653001f8bd8e7b571b2375faa97d95e6dc41e188e76
+  metadata.gz: af9b30c58737a261963da35795445aadfcb38efe2f3ed6d4fc8055f19399b0df
+  data.tar.gz: 865e73ba12d379aba2b3f48a160ce421efe7d49a958db72f19b185d4d1045175
 SHA512:
-  metadata.gz: cd4e4c6609afbe0a09413cf19d71eec01b9366f4e2d793190b8cb9b7aa86eecded615cbeae5daf31036cd3ca6a4bfea42c3bc568236aa9c4c3357b9e81157052
-  data.tar.gz: 2210cb7393ce70c90d3e0225ba28f9b87ee2f4b6d1d106ce029e352b475b6c1c3eed78c1af4bd15e864330101f0059a06ec2f5c65415faf1228a44e03bcf8693
+  metadata.gz: 9c1950bc97570624b27f2f928ec82586816429e1f7a34378f5336c83d8d420180ad65093677744a4b6efa8e3cbc2b7a298631837dbb9ffc32d0c11941d372596
+  data.tar.gz: 455b1430edd5fb21874e7cd906688ea55ea3e1753c0e02b13b2bcd051f2e68f17d02174f6b770cac9b15f212cef0923b52c3584f40f7b1d662957cff1a4c0cc3

data/README.md

@@ -9,6 +9,7 @@ A few things to note:
 - generated fixture that `belongs_to` a record from an existing fixture, will reference that fixture by name.
 - models, destroyed during recording, will be removed from fixtures (if they were originally there).
 - generated `ActiveStorage::Blob` fixtures file names, will be the same as fixture names (so they can be generated multiple times, without generating new file each time).
+- AR models gain `#fixture_name` method
 
 ### Limitations
 
@@ -61,82 +62,85 @@ bundle exec fixture_farm stop
 
 ### Record in tests
 
-To record in tests, wrap some code in `record_new_fixtures` block. For example:
+To record in tests, wrap some code in `record_fixtures` block. For example:
 
 ```ruby
 
 include FixtureFarm::TestHelper
 
-test 'some stuff does the right thing' do
-  record_new_fixtures do |recorder|
-    user = User.create!(name: 'Bob')
-    post = user.posts.create!(title: 'Stuff')
+test 'parents fixtures have children' do
+  offending_records = Parent.where.missing(:children)
 
-    recorder.stop!
-
-    assert_difference 'user.published_posts.size' do
-      post.publish!
+  if ENV['GENERATE_FIXTURES']
+    record_fixtures do
+      offending_records.each do |parent|
+        parent.children.create!(name: 'Bob')
+      end
     end
+  else
+    assert_empty offending_records.map(&:fixture_name),
+      "The following parents don't have children:"
   end
 end
 ```
 
-Running this test generates user and post fixtures. Now you can rewrite this test to use them:
-
-```ruby
-test 'some stuff does the right thing' do
-  user = users('user_1')
+Assuming there was a parent fixture `dave` that didn't have any children, this test will fail. Now, running the same test with `GENERATE_FIXTURES=1` will generate one child fixture named `dave_child_1`. The test is now passing.
 
-  assert_difference 'user.published_posts.size' do
-    user.posts.first.publish!
-  end
-end
-```
+`record_fixtures` accepts optional name prefix, that applies to all new fixture names.
 
-`record_new_fixtures` accepts optional name prefix, that applies to all new fixture names.
+### Automatic fixture naming
 
-A more robust approach is to have dedicated fixture tests that normally fail, but can be optionally run in "record mode" (think VCR).
+Generated fixture names are based on the first `belongs_to` association of the model. E.g., if a new post fixtures belongs_to to a user fixture `bob`, the name is going to be `bob_post_1`.
 
-For example, let's say we have `Author` model that `has_many :posts` and we require authors to have at least one post. Here's the test to enforce `authors` fixtures to comply with this rule:
+It's possible to lower the priority of given parent assiciations when it comes to naming, so that certain names are only picked when there are no other suitable parent associations. This is useful, for example, to exclude `acts_as_tenant` association:
 
 ```ruby
-test 'authors fixtures must have at least one post' do
-  offending_records = Author.where.missing(:posts)
-
-  assert_empty offending_records
-end
+FixtureFarm.low_priority_parent_model_for_naming = -> { _1.is_a?(TenantModel) }
 ```
 
-Let's say this test is currently failing.
+### Attachment fixtures
 
-Now let's add the option to automatically record missing fixtures:
+Rather than [manually crafting attachment fixtures](https://guides.rubyonrails.org/v8.0/active_storage_overview.html#adding-attachments-to-fixtures), we can get the gem do the leg work. Not only is this less boring, but it's also going to generate variant fixtures.
 
-```ruby
-test 'authors fixtures must have at least one post' do
-  offending_records = Author.where.missing(:posts)
+I'd also go as far as suggesting that attachment files for generated blobs should be checked into git just as the fixtures themselves are. To share them with the development environment (e.g. `rails db:fixtures:load`), let's store test attachment files in the same `./storage` directory used in development:
 
-  if ENV['RECORD_FIXTURES']
-    record_new_fixtures do
-      offending_records.each do |author|
-        author.posts.create!(text: 'some text')
-      end
-    end
-  end
-
-  assert_empty offending_records
-end
+```ruby
+# config/environments/test.rb
+config.active_storage.service = :local
 ```
 
-Running this test with `RECORD_FIXTURES=1` will generate missing fixture entries in `test/fixtures/posts.yml`. Now re-run the test again and it's passing.
+Now this test will not only generate attachments and variant fixtures, but also `git add` new attachment files. The old removed ones will show up in `git status`.
 
-### Automatic fixture naming
-
-Generated fixture names are based on the first `belongs_to` association of the model. E.g., if a new post fixtures belongs_to to a user fixture `bob`, the name is going to be `bob_post_1`.
+```ruby
+test "product fixtures have images" do
+  offending_records = Product.where.missing(:images_attachments)
+
+  if ENV["GENERATE_FIXTURES"]
+    # Makes generation idempotent
+    `git restore --staged storage`
+
+    record_fixtures do |recorder|
+      ActiveStorage::Attachment.where(record_type: 'Product').destroy_all
+
+      Product.find_each do |product|
+        product.images.attach(
+          io: File.open(file_fixture("products/#{product.fixture_name}.jpg")),
+          filename: "#{product.fixture_name}.jpg",
+          content_type: "image/jpeg"
+        )
+        # This generates variants
+        perform_enqueued_jobs
+      end
 
-It's possible to lower the priority of given parent assiciations when it comes to naming, so that certain names are only picked when there are no other suitable parent associations. This is useful, for example, to exclude `acts_as_tenant` association:
+      recorder.stop!
 
-```ruby
-FixtureFarm.low_priority_parent_model_for_naming = -> { _1.is_a?(TenantModel) }
+      `git add -f #{recorder.new_blob_file_paths.join(' ')}`
+    end
+  else
+    assert_empty offending_records.map(&:fixture_name),
+      "Expected the following product fixtures to have images:"
+  end
+end
 ```
 
 ## License

data/lib/fixture_farm/active_job_hook.rb

@@ -8,7 +8,7 @@ module FixtureFarm
     include Hook
 
     included do
-      around_perform :record_new_fixtures, if: :record_new_fixtures?
+      around_perform :record_fixtures, if: :record_fixtures?
     end
   end
 end

data/lib/fixture_farm/controller_hook.rb

@@ -8,7 +8,7 @@ module FixtureFarm
     include Hook
 
     included do
-      around_action :record_new_fixtures, if: :record_new_fixtures?
+      around_action :record_fixtures, if: :record_fixtures?
     end
   end
 end

data/lib/fixture_farm/fixture_recorder.rb

@@ -72,7 +72,7 @@ module FixtureFarm
       recording_session['error']
     end
 
-    def record_new_fixtures
+    def record_fixtures
       @stopped = false
 
       @subscriber = ActiveSupport::Notifications.subscribe 'sql.active_record' do |event|

data/lib/fixture_farm/hook.rb

@@ -4,12 +4,12 @@ require 'fixture_farm/fixture_recorder'
 
 module FixtureFarm
   module Hook
-    def record_new_fixtures(&block)
+    def record_fixtures(&block)
       fixture_recorder = FixtureRecorder.resume_recording_session
       return unless fixture_recorder # Bail if session was stopped due to error
 
       begin
-        fixture_recorder.record_new_fixtures { block.call }
+        fixture_recorder.record_fixtures { block.call }
       ensure
         fixture_recorder.update_recording_session
       end
@@ -17,7 +17,7 @@ module FixtureFarm
 
     private
 
-    def record_new_fixtures?
+    def record_fixtures?
       FixtureRecorder.recording_session_in_progress?
     end
   end

data/lib/fixture_farm/test_helper.rb

@@ -4,8 +4,8 @@ require 'fixture_farm/fixture_recorder'
 
 module FixtureFarm
   module TestHelper
-    def record_new_fixtures(fixture_name_prefix = nil, &block)
-      FixtureRecorder.new(fixture_name_prefix).record_new_fixtures(&block)
+    def record_fixtures(fixture_name_prefix = nil, &block)
+      FixtureRecorder.new(fixture_name_prefix).record_fixtures(&block)
     end
   end
 end

data/lib/fixture_farm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FixtureFarm
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixture_farm
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - artemave
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-28 00:00:00.000000000 Z
+date: 2025-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails