factory_sloth 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80d822847c787a87466a4e359de88dab4838cf0c22f60f93c8d04e236d6d7605
-  data.tar.gz: a76d0cc92c138b39d0042ca70c12a2ac44985d18100ceb42d5a9f21b780f50f8
+  metadata.gz: 3550aaf57e03aa0da8d68264bab3c4a0a17ed264995859f34cc641e7e376b51b
+  data.tar.gz: d947f5e3533b24b7740d509b5e9b8f3a832a6c535eb81f859ba7c562127c3e5a
 SHA512:
-  metadata.gz: 78a95512cbfe09fc763ba18b4304b8abbc35740af0654459bd9cd6724e3413ad3261f3c1c51aac38b7d31d42dc6c4798fa2dd1e0a8045e6dcc388a1863ecf147
-  data.tar.gz: a531d2ef5a770cb73f693d392c9890db5e707297f73c93497170d3b05af666449f810ba46696909673087ef0e103a2ed1434a6d11225825bd92af02cfdd5fa77
+  metadata.gz: e9abcbc30c854da1ec58f4ab292ab6ed9a851dcbd11bd00291b2902bdec14ec79c21145033c2a984b7243831dd27b426bf5e33f6e9d22272d673a9ff2f61dd97
+  data.tar.gz: '03280bc6477e646583c5af49d46e8bacbf611387181c3e0625e007c019170b697151a78fbd1698a859358a512f483a9949f3b6b27006fe92fc85fd10ccb2b149'

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [1.2.0] - 2023-05-16
+
+### Added
+
+- Added support for magic comments `# sloth:disable`, `# sloth:enable`
+
+## [1.1.0] - 2023-05-16
+
+### Added
+
+- Added summary at end of CLI output
+
 ## [1.0.1] - 2023-05-14
 
 ### Fixed

data/README.md

@@ -50,10 +50,20 @@ Processing spec/models/user_spec.rb ...
 Processing spec/weird_dir/crazy_spec.rb ...
 - create in line 8 can be replaced with build_stubbed
 🔴 33 create calls found, 0 replaced (conflict)
