module Mongoid::Contextual::Aggregable::Memory
Contains behavior for aggregating values in memory.
Public Instance Methods
Get the average value of the provided field.
@example Get the average of a single field.
aggregable.avg(:likes)
@param [ Symbol ] field The field to average.
@return [ Float ] The average.
@since 3.0.0
# File lib/mongoid/contextual/aggregable/memory.rb, line 20 def avg(field) count > 0 ? sum(field).to_f / count.to_f : nil end
Get the max value of the provided field. If provided a block, will return the Document
with the greatest value for the field, in accordance with Ruby’s enumerable API.
@example Get the max of a single field.
aggregable.max(:likes)
@example Get the document with the max value.
aggregable.max do |a, b| a.likes <=> b.likes end
@param [ Symbol ] field The field to max.
@return [ Float, Document
] The max value or document with the max
value.
@since 3.0.0
# File lib/mongoid/contextual/aggregable/memory.rb, line 42 def max(field = nil) block_given? ? super() : aggregate_by(field, :max_by) end
Get the min value of the provided field. If provided a block, will return the Document
with the smallest value for the field, in accordance with Ruby’s enumerable API.
@example Get the min of a single field.
aggregable.min(:likes)
@example Get the document with the min value.
aggregable.min do |a, b| a.likes <=> b.likes end
@param [ Symbol ] field The field to min.
@return [ Float, Document
] The min value or document with the min
value.
@since 3.0.0
# File lib/mongoid/contextual/aggregable/memory.rb, line 64 def min(field = nil) block_given? ? super() : aggregate_by(field, :min_by) end
Get the sum value of the provided field. If provided a block, will return the sum in accordance with Ruby’s enumerable API.
@example Get the sum of a single field.
aggregable.sum(:likes)
@example Get the sum for the provided block.
aggregable.sum(&:likes)
@param [ Symbol ] field The field to sum.
@return [ Float ] The sum value.
@since 3.0.0
# File lib/mongoid/contextual/aggregable/memory.rb, line 82 def sum(field = nil) if block_given? super() else count > 0 ? super(0) { |doc| doc.public_send(field) } : 0 end end
Private Instance Methods
Aggregate by the provided field and method.
@api private
@example Aggregate by the field and method.
aggregable.aggregate_by(:name, :min_by)
@param [ Symbol ] field The field to aggregate on. @param [ Symbol ] method The method (min_by or max_by).
@return [ Integer ] The aggregate.
@since 3.0.0
# File lib/mongoid/contextual/aggregable/memory.rb, line 105 def aggregate_by(field, method) count > 0 ? send(method) { |doc| doc.public_send(field) }.public_send(field) : nil end