Module | ActsAsList::ClassMethods |
In: |
lib/acts_as_list.rb
lib/acts_as_list.rb |
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:
class TodoList < ActiveRecord::Base has_many :todo_items, :order => "position" end class TodoItem < ActiveRecord::Base belongs_to :todo_list acts_as_list :scope => :todo_list end todo_list.first.move_to_bottom todo_list.last.move_higher
Configuration options are:
# File lib/acts_as_list.rb, line 31 31: def acts_as_list(options = {}) 32: configuration = { :column => "position", :scope => "1 = 1" } 33: configuration.update(options) if options.is_a?(Hash) 34: 35: configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/ 36: 37: if configuration[:scope].is_a?(Symbol) 38: scope_condition_method = %( 39: def scope_condition 40: if #{configuration[:scope].to_s}.nil? 41: "#{configuration[:scope].to_s} IS NULL" 42: else 43: "#{configuration[:scope].to_s} = \#{#{configuration[:scope].to_s}}" 44: end 45: end 46: ) 47: else 48: scope_condition_method = "def scope_condition() \"#{configuration[:scope]}\" end" 49: end 50: 51: class_eval "include ActsAsList::InstanceMethods\n\ndef acts_as_list_class\n::\#{self.name}\nend\n\ndef position_column\n'\#{configuration[:column]}'\nend\n\n\#{scope_condition_method}\n\nbefore_destroy :remove_from_list\nbefore_create :add_to_list_bottom\n" 52: end
Configuration options are:
# File lib/acts_as_list.rb, line 31 31: def acts_as_list(options = {}) 32: configuration = { :column => "position", :scope => "1 = 1" } 33: configuration.update(options) if options.is_a?(Hash) 34: 35: configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/ 36: 37: if configuration[:scope].is_a?(Symbol) 38: scope_condition_method = %( 39: def scope_condition 40: if #{configuration[:scope].to_s}.nil? 41: "#{configuration[:scope].to_s} IS NULL" 42: else 43: "#{configuration[:scope].to_s} = \#{#{configuration[:scope].to_s}}" 44: end 45: end 46: ) 47: else 48: scope_condition_method = "def scope_condition() \"#{configuration[:scope]}\" end" 49: end 50: 51: class_eval "include ActsAsList::InstanceMethods\n\ndef acts_as_list_class\n::\#{self.name}\nend\n\ndef position_column\n'\#{configuration[:column]}'\nend\n\n\#{scope_condition_method}\n\nbefore_destroy :remove_from_list\nbefore_create :add_to_list_bottom\n" 52: end