awesome_print 1.0.2 → 1.1.0

data/.gitignore

@@ -20,3 +20,4 @@ pkg
 
 ## PROJECT::SPECIFIC
 .rvmrc
+.idea

data/CHANGELOG

@@ -1,3 +1,14 @@
+1.1.0
+  - Objects are no longer recursively formatted by default. Reenable by using :raw => true option.
+  - ap(object) now returns nil when running under IRB or Pry
+  - Added support for Mongoid 3 and Moped (Nikolaj Nikolajsen)
+  - Improved formatting of MongoMapper objects (George .)
+  - ActiveRecord::Relation now renders as array (Dan Lynn)
+  - Formatting BigDecimal no longer looses precision (Evan Senter)
+  - Added AwesomePrint.irb! and AwesomePrint.pry! convenience methods
+  - Fixed conflict with the colorize gem
+  - Misc tweaks and bug fixes
+
 1.0.2
   - Added formatting of Mongoid documents (Adam Doppelt)
   - ActiveRecord objects display attributes only. Use :raw => true to display the entire object

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    awesome_print (1.0.0)
+    awesome_print (1.0.2)
 
 GEM
   remote: http://rubygems.org/

data/LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2010-2011 Michael Dvorkin
-twitter.com/mid
+Copyright (c) 2010-2012 Michael Dvorkin
+http://www.dvorkin.net
 %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -22,6 +22,7 @@ Default options:
     :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 => {
@@ -37,6 +38,7 @@ Default options:
       :keyword    => :cyan,
       :method     => :purpleish,
       :nilclass   => :red,
+      :rational   => :blue,
       :string     => :yellowish,
       :struct     => :pale,
       :symbol     => :cyanish,
@@ -231,31 +233,15 @@ Supported color names:
 To use awesome_print as default formatter in irb and Rails console add the following
 code to your ~/.irbrc file:
 
-	require "rubygems"
 	require "awesome_print"
-
-	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
+  AwesomePrint.irb!
 
 ### PRY integration ###
 If you miss awesome_print's way of formatting output, here's how you can use it in place
 of the formatting which comes with pry. Add the following code to your ~/.pryrc:
 
-	require "rubygems"
 	require "awesome_print"
-	
-	Pry.print = proc { |output, value| output.puts value.ai }
+  AwesomePrint.pry!
 
 ### Logger Convenience Method ###
 awesome_print adds the 'ap' method to the Logger and ActiveSupport::BufferedLogger classes
@@ -308,31 +294,38 @@ For example:
 * 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.
+* Send me commit URL (*do not* send me pull requests).
 
 ### Contributors ###
 
 * Adam Doppelt -- https://github.com/gurgeous
 * Andrew O'Brien -- https://github.com/AndrewO
 * Andrew Horsman -- https://github.com/basicxman
+* Barry Allard -- https://github.com/steakknife
 * Benoit Daloze -- http://github.com/eregon
 * Brandon Zylstra -- https://github.com/brandondrew
+* Dan Lynn -- https://github.com/danlynn
 * Daniel Johnson -- https://github.com/adhd360
 * Daniel Bretoi -- http://github.com/danielb2
 * Eloy Duran -- http://github.com/alloy
 * Elpizo Choi -- https://github.com/fuJiin
+* Evan Senter -- https://github.com/evansenter
+* George . -- https://github.com/gardelea
 * Greg Weber -- https://github.com/gregwebs
 * Jeff Felchner -- https://github.com/jfelchner
+* Nikolaj Nikolajsen -- https://github.com/nikolajsen
+* Ryan Schlesinger -- https://github.com/ryansch
 * Sean Gallagher -- http://github.com/torandu
 * Stephan Hagemann -- https://github.com/shageman
 * Tim Harper -- http://github.com/timcharper
 * Tobias Crawley -- http://github.com/tobias
+* Thibaut Barrère -- https://github.com/thbar
 * Viktar Basharymau -- https://github.com/DNNX
 
 ### License ###
-Copyright (c) 2010-2011 Michael Dvorkin
+Copyright (c) 2010-2012 Michael Dvorkin
 
-twitter.com/mid
+http://www.dvorkin.net
 
 %w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
 

data/Rakefile

@@ -1,2 +1,11 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run all awesome_print gem specs"
+task :spec do
+  # Run plain rspec command without RSpec::Core::RakeTask overrides.
+  exec "rspec -c spec"
+end
+

data/lib/ap.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

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,13 +16,15 @@ 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::Base)
   require File.dirname(__FILE__) + "/awesome_print/ext/mongo_mapper"   if defined?(MongoMapper)
   require File.dirname(__FILE__) + "/awesome_print/ext/mongoid"        if defined?(Mongoid)

