factory_sloth 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9032b54abec61f25adcfd938a503f312017667f64b4aa1f303ede50a346a62be
-  data.tar.gz: 901d358d3572a708ec8190c2d2e59dbdab3bce42f894301284dc285895d48f19
+  metadata.gz: 1ca25fc42535f24034b3a52ddb2b88d9e64dbd68b83e2febb7ddb31679daa118
+  data.tar.gz: 92814709e951c1dc15040496ec1c5dea101f2bdcb8d58eb1298182a91a2df2f1
 SHA512:
-  metadata.gz: b1aa29c8c7dd007c5e82ee4cfbc164df1550ace4c2d7880e0471b4a892a2dad33a8e03469c56ec5620f99e7c2dc8c6c47f0d7256102910385acea9a3f97f4b74
-  data.tar.gz: bace623884d7e447200af29fb216f8814f86a7bae4deda093105bb9df716c8151332136a473c31cd6c9e51bc07ded9f2306e9eda29b536b7b4aa130384f0059a
+  metadata.gz: 188f7f29920ba9f868171c65c21e7e4611e8c8c9cf41eb229e3f1a17fb98c6c970a491051fac6b501b5544b4298cef22f42335e8306e93370225c9acedfe8182
+  data.tar.gz: dbc6452a523efb648d0f2d71594d883c469194164b86a8f2f16ece21a171e8d82bd2a8260072e777b731b1001ad9f0eb0c5f51ce1610ebf3f8cc67b7d19e4471

data/CHANGELOG.md

@@ -1,11 +1,17 @@
 ## [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
+- Nicer output
+- Verbose mode
 
 ## [1.2.2] - 2023-05-18
 

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/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.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_sloth
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Janosch Müller
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email: