factory_sloth 1.2.2 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c628e26d703d50de9a6f087174d01132942eb557ccbb4519a173116922cb2541
-  data.tar.gz: 40c2d6873fb446d5a8dbba7339ebc481e766989ff722531e24d891213bac3434
+  metadata.gz: 1ca25fc42535f24034b3a52ddb2b88d9e64dbd68b83e2febb7ddb31679daa118
+  data.tar.gz: 92814709e951c1dc15040496ec1c5dea101f2bdcb8d58eb1298182a91a2df2f1
 SHA512:
-  metadata.gz: aa04cdbe7e3bf0fe25b9754f6fa5d356db63c4cf18ef193c5a0b11ae8629c36cd3e39ffda5fa71e47cf1ddef16b0dc4b84564c87cc6e493169150bbe35aeccd3
-  data.tar.gz: 8bfc7521d09398337217f0ed04adccda7380f653efd46c2c0d39858082d7d949996142b5bf074eaab36524b3df197a29875b72bd21a8b7a326886303cbd1d9fa
+  metadata.gz: 188f7f29920ba9f868171c65c21e7e4611e8c8c9cf41eb229e3f1a17fb98c6c970a491051fac6b501b5544b4298cef22f42335e8306e93370225c9acedfe8182
+  data.tar.gz: dbc6452a523efb648d0f2d71594d883c469194164b86a8f2f16ece21a171e8d82bd2a8260072e777b731b1001ad9f0eb0c5f51ce1610ebf3f8cc67b7d19e4471

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [1.3.1] - 2023-05-24
+
+### Fixed
+
+- Stop trying to patch lines with multiple create calls, which was unreliable
+
+## [1.3.0] - 2023-05-22
+
+### Added
+
+- Nicer output
+- Verbose mode
+
 ## [1.2.2] - 2023-05-18
 
 ### 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_list in line 4 can be replaced with build_list
-🟢 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
 ```

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,116 +1,132 @@
-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
+    require 'forwardable'
+    extend Forwardable
 
-  def initialize(path, code)
-    self.path = path
-    self.original_code = code
-    self.patched_code = code
-  end
+    def_delegator :changed_create_calls, :any?, :changed?
+    def_delegator :changed_create_calls, :count, :change_count
+    def_delegator :create_calls, :count, :create_count
 
-  def call
-    self.create_calls = FactorySloth::CreateCallFinder.call(code: original_code)
+    def self.call(path, code)
+      new(path, code).tap(&:call)
+    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
+    def initialize(path, code)
+      self.path = path
+      self.original_code = code
+      self.patched_code = code
+    end
 
-        build_result == SUCCESS || try_patch(call, 'build_stubbed') == SUCCESS
-      end
+    def call
+      self.create_calls = CreateCallFinder.call(code: original_code)
 
-    # validate whole spec after changes, e.g. to detect side-effects
-    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
+      self.changed_create_calls = find_changeable_create_calls
 
-  def ok?
-    @ok
-  end
+      # 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 changed?
-    change_count > 0
-  end
+    def ok?
+      @ok
+    end
 
-  def create_count
-    create_calls.count
-  end
+    def message
+      stats = "#{path}: #{create_count} create calls found, #{change_count} "\
+              "#{FactorySloth.dry_run ? 'replaceable' : 'replaced'}"
 
-  def change_count
-    changed_create_calls.count
-  end
+      return "🔴 #{stats} (conflict)" unless ok?
 
-  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)
-    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)
-
-    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
+      if create_count == 0
+        "⚪️ #{stats}"
+      elsif change_count == 0
+        "🟡 #{stats}"
+      else
+        "🟢 #{stats}"
+      end
     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
+    private
+
+    attr_writer :create_calls, :changed_create_calls, :ok, :path, :original_code, :patched_code
 
-        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})
+    # 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.
+    def find_changeable_create_calls
+      lines = create_calls.map(&:line)
+
+      self.changed_create_calls =
+        create_calls.sort_by { |call| [-call.line, -call.column] }.select do |call|
+          if lines.count(call.line) > 1
+            print_call_info(call, 'multiple create calls per line are unsupported, skipping')
+            next
           end
+
+          build_result = try_patch(call, 'build')
+          next if build_result == ABORT
+
+          build_result == SUCCESS || try_patch(call, 'build_stubbed') == SUCCESS
         end
+    end
+
+    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'
+        print_call_info(call, "#{info} with #{variant}")
+        self.patched_code = new_patched_code
+        SUCCESS
+      elsif result.exitstatus == ExecutionCheck::FACTORY_UNUSED_CODE
+        print_call_info(call, "is never executed, skipping")
+        ABORT
+      elsif result.exitstatus == ExecutionCheck::FACTORY_PERSISTED_LATER_CODE
+        FactorySloth.verbose && print_call_info("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 print_call_info(call, message)
+      line_content = original_code[/\A(?:.*\R){#{call.line - 1}}\K.*/]
+      indentation = line_content[/^\s*/]
+      underline = Color.yellow('^' * call.name.size)
+
+      puts(
+        "#{link_to_call(call)}: #{call.name} #{message}",
+        "  #{line_content.delete_prefix(indentation)}",
+        "  #{' ' * (call.column - indentation.size)}#{underline}",
+        "",
+      )
+    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,25 @@
+# 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 tty?
+
+    "\e[#{color_code}m#{str}\e[0m"
+  end
+
+  def tty?
+    $stdout.is_a?(IO) && $stdout.tty?
+  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/execution_check.rb

@@ -0,0 +1,43 @@
+# 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.
+#
+# Note: the caller column is only available in a roundabout way in Ruby >= 3.1,
+# https://bugs.ruby-lang.org/issues/17930, 19452, so multiple replacements
+# in one line would not be validated correctly iff they had mixed validity.
+
+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
+          original_variant = instance_method("#{variant}") # e.g. build
+
+          define_method("#{variant}") do |*args, **kwargs, &blk|
+            result = original_variant.bind_call(self, *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

@@ -8,8 +8,14 @@ module FactorySloth::SpecRunner
     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
+    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

data/lib/factory_sloth/version.rb

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