rubocop-migration 0.3.2 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d5fe85da04542f564b53e8c0d779c4258ca907f99a7583919aa02007d719f33
-  data.tar.gz: 06bd03d9e0afdf5618ad2bdfffbfa2ac465821f65009e2c949051bd04e3defae
+  metadata.gz: fa5e7fda6eeffbf26f8c9bd1a4433a689416e0a2098ce9193f93c72564b8b4f2
+  data.tar.gz: 4907939dbd5ba1a39cf76d838824bfa8574fe527b6a8985588bd7897eb5a3a1c
 SHA512:
-  metadata.gz: 5943d60b5a214eecc77d326cf94b7f44fb270592822687f05b7165ca4b6165086ae6491f523a27dab620fb3e83ee6c7e03058d14b93cbecbc9dcf1334c47f333
-  data.tar.gz: 7b20c8d2766ff2803ae32a31f598e447fa5fd4282c9507fded7181d5c85d139fe8de603f6000e4dbe49c73b963a07f6cef12b8ec248eba925a621024086c2b86
+  metadata.gz: 6885d3a799806f1a3699cf892eb2a9855b66b8d29f9578fe9a0d8f98e84ab0526683710a35b22dbb1601cc6b52c015421aa163c6f671a4366ceb3d5a582dedba
+  data.tar.gz: 8838e0d3758231c59a844e26d4b7795dd7abf74743a16f25075f9804f3de51248d2c6893614ecfdee8cdf075af46430b3723b3e10f62a57a39f42ef31b326489

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-migration (0.3.2)
+    rubocop-migration (0.4.1)
       activesupport
       rubocop (>= 1.34)
       rubocop-rails
@@ -9,22 +9,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
-    minitest (5.16.3)
+    minitest (5.18.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
-    rack (3.0.0)
+    rack (3.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.0)
@@ -57,7 +57,7 @@ GEM
     rubocop-performance (1.15.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.16.1)
+    rubocop-rails (2.19.1)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.33.0, < 2.0)
@@ -68,7 +68,7 @@ GEM
     ruby-progressbar (1.11.0)
     sevencop (0.21.0)
       rubocop
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
 

data/README.md

@@ -6,14 +6,11 @@ RuboCop extension focused on ActiveRecord migration.
 
 ## Usage
 
