chrono_model 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 143b16e6e193bd56c88d1541f965150b07af191992aec7978dc94c84d7e53f87
-  data.tar.gz: 4aa06ed4110a6dbd9047f580b2972589d813f5108b422fe6ba0a80c021d56d03
+  metadata.gz: 15a81b8b75b7b77c03e9e750db3122cc0107e238696882bd67f2fe8fc7647274
+  data.tar.gz: 599dd55436b014a5db0ce7c1b003aa34ce15e3e12f08dac3e5cc0c5549823a8e
 SHA512:
-  metadata.gz: 57a62853b840b3edd78d1e0402c8d66458b01980956c87c880b84261490ed6f251a00b497c70f56646b4dd051869554118fc426d31b9bfda0af367e8977f3612
-  data.tar.gz: 854b001d29648c4b191eb7e985d720d72bd82cd43dc40df481cc63a83d684fe15922b8127ea40418ad89e5cc7cee30bb3e2551e2eeb6964bbb6477a97aa2f109
+  metadata.gz: 2ba2dc61cc6a62e573dea411005abf071e8010bcd249b05f274afefc756b1ac85b47e6469a6c9988f3b97c3f340891606bbe32d97cd75dfc4fcf0c1f99148805
+  data.tar.gz: 2cce42ff59e611beb10929f8484b8a0ec9eb106f2284770566d51d979eb6b8bb0c0627f88a4e8d1ef0c83cd7dfbd0733b44e09b339994a0424e7114181a74bf6

data/lib/chrono_model/patches/join_node.rb

@@ -22,7 +22,7 @@ module ChronoModel
         @as_of_time  = as_of_time
 
         virtual_table = history_model.
-          virtual_table_at(@as_of_time, @table_alias || @table_name)
+          virtual_table_at(@as_of_time, table_name: @table_alias || @table_name)
 
         super(virtual_table)
       end

data/lib/chrono_model/time_machine.rb

@@ -29,64 +29,37 @@ module ChronoModel
           descendants_with_history.reject(&:history?)
         end
 
-        # STI support. TODO: more thorough testing
+        # STI support.
         #
         def inherited(subclass)
           super
 
-          # Do not smash stack: as the below method is defining a
-          # new anonymous class, without this check this leads to
-          # infinite recursion.
+          # Do not smash stack. The below +define_history_model_for+ method
+          # defines a new inherited class via Class.new(), thus +inherited+
+          # is going to be called again. By that time the subclass is still
+          # an anonymous one, so its +name+ method returns nil. We use this
+          # condition to avoid infinite recursion.
+          #
+          # Sadly, we can't avoid it by calling +.history?+, because in the
+          # subclass the HistoryModel hasn't been included yet.
+          #
           unless subclass.name.nil?
-            ChronoModel::TimeMachine.define_inherited_history_model_for(subclass)
+            ChronoModel::TimeMachine.define_history_model_for(subclass)
           end
         end
       end
     end
 
     def self.define_history_model_for(model)
-      history = Class.new(model) { include ChronoModel::TimeMachine::HistoryModel }
+      history = Class.new(model) do
+        include ChronoModel::TimeMachine::HistoryModel
+      end
 
       model.singleton_class.instance_eval do
         define_method(:history) { history }
       end
 
-      history.singleton_class.instance_eval do
-        define_method(:sti_name) { model.sti_name }
-      end
-
       model.const_set :History, history
-
-      return history
-    end
-
-    def self.define_inherited_history_model_for(subclass)
-      # Define history model for the subclass
-      history = Class.new(subclass.superclass.history)
-      history.table_name = subclass.superclass.history.table_name
-
-      # Override the STI name on the history subclass
-      history.singleton_class.instance_eval do
-        define_method(:sti_name) { subclass.sti_name }
-      end
-
-      # Return the subclass history via the .history method
-      subclass.singleton_class.instance_eval do
-        define_method(:history) { history }
-      end
-
-      # Define the History constant inside the subclass
-      subclass.const_set :History, history
-
-      history.instance_eval do
-        # Monkey patch of ActiveRecord::Inheritance.
-        # STI fails when a Foo::History record has Foo as type in the
-        # inheritance column; AR expects the type to be an instance of the
-        # current class or a descendant (or self).
-        def find_sti_class(type_name)
-          super(type_name + "::History")
-        end
-      end
     end
 
     module ClassMethods

data/lib/chrono_model/time_machine/history_model.rb

@@ -50,21 +50,6 @@ module ChronoModel
           true
         end
 
-        # Getting the correct quoted_table_name can be tricky when
-        # STI is involved. If Orange < Fruit, then Orange::History < Fruit::History
-        # (see define_inherited_history_model_for).
-        # This means that the superclass method returns Fruit::History, which
-        # will give us the wrong table name. What we actually want is the
-        # superclass of Fruit::History, which is Fruit. So, we use
-        # non_history_superclass instead. -npj
-        def non_history_superclass(klass = self)
-          if klass.superclass.history?
-            non_history_superclass(klass.superclass)
-          else
-            klass.superclass
-          end
-        end
-
         def relation
           super.as_of_time!(Time.now)
         end
@@ -72,14 +57,15 @@ module ChronoModel
         # Fetches as of +time+ records.
         #
         def as_of(time)
-          non_history_superclass.from(virtual_table_at(time)).as_of_time!(time)
+          superclass.from(virtual_table_at(time)).as_of_time!(time)
         end
 
