mongoid_acts_as_list 0.0.4 → 0.0.5

data/README.markdown

@@ -13,7 +13,7 @@ Mongoid::ActsAsList provides the ability of ordering and sorting a number of obj
 Place the following in your Gemfile:
 
 ``` ruby
-gem 'mongoid_acts_as_list', '~> 0.0.3'
+gem 'mongoid_acts_as_list', '~> 0.0.4'
 ```
 
 Then run `bundle install`
@@ -108,6 +108,16 @@ item.last?
 
 item.next_item               #=> returns the item immediately following `item` in the list
 item.previous_item           #=> returns the item immediately preceding `item` in the list
+
+## Original ActsAsList #move_ methods
+
+item.move_higher             #=> same as item.move(:backward)
+item.move_lower              #=> same as item.move(:forward)
+item.move_to_top             #=> same as item.move(to: :start)
+item.move_to_bottom          #=> same as item.move(to: :end)
+item.increment_position      #=> increments the position number without affecting other items
+item.decrement_position      #=> decrements the position number without affecting other items
+item.insert_at 3             #=> same as item.move(to: 3)
 ```
 
 

data/lib/mongoid/acts_as_list/list.rb

@@ -8,6 +8,47 @@ module Mongoid::ActsAsList
     class ScopeMissingError < RuntimeError; end
 
     module ClassMethods
+
+      # Public: class macro to enable the ActsAsList module
+      #
+      # options - a Hash of options
+      #             :field - the name of the field to hold the position number as a Symbol or a String (optional)
+      #             :scope - the name of the association to scope the list for (required for non-embedded models)
+      #
+      # Examples
+      #
+      #   ## on a belong_to relation
+      #
+      #   class List
+      #     include Mongoid::Document
+      #
+      #     has_many :items
+      #   end
+      #
+      #   class Item
+      #     include Mongoid::Document
+      #     include Mongoid::ActsAsList
+      #
+      #     belongs_to :list
+      #     acts_as_list scope: :list, field: :position
+      #   end
+      #
+      #
+      #   ## on a embedded_in relation
+      #
+      #   class List
+      #     include Mongoid::Document
+      #
+      #     embeds_many :items
+      #   end
+      #
+      #   class Item
+      #     include Mongoid::Document
+      #     include Mongoid::ActsAsList
+      #
+      #     embedded_in :list
+      #     acts_as_list field: :num
+      #   end
       def acts_as_list options = {}
         field = options.fetch(:field, Mongoid::ActsAsList.configuration.default_position_field).try(:to_sym)
         scope = options.fetch(:scope, nil).try(:to_sym)
@@ -138,8 +179,8 @@ module Mongoid::ActsAsList
     def move_backwards by_how_much = 1
       move_to(self[position_field] - by_how_much) unless first?
     end
-    alias_method :move_higher , :move_backwards
-    alias_method :move_forward, :move_forwards
+    alias_method :move_higher  , :move_backwards
+    alias_method :move_backward, :move_backwards
 
     # Public: Moves the item before another one in the list
     #
@@ -216,7 +257,7 @@ module Mongoid::ActsAsList
       return unless in_list?
       items_in_list.where(position_field => self[position_field]+1).first
     end
-    alias_method :higher_item, :next_item
+    alias_method :lower_item, :next_item
 
     # Public: Gets the preceding item in the list
     #
@@ -226,11 +267,10 @@ module Mongoid::ActsAsList
       return unless in_list?
       items_in_list.where(position_field => self[position_field]-1).first
     end
-    alias_method :lower_item, :previous_item
-
-  private
+    alias_method :higher_item, :previous_item
 
-    # Internal: Insert at a given position in the list
+    # Public: Insert at a given position in the list
+    #         for API compatibility with AR acts_as_list
     #
     # new_position - an Integer indicating the position to insert the item at
     #
@@ -240,6 +280,32 @@ module Mongoid::ActsAsList
       update_attribute(position_field, new_position)
     end
 
+    # Public: increments the position number without affecting other items
+    #         for API compatibility with AR acts_as_list
+    def increment_position
+      inc(position_field, 1)
+    end
+
+    # Public: decrements the position number without affecting other items
+    #         for API compatibility with AR acts_as_list
+    def decrement_position
+      inc(position_field, -1)
+    end
+
+    # Public: returns the default position symbol as defined in the configuration
+    #         for API compatibility with AR acts_as_list
+    def default_position
+      Mongoid::ActsAsList.configuration.default_position_field
+    end
+
+    # Public: returns true if the model uses the default position field name as defined in the configuration
+    #         for API compatibility with AR acts_as_list
+    def default_position?
+      position_field == default_position
+    end
+
+  private
+
     # Internal: Make space in the list at a given position number
     #   used when moving a item to a new position in the list.
     #

data/lib/mongoid/acts_as_list/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module ActsAsList
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/spec/support/list_examples.rb

@@ -103,7 +103,37 @@ shared_examples_for "a list" do
     end
   end
 
-  %w[higher_item next_item].each do |method_name|
+  describe "#increment_position" do
+    let(:item) { category.items.order_by_position.first }
+
+    it "increments the position number" do
+      lambda do
+        item.increment_position
+      end.should change(item, position_field).by(1)
+    end
+
+    it "does not reorder other items" do
+      item.increment_position
+      category.items.order_by_position.map(&position_field).should == [1,1,2]
+    end
+  end
+
+  describe "#increment_position" do
+    let(:item) { category.items.order_by_position.last }
+
+    it "descrements the position number" do
+      lambda do
+        item.decrement_position
+      end.should change(item, position_field).by(-1)
+    end
+
+    it "does not reorder other items" do
+      item.decrement_position
+      category.items.order_by_position.map(&position_field).should == [0,1,1]
+    end
+  end
+
+  %w[lower_item next_item].each do |method_name|
     describe "##{method_name}" do
       it "returns the next item in the list if there is one" do
         item      = category.items.where(position_field => 1).first
@@ -124,7 +154,7 @@ shared_examples_for "a list" do
     end
   end
 
-  %w[lower_item previous_item].each do |method_name|
+  %w[higher_item previous_item].each do |method_name|
     describe "##{method_name}" do
       it "returns the previous item in the list if there is one" do
         item          = category.items.where(position_field => 1).first
@@ -511,15 +541,33 @@ shared_examples_for "a list" do
       Mongoid::ActsAsList.configure {|c| c.start_list_at = @original_start}
     end
 
-    # it "is configurable" do
-    #   empty_category = category.class.create!
-    #   empty_category.items.should be_empty
-    #   start = 1
-    #   Mongoid::ActsAsList.configure {|c| c.start_list_at = start}
-    #   item = empty_category.items.create!
-    #   item[position_field].should == start
-    #   item = empty_category.items.create!
-    #   item[position_field].should == start+1
-    # end
+    it "is configurable" do
+      category.items.destroy_all
+      start = 1
+      Mongoid::ActsAsList.configure {|c| c.start_list_at = start}
+      item = category.items.create!
+      item[position_field].should == start
+      item = category.items.create!
+      item[position_field].should == start+1
+    end
+  end
+
+  describe "#default_position" do
+    it "returns the default position field name" do
+      item = category.items.create!
+      item.default_position.should == position_field
+    end
+  end
+  describe "#default_position?" do
+    let(:item) { category.items.create! }
+
+    it "returns true if the model uses the default position field" do
+      item.default_position?.should == true
+    end
+
+    it "returns false if not" do
+      item.stub(:position_field).and_return :blahblah
+      item.default_position?.should == false
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_acts_as_list
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-25 00:00:00.000000000 Z
+date: 2012-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &74681830 !ruby/object:Gem::Requirement
+  requirement: &77666190 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74681830
+  version_requirements: *77666190
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &74681400 !ruby/object:Gem::Requirement
+  requirement: &77665860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74681400
+  version_requirements: *77665860
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &74681120 !ruby/object:Gem::Requirement
+  requirement: &77665580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74681120
+  version_requirements: *77665580
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &74680850 !ruby/object:Gem::Requirement
+  requirement: &77665230 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.5'
   type: :development
   prerelease: false
-  version_requirements: *74680850
+  version_requirements: *77665230
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &74680180 !ruby/object:Gem::Requirement
+  requirement: &77664690 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74680180
+  version_requirements: *77664690
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &74679440 !ruby/object:Gem::Requirement
+  requirement: &77663960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *74679440
+  version_requirements: *77663960
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &74678270 !ruby/object:Gem::Requirement
+  requirement: &77662720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: 2.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *74678270
+  version_requirements: *77662720
 description: ''
 email:
 - olivier.melcher@gmail.com