draftsman 0.1.0

data/spec/models/draft_spec.rb

@@ -0,0 +1,297 @@
+require 'spec_helper'
+
+describe Draftsman::Draft do
+  let(:trashable) { Trashable.new :name => 'Bob' }
+  subject { trashable.draft }
+
+  describe :event, :create?, :update?, :destroy?, :object, :changeset do
+    context 'with `create` draft' do
+      before { trashable.draft_creation }
+      its(:event) { should eql 'create' }
+      its(:create?) { should be_true }
+      its(:update?) { should be_false }
+      its(:destroy?) { should be_false }
+      its(:object) { should be_present }
+      its(:changeset) { should include :id }
+      its(:changeset) { should include :name }
+      its(:changeset) { should_not include :title }
+      its(:changeset) { should include :created_at }
+      its(:changeset) { should include :updated_at }
+      its(:previous_draft) { should be_nil }
+
+      context 'updated create' do
+        before do
+          trashable.name = 'Sam'
+          trashable.draft_update
+        end
+
+        it { should be_create }
+        it { should_not be_update }
+        it { should_not be_destroy }
+        its(:event) { should eql 'create' }
+        its(:object) { should be_present }
+        its(:changeset) { should include :id }
+        its(:changeset) { should include :name }
+        its(:changeset) { should_not include :title }
+        its(:changeset) { should include :created_at }
+        its(:changeset) { should include :updated_at }
+        its(:previous_draft) { should be_nil }
+      end
+    end
+
+    context 'with `update` draft' do
+      before do
+        trashable.save!
+        trashable.name = 'Sam'
+        trashable.title = 'My Title'
+        trashable.draft_update
+      end
+
+      it { should_not be_create }
+      it { should be_update }
+      it { should_not be_destroy }
+      its(:event) { should eql 'update' }
+      its(:object) { should be_present }
+      its(:changeset) { should_not include :id }
+      its(:changeset) { should include :name }
+      its(:changeset) { should include :title }
+      its(:changeset) { should_not include :created_at }
+      its(:changeset) { should_not include :updated_at }
+      its(:previous_draft) { should be_nil }
+
+      context 'updating the update' do
+        before do
+          trashable.title = nil
+          trashable.draft_update
+        end
+
+        it { should_not be_create }
+        it { should be_update }
+        it { should_not be_destroy }
+        its(:event) { should eql 'update' }
+        its(:object) { should be_present }
+        its(:changeset) { should_not include :id }
+        its(:changeset) { should include :name }
+        its(:changeset) { should_not include :title }
+        its(:changeset) { should_not include :created_at }
+        its(:changeset) { should_not include :updated_at }
+        its(:previous_draft) { should be_nil }
+      end
+    end
+
+    context 'with `destroy` draft' do
+      context 'without previous draft' do
+        before do
+          trashable.save!
+          trashable.draft_destroy
+        end
+
+        it { should_not be_create }
+        it { should_not be_update }
+        it { should be_destroy }
+        it { should_not be_destroyed }
+        its(:event) { should eql 'destroy' }
+        its(:object) { should be_present }
+        its(:changeset) { should eql Hash.new }
+        its(:previous_draft) { should be_nil }
+      end
+
+      context 'with previous `create` draft' do
+        before do
+          trashable.draft_creation
+          trashable.draft_destroy
+        end
+
+        it { should_not be_create }
+        it { should_not be_update }
+        it { should be_destroy }
+        it { should_not be_destroyed }
+        its(:event) { should eql 'destroy' }
+        its(:object) { should be_present }
+        its(:changeset) { should include :id }
+        its(:changeset) { should include :name }
+        its(:changeset) { should_not include :title }
+        its(:changeset) { should include :created_at }
+        its(:changeset) { should include :updated_at }
+        its(:previous_draft) { should be_present }
+      end
+    end
+  end
+
+  describe :publish! do
+    context 'with `create` draft' do
+      before { trashable.draft_creation }
+      subject { trashable.draft.publish!; return trashable.reload }
+      it { expect { subject }.to_not raise_exception }
+      it { should be_published }
+      it { should_not be_trashed }
+      it { should_not be_draft }
+      its(:published_at) { should be_present }
+      its(:draft_id) { should be_nil }
+      its(:draft) { should be_nil }
+      its(:trashed_at) { should be_nil }
+
+      it 'deletes the draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+      end
+    end
+
+    context 'with `update` draft' do
+      before do
+        trashable.save!
+        trashable.name = 'Sam'
+        trashable.draft_update
+      end
+
+      subject { trashable.draft.publish!; return trashable.reload }
+      it { expect { subject }.to_not raise_exception }
+      it { should be_published }
+      it { should_not be_draft }
+      it { should_not be_trashed }
+      its(:name) { should eql 'Sam' }
+      its(:published_at) { should be_present }
+      its(:draft_id) { should be_nil }
+      its(:draft) { should be_nil }
+      its(:trashed_at) { should be_nil }
+
+      it 'deletes the draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+      end
+
+      it 'does not delete the associated item' do
+        expect { subject }.to_not change(Trashable, :count)
+      end
+    end
+
+    context 'with `destroy` draft' do
+      context 'without previous draft' do
+        before do
+          trashable.save!
+          trashable.draft_destroy
+        end
+
+        subject { trashable.draft.publish! }
+
+        it 'destroys the draft' do
+          expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+        end
+
+        it 'deletes the associated item' do
+          expect { subject }.to change(Trashable, :count).by(-1)
+        end
+      end
+
+      context 'with previous `create` draft' do
+        before do
+          trashable.draft_creation
+          trashable.draft_destroy
+        end
+
+        subject { trashable.draft.publish! }
+
+        it 'destroys the draft' do
+          expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+        end
+
+        it 'deletes the associated item' do
+          expect { subject }.to change(Trashable, :count).by(-1)
+        end
+      end
+    end
+  end
+
+  describe :revert! do
+    context 'with `create` draft' do
+      before { trashable.draft_creation }
+      subject { trashable.draft.revert! }
+      it { expect { subject }.to_not raise_exception }
+
+      it 'deletes the draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+      end
+
+      it 'deletes associated item' do
+        expect { subject }.to change(Trashable, :count).by(-1)
+      end
+    end
+
+    context 'with `update` draft' do
+      before do
+        trashable.save!
+        trashable.name = 'Sam'
+        trashable.draft_update
+      end
+
+      subject { trashable.draft.revert!; return trashable.reload }
+      it { expect { subject }.to_not raise_exception }
+      it { should_not be_draft }
+      its(:name) { should eql 'Bob' }
+      its(:draft_id) { should be_nil }
+      its(:draft) { should be_nil }
+
+      it 'deletes the draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+      end
+
+      it 'does not delete the associated item' do
+        expect { subject }.to_not change(Trashable, :count)
+      end
+    end
+
+    context 'with `destroy` draft' do
+      context 'without previous draft' do
+        before do
+          trashable.save!
+          trashable.draft_destroy
+        end
+
+        subject { trashable.draft.revert!; return trashable.reload }
+        it { expect { subject }.to_not raise_exception }
+        it { should_not be_trashed }
+        it { should_not be_draft }
+        its(:draft_id) { should be_nil }
+        its(:draft) { should be_nil }
+        its(:trashed_at) { should be_nil }
+
+        it 'deletes the draft' do
+          expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+        end
+
+        it 'does not delete the associated item' do
+          expect { subject }.to_not change(Trashable, :count)
+        end
+      end
+
+      context 'with previous `create` draft' do
+        before do
+          trashable.draft_creation
+          trashable.draft_destroy
+        end
+
+        subject { trashable.draft.revert!; return trashable.reload }
+        it { expect { subject }.to_not raise_exception }
+        it { should_not be_trashed }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:trashed_at) { should be_nil }
+
+        it 'deletes the `destroy` draft' do
+          expect { subject }.to change(Draftsman::Draft.where(:event => 'destroy'), :count).by(-1)
+        end
+
+        it 'reifies the previous `create` draft' do
+          expect { subject }.to change(Draftsman::Draft.where(:event => 'create'), :count).by(1)
+        end
+
+        it 'does not delete the associated item' do
+          expect { subject }.to_not change(Trashable, :count)
+        end
+
+        its "draft's previous draft should be nil" do
+          subject.draft.previous_draft.should be_nil
+        end
+      end
+    end
+  end
+end

data/spec/models/parent_spec.rb

@@ -0,0 +1,191 @@
+require 'spec_helper'
+
+describe Parent do
+  let(:parent) { Parent.new(:name => 'Marge') }
+  let(:child)  { Child.new(:name => 'Lisa', :parent => parent) }
+
+  describe :publish! do
+    context 'parent `create` draft with child `create` draft' do
+      before do
+        parent.draft_creation
+        child.draft_creation
+      end
+
+      subject { parent.draft.publish! }
+
+      its 'parent should be published' do
+        subject
+        parent.reload.should be_published
+      end
+
+      its 'parent should not be a draft' do
+        subject
+        parent.reload.should_not be_draft
+      end
+
+      its 'child should be a draft' do
+        subject
+        child.reload.should be_draft
+      end
+
+      its 'child should not be published' do
+        subject
+        child.reload.should_not be_published
+      end
+
+      it 'destroys 1 draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(-1)
+      end
+
+      it "destroys the parent's draft" do
+        expect { subject }.to change(Draftsman::Draft.where(:item_type => 'Parent'), :count).by(-1)
+      end
+    end
+
+    context 'parent `destroy` draft with child `destroy` draft' do
+      before do
+        child.save!
+        child.draft_destroy
+        parent.draft_destroy
+      end
+
+      subject { parent.draft.publish! }
+
+      it 'destroys the parent' do
+        expect { subject }.to change(Parent, :count).by(-1)
+      end
+
+      it 'destroys the child' do
+        expect { subject }.to change(Child, :count).by(-1)
+      end
+
+      it 'destroys 2 drafts' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(-2)
+      end
+    end
+  end
+
+  describe :revert! do
+    context 'parent `create` draft with child `create` draft' do
+      before do
+        parent.draft_creation
+        child.draft_creation
+      end
+
+      subject { parent.draft.revert! }
+
+      it 'destroys the parent' do
+        expect { subject }.to change(Parent, :count).by(-1)
+      end
+
+      it 'destroys the child' do
+        expect { subject }.to change(Child, :count).by(-1)
+      end
+
+      it 'destroys both drafts' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(-2)
+      end
+    end
+
+    context 'parent `destroy` draft with child `destroy` draft' do
+      before do
+        child.save!
+        child.draft_destroy
+        parent.draft_destroy
+      end
+
+      subject do
+        parent.draft.revert!
+        child.reload
+        parent.reload
+      end
+
+      it { should be_persisted }
+      it { should_not be_draft }
+      it { should_not be_trashed }
+
+      it "keeps the child's draft" do
+        expect { subject }.to_not change(Draftsman::Draft.where(:item_type => 'Child'), :count)
+      end
+
+      it "deletes the parent's draft" do
+        expect { subject }.to change(Draftsman::Draft.where(:item_type => 'Parent'), :count).by(-1)
+      end
+
+      its 'child should remain a draft' do
+        subject
+        child.should be_draft
+      end
+
+      its 'child should still be a `destroy` draft' do
+        subject
+        child.draft.reload.should be_destroy
+      end
+
+      its 'child should still be trashed' do
+        subject
+        child.should be_trashed
+      end
+    end
+  end
+
+  describe :draft_publication_dependencies do
+    context 'parent `create` draft with child `create` draft' do
+      before do
+        parent.draft_creation
+        child.draft_creation
+      end
+
+      subject { parent.draft }
+      its(:draft_publication_dependencies) { should be_empty }
+    end
+
+    context 'parent `update` draft with child `create` draft' do
+      before do
+        parent.save!
+        parent.name = 'Selma'
+        parent.draft_update
+        child.draft_creation
+      end
+
+      subject { parent.draft }
+      its(:draft_publication_dependencies) { should be_empty }
+    end
+
+    context 'parent `destroy` draft with child `destroy` draft' do
+      before do
+        child.save!
+        parent.draft_destroy
+        child.reload
+      end
+
+      subject { parent.draft }
+      its(:draft_publication_dependencies) { should be_present }
+      its(:draft_publication_dependencies) { should include child.draft }
+    end
+  end
+
+  describe :draft_reversion_dependencies do
+    context 'parent `create` draft with child `create` draft' do
+      before do
+        parent.draft_creation
+        child.draft_creation
+      end
+
+      subject { parent.draft }
+      its(:draft_reversion_dependencies) { should be_present }
+      its(:draft_reversion_dependencies) { should include child.draft }
+    end
+
+    context 'parent `destroy` draft with child `destroy` draft' do
+      before do
+        child.save!
+        parent.draft_destroy
+        child.reload
+      end
+
+      subject { parent.draft }
+      its(:draft_reversion_dependencies) { should be_empty }
+    end
+  end
+end

data/spec/models/trashable_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+
+# A Trashable has a simple call to `has_drafts` without any options specified. The model also contains a `deleted_at`
+# attribute, which allows deletes to be drafts too.
+describe Trashable do
+  let(:trashable) { Trashable.new :name => 'Bob' }
+  it { should be_draftable }
+
+  # Not affected by this customization
+  describe :draft_creation do
+  end
+
+  # Not affected by this customization
+  describe :draft_update do
+  end
+
+  describe :draft_destroy do
+    context 'with `:create` draft' do
+      before { trashable.draft_creation }
+      subject { trashable.draft_destroy; return trashable }
+      it { should be_persisted }
+      it { should_not be_published }
+      it { should be_draft }
+      it { should be_trashed}
+      its(:published_at) { should be_nil }
+      its(:trashed_at) { should be_present }
+      its(:draft_id) { should be_present }
+      its(:draft) { should be_present }
+      its(:draft) { should be_destroy }
+      its(:name) { should eql 'Bob' }
+
+      it 'keeps the item' do
+        expect { subject }.to_not change(Trashable, :count)
+      end
+
+      it 'keeps the associated draft' do
+        expect { subject }.to_not change(Draftsman::Draft.where(:id => trashable.draft_id), :count)
+      end
+
+      its "draft's name should be 'Bob'" do
+        subject.draft.reify.name.should eql 'Bob'
+      end
+    end
+
+    context 'with `:update` draft' do
+      before do
+        trashable.save!
+        trashable.published_at = Time.now
+        trashable.save!
+        trashable.name = 'Sam'
+        trashable.draft_update
+      end
+
+      subject { trashable.draft_destroy; return trashable.reload }
+      it { should be_persisted }
+      it { should be_published }
+      it { should be_draft }
+      it { should be_trashed}
+      its(:published_at) { should be_present }
+      its(:trashed_at) { should be_present }
+      its(:draft_id) { should be_present }
+      its(:draft) { should be_present }
+      its(:draft) { should be_destroy }
+      its(:name) { should eql 'Bob' }
+
+      it 'keeps the item' do
+        expect { subject }.to_not change(Trashable, :count)
+      end
+
+      it 'keeps the associated draft' do
+        expect { subject }.to_not change(Draftsman::Draft.where(:id => trashable.draft_id), :count)
+      end
+
+      its "draft's name should be 'Sam'" do
+        subject.draft.reify.name.should eql 'Sam'
+      end
+    end
+
+    context 'without draft' do
+      before do
+        trashable.save!
+        trashable.update_attributes! :published_at => Time.now
+      end
+
+      subject { trashable.draft_destroy; return trashable.reload }
+      it { should be_persisted }
+      it { should be_published }
+      it { should be_draft }
+      it { should be_trashed }
+      its(:published_at) { should be_present }
+      its(:trashed_at) { should be_present }
+      its(:draft_id) { should be_present }
+      its(:draft) { should be_present }
+      its(:draft) { should be_destroy }
+      its(:name) { should eql 'Bob' }
+
+      it 'keeps the item' do
+        expect { subject }.to_not change(Trashable, :count)
+      end
+
+      it 'creates a draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(1)
+      end
+    end
+  end
+
+  describe 'scopes' do
+    let!(:drafted_trashable)   { trashable.draft_creation; return trashable }
+    let!(:published_trashable) { Trashable.create :name => 'Jane', :published_at => Time.now }
+    let!(:trashed_trashable)   { Trashable.create :name => 'Ralph' }
+
+    # Not affected by this customization
+    describe :drafted do
+    end
+
+    describe :live do
+      before { trashed_trashable.draft_destroy }
+      subject { Trashable.live }
+      its(:count) { should eql 2 }
+
+      it 'does not raise an exception' do
+        expect { subject }.to_not raise_exception
+      end
+
+      it 'includes the drafted item' do
+        subject.should include drafted_trashable
+      end
+
+      it 'includes the published item' do
+        subject.should include published_trashable
+      end
+
+      it 'does not include the trashed item' do
+        subject.should_not include trashed_trashable
+      end
+    end
+
+    # Not affected by this customization
+    describe :published do
+    end
+
+    describe :trashed do
+      before { trashed_trashable.draft_destroy }
+      subject { Trashable.trashed }
+      its(:count) { should eql 1 }
+
+      it 'does not raise an exception' do
+        expect { subject.load }.to_not raise_exception
+      end
+
+      it 'does not include the drafted item' do
+        subject.should_not include drafted_trashable
+      end
+
+      it 'does not include the published item' do
+        subject.should_not include published_trashable
+      end
+
+      it 'includes the trashed item' do
+        subject.should include trashed_trashable
+      end
+    end
+  end
+end