module Mongoid::Extensions::Array
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.
@since 3.0.0
# File lib/mongoid/extensions/array.rb, line 13 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.
@since 3.0.0
# File lib/mongoid/extensions/array.rb, line 26 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.
@since 3.0.0
# 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.
@example Convert the array to a time.
[ 2010, 1, 1 ].__mongoize_time__
@return [ Time ] The time.
@since 3.0.0
# File lib/mongoid/extensions/array.rb, line 51 def __mongoize_time__ ::Time.configured.local(*self) end
Check if the array is part of a blank relation criteria.
@example Is the array blank criteria?
[].blank_criteria?
@return [ true, false ] If the array is blank criteria.
@since 3.1.0
# File lib/mongoid/extensions/array.rb, line 63 def blank_criteria? any?(&:blank_criteria?) 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 ince it attempt to delete multiple in the other.
@example Delete the first object.
[ "1", "2", "1" ].delete_one("1")
@param [ Object ] object The object to delete.
@return [ Object ] The deleted object.
@since 2.1.0
# File lib/mongoid/extensions/array.rb, line 105 def delete_one(object) position = index(object) position ? delete_at(position) : nil 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.
@since 3.0.0
# File lib/mongoid/extensions/array.rb, line 75 def multi_arged? !first.is_a?(Hash) && first.resizable? || size > 1 end
Is the object's size changable?
@example Is the object resizable?
object.resizable?
@return [ true ] true.
@since 3.0.0
# File lib/mongoid/extensions/array.rb, line 118 def resizable? true end