temporal_tables 1.1.0 → 3.0.0.pre.rc.1

data/gemfiles/Gemfile.7.1.pg.lock

@@ -0,0 +1,266 @@
+PATH
+  remote: ..
+  specs:
+    temporal_tables (3.0.0)
+      rails (>= 6.0, < 7.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.2)
+      actionpack (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.2)
+      actionpack (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activesupport (= 7.1.2)
+      marcel (~> 1.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
+    builder (3.2.4)
+    byebug (11.1.3)
+    combustion (1.3.7)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    database_cleaner (2.0.2)
+      database_cleaner-active_record (>= 2, < 3)
+    database_cleaner-active_record (2.1.0)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    date (3.3.4)
+    diff-lcs (1.5.0)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    gemika (0.8.2)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.1)
+    irb (1.11.0)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    net-imap (0.4.9)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.0)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.4)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.2)
+      actioncable (= 7.1.2)
+      actionmailbox (= 7.1.2)
+      actionmailer (= 7.1.2)
+      actionpack (= 7.1.2)
+      actiontext (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activemodel (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.0)
+      rubocop (~> 1.33)
+    rubocop-rails (2.23.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    stringio (3.1.0)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  combustion
+  database_cleaner
+  gemika
+  pg (>= 0.18, < 2.0)
+  rails (~> 7.1.0)
+  rake
+  rspec (~> 3.4)
+  rubocop
+  rubocop-rails
+  rubocop-rspec
+  temporal_tables!
+
+BUNDLED WITH
+   2.4.10

data/lib/temporal_tables/arel_table.rb

@@ -9,7 +9,7 @@ module TemporalTables
       if at_value
         join =
           join
-          .and(to[:eff_to].gteq(at_value))
+          .and(to[:eff_to].gt(at_value).or(to[:eff_to].eq(TemporalTables::END_OF_TIME)))
           .and(to[:eff_from].lteq(at_value))
       end
       join

data/lib/temporal_tables/association_extensions.rb

@@ -16,6 +16,14 @@ module TemporalTables
         super
       end
     end
+
+    # There seems to be an issue with the statement cache for history associations.
+    # This may be due to the at_value not being part of how the relations are hashed,
+    # or that the cached statements are not parameterized. Will require further investigation.
+    # In the meantime, we can workaround this issue by disabling the statement cache for History queries.
+    def skip_statement_cache?(scope)
+      klass.is_a?(TemporalTables::TemporalClass::ClassMethods) || super(scope)
+    end
   end
 end
 

data/lib/temporal_tables/connection_adapters/mysql_adapter.rb

@@ -34,7 +34,7 @@ module TemporalTables
 
             update #{temporal_name(table_name)} set eff_to = @current_time
             where #{primary_key} = new.#{primary_key}
-            and eff_to = '9999-12-31';
+            and eff_to = '#{TemporalTables::END_OF_TIME}';
 
             insert into #{temporal_name(table_name)} (#{column_names.join(', ')}, eff_from)
             values (#{column_names.collect { |c| "new.#{c}" }.join(', ')}, @current_time);
@@ -51,7 +51,7 @@ module TemporalTables
 
             update #{temporal_name(table_name)} set eff_to = @current_time
             where #{primary_key} = old.#{primary_key}
-            and eff_to = '9999-12-31';
+            and eff_to = '#{TemporalTables::END_OF_TIME}';
 
           end
         }

data/lib/temporal_tables/connection_adapters/postgresql_adapter.rb

@@ -40,7 +40,7 @@ module TemporalTables
 
               update #{temporal_name(table_name)} set eff_to = cur_time
               where #{primary_key} = new.#{primary_key}
-                and eff_to = '9999-12-31';
+                and eff_to = '#{TemporalTables::END_OF_TIME}';
 
               insert into #{temporal_name(table_name)} (#{column_list(column_names)}, eff_from)
               values (#{column_names.collect { |c| "new.#{c}" }.join(', ')}, cur_time);
@@ -63,7 +63,7 @@ module TemporalTables
 
               update #{temporal_name(table_name)} set eff_to = cur_time
               where #{primary_key} = old.#{primary_key}
-                and eff_to = '9999-12-31';
+                and eff_to = '#{TemporalTables::END_OF_TIME}';
 
               return null;
             end

data/lib/temporal_tables/constants.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TemporalTables
+  END_OF_TIME = '9999-12-31'
+end

data/lib/temporal_tables/temporal_adapter.rb

@@ -5,12 +5,13 @@ 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
+      valid_options = options.except(:temporal, :temporal_bypass)
       if options[:temporal_bypass]
-        super(table_name, **options, &block)
+        super(table_name, **valid_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|
+        super(table_name, **valid_options) do |t|
           block.call t
 
           if TemporalTables.add_updated_by_field && !skip_table
@@ -35,7 +36,7 @@ module TemporalTables
         **options.merge(id: false, primary_key: 'history_id', temporal_bypass: true)
       ) do |t|
         t.datetime :eff_from, null: false, limit: 6
-        t.datetime :eff_to,   null: false, limit: 6, default: '9999-12-31'
+        t.datetime :eff_to,   null: false, limit: 6, default: TemporalTables::END_OF_TIME
 
         columns(table_name).each do |c|
           column_options = { limit: c.limit }

data/lib/temporal_tables/temporal_class.rb

@@ -33,7 +33,7 @@ module TemporalTables
 
             # Calling .history here will ensure that the history class
             # for this association is created and initialized
-            clazz = association.class_name.constantize.history
+            clazz = association.klass.history
 
             # Recreate the association, updating it to point at the
             # history class.  The foreign key is explicitly set since it's
@@ -74,8 +74,10 @@ module TemporalTables
 
       delegate :descends_from_active_record?, to: :superclass
 
+      # An object at a given time should fall within the range, excluding the effective end date.
+      # However, when using '9999-12-31', this is effectively infinity and should not be excluded.
       def build_temporal_constraint(at_value)
-        arel_table[:eff_to].gteq(at_value).and(
+        arel_table[:eff_to].gt(at_value).or(arel_table[:eff_to].eq(TemporalTables::END_OF_TIME)).and(
           arel_table[:eff_from].lteq(at_value)
         )
       end

data/lib/temporal_tables/version.rb

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

data/lib/temporal_tables.rb

@@ -1,7 +1,6 @@
 # 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'
@@ -12,6 +11,7 @@ require 'temporal_tables/association_extensions'
 require 'temporal_tables/preloader_extensions'
 require 'temporal_tables/reflection_extensions'
 require 'temporal_tables/arel_table'
+require 'temporal_tables/constants'
 require 'temporal_tables/version'
 
 module TemporalTables
@@ -22,11 +22,7 @@ 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|
-        if ActiveRecord.version < ::Gem::Version.new('6.1')
-          subclass.send :prepend, TemporalTables::TemporalAdapterSixOh
-        else
-          subclass.send :prepend, TemporalTables::TemporalAdapter
-        end
+        subclass.send :prepend, TemporalTables::TemporalAdapter
 
         module_name = subclass.name.split('::').last
         next unless TemporalTables::ConnectionAdapters.const_defined?(module_name)

data/spec/basic_history_spec.rb

@@ -90,10 +90,10 @@ describe Person do
         where = sql[4]
 
         expect(from.scan(/.warts_h.\..eff_from./i).count).to eq(1)
-        expect(from.scan(/.warts_h.\..eff_to./i).count).to eq(1)
+        expect(from.scan(/.warts_h.\..eff_to./i).count).to eq(2)
 
         expect(where.scan(/.people_h.\..eff_from./i).count).to eq(1)
-        expect(where.scan(/.people_h.\..eff_to./i).count).to eq(1)
+        expect(where.scan(/.people_h.\..eff_to./i).count).to eq(2)
         expect(where.scan(/.warts_h.\..eff_from./i).count).to eq(0)
         expect(where.scan(/.warts_h.\..eff_to./i).count).to eq(0)
       end
@@ -132,6 +132,21 @@ describe Person do
       end
     end
 
+    # This test is to cover the StatementCache issue being worked around by the monkey patch in AssociationExtensions
+    describe 'when making multiple association queries with different at values for different data' do
+      it 'the correct data should be returned' do
+        sabrina = Person.create name: 'Sabrina'
+        sabrina_wart = Wart.create person: sabrina
+        sabrina_wart.history.at(Time.current).first.person
+
+        willow = Person.create name: 'Willow'
+        willow_wart = Wart.create person: willow
+        current_willow = willow_wart.history.at(Time.current).first.person
+
+        expect(current_willow.name).to eq('Willow')
+      end
+    end
+
     describe 'when working with STI one level deep' do
       let!(:broom) { Broom.create person: emily, model: 'Cackler 2000' }
 
@@ -180,7 +195,7 @@ describe Person do
   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
+    context 'when Fido is renamed to Max' do
       before do
         dog.name = 'Max'
         dog.save!
@@ -195,7 +210,13 @@ describe Person do
         expect(fido.orig_obj.name).to eq('Max')
       end
 
-      context 'Max is rehomed' do
+      it 'at the exact time of the name change, the dog should not be both Max and Fido' do
+        dog_at_moment_of_name_change = dog.history.at(dog.history.last.eff_from)
+        expect(dog_at_moment_of_name_change.count).to eq(1)
+        expect(dog_at_moment_of_name_change.first.name).to eq('Max')
+      end
+
+      context 'when Max is rehomed' do
         before do
           dog.destroy!
         end
@@ -209,3 +230,17 @@ describe Person do
     end
   end
 end
+
+describe Bird do
+  context 'when a bird and nest exist' do
+    let(:bird) { Bird.create name: 'Sam' }
+    let(:nest) { Bird::Nest.create bird: bird, height: 100 }
+
+    it 'can create instance of class with nested class name with history entries' do
+      expect(bird).not_to be_nil
+      expect(nest).not_to be_nil
+      expect(bird.history.first).not_to be_nil
+      expect(nest.history.first).not_to be_nil
+    end
+  end
+end

data/spec/internal/app/models/bird/nest.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class Bird::Nest < ActiveRecord::Base
+  self.table_name = 'nests'
+  belongs_to :bird, inverse_of: :nest
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Bird < ActiveRecord::Base
+  has_one :nest, inverse_of: :bird
+end

data/spec/internal/db/schema.rb

@@ -60,4 +60,13 @@ ActiveRecord::Schema.define do
   create_table :a_very_very_very_very_very_long_table_name, temporal: true do |t|
     t.string :name
   end
+
+  create_table :birds, id: (postgres ? :uuid : :integer), temporal: true, force: true do |t|
+    t.string :name
+  end
+
+  create_table :nests, id: (postgres ? :uuid : :integer), temporal: true do |t|
+    t.belongs_to :bird, type: (postgres ? :uuid : :integer)
+    t.integer :height
+  end
 end

data/spec/spec_helper.rb

@@ -45,7 +45,7 @@ rescue ActiveRecord::RecordNotUnique
 end
 
 RSpec.configure do |config|
-  config.before(:each) do
+  config.before do
     DatabaseCleaner.clean
   end
 end

data/temporal_tables.gemspec

@@ -5,7 +5,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'temporal_tables/version'
 
-Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |gem|
   gem.name = 'temporal_tables'
   gem.version = TemporalTables::VERSION
   gem.authors = ['Brent Kroeker']
@@ -21,17 +21,19 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
-  gem.required_ruby_version = '>= 2.5.0'
+  gem.required_ruby_version = '>= 3.0.0'
   gem.metadata = { 'rubygems_mfa_required' => 'true' }
 
-  gem.add_dependency 'rails', '>= 6.0', '< 7.1'
+  gem.add_dependency 'rails', '>= 6.0', '< 7.2'
   gem.add_development_dependency 'combustion', '~> 1'
   gem.add_development_dependency 'database_cleaner'
-  gem.add_development_dependency 'gemika', '~> 0.6'
+  gem.add_development_dependency 'gemika', '~> 0.8'
   gem.add_development_dependency 'mysql2'
   gem.add_development_dependency 'pg'
   gem.add_development_dependency 'pry'
   gem.add_development_dependency 'rspec', '~> 3.4'
   gem.add_development_dependency 'rubocop'
+  gem.add_development_dependency 'rubocop-rails'
+  gem.add_development_dependency 'rubocop-rspec'
   gem.metadata['rubygems_mfa_required'] = 'true'
 end