In Files

  • pp.rb

PP::ObjectMixin

Public Instance Methods

pretty_print(q) click to toggle source

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.

 
               # File pp.rb, line 285
def pretty_print(q)
  method_method = Object.instance_method(:method).bind(self)
  begin
    inspect_method = method_method.call(:inspect)
  rescue NameError
  end
  begin
    to_s_method = method_method.call(:to_s)
  rescue NameError
  end
  if inspect_method && /\(Kernel\)#/ !~ inspect_method.inspect
    q.text self.inspect
  elsif !inspect_method && self.respond_to?(:inspect)
    q.text self.inspect
  elsif to_s_method && /\(Kernel\)#/ !~ to_s_method.inspect &&
        instance_variables.empty?
    q.text self.to_s
  elsif !to_s_method && self.respond_to?(:to_s)
    q.text self.to_s
  else
    q.pp_object(self)
  end
end
            
pretty_print_cycle(q) click to toggle source

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

 
               # File pp.rb, line 311
def pretty_print_cycle(q)
  q.object_address_group(self) {
    q.breakable
    q.text '...'
  }
end
            
pretty_print_inspect() click to toggle source

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.

 
               # File pp.rb, line 333
def pretty_print_inspect
  if /\(PP::ObjectMixin\)#/ =~ Object.instance_method(:method).bind(self).call(:pretty_print).inspect
    raise "pretty_print is not overridden for #{self.class}"
  end
  PP.singleline_pp(self, '')
end
            
pretty_print_instance_variables() click to toggle source

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]+.

 
               # File pp.rb, line 322
def pretty_print_instance_variables
  instance_variables.sort
end