fixture_farm 0.1.6 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c681a08bddfef41bec83f8fc4693fc299f5b0f750d1904a652d2adac306aad51
-  data.tar.gz: b1a19637eab90fe234dc45eba360963a5342b1923f7085d75a19df4678829669
+  metadata.gz: aff981f1a6701eb197d0a067391143ce166d4c64de2d3c449cfac8400bb48dd2
+  data.tar.gz: 49d489ca4b85708d285db668ca2dcde57ac4a3aa52b394403ad82ccde4841196
 SHA512:
-  metadata.gz: 194b052b53935e3e74c7f16818b83f8536c836ac09d3911a966f50591b0931348d75a4448fafcfaa657295855c016902df0bed068a798e90ff478d841f0a5427
-  data.tar.gz: d1da130e48e0fa0802edb690600482b897985fa8928be6189b5c13c3b74401df67d5963e9c183387e6dd309826e1fc20b989b7b8c4348ec3cf0394b3e9beb075
+  metadata.gz: 138bcbab569d27a49c332ac24b814392aab3888e2cd49cf3b64e3f46b3b5a6f6c780d6f7aa355ceba410c900611b31c16dc7ead35af6d74431043391fb34cbce
+  data.tar.gz: 22170db6fd9112ea4d67d6de74f270f4615a2d2ab07b02af913c2de516c952d4045685c19a1f382679046939ccf7425dc05c6742f934c58cddc4c7afa116f7b1

data/README.md

@@ -65,7 +65,7 @@ To record in tests, wrap some code in `record_new_fixtures` block. For example:
 include FixtureFarm::TestHelper
 
 test 'some stuff does the right thing' do
-  record_new_fixtures('some_stuff') do |stop_recording|
+  record_new_fixtures do |stop_recording|
     user = User.create!(name: 'Bob')
     post = user.posts.create!(title: 'Stuff')
 
@@ -82,7 +82,7 @@ Running this test generates user and post fixtures. Now you can rewrite this tes
 
 ```ruby
 test 'some stuff does the right thing' do
-  user = users('some_stuff_user_1')
+  user = users('user_1')
 
   assert_difference 'user.published_posts.size' do
     user.posts.first.publish!
@@ -90,5 +90,41 @@ test 'some stuff does the right thing' do
 end
 ```
 
+`record_new_fixtures` accepts optional name prefix, that applies to all new fixture names.
+
+A more robust approach is to have dedicated fixture tests that normally fail, but can be optionally run in "record mode" (think VCR).
+
+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:
+
+```ruby
+test 'authors fixtures must have at least one post' do
+  offending_records = Author.where.missing(:posts)
+
+  assert_empty offending_records
+end
+```
+
+Let's say this test is currently failing.
+
+Now let's add the option to automatically record missing fixtures:
+
+```ruby
+test 'authors fixtures must have at least one post' do
+  offending_records = Author.where.missing(:posts)
+
+  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
+```
+
+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.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/fixture_farm.rb

@@ -10,9 +10,8 @@ end
 
 case ARGV[0]
 when 'record'
-  usage unless ARGV[1]
   FixtureFarm::FixtureRecorder.start_recording_session!(ARGV[1])
-  puts "Recording fixtures with prefix #{ARGV[1]}"
+  puts 'Recording fixtures' + ARGV[1].nil? ? '' : " with prefix #{ARGV[1]}"
 when 'status'
   puts "Recording is #{FixtureFarm::FixtureRecorder.recording_session_in_progress? ? 'on' : 'off'}"
 when 'stop'

data/lib/fixture_farm/fixture_recorder.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module FixtureFarm
+  mattr_accessor :parent_models_to_ignore_when_naming_fixtures, default: []
+
   class FixtureRecorder
     STORE_PATH = Rails.root.join('tmp', 'fixture_farm_store.json')
 
@@ -8,6 +10,7 @@ module FixtureFarm
       @fixture_name_prefix = fixture_name_prefix
       @new_models = new_models
       @initial_now = Time.zone.now
