Module: Mongoid::Extensions::Object
- Defined in:
- build/mongoid-7.3/lib/mongoid/extensions/object.rb
Defined Under Namespace
Modules: ClassMethods
Instance Method Summary collapse
-
#__evolve_object_id__ ⇒ Object
(also: #__mongoize_object_id__)
Evolve a plain object into an object id.
-
#__find_args__ ⇒ Object
Convert the object to args for a find query.
- #__mongoize_time__ ⇒ Object deprecated Deprecated.
-
#__setter__ ⇒ String
Try to form a setter from this object.
-
#__sortable__ ⇒ Object
Get the value of the object as a mongo friendy sort value.
-
#__to_inc__ ⇒ Object
Conversion of an object to an $inc-able value.
- #blank_criteria? ⇒ false deprecated Deprecated.
-
#do_or_do_not(name, *args) ⇒ Object?
Do or do not, there is no try.
-
#ivar(name) ⇒ Object, false
Get the value for an instance variable or false if it doesn’t exist.
-
#mongoize ⇒ Object
Turn the object from the ruby type we deal with to a Mongo friendly type.
-
#multi_arged? ⇒ false
Is the object multi args.
-
#numeric? ⇒ false
Is the object a number?.
-
#remove_ivar(name) ⇒ true, false
Remove the instance variable for the provided name.
-
#resizable? ⇒ false
Is the object’s size changable? Only returns true for arrays and hashes currently.
-
#substitutable ⇒ Object
Get the substitutable version of an object.
-
#you_must(name, *args) ⇒ Object?
You must unlearn what you have learned.
Instance Method Details
#__evolve_object_id__ ⇒ Object Also known as: __mongoize_object_id__
Evolve a plain object into an object id.
16 17 18 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 16 def __evolve_object_id__ self end |
#__find_args__ ⇒ Object
Convert the object to args for a find query.
29 30 31 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 29 def __find_args__ self end |
#__mongoize_time__ ⇒ Object
This method should not be used, because it does not return correct results for non-Time objects. Override mongoize_time in classes that are time-like to return an instance of Time or ActiveSupport::TimeWithZone.
Mongoize a plain object into a time.
47 48 49 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 47 def __mongoize_time__ self end |
#__setter__ ⇒ String
Try to form a setter from this object.
59 60 61 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 59 def __setter__ "#{self}=" end |
#__sortable__ ⇒ Object
Get the value of the object as a mongo friendy sort value.
71 72 73 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 71 def __sortable__ self end |
#__to_inc__ ⇒ Object
Conversion of an object to an $inc-able value.
83 84 85 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 83 def __to_inc__ self end |
#blank_criteria? ⇒ false
Checks whether conditions given in this object are known to be unsatisfiable, i.e., querying with this object will always return no documents.
This method is deprecated. Mongoid now uses _mongoid_unsatisfiable_criteria?
internally; this method is retained for backwards compatibility only. It always returns false.
99 100 101 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 99 def blank_criteria? false end |
#do_or_do_not(name, *args) ⇒ Object?
Do or do not, there is no try. – Yoda.
115 116 117 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 115 def do_or_do_not(name, *args) send(name, *args) if name && respond_to?(name) end |
#ivar(name) ⇒ Object, false
Get the value for an instance variable or false if it doesn’t exist.
129 130 131 132 133 134 135 136 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 129 def ivar(name) var_name = "@_#{name}" if instance_variable_defined?(var_name) return instance_variable_get(var_name) else false end end |
#mongoize ⇒ Object
Turn the object from the ruby type we deal with to a Mongo friendly type.
147 148 149 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 147 def mongoize self end |
#multi_arged? ⇒ false
Is the object multi args.
159 160 161 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 159 def multi_arged? false end |
#numeric? ⇒ false
Is the object a number?
171 172 173 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 171 def numeric? false end |
#remove_ivar(name) ⇒ true, false
Remove the instance variable for the provided name.
185 186 187 188 189 190 191 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 185 def remove_ivar(name) if instance_variable_defined?("@_#{name}") return remove_instance_variable("@_#{name}") else false end end |
#resizable? ⇒ false
Is the object’s size changable? Only returns true for arrays and hashes currently.
202 203 204 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 202 def resizable? false end |
#substitutable ⇒ Object
Get the substitutable version of an object.
214 215 216 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 214 def substitutable self end |
#you_must(name, *args) ⇒ Object?
You must unlearn what you have learned. – Yoda
230 231 232 |
# File 'build/mongoid-7.3/lib/mongoid/extensions/object.rb', line 230 def you_must(name, *args) frozen? ? nil : do_or_do_not(name, *args) end |