123456789_123456789_123456789_123456789_123456789_

Module: PP::ObjectMixin

Do not use. This module is for internal use only.
Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
::Object
Defined in: lib/pp.rb

Instance Method Summary

Instance Method Details

#pretty_print(q)

A default pretty printing method for general objects. It calls #pretty_print_instance_variables to list instance variables.

If self has a customized (redefined) #inspect method, the result of self.inspect is used but it obviously has no line break hints.

This module provides predefined #pretty_print methods for some of the most commonly used built-in classes for convenience.

[ GitHub ] 

  


# File 'lib/pp.rb', line 281



def pretty_print(q)
  method_method = Object.instance_method(:method).bind(self)
  begin
    inspect_method = method_method.call(:inspect)
  rescue NameError
  end
  if inspect_method && inspect_method.owner != Kernel
    q.text self.inspect
  elsif !inspect_method && self.respond_to?(:inspect)
    q.text self.inspect
  else
    q.pp_object(self)
  end
end


  








  

    #pretty_print_cycle(q)  
  



  

    

A default pretty printing method for general objects that are detected as part of a cycle.


  



  [ GitHub ]


  

  


# File 'lib/pp.rb', line 298



def pretty_print_cycle(q)
  q.object_address_group(self) {
    q.breakable
    q.text '...'
  }
end


  








  

    #pretty_print_inspect  
  



  

    

Is #inspect implementation using #pretty_print. If you implement #pretty_print, it can be used as follows.



alias inspect pretty_print_inspect



However, doing this requires that every class that #inspect is called on implement #pretty_print, or a RuntimeError will be raised.


  



  [ GitHub ]


  

  


# File 'lib/pp.rb', line 320



def pretty_print_inspect
  if Object.instance_method(:method).bind(self).call(:pretty_print).owner == PP::ObjectMixin
    raise "pretty_print is not overridden for #{self.class}"
  end
  PP.singleline_pp(self, ''.dup)
end


  








  

    #pretty_print_instance_variables  
  



  

    

Returns a sorted array of instance variable names.



This method should return an array of names of instance variables as symbols or strings as: [:@a, :@b].


  



  [ GitHub ]


  

  


# File 'lib/pp.rb', line 309



def pretty_print_instance_variables
  instance_variables.sort
end