mongoid_orderable 5.0.0 → 6.0.2

data/spec/integration/multiple_scoped_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe MultipleScopedOrderable do
+
+  shared_examples_for 'multiple_scoped_orderable' do
+
+    before :each do
+      3.times do
+        Apple.create
+        Orange.create
+      end
+      MultipleScopedOrderable.create! apple_id: 1, orange_id: 1
+      MultipleScopedOrderable.create! apple_id: 2, orange_id: 1
+      MultipleScopedOrderable.create! apple_id: 2, orange_id: 2
+      MultipleScopedOrderable.create! apple_id: 1, orange_id: 3
+      MultipleScopedOrderable.create! apple_id: 1, orange_id: 1
+      MultipleScopedOrderable.create! apple_id: 3, orange_id: 3
+      MultipleScopedOrderable.create! apple_id: 2, orange_id: 3
+      MultipleScopedOrderable.create! apple_id: 3, orange_id: 2
+      MultipleScopedOrderable.create! apple_id: 1, orange_id: 3
+    end
+
+    def apple_positions
+      MultipleScopedOrderable.order_by([:apple_id, :asc], [:posa, :asc]).map(&:posa)
+    end
+
+    def orange_positions
+      MultipleScopedOrderable.order_by([:orange_id, :asc], [:poso, :asc]).map(&:poso)
+    end
+
+    describe 'default positions' do
+      it { expect(apple_positions).to eq([1, 2, 3, 4, 1, 2, 3, 1, 2]) }
+      it { expect(orange_positions).to eq([1, 2, 3, 1, 2, 1, 2, 3, 4]) }
+    end
+
+    describe 'change the scope of the apple' do
+      let(:record) { MultipleScopedOrderable.first }
+      before do
+        record.update_attribute(:apple_id, 2)
+      end
+
+      it 'should properly set the apple positions' do
+        expect(apple_positions).to eq([1, 2, 3, 1, 2, 3, 4, 1, 2])
+      end
+
+      it 'should not affect the orange positions' do
+        expect(orange_positions).to eq([1, 2, 3, 1, 2, 1, 2, 3, 4])
+      end
+    end
+  end
+
+  context 'with transactions' do
+    enable_transactions!
+
+    it_behaves_like 'multiple_scoped_orderable'
+  end
+
+  context 'without transactions' do
+    disable_transactions!
+
+    it_behaves_like 'multiple_scoped_orderable'
+  end
+end

data/spec/integration/no_indexed_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe NoIndexOrderable do
+
+  shared_examples_for 'no_index_orderable' do
+
+    it 'should not have index on position field' do
+      expect(NoIndexOrderable.index_specifications.detect {|spec| spec.key == :position }).to be_nil
+    end
+  end
+
+  context 'with transactions' do
+    enable_transactions!
+
+    it_behaves_like 'no_index_orderable'
+  end
+
+  context 'without transactions' do
+    disable_transactions!
+
+    it_behaves_like 'no_index_orderable'
+  end
+end

data/spec/integration/scoped_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe ScopedOrderable do
+
+  shared_examples_for 'scoped_orderable' do
+
+    def positions
+      ScopedOrderable.order_by([:group_id, :asc], [:position, :asc]).map(&:position)
+    end
+
+    before :each do
+      2.times { ScopedOrderable.create! group_id: 1 }
+      3.times { ScopedOrderable.create! group_id: 2 }
+    end
+
+    it 'should set proper position while creation' do
+      expect(positions).to eq([1, 2, 1, 2, 3])
+    end
+
+    describe 'removement' do
+      it 'top' do
+        ScopedOrderable.where(position: 1, group_id: 1).destroy
+        expect(positions).to eq([1, 1, 2, 3])
+      end
+
+      it 'bottom' do
+        ScopedOrderable.where(position: 3, group_id: 2).destroy
+        expect(positions).to eq([1, 2, 1, 2])
+      end
+
+      it 'middle' do
+        ScopedOrderable.where(position: 2, group_id: 2).destroy
+        expect(positions).to eq([1, 2, 1, 2])
+      end
+    end
+
+    describe 'inserting' do
+      it 'top' do
+        newbie = ScopedOrderable.create! move_to: :top, group_id: 1
+        expect(positions).to eq([1, 2, 3, 1, 2, 3])
+        expect(newbie.position).to eq(1)
+      end
+
+      it 'bottom' do
+        newbie = ScopedOrderable.create! move_to: :bottom, group_id: 2
+        expect(positions).to eq([1, 2, 1, 2, 3, 4])
+        expect(newbie.position).to eq(4)
+      end
+
+      it 'middle' do
+        newbie = ScopedOrderable.create! move_to: 2, group_id: 2
+        expect(positions).to eq([1, 2, 1, 2, 3, 4])
+        expect(newbie.position).to eq(2)
+      end
+
+      it 'middle (with a numeric string)' do
+        newbie = ScopedOrderable.create! move_to: '2', group_id: 2
+        expect(positions).to eq([1, 2, 1, 2, 3, 4])
+        expect(newbie.position).to eq(2)
+      end
+
+      it 'middle (with a non-numeric string)' do
+        expect do
+          ScopedOrderable.create! move_to: 'two', group_id: 2
+        end.to raise_error Mongoid::Orderable::Errors::InvalidTargetPosition
+      end
+    end
+
+    describe 'index' do
+      it 'is not on position alone' do
+        expect(ScopedOrderable.index_specifications.detect { |spec| spec.key == { position: 1 } }).to be_nil
+      end
+
+      it 'is on compound fields' do
+        expect(ScopedOrderable.index_specifications.detect { |spec| spec.key == { group_id: 1, position: 1 } }).to_not be_nil
+      end
+    end
+
+    describe 'scope movement' do
+      let(:record) { ScopedOrderable.where(group_id: 2, position: 2).first }
+
+      it 'to a new scope group' do
+        record.update_attributes group_id: 3
+        expect(positions).to eq([1, 2, 1, 2, 1])
+        expect(record.position).to eq(1)
+      end
+
+      context 'when moving to an existing scope group' do
+        it 'without a position' do
+          record.update_attributes group_id: 1
+          expect(positions).to eq([1, 2, 3, 1, 2])
+          expect(record.reload.position).to eq(3)
+        end
+
+        it 'with symbol position' do
+          record.update_attributes group_id: 1, move_to: :top
+          expect(positions).to eq([1, 2, 3, 1, 2])
+          expect(record.reload.position).to eq(1)
+        end
+
+        it 'with point position' do
+          record.update_attributes group_id: 1, move_to: 2
+          expect(positions).to eq([1, 2, 3, 1, 2])
+          expect(record.reload.position).to eq(2)
+        end
+
+        it 'with point position (with a numeric string)' do
+          record.update_attributes group_id: 1, move_to: '2'
+          expect(positions).to eq([1, 2, 3, 1, 2])
+          expect(record.reload.position).to eq(2)
+        end
+
+        it 'with point position (with a non-numeric string)' do
+          expect do
+            record.update_attributes group_id: 1, move_to: 'two'
+          end.to raise_error Mongoid::Orderable::Errors::InvalidTargetPosition
+        end
+      end
+    end
+
+    describe 'utility methods' do
+      it 'should return a collection of items lower/higher on the list for next_items/previous_items' do
+        record1 = ScopedOrderable.where(group_id: 1, position: 1).first
+        record2 = ScopedOrderable.where(group_id: 1, position: 2).first
+        record3 = ScopedOrderable.where(group_id: 2, position: 1).first
+        record4 = ScopedOrderable.where(group_id: 2, position: 2).first
+        record5 = ScopedOrderable.where(group_id: 2, position: 3).first
+        expect(record1.next_items.to_a).to eq([record2])
+        expect(record5.previous_items.to_a).to eq([record3, record4])
+        expect(record3.previous_items.to_a).to eq([])
+        expect(record3.next_items.to_a).to eq([record4, record5])
+        expect(record1.next_item).to eq(record2)
+        expect(record2.previous_item).to eq(record1)
+        expect(record1.previous_item).to eq(nil)
+        expect(record2.next_item).to eq(nil)
+      end
+    end
+  end
+
+  context 'with transactions' do
+    enable_transactions!
+
+    it_behaves_like 'scoped_orderable'
+  end
+
+  context 'without transactions' do
+    disable_transactions!
+
+    it_behaves_like 'scoped_orderable'
+  end
+end

