fixture_farm 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af9b30c58737a261963da35795445aadfcb38efe2f3ed6d4fc8055f19399b0df
-  data.tar.gz: 865e73ba12d379aba2b3f48a160ce421efe7d49a958db72f19b185d4d1045175
+  metadata.gz: d3a39068e7447367066d1947cf1f14d16366d10e88e91ae922ff3953b7667ff5
+  data.tar.gz: 7f28f26923b51368511ed5ef8c55531f2d405ba36d11ea802caedbc554fbcf0a
 SHA512:
-  metadata.gz: 9c1950bc97570624b27f2f928ec82586816429e1f7a34378f5336c83d8d420180ad65093677744a4b6efa8e3cbc2b7a298631837dbb9ffc32d0c11941d372596
-  data.tar.gz: 455b1430edd5fb21874e7cd906688ea55ea3e1753c0e02b13b2bcd051f2e68f17d02174f6b770cac9b15f212cef0923b52c3584f40f7b1d662957cff1a4c0cc3
+  metadata.gz: 84a8649ace5e14d8dd09b94cdde3d15f02ebd8bd602f706b48ec48f9bff9ab4ea0170fd26827886ee8b0595909d930ce16e61d21e422df9b9e9a7c545df248b7
+  data.tar.gz: d25f84374a79d33ee8ee117656c59e7523d4087dd3dc9065de7a540b882b5cd2fd9897e4aee3aa23af3a8f0eb43ee5168efb2d390dc12ecbde8b1a3b0fd22656

data/README.md

@@ -55,7 +55,12 @@ include FixtureFarm::ActiveJobHook if defined?(FixtureFarm)
 Then start/stop recording using tasks:
 
 ```bash
-bundle exec fixture_farm record some_awesome_name_prefix
+bundle exec fixture_farm record
+# OR
+bundle exec fixture_farm record name_prefix
+# OR
+bundle exec fixture_farm record name_prefix:replaces_name
+
 bundle exec fixture_farm status
 bundle exec fixture_farm stop
 ```
@@ -88,6 +93,25 @@ Assuming there was a parent fixture `dave` that didn't have any children, this t
 
 `record_fixtures` accepts optional name prefix, that applies to all new fixture names.
 
+#### Fixture Name Replacement
+
+`record_fixtures` also supports hash arguments for advanced fixture naming control:
+
+```ruby
+# Replace 'client_1' with 'new_client' in fixture names, or use 'new_client' as prefix if not found
+record_fixtures(new_client: :client_1) do
+  User.create!(name: 'Test User', email: 'test@example.com')
+end
+```
+
+This works in two ways:
+- **Replacement**: If a generated fixture name contains `client_1`, it gets replaced with `new_client`
+- **Prefixing**: If a generated fixture name doesn't contain `client_1`, it gets prefixed with `new_client_`
+
+For example:
+- A user fixture that would be named `client_1_user_1` becomes `new_client_user_1` (replacement)
+- A user fixture that would be named `user_1` becomes `new_client_user_1` (prefixing)
+
 ### 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`.
@@ -100,25 +124,42 @@ FixtureFarm.low_priority_parent_model_for_naming = -> { _1.is_a?(TenantModel) }
 
 ### Attachment 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.
+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 to do the work. Not only is this less boring, but it's also going to generate variant fixtures.
 
-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 we then check the generated blob files into git (along with the fixture files themselves), no attachment processing will be happening in tests or after `rails db:fixtures:load`.
 
-```ruby
-# config/environments/test.rb
-config.active_storage.service = :local
+We'll need a special storage service for the fixture blobs we want to keep versioned. For example:
+
+```yml
+# config/storage.yml
+test_fixtures:
+  service: Disk
+  root: <%= Rails.root.join("test/fixtures/files/active_storage_blobs") %>
 ```
 
-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`.
+Now a test like the one below is either going to fail if some product fixtures have no attachments, or, if run with `GENERATE_FIXTURES=1`, is going to generate those attachment fixtures, their variant fixtures if needed, along with all the blob files tucked away in a separate (from regular throw away storage) folder that can be checked in:
 
 ```ruby
+if ENV["GENERATE_FIXTURES"]
+  setup do
+    @original_queue_adapter = Rails.configuration.active_job.queue_adapter
+    # This is so that variants get generated and blobs analyzed
+    Rails.configuration.active_job.queue_adapter = :inline
+
+    @original_storage_service = ActiveStorage::Blob.service
+    ActiveStorage::Blob.service = ActiveStorage::Blob.services.fetch(:test_fixtures)
+  end
+
+  teardown do
+    Rails.configuration.active_job.queue_adapter = @original_queue_adapter
+    ActiveStorage::Blob.service = @original_storage_service
+  end
+end
+
 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
 
@@ -128,13 +169,7 @@ test "product fixtures have images" do
           filename: "#{product.fixture_name}.jpg",
           content_type: "image/jpeg"
         )
-        # This generates variants
-        perform_enqueued_jobs
       end
-
-      recorder.stop!
-
-      `git add -f #{recorder.new_blob_file_paths.join(' ')}`
     end
   else
     assert_empty offending_records.map(&:fixture_name),

data/bin/fixture_farm.rb

@@ -4,14 +4,24 @@
 require_relative '../lib/fixture_farm/fixture_recorder'
 
 def usage
-  puts 'Usage: bundle exec fixture_farm <record|status|stop> [fixture_name_prefix]'
+  puts 'Usage: bundle exec fixture_farm <record|status|stop> [name_prefix|name_prefix:replaces_name]'
   exit 1
 end
 
 case ARGV[0]
 when 'record'
-  FixtureFarm::FixtureRecorder.start_recording_session!(ARGV[1])
-  puts "Recording fixtures#{" with prefix #{ARGV[1]}" unless ARGV[1].nil?}"
+  prefix_arg = ARGV[1]
+
+  # Parse hash syntax like "new_user:user_1" into {new_user: :user_1}
+  if prefix_arg&.include?(':')
+    parts = prefix_arg.split(':', 2)
+    parsed_prefix = { parts[0].to_sym => parts[1].to_sym }
+  else
+    parsed_prefix = prefix_arg
+  end
+
+  FixtureFarm::FixtureRecorder.start_recording_session!(parsed_prefix)
+  puts "Recording fixtures#{" with prefix #{prefix_arg}" unless prefix_arg.nil?}"
 when 'status'
   if FixtureFarm::FixtureRecorder.recording_session_in_progress?
     puts 'Recording is on'

data/lib/fixture_farm/fixture_recorder.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module FixtureFarm
-
   mattr_accessor :low_priority_parent_model_for_naming
 
   class FixtureRecorder
@@ -16,7 +15,13 @@ module FixtureFarm
     end
 
     def initialize(fixture_name_prefix, new_models = [])
-      @fixture_name_prefix = fixture_name_prefix
+      if fixture_name_prefix.is_a?(Hash)
+        @fixture_name_replacements = fixture_name_prefix
+        @fixture_name_prefix = nil
+      else
+        @fixture_name_prefix = fixture_name_prefix
+        @fixture_name_replacements = {}
+      end
       @new_models = new_models
       @deleted_models = {}
       @initial_now = Time.zone.now
@@ -95,9 +100,11 @@ module FixtureFarm
         end
       end
 
-      yield self
+      result = yield self
 
       stop! unless @stopped
+
+      result
     ensure
       ActiveSupport::Notifications.unsubscribe(@subscriber)
     end
@@ -144,8 +151,10 @@ module FixtureFarm
 
       blob.update!(key: new_key)
 
-      from_path = Rails.root.join('storage', old_key[0..1], old_key[2..3], old_key)
-      to_dir = Rails.root.join('storage', new_key[0..1], new_key[2..3])
+      blobs_root_path = Pathname.new(ActiveStorage::Blob.service.root)
+
+      from_path = blobs_root_path.join(old_key[0..1], old_key[2..3], old_key)
+      to_dir = blobs_root_path.join(new_key[0..1], new_key[2..3])
       to_path = to_dir.join(new_key)
 
       `mkdir -p #{to_dir}`
@@ -366,12 +375,25 @@ module FixtureFarm
       fixture_name(model_instance) || begin
         existing_fixtures = existing_fixtures_for_model(model_instance)
 
-        new_fixture_name = [
+        base_name = [
           first_belongs_to_fixture_name(model_instance).presence || @fixture_name_prefix,
           "#{model_instance.class.name.underscore.split('/').last}_1"
         ].select(&:present?).join('_')
 
-        while @named_new_fixtures[new_fixture_name] || existing_fixtures[new_fixture_name] && !@deleted_models[new_fixture_name]
+        @fixture_name_replacements.each do |new_name, old_name|
+          # Only apply replacement if the base_name doesn't already start with new_name
+          # This prevents double-application of replacements
+          next if base_name.start_with?("#{new_name}_")
+
+          original_name = base_name
+          base_name = base_name.gsub(/\b#{Regexp.escape(old_name.to_s)}\b/, new_name.to_s)
+
+          # If no replacement occurred, use new_name as prefix
+          base_name = "#{new_name}_#{base_name}" if base_name == original_name
+        end
+
+        new_fixture_name = base_name
+        while @named_new_fixtures[new_fixture_name] || (existing_fixtures[new_fixture_name] && !@deleted_models[new_fixture_name])
           new_fixture_name = new_fixture_name.sub(/_(\d+)$/, "_#{Regexp.last_match(1).to_i + 1}")
         end
 

data/lib/fixture_farm/version.rb

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

metadata

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