sbf-dm-core 1.3.0.beta

data/spec/semipublic/resource/state/clean_spec.rb

@@ -0,0 +1,89 @@
+require_relative '../../../spec_helper'
+
+describe DataMapper::Resource::PersistenceState::Clean do
+  before :all do
+    class ::Author
+      include DataMapper::Resource
+
+      property :id,     HugeInteger, :key => true, :default => 1
+      property :name,   String
+      property :active, Boolean,     :default => true
+      property :coding, Boolean,     :default => true
+
+      belongs_to :parent, self, :required => false
+      has n, :children, self, :inverse => :parent
+    end
+    DataMapper.finalize
+
+    @model = Author
+  end
+
+  before do
+    @resource = @model.create(:name => 'Dan Kubb')
+
+    @state = @resource.persistence_state
+    expect(@state).to be_kind_of(DataMapper::Resource::PersistenceState::Clean)
+  end
+
+  after do
+    @model.destroy!
+  end
+
+  [ :commit, :rollback ].each do |method|
+    describe "##{method}" do
+      subject { @state.send(method) }
+
+      supported_by :all do
+        it 'is a no-op' do
+          is_expected.to equal(@state)
+        end
+      end
+    end
+  end
+
+  describe '#delete' do
+    subject { @state.delete }
+
+    supported_by :all do
+      it 'returns a Deleted state' do
+        is_expected.to eql(DataMapper::Resource::PersistenceState::Deleted.new(@resource))
+      end
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like 'Resource::PersistenceState::Persisted#get'
+  end
+
+  describe '#set' do
+    subject { @state.set(@key, @value) }
+
+    supported_by :all do
+      describe 'with attributes that make the resource dirty' do
+        before do
+          @key = @model.properties[:name]
+          @value = nil
+        end
+
+        it_behaves_like 'A method that delegates to the superclass #set'
+
+        it 'returns a Dirty state' do
+          is_expected.to eql(DataMapper::Resource::PersistenceState::Dirty.new(@resource))
+        end
+      end
+
+      describe 'with attributes that keep the resource clean' do
+        before do
+          @key   = @model.properties[:name]
+          @value = 'Dan Kubb'
+        end
+
+        it_behaves_like 'A method that does not delegate to the superclass #set'
+
+        it 'returns a Clean state' do
+          is_expected.to equal(@state)
+        end
+      end
+    end
+  end
+end

data/spec/semipublic/resource/state/deleted_spec.rb

@@ -0,0 +1,79 @@
+require_relative '../../../spec_helper'
+
+describe DataMapper::Resource::PersistenceState::Deleted do
+  before :all do
+    class ::Author
+      include DataMapper::Resource
+
+      property :id,     HugeInteger, :key => true, :default => 1
+      property :name,   String
+      property :active, Boolean,     :default => true
+      property :coding, Boolean,     :default => true
+
+      belongs_to :parent, self, :required => false
+      has n, :children, self, :inverse => :parent
+    end
+
+    DataMapper.finalize
+    @model = Author
+  end
+
+  before do
+    @resource = @model.create(:name => 'Dan Kubb')
+
+    @state = DataMapper::Resource::PersistenceState::Deleted.new(@resource)
+  end
+
+  after do
+    @model.destroy!
+  end
+
+  describe '#commit' do
+    subject { @state.commit }
+
+    supported_by :all do
+      it 'returns an Immutable state' do
+        is_expected.to eql(DataMapper::Resource::PersistenceState::Immutable.new(@resource))
+      end
+
+      it 'deletes the resource' do
+        subject
+        expect(@model.get(*@resource.key)).to be_nil
+      end
+
+      it 'removes the resource from the identity map' do
+        identity_map = @resource.repository.identity_map(@model)
+        expect { method(:subject) }.to change { identity_map.dup }.from(@resource.key => @resource).to({})
+      end
+    end
+  end
+
+  describe '#delete' do
+    subject { @state.delete }
+
+    supported_by :all do
+      it 'is a no-op' do
+        is_expected.to equal(@state)
+      end
+    end
+  end
+
+  describe '#get' do
+    it_behaves_like 'Resource::PersistenceState::Persisted#get'
+  end
+
+  describe '#set' do
+    subject { @state.set(@key, @value) }
+
+    supported_by :all do
+      before do
+        @key   = @model.properties[:name]
+        @value = @key.get!(@resource)
+      end
+
+      it 'raises an exception' do
+        expect { method(:subject) }.to raise_error(DataMapper::ImmutableDeletedError, 'Deleted resource cannot be modified')
+      end
+    end
+  end
+end

