mongoid_orderable 1.1.0 → 1.2.0

data/.travis.yml

@@ -8,4 +8,11 @@ rvm:
 
 env:
   - MONGOID_VERSION=2
-  - MONGOID_VERSION='~> 3.0.0.rc'
+  - MONGOID_VERSION='~> 3.0.0'
+
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      env: MONGOID_VERSION='~> 3.0.0'
+
+services: mongodb

data/README.md

@@ -30,6 +30,7 @@ class Item
   # orderable :scope => :group, :column => :pos
   # orderable :scope => lambda { |document| where(:group_id => document.group_id) }
   # orderable :index => false # this one if you want specify indexes manually
+  # orderable :base => 0 # count position from zero as the top-most value (1 is the default value)
 end
 ```
 

data/lib/mongoid/orderable.rb

@@ -6,7 +6,8 @@ module Mongoid::Orderable
       configuration = {
         :column => :position,
         :index => true,
-        :scope => nil
+        :scope => nil,
+        :base => 1
       }
 
       configuration.merge! options if options.is_a?(Hash)
@@ -35,6 +36,10 @@ module Mongoid::Orderable
         configuration[:column]
       end
 
+      define_method :orderable_base do
+        configuration[:base]
+      end
+
       before_save :add_to_list
       after_destroy :remove_from_list
     end
@@ -77,7 +82,7 @@ module Mongoid::Orderable
   end
 
   def first?
-    in_list? && orderable_position == 1
+    in_list? && orderable_position == orderable_base
   end
 
   def last?
@@ -142,20 +147,22 @@ private
     target_position = :bottom unless target_position
 
     target_position = case target_position.to_sym
-      when :top then 1
+      when :top then orderable_base
       when :bottom then bottom_orderable_position
       when :higher then orderable_position.pred
       when :lower then orderable_position.next
     end unless target_position.is_a? Numeric
 
-    target_position = 1 if target_position < 1
+    target_position = orderable_base if target_position < orderable_base
     target_position = bottom_orderable_position if target_position > bottom_orderable_position
     target_position
   end
 
   def bottom_orderable_position
     @bottom_orderable_position = begin
-      max = orderable_scoped.distinct(orderable_column).map(&:to_i).max.to_i
+      positions_list = orderable_scoped.distinct(orderable_column)
+      return orderable_base if positions_list.empty?
+      max = positions_list.map(&:to_i).max.to_i
       in_list? ? max : max.next
     end
   end

data/lib/mongoid_orderable/version.rb

@@ -1,3 +1,3 @@
 module MongoidOrderable
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/mongoid/orderable_spec.rb

@@ -52,6 +52,13 @@ describe Mongoid::Orderable do
     orderable :index => false
   end
 
+  class ZeroBasedOrderable
+    include Mongoid::Document
+    include Mongoid::Orderable
+
+    orderable :base => 0
+  end
+
   describe SimpleOrderable do
     before :each do
       SimpleOrderable.delete_all
@@ -77,6 +84,10 @@ describe Mongoid::Orderable do
       end
     end
 
+    it 'should have a orderable base of 1' do
+      SimpleOrderable.create!.orderable_base.should == 1
+    end
+
     it 'should set proper position while creation' do
       positions.should == [1, 2, 3, 4, 5]
     end
@@ -105,16 +116,19 @@ describe Mongoid::Orderable do
       it 'top' do
         newbie = SimpleOrderable.create! :move_to => :top
         positions.should == [1, 2, 3, 4, 5, 6]
+        newbie.position.should == 1
       end
 
       it 'bottom' do
         newbie = SimpleOrderable.create! :move_to => :bottom
         positions.should == [1, 2, 3, 4, 5, 6]
+        newbie.position.should == 6
       end
 
       it 'middle' do
         newbie = SimpleOrderable.create! :move_to => 4
         positions.should == [1, 2, 3, 4, 5, 6]
+        newbie.position.should == 4
       end
 
     end
@@ -217,16 +231,19 @@ describe Mongoid::Orderable do
       it 'top' do
         newbie = ScopedOrderable.create! :move_to => :top, :group_id => 1
         positions.should == [1, 2, 3, 1, 2, 3]
+        newbie.position.should == 1
       end
 
       it 'bottom' do
         newbie = ScopedOrderable.create! :move_to => :bottom, :group_id => 2
         positions.should == [1, 2, 1, 2, 3, 4]
+        newbie.position.should == 4
       end
 
       it 'middle' do
         newbie = ScopedOrderable.create! :move_to => 2, :group_id => 2
         positions.should == [1, 2, 1, 2, 3, 4]
+        newbie.position.should == 2
       end
 
     end
@@ -290,4 +307,121 @@ describe Mongoid::Orderable do
     end
   end
 
+
+  describe ZeroBasedOrderable do
+    before :each do
+      ZeroBasedOrderable.delete_all
+      5.times do
+        ZeroBasedOrderable.create!
+      end
+    end
+
+    def positions
+      ZeroBasedOrderable.all.map(&:position).sort
+    end
+
+    it 'should have a orderable base of 0' do
+      ZeroBasedOrderable.create!.orderable_base.should == 0
+    end
+
+    it 'should set proper position while creation' do
+      positions.should == [0, 1, 2, 3, 4]
+    end
+
+    describe 'removement' do
+
+      it 'top' do
+        ZeroBasedOrderable.where(:position => 0).destroy
+        positions.should == [0, 1, 2, 3]
+      end
+
+      it 'bottom' do
+        ZeroBasedOrderable.where(:position => 4).destroy
+        positions.should == [0, 1, 2, 3]
+      end
+
+      it 'middle' do
+        ZeroBasedOrderable.where(:position => 2).destroy
+        positions.should == [0, 1, 2, 3]
+      end
+
+    end
+
+    describe 'inserting' do
+
+      it 'top' do
+        newbie = ZeroBasedOrderable.create! :move_to => :top
+        positions.should == [0, 1, 2, 3, 4, 5]
+        newbie.position.should == 0
+      end
+
+      it 'bottom' do
+        newbie = ZeroBasedOrderable.create! :move_to => :bottom
+        positions.should == [0, 1, 2, 3, 4, 5]
+        newbie.position.should == 5
+      end
+
+      it 'middle' do
+        newbie = ZeroBasedOrderable.create! :move_to => 3
+        positions.should == [0, 1, 2, 3, 4, 5]
+        newbie.position.should == 3
+      end
+
+    end
+
+    describe 'movement' do
+
+      it 'higher from top' do
+        record = ZeroBasedOrderable.where(:position => 0).first
+        record.update_attributes :move_to => :higher
+        positions.should == [0, 1, 2, 3, 4]
+        record.reload.position.should == 0
+      end
+
+      it 'higher from bottom' do
+        record = ZeroBasedOrderable.where(:position => 4).first
+        record.update_attributes :move_to => :higher
+        positions.should == [0, 1, 2, 3, 4]
+        record.reload.position.should == 3
+      end
+
+      it 'higher from middle' do
+        record = ZeroBasedOrderable.where(:position => 3).first
+        record.update_attributes :move_to => :higher
+        positions.should == [0, 1, 2, 3, 4]
+        record.reload.position.should == 2
+      end
+
+      it 'lower from top' do
+        record = ZeroBasedOrderable.where(:position => 0).first
+        record.update_attributes :move_to => :lower
+        positions.should == [0, 1, 2, 3, 4]
+        record.reload.position.should == 1
+      end
+
+      it 'lower from bottom' do
+        record = ZeroBasedOrderable.where(:position => 4).first
+        record.update_attributes :move_to => :lower
+        positions.should == [0, 1, 2, 3, 4]
+        record.reload.position.should == 4
+      end
+
+      it 'lower from middle' do
+        record = ZeroBasedOrderable.where(:position => 2).first
+        record.update_attributes :move_to => :lower
+        positions.should == [0, 1, 2, 3, 4]
+        record.reload.position.should == 3
+      end
+
+      it "does nothing if position not change" do
+        record = ZeroBasedOrderable.where(:position => 3).first
+        record.save
+        positions.should == [0, 1, 2, 3, 4]
+        record.reload.position.should == 3
+      end
+
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_orderable
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-23 00:00:00.000000000 Z
+date: 2013-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -95,16 +95,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 796603552408515910
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 796603552408515910
 requirements: []
 rubyforge_project: mongoid_orderable
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Acts as list mongoid implementation
-test_files: []
+test_files:
+- spec/mongoid/orderable_spec.rb
+- spec/spec_helper.rb