awesome_print 0.1.0 → 0.2.0

data/CHANGELOG

@@ -0,0 +1,27 @@
+0.2.0
+  - Added support for logger.ap (including Rails logger)
+  - Added support for HashWithIndifferentAccess from ActiveSupport
+  - ap now works with scripts that use ActiveRecord/ActiveSupport outside Rails
+  - ap now correctly shows file and directory names with fancy characters (shell escape)
+
+0.1.4
+  - Format BigDecimal and Rational objects as Float scalars
+  - Explicit options parameter can override custom defaults
+  - Custom defaults are not interfering when running specs
+  - Custom defaults now work correctly with Ruby 1.9.x
+
+0.1.3
+  - Added support for setting custom defaults in ~/.aprc
+  
+0.1.2
+  - Correctly handle empty arrays and hashes
+  - Use alias_method instead of alias (fixes non-tty method aliasing)
+  - Added awesome_inspect method
+
+0.1.1
+  - Added support for tableless ActiveRecord models
+  - Left align hash keys if @options[:indent] is negative
+  
+0.1.0
+  - Initial Release.
+  

data/README.md

@@ -1,55 +1,61 @@
 ## Awesome Print ##
-    Awesome Print is Ruby library that pretty prints Ruby objects in full color
-    exposing their internal structure with proper indentation. Rails ActiveRecord
-    objects are supported via included mixin.
+Awesome Print is Ruby library that pretty prints Ruby objects in full color
+exposing their internal structure with proper indentation. Rails ActiveRecord
+objects are supported via included mixin.
 
 ### Installation ###
-    $ # Installing as Ruby gem
+    # Installing as Ruby gem
     $ gem install awesome_print
 
     # Installing as Rails plugin
     $ ruby script/plugin install http://github.com/michaeldv/awesome_print_.git
 
-    $ # Cloning the repository
+    # Cloning the repository
     $ git clone git://github.com/michaeldv/awesome_print_.git
 
 ### Usage ###
+
     require "ap"
-    ap(object, options = {})
-
-    Default options:
-      :miltiline => true,
-      :plain  => false,
-      :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
-      }
+    ap object, options = {}
 
-    Supported color names:
-      :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white
-      :black, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :pale
+Default options:
+
+    :multiline => true,
+    :plain  => false,
+    :indent => 4,
+    :color => {
+      :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
+    }
 
-### 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
+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"
+    data = [ false, 42, %w(forty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
+    ap data
+    ^D
+    $ ruby 1.rb
     [
         [0] false,
         [1] 42,
         [2] [
-            [0] "fourty",
+            [0] "forty",
             [1] "two"
         ],
         [3] {
@@ -58,11 +64,29 @@
             :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 > 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
+    }
+
+    $ cat > 3.rb
+    require "ap"
+    data = [ false, 42, %w(forty two) ]
+    data << data  # <-- Nested array.
+    ap data, :multiline => false
+    ^D
+    $ ruby 3.rb
+    [ false, 42, [ "forty", "two" ], [...] ]
+
+### Example (Rails console) ###
     $ ruby script/console
     Loading development environment (Rails 2.3.5)
     rails> require "ap"
@@ -120,15 +144,61 @@
     }
     rails>
 
+### IRB integration ###
+To use awesome_print as default formatter in irb and Rails console add the following
+lines into your ~/.irbrc file:
+
+	require "rubygems"
+	require "ap"
+	IRB::Irb.class_eval do
+	  def output_value
+	    ap @context.last_value
+	  end
+	end
+
+### Logger Convenience Method ###
+awesome_print adds an ap method to the Logger and ActiveSupport::BufferedLogger classes,
+allowing you to call:
+
+    logger.ap object
+
+By default, this logs at the :debug level. You can override that globally with
+
+    :log_level => :info
+
+in the custom defaults (see below), or you can override on a per call basis with
+
+    logger.ap object, :warn
+
+### Setting Custom Defaults ###
+You can set your own default options by creating ``.aprc`` file in your home
+directory. Within that file assign your  defaults to ``AwesomePrint.defaults``.
+For example:
+
+    # ~/.aprc file.
+    AwesomePrint.defaults = {
+      :indent => -2,
+      :color => {
+        :hash  => :pale,
+        :class => :white
+      }
+    }
+
 ### Note on Patches/Pull Requests ###
-    * Fork the project on Github.
-    * Make your feature addition or bug fix.
-    * Add specs for it, making sure $ rake spec is all green.
-    * Commit, do not mess with rakefile, version, or history.
-    * Send me a pull request.
+* Fork the project on Github.
+* Make your feature addition or bug fix.
+* Add specs for it, making sure $ rake spec is all green.
+* Commit, do not mess with rakefile, version, or history.
+* Send me a pull request.
+
+### Contributors ###
+
+* Daniel Bretoi -- http://github.com/danielb2
+* eregon -- http://github.com/eregon
+* Tobias Crawley -- http://github.com/tobias
 
 ### License ###
-    Copyright (c) 2010 Michael Dvorkin  
-    %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+Copyright (c) 2010 Michael Dvorkin  
+%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
 
-    Released under the MIT license. See LICENSE file for details.
+Released under the MIT license. See LICENSE file for details.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/ap/awesome_print.rb

@@ -3,9 +3,11 @@
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
+require "shellwords"
+
 class AwesomePrint
   AP = :__awesome_print__
-  CORE = [ :array, :hash, :class, :file, :dir ]
+  CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational ]
 
   def initialize(options = {})
     @options = { 
@@ -14,35 +16,36 @@ class AwesomePrint
       :indent    => 4,
       :color     => { 
         :array      => :white,
-        :bignum     => :blue,
+        :bigdecimal => :blue,
         :class      => :yellow,
         :date       => :greenish,
         :falseclass => :red,
         :fixnum     => :blue,
         :float      => :blue,
-        :hash       => :gray,
+        :hash       => :pale,
         :nilclass   => :red,
         :string     => :yellowish,
         :symbol     => :cyanish,
         :time       => :greenish,
         :trueclass  => :green
-      }.merge(options.delete(:color) || {})
-    }.merge(options)
+      }
+    }
 
-    @indentation = @options[:indent]
-    Thread.current[AP] ||= []
-  end
+    # Merge custom defaults and let explicit options parameter override them.
+    merge_custom_defaults!
+    merge_options!(options)
 
-  def puts(object)
-    Kernel.puts awesome(object)
+    @indentation = @options[:indent].abs
+    Thread.current[AP] ||= []
   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|
@@ -58,21 +61,28 @@ class AwesomePrint
     end
   end
 
-  # Format a hash.
+  # 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 + @indentation
+    width = data.map { |key, | key.size }.max || 0
+    width += @indentation if @options[:indent] > 0
   
     data = data.inject([]) do |arr, (key, value)|
-      formatted_key = (@options[:multiline] ? key.rjust(width) : key) << colorize(" => ", :hash)
+      if @options[:multiline]
+        formatted_key = (@options[:indent] >= 0 ? key.rjust(width) : indent + key.ljust(width))
+      else
+        formatted_key = key
+      end
       indented do
-        arr << (formatted_key << awesome(value))
+        arr << (formatted_key << colorize(" => ", :hash) << awesome(value))
       end
     end
     if @options[:multiline]
@@ -95,17 +105,24 @@ class AwesomePrint
   # Format File object.
   #------------------------------------------------------------------------------
   def awesome_file(f)
-    ls = File.directory?(f) ? `ls -adlF #{f.path}` : `ls -alF #{f.path}`
+    ls = File.directory?(f) ? `ls -adlF #{f.path.shellescape}` : `ls -alF #{f.path.shellescape}`
     awesome_self(f, :with => ls.empty? ? nil : "\n#{ls.chop}")
   end
 
   # Format Dir object.
   #------------------------------------------------------------------------------
   def awesome_dir(d)
