temporal_tables 0.7.1 → 1.0.2

data/lib/temporal_tables.rb

@@ -1,67 +1,82 @@
-require "temporal_tables/temporal_adapter"
-require "temporal_tables/connection_adapters/mysql_adapter"
-require "temporal_tables/connection_adapters/postgresql_adapter"
-require "temporal_tables/whodunnit"
-require "temporal_tables/temporal_class"
-require "temporal_tables/history_hook"
-require "temporal_tables/relation_extensions"
-require "temporal_tables/association_extensions"
-require "temporal_tables/join_extensions"
-require "temporal_tables/preloader_extensions"
-require "temporal_tables/reflection_extensions"
-require "temporal_tables/arel_table"
-require "temporal_tables/version"
+# 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'
+require 'temporal_tables/temporal_class'
+require 'temporal_tables/history_hook'
+require 'temporal_tables/relation_extensions'
+require 'temporal_tables/association_extensions'
+require 'temporal_tables/preloader_extensions'
+require 'temporal_tables/reflection_extensions'
+require 'temporal_tables/arel_table'
+require 'temporal_tables/version'
 
 module TemporalTables
   class Railtie < ::Rails::Railtie
-    initializer "temporal_tables.load" do
+    initializer 'temporal_tables.load' do
       # Iterating the subclasses will find any adapter implementations
       # which are in use by the rails app, and mixin the temporal functionality.
       # 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)
 
-        module_name = subclass.name.split("::").last
-        subclass.send :prepend, TemporalTables::ConnectionAdapters.const_get(module_name) if TemporalTables::ConnectionAdapters.const_defined?(module_name)
+        subclass.send(
+          :prepend,
+          TemporalTables::ConnectionAdapters.const_get(module_name)
+        )
       end
 
-      ActiveRecord::Base.send :include, TemporalTables::Whodunnit
+      ActiveRecord::Base.include TemporalTables::Whodunnit
     end
   end
 
-  @@create_by_default = false
+  @create_by_default = false
   def self.create_by_default
-    @@create_by_default
+    @create_by_default
   end
+
   def self.create_by_default=(default)
-    @@create_by_default = default
+    @create_by_default = default
   end
 
-  @@skipped_temporal_tables = [:schema_migrations, :sessions, :ar_internal_metadata]
+  @skipped_temporal_tables = [:schema_migrations, :sessions, :ar_internal_metadata]
   def self.skip_temporal_table_for(*tables)
-    @@skipped_temporal_tables += tables
+    @skipped_temporal_tables += tables
   end
+
   def self.skipped_temporal_tables
-    @@skipped_temporal_tables.dup
+    @skipped_temporal_tables.dup
   end
 
-  @@add_updated_by_field = false
-  @@updated_by_type = :string
-  @@updated_by_proc = nil
+  @add_updated_by_field = false
+  @updated_by_type = :string
+  @updated_by_proc = nil
   def self.updated_by_type
-    @@updated_by_type
+    @updated_by_type
   end
+
   def self.updated_by_proc
-    @@updated_by_proc
+    @updated_by_proc
   end
+
   def self.add_updated_by_field(type = :string, &block)
     if block_given?
-      @@add_updated_by_field = true
-      @@updated_by_type = type
-      @@updated_by_proc = block
+      @add_updated_by_field = true
+      @updated_by_type = type
+      @updated_by_proc = block
     end
 
-    @@add_updated_by_field
+    @add_updated_by_field
   end
 end

data/spec/basic_history_spec.rb

@@ -1,66 +1,68 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Person do
-  let(:emily) { Person.create name: "Emily" }
+  let(:emily) { Person.create name: 'Emily' }
   let(:historical_emily) { emily.history.last }
 
   before do
     emily
-    @init_time = Time.now
+    @init_time = Time.zone.now
     sleep 0.1
   end
 
-  describe "upon making significant life changes" do
-    let!(:coven) { Coven.create name: "Double Double Toil & Trouble" }
+  describe 'upon making significant life changes' do
+    let!(:coven) { Coven.create name: 'Double Double Toil & Trouble' }
     let!(:wart) { Wart.create person: emily, hairiness: 3 }
 
     before do
-      emily.update name: "Grunthilda", coven: coven
+      emily.update name: 'Grunthilda', coven: coven
       sleep 0.1
     end
 
