rubocop-petal 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a53e19d1caafc491f963ad3a723fb1b06f9e15fc9d0914db50287c68af1dd6
-  data.tar.gz: c1c37cbc85d3c4e56bdd2fffa928f8ce7f16db9afa5541014275a519d75146a5
+  metadata.gz: cdc12661793d2fbaa5d5634b86c23eb3e249a884ec4902406d66d969565fccd7
+  data.tar.gz: 8b1b59059300e38b056fab5b4c1d342ae3bf61dcd0db1204f140586c15dc889a
 SHA512:
-  metadata.gz: 862c765c3e4c638372c04b441d569d25b260f0333e887cb25b76064ac82214173e4367b0225e4023b9ee4de9f804bb57b224bc524fb4beec46b9eff4bde8546d
-  data.tar.gz: 263fe7fd0120e188d681dd68f7f44533e01c32d0a71596bc064781628175c7a40f0acea5cb22ec00707a8a67917fdb1dda1ee6811fea92ebf1047887346da20a
+  metadata.gz: 5c1494de93b6053ecac07431001234072212e9f62f9130b3dcc6ccefd3218cb3b454e5ace6de2c1e0d6d6aa91adf651d5454ebcfbca346b707579d45e855e77f
+  data.tar.gz: adb3d03f9419b9629ae7db9b7b1b4e811ce9d27a6a3b209f6ad6feaa4ca7edce47da7c698d3e9074cf25c3d452f022a2abebf0c80bb9b1b9764178614a571133

data/config/default.yml

@@ -4,6 +4,10 @@ Chewy/FieldType:
   Include:
     - app/chewy/**/*
 
+Chewy/UpdateIndexArgument:
+  Description: 'Prevent single expression in update_index block.'
+  Enabled: true
+
 Grape/PreferNamespace:
   Description: 'Prevent usage of namespace aliases.'
   Enabled: true
@@ -146,6 +150,10 @@ Sidekiq/NoNilReturn:
   Include:
     - app/workers/**/*
 
+Sidekiq/PerformInline:
+  Description: 'Suggest to use `perform_inline` instead of `new.perform` for Sidekiq workers.'
+  Enabled: true
+
 Sidekiq/SymbolArgument:
   Description: "Prevent passing keywords arguments in worker's perform method"
   Enabled: true

data/lib/rubocop/cop/chewy/update_index_argument.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Chewy
+      # This cop checks for the use of block with single expression in `update_index` method
+      # and suggests to use method symbol as second argument instead of block.
+      #
+      # # bad
+      # update_index('index_name') { self }
+      #
+      # # good
+      # update_index('index_name', :self)
+      #
+      class UpdateIndexArgument < Base
+        extend AutoCorrector
+
+        MSG = 'Use method symbol as second argument instead of block.'
+
+        RESTRICT_ON_SEND = %i[update_index].freeze
+
+        # @!method block_with_single_expression?(node)
+        def_node_matcher :block_with_single_expression?, <<~PATTERN
+          (block
+            (send nil? :update_index (str _) $...)
+            (args)
+            $...)
+        PATTERN
+
+        def on_block(node)
+          block_with_single_expression?(node) do |existing_args, method_name|
+            return if method_name.last.children.compact.size > 1
+
+            method_name = method_name.first.source
+            add_offense(node.loc.expression) do |corrector|
+              corrector.replace(node.loc.expression, corrected_code(node, existing_args, method_name))
+            end
+          end
+        end
+
+        private
+
+        def corrected_code(node, existing_args, method_name)
+          method_call = node.children[0]
+          index_name = method_call.children[2].source
+
+          if existing_args.any?
+            "update_index(#{index_name}, :#{method_name}, #{existing_args.map(&:source).join(', ')})"
+          else
+            "update_index(#{index_name}, :#{method_name})"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sidekiq/perform_inline.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sidekiq
+      # Suggest to use `perform_inline` instead of `new.perform` for Sidekiq workers.
+      #
+      # @bad
+      #   MyWorker.new.perform
+      #
+      # @good
+      #   MyWorker.perform_inline
+      #
+      class PerformInline < Base
+        extend AutoCorrector
+        MSG = 'Use `perform_inline` instead of `new.perform`'
+
+        RESTRICT_ON_SEND = %i[perform].freeze
+
+        # @!method new_perform?(node)
+        def_node_matcher :new_perform?, <<~PATTERN
+          (send (send _ :new) :perform ...)
+        PATTERN
+
+        def on_send(node)
+          return unless new_perform?(node)
+
+          new_perform_node = node.source_range.with(
+            begin_pos: node.receiver.receiver.source_range.end_pos + 1,
+            end_pos: node.loc.selector.end_pos
+          )
+
+          add_offense(new_perform_node) do |corrector|
+            corrector.replace(new_perform_node, 'perform_inline')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '1.4.0'
+    VERSION = '1.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -96,6 +96,7 @@ files:
 - lib/rubocop-petal.rb
 - lib/rubocop/cop/chewy/field_type.rb
 - lib/rubocop/cop/chewy/reset_on_type.rb
+- lib/rubocop/cop/chewy/update_index_argument.rb
 - lib/rubocop/cop/grape/helpers_include_module.rb
 - lib/rubocop/cop/grape/prefer_namespace.rb
 - lib/rubocop/cop/grape/unnecessary_namespace.rb
@@ -126,6 +127,7 @@ files:
 - lib/rubocop/cop/sidekiq/helpers.rb
 - lib/rubocop/cop/sidekiq/keyword_arguments.rb
 - lib/rubocop/cop/sidekiq/no_nil_return.rb
+- lib/rubocop/cop/sidekiq/perform_inline.rb
 - lib/rubocop/cop/sidekiq/symbol_argument.rb
 - lib/rubocop/petal.rb
 - lib/rubocop/petal/inject.rb