colorful_inspect 0.0.1

data/README.md

@@ -0,0 +1,121 @@
+# What is it?
+
+PP is a library from stdlib that allows to print objects with a nice formatting,
+using PrettyPrint from stdlib. It is quite easy to customize it.
+
+AwesomePrint is a gem to print objects using fancy colors. The output is nice,
+but it's not as extensible as PP/PrettyPrint and it monkey patches several
+classes from core (e.g. Object#methods, String to add colors, …). It also won't
+use the pretty_print methods from classes that implement it.
+
+ColorfulInspect is only changing the pretty_print method from several classes to
+add colored formatting.
+
+# Installation
+
+    gem install colorful_inspect
+
+# Example
+
+Just require it and use pp as usual:
+
+    require 'colorful_inspect'
+
+    Person = Struct.new :first_name, :last_name
+
+    pp [
+        1, 2, true, 3, false, 4, nil, Rational(3, 4), 10 ** 50, Complex(3, 2),
+        [], {},
+        {
+          :alpha => "foo",
+          :beta  => "bar",
+          :delta => "baz",
+          [1, 3] => "some\nthing"
+        },
+        Date.new(2011, 10, 24),
+        Time.now,
+        String, Array, BasicObject, Enumerable,
+        Array.instance_method(:each), 3.method(:succ), "foo".method(:pp),
+        Person.new("John", "Smith"),
+        $stdout, $stdin,
+        LoadError.new("could not find a good message"),
+        PrettyPrint.new
+      ]
+
+And here's the output (without the colors):
+
+    [
+      [ 0] 1,
+      [ 1] 2,
+      [ 2] true,
+      [ 3] 3,
+      [ 4] false,
+      [ 5] 4,
+      [ 6] nil,
+      [ 7] (3/4) ≈ 0.75,
+      [ 8] 100000000000000000000000000000000000000000000000000,
+      [ 9] 3+2i,
+      [10] [],
+      [11] {},
+      [12] {
+        :alpha => "foo",
+        :beta => "bar",
+        :delta => "baz",
+        [
+          [0] 1,
+          [1] 3
+        ] => "some\nthing"
+      },
+      [13] Mon Oct 24 00:00:00 2011,
+      [14] Fri Jun 10 01:43:18 2011,
+      [15] String < Object,
+      [16] Array < Object,
+      [17] BasicObject,
+      [18] Enumerable,
+      [19] Array#each() [unbound],
+      [20] Fixnum#succ(),
+      [21] Kernel#pp(*objs),
+      [22] (Person < Struct) {
+        :first_name => "John",
+        :last_name => "Smith"
+      },
+      [23] #<IO:<STDOUT>>,
+      [24] #<IO:<STDIN>>,
+      [25] LoadError < ScriptError: could not find a good message,
+      [26] #<PrettyPrint:0x1b1db58
+        @buffer=[],
+        @buffer_width=0,
+        @genspace=
+          #<Proc:0x00000001b1dab8@/usr/lib/ruby/1.9.1/prettyprint.rb:82 (lambda)>,
+        @group_queue=
+          #<PrettyPrint::GroupQueue:0x1b1d9f0
+            @queue=
+              [
+                [0] [
+                  [0] #<PrettyPrint::Group:0x1b1da68
+                    @break=false,
+                    @breakables=[],
+                    @depth=0>
+                ]
+              ]>,
+        @group_stack=
+          [
+            [0] #<PrettyPrint::Group:0x1b1da68
+              @break=false,
+              @breakables=[],
+              @depth=0>
+          ],
+        @indent=0,
+        @maxwidth=79,
+        @newline="\n",
+        @output="",
+        @output_width=0>
+    ]
+
+
+You can change the indentation as well as the used colors:
+
+    ColorfulInspect.indent = 4 # defaults to two
+
+    # pp ColorfulInspect.colors to see available colors :)
+    ColorfulInspect.colors[:nil] = :red

data/Rakefile

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+require 'jeweler'
+
+Jeweler::Tasks.new do |s|
+  s.name = "colorful_inspect"
+
+  s.summary     = "A small library to print objects with colors"
+  s.description = s.summary
+  s.homepage    = "http://github.com/Mon-Ouie/colorful_inspect"
+
+  s.email   = "mon.ouie@gmail.com"
+  s.authors = ["Mon ouïe"]
+
+  s.files = ["Rakefile", "README.md", "lib/colorful_inspect.rb"]
+
+  s.add_dependency "term-ansicolor"
+  s.add_development_dependency "jeweler"
+end

data/lib/colorful_inspect.rb

@@ -0,0 +1,318 @@
+# -*- coding: utf-8 -*-
+
+require 'pp'
+require 'date'
+require 'time'
+require 'term/ansicolor'
+
+module ColorfulInspect
+  class << self
+    attr_accessor :indent
+    attr_accessor :colors
+  end
+
+  self.indent = 2
+
+  self.colors = {
+    :numeric   => [:blue, :bold],
+    :bignum    => [:blue],
+    :fixnum    => [:blue, :bold],
+    :float     => [:blue, :bold],
+    :rational  => [:blue],
+    :true      => [:green, :bold],
+    :false     => [:red, :bold],
+    :nil       => [:red],
+    :symbol    => [:cyan, :bold],
+    :string    => [:green],
+    :date      => [:black],
+    :time      => [:black, :bold],
+    :class     => [:yellow, :bold],
+    :module    => [:yellow],
+    :method    => [:magenta],
+    :exception => [:red],
+    :ivar      => [:cyan]
+  }
+
+  module_function
+  def group(q, open, close, &block)
+    q.group(ColorfulInspect.indent, open, "\n#{q.genspace[q.indent]}#{close}",
+            &block)
+  end
+
+  def break(q)
+    q.breakable ''
+  end
+
+  def colorize(q, type, string)
+    Array(ColorfulInspect.colors[type]).inject(string) do |str, msg|
+      Term::ANSIColor.send(msg, str)
+    end
+  end
+
+  def method_info(method)
+    args = ''
+
+    if method.respond_to?(:parameters) && (arg_ary = method.parameters)
+      arg_ary.map!.each_with_index do |(type, name), index|
+        name ||= "arg#{index + 1}"
+
+        case type
+        when :req   then "#{name}"
+        when :opt   then "#{name} = ?"
+        when :rest  then "*#{name}"
+        when :block then "&#{name}"
+        else name
+        end
+      end
+
+      args = '(' + arg_ary.join(', ') + ')'
+    elsif method.arity == 0
+      args = "()"
+    elsif method.arity > 0
+      n = method.arity
+      args = '(' + (1..n).map { |i| "arg#{i}" }.join(", ") + ')'
+    elsif method.arity < 0
+      n = -method.arity
+      args = '(' + (1..n).map { |i| "arg#{i}" }.join(", ") + ')'
+    end
+
+    klass = if method.respond_to? :owner
+              method.owner.name
+            elsif method.inspect =~ /Method: (.*?)#/
+              $1
+            end
+
+    location = if method.respond_to? :source_location
+                 file, line = method.source_location
+                 "#{file}:#{line}" if file && line
+               end
+
+    [method.name.to_s, args, klass.to_s, location]
+  end
+end
+
+class Array
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    return q.text("[]") if empty?
+
+    ColorfulInspect.group(q, "[", "]") do
+      index_width = (size - 1).to_s.size
+
+      each_with_index do |elem, n|
+        q.breakable ''
+        q.text "[#{n.to_s.rjust(index_width)}] "
+        q.pp elem
+        q.text "," if n != size - 1
+      end
+    end
+  end
+end
+
+class Hash
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    return q.text("{}") if empty?
+
+    ColorfulInspect.group(q, "{", "}") do
+      each_with_index do |(key, val), n|
+        q.breakable ''
+        q.pp key
+        q.text " => "
+        q.pp val
+        q.text "," if n != size - 1
+      end
+    end
+  end
+end
+
+[Numeric, Bignum, Fixnum, Float].each do |klass|
+  type = klass.to_s.downcase.to_sym
+
+  klass.class_eval do
+    alias colorless_pretty_print pretty_print
+
+    define_method :pretty_print do |q|
+      q.text ColorfulInspect.colorize(q, type, to_s)
+    end
+  end
+end
+
+class Rational
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    q.text ColorfulInspect.colorize(q, :rational, "#{inspect} ≈ #{to_f}")
+  end
+end
+
+[true, false, nil].each do |obj|
+  obj.class.class_eval do
+    alias colorless_pretty_print pretty_print
+
+    def pretty_print(q)
+      q.text ColorfulInspect.colorize(q, inspect.to_sym, inspect)
+    end
+  end
+end
+
+class Symbol
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    q.text ColorfulInspect.colorize(q, :symbol, inspect)
+  end
+end
+
+class String
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    q.text ColorfulInspect.colorize(q, :string, inspect)
+  end
+end
+
+[Date, Time].each do |klass|
+  type = klass.to_s.downcase.to_sym
+
+  klass.class_eval do
+    alias colorless_pretty_print pretty_print
+
+    define_method :pretty_print do |q|
+      q.text ColorfulInspect.colorize(q, type, ctime)
+    end
+  end
+end
+
+class Time
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    q.text ColorfulInspect.colorize(q, :time, ctime)
+  end
+end
+
+class Class
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    str = "#{inspect}#{" < #{superclass.inspect}" if superclass}"
+    q.text ColorfulInspect.colorize(q, :class, str)
+  end
+end
+
+class Module
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    q.text ColorfulInspect.colorize(q, :module, inspect)
+  end
+end
+
+[Method, UnboundMethod].each do |klass|
+  klass.class_eval do
+    alias colorless_pretty_print pretty_print
+
+    public
+    def pretty_print(q)
+      name, args, owner = ColorfulInspect.method_info(self)
+
+      q.text ColorfulInspect.colorize(q, :class, owner)
+      q.text '#'
+      q.text ColorfulInspect.colorize(q, :method, name)
+      q.text ColorfulInspect.colorize(q, :args, args)
+
+      q.text " [unbound]" if kind_of? UnboundMethod
+    end
+  end
+end
+
+class Struct
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    q.text '('
+    q.pp self.class
+    q.text ") "
+
+    ColorfulInspect.group(q, "{", "}") do
+      each_pair.with_index do |(key, val), n|
+        q.breakable ''
+        q.pp key
+        q.text " => "
+        q.pp val
+        q.text "," if n != size - 1
+      end
+    end
+  end
+end
+
+class Exception
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    q.pp self.class
+    q.text ": "
+    q.text ColorfulInspect.colorize(q, :exception, message)
+  end
+end
+
+class Object
+  alias colorless_pretty_print pretty_print
+
+  def pretty_print(q)
+    # Check from pp.rb
+    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
+      id = "%x" % (__id__ * 2)
+      id.sub!(/\Af(?=[[:xdigit:]]{2}+\z)/, '') if id.sub!(/\A\.\./, '')
+
+      klass = ColorfulInspect.colorize(q, :class, self.class.to_s)
+
+      q.group(ColorfulInspect.indent, "\#<#{klass}:0x#{id}", '>') do
+        q.seplist(pretty_print_instance_variables, lambda { q.text ',' }) do |ivar|
+          q.breakable
+
+          q.text ColorfulInspect.colorize(q, :ivar, ivar.to_s)
+          q.text '='
+
+          q.group(ColorfulInspect.indent) do
+            q.breakable ''
+            q.pp instance_variable_get(ivar)
+          end
+        end
+      end
+    end
+  end
+end
+
+if $PROGRAM_NAME == __FILE__
+  # There is but one test to see if this works: see if the output is pretty.
+
+  Person = Struct.new :first_name, :last_name
+
+  pp [
+      1, 2, true, 3, false, 4, nil, Rational(3, 4), 10 ** 50, Complex(3, 2),
+      [], {},
+      {
+        :alpha => "foo",
+        :beta  => "bar",
+        :delta => "baz",
+        [1, 3] => "some\nthing"
+      },
+      Date.new(2011, 10, 24),
+      Time.now,
+      String, Array, BasicObject, Enumerable,
+      Array.instance_method(:each), 3.method(:succ), "foo".method(:pp),
+      Person.new("John", "Smith"),
+      $stdout, $stdin,
+      LoadError.new("could not find a good message"),
+      PrettyPrint.new
+    ]
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: colorful_inspect
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Mon ou\xC3\xAFe"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A small library to print objects with colors
+email: mon.ouie@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- lib/colorful_inspect.rb
+homepage: http://github.com/Mon-Ouie/colorful_inspect
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A small library to print objects with colors
+test_files: []
+