+      @ignore_while_tree_walking = Set.new
     end
 
     def self.resume_recording_session
@@ -92,15 +95,41 @@ module FixtureFarm
     end
 
     def named_new_fixtures
-      @new_models.uniq(&:id).each_with_object({}) do |model_instance, named_new_fixtures|
-        new_fixture_name = "#{@fixture_name_prefix}_#{model_instance.class.name.underscore.gsub('/', '_')}_1"
+      @named_new_fixtures ||= begin
+                                (@new_models - @ignore_while_tree_walking.to_a).uniq(&:id).each_with_object({}) do |model_instance, named_new_fixtures|
+                                  @ignore_while_tree_walking.add(model_instance)
 
-        while named_new_fixtures[new_fixture_name]
-          new_fixture_name = new_fixture_name.sub(/_(\d+)$/, "_#{Regexp.last_match(1).to_i + 1}")
-        end
+                                  new_fixture_name = [
+                                    @fixture_name_prefix,
+                                    first_belongs_to_fixture_name(model_instance),
+                                    "#{model_instance.class.name.underscore.split('/').last}_1"
+                                  ].select(&:present?).join('_')
+
+                                  while named_new_fixtures[new_fixture_name]
+                                    new_fixture_name = new_fixture_name.sub(/_(\d+)$/, "_#{Regexp.last_match(1).to_i + 1}")
+                                  end
+
+                                  named_new_fixtures[new_fixture_name] = model_instance
+
+                                  @ignore_while_tree_walking.delete(model_instance)
+                                end
+                              end
+    end
+
+    def first_belongs_to_fixture_name(model_instance)
+      model_instance.class.reflect_on_all_associations.filter(&:belongs_to?).each do |association|
+        associated_model_instance = find_associated_model_instance(model_instance, association)
+
+        next unless associated_model_instance
 
-        named_new_fixtures[new_fixture_name] = model_instance
+        next if FixtureFarm.parent_models_to_ignore_when_naming_fixtures.any? { _1.call(associated_model_instance) }
+
+        if (associated_model_instance_fixture_name = fixture_name(associated_model_instance))
+          return associated_model_instance_fixture_name
+        end
       end
+
+      nil
     end
 
     def update_fixture_files(named_new_fixtures)
@@ -113,15 +142,11 @@ module FixtureFarm
           end
 
           if belongs_to_association
-            associated_model_instance = find_assiciated_model_instance(model_instance, belongs_to_association)
+            associated_model_instance = find_associated_model_instance(model_instance, belongs_to_association)
 
             next unless associated_model_instance
 
-            associated_fixture_name = named_new_fixtures.find do |_, fixture_model|
-              fixture_model.id == associated_model_instance.id
-            end&.first || associated_model_instance.fixture_name
-
-            [belongs_to_association.name.to_s, associated_fixture_name]
+            [belongs_to_association.name.to_s, fixture_name(associated_model_instance)]
           elsif model_instance.column_for_attribute(k).type
             [k, serialize_attributes(v)]
           end
@@ -147,7 +172,7 @@ module FixtureFarm
     # Clear default_scope before finding associated model record.
     # This, in particular, turns off ActsAsTenant, that otherwise
     # might return no record if the tenant has changed by this point.
-    def find_assiciated_model_instance(model_instance, association)
+    def find_associated_model_instance(model_instance, association)
       associated_model_class = if association.polymorphic?
                                  model_instance.public_send(association.foreign_type).safe_constantize
                                else
@@ -238,5 +263,11 @@ module FixtureFarm
         end
       end.except(:value_rest)
     end
+
+    def fixture_name(model_instance)
+      named_new_fixtures.find do |_, fixture_model|
+        fixture_model.id == model_instance.id
+      end&.first || model_instance.fixture_name
+    end
   end
 end

data/lib/fixture_farm/test_helper.rb

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

data/lib/fixture_farm/version.rb

@@ -1,3 +1,3 @@
 module FixtureFarm
-  VERSION = '0.1.6'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixture_farm
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors:
 - artemave
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2025-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Generate rails fixutures while browsing