chrono_model 0.3.1 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    chrono_model (0.3.0)
+    chrono_model (0.4.0)
       activerecord (~> 3.2)
       pg
 

data/README.md

@@ -181,6 +181,10 @@ them in your output, use `rake VERBOSE=true`.
 
  * The schema dumper is WAY TOO hacky.
 
+ * Savepoints are disabled, because there is
+   [currently](http://archives.postgresql.org/pgsql-hackers/2012-08/msg01094.php)
+   no way to identify a subtransaction belonging to the current transaction.
+
 
 ## Contributing
 

data/lib/chrono_model/adapter.rb

@@ -309,6 +309,17 @@ module ChronoModel
       end
     end
 
+    # Disable savepoints support, as they break history keeping.
+    # http://archives.postgresql.org/pgsql-hackers/2012-08/msg01094.php
+    #
+    def supports_savepoints?
+      false
+    end
+
+    def create_savepoint; end
+    def rollback_to_savepoint; end
+    def release_savepoint; end
+
     private
       # Create the history table in the history schema
       def chrono_create_history_for(table)
@@ -364,7 +375,8 @@ module ChronoModel
 
         # SELECT - return only current data
         #
-        execute "CREATE OR REPLACE VIEW #{table} AS SELECT * FROM ONLY #{current}"
+        execute "DROP VIEW #{table}" if table_exists? table
+        execute "CREATE VIEW #{table} AS SELECT *, xmin AS __xid FROM ONLY #{current}"
 
         columns  = columns(table).map(&:name)
         sequence = serial_sequence(current, pk)                    # For INSERT
@@ -378,13 +390,13 @@ module ChronoModel
         #
         if sequence.present?
           execute <<-SQL
-            CREATE OR REPLACE RULE #{table}_ins AS ON INSERT TO #{table} DO INSTEAD (
+            CREATE RULE #{table}_ins AS ON INSERT TO #{table} DO INSTEAD (
 
               INSERT INTO #{current} ( #{fields} ) VALUES ( #{values} );
 
               INSERT INTO #{history} ( #{pk}, #{fields}, valid_from )
               VALUES ( currval('#{sequence}'), #{values}, timezone('UTC', now()) )
-              RETURNING #{pk}, #{fields}
+              RETURNING #{pk}, #{fields}, xmin
             )
           SQL
         else
@@ -392,7 +404,7 @@ module ChronoModel
           values_with_pk = "new.#{pk}, " << values
 
           execute <<-SQL
-            CREATE OR REPLACE RULE #{table}_ins AS ON INSERT TO #{table} DO INSTEAD (
+            CREATE RULE #{table}_ins AS ON INSERT TO #{table} DO INSTEAD (
 
               INSERT INTO #{current} ( #{fields_with_pk} ) VALUES ( #{values_with_pk} );
 
@@ -405,9 +417,27 @@ module ChronoModel
 
         # UPDATE - set the last history entry validity to now, save the current data
         # in a new history entry and update the temporal table with the new data.
+
+        # If this is the first statement of a transaction, inferred by the last
+        # transaction ID that updated the row, create a new row in the history.
+        #
+        # The current transaction ID is returned by txid_current() as a 64-bit
+        # signed integer, while the last transaction ID that changed a row is
+        # stored into a 32-bit unsigned integer in the __xid column. As XIDs
+        # wrap over time, txid_current() adds an "epoch" counter in the most
+        # significant bits (http://bit.ly/W2Srt7) of the int - thus here we
+        # remove it by and'ing with 2^32-1.
+        #
+        # XID are 32-bit unsigned integers, and by design cannot be casted nor
+        # compared to anything else, adding a CAST or an operator requires
+        # super-user privileges, so here we do a double-cast from varchar to
+        # int8, to finally compare it with the current XID. We're using 64bit
+        # integers as in PG there is no 32-bit unsigned data type.
         #
         execute <<-SQL
-          CREATE OR REPLACE RULE #{table}_upd AS ON UPDATE TO #{table} DO INSTEAD (
+          CREATE RULE #{table}_upd_first AS ON UPDATE TO #{table}
+          WHERE old.__xid::char(10)::int8 <> (txid_current() & (2^32-1)::int8)
+          DO INSTEAD (
 
             UPDATE #{history} SET valid_to = timezone('UTC', now())
             WHERE #{pk} = old.#{pk} AND valid_to = '9999-12-31';
@@ -420,11 +450,32 @@ module ChronoModel
           )
         SQL
 
-        # DELETE - save the current data in the history and eventually delete the data
-        # from the temporal table.
+        # Else, update the already present history row with new data. This logic
+        # makes possible to "squash" together changes made in a transaction in a
+        # single history row, assuring timestamps consistency.
         #
         execute <<-SQL
-          CREATE OR REPLACE RULE #{table}_del AS ON DELETE TO #{table} DO INSTEAD (
+          CREATE RULE #{table}_upd_next AS ON UPDATE TO #{table} DO INSTEAD (
+            UPDATE #{history} SET #{updates}
+            WHERE #{pk} = old.#{pk} AND valid_from = timezone('UTC', now());
+
+            UPDATE ONLY #{current} SET #{updates}
+            WHERE #{pk} = old.#{pk}
+          )
+        SQL
+
+        # DELETE - save the current data in the history and eventually delete the
+        # data from the temporal table.
+        # The first DELETE is required to remove history for records INSERTed and
+        # DELETEd in the same transaction.
+        #
+        execute <<-SQL
+          CREATE RULE #{table}_del AS ON DELETE TO #{table} DO INSTEAD (
+
+            DELETE FROM #{history}
+            WHERE #{pk} = old.#{pk}
+              AND valid_from = timezone('UTC', now())
+              AND valid_to   = '9999-12-31';
 
             UPDATE #{history} SET valid_to = timezone('UTC', now())
             WHERE #{pk} = old.#{pk} AND valid_to = '9999-12-31';

data/lib/chrono_model/railtie.rb

@@ -1,17 +1,21 @@
 module ChronoModel
   class Railtie < ::Rails::Railtie
+    initializer :chrono_create_schemas do
+      ActiveRecord::Base.connection.chrono_create_schemas!
+    end
+
     rake_tasks do
 
-      namespace :db do
-        namespace :chrono do
-          task :create_schemas do
-            ActiveRecord::Base.connection.chrono_create_schemas!
-          end
-        end
-      end
+     namespace :db do
+       namespace :chrono do
+         task :create_schemas do
+           puts 'create schemas'
+           ActiveRecord::Base.connection.chrono_create_schemas!
+         end
+       end
+     end
 
       task 'db:schema:load' => 'db:chrono:create_schemas'
-      task 'db:migrate'     => 'db:chrono:create_schemas'
     end
 
     class SchemaDumper < ::ActiveRecord::SchemaDumper

data/lib/chrono_model/time_machine.rb

@@ -137,6 +137,10 @@ module ChronoModel
       self.kind_of? self.class.history
     end
 
+    def attributes(*)
+      super.tap {|x| x.delete('__xid')}
+    end
+
     module ClassMethods
       # Returns an ActiveRecord::Relation on the history of this model as
       # it was +time+ ago.

data/lib/chrono_model/version.rb

@@ -1,3 +1,3 @@
 module ChronoModel
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/time_machine_spec.rb

@@ -306,4 +306,54 @@ describe ChronoModel::TimeMachine do
     end
   end
 
+  # Transactions
+  context 'Within transactions' do
+    context 'multiple updates to an existing record' do
+      let!(:r1) do
+        Foo.create!(:name => 'xact test').tap do |record|
+          Foo.transaction do
+            record.update_attribute 'name', 'lost into oblivion'
+            record.update_attribute 'name', 'does work'
+          end
+        end
+      end
+
+      it "generate only a single history record" do
+        r1.history.should have(2).entries
+
+        r1.history.first.name.should == 'xact test'
+        r1.history.last.name.should  == 'does work'
+      end
+    end
+
+    context 'insertion and subsequent update' do
+      let!(:r2) do
+        Foo.transaction do
+          Foo.create!(:name => 'lost into oblivion').tap do |record|
+            record.update_attribute 'name', 'I am Bar'
+            record.update_attribute 'name', 'I am Foo'
+          end
+        end
+      end
+
+      it 'generates a single history record' do
+        r2.history.should have(1).entry
+
+        r2.history.first.name.should == 'I am Foo'
+      end
+    end
+
+    context 'insertion and subsequent deletion' do
+      let!(:r3) do
+        Foo.transaction do
+          Foo.create!(:name => 'it never happened').destroy
+        end
+      end
+
+      it 'does not generate any history' do
+        Foo.history.where(:id => r3.id).should be_empty
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrono_model
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70658630 !ruby/object:Gem::Requirement
+  requirement: &79419830 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70658630
+  version_requirements: *79419830
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &70658260 !ruby/object:Gem::Requirement
+  requirement: &79493370 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70658260
+  version_requirements: *79493370
 description: Give your models as-of date temporal extensions. Built entirely for PostgreSQL
   >= 9.0
 email: