factory_sloth 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9032b54abec61f25adcfd938a503f312017667f64b4aa1f303ede50a346a62be
-  data.tar.gz: 901d358d3572a708ec8190c2d2e59dbdab3bce42f894301284dc285895d48f19
+  metadata.gz: c9c56ba87b89aec371bdf53b61c50c66a0f0c51b8ba75c4edc12245967face48
+  data.tar.gz: f1ead7cb06982fd34eedde94bc017dfb5612c744266d9e76fa014864fdaccc7c
 SHA512:
-  metadata.gz: b1aa29c8c7dd007c5e82ee4cfbc164df1550ace4c2d7880e0471b4a892a2dad33a8e03469c56ec5620f99e7c2dc8c6c47f0d7256102910385acea9a3f97f4b74
-  data.tar.gz: bace623884d7e447200af29fb216f8814f86a7bae4deda093105bb9df716c8151332136a473c31cd6c9e51bc07ded9f2306e9eda29b536b7b4aa130384f0059a
+  metadata.gz: 1016ee245df8b06fb396f12806004c6ea63f88944b3286723623906dca43be42a5b39dae87db377f9616f35f6b5b3bea2d080eaa0818a14f429f110c388c9a4f
+  data.tar.gz: 96c402e4c4a287e69cb641ccf281365da5ea4f64f6d1092534483b9971d93fd0196bcb22c870516b3df5b88eaabe9097ae2a12758acc28f7616b2615e56935f6

data/CHANGELOG.md

@@ -1,11 +1,23 @@
 ## [Unreleased]
 
+### Added
+
+## [1.4.0] - 2024-10-04
+
+- ignore underscore-prefixed assignments e.g. `_user = create(:user)`
+
+## [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
+- Nicer output
+- Verbose mode
 
 ## [1.2.2] - 2023-05-18
 

data/README.md

@@ -27,6 +27,7 @@ Examples:
 Options:
     -f, --force                      Ignore ./.factory_sloth_done
     -l, --lint                       Dont fix, just list bad create calls
+    -u, --underscore                 Check underscore-prefixed variables
     -V, --verbose                    Verbose output, useful for debugging
     -v, --version                    Show gem version
     -h, --help                       Show this help
@@ -80,6 +81,16 @@ 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 :)
 
+### Underscore-prefixed variable names
+
+Prefixing a variable name with an underscore is a common way of saying "I am creating this for side effects":
+
+```ruby
+_user = create(:user)
+```
+
+Therefore `factory_sloth` ignores such cases by default. Use the `-u` flag to check such cases as well.
+
 ## 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

@@ -36,6 +36,10 @@ module FactorySloth
           FactorySloth.lint = true
         end
 
+        opts.on('-u', '--underscore', 'Check underscore-prefixed variables') do
+          FactorySloth.check_underscore_vars = true
+        end
+
         opts.on('-V', '--verbose', 'Verbose output, useful for debugging') do
           FactorySloth.verbose = true
         end

data/lib/factory_sloth/code_mod.rb

@@ -22,17 +22,7 @@ module FactorySloth
     def call
       self.create_calls = 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 do |call|
-          build_result = try_patch(call, 'build')
-          next if build_result == ABORT
-
-          build_result == SUCCESS || try_patch(call, 'build_stubbed') == SUCCESS
-        end
+      self.changed_create_calls = find_changeable_create_calls
 
       # validate whole spec after changes, e.g. to detect side-effects
       self.ok = changed_create_calls.none? || begin
@@ -65,6 +55,27 @@ module FactorySloth
 
     attr_writer :create_calls, :changed_create_calls, :ok, :path, :original_code, :patched_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} ...")
@@ -79,14 +90,14 @@ module FactorySloth
 
       if result.success?
         info = FactorySloth.dry_run ? 'can be replaced' : 'replaced'
-        puts call_message(call, "#{info} with #{variant}"), ''
+        print_call_info(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"), ''
+        print_call_info(call, "is never executed, skipping")
         ABORT
       elsif result.exitstatus == ExecutionCheck::FACTORY_PERSISTED_LATER_CODE
-        FactorySloth.verbose && puts("Record is persisted later, skipping")
+        FactorySloth.verbose && print_call_info("record is persisted later, skipping")
         ABORT
       end
     end
@@ -100,13 +111,17 @@ module FactorySloth
     ABORT = :ABORT # returned if there is no need to try other variants
     SUCCESS = :SUCCESS
 
-    def call_message(call, message)
+    def print_call_info(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)}"
+      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)

data/lib/factory_sloth/color.rb

@@ -14,8 +14,12 @@ module FactorySloth::Color
   private
 
   def colorize(str, color_code)
-    return str unless $stdout.is_a?(IO) && $stdout.tty?
+    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_finder.rb

@@ -17,19 +17,32 @@ class FactorySloth::CreateCallFinder < Ripper
 
   def store_call(obj)
     @calls << obj if obj.is_a?(FactorySloth::CreateCall) && !@disabled
+    obj
   end
 
   def on_ident(name, *)
-    %w[create create_list create_pair].include?(name) &&
-      FactorySloth::CreateCall.new(name: name, line: lineno, column: column)
+    return name unless %w[create create_list create_pair].include?(name)
+
+    FactorySloth::CreateCall.new(name: name, line: lineno, column: column)
+  end
+
+  def on_assign(left, right)
+    if left.to_s.match?(/\A_/) &&
+       !FactorySloth.check_underscore_vars &&
+       [right, Array(right).last].any? { |v| v.is_a?(FactorySloth::CreateCall) }
+      @calls.pop
+    end
+    [left, right]
   end
 
-  def on_call(mod, _, obj, *)
-    store_call(obj) if mod == 'FactoryBot'
+  def on_call(mod, op, method, *args)
+    store_call(method) if mod == 'FactoryBot'
+    [mod, op, method, *args]
   end
 
-  def on_command_call(mod, _, obj, *)
-    store_call(obj) if mod == 'FactoryBot'
+  def on_command_call(mod, op, method, *args)
+    store_call(method) if mod == 'FactoryBot'
+    [mod, op, method, *args]
   end
 
   def on_comment(text, *)

data/lib/factory_sloth/execution_check.rb

@@ -4,6 +4,10 @@
 # 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
@@ -15,10 +19,10 @@ module FactorySloth::ExecutionCheck
         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
+          original_variant = instance_method("#{variant}") # e.g. build
 
-          define_method("#{variant}") do |*args, **kwargs, &blk| # e.g. build
-            result = ___original_#{variant}(*args, **kwargs, &blk)
+          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

data/lib/factory_sloth/version.rb

@@ -1,3 +1,3 @@
 module FactorySloth
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/lib/factory_sloth.rb

@@ -1,5 +1,11 @@
 module FactorySloth
-  singleton_class.attr_accessor :dry_run, :force, :lint, :verbose
+  singleton_class.attr_accessor(*%i[
+    check_underscore_vars
+    dry_run
+    force
+    lint
+    verbose
+  ])
 end
 
 require_relative 'factory_sloth/cli'

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_sloth
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Janosch Müller
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - janosch84@gmail.com
 executables:
@@ -44,7 +42,6 @@ metadata:
   homepage_uri: https://github.com/jaynetics/factory_sloth
   source_code_uri: https://github.com/jaynetics/factory_sloth
   changelog_uri: https://github.com/jaynetics/factory_sloth/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -59,8 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: Find and replace unnecessary factory_bot create calls.
 test_files: []