123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Extensions::BigDecimal

Relationships & Source Files
Namespace Children
Modules:
ClassMethods
Defined in: lib/mongoid/extensions/big_decimal.rb

Overview

Adds type-casting behavior to BigDecimal class.

Class Method Summary

  • .included(base) Internal use only Internal use only

    Behavior to be invoked when the module is included.

Instance Attribute Summary

Instance Method Summary

Class Method Details

.included(base)

This method is for internal use only.

Behavior to be invoked when the module is included.

Parameters:

  • base (Module) —

    the class or module doing the including

[ GitHub ] 

  


# File 'lib/mongoid/extensions/big_decimal.rb', line 13



def self.included(base)
  base.extend(ClassMethods)
end


  







Instance Attribute Details



  

    #numeric?  ⇒ true  (readonly)
  



  

    

Is the BigDecimal a number?


  





    

    
Examples:

        


Is the object a number?.



      
object.numeric?

  


Returns:


    
  
  • 
    (true)
—    
    

    Always true.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/extensions/big_decimal.rb', line 46



def numeric?
  true
end


  







Instance Method Details



  

    #__to_inc__  ⇒ Float 
  



  

    
Deprecated. 



Convert the big decimal to an $inc-able value.


  





    

    
Examples:

        


Convert the big decimal.



      
bd.__to_inc__

  


Returns:


    
  
  • 
    (Float)
—    
    

    The big decimal as a float.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/extensions/big_decimal.rb', line 24



def __to_inc__
  to_f
end


  








  

    #mongoize  ⇒ String | BSON::Decimal128 | nil 
  



  

    

Turn the object from the ruby type we deal with to a Mongo friendly type.


  





    

    
Examples:

        


Mongoize the object.



      
object.mongoize

  


Returns:





  [ GitHub ]


  

  


# File 'lib/mongoid/extensions/big_decimal.rb', line 36



def mongoize
  ::BigDecimal.mongoize(self)
end