chrono_model 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 576c9df58b2b91c8521458a12eaa036d687287fb
-  data.tar.gz: 4529a430a634516a8c3c1007589c05ba346e0aa3
+  metadata.gz: 6372b41af69ba073bf8d6ea27f34c238ce3c1426
+  data.tar.gz: 9bda73df3fa2d169da83fedd4d499521745a61b8
 SHA512:
-  metadata.gz: 369e1b1fc4874efb19b3b981a96727da8ea6c6cd34521ed746c2357481256c8344f64341b8e09fdebc97bac71dd235ad9fde66340e4c806b66e8aff4c0442f3f
-  data.tar.gz: 9788dea81eb29affaed8e83200b043bae597e14bbf0292fa908f3f5fc6d2d82da7fcad37d28ef2dda3fe46e53e6ab6443c95588b0f7a4b2d27b7ecc63d9c23e5
+  metadata.gz: a04bfe04096c15f977c0972458e53508c81bccbf84b81df79e990f3174152af5f788f1564acf27ace77e3721ba9717a30ec8e5d68f813aaa2761528bed57da52
+  data.tar.gz: 66289e54ef6511b1ff005705386585f82ce5571a99763b37d522d1208dcd87c738c7a2b2d004e205ed5438ff53d28cf8cc076bf29eb5657be318f326953efd1b

data/lib/chrono_model/patches.rb

@@ -56,6 +56,8 @@ module ChronoModel
         end
       end
 
+      # Build a preloader at the +as_of_time+ of this relation
+      #
       def build_preloader
         ActiveRecord::Associations::Preloader.new(as_of_time: as_of_time)
       end
@@ -68,15 +70,60 @@ module ChronoModel
     module Preloader
       attr_reader :options
 
-      NULL_RELATION = ActiveRecord::Associations::Preloader::NULL_RELATION
-      AS_OF_PRELOAD_SCOPE = Struct.new(:as_of_time, *NULL_RELATION.members)
-
+      # We overwrite the initializer in order to pass the +as_of_time+
+      # parameter above in the build_preloader
+      #
       def initialize(options = {})
         @options = options.freeze
       end
 
+      # See +ActiveRecord::Associations::Preloader::NULL_RELATION+
+      NULL_RELATION = ActiveRecord::Associations::Preloader::NULL_RELATION
+
+      # Extension of +NULL_RELATION+ adding an +as_of_time+ property. See
+      # +preload+.
+      AS_OF_PRELOAD_SCOPE = Struct.new(:as_of_time, *NULL_RELATION.members)
+
+      # Patches the AR Preloader (lib/active_record/associations/preloader.rb)
+      # in order to carry around the +as_of_time+ of the original invocation.
+      #
+      # * The +records+ are the parent records where the association is defined
+      # * The +associations+ are the association names involved in preloading
+      # * The +given_preload_scope+ is the preloading scope, that is used only
+      # in the :through association and it holds the intermediate records
+      # _through_ which the final associated records are eventually fetched.
+      #
+      # As the +preload_scope+ is passed around to all the different
+      # incarnations of the preloader strategies, we are using it to pass
+      # around the +as_of_time+ of the original query invocation, so that
+      # preloaded records are preloaded honoring the +as_of_time+.
+      #
+      # The +preload_scope+ is not nil only for through associations, but the
+      # preloader interfaces expect it to be always defined, for consistency.
+      # So, AR defines a +NULL_RELATION+ constant to pass around for the
+      # association types that do not have a preload_scope. It quacks like a
+      # Relation, and it contains only the methods that are used by the other
+      # preloader methods. We extend AR's +NULL_RELATION+ with an `as_of_time`
+      # property.
+      #
+      # For `:through` associations, the +given_preload_scope+ is already a
+      # +Relation+, that already has the +as_of_time+ getters and setters,
+      # so we use them here.
+      #
       def preload(records, associations, given_preload_scope = nil)
         if (as_of_time = options[:as_of_time])
+          preload_scope = if given_preload_scope.respond_to?(:as_of_time!)
+            given_preload_scope.as_of_time!(as_of_time)
+          else
+            null_relation_preload_scope(as_of_time, given_preload_scope)
+          end
+        end
+
+        super records, associations, preload_scope
+      end
+
+      private
+        def null_relation_preload_scope(as_of_time, given_preload_scope)
           preload_scope = AS_OF_PRELOAD_SCOPE.new
 
           preload_scope.as_of_time = as_of_time
@@ -85,12 +132,15 @@ module ChronoModel
           NULL_RELATION.members.each do |member|
             preload_scope[member] = given_preload_scope[member]
           end
-        end
 
-        super records, associations, preload_scope
-      end
+          return preload_scope
+        end
 
       module Association
+        # Builds the preloader scope taking into account a potential
+        # +as_of_time+ set above in +Preloader#preload+ and coming from the
+        # user's query invocation.
+        #
         def build_scope
           scope = super
 

data/lib/chrono_model/schema_format.rb

@@ -17,6 +17,8 @@ end
 # PG utilities
 #
 module PG
+  SQL_COMMENT_BEGIN = "--".freeze
+
   extend self
 
   def config!
@@ -30,6 +32,7 @@ module PG
 
   def make_dump(target, username, database, *options)
     exec 'pg_dump', '-f', target, '-U', username, '-d', database, *options
+    remove_sql_header_comments(target)
   end
 
   def load_dump(source, username, database, *options)
@@ -76,4 +79,20 @@ module PG
     ActiveRecord::Base.logger
   end
 
