declare_schema 1.3.0 → 1.3.1.colin.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51aba0260c648b9baab8e50a93ff384d4e8b2f39d6dd9284f9fbd900773f9207
-  data.tar.gz: 9cb9859880e62e726fc87b5e9d6893eabfc9ec102be35139a1a390fffba6a7ce
+  metadata.gz: a0f533d7dc8d88f7a84002c3f683cc4afa1a50af764fb6f478fb6d21f06d3d00
+  data.tar.gz: a033eb5411618bf7d0e1beb51176aa682a7362820df942df52f9d87818875237
 SHA512:
-  metadata.gz: 3314c3544ffde59d7447dec0c64060355f4dd30ee659eae769029deb4f486df8347290c674ab368321a71be6072bada62a6217c60eaaade2780e2fda0c70e258
-  data.tar.gz: 5f1e040b3f8edaee24375e79cba08b4da33df9ec400a884dfe8f4445485723110ea85763456708d7cd59f28060a332f6800795ebfae71ea3cd53cf03ddaf0934
+  metadata.gz: eb1c42caab31adbd01450a2c94c7a15d4c535bc1e8b89a50370f95796adad9bc21d297969c463febc77f7ba3f64ccd4a79cb68480bf02baff2f864302f435cd1
+  data.tar.gz: f2882b79e6eadd987d064e9adb742e5d2adea31c1de9a716fdd5a05a1c6a9e54491b8d5825ef9f310038e430ca2c54af08dad0c389202ff101a659065dc6b942

data/CHANGELOG.md

@@ -4,6 +4,11 @@ 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
+### Fixed
+- Fix bug in default index anme 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
 ### Added
 - Added `DeclareSchema.max_index_and_constraint_name_length` with default of 64.

data/Gemfile.lock

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

data/lib/declare_schema/model/index_definition.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest/sha2'
+
 module DeclareSchema
   module Model
     class IndexDefinition
@@ -69,12 +71,30 @@ module DeclareSchema
 
         private
 
+        SHA_SUFFIX_LENGTH = 4
+
+        def shorten_name(name, max_len)
+          if name.size <= max_len
+            name
+          else
+            name_prefix = name.first(max_len >= SHA_SUFFIX_LENGTH*2 ? (max_len - SHA_SUFFIX_LENGTH) : ((max_len + 1)/2))
+            sha = Digest::SHA256.hexdigest(name)
+            (name_prefix + sha).first(max_len)
+          end
+        end
+
         def long_index_name(table_name, columns)
           "index_#{table_name}_on_#{Array(columns).join("_and_")}"
         end
 
         def short_index_name(table_name, columns)
-          "#{table_name}__#{Array(columns).join("_")}"
+          columns_suffix = "__" + Array(columns).join('_')
+          if DeclareSchema.max_index_and_constraint_name_length.nil?
+            table_name + columns_suffix
+          else
+            max_name_len = [DeclareSchema.max_index_and_constraint_name_length - columns_suffix.length, 0].max
+            shorten_name(table_name, max_name_len) + columns_suffix
+          end
         end
       end
 

data/lib/declare_schema/version.rb

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

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

@@ -133,6 +133,46 @@ RSpec.describe DeclareSchema::Model::IndexDefinition do
 
         it { is_expected.to eq("users__last_name_first_name_middle_name") }
       end
+
+      context 'with long table name' do
+        let(:table_name2) { 'user_domains_extra' }
+        {
+          34 => '__last_name_first_name_middle_name',
+          35 => 'u__last_name_first_name_middle_name',
+          36 => 'u4__last_name_first_name_middle_name',
+          37 => 'us4__last_name_first_name_middle_name',
+          38 => 'us48__last_name_first_name_middle_name',
+          39 => 'use48__last_name_first_name_middle_name',
+          40 => 'use481__last_name_first_name_middle_name',
+          41 => 'user481__last_name_first_name_middle_name',
+          42 => 'user4814__last_name_first_name_middle_name',
+          43 => 'user_4814__last_name_first_name_middle_name',
+          44 => 'user_d4814__last_name_first_name_middle_name',
+          45 => 'user_do4814__last_name_first_name_middle_name',
+          46 => 'user_dom4814__last_name_first_name_middle_name',
+          47 => 'user_doma4814__last_name_first_name_middle_name',
+          48 => 'user_domai4814__last_name_first_name_middle_name',
+          49 => 'user_domain4814__last_name_first_name_middle_name',
+          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',
+        }.each do |len, index_name|
+          context "with max_index_and_constraint_name_length of #{len}" do
+            let(:max_index_and_constraint_name_length) { len }
+
+            it { is_expected.to eq(index_name) }
+          end
+        end
+
+        context "with max_index_and_constraint_name_length shorter than columns suffix" do
+          let(:max_index_and_constraint_name_length) { 33 }
+
+          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/)
+          end
+        end
+      end
     end
   end
   # TODO: fill out remaining tests

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1.colin.1
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails