chrono_model 0.8.0 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da72ced6e70c0fc98ba5b78417421557dfd22708
-  data.tar.gz: 6f6c9b32d810cceb820f5e6b502baef95add1c26
+  metadata.gz: 9e2f6c55882d65be9f8fb0ff2ef4bbc2260d7d0a
+  data.tar.gz: f1d2aa3879ea83b657a7c3954ad1335817c8f8ce
 SHA512:
-  metadata.gz: 1f7c0e8f7e1db361fb037295122f03562359ba497495a279e53b9aa7d48cbecac4c2396bd5cff88ea609a5a2a62cc70060d24c9e8047f9482dca27d2633e61de
-  data.tar.gz: 7226296b3c3e0442f9c9795e556711c8a8d7cfc963da315eaaa8f50f55c91146c356ab93c3045646c2d564086ecafb7ee2df912a0082e96942e2391bbdc56653
+  metadata.gz: 3b5c36f3ce8e4947038141179a04361f0b3eec0d36a7f50334a9b86903d904a852434ddfad69fa957cc6e2164e0d7dee89aa91593be4b8d72cafdfbcf7cce4d6
+  data.tar.gz: e1e2f4938157129ff3eaea888b67716ac1e24a9ee45bd0345c6aa1b1c381f309635f1f855eeccfb3b40d5b8008ca7ede2e66460a630306adebcd18ff4b16b2e9

data/README.md

@@ -51,8 +51,8 @@ All timestamps are _forcibly_ stored in as UTC, bypassing the
 
 ## Requirements
 
-* Ruby >= 1.9.3
-* Active Record >= 4.0
+* Ruby >= 2.0 (1.9 is still supported, but support will be dropped soon).
+* Active Record = 4.0
 * PostgreSQL >= 9.3
 * The `btree_gist` PostgreSQL extension
 
@@ -230,6 +230,10 @@ SELECT "countries".* FROM (
 
 More methods are provided, see the [TimeMachine][] source for more information.
 
+## History manipulation
+
+History objects can be changed and `.save`d just like any other record.
+
 ## Running tests
 
 You need a running PostgreSQL 9.3 instance. Create `spec/config.yml` with the

data/chrono_model.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = ChronoModel::VERSION
 
-  gem.add_dependency "activerecord", "~> 4.0"
+  gem.add_dependency "activerecord", "~> 4.0.0"
   gem.add_dependency "pg"
   gem.add_dependency "multi_json"
 end

data/lib/chrono_model.rb

@@ -14,8 +14,23 @@ if defined?(Rails)
   require 'chrono_model/railtie'
 end
 
-silence_warnings do
-  # We need to override the "scoped" method on AR::Association for temporal
-  # associations to work as well
-  ActiveRecord::Associations::Association = ChronoModel::Patches::Association
+# We need to override the "scoped" method on AR::Association for temporal
+# associations to work. On Ruby 2.0 and up, the Module#prepend comes in
+# handy - on Ruby 1.9 we have to hack the inheritance hierarchy.
+#
+
+if RUBY_VERSION.to_i >= 2
+  ActiveRecord::Associations::Association.instance_eval do
+    prepend ChronoModel::Patches::Association
+  end
+else
+  ActiveSupport::Deprecation.warn 'Ruby 1.9 is deprecated. Please update your Ruby <3'
+
+  silence_warnings do
+    class ChronoModel::Patches::AssociationPatch < ActiveRecord::Associations::Association
+      include ChronoModel::Patches::Association
+    end
+
+    ActiveRecord::Associations::Association = ChronoModel::Patches::AssociationPatch
+  end
 end

data/lib/chrono_model/adapter.rb

@@ -558,6 +558,13 @@ module ChronoModel
             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!"
+
+        # Quite important, output it also to stderr.
+        #
+        logger.error message
+        $stderr.puts message
       end
 
       def chrono_metadata_for(table)
@@ -699,6 +706,10 @@ module ChronoModel
         # exists, update it with new data. This logic makes possible to "squash"
         # together changes made in a transaction in a single history row.
         #
+        # If you want to disable this behaviour, set the CHRONOMODEL_NO_SQUASH
+        # environment variable. This is useful when running scenarios inside
+        # cucumber, in which everything runs in the same transaction.
+        #
         execute <<-SQL
           CREATE OR REPLACE FUNCTION chronomodel_#{table}_update() RETURNS TRIGGER AS $$
             DECLARE _now timestamp;
@@ -721,7 +732,7 @@ module ChronoModel
               _now := timezone('UTC', now());
               _hid := NULL;
 
-              SELECT hid INTO _hid FROM #{history} WHERE #{pk} = OLD.#{pk} AND lower(validity) = _now;
+              #{"SELECT hid INTO _hid FROM #{history} WHERE #{pk} = OLD.#{pk} AND lower(validity) = _now;" unless ENV['CHRONOMODEL_NO_SQUASH']}
 
               IF _hid IS NOT NULL THEN
                 UPDATE #{history} SET ( #{fields} ) = ( #{values} ) WHERE hid = _hid;

data/lib/chrono_model/patches.rb

@@ -11,7 +11,7 @@ module ChronoModel
     # then the as_of scope is called on either this association's class or
     # on the join model's (:through association) one.
     #
-    class Association < ActiveRecord::Associations::Association
+    module Association
 
       # If the association class or the through association are ChronoModels,
       # then fetches the records from a virtual table using a subquery scope
@@ -28,7 +28,7 @@ module ChronoModel
           # For standard associations, replace the table name with the virtual
           # as-of table name at the owner's as-of-time
           #
-          scope = scope.readonly.from(klass.history.virtual_table_at(owner.as_of_time))
+          scope = scope.from(klass.history.virtual_table_at(owner.as_of_time))
         elsif respond_to?(:through_reflection) && through_reflection.klass.chrono?
 
           # For through associations, replace the joined table name instead.

data/lib/chrono_model/time_machine.rb

@@ -52,17 +52,45 @@ module ChronoModel
           attributes[self.class.primary_key]
         end
 
-        # HACK to make ActiveAdmin work properly. This will be surely
-        # better written in the future.
+        # HACK. find() and save() require the real history ID. So we are
+        # setting it now and ensuring to reset it to the original one after
+        # execution completes.
         #
-        def self.find(*args)
+        def self.with_hid_pkey(&block)
           old = self.primary_key
           self.primary_key = :hid
-          super
+
+          block.call
         ensure
           self.primary_key = old
         end
 
+        def self.find(*)
+          with_hid_pkey { super }
+        end
+
+        if RUBY_VERSION.to_f < 2.0
+          # PLEASE UPDATE YOUR RUBY <3
+          #
+          def save_with_pkey(*)
+            self.class.with_hid_pkey { save_without_pkey }
+          end
+
+          def save_with_pkey!(*)
+            self.class.with_hid_pkey { save_without_pkey! }
+          end
+
+          alias_method_chain :save, :pkey
+        else
+          def save(*)
+            self.class.with_hid_pkey { super }
+          end
+
+          def save!(*)
+            self.class.with_hid_pkey { super }
+          end
+        end
+
         # Returns the previous history entry, or nil if this
         # is the first one.
         #
@@ -104,8 +132,13 @@ module ChronoModel
 
         # Returns this history entry's current record
         #
-        def record
-          self.class.superclass.find(rid)
+        def current_version
+          self.class.non_history_superclass.find(rid)
+        end
+
+        def record #:nodoc:
+          ActiveSupport::Deprecation.warn '.record is deprecated in favour of .current_version'
+          self.current_version
         end
 
         def valid_from
@@ -251,6 +284,12 @@ module ChronoModel
       timeline(options.merge(:limit => 1, :reverse => false)).first
     end
 
+    # Returns the current history version
+    #
+    def current_version
+      self.historical? ? self.class.find(self.id) : self
+    end
+
     # Returns the differences between this entry and the previous history one.
     # See: +changes_against+.
     #
@@ -316,10 +355,12 @@ module ChronoModel
           "NOT (#{build_time_query_at(time, range)})"
 
         when :before
-          build_time_query(['NULL', time_for_time_query(time, range)], range)
+          op = options.fetch(:inclusive, true) ? '&&' : '@>'
+          build_time_query(['NULL', time_for_time_query(time, range)], range, op)
 
         when :after
-          build_time_query([time_for_time_query(time, range), 'NULL'], range)
+          op = options.fetch(:inclusive, true) ? '&&' : '@>'
+          build_time_query([time_for_time_query(time, range), 'NULL'], range, op)
 
         else
           raise ArgumentError, "Invalid time_query: #{match}"
@@ -367,9 +408,9 @@ module ChronoModel
           build_time_query(time, range)
         end
 
-        def build_time_query(time, range)
+        def build_time_query(time, range, op = '&&')
           if time.kind_of?(Array)
-            %[ #{range.type}(#{time.first}, #{time.last}) && #{table_name}.#{range.name} ]
+            %[ #{range.type}(#{time.first}, #{time.last}) #{op} #{table_name}.#{range.name} ]
           else
             %[ #{time} <@ #{table_name}.#{range.name} ]
           end
@@ -415,7 +456,7 @@ module ChronoModel
       # Fetches as of +time+ records.
       #
       def as_of(time, scope = nil)
-        as_of = non_history_superclass.unscoped.readonly.from(virtual_table_at(time))
+        as_of = non_history_superclass.unscoped.from(virtual_table_at(time))
 
         # Add default scopes back if we're passed nil or a
         # specific scope, because we're .unscopeing above.
@@ -452,12 +493,6 @@ module ChronoModel
           time_query(:at, time)
       end
 
-      # Returns the whole history as read only.
-      #
-      def all
-        super.readonly
-      end
-
       # Returns the history sorted by recorded_at
       #
       def sorted
@@ -470,12 +505,33 @@ module ChronoModel
       # is maximum.
       #
       def of(object)
-        readonly.where(:id => object).extend(HistorySelect)
+        where(:id => object).extend(HistorySelect)
+      end
+
+      # HACK FIXME. When querying history, ChronoModel does not add his
+      # timestamps and sorting if there is an aggregate function in the
+      # select list - as it is likely what you'll want. However, if you
+      # have a query that performs an aggregate in a subquery, the code
+      # below will do the wrong thing - and you'll have to forcibly add
+      # back the history fields yourself.
+      #
+      # The obvious solution is to use a VIEW on the history containing
+      # the added history fields, and remove all this crap from here...
+      # but it is not easily feasible. So we're going with a workaround
+      # for now.
+      #
+      #   - vjt  Wed Apr  2 19:56:35 CEST 2014
+      #
+      def force_history_fields
+        select(HistorySelect::SELECT_VALUES).order(HistorySelect::ORDER_VALUES[quoted_table_name])
       end
 
       module HistorySelect #:nodoc:
         Aggregates = %r{(?:(?:bit|bool)_(?:and|or)|(?:array_|string_|xml)agg|count|every|m(?:in|ax)|sum|stddev|var(?:_pop|_samp|iance)|corr|covar_|regr_)\w*\s*\(}i
 
+        SELECT_VALUES = "upper(validity) AS as_of_time"
+        ORDER_VALUES  = lambda {|tbl| %[#{tbl}."recorded_at", #{tbl}."hid"]}
+
         def build_arel
           has_aggregate = select_values.any? do |v|
             v.kind_of?(Arel::Nodes::Function) || # FIXME this is a bit ugly.
@@ -485,11 +541,11 @@ module ChronoModel
           return super if has_aggregate
 
           if order_values.blank?
-            self.order_values += [ %[#{quoted_table_name}."recorded_at", #{quoted_table_name}."hid"] ]
+            self.order_values += [ ORDER_VALUES[quoted_table_name] ]
           end
 
           super.tap do |rel|
-            rel.project("LEAST(upper(validity), timezone('UTC', now())) AS as_of_time")
+            rel.project(SELECT_VALUES)
           end
         end
       end

data/lib/chrono_model/version.rb

@@ -1,3 +1,3 @@
 module ChronoModel
-  VERSION = "0.8.0"
+  VERSION = "0.8.2"
 end

data/spec/time_machine_spec.rb

@@ -156,9 +156,9 @@ describe ChronoModel::TimeMachine do
       it { bar.history.map(&:name).should == ['bar', 'foo bar', 'bar bar', 'new bar'] }
     end
 
-    describe 'returns read only records' do
-      it { foo.history.all?(&:readonly?).should be_true }
-      it { bar.history.all?(&:readonly?).should be_true }
+    describe 'does not return read only records' do
+      it { foo.history.all?(&:readonly?).should_not be_true }
+      it { bar.history.all?(&:readonly?).should_not be_true }
     end
 
     describe 'takes care of associated records' do
@@ -166,9 +166,9 @@ describe ChronoModel::TimeMachine do
       it { should == [nil, 'foo bar', 'new bar'] }
     end
 
-    describe 'returns read only associated records' do
-      it { foo.history[2].bars.all?(&:readonly?).should be_true }
-      it { bar.history.all? {|b| b.foo.readonly?}.should be_true }
+    describe 'does not return read only associated records' do
+      it { foo.history[2].bars.all?(&:readonly?).should_not be_true }
+      it { bar.history.all? {|b| b.foo.readonly?}.should_not be_true }
     end
 
     describe 'allows a custom select list' do
@@ -244,9 +244,21 @@ describe ChronoModel::TimeMachine do
     it { should == foo.history.last }
   end
 
-  describe '#record' do
-    subject { foo.history.sample.record }
-    it { should == foo }
+  describe '#current_version' do
+    describe 'on plain records' do
+      subject { foo.current_version }
+      it { should == foo }
+    end
+
+    describe 'from #as_of' do
+      subject { foo.as_of(Time.now) }
+      it { should == foo }
+    end
+
+    describe 'on historical records' do
+      subject { foo.history.sample.current_version }
+      it { should == foo }
+    end
   end
 
   describe '#historical?' do
@@ -536,8 +548,11 @@ describe ChronoModel::TimeMachine do
     end
 
     describe '.time_query' do
-      it { Foo.history.time_query(:after, :now).count.should == 3 }
-      it { Foo.history.time_query(:before, :now).count.should == 5 }
+      it { Foo.history.time_query(:after,  :now, inclusive: true ).count.should == 3 }
+      it { Foo.history.time_query(:after,  :now, inclusive: false).count.should == 0 }
+      it { Foo.history.time_query(:before, :now, inclusive: true ).count.should == 5 }
+      it { Foo.history.time_query(:before, :now, inclusive: false).count.should == 2 }
+
       it { Foo.history.past.size.should == 2 }
     end
 
@@ -593,4 +608,36 @@ describe ChronoModel::TimeMachine do
     end
   end
 
+  # This group is below here to not to disturb the flow of the above specs.
+  #
+  context 'history modification' do
+    describe '#save' do
+      subject { bar.history.first }
+
+      before do
+        subject.name = 'modified bar history'
+        subject.save
+        subject.reload
+      end
+
+      it { should be_a(Bar::History) }
+      it { should be_true }
+      its(:name) { should == 'modified bar history' }
+    end
+
+    describe '#save!' do
+      subject { bar.history.second }
+
+      before do
+        subject.name = 'another modified bar history'
+        subject.save
+        subject.reload
+      end
+
+      it { should be_a(Bar::History) }
+      it { should be_true }
+      its(:name) { should == 'another modified bar history' }
+    end
+  end
+
 end

data/spec/time_query_spec.rb

@@ -87,7 +87,8 @@ describe ChronoModel::TimeMachine::TimeQuery do
   end
 
   describe :before do
-    subject { Event.time_query(:before, time.try(:to_date) || time, on: :interval, type: :daterange).to_a }
+    let(:inclusive) { true }
+    subject { Event.time_query(:before, time.try(:to_date) || time, on: :interval, type: :daterange, inclusive: inclusive).to_a }
 
     context '16 days ago' do
       let(:time) { 16.days.ago }
@@ -97,11 +98,21 @@ describe ChronoModel::TimeMachine::TimeQuery do
     context '14 days ago' do
       let(:time) { 14.days.ago }
       it { should == [think] }
+
+      context 'not inclusive' do
+        let(:inclusive) { false }
+        it { should be_empty }
+      end
     end
 
     context '11 days ago' do
       let(:time) { 11.days.ago }
       it { should =~ [think, plan, collect] }
+
+      context 'not inclusive' do
+        let(:inclusive) { false }
+        it { should == [think, plan] }
+      end
     end
 
     context '10 days ago' do
@@ -126,7 +137,8 @@ describe ChronoModel::TimeMachine::TimeQuery do
   end
 
   describe :after do
-    subject { Event.time_query(:after, time.try(:to_date) || time, on: :interval, type: :daterange).to_a }
+    let(:inclusive) { true }
+    subject { Event.time_query(:after, time.try(:to_date) || time, on: :interval, type: :daterange, inclusive: inclusive).to_a }
 
     context 'one month ago' do
       let(:time) { 1.month.ago }
@@ -161,6 +173,11 @@ describe ChronoModel::TimeMachine::TimeQuery do
     context 'one month from now' do
       let(:time) { 1.month.from_now }
       it { should == [profit] }
+
+      context 'not inclusive' do
+        let(:inclusive) { false }
+        it { should be_empty }
+      end
     end
 
     context 'far future' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrono_model
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.2
 platform: ruby
 authors:
 - Marcello Barnaba
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-29 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement