Support filter in Rails/CompactBlank

rubocop · Sep 9, 2024 · 8622e08 · 8622e08
1 parent cbb7257
commit 8622e08
Show file tree

Hide file tree

Showing 3 changed files with 68 additions and 4 deletions.
diff --git a/changelog/change_support_filter_in_rails_compact_blank.md b/changelog/change_support_filter_in_rails_compact_blank.md
@@ -0,0 +1 @@
+* [#1358](https://github.com/rubocop/rubocop-rails/pull/1358): Support `filter` in `Rails/CompactBlank`. ([@masato-bkn][])
diff --git a/lib/rubocop/cop/rails/compact_blank.rb b/lib/rubocop/cop/rails/compact_blank.rb
@@ -25,6 +25,8 @@ module Rails
       #   collection.reject { |_k, v| v.blank? }
       #   collection.select(&:present?)
       #   collection.select { |_k, v| v.present? }
+      #   collection.filter(&:present?)
+      #   collection.filter { |_k, v| v.present? }
       #
       #   # good
       #   collection.compact_blank
@@ -44,7 +46,7 @@ class CompactBlank < Base
         extend TargetRailsVersion
 
         MSG = 'Use `%<preferred_method>s` instead.'
-        RESTRICT_ON_SEND = %i[reject delete_if select keep_if].freeze
+        RESTRICT_ON_SEND = %i[reject delete_if select filter keep_if].freeze
 
         minimum_target_rails_version 6.1
 
@@ -64,14 +66,14 @@ class CompactBlank < Base
 
         def_node_matcher :select_with_block?, <<~PATTERN
           (block
-            (send _ {:select :keep_if})
+            (send _ {:select :filter :keep_if})
             $(args ...)
             (send
               $(lvar _) :present?))
         PATTERN
 
         def_node_matcher :select_with_block_pass?, <<~PATTERN
-          (send _ {:select :keep_if}
+          (send _ {:select :filter :keep_if}
             (block-pass
               (sym :present?)))
         PATTERN
@@ -120,7 +122,11 @@ def offense_range(node)
         end
 
         def preferred_method(node)
-          node.method?(:reject) || node.method?(:select) ? 'compact_blank' : 'compact_blank!'
+          if %i[reject select filter].include?(node.method_name)
+            'compact_blank'
+          else
+            'compact_blank!'
+          end
         end
       end
     end

diff --git a/spec/rubocop/cop/rails/compact_blank_spec.rb b/spec/rubocop/cop/rails/compact_blank_spec.rb
@@ -124,6 +124,39 @@
       RUBY
     end
 
+    it 'registers and corrects an offense when using `filter { |e| e.present? }`' do
+      expect_offense(<<~RUBY)
+        collection.filter { |e| e.present? }
+                   ^^^^^^^^^^^^^^^^^^^^^^^^^ Use `compact_blank` instead.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        collection.compact_blank
+      RUBY
+    end
+
+    it 'registers and corrects an offense when using `filter(&:present?)`' do
+      expect_offense(<<~RUBY)
+        collection.filter(&:present?)
+                   ^^^^^^^^^^^^^^^^^^ Use `compact_blank` instead.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        collection.compact_blank
+      RUBY
+    end
+
+    it 'registers and corrects an offense when using `filter { |k, v| v.present? }`' do
+      expect_offense(<<~RUBY)
+        collection.filter { |k, v| v.present? }
+                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `compact_blank` instead.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        collection.compact_blank
+      RUBY
+    end
+
     it 'registers and corrects an offense when using `keep_if { |e| e.present? }`' do
       expect_offense(<<~RUBY)
         collection.keep_if { |e| e.present? }
@@ -169,6 +202,18 @@
       RUBY
     end
 
+    it 'does not register an offense when using `filter! { |e| e.present? }`' do
+      expect_no_offenses(<<~RUBY)
+        collection.filter! { |e| e.present? }
+      RUBY
+    end
+
+    it 'does not register an offense when using `filter!(&:present?)`' do
+      expect_no_offenses(<<~RUBY)
+        collection.filter!(&:present?)
+      RUBY
+    end
+
     it 'does not register an offense when using `compact_blank`' do
       expect_no_offenses(<<~RUBY)
         collection.compact_blank
@@ -206,6 +251,12 @@ def foo(arg)
         collection.select { |e| e.blank? }
       RUBY
     end
+
+    it 'does not register an offense when using `filter { |e| e.blank? }`' do
+      expect_no_offenses(<<~RUBY)
+        collection.filter { |e| e.blank? }
+      RUBY
+    end
   end
 
   context 'Rails <= 6.0', :rails60 do
@@ -226,5 +277,11 @@ def foo(arg)
         collection.select { |e| e.present? }
       RUBY
     end
+
+    it 'does not register an offense when using `filter { |e| e.present? }`' do
+      expect_no_offenses(<<~RUBY)
+        collection.filter { |e| e.present? }
+      RUBY
+    end
   end
 end