factory_sloth 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce07258dd3b7b7e17ba54accb86be394e97f3f7c986b7d05705dcd54b93e6d50
-  data.tar.gz: 3160fc1436b8f9271f94b005a367c18084298c003623ca97bb773c9b10656f32
+  metadata.gz: 9032b54abec61f25adcfd938a503f312017667f64b4aa1f303ede50a346a62be
+  data.tar.gz: 901d358d3572a708ec8190c2d2e59dbdab3bce42f894301284dc285895d48f19
 SHA512:
-  metadata.gz: 44dec49c5e35641d9a92bf175bed7afa4a9a58a87e4c663fb50545aaec7551ee49ca88e61d827053c0505d0d0ae9e59d323a7eba3d059f7361d9cc610ba9cf08
-  data.tar.gz: 0ada9a7c4f0a787bef23d67d4bdcb1dbf80b22294b13467ccdf1b0ed0f044017cac9ffe2e2db4b61622f0da19996b3d4f6d733947fd1f1b3b45e6283ae773abf
+  metadata.gz: b1aa29c8c7dd007c5e82ee4cfbc164df1550ace4c2d7880e0471b4a892a2dad33a8e03469c56ec5620f99e7c2dc8c6c47f0d7256102910385acea9a3f97f4b74
+  data.tar.gz: bace623884d7e447200af29fb216f8814f86a7bae4deda093105bb9df716c8151332136a473c31cd6c9e51bc07ded9f2306e9eda29b536b7b4aa130384f0059a

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [1.3.0] - 2023-05-22
+
+### Added
+
+- nicer output
+- verbose mode
+
+## [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

@@ -27,6 +27,7 @@ Examples:
 Options:
     -f, --force                      Ignore ./.factory_sloth_done
     -l, --lint                       Dont fix, just list bad create calls
+    -V, --verbose                    Verbose output, useful for debugging
     -v, --version                    Show gem version
     -h, --help                       Show this help
 ```
@@ -36,20 +37,25 @@ Options:
 While running, `factory_sloth` produces output like this:
 
 ```
-Processing spec/features/sign_up_spec.rb ...
-🟡 2 create calls found, 0 replaced
+🟡 spec/features/sign_up_spec.rb: 2 create calls found, 0 replaced
 
-Processing spec/lib/string_ext_spec.rb ...
-⚪️ 0 create calls found, 0 replaced
+⚪️ spec/lib/string_ext_spec.rb: 0 create calls found, 0 replaced
 
-Processing spec/models/user_spec.rb ...
-- create in line 3 can be replaced with build
-- create in line 4 can be replaced with build
-🟢 3 create calls found, 2 replaced
+spec/models/user_spec.rb:3:2: create replaced with build
+  expect(create(:user)).not_to be_nil
+         ^^^^^^
 
