declare_schema 1.2.3.pre.ga.2 → 1.2.3.pre.ga.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b2501407fb1875c42fda5d9c77ab78ca1f966c780e0888716e6e71769ea53b1
-  data.tar.gz: 535e054f1ad938d271334fdc6054108778dde1f72e59335d778f11ab73d08c14
+  metadata.gz: aacc7a857e82fc857a7694a7c32afe7b9bee2a8949dd455f6506eac066658353
+  data.tar.gz: 513a4171b54d053b3e9cc58111256010040634e287cf2d7f1a33b278cad92548
 SHA512:
-  metadata.gz: 6f5c2dea9bd05f536f05f058ce193a4003384f754649d5b922bbce6532bfe25f60e8c987e2b1136b603899cc0cb9217f0dcc8b59e6bbf974f9dc57aa600abf36
-  data.tar.gz: 17fe43628304597208f5063fc907ae3bd85586732a26985c0d709004d4411af1ff89dfab79b41334073c7860231b0c560ae5d6eff605a72335748335696da5d8
+  metadata.gz: b5075ebac4ebd80def763e46df74d506e3c2df43d4c0601e35fe335be7c3db8faf5b280fd4417dc54ff2f6608162de5ba69082af4353df6f3d7b0ff449b20486
+  data.tar.gz: 48534ddd177e9061390b26db9142842968cf28f2637f1cc7d091e28205ace5d55c0ddb0669c7b31b370d4d27d18e83ecc09d0c4b8451f79c4230ef0667c89d4f

data/CHANGELOG.md

@@ -4,6 +4,10 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.3] - Unreleased
+### Changed
+- Fixed a bug where renaming a foreign key resulted in an incorrect migration
+
 ## [1.2.2] - 2023-01-27
 ### Changed
 - Documented `belongs_to` and `has_and_belongs_to_many` behavior

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (1.2.3.pre.ga.2)
+    declare_schema (1.2.3.pre.ga.5)
       rails (>= 5.0)
 
 GEM

data/lib/declare_schema/model/foreign_key_definition.rb

@@ -12,7 +12,7 @@ module DeclareSchema
 
       def initialize(model, foreign_key, **options)
         @model = model
-        @foreign_key = foreign_key.to_s.presence
+        @foreign_key = foreign_key.to_s.presence or raise ArgumentError "Foreign key cannot be empty: #{foreign_key.inspect}"
         @options = options
 
         @child_table_name = model.table_name # unless a table rename, which would happen when a class is renamed??

data/lib/declare_schema/model/habtm_model_shim.rb

@@ -57,7 +57,7 @@ module DeclareSchema
 
       def index_definitions_with_primary_key
         [
-          IndexDefinition.new(self, foreign_keys, unique: true, name: index_name), # creates a primary composite key on both foriegn keys
+          IndexDefinition.new(self, foreign_keys, unique: true, name: index_name), # creates a primary composite key on both foreign keys
           IndexDefinition.new(self, foreign_keys.last) # not unique by itself; combines with primary key to be unique
         ]
       end

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "1.2.3.pre.ga.2"
+  VERSION = "1.2.3.pre.ga.5"
 end

data/lib/generators/declare_schema/migration/migrator.rb

@@ -454,21 +454,7 @@ module Generators
           indexes_to_drop = existing_indexes_without_primary_key - model_indexes_without_primary_key
           indexes_to_add = model_indexes_without_primary_key - existing_indexes_without_primary_key
 
-          renamed_indexes_to_drop = []
-          renamed_indexes_to_add = []
-
-          indexes_to_drop.each { |index_to_drop|
-            renamed_columns = index_to_drop.columns.map do |column|
-              to_rename[column]
-            end
-
-            indexes_to_add.each { |index_to_add|
-              if renamed_columns == index_to_add.columns
-                renamed_indexes_to_drop.append(index_to_drop)
-                renamed_indexes_to_add.append(index_to_add)
-              end
-            }
-          }
+          renamed_indexes_to_drop, renamed_indexes_to_add = index_changes_due_to_column_renames(indexes_to_drop, indexes_to_add, to_rename)
 
           drop_indexes = (indexes_to_drop - renamed_indexes_to_drop).map do |i|
             ::DeclareSchema::SchemaChange::IndexRemove.new(new_table_name, i.columns, unique: i.unique, where: i.where, name: i.name)
@@ -482,6 +468,19 @@ module Generators
           [Array(change_primary_key) + drop_indexes + add_indexes]
         end
 
+        def index_changes_due_to_column_renames(indexes_to_drop, indexes_to_add, to_rename)
+          indexes_to_drop.each_with_object([], []) do |index_to_drop, (renamed_indexes_to_drop, renamed_indexes_to_add)|
+            renamed_columns = index_to_drop.columns.map do |column|
+              to_rename.fetch(column, column)
+            end.sort
+
+            if (index_to_add = indexes_to_add.find { |index_to_add| renamed_columns == index_to_add.columns.sort })
+              renamed_indexes_to_drop << index_to_drop
+              renamed_indexes_to_add << index_to_add
+            end
+          end
+        end
+
         def change_foreign_key_constraints(model, old_table_name, to_rename)
           ActiveRecord::Base.connection.class.name.match?(/SQLite3Adapter/) and raise ArgumentError, 'SQLite does not support foreign keys'
           ::DeclareSchema.default_generate_foreign_keys or return []
@@ -492,20 +491,7 @@ module Generators
           fks_to_drop = existing_fks - model_fks
           fks_to_add = model_fks - existing_fks
 
-          renamed_fks_to_drop = []
-          renamed_fks_to_add = []
-
-          fks_to_drop.each { |fk_to_drop|
-            fks_to_add.each { |fk_to_add|
-              if fk_to_add.child_table_name == fk_to_drop.child_table_name &&
-                fk_to_add.parent_table_name == fk_to_drop.parent_table_name &&
-                fk_to_add.foreign_key == to_rename[fk_to_drop.foreign_key]
-
-                renamed_fks_to_drop.append(fk_to_drop)
-                renamed_fks_to_add.append(fk_to_add)
-              end
-            }
-          }
+          renamed_fks_to_drop, renamed_fks_to_add = foreign_key_changes_due_to_column_renames(fks_to_drop, fks_to_add, to_rename)
 
           drop_fks = (fks_to_drop - renamed_fks_to_drop).map do |fk|
             ::DeclareSchema::SchemaChange::ForeignKeyRemove.new(fk.child_table_name, fk.parent_table_name,
@@ -521,6 +507,21 @@ module Generators
           [drop_fks + add_fks]
         end
 
+        def foreign_key_changes_due_to_column_renames(fks_to_drop, fks_to_add, to_rename)
+          fks_to_drop.each_with_object([], []) do |fk_to_drop, (renamed_fks_to_drop, renamed_fks_to_add)|
+            if (fks_to_add = fks_to_add.find do |fk_to_add|
+              fk_to_add.foreign_key.nil? and raise "Foreign key is not allowed to be nil for #{fk_to_add.inspect}"
+              if fk_to_add.child_table_name == fk_to_drop.child_table_name &&
+                fk_to_add.parent_table_name == fk_to_drop.parent_table_name &&
+                fk_to_add.foreign_key == to_rename[fk_to_drop.foreign_key]
+              end
+            end)
+              renamed_fks_to_drop << fk_to_drop
+              renamed_fks_to_add << fks_to_add
+            end
+          end
+        end
+
         def fk_field_options(model, field_name)
           foreign_key = model.constraint_specs.find { |fk| field_name == fk.foreign_key.to_s }
           if foreign_key && (parent_table = foreign_key.parent_table_name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 1.2.3.pre.ga.2
+  version: 1.2.3.pre.ga.5
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails