factory_sloth 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce07258dd3b7b7e17ba54accb86be394e97f3f7c986b7d05705dcd54b93e6d50
-  data.tar.gz: 3160fc1436b8f9271f94b005a367c18084298c003623ca97bb773c9b10656f32
+  metadata.gz: c628e26d703d50de9a6f087174d01132942eb557ccbb4519a173116922cb2541
+  data.tar.gz: 40c2d6873fb446d5a8dbba7339ebc481e766989ff722531e24d891213bac3434
 SHA512:
-  metadata.gz: 44dec49c5e35641d9a92bf175bed7afa4a9a58a87e4c663fb50545aaec7551ee49ca88e61d827053c0505d0d0ae9e59d323a7eba3d059f7361d9cc610ba9cf08
-  data.tar.gz: 0ada9a7c4f0a787bef23d67d4bdcb1dbf80b22294b13467ccdf1b0ed0f044017cac9ffe2e2db4b61622f0da19996b3d4f6d733947fd1f1b3b45e6283ae773abf
+  metadata.gz: aa04cdbe7e3bf0fe25b9754f6fa5d356db63c4cf18ef193c5a0b11ae8629c36cd3e39ffda5fa71e47cf1ddef16b0dc4b84564c87cc6e493169150bbe35aeccd3
+  data.tar.gz: 8bfc7521d09398337217f0ed04adccda7380f653efd46c2c0d39858082d7d949996142b5bf074eaab36524b3df197a29875b72bd21a8b7a326886303cbd1d9fa

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.2.2] - 2023-05-18
+
+### Fixed
+
+- No longer changes create to build for records that are persisted later
+- Fixed duplicate entries in `.factory_sloth_done` file
+
 ## [1.2.1] - 2023-05-17
 
 ### Fixed

data/README.md

@@ -44,7 +44,7 @@ Processing spec/lib/string_ext_spec.rb ...
 
 Processing spec/models/user_spec.rb ...
 - create in line 3 can be replaced with build
-- create in line 4 can be replaced with build
+- create_list in line 4 can be replaced with build_list
 🟢 3 create calls found, 2 replaced
 
 Processing spec/weird_dir/crazy_spec.rb ...
@@ -58,15 +58,21 @@ The `conflict` case is rare. It only happens if individual examples were green a
 
 ## Limitations / known issues
 
-FactorySloth only works with RSpec so far. It also generates false positives in cases where create calls are done but only the *absence* of any effect is tested, e.g.:
+`factory_sloth` only works with RSpec so far. It also works best with unit tests such as model specs. It generates **false positives** in cases where create calls are done but only the *absence* of any effect is tested, e.g.:
 
 ```ruby
-user1 = create(:user, in_search: true)
-user2 = create(:user, in_search: false)
-expect(User.searchable).to eq(user1)
+user = create(:user)
+User.delete_all
+expect(User.count).to eq 0
 ```
 
-This test will still pass if `user2` is no longer inserted into the database, leading factory_sloth to believe that `build` suffices here. However, this makes the test no longer assert the same thing. `# sloth:disable` / `# sloth:enable` comments can be used to prevent `factory_sloth` from making such changes. If you have a good idea about how to detect such cases automatically, let me know :)
+This test will still pass if `user` is never inserted into the database in the first place, leading `factory_sloth` to believe that `build` suffices here. However, this change makes the test no longer assert the same thing and reduces coverage. Magic comments can be used to prevent `factory_sloth` from making such changes. `factory_sloth` will not touch lines with inline `# sloth:disable` comments, or sections framed in `# sloth:disable` / `# sloth:enable` comments. Another option is to write the test in a different (and arguably more assertive) way, e.g.:
+
+```ruby
+expect { User.delete_all }.to change { User.count }.from(1).to(0)
+```
+
+If you have a good idea about how to detect such cases automatically, let me know :)
 
 ## Development
 

data/lib/factory_sloth/code_mod.rb

@@ -19,13 +19,16 @@ class FactorySloth::CodeMod
     # rspec call. However, this would make it impossible to use `--fail-fast`,
     # and might make examples fail that are not as idempotent as they should be.
     self.changed_create_calls =
-      create_calls
-      .sort_by { |call| [-call.line, -call.column] }
-      .select { |call| try_patch(call, 'build') || try_patch(call, 'build_stubbed') }
+      create_calls.sort_by { |call| [-call.line, -call.column] }.select do |call|
+        build_result = try_patch(call, 'build')
+        next if build_result == ABORT
+
+        build_result == SUCCESS || try_patch(call, 'build_stubbed') == SUCCESS
+      end
 
     # validate whole spec after changes, e.g. to detect side-effects
     self.ok = changed_create_calls.none? ||
-      FactorySloth::SpecRunner.call(path, patched_code)
+      FactorySloth::SpecRunner.call(path, patched_code).success?
     changed_create_calls.clear unless ok?
     patched_code.replace(original_code) unless ok?
   end
