Module: Mongoid::Fields

Extended by:

ActiveSupport::Concern

Included in:

Components

Defined in:

lib/mongoid/fields.rb,
lib/mongoid/fields/standard.rb,
lib/mongoid/fields/localized.rb,
lib/mongoid/fields/foreign_key.rb

Overview

Defined Under Namespace

Modules: ClassMethods Classes: ForeignKey, Localized, Standard

Class Method Summary (collapse)

• + (Object) option(option_name, &block)

  Stores the provided block to be run when the option name specified is defined on a field.

• + (Hash) options

  Return a map of custom option names to their handlers.

Instance Method Summary (collapse)

• - (Object) apply_default(name)

  Applies a single default value for the given name.

• - (Object) apply_defaults

  Apply all the defaults at once.

• - (Array<String ] The names of the proc defaults.) apply_post_processed_defaults

  Apply all default values to the document which are procs.

• - (Array<String ] The names of the non-proc defaults.) apply_pre_processed_defaults

  Apply all default values to the document which are not procs.

• - (Object) demongoized

  Cache of demongoized field data mapping field names to all previously demongoized attributes for this object.

• - (true, false) using_object_ids?

  Is the document using object ids?.

Mongoid::Fields.option :required do |model, field, value|
  model.validates_presence_of field if value
end

145
146
147

# File 'lib/mongoid/fields.rb', line 145

def option(option_name, &block)
  options[option_name] = block
end

Mongoid::Fields.options
# => { :required => #<Proc:0x00000100976b38> }

158
159
160

# File 'lib/mongoid/fields.rb', line 158

def options
  @options ||= {}
end

model.apply_default("name")

73
74
75
76
77
78
79
80
81
82
83

# File 'lib/mongoid/fields.rb', line 73

def apply_default(name)
  unless attributes.has_key?(name)
    if field = fields[name]
      default = field.eval_default(self)
      unless default.nil?
        attribute_will_change!(name)
        attributes[name] = default
      end
    end
  end
end

model.apply_defaults

91
92
93
94

# File 'lib/mongoid/fields.rb', line 91

def apply_defaults
  apply_pre_processed_defaults
  apply_post_processed_defaults
end

model.apply_post_processed_defaults

59
60
61
62
63

# File 'lib/mongoid/fields.rb', line 59

def apply_post_processed_defaults
  post_processed_defaults.each do |name|
    apply_default(name)
  end
end

model.apply_pre_processed_defaults

45
46
47
48
49

# File 'lib/mongoid/fields.rb', line 45

def apply_pre_processed_defaults
  pre_processed_defaults.each do |name|
    apply_default(name)
  end
end

[attribute.object_id, attribute.hash]

122
123
124

# File 'lib/mongoid/fields.rb', line 122

def demongoized
  @demongoized ||= Hash.new{|hash, name| hash[name] = Hash.new}
end

model.using_object_ids?

104
105
106

# File 'lib/mongoid/fields.rb', line 104

def using_object_ids?
  self.class.using_object_ids?
end