Refactored to move #ai (aka ##awesome_inspect) to Kernel

lib/ap.rb

@@ -5,7 +5,6 @@
 #------------------------------------------------------------------------------
 require File.dirname(__FILE__) + "/ap/core_ext/string"
 require File.dirname(__FILE__) + "/ap/core_ext/kernel"
-require File.dirname(__FILE__) + "/ap/core_ext/object"
 require File.dirname(__FILE__) + "/ap/awesome_print"
 
 require File.dirname(__FILE__) + "/ap/mixin/rails" if defined?(::Rails)

lib/ap/core_ext/kernel.rb

@@ -5,10 +5,17 @@
 #------------------------------------------------------------------------------
 module Kernel
 
+  def ai(options = {})
+    ap = AwesomePrint.new(options)
+    ap.send(:awesome, self)
+  end
+  alias :awesome_inspect :ai
+
   def ap(object, options = {})
     ap = AwesomePrint.new(options)
-    ap.puts object
+    ap.puts object.ai
   end
+  alias :awesome_print :ap
 
   module_function :ap
 end

lib/ap/core_ext/object.rb

@@ -1,11 +0,0 @@
-# Copyright (c) 2010 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
-#------------------------------------------------------------------------------
-class Object
-  def awesome_inspect(options = {})
-    ap = AwesomePrint.new(options)
-    ap.send(:awesome, self).to_s
-  end
-end

spec/awesome_print_spec.rb

@@ -1,25 +1,18 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "AwesomePrint" do
-  before(:each) do
-    @color_ap = AwesomePrint.new
-    @plain_ap = AwesomePrint.new(:plain => true)
-  end
 
-  #------------------------------------------------------------------------------
   describe "Array" do
     before(:each) do
       @arr = [ 1, :two, "three", [ nil, [ true, false] ] ]
     end
 
     it "empty array" do
