sequel_bitemporal 0.4.15 → 0.4.16

data/Gemfile

@@ -1,2 +1,4 @@
 source "http://rubygems.org"
 gemspec
+
+gem "pry"

data/lib/sequel/plugins/bitemporal.rb

@@ -18,7 +18,7 @@ module Sequel
       end
 
       THREAD_NOW_KEY = :sequel_plugins_bitemporal_now
-      def self.at(time)                                            
+      def self.at(time)
         previous = Thread.current[THREAD_NOW_KEY]
         raise ArgumentError, "requires a block" unless block_given?
         Thread.current[THREAD_NOW_KEY] = time.to_datetime
@@ -31,11 +31,14 @@ module Sequel
         Thread.current[THREAD_NOW_KEY] || DateTime.now
       end
 
+      def self.bitemporal_version_columns
+        @bitemporal_version_columns ||= [:master_id, :valid_from, :valid_to, :created_at, :expired_at]
+      end
+
       def self.configure(master, opts = {})
         version = opts[:version_class]
         raise Error, "please specify version class to use for bitemporal plugin" unless version
-        required = [:master_id, :valid_from, :valid_to, :created_at, :expired_at]
-        missing = required - version.columns
+        missing = bitemporal_version_columns - version.columns
         raise Error, "bitemporal plugin requires the following missing column#{"s" if missing.size>1} on version class: #{missing.join(", ")}" unless missing.empty?
         master.instance_eval do
           @version_class = version
@@ -44,6 +47,7 @@ module Sequel
           @current_version_alias = "#{base_alias}_current_version".to_sym
           @audit_class = opts[:audit_class]
           @audit_updated_by_method = opts[:audit_updated_by_method] || :updated_by_id
+          @propagate_per_column = opts.fetch(:propagate_per_column, false)
         end
         master.one_to_many :versions, class: version, key: :master_id, graph_alias_base: master.versions_alias
         master.one_to_one :current_version, class: version, key: :master_id, graph_alias_base: master.current_version_alias, :graph_block=>(proc do |j, lj, js|
@@ -91,7 +95,7 @@ module Sequel
           end
         end
         unless opts[:delegate]==false
-          (version.columns-required-[:id]).each do |column|
+          (version.columns-bitemporal_version_columns-[:id]).each do |column|
             master.class_eval <<-EOS
               def #{column}
                 pending_or_current_version.#{column} if pending_or_current_version
@@ -102,6 +106,7 @@ module Sequel
       end
       module ClassMethods
         attr_reader :version_class, :versions_alias, :current_version_alias
+        attr_reader :propagate_per_column
         attr_reader :audit_class, :audit_updated_by_method
       end
       module DatasetMethods
@@ -140,8 +145,8 @@ module Sequel
         end
 
         def attributes=(attributes)
+          @current_version_values = current_version ? current_version.values : {}
           if attributes.delete(:partial_update) && !@pending_version && !new? && current_version
-            @current_version_values = current_version.values if audited?
             current_attributes = current_version.keys.inject({}) do |hash, key|
               hash[key] = current_version.send key
               hash
@@ -149,8 +154,6 @@ module Sequel
             current_attributes.delete :valid_from
             current_attributes.delete :valid_to
             attributes = current_attributes.merge attributes
-          elsif audited? && !new? && current_version
-            @current_version_values = current_version.values
           end
           attributes.delete :id
           @pending_version ||= model.version_class.new
@@ -242,8 +245,51 @@ module Sequel
           versions_dataset.where(id: expired.collect(&:id)).update expired_at: pending_version.created_at
         end
 
+        def propagate_changes_to_future_versions
+          return true unless self.class.propagate_per_column
+          lock!
+          futures = versions_dataset.where expired_at: nil
+          futures = futures.exclude "valid_from=valid_to"
+          futures = futures.exclude "valid_to<=?", pending_version.valid_from
+          futures = futures.where "valid_from>?", pending_version.valid_from
+          futures = futures.order(:valid_from).all
+
+          excluded_columns = Sequel::Plugins::Bitemporal.bitemporal_version_columns + [:id]
+          to_check_columns = self.class.version_class.columns - excluded_columns
+          updated_by = send(self.class.audit_updated_by_method) if audited?
+          previous_values = @current_version_values
+          current_version_values = pending_version.values
+
+          futures.each do |future_version|
+            attrs = {}
+            to_check_columns.each do |col|
+              if previous_values[col]==future_version[col] &&
+                  previous_values[col]!=current_version_values[col]
+                attrs[col] = current_version_values[col]
+              end
+            end
+            if attrs.any?
+              propagated = save_propagated future_version, attrs
+              if !propagated.new? && audited?
+                self.class.audit_class.audit(
+                  self,
+                  future_version.values,
+                  propagated.values,
+                  propagated.valid_from,
+                  send(self.class.audit_updated_by_method)
+                )
+              end
+              previous_values = future_version.values.dup
+              current_version_values = propagated.values
+              future_version.this.update :expired_at => Sequel::Plugins::Bitemporal.point_in_time
+            else
+              break
+            end
+          end
+        end
+
         def save_pending_version
-          current_values_for_audit = @current_version_values || {} if audited?
+          current_values_for_audit = @current_version_values || {}
           pending_version.valid_to ||= Time.utc 9999
           success = add_version pending_version
           if success
@@ -251,10 +297,10 @@ module Sequel
               self,
               current_values_for_audit,
               pending_version.values,
-              pending_version.valid_from, 
+              pending_version.valid_from,
               send(self.class.audit_updated_by_method)
             ) if audited?
