rubocop-petal 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8569e249e175a6a16fbfd1b097654b83327dde914826987a0faaae4f418688c9
-  data.tar.gz: 91eb5f11e7e5bfe69b9395f8d79674d5aeaa986cf69ac8d684ccbdd1c954b3a7
+  metadata.gz: 308ace8925b50301e05d8fec4a5a94846dbe2b6161196ef71555add216dbc177
+  data.tar.gz: 0dde2a25fde7f35d5d75346cb7cdb825fc451dbddba99056fb1c79782d575433
 SHA512:
-  metadata.gz: 2b7d7797b3774dc52bb4643ed871ed08e570b19298c32c733f0265d7bd257709ff425c632f9889078a4f3cd9b1f71a3cb6479cb5b26197915490640e5ed3b9b7
-  data.tar.gz: 633e71440f3ba8513d388da6aed6c9a63986fdf262d990e4434054a0b56b836338cb6ddbd9fa075165dc04d6e4ee9cc041b944e7940bb8c1cf7d9c3395f04f66
+  metadata.gz: dde8a2affe791c2ba4903e5d5a5c0360b477b4ef06668920d8d04eeb106526ccb9d79fc1bf3b8f992a03af80671ccab3d41a51518fee680e61556ae2a590f9a8
+  data.tar.gz: d636067ac2f064154c751c316ca7dc345a5ead4df64de07cc9948de8feb32da5d648ce4727cb0608ae70e70232e0444c39e45c7e52987d19709bb797c3795aea

data/config/default.yml

@@ -1,3 +1,9 @@
+Chewy/FieldType:
+  Description: 'Assure that a type is defined for a Chewy field.'
+  Enabled: true
+  Include:
+    - app/chewy/**/*
+
 Grape/PreferNamespace:
   Description: 'Prevent usage of namespace aliases.'
   Enabled: true
@@ -29,6 +35,12 @@ Migration/SchemaStatementsMethods:
   Include:
     - db/migrate/**
 
+Migration/StandaloneAddReference:
+  Description: 'Prevent using `add_reference/belongs_to` outside of a change_table.'
+  Enabled: true
+  Include:
+    - db/migrate/**
+
 RSpec/AuthenticatedAs:
   Description: 'Suggest to use authenticated_as instead of legacy api_key.'
   Enabled: true
@@ -68,6 +80,11 @@ Grape/UnnecessaryNamespace:
   Include:
     - app/api/**/*
 
+Rails/DestroyAllBang:
+  Description: 'Prevent using `destroy_all` in favor of `each(&:destroy!)` to go along Rails/SaveBang cop.'
+  StyleGuide: https://rails.rubystyle.guide#save-bang
+  Enabled: true
+
 Rails/EnumPrefix:
   Description: 'Set prefix options when using enums.'
   Enabled: true
@@ -75,6 +92,13 @@ Rails/EnumPrefix:
   Include:
     - app/models/**/*
 
+Rails/EnumStartingValue:
+  Description: 'Prevent starting from zero with an enum.'
+  Enabled: true
+  StyleGuide: https://github.com/petalmd/rubocop-petal/issues/56
+  Include:
+    - app/models/**/*
+
 Rails/RiskyActiverecordInvocation:
   Description: 'Interpolation, use hash or parameterized syntax.'
   Enabled: true
@@ -93,3 +117,7 @@ RSpec/JsonResponse:
 Performance/Snif:
   Description: 'Prevent snif in favor of detect'
   Enabled: true
+
+Sidekiq/NoNilReturn:
+  Description: 'Prevent early nil return in workers'
+  Enabled: false

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Chewy
+      # This cop force to specify a type for Chewy field
+      #
+      #   # bad
+      #   field :name
+      #
+      #   # good
+      #   field :name, type: 'text'
+      class FieldType < Base
+        MSG = 'Specify a `type` for Chewy field.'
+
+        RESTRICT_ON_SEND = %i[field].freeze
+
+        # @!method options_has_field?(node)
+        def_node_matcher :options_has_field?, <<~PATTERN
+          (send nil? :field (sym _)+ (hash <(pair (sym :type) {str sym}) ...>))
+        PATTERN
+
+        def on_send(node)
+          return if options_has_field?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/migration/change_table_references.rb

@@ -21,22 +21,23 @@ module RuboCop
       #     t.foreign_key :users, column: :user_id
       #   end
       class ChangeTableReferences < Base
-        MSG = 'Use a combination of `t.bigint`, `t.index` and `t.foreign_key` in a change_table.'
+        MSG = 'Use a combination of `t.bigint`, `t.index` and `t.foreign_key` in a change_table to add a reference.' \
+              'Or `t.remove_foreign_key`, `t.remove` to remove a reference.'
 
         # @!method add_references_in_block?(node)
-        def_node_search :add_references_in_block?, <<~PATTERN
-          (send lvar /references|belongs_to/ ...)
+        def_node_matcher :add_references_in_block?, <<~PATTERN
+          (send lvar /references|belongs_to|remove_references|remove_belongs_to/ ...)
         PATTERN
 
         # @!method change_table?(node)
-        def_node_search :change_table?, <<~PATTERN
-          (send nil? :change_table ...)
+        def_node_matcher :change_table?, <<~PATTERN
+          (block (send nil? :change_table ...) ...)
         PATTERN
 
         def on_block(node)
           return unless change_table?(node)
 
