draftsman 0.1.0

data/spec/models/vanilla_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+
+# A Vanilla has a simple call to `has_drafts` without any options specified.
+describe Vanilla do
+  let(:vanilla) { Vanilla.new :name => 'Bob' }
+  it { should be_draftable }
+
+  describe :draft_creation do
+    subject do
+      vanilla.draft_creation
+      vanilla.reload
+    end
+
+    it { should be_persisted }
+    it { should be_draft }
+    its(:draft_id) { should be_present }
+    its(:draft) { should be_present }
+    its(:draft) { should be_create }
+    its(:name) { should eql 'Bob' }
+  end
+
+  describe :draft_update do
+    subject do
+      vanilla.draft_update
+      vanilla.reload
+    end
+
+    context 'without existing draft' do
+      before do
+        vanilla.save!
+        vanilla.name = 'Sam'
+      end
+
+      it { should be_persisted }
+      it { should be_draft }
+      its(:draft_id) { should be_present }
+      its(:draft) { should be_present }
+      its(:draft) { should be_update }
+      its(:name) { should eql 'Bob' }
+
+      it 'creates a new draft' do
+        expect { subject }.to change(Draftsman::Draft, :count).by(1)
+      end
+    end
+
+    describe 'changing back to initial state' do
+      before do
+        vanilla.published_at = Time.now
+        vanilla.save!
+        vanilla.name = 'Sam'
+        vanilla.draft_update
+        vanilla.reload
+        vanilla.name = 'Bob'
+      end
+
+      it { should_not be_draft }
+      its(:name) { should eql 'Bob' }
+      its(:draft_id) { should be_nil }
+      its(:draft) { should be_nil }
+
+      it 'destroys the draft' do
+        expect { subject }.to change(Draftsman::Draft.where(:id => vanilla.draft_id), :count).by(-1)
+      end
+    end
+
+    context 'with existing `create` draft' do
+      before { vanilla.draft_creation }
+
+      context 'with changes' do
+        before { vanilla.name = 'Sam' }
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:name) { should eql 'Sam' }
+
+        it 'updates the existing draft' do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => vanilla.draft_id), :count)
+        end
+
+        its "draft's `name` is updated" do
+          subject.draft.reify.name.should eql 'Sam'
+        end
+
+        it 'has a `create` draft' do
+          subject.draft.should be_create
+        end
+      end
+
+      context 'with no changes' do
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:draft) { should be_create }
+        its(:name) { should eql 'Bob' }
+
+        it "doesn't change the number of drafts" do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => vanilla.draft_id), :count)
+        end
+      end
+    end
+
+    context 'with existing `update` draft' do
+      before do
+        vanilla.save!
+        vanilla.name = 'Sam'
+        vanilla.draft_update
+      end
+
+      context 'with changes' do
+        before { vanilla.name = 'Steve' }
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:name) { should eql 'Bob' }
+
+        it 'updates the existing draft' do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => vanilla.draft_id), :count)
+        end
+
+        its "draft's `name` is updated" do
+          subject.draft.reify.name.should eql 'Steve'
+        end
+
+        it 'has a `create` draft' do
+          subject.draft.update?.should be_true
+        end
+      end
+
+      context 'with no changes' do
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:draft) { should be_update }
+        its(:name) { should eql 'Bob' }
+
+        it "doesn't change the number of drafts" do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => vanilla.draft_id), :count)
+        end
+
+        its "draft's `name` is not updated" do
+          subject.draft.reify.name.should eql 'Sam'
+        end
+      end
+    end
+  end
+
+  # Not applicable to this customization
+  describe :draft_destroy do
+  end
+
+  describe 'scopes' do
+    let!(:drafted_vanilla)   { vanilla.draft_creation; return vanilla }
+    let!(:published_vanilla) { Vanilla.create :name => 'Jane', :published_at => Time.now }
+
+    describe :drafted do
+      subject { Vanilla.drafted }
+      its(:count) { should eql 1 }
+
+      it 'includes the unpublished item' do
+        subject.should include drafted_vanilla
+      end
+
+      it 'does not include the published item' do
+        subject.should_not include published_vanilla
+      end
+    end
+
+    describe :live do
+      subject { Vanilla.live }
+
+      it 'raises an exception' do
+        expect { subject.load }.to raise_exception
+      end
+    end
+
+    describe :published do
+      subject { Vanilla.published }
+      its(:count) { should eql 1 }
+
+      it 'does not include the unpublished item' do
+        subject.should_not include drafted_vanilla
+      end
+
+      it 'includes the published item' do
+        subject.should include published_vanilla
+      end
+    end
+
+    describe :trashed do
+      subject { Vanilla.trashed }
+
+      it 'raises an exception' do
+        expect { subject.load }.to raise_exception
+      end
+    end
+  end
+end