-        def virtual_table_at(time, name = nil)
-          name = name ? connection.quote_table_name(name) :
-            non_history_superclass.quoted_table_name
+        def virtual_table_at(time, table_name: nil)
+          virtual_name = table_name ?
+            connection.quote_table_name(table_name) :
+            superclass.quoted_table_name
 
-          "(#{at(time).to_sql}) #{name}"
+          "(#{at(time).to_sql}) #{virtual_name}"
         end
 
         # Fetches history record at the given time
@@ -102,6 +88,37 @@ module ChronoModel
         def of(object)
           where(id: object)
         end
+
+        # The `sti_name` method returns the contents of the inheritance
+        # column, and it is usually the class name. The inherited class
+        # name has the "::History" suffix but that is never going to be
+        # present in the data.
+        #
+        # As such it is overriden here to return the same contents that
+        # the parent would have returned.
+        def sti_name
+          superclass.sti_name
+        end
+
+        # For STI to work, the history model needs to have the exact same
+        # semantics as the model it inherits from. However given it is
+        # actually inherited, the original AR implementation would return
+        # false here. But for STI sake, the history model is located in the
+        # same exact hierarchy location as its parent, thus this is defined in
+        # this override.
+        #
+        def descends_from_active_record?
+          superclass.descends_from_active_record?
+        end
+
+        private
+          # STI fails when a Foo::History record has Foo as type in the
+          # inheritance column; AR expects the type to be an instance of the
+          # current class or a descendant (or self).
+          #
+          def find_sti_class(type_name)
+            super(type_name + "::History")
+          end
       end
 
       # The history id is `hid`, but this cannot set as primary key
@@ -170,7 +187,7 @@ module ChronoModel
       # Returns this history entry's current record
       #
       def current_version
-        self.class.non_history_superclass.find(rid)
+        self.class.superclass.find(rid)
       end
 
       def record #:nodoc:

data/lib/chrono_model/version.rb

@@ -1,3 +1,3 @@
 module ChronoModel
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/chrono_model/adapter/counter_cache_race_spec.rb

@@ -4,15 +4,15 @@ require 'support/helpers'
 describe 'models with counter cache' do
   include ChronoTest::Helpers::TimeMachine
 
-    adapter.create_table 'sections', temporal: true, no_journal: %w( articles_count ) do |t|
-      t.string :name
-      t.integer :articles_count, default: 0
-    end
+  adapter.create_table 'sections', temporal: true, no_journal: %w( articles_count ) do |t|
+    t.string :name
+    t.integer :articles_count, default: 0
+  end
 
-    adapter.create_table 'articles', temporal: true do |t|
-      t.string :title
-      t.references :section
-    end
+  adapter.create_table 'articles', temporal: true do |t|
+    t.string :title
+    t.references :section
+  end
 
   class ::Section < ActiveRecord::Base
     include ChronoModel::TimeMachine

data/spec/chrono_model/adapter/sti_bug_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'support/helpers'
+
+describe 'models with STI' do
+  include ChronoTest::Helpers::TimeMachine
+
+  adapter.create_table 'animals', temporal: true do |t|
+    t.string :type
+  end
+
+  class ::Animal < ActiveRecord::Base
+    include ChronoModel::TimeMachine
+  end
+
+  class ::Dog < Animal
+  end
+
+  class ::Goat < Animal
+  end
+
+  describe 'it generates the right queries' do
+    before do
+      Dog.create!
+      @later = Time.new
+      Goat.create!
+    end
+
+    after do
+      tables = ['temporal.animals', 'history.animals']
+      ActiveRecord::Base.connection.execute "truncate #{tables.join(', ')} cascade"
+    end
+
+    specify "select" do
+      expect(Animal.first).to_not be_nil
+      expect(Animal.as_of(@later).first).to_not be_nil
+    end
+
+    specify "count" do
+      expect(Animal.count).to eq(2)
+      expect(Animal.as_of(@later).count).to eq(1)
+
+      expect(Dog.count).to eq(1)
+      expect(Dog.as_of(@later).count).to eq(1)
+
+      expect(Goat.count).to eq(1)
+      expect(Goat.as_of(@later).count).to eq(0)
+    end
+  end
+end

data/spec/chrono_model/time_machine_spec.rb

@@ -93,6 +93,7 @@ describe ChronoModel::TimeMachine do
       'elements' => Element::History,
       'sections' => Section::History,
       'sub_bars' => SubBar::History,
+      'animals'  => Animal::History,
     ) }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrono_model
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Marcello Barnaba
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -253,6 +253,7 @@ files:
 - spec/aruba/migrations_spec.rb
 - spec/aruba/rake_task_spec.rb
 - spec/chrono_model/adapter/counter_cache_race_spec.rb
+- spec/chrono_model/adapter/sti_bug_spec.rb
 - spec/chrono_model/adapter_spec.rb
 - spec/chrono_model/conversions_spec.rb
 - spec/chrono_model/json_ops_spec.rb
@@ -308,6 +309,7 @@ test_files:
 - spec/aruba/migrations_spec.rb
 - spec/aruba/rake_task_spec.rb
 - spec/chrono_model/adapter/counter_cache_race_spec.rb
+- spec/chrono_model/adapter/sti_bug_spec.rb
 - spec/chrono_model/adapter_spec.rb
 - spec/chrono_model/conversions_spec.rb
 - spec/chrono_model/json_ops_spec.rb