rubocop-petal 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02e763ff0683f1009a5b4e387eea9beb7e19eea47670c634f7d182b182856e41
-  data.tar.gz: 66576879ea7a772d5323fcf89aadf9a91ea1e0a25ee2679553ec5c83d2e197d7
+  metadata.gz: 10f81655924fecdd2195281a71d19602efadfc7a9a60e7a9f005136c969aa45f
+  data.tar.gz: d5e0bab2b887cec6b46ed1ac96993cd18fe0c485f0723425288bb9c80c57f396
 SHA512:
-  metadata.gz: '02790f98ebe560dec0615c66faabf2c67ec9f062ef8db564026b76ee72dbbfb695bbe63946d418f5b8b2872275e684acf3f5d31a74bae35c54f0d30d5d31950d'
-  data.tar.gz: 2a363c24244f2c6b6b451bac58ccd9a65c6c0f4e5ab6d07160720ae28a707c85a2f3e273f38116b90cb3b2bf9f3a1d089f9f58cb422cfa89be002d720543c1e1
+  metadata.gz: 0f54b691eb3fa5512d745e425494ce785dec5f74deccc101c85e7214eb2b4d227619f987347e2ab29a7dc5d0d509b52bfdaa6e44cdf297d440b76a21a91dd4dd
+  data.tar.gz: 210f323604d3ceae5db556afd7aa7f689b4c830d2886d7994030586c0726f5e6f7b7e05314dc49f0d39ec887142b857dd0ce9cbe22712dc3fc8a855ae35ac084

data/config/default.yml

@@ -15,6 +15,12 @@ Grape/PreferNamespace:
   Include:
     - app/api/**/*
 
+Migration/AlterAfterCreateTable:
+  Description: 'Prefer defining new table changes inside the create_table block.'
+  Enabled: true
+  Include:
+    - db/migrate/**
+
 Migration/AlwaysBulkChangeTable:
   Description: 'Suggest to always use `bulk: true` when using `change_table`.'
   Enabled: true

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Prefer defining table changes inside the create_table block instead of
+      # altering the table immediately after creating it.
+      #
+      # @example
+      #   # bad
+      #   create_table :users do |t|
+      #     t.string :email
+      #   end
+      #
+      #   add_index :users, :email, unique: true
+      #
+      #   # good
+      #   create_table :users do |t|
+      #     t.string :email
+      #     t.index :email, unique: true
+      #   end
+      class AlterAfterCreateTable < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Prefer defining new table changes inside the create_table block.'
+
+        ALTER_METHODS = (
+          Rails::BulkChangeTable::COMBINABLE_ALTER_METHODS +
+          Rails::BulkChangeTable::MYSQL_COMBINABLE_ALTER_METHODS +
+          Rails::BulkChangeTable::POSTGRESQL_COMBINABLE_ALTER_METHODS +
+          Rails::BulkChangeTable::POSTGRESQL_COMBINABLE_ALTER_METHODS_SINCE_6_1
+        ).uniq.freeze
+
+        RESTRICT_ON_SEND = ALTER_METHODS.freeze
+
+        def on_block(node)
+          return unless node.send_node&.command?(:create_table)
+          return unless (alter_node = alter_node_after_create_table(node))
+          return unless same_table?(node.send_node, alter_node)
+
+          add_alter_offense(node, alter_node)
+        end
+
+        private
+
+        def alter_node_after_create_table(create_table_node)
+          siblings = sibling_nodes(create_table_node)
+          index = siblings.index(create_table_node)
+          return unless index
+
+          alter_node = siblings[index + 1]
+          return unless alter_node&.send_type?
+          return unless ALTER_METHODS.include?(alter_node.method_name)
+          return unless alter_node.receiver.nil?
+
+          alter_node
+        end
+
+        def sibling_nodes(node)
+          parent = node.parent
+          return parent.children if parent&.begin_type?
+
+          []
+        end
+
+        def same_table?(create_table_node, alter_node)
+          create_table_argument = create_table_node.first_argument
+          alter_table_argument = alter_node.first_argument
+          return false unless create_table_argument && alter_table_argument
+
+          if create_table_argument.is_a?(RuboCop::AST::BasicLiteralNode) &&
+             alter_table_argument.is_a?(RuboCop::AST::BasicLiteralNode)
+            literal_value(create_table_argument) == literal_value(alter_table_argument)
+          else
+            create_table_argument.source == alter_table_argument.source
+          end
+        end
+
+        def literal_value(node)
+          return unless node.is_a?(RuboCop::AST::BasicLiteralNode)
+
+          node.value.to_s
+        end
+
+        def add_alter_offense(create_table_node, alter_node)
+          replacement = replacement_for(create_table_node, alter_node)
+
+          add_offense(alter_node.loc.selector) do |corrector|
+            next unless replacement
+
+            end_line_range = processed_source.buffer.line_range(create_table_node.loc.end.line)
+            corrector.insert_before(end_line_range, "#{replacement}\n")
+            corrector.remove(range_by_whole_lines(alter_node.source_range, include_final_newline: true))
+          end
+        end
+
+        def replacement_for(create_table_node, alter_node)
+          block_variable = create_table_node.arguments.first&.source
+          return unless block_variable
+
+          case alter_node.method_name
+            when :add_index
+              replacement_for_add_index(block_variable, alter_node)
+            when :add_column
+              replacement_for_add_column(block_variable, alter_node)
+            when :add_timestamps
+              replacement_for_add_timestamps(block_variable, alter_node)
+          end
+        end
+
+        def replacement_for_add_index(block_variable, node)
+          "#{indentation(node)}#{block_variable}.index #{arguments_after_table(node)}"
+        end
+
+        def replacement_for_add_column(block_variable, node)
+          column_node, type_node = node.arguments[1, 2]
+          return unless column_node && type_node
+          return unless type_node.sym_type?
+
+          extra_arguments = node.arguments[3..].map(&:source)
+          arguments = [column_node.source, *extra_arguments].join(', ')
+
+          "#{indentation(node)}#{block_variable}.#{type_node.value} #{arguments}"
+        end
+
+        def replacement_for_add_timestamps(block_variable, node)
+          arguments = arguments_after_table(node)
+          method_call = "#{block_variable}.timestamps"
+          method_call = "#{method_call} #{arguments}" unless arguments.empty?
+
+          "#{indentation(node)}#{method_call}"
+        end
+
+        def arguments_after_table(node)
+          node.arguments[1..].map(&:source).join(', ')
+        end
+
+        def indentation(alter_node)
+          ' ' * (alter_node.loc.column + 2)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '1.9.0'
+    VERSION = '1.10.0'
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lint_roller
@@ -108,7 +107,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.31'
-description:
 email:
 - jfbastien@petalmd.com
 executables: []
@@ -128,6 +126,7 @@ 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/alter_after_create_table.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
@@ -176,7 +175,6 @@ metadata:
   bug_tracker_uri: https://github.com/petalmd/rubocop-petal/issues
   rubygems_mfa_required: 'true'
   default_lint_roller_plugin: RuboCop::Petal::Plugin
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,8 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Petal custom cops
 test_files: []