data/spec/semipublic/resource/state/dirty_spec.rb

@@ -0,0 +1,163 @@
+require_relative '../../../spec_helper'
+
+describe DataMapper::Resource::PersistenceState::Dirty do
+  before :all do
+    class ::Author
+      include DataMapper::Resource
+
+      property :id,     HugeInteger, :key => true, :default => 1
+      property :name,   String
+      property :active, Boolean,     :default => true
+      property :coding, Boolean,     :default => true
+
+      belongs_to :parent, self, :required => false
+      has n, :children, self, :inverse => :parent
+    end
+
+    DataMapper.finalize
+
+    @model = Author
+  end
+
+  before do
+    @parent = @model.create(:name => 'Jane Doe')
+
+    @resource = @model.create(:id => 2, :name => 'Dan Kubb', :parent => @parent)
+    @resource.attributes = { :name => 'John Doe' }
+
+    @state = @resource.persistence_state
+    expect(@state).to be_kind_of(DataMapper::Resource::PersistenceState::Dirty)
+  end
+
+  after do
+    @model.destroy!
+  end
+
+  describe '#commit' do
+    subject { @state.commit }
+
+    supported_by :all do
+      context 'with valid attributes' do
+        let(:state) { @state }
+
+        before do
+          @new_id = @resource.id = @resource.id.succ
+        end
+
+        it 'returns a Clean state' do
+          is_expected.to eql(DataMapper::Resource::PersistenceState::Clean.new(@resource))
+        end
+
+        it 'sets the child key if the parent key changes' do
+          original_id = @parent.id
+          expect { @parent.update(id: 42) }.to be(true)
+          expect { method(:subject) }.to change(@resource, :parent_id).from(original_id).to(42)
+        end
+
+        it 'updates the resource' do
+          subject
+          expect { @model.get!(*@resource.key) }.to eq @resource
+        end
+
+        it 'updates the resource to the identity map if the key changed' do
+          identity_map = @resource.repository.identity_map(@model)
+          expect(identity_map).to eq({ @resource.key => @resource })
+          subject
+          expect(identity_map).to eq({[@new_id] => @resource})
+        end
+      end
+
+      context 'with invalid attributes' do
+        before do
+          @resource.coding = 'invalid'
+        end
+
+        it 'raises InvalidValueError' do
+          expect { subject }.to(raise_error(DataMapper::Property::InvalidValueError) do |error|
+            expect(error.property).to eq Author.coding
+          end)
+        end
+
+        it 'does not change the identity map' do
+          identity_map = @resource.repository.identity_map(@model).dup
+          expect { subject }.to raise_error(DataMapper::Property::InvalidValueError)
+          expect(identity_map).to eq @resource.repository.identity_map(@model)
+        end
+      end
+    end
+  end
+
+  describe '#delete' do
+    subject { @state.delete }
+
+    supported_by :all do
+      before do
+        @resource.children = [ @resource.parent = @resource ]
+      end
+
+      it_behaves_like 'It resets resource state'
+
+      it 'returns a Deleted state' do
+        is_expected.to eql(DataMapper::Resource::PersistenceState::Deleted.new(@resource))
+      end
+    end
+  end
+
+  describe '#get' do
+    before do
+      @loaded_value = 'John Doe'
+    end
+
+    it_behaves_like 'Resource::PersistenceState::Persisted#get'
+  end
+
+  describe '#rollback' do
+    subject { @state.rollback }
+
+    supported_by :all do
+      before do
+        @resource.children = [ @resource.parent = @resource ]
+      end
+
+      it_behaves_like 'It resets resource state'
+
+      it 'returns a Clean state' do
+        is_expected.to eql(DataMapper::Resource::PersistenceState::Clean.new(@resource))
+      end
+    end
+  end
+
+  describe '#set' do
+    subject { @state.set(@key, @value) }
+
+    supported_by :all do
+      describe 'with attributes that keep the resource dirty' do
+        before do
+          @key   = @model.properties[:id]
+          @value = @key.get!(@resource)
+        end
+
+        it_behaves_like 'A method that delegates to the superclass #set'
+
+        it 'returns a Dirty state' do
+          is_expected.to equal(@state)
+        end
+
+        its(:original_attributes) { is_expected.to eq({@model.properties[:name] => 'Dan Kubb'}) }
+      end
+
+      describe 'with attributes that make the resource clean' do
+        before do
+          @key   = @model.properties[:name]
+          @value = 'Dan Kubb'
+        end
+
+        it_behaves_like 'A method that delegates to the superclass #set'
+
+        it 'returns a Clean state' do
+          is_expected.to eql(DataMapper::Resource::PersistenceState::Clean.new(@resource))
+        end
+      end
+    end
+  end
+end

data/spec/semipublic/resource/state/immutable_spec.rb

@@ -0,0 +1,107 @@
+require_relative '../../../spec_helper'
+
+describe DataMapper::Resource::PersistenceState::Immutable do
+  before :all do
+    class ::Author
+      include DataMapper::Resource
+
+      property :id,     Serial
+      property :name,   String
+      property :active, Boolean, :default => true
+      property :coding, Boolean, :default => true
+
+      belongs_to :parent, self, :required => false
+    end
+
+    DataMapper.finalize
+
+    @model = Author
+  end
+
+  before do
+    @parent = @model.create(:name => 'John Doe')
+
+    @resource  = @model.create(:name => 'Dan Kubb', :parent => @parent)
+    attributes = Hash[ @model.key.zip(@resource.key) ]
+    @resource  = @model.first(attributes.merge(:fields => [ :name, :parent_id ]))
+
+    @state = @resource.persistence_state
+
+    expect(@state).to be_kind_of(DataMapper::Resource::PersistenceState::Immutable)
+  end
+
+  after do
+    @model.destroy!
+  end
+
+  describe '#commit' do
+    subject { @state.commit }
+
+    supported_by :all do
+      it 'is a no-op' do
+        is_expected.to equal(@state)
+      end
+    end
+  end
+
+  describe '#delete' do
+    subject { @state.delete }
+
+    supported_by :all do
+      it 'raises an exception' do
+        expect { method(:subject) }.to raise_error(DataMapper::ImmutableError, 'Immutable resource cannot be deleted')
+      end
+    end
+  end
+
+  describe '#get' do
+    subject { @state.get(@key) }
+
+    supported_by :all do
+      describe 'with an unloaded property' do
+        before do
+          @key = @model.properties[:id]
+        end
+
+        it 'raises an exception' do
+          expect { method(:subject) }.to raise_error(DataMapper::ImmutableError, 'Immutable resource cannot be lazy loaded')
+        end
+      end
+
+      describe 'with an unloaded relationship' do
+        before do
+          @key = @model.relationships[:parent]
+        end
+
+        it 'returns value' do
+          is_expected.to eq @parent
+        end
+      end
+
+      describe 'with a loaded subject' do
+        before do
+          @key = @model.properties[:name]
+        end
+
+        it 'returns value' do
+          is_expected.to eq 'Dan Kubb'
+        end
+      end
+    end
+  end
+
+  describe '#set' do
+    before do
+      @key   = @model.properties[:name]
+      @value = @key.get!(@resource)
+    end
+
+    subject { @state.set(@key, @value) }
+
+    supported_by :all do
+      it 'raises an exception' do
+        expect { method(:subject) }.to raise_error(DataMapper::ImmutableError, 'Immutable resource cannot be modified')
+      end
+    end
+  end
+end

data/spec/semipublic/resource/state/transient_spec.rb

@@ -0,0 +1,163 @@
+require_relative '../../../spec_helper'
+
+describe DataMapper::Resource::PersistenceState::Transient do
+  before :all do
+    class ::Author
+      include DataMapper::Resource
+
+      property :id,          Serial
+      property :name,        String
+      property :age,         Integer
+      property :description, Text,    :default => lambda { |resource, property| resource.name }
+      property :active,      Boolean, :default => true
+      property :coding,      Boolean, :default => true
+
+      belongs_to :parent, self, :required => false
+      has n, :children, self, :inverse => :parent
+
+      belongs_to :with_default, self, :required => false, :default => proc { first(:name => 'John Doe') }
+    end
+
+    DataMapper.finalize
+
+    @model = Author
+  end
+
+  before do
+    @parent   = @model.create(:name => 'John Doe')
+    @resource = @model.new(:name => 'Dan Kubb', :coding => false, :parent => @parent)
+
+    @state = @resource.persistence_state
+    expect(@state).to be_kind_of(DataMapper::Resource::PersistenceState::Transient)
+  end
+
+  after do
+    @model.destroy!
+  end
+
+  describe '#commit' do
+    subject { @state.commit }
+
+    supported_by :all do
+      it 'Returns the expected Clean state' do
+        is_expected.to eql(DataMapper::Resource::PersistenceState::Clean.new(@resource))
+      end
+
+      it 'Sets the serial property' do
+        expect { method(:subject) }.to change(@resource, :id).from(nil)
+      end
+
+      it 'Sets the child key if the parent key changes' do
+        # SqlServer does not allow updating IDENTITY columns.
+        if defined?(DataMapper::Adapters::SqlserverAdapter) &&
+           @adapter.kind_of?(DataMapper::Adapters::SqlserverAdapter)
+          return
+        end
+
+        original_id = @parent.id
+        expect { @parent.update(id: 42) }.to be(true)
+        expect { method(:subject) }.to change(@resource, :parent_id).from(original_id).to(42)
+      end
+
+      it 'Sets the default values' do
+        expect { method(:subject) }.to change { @model.relationships[:with_default].get!(@resource) }.from(nil).to(@parent)
+      end
+
+      it "Doesn't set default values when they are already set" do
+        expect { method(:subject) }.not_to change(@resource, :coding)
+      end
+
+      it 'Creates the resource' do
+        subject
+        expect { @model.get(*@resource.key) }.to eq @resource
+      end
+
+      it 'resets original attributes' do
+        original_attributes = {
+          @model.properties[:name]      => nil,
+          @model.properties[:coding]    => nil,
+          @model.properties[:parent_id] => nil,
+          @model.relationships[:parent] => nil,
+        }
+
+        expect do
+          @resource.persistence_state = subject
+        end.to change { @resource.original_attributes.dup }.from(original_attributes).to({})
+      end
+
+      it 'adds the resource to the identity map' do
+        DataMapper.repository do |repository|
+          identity_map = repository.identity_map(@model)
+          expect(identity_map).to be_empty
+          subject
+          expect(identity_map).to eq({@parent.key => @parent, @resource.key => @resource})
+        end
+      end
+    end
+  end
+
+  [ :delete, :rollback ].each do |method|
+    describe "##{method}" do
+      subject { @state.send(method) }
+
+      supported_by :all do
+        it 'is a no-op' do
+          is_expected.to equal(@state)
+        end
+      end
+    end
+  end
+
+  describe '#get' do
+    subject { @state.get(@key) }
+
+    supported_by :all do
+      describe 'with a set value' do
+        before do
+          @key = @model.properties[:coding]
+          expect(@key).to be_loaded(@resource)
+        end
+
+        it 'returns value' do
+          is_expected.to be(false)
+        end
+
+        it 'is idempotent' do
+          is_expected.to equal(subject)
+        end
+      end
+
+      describe 'with an unset value and no default value' do
+        before do
+          @key = @model.properties[:age]
+          expect(@key).not_to be_loaded(@resource)
+          expect(@key).not_to be_default
+        end
+
+        it 'returns nil' do
+          is_expected.to be_nil
+        end
+
+        it 'is idempotent' do
+          is_expected.to equal(subject)
+        end
+      end
+
+      describe 'with an unset value and a default value' do
+        before do
+          @key = @model.properties[:description]
+          expect(@key).not_to be_loaded(@resource)
+          expect(@key).to be_default
+        end
+
+        it 'Returns the name' do
+          is_expected.to eq 'Dan Kubb'
+        end
+
+        it 'Is idempotent' do
+          is_expected.to equal(subject)
+        end
+      end
+    end
+  end
+end