declare_schema 1.3.1.colin.1 → 1.3.2.rp.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0f533d7dc8d88f7a84002c3f683cc4afa1a50af764fb6f478fb6d21f06d3d00
-  data.tar.gz: a033eb5411618bf7d0e1beb51176aa682a7362820df942df52f9d87818875237
+  metadata.gz: 177fdef8d03843627f34a461487ec92d222e5d18efe3a4881bc1b4326a069e99
+  data.tar.gz: d5dac684d51bfad5e7e92214fcc9a7e1b4020a70aa4cd2fd8a5bbb0c718f1c71
 SHA512:
-  metadata.gz: eb1c42caab31adbd01450a2c94c7a15d4c535bc1e8b89a50370f95796adad9bc21d297969c463febc77f7ba3f64ccd4a79cb68480bf02baff2f864302f435cd1
-  data.tar.gz: f2882b79e6eadd987d064e9adb742e5d2adea31c1de9a716fdd5a05a1c6a9e54491b8d5825ef9f310038e430ca2c54af08dad0c389202ff101a659065dc6b942
+  metadata.gz: 7bdc6408f561f9aa70dad7e2208ae2022f8b30adce1c1350f598cae1c93b4dbd9f65f61a97324282fad9f0d2dd2126e90dda199781040f08564bc6998121c670
+  data.tar.gz: 1057a1c6202b77f5854b119208227c7a7341f2c3d0cab7eb7a743322ebb60bddaec4eb77671d60035e610789a9d73c7b345868262aebe0e6052ff2c17c8a6d81

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.2

data/CHANGELOG.md

@@ -4,9 +4,13 @@ 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.3.1] - Unreleased
+## [1.3.2] - Unreleased
 ### Fixed
-- Fix bug in default index anme when table name + __ + column suffix exceeds `DeclareSchema.max_index_and_constraint_name_length`.
+- Fix bug in migrator when table option definitions differ
+
+## [1.3.1] - 2023-10-12
+### Fixed
+- Fix bug in default index name when table name + __ + column suffix exceeds `DeclareSchema.max_index_and_constraint_name_length`.
   In this case we truncate the table name and append part of its hash.
 
 ## [1.3.0] - 2023-07-10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (1.3.1.colin.1)
+    declare_schema (1.3.2.rp.1)
       rails (>= 5.0)
 
 GEM

data/lib/declare_schema/model/index_definition.rb

@@ -66,7 +66,7 @@ module DeclareSchema
               break index_name
             end
           end or raise IndexNameTooLongError,
-                       "Index '#{index_name}' exceeds configured limit of #{DeclareSchema.max_index_and_constraint_name_length} characters."
+                       "Default index name '#{index_name}' exceeds configured limit of #{DeclareSchema.max_index_and_constraint_name_length} characters. Use the `name:` option to give it a shorter name, or adjust DeclareSchema.max_index_and_constraint_name_length if you know your database can accept longer names."
         end
 
         private

data/lib/declare_schema/model/table_options_definition.rb

@@ -57,6 +57,9 @@ module DeclareSchema
         @key ||= [table_name, table_options].map(&:to_s)
       end
 
+      # Flatten out/join table options as a space-separated string
+      #
+      # @return [String] Table options as a string
       def settings
         @settings ||= table_options.map { |name, value| "#{TABLE_OPTIONS_TO_SQL_MAPPINGS[name]} #{value}" if value }.compact.join(" ")
       end

data/lib/declare_schema/schema_change/table_change.rb

@@ -5,8 +5,15 @@ require_relative 'base'
 module DeclareSchema
   module SchemaChange
     class TableChange < Base
+
+      # @param [String] table_name  The name of the table being changed
+      # @param [Hash]   old_options The old/existing table option definitions
+      # @param [Hash]   new_options The new/existing table option definitions
       def initialize(table_name, old_options, new_options)
-        @table_name = table_name
+        old_options.is_a?(Hash) or raise ArgumentError, "old_options must be a Hash but is: #{old_options.inspect}"
+        new_options.is_a?(Hash) or raise ArgumentError, "new_options must be a Hash but is: #{new_options.inspect}"
+
+        @table_name  = table_name
         @old_options = old_options
         @new_options = new_options
       end

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "1.3.1.colin.1"
+  VERSION = "1.3.2.rp.1"
 end

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

