awesome_print 0.4.0 → 1.0.0

data/lib/awesome_print/inspector.rb

@@ -0,0 +1,140 @@
+# Copyright (c) 2010-2011 Michael Dvorkin
+#
+# Awesome Print is freely distributable under the terms of MIT license.
+# See LICENSE file or http://www.opensource.org/licenses/mit-license.php
+#------------------------------------------------------------------------------
+module AwesomePrint
+
+  class << self # Class accessors for custom defaults.
+    attr_accessor :defaults, :force_colors
+
+    # Class accessor to force colorized output (ex. forked subprocess where TERM
+    # might be dumb).
+    #------------------------------------------------------------------------------
+    def force_colors!(value = true)
+      @force_colors = value
+    end
+  end
+
+  class Inspector
+    attr_accessor :options
+
+    AP = :__awesome_print__
+
+    def initialize(options = {})
+      @options = { 
+        :indent     => 4,      # Indent using 4 spaces.
+        :index      => true,   # Display array indices.
+        :html       => false,  # Use ANSI color codes rather than HTML.
+        :multiline  => true,   # Display in multiple lines.
+        :plain      => false,  # Use colors.
+        :sort_keys  => false,  # Do not sort hash keys.
+        :limit      => false,  # Limit large output for arrays and hashes. Set to a boolean or integer.
+        :color => { 
+          :args       => :pale,
+          :array      => :white,
+          :bigdecimal => :blue,
+          :class      => :yellow,
+          :date       => :greenish,
+          :falseclass => :red,
+          :fixnum     => :blue,
+          :float      => :blue,
+          :hash       => :pale,
+          :keyword    => :cyan,
+          :method     => :purpleish,
+          :nilclass   => :red,
+          :string     => :yellowish,
+          :struct     => :pale,
+          :symbol     => :cyanish,
+          :time       => :greenish,
+          :trueclass  => :green,
+          :variable   => :cyanish
+        }
+      }
+
+      # Merge custom defaults and let explicit options parameter override them.
+      merge_custom_defaults!
+      merge_options!(options)
+
+      @formatter = AwesomePrint::Formatter.new(self)
+      Thread.current[AP] ||= []
+    end
+  
+    # Dispatcher that detects data nesting and invokes object-aware formatter.
+    #------------------------------------------------------------------------------
+    def awesome(object)
+      if Thread.current[AP].include?(object.object_id)
+        nested(object)
+      else
+        begin
+          Thread.current[AP] << object.object_id
+          unnested(object)
+        ensure
+          Thread.current[AP].pop
+        end
+      end
+    end
+
+    # Return true if we are to colorize the output.
+    #------------------------------------------------------------------------------
+    def colorize?
+      AwesomePrint.force_colors ||= false
+      AwesomePrint.force_colors || (STDOUT.tty? && ((ENV['TERM'] && ENV['TERM'] != 'dumb') || ENV['ANSICON']))
+    end
+
+    private
+
+    # Format nested data, for example:
+    #   arr = [1, 2]; arr << arr
+    #   => [1,2, [...]]
+    #   hash = { :a => 1 }; hash[:b] = hash
+    #   => { :a => 1, :b => {...} }
+    #------------------------------------------------------------------------------
+    def nested(object)
+      case printable(object)
+        when :array  then @formatter.colorize("[...]", :array)
+        when :hash   then @formatter.colorize("{...}", :hash)
+        when :struct then @formatter.colorize("{...}", :struct)
+        else @formatter.colorize("...#{object.class}...", :class)
+      end
+    end
+
+    #------------------------------------------------------------------------------
+    def unnested(object)
+      @formatter.format(object, printable(object))
+    end
+
+    # Turn class name into symbol, ex: Hello::World => :hello_world. Classes that
+    # inherit from Array, Hash, File, Dir, and Struct are treated as the base class.
+    #------------------------------------------------------------------------------
+    def printable(object)
+      case object
+      when Array  then :array
+      when Hash   then :hash
+      when File   then :file
+      when Dir    then :dir
+      when Struct then :struct
+      else object.class.to_s.gsub(/:+/, "_").downcase.to_sym
+      end
+    end
+
+    # Update @options by first merging the :color hash and then the remaining keys.
+    #------------------------------------------------------------------------------
+    def merge_options!(options = {})
+      @options[:color].merge!(options.delete(:color) || {})
+      @options.merge!(options)
+    end
+
+    # Load ~/.aprc file with custom defaults that override default options.
+    #------------------------------------------------------------------------------
+    def merge_custom_defaults!
+      dotfile = File.join(ENV["HOME"], ".aprc")
+      if File.readable?(dotfile)
+        load dotfile
+        merge_options!(AwesomePrint.defaults)
+      end
+    rescue => e
+      $stderr.puts "Could not load #{dotfile}: #{e}"
+    end
+  end
+end

data/{rails/init.rb → lib/awesome_print/version.rb}

@@ -3,7 +3,8 @@
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
-#
-# Load awesome_print when installed as Rails 2.3.x plugin.
-#
-require File.join(File.dirname(__FILE__), "..", "init") unless defined?(AwesomePrint)
+module AwesomePrint
+  def self.version
+    '1.0.0'
+  end
+end

data/spec/colors_spec.rb

@@ -0,0 +1,106 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AwesomePrint" do
+  def stub_tty!(output = true, stream = STDOUT)
+    if output
+      stream.instance_eval { def tty?;  true; end }
+    else
+      stream.instance_eval { def tty?; false; end }
+    end
+  end
+
+  before do
+    stub_dotfile!
+  end
+
+  describe "colorization" do
+    PLAIN = '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
+    COLORIZED = "[ \e[1;34m1\e[0m, \e[0;36m:two\e[0m, \e[0;33m\"three\"\e[0m, [ \e[1;31mnil\e[0m, [ \e[1;32mtrue\e[0m, \e[1;31mfalse\e[0m ] ] ]"
+
+    before do
+      ENV['TERM'] = "xterm-colors"
+      ENV.delete('ANSICON')
+      @arr = [ 1, :two, "three", [ nil, [ true, false] ] ]
+    end
+
+    describe "default settings (no forced colors)" do
+      before do
+        AwesomePrint.force_colors! false
+      end
+
+      it "colorizes tty processes by default" do
+        stub_tty!
+        @arr.ai(:multiline => false).should == COLORIZED
+      end
+
+      it "colorizes processes with ENV['ANSICON'] by default" do
+        begin
+          stub_tty!
+          term, ENV['ANSICON'] = ENV['ANSICON'], "1"
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          ENV['ANSICON'] = term
+        end
+      end
+
+      it "does not colorize tty processes running in dumb terminals by default" do
+        begin
+          stub_tty!
+          term, ENV['TERM'] = ENV['TERM'], "dumb"
+          @arr.ai(:multiline => false).should == PLAIN
+        ensure
+          ENV['TERM'] = term
+        end
+      end
+
+      it "does not colorize subprocesses by default" do
+        begin
+          stub_tty! false
+          @arr.ai(:multiline => false).should == PLAIN
+        ensure
+          stub_tty!
+        end
+      end
+    end
+
+    describe "forced colors override" do
+      before do
+        AwesomePrint.force_colors!
+      end
+      
+      it "still colorizes tty processes" do
+        stub_tty!
+        @arr.ai(:multiline => false).should == COLORIZED
+      end
+
+      it "colorizes processes with ENV['ANSICON'] set to 0" do
+        begin
+          stub_tty!
+          term, ENV['ANSICON'] = ENV['ANSICON'], "1"
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          ENV['ANSICON'] = term
+        end
+      end
+      
+      it "colorizes dumb terminals" do
+        begin
+          stub_tty!
+          term, ENV['TERM'] = ENV['TERM'], "dumb"
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          ENV['TERM'] = term
+        end
+      end
+
+      it "colorizes subprocess" do
+        begin
+          stub_tty! false
+          @arr.ai(:multiline => false).should == COLORIZED
+        ensure
+          stub_tty!
+        end
+      end
+    end
+  end
+end