-Processing spec/weird_dir/crazy_spec.rb ...
-- create in line 8 can be replaced with build_stubbed
-🔴 33 create calls found, 0 replaced (conflict)
+spec/models/user_spec.rb:4:2: create_list replaced with build_list
+  expect(create_list(:user, 2).count).to eq 2
+          ^^^^^^^^^^^
+
+🟢 spec/models/user_spec.rb: 3 create calls found, 2 replaced
+
+spec/weird_dir/crazy_spec.rb:8:4: create replaced with build_stubbed
+  expect(create(:user)).not_to be_nil
+         ^^^^^^
+
+🔴 spec/weird_dir/crazy_spec.rb: 33 create calls found, 0 replaced (conflict)
 
 Scanned 4 files, found 2 unnecessary create calls across 1 files and 1 broken specs
 ```
@@ -58,15 +64,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
+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
-user1 = create(:user, in_search: true)
-user2 = create(:user, in_search: false)
-expect(User.searchable).to eq(user1)
+expect { User.delete_all }.to change { User.count }.from(1).to(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 :)
+If you have a good idea about how to detect such cases automatically, let me know :)
 
 ## Development
 

data/lib/factory_sloth/cli.rb

@@ -7,8 +7,7 @@ module FactorySloth
     def call(argv = ARGV)
       args = option_parser.parse!(argv)
       specs = SpecPicker.call(paths: args)
-      forced_files = @force ? specs : args
-      results = FileProcessor.call(files: specs, forced_files: forced_files, dry_run: @lint)
+      results = FileProcessor.call(files: specs, forced_files: args)
       print_summary(results)
     end
 
@@ -29,11 +28,16 @@ module FactorySloth
         opts.separator 'Options:'
 
         opts.on('-f', '--force', "Ignore #{DoneTracker.file}") do
-          @force = true
+          FactorySloth.force = true
         end
 
         opts.on('-l', '--lint', 'Dont fix, just list bad create calls') do
-          @lint = true
+          FactorySloth.dry_run = true
+          FactorySloth.lint = true
+        end
+
+        opts.on('-V', '--verbose', 'Verbose output, useful for debugging') do
+          FactorySloth.verbose = true
         end
 
         opts.on('-v', '--version', 'Show gem version') do
@@ -49,14 +53,14 @@ module FactorySloth
     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? }
+      change_sum = results.values.sum { |v| v[:change_count] }
+      changed_specs = results.keys.select { |path| results[path][:change_count] > 0 }
       broken_specs = results.keys.select { |path| !results[path][:ok] }
-      stats = "Scanned #{results.count} files, found #{unnecessary_call_count}"\
+      stats = "Scanned #{results.count} files, found #{change_sum}"\
               " unnecessary create calls across #{changed_specs.count} files"\
               "#{" and #{broken_specs.count} broken specs" if broken_specs.any?}"
 
-      if @lint && unnecessary_call_count > 0
+      if FactorySloth.lint && change_sum > 0
         warn "#{stats}:\n#{(changed_specs + broken_specs).join("\n")}"
         exit 1
       else

data/lib/factory_sloth/code_mod.rb

@@ -1,87 +1,117 @@
-class FactorySloth::CodeMod
-  attr_reader :create_calls, :changed_create_calls, :path, :original_code, :patched_code
+module FactorySloth
+  class CodeMod
+    attr_reader :create_calls, :changed_create_calls, :path, :original_code, :patched_code
 
-  def self.call(path, code)
-    new(path, code).tap(&:call)
-  end
-
-  def initialize(path, code)
-    self.path = path
-    self.original_code = code
-    self.patched_code = code
-  end
+    require 'forwardable'
+    extend Forwardable
 
-  def call
-    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.
-    self.changed_create_calls =
-      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 = 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_delegator :changed_create_calls, :any?, :changed?
+    def_delegator :changed_create_calls, :count, :change_count
+    def_delegator :create_calls, :count, :create_count
 
-  def ok?
-    @ok
-  end
+    def self.call(path, code)
+      new(path, code).tap(&:call)
+    end
 
-  def changed?
-    change_count > 0
-  end
+    def initialize(path, code)
+      self.path = path
+      self.original_code = code
+      self.patched_code = code
+    end
 
-  def create_count
-    create_calls.count
-  end
+    def call
+      self.create_calls = CreateCallFinder.call(code: original_code)
 
-  def change_count
-    changed_create_calls.count
-  end
+      # 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.
+      self.changed_create_calls =
+        create_calls.sort_by { |call| [-call.line, -call.column] }.select do |call|
+          build_result = try_patch(call, 'build')
+          next if build_result == ABORT
 
-  private
+          build_result == SUCCESS || try_patch(call, 'build_stubbed') == SUCCESS
+        end
 
-  attr_writer :create_calls, :changed_create_calls, :ok, :path, :original_code, :patched_code
+      # validate whole spec after changes, e.g. to detect side-effects
+      self.ok = changed_create_calls.none? || begin
+        FactorySloth.verbose && puts("Checking whole file after changes")
+        run(patched_code).success?
+      end
+      ok? || changed_create_calls.clear && patched_code.replace(original_code)
+    end
 
-  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
+    def ok?
+      @ok
     end
-  end
 
-  def with_execution_check(spec_code, line, variant)
-    spec_code + <<~RUBY
-      ; defined?(FactoryBot) && defined?(RSpec) && RSpec.configure do |config|
-        executed_lines = []
+    def message
+      stats = "#{path}: #{create_count} create calls found, #{change_count} "\
+              "#{FactorySloth.dry_run ? 'replaceable' : 'replaced'}"
 
-        FactoryBot::Syntax::Methods.class_eval do
-          alias ___original_#{variant} #{variant}
+      return "🔴 #{stats} (conflict)" unless ok?
 
-          define_method("#{variant}") do |*args, **kwargs, &blk|
-            executed_lines << caller_locations(1, 1)&.first&.lineno
-            ___original_#{variant}(*args, **kwargs, &blk)
-          end
-        end
+      if create_count == 0
+        "⚪️ #{stats}"
+      elsif change_count == 0
+        "🟡 #{stats}"
+      else
+        "🟢 #{stats}"
+      end
+    end
 
-        config.after(:suite) do
-          executed_lines.include?(#{line}) ||
-            fail("unused factory in line #{line} - will not be modified")
-        end
+    private
+
+    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)
+      FactorySloth.verbose && puts("#{link_to_call(call)}: trying #{variant} ...")
+
+      new_patched_code = patched_code.sub(
+        /\A(?:.*\R){#{call.line - 1}}.{#{call.column}}\K#{call.name}/,
+        variant
+      )
+      checked_patched_code = new_patched_code + ExecutionCheck.for(call.line, variant)
+
+      result = run(checked_patched_code, line: call.line)
+
+      if result.success?
+        info = FactorySloth.dry_run ? 'can be replaced' : 'replaced'
+        puts call_message(call, "#{info} with #{variant}"), ''
+        self.patched_code = new_patched_code
+        SUCCESS
+      elsif result.exitstatus == ExecutionCheck::FACTORY_UNUSED_CODE
+        puts call_message(call, "is never executed, skipping"), ''
+        ABORT
+      elsif result.exitstatus == ExecutionCheck::FACTORY_PERSISTED_LATER_CODE
+        FactorySloth.verbose && puts("Record is persisted later, skipping")
+        ABORT
       end
-    RUBY
+    end
+
+    def run(code, line: nil)
+      result = SpecRunner.call(path, code, line: line)
+      FactorySloth.verbose && puts('  RSpec output:', result.output.gsub(/^/, '    '))
+      result
+    end
+
+    ABORT = :ABORT # returned if there is no need to try other variants
+    SUCCESS = :SUCCESS
+
+    def call_message(call, message)
+      line_content = original_code[/\A(?:.*\R){#{call.line - 1}}\K.*/]
+      indent = line_content[/^\s*/]
+
+      "#{link_to_call(call)}: #{call.name} #{message}\n"\
+      "  #{line_content.delete_prefix(indent)}\n"\
+      "  #{' ' * (call.column - indent.size)}#{Color.yellow('^' * call.name.size)}"
+    end
+
+    def link_to_call(call)
+      # note: column from Ripper is 0-indexed, editors expect 1-indexed columns
+      Color.light_blue("#{path}:#{call.line}:#{call.column + 1}")
+    end
   end
 end

data/lib/factory_sloth/color.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FactorySloth::Color
+  extend self
+
+  def yellow(str)
+    colorize(str, 33)
+  end
+
+  def light_blue(str)
+    colorize(str, 36)
+  end
+
+  private
+
+  def colorize(str, color_code)
+    return str unless $stdout.is_a?(IO) && $stdout.tty?
+
+    "\e[#{color_code}m#{str}\e[0m"
+  end
+end

data/lib/factory_sloth/create_call.rb

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

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

@@ -0,0 +1,39 @@
+# 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.
+
+module FactorySloth::ExecutionCheck
+  FACTORY_UNUSED_CODE          = 77
+  FACTORY_PERSISTED_LATER_CODE = 78
+
+  def self.for(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/file_processor.rb

@@ -2,46 +2,30 @@ module FactorySloth
   module FileProcessor
     extend self
 
-    def call(files:, forced_files: [], dry_run: false)
+    def call(files:, forced_files: [])
       files.each_with_object({}) do |path, acc|
-        puts "Processing #{path} ..."
-
-        if DoneTracker.done?(path) && !forced_files.include?(path)
-          puts "🔵 Skipped (marked as done in #{DoneTracker.file})", ''
+        if DoneTracker.done?(path) &&
+           !(FactorySloth.force || forced_files.include?(path))
+          puts "🔵 #{path}: skipped (marked as done in #{DoneTracker.file})", ''
           next
         end
 
-        result = process(path, dry_run: dry_run)
-        acc[path] = { ok: result.ok?, changed_create_calls: result.changed_create_calls }
+        result = process(path)
+        acc[path] = { ok: result.ok?, change_count: result.change_count }
         DoneTracker.mark_as_done(path)
       end
     end
 
     private
 
-    def process(path, dry_run:)
+    def process(path)
       code = File.read(path)
       result = CodeMod.call(path, code)
-      unless dry_run
+      unless FactorySloth.dry_run
         File.write(path, result.patched_code) if result.changed?
       end
-      puts result_message(result, dry_run), ''
+      puts result.message, ''
       result
     end
-
-    def result_message(result, dry_run)
-      stats = "#{result.create_count} create calls found, "\
-              "#{result.change_count} #{dry_run ? 'replaceable' : 'replaced'}"
-
-      return "🔴 #{stats} (conflict)" unless result.ok?
-
-      if result.create_count == 0
-        "⚪️ #{stats}"
-      elsif result.change_count == 0
-        "🟡 #{stats}"
-      else
-        "🟢 #{stats}"
-      end
-    end
   end
 end

data/lib/factory_sloth/spec_runner.rb

@@ -1,13 +1,28 @@
+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, process_status = Open3.capture2(command)
+    Result.new(output: output, process_status: process_status)
+  end
+
+  Result = Struct.new(:output, :process_status, keyword_init: true) do
+    require 'forwardable'
+    extend Forwardable
+    def_delegators :process_status, :exitstatus, :success?
+  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.3.0'
 end

data/lib/factory_sloth.rb

@@ -1,10 +1,14 @@
-module FactorySloth; end
+module FactorySloth
+  singleton_class.attr_accessor :dry_run, :force, :lint, :verbose
+end
 
 require_relative 'factory_sloth/cli'
 require_relative 'factory_sloth/code_mod'
+require_relative 'factory_sloth/color'
 require_relative 'factory_sloth/create_call'
 require_relative 'factory_sloth/create_call_finder'
 require_relative 'factory_sloth/done_tracker'
+require_relative 'factory_sloth/execution_check'
 require_relative 'factory_sloth/file_processor'
 require_relative 'factory_sloth/spec_picker'
 require_relative 'factory_sloth/spec_runner'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_sloth
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -28,9 +28,11 @@ files:
 - lib/factory_sloth.rb
 - lib/factory_sloth/cli.rb
 - lib/factory_sloth/code_mod.rb
+- lib/factory_sloth/color.rb
 - lib/factory_sloth/create_call.rb
 - lib/factory_sloth/create_call_finder.rb
 - lib/factory_sloth/done_tracker.rb
+- lib/factory_sloth/execution_check.rb
 - lib/factory_sloth/file_processor.rb
 - lib/factory_sloth/spec_picker.rb
 - lib/factory_sloth/spec_runner.rb