Module: PP::ObjectMixin
- Included in:
- Object
- Defined in:
- opal/stdlib/pp.rb
Overview
:nodoc:
Instance Method Summary collapse
-
#pretty_print(q) ⇒ Object
A default pretty printing method for general objects.
-
#pretty_print_cycle(q) ⇒ Object
A default pretty printing method for general objects that are detected as part of a cycle.
-
#pretty_print_inspect ⇒ Object
Is #inspect implementation using #pretty_print.
-
#pretty_print_instance_variables ⇒ Object
Returns a sorted array of instance variable names.
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.
302 303 304 305 306 307 308 309 310 311 312 313 314 315
# File 'opal/stdlib/pp.rb', line 302 def pretty_print(q) umethod_method = Object .instance_method(:method) begin inspect_method = umethod_method.bind_call(self, :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) ⇒ Object
A default pretty printing method for general objects that are detected as part of a cycle.
319 320 321 322 323 324
# File 'opal/stdlib/pp.rb', line 319 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.
341 342 343 344 345 346
# File 'opal/stdlib/pp.rb', line 341 def pretty_print_inspect if Object .instance_method(:method).bind_call(self, :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 ⇒ 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]+.
330 331 332
# File 'opal/stdlib/pp.rb', line 330 def pretty_print_instance_variables instance_variables.sort end