Module: ActiveRecord::Acts::List::InstanceMethods
- Defined in:
- vendor/plugins/acts_as_list/lib/active_record/acts/list.rb
Overview
All the methods available to a record that has had acts_as_list specified. Each method works by assuming the object to be the item in the list, so chapter.move_lower would move that chapter lower in the list of all chapters. Likewise, chapter.first? would return true if that chapter is the first in the list of all chapters.
Instance Method Summary
-
- (Object) decrement_position
Decrease the position of this item without adjusting the rest of the list.
-
- (Boolean) first?
Return true if this object is the first in the list.
-
- (Object) higher_item
Return the next higher item in the list.
-
- (Boolean) in_list?
Test if this record is in a list.
-
- (Object) increment_position
Increase the position of this item without adjusting the rest of the list.
-
- (Object) insert_at(position = 1)
Insert the item at the given position (defaults to the top position of 1).
-
- (Boolean) last?
Return true if this object is the last in the list.
-
- (Object) lower_item
Return the next lower item in the list.
-
- (Object) move_higher
Swap positions with the next higher item, if one exists.
-
- (Object) move_lower
Swap positions with the next lower item, if one exists.
-
- (Object) move_to(pos)
Move to the given position.
-
- (Object) move_to_bottom
Move to the bottom of the list.
-
- (Object) move_to_top
Move to the top of the list.
-
- (Object) remove_from_list
Removes the item from the list.
Instance Method Details
- (Object) decrement_position
Decrease the position of this item without adjusting the rest of the list.
152 153 154 155 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 152 def decrement_position return unless in_list? update_attribute position_column, self.send(position_column).to_i - 1 end |
- (Boolean) first?
Return true if this object is the first in the list.
158 159 160 161 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 158 def first? return false unless in_list? self.send(position_column) == 1 end |
- (Object) higher_item
Return the next higher item in the list.
170 171 172 173 174 175 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 170 def higher_item return nil unless in_list? acts_as_list_class.find(:first, :conditions => "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}" ) end |
- (Boolean) in_list?
Test if this record is in a list
186 187 188 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 186 def in_list? !send(position_column).nil? end |
- (Object) increment_position
Increase the position of this item without adjusting the rest of the list.
146 147 148 149 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 146 def increment_position return unless in_list? update_attribute position_column, self.send(position_column).to_i + 1 end |
- (Object) insert_at(position = 1)
Insert the item at the given position (defaults to the top position of 1).
79 80 81 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 79 def insert_at(position = 1) insert_at_position(position) end |
- (Boolean) last?
Return true if this object is the last in the list.
164 165 166 167 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 164 def last? return false unless in_list? self.send(position_column) == bottom_position_in_list end |
- (Object) lower_item
Return the next lower item in the list.
178 179 180 181 182 183 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 178 def lower_item return nil unless in_list? acts_as_list_class.find(:first, :conditions => "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}" ) end |
- (Object) move_higher
Swap positions with the next higher item, if one exists.
94 95 96 97 98 99 100 101 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 94 def move_higher return unless higher_item acts_as_list_class.transaction do higher_item.increment_position decrement_position end end |
- (Object) move_lower
Swap positions with the next lower item, if one exists.
84 85 86 87 88 89 90 91 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 84 def move_lower return unless lower_item acts_as_list_class.transaction do lower_item.decrement_position increment_position end end |
- (Object) move_to=(pos)
Move to the given position
124 125 126 127 128 129 130 131 132 133 134 135 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 124 def move_to=(pos) case pos.to_s when 'highest' move_to_top when 'higher' move_higher when 'lower' move_lower when 'lowest' move_to_bottom end end |
- (Object) move_to_bottom
Move to the bottom of the list. If the item is already in the list, the items below it have their position adjusted accordingly.
105 106 107 108 109 110 111 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 105 def move_to_bottom return unless in_list? acts_as_list_class.transaction do decrement_positions_on_lower_items assume_bottom_position end end |
- (Object) move_to_top
Move to the top of the list. If the item is already in the list, the items above it have their position adjusted accordingly.
115 116 117 118 119 120 121 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 115 def move_to_top return unless in_list? acts_as_list_class.transaction do increment_positions_on_higher_items assume_top_position end end |
- (Object) remove_from_list
Removes the item from the list.
138 139 140 141 142 143 |
# File 'vendor/plugins/acts_as_list/lib/active_record/acts/list.rb', line 138 def remove_from_list if in_list? decrement_positions_on_lower_items update_attribute position_column, nil end end |