acts_as_list_mongoid 0.1.0 → 0.2.0

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+.bundle
+vendor

data/README.markdown

@@ -47,12 +47,33 @@ See the /specs folder specs that demontrate the API. Usage examples are located
     todo_item = Item.new(:name => name)
     todo_list.items << todo_item
   end  
-  todo_list.items.created! # IMPORTANT!!!
+  todo_list.items.init_list! # IMPORTANT!!!
 
-  todo_list.items.first.move_to_bottom
-  todo_list.items.last.move_higher
+  todo_list.items.first.move(:bottom)
+  todo_list.items.last.move(:higher)
 </pre>  
-  
+
+### List initialization 
+
+In order for the list items to be initialized properly, it is necessary to call the method <code>init_list!</code> on the
+collection in order for the position of each list item to be set to an initial position.
+
++Example:+
+<code>todo_list.items.init_list!</code>
+
+## New move API borrowed from Data Mapper *in-list* plugin
+     
+<pre>
+item.move(:highest)          # moves to top of list.
+item.move(:lowest)           # moves to bottom of list.
+item.move(:top)              # moves to top of list.
+item.move(:bottom)           # moves to bottom of list.
+item.move(:up)               # moves one up (:higher and :up is the same) within the scope.
+item.move(:down)             # moves one up (:lower and :down is the same) within the scope.
+item.move(:to => position)   # moves item to a specific position.
+item.move(:above => other)   # moves item above the other item.*
+item.move(:below => other)
+<pre>
 
 ## Running the specs
 

data/Rakefile