data/spec/integration/simple_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+describe SimpleOrderable do
+
+  shared_examples_for 'simple_orderable' do
+
+    def positions
+      SimpleOrderable.pluck(:position).sort
+    end
+
+    before :each do
+      5.times { SimpleOrderable.create! }
+    end
+
+    it 'should have proper position field' do
+      expect(SimpleOrderable.fields.key?('position')).to be true
+      expect(SimpleOrderable.fields['position'].options[:type]).to eq(Integer)
+    end
+
+    it 'should have index on position field' do
+      expect(SimpleOrderable.index_specifications.detect { |spec| spec.key == { position: 1 } }).not_to be_nil
+    end
+
+    it 'should have a orderable base of 1' do
+      expect(SimpleOrderable.create!.orderable_top).to eq(1)
+    end
+
+    it 'should set proper position while creation' do
+      expect(positions).to eq([1, 2, 3, 4, 5])
+    end
+
+    describe 'removement' do
+      it 'top' do
+        SimpleOrderable.where(position: 1).destroy
+        expect(positions).to eq([1, 2, 3, 4])
+      end
+
+      it 'bottom' do
+        SimpleOrderable.where(position: 5).destroy
+        expect(positions).to eq([1, 2, 3, 4])
+      end
+
+      it 'middle' do
+        SimpleOrderable.where(position: 3).destroy
+        expect(positions).to eq([1, 2, 3, 4])
+      end
+    end
+
+    describe 'inserting' do
+      it 'top' do
+        newbie = SimpleOrderable.create! move_to: :top
+        expect(positions).to eq([1, 2, 3, 4, 5, 6])
+        expect(newbie.position).to eq(1)
+      end
+
+      it 'bottom' do
+        newbie = SimpleOrderable.create! move_to: :bottom
+        expect(positions).to eq([1, 2, 3, 4, 5, 6])
+        expect(newbie.position).to eq(6)
+      end
+
+      it 'middle' do
+        newbie = SimpleOrderable.create! move_to: 4
+        expect(positions).to eq([1, 2, 3, 4, 5, 6])
+        expect(newbie.position).to eq(4)
+      end
+
+      it 'middle (with a numeric string)' do
+        newbie = SimpleOrderable.create! move_to: '4'
+        expect(positions).to eq([1, 2, 3, 4, 5, 6])
+        expect(newbie.position).to eq(4)
+      end
+
+      it 'middle (with a non-numeric string)' do
+        expect do
+          SimpleOrderable.create! move_to: 'four'
+        end.to raise_error Mongoid::Orderable::Errors::InvalidTargetPosition
+      end
+
+      it 'simultaneous create and update' do
+        newbie = SimpleOrderable.new
+        newbie.send(:orderable_before_update) { }
+        expect(newbie.position).to eq(6)
+        another = SimpleOrderable.create!
+        expect(another.position).to eq(6)
+        newbie.save!
+        expect(positions).to eq([1, 2, 3, 4, 5, 6, 7])
+        expect(newbie.position).to eq(7)
+        expect(another.position).to eq(6)
+      end
+
+      it 'parallel updates' do
+        newbie = SimpleOrderable.new
+        newbie.send(:orderable_before_update) { }
+        another = SimpleOrderable.create!
+        newbie.save!
+        expect(positions).to eq([1, 2, 3, 4, 5, 6, 7])
+        expect(newbie.position).to eq(7)
+        expect(another.position).to eq(6)
+      end
+    end
+
+    describe 'movement' do
+      it 'higher from top' do
+        record = SimpleOrderable.where(position: 1).first
+        record.update_attributes move_to: :higher
+        expect(positions).to eq([1, 2, 3, 4, 5])
+        expect(record.reload.position).to eq(1)
+      end
+
+      it 'higher from bottom' do
+        record = SimpleOrderable.where(position: 5).first
+        record.update_attributes move_to: :higher
+        expect(positions).to eq([1, 2, 3, 4, 5])
+        expect(record.reload.position).to eq(4)
+      end
+
+      it 'higher from middle' do
+        record = SimpleOrderable.where(position: 3).first
+        record.update_attributes move_to: :higher
+        expect(positions).to eq([1, 2, 3, 4, 5])
+        expect(record.reload.position).to eq(2)
+      end
+
+      it 'lower from top' do
+        record = SimpleOrderable.where(position: 1).first
+        record.update_attributes move_to: :lower
+        expect(positions).to eq([1, 2, 3, 4, 5])
+        expect(record.reload.position).to eq(2)
+      end
+
+      it 'lower from bottom' do
+        record = SimpleOrderable.where(position: 5).first
+        record.update_attributes move_to: :lower
+        expect(positions).to eq([1, 2, 3, 4, 5])
+        expect(record.reload.position).to eq(5)
+      end
+
+      it 'lower from middle' do
+        record = SimpleOrderable.where(position: 3).first
+        record.update_attributes move_to: :lower
+        expect(positions).to eq([1, 2, 3, 4, 5])
+        expect(record.reload.position).to eq(4)
+      end
+
+      it 'does nothing if position not change' do
+        record = SimpleOrderable.where(position: 3).first
+        record.save
+        expect(positions).to eq([1, 2, 3, 4, 5])
+        expect(record.reload.position).to eq(3)
+      end
+    end
+
+    describe 'utility methods' do
+      it 'should return a collection of items lower/higher on the list for next_items/previous_items' do
+        record1 = SimpleOrderable.where(position: 1).first
+        record2 = SimpleOrderable.where(position: 2).first
+        record3 = SimpleOrderable.where(position: 3).first
+        record4 = SimpleOrderable.where(position: 4).first
+        record5 = SimpleOrderable.where(position: 5).first
+        expect(record1.next_items.to_a).to eq([record2, record3, record4, record5])
+        expect(record5.previous_items.to_a).to eq([record1, record2, record3, record4])
+        expect(record3.previous_items.to_a).to eq([record1, record2])
+        expect(record3.next_items.to_a).to eq([record4, record5])
+        expect(record1.next_item).to eq(record2)
+        expect(record2.previous_item).to eq(record1)
+        expect(record1.previous_item).to eq(nil)
+        expect(record5.next_item).to eq(nil)
+      end
+    end
+  end
+
+  context 'with transactions' do
+    enable_transactions!
+
+    it_behaves_like 'simple_orderable'
+  end
+
+  context 'without transactions' do
+    disable_transactions!
+
+    it_behaves_like 'simple_orderable'
+  end
+end

data/spec/integration/string_scoped_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe StringScopedOrderable do
+
+  shared_examples_for 'string_scoped_orderable' do
+
+    it 'uses the foreign key of the relationship as scope' do
+      orderable1 = StringScopedOrderable.create!(some_scope: 1)
+      orderable2 = StringScopedOrderable.create!(some_scope: 1)
+      orderable3 = StringScopedOrderable.create!(some_scope: 2)
+      expect(orderable1.position).to eq 1
+      expect(orderable2.position).to eq 2
+      expect(orderable3.position).to eq 1
+    end
+  end
+
+  context 'with transactions' do
+    enable_transactions!
+
+    it_behaves_like 'string_scoped_orderable'
+  end
+
+  context 'without transactions' do
+    disable_transactions!
+
+    it_behaves_like 'string_scoped_orderable'
+  end
+end