data/lib/awesome_print/core_ext/array.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
@@ -58,7 +58,17 @@ class Array #:nodoc:
       original_grep(pattern)
     else
       original_grep(pattern) do |match|
-        eval("%Q/#{match.to_s.gsub('/', '\/')}/ =~ #{pattern.inspect}", blk.binding)
+        #
+        # The binding can only be used with Ruby-defined methods, therefore
+        # we must rescue potential "ArgumentError: Can't create Binding from
+        # C level Proc" error.
+        #
+        # For example, the following raises ArgumentError since #succ method
+        # is defined in C.
+        #
+        # [ 0, 1, 2, 3, 4 ].grep(1..2, &:succ)
+        #
+        eval("%Q/#{match.to_s.gsub('/', '\/')}/ =~ #{pattern.inspect}", blk.binding) rescue ArgumentError
         yield match
       end
     end

data/lib/awesome_print/core_ext/class.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

data/lib/awesome_print/core_ext/kernel.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
@@ -13,7 +13,7 @@ module Kernel
 
   def ap(object, options = {})
     puts object.ai(options)
-    object
+    object unless AwesomePrint.console?
   end
   alias :awesome_print :ap
 

data/lib/awesome_print/core_ext/logger.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

data/lib/awesome_print/core_ext/method.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

data/lib/awesome_print/core_ext/object.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

data/lib/awesome_print/core_ext/string.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

data/lib/awesome_print/ext/action_view.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

data/lib/awesome_print/ext/active_record.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
@@ -21,6 +21,8 @@ module AwesomePrint
         cast = :active_record_instance
       elsif object.is_a?(Class) && object.ancestors.include?(::ActiveRecord::Base)
         cast = :active_record_class
+      elsif type == :activerecord_relation
+        cast = :array
       end
       cast
     end

data/lib/awesome_print/ext/active_support.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,7 +14,7 @@ module AwesomePrint
     def cast_with_active_support(object, type)
       cast = cast_without_active_support(object, type)
       if defined?(::ActiveSupport) && defined?(::HashWithIndifferentAccess)
-        if object.is_a?(::ActiveSupport::TimeWithZone) || object.is_a?(::Date)
+        if (defined?(::ActiveSupport::TimeWithZone) && object.is_a?(::ActiveSupport::TimeWithZone)) || object.is_a?(::Date)
           cast = :active_support_time
         elsif object.is_a?(::HashWithIndifferentAccess)
           cast = :hash_with_indifferent_access

data/lib/awesome_print/ext/mongo_mapper.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,10 +14,21 @@ module AwesomePrint
     # Add MongoMapper class names to the dispatcher pipeline.
     #------------------------------------------------------------------------------
     def cast_with_mongo_mapper(object, type)
+      apply_default_mongo_mapper_options
       cast = cast_without_mongo_mapper(object, type)
-      if defined?(::MongoMapper::Document) && object.is_a?(Class) && (object.ancestors & [ ::MongoMapper::Document, ::MongoMapper::EmbeddedDocument ]).size > 0
-        cast = :mongo_mapper_class
+
+      if defined?(::MongoMapper::Document)
+        if object.is_a?(Class) && (object.ancestors & [ ::MongoMapper::Document, ::MongoMapper::EmbeddedDocument ]).size > 0
+          cast = :mongo_mapper_class
+        elsif object.is_a?(::MongoMapper::Document) || object.is_a?(::MongoMapper::EmbeddedDocument)
+          cast = :mongo_mapper_instance
+        elsif object.is_a?(::MongoMapper::Plugins::Associations::Base)
+          cast = :mongo_mapper_association
+        elsif object.is_a?(::BSON::ObjectId)
+          cast = :mongo_mapper_bson_id
+        end
       end