@@ -5,7 +5,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name        = "acts_as_list_mongoid"
-    gem.summary     = %Q{Gem version of acts_as_list for Mongoid}
+    gem.summary     = %Q{acts_as_list for Mongoid}
     gem.description = %Q{Make your Mongoid model acts as a list. This acts_as extension provides the capabilities for sorting and reordering a number of objects in a list.
       The instances that take part in the list should have a +position+ field of type Integer.}
     gem.email       = "kmandrup@gmail.com"

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/acts_as_list_mongoid.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_list_mongoid}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-07-06}
+  s.description = %q{Make your Mongoid model acts as a list. This acts_as extension provides the capabilities for sorting and reordering a number of objects in a list.
+      The instances that take part in the list should have a +position+ field of type Integer.}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".DS_Store",
+     ".gitignore",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "acts_as_list_mongoid.gemspec",
+     "example/example.rb",
+     "init.rb",
+     "lib/.DS_Store",
+     "lib/acts_as_list_mongoid.rb",
+     "lib/init.rb",
+     "lib/mongoid/acts_as_list.rb",
+     "model/embedded_item.rb",
+     "spec/.rspec",
+     "spec/acts_as_list/embedded_item_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rails/acts_as_list}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{acts_as_list for Mongoid}
+  s.test_files = [
+    "spec/acts_as_list/embedded_item_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, [">= 2.0.0.beta7"])
+      s.add_runtime_dependency(%q<mongoid_embedded_helper>, [">= 0.2.3"])
+    else
+      s.add_dependency(%q<mongoid>, [">= 2.0.0.beta7"])
+      s.add_dependency(%q<mongoid_embedded_helper>, [">= 0.2.3"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, [">= 2.0.0.beta7"])
+    s.add_dependency(%q<mongoid_embedded_helper>, [">= 0.2.3"])
+  end
+end
+

data/lib/mongoid/acts_as_list.rb

@@ -47,9 +47,53 @@ module ActsAsList
       def in_scope
         where(scope_condition)
       end  		
+      
+      def move_commands symbol
+        case symbol
+        when :symbol
+          [:highest, :top, :lowest, :bottom, :up, :higher, :down, :lower]
+        when :hash
+          [:to, :above, :below]
+        else
+          raise ArgumentError, "no move_commands defined for: #{symbol}"
+        end
+      end
     end
   
-    module InstanceMethods           
+    module InstanceMethods 
+      def move command
+        if command.kind_of? Symbol
+          case command
+          when :highest, :top
+            move_to_top
+          when :lowest, :bottom
+            move_to_bottom          
+          when :up, :higher
+            move_higher
+          when :down, :lower
+            move_lower
+          else
+            raise ArgumentError, "unknown move command '#{command}', try one of #{self.class.move_commands_available}"
+          end
+        elsif command.kind_of? Hash     
+          other = command.values.first
+          cmd = command.keys.first
+          case cmd
+          when :to 
+            move_to(other)
+          when :above
+            move_above(other)
+          when :below
+            move_below(other)
+          else
+            raise ArgumentError, "Hash command #{cmd.inspect} not valid, must be one of"
+          end
+        else
+          raise ArgumentError, "move command takes either a Symbol or Hash as an argument, not a #{command.class}"
+        end        
+      end
+      
+                
       def order_by_position conditions, extras = []
         sub_collection = in_collection.where(conditions)
         sub_collection = if embedded?
@@ -96,6 +140,20 @@ module ActsAsList
         insert_in_list_at(position)
       end
 
+      def move_to(position = 1)    
+        insert_in_list_at(position)
+      end
+
+      def move_below(object)
+        new_pos = ( (self == object) or (object.my_position < self.my_position) ) ? self.my_position : object.my_position
+        move_to(new_pos)
+      end
+
+      def move_above(object)    
+        new_pos = ( self == object or (object.my_position < self.my_position) ) ? self.my_position : object.my_position - 1
+        move_to(new_pos)
+      end
+
   		# Insert the item at the given position (defaults to the top position of 1).
       def insert_in_list_at(position = 1)
         insert_at_position(position)
@@ -257,23 +315,26 @@ module ActsAsList
       def decrement_positions_on_higher_items(position)
   			conditions = scope_condition
   			conditions.merge!( { position_key.lt => position } )
-  			in_collection.where(conditions).adjust! position_key => 1
+
+  			decrease_all! in_collection.where(conditions)
       end
 
       # This has the effect of moving all the lower items up one.
-      def decrement_positions_on_lower_items
+      def decrement_positions_on_lower_items(max_pos = nil)
         return unless in_list?
   			conditions = scope_condition
   			conditions.merge!( greater_than_me ) 
+        conditions.merge!({ position_key.lt => max_pos} ) if max_pos
 
         decrease_all! in_collection.where(conditions)
       end
 
       # This has the effect of moving all the higher items down one.
-      def increment_positions_on_higher_items
+      def increment_positions_on_higher_items(min_pos = nil)
         return unless in_list?
   			conditions = scope_condition
   			conditions.merge!( less_than_me )
+        conditions.merge!({ position_key.gt => min_pos} ) if min_pos
 
         increase_all! in_collection.where(conditions)
       end
@@ -306,6 +367,7 @@ module ActsAsList
       end
 
       def insert_at_position(position)
+        position = [position, 1].max
         remove_from_list
         increment_positions_on_lower_items(position)
   			set_my_position(position)
@@ -317,7 +379,7 @@ module ActsAsList
         # should register on root element to be called when root is saved first time!?
       end			
 
-      def created!
+      def init_list_item!
         self['created_at'] = Time.now
         self['updated_at'] = Time.now        
         add_to_list_bottom unless in_list?
@@ -364,7 +426,7 @@ module ActsAsList
 end
 
 class Array            
-  def created!
-    each {|i| i.created! }
+  def init_list!
+    each {|i| i.init_list_item! }
   end
 end  

data/spec/acts_as_list/{embedded/custom_embedded_spec.rb → embedded_item_spec.rb}

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 require 'acts_as_list_mongoid'
 require 'embedded_item'
@@ -13,7 +13,7 @@ describe 'ActsAsList for Mongoid' do
     end
     @list.save!
     
-    @list.items.created!
+    @list.items.init_list!
   end    
   
   after :each do
@@ -46,21 +46,56 @@ describe 'ActsAsList for Mongoid' do
         @list.items.where(:number => 2).first.move_lower
         get_positions(@list).should == [1, 3, 2, 4]
       end
+
+      it "move :down should move item 2 to position 3" do          
+        @list.items.where(:number => 2).first.move(:down)
+        get_positions(@list).should == [1, 3, 2, 4]
+      end
+
+      it "move :lower should move item 2 to position 3" do          
+        @list.items.where(:number => 2).first.move(:lower)
+        get_positions(@list).should == [1, 3, 2, 4]
+      end
       
       it "should move item 2 to position 1" do    
         @list.items.where(:number => 2).first.move_higher
         get_positions(@list).should == [2, 1, 3, 4]  
       end 
+
+      it "move :up should move item 2 to position 1" do    
+        @list.items.where(:number => 2).first.move(:up)
+        get_positions(@list).should == [2, 1, 3, 4]  
+      end 
+
+      it "move :higher should move item 2 to position 1" do    
+        @list.items.where(:number => 2).first.move(:higher)
+        get_positions(@list).should == [2, 1, 3, 4]  
+      end 
         
       it "should move item 1 to bottom" do    
         @list.items.where(:number => 1).first.move_to_bottom
         get_positions(@list).should == [2, 3, 4, 1]  
       end
+
+      it "move :lowest should move item 1 to bottom" do    
+        @list.items.where(:number => 1).first.move(:lowest)
+        get_positions(@list).should == [2, 3, 4, 1]
+      end
       
       it "should move item 1 to top" do    
         @list.items.where(:number => 1).first.move_to_top
-        get_positions(@list).should == [1, 2, 3, 4]  
+        get_positions(@list).should == [1, 2, 3, 4]
+      end
+
+      it "move :highest should move item 1 to top" do    
+        @list.items.where(:number => 1).first.move(:highest)
+        get_positions(@list).should == [1, 2, 3, 4]
+      end
+
+      it "move :unknown should cause argument error" do
+        lambda {@list.items.where(:number => 1).first.move(:unknown)}.should raise_error
       end
+
       
       it "should move item 2 to bottom" do    
         @list.items.where(:number => 2).first.move_to_bottom
@@ -73,12 +108,38 @@ describe 'ActsAsList for Mongoid' do
       end  
     
       it "should move item 3 to bottom" do
-        get_positions(@list).should == [1, 2, 3, 4]      
-           
         @list.items.where(:number => 3).first.move_to_bottom
         get_positions(@list).should == [1, 2, 4, 3]  
         
       end      
+
+      it "items[2].move_to(4) should move item 2 to position 4" do           
+        @list.items.where(:number => 2).first.move_to(4)
+        get_positions(@list).should == [1, 3, 4, 2]          
+      end      
+
+      it "items[2].insert_at(3) should move item 2 to position 3" do           
+        @list.items.where(:number => 2).first.insert_at(3)
+        get_positions(@list).should == [1, 3, 2, 4]          
+      end
+
+      it "items[2].move(:to => 3) should move item 2 to position 3" do           
+        @list.items.where(:number => 2).first.move(:to => 3)
+        get_positions(@list).should == [1, 3, 2, 4]          
+      end
+
+      it "items[1].move_below(item[2]) should move item 1 to position 2" do           
+        item2 = @list.items.where(:number => 2).first
+        @list.items.where(:number => 1).first.move_below(item2)
+        get_positions(@list).should == [2, 1, 3, 4]          
+      end
+
+      it "items[1].move_above(item[3]) should move item 1 to position 2" do           
+        item3 = @list.items.where(:number => 3).first
+        @list.items.where(:number => 1).first.move_above(item3)
+        get_positions(@list).should == [2, 1, 3, 4]          
+      end
+
     end
     
     describe 'relative position queries' do
@@ -99,6 +160,6 @@ describe 'ActsAsList for Mongoid' do
       it "should not find item lower than item 4" do            
         @list.items.where(:pos => 4).first.lower_item.should == nil
       end
-    end        
+    end            
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kristian Mandrup
@@ -60,9 +60,11 @@ extra_rdoc_files:
 - README.markdown
 files: 
 - .DS_Store
+- .gitignore
 - README.markdown
 - Rakefile
 - VERSION
+- acts_as_list_mongoid.gemspec
 - example/example.rb
 - init.rb
 - lib/.DS_Store
@@ -71,7 +73,7 @@ files:
 - lib/mongoid/acts_as_list.rb
 - model/embedded_item.rb
 - spec/.rspec
-- spec/acts_as_list/embedded/custom_embedded_spec.rb
+- spec/acts_as_list/embedded_item_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -105,7 +107,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Gem version of acts_as_list for Mongoid
+summary: acts_as_list for Mongoid
 test_files: 
-- spec/acts_as_list/embedded/custom_embedded_spec.rb
+- spec/acts_as_list/embedded_item_spec.rb
 - spec/spec_helper.rb