data/spec/models/whitelister_spec.rb

@@ -0,0 +1,262 @@
+require 'spec_helper'
+
+describe Whitelister do
+  let(:whitelister) { Whitelister.new :name => 'Bob' }
+  it { should be_draftable }
+
+  # Not affected by this customization
+  describe :draft_creation do
+  end
+
+  describe :draft_update do
+    subject do
+      whitelister.draft_update
+      whitelister.reload
+    end
+
+    context 'with whitelisted change' do
+      context 'without draft' do
+        before do
+          whitelister.save!
+          whitelister.attributes = { :name => 'Sam', :ignored => 'Meh.' }
+        end
+
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:draft) { should be_update }
+        its(:name) { should eql 'Bob' }
+        its(:ignored) { should eql 'Meh.' }
+
+        it 'creates a new draft' do
+          expect { subject }.to change(Draftsman::Draft, :count).by(1)
+        end
+
+        it 'has an `update` draft' do
+          subject.draft.update?.should be_true
+        end
+
+        its "draft's name should be `Sam`" do
+          subject.draft.reify.name.should eql 'Sam'
+        end
+
+        context 'changing back to initial state' do
+          before do
+            whitelister.draft_update
+            whitelister.attributes = { :name => 'Bob', :ignored => 'Huzzah!' }
+          end
+          
+          it { should_not be_draft }
+          its(:name) { should eql 'Bob' }
+          its(:ignored) { should eql 'Huzzah!' }
+          its(:draft_id) { should be_nil }
+          its(:draft) { should be_nil }
+
+          it 'destroys the draft' do
+            expect { subject }.to change(Draftsman::Draft.where(:id => whitelister.draft_id), :count).by(-1)
+          end
+        end
+      end
+
+      context 'with existing `create` draft' do
+        before { whitelister.draft_creation }
+
+        context 'with changes' do
+          before { whitelister.attributes = { :name => 'Sam', :ignored => 'Meh.' } }
+          it { should be_persisted }
+          it { should be_draft }
+          its(:draft_id) { should be_present }
+          its(:draft) { should be_present }
+          its(:draft) { should be_create }
+          its(:name) { should eql 'Sam' }
+
+          it 'updates the existing draft' do
+            expect { subject }.to_not change(Draftsman::Draft.where(:id => whitelister.draft_id), :count)
+          end
+
+          its "draft's `name` is updated" do
+            subject.draft.reify.name.should eql 'Sam'
+          end
+
+          its "draft's `ignored` is updated" do
+            subject.draft.reify.ignored.should eql 'Meh.'
+          end
+        end
+
+        context 'with no changes' do
+          it { should be_persisted }
+          it { should be_draft }
+          its(:draft_id) { should be_present }
+          its(:draft) { should be_present }
+          its(:draft) { should be_create }
+          its(:name) { should eql 'Bob' }
+
+          it "doesn't change the number of drafts" do
+            expect { subject }.to_not change(Draftsman::Draft.where(:id => whitelister.draft_id), :count)
+          end
+        end
+      end
+
+      context 'with existing `update` draft' do
+        before do
+          whitelister.save!
+          whitelister.attributes = { :name => 'Sam', :ignored => 'Meh.' }
+        end
+        
+        context 'with changes' do
+          before { whitelister.attributes = { :name => 'Steve', :ignored => 'Huzzah!' } }
+          it { should be_persisted }
+          it { should be_draft }
+          its(:draft_id) { should be_present }
+          its(:draft) { should be_present }
+          its(:draft) { should be_update }
+          its(:name) { should eql 'Bob' }
+          its(:ignored) { should eql 'Huzzah!' }
+
+          it 'updates the existing draft' do
+            expect { subject }.to_not change(Draftsman::Draft.where(:id => whitelister.draft_id), :count)
+          end
+
+          its "draft's `name` is updated" do
+            subject.draft.reify.name.should eql 'Steve'
+          end
+
+          its "draft's `ignored` is 'Huzzah!'" do
+            subject.draft.reify.ignored.should eql 'Huzzah!'
+          end
+        end
+
+        context 'with no changes' do
+          it { should be_persisted }
+          it { should be_draft }
+          its(:draft_id) { should be_present }
+          its(:draft) { should be_present }
+          its(:name) { should eql 'Bob' }
+
+          it "doesn't change the number of drafts" do
+            expect { subject }.to_not change(Draftsman::Draft.where(:id => whitelister.draft_id), :count)
+          end
+
+          its "draft's `name` is not updated" do
+            subject.draft.reify.name.should eql 'Sam'
+          end
+
+          it 'still has an `update` draft' do
+            subject.draft.update?.should be_true
+          end
+        end
+      end
+    end
+
+    context 'without whitelisted change' do
+      context 'without existing draft' do
+        before do
+          whitelister.save!
+          whitelister.ignored = 'Huzzah!'
+        end
+
+        it { should be_persisted }
+        it { should_not be_draft }
+        its(:draft_id) { should be_nil }
+        its(:draft) { should be_nil }
+        its(:name) { should eql 'Bob' }
+        its(:ignored) { should eql 'Huzzah!' }
+
+        it 'does not create a draft' do
+          expect { subject }.to_not change(Draftsman::Draft, :count)
+        end
+
+        # Not affected by this customization
+        context 'changing back to initial state' do
+        end
+      end
+
+      context 'with existing `create` draft' do
+        before do
+          whitelister.draft_creation
+          whitelister.ignored = 'Huzzah!'
+        end
+
+        it { should be_persisted }
+        it { should be_draft }
+        its(:draft_id) { should be_present }
+        its(:draft) { should be_present }
+        its(:name) { should eql 'Bob' }
+        its(:ignored) { should eql 'Huzzah!' }
+
+        it 'updates the existing draft' do
+          expect { subject }.to_not change(Draftsman::Draft.where(:id => whitelister.draft_id), :count)
+        end
+
+        its "draft's `ignored` is updated" do
+          subject.draft.reify.ignored.should eql 'Huzzah!'
+        end
+
+        it 'has a `create` draft' do
+          subject.draft.should be_create
+        end
+      end
+
+      context 'with existing `update` draft' do
+        before do
+          whitelister.save!
+          whitelister.attributes = { :name => 'Sam', :ignored => 'Meh.' }
+        end
+
+        context 'with changes' do
+          before { whitelister.ignored = 'Huzzah!' }
+          it { should be_persisted }
+          it { should be_draft }
+          its(:draft_id) { should be_present }
+          its(:draft) { should be_present }
+          its(:draft) { should be_update }
+          its(:name) { should eql 'Bob' }
+          its(:ignored) { should eql 'Huzzah!' }
+
+          it 'updates the existing draft' do
+            expect { subject }.to_not change(Draftsman::Draft.where(:id => whitelister.draft_id), :count)
+          end
+
+          its "draft's `name` is not changed" do
+            subject.draft.reify.name.should eql 'Sam'
+          end
+
+          its "draft's `ignored` is updated" do
+            subject.draft.reify.ignored.should eql 'Huzzah!'
+          end
+        end
+
+        context 'with no changes' do
+          it { should be_persisted }
+          it { should be_draft }
+          its(:draft_id) { should be_present }
+          its(:draft) { should be_present }
+          its(:draft) { should be_update }
+          its(:name) { should eql 'Bob' }
+          its(:ignored) { should eql 'Meh.' }
+
+          it "doesn't change the number of drafts" do
+            expect { subject }.to_not change(Draftsman::Draft.where(:id => whitelister.draft_id), :count)
+          end
+
+          its "draft's `name` is not updated" do
+            subject.draft.reify.name.should eql 'Sam'
+          end
+
+          its "draft's `ignored` is not updated" do
+            subject.draft.reify.ignored.should eql 'Meh.'
+          end
+        end
+      end
+    end
+  end
+
+  # Not affected by this customization
+  describe :draft_destroy do
+  end
+
+  # Not affected by this customization
+  describe 'scopes' do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'shoulda/matchers/integrations/rspec'
+require 'capybara/rspec'
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+
+  config.mock_with :rspec
+end
+
+#require 'rails/railtie'
+#require 'active_record'
+#
+#require 'draftsman'