123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Inspectable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
Composable, Document, GlobalDiscriminatorKeyAssignment::InvalidFieldHost
Defined in: lib/mongoid/inspectable.rb

Overview

Contains the behavior around inspecting documents via inspect.

Instance Method Summary

Instance Method Details

#inspect ⇒ String

Returns the class name plus its attributes. If using dynamic fields will include those as well.

Examples:

Inspect the document.

person.inspect

Returns:

  • (String) —

    A nice pretty string to look at.

[ GitHub ] 

  


# File 'lib/mongoid/inspectable.rb', line 16



def inspect
  inspection = []
  inspection.concat(inspect_fields).concat(inspect_dynamic_fields)
  "#<#{self.class.name} _id: #{_id}, #{inspection * ', '}>"
end


  








  

    #inspect_dynamic_fields  ⇒ String  (private)
  

  

    This method is for internal use only.
  



  

    

Get an array of inspected dynamic fields for the document.


  





    

    
Examples:

        


Inspect the dynamic fields.



      
document.inspect_dynamic_fields

  


Returns:


    
  
  • 
    (String)
—    
    

    An array of pretty printed dynamic field values.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/inspectable.rb', line 80



def inspect_dynamic_fields
  []
end


  








  

    #inspect_fields  ⇒ String  (private)
  

  

    This method is for internal use only.
  



  

    

Get an array of inspected fields for the document.


  





    

    
Examples:

        


Inspect the defined fields.



      
document.inspect_fields

  


Returns:


    
  
  • 
    (String)
—    
    

    An array of pretty printed field values.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/inspectable.rb', line 63



def inspect_fields
  fields.map do |name, field|
    unless name == "_id"
      as = field.options[:as]
      "#{name}#{as ? "(#{as})" : nil}: #{@attributes[name].inspect}"
    end
  end.compact
end


  








  

    #pretty_print(pretty_printer)  
  

  

    This method is for internal use only.
  



  

    

This pretty prints the same information as the inspect method. This is meant to be called by the standard ‘pp’ library.


  





    

    
Examples:

        


Pretty print the document.



      
person.pretty_inspect

  


Parameters:


    
  
  • 
    pretty_printer
    (PP)
—    
    

    The pretty printer.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/mongoid/inspectable.rb', line 31



def pretty_print(pretty_printer)
  keys = fields.keys | attributes.keys
  pretty_printer.group(1, "#<#{self.class.name}", '>') do
    sep = lambda { pretty_printer.text(',') }
    pretty_printer.seplist(keys, sep) do |key|
      pretty_printer.breakable
      field = fields[key]
      as = "(#{field.options[:as]})" if field && field.options[:as]
      pretty_printer.text("#{key}#{as}")
      pretty_printer.text(':')
      pretty_printer.group(1) do
        pretty_printer.breakable
        if key == "_id"
          pretty_printer.text(_id.to_s)
        else
          pretty_printer.pp(@attributes[key])
        end
      end
    end
  end
end