Module: ActiveRecord::Acts::List::InstanceMethods

Defined in:
lib/acts_as_list/active_record/acts/list.rb

Instance Method Summary collapse

Instance Method Details

#decrement_position ⇒ Object

Decrease the position of this item without adjusting the rest of the list.



142
143
144
145
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 142

def decrement_position
  return unless in_list?
  set_list_position(self.send(position_column).to_i - 1)
end

#default_position ⇒ Object 



202
203
204
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 202

def default_position
  acts_as_list_class.columns_hash[position_column.to_s].default
end

#default_position? ⇒ Boolean

Returns:

  • (Boolean) 


206
207
208
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 206

def default_position?
  default_position && default_position.to_i == send(position_column)
end

#first? ⇒ Boolean

Returns:

  • (Boolean) 


147
148
149
150
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 147

def first?
  return false unless in_list?
  !higher_items(1).exists?
end

#higher_item ⇒ Object

Return the next higher item in the list.



158
159
160
161
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 158

def higher_item
  return nil unless in_list?
  higher_items(1).first
end

#higher_items(limit = nil) ⇒ Object

Return the next n higher items in the list selects all higher items by default



165
166
167
168
169
170
171
172
173
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 165

def higher_items(limit=nil)
  limit ||= acts_as_list_list.count
  position_value = send(position_column)
  acts_as_list_list.
    where("#{quoted_position_column_with_table_name} <= ?", position_value).
    where("#{quoted_table_name}.#{self.class.primary_key} != ?", self.send(self.class.primary_key)).
    reorder(acts_as_list_order_argument(:desc)).
    limit(limit)
end

#in_list? ⇒ Boolean

Test if this record is in a list

Returns:

  • (Boolean) 


194
195
196
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 194

def in_list?
  !not_in_list?
end

#increment_position ⇒ Object

Increase the position of this item without adjusting the rest of the list.



136
137
138
139
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 136

def increment_position
  return unless in_list?
  set_list_position(self.send(position_column).to_i + 1)
end

#insert_at(position = acts_as_list_top) ⇒ Object

Insert the item at the given position (defaults to the top position of 1).



68
69
70
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 68

def insert_at(position = acts_as_list_top)
  insert_at_position(position)
end

#last? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
155
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 152

def last?
  return false unless in_list?
  !lower_items(1).exists?
end

#lower_item ⇒ Object

Return the next lower item in the list.



176
177
178
179
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 176

def lower_item
  return nil unless in_list?
  lower_items(1).first
end

#lower_items(limit = nil) ⇒ Object

Return the next n lower items in the list selects all lower items by default



183
184
185
186
187
188
189
190
191
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 183

def lower_items(limit=nil)
  limit ||= acts_as_list_list.count
  position_value = send(position_column)
  acts_as_list_list.
    where("#{quoted_position_column_with_table_name} >= ?", position_value).
    where("#{quoted_table_name}.#{self.class.primary_key} != ?", self.send(self.class.primary_key)).
    reorder(acts_as_list_order_argument(:asc)).
    limit(limit)
end

#move_higher ⇒ Object

Swap positions with the next higher item, if one exists.



87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 87

def move_higher
  return unless higher_item

  acts_as_list_class.transaction do
    if higher_item.send(position_column) != self.send(position_column)
      swap_positions(higher_item, self)
    else
      higher_item.increment_position
      decrement_position
    end
  end
end

#move_lower ⇒ Object

Swap positions with the next lower item, if one exists.



73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 73

def move_lower
  return unless lower_item

  acts_as_list_class.transaction do
    if lower_item.send(position_column) != self.send(position_column)
      swap_positions(lower_item, self)
    else
      lower_item.decrement_position
      increment_position
    end
  end
end

#move_to_bottom ⇒ Object

Move to the bottom of the list. If the item is already in the list, the items below it have their position adjusted accordingly.



102
103
104
105
106
107
108
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 102

def move_to_bottom
  return unless in_list?
  acts_as_list_class.transaction do
    decrement_positions_on_lower_items
    assume_bottom_position
  end
end

#move_to_top ⇒ Object

Move to the top of the list. If the item is already in the list, the items above it have their position adjusted accordingly.



112
113
114
115
116
117
118
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 112

def move_to_top
  return unless in_list?
  acts_as_list_class.transaction do
    increment_positions_on_higher_items
    assume_top_position
  end
end

#move_within_scope(scope_id) ⇒ Object

Move the item within scope. If a position within the new scope isn’t supplied, the item will be appended to the end of the list.



130
131
132
133
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 130

def move_within_scope(scope_id)
  send("#{scope_name}=", scope_id)
  save!
end

#not_in_list? ⇒ Boolean

Returns:

  • (Boolean) 


198
199
200
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 198

def not_in_list?
  send(position_column).nil?
end

#remove_from_list ⇒ Object

Removes the item from the list.



121
122
123
124
125
126
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 121

def remove_from_list
  if in_list?
    decrement_positions_on_lower_items
    set_list_position(nil)
  end
end

#set_list_position(new_position) ⇒ Object

Sets the new position and saves it



211
212
213
214
 
# File 'lib/acts_as_list/active_record/acts/list.rb', line 211

def set_list_position(new_position)
  write_attribute position_column, new_position
  save(validate: false)
end