rubocop-migration 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0813a8046835fbb1c8382152971eaada39e144aabb2266cda2115b2e5c2a1398'
-  data.tar.gz: 38580189a800f01224c4dbfd39d7aed4707509d148ec1deed74e936858a99624
+  metadata.gz: '04080713782c1efcf724f467e77e9e550d70070bcb1d69592caeb1d4740b9282'
+  data.tar.gz: 80fece0029a643072003348334363a51a84c636fdcf2c50219a3b8ca967f25f0
 SHA512:
-  metadata.gz: 65e716d2e0cecb340f2e8171d125d901f7eb8e53352227fa472e4489da1c8b97c04000ae6bb59080f2a7d811e9cc2c1dad3248d9624a00f90fba3b2ce55c7e93
-  data.tar.gz: 4bb8b248e3f0bc57767bc0be615a27d31d663f89e2d8eddd67e30102cbbfe6d49f1bd119db3b6a3fae5593f0751b5862e1af993e90e0f6514e788faadb8d6314
+  metadata.gz: eb8d8c1f01f4034d17c474cb8e2561a5a0b74b34aef294f464891619fabed9f8210653d19c20115cb7a5883ca141054244c13d1fa26e258f489ef14c0365b569
+  data.tar.gz: db392a7a94d3857e1db00fa59dad6739d6c8292bfcffccd71c2684c98a80332afe36f90c452cd4ed5ed48cba5ce27f48129ffc3d87a9969658131078b7e750bc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-migration (0.8.0)
+    rubocop-migration (0.9.0)
       activesupport
       lint_roller (>= 1.1)
       rubocop (>= 1.72.1)

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

@@ -31,9 +31,21 @@ module RuboCop
       #       validate_check_constraint :orders, name: 'orders_price_positive'
       #     end
       #   end
+      #
+      #   # good
+      #   class CreateOrders < ActiveRecord::Migration[7.0]
+      #     def change
+      #       create_table :orders do |t|
+      #         t.integer :price
+      #       end
+      #       add_check_constraint :orders, 'price > 0', name: 'orders_price_positive'
+      #     end
+      #   end
       class AddCheckConstraint < RuboCop::Cop::Base
         extend AutoCorrector
 