+  private
+
+  def remove_sql_header_comments(filename)
+    tempfile = Tempfile.open("uncommented_structure.sql")
+    begin
+      File.foreach(filename) do |line|
+        unless line.start_with?(SQL_COMMENT_BEGIN)
+          tempfile << line
+        end
+      end
+    ensure
+      tempfile.close
+    end
+    FileUtils.mv(tempfile.path, filename)
+  end
+
 end

data/lib/chrono_model/version.rb

@@ -1,3 +1,3 @@
 module ChronoModel
-  VERSION = "0.10.1"
+  VERSION = "0.11.0"
 end

data/spec/support/helpers.rb

@@ -74,6 +74,11 @@ module ChronoTest::Helpers
           t.references :foo
         end
 
+        adapter.create_table 'sub_bars' do |t|
+          t.string     :name
+          t.references :bar
+        end
+
         adapter.create_table 'bazs' do |t|
           t.string     :name
           t.references :bar
@@ -104,17 +109,27 @@ module ChronoTest::Helpers
           include ChronoModel::TimeMachine
 
           has_many :bars
+          has_many :sub_bars, :through => :bars
         end
 
         class ::Bar < ActiveRecord::Base
           include ChronoModel::TimeMachine
 
           belongs_to :foo
+          has_many :sub_bars
           has_one :baz
 
           has_timeline :with => :foo
         end
 
+        class ::SubBar < ActiveRecord::Base
+          include ChronoModel::TimeGate
+
+          belongs_to :bar
+
+          has_timeline :with => :bar
+        end
+
         class ::Baz < ActiveRecord::Base
           include ChronoModel::TimeGate
 

data/spec/time_machine_spec.rb

@@ -16,11 +16,18 @@ describe ChronoModel::TimeMachine do
   bar = ts_eval { Bar.create! :name => 'bar', :foo => foo }
   ts_eval(bar) { update_attributes! :name => 'foo bar' }
 
+  #
+  subbar = ts_eval { SubBar.create! :name => 'sub-bar', :bar => bar }
+  ts_eval(subbar) { update_attributes! :name => 'bar sub-bar' }
+
   ts_eval(foo) { update_attributes! :name => 'new foo' }
 
   ts_eval(bar) { update_attributes! :name => 'bar bar' }
   ts_eval(bar) { update_attributes! :name => 'new bar' }
 
+  ts_eval(subbar) { update_attributes! :name => 'sub-bar sub-bar' }
+  ts_eval(subbar) { update_attributes! :name => 'new sub-bar' }
+
   #
   baz = Baz.create :name => 'baz', :bar => bar
 
@@ -145,6 +152,16 @@ describe ChronoModel::TimeMachine do
       it { expect(Foo.as_of(bar.ts[3]).includes(:bars).first.bars.first.name).to eq 'new bar' }
 
 
+      it { expect(Foo.as_of(foo.ts[0]).includes(bars: :sub_bars).first.bars).to eq [] }
+      it { expect(Foo.as_of(foo.ts[1]).includes(bars: :sub_bars).first.bars).to eq [] }
+      it { expect(Foo.as_of(foo.ts[2]).includes(bars: :sub_bars).first.bars).to eq [bar] }
+
+      it { expect(Foo.as_of(bar.ts[0]).includes(bars: :sub_bars).first.bars.first.name).to eq 'bar' }
+      it { expect(Foo.as_of(bar.ts[1]).includes(bars: :sub_bars).first.bars.first.name).to eq 'foo bar' }
+      it { expect(Foo.as_of(bar.ts[2]).includes(bars: :sub_bars).first.bars.first.name).to eq 'bar bar' }
+      it { expect(Foo.as_of(bar.ts[3]).includes(bars: :sub_bars).first.bars.first.name).to eq 'new bar' }
+
+
       it { expect(Bar.as_of(bar.ts[0]).includes(:foo).first.foo).to eq foo }
       it { expect(Bar.as_of(bar.ts[1]).includes(:foo).first.foo).to eq foo }
       it { expect(Bar.as_of(bar.ts[2]).includes(:foo).first.foo).to eq foo }
@@ -154,6 +171,18 @@ describe ChronoModel::TimeMachine do
       it { expect(Bar.as_of(bar.ts[1]).includes(:foo).first.foo.name).to eq 'foo bar' }
       it { expect(Bar.as_of(bar.ts[2]).includes(:foo).first.foo.name).to eq 'new foo' }
       it { expect(Bar.as_of(bar.ts[3]).includes(:foo).first.foo.name).to eq 'new foo' }
+
+
+      it { expect(Bar.as_of(bar.ts[0]).includes(foo: :sub_bars).first.foo).to eq foo }
+      it { expect(Bar.as_of(bar.ts[1]).includes(foo: :sub_bars).first.foo).to eq foo }
+      it { expect(Bar.as_of(bar.ts[2]).includes(foo: :sub_bars).first.foo).to eq foo }
+      it { expect(Bar.as_of(bar.ts[3]).includes(foo: :sub_bars).first.foo).to eq foo }
+
+      it { expect(Bar.as_of(bar.ts[0]).includes(foo: :sub_bars).first.foo.name).to eq 'foo bar' }
+      it { expect(Bar.as_of(bar.ts[1]).includes(foo: :sub_bars).first.foo.name).to eq 'foo bar' }
+      it { expect(Bar.as_of(bar.ts[2]).includes(foo: :sub_bars).first.foo.name).to eq 'new foo' }
+      it { expect(Bar.as_of(bar.ts[3]).includes(foo: :sub_bars).first.foo.name).to eq 'new foo' }
+
     end
 
     it 'doesn\'t raise RecordNotFound when no history records are found' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrono_model
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Marcello Barnaba
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord