awesome_print 1.0.0 → 1.1.0

data/lib/awesome_print/formatter.rb

@@ -1,9 +1,9 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2012 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
 #------------------------------------------------------------------------------
-require "cgi"
+autoload :CGI, "cgi"
 require "shellwords"
 
 module AwesomePrint
@@ -25,12 +25,13 @@ module AwesomePrint
       awesome = if core_class != :self
         send(:"awesome_#{core_class}", object) # Core formatters.
       else
-        awesome_self(object, type) # Catch all that falls back on object.inspect.
+        awesome_self(object, type) # Catch all that falls back to object.inspect.
       end
       @options[:html] ? "<pre>#{awesome}</pre>" : awesome
     end
 
-    # Hook this when adding custom formatters.
+    # Hook this when adding custom formatters. Check out lib/awesome_print/ext
+    # directory for custom formatters that ship with awesome_print.
     #------------------------------------------------------------------------------
     def cast(object, type)
       CORE.grep(type)[0] || :self
@@ -38,12 +39,19 @@ module AwesomePrint
 
     # Pick the color and apply it to the given string as necessary.
     #------------------------------------------------------------------------------
-    def colorize(s, type)
-      s = CGI.escapeHTML(s) if @options[:html]
+    def colorize(str, type)
+      str = CGI.escapeHTML(str) if @options[:html]
       if @options[:plain] || !@options[:color][type] || !@inspector.colorize?
-        s
+        str
+      #
+      # Check if the string color method is defined by awesome_print and accepts
+      # html parameter or it has been overriden by some gem such as colorize.
+      #
+      elsif str.method(@options[:color][type]).arity == -1 # Accepts html parameter.
+        str.send(@options[:color][type], @options[:html])
       else
-        s.send(@options[:color][type], @options[:html])
+        str = %Q|<kbd style="color:#{@options[:color][type]}">#{str}</kbd>| if @options[:html]
+        str.send(@options[:color][type])
       end
     end
 
@@ -53,8 +61,11 @@ module AwesomePrint
     # Catch all method to format an arbitrary object.
     #------------------------------------------------------------------------------
     def awesome_self(object, type)
-      return awesome_object(object) if object.instance_variables.any?
-      colorize(object.inspect.to_s, type)
+      if @options[:raw] && object.instance_variables.any?
+        awesome_object(object)
+      else
+        colorize(object.inspect.to_s, type)
+      end
     end
 
     # Format an array.
@@ -188,12 +199,17 @@ module AwesomePrint
       colorize(ls.empty? ? d.inspect : "#{d.inspect}\n#{ls.chop}", :dir)
     end
 
-    # Format BigDecimal and Rational objects by convering them to Float.
+    # Format BigDecimal object.
     #------------------------------------------------------------------------------
     def awesome_bigdecimal(n)
-      colorize(n.to_f.inspect, :bigdecimal)
+      colorize(n.to_s("F"), :bigdecimal)
+    end
+
+    # Format Rational object.
+    #------------------------------------------------------------------------------
+    def awesome_rational(n)
+      colorize(n.to_s, :rational)
     end
-    alias :awesome_rational :awesome_bigdecimal
 
     # Format a method.
     #------------------------------------------------------------------------------
@@ -212,17 +228,20 @@ module AwesomePrint
     # Format object.methods array.
     #------------------------------------------------------------------------------
     def methods_array(a)
+      a.sort! { |x, y| x.to_s <=> y.to_s }                  # Can't simply a.sort! because of o.methods << [ :blah ]
       object = a.instance_variable_get('@__awesome_methods__')
       tuples = a.map do |name|
-        tuple = if object.respond_to?(name, true)         # Is this a regular method?
-          the_method = object.method(name) rescue nil     # Avoid potential ArgumentError if object#method is overridden.
-          if the_method && the_method.respond_to?(:arity) # Is this original object#method?
-            method_tuple(the_method)                      # Yes, we are good.
+        if name.is_a?(Symbol) || name.is_a?(String)         # Ignore garbage, ex. 42.methods << [ :blah ]
+          tuple = if object.respond_to?(name, true)         # Is this a regular method?
+            the_method = object.method(name) rescue nil     # Avoid potential ArgumentError if object#method is overridden.
+            if the_method && the_method.respond_to?(:arity) # Is this original object#method?
+              method_tuple(the_method)                      # Yes, we are good.
+            end
+          elsif object.respond_to?(:instance_method)        # Is this an unbound method?
+            method_tuple(object.instance_method(name))
           end
-        elsif object.respond_to?(:instance_method)        # Is this an unbound method?
-          method_tuple(object.instance_method(name))
         end
-        tuple || [ name.to_s, '(?)', '' ]                 # Return WTF default if all the above fails.
+        tuple || [ name.to_s, '(?)', '?' ]                  # Return WTF default if all the above fails.
       end
 
       width = (tuples.size - 1).to_s.size
@@ -259,14 +278,27 @@ module AwesomePrint
         args[-1] = "*#{args[-1]}" if method.arity < 0
       end
 
-      if method.to_s =~ /(Unbound)*Method: (.*?)[#\.]/
-        owner = "#{$2}#{$1 ? '(unbound)' : ''}".gsub('(', ' (')
+      # method.to_s formats to handle:
+      #
+      # #<Method: Fixnum#zero?>
+      # #<Method: Fixnum(Integer)#years>
+      # #<Method: User(#<Module:0x00000103207c00>)#_username>
+      # #<Method: User(id: integer, username: string).table_name>
+      # #<Method: User(id: integer, username: string)(ActiveRecord::Base).current>
+      # #<UnboundMethod: Hello#world>
+      #
+      if method.to_s =~ /(Unbound)*Method: (.*)[#\.]/
+        unbound, klass = $1 && '(unbound)', $2
+        if klass && klass =~ /(\(\w+:\s.*?\))/  # Is this ActiveRecord-style class?
+          klass.sub!($1, '')                    # Yes, strip the fields leaving class name only.
+        end
+        owner = "#{klass}#{unbound}".gsub('(', ' (')
       end
 
       [ method.name.to_s, "(#{args.join(', ')})", owner.to_s ]
     end
 
-    # Format hash keys as plain string regardless of underlying data type.
+    # Format hash keys as plain strings regardless of underlying data type.
     #------------------------------------------------------------------------------
     def plain_single_line
       plain, multiline = @options[:plain], @options[:multiline]
@@ -314,7 +346,25 @@ module AwesomePrint
       ' ' * (@indentation - @options[:indent].abs)
     end
 
-    # To support limited output.
+    # To support limited output, for example:
+    #
+    # ap ('a'..'z').to_a, :limit => 3
+    # [
+    #     [ 0] "a",
+    #     [ 1] .. [24],
+    #     [25] "z"
+    # ]
+    #
+    # ap (1..100).to_a, :limit => true # Default limit is 7.
+    # [
+    #     [ 0] 1,
+    #     [ 1] 2,
+    #     [ 2] 3,
+    #     [ 3] .. [96],
+    #     [97] 98,
+    #     [98] 99,
+    #     [99] 100
+    # ]
     #------------------------------------------------------------------------------
     def should_be_limited?
       @options[:limit] == true or (@options[:limit].is_a?(Fixnum) and @options[:limit] > 0)
@@ -345,6 +395,5 @@ module AwesomePrint
         temp
       end
     end
-
   end
 end

data/lib/awesome_print/inspector.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2012 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
@@ -14,6 +14,37 @@ module AwesomePrint
     def force_colors!(value = true)
       @force_colors = value
     end
+
+    def console?
+      !!(defined?(IRB) || defined?(Pry))
+    end
+
+    def rails_console?
+      console? && !!(defined?(Rails::Console) || ENV["RAILS_ENV"])
+    end
+
+    def irb!
+      return unless defined?(IRB)
+      unless IRB.version.include?("DietRB")
+        IRB::Irb.class_eval do
+          def output_value
+            ap @context.last_value
+          end
+        end
+      else # MacRuby
+        IRB.formatter = Class.new(IRB::Formatter) do
+          def inspect_object(object)
+            object.ai
+          end
+        end.new
+      end
+    end
+
+    def pry!
+      if defined?(Pry)
+        Pry.print = proc { |output, value| output.puts value.ai }
+      end
+    end
   end
 
   class Inspector
@@ -28,6 +59,7 @@ module AwesomePrint
         :html       => false,  # Use ANSI color codes rather than HTML.
         :multiline  => true,   # Display in multiple lines.
         :plain      => false,  # Use colors.
+        :raw        => false,  # Do not recursively format object instance variables.
         :sort_keys  => false,  # Do not sort hash keys.
         :limit      => false,  # Limit large output for arrays and hashes. Set to a boolean or integer.
         :color => { 
@@ -43,6 +75,7 @@ module AwesomePrint
           :keyword    => :cyan,
           :method     => :purpleish,
           :nilclass   => :red,
+          :rational   => :blue,
           :string     => :yellowish,
           :struct     => :pale,
           :symbol     => :cyanish,
@@ -129,10 +162,8 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def merge_custom_defaults!
       dotfile = File.join(ENV["HOME"], ".aprc")
-      if File.readable?(dotfile)
-        load dotfile
-        merge_options!(AwesomePrint.defaults)
-      end
+      load dotfile if File.readable?(dotfile)
+      merge_options!(AwesomePrint.defaults) if AwesomePrint.defaults.is_a?(Hash)
     rescue => e
       $stderr.puts "Could not load #{dotfile}: #{e}"
     end

data/lib/awesome_print/version.rb

@@ -1,10 +1,10 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2012 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
   def self.version
-    '1.0.0'
+    '1.1.0'
   end
 end

data/lib/awesome_print.rb

@@ -1,13 +1,13 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2012 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
 #------------------------------------------------------------------------------
 #
-# AwesomePrint might be loaded implicitly through ~/.irbrc so do nothing
-# for subsequent requires.
+# AwesomePrint might be loaded implicitly through ~/.irbrc or ~/.pryrc
+# so do nothing for subsequent requires.
 #
-unless defined?(AwesomePrint)
+unless defined?(AwesomePrint::Inspector)
   %w(array string method object class kernel).each do |file|
     require File.dirname(__FILE__) + "/awesome_print/core_ext/#{file}"
   end
@@ -16,14 +16,16 @@ unless defined?(AwesomePrint)
   require File.dirname(__FILE__) + "/awesome_print/formatter"
   require File.dirname(__FILE__) + "/awesome_print/version"
   require File.dirname(__FILE__) + "/awesome_print/core_ext/logger" if defined?(Logger)
-
+  #
   # Load the following under normal circumstances as well as in Rails
-  # console when required from ~/.irbrc.
-  require File.dirname(__FILE__) + "/awesome_print/ext/active_record"  if defined?(ActiveRecord)  || (defined?(IRB) && ENV['RAILS_ENV'])
-  require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || (defined?(IRB) && ENV['RAILS_ENV'])
-
+  # console when required from ~/.irbrc or ~/.pryrc.
+  #
+  require File.dirname(__FILE__) + "/awesome_print/ext/active_record"  if defined?(ActiveRecord)  || AwesomePrint.rails_console?
+  require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || AwesomePrint.rails_console?
+  #
   # Load remaining extensions.
-  require File.dirname(__FILE__) + "/awesome_print/ext/action_view"    if defined?(ActionView)
+  #
+  require File.dirname(__FILE__) + "/awesome_print/ext/action_view"    if defined?(ActionView::Base)
   require File.dirname(__FILE__) + "/awesome_print/ext/mongo_mapper"   if defined?(MongoMapper)
   require File.dirname(__FILE__) + "/awesome_print/ext/mongoid"        if defined?(Mongoid)
   require File.dirname(__FILE__) + "/awesome_print/ext/nokogiri"       if defined?(Nokogiri)

data/spec/formats_spec.rb

@@ -479,14 +479,24 @@ EOS
 
   #------------------------------------------------------------------------------
   describe "BigDecimal and Rational" do
-    it "should present BigDecimal object as Float scalar" do
-      big = BigDecimal("2010.4")
-      big.ai(:plain => true).should == "2010.4"
-    end
-
-    it "should present Rational object as Float scalar" do
-      rat = Rational(2010, 2)
-      rat.ai(:plain => true).should == "1005.0"
+    it "should present BigDecimal object with arbitrary precision" do
+      big = BigDecimal("201020102010201020102010201020102010.4")
+      big.ai(:plain => true).should == "201020102010201020102010201020102010.4"
+    end
+
+    it "should present Rational object with arbitrary precision" do
+      rat = Rational(201020102010201020102010201020102010, 2)
+      out = rat.ai(:plain => true)
+      #
+      # Ruby 1.9 slightly changed the format of Rational#to_s, see
+      # http://techtime.getharvest.com/blog/harvest-is-now-on-ruby-1-dot-9-3 and
+      # http://www.ruby-forum.com/topic/189397
+      #
+      if RUBY_VERSION < "1.9"
+        out.should == "100510051005100510051005100510051005"
+      else
+        out.should == "100510051005100510051005100510051005/1"
+      end
     end
   end
 
@@ -501,7 +511,6 @@ EOS
     end
   end
 
-
   #------------------------------------------------------------------------------
   describe "Struct" do
     before do
@@ -573,80 +582,6 @@ EOS
     end
   end
 
-
-  #------------------------------------------------------------------------------
-  describe "Misc" do
-    it "handle weird objects that return nil on inspect" do
-      weird = Class.new do
-        def inspect
-          nil
-        end
-      end
-      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" }
-      grepped = hash.keys.grep(/^(\d+)\//) { $1 }
-      grepped.ai(:plain => true, :multiline => false).should == '[ "1", "2" ]'
-    end
-
-    it "returns value passed as a parameter" do
-      object = rand
-      self.stub!(:puts)
-      (ap object).should == object
-    end
-
-    # Require different file name this time (lib/ap.rb vs. lib/awesome_print).
-    it "several require 'awesome_print' should do no harm" do
-      require File.expand_path(File.dirname(__FILE__) + '/../lib/ap')
-      lambda { rand.ai }.should_not raise_error
-    end
-  end
-
-  describe "HTML output" do
-    it "wraps ap output with plain <pre> tag" do
-      markup = rand
-      markup.ai(:html => true, :plain => true).should == "<pre>#{markup}</pre>"
-    end
-
-    it "wraps ap output with <pre> tag with colorized <kbd>" do
-      markup = rand
-      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
-      markup = ' &<hello>'
-      markup.ai(:html => true, :plain => true).should == '<pre>&quot; &amp;&lt;hello&gt;&quot;</pre>'
-    end
-
-    it "encodes HTML entities (color)" do
-      markup = ' &<hello>'
-      markup.ai(:html => true).should == '<pre><kbd style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</kbd></pre>'
-    end
-  end
-
   #------------------------------------------------------------------------------
   describe "Inherited from standard Ruby classes" do
     after do

data/spec/methods_spec.rb

@@ -155,9 +155,10 @@ describe "Object methods" do
         def m1; end
         def m2; end
       end
+
       out = Hello.new.private_methods.ai(:plain => true).split("\n").grep(/m\d/)
-      out.first.should =~ /^\s+\[\d+\]\s+m1\(\)\s+Hello$/
-      out.last.should  =~ /^\s+\[\d+\]\s+m2\(\)\s+Hello$/
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\)\s+Hello$/
+      out.last.should  =~ /^\s+\[\s*\d+\]\s+m2\(\)\s+Hello$/
     end
 
     it "no index: should handle object.private_methods" do
@@ -167,9 +168,9 @@ describe "Object methods" do
       end
       out = Hello.new.private_methods.ai(:plain => true).split("\n").grep(/m\d/)
       if RUBY_VERSION < '1.9.2'
-        out.first.should =~ /^\s+\[\d+\]\s+m3\(arg1, arg2\)\s+Hello$/
+        out.first.should =~ /^\s+\[\s*\d+\]\s+m3\(arg1, arg2\)\s+Hello$/
       else
-        out.first.should =~ /^\s+\[\d+\]\s+m3\(a, b\)\s+Hello$/
+        out.first.should =~ /^\s+\[\s*\d+\]\s+m3\(a, b\)\s+Hello$/
       end
     end
   end
@@ -183,8 +184,8 @@ describe "Object methods" do
         end
       end
       out = Hello.singleton_methods.ai(:plain => true).split("\n").grep(/m\d/)
-      out.first.should =~ /^\s+\[\d+\]\s+m1\(\)\s+Hello$/
-      out.last.should  =~ /^\s+\[\d+\]\s+m2\(\)\s+Hello$/
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\)\s+Hello$/
+      out.last.should  =~ /^\s+\[\s*\d+\]\s+m2\(\)\s+Hello$/
     end
 
     it "no index: should handle object.singleton_methods" do
@@ -266,8 +267,8 @@ describe "Class methods" do
         def m2; end
       end
       out = Hello.protected_instance_methods.ai(:plain => true).split("\n").grep(/m\d/)
-      out.first.should =~ /^\s+\[\d+\]\s+m1\(\)\s+Hello\s\(unbound\)$/
-      out.last.should  =~ /^\s+\[\d+\]\s+m2\(\)\s+Hello\s\(unbound\)$/
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\)\s+Hello\s\(unbound\)$/
+      out.last.should  =~ /^\s+\[\s*\d+\]\s+m2\(\)\s+Hello\s\(unbound\)$/
     end
 
     it "no index: should handle class.protected_instance_methods" do
@@ -410,7 +411,7 @@ describe "Methods arrays" do
       def self.m_two; end
     end
 
-    out = Hello.methods.grep(/^m_(.+)$/) { $1.to_sym }
+    out = Hello.methods.sort.grep(/^m_(.+)$/) { $1.to_sym }
     out.should == [:one, :two]
   end
 
@@ -445,4 +446,14 @@ describe "Methods arrays" do
     hello = Hello.new
     (hello.send(:his) - hello.send(:her)).sort_by { |x| x.to_s }.should == [ :him, :his ]
   end
+
+  it "appending garbage to methods array should not raise error" do
+    arr = 42.methods << [ :wtf ]
+    arr.ai(:plain => true).should_not raise_error(TypeError)
+    if RUBY_VERSION < '1.9.2'
+      arr.ai(:plain => true).should =~ /\s+wtf\(\?\)\s+\?/      # [ :wtf ].to_s => "wtf"
+    else
+      arr.ai(:plain => true).should =~ /\s+\[:wtf\]\(\?\)\s+\?/ # [ :wtf ].to_s => [:wtf]
+    end
+  end
 end