-            @current_version_values = nil if audited?
+            propagate_changes_to_future_versions
             @pending_version = nil
           end
           success
@@ -267,6 +313,16 @@ module Sequel
           fossil.send :set_values, expired_attributes.merge(attributes)
           fossil.save validate: false
         end
+
+        def save_propagated(version, attributes={})
+          propagated = model.version_class.new
+          version_attributes = version.values.dup
+          version_attributes.delete :id
+          version_attributes[:created_at] = Sequel::Plugins::Bitemporal.point_in_time
+          propagated.send :set_values, version_attributes.merge(attributes)
+          propagated.save validate: false
+          propagated
+        end
       end
     end
   end

data/sequel_bitemporal.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "sequel_bitemporal"
-  s.version     = "0.4.15"
+  s.version     = "0.4.16"
   s.authors     = ["Joseph HALTER", "Jonathan TRON"]
   s.email       = ["joseph.halter@thetalentbox.com", "jonathan.tron@thetalentbox.com"]
   s.homepage    = "https://github.com/TalentBox/sequel_bitemporal"

data/spec/bitemporal_date_spec.rb

@@ -312,6 +312,37 @@ describe "Sequel::Plugins::Bitemporal" do
       | Single Standard | 94    | 2009-11-29 |            | 2009-11-29 | MAX DATE   | true    |
     }
   end
+  it "can propagate changes to future versions per column" do
+    propagate_per_column = @master_class.propagate_per_column
+    begin
+      @master_class.instance_variable_set :@propagate_per_column, true
+      master = @master_class.new
+      master.update_attributes name: "Single Standard", price: 12, length: nil, width: 1
+      initial_today = Date.today
+      Timecop.freeze initial_today+1 do
+        master.update_attributes valid_from: initial_today+4, name: "King Size", price: 15, length: 2, width: 2, partial_update: true
+      end
+      Timecop.freeze initial_today+2 do
+        master.update_attributes valid_from: initial_today+3, length: 1, width: 1, partial_update: true
+      end
+      Timecop.freeze initial_today+3 do
+        master.update_attributes valid_from: initial_today+2, length: 3, width: 4, partial_update: true
+      end
+      master.should have_versions %Q{
+        | name            | price | length | width | created_at | expired_at | valid_from | valid_to   | current |
+        | Single Standard | 12    |        | 1     | 2009-11-28 | 2009-11-29 | 2009-11-28 | MAX DATE   | true    |
+        | Single Standard | 12    |        | 1     | 2009-11-29 | 2009-11-30 | 2009-11-28 | 2009-12-02 |         |
+        | King Size       | 15    | 2      | 2     | 2009-11-29 |            | 2009-12-02 | MAX DATE   |         |
+        | Single Standard | 12    |        | 1     | 2009-11-30 | 2009-12-01 | 2009-11-28 | 2009-12-01 |         |
+        | Single Standard | 12    | 1      | 1     | 2009-11-30 | 2009-12-01 | 2009-12-01 | 2009-12-02 |         |
+        | Single Standard | 12    |        | 1     | 2009-12-01 |            | 2009-11-28 | 2009-11-30 |         |
+        | Single Standard | 12    | 3      | 4     | 2009-12-01 |            | 2009-11-30 | 2009-12-01 |         |
+        | Single Standard | 12    | 1      | 4     | 2009-12-01 |            | 2009-12-01 | 2009-12-02 |         |
+      }
+    ensure
+      @master_class.instance_variable_set :@propagate_per_column, propagate_per_column
+    end
+  end
   it "allows eager loading with conditions on current version" do
     master = @master_class.new
     master.update_attributes name: "Single Standard", price: 98
@@ -532,7 +563,9 @@ end
 describe "Sequel::Plugins::Bitemporal", "with audit" do
   include DbHelpers
   before :all do
-    @audit_class = Class.new
+    @audit_class = Class.new do
+      def self.audit(*args); end
+    end
     db_setup audit_class: @audit_class
   end
   before do
@@ -556,7 +589,6 @@ describe "Sequel::Plugins::Bitemporal", "with audit" do
   it "generates a new audit on full update" do
     master = @master_class.new
     master.should_receive(:updated_by_id).twice.and_return(updated_by_id = stub)
-    @audit_class.stub(:audit)
     master.update_attributes name: "Single Standard", price: 98
     @audit_class.should_receive(:audit).with(
       master,
@@ -570,7 +602,6 @@ describe "Sequel::Plugins::Bitemporal", "with audit" do
   it "generates a new audit on partial update" do
     master = @master_class.new
     master.should_receive(:updated_by_id).twice.and_return(updated_by_id = stub)
-    @audit_class.stub(:audit)
     master.update_attributes name: "Single Standard", price: 98
     @audit_class.should_receive(:audit).with(
       master,
@@ -581,11 +612,55 @@ describe "Sequel::Plugins::Bitemporal", "with audit" do
     )
     master.update_attributes partial_update: true, name: "King size", price: 98 
   end
+  it "generate a new audit for each future version update when propagating changes" do
+    propagate_per_column = @master_class.propagate_per_column
+    begin
+      @master_class.instance_variable_set :@propagate_per_column, true
+      master = @master_class.new
+      master.should_receive(:updated_by_id).exactly(9).times.and_return(updated_by_id = stub)
+
+      master.update_attributes name: "Single Standard", price: 12, length: nil, width: 1
+      initial_today = Date.today
+      Timecop.freeze initial_today+1 do
+        Sequel::Plugins::Bitemporal.at initial_today+4 do
+          master.update_attributes valid_from: initial_today+4, name: "King Size", price: 15, length: 2, width: 2, partial_update: true
+        end
+      end
+      Timecop.freeze initial_today+2 do
+        Sequel::Plugins::Bitemporal.at initial_today+3 do
+          master.update_attributes valid_from: initial_today+3, length: 1, width: 1, partial_update: true
+        end
+      end
+      @audit_class.should_receive(:audit).with(
+        master,
+        hash_including({name: "Single Standard", price: 12, length: nil, width: 1}),
+        hash_including({name: "Single Standard", price: 12, length: 3, width: 4}),
+        initial_today+2,
+        updated_by_id
+      )
+      @audit_class.should_receive(:audit).with(
+        master,
+        hash_including({name: "Single Standard", price: 12, length: 1, width: 1}),
+        hash_including({name: "Single Standard", price: 12, length: 1, width: 4}),
+        initial_today+3,
+        updated_by_id
+      )
+      Timecop.freeze initial_today+3 do
+        Sequel::Plugins::Bitemporal.at initial_today+2 do
+          master.update_attributes valid_from: initial_today+2, length: 3, width: 4, partial_update: true
+        end
+      end
+    ensure
+      @master_class.instance_variable_set :@propagate_per_column, propagate_per_column
+    end
+  end
 end
 describe "Sequel::Plugins::Bitemporal", "with audit, specifying how to get the updated id" do
   include DbHelpers
   before :all do
-    @audit_class = Class.new
+    @audit_class = Class.new do
+      def self.audit(*args); end
+    end
     db_setup audit_class: @audit_class, audit_updated_by_method: :author_id
   end
   before do
@@ -609,7 +684,6 @@ describe "Sequel::Plugins::Bitemporal", "with audit, specifying how to get the u
   it "generates a new audit on full update" do
     master = @master_class.new
     master.should_receive(:author_id).twice.and_return(updated_by_id = stub)
-    @audit_class.stub(:audit)
     master.update_attributes name: "Single Standard", price: 98
     @audit_class.should_receive(:audit).with(
       master,
@@ -623,7 +697,6 @@ describe "Sequel::Plugins::Bitemporal", "with audit, specifying how to get the u
   it "generates a new audit on partial update" do
     master = @master_class.new
     master.should_receive(:author_id).twice.and_return(updated_by_id = stub)
-    @audit_class.stub(:audit)
     master.update_attributes name: "Single Standard", price: 98
     @audit_class.should_receive(:audit).with(
       master,

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "sequel"
 require "timecop"
+require "pry"
 DB = Sequel.sqlite
-Dir[File.expand_path("../support/*.rb", __FILE__)].each{|f| require f}
+Dir[File.expand_path("../support/*.rb", __FILE__)].each{|f| require f}

data/spec/support/db.rb

@@ -19,6 +19,8 @@ module DbHelpers
       foreign_key :master_id, :rooms
       String      :name
       Fixnum      :price
+      Fixnum      :length
+      Fixnum      :width
       send(use_time ? :Time : :Date, :created_at)
       send(use_time ? :Time : :Date, :expired_at)
       send(use_time ? :Time : :Date, :valid_from)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel_bitemporal
 version: !ruby/object:Gem::Version
-  version: 0.4.15
+  version: 0.4.16
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2816087216667685426
+      hash: -3018429499339951723
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2816087216667685426
+      hash: -3018429499339951723
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24