+        include ::RuboCop::Migration::CopConcerns::NewTable
+
         MSG = 'Activate a check constraint in a separate migration in PostgreSQL.'
 
         RESTRICT_ON_SEND = %i[
@@ -104,7 +116,8 @@ module RuboCop
         # @return [Boolean]
         def bad?(node)
           add_check_constraint?(node) &&
-            !add_check_constraint_with_validate_false?(node)
+            !add_check_constraint_with_validate_false?(node) &&
+            !new_table?(node.first_argument)
         end
       end
     end

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

@@ -27,11 +27,22 @@ module RuboCop
       #       change_column_default :users, :some_column, 'some value'
       #     end
       #   end
+      #
+      #   # good
+      #   class CreateUsers < ActiveRecord::Migration[7.0]
+      #     def change
+      #       create_table :users do |t|
+      #         t.string :name
+      #       end
+      #       add_column :users, :some_column, :string, default: 'some value'
+      #     end
+      #   end
       class AddColumnWithDefaultValue < RuboCop::Cop::Base
         extend AutoCorrector
 
         include RangeHelp
         include ::RuboCop::Migration::CopConcerns::ColumnTypeMethod
+        include ::RuboCop::Migration::CopConcerns::NewTable
 
         MSG = 'Add the column without a default value then change the default.'
 
@@ -44,6 +55,7 @@ module RuboCop
         # @return [void]
         def on_send(node)
           return unless target_method?(node)
+          return if new_table?(find_table_node_from(node))
 
           default_option_node = non_nil_default_option_node_from(node)
           return unless default_option_node

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

@@ -100,7 +100,7 @@ module RuboCop
           case node.type
           when :array
             node.values.count
-          when :sym
+          when :str, :sym
             1
           end
         end

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

@@ -26,10 +26,21 @@ module RuboCop
       #       add_index :users, :name, algorithm: :concurrently
       #     end
       #   end
+      #
+      #   # good
+      #   class CreateUsers < ActiveRecord::Migration[7.0]
+      #     def change
+      #       create_table :users do |t|
+      #         t.string :name
+      #       end
+      #       add_index :users, :name
+      #     end
+      #   end
       class AddIndexConcurrently < RuboCop::Cop::Base
         extend AutoCorrector
 
         include ::RuboCop::Migration::CopConcerns::DisableDdlTransaction
+        include ::RuboCop::Migration::CopConcerns::NewTable
         include RangeHelp
 
         MSG = 'Use `algorithm: :concurrently` on adding indexes to existing tables in PostgreSQL.'
@@ -44,7 +55,7 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         # @return [void]
         def on_send(node)
-          if add_index_without_concurrency?(node)
+          if add_index_without_concurrency?(node) && !new_table?(find_table_node_from(node))
             add_offense(node) do |corrector|
               autocorrect(corrector, node)
             end
@@ -159,6 +170,17 @@ module RuboCop
           disable_ddl_transactions_from(node)[1..] || []
         end
 
+        # @param node [RuboCop::AST::SendNode]
+        # @return [RuboCop::AST::Node, nil]
+        def find_table_node_from(node)
+          case node.method_name
+          when :add_index
+            node.first_argument
+          else
+            node.each_ancestor(:block).first.send_node.first_argument
+          end
+        end
+
         # @param node [RuboCop::AST::SendNode]
         # @return [Boolean]
         def in_change_table?(node)

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

@@ -28,16 +28,33 @@ module RuboCop
       #
       #   class ReplaceNotNullConstraintOnUsersName < ActiveRecord::Migration[7.0]
       #     def change
-      #       validate_constraint :users, name: 'users_name_is_not_null'
+      #       validate_check_constraint :users, name: 'users_name_is_not_null'
       #       change_column_null :users, :name, false
       #       remove_check_constraint :users, name: 'users_name_is_not_null'
       #     end
       #   end
+      #
+      #   # bad
+      #   class AllowNullOnUsersName < ActiveRecord::Migration[7.0]
+      #     def change
+      #       change_column_null :users, :name, true
+      #     end
+      #   end
+      #
+      #   # good
+      #   class AllowNullOnUsersName < ActiveRecord::Migration[7.0]
+      #     def up
+      #       change_column_null :users, :name, true
+      #     end
+      #   end
       class ChangeColumnNull < RuboCop::Cop::Base
         extend AutoCorrector
 
         MSG = 'Avoid simply setting `NOT NULL` constraint on an existing column in PostgreSQL.'
 
+        MSG_FOR_ALLOW_NULL_IN_CHANGE = 'Allow NULL in `up` instead of `change`, ' \
+                                       'as rolling back `change` simply sets `NOT NULL` constraint again.'
+
         RESTRICT_ON_SEND = %i[
           change_column_null
           change_null
@@ -48,6 +65,11 @@ module RuboCop
         def on_send(node)
           return if called_with_validate_constraint?(node)
 
+          if allow_null?(node)
+            add_offense(node, message: MSG_FOR_ALLOW_NULL_IN_CHANGE) if in_change_method?(node)
+            return
+          end
+
           add_offense(node) do |corrector|
             autocorrect(corrector, node)
           end
@@ -56,11 +78,21 @@ module RuboCop
 
         private
 
+        # @!method allow_null?(node)
+        #   @param node [RuboCop::AST::SendNode]
+        #   @return [Boolean]
+        def_node_matcher :allow_null?, <<~PATTERN
+          {
+            (send nil? :change_column_null _ _ true ...)
+            (call _ :change_null _ true ...)
+          }
+        PATTERN
+
         # @!method validate_constraint?(node)
         #   @param node [RuboCop::AST::SendNode]
         #   @return [Boolean]
         def_node_matcher :validate_constraint?, <<~PATTERN
-          (send nil? :validate_constraint ...)
+          (send nil? {:validate_constraint :validate_check_constraint} ...)
         PATTERN
 
         # @param corrector [RuboCop::Cop::Corrector]
@@ -203,6 +235,12 @@ module RuboCop
             constraint_name: "#{table_name}_#{column_name}_is_not_null"
           )
         end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def in_change_method?(node)
+          node.each_ancestor(:def).first&.method?(:change) || false
+        end
       end
     end
   end

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

@@ -121,9 +121,10 @@ module RuboCop
         # @return [Array<String>]
         def find_ignored_column_names_from(table_name)
           pathname = model_pathname_from(
-            singularize(table_name)
+            directory: ::Pathname.new('app/models'),
+            snake_cased_model_name: singularize(table_name)
           )
-          return [] unless pathname.exist?
+          return [] unless pathname
 
           ignored_column_nodes = ignored_column_nodes_from(
             parse(
@@ -155,10 +156,28 @@ module RuboCop
           )
         end
 
+        # @note Tries `accounts_user.rb` first, then namespaces such as `accounts/user.rb`.
+        # @param directory [Pathname]
         # @param snake_cased_model_name [String]
-        # @return [Pathname]
-        def model_pathname_from(snake_cased_model_name)
-          ::Pathname.new("app/models/#{snake_cased_model_name}.rb")
+        # @return [Pathname, nil]
+        def model_pathname_from(
+          directory:,
+          snake_cased_model_name:
+        )
+          pathname = directory.join("#{snake_cased_model_name}.rb")
+          return pathname if pathname.exist?
+
+          snake_cased_model_name.scan(/(?<=[^_])_(?=[^_])/) do
+            namespace = ::Regexp.last_match.pre_match
+            next unless directory.join(namespace).directory?
+
+            pathname = model_pathname_from(
+              directory: directory.join(namespace),
+              snake_cased_model_name: ::Regexp.last_match.post_match
+            )
+            return pathname if pathname
+          end
+          nil
         end
 
         # @param content [String]

data/lib/rubocop/migration/cop_concerns/new_table.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Migration
+    module CopConcerns
+      module NewTable
+        class << self
+          def included(klass)
+            super
+            klass.class_eval do
+              # @!method create_table_if_not_exists?(node)
+              #   @param node [RuboCop::AST::SendNode]
+              #   @return [Boolean]
+              def_node_matcher :create_table_if_not_exists?, <<~PATTERN
+                (send
+                  nil?
+                  :create_table
+                  _
+                  (hash
+                    <
+                      (pair
+                        (sym :if_not_exists)
+                        true
+                      )
+                      ...
+                    >
+                  )
+                )
+              PATTERN
+
+              # @!method create_table_name_from(node)
+              #   @param node [RuboCop::AST::SendNode]
+              #   @return [String, Symbol, nil]
+              def_node_matcher :create_table_name_from, <<~PATTERN
+                (send
+                  nil?
+                  :create_table
+                  ({str sym} $_)
+                  ...
+                )
+              PATTERN
+            end
+          end
+        end
+
+        private
+
+        # @param node [RuboCop::AST::Node]
+        # @param table_name [String]
+        # @return [Boolean]
+        def create_table_of?(
+          node,
+          table_name
+        )
+          node = node.send_node if node.block_type?
+          node.send_type? &&
+            create_table_name_from(node)&.to_s == table_name &&
+            !create_table_if_not_exists?(node)
+        end
+
+        # Whether the table is created by a `create_table` written directly in the method body before it,
+        # not under a condition, a block, or a rescue.
+        # @param table_node [RuboCop::AST::Node, nil]
+        # @return [Boolean]
+        def new_table?(table_node)
+          return false unless table_node&.type?(:str, :sym)
+
+          body_node = table_node.each_ancestor(:def, :defs).first&.body
+          return false unless body_node&.begin_type?
+
+          table_name = table_node.value.to_s
+          body_node.each_child_node.any? do |statement_node|
+            statement_node.source_range.end_pos < table_node.source_range.begin_pos &&
+              create_table_of?(statement_node, table_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/migration/cop_concerns.rb

@@ -6,6 +6,7 @@ module RuboCop
       autoload :BatchProcessing, 'rubocop/migration/cop_concerns/batch_processing'
       autoload :ColumnTypeMethod, 'rubocop/migration/cop_concerns/column_type_method'
       autoload :DisableDdlTransaction, 'rubocop/migration/cop_concerns/disable_ddl_transaction'
+      autoload :NewTable, 'rubocop/migration/cop_concerns/new_table'
     end
   end
 end

data/lib/rubocop/migration/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Migration
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-migration
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Ryo Nakamura
@@ -104,6 +104,7 @@ files:
 - lib/rubocop/migration/cop_concerns/batch_processing.rb
 - lib/rubocop/migration/cop_concerns/column_type_method.rb
 - lib/rubocop/migration/cop_concerns/disable_ddl_transaction.rb
+- lib/rubocop/migration/cop_concerns/new_table.rb
 - lib/rubocop/migration/plugin.rb
 - lib/rubocop/migration/version.rb
 - rubocop-migration.gemspec