factory_sloth 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cefc242e547927b9e8805b2dd4be60905f4dd5e484a5b42da6699e3c104879e8
-  data.tar.gz: 60c06cc54a40a35b4a72850d636510af0883071760fd88b5587091e1866de261
+  metadata.gz: ce07258dd3b7b7e17ba54accb86be394e97f3f7c986b7d05705dcd54b93e6d50
+  data.tar.gz: 3160fc1436b8f9271f94b005a367c18084298c003623ca97bb773c9b10656f32
 SHA512:
-  metadata.gz: c96fcd9841cd70fc952f6f503bd2e84024a2bf786fd132805f0badff7b5208f720be9cc36a73981d77f65fa932e256d7b4ecf2c08e59425ce811e10c61f2813a
-  data.tar.gz: 885c2928964f3dff1e041a4fa09b3c85a13a452e3168a6985754b0ec6fae01c1cc550001f76808451d02ee477bdcb82b1d2c10dd82576f95b1555b2eab325dcb
+  metadata.gz: 44dec49c5e35641d9a92bf175bed7afa4a9a58a87e4c663fb50545aaec7551ee49ca88e61d827053c0505d0d0ae9e59d323a7eba3d059f7361d9cc610ba9cf08
+  data.tar.gz: 0ada9a7c4f0a787bef23d67d4bdcb1dbf80b22294b13467ccdf1b0ed0f044017cac9ffe2e2db4b61622f0da19996b3d4f6d733947fd1f1b3b45e6283ae773abf

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [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
+
+- Added support for magic comments `# sloth:disable`, `# sloth:enable`
+
 ## [1.1.0] - 2023-05-16
 
 ### Added

data/README.md

@@ -56,10 +56,17 @@ 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)
+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.:
+
+```ruby
+user1 = create(:user, in_search: true)
+user2 = create(:user, in_search: false)
+expect(User.searchable).to eq(user1)
+```
+
+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 :)
 
 ## 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,15 @@ 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 { |call| try_patch(call, 'build') || try_patch(call, 'build_stubbed') }
 
     # 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)
+    changed_create_calls.clear unless ok?
+    patched_code.replace(original_code) unless ok?
   end
 
   def ok?
@@ -46,14 +48,40 @@ 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(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}"
+  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 = with_execution_check(new_patched_code, call.line, variant)
+    if FactorySloth::SpecRunner.call(path, checked_patched_code, line: call.line)
+      puts "- #{call.name} in line #{call.line} can be replaced with #{variant}"
       self.patched_code = new_patched_code
     end
   end
+
+  def with_execution_check(spec_code, line, variant)
+    spec_code + <<~RUBY
+      ; defined?(FactoryBot) && defined?(RSpec) && RSpec.configure do |config|
+        executed_lines = []
+
+        FactoryBot::Syntax::Methods.class_eval do
+          alias ___original_#{variant} #{variant}
+
+          define_method("#{variant}") do |*args, **kwargs, &blk|
+            executed_lines << caller_locations(1, 1)&.first&.lineno
+            ___original_#{variant}(*args, **kwargs, &blk)
+          end
+        end
+
+        config.after(:suite) do
+          executed_lines.include?(#{line}) ||
+            fail("unused factory in line #{line} - will not be modified")
+        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,35 +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(...)
+  def initialize(code, ...)
     super
-    @locations = []
+    @code = code
+    @disabled = false
+    @calls = []
   end
   private_class_method :new
 
+  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, *)
-    @locations << loc if loc.instance_of?(Array) && mod == 'FactoryBot'
+  def on_call(mod, _, obj, *)
+    store_call(obj) if mod == 'FactoryBot'
   end
 
-  def on_command_call(mod, _, loc, *)
-    @locations << loc if loc.instance_of?(Array) && 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' &&
+      @calls.reject! { |obj| obj[1] == lineno } ||
+      (@lines ||= @code.lines)[lineno - 1].match?(/^\s*#/) &&
+      (@disabled = directive != 'enable')
   end
 
   def on_fcall(loc, *)
-    @locations << loc if loc.instance_of?(Array)
+    store_call(loc)
   end
 
   def on_vcall(loc, *)
-    @locations << loc if loc.instance_of?(Array)
+    store_call(loc)
   end
 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,13 @@
-require 'tempfile'
+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)
+    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")
+    end
   end
 end

data/lib/factory_sloth/version.rb

@@ -1,3 +1,3 @@
 module FactorySloth
-  VERSION = '1.1.0'
+  VERSION = '1.2.1'
 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.1.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-05-17 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