temporal_tables 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca70c4c007415e5835f5730f6e75f50c35c4df2d25ae815b6b40dd180609f3bc
-  data.tar.gz: 2d65f6d907abef85e2746af4090b0e03a4da70ccf6bc2bbff988440996aab48c
+  metadata.gz: 7482588a765da3aeea2a1a5d7f32fdc000ee7f4c46b1affc2d9084822dd92313
+  data.tar.gz: 18eab05d32391261c5bf39bc4ddac2b91a177550d30100da2e270530f7bee8f4
 SHA512:
-  metadata.gz: 2f67e6396728644773ef0a77e852329feb5bec150e04eb1c1172f3a366bde947b71e7d15d0056dc7fff829080002242ef04055aab8e447720e0efe622bbe5085
-  data.tar.gz: 17271125d8e63c6a8baed4ed0e7b5c9cf58bd1cfd4afeb421286226004138b335f0f50e479f4c3886e4b3143a411d715d40e273712be40996cbb57247c843939
+  metadata.gz: 25a32d75519abc56c1dcd1debb1313ffefe964d1f514b82a8ad3919af84d5072418c87d0e580668f48617e41e2ed4bb33b28edd8ae2537315a0428b85a694cf2
+  data.tar.gz: 88b6b7f2db88810911f52c37faf86412ef9f315a6d664c2785a89c486cd4a38564a8d3b0849137ea796f5fc823788b2dc5b4c5b20629593b06d380452df5ab46

data/gemfiles/Gemfile.6.0.mysql.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    temporal_tables (1.0.1)
+    temporal_tables (1.0.2)
       rails (>= 6.0, < 7.1)
 
 GEM

data/gemfiles/Gemfile.6.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    temporal_tables (1.0.1)
+    temporal_tables (1.0.2)
       rails (>= 6.0, < 7.1)
 
 GEM

data/gemfiles/Gemfile.6.1.mysql.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    temporal_tables (1.0.1)
+    temporal_tables (1.0.2)
       rails (>= 6.0, < 7.1)
 
 GEM

data/gemfiles/Gemfile.6.1.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    temporal_tables (1.0.1)
+    temporal_tables (1.0.2)
       rails (>= 6.0, < 7.1)
 
 GEM

data/gemfiles/Gemfile.7.0.mysql.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    temporal_tables (1.0.1)
+    temporal_tables (1.0.2)
       rails (>= 6.0, < 7.1)
 
 GEM

data/gemfiles/Gemfile.7.0.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    temporal_tables (1.0.1)
+    temporal_tables (1.0.2)
       rails (>= 6.0, < 7.1)
 
 GEM

data/lib/temporal_tables/connection_adapters/mysql_adapter.rb

@@ -9,9 +9,10 @@ module TemporalTables
         execute "drop trigger #{table_name}_ad"
       end
 
-      def create_temporal_triggers(table_name) # rubocop:disable Metrics/MethodLength
+      def create_temporal_triggers(table_name) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         column_names = columns(table_name).map(&:name)
 
+        execute "drop trigger if exists #{table_name}_ai"
         execute %{
           create trigger #{table_name}_ai after insert on #{table_name}
           for each row
@@ -24,6 +25,7 @@ module TemporalTables
           end
         }
 
+        execute "drop trigger if exists #{table_name}_au"
         execute %{
           create trigger #{table_name}_au after update on #{table_name}
           for each row
@@ -40,6 +42,7 @@ module TemporalTables
           end
         }
 
+        execute "drop trigger if exists #{table_name}_ad"
         execute %{
           create trigger #{table_name}_ad after delete on #{table_name}
           for each row

data/lib/temporal_tables/temporal_adapter.rb

@@ -2,7 +2,7 @@
 
 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
+    def create_table(table_name, **options, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       if options[:temporal_bypass]
         super(table_name, **options, &block)
       else
@@ -22,15 +22,15 @@ module TemporalTables
         end
 
         if options[:temporal] || (TemporalTables.create_by_default && !skip_table)
-          add_temporal_table table_name, options
+          add_temporal_table table_name, **options
         end
       end
     end
 
-    def add_temporal_table(table_name, options = {}) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+    def add_temporal_table(table_name, **options) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       create_table(
         temporal_name(table_name),
-        options.merge(id: false, primary_key: 'history_id', temporal_bypass: true)
+        **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
@@ -61,7 +61,7 @@ module TemporalTables
       drop_table_without_temporal temporal_name(table_name)
     end
 
-    def drop_table(table_name, options = {})
+    def drop_table(table_name, **options)
       super(table_name, **options)
 
       super(temporal_name(table_name), **options) if table_exists?(temporal_name(table_name))
@@ -78,30 +78,39 @@ module TemporalTables
       create_temporal_triggers new_name
     end
 
-    def add_column(table_name, column_name, type, options = {})
+    def add_column(table_name, column_name, type, **options)
       super(table_name, column_name, type, **options)
 
       return unless table_exists?(temporal_name(table_name))
 
-      super temporal_name(table_name), column_name, type, options
+      super temporal_name(table_name), column_name, type, **options
       create_temporal_triggers table_name
     end
 
-    def remove_column(table_name, *column_names)
-      super(table_name, *column_names)
+    def remove_columns(table_name, *column_names, **options)
+      super(table_name, *column_names, **options)
 
       return unless table_exists?(temporal_name(table_name))
 
-      super temporal_name(table_name), *column_names
+      super temporal_name(table_name), *column_names, **options
       create_temporal_triggers table_name
     end
 
-    def change_column(table_name, column_name, type, options = {})
-      super(table_name, column_name, type, options)
+    def remove_column(table_name, column_name, type = nil, **options)
+      super(table_name, column_name, type, **options)
 
       return unless table_exists?(temporal_name(table_name))
 
-      super temporal_name(table_name), column_name, type, options
+      super temporal_name(table_name), column_name, type, **options
+      create_temporal_triggers table_name
+    end
+
+    def change_column(table_name, column_name, type, **options)
+      super(table_name, column_name, type, **options)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      super temporal_name(table_name), column_name, type, **options
       # Don't need to update triggers here...
     end
 
@@ -114,23 +123,22 @@ module TemporalTables
       create_temporal_triggers table_name
     end
 
-    def add_index(table_name, column_name, options = {})
+    def add_index(table_name, column_name, **options)
       super(table_name, column_name, **options)
 
       return unless table_exists?(temporal_name(table_name))
 
-      column_names = Array.wrap(column_name)
-      idx_name = temporal_index_name(options[:name] || index_name(table_name, column: column_names))
-      super temporal_name(table_name), column_name, options.except(:unique).merge(name: idx_name)
+      idx_name = temporal_index_name(options[:name] || index_name(table_name, column: column_name))
+      super temporal_name(table_name), column_name, **options.except(:unique).merge(name: idx_name)
     end
 
-    def remove_index(table_name, options = {})
-      super(table_name, options)
+    def remove_index(table_name, column_name = nil, **options)
+      super(table_name, column_name, **options)
 
       return unless table_exists?(temporal_name(table_name))
 
-      idx_name = temporal_index_name(index_name(table_name, options))
-      super temporal_name(table_name), name: idx_name
+      idx_name = temporal_index_name(options[:name] || index_name_for_remove(table_name, column_name, options))
+      super temporal_name(table_name), column_name, name: idx_name
     end
 
     def create_temporal_indexes(table_name) # rubocop:disable Metrics/MethodLength
@@ -143,12 +151,11 @@ module TemporalTables
 
         add_index(
           temporal_name(table_name),
-          index.columns, {
-            # exclude unique constraints for temporal tables
-            name: index_name,
-            length: index.lengths,
-            order: index.orders
-          }
+          index.columns,
+          # exclude unique constraints for temporal tables
+          name: index_name,
+          length: index.lengths,
+          order: index.orders
         )
       end
     end

data/lib/temporal_tables/temporal_adapter_six_oh.rb

@@ -0,0 +1,187 @@
+# frozen_string_literal: true
+
+module TemporalTables
+  # The main difference here is the add_index method, which still uses
+  # the old options={} syntax
+  module TemporalAdapterSixOh # rubocop:disable Metrics/ModuleLength
+    def create_table(table_name, **options, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+      if options[:temporal_bypass]
+        super(table_name, **options, &block)
+      else
+        skip_table = TemporalTables.skipped_temporal_tables.include?(table_name.to_sym) || table_name.to_s =~ /_h$/
+
+        super(table_name, **options) do |t|
+          block.call t
+
+          if TemporalTables.add_updated_by_field && !skip_table
+            updated_by_already_exists = t.columns.any? { |c| c.name == 'updated_by' }
+            if updated_by_already_exists
+              puts "consider adding #{table_name} to TemporalTables skip_table" # rubocop:disable Rails/Output
+            else
+              t.column(:updated_by, TemporalTables.updated_by_type)
+            end
+          end
+        end
+
+        if options[:temporal] || (TemporalTables.create_by_default && !skip_table)
+          add_temporal_table table_name, **options
+        end
+      end
+    end
+
+    def add_temporal_table(table_name, **options) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      create_table(
+        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
+        end
+      end
+
+      if TemporalTables.add_updated_by_field && !column_exists?(table_name, :updated_by)
+        change_table table_name do |t|
+          t.column :updated_by, TemporalTables.updated_by_type
+        end
+      end
+
+      add_index temporal_name(table_name), [:id, :eff_to]
+      create_temporal_triggers table_name
+      create_temporal_indexes table_name
+    end
+
+    def remove_temporal_table(table_name)
+      return unless table_exists?(temporal_name(table_name))
+
+      drop_temporal_triggers table_name
+      drop_table_without_temporal temporal_name(table_name)
+    end
+
+    def drop_table(table_name, **options)
+      super(table_name, **options)
+
+      super(temporal_name(table_name), **options) if table_exists?(temporal_name(table_name))
+    end
+
+    def rename_table(name, new_name)
+      drop_temporal_triggers name if table_exists?(temporal_name(name))
+
+      super name, new_name
+
+      return unless table_exists?(temporal_name(name))
+
+      super(temporal_name(name), temporal_name(new_name))
+      create_temporal_triggers new_name
+    end
+
+    def add_column(table_name, column_name, type, **options)
+      super(table_name, column_name, type, **options)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      super temporal_name(table_name), column_name, type, **options
+      create_temporal_triggers table_name
+    end
+
+    def remove_columns(table_name, *column_names, **options)
+      super(table_name, *column_names, **options)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      super temporal_name(table_name), *column_names, **options
+      create_temporal_triggers table_name
+    end
+
+    def remove_column(table_name, column_name, type = nil, **options)
+      super(table_name, column_name, type, **options)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      super temporal_name(table_name), column_name, type, **options
+      create_temporal_triggers table_name
+    end
+
+    def change_column(table_name, column_name, type, **options)
+      super(table_name, column_name, type, **options)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      super temporal_name(table_name), column_name, type, **options
+      # Don't need to update triggers here...
+    end
+
+    def rename_column(table_name, column_name, new_column_name)
+      super(table_name, column_name, new_column_name)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      super temporal_name(table_name), column_name, new_column_name
+      create_temporal_triggers table_name
+    end
+
+    def add_index(table_name, column_name, options = {})
+      super(table_name, column_name, options)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      column_names = Array.wrap(column_name)
+      idx_name = temporal_index_name(options[:name] || index_name(table_name, column: column_names))
+      super temporal_name(table_name), column_name, options.except(:unique).merge(name: idx_name)
+    end
+
+    def remove_index(table_name, options = {})
+      super(table_name, options)
+
+      return unless table_exists?(temporal_name(table_name))
+
+      idx_name = temporal_index_name(index_name_for_remove(table_name, options))
+      super temporal_name(table_name), name: idx_name
+    end
+
+    def create_temporal_indexes(table_name) # rubocop:disable Metrics/MethodLength
+      indexes = ActiveRecord::Base.connection.indexes(table_name)
+
+      indexes.each do |index|
+        index_name = temporal_index_name(index.name)
+
+        next if temporal_index_exists?(table_name, index_name)
+
+        add_index(
+          temporal_name(table_name),
+          index.columns,
+          # exclude unique constraints for temporal tables
+          name: index_name,
+          length: index.lengths,
+          order: index.orders
+        )
+      end
+    end
+
+    def temporal_name(table_name)
+      "#{table_name}_h"
+    end
+
+    def create_temporal_triggers(_table_name)
+      raise NotImplementedError, 'create_temporal_triggers is not implemented'
+    end
+
+    def drop_temporal_triggers(_table_name)
+      raise NotImplementedError, 'drop_temporal_triggers is not implemented'
+    end
+
+    # It's important not to increase the length of the returned string.
+    def temporal_index_name(index_name)
+      index_name.to_s.sub(/^index/, 'ind_h').sub(/_ix(\d+)$/, '_hi\1')
+    end
+
+    def temporal_index_exists?(table_name, index_name)
+      index_name_exists?(temporal_name(table_name), index_name)
+    end
+  end
+end

data/lib/temporal_tables/version.rb

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

data/lib/temporal_tables.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'temporal_tables/temporal_adapter'
+require 'temporal_tables/temporal_adapter_six_oh'
 require 'temporal_tables/connection_adapters/mysql_adapter'
 require 'temporal_tables/connection_adapters/postgresql_adapter'
 require 'temporal_tables/whodunnit'
@@ -21,7 +22,11 @@ module TemporalTables
       # It's necessary to do this on the implementations in order for the
       # alias method chain hooks to work.
       ActiveRecord::ConnectionAdapters::AbstractAdapter.subclasses.each do |subclass|
-        subclass.send :prepend, TemporalTables::TemporalAdapter
+        if ActiveRecord.version < ::Gem::Version.new('6.1')
+          subclass.send :prepend, TemporalTables::TemporalAdapterSixOh
+        else
+          subclass.send :prepend, TemporalTables::TemporalAdapter
+        end
 
         module_name = subclass.name.split('::').last
         next unless TemporalTables::ConnectionAdapters.const_defined?(module_name)

data/spec/internal/db/schema.rb

@@ -9,20 +9,21 @@ end
 ActiveRecord::Schema.define do
   enable_extension 'pgcrypto' if postgres
 
-  create_table :people, temporal: true, force: true do |t|
-    t.belongs_to :coven
+  create_table :covens, force: true do |t|
     t.string :name
   end
+  add_temporal_table :covens
 
-  create_table :covens, force: true do |t|
+  create_table :people, temporal: true, force: true do |t|
+    t.belongs_to :coven
     t.string :name
   end
-  add_temporal_table :covens
+  add_index :people, :name, unique: true
 
   create_table :warts, temporal: true, force: true do |t|
     t.belongs_to :person
-    t.integer :hairiness
   end
+  add_column :warts, :hairiness, :integer
 
   create_table :flying_machines, temporal: true, force: true do |t|
     t.belongs_to :person

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: temporal_tables
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Brent Kroeker
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-18 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -184,6 +184,7 @@ files:
 - lib/temporal_tables/reflection_extensions.rb
 - lib/temporal_tables/relation_extensions.rb
 - lib/temporal_tables/temporal_adapter.rb
+- lib/temporal_tables/temporal_adapter_six_oh.rb
 - lib/temporal_tables/temporal_class.rb
 - lib/temporal_tables/version.rb
 - lib/temporal_tables/whodunnit.rb