chrono_model 0.3.0

data/spec/support/matchers/table.rb

@@ -0,0 +1,171 @@
+require 'support/matchers/base'
+
+module ChronoTest::Matchers
+
+  module Table
+    class Base < ChronoTest::Matchers::Base
+
+      protected
+        # Database statements
+        #
+        def relation_exists?(options)
+          schema = options[:in]
+          kind   = options[:kind] == :view ? 'v' : 'r'
+
+          select_value(<<-SQL, [ table, schema ], 'Check table exists') == 't'
+            SELECT EXISTS (
+              SELECT 1
+                FROM pg_class c
+                LEFT JOIN pg_namespace n ON n.oid = c.relnamespace
+               WHERE c.relkind = '#{kind}'
+                 AND c.relname = $1
+                 AND n.nspname = $2
+            )
+          SQL
+        end
+    end
+
+    # ##################################################################
+    # Checks that a table exists in the Public schema
+    #
+    class HavePublicBacking < Base
+      def matches?(table)
+        super(table)
+
+        relation_exists? :in => public_schema
+      end
+
+      def failure_message_for_should
+        "expected #{table} to exist in the #{public_schema} schema"
+      end
+    end
+
+    def have_public_backing
+      HavePublicBacking.new
+    end
+
+
+    # ##################################################################
+    # Checks that a table exists in the Temporal schema
+    #
+    class HaveTemporalBacking < Base
+      def matches?(table)
+        super(table)
+
+        relation_exists? :in => temporal_schema
+      end
+
+      def failure_message_for_should
+        "expected #{table} to exist in the #{temporal_schema} schema"
+      end
+    end
+
+    def have_temporal_backing
+      HaveTemporalBacking.new
+    end
+
+
+    # ##################################################################
+    # Checks that a table exists in the History schema and inherits from
+    # the one in the Temporal schema
+    #
+    class HaveHistoryBacking < Base
+      def matches?(table)
+        super(table)
+
+        table_exists? && inherits_from_temporal?
+      end
+
+      def failure_message_for_should
+        "expected #{table} ".tap do |message|
+          message << [
+            ("to exist in the #{history_schema} schema"    unless @existance),
+            ("to inherit from #{temporal_schema}.#{table}" unless @inheritance)
+          ].compact.to_sentence
+        end
+      end
+
+      private
+        def table_exists?
+          @existance = relation_exists? :in => history_schema
+        end
+
+        def inherits_from_temporal?
+          binds = ["#{history_schema}.#{table}", "#{temporal_schema}.#{table}"]
+
+          @inheritance = select_value(<<-SQL, binds, 'Check inheritance') == 't'
+            SELECT EXISTS (
+              SELECT 1 FROM pg_catalog.pg_inherits
+               WHERE inhrelid  = $1::regclass::oid
+                 AND inhparent = $2::regclass::oid
+            )
+          SQL
+        end
+    end
+
+    def have_history_backing
+      HaveHistoryBacking.new
+    end
+
+
+    # ##################################################################
+    # Checks that a table exists in the Public schema, is an updatable
+    # view and has an INSERT, UPDATE and DELETE rule.
+    #
+    class HavePublicInterface < Base
+      def matches?(table)
+        super(table)
+
+        view_exists? && [ is_updatable?, has_rules? ].all?
+      end
+
+      def failure_message_for_should
+        "expected #{table} ".tap do |message|
+          message << [
+            ("to exist in the #{public_schema} schema" unless @existance  ),
+            ('to be an updatable view'                 unless @updatable  ),
+            ('to have an INSERT rule'                  unless @insert_rule),
+            ('to have an UPDATE rule'                  unless @update_rule),
+            ('to have a DELETE rule'                   unless @delete_rule)
+          ].compact.to_sentence
+        end
+      end
+
+      private
+        def view_exists?
+          @existance = relation_exists? :in => public_schema, :kind => :view
+        end
+
+        def is_updatable?
+          binds = [ public_schema, table ]
+
+          @updatable = select_value(<<-SQL, binds, 'Check updatable') == 'YES'
+            SELECT is_updatable FROM information_schema.views
+             WHERE table_schema = $1 AND table_name = $2
+          SQL
+        end
+
+        def has_rules?
+          rules = select_values(<<-SQL, [ public_schema, table ], 'Check rules')
+            SELECT UNNEST(REGEXP_MATCHES(
+                definition, 'ON (INSERT|UPDATE|DELETE) TO #{table} DO INSTEAD'
+              ))
+             FROM pg_catalog.pg_rules
+            WHERE schemaname = $1
+              AND tablename  = $2
+          SQL
+
+          @insert_rule = rules.include? 'INSERT'
+          @update_rule = rules.include? 'UPDATE'
+          @delete_rule = rules.include? 'DELETE'
+
+          @insert_rule && @update_rule && @delete_rule
+        end
+    end
+
+    def have_public_interface
+      HavePublicInterface.new
+    end
+  end
+
+end

