rubocop-petal 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a53e19d1caafc491f963ad3a723fb1b06f9e15fc9d0914db50287c68af1dd6
-  data.tar.gz: c1c37cbc85d3c4e56bdd2fffa928f8ce7f16db9afa5541014275a519d75146a5
+  metadata.gz: 9f52260437fb7b62b35bc5ca331edb0d443b28b2b45ea319c3bfc0aa13561d9a
+  data.tar.gz: 7180f8ef26b11cd926c56dd7cb79117e67ebfee8afff1a1baf5ff836b3a6c047
 SHA512:
-  metadata.gz: 862c765c3e4c638372c04b441d569d25b260f0333e887cb25b76064ac82214173e4367b0225e4023b9ee4de9f804bb57b224bc524fb4beec46b9eff4bde8546d
-  data.tar.gz: 263fe7fd0120e188d681dd68f7f44533e01c32d0a71596bc064781628175c7a40f0acea5cb22ec00707a8a67917fdb1dda1ee6811fea92ebf1047887346da20a
+  metadata.gz: c7752ae4a230a0a6d270e067712f9557d75705e38638c5a1de4de6ea04c2a2109bddd90ec38b85d9f796dc4fb42757550d0f2d7a9ea2107a1a7b5b7302c5bdc1
+  data.tar.gz: 997f99882b2203079aaff70c517709ce355bbcdf2a1709a413eed9f5d5aacce47949e224f0c29377133f6a05eac2d420c18a91298037ce698a16d99e67491a1d

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,11 @@ 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
+  SafeAutoCorrect: false

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/rails/risky_activerecord_invocation.rb

@@ -5,7 +5,7 @@ module RuboCop
     module Rails
       # Disallow ActiveRecord calls that pass interpolated or added strings as an argument.
       # https://github.com/airbnb/ruby/blob/12435e8136d2adf710de999bc0f6bef01215df2c/rubocop-airbnb/lib/rubocop/cop/airbnb/risky_activerecord_invocation.rb