data/spec/{awesome_print_spec.rb → formats_spec.rb}

@@ -3,12 +3,12 @@ require "bigdecimal"
 require "rational"
 
 describe "AwesomePrint" do
-  before(:each) do
+  before do
     stub_dotfile!
   end
 
   describe "Array" do
-    before(:each) do
+    before do
       @arr = [ 1, :two, "three", [ nil, [ true, false] ] ]
     end
 
@@ -91,14 +91,14 @@ EOS
     it "colored multiline (default)" do
       @arr.ai.should == <<-EOS.strip
 [
-\e[1;37m    [0] \e[0m\e[1;34m1\e[0m,
-\e[1;37m    [1] \e[0m\e[0;36m:two\e[0m,
-\e[1;37m    [2] \e[0m\e[0;33m\"three\"\e[0m,
-\e[1;37m    [3] \e[0m[
-\e[1;37m        [0] \e[0m\e[1;31mnil\e[0m,
-\e[1;37m        [1] \e[0m[
-\e[1;37m            [0] \e[0m\e[1;32mtrue\e[0m,
-\e[1;37m            [1] \e[0m\e[1;31mfalse\e[0m
+    \e[1;37m[0] \e[0m\e[1;34m1\e[0m,
+    \e[1;37m[1] \e[0m\e[0;36m:two\e[0m,
+    \e[1;37m[2] \e[0m\e[0;33m\"three\"\e[0m,
+    \e[1;37m[3] \e[0m[
+        \e[1;37m[0] \e[0m\e[1;31mnil\e[0m,
+        \e[1;37m[1] \e[0m[
+            \e[1;37m[0] \e[0m\e[1;32mtrue\e[0m,
+            \e[1;37m[1] \e[0m\e[1;31mfalse\e[0m
         ]
     ]
 ]
@@ -108,14 +108,14 @@ EOS
     it "colored multiline indented" do
       @arr.ai(:indent => 8).should == <<-EOS.strip
 [
-\e[1;37m        [0] \e[0m\e[1;34m1\e[0m,
-\e[1;37m        [1] \e[0m\e[0;36m:two\e[0m,
-\e[1;37m        [2] \e[0m\e[0;33m\"three\"\e[0m,
-\e[1;37m        [3] \e[0m[
-\e[1;37m                [0] \e[0m\e[1;31mnil\e[0m,
-\e[1;37m                [1] \e[0m[
-\e[1;37m                        [0] \e[0m\e[1;32mtrue\e[0m,
-\e[1;37m                        [1] \e[0m\e[1;31mfalse\e[0m
+        \e[1;37m[0] \e[0m\e[1;34m1\e[0m,
+        \e[1;37m[1] \e[0m\e[0;36m:two\e[0m,
+        \e[1;37m[2] \e[0m\e[0;33m\"three\"\e[0m,
+        \e[1;37m[3] \e[0m[
+                \e[1;37m[0] \e[0m\e[1;31mnil\e[0m,
+                \e[1;37m[1] \e[0m[
+                        \e[1;37m[0] \e[0m\e[1;32mtrue\e[0m,
+                        \e[1;37m[1] \e[0m\e[1;31mfalse\e[0m
                 ]
         ]
 ]
@@ -129,7 +129,7 @@ EOS
 
   #------------------------------------------------------------------------------
   describe "Nested Array" do
-    before(:each) do
+    before do
       @arr = [ 1, 2 ]
       @arr << @arr
     end
@@ -160,8 +160,97 @@ EOS
   end
 
   #------------------------------------------------------------------------------
-  describe "Hash" do
+  describe "Limited Output Array" do
+    before(:each) do
+      @arr = (1..1000).to_a
+    end
+
+    it "plain limited output large" do
+      @arr.ai(:plain => true, :limit => true).should == <<-EOS.strip
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] 3,
+    [  3] .. [996],
+    [997] 998,
+    [998] 999,
+    [999] 1000
+]
+EOS
+    end
+
+    it "plain limited output small" do
+      @arr = @arr[0..3]
+      @arr.ai(:plain => true, :limit => true).should == <<-EOS.strip
+[
+    [0] 1,
+    [1] 2,
+    [2] 3,
+    [3] 4
+]
+EOS
+    end
+
+    it "plain limited output with 10 lines" do
+      @arr.ai(:plain => true, :limit => 10).should == <<-EOS.strip
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] 3,
+    [  3] 4,
+    [  4] 5,
+    [  5] .. [995],
+    [996] 997,
+    [997] 998,
+    [998] 999,
+    [999] 1000
+]
+EOS
+    end
+
+    it "plain limited output with 11 lines" do
+      @arr.ai(:plain => true, :limit => 11).should == <<-EOS.strip
+[
+    [  0] 1,
+    [  1] 2,
+    [  2] 3,
+    [  3] 4,
+    [  4] 5,
+    [  5] .. [994],
+    [995] 996,
+    [996] 997,
+    [997] 998,
+    [998] 999,
+    [999] 1000
+]
+EOS
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Limited Output Hash" do
     before(:each) do
+      @hash = ("a".."z").inject({}) { |h, v| h.merge({ v => v.to_sym }) }
+    end
+
+    it "plain limited output" do
+      @hash.ai(:sort_keys => true, :plain => true, :limit => true).should == <<-EOS.strip
+{
+    "a" => :a,
+    "b" => :b,
+    "c" => :c,
+    "d" => :d .. "w" => :w,
+    "x" => :x,
+    "y" => :y,
+    "z" => :z
+}
+EOS
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Hash" do
+    before do
       @hash = { 1 => { :sym => { "str" => { [1, 2, 3] => { { :k => :v } => Hash } } } } }
     end
     
@@ -245,7 +334,7 @@ EOS
 
   #------------------------------------------------------------------------------
   describe "Nested Hash" do
-    before(:each) do
+    before do
       @hash = {}
       @hash[:a] = @hash
     end
@@ -265,7 +354,7 @@ EOS
 
   #------------------------------------------------------------------------------
   describe "Hash with several keys" do
-    before(:each) do
+    before do
       @hash = {"b" => "b", :a => "a", :z => "z", "alpha" => "alpha"}
     end
 
@@ -290,7 +379,7 @@ EOS
     end
     
     it "plain multiline with sorted keys" do
-      @hash.ai(:plain => true, :sorted_hash_keys => true).should == <<-EOS.strip
+      @hash.ai(:plain => true, :sort_keys => true).should == <<-EOS.strip
 {
          :a => "a",
     "alpha" => "alpha",
@@ -304,17 +393,58 @@ EOS
 
   #------------------------------------------------------------------------------
   describe "Negative options[:indent]" do
-    before(:each) do
-      @hash = { [0, 0, 255] => :yellow, :red => "rgb(255, 0, 0)", "magenta" => "rgb(255, 0, 255)" }
+    #
+    # With Ruby < 1.9 the order of hash keys is not defined so we can't
+    # reliably compare the output string.
+    #
+    it "hash keys must be left aligned" do
+      hash = { [0, 0, 255] => :yellow, :red => "rgb(255, 0, 0)", "magenta" => "rgb(255, 0, 255)" }
+      out = hash.ai(:plain => true, :indent => -4, :sort_keys => true)
+      out.should == <<-EOS.strip
+{
+    [ 0, 0, 255 ] => :yellow,
+    "magenta"     => "rgb(255, 0, 255)",
+    :red          => "rgb(255, 0, 0)"
+}
+EOS
     end
 
-    it "hash keys must be left aligned" do
-      out = @hash.ai(:plain => true, :indent => -4)
-      out.start_with?("{\n").should == true
-      out.include?('    :red          => "rgb(255, 0, 0)"').should == true
-      out.include?('    "magenta"     => "rgb(255, 0, 255)"').should == true
-      out.include?('    [ 0, 0, 255 ] => :yellow').should == true
-      out.end_with?("\n}").should == true
+    it "nested hash keys should be indented (array of hashes)" do
+      arr = [ { :a => 1, :bb => 22, :ccc => 333}, { 1 => :a, 22 => :bb, 333 => :ccc} ]
+      out = arr.ai(:plain => true, :indent => -4, :sort_keys => true)
+      out.should == <<-EOS.strip
+[
+    [0] {
+        :a   => 1,
+        :bb  => 22,
+        :ccc => 333
+    },
+    [1] {
+        1   => :a,
+        22  => :bb,
+        333 => :ccc
+    }
+]
+EOS
+    end
+
+    it "nested hash keys should be indented (hash of hashes)" do
+      arr = { :first => { :a => 1, :bb => 22, :ccc => 333}, :second => { 1 => :a, 22 => :bb, 333 => :ccc} }
+      out = arr.ai(:plain => true, :indent => -4, :sort_keys => true)
+      out.should == <<-EOS.strip
+{
+    :first  => {
+        :a   => 1,
+        :bb  => 22,
+        :ccc => 333
+    },
+    :second => {
+        1   => :a,
+        22  => :bb,
+        333 => :ccc
+    }
+}
+EOS
     end
   end
 
@@ -363,7 +493,7 @@ EOS
   #------------------------------------------------------------------------------
   describe "Utility methods" do
     it "should merge options" do
-      ap = AwesomePrint.new
+      ap = AwesomePrint::Inspector.new
       ap.send(:merge_options!, { :color => { :array => :black }, :indent => 0 })
       options = ap.instance_variable_get("@options")
       options[:color][:array].should == :black
@@ -374,7 +504,7 @@ EOS
 
   #------------------------------------------------------------------------------
   describe "Struct" do
-    before(:each) do
+    before do
       @struct = unless defined?(Struct::SimpleStruct)
         Struct.new("SimpleStruct", :name, :address).new
       else
@@ -455,6 +585,15 @@ EOS
       weird.new.ai(:plain => true).should == ''
     end
 
+    it "handle frozen object.inspect" do
+      weird = Class.new do
+        def inspect
+          "ice".freeze
+        end
+      end
+      weird.new.ai(:plain => false).should == "ice"
+    end
+
     # See https://github.com/michaeldv/awesome_print/issues/35
     it "handle array grep when pattern contains / chapacter" do
       hash = { "1/x" => 1,  "2//x" => :"2" }
@@ -481,9 +620,20 @@ EOS
       markup.ai(:html => true, :plain => true).should == "<pre>#{markup}</pre>"
     end
 
-    it "wraps ap output with colorized <pre> tag" do
+    it "wraps ap output with <pre> tag with colorized <kbd>" do
       markup = rand
-      markup.ai(:html => true).should == %Q|<pre style="color:blue">#{markup}</pre>|
+      markup.ai(:html => true).should == %Q|<pre><kbd style="color:blue">#{markup}</kbd></pre>|
+    end
+
+    it "wraps multiline ap output with <pre> tag with colorized <kbd>" do
+      markup = [ 1, :two, "three" ]
+      markup.ai(:html => true).should == <<-EOS.strip
+<pre>[
+    <kbd style="color:white">[0] </kbd><pre><kbd style="color:blue">1</kbd></pre>,
+    <kbd style="color:white">[1] </kbd><pre><kbd style="color:darkcyan">:two</kbd></pre>,
+    <kbd style="color:white">[2] </kbd><pre><kbd style="color:brown">&quot;three&quot;</kbd></pre>
+]</pre>
+EOS
     end
 
     it "encodes HTML entities (plain)" do
@@ -493,7 +643,7 @@ EOS
 
     it "encodes HTML entities (color)" do
       markup = ' &<hello>'
-      markup.ai(:html => true).should == '<pre style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</pre>'
+      markup.ai(:html => true).should == '<pre><kbd style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</kbd></pre>'
     end
   end