sequel_bitemporal 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+sequel_bitemporal
+=================
+
+Bitemporal versioning for sequel.
+
+Dependencies
+------------
+
+* Ruby >= 1.9.2
+* gem "sequel"
+
+Usage
+-----
+
+* Declare bitemporality inside your model:
+
+        class HotelPrice < Sequel::Model
+          plugin :bitemporal
+        end
+
+Build Status
+------------
+
+[![Build Status](http://travis-ci.org/TalentBox/sequel_bitemporal.png)](http://travis-ci.org/TalentBox/sequel_bitemporal)
+
+License
+-------
+
+sequel_bitemporal is Copyright © 2011 TalentBox SA. It is free software, and may be redistributed under the terms specified in the LICENSE file.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new("spec").tap do |config|
+  config.rspec_opts = "--color"
+end
+task :default => :spec

data/lib/sequel/plugins/bitemporal.rb

@@ -0,0 +1,121 @@
+module Sequel
+  module Plugins
+    module Bitemporal
+      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
+        raise Error, "bitemporal plugin requires the following missing column#{"s" if missing.size>1} on version class: #{missing.join(", ")}" unless missing.empty?
+        master.one_to_many :versions, class: version, key: :master_id
+        master.one_to_one :current_version, class: version, key: :master_id, conditions: ["created_at<=:now AND (expired_at IS NULL OR expired_at>:now) AND valid_from<=:now AND valid_to>:now", now: Time.now]
+        version.many_to_one :master, class: master, key: :master_id
+        version.class_eval do
+          def current?(now = Time.now)
+            !new? &&
+            created_at.to_time<=now &&
+            (expired_at.nil? || expired_at.to_time>now) &&
+            valid_from.to_time<=now &&
+            valid_to.to_time>now
+          end
+        end
+        master.instance_eval do
+          @version_class = version
+        end
+      end
+      module ClassMethods
+        attr_reader :version_class
+      end
+      module DatasetMethods
+      end
+      module InstanceMethods
+        attr_reader :pending_version
+
+        def validate
+          super
+          pending_version.errors.each do |key, key_errors|
+            key_errors.each{|error| errors.add key, error}
+          end if pending_version && !pending_version.valid?
+        end
+
+        def attributes
+          pending_version ? pending_version.values : {}
+        end
+
+        def attributes=(attributes)
+          @pending_version ||= model.version_class.new
+          pending_version.set attributes
+        end
+
+        def update_attributes(attributes={})
+          if attributes.delete(:partial_update) && current_version
+            current_attributes = current_version.values.dup
+            current_attributes.delete :id
+            attributes = current_attributes.merge attributes
+          end
+          self.attributes = attributes
+          save raise_on_failure: false
+        end
+
+        def after_create
+          super
+          if pending_version
+            prepare_pending_version
+            return false unless save_pending_version
+          end
+        end
+
+        def before_update
+          if pending_version
+            lock!
+            prepare_pending_version
+            expire_previous_versions
+            return false unless save_pending_version
+          end
+          super
+        end
+
+      private
+
+        def prepare_pending_version
+          point_in_time = Time.now
+          pending_version.created_at = point_in_time
+          pending_version.valid_from = point_in_time if !pending_version.valid_from || pending_version.valid_from.to_time<point_in_time
+        end
+
+        def save_pending_version
+          pending_version.valid_to ||= Time.utc 9999
+          success = add_version pending_version
+          @pending_version = nil if success
+          success
+        end
+
+        def expire_previous_versions
+          expired = versions_dataset.where expired_at: nil
+          expired = expired.exclude "valid_from=valid_to"
+          expired = expired.exclude "valid_to<=?", pending_version.valid_from
+          pending_version.valid_to ||= expired.where("valid_from>?", pending_version.valid_from).select("MIN(valid_from)").first
+          pending_version.valid_to ||= Time.utc 9999
+          expired = expired.exclude "valid_from>=?", pending_version.valid_to
+          expired = expired.all
+          expired.each do |expired_version|
+            if expired_version.valid_from<pending_version.valid_from && expired_version.valid_to>pending_version.valid_from
+              return false unless save_fossil expired_version, created_at: pending_version.created_at, valid_to: pending_version.valid_from
+            elsif expired_version.valid_from<pending_version.valid_to && expired_version.valid_to>pending_version.valid_to
+              return false unless save_fossil expired_version, created_at: pending_version.created_at, valid_from: pending_version.valid_to
+            end
+          end
+          versions_dataset.where(id: expired.collect(&:id)).update expired_at: pending_version.created_at
+        end
+
+        def save_fossil(expired, attributes={})
+          fossil = model.version_class.new
+          expired_attributes = expired.values.dup
+          expired_attributes.delete :id
+          fossil.send :set_values, expired_attributes.merge(attributes)
+          fossil.save validate: false
+        end
+      end
+    end
+  end
+end

data/lib/sequel_bitemporal.rb

@@ -0,0 +1 @@
+require "sequel/plugins/bitemporal"

data/sequel_bitemporal.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sequel_bitemporal"
+  s.version     = "0.1.0"
+  s.authors     = ["Joseph HALTER"]
+  s.email       = ["joseph.halter@thetalentbox.com"]
+  s.homepage    = "https://github.com/TalentBox/sequel_bitemporal"
+  s.summary     = "Bitemporal versioning for sequel."
+  s.description = "Bitemporal versioning for sequel, fully tested."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "timecop"
+  s.add_runtime_dependency "sequel"
+end

data/spec/bitemporal_spec.rb

@@ -0,0 +1,183 @@
+require "spec_helper"
+
+describe "Sequel::Plugins::Bitemporal" do
+  before :all do
+    DB.create_table! :rooms do
+      primary_key :id
+    end
+    DB.create_table! :room_versions do
+      primary_key :id
+      foreign_key :master_id, :rooms
+      String      :name
+      Fixnum      :price
+      Date        :created_at
+      Date        :expired_at
+      Date        :valid_from
+      Date        :valid_to
+    end
+    @version_class = Class.new Sequel::Model do
+      set_dataset :room_versions
+      def validate
+        super
+        errors.add(:name, "is required") unless name
+        errors.add(:price, "is required") unless price
+      end
+    end
+    closure = @version_class
+    @master_class = Class.new Sequel::Model do
+      set_dataset :rooms
+      plugin :bitemporal, version_class: closure
+    end
+  end
+  before do
+    Timecop.freeze 2009, 11, 28
+  end
+  after do
+    Timecop.return
+    @master_class.truncate
+    @version_class.truncate
+  end
+  it "checks version class is given" do
+    lambda{
+      @version_class.plugin :bitemporal
+    }.should raise_error Sequel::Error, "please specify version class to use for bitemporal plugin"
+  end
+  it "checks required columns are present" do
+    lambda{
+      @version_class.plugin :bitemporal, :version_class => @master_class
+    }.should raise_error Sequel::Error, "bitemporal plugin requires the following missing columns on version class: master_id, valid_from, valid_to, created_at, expired_at"
+  end
+  it "propagates errors from version to master" do
+    master = @master_class.new
+    master.should be_valid
+    master.attributes = {name: "Single Standard"}
+    master.should_not be_valid
+    master.errors.should == {price: ["is required"]}
+  end
+  it "#update_attributes returns false instead of raising errors" do
+    master = @master_class.new
+    master.update_attributes(name: "Single Standard").should be_false
+    master.should be_new
+    master.errors.should == {price: ["is required"]}
+    master.update_attributes(price: 98).should be_true
+  end
+  it "allows creating a master and its first version in one step" do
+    master = @master_class.new
+    master.update_attributes(name: "Single Standard", price: 98).should be_true
+    master.should_not be_new
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to | current |
+      | Single Standard | 98    | 2009-11-28 |            | 2009-11-28 |          | true    |
+    }
+  end
+  it "prevents creating a new version in the past" do
+    master = @master_class.new
+    master.update_attributes name: "Single Standard", price: 98, valid_from: Date.today-1
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to | current |
+      | Single Standard | 98    | 2009-11-28 |            | 2009-11-28 |          | true    |
+    }
+  end
+  it "allows creating a new version in the future" do
+    master = @master_class.new
+    master.update_attributes name: "Single Standard", price: 98, valid_from: Date.today+1
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to | current |
+      | Single Standard | 98    | 2009-11-28 |            | 2009-11-29 |          |         |
+    }
+  end
+  it "doesn't loose previous version in same-day update" do
+    master = @master_class.new
+    master.update_attributes name: "Single Standard", price: 98
+    master.update_attributes name: "Single Standard", price: 94
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to | current |
+      | Single Standard | 98    | 2009-11-28 | 2009-11-28 | 2009-11-28 |          |         |
+      | Single Standard | 94    | 2009-11-28 |            | 2009-11-28 |          | true    |
+    }
+  end
+  it "allows partial updating based on current version" do
+    master = @master_class.new
+    master.update_attributes name: "Single Standard", price: 98
+    master.update_attributes price: 94, partial_update: true
+    master.update_attributes name: "King Size", partial_update: true
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to | current |
+      | Single Standard | 98    | 2009-11-28 | 2009-11-28 | 2009-11-28 |          |         |
+      | Single Standard | 94    | 2009-11-28 | 2009-11-28 | 2009-11-28 |          |         |
+      | King Size       | 94    | 2009-11-28 |            | 2009-11-28 |          | true    |
+    }
+  end
+  it "expires previous version but keep it in history" do
+    master = @master_class.new
+    master.update_attributes name: "Single Standard", price: 98
+    Timecop.freeze Date.today+1
+    master.update_attributes price: 94, partial_update: true
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to   | current |
+      | Single Standard | 98    | 2009-11-28 | 2009-11-29 | 2009-11-28 |            |         |
+      | Single Standard | 98    | 2009-11-29 |            | 2009-11-28 | 2009-11-29 |         |
+      | Single Standard | 94    | 2009-11-29 |            | 2009-11-29 |            | true    |
+    }
+  end
+  it "doesn't expire no longer valid versions" do
+    master = @master_class.new
+    master.update_attributes name: "Single Standard", price: 98, valid_to: Date.today+1
+    Timecop.freeze Date.today+1
+    master.update_attributes(price: 94, partial_update: true).should be_false
+    master.update_attributes name: "Single Standard", price: 94
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to   | current |
+      | Single Standard | 98    | 2009-11-28 |            | 2009-11-28 | 2009-11-29 |         |
+      | Single Standard | 94    | 2009-11-29 |            | 2009-11-29 |            | true    |
+    }
+  end
+  it "allows shortening validity (COULD BE IMPROVED!)" do
+    master = @master_class.new
+    master.update_attributes name: "Single Standard", price: 98
+    Timecop.freeze Date.today+1
+    master.update_attributes valid_to: Date.today+10, partial_update: true
+    master.should have_versions %Q{
+      | name            | price | created_at | expired_at | valid_from | valid_to   | current |
+      | Single Standard | 98    | 2009-11-28 | 2009-11-29 | 2009-11-28 |            |         |
+      | Single Standard | 98    | 2009-11-29 |            | 2009-11-28 | 2009-11-29 |         |
+      | Single Standard | 98    | 2009-11-29 |            | 2009-11-29 | 2009-12-09 | true    |
+    }
+  end
+    # Timecop.freeze Date.today+1
+    # version.update_attributes valid_to: "2009-12-05"
+    # version.master.check_versions %Q{
+# | name            | price | created_at | expired_at | valid_from | valid_to   | current |
+# | Single Standard | 98.00 | 2009-11-28 | 2009-11-29 | 2009-11-28 |            |         |
+# | Single Standard | 98.00 | 2009-11-29 |            | 2009-11-28 | 2009-11-29 |         |
+# | Single Standard | 94.00 | 2009-11-29 | 2009-11-30 | 2009-11-29 |            |         |
+# | Single Standard | 94.00 | 2009-11-30 |            | 2009-11-29 | 2009-12-05 | true    |
+    # }
+    # Timecop.freeze Date.today+1
+    # version.update_attributes valid_from: "2009-12-02", valid_to: nil, price: 95
+    # version.master.check_versions %Q{
+# | name            | price | created_at | expired_at | valid_from | valid_to   | current |
+# | Single Standard | 98.00 | 2009-11-28 | 2009-11-29 | 2009-11-28 |            |         |
+# | Single Standard | 98.00 | 2009-11-29 |            | 2009-11-28 | 2009-11-29 |         |
+# | Single Standard | 94.00 | 2009-11-29 | 2009-11-30 | 2009-11-29 |            |         |
+# | Single Standard | 94.00 | 2009-11-30 | 2009-12-01 | 2009-11-29 | 2009-12-05 |         |
+# | Single Standard | 94.00 | 2009-12-01 |            | 2009-11-29 | 2009-12-02 | true    |
+# | Single Standard | 95.00 | 2009-12-01 |            | 2009-11-02 |            |         |
+    # }
+    # Timecop.freeze Date.today+1
+    # version.master.check_versions %Q{
+# | name            | price | created_at | expired_at | valid_from | valid_to   | current |
+# | Single Standard | 98.00 | 2009-11-28 | 2009-11-29 | 2009-11-28 |            |         |
+# | Single Standard | 98.00 | 2009-11-29 |            | 2009-11-28 | 2009-11-29 |         |
+# | Single Standard | 94.00 | 2009-11-29 | 2009-11-30 | 2009-11-29 |            |         |
+# | Single Standard | 94.00 | 2009-11-30 | 2009-12-01 | 2009-11-29 | 2009-12-05 |         |
+# | Single Standard | 94.00 | 2009-12-01 |            | 2009-11-29 | 2009-12-02 |         |
+# | Single Standard | 95.00 | 2009-12-01 |            | 2009-11-02 |            | true    |
+    # }
+    # missing scenarios:
+    # - same date update
+    # - save unchanged
+    # - delete scheduled version
+    # - delete all versions
+    # - simultaneous updates
+end

