module Mongoid::Extensions::Array
Adds type-casting behavior to Array
class.
Public Instance Methods
Evolve the array into an array of object ids.
@example Evolve the array to object ids.
[ id ].__evolve_object_id__
@return [ Array
<BSON::ObjectId> ] The converted array.
# File lib/mongoid/extensions/array.rb, line 15 def __evolve_object_id__ map!(&:__evolve_object_id__) self end
Get the array of args as arguments for a find query.
@example Get the array as find args.
[ 1, 2, 3 ].__find_args__
@return [ Array
] The array of args. @deprecated
# File lib/mongoid/extensions/array.rb, line 27 def __find_args__ flat_map{ |a| a.__find_args__ }.uniq{ |a| a.to_s } end
Mongoize the array into an array of object ids.
@example Evolve the array to object ids.
[ id ].__mongoize_object_id__
@return [ Array
<BSON::ObjectId> ] The converted array.
# File lib/mongoid/extensions/array.rb, line 38 def __mongoize_object_id__ map!(&:__mongoize_object_id__).compact! self end
Converts the array for storing as a time.
@note Returns a local time in the default time zone.
@example Convert the array to a time.
[ 2010, 1, 1 ].__mongoize_time__ # => 2010-01-01 00:00:00 -0500
@return [ Time
| ActiveSupport::TimeWithZone ] Local time in the
configured default time zone corresponding to date/time components in this array.
# File lib/mongoid/extensions/array.rb, line 54 def __mongoize_time__ ::Time.zone.local(*self) end
Delete the first object in the array that is equal to the supplied object and return it. This is much faster than performing a standard delete for large arrays since it does not perform multiple deletes.
@example Delete the first object.
[ "1", "2", "1" ].delete_one("1")
@param [ Object
] object The object to delete.
@return [ Object
] The deleted object.
# File lib/mongoid/extensions/array.rb, line 91 def delete_one(object) position = index(object) position ? delete_at(position) : nil end
Turn the object from the ruby type we deal with to a Mongo friendly type.
@example Mongoize the object.
object.mongoize
@return [ Array
| nil ] The object or nil.
# File lib/mongoid/extensions/array.rb, line 77 def mongoize ::Array.mongoize(self) end
Is the array a set of multiple arguments in a method?
@example Is this multi args?
[ 1, 2, 3 ].multi_arged?
@return [ true | false ] If the array is multi args. @deprecated
# File lib/mongoid/extensions/array.rb, line 65 def multi_arged? !first.is_a?(Hash) && first.resizable? || size > 1 end
Returns whether the object’s size can be changed.
@example Is the object resizable?
object.resizable?
@return [ true ] true.
# File lib/mongoid/extensions/array.rb, line 102 def resizable? true end