factory_sloth 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ca25fc42535f24034b3a52ddb2b88d9e64dbd68b83e2febb7ddb31679daa118
-  data.tar.gz: 92814709e951c1dc15040496ec1c5dea101f2bdcb8d58eb1298182a91a2df2f1
+  metadata.gz: c9c56ba87b89aec371bdf53b61c50c66a0f0c51b8ba75c4edc12245967face48
+  data.tar.gz: f1ead7cb06982fd34eedde94bc017dfb5612c744266d9e76fa014864fdaccc7c
 SHA512:
-  metadata.gz: 188f7f29920ba9f868171c65c21e7e4611e8c8c9cf41eb229e3f1a17fb98c6c970a491051fac6b501b5544b4298cef22f42335e8306e93370225c9acedfe8182
-  data.tar.gz: dbc6452a523efb648d0f2d71594d883c469194164b86a8f2f16ece21a171e8d82bd2a8260072e777b731b1001ad9f0eb0c5f51ce1610ebf3f8cc67b7d19e4471
+  metadata.gz: 1016ee245df8b06fb396f12806004c6ea63f88944b3286723623906dca43be42a5b39dae87db377f9616f35f6b5b3bea2d080eaa0818a14f429f110c388c9a4f
+  data.tar.gz: 96c402e4c4a287e69cb641ccf281365da5ea4f64f6d1092534483b9971d93fd0196bcb22c870516b3df5b88eaabe9097ae2a12758acc28f7616b2615e56935f6

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+### Added
+
+## [1.4.0] - 2024-10-04
+
+- ignore underscore-prefixed assignments e.g. `_user = create(:user)`
+
 ## [1.3.1] - 2023-05-24
 
 ### 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
+    -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/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/version.rb

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