fixture_farm 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9120ab7f693c781ea48772f5b4f9d277165771afc073f6ed466c88a5fdea2455
-  data.tar.gz: 50b502cab64010626ea929ecf3702b51c4211b98db14a013adb1194c687073a5
+  metadata.gz: 72792ee8f5bca838e5fda1e5ec3088e4c97ec40e740b732734cc0529304afdf4
+  data.tar.gz: c14d543f77631a323abbcee6ce81d1d52afbb04785a2ba82d611f29ebd6e39b8
 SHA512:
-  metadata.gz: 17eadbd5c25eb70dd41dec53f0727890bb7674ddb25bb349eca51e646e8a81f822b8736fe9e6e5ffb9e5cd7b19f7677b92e574c694dc35814d79f0441c22d6bb
-  data.tar.gz: 4403bf7831042e7abce331e3076242cf97c9916ddef4457c08322e956f0a79f9606ed1fd9f348876988741ab277461e15484577698a74d4732d2d0acd8a3a13f
+  metadata.gz: af76dc042d9d51ede677265a6da0cf0203d2934db1bd7b2d218569519df5cdf34a5b1951ce958b90efa2955df5dae6e3fda25a059df2cad31969cece715743c7
+  data.tar.gz: 1ddc003eade3440055aa754290ffea23cca62c0c71c72c3e38e2a4f783255828ad2860400415e33aa1f7f97b4a7e0b7e14a7d969f8e7544aaf39bbd7ecd9c899

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,38 @@ 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
+```
+
+Now let's 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
+  else
+    assert_empty offending_records
+  end
+end
+```
+
+
 ## 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
+
   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)
 
-        named_new_fixtures[new_fixture_name] = model_instance
+        next unless associated_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,13 +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)
 
-            associated_fixture_name = named_new_fixtures.find do |_, fixture_model|
-              fixture_model.id == associated_model_instance.id
-            end&.first || associated_model_instance.fixture_name
+            next unless associated_model_instance
 
-            [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
@@ -145,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
@@ -154,6 +181,11 @@ module FixtureFarm
 
       id = model_instance.public_send(association.foreign_key)
       associated_model_class.unscoped.find(id)
+    rescue ActiveRecord::RecordNotFound
+      # In case of `belongs_to optional: true`, the associated record
+      # may have already been deleted by the time we record fixtures.
+      # We don't want to fail in this case.
+      nil
     end
 
     def serialize_attributes(value)
@@ -231,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.5'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixture_farm
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - artemave
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-09 00:00:00.000000000 Z
+date: 2025-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.2'
-description: 
+description:
 email:
 - mr@artem.rocks
 executables:
@@ -52,7 +52,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/featurist/fixture_farm
   source_code_uri: https://github.com/featurist/fixture_farm.git
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,8 +67,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Generate rails fixutures while browsing
 test_files: []