-          references_node = node.children.detect { |n| add_references_in_block?(n) }
+          references_node = node.child_nodes[2].each_node.detect { |n| add_references_in_block?(n) }
           return unless references_node
 
           arguments = references_node.child_nodes[1]

data/lib/rubocop/cop/migration/standalone_add_reference.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Prevent using `add_reference` and `remove_reference` outside of
+      # a `change_table` block. `add_reference` create multiples `ALTER TABLE`
+      # statements. Using `change_table` with `bulk: true` is more efficient.
+      #
+      #  # bad
+      #  add_reference :products, :user, foreign_key: true
+      #
+      #  # good
+      #  change_table :products, bulk: true do |t|
+      #    t.bigint :user_id, null: false
+      #    t.index :user_id
+      #    t.foreign_key :users, column: :user_id
+      #  end
+      class StandaloneAddReference < Base
+        MSG = 'Modifying references must be done in a change_table block.'
+
+        RESTRICT_ON_SEND = %i[add_reference add_belongs_to remove_reference remove_belongs_to].freeze
+
+        def on_send(node)
+          reference_method = node.source_range.with(end_pos: node.child_nodes.first.source_range.begin_pos - 1)
+
+          add_offense(reference_method)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/destroy_all_bang.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Cop to enforce the use of `each(&:destroy!)` over `destroy_all`.
+      # https://docs.rubocop.org/rubocop-rails/cops_rails.html#railssavebang
+      # https://github.com/rails/rails/pull/37782
+      # https://discuss.rubyonrails.org/t/proposal-add-destroy-all-method-to-activerecord-relation/80959
+      #
+      #   # bad
+      #   User.destroy_all
+      #
+      #   # good
+      #   User.each(&:destroy!)
+      class DestroyAllBang < Base
+        extend AutoCorrector
+        MSG = 'Use `each(&:destroy!)` instead of `destroy_all`.'
+        RESTRICT_ON_SEND = %i[destroy_all].freeze
+
+        def on_send(node)
+          destroy_all_range = node.loc.selector
+          add_offense(destroy_all_range) do |corrector|
+            corrector.replace(node.loc.selector, 'each(&:destroy!)')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rails/enum_starting_value.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Rails
+      # Prevent the user to start from Zero with an enum.
+      # When using a wrong value like .where(state: :patato) let Rails + MySQL do a WHERE state = 0.
+      # It will match nothing since no record will have a 0 value.
+      #
+      #   # bad
+      #   enum my_enum: {apple: 0, bannana: 1}
+      #
+      #   # good
+      #   enum my_enum: {apple: 1, banana: 2}
+
+      class EnumStartingValue < Base
+        MSG = 'Prefer starting from `1` instead of `0` with `enum`.'
+
+        def_node_matcher :enum?, <<~PATTERN
+          (send nil? :enum (hash ...))
+        PATTERN
+
+        def_node_matcher :enum_attributes, <<~PATTERN
+          (send nil? :enum (:hash (:pair (...)$(...) )...))
+        PATTERN
+
+        def on_send(node)
+          return unless enum? node
+
+          add_offense(node) if start_with_zero?(enum_attributes(node))
+        end
+
+        def start_with_zero?(node)
+          return unless node.type == :hash
+
+          node.children.any? do |child|
+            value = child.value
+            value.type == :int && value.value.zero?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Sidekiq
+      # Ensure workers avoid returning early
+      #
+      # # bad
+      # def perform
+      #   return if condition
+      #   ...
+      # end
+      #
+      # # good
+      # def perform
+      #   # TDB, idea would be `raise SilentError if condition`
+      # end
+
+      class NoNilReturn < Base
+        MSG = 'Avoid using early nil return in workers.'
+
+        def on_return(node)
+          add_offense(node) if node.arguments.first&.nil_type? || node.arguments.empty?
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '1.1.1'
+    VERSION = '1.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-29 00:00:00.000000000 Z
+date: 2023-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -80,6 +80,7 @@ files:
 - config/base.yml
 - config/default.yml
 - lib/rubocop-petal.rb
+- lib/rubocop/cop/chewy/field_type.rb
 - lib/rubocop/cop/chewy/reset_on_type.rb
 - lib/rubocop/cop/grape/helpers_include_module.rb
 - lib/rubocop/cop/grape/prefer_namespace.rb
@@ -88,15 +89,19 @@ files:
 - lib/rubocop/cop/migration/change_table_references.rb
 - lib/rubocop/cop/migration/foreign_key_option.rb
 - lib/rubocop/cop/migration/schema_statements_methods.rb
+- lib/rubocop/cop/migration/standalone_add_reference.rb
 - lib/rubocop/cop/performance/snif.rb
 - lib/rubocop/cop/petal_cops.rb
+- lib/rubocop/cop/rails/destroy_all_bang.rb
 - lib/rubocop/cop/rails/enum_prefix.rb
+- lib/rubocop/cop/rails/enum_starting_value.rb
 - lib/rubocop/cop/rails/risky_activerecord_invocation.rb
 - lib/rubocop/cop/rspec/authenticated_as.rb
 - lib/rubocop/cop/rspec/create_list_max.rb
 - lib/rubocop/cop/rspec/json_response.rb
 - lib/rubocop/cop/rspec/sidekiq_inline.rb
 - lib/rubocop/cop/rspec/stub_products.rb
+- lib/rubocop/cop/sidekiq/no_nil_return.rb
 - lib/rubocop/petal.rb
 - lib/rubocop/petal/inject.rb
 - lib/rubocop/petal/version.rb