data/spec/time_machine_spec.rb

@@ -0,0 +1,299 @@
+require 'spec_helper'
+require 'support/helpers'
+
+describe ChronoModel::TimeMachine do
+  include ChronoTest::Helpers::TimeMachine
+
+  setup_schema!
+  define_models!
+
+  describe '.chrono_models' do
+    subject { ChronoModel::TimeMachine.chrono_models }
+
+    it { should == {'foos' => Foo, 'bars' => Bar} }
+  end
+
+
+  # Set up two associated records, with intertwined updates
+  #
+  let!(:foo) {
+    foo = ts_eval { Foo.create! :name => 'foo', :fooity => 1 }
+    ts_eval(foo) { update_attributes! :name => 'foo bar' }
+  }
+
+  let!(:bar) {
+    bar = ts_eval { Bar.create! :name => 'bar', :foo => foo }
+    ts_eval(bar) { update_attributes! :name => 'foo bar' }
+
+    ts_eval(foo) { update_attributes! :name => 'new foo' }
+
+    ts_eval(bar) { update_attributes! :name => 'bar bar' }
+    ts_eval(bar) { update_attributes! :name => 'new bar' }
+  }
+
+  # Specs start here
+  #
+  describe '#as_of' do
+    describe 'accepts a Time instance' do
+      it { foo.as_of(Time.now).name.should == 'new foo' }
+      it { bar.as_of(Time.now).name.should == 'new bar' }
+    end
+
+    describe 'ignores time zones' do
+      it { foo.as_of(Time.now.in_time_zone('America/Havana')).name.should == 'new foo' }
+      it { bar.as_of(Time.now.in_time_zone('America/Havana')).name.should == 'new bar' }
+    end
+
+    describe 'returns records as they were before' do
+      it { foo.as_of(foo.ts[0]).name.should == 'foo' }
+      it { foo.as_of(foo.ts[1]).name.should == 'foo bar' }
+      it { foo.as_of(foo.ts[2]).name.should == 'new foo' }
+
+      it { bar.as_of(bar.ts[0]).name.should == 'bar' }
+      it { bar.as_of(bar.ts[1]).name.should == 'foo bar' }
+      it { bar.as_of(bar.ts[2]).name.should == 'bar bar' }
+      it { bar.as_of(bar.ts[3]).name.should == 'new bar' }
+    end
+
+    describe 'takes care of associated records' do
+      it { foo.as_of(foo.ts[0]).bars.should == [] }
+      it { foo.as_of(foo.ts[1]).bars.should == [] }
+      it { foo.as_of(foo.ts[2]).bars.should == [bar] }
+
+      it { foo.as_of(foo.ts[2]).bars.first.name.should == 'foo bar' }
+
+
+      it { foo.as_of(bar.ts[0]).bars.should == [bar] }
+      it { foo.as_of(bar.ts[1]).bars.should == [bar] }
+      it { foo.as_of(bar.ts[2]).bars.should == [bar] }
+      it { foo.as_of(bar.ts[3]).bars.should == [bar] }
+
+      it { foo.as_of(bar.ts[0]).bars.first.name.should == 'bar' }
+      it { foo.as_of(bar.ts[1]).bars.first.name.should == 'foo bar' }
+      it { foo.as_of(bar.ts[2]).bars.first.name.should == 'bar bar' }
+      it { foo.as_of(bar.ts[3]).bars.first.name.should == 'new bar' }
+
+
+      it { bar.as_of(bar.ts[0]).foo.should == foo }
+      it { bar.as_of(bar.ts[1]).foo.should == foo }
+      it { bar.as_of(bar.ts[2]).foo.should == foo }
+      it { bar.as_of(bar.ts[3]).foo.should == foo }
+
+      it { bar.as_of(bar.ts[0]).foo.name.should == 'foo bar' }
+      it { bar.as_of(bar.ts[1]).foo.name.should == 'foo bar' }
+      it { bar.as_of(bar.ts[2]).foo.name.should == 'new foo' }
+      it { bar.as_of(bar.ts[3]).foo.name.should == 'new foo' }
+    end
+
+    it 'raises RecordNotFound when no history records are found' do
+      expect { foo.as_of(1.minute.ago) }.to raise_error
+    end
+  end
+
+  describe '#history' do
+    describe 'returns historical instances' do
+      it { foo.history.should have(3).entries }
+      it { foo.history.map(&:name).should == ['foo', 'foo bar', 'new foo'] }
+
+      it { bar.history.should have(4).entries }
+      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 }
+    end
+
+    describe 'takes care of associated records' do
+      subject { foo.history.map {|f| f.bars.first.try(:name)} }
+      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 }
+    end
+  end
+
+  describe '#historical?' do
+    describe 'on plain records' do
+      subject { foo.historical? }
+      it { should be_false }
+    end
+
+    describe 'on historical records' do
+      describe 'from #history' do
+        subject { foo.history.first }
+        it { should be_true }
+      end
+
+      describe 'from #as_of' do
+        subject { foo.as_of(Time.now) }
+        it { should be_true }
+      end
+    end
+  end
+
+  describe '#destroy' do
+    describe 'on historical records' do
+      subject { foo.history.first.destroy }
+      it { expect { subject }.to raise_error(ActiveRecord::ReadOnlyRecord) }
+    end
+
+    describe 'on current records' do
+      let!(:rec) {
+        rec = ts_eval { Foo.create!(:name => 'alive foo', :fooity => 42) }
+        ts_eval(rec) { update_attributes!(:name => 'dying foo') }
+      }
+
+      subject { rec.destroy }
+
+      it { expect { subject }.to_not raise_error }
+      it { expect { rec.reload }.to raise_error(ActiveRecord::RecordNotFound) }
+
+      describe 'does not delete its history' do
+        context do
+          subject { rec.as_of(rec.ts.first) }
+          its(:name) { should == 'alive foo' }
+        end
+
+        context do
+          subject { rec.as_of(rec.ts.last) }
+          its(:name) { should == 'dying foo' }
+        end
+
+        context do
+          subject { Foo.as_of(rec.ts.first).where(:fooity => 42).first }
+          its(:name) { should == 'alive foo' }
+        end
+
+        context do
+          subject { Foo.history.where(:fooity => 42).map(&:name) }
+          it { should == ['alive foo', 'dying foo'] }
+        end
+      end
+    end
+  end
+
+  describe '#history_timestamps' do
+    timestamps_from = lambda {|*records|
+      records.map(&:history).flatten!.inject([]) {|ret, rec|
+        ret.concat [rec.valid_from, rec.valid_to]
+      }.sort.uniq[0..-2]
+    }
+
+    describe 'on records having an :has_many relationship' do
+      subject { foo.history_timestamps }
+
+      describe 'returns timestamps of the record and its associations' do
+        its(:size) { should == foo.ts.size + bar.ts.size }
+        it { should == timestamps_from.call(foo, bar) }
+      end
+    end
+
+    describe 'on records having a :belongs_to relationship' do
+      subject { bar.history_timestamps }
+
+      describe 'returns timestamps of the record only' do
+        its(:size) { should == bar.ts.size }
+        it { should == timestamps_from.call(bar) }
+      end
+    end
+  end
+
+  context do
+    history_attrs = ChronoModel::TimeMachine::HISTORY_ATTRIBUTES
+
+    let!(:history) { foo.history.first }
+    let!(:current) { foo }
+
+    history_attrs.each do |attr|
+      describe ['#', attr].join do
+        describe 'on history records' do
+          subject { history.public_send(attr) }
+
+          it { should be_present }
+          it { should be_a(Time) }
+          it { should be_utc }
+        end
+
+        describe 'on current records' do
+          subject { current.public_send(attr) }
+          it { should be_nil }
+        end
+      end
+    end
+
+    describe '#initialize_dup' do
+      describe 'on history records' do
+        subject { history.dup }
+
+        history_attrs.each do |attr|
+          its(attr) { should be_nil }
+        end
+
+        it { should_not be_readonly }
+        it { should be_new_record }
+
+      end
+    end
+  end
+
+  # Class methods
+  context do
+    let!(:foos) { Array.new(2) {|i| ts_eval { Foo.create! :name => "foo #{i}" } } }
+    let!(: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 { Foo.as_of(1.month.ago).should == [] }
+
+      it { Foo.as_of(foos[0].ts[0]).should == [foo, foos[0]] }
+      it { Foo.as_of(foos[1].ts[0]).should == [foo, foos[0], foos[1]] }
+      it { Foo.as_of(Time.now     ).should == [foo, foos[0], foos[1]] }
+
+      it { Bar.as_of(foos[1].ts[0]).should == [bar] }
+
+      it { Bar.as_of(bars[0].ts[0]).should == [bar, bars[0]] }
+      it { Bar.as_of(bars[1].ts[0]).should == [bar, bars[0], bars[1]] }
+      it { Bar.as_of(Time.now     ).should == [bar, bars[0], bars[1]] }
+
+      # Associations
+      context do
+        subject { foos[0] }
+
+        it { Foo.as_of(foos[0].ts[0]).find(subject).bars.should == [] }
+        it { Foo.as_of(foos[1].ts[0]).find(subject).bars.should == [] }
+        it { Foo.as_of(bars[0].ts[0]).find(subject).bars.should == [bars[0]] }
+        it { Foo.as_of(bars[1].ts[0]).find(subject).bars.should == [bars[0]] }
+        it { Foo.as_of(Time.now     ).find(subject).bars.should == [bars[0]] }
+      end
+
+      context do
+        subject { foos[1] }
+
+        it { expect { Foo.as_of(foos[0].ts[0]).find(subject) }.to raise_error(ActiveRecord::RecordNotFound) }
+        it { expect { Foo.as_of(foos[1].ts[0]).find(subject) }.to_not raise_error }
+
+        it { Foo.as_of(bars[0].ts[0]).find(subject).bars.should == [] }
+        it { Foo.as_of(bars[1].ts[0]).find(subject).bars.should == [bars[1]] }
+        it { Foo.as_of(Time.now     ).find(subject).bars.should == [bars[1]] }
+      end
+    end
+
+    describe '.history' do
+      let(:foo_history) {
+        ['foo', 'foo bar', 'new foo', 'alive foo', 'dying foo', 'foo 0', 'foo 1']
+      }
+
+      let(:bar_history) {
+        ['bar', 'foo bar', 'bar bar', 'new bar', 'bar 0', 'bar 1']
+      }
+
+      it { Foo.history.map(&:name).should == foo_history }
+      it { Bar.history.map(&:name).should == bar_history }
+    end
+  end
+
+end