data/spec/spec_helper.rb

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

data/spec/support/bitemporal_matchers.rb

@@ -0,0 +1,41 @@
+RSpec::Matchers.define :have_versions do |versions_str|
+  @table = have_versions_parse_table versions_str
+  @last_index = nil
+  @last_version = nil
+  match do |master|
+    versions = master.versions_dataset.order(:id).all
+    versions.size == @table.size && @table.each.with_index.all? do |version, index|
+      @last_index = index
+      @last_version = version
+      master_version = versions[index]
+      [:name, :price, :valid_from, :valid_to, :created_at, :expired_at, :current].all? do |column|
+        expected = version[column.to_s]
+        case column
+        when :valid_to
+          expected = "9999-01-01"
+        when :current
+          expected = "false"
+        end if expected==""
+        found = master_version.send(column == :current ? "current?" : column).to_s
+        equal = found == expected
+        puts "#{column}: #{found} != #{expected}" unless equal
+        equal
+      end
+    end
+  end
+  failure_message_for_should do |master|
+    versions = master.versions_dataset.order(:id).all
+    if versions.size != @table.size
+      "Expected #{master.class} to have #{@table.size} versions but found #{versions.size}"
+    else
+      "Expected row #{@last_index+1} to match #{@last_version.inspect} but found #{versions[@last_index].inspect}"
+    end
+  end
+end
+
+def have_versions_parse_table(str)
+  rows = str.strip.split("\n")
+  rows.collect!{|row| row[/^\s*\|(.+)\|\s*$/, 1].split("|").collect(&:strip)}
+  headers = rows.shift
+  rows.collect{|row| Hash[headers.zip row]}
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: sequel_bitemporal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joseph HALTER
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2162303500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2162303500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2162303060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2162303060
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &2162330280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2162330280
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: &2162329860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2162329860
+description: Bitemporal versioning for sequel, fully tested.
+email:
+- joseph.halter@thetalentbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/sequel/plugins/bitemporal.rb
+- lib/sequel_bitemporal.rb
+- sequel_bitemporal.gemspec
+- spec/bitemporal_spec.rb
+- spec/spec_helper.rb
+- spec/support/bitemporal_matchers.rb
+homepage: https://github.com/TalentBox/sequel_bitemporal
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Bitemporal versioning for sequel.
+test_files:
+- spec/bitemporal_spec.rb
+- spec/spec_helper.rb
+- spec/support/bitemporal_matchers.rb