temporal_tables 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf7a65a415b9c610e9ea05fd20ddbe8466dd37279f65bf62d4d499cab1d5527f
-  data.tar.gz: 803d774d51c82624c33b4fd732d2f2b9c6f16fe288725aca6ced174f7e35071e
+  metadata.gz: 60c0235cfec08bde495d37a7304eeca6a0bd46aa310224b8a240bbc2ff98bd23
+  data.tar.gz: b68fb0409c0fd389e6a544f0d3ba10f560da3e6536e6dff5a3655e8fe21c3494
 SHA512:
-  metadata.gz: 7d3599da77f429b650b262128841864d774ec3be87dc5393702146f06d2fb5acc2ff8fd0c146e02cc328eb563b07f1d3a9638551dcc3a63d25ccbedc29d48e53
-  data.tar.gz: 6ce73a4fac38c371fe1d663e1970ee09e824b1e476872e5e7cf49c3b488ea9811efae0754798f8b39b60e340d14b9944fdeb8ed27fc4f20fb19386b4170f9ffb
+  metadata.gz: 2b9e2a3855dcce4b6f50a40e887451097efe51377cd3edbfe4ee7af6023dfb62f3f8deb9d3664827cc7db6426d29aab235349ab33b00b691b7dcaca639c0874b
+  data.tar.gz: f35f963e1540f869f0d0375d63aacd02eb76805a51f11324163712e48a7e38e54153c6ab496088edfc647dc3dfa1b689d03d17908033c9addd10fad6138ff5ac

data/lib/temporal_tables/connection_adapters/mysql_adapter.rb

@@ -9,7 +9,7 @@ module TemporalTables
         execute "drop trigger #{table_name}_ad"
       end
 
-      def create_temporal_triggers(table_name) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      def create_temporal_triggers(table_name, primary_key) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         column_names = columns(table_name).map(&:name)
 
         execute "drop trigger if exists #{table_name}_ai"
@@ -33,7 +33,7 @@ module TemporalTables
             set @current_time = utc_timestamp(6);
 
             update #{temporal_name(table_name)} set eff_to = @current_time
-            where id = new.id
+            where #{primary_key} = new.#{primary_key}
             and eff_to = '9999-12-31';
 
             insert into #{temporal_name(table_name)} (#{column_names.join(', ')}, eff_from)
@@ -50,7 +50,7 @@ module TemporalTables
             set @current_time = utc_timestamp(6);
 
             update #{temporal_name(table_name)} set eff_to = @current_time
-            where id = old.id
+            where #{primary_key} = old.#{primary_key}
             and eff_to = '9999-12-31';
 
           end

data/lib/temporal_tables/connection_adapters/postgresql_adapter.rb

@@ -9,7 +9,7 @@ module TemporalTables
         execute "drop trigger #{table_name}_ad on #{table_name}"
       end
 