@@ -56,30 +59,56 @@ class FactorySloth::CodeMod
       /\A(?:.*\n){#{call.line - 1}}.{#{call.column}}\K#{call.name}/,
       variant
     )
-    checked_patched_code = with_execution_check(new_patched_code, call.line, variant)
-    if FactorySloth::SpecRunner.call(path, checked_patched_code, line: call.line)
+    checked_patched_code = new_patched_code + checks(call.line, variant)
+
+    result = FactorySloth::SpecRunner.call(path, checked_patched_code, line: call.line)
+    if result.success?
       puts "- #{call.name} in line #{call.line} can be replaced with #{variant}"
       self.patched_code = new_patched_code
+      SUCCESS
+    elsif result.exitstatus == FACTORY_UNUSED_CODE
+      puts "- #{call.name} in line #{call.line} is never executed, skipping"
+      ABORT
+    elsif result.exitstatus == FACTORY_PERSISTED_LATER_CODE
+      ABORT
     end
   end
 
-  def with_execution_check(spec_code, line, variant)
-    spec_code + <<~RUBY
+  ABORT = :ABORT # returned if there is no need to try other variants
+  SUCCESS = :SUCCESS
+
+  FACTORY_UNUSED_CODE          = 77
+  FACTORY_PERSISTED_LATER_CODE = 78
+
+  # This adds code that makes a spec run fail and thus prevents changes if:
+  # a) the patched factory in the given line is never called
+  # b) the built record was persisted later anyway
+  # The rationale behind a) is that things like skipped examples should not
+  # be broken. The rationale behind b) is that not much DB work would be saved,
+  # but diff noise would be increased and ease of editing the example reduced.
+  def checks(line, variant)
+    <<~RUBY
       ; defined?(FactoryBot) && defined?(RSpec) && RSpec.configure do |config|
-        executed_lines = []
+        records_by_line = {} # track records initialized through factories per line
 
         FactoryBot::Syntax::Methods.class_eval do
-          alias ___original_#{variant} #{variant}
+          alias ___original_#{variant} #{variant} # e.g. ___original_build build
 
-          define_method("#{variant}") do |*args, **kwargs, &blk|
-            executed_lines << caller_locations(1, 1)&.first&.lineno
-            ___original_#{variant}(*args, **kwargs, &blk)
+          define_method("#{variant}") do |*args, **kwargs, &blk| # e.g. build
+            result = ___original_#{variant}(*args, **kwargs, &blk)
+            list = records_by_line[caller_locations(1, 1)&.first&.lineno] ||= []
+            list.concat([result].flatten) # to work with single, list, and pair
+            result
           end
         end
 
         config.after(:suite) do
-          executed_lines.include?(#{line}) ||
-            fail("unused factory in line #{line} - will not be modified")
+          records = records_by_line[#{line}]
+          records&.any? || exit!(#{FACTORY_UNUSED_CODE})
+          unless "#{variant}".include?('stub') # factory_bot stub stubs persisted? as true
+            records.any? { |r| r.respond_to?(:persisted?) && r.persisted? } &&
+              exit!(#{FACTORY_PERSISTED_LATER_CODE})
+          end
         end
       end
     RUBY

data/lib/factory_sloth/done_tracker.rb

@@ -7,6 +7,8 @@ module FactorySloth::DoneTracker
 
   def mark_as_done(path)
     normalized_path = normalize(path)
+    return if done?(normalized_path)
+
     done << normalized_path
     File.open(file, 'a') { |f| f.puts(normalized_path) }
   end

data/lib/factory_sloth/spec_runner.rb

@@ -1,13 +1,22 @@
+require 'open3'
 require 'tmpdir'
 
 module FactorySloth::SpecRunner
   def self.call(spec_path, spec_code, line: nil)
-    Dir.mktmpdir do |tmpdir|
-      path = File.join(tmpdir, spec_path)
-      FileUtils.mkdir_p(File.dirname(path))
-      File.write(path, spec_code)
-      path_arg = [path, line].compact.map(&:to_s).join(':')
-      !!system("bundle exec rspec #{path_arg} --fail-fast 1>/dev/null 2>&1")
+    path = File.join(tmpdir, spec_path)
+    FileUtils.mkdir_p(File.dirname(path))
+    File.write(path, spec_code)
+    path_arg = [path, line].compact.map(&:to_s).join(':')
+    command = "bundle exec rspec #{path_arg} --fail-fast --order defined 2>&1"
+    _output, status = Open3.capture2(command)
+    status
+  end
+
+  def self.tmpdir
+    @tmpdir ||= begin
+      dir = Dir.mktmpdir('factory_sloth-')
+      at_exit { FileUtils.remove_entry(dir) if File.exist?(dir) }
+      dir
     end
   end
 end

data/lib/factory_sloth/version.rb

@@ -1,3 +1,3 @@
 module FactorySloth
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_sloth
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email: