awesome_print 0.1.1 → 0.1.2

data/README.md

@@ -14,38 +14,43 @@ objects are supported via included mixin.
     $ git clone git://github.com/michaeldv/awesome_print_.git
 
 ### Usage ###
+
+    require "ap"
+    ap object, options = {}
+
+Default options:
+
+    :miltiline => true,
+    :plain  => false,
+    :indent => 4,
+    :colors => {
+      :array      => :white,
+      :bignum     => :blue,
+      :class      => :yellow,
+      :date       => :greenish,
+      :falseclass => :red,
+      :fixnum     => :blue,
+      :float      => :blue,
+      :hash       => :gray,
+      :nilclass   => :red,
+      :string     => :yellowish,
+      :symbol     => :cyanish,
+      :time       => :greenish,
+      :trueclass  => :green
+    }
+
+Supported color names:
+
+    :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white
+    :black, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :pale
+
+### Examples ###
+    $ cat > 1.rb
     require "ap"
-    ap(object, options = {})
-
-    Default options:
-      :miltiline => true,
-      :plain  => false,
-      :indent => 4,
-      :colors => {
-        :array      => :white,
-        :bignum     => :blue,
-        :class      => :yellow,
-        :date       => :greenish,
-        :falseclass => :red,
-        :fixnum     => :blue,
-        :float      => :blue,
-        :hash       => :gray,
-        :nilclass   => :red,
-        :string     => :yellowish,
-        :symbol     => :cyanish,
-        :time       => :greenish,
-        :trueclass  => :green
-      }
-
-    Supported color names:
-      :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white
-      :black, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :pale
-
-### Example (IRB) ###
-    $ irb
-    irb> require "ap"
-    irb> data = [ false, 42, %w(fourty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
-    irb> ap data
+    data = [ false, 42, %w(fourty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
+    ap data
+    ^D
+    $ ruby 1.rb
     [
         [0] false,
         [1] 42,
@@ -59,17 +64,29 @@ objects are supported via included mixin.
             :distance => 4.2e+43
         }
     ]
-    irb> ap data[3], :indent => -2 # Left align hash keys.
+
+    $ cat > 2.rb
+    require "ap"
+    data = { :now => Time.now, :class => Time.now.class, :distance => 42e42 }
+    ap data, :indent => -2  # <-- Left align hash keys.
+    ^D
+    $ ruby 2.rb
     {
       :class    => Time < Object,
       :now      => Fri Apr 02 19:55:53 -0700 2010,
       :distance => 4.2e+43
     }
-    irb> ap data, :multiline => false
-    [ false, 42, [ "fourty", "two" ], { :class => Time < Object, :distance => 4.2e+43, :now => Fri Apr 02 19:44:52 -0700 2010 } ]
-    irb>
 
-### Example (Rails) ###
+    $ cat > 3.rb
+    require "ap"
+    data = [ false, 42, %w(fourty two) ]
+    data << data  # <-- Nested array.
+    ap data, :multiline => false
+    ^D
+    $ ruby 3.rb
+    [ false, 42, [ "fourty", "two" ], [...] ]
+
+### Example (Rails console) ###
     $ ruby script/console
     Loading development environment (Rails 2.3.5)
     rails> require "ap"

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/ap/awesome_print.rb

@@ -33,16 +33,14 @@ class AwesomePrint
     Thread.current[AP] ||= []
   end
 
-  def puts(object)
-    Kernel.puts awesome(object)
-  end
-
 
   private
 
   # Format an array.
   #------------------------------------------------------------------------------
   def awesome_array(a)
+    return "[]" if a == []
+
     if @options[:multiline]
       width = (a.size - 1).to_s.size 
       data = a.inject([]) do |arr, item|
@@ -61,13 +59,15 @@ class AwesomePrint
   # Format a hash. If @options[:indent] if negative left align hash keys.
   #------------------------------------------------------------------------------
   def awesome_hash(h)
+    return "{}" if h == {}
+
     data = h.keys.inject([]) do |arr, key|
       plain_single_line do
         arr << [ awesome(key), h[key] ]
       end
     end
       
-    width = data.map { |key, | key.size }.max
+    width = data.map { |key, | key.size }.max || 0
     width += @indentation if @options[:indent] > 0
   
     data = data.inject([]) do |arr, (key, value)|

data/lib/ap/core_ext/kernel.rb

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

data/lib/ap/core_ext/string.rb

@@ -3,7 +3,7 @@
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
-class String # :nodoc:
+class String
 
   [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each_with_index do |color, i|
     if STDOUT.tty? && ENV['TERM'] && ENV['TERM'] != 'dumb'
@@ -11,7 +11,7 @@ class String # :nodoc:
       define_method :"#{color}ish" do "\033[0;#{30+i}m#{self}\033[0m" end
     else
       define_method color do self end
-      alias :"#{color}ish" color # <- This break Rdoc: Name or symbol expected (got #<RubyToken::TkDSTRING
+      alias_method :"#{color}ish", color 
     end
   end
 

data/spec/awesome_print_spec.rb

@@ -1,20 +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
+      [].ai.should == "[]"
+    end
+
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
-      ap.send(:awesome, @arr).should == <<-EOS.strip
+      @arr.ai(:plain => true).should == <<-EOS.strip
 [
     [0] 1,
     [1] :two,
@@ -31,8 +29,7 @@ EOS
       end
 
     it "plain multiline indented" do
-      ap = AwesomePrint.new(:plain => true, :indent => 2)
-      ap.send(:awesome, @arr).should == <<-EOS.strip
+      @arr.ai(:plain => true, :indent => 2).should == <<-EOS.strip
 [
   [0] 1,
   [1] :two,
@@ -49,13 +46,11 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
-      ap.send(:awesome, @arr).should == '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
+      @arr.ai(:plain => true, :multiline => false).should == '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
     end
 
-    it "colored multiline" do
-      ap = AwesomePrint.new
-      ap.send(:awesome, @arr).should == <<-EOS.strip
+    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,
@@ -72,8 +67,7 @@ EOS
       end
 
     it "colored multiline indented" do
-      ap = AwesomePrint.new(:indent => 8)
-      ap.send(:awesome, @arr).should == <<-EOS.strip
+      @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,
@@ -90,8 +84,7 @@ EOS
     end
 
     it "colored single line" do
-      ap = AwesomePrint.new(:multiline => false)
-      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 ] ] ]"
+      @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 ] ] ]"
     end
   end
 
@@ -103,8 +96,7 @@ EOS
     end
 
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
-      ap.send(:awesome, @arr).should == <<-EOS.strip
+      @arr.ai(:plain => true).should == <<-EOS.strip
 [
     [0] 1,
     [1] 2,
@@ -114,8 +106,7 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
-      ap.send(:awesome, @arr).should == "[ 1, 2, [...] ]"
+      @arr.ai(:plain => true, :multiline => false).should == "[ 1, 2, [...] ]"
     end
   end
 
@@ -124,10 +115,13 @@ EOS
     before(:each) do
       @hash = { 1 => { :sym => { "str" => { [1, 2, 3] => { { :k => :v } => Hash } } } } }
     end
-
+    
+    it "empty hash" do
+      {}.ai.should == "{}"
+    end
+    
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
-      ap.send(:awesome, @hash).should == <<-EOS.strip
+      @hash.ai(:plain => true).should == <<-EOS.strip
 {
     1 => {
         :sym => {
@@ -143,8 +137,7 @@ EOS
     end
 
     it "plain multiline indented" do
-      ap = AwesomePrint.new(:plain => true, :indent => 1)
-      ap.send(:awesome, @hash).should == <<-EOS.strip
+      @hash.ai(:plain => true, :indent => 1).should == <<-EOS.strip
 {
  1 => {
   :sym => {
@@ -160,13 +153,11 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
-      ap.send(:awesome, @hash).should == '{ 1 => { :sym => { "str" => { [ 1, 2, 3 ] => { { :k => :v } => Hash < Object } } } } }'
+      @hash.ai(:plain => true, :multiline => false).should == '{ 1 => { :sym => { "str" => { [ 1, 2, 3 ] => { { :k => :v } => Hash < Object } } } } }'
     end
 
-    it "colored multiline" do
-      ap = AwesomePrint.new
-      ap.send(:awesome, @hash).should == <<-EOS.strip
+    it "colored multiline (default)" do
+      @hash.ai.should == <<-EOS.strip
 {
     1\e[1;30m => \e[0m{
         :sym\e[1;30m => \e[0m{
@@ -182,8 +173,7 @@ EOS
     end
 
     it "colored multiline indented" do
-      ap = AwesomePrint.new(:indent => 2)
-      ap.send(:awesome, @hash).should == <<-EOS.strip
+      @hash.ai(:indent => 2).should == <<-EOS.strip
 {
   1\e[1;30m => \e[0m{
     :sym\e[1;30m => \e[0m{
@@ -199,8 +189,7 @@ EOS
     end
 
     it "colored single line" do
-      ap = AwesomePrint.new(:multiline => false)
-      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 } } } } }"
+      @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 } } } } }"
     end
 
   end
@@ -213,8 +202,7 @@ EOS
     end
 
     it "plain multiline" do
-      ap = AwesomePrint.new(:plain => true)
-      ap.send(:awesome, @hash).should == <<-EOS.strip
+      @hash.ai(:plain => true).should == <<-EOS.strip
 {
     :a => {...}
 }
@@ -222,8 +210,7 @@ EOS
     end
 
     it "plain single line" do
-      ap = AwesomePrint.new(:plain => true, :multiline => false)
-      ap.send(:awesome, @hash).should == '{ :a => {...} }'
+      @hash.ai(:plain => true, :multiline => false).should == '{ :a => {...} }'
     end
   end
 
@@ -234,8 +221,7 @@ EOS
     end
 
     it "hash keys must be left aligned" do
-      ap = AwesomePrint.new(:plain => true, :indent => -4)
-      out = ap.send(:awesome, @hash)
+      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
@@ -247,13 +233,11 @@ EOS
   #------------------------------------------------------------------------------
   describe "Class" do
     it "shoud show superclass (plain)" do
-      ap = AwesomePrint.new(:plain => true)
-      ap.send(:awesome, self.class).should == "#{self.class} < #{self.class.superclass}"
+      self.class.ai(:plain => true).should == "#{self.class} < #{self.class.superclass}"
     end
 
     it "shoud show superclass (color)" do
-      ap = AwesomePrint.new
-      ap.send(:awesome_class, self.class).should == "#{self.class} < #{self.class.superclass}".yellow
+      self.class.ai.should == "#{self.class} < #{self.class.superclass}".yellow
     end
   end
 
@@ -261,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
@@ -270,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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-04 00:00:00 -07:00
+date: 2010-04-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency