acts-as-approvable 0.6.7 → 0.6.8.1

data/spec/acts_as_approvable/model/class_methods_spec.rb

@@ -0,0 +1,219 @@
+require 'spec_helper'
+
+describe ActsAsApprovable::Model::ClassMethods do
+  subject { DefaultApprovable }
+
+  describe '.acts_as_approvable' do
+    subject { CleanApprovable }
+
+    it 'includes InstanceMethods into the class' do
+      subject.should_not extend(ActsAsApprovable::Model::InstanceMethods)
+      subject.acts_as_approvable
+      subject.should extend(ActsAsApprovable::Model::InstanceMethods)
+    end
+
+    it 'includes ClassMethods into the class' do
+      subject.should_not extend(ActsAsApprovable::Model::ClassMethods)
+      subject.acts_as_approvable
+      subject.should extend(ActsAsApprovable::Model::ClassMethods)
+    end
+  end
+
+  describe '.approvals_enabled?' do
+    before(:each) do
+      subject.stub(:global_approvals_on? => true)
+      subject.stub(:approvals_on? => true)
+    end
+
+    context 'when approvals are globally disabled' do
+      before(:each) do
+        subject.stub(:global_approvals_on? => false)
+      end
+
+      it 'returns false' do
+        subject.approvals_enabled?.should be_false
+      end
+
+      it 'checks the global status' do
+        subject.should_receive(:global_approvals_on?).and_return(false)
+        subject.approvals_enabled?
+      end
+
+      it 'does not check the model status' do
+        subject.should_not_receive(:approvals_on?)
+        subject.approvals_enabled?
+      end
+    end
+
+    context 'when approvals are disabled for the Model' do
+      before(:each) do
+        subject.stub(:approvals_on? => false)
+      end
+
+      it 'returns false' do
+        subject.approvals_enabled?.should be_false
+      end
+
+      it 'checks the global status' do
+        subject.should_receive(:global_approvals_on?).and_return(true)
+        subject.approvals_enabled?
+      end
+
+      it 'checks the model status' do
+        subject.should_receive(:approvals_on?).and_return(false)
+        subject.approvals_enabled?
+      end
+    end
+  end
+
+  describe '.approvals_disabled?' do
+    before(:each) do
+      subject.stub(:approvals_enabled? => true)
+    end
+
+    it 'returns the inverse of the approval queue status' do
+      subject.approvals_disabled?.should == !subject.approvals_enabled?
+    end
+
+    it 'calls .approvals_enabled? for the status' do
+      subject.should_receive(:approvals_enabled?).and_return(true)
+      subject.approvals_disabled?
+    end
+  end
+
+  describe '.approvals_off' do
+    before(:each) do
+      subject.approvals_off
+    end
+
+    it 'disables the model level approval queue' do
+      subject.approvals_on?.should be_false
+    end
+  end
+
+  describe '.approvals_on' do
+    before(:each) do
+      subject.approvals_on
+    end
+
+    it 'enables the model level approval queue' do
+      subject.approvals_on?.should be_true
+    end
+  end
+
+  describe '.approvals_on?' do
+    context 'when approval queues are enabled locally' do
+      before(:each) do
+        subject.approvals_disabled = false
+      end
+
+      it 'returns true' do
+        subject.approvals_on?.should be_true
+      end
+
+      it 'ignores the global level status' do
+        subject.stub(:global_approvals_on? => false)
+        subject.approvals_on?.should be_true
+      end
+    end
+
+    context 'when approval queues are disabled locally' do
+      before(:each) do
+        subject.approvals_disabled = true
+      end
+
+      it 'returns false' do
+        subject.approvals_on?.should be_false
+      end
+
+      it 'ignores the global level status' do
+        subject.stub(:global_approvals_on? => true)
+        subject.approvals_on?.should be_false
+      end
+    end
+  end
+
+  describe '.global_approvals_on?' do
+    it 'checks the global approval status' do
+      ActsAsApprovable.should_receive(:enabled?)
+      subject.global_approvals_on?
+    end
+  end
+
+  describe '.approvable_on?' do
+    it { should be_approvable_on(:create) }
+    it { should be_approvable_on(:update) }
+
+    context 'when the model is approvable on :create events' do
+      subject { CreatesApprovable }
+
+      it { should be_approvable_on(:create) }
+      it { should_not be_approvable_on(:update) }
+    end
+
+    context 'when the model is approvable on :update events' do
+      subject { UpdatesApprovable }
+
+      it { should be_approvable_on(:update) }
+      it { should_not be_approvable_on(:create) }
+    end
+  end
+
+  describe '.approvable_fields' do
+    subject { CleanApprovable }
+
+    context 'with :only fields configured' do
+      before(:each) do
+        subject.acts_as_approvable :only => [:body, :extra]
+      end
+
+      it 'returns the configured fields' do
+        subject.approvable_fields.should == ['body', 'extra']
+      end
+    end
+
+    context 'with :ignore fields configured' do
+      before(:each) do
+        subject.acts_as_approvable :ignore => [:title, :extra]
+      end
+
+      it 'returns the available fields minus whats ignored' do
+        subject.approvable_fields.should include('body')
+      end
+
+      it 'ignores timestamps' do
+        subject.approvable_fields.should_not include('created_at')
+        subject.approvable_fields.should_not include('updated_at')
+      end
+
+      it 'ignores primary keys' do
+        subject.approvable_fields.should_not include(subject.primary_key)
+      end
+    end
+  end
+
+  describe '.without_approval' do
+    around(:each) do |example|
+      subject.approvals_on
+      example.run
+      subject.approvals_on
+    end
+
+    it 'disables approval queues' do
+      @record = subject.without_approval { |m| m.create(:title => 'title', :body => 'the body') }
+      @record.approval.should_not be
+    end
+
+    it 'enables the approval queue after running' do
+      subject.should be_approvals_on
+      subject.without_approval { |m| m.create(:title => 'title', :body => 'the body') }
+      subject.should be_approvals_on
+    end
+
+    it 'returns the approval queue to the previous state' do
+      subject.approvals_off
+      subject.without_approval { |m| m.create(:title => 'title', :body => 'the body') }
+      subject.should_not be_approvals_on
+    end
+  end
+end

data/spec/acts_as_approvable/model/create_instance_methods_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+describe ActsAsApprovable::Model::CreateInstanceMethods do
+  subject { CreatesApprovable.create }
+
+  describe '#approval' do
+    subject { CreatesApprovable.create } # Reverse the mocking for #approval
+
+    it 'returns a :create approval' do
+      subject.approval.event == :create
+    end
+
+    it 'returns the first :create approval' do
+      duplicate = Approval.create(:item_id => subject.id, :item_type => 'CreatesApprovable', :event => 'create')
+      subject.approval != duplicate
+    end
+  end
+
+  context do
+    before(:each) do
+      @approval = subject.approvals.first
+      subject.stub(:approval => @approval)
+    end
+
+    describe '#approval_state' do
+      it 'gets the state from the approval record' do
+        @approval.should_receive(:state)
+        subject.approval_state
+      end
+
+      context 'when a :state_field is configured' do
+        subject { CreatesWithStateApprovable.create }
+
+        it 'gets the state from the configured field' do
+          subject.should_receive(:state)
+          subject.approval_state
+        end
+
+        it 'does not get the state from the approval record' do
+          subject.should_not_receive(:approval)
+          subject.approval_state
+        end
+      end
+    end
+
+    describe '#set_approval_state' do
+      it 'does nothing if no :state_field is configured' do
+        subject.should_not_receive(:state=)
+        subject.set_approval_state('pending')
+      end
+
+      context 'when a :state_field is configured' do
+        subject { CreatesWithStateApprovable.create }
+
+        it 'sets the configured field' do
+          subject.should_receive(:state=)
+          subject.set_approval_state('pending')
+        end
+      end
+    end
+
+    describe '#pending?' do
+      it 'gets the status from the approval record' do
+        subject.should_receive(:approval)
+        subject.pending?
+      end
+
+      context 'when a :state_field is configured' do
+        subject { CreatesWithStateApprovable.create }
+
+        it 'gets the state from the configured field' do
+          subject.should_receive(:state)
+          subject.pending?
+        end
+
+        it 'does not get the state from the approval record' do
+          subject.should_not_receive(:approval)
+          subject.pending?
+        end
+      end
+    end
+
+    describe '#approved?' do
+      it 'gets the status from the approval record' do
+        subject.should_receive(:approval)
+        subject.approved?
+      end
+
+      context 'when a :state_field is configured' do
+        subject { CreatesWithStateApprovable.create }
+
+        it 'gets the state from the configured field' do
+          subject.should_receive(:state)
+          subject.approved?
+        end
+
+        it 'does not get the state from the approval record' do
+          subject.should_not_receive(:approval)
+          subject.approved?
+        end
+      end
+    end
+
+    describe '#rejected?' do
+      it 'gets the status from the approval record' do
+        subject.should_receive(:approval)
+        subject.rejected?
+      end
+
+      context 'when a :state_field is configured' do
+        subject { CreatesWithStateApprovable.create }
+
+        it 'gets the state from the configured field' do
+          subject.should_receive(:state)
+          subject.rejected?
+        end
+
+        it 'does not get the state from the approval record' do
+          subject.should_not_receive(:approval)
+          subject.rejected?
+        end
+      end
+    end
+
+    describe '#approve!' do
+      it 'approves the record' do
+        subject.approve!
+        subject.should be_approved
+      end
+
+      it 'proxies to the approval record for approval' do
+        subject.should_receive(:approval)
+        subject.approve!
+      end
+    end
+
+    describe '#reject!' do
+      it 'rejects the record' do
+        subject.reject!
+        subject.should be_rejected
+      end
+
+      it 'proxies to the approval record for approval' do
+        subject.should_receive(:approval)
+        subject.reject!
+      end
+    end
+  end
+end

data/spec/acts_as_approvable/model/instance_methods_spec.rb

@@ -0,0 +1,328 @@
+require 'spec_helper'
+
+describe ActsAsApprovable::Model::InstanceMethods do
+  subject { DefaultApprovable.new }
+
+  describe '#approvals_enabled?' do
+    before(:each) do
+      subject.stub(:global_approvals_on? => true)
+      subject.stub(:model_approvals_on? => true)
+      subject.stub(:approvals_on? => true)
+    end
+
+    context 'when approvals are globally disabled' do
+      before(:each) do
+        subject.stub(:global_approvals_on? => false)
+      end
+
+      it 'returns false' do
+        subject.approvals_enabled?.should be_false
+      end
+
+      it 'checks the global status' do
+        subject.should_receive(:global_approvals_on?).and_return(false)
+        subject.approvals_enabled?
+      end
+
+      it 'does not check the model status' do
+        subject.should_not_receive(:model_approvals_on?)
+        subject.approvals_enabled?
+      end
+
+      it 'does not check the record status' do
+        subject.should_not_receive(:approvals_on?)
+        subject.approvals_enabled?
+      end
+    end
+
+    context 'when approvals are disabled for the Model' do
+      before(:each) do
+        subject.stub(:model_approvals_on? => false)
+      end
+
+      it 'returns false' do
+        subject.approvals_enabled?.should be_false
+      end
+
+      it 'checks the global status' do
+        subject.should_receive(:global_approvals_on?).and_return(true)
+        subject.approvals_enabled?
+      end
+
+      it 'checks the model status' do
+        subject.should_receive(:model_approvals_on?).and_return(false)
+        subject.approvals_enabled?
+      end
+
+      it 'does not check the record status' do
+        subject.should_not_receive(:approvals_on?)
+        subject.approvals_enabled?
+      end
+    end
+
+    context 'when approvals are disabled for the Record' do
+      before(:each) do
+        subject.stub(:approvals_on? => false)
+      end
+
+      it 'returns false' do
+        subject.approvals_enabled?.should be_false
+      end
+
+      it 'checks the global status' do
+        subject.should_receive(:global_approvals_on?).and_return(true)
+        subject.approvals_enabled?
+      end
+
+      it 'checks the model status' do
+        subject.should_receive(:model_approvals_on?).and_return(true)
+        subject.approvals_enabled?
+      end
+
+      it 'checks the record status' do
+        subject.should_receive(:approvals_on?).and_return(false)
+        subject.approvals_enabled?
+      end
+    end
+  end
+
+  describe '#approvals_disabled?' do
+    before(:each) do
+      subject.stub(:approvals_enabled? => true)
+    end
+
+    it 'returns the inverse of the approval queue status' do
+      subject.approvals_disabled?.should == !subject.approvals_enabled?
+    end
+
+    it 'calls #approvals_enabled? for the status' do
+      subject.should_receive(:approvals_enabled?).and_return(true)
+      subject.approvals_disabled?
+    end
+  end
+
+  describe '#approvals_off' do
+    before(:each) do
+      subject.approvals_off
+    end
+
+    it 'disables the record level approval queue' do
+      subject.approvals_on?.should be_false
+    end
+  end
+
+  describe '#approvals_on' do
+    before(:each) do
+      subject.approvals_on
+    end
+
+    it 'enables the record level approval queue' do
+      subject.approvals_on?.should be_true
+    end
+  end
+
+  describe '#approvals_on?' do
+    context 'when approval queues are enabled locally' do
+      before(:each) do
+        subject.instance_variable_set('@approvals_disabled', false)
+      end
+
+      it 'returns true' do
+        subject.approvals_on?.should be_true
+      end
+
+      it 'ignores the model level status' do
+        subject.stub(:model_approvals_on? => false)
+        subject.approvals_on?.should be_true
+      end
+
+      it 'ignores the global level status' do
+        subject.stub(:global_approvals_on? => false)
+        subject.approvals_on?.should be_true
+      end
+    end
+
+    context 'when approval queues are disabled locally' do
+      before(:each) do
+        subject.instance_variable_set('@approvals_disabled', true)
+      end
+
+      it 'returns false' do
+        subject.approvals_on?.should be_false
+      end
+
+      it 'ignores the model level status' do
+        subject.stub(:model_approvals_on? => true)
+        subject.approvals_on?.should be_false
+      end
+
+      it 'ignores the global level status' do
+        subject.stub(:global_approvals_on? => true)
+        subject.approvals_on?.should be_false
+      end
+    end
+  end
+
+  describe '#approvable_on?' do
+    it { should be_approvable_on(:create) }
+    it { should be_approvable_on(:update) }
+
+    context 'when the model is approvable on :create events' do
+      subject { CreatesApprovable.new }
+
+      it { should be_approvable_on(:create) }
+      it { should_not be_approvable_on(:update) }
+    end
+
+    context 'when the model is approvable on :update events' do
+      subject { UpdatesApprovable.new }
+
+      it { should be_approvable_on(:update) }
+      it { should_not be_approvable_on(:create) }
+    end
+  end
+
+  context 'with approval and rejection hooks' do
+    before(:each) do
+      @record = CreatesApprovable.create
+
+      @approval = @record.approval
+      @approval.stub(:item => @record)
+    end
+
+    describe '#before_approve' do
+      before(:each) do
+        @record.stub(:before_approve => true)
+      end
+
+      it 'is called when approving a record' do
+        @record.should_receive(:before_approve).and_return(true)
+        @approval.approve!
+      end
+
+      it 'is not called when rejecting a record' do
+        @record.should_not_receive(:before_approve)
+        @approval.reject!
+      end
+
+      it 'receives the approval as an argument' do
+        @record.should_receive(:before_approve).with(@approval).and_return(true)
+        @approval.approve!
+      end
+
+      context 'when it returns false' do
+        before(:each) do
+          @record.stub(:before_approve => false)
+        end
+
+        it 'prevents the approval from proceeding' do
+          @approval.approve!
+          @approval.state.should == 'pending'
+        end
+      end
+    end
+
+    describe '#before_reject' do
+      before(:each) do
+        @record.stub(:before_reject => true)
+      end
+
+      it 'is called when rejecting a record' do
+        @record.should_receive(:before_reject).and_return(true)
+        @approval.reject!
+      end
+
+      it 'is not called when approving a record' do
+        @record.should_not_receive(:before_reject)
+        @approval.approve!
+      end
+
+      it 'receives the approval as an argument' do
+        @record.should_receive(:before_reject).with(@approval).and_return(true)
+        @approval.reject!
+      end
+
+      context 'when it returns false' do
+        before(:each) do
+          @record.stub(:before_reject => false)
+        end
+
+        it 'prevents the rejection from proceeding' do
+          @approval.reject!
+          @approval.state.should == 'pending'
+        end
+      end
+    end
+
+    describe '#after_approve' do
+      it 'is called when approving a record' do
+        @record.should_receive(:before_approve)
+        @approval.approve!
+      end
+
+      it 'is not called when rejecting a record' do
+        @record.should_not_receive(:after_approve)
+        @approval.reject!
+      end
+
+      it 'receives the approval as an argument' do
+        @record.should_receive(:after_approve).with(@approval).and_return(true)
+        @approval.approve!
+      end
+    end
+
+    describe '#after_reject' do
+      it 'is called when rejecting a record' do
+        @record.should_receive(:after_reject).and_return(true)
+        @approval.reject!
+      end
+
+      it 'is not called when approving a record' do
+        @record.should_not_receive(:after_reject)
+        @approval.approve!
+      end
+
+      it 'receives the approval as an argument' do
+        @record.should_receive(:after_reject).with(@approval).and_return(true)
+        @approval.reject!
+      end
+    end
+  end
+
+  describe '#without_approval' do
+    around(:each) do
+      subject.approvals_on
+    end
+
+    it 'disables approval queues' do
+      subject.without_approval { |r| r.update_attributes(:title => 'no review') }
+      subject.update_approvals.should be_empty
+    end
+
+    it 'enables the approval queue after running' do
+      subject.should be_approvals_on
+      subject.without_approval { |r| r.update_attributes(:title => 'no review') }
+      subject.should be_approvals_on
+    end
+
+    it 'returns the approval queue to the previous state' do
+      subject.approvals_off
+      subject.without_approval { |r| r.update_attributes(:title => 'no review') }
+      subject.should_not be_approvals_on
+    end
+  end
+
+  describe '#save_without_approval' do
+    it 'calls #without_approval' do
+      subject.should_receive(:without_approval)
+      subject.save_without_approval
+    end
+  end
+
+  describe '#save_without_approval!' do
+    it 'calls #without_approval' do
+      subject.should_receive(:without_approval)
+      subject.save_without_approval!
+    end
+  end
+end