123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Persistable::Maxable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
::Mongoid::Composable, ::Mongoid::Document, ::Mongoid::GlobalDiscriminatorKeyAssignment::InvalidFieldHost, ::Mongoid::Persistable
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ActiveSupport::Concern
Defined in: lib/mongoid/persistable/maxable.rb

Overview

Defines behavior for setting a field (or fields) to the larger of either it’s current value, or a given value.

Instance Method Summary

Instance Method Details

#clamp_lower_bound(fields)

Alias for #set_max.

[ GitHub ] 

  


# File 'lib/mongoid/persistable/maxable.rb', line 34



alias :clamp_lower_bound :set_max


  








  

    #set_max(fields)  ⇒ Document 
    Also known as: #clamp_lower_bound
  



  

    

::Set the given field or fields to the larger of either it’s current value, or a given value.


  





    

    
Examples:

        


::Set a field to be no less than 100.



      
document.set_max(field: 100)

  


Parameters:


    
  
  • 
    fields
    (Hash<Symbol | String, Comparable>)
—    
    

    The fields to set, with corresponding minimum values.
    

    
  
    • 



Returns:





  [ GitHub ]


  

  


# File 'lib/mongoid/persistable/maxable.rb', line 22



def set_max(fields)
  prepare_atomic_operation do |ops|
    process_atomic_operations(fields) do |field, value|
      current_value = attributes[field]
      if value > current_value
        process_attribute field, value
        ops[atomic_attribute_name(field)] = value
      end
    end
    { "$max" => ops } unless ops.empty?
  end
end