-    ls = `ls -alF #{d.path}`
+    ls = `ls -alF #{d.path.shellescape}`
     awesome_self(d, :with => ls.empty? ? nil : "\n#{ls.chop}")
   end
 
+  # Format BigDecimal and Rational objects by convering them to Float.
+  #------------------------------------------------------------------------------
+  def awesome_bigdecimal(n)
+    awesome_self(n.to_f, :as => :bigdecimal)
+  end
+  alias :awesome_rational :awesome_bigdecimal
+
   # Catch all method to format an arbitrary object.
   #------------------------------------------------------------------------------
   def awesome_self(object, appear = {})
@@ -175,20 +192,47 @@ class AwesomePrint
 
   #------------------------------------------------------------------------------
   def indented
-    @indentation += @options[:indent]
+    @indentation += @options[:indent].abs
     yield
   ensure
-    @indentation -= @options[:indent]
+    @indentation -= @options[:indent].abs
   end
 
-  #------------------------------------------------------------------------------
   def indent
-    ' ' * @indentation
+    @indent = ' ' * @indentation
   end
 
-  #------------------------------------------------------------------------------
   def outdent
-    ' ' * (@indentation - @options[:indent])
+    @outdent = ' ' * (@indentation - @options[:indent].abs)
+  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!(self.class.defaults)
+    end
+  rescue => e
+    $stderr.puts "Could not load #{dotfile}: #{e}"
+  end
+
+  # Class accessors for custom defaults.
+  #------------------------------------------------------------------------------
+  def self.defaults
+    @@defaults ||= {}
+  end
+
+  def self.defaults=(args = {})
+    @@defaults = args
   end
 
 end

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/logger.rb

@@ -0,0 +1,18 @@
+# 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
+#------------------------------------------------------------------------------
+module AwesomePrintLogger
+
+  # Add ap method to logger
+  #------------------------------------------------------------------------------
+  def ap(object, level = nil)
+    level ||= AwesomePrint.defaults[:log_level] || :debug
+    send level, object.ai
+  end
+
+end
+
+Logger.send(:include, AwesomePrintLogger) if defined?(Logger)
+ActiveSupport::BufferedLogger.send(:include, AwesomePrintLogger) if defined?(::ActiveSupport::BufferedLogger)

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/lib/ap/mixin/{rails.rb → active_record.rb}

@@ -3,23 +3,22 @@
 # Awesome Print is freely distributable under the terms of MIT license.
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
-module AwesomePrintRails
+module AwesomePrintActiveRecord
 
   def self.included(base)
-    base.alias_method_chain :printable, :rails
+    base.send :alias_method, :printable_without_active_record, :printable
+    base.send :alias_method, :printable, :printable_with_active_record
   end
 
   # Add ActiveRecord class names to the dispatcher pipeline.
   #------------------------------------------------------------------------------
-  def printable_with_rails(object)
-    printable = printable_without_rails(object)
+  def printable_with_active_record(object)
+    printable = printable_without_active_record(object)
     if printable == :self
       if object.is_a?(ActiveRecord::Base)
         printable = :active_record_instance
-      elsif object.is_a?(ActiveSupport::TimeWithZone)
-        printable = :active_support_time
       end
-    elsif printable == :class && object.class.is_a?(ActiveRecord::Base.class)
+    elsif printable == :class and object.ancestors.include?(ActiveRecord::Base)
       printable = :active_record_class
     end
     printable
@@ -38,7 +37,7 @@ module AwesomePrintRails
   # Format ActiveRecord class object.
   #------------------------------------------------------------------------------
   def awesome_active_record_class(object)
-    if object.table_exists?
+    if object.respond_to?(:columns)
       data = object.columns.inject(ActiveSupport::OrderedHash.new) do |hash, c|
         hash[c.name.to_sym] = c.type
         hash
@@ -48,13 +47,7 @@ module AwesomePrintRails
       object.inspect
     end
   end
-
-  # Format ActiveSupport::TimeWithZone as standard Time.
-  #------------------------------------------------------------------------------
-  def awesome_active_support_time(object)
-    awesome_self(object, :as => :time)
-  end
-
+  
 end
 
-AwesomePrint.send(:include, AwesomePrintRails)
+AwesomePrint.send(:include, AwesomePrintActiveRecord)

data/lib/ap/mixin/active_support.rb

@@ -0,0 +1,44 @@
+# 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
+#------------------------------------------------------------------------------
+module AwesomePrintActiveSupport
+
+  def self.included(base)
+    base.send :alias_method, :printable_without_active_support, :printable
+    base.send :alias_method, :printable, :printable_with_active_support
+  end
+
+  # Add ActiveSupport class names to the dispatcher pipeline.
+  #------------------------------------------------------------------------------
+  def printable_with_active_support(object)
+    printable = printable_without_active_support(object)
+    if printable == :self
+      if object.is_a?(ActiveSupport::TimeWithZone)
+        printable = :active_support_time
+      elsif object.is_a?(HashWithIndifferentAccess)
+        printable = :hash_with_indifferent_access
+      end
+    end
+    printable
+  end
+
+  # Format ActiveSupport::TimeWithZone as standard Time.
+  #------------------------------------------------------------------------------
+  def awesome_active_support_time(object)
+    awesome_self(object, :as => :time)
+  end
+
+  # Format HashWithIndifferentAccess as standard Hash.
+  #
+  # NOTE: can't use awesome_self(object, :as => :hash) since awesome_self uses
+  # object.inspect internally, i.e. it would convert hash to string.
+  #------------------------------------------------------------------------------
+  def awesome_hash_with_indifferent_access(object)
+    awesome_hash(object)
+  end
+
+end
+
+AwesomePrint.send(:include, AwesomePrintActiveSupport)

data/lib/ap.rb

@@ -7,4 +7,8 @@ require File.dirname(__FILE__) + "/ap/core_ext/string"
 require File.dirname(__FILE__) + "/ap/core_ext/kernel"
 require File.dirname(__FILE__) + "/ap/awesome_print"
 
-require File.dirname(__FILE__) + "/ap/mixin/rails" if defined?(::Rails)
+require File.dirname(__FILE__) + "/ap/core_ext/logger" if defined?(::Logger) or defined?(::ActiveSupport::BufferedLogger)
+
+require File.dirname(__FILE__) + "/ap/mixin/active_record" if defined?(::ActiveRecord)
+require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(::ActiveSupport)
+

data/spec/active_record_spec.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require 'active_record'
+require 'ap/mixin/active_record'
+
+
+if defined?(::ActiveRecord)
+
+  # Create tableless ActiveRecord model.
+  #------------------------------------------------------------------------------
+  class User < ActiveRecord::Base
+    def self.columns()
+      @columns ||= []
+    end
+
+    def self.column(name, sql_type = nil, default = nil, null = true)
+      columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
+    end
+
+    column :id, :integer
+    column :name, :string
+    column :rank, :integer
+    column :admin, :boolean
+    column :created_at, :datetime
+
+    def self.table_exists?
+      true
+    end
+  end
+  
+  class SubUser < User
+    def self.columns
+      User.columns
+    end
+  end
+  
+  describe "AwesomePrint/ActiveRecord" do
+    before(:each) do
+      stub_dotfile!
+    end
+
+    #------------------------------------------------------------------------------
+    describe "ActiveRecord instance" do
+      before(:each) do
+        ActiveRecord::Base.default_timezone = :utc
+        @diana = User.new(:name => "Diana", :rank => 1, :admin => false, :created_at => "1992-10-10 12:30:00")
+        @laura = User.new(:name => "Laura", :rank => 2, :admin => true,  :created_at => "2003-05-26 14:15:00")
+        @ap = AwesomePrint.new(:plain => true)
+      end
+
+      it "display single record" do
+        out = @ap.send(:awesome, @diana)
+        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+#<User:0x01234567> {
+            :id => nil,
+          :name => "Diana",
+          :rank => 1,
+         :admin => false,
+    :created_at => Sat Oct 10 12:30:00 UTC 1992
+}
+EOS
+      end
+
+      it "display multiple records" do
+        out = @ap.send(:awesome, [ @diana, @laura ])
+        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+[
+    [0] #<User:0x01234567> {
+                :id => nil,
+              :name => "Diana",
+              :rank => 1,
+             :admin => false,
+        :created_at => Sat Oct 10 12:30:00 UTC 1992
+    },
+    [1] #<User:0x01234567> {
+                :id => nil,
+              :name => "Laura",
+              :rank => 2,
+             :admin => true,
+        :created_at => Mon May 26 14:15:00 UTC 2003
+    }
+]
+EOS
+      end
+    end
+
+    #------------------------------------------------------------------------------
+    describe "ActiveRecord class" do
+      it "should print the class" do
+        @ap = AwesomePrint.new(:plain => true)
+        @ap.send(:awesome, User).should == <<-EOS.strip
+class User < ActiveRecord::Base {
+            :id => :integer,
+          :name => :string,
+          :rank => :integer,
+         :admin => :boolean,
+    :created_at => :datetime
+}
+        EOS
+  
+end
+
+it "should print the class for non-direct subclasses of AR::Base" do
+  @ap = AwesomePrint.new(:plain => true)
+  @ap.send(:awesome, SubUser).should == <<-EOS.strip
+class SubUser < User {
+            :id => :integer,
+          :name => :string,
+          :rank => :integer,
+         :admin => :boolean,
+    :created_at => :datetime
+}
+  EOS
+  
+      end
+    end
+  end
+end

data/spec/awesome_print_spec.rb

@@ -1,20 +1,23 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require "bigdecimal"
+require "rational"
 
 describe "AwesomePrint" do
   before(:each) do
-    @color_ap = AwesomePrint.new
-    @plain_ap = AwesomePrint.new(:plain => true)
+    stub_dotfile!
   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 +34,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 +51,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 +72,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 +89,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 +101,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 +111,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 +120,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 +142,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 +158,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 +178,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 +194,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 +207,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,21 +215,34 @@ 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
+
+  #------------------------------------------------------------------------------
+  describe "Negative options[:indent]" do
+    before(:each) do
+      @hash = { [0, 0, 255] => :yellow, :red => "rgb(255, 0, 0)", "magenta" => "rgb(255, 0, 255)" }
+    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
     end
   end
 
   #------------------------------------------------------------------------------
   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
 
@@ -244,7 +250,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
@@ -253,9 +259,33 @@ 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
 
+  #------------------------------------------------------------------------------
+  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"
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Utility methods" do
+    it "should merge options" do
+      ap = AwesomePrint.new
+      ap.send(:merge_options!, { :color => { :array => :black }, :indent => 0 })
+      options = ap.instance_variable_get("@options")
+      options[:color][:array].should == :black
+      options[:indent].should == 0
+    end
+  end
+
 end

data/spec/logger_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+require 'logger'
+require 'ap/core_ext/logger'
+
+describe "AwesomePrint logging extensions" do
+  before(:all) do
+    @logger = Logger.new('/dev/null')
+  end
+
+  describe "ap method" do
+    it "should awesome_inspect the given object" do
+      object = mock
+      object.should_receive(:ai)
+      @logger.ap object
+    end
+    
+    describe "the log level" do
+      before(:each) do
+        AwesomePrint.defaults = { }
+      end
+      
+      it "should fallback to the default :debug log level" do
+        @logger.should_receive(:debug)
+        @logger.ap(nil)
+      end
+
+      it "should use the global user default if no level passed" do
+        AwesomePrint.defaults = { :log_level => :info }
+        @logger.should_receive(:info)
+        @logger.ap(nil)
+      end
+
+      it "should use the passed in level" do
+        @logger.should_receive(:warn)
+        @logger.ap(nil, :warn)
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -3,7 +3,12 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ap'
 require 'spec'
 require 'spec/autorun'
+require 'rubygems'
 
 Spec::Runner.configure do |config|
-  
+end
+
+def stub_dotfile!
+  dotfile = File.join(ENV["HOME"], ".aprc")
+  File.should_receive(:readable?).at_least(:once).with(dotfile).and_return(false)
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 -07:00
+date: 2010-05-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,6 +41,7 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
+- CHANGELOG
 - LICENSE
 - README.md
 - Rakefile
@@ -49,11 +50,14 @@ files:
 - lib/ap.rb
 - lib/ap/awesome_print.rb
 - lib/ap/core_ext/kernel.rb
+- lib/ap/core_ext/logger.rb
 - lib/ap/core_ext/string.rb
-- lib/ap/mixin/rails.rb
+- lib/ap/mixin/active_record.rb
+- lib/ap/mixin/active_support.rb
 - rails/init.rb
+- spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
-- spec/rails_spec.rb
+- spec/logger_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/string_spec.rb
@@ -88,7 +92,8 @@ signing_key:
 specification_version: 3
 summary: Pretty print Ruby objects with proper indentation and colors.
 test_files: 
+- spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
-- spec/rails_spec.rb
+- spec/logger_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb

data/spec/rails_spec.rb

@@ -1,87 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-if defined?(::Rails)
-
-  # Create tableless ActiveRecord model.
-  #------------------------------------------------------------------------------
-  class User < ActiveRecord::Base
-    def self.columns()
-      @columns ||= []
-    end
-
-    def self.column(name, sql_type = nil, default = nil, null = true)
-      columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type.to_s, null)
-    end
-
-    def self.table_exists?
-      true
-    end
-
-    column :id, :integer
-    column :name, :string
-    column :rank, :integer
-    column :admin, :boolean
-    column :created_at, :datetime
-  end
-
-  #------------------------------------------------------------------------------
-  describe "ActiveRecord instance" do
-    before(:each) do
-      @diana = User.new(:name => "Diana", :rank => 1, :admin => false, :created_at => "1992-10-10 12:30:00")
-      @laura = User.new(:name => "Laura", :rank => 2, :admin => true,  :created_at => "2003-05-26 14:15:00")
-      @ap = AwesomePrint.new(:plain => true)
-    end
-
-    it "display single record" do
-      out = @ap.send(:awesome, @diana)
-      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
-#<User:0x01234567> {
-            :id => nil,
-          :name => "Diana",
-          :rank => 1,
-         :admin => false,
-    :created_at => Sat, 10 Oct 1992 12:30:00 UTC +00:00
-}
-EOS
-    end
-
-    it "display multiple records" do
-      out = @ap.send(:awesome, [ @diana, @laura ])
-      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
-[
-    [0] #<User:0x01234567> {
-                :id => nil,
-              :name => "Diana",
-              :rank => 1,
-             :admin => false,
-        :created_at => Sat, 10 Oct 1992 12:30:00 UTC +00:00
-    },
-    [1] #<User:0x01234567> {
-                :id => nil,
-              :name => "Laura",
-              :rank => 2,
-             :admin => true,
-        :created_at => Mon, 26 May 2003 14:15:00 UTC +00:00
-    }
-]
-EOS
-    end
-  end
-
-  #------------------------------------------------------------------------------
-  describe "ActiveRecord class" do
-    it "should" do
-      @ap = AwesomePrint.new(:plain => true)
-      @ap.send(:awesome, User).should == <<-EOS.strip
-class User < ActiveRecord::Base {
-            :id => :integer,
-          :name => :string,
-          :rank => :integer,
-         :admin => :boolean,
-    :created_at => :datetime
-}
-EOS
-    end
-  end
-
-end