-      ap = AwesomePrint.new
+      [].ai.should == "[]"
-      ap.send(:awesome, []).should == "[]"
     end
 
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
+      @arr.ai(:plain => true).should == <<-EOS.strip
-      ap.send(:awesome, @arr).should == <<-EOS.strip
 [
     [0] 1,
     [1] :two,
@@ -36,8 +29,7 @@ EOS
       end
 
     it "plain multiline indented" do
-      ap = AwesomePrint.new(:plain => true, :indent => 2)
+      @arr.ai(:plain => true, :indent => 2).should == <<-EOS.strip
-      ap.send(:awesome, @arr).should == <<-EOS.strip
 [
   [0] 1,
   [1] :two,
@@ -54,13 +46,11 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
+      @arr.ai(:plain => true, :multiline => false).should == '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
-      ap.send(:awesome, @arr).should == '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
     end
 
-    it "colored multiline" do
+    it "colored multiline (default)" do
-      ap = AwesomePrint.new
+      @arr.ai.should == <<-EOS.strip
-      ap.send(:awesome, @arr).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,
@@ -77,8 +67,7 @@ EOS
       end
 
     it "colored multiline indented" do
-      ap = AwesomePrint.new(:indent => 8)
+      @arr.ai(:indent => 8).should == <<-EOS.strip
-      ap.send(:awesome, @arr).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,
@@ -95,8 +84,7 @@ EOS
     end
 
     it "colored single line" do
-      ap = AwesomePrint.new(:multiline => false)
+      @arr.ai(:multiline => false).should == "[ \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 ] ] ]"
-      ap.send(:awesome, @arr).should == "[ \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 ] ] ]"
     end
   end
 
@@ -108,8 +96,7 @@ EOS
     end
 
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
+      @arr.ai(:plain => true).should == <<-EOS.strip
-      ap.send(:awesome, @arr).should == <<-EOS.strip
 [
     [0] 1,
     [1] 2,
@@ -119,8 +106,7 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
+      @arr.ai(:plain => true, :multiline => false).should == "[ 1, 2, [...] ]"
-      ap.send(:awesome, @arr).should == "[ 1, 2, [...] ]"
     end
   end
 
@@ -131,13 +117,11 @@ EOS
     end
     
     it "empty hash" do
-      ap = AwesomePrint.new
+      {}.ai.should == "{}"
-      ap.send(:awesome, {}).should == "{}"
     end
     
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
+      @hash.ai(:plain => true).should == <<-EOS.strip
-      ap.send(:awesome, @hash).should == <<-EOS.strip
 {
     1 => {
         :sym => {
@@ -153,8 +137,7 @@ EOS
     end
 
     it "plain multiline indented" do
-      ap = AwesomePrint.new(:plain => true, :indent => 1)
+      @hash.ai(:plain => true, :indent => 1).should == <<-EOS.strip
-      ap.send(:awesome, @hash).should == <<-EOS.strip
 {
  1 => {
   :sym => {
@@ -170,13 +153,11 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
+      @hash.ai(:plain => true, :multiline => false).should == '{ 1 => { :sym => { "str" => { [ 1, 2, 3 ] => { { :k => :v } => Hash < Object } } } } }'
-      ap.send(:awesome, @hash).should == '{ 1 => { :sym => { "str" => { [ 1, 2, 3 ] => { { :k => :v } => Hash < Object } } } } }'
     end
 
-    it "colored multiline" do
+    it "colored multiline (default)" do
-      ap = AwesomePrint.new
+      @hash.ai.should == <<-EOS.strip
-      ap.send(:awesome, @hash).should == <<-EOS.strip
 {
     1\e[1;30m => \e[0m{
         :sym\e[1;30m => \e[0m{
@@ -192,8 +173,7 @@ EOS
     end
 
     it "colored multiline indented" do
-      ap = AwesomePrint.new(:indent => 2)
+      @hash.ai(:indent => 2).should == <<-EOS.strip
-      ap.send(:awesome, @hash).should == <<-EOS.strip
 {
   1\e[1;30m => \e[0m{
     :sym\e[1;30m => \e[0m{
@@ -209,8 +189,7 @@ EOS
     end
 
     it "colored single line" do
-      ap = AwesomePrint.new(:multiline => false)
+      @hash.ai(:multiline => false).should == "{ 1\e[1;30m => \e[0m{ :sym\e[1;30m => \e[0m{ \"str\"\e[1;30m => \e[0m{ [ 1, 2, 3 ]\e[1;30m => \e[0m{ { :k => :v }\e[1;30m => \e[0m\e[1;33mHash < Object\e[0m } } } } }"
-      ap.send(:awesome, @hash).should == "{ 1\e[1;30m => \e[0m{ :sym\e[1;30m => \e[0m{ \"str\"\e[1;30m => \e[0m{ [ 1, 2, 3 ]\e[1;30m => \e[0m{ { :k => :v }\e[1;30m => \e[0m\e[1;33mHash < Object\e[0m } } } } }"
     end
 
   end
@@ -223,8 +202,7 @@ EOS
     end
 
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
+      @hash.ai(:plain => true).should == <<-EOS.strip
-      ap.send(:awesome, @hash).should == <<-EOS.strip
 {
     :a => {...}
 }
@@ -232,8 +210,7 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
+      @hash.ai(:plain => true, :multiline => false).should == '{ :a => {...} }'
-      ap.send(:awesome, @hash).should == '{ :a => {...} }'
     end
   end
 
@@ -244,8 +221,7 @@ EOS
     end
 
     it "hash keys must be left aligned" do
-      ap = AwesomePrint.new(:plain => true, :indent => -4)
+      out = @hash.ai(:plain => true, :indent => -4)
-      out = ap.send(:awesome, @hash)
       out.start_with?("{\n").should == true
       out.include?('    :red          => "rgb(255, 0, 0)"').should == true
       out.include?('    "magenta"     => "rgb(255, 0, 255)"').should == true
@@ -257,13 +233,11 @@ EOS
   #------------------------------------------------------------------------------
   describe "Class" do
     it "shoud show superclass (plain)" do
-      ap = AwesomePrint.new(:plain => true)
+      self.class.ai(:plain => true).should == "#{self.class} < #{self.class.superclass}"
-      ap.send(:awesome, self.class).should == "#{self.class} < #{self.class.superclass}"
     end
 
     it "shoud show superclass (color)" do
-      ap = AwesomePrint.new
+      self.class.ai.should == "#{self.class} < #{self.class.superclass}".yellow
-      ap.send(:awesome_class, self.class).should == "#{self.class} < #{self.class.superclass}".yellow
     end
   end
 
@@ -271,7 +245,7 @@ EOS
   describe "File" do
     it "should display a file (plain)" do
       File.open(__FILE__, "r") do |f|
-        @plain_ap.send(:awesome_file, f).should == "#{f.inspect}\n" << `ls -alF #{f.path}`.chop
+        f.ai(:plain => true).should == "#{f.inspect}\n" << `ls -alF #{f.path}`.chop
       end
     end
   end
@@ -280,7 +254,7 @@ EOS
   describe "Dir" do
     it "should display a direcory (plain)" do
       Dir.open(File.dirname(__FILE__)) do |d|
-        @plain_ap.send(:awesome_dir, d).should == "#{d.inspect}\n" << `ls -alF #{d.path}`.chop
+        d.ai(:plain => true).should == "#{d.inspect}\n" << `ls -alF #{d.path}`.chop
       end
     end
   end