acts_as_silent_list 1.0.0 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+= 1.1.0 - 2011-10-19
+
+== Features
+
+* adding private method to remove an item from a list without touching the other list elements.
+
+
 = 1.0.0 - Initial Release
 
 This gem is based on acts_as_list, while it tries to avoid triggering

data/lib/acts_as_silent_list/active_record/acts/silent_list.rb

@@ -5,9 +5,10 @@ module ActiveRecord
         base.extend(ClassMethods)
       end
 
-      # This +acts_as+ extension provides the capabilities for sorting and reordering a number of objects in a list.
-      # The class that has this specified needs to have a +position+ column defined as an integer on
-      # the mapped database table.
+      # This +acts_as+ extension provides the capabilities for sorting and
+      # reordering a number of objects in a list.  The class that has this
+      # specified needs to have a +position+ column defined as an integer on the
+      # mapped database table.
       #
       # Todo list example:
       #
@@ -25,13 +26,17 @@ module ActiveRecord
       module ClassMethods
         # Configuration options are:
         #
-        # * +column+ - specifies the column name to use for keeping the position integer (default: +position+)
-        # * +scope+ - restricts what is to be considered a list. Given a symbol, it'll attach <tt>_id</tt>
-        #   (if it hasn't already been added) and use that as the foreign key restriction. It's also possible
-        #   to give it an entire string that is interpolated if you need a tighter scope than just a foreign key.
-        #   Example: <tt>acts_as_silent_list :scope => 'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
-        # * +top_of_list+ - defines the integer used for the top of the list. Defaults to 1. Use 0 to make the collection
-        #   act more like an array in its indexing.
+        # * +column+ - specifies the column name to use for keeping the position
+        #   integer (default: +position+)
+        # * +scope+ - restricts what is to be considered a list. Given a symbol,
+        #   it'll attach <tt>_id</tt> (if it hasn't already been added) and use
+        #   that as the foreign key restriction. It's also possible to give it
+        #   an entire string that is interpolated if you need a tighter scope
+        #   than just a foreign key.  Example: <tt>acts_as_silent_list :scope =>
+        #   'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
+        # * +top_of_list+ - defines the integer used for the top of the list.
+        #   Defaults to 1. Use 0 to make the collection act more like an array
+        #   in its indexing.
         def acts_as_silent_list(options = {})
           configuration = { :column => "position", :scope => "1 = 1", :top_of_list => 1}
           configuration.update(options) if options.is_a?(Hash)
@@ -85,12 +90,15 @@ module ActiveRecord
         end
       end
 
-      # All the methods available to a record that has had <tt>acts_as_silent_list</tt> specified. Each method works
-      # by assuming the object to be the item in the list, so <tt>chapter.move_lower</tt> would move that chapter
-      # lower in the list of all chapters. Likewise, <tt>chapter.first?</tt> would return +true+ if that chapter is
-      # the first in the list of all chapters.
+      # All the methods available to a record that has had
+      # <tt>acts_as_silent_list</tt> specified. Each method works by assuming
+      # the object to be the item in the list, so <tt>chapter.move_lower</tt>
+      # would move that chapter lower in the list of all chapters. Likewise,
+      # <tt>chapter.first?</tt> would return +true+ if that chapter is the first
+      # in the list of all chapters.
       module InstanceMethods
-        # Insert the item at the given position (defaults to the top position of 1).
+        # Insert the item at the given position
+        # (defaults to the top position of 1).
         def insert_at(position = acts_as_silent_list_top)
           insert_at_position(position)
         end
@@ -115,8 +123,8 @@ module ActiveRecord
           end
         end
 
-        # Move to the bottom of the list. If the item is already in the list, the items below it have their
-        # position adjusted accordingly.
+        # Move to the bottom of the list. If the item is already in the list,
+        # the items below it have their position adjusted accordingly.
         def move_to_bottom
           return unless in_list?
           acts_as_silent_list_class.transaction do
@@ -125,8 +133,8 @@ module ActiveRecord
           end
         end
 
-        # Move to the top of the list. If the item is already in the list, the items above it have their
-        # position adjusted accordingly.
+        # Move to the top of the list. If the item is already in the list, the
+        # items above it have their position adjusted accordingly.
         def move_to_top
           return unless in_list?
           acts_as_silent_list_class.transaction do
@@ -139,17 +147,19 @@ module ActiveRecord
         def remove_from_list
           if in_list?
             decrement_positions_on_lower_items
-            update_attribute_silently(position_column, nil)
+            assume_not_in_list
           end
         end
 
-        # Increase the position of this item without adjusting the rest of the list.
+        # Increase the position of this item without adjusting the rest of the
+        # list.
         def increment_position
           return unless in_list?
           update_attribute_silently(position_column, self.send(position_column).to_i + 1)
         end
 