-      class RiskyActiverecordInvocation < Cop
+      class RiskyActiverecordInvocation < Base
         VULNERABLE_AR_METHODS = %i[
           delete_all
           destroy_all

data/lib/rubocop/cop/rspec/aggregate_examples/language.rb

@@ -6,7 +6,7 @@ module RuboCop
   module Cop
     module RSpec
       # RSpec public API methods that are commonly used in cops
-      class AggregateExamples < ::RuboCop::Cop::Cop
+      class AggregateExamples < Base
         module Language
           RSPEC = '{(const {nil? cbase} :RSpec) nil?}'
 

data/lib/rubocop/cop/rspec/aggregate_examples/line_range_helpers.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      class AggregateExamples < ::RuboCop::Cop::Cop
+      class AggregateExamples < Base
         # @internal Support methods for keeping newlines around examples.
         module LineRangeHelpers
           include RangeHelp

data/lib/rubocop/cop/rspec/aggregate_examples/matchers_with_side_effects.rb

@@ -5,7 +5,7 @@ require_relative 'language'
 module RuboCop
   module Cop
     module RSpec
-      class AggregateExamples < ::RuboCop::Cop::Cop
+      class AggregateExamples < Base
         # When aggregated, the expectations will fail when not supposed to or
         # have a risk of not failing when expected to. One example is
         # `validate_presence_of :comment` as it leaves an empty comment after

data/lib/rubocop/cop/rspec/aggregate_examples/metadata_helpers.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Cop
     module RSpec
-      class AggregateExamples < ::RuboCop::Cop::Cop
+      class AggregateExamples < Base
         # @internal
         #   Support methods for example metadata.
         #   Examples with similar metadata are grouped.

data/lib/rubocop/cop/rspec/aggregate_examples/node_matchers.rb

@@ -5,7 +5,7 @@ require_relative 'language'
 module RuboCop
   module Cop
     module RSpec
-      class AggregateExamples < ::RuboCop::Cop::Cop
+      class AggregateExamples < Base
         # @internal
         #   Node matchers and searchers.
         module NodeMatchers

data/lib/rubocop/cop/rspec/aggregate_examples.rb

@@ -109,10 +109,11 @@ module RuboCop
       #     expect(number).to be_odd
       #   end
       #
-      class AggregateExamples < ::RuboCop::Cop::Cop
+      class AggregateExamples < Base
         include LineRangeHelpers
         include MetadataHelpers
         include NodeMatchers
+        extend AutoCorrector
 
         # Methods from the following modules override and extend methods of this
         # class, extracting specific behavior.
@@ -124,25 +125,21 @@ module RuboCop
           example_group_with_several_examples(node) do |all_examples|
             example_clusters(all_examples).each_value do |examples|
               examples[1..].each do |example|
-                add_offense(example,
-                            location: :expression,
-                            message: message_for(example, examples[0]))
+                add_offense(example, message: message_for(example, examples[0])) do |corrector|
+                  clusters = example_clusters_for_autocorrect(example)
+                  autocorrect(corrector, clusters)
+                end
               end
             end
           end
         end
 
-        def autocorrect(example_node)
-          clusters = example_clusters_for_autocorrect(example_node)
-          return if clusters.empty?
-
-          lambda do |corrector|
-            clusters.each do |metadata, examples|
-              range = range_for_replace(examples)
-              replacement = aggregated_example(examples, metadata)
-              corrector.replace(range, replacement)
-              examples[1..].map { |example| drop_example(corrector, example) }
-            end
+        def autocorrect(corrector, clusters)
+          clusters.each do |metadata, examples|
+            range = range_for_replace(examples)
+            replacement = aggregated_example(examples, metadata)
+            corrector.replace(range, replacement)
+            examples[1..].map { |example| drop_example(corrector, example) }
           end
         end
 

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

@@ -25,8 +25,8 @@ module RuboCop
 
         include Helpers
 
-        MSG = 'Objects are not Sidekiq-serializable.'
-        MSG_SELF = '`self` is not Sidekiq-serializable.'
+        MSG = 'Objects are not native JSON types.'
+        MSG_SELF = '`self` is not a native JSON type.'
 
         def_node_matcher :initializer?, <<~PATTERN
           (send const :new)

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

@@ -34,7 +34,7 @@ module RuboCop
       #   # good
       #   MyWorker.perform_async(Time.now.mday)
       #
-      class DateTimeArgument < ::RuboCop::Cop::Cop
+      class DateTimeArgument < Base
         DURATION_METHODS = %i[
           second
           seconds
@@ -61,8 +61,8 @@ module RuboCop
 
         include Helpers
 
-        DURATION_MSG = 'Durations are not Sidekiq-serializable; use the integer instead.'
-        MSG = 'Date/Time objects are not Sidekiq-serializable; convert to integers or strings instead.'
+        DURATION_MSG = 'Durations are not native JSON types; use the integer instead.'
+        MSG = 'Date/Time objects are not native JSON types; convert to integers or strings instead.'
         ALLOWED_METHODS = %i[to_i to_s].freeze
 
         def_node_matcher :rational_literal?, <<~PATTERN

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

@@ -50,20 +50,49 @@ module RuboCop
           node.each_ancestor(:class, :block).detect { |anc| sidekiq_worker?(anc) }
         end
 
-        def sidekiq_arguments(node)
+        def sidekiq_arguments(node, &block)
           return [] unless node.send_type? && (method_name = sidekiq_perform?(node))
+          return enum_for(:sidekiq_arguments, node) unless block
 
           # Drop the first argument for perform_at and perform_in
-          expand_arguments(method_name == :perform_async ? node.arguments : node.arguments[1..])
+          expand_nodes(method_name == :perform_async ? node.arguments : node.arguments[1..], &block)
         end
 
-        def expand_arguments(arguments)
-          arguments.flat_map do |argument|
-            if argument.array_type? || argument.hash_type?
-              expand_arguments(argument.values)
-            else
-              argument
-            end
+        def expand_nodes(nodes, &block)
+          return enum_for(:expand_nodes, nodes) unless block
+
+          nodes.each { |node| expand_node(node, &block) }
+        end
+
+        def expand_node(node, &block)
+          return enum_for(:expand_node, node) unless block
+
+          expand_hash_array_node(node, &block) || yield(node)
+        end
+
+        def expand_hash_array_node(node, &block)
+          expand_hash_node(node, &block) || expand_array_node(node, &block)
+        end
+
+        def expand_hash_node(node, &block)
+          return unless node.hash_type?
+          return enum_for(:expand_hash_node, node) unless block
+
+          node.pairs.each do |pair_node|
+            expand_hash_array_node(pair_node.key, &block) ||
+              expand_hash_array_node(pair_node.value, &block) ||
+              yield(pair_node)
+          end
+        end
+
+        def expand_array_node(node, &block)
+          return unless node.array_type?
+          return enum_for(:expand_array_node, node) unless block
+
+          if node.square_brackets?
+            expand_nodes(node.values, &block)
+          else
+            yield node
           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/cop/sidekiq/symbol_argument.rb

@@ -14,17 +14,129 @@ module RuboCop
       #   MyWorker.perform_async(:foo)
       #
       #   # good
-      #   MyWorker.perform_async('foo')
+      #   MyWorker.perform_async("foo")
+      #
+      #   # bad
+      #   MyWorker.perform_async(%i(foo))
+      #
+      #   # good
+      #   MyWorker.perform_async(%w(foo))
+      #
+      #   # bad
+      #   MyWorker.perform_async([:foo])
+      #
+      #   # good
+      #   MyWorker.perform_async(["foo"]))
+      #
+      #   # bad
+      #   MyWorker.perform_async(foo: 1)
+      #
+      #   # good
+      #   MyWorker.perform_async('foo' => 1)
+      #
+      #   # bad
+      #   MyWorker.perform_async('foo' => :baz)
+      #
+      #   # good
+      #   MyWorker.perform_async('foo' => "baz")
+      #
+      #   # bad
+      #   MyWorker.perform_async('foo' => [:bar]
+      #
+      #   # good
+      #   MyWorker.perform_async('foo' => ["baz"])
+      #
+      #   # bad
+      #   MyWorker.perform_async('foo' => %i(baz)
+      #
+      #   # good
+      #   MyWorker.perform_async('foo' => %w(baz))
+      #
+      #   # bad
+      #   MyWorker.perform_async('foo' => { bar: %i(baz) })
+      #
+      #   # good
+      #   MyWorker.perform_async('foo' => { bar: %w(baz) })
+      #
+      #   # bad
+      #   MyWorker.perform_async('foo' => { bar: [:baz]) })
+      #
+      #   # good
+      #   MyWorker.perform_async('foo' => { bar: ["baz"] })
+      #
       class SymbolArgument < Base
+        extend AutoCorrector
+
         include Helpers
 
-        MSG = 'Symbols are not Sidekiq-serializable; use strings instead.'
+        MSG = 'Symbols are not native JSON types; use strings instead.'
 
         def on_send(node)
-          sidekiq_arguments(node).select(&:sym_type?).each do |argument|
-            add_offense(argument)
+          sidekiq_arguments(node)
+            .lazy
+            .select { |n| node_contains_symbol?(n) }
+            .each do |selected_node|
+            offense_data(selected_node) do |offense_node, replace_node, replace_value|
+              add_offense(offense_node) do |corrector|
+                corrector.replace(replace_node, replace_value)
+              end
+            end
           end
         end
+
+        private
+
+        def node_contains_symbol?(node)
+          node.sym_type? || symbol_percent_literal?(node) || pair_with_symbol?(node)
+        end
+
+        def symbol_percent_literal?(node)
+          node.array_type? && node.percent_literal?(:symbol)
+        end
+
+        def pair_with_symbol?(node)
+          node.pair_type? && (node.key.sym_type? || node.value.sym_type?)
+        end
+
+        def offense_data(node)
+          yield sym_replace_value(node) || array_replace_value(node) || pair_replace_value(node)
+        end
+
+        def sym_replace_value(node)
+          return unless node.sym_type?
+
+          [node, node, %("#{node.value}")]
+        end
+
+        def array_replace_value(node)
+          return unless node.array_type?
+
+          [node, node, "%w(#{node.values.map(&:value).join(' ')})"]
+        end
+
+        def pair_replace_value(node)
+          return unless node.pair_type?
+
+          pair_both_symbol(node) || pair_only_key_symbol(node) || pair_only_value_symbol(node)
+        end
+
+        def pair_both_symbol(node)
+          return unless node.key.sym_type? && node.value.sym_type?
+
+          [node, node, %("#{node.key.value}" => "#{node.value.value}")]
+        end
+
+        def pair_only_key_symbol(node)
+          return unless node.key.sym_type?
+
+          [node.key, node, %("#{node.key.value}" => #{node.value.source})]
+        end
+
+        def pair_only_value_symbol(node)
+          return unless node.value.sym_type?
+
+          [node.value, node.value, %("#{node.value.value}")]
+        end
       end
     end
   end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '1.4.0'
+    VERSION = '1.6.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.6.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.59'
+        version: '1.70'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.59'
+        version: '1.70'
 - !ruby/object:Gem::Dependency
   name: rubocop-factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '2.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.24'
+        version: '2.26'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.23'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.28'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.23'
+        version: '2.28'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.25'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.25'
+        version: '3.3'
 description:
 email:
 - jfbastien@petalmd.com
@@ -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