+
       cast
     end
 
@@ -30,8 +41,80 @@ module AwesomePrint
         hash[c.first] = (c.last.type || "undefined").to_s.underscore.intern
         hash
       end
+
+      # Add in associations
+      if @options[:mongo_mapper][:show_associations]
+        object.associations.each do |name, assoc|
+          data[name.to_s] = assoc
+        end
+      end
+
       "class #{object} < #{object.superclass} " << awesome_hash(data)
     end
+
+    # Format MongoMapper instance object.
+    #
+    # NOTE: by default only instance attributes (i.e. keys) are shown. To format
+    # MongoMapper instance as regular object showing its instance variables and
+    # accessors use :raw => true option:
+    #
+    # ap record, :raw => true
+    #
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_instance(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
+      return awesome_object(object) if @options[:raw]
+
+      data = object.keys.keys.sort_by{|k| k}.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
+        hash[name] = object[name]
+        hash
+      end
+
+      # Add in associations
+      if @options[:mongo_mapper][:show_associations]
+        object.associations.each do |name, assoc|
+          if @options[:mongo_mapper][:inline_embedded] and assoc.embeddable?
+            data[name.to_s] = object.send(name)
+          else
+            data[name.to_s] = assoc
+          end
+        end
+      end
+
+      label = object.to_s
+      label = "#{colorize('embedded', :assoc)} #{label}" if object.is_a?(::MongoMapper::EmbeddedDocument)
+
+      "#{label} " << awesome_hash(data)
+    end
+
+    # Format MongoMapper association object.
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_association(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
+      return awesome_object(object) if @options[:raw]
+
+      association = object.class.name.split('::').last.titleize.downcase.sub(/ association$/,'')
+      association = "embeds #{association}" if object.embeddable?
+      class_name = object.class_name
+
+      "#{colorize(association, :assoc)} #{colorize(class_name, :class)}"
+    end
+
+    # Format BSON::ObjectId
+    #------------------------------------------------------------------------------
+    def awesome_mongo_mapper_bson_id(object)
+      object.inspect
+    end
+
+    private
+
+    def apply_default_mongo_mapper_options
+      @options[:color][:assoc] ||= :greenish
+      @options[:mongo_mapper]  ||= {
+        :show_associations => false, # Display association data for MongoMapper documents and classes.
+        :inline_embedded => false    # Display embedded associations inline with MongoMapper documents.
+      }
+    end
   end
 end
 

data/lib/awesome_print/ext/mongoid.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
@@ -20,7 +20,7 @@ module AwesomePrint
           cast = :mongoid_class
         elsif object.class.ancestors.include?(::Mongoid::Document)
           cast = :mongoid_document
-        elsif object.is_a?(::BSON::ObjectId)
+        elsif (defined?(::BSON) && object.is_a?(::BSON::ObjectId)) || (defined?(::Moped) && object.is_a?(::Moped::BSON::ObjectId))
           cast = :mongoid_bson_id
         end
       end

data/lib/awesome_print/ext/nokogiri.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

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
@@ -39,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
 
@@ -54,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.
@@ -189,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.
     #------------------------------------------------------------------------------

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.2'
+    '1.1.0'
   end
 end

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
 

data/spec/misc_spec.rb

@@ -0,0 +1,213 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AwesomePrint" do
+
+  describe "Misc" do
+    before do
+      stub_dotfile!
+    end
+
+    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.sort.grep(/^(\d+)\//) { $1 }
+      grepped.ai(:plain => true, :multiline => false).should == '[ "1", "2" ]'
+    end
+
+    # See https://github.com/michaeldv/awesome_print/issues/85
+    if RUBY_VERSION >= "1.8.7"
+      it "handle array grep when a method is defined in C and thus doesn't have a binding" do
+        arr = (0..6).to_a
+        grepped = arr.grep(1..4, &:succ)
+        grepped.ai(:plain => true, :multiline => false).should == '[ 2, 3, 4, 5 ]'
+      end
+    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
+    before do
+      stub_dotfile!
+    end
+
+    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 "AwesomePrint.defaults" do
+    before do
+      stub_dotfile!
+    end
+
+    after do
+      AwesomePrint.defaults = nil
+    end
+
+    # See https://github.com/michaeldv/awesome_print/issues/98
+    it "should properly merge the defaults" do
+      AwesomePrint.defaults = { :indent => -2, :sort_keys => true }
+      hash = { [0, 0, 255] => :yellow, :red => "rgb(255, 0, 0)", "magenta" => "rgb(255, 0, 255)" }
+      out = hash.ai(:plain => true)
+      out.should == <<-EOS.strip
+{
+  [ 0, 0, 255 ] => :yellow,
+  "magenta"     => "rgb(255, 0, 255)",
+  :red          => "rgb(255, 0, 0)"
+}
+EOS
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Coexistence with the colorize gem" do
+    before do
+      stub_dotfile!
+    end
+
+    before do # Redefine String#red just like colorize gem does it.
+      @awesome_method = "".method(:red)
+
+      String.instance_eval do
+        define_method :red do   # Method arity is now 0 in Ruby 1.9+.
+          "[red]#{self}[/red]"
+        end
+      end
+    end
+
+    after do # Restore String#red method.
+      awesome_method = @awesome_method
+      String.instance_eval do
+        define_method :red, awesome_method
+      end
+    end
+
+    it "shoud not raise ArgumentError when formatting HTML" do
+      out = "hello".ai(:color => { :string => :red }, :html => true)
+      if RUBY_VERSION >= "1.9"
+        out.should == %Q|<pre>[red]<kbd style="color:red">&quot;hello&quot;</kbd>[/red]</pre>|
+      else
+        out.should == %Q|<pre>[red]&quot;hello&quot;[/red]</pre>|
+      end
+    end
+
+    it "shoud not raise ArgumentError when formatting HTML (shade color)" do
+      out = "hello".ai(:color => { :string => :redish }, :html => true)
+      out.should == %Q|<pre><kbd style="color:darkred">&quot;hello&quot;</kbd></pre>|
+    end
+
+    it "shoud not raise ArgumentError when formatting non-HTML" do
+      out = "hello".ai(:color => { :string => :red }, :html => false)
+      out.should == %Q|[red]"hello"[/red]|
+    end
+
+    it "shoud not raise ArgumentError when formatting non-HTML (shade color)" do
+      out = "hello".ai(:color => { :string => :redish }, :html => false)
+      out.should == %Q|\e[0;31m"hello"\e[0m|
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Console" do
+    it "should detect IRB" do
+      class IRB; end
+      AwesomePrint.console?.should == true
+      AwesomePrint.rails_console?.should == false
+      Object.instance_eval{ remove_const :IRB }
+    end
+
+    it "should detect Pry" do
+      class Pry; end
+      AwesomePrint.console?.should == true
+      AwesomePrint.rails_console?.should == false
+      Object.instance_eval{ remove_const :Pry }
+    end
+
+    it "should detect Rails::Console" do
+      class IRB; end
+      class Rails; class Console; end; end
+      AwesomePrint.console?.should == true
+      AwesomePrint.rails_console?.should == true
+      Object.instance_eval{ remove_const :IRB }
+      Object.instance_eval{ remove_const :Rails }
+    end
+
+    it "should detect ENV['RAILS_ENV']" do
+      class Pry; end
+      ENV["RAILS_ENV"] = "development"
+      AwesomePrint.console?.should == true
+      AwesomePrint.rails_console?.should == true
+      Object.instance_eval{ remove_const :Pry }
+    end
+
+    it "should return the actual object when *not* running under console" do
+      capture! { ap([ 1, 2, 3 ]) }.should == [ 1, 2, 3 ]
+      capture! { ap({ :a => 1 }) }.should == { :a => 1 }
+    end
+
+    it "should return nil when running under console" do
+      class IRB; end
+      capture! { ap([ 1, 2, 3 ]) }.should == nil
+      capture! { ap({ :a => 1 }) }.should == nil
+      Object.instance_eval{ remove_const :IRB }
+    end
+  end
+end

data/spec/objects_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "Single method" do
+describe "Objects" do
   before do
     stub_dotfile!
   end
@@ -9,7 +9,7 @@ describe "Single method" do
     Object.instance_eval{ remove_const :Hello } if defined?(Hello)
   end
 
-  describe "object" do
+  describe "Formatting an object" do
     it "attributes" do
       class Hello
         attr_reader   :abra
@@ -21,7 +21,8 @@ describe "Single method" do
         end
       end
 
-      out = Hello.new.ai(:plain => true)
+      hello = Hello.new
+      out = hello.ai(:plain => true, :raw => true)
       str = <<-EOS.strip
 #<Hello:0x01234567
     attr_accessor :dabra = 3,
@@ -30,6 +31,7 @@ describe "Single method" do
 >
 EOS
       out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+      hello.ai(:plain => true, :raw => false).should == hello.inspect
     end
 
     it "instance variables" do
@@ -39,7 +41,8 @@ EOS
         end
       end
 
-      out = Hello.new.ai(:plain => true)
+      hello = Hello.new
+      out = hello.ai(:plain => true, :raw => true)
       str = <<-EOS.strip
 #<Hello:0x01234567
     @abra = 1,
@@ -48,6 +51,7 @@ EOS
 >
 EOS
       out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+      hello.ai(:plain => true, :raw => false).should == hello.inspect
     end
 
     it "attributes and instance variables" do
@@ -62,7 +66,8 @@ EOS
         end
       end
 
-      out = Hello.new.ai(:plain => true)
+      hello = Hello.new
+      out = hello.ai(:plain => true, :raw => true)
       str = <<-EOS.strip
 #<Hello:0x01234567
     @doo = 1,
@@ -74,6 +79,7 @@ EOS
 >
 EOS
       out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+      hello.ai(:plain => true, :raw => false).should == hello.inspect
     end
   end
 end

data/spec/spec_helper.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
@@ -6,7 +6,13 @@
 #
 # Running specs from the command line:
 #   $ rake spec                   # Entire spec suite.
-#   $ rspec spec/logger_spec.rb   # Individual spec file.
+#   $ rspec spec/objects_spec.rb  # Individual spec file.
+#
+# NOTE: To successfully run specs with Ruby 1.8.6 the older versions of
+# Bundler and RSpec gems are required:
+#
+# $ gem install bundler -v=1.0.2
+# $ gem install rspec -v=2.6.0
 #
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -17,6 +23,13 @@ def stub_dotfile!
   File.should_receive(:readable?).at_least(:once).with(dotfile).and_return(false)
 end
 
+def capture!
+  standard, $stdout = $stdout, StringIO.new
+  yield
+ensure
+  $stdout = standard
+end
+
 # The following is needed for the Infinity Test. It runs tests as subprocesses,
 # which sets STDOUT.tty? to false and would otherwise prematurely disallow colors.
 ### AwesomePrint.force_colors!

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awesome_print
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
-  version: 1.0.2
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-20 00:00:00 Z
+date: 2012-09-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -20,6 +25,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
         version: 2.6.0
   type: :development
   version_requirements: *id001
@@ -31,6 +41,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 2
+        - 1
         version: 0.2.1
   type: :development
   version_requirements: *id002
@@ -70,6 +85,7 @@ files:
 - spec/colors_spec.rb
 - spec/formats_spec.rb
 - spec/methods_spec.rb
+- spec/misc_spec.rb
 - spec/objects_spec.rb
 - spec/spec_helper.rb
 - .gitignore
@@ -86,17 +102,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: awesome_print
-rubygems_version: 1.8.5
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Pretty print Ruby objects with proper indentation and colors
@@ -104,5 +126,6 @@ test_files:
 - spec/colors_spec.rb
 - spec/formats_spec.rb
 - spec/methods_spec.rb
+- spec/misc_spec.rb
 - spec/objects_spec.rb
 - spec/spec_helper.rb