-    describe "when affirming changes" do
-      it "should have new name" do
-        expect(emily.name).to eq("Grunthilda")
-        expect(historical_emily.name).to eq("Grunthilda")
+    describe 'when affirming changes' do
+      it 'should have new name' do
+        expect(emily.name).to eq('Grunthilda')
+        expect(historical_emily.name).to eq('Grunthilda')
       end
 
-      it "should belong to coven" do
+      it 'should belong to coven' do
         expect(emily.coven.name).to eq(coven.name)
         expect(historical_emily.coven.name).to eq(coven.name)
       end
 
-      it "should have a wart" do
+      it 'should have a wart' do
         expect(emily.warts).to eq([wart])
-        expect(emily.history.at(Time.now).last.warts).to eq([wart.history.last])
+        expect(emily.history.at(Time.zone.now).last.warts).to eq([wart.history.last])
       end
 
-      it "should allow scopes on associations" do
+      it 'should allow scopes on associations' do
         expect(emily.warts.very_hairy).to eq([wart])
         expect(historical_emily.warts.very_hairy).to eq([wart.history.last])
       end
 
-      it "should allow at value on class too" do
-        expect(Wart.history.at(Time.now).where(person: emily).count).to eq(1)
+      it 'should allow at value on class too' do
+        expect(Wart.history.at(Time.zone.now).where(person: emily).count).to eq(1)
         expect(Wart.history.at(1.minute.ago).where(person: emily).count).to eq(0)
       end
     end
 
-    describe "when reflecting on the past" do
+    describe 'when reflecting on the past' do
       let(:orig_emily) { emily.history.at(@init_time).last }
 
-      it "should have historical name" do
-        expect(orig_emily.name).to eq("Emily")
+      it 'should have historical name' do
+        expect(orig_emily.name).to eq('Emily')
         expect(orig_emily.at_value).to eq(@init_time)
       end
 
-      it "should not belong to a coven or have warts" do
+      it 'should not belong to a coven or have warts' do
         expect(orig_emily.coven).to eq(nil)
         expect(orig_emily.warts.count).to eq(0)
       end
     end
 
-    describe "when preloading associations" do
+    describe 'when preloading associations' do
       let(:orig_emily) { emily.history.at(@init_time).preload(:warts).first }
 
       it 'should preload the correct time' do
@@ -68,7 +70,7 @@ describe Person do
       end
     end
 
-    describe "when eager_loading associations" do
+    describe 'when eager_loading associations' do
       let(:orig_emily) { emily.history.at(@init_time).eager_load(:warts).first }
 
       it 'should include the correct time' do
@@ -76,7 +78,14 @@ describe Person do
       end
 
       it 'should generate sensible sql' do
-        sql = emily.history.at(@init_time).eager_load(:warts).where(Wart.history.arel_table[:hairiness].gteq(2)).to_sql.split(/(FROM)|(WHERE)|(ORDER)/)
+        sql =
+          emily
+          .history
+          .at(@init_time)
+          .eager_load(:warts)
+          .where(Wart.history.arel_table[:hairiness].gteq(2))
+          .to_sql
+          .split(/(FROM)|(WHERE)|(ORDER)/)
         from = sql[2]
         where = sql[4]
 
@@ -90,15 +99,15 @@ describe Person do
       end
     end
 
-    describe "when checking simple code values" do
-      it "should have correct class names" do
-        expect(emily.class.name).to eq("Person")
-        expect(historical_emily.class.name).to eq("PersonHistory")
+    describe 'when checking simple code values' do
+      it 'should have correct class names' do
+        expect(emily.class.name).to eq('Person')
+        expect(historical_emily.class.name).to eq('PersonHistory')
 
         expect(Person.history).to eq(PersonHistory)
       end
 
-      it "should have correct class hierarchies" do
+      it 'should have correct class hierarchies' do
         expect(emily.is_a?(Person)).to eq(true)
         expect(emily.is_a?(PersonHistory)).to eq(false)
 
@@ -107,8 +116,8 @@ describe Person do
       end
     end
 
-    describe "when checking current state" do
-      it "should have correct information" do
+    describe 'when checking current state' do
+      it 'should have correct information' do
         # ie. we shouldn't break regular ActiveRecord behaviour
         expect(Person.count).to eq(1)
         expect(Wart.count).to eq(1)
@@ -123,20 +132,41 @@ describe Person do
       end
     end
 
-    describe "when working with STI one level deep" do
-      let!(:broom) { Broom.create person: emily, model: "Cackler 2000" }
+    describe 'when working with STI one level deep' do
+      let!(:broom) { Broom.create person: emily, model: 'Cackler 2000' }
 
-      it "should initialize model correctly" do
+      it 'should initialize model correctly' do
         expect(emily.history.last.flying_machines).to eq([broom.history.last])
       end
     end
 
-    describe "when working with STI two levels deep" do
-      let!(:rocket_broom) { RocketBroom.create person: emily, model: "Pyrocackler 3000X" }
+    describe 'when working with STI two levels deep' do
+      let!(:rocket_broom) { RocketBroom.create person: emily, model: 'Pyrocackler 3000X' }
 
-      it "should initialize model correctly" do
+      it 'should initialize model correctly' do
         expect(emily.history.last.flying_machines).to eq([rocket_broom.history.last])
       end
     end
   end
+
+  # The following only tests non-integer ids for postgres (see schema.rb)
+  describe 'when spawning and aging a creature with a non-integer id' do
+    let!(:cat) { Cat.create name: 'Mr. Mittens', color: 'black' }
+
+    before do
+      cat.lives.create started_at: 3.years.ago
+      @init_time = Time.zone.now
+      cat.update name: 'Old Mr. Mittens'
+      cat.lives.first.update ended_at: Time.zone.now, death_reason: 'fell into cauldron'
+      cat.lives.create started_at: Time.zone.now
+    end
+
+    it 'shows one life at the beginning' do
+      expect(cat.history.at(@init_time).last.lives.size).to eq(1)
+    end
+
+    it 'shows two lives at the end' do
+      expect(cat.history.last.lives.size).to eq(2)
+    end
+  end
 end

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

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class Broom < FlyingMachine
 end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Cat < ActiveRecord::Base
+  has_many :lives, class_name: 'CatLife'
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class CatLife < ActiveRecord::Base
+  belongs_to :cat
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Coven < ActiveRecord::Base
   has_many :people
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class FlyingMachine < ActiveRecord::Base
   belongs_to :person
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Person < ActiveRecord::Base
   belongs_to :coven
   has_many :warts

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

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 class RocketBroom < Broom
 end

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

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class Wart < ActiveRecord::Base
   belongs_to :person
 
