factory_sloth 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3550aaf57e03aa0da8d68264bab3c4a0a17ed264995859f34cc641e7e376b51b
-  data.tar.gz: d947f5e3533b24b7740d509b5e9b8f3a832a6c535eb81f859ba7c562127c3e5a
+  metadata.gz: c628e26d703d50de9a6f087174d01132942eb557ccbb4519a173116922cb2541
+  data.tar.gz: 40c2d6873fb446d5a8dbba7339ebc481e766989ff722531e24d891213bac3434
 SHA512:
-  metadata.gz: e9abcbc30c854da1ec58f4ab292ab6ed9a851dcbd11bd00291b2902bdec14ec79c21145033c2a984b7243831dd27b426bf5e33f6e9d22272d673a9ff2f61dd97
-  data.tar.gz: '03280bc6477e646583c5af49d46e8bacbf611387181c3e0625e007c019170b697151a78fbd1698a859358a512f483a9949f3b6b27006fe92fc85fd10ccb2b149'
+  metadata.gz: aa04cdbe7e3bf0fe25b9754f6fa5d356db63c4cf18ef193c5a0b11ae8629c36cd3e39ffda5fa71e47cf1ddef16b0dc4b84564c87cc6e493169150bbe35aeccd3
+  data.tar.gz: 8bfc7521d09398337217f0ed04adccda7380f653efd46c2c0d39858082d7d949996142b5bf074eaab36524b3df197a29875b72bd21a8b7a326886303cbd1d9fa

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [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
+
+- Fixed handling of path-based, derived spec metadata
+  - Thanks to https://github.com/bquorning
+- Fixed unnecessary spec runs for files without create calls or changes
+- Fixed modification of factory calls that never run (e.g. in skipped examples)
+
 ## [1.2.0] - 2023-05-16
 
 ### Added

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 ...
@@ -56,13 +56,23 @@ Scanned 4 files, found 2 unnecessary create calls across 1 files and 1 broken sp
 
 The `conflict` case is rare. It only happens if individual examples were green after changing them, but at least one example failed when evaluating the whole file after all changes. This probably means that some other example was red even before making changes, or that something else is wrong with this spec file, e.g. some examples depend on other examples' side effects.
 
-## Limitations
+## Limitations / known issues
 
-- only works with RSpec so far
-- downgrades create calls that never run (e.g. in skipped examples)
-- downgrades create calls that are only checked for an absence of effects
-  - e.g. `a = create(:a); b = create(:b); expect(Record.filtered).to eq [b]`
-  - `# sloth:disable` / `# sloth:enable` comments can be used to control this
+`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
+user = create(:user)
+User.delete_all
+expect(User.count).to eq 0
+```
+
+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

@@ -1,11 +1,12 @@
 class FactorySloth::CodeMod
-  attr_reader :create_calls, :changed_create_calls, :original_code, :patched_code
+  attr_reader :create_calls, :changed_create_calls, :path, :original_code, :patched_code
 
-  def self.call(code)
-    new(code).tap(&:call)
+  def self.call(path, code)
+    new(path, code).tap(&:call)
   end
 
-  def initialize(code)
+  def initialize(path, code)
+    self.path = path
     self.original_code = code
     self.patched_code = code
   end
@@ -18,14 +19,18 @@ 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 { |line, col| [-line, -col] }.select do |line, col|
-        try_patch(line, col, 'build') || try_patch(line, col, 'build_stubbed')
-      end.sort
+      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 = FactorySloth::SpecRunner.call(patched_code)
-    self.changed_create_calls.clear unless ok?
-    self.patched_code = original_code unless ok?
+    self.ok = changed_create_calls.none? ||
+      FactorySloth::SpecRunner.call(path, patched_code).success?
+    changed_create_calls.clear unless ok?
+    patched_code.replace(original_code) unless ok?
   end
 
   def ok?
@@ -46,14 +51,66 @@ class FactorySloth::CodeMod
 
   private
 
-  attr_writer :create_calls, :changed_create_calls, :ok, :original_code, :patched_code
+  attr_writer :create_calls, :changed_create_calls, :ok, :path, :original_code, :patched_code
+
+  def try_patch(call, base_variant)
+    variant = call.name.sub('create', base_variant)
+    new_patched_code = patched_code.sub(
+      /\A(?:.*\n){#{call.line - 1}}.{#{call.column}}\K#{call.name}/,
+      variant
+    )
+    checked_patched_code = new_patched_code + checks(call.line, variant)
 
-  def try_patch(line, col, variant)
-    new_patched_code =
-      patched_code.sub(/\A(?:.*\n){#{line - 1}}.{#{col}}\Kcreate/, variant)
-    if FactorySloth::SpecRunner.call(new_patched_code, line: line)
-      puts "- create in line #{line} can be replaced with #{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
+
+  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|
+        records_by_line = {} # track records initialized through factories per line
+
+        FactoryBot::Syntax::Methods.class_eval do
+          alias ___original_#{variant} #{variant} # e.g. ___original_build build
+
+          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
+          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
+  end
 end

data/lib/factory_sloth/create_call.rb

@@ -0,0 +1 @@
+FactorySloth::CreateCall = Struct.new(:name, :line, :column, keyword_init: true)

data/lib/factory_sloth/create_call_finder.rb

@@ -1,50 +1,51 @@
 require 'ripper'
 
 class FactorySloth::CreateCallFinder < Ripper
-  attr_reader :locations
+  attr_reader :calls
 
   def self.call(code:)
-    new(code).tap(&:parse).locations
+    new(code).tap(&:parse).calls
   end
 
   def initialize(code, ...)
     super
     @code = code
     @disabled = false
-    @locations = []
+    @calls = []
   end
   private_class_method :new
 
-  def store_location(loc)
-    @locations << loc if loc.instance_of?(Array) && !@disabled
+  def store_call(obj)
+    @calls << obj if obj.is_a?(FactorySloth::CreateCall) && !@disabled
   end
 
   def on_ident(name, *)
-    [lineno, column] if %w[create create_list create_pair].include?(name)
+    %w[create create_list create_pair].include?(name) &&
+      FactorySloth::CreateCall.new(name: name, line: lineno, column: column)
   end
 
-  def on_call(mod, _, loc, *)
-    store_location(loc) if mod == 'FactoryBot'
+  def on_call(mod, _, obj, *)
+    store_call(obj) if mod == 'FactoryBot'
   end
 
-  def on_command_call(mod, _, loc, *)
-    store_location(loc) if mod == 'FactoryBot'
+  def on_command_call(mod, _, obj, *)
+    store_call(obj) if mod == 'FactoryBot'
   end
 
   def on_comment(text, *)
     return unless /sloth:(?<directive>disable|enable)/ =~ text
 
     directive == 'disable' &&
-      @locations.reject! { |loc| loc.first == lineno } ||
+      @calls.reject! { |obj| obj[1] == lineno } ||
       (@lines ||= @code.lines)[lineno - 1].match?(/^\s*#/) &&
       (@disabled = directive != 'enable')
   end
 
   def on_fcall(loc, *)
-    store_location(loc)
+    store_call(loc)
   end
 
   def on_vcall(loc, *)
-    store_location(loc)
+    store_call(loc)
   end
 end

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/file_processor.rb

@@ -21,7 +21,7 @@ module FactorySloth
 
     def process(path, dry_run:)
       code = File.read(path)
-      result = CodeMod.call(code)
+      result = CodeMod.call(path, code)
       unless dry_run
         File.write(path, result.patched_code) if result.changed?
       end

data/lib/factory_sloth/spec_runner.rb

@@ -1,13 +1,22 @@
-require 'tempfile'
+require 'open3'
+require 'tmpdir'
 
 module FactorySloth::SpecRunner
-  def self.call(spec_code, line: nil)
-    tempfile = Tempfile.new
-    tempfile.write(spec_code)
-    tempfile.close
-    path = [tempfile.path, line].compact.map(&:to_s).join(':')
-    result = !!system("bundle exec rspec #{path} --fail-fast 1>/dev/null 2>&1")
-    tempfile.unlink
-    result
+  def self.call(spec_path, spec_code, line: nil)
+    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.0'
+  VERSION = '1.2.2'
 end

data/lib/factory_sloth.rb

@@ -2,6 +2,7 @@ module FactorySloth; end
 
 require_relative 'factory_sloth/cli'
 require_relative 'factory_sloth/code_mod'
+require_relative 'factory_sloth/create_call'
 require_relative 'factory_sloth/create_call_finder'
 require_relative 'factory_sloth/done_tracker'
 require_relative 'factory_sloth/file_processor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_sloth
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -28,6 +28,7 @@ files:
 - lib/factory_sloth.rb
 - lib/factory_sloth/cli.rb
 - lib/factory_sloth/code_mod.rb
+- lib/factory_sloth/create_call.rb
 - lib/factory_sloth/create_call_finder.rb
 - lib/factory_sloth/done_tracker.rb
 - lib/factory_sloth/file_processor.rb