Module: PP::ObjectMixin

Module | PP::ObjectMixin
In: | pp.rb

### Methods

pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables

### Public Instance methods

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.

[Source]

    # File pp.rb, line 243
        def pretty_print(q)
          if /\(Kernel\)#/ !~ method(:inspect).inspect
            q.text self.inspect
          elsif /\(Kernel\)#/ !~ method(:to_s).inspect && instance_variables.empty?
            q.text self.to_s
          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.

[Source]

    # File pp.rb, line 255
        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.

[Source]

    # File pp.rb, line 277
        def pretty_print_inspect
          if /\(PP::ObjectMixin\)#/ =~ method(:pretty_print).inspect
            raise "pretty_print is not overridden."
          end
          PP.singleline_pp(self, '')
        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]+.

[Source]

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

[Validate]