Module: PP::ObjectMixin

Included in:
Object
Defined in:
lib/pp.rb

Instance Method Summary collapse

Instance Method Details

#pretty_print(q) ⇒ Object

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.



257
258
259
260
261
262
263
264
265
 
# File 'lib/pp.rb', line 257

def pretty_print(q)
  if /\(Kernel\)#/ !~ Object.instance_method(:method).bind(self).call(:inspect).inspect
    q.text self.inspect
  elsif /\(Kernel\)#/ !~ Object.instance_method(:method).bind(self).call(:to_s).inspect && instance_variables.empty?
    q.text self.to_s
  else
    q.pp_object(self)
  end
end

#pretty_print_cycle(q) ⇒ Object

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



269
270
271
272
273
274
 
# File 'lib/pp.rb', line 269

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

#pretty_print_inspect ⇒ Object

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.



291
292
293
294
295
296
 
# File 'lib/pp.rb', line 291

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 ⇒ Object

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



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

def pretty_print_instance_variables
  instance_variables.sort
end