+
+Scanned 4 files, found 2 unnecessary create calls across 1 files and 1 broken specs
 ```
 
 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
+
+- 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
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/factory_sloth/cli.rb

@@ -8,12 +8,8 @@ module FactorySloth
       args = option_parser.parse!(argv)
       specs = SpecPicker.call(paths: args)
       forced_files = @force ? specs : args
-      bad_specs = FileProcessor.call(files: specs, forced_files: forced_files, dry_run: @lint)
-
-      if @lint && bad_specs.any?
-        warn "Found unnecessary create calls in:\n#{bad_specs.join("\n")}"
-        exit 1
-      end
+      results = FileProcessor.call(files: specs, forced_files: forced_files, dry_run: @lint)
+      print_summary(results)
     end
 
     private
@@ -51,5 +47,21 @@ module FactorySloth
         end
       end
     end
+
+    def print_summary(results)
+      unnecessary_call_count = results.values.sum { |v| v[:changed_create_calls].count }
+      changed_specs = results.keys.select { |path| results[path][:changed_create_calls].any? }
+      broken_specs = results.keys.select { |path| !results[path][:ok] }
+      stats = "Scanned #{results.count} files, found #{unnecessary_call_count}"\
+              " unnecessary create calls across #{changed_specs.count} files"\
+              "#{" and #{broken_specs.count} broken specs" if broken_specs.any?}"
+
+      if @lint && unnecessary_call_count > 0
+        warn "#{stats}:\n#{(changed_specs + broken_specs).join("\n")}"
+        exit 1
+      else
+        puts stats
+      end
+    end
   end
 end

data/lib/factory_sloth/code_mod.rb

@@ -1,62 +1,59 @@
-require 'tempfile'
-
 class FactorySloth::CodeMod
-  attr_reader :change_count, :create_count, :ok, :original_code, :patched_code
-  alias_method :ok?, :ok
+  attr_reader :create_calls, :changed_create_calls, :original_code, :patched_code
 
   def self.call(code)
     new(code).tap(&:call)
   end
 
   def initialize(code)
-    self.change_count = 0
     self.original_code = code
     self.patched_code = code
   end
 
   def call
-    create_calls = FactorySloth::CreateCallFinder.call(code: original_code)
+    self.create_calls = FactorySloth::CreateCallFinder.call(code: original_code)
 
     # Performance note: it might be faster to write ALL possible patches for a
     # given spec file to tempfiles first, and then run them all in a single
     # 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.
-    create_calls.sort_by { |line, col| [-line, -col] }.each do |line, col|
-      try_patch(line, col, 'build') || try_patch(line, col, 'build_stubbed')
-    end
+    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
 
     # validate whole spec after changes, e.g. to detect side-effects
-    self.ok = spec_code_passes?(patched_code)
-    self.change_count = 0 unless ok?
+    self.ok = FactorySloth::SpecRunner.call(patched_code)
+    self.changed_create_calls.clear unless ok?
     self.patched_code = original_code unless ok?
-    self.create_count = create_calls.count
+  end
+
+  def ok?
+    @ok
   end
 
   def changed?
     change_count > 0
   end
 
+  def create_count
+    create_calls.count
+  end
+
+  def change_count
+    changed_create_calls.count
+  end
+
   private
 
-  attr_writer :change_count, :create_count, :ok, :original_code, :patched_code
+  attr_writer :create_calls, :changed_create_calls, :ok, :original_code, :patched_code
 
   def try_patch(line, col, variant)
     new_patched_code =
       patched_code.sub(/\A(?:.*\n){#{line - 1}}.{#{col}}\Kcreate/, variant)
-    if spec_code_passes?(new_patched_code, line: line)
+    if FactorySloth::SpecRunner.call(new_patched_code, line: line)
       puts "- create in line #{line} can be replaced with #{variant}"
       self.patched_code = new_patched_code
-      self.change_count += 1
     end
   end
-
-  def spec_code_passes?(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
-  end
 end

data/lib/factory_sloth/create_call_finder.rb

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

data/lib/factory_sloth/file_processor.rb

@@ -3,7 +3,7 @@ module FactorySloth
     extend self
 
     def call(files:, forced_files: [], dry_run: false)
-      files.select do |path|
+      files.each_with_object({}) do |path, acc|
         puts "Processing #{path} ..."
 
         if DoneTracker.done?(path) && !forced_files.include?(path)
@@ -11,9 +11,9 @@ module FactorySloth
           next
         end
 
-        bad_creates_found = process(path, dry_run: dry_run)
+        result = process(path, dry_run: dry_run)
+        acc[path] = { ok: result.ok?, changed_create_calls: result.changed_create_calls }
         DoneTracker.mark_as_done(path)
-        bad_creates_found
       end
     end
 
@@ -26,7 +26,7 @@ module FactorySloth
         File.write(path, result.patched_code) if result.changed?
       end
       puts result_message(result, dry_run), ''
-      result.changed?
+      result
     end
 
     def result_message(result, dry_run)

data/lib/factory_sloth/spec_runner.rb

@@ -0,0 +1,13 @@
+require 'tempfile'
+
+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
+  end
+end

data/lib/factory_sloth/version.rb

@@ -1,3 +1,3 @@
 module FactorySloth
-  VERSION = '1.0.1'
+  VERSION = '1.2.0'
 end

data/lib/factory_sloth.rb

@@ -6,4 +6,5 @@ require_relative 'factory_sloth/create_call_finder'
 require_relative 'factory_sloth/done_tracker'
 require_relative 'factory_sloth/file_processor'
 require_relative 'factory_sloth/spec_picker'
+require_relative 'factory_sloth/spec_runner'
 require_relative 'factory_sloth/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_sloth
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-14 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -21,7 +21,6 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -33,6 +32,7 @@ files:
 - lib/factory_sloth/done_tracker.rb
 - lib/factory_sloth/file_processor.rb
 - lib/factory_sloth/spec_picker.rb
+- lib/factory_sloth/spec_runner.rb
 - lib/factory_sloth/version.rb
 homepage: https://github.com/jaynetics/factory_sloth
 licenses:

data/Gemfile.lock

@@ -1,47 +0,0 @@
-PATH
-  remote: .
-  specs:
-    factory_sloth (1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    rake (13.0.6)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-cobertura (2.1.0)
-      rexml
-      simplecov (~> 0.19)
-    simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.4)
-
-PLATFORMS
-  arm64-darwin-21
-  ruby
-
-DEPENDENCIES
-  factory_sloth!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  simplecov-cobertura (~> 2.1)
-
-BUNDLED WITH
-   2.4.7