-      def create_temporal_triggers(table_name) # rubocop:disable Metrics/MethodLength
+      def create_temporal_triggers(table_name, primary_key) # rubocop:disable Metrics/MethodLength
         column_names = columns(table_name).map(&:name)
 
         execute %{
@@ -39,7 +39,7 @@ module TemporalTables
               cur_time := localtimestamp;
 
               update #{temporal_name(table_name)} set eff_to = cur_time
-              where id = new.id
+              where #{primary_key} = new.#{primary_key}
                 and eff_to = '9999-12-31';
 
               insert into #{temporal_name(table_name)} (#{column_list(column_names)}, eff_from)
@@ -62,7 +62,7 @@ module TemporalTables
               cur_time := localtimestamp;
 
               update #{temporal_name(table_name)} set eff_to = cur_time
-              where id = old.id
+              where #{primary_key} = old.#{primary_key}
                 and eff_to = '9999-12-31';
 
               return null;

data/lib/temporal_tables/history_hook.rb

@@ -45,7 +45,7 @@ module TemporalTables
     def history
       clazz = is_a?(TemporalTables::TemporalClass) ? self.class : self.class.history
       oid = is_a?(TemporalTables::TemporalClass) ? orig_class.primary_key : self.class.primary_key
-      clazz.unscoped.where(id: attributes[oid]).order(:eff_from)
+      clazz.unscoped.where(oid => attributes[oid]).order(:eff_from)
     end
   end
 end

data/lib/temporal_tables/temporal_adapter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest'
+
 module TemporalTables
   module TemporalAdapter # rubocop:disable Metrics/ModuleLength
     def create_table(table_name, **options, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
@@ -32,14 +34,22 @@ module TemporalTables
         temporal_name(table_name),
         **options.merge(id: false, primary_key: 'history_id', temporal_bypass: true)
       ) do |t|
-        t.column :id, options.fetch(:id, :integer) if options[:id] != false
         t.datetime :eff_from, null: false, limit: 6
         t.datetime :eff_to,   null: false, limit: 6, default: '9999-12-31'
 
         columns(table_name).each do |c|
-          next if c.name == 'id'
+          column_options = { limit: c.limit }
+          column_type = c.type
+          if column_type == :enum
+            enum_type = c.sql_type_metadata.sql_type
+            if t.respond_to?(:enum)
+              column_options[:enum_type] = enum_type
+            else
+              column_type = enum_type
+            end
+          end
 
-          t.send c.type, c.name, limit: c.limit
+          t.column c.name, column_type, **column_options
         end
       end
 
@@ -49,8 +59,13 @@ module TemporalTables
         end
       end
 
-      add_index temporal_name(table_name), [:id, :eff_to]
-      create_temporal_triggers table_name
+      original_primary_key = original_primary_key(table_name)
+      temporal_table_index_name = index_name(temporal_name(table_name), [original_primary_key, :eff_to])
+      if temporal_table_index_name.length > index_name_length
+        temporal_table_index_name = truncated_index_name(temporal_table_index_name)
+      end
+      add_index temporal_name(table_name), [original_primary_key, :eff_to], name: temporal_table_index_name
+      create_temporal_triggers table_name, original_primary_key
       create_temporal_indexes table_name
     end
 
@@ -75,7 +90,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(name))
 
       super(temporal_name(name), temporal_name(new_name))
-      create_temporal_triggers new_name
+      create_temporal_triggers new_name, original_primary_key(table_name)
     end
 
     def add_column(table_name, column_name, type, **options)
@@ -84,7 +99,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), column_name, type, **options
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def remove_columns(table_name, *column_names, **options)
@@ -93,7 +108,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), *column_names, **options
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def remove_column(table_name, column_name, type = nil, **options)
@@ -102,7 +117,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), column_name, type, **options
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def change_column(table_name, column_name, type, **options)
@@ -120,7 +135,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), column_name, new_column_name
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def add_index(table_name, column_name, **options)
@@ -173,13 +188,27 @@ module TemporalTables
       raise NotImplementedError, 'drop_temporal_triggers is not implemented'
     end
 
-    # It's important not to increase the length of the returned string.
+    # Index names max out at 63 characters. If appending _h to the index name would surpass that limit,
+    # we can trim the index name and append a deterministically generated 5 character hash as well as _h.
     def temporal_index_name(index_name)
-      index_name.to_s.sub(/^index/, 'ind_h').sub(/_ix(\d+)$/, '_hi\1')
+      "#{index_name.length < 62 ? index_name : truncated_index_name(index_name, 2)}_h"
+    end
+
+    def truncated_index_name(index_name, required_padding = 0)
+      max_length = index_name_length - required_padding
+      index_name_hash = Digest::SHA1.base64digest(index_name.to_s)[0, 5]
+      "#{index_name[0, max_length - 6]}_#{index_name_hash}"
     end
 
     def temporal_index_exists?(table_name, index_name)
       index_name_exists?(temporal_name(table_name), index_name)
     end
+
+    def original_primary_key(table_name)
+      original_primary_key = primary_key(table_name)
+      raise 'temporal_adapter requires that the table has a single primary key' unless original_primary_key.is_a? String
+
+      original_primary_key
+    end
   end
 end

data/lib/temporal_tables/temporal_adapter_six_oh.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'digest'
+
 module TemporalTables
   # The main difference here is the add_index method, which still uses
   # the old options={} syntax
@@ -34,14 +36,12 @@ module TemporalTables
         temporal_name(table_name),
         **options.merge(id: false, primary_key: 'history_id', temporal_bypass: true)
       ) do |t|
-        t.column :id, options.fetch(:id, :integer) if options[:id] != false
         t.datetime :eff_from, null: false, limit: 6
         t.datetime :eff_to,   null: false, limit: 6, default: '9999-12-31'
 
         columns(table_name).each do |c|
-          next if c.name == 'id'
-
-          t.send c.type, c.name, limit: c.limit
+          column_type = c.type == :enum ? c.sql_type_metadata.sql_type : c.type
+          t.column c.name, column_type, limit: c.limit
         end
       end
 
@@ -51,8 +51,13 @@ module TemporalTables
         end
       end
 
-      add_index temporal_name(table_name), [:id, :eff_to]
-      create_temporal_triggers table_name
+      original_primary_key = original_primary_key(table_name)
+      temporal_table_index_name = index_name(temporal_name(table_name), [original_primary_key, :eff_to])
+      if temporal_table_index_name.length > index_name_length
+        temporal_table_index_name = truncated_index_name(temporal_table_index_name)
+      end
+      add_index temporal_name(table_name), [original_primary_key, :eff_to], { name: temporal_table_index_name }
+      create_temporal_triggers table_name, original_primary_key
       create_temporal_indexes table_name
     end
 
@@ -77,7 +82,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(name))
 
       super(temporal_name(name), temporal_name(new_name))
-      create_temporal_triggers new_name
+      create_temporal_triggers new_name, original_primary_key(table_name)
     end
 
     def add_column(table_name, column_name, type, **options)
@@ -86,7 +91,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), column_name, type, **options
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def remove_columns(table_name, *column_names, **options)
@@ -95,7 +100,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), *column_names, **options
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def remove_column(table_name, column_name, type = nil, **options)
@@ -104,7 +109,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), column_name, type, **options
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def change_column(table_name, column_name, type, **options)
@@ -122,7 +127,7 @@ module TemporalTables
       return unless table_exists?(temporal_name(table_name))
 
       super temporal_name(table_name), column_name, new_column_name
-      create_temporal_triggers table_name
+      create_temporal_triggers table_name, original_primary_key(table_name)
     end
 
     def add_index(table_name, column_name, options = {})
@@ -176,13 +181,27 @@ module TemporalTables
       raise NotImplementedError, 'drop_temporal_triggers is not implemented'
     end
 
-    # It's important not to increase the length of the returned string.
+    # Index names max out at 63 characters. If appending _h to the index name would surpass that limit,
+    # we can trim the index name and append a deterministically generated 5 character hash as well as _h.
     def temporal_index_name(index_name)
-      index_name.to_s.sub(/^index/, 'ind_h').sub(/_ix(\d+)$/, '_hi\1')
+      "#{index_name.length < 62 ? index_name : truncated_index_name(index_name, 2)}_h"
+    end
+
+    def truncated_index_name(index_name, required_padding = 0)
+      max_length = index_name_length - required_padding
+      index_name_hash = Digest::SHA1.base64digest(index_name.to_s)[0, 5]
+      "#{index_name[0, max_length - 6]}_#{index_name_hash}"
     end
 
     def temporal_index_exists?(table_name, index_name)
       index_name_exists?(temporal_name(table_name), index_name)
     end
+
+    def original_primary_key(table_name)
+      original_primary_key = primary_key(table_name)
+      raise 'temporal_adapter requires that the table has a single primary key' unless original_primary_key.is_a? String
+
+      original_primary_key
+    end
   end
 end

data/lib/temporal_tables/temporal_class.rb

@@ -90,7 +90,7 @@ module TemporalTables
     end
 
     def orig_obj
-      @orig_obj ||= orig_class.find_by id: orig_id
+      @orig_obj ||= orig_class.find_by(orig_class.primary_key => orig_id)
     end
 
     def prev

data/lib/temporal_tables/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TemporalTables
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