-        # Decrease the position of this item without adjusting the rest of the list.
+        # Decrease the position of this item without adjusting the rest of the
+        # list.
         def decrement_position
           return unless in_list?
           update_attribute_silently(position_column, self.send(position_column).to_i - 1)
@@ -228,13 +238,16 @@ module ActiveRecord
             conditions = scope_condition
             conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
             acts_as_silent_list_class.unscoped do
-              acts_as_silent_list_class.find(:first, :conditions => conditions, :order => "#{position_column} DESC")
+              acts_as_silent_list_class.find(:first,
+                                             :conditions => conditions,
+                                             :order => "#{position_column} DESC")
             end
           end
 
           # Forces item to assume the bottom position in the list.
           def assume_bottom_position
-            update_attribute_silently(position_column, bottom_position_in_list(self).to_i + 1)
+            update_attribute_silently(position_column,
+                                      bottom_position_in_list(self).to_i + 1)
           end
 
           # Forces item to assume the top position in the list.
@@ -242,10 +255,16 @@ module ActiveRecord
             update_attribute_silently(position_column, acts_as_silent_list_top)
           end
 
+          # Force item to assume no position in the list.
+          def assume_not_in_list
+            update_attribute_silently(position_column, nil)
+          end
+
           # This has the effect of moving all the higher items up one.
           def decrement_positions_on_higher_items(position)
             acts_as_silent_list_class.update_all(
-              "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} <= #{position}"
+              "#{position_column} = (#{position_column} - 1)",
+              "#{scope_condition} AND #{position_column} <= #{position}"
             )
           end
 
@@ -253,7 +272,8 @@ module ActiveRecord
           def decrement_positions_on_lower_items
             return unless in_list?
             acts_as_silent_list_class.update_all(
-              "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} > #{send(position_column).to_i}"
+              "#{position_column} = (#{position_column} - 1)",
+              "#{scope_condition} AND #{position_column} > #{send(position_column).to_i}"
             )
           end
 
@@ -261,21 +281,25 @@ module ActiveRecord
           def increment_positions_on_higher_items
             return unless in_list?
             acts_as_silent_list_class.update_all(
-              "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} < #{send(position_column).to_i}"
+              "#{position_column} = (#{position_column} + 1)",
+              "#{scope_condition} AND #{position_column} < #{send(position_column).to_i}"
             )
           end
 
           # This has the effect of moving all the lower items down one.
           def increment_positions_on_lower_items(position)
             acts_as_silent_list_class.update_all(
-              "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} >= #{position}"
-           )
+              "#{position_column} = (#{position_column} + 1)",
+              "#{scope_condition} AND #{position_column} >= #{position}"
+            )
           end
 
-          # Increments position (<tt>position_column</tt>) of all items in the list.
+          # Increments position (<tt>position_column</tt>) of all items in the
+          # list.
           def increment_positions_on_all_items
             acts_as_silent_list_class.update_all(
-              "#{position_column} = (#{position_column} + 1)",  "#{scope_condition}"
+              "#{position_column} = (#{position_column} + 1)",
+              "#{scope_condition}"
             )
           end
 
@@ -285,7 +309,8 @@ module ActiveRecord
             update_attribute_silently(position_column, position)
           end
 
-          # used by insert_at_position instead of remove_from_list, as postgresql raises error if position_column has non-null constraint
+          # used by insert_at_position instead of remove_from_list, as
+          # postgresql raises error if position_column has non-null constraint
           def store_at_0
             if in_list?
               decrement_positions_on_lower_items

data/lib/acts_as_silent_list/version.rb

@@ -1,7 +1,7 @@
 module ActiveRecord
   module Acts
     module SilentList
-      VERSION = "1.0.0"
+      VERSION = "1.1.0"
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_silent_list
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - David Heinemeier Hansson
@@ -18,11 +18,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-10 00:00:00 +02:00
+date: 2011-10-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -36,9 +35,9 @@ dependencies:
         - 0
         version: 1.0.0
   type: :development
+  name: bundler
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -53,9 +52,9 @@ dependencies:
         - 7794
         version: 1.15.4.7794
   type: :development
+  name: activerecord
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -67,9 +66,9 @@ dependencies:
         - 0
         version: "0"
   type: :development
+  name: rake
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -81,9 +80,9 @@ dependencies:
         - 0
         version: "0"
   type: :development
+  name: rdoc
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -95,6 +94,7 @@ dependencies:
         - 0
         version: "0"
   type: :development
+  name: sqlite3
   version_requirements: *id005
 description: This "acts_as" extension is a clone of the well known acts_as_list, only it avoids triggering active record callbacks.
 email: