rubocop-petal 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d59a2d5781acf6465d3b1f5fef4575af1db1da8fd4af2d4ec3b0af863139cb2
-  data.tar.gz: aa4221534a285b746c8dd195347ab93c27954762bdd26f93242c712c8cbed20f
+  metadata.gz: 5e03823477b0b4b7ae8716d58bc3f14fe3eb639979ae2f26a96f2a6f2b959dd9
+  data.tar.gz: 36e8f4940ac8ec120b918f580a625d40b56d32e2fcf4a0b502b90f16ad7881bb
 SHA512:
-  metadata.gz: 81707e3d93a3e10e36dcdd299c63f804b8b820a8406b267715c084ed8fd5b0180633ea2e2a335623df414e3251959813332526d1e796fe86771241af85c09920
-  data.tar.gz: '048bde3d8f343cb218b2bd25dbbedbd30fc8ff7579028e3a6f3d805800c7212720b7fc48e4b8757dd9948c5775730f27287490b18dc701d15e893800a7c73562'
+  metadata.gz: 57d28ac81e61b2b04f5828254b9ae62e5a13e30cf153cc993cb600fd33a5295ee2976c70504bcef6ebadb1179bf30f66895fca3cf99cea170fc70a719de99b3b
+  data.tar.gz: 377ce23841da62012e8abe7b9512e2fe39afc74fb14bd42712ab65b983efb62969d96b4c9e4638996e996ea7a7db1c8559b12c15f0d262754b7eb324e6bee8fb

data/README.md

@@ -54,7 +54,7 @@ bundle exec rake 'new_cop[Rails/MyNewCop]'
 ```
 
 Have a look to [RuboCop documentation](https://docs.rubocop.org/rubocop/1.23/development.html) to get started with
-_node pattern_.
+_node pattern_. [Rubocop AST](https://github.com/rubocop/rubocop-ast/blob/master/docs/modules/ROOT/pages/node_pattern.adoc)
 
 ## Release
 

data/config/base.yml

@@ -38,13 +38,13 @@ Metrics/BlockNesting:
 Metrics/ClassLength:
   Enabled: false
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 9
 Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
 Metrics/PerceivedComplexity:
-  Max: 12
+  Max: 10
 RSpec:
   StyleGuideBaseURL: https://rspec.rubystyle.guide
 RSpec/ContextWording:
@@ -92,6 +92,8 @@ Rails/UnknownEnv:
     - staging
 Rails/WhereExists:
   Enabled: false
+Rails/TableNameAssignment:
+  Enabled: true
 Style/CollectionMethods:
   PreferredMethods:
     detect: detect

data/config/default.yml

@@ -5,6 +5,18 @@ Grape/PreferNamespace:
   Include:
     - app/api/**/*
 
+Migration/AlwaysBulkChangeTable:
+  Description: 'Suggest to always use `bulk: true` when using `change_table`.'
+  Enabled: true
+  Include:
+    - db/migrate/**
+
+Migration/ChangeTableReferences:
+  Description: 'Prevent using `t.references` or `t.belongs_to` in a change_table.'
+  Enabled: true
+  Include:
+    - db/migrate/**
+
 Migration/ForeignKeyOption:
   Description: 'Specify the foreign key option to create the constraint.'
   Enabled: true
@@ -67,13 +79,6 @@ Rails/RiskyActiverecordInvocation:
   Description: 'Interpolation, use hash or parameterized syntax.'
   Enabled: true
 
-Rails/TableName:
-  Description: 'Prevent usage of table_name= to in favor of convention.'
-  Enabled: true
-  StyleGuide: "https://rails.rubystyle.guide/#keep-ar-defaults"
-  Include:
-    - app/models/**/*
-
 Chewy/ResetOnType:
   Description: 'Prevent using reset! methods on Chewy type class'
   Enabled: true

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Using `bulk: true` with `change_table` is recommended.
+      # Without `bulk: true`, `change_table` generates multiple
+      # `ALTER TABLE` statements and the migration process will
+      # be duplicated.
+      #
+      # @bad
+      #   change_table :users do |t|
+      #     t.string :first_name
+      #     t.string :last_name
+      #   end
+      #
+      # @good
+      #  change_table :users, bulk: true do |t|
+      #    t.string :first_name
+      #    t.string :last_name
+      #  end
+      #
+      class AlwaysBulkChangeTable < Rails::BulkChangeTable
+        MSG = 'Add `bulk: true` when using change_table.'
+        RESTRICT_ON_SEND = %i[change_table].freeze
+
+        def on_send(node)
+          return unless node.command?(:change_table)
+
+          unless include_bulk_options?(node)
+            add_offense(node)
+            return
+          end
+
+          add_offense(node) unless bulk_options_true?(node)
+        end
+
+        def bulk_options_true?(node)
+          options = node.arguments[1]
+          options.each_pair do |key, value|
+            return true if key.value == :bulk && value.true_type?
+          end
+          false
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Prevent using `t.references` or `t.belongs_to` in a change_table.
+      # Internally, `t.references` use multiple `ALTER TABLE` statements.
+      # Since Rails cannot transform automatically `t.references` inside
+      # a `change_table bulk: true` we can manually create the equivalent
+      # `ALTER TABLE` statement using `t.bigint`, `t.index` and `t.foreign_key`.
+      #
+      #   #bad
+      #   change_table :subscriptions, bulk: true do |t|
+      #     t.references :user, null: false, foreign_key: true
+      #   end
+      #
+      #   #good
+      #   change_table :subscriptions, bulk: true do |t|
+      #     t.bigint :user_id, null: false
+      #     t.index :user_id
+      #     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.'
+
+        # @!method add_references_in_block?(node)
+        def_node_search :add_references_in_block?, <<~PATTERN
+          (send lvar /references|belongs_to/ ...)
+        PATTERN
+
+        # @!method change_table?(node)
+        def_node_search :change_table?, <<~PATTERN
+          (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) }
+          return unless references_node
+
+          arguments = references_node.child_nodes[1]
+          references_methods_range = references_node.source_range.with(end_pos: arguments.source_range.begin_pos - 1)
+          add_offense(references_methods_range)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '1.0.0'
+    VERSION = '1.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -84,13 +84,14 @@ files:
 - lib/rubocop/cop/grape/helpers_include_module.rb
 - lib/rubocop/cop/grape/prefer_namespace.rb
 - lib/rubocop/cop/grape/unnecessary_namespace.rb
+- lib/rubocop/cop/migration/always_bulk_change_table.rb
+- 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/performance/snif.rb
 - lib/rubocop/cop/petal_cops.rb
 - lib/rubocop/cop/rails/enum_prefix.rb
 - lib/rubocop/cop/rails/risky_activerecord_invocation.rb
-- lib/rubocop/cop/rails/table_name.rb
 - lib/rubocop/cop/rspec/authenticated_as.rb
 - lib/rubocop/cop/rspec/create_list_max.rb
 - lib/rubocop/cop/rspec/json_response.rb

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

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module Rails
-      # This cop enforces the absence of explicit table name definitions.
-      #
-      #   # bad
-      #   self.table_name = 'some_table_name'
-      #   self.table_name = :some_other_name
-      class TableName < Base
-        include ActiveRecordHelper
-
-        MSG = %(
-Avoid using `self.table_name=` if at all possible. When ActiveRecord's defaults are used, it may be omitted.
-If you are working on a new model, you should name the table and model to fit the defaults
-If you absolutely must use it, disable the cop with `# rubocop:disable Rails/TableName`
-        )
-
-        def on_send(node)
-          add_offense(node) if find_set_table_name(node).to_a.any?
-        end
-      end
-    end
-  end
-end