-~~Install `rubocop-migration` gem:~~
-
-This gem is not yet published to rubygems.org.
-See [#1](https://github.com/r7kamura/rubocop-migration/issues/1) for more details.
+Install `rubocop-migration` gem:
 
 ```ruby
 # Gemfile
-gem 'rubocop-migration', require: false, github: 'r7kamura/rubocop-migration', tag: 'v0.3.1'
+gem 'rubocop-migration', require: false
 ```
 
 then require `rubocop-migration` and enable the cops you want to use in your .rubocop.yml:
@@ -24,7 +21,7 @@ require:
   - rubocop-migration
 
 Migration/AddCheckConstraint:
-  Enabled: false
+  Enabled: true
 ```
 
 Note that all cops are `Enabled: false` by default.
@@ -53,6 +50,8 @@ Please read the comments of the respective cop classes for more information.
 
 ## Acknowledgements
 
-This gem was heavily inspired by the following gem:
+This gem was heavily inspired by [ankane/strong_migrations](https://github.com/ankane/strong_migrations).
+
+The gem `rubocop-migration` was originally developed at [wealthsimple/rubocop-migration](https://github.com/wealthsimple/rubocop-migration), and later the gem name was transferred to this repository.
 
-- [ankane/strong_migrations](https://github.com/ankane/strong_migrations)
+Some cops were originally created at [r7kamura/sevencop](https://github.com/r7kamura/sevencop) then moved to this repository.

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

@@ -30,9 +30,12 @@ module RuboCop
         extend AutoCorrector
 
         include ::RuboCop::Migration::CopConcerns::DisableDdlTransaction
+        include RangeHelp
 
         MSG = 'Use `algorithm: :concurrently` on adding indexes to existing tables in PostgreSQL.'
 
+        MESSAGE_FOR_DUPLICATED_DISABLE_DDL_TRANSACTION = 'Remove duplicated `disable_ddl_transaction!`.'
+
         RESTRICT_ON_SEND = %i[
           add_index
           index
@@ -41,10 +44,21 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         # @return [void]
         def on_send(node)
-          return unless bad?(node)
+          if add_index_without_concurrency?(node)
+            add_offense(node) do |corrector|
+              autocorrect(corrector, node)
+            end
+          end
 
-          add_offense(node) do |corrector|
-            autocorrect(corrector, node)
+          duplicated_disable_ddl_transactions_from(node).each do |disable_ddl_transactions_node|
+            add_offense(node, message: MESSAGE_FOR_DUPLICATED_DISABLE_DDL_TRANSACTION) do |corrector|
+              corrector.remove(
+                range_with_surrounding_space(
+                  disable_ddl_transactions_node.source_range,
+                  side: :left
+                )
+              )
+            end
           end
         end
 
@@ -116,6 +130,17 @@ module RuboCop
           )
         PATTERN
 
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Boolean]
+        def add_index_without_concurrency?(node)
+          case node.method_name
+          when :add_index
+            add_index?(node) && !add_index_concurrently?(node)
+          when :index
+            index?(node) && in_change_table?(node) && !index_concurrently?(node)
+          end
+        end
+
         # @param corrector [RuboCop::Cop::Corrector]
         # @param node [RuboCop::AST::SendNode]
         # @return [void]
@@ -128,14 +153,9 @@ module RuboCop
         end
 
         # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def bad?(node)
-          case node.method_name
-          when :add_index
-            add_index?(node) && !add_index_concurrently?(node)
-          when :index
-            index?(node) && in_change_table?(node) && !index_concurrently?(node)
-          end
+        # @return [Array<RuboCop::AST::SendNode>]
+        def duplicated_disable_ddl_transactions_from(node)
+          disable_ddl_transactions_from(node)[1..] || []
         end
 
         # @param node [RuboCop::AST::SendNode]

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

@@ -40,12 +40,13 @@ module RuboCop
 
         RESTRICT_ON_SEND = %i[
           change_column_null
+          change_null
         ].freeze
 
         # @param node [RuboCop::AST::SendNode]
         # @return [void]
         def on_send(node)
-          return if in_second_migration?(node)
+          return if called_with_validate_constraint?(node)
 
           add_offense(node) do |corrector|
             autocorrect(corrector, node)
@@ -54,26 +55,6 @@ module RuboCop
 
         private
 
-        # @!method parse_table_name_and_column_name(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Array<Symbol>, nil]
-        def_node_matcher :parse_table_name_and_column_name, <<~PATTERN
-          (send
-            nil?
-            _
-            ({str sym} $_)
-            ({str sym} $_)
-            ...
-          )
-        PATTERN
-
-        # @!method remove_check_constraint?(node)
-        #   @param node [RuboCop::AST::SendNode]
-        #   @return [Boolean]
-        def_node_matcher :remove_check_constraint?, <<~PATTERN
-          (send nil? :remove_check_constraint ...)
-        PATTERN
-
         # @!method validate_constraint?(node)
         #   @param node [RuboCop::AST::SendNode]
         #   @return [Boolean]
@@ -88,39 +69,138 @@ module RuboCop
           corrector,
           node
         )
-          table_name, column_name = parse_table_name_and_column_name(node)
+          case node.method_name
+          when :change_column_null
+            autocorrect_change_column_null(corrector, node)
+          when :change_null
+            autocorrect_change_null(corrector, node)
+          end
+        end
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def autocorrect_change_column_null(
+          corrector,
+          node
+        )
           corrector.replace(
             node,
-            format(
-              "add_check_constraint :%<table>s, '%<column>s IS NOT NULL', name: '%<constraint>s', validate: false",
-              column: column_name,
-              constraint: "#{table_name}_#{column_name}_is_not_null",
-              table: table_name
+            format_add_check_constraint(
+              column_name: find_column_name_from_change_column_null(node),
+              table_name: find_table_name_from_change_column_null(node)
+            )
+          )
+        end
+
+        # @param corrector [RuboCop::Cop::Corrector]
+        # @param node [RuboCop::AST::SendNode]
+        # @return [void]
+        def autocorrect_change_null(
+          corrector,
+          node
+        )
+          corrector.replace(
+            node.location.selector.with(
+              end_pos: node.location.expression.end_pos
+            ),
+            format_check_constraint(
+              column_name: find_column_name_from_change_null(node),
+              table_name: find_table_name_from_change_null(node)
             )
           )
         end
 
         # @param node [RuboCop::AST::SendNode]
         # @return [Boolean]
-        def called_after_validate_constraint?(node)
-          node.left_siblings.any? do |sibling|
+        def called_with_validate_constraint?(node)
+          case node.method_name
+          when :change_column_null
+            node
+          when :change_null
+            find_ancestor_change_table(node)
+          end.left_siblings.any? do |sibling|
             validate_constraint?(sibling)
           end
         end
 
         # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def called_before_remove_check_constraint?(node)
-          node.right_siblings.any? do |sibling|
-            remove_check_constraint?(sibling)
+        # @return [RuboCop::AST::BlockNode]
+        def find_ancestor_change_table(node)
+          node.each_ancestor(:block).find do |ancestor|
+            ancestor.method?(:change_table)
           end
         end
 
         # @param node [RuboCop::AST::SendNode]
-        # @return [Boolean]
-        def in_second_migration?(node)
-          called_after_validate_constraint?(node) ||
-            called_before_remove_check_constraint?(node)
+        # @return [String]
+        def find_column_name_from_change_column_null(node)
+          node.arguments[1].value.to_s
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String]
+        def find_column_name_from_change_null(node)
+          node.arguments[0].value.to_s
+        end
+
+        # @parm node [RuboCop::AST::SendNode]
+        # @return [String]
+        def find_table_name_from_change_column_null(node)
+          node.arguments[0].value.to_s
+        end
+
+        # @param node [RuboCop::AST::SendNode]
+        # @return [String]
+        def find_table_name_from_change_null(node)
+          find_ancestor_change_table(node).send_node.arguments[0].value.to_s
+        end
+
+        # @param column_name [String]
+        # @param table_name [String]
+        # @return [String]
+        def format_add_check_constraint(
+          column_name:,
+          table_name:
+        )
+          format(
+            'add_check_constraint :%<table_name>s, %<arguments>s',
+            arguments: format_check_constraint_arguments(
+              column_name: column_name,
+              table_name: table_name
+            ),
+            table_name: table_name
+          )
+        end
+
+        # @param column_name [String]
+        # @param table_name [String]
+        # @return [String]
+        def format_check_constraint(
+          column_name:,
+          table_name:
+        )
+          format(
+            'check_constraint %<arguments>s',
+            arguments: format_check_constraint_arguments(
+              column_name: column_name,
+              table_name: table_name
+            )
+          )
+        end
+
+        # @param coumn_name [String]
+        # @param table_name [String]
+        # @return [String]
+        def format_check_constraint_arguments(
+          column_name:,
+          table_name:
+        )
+          format(
+            "'%<column_name>s IS NOT NULL', name: '%<constraint_name>s', validate: false",
+            column_name: column_name,
+            constraint_name: "#{table_name}_#{column_name}_is_not_null"
+          )
         end
       end
     end

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

@@ -24,6 +24,15 @@ module RuboCop
 
         private
 
+        # @param node [RuboCop::AST::SendNode]
+        # @return [Array<RuboCop::AST::SendNode>]
+        def disable_ddl_transactions_from(node)
+          node.each_ancestor(:def).first&.left_siblings&.select do |sibling|
+            sibling.is_a?(::RuboCop::AST::SendNode) &&
+              disable_ddl_transaction?(sibling)
+          end || []
+        end
+
         # @param corrector [RuboCop::Cop::Corrector]
         # @param node [RuboCop::AST::SendNode]
         # @return [void]
@@ -40,10 +49,7 @@ module RuboCop
         # @param node [RuboCop::AST::SendNode]
         # @return [Boolean]
         def within_disable_ddl_transaction?(node)
-          node.each_ancestor(:def).first&.left_siblings&.any? do |sibling|
-            sibling.is_a?(::RuboCop::AST::SendNode) &&
-              disable_ddl_transaction?(sibling)
-          end
+          !disable_ddl_transactions_from(node).empty?
         end
       end
     end

data/lib/rubocop/migration/version.rb

@@ -2,6 +2,6 @@
 
 module Rubocop
   module Migration
-    VERSION = '0.3.2'
+    VERSION = '0.4.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-migration
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2023-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,7 +61,6 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
-- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -118,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: RuboCop extension focused on ActiveRecord migration.

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-## [Unreleased]
-
-## [0.1.0] - 2022-10-17
-
-- Initial release