-  scope :very_hairy, -> {
+  scope :very_hairy, lambda {
     where(arel_table[:hairiness].gteq(3))
   }
 end

data/spec/internal/config/database.ci.yml

@@ -0,0 +1,12 @@
+mysql:
+  adapter: mysql2
+  database: temporal_tables_test
+  host: 127.0.0.1
+  username: root
+  password: password
+
+postgresql:
+  adapter: postgresql
+  database: temporal_tables_test
+  user: postgres
+  password:

data/spec/internal/db/schema.rb

@@ -1,22 +1,45 @@
+# frozen_string_literal: true
+
+begin
+  postgres = ActiveRecord::Base.connection.instance_of?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+rescue NameError
+  postgres = false
+end
+
 ActiveRecord::Schema.define do
-  create_table :people, temporal: true, force: true do |t|
-    t.belongs_to :coven
-    t.string :name
-  end
+  enable_extension 'pgcrypto' if postgres
 
   create_table :covens, force: true do |t|
     t.string :name
   end
   add_temporal_table :covens
 
+  create_table :people, temporal: true, force: true do |t|
+    t.belongs_to :coven
+    t.string :name
+  end
+  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
     t.string :type
     t.string :model
   end
+
+  create_table :cats, id: (postgres ? :uuid : :integer), temporal: true, force: true do |t|
+    t.string :name
+    t.string :color
+  end
+
+  create_table :cat_lives, id: (postgres ? :uuid : :integer), temporal: true do |t|
+    t.belongs_to :cat, type: (postgres ? :uuid : :integer)
+    t.timestamp :started_at
+    t.timestamp :ended_at
+    t.string :death_reason
+  end
 end

data/spec/spec_helper.rb

@@ -1,14 +1,48 @@
+# frozen_string_literal: true
+
 require 'gemika'
 require 'combustion'
+require 'yaml'
 
-Dir["#{File.dirname(__FILE__)}/extensions/*.rb"].sort.each {|f| require f}
-Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each {|f| require f}
+Dir["#{File.dirname(__FILE__)}/extensions/*.rb"].sort.each { |f| require f }
+Dir["#{File.dirname(__FILE__)}/support/*.rb"].sort.each { |f| require f }
+READ_DATABASE_CONFIG_LOCATION = 'spec/internal/config/database.ci.yml'
+WRITE_DATABASE_CONFIG_LOCATION = 'spec/internal/config/database.yml'
 
-Combustion.initialize! :active_record do
-  Rails.env = TemporalTables::DatabaseAdapter.adapter_name
+def adapter_name
+  if Gemika::Env.gem?('mysql2')
+    'mysql'
+  else
+    'postgresql'
+  end
 end
 
-DatabaseCleaner.strategy = :deletion
+def database_config_from_gems(file_location)
+  config = YAML.load_file(file_location)
+  data = config.slice(adapter_name)
+  { Rails.env.to_s => data }
+end
+
+original_env = Rails.env
+
+puts database_config_from_gems(READ_DATABASE_CONFIG_LOCATION)
+File.write(
+  WRITE_DATABASE_CONFIG_LOCATION,
+  database_config_from_gems(READ_DATABASE_CONFIG_LOCATION).to_yaml
+)
+
+Rails.env = adapter_name
+database = Gemika::Database.new
+database.connect
+
+Gemika::RSpec.configure_clean_database_before_example
+Rails.env = original_env
+
+begin
+  Combustion.initialize! :active_record
+rescue ActiveRecord::RecordNotUnique
+  # noop
+end
 
 RSpec.configure do |config|
   config.before(:each) do

data/spec/support/database.rb

@@ -1,9 +1,13 @@
-module TemporalTables::DatabaseAdapter
-  def self.adapter_name
-    if Gemika::Env.gem?('pg')
-      "postgresql"
-    elsif Gemika::Env.gem?('mysql2')
-      "mysql"
+# frozen_string_literal: true
+
+module TemporalTables
+  module DatabaseAdapter
+    def self.adapter_name
+      if Gemika::Env.gem?('pg')
+        'postgresql'
+      elsif Gemika::Env.gem?('mysql2')
+        'mysql'
+      end
     end
   end
 end

data/temporal_tables.gemspec

@@ -1,24 +1,37 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'temporal_tables/version'
 
-Gem::Specification.new do |gem|
-  gem.name          = "temporal_tables"
-  gem.version       = TemporalTables::VERSION
-  gem.authors       = ["Brent Kroeker"]
-  gem.email         = ["brent@bkroeker.com"]
-  gem.description   = %q{Easily recall what your data looked like at any point in the past!  TemporalTables sets up and maintains history tables to track all temporal changes to to your data.}
-  gem.summary       = %q{Tracks all history of changes to a table automatically in a history table.}
-  gem.homepage      = ""
+Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
+  gem.name = 'temporal_tables'
+  gem.version = TemporalTables::VERSION
+  gem.authors = ['Brent Kroeker']
+  gem.email = ['brent@bkroeker.com']
+  gem.description = <<-DESC
+    Easily recall what your data looked like at any point in the past!
+    TemporalTables sets up and maintains history tables to track all temporal changes to to your data.
+  DESC
+  gem.summary = 'Tracks all history of changes to a table automatically in a history table.'
+  gem.homepage = ''
 
-  gem.files         = `git ls-files`.split($/)
-  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.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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.metadata = { 'rubygems_mfa_required' => 'true' }
 
-  gem.add_dependency "rails", ">= 5.0", "< 6.1"
-  gem.add_development_dependency "rspec", "~> 3.4"
-  gem.add_development_dependency "combustion", "~> 0.9.1"
-  gem.add_development_dependency "gemika"
+  gem.add_dependency 'rails', '>= 6.0', '< 7.1'
+  gem.add_development_dependency 'combustion', '~> 1'
+  gem.add_development_dependency 'database_cleaner'
+  gem.add_development_dependency 'gemika', '~> 0.6'
+  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.metadata['rubygems_mfa_required'] = 'true'
 end