Module: Mongoid::ActsAsList

Defined in:
lib/mongoid_acts_as_list.rb,
lib/mongoid/acts_as_list/list.rb,
lib/mongoid/acts_as_list/version.rb,
lib/mongoid/acts_as_list/list/root.rb,
lib/mongoid/acts_as_list/configuration.rb,
lib/mongoid/acts_as_list/list/embedded.rb

Defined Under Namespace

Modules: List Classes: Configuration

Constant Summary collapse

VERSION = 
"0.0.5"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Public: the configuration object used by Mongoid::ActsAsList

Examples

Mongoid::ActsAsList.configuration.default_position_field
#=> :position

Returns the configuration object



17
18
19
 
# File 'lib/mongoid_acts_as_list.rb', line 17

def configuration
  @configuration
end

Class Method Details

.configure {|configuration| ... } ⇒ Object

Public: set the configuration options for Mongoid::ActsAsList

yields the configuration object

Examples

Mongoid::ActsAsList.configure do |config|
  # These are the default options.
  # Modify as you see fit:
  config.default_position_field = :position
  config.start_list_at = 0
end

Returns the configuration object

Yields:



33
34
35
36
 
# File 'lib/mongoid_acts_as_list.rb', line 33

def configure
  self.configuration ||= Configuration.new
  yield(configuration) if block_given?
end

.included(base) ⇒ Object 



38
39
40
41
 
# File 'lib/mongoid_acts_as_list.rb', line 38

def included base
  self.configure
  base.send :include, List
end