@@ -548,8 +548,8 @@ module Generators
           else
             [
               ::DeclareSchema::SchemaChange::TableChange.new(current_table_name,
-                                                             old_options_definition.settings,
-                                                             new_options_definition.settings)
+                                                             old_options_definition.table_options,
+                                                             new_options_definition.table_options)
             ]
           end
         end

data/spec/lib/declare_schema/model/index_definition_spec.rb

@@ -156,6 +156,7 @@ RSpec.describe DeclareSchema::Model::IndexDefinition do
           50 => 'user_domains4814__last_name_first_name_middle_name',
           51 => 'user_domains_4814__last_name_first_name_middle_name',
           52 => 'user_domains_extra__last_name_first_name_middle_name',
+          53 => 'user_domains_extra__last_name_first_name_middle_name',
         }.each do |len, index_name|
           context "with max_index_and_constraint_name_length of #{len}" do
             let(:max_index_and_constraint_name_length) { len }
@@ -169,7 +170,7 @@ RSpec.describe DeclareSchema::Model::IndexDefinition do
 
           it 'raises' do
             expect { subject }.to raise_exception(DeclareSchema::Model::IndexDefinition::IndexNameTooLongError,
-                                                  /Index '__last_name_first_name_middle_name' exceeds configured limit of 33 characters/)
+                                                  /Default index name '__last_name_first_name_middle_name' exceeds configured limit of 33 characters\. Use the `name:` option to give it a shorter name, or adjust DeclareSchema\.max_index_and_constraint_name_length/i)
           end
         end
       end

data/spec/lib/declare_schema/schema_change/table_change_spec.rb

@@ -7,23 +7,52 @@ RSpec.describe DeclareSchema::SchemaChange::TableChange do
     load File.expand_path('../prepare_testapp.rb', __dir__)
   end
 
-  let(:table_name) { 'networks' }
-  let(:old_options) { { charset: 'utf8', collation: 'utf8_ci' } }
-  let(:new_options) { { charset: 'utf8mb4', collation: 'utf8mb4_bin' } }
-  subject { described_class.new(table_name, old_options, new_options) }
+  let(:table_name)     { 'networks' }
+  let(:old_options)    { { charset: 'utf8', collation: 'utf8_ci' } }
+  let(:new_options)    { { charset: 'utf8mb4', collation: 'utf8mb4_bin' } }
+  let(:options_string) { 'CHARACTER SET utf8mb4 COLLATE utf8mb4_bin' }
+  subject              { described_class.new(table_name, old_options, new_options) }
 
   describe '#up/down' do
-    describe '#up' do
-      it 'responds with command' do
-        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} CHARACTER SET utf8mb4 COLLATE utf8mb4_bin"
-        expect(subject.up).to eq("execute #{statement.inspect}\n")
+    context 'when Hashes are used to construct the TableChange' do
+      it 'does not raise' do
+        described_class.new(table_name, old_options, new_options)
+      end
+
+      describe '#up' do
+        it 'responds with command' do
+          statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} CHARACTER SET utf8mb4 COLLATE utf8mb4_bin"
+          expect(subject.up).to eq("execute #{statement.inspect}\n")
+        end
+      end
+
+      describe '#down' do
+        it 'responds with command' do
+          statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} CHARACTER SET utf8 COLLATE utf8_ci"
+          expect(subject.down).to eq("execute #{statement.inspect}\n")
+        end
       end
     end
 
-    describe '#down' do
-      it 'responds with command' do
-        statement = "ALTER TABLE #{ActiveRecord::Base.connection.quote_table_name(table_name)} CHARACTER SET utf8 COLLATE utf8_ci"
-        expect(subject.down).to eq("execute #{statement.inspect}\n")
+    context 'when Strings are used to construct the TableChange' do
+      context 'when old_options is a string' do
+        subject { described_class.new(table_name, options_string, new_options) }
+
+        it 'raises' do
+          expect {
+            subject
+          }.to raise_exception(ArgumentError, /old_options must be a Hash but is: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin"/)
+        end
+      end
+
+      context 'when new_options is a string' do
+        subject { described_class.new(table_name, old_options, options_string) }
+
+        it 'raises' do
+          expect {
+            subject
+          }.to raise_exception(ArgumentError, /new_options must be a Hash but is: "CHARACTER SET utf8mb4 COLLATE utf8mb4_bin"/)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 1.3.1.colin.1
+  version: 1.3.2.rp.1
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 2024-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Database schema declaration and migration generator for Rails