Merge pull request #1549 from viralpraxis/fix-rails-inverse-of-cop-false-positives-when-using-dynamic-association-options

Fix `Rails/InverseOf` cop false positives when using dynamic assoc options

Author: koic

changelog/fix_rails_inverse_of_cop_false_positives_when_using_dynamic_association_options.md

@@ -0,0 +1 @@
+* [#1549](https://github.com/rubocop/rubocop-rails/pull/1549): Fix `Rails/InverseOf` cop false positives when using dynamic association options. ([@viralpraxis][])

lib/rubocop/cop/rails/inverse_of.rb

@@ -178,6 +178,7 @@ class InverseOf < Base
           (pair (sym :inverse_of) nil)
         PATTERN
 
+        # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def on_send(node)
           recv, arguments = association_recv_arguments(node)
           return unless arguments
@@ -192,9 +193,11 @@ def on_send(node)
           return unless scope?(arguments) || options_requiring_inverse_of?(options)
 
           return if options_contain_inverse_of?(options)
+          return if dynamic_options?(options) && options.none? { |opt| inverse_of_nil_option?(opt) }
 
           add_offense(node.loc.selector, message: message(options))
         end
+        # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         def scope?(arguments)
           !ignore_scopes? && arguments.any?(&:block_type?)
@@ -216,6 +219,10 @@ def options_ignoring_inverse_of?(options)
           end
         end
 
+        def dynamic_options?(options)
+          options.any? { |option| option&.kwsplat_type? }
+        end
+
         def options_contain_inverse_of?(options)
           options.any? { |opt| inverse_of_option?(opt) }
         end

spec/rubocop/cop/rails/inverse_of_spec.rb

@@ -24,6 +24,17 @@ class Person
       RUBY
     end
 
+    it 'registers an offense when specifying `inverse_of: nil` with dynamic options' do
+      expect_offense(<<~RUBY)
+        class Person
+          def define_association(**options)
+            has_many :foo, -> () { where(bar: true) }, inverse_of: nil, **options
+            ^^^^^^^^ You specified `inverse_of: nil`, you probably meant to use `inverse_of: false`.
+          end
+        end
+      RUBY
+    end
+
     context 'when `IgnoreScopes: true`' do
       let(:cop_config) do
         { 'IgnoreScopes' => true }
@@ -70,6 +81,16 @@ class Person
         end
       RUBY
     end
+
+    it 'does not register an offense with dynamic options' do
+      expect_no_offenses(<<~RUBY)
+        class Person
+          def define_association(**options)
+            has_many :foo, conditions: -> { where(bar: true) }, **options
+          end
+        end
+      RUBY
+    end
   end
 
   context 'with scope and options' do
@@ -82,6 +103,16 @@ class Person
       RUBY
     end
 
+    it 'does not register an offense with dynamic options' do
+      expect_no_offenses(<<~RUBY)
+        class Person
+          def define_association(**options)
+            has_many(:foo, -> { group 'x' }, dependent: :destroy, **options)
+          end
+        end
+      RUBY
+    end
+
     it 'does not register an offense when specifying `:inverse_of`' do
       expect_no_offenses("has_many :foo, -> { group 'x' }, dependent: :destroy, inverse_of: :baz")
     end