chrono_model 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 883f6c37f76cc8b57b2d7f6b59e1a5627592907e
-  data.tar.gz: 8b35df17eb98dbddd3d0b5c5c046b7b9d7d00501
+SHA256:
+  metadata.gz: 940172f2bad591657a9db2e6124c5b36ccab57cae41f8a0a85c2d473345b8f2c
+  data.tar.gz: 0060e673c40a25cd8d44f925483c85cb08dc794b15291705fa69e64c2b3d9eca
 SHA512:
-  metadata.gz: 99fdb72cb9604d4566049199192b3982f5f44a088ad0f94335e677d8d847fd0a993390d6c17bb2381ec9c32c37c9fd378ba356ce7f9628b0e23aabe82b6702eb
-  data.tar.gz: 7e0be5293bcea607ee1fc1300ad28b491bc9620a2e4ee965f3763e7dadb509f702019fbbc27b254ba41243bd0e35ac4cf9131ab79beb561f87a814de2483b604
+  metadata.gz: b850d300fe412425c472f04e022ff89ca9ab9d299f65c52ac65a4ccfd401828301d524868b57f5490e84d32d7baf4dd2c446ba9cf9ea6ab780910ee9ced80ad5
+  data.tar.gz: 26f7751a0ff8dc234f32d391a6cb84a853edd2213547613db3d413cceaba42475f12537a7f5e647d6c307f9016b445c16f956a5f912542c2c83a19b3de4f31e0

data/README.md

@@ -257,7 +257,23 @@ more information.
 
 ## History manipulation
 
-History objects can be changed and `.save`d just like any other record.
+History objects can be changed and `.save`d just like any other record. They
+cannot be deleted.
+
+## Upgrading
+
+ChronoModel currently performs upgrades by dropping and re-creating the views
+that give access to current data. If you have built other database objects on
+these views, the upgrade cannot be performed automatically as the dependant
+objects must be dropped first.
+
+When booting, ChronoModel will issue a warning in your logs about the need of
+a structure upgrade. Structure usually changes across versions. In this case,
+you need to set up a rake task that drops your dependant objects, runs
+ChronoModel.upgrade! and then re-creates them.
+
+A migration system should be introduced, but it is seen as overkill for now,
+given that usually database objects have creation and dropping scripts.
 
 
 ## Running tests

data/lib/chrono_model.rb

@@ -8,6 +8,16 @@ require 'chrono_model/utils'
 module ChronoModel
   class Error < ActiveRecord::ActiveRecordError #:nodoc:
   end
+
+  def self.upgrade!
+    connection = ActiveRecord::Base.connection
+
+    unless connection.is_a?(ChronoModel::Adapter)
+      raise ChronoModel::Error, "This database connection is not a ChronoModel::Adapter"
+    end
+
+    connection.chrono_upgrade!
+  end
 end
 
 if defined?(Rails)

data/lib/chrono_model/adapter.rb

@@ -462,7 +462,13 @@ module ChronoModel
     end
 
     def chrono_setup!
-      chrono_create_schemas
+      chrono_ensure_schemas
+
+      chrono_upgrade_warning
+    end
+
+    def chrono_upgrade!
+      chrono_ensure_schemas
 
       chrono_upgrade_structure!
     end
@@ -541,37 +547,69 @@ module ChronoModel
     private
       # Create the temporal and history schemas, unless they already exist
       #
-      def chrono_create_schemas
+      def chrono_ensure_schemas
         [TEMPORAL_SCHEMA, HISTORY_SCHEMA].each do |schema|
           execute "CREATE SCHEMA #{schema}" unless schema_exists?(schema)
         end
       end
 
+      # Locate tables needing a structure upgrade
+      #
+      def chrono_tables_needing_upgrade
+        tables = { }
+
+        _on_temporal_schema { self.tables }.each do |table_name|
+          next unless is_chrono?(table_name)
+          metadata = chrono_metadata_for(table_name)
+          version = metadata['chronomodel']
+
+          if version.blank?
+            tables[table_name] = { version: nil, priority: 'CRITICAL' }
+          elsif version != VERSION
+            tables[table_name] = { version: version, priority: 'LOW' }
+          end
+        end
+
+        return tables
+      end
+
+      # Emit a warning about tables needing an upgrade
+      #
+      def chrono_upgrade_warning
+        upgrade = chrono_tables_needing_upgrade.map do |table, desc|
+          "#{table} - priority: #{desc[:priority]}"
+        end.join('; ')
+
+        return if upgrade.empty?
+
+        logger.warn "ChronoModel: There are tables needing a structure upgrade, and ChronoModel structures need to be recreated."
+        logger.warn "ChronoModel: Please run ChronoModel.upgrade! to attempt the upgrade. If you have dependant database objects"
+        logger.warn "ChronoModel: the upgrade will fail and you have to drop the dependent objects, run .upgrade! and create them"
+        logger.warn "ChronoModel: again. Sorry. Some features or the whole library may not work correctly until upgrade is complete."
+        logger.warn "ChronoModel: Tables pending upgrade: #{upgrade}"
+      end
+
       # Upgrades existing structure for each table, if required.
-      # TODO: allow upgrades from pre-0.6 structure with box() and stuff.
       #
       def chrono_upgrade_structure!
         transaction do
-          current = VERSION
 
-          _on_temporal_schema { tables }.each do |table_name|
-            next unless is_chrono?(table_name)
-            metadata = chrono_metadata_for(table_name)
-            version = metadata['chronomodel']
+          chrono_tables_needing_upgrade.each do |table_name, desc|
 
-            if version.blank?
+            if desc[:version].blank?
+              logger.info "ChronoModel: Upgrading legacy table #{table_name} to #{VERSION}"
               upgrade_from_legacy(table_name)
+              logger.info "ChronoModel: legacy #{table_name} upgrade complete"
+            else
+              logger.info "ChronoModel: upgrading #{table_name} from #{version} to #{VERSION}"
+              chrono_create_view_for(table_name)
+              logger.info "ChronoModel: #{table_name} upgrade complete"
             end
 
-            next if version == current
-
-            logger.info "ChronoModel: upgrading #{table_name} from #{version} to #{current}"
-            chrono_create_view_for(table_name)
-            logger.info "ChronoModel: upgrade complete"
           end
         end
       rescue => e
-        message = "ChronoModel structure upgrade failed: #{e.message}. Please drop dependent objects and then run ActiveRecord::Base.connection.chrono_setup!"
+        message = "ChronoModel structure upgrade failed: #{e.message}. Please drop dependent objects first and then run ChronoModel.upgrade! again."
 
         # Quite important, output it also to stderr.
         #

data/lib/chrono_model/patches.rb

@@ -88,7 +88,8 @@ module ChronoModel
       # Build a preloader at the +as_of_time+ of this relation
       #
       def build_preloader
-        ActiveRecord::Associations::Preloader.new(as_of_time: as_of_time)
+        options = as_of_time ? {as_of_time: as_of_time} : {}
+        ActiveRecord::Associations::Preloader.new(options)
       end
     end
 
@@ -157,7 +158,7 @@ module ChronoModel
         def build_scope
           scope = super
 
-          if preload_scope.respond_to?(:as_of_time)
+          if preload_scope.respond_to?(:as_of_time) && preload_scope.as_of_time
             scope = scope.as_of(preload_scope.as_of_time)
           end
 

data/lib/chrono_model/version.rb

@@ -1,3 +1,3 @@
 module ChronoModel
-  VERSION = "0.13.0"
+  VERSION = "0.13.1"
 end

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@
 require 'simplecov'
 SimpleCov.start
 
+require 'byebug'
+
 require 'chrono_model'
 
 require 'support/connection'
@@ -13,6 +15,8 @@ require 'support/matchers/index'
 require 'support/matchers/function'
 require 'support/aruba'
 
+puts "Testing against Active Record #{ActiveRecord::VERSION::STRING} with Arel #{Arel::VERSION}"
+
 # Rails 5 returns a True/FalseClass
 AR_TRUE, AR_FALSE  = ActiveRecord::VERSION::MAJOR == 4 ? ['t', 'f'] : [true, false]
 

data/spec/time_machine_spec.rb

@@ -28,6 +28,10 @@ describe ChronoModel::TimeMachine do
   ts_eval(subbar) { update_attributes! :name => 'sub-bar sub-bar' }
   ts_eval(subbar) { update_attributes! :name => 'new sub-bar' }
 
+  #
+  foos = Array.new(2) {|i| ts_eval { Foo.create! :name => "foo #{i}" } }
+  bars = Array.new(2) {|i| ts_eval { Bar.create! :name => "bar #{i}", :foo => foos[i] } }
+
   #
   baz = Baz.create :name => 'baz', :bar => bar
 
@@ -90,6 +94,28 @@ describe ChronoModel::TimeMachine do
     ) }
   end
 
+  describe 'does not interfere with AR standard behaviour' do
+    all_foos = [ foo ] + foos
+    all_bars = [ bar ] + bars
+
+    it { expect(Foo.count).to eq all_foos.size }
+    it { expect(Bar.count).to eq all_bars.size }
+
+    it { expect(Foo.includes(bars: :sub_bars)).to eq all_foos }
+    it { expect(Foo.includes(:bars).preload(bars: :sub_bars)).to eq all_foos }
+
+    it { expect(Foo.includes(:bars).first.name).to eq 'new foo' }
+    it { expect(Foo.includes(:bars).as_of(foo.ts[0]).first.name).to eq 'foo' }
+
+    it { expect(Foo.joins(:bars).map(&:bars).flatten).to eq all_bars }
+    it { expect(Foo.joins(:bars).first.bars.joins(:sub_bars).first.name).to eq 'new bar' }
+
+    it { expect(Foo.joins(bars: :sub_bars).first.bars.joins(:sub_bars).first.sub_bars.first.name).to eq 'new sub-bar' }
+
+    it { expect(Foo.first.bars.includes(:sub_bars)).to eq [ bar ] }
+
+  end
+
   describe '#as_of' do
     describe 'accepts a Time instance' do
       it { expect(foo.as_of(Time.now).name).to eq 'new foo' }
@@ -264,7 +290,7 @@ describe ChronoModel::TimeMachine do
     end
 
     describe 'does not add as_of_time when there are aggregates' do
-      it { expect(foo.history.select('max(id)').to_sql).to_not match /as_of_time/ }
+      it { expect(foo.history.select('max(id)').to_sql).to_not match(/as_of_time/) }
 
       it { expect(foo.history.except(:order).select('max(id) as foo, min(id) as bar').group('id').first.attributes.keys).to eq %w( id foo bar ) }
     end
@@ -278,7 +304,7 @@ describe ChronoModel::TimeMachine do
 
     context '.sorted' do
       describe 'orders by recorded_at, hid' do
-        it { expect(foo.history.sorted.to_sql).to match /order by .+"recorded_at", .+"hid"/i }
+        it { expect(foo.history.sorted.to_sql).to match(/order by .+"recorded_at", .+"hid"/i) }
       end
     end
   end
@@ -416,7 +442,7 @@ describe ChronoModel::TimeMachine do
     split = lambda {|ts| ts.map!{|t| [t.to_i, t.usec]} }
 
     timestamps_from = lambda {|*records|
-      ts = records.map(&:history).flatten!.inject([]) {|ret, rec|
+      records.map(&:history).flatten!.inject([]) {|ret, rec|
         ret.push [rec.valid_from.to_i, rec.valid_from.usec] if rec.try(:valid_from)
         ret.push [rec.valid_to  .to_i, rec.valid_to  .usec] if rec.try(:valid_to)
         ret
@@ -570,11 +596,6 @@ describe ChronoModel::TimeMachine do
 
   # Class methods
   context do
-    foos = Array.new(2) {|i| ts_eval { Foo.create! :name => "foo #{i}" } }
-    bars = Array.new(2) {|i| ts_eval { Bar.create! :name => "bar #{i}", :foo => foos[i] } }
-
-    after(:all) { foos.each(&:destroy); bars.each(&:destroy) }
-
     describe '.as_of' do
       it { expect(Foo.as_of(1.month.ago)).to eq [] }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrono_model
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Marcello Barnaba
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-29 00:00:00.000000000 Z
+date: 2019-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -278,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: Temporal extensions (SCD Type II) for Active Record