data/spec/basic_history_spec.rb

@@ -161,6 +161,12 @@ describe Person do
       cat.lives.create started_at: Time.zone.now
     end
 
+    # The following tests enum type columns for postgres
+    it 'breed is set correctly' do
+      expect(cat.breed).to eq('ragdoll')
+      expect(cat.history.last.breed).to eq('ragdoll')
+    end
+
     it 'shows one life at the beginning' do
       expect(cat.history.at(@init_time).last.lives.size).to eq(1)
     end
@@ -169,4 +175,37 @@ describe Person do
       expect(cat.history.last.lives.size).to eq(2)
     end
   end
+
+  # The following tests PKs with names other than "id"
+  describe 'when spawning and renaming a creature with PK not named id' do
+    let!(:dog) { Dog.create name: 'Fido' }
+
+    context 'Fido is renamed to Max' do
+      before do
+        dog.name = 'Max'
+        dog.save!
+      end
+
+      it 'name is set correctly and we remember Max\'s original name' do
+        expect(dog.name).to eq('Max')
+        expect(dog.history.last.name).to eq('Max')
+
+        fido = dog.history.first
+        expect(fido.name).to eq('Fido')
+        expect(fido.orig_obj.name).to eq('Max')
+      end
+
+      context 'Max is rehomed' do
+        before do
+          dog.destroy!
+        end
+
+        it 'Max is no longer home but Max/Fido lives on in our memories' do
+          expect(Dog.count).to eq(0)
+          expect(dog.history.last.name).to eq('Max')
+          expect(dog.history.first.name).to eq('Fido')
+        end
+      end
+    end
+  end
 end

data/spec/internal/app/models/dog.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Dog < ActiveRecord::Base
+  self.primary_key = :dog_id
+end

data/spec/internal/db/schema.rb

@@ -7,7 +7,12 @@ rescue NameError
 end
 
 ActiveRecord::Schema.define do
-  enable_extension 'pgcrypto' if postgres
+  if postgres
+    enable_extension 'pgcrypto'
+    execute <<-SQL
+      CREATE TYPE cat_breed AS ENUM ('ragdoll', 'persian', 'sphynx');
+    SQL
+  end
 
   create_table :covens, force: true do |t|
     t.string :name
@@ -36,6 +41,7 @@ ActiveRecord::Schema.define do
   create_table :cats, id: (postgres ? :uuid : :integer), temporal: true, force: true do |t|
     t.string :name
     t.string :color
+    t.column :breed, (postgres ? :cat_breed : :string), null: false, default: 'ragdoll'
   end
 
   create_table :cat_lives, id: (postgres ? :uuid : :integer), temporal: true do |t|
@@ -44,4 +50,14 @@ ActiveRecord::Schema.define do
     t.timestamp :ended_at
     t.string :death_reason
   end
+
+  create_table :dogs, primary_key: 'dog_id', temporal: true do |t|
+    t.string :name
+  end
+  add_index :dogs, :name, name: 'name_index_with_a_name_that_happens_to_be_exactly_63_chars_long'
+  remove_index :dogs, name: :name_index_with_a_name_that_happens_to_be_exactly_63_chars_long
+
+  create_table :a_very_very_very_very_very_long_table_name, temporal: true do |t|
+    t.string :name
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: temporal_tables
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Brent Kroeker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -193,6 +193,7 @@ files:
 - spec/internal/app/models/cat.rb
 - spec/internal/app/models/cat_life.rb
 - spec/internal/app/models/coven.rb
+- spec/internal/app/models/dog.rb
 - spec/internal/app/models/flying_machine.rb
 - spec/internal/app/models/person.rb
 - spec/internal/app/models/rocket_broom.rb
@@ -234,6 +235,7 @@ test_files:
 - spec/internal/app/models/cat.rb
 - spec/internal/app/models/cat_life.rb
 - spec/internal/app/models/coven.rb
+- spec/internal/app/models/dog.rb
 - spec/internal/app/models/flying_machine.rb
 - spec/internal/app/models/person.rb
 - spec/internal/app/models/rocket_broom.rb