rubocop-sequel 0.3.6 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8264c5365683296b4ca9330ef776756e3c04ac55bb1ccdb9b2e76ea42d587e95
-  data.tar.gz: 53417ac0da345eba715ef2ce39a7ac60dbd93a0b6a2d174400ff3928bdb8814c
+  metadata.gz: 43689260646cb1428cd6629924d01648a005939d8f1094a6fcbb88ecc1a7fc68
+  data.tar.gz: b95f6400f9d2857ac7ce9d32c8931a71db14ba6e8cd86e128289fe1ef836d95b
 SHA512:
-  metadata.gz: aa8a47c34b42c304ba81f83725298b2e7ed6ba5c5da8432c5869e10f22e728fe3009132e1d7a144492f95e509908cbd3378d055d1bb9ff164c58363794df9210
-  data.tar.gz: a664d80d57e0477053dd8aaf45dc052c306714e610c7f312e1f656b20f0a11d7f9e17394ec63a9bf61353214f10a3d97b0059d826f85ef01399777bfc4225ed0
+  metadata.gz: a78387c550cc09564f2fffee05a5dda77c370130dd41f9c8b8a0f8bb26683813b97c1c2540250574c95ae7a192743d1873f59b82cdf02de501ff1d679a029bb5
+  data.tar.gz: 2e91b8df57f918c221d2d2319037264d347b84eaa082ed6f378d85f5023f9b6bcf19a5b2854553cc56707e986551c9bf5dd2ff1f17aaa1e04a3e5bd7c94221a9

data/config/default.yml

@@ -17,7 +17,7 @@ Sequel/IrreversibleMigration:
   Reference: https://www.rubydoc.info/gems/rubocop-sequel/RuboCop/Cop/Sequel/IrreversibleMigration
   Enabled: true
   VersionAdded: 0.3.5
-  VersionChanged: 0.3.6
+  VersionChanged: 0.3.8
 
 Sequel/JSONColumn:
   Description: >-

data/lib/rubocop/cop/sequel/irreversible_migration.rb

@@ -28,7 +28,7 @@ module RuboCop
           set_column_allow_null
         ].freeze
 
-        MSG = 'Avoid using "%<name>s" inside a "change" block. Use "up" & "down" blocks instead.'
+        MSG = 'Using "%<name>s" inside a "change" block may cause an irreversible migration. Use "up" & "down" instead.'
         PRIMARY_KEY_MSG = 'Avoid using "add_primary_key" with an array argument inside a "change" block.'
 
         def on_block(node)
@@ -44,15 +44,35 @@ module RuboCop
         private
 
         def validate_node(node)
-          name = node.method_name
+          return if within_create_table_block?(node)
 
-          add_offense(node.loc.selector, message: format(MSG, name: name)) unless VALID_CHANGE_METHODS.include?(name)
+          return if part_of_method_call?(node)
 
-          return unless name == :add_primary_key
+          add_offense(node.loc.selector, message: format(MSG, name: node.method_name)) unless valid_change_method?(node)
 
-          return unless node.arguments.any?(&:array_type?)
+          add_offense(node.loc.selector, message: PRIMARY_KEY_MSG) if invalid_primary_key_method?(node)
+        end
+
+        def valid_change_method?(node)
+          VALID_CHANGE_METHODS.include?(node.method_name)
+        end
+
+        def invalid_primary_key_method?(node)
+          return false unless node.method_name == :add_primary_key
+
+          node.arguments.any?(&:array_type?)
+        end
+
+        def within_create_table_block?(node)
+          return true if node.method_name == :create_table
+
+          node.each_ancestor(:block).any? do |ancestor|
+            ancestor.method_name == :create_table
+          end
+        end
 
-          add_offense(node.loc.selector, message: PRIMARY_KEY_MSG)
+        def part_of_method_call?(node)
+          node.each_ancestor(:send).count.positive?
         end
       end
     end

data/lib/rubocop/sequel/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Sequel
     # This module holds the RuboCop Sequel version information.
     module Version
-      STRING = '0.3.6'
+      STRING = '0.3.8'
     end
   end
 end

data/rubocop-sequel.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.name          = 'rubocop-sequel'
   gem.require_paths = ['lib']
-  gem.version       = '0.3.6'
+  gem.version       = '0.3.8'
   gem.metadata['rubygems_mfa_required'] = 'true'
 
   gem.required_ruby_version = '>= 2.5'

data/spec/rubocop/cop/sequel/irreversible_migration_spec.rb

@@ -39,6 +39,54 @@ RSpec.describe RuboCop::Cop::Sequel::IrreversibleMigration do
       expect(offenses).to be_empty
     end
 
+    describe 'and using a create_table block' do
+      let(:source) do
+        <<~SOURCE
+          change do
+            create_table(:artists) do
+              primary_key :id
+              String :name, null: false
+            end
+          end
+        SOURCE
+      end
+
+      it 'does not register any offenses' do
+        offenses = inspect_source_within_migration(source)
+        expect(offenses).to be_empty
+      end
+    end
+
+    describe 'and using a create_table block and alter_table block' do
+      let(:source) do
+        <<~SOURCE
+          change do
+            alter_table(:stores) do
+              drop_column(:products, :name)
+              drop_index(:products, :price)
+            end
+
+            add_column :books, :name, String
+
+            create_table(:artists) do
+              primary_key :id
+              String :name, null: false
+            end
+          end
+        SOURCE
+      end
+      let(:expected_methods) { %w[drop_column drop_index] }
+
+      it 'only registers offenses from within alter_table block' do
+        messages = inspect_source_within_migration(source).map(&:message)
+        expected_methods_present = expected_methods.all? do |method|
+          messages.any? { |message| message.include?(method) }
+        end
+
+        expect(expected_methods_present).to be(true)
+      end
+    end
+
     describe 'and an array is passed into `add_primary_key`' do
       let(:source) do
         <<~SOURCE
@@ -55,6 +103,52 @@ RSpec.describe RuboCop::Cop::Sequel::IrreversibleMigration do
         expect(offenses.size).to eq(1)
       end
     end
+
+    describe 'and a method is used within an argument' do
+      let(:source) do
+        <<~SOURCE
+          change do
+            alter_table(:stores) do
+              add_column(:products, JSON, null: false, default: Sequel.pg_json({}))
+              add_constraint(
+                :only_one_user,
+                (
+                  Sequel.cast(Sequel.~(user_id: nil), Integer) +
+                  Sequel.cast(Sequel.~(owner_id: nil), Integer)
+                ) => 1,
+              )
+            end
+          end
+        SOURCE
+      end
+
+      it 'does not register an offense with valid methods' do
+        offenses = inspect_source_within_migration(source)
+        expect(offenses).to be_empty
+      end
+    end
+
+    describe 'and an invalid change method contains another invalid change method as an argument' do
+      let(:source) do
+        <<~SOURCE
+          change do
+            alter_table(:stores) do
+              drop_column(:products, JSON, null: false, default: Sequel.pg_json({}))
+            end
+          end
+        SOURCE
+      end
+
+      it 'only registers 1 offense' do
+        offenses = inspect_source_within_migration(source)
+        expect(offenses.size).to eq(1)
+      end
+
+      it 'only registers an offense for the parent method' do
+        offenses = inspect_source_within_migration(source)
+        expect(offenses.first.message).to include('drop_column')
+      end
+    end
   end
 
   context 'when inside an up block' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-sequel
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.8
 platform: ruby
 authors:
 - Timothée Peignier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop