awesome_print 1.0.0 → 1.1.0

data/.gitignore

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

data/CHANGELOG

@@ -1,3 +1,24 @@
+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
+  - ActiveSupport::Date objects get formatted as regular Date
+  - Rails.logger.ap colorizes output based on ActiveSupport::LogSubscriber.colorize_logging (default is true)
+  - Improved formatting of methods array
+
+1.0.1
+  - Updated repo tags for Rubygems.org
+
 1.0.0 Thanksgiving edition
   - Added ability to format *arbitrary* Ruby object
   - Added :limit option to limit large output for arrays and hashes (Andrew Horsman)

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,
@@ -229,24 +231,17 @@ Supported color names:
 
 ### IRB integration ###
 To use awesome_print as default formatter in irb and Rails console add the following
-lines into your ~/.irbrc file:
+code to your ~/.irbrc file:
 
-	require "rubygems"
 	require "awesome_print"
+  AwesomePrint.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
+### 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 "awesome_print"
+  AwesomePrint.pry!
 
 ### Logger Convenience Method ###
 awesome_print adds the 'ap' method to the Logger and ActiveSupport::BufferedLogger classes
@@ -266,7 +261,8 @@ in the custom defaults (see below). You can also override on a per call basis wi
 awesome_print adds the 'ap' method to the ActionView::Base class making it available
 within Rails templates. For example:
 
-    <%= ap @accounts.first %>
+    <%= ap @accounts.first %>   # ERB
+    != ap @accounts.first       # HAML
 
 With other web frameworks (ex: in Sinatra templates) you can explicitly request HTML
 formatting:
@@ -298,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/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,17 +1,22 @@
-# 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
 #------------------------------------------------------------------------------
 class Class #:nodoc:
+  #
+  # Intercept methods below to inject @__awesome_print__ instance variable
+  # so we know it is the *methods* array when formatting an array.
+  #
   # Remaining public/private etc. '_methods' are handled in core_ext/object.rb.
+  #
   %w(instance_methods private_instance_methods protected_instance_methods public_instance_methods).each do |name|
     original_method = instance_method(name)
 
     define_method name do |*args|
       methods = original_method.bind(self).call(*args)
-      methods.instance_variable_set('@__awesome_methods__', self) # Evil?!
-      methods.sort!
+      methods.instance_variable_set('@__awesome_methods__', self)
+      methods
     end
   end
 end

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
@@ -17,4 +17,4 @@ module AwesomePrint
 end
 
 Logger.send(:include, AwesomePrint::Logger)
-ActiveSupport::BufferedLogger.send(:include, AwesomePrint::Logger) if defined?(::ActiveSupport::BufferedLogger)
+ActiveSupport::BufferedLogger.send(:include, AwesomePrint::Logger) if defined?(ActiveSupport::BufferedLogger)

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,17 +1,22 @@
-# 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
 #------------------------------------------------------------------------------
 class Object #:nodoc:
+  #
+  # Intercept methods below to inject @__awesome_print__ instance variable
+  # so we know it is the *methods* array when formatting an array.
+  #
   # Remaining instance '_methods' are handled in core_ext/class.rb.
+  #
   %w(methods private_methods protected_methods public_methods singleton_methods).each do |name|
     original_method = instance_method(name)
 
     define_method name do |*args|
       methods = original_method.bind(self).call(*args)
-      methods.instance_variable_set('@__awesome_methods__', self) # Evil?!
-      methods.sort!
+      methods.instance_variable_set('@__awesome_methods__', self)
+      methods
     end
   end
 end

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
@@ -15,4 +15,4 @@ module AwesomePrint
   end
 end
 
-ActionView::Base.send(:include, AwesomePrint::ActionView) if defined?(ActionView)
+ActionView::Base.send(:include, AwesomePrint::ActionView)

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
@@ -15,14 +15,40 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def cast_with_active_record(object, type)
       cast = cast_without_active_record(object, type)
-      if defined?(::ActiveRecord) && object.is_a?(Class) && object.ancestors.include?(::ActiveRecord::Base)
+      return cast if !defined?(::ActiveRecord)
+
+      if object.is_a?(::ActiveRecord::Base)
+        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
 
     private
 
+    # Format ActiveRecord instance object.
+    #
+    # NOTE: by default only instance attributes (i.e. columns) are shown. To format
+    # ActiveRecord instance as regular object showing its instance variables and
+    # accessors use :raw => true option:
+    #
+    # ap record, :raw => true
+    #
+    #------------------------------------------------------------------------------
+    def awesome_active_record_instance(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
+      return awesome_object(object) if @options[:raw]
+
+      data = object.class.column_names.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
+        hash[name.to_sym] = object.send(name) if object.has_attribute?(name) || object.new_record?
+        hash
+      end
+      "#{object} " << awesome_hash(data)
+    end
+
     # Format ActiveRecord class object.
     #------------------------------------------------------------------------------
     def awesome_active_record_class(object)

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)
+        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
@@ -38,3 +38,10 @@ module AwesomePrint
 end
 
 AwesomePrint::Formatter.send(:include, AwesomePrint::ActiveSupport)
+#
+# Colorize Rails logs.
+#
+if defined?(ActiveSupport::LogSubscriber)
+  AwesomePrint.force_colors! ActiveSupport::LogSubscriber.colorize_logging
+end
+

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
@@ -15,8 +15,14 @@ module AwesomePrint
     #------------------------------------------------------------------------------
     def cast_with_mongoid(object, type)
       cast = cast_without_mongoid(object, type)
-      if defined?(::Mongoid::Document) && object.is_a?(Class) && object.ancestors.include?(::Mongoid::Document)
-        cast = :mongoid_class
+      if defined?(::Mongoid::Document)
+        if object.is_a?(Class) && object.ancestors.include?(::Mongoid::Document)
+          cast = :mongoid_class
+        elsif object.class.ancestors.include?(::Mongoid::Document)
+          cast = :mongoid_document
+        elsif (defined?(::BSON) && object.is_a?(::BSON::ObjectId)) || (defined?(::Moped) && object.is_a?(::Moped::BSON::ObjectId))
+          cast = :mongoid_bson_id
+        end
       end
       cast
     end
@@ -26,13 +32,33 @@ module AwesomePrint
     def awesome_mongoid_class(object)
       return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:fields)
 
-      data = object.fields.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
-        hash[c[1].name] = (c[1].type || "undefined").to_s.underscore.intern
-        # hash[c[1].name] = (c[1].type || "undefined").to_s.underscore.intern rescue c[1].type
+      data = object.fields.sort_by { |key| key }.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
+        hash[c[1].name.to_sym] = (c[1].type || "undefined").to_s.underscore.intern
         hash
       end
       "class #{object} < #{object.superclass} " << awesome_hash(data)
     end
+
+    # Format Mongoid Document object.
+    #------------------------------------------------------------------------------
+    def awesome_mongoid_document(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
+
+      data = object.attributes.sort_by { |key| key }.inject(::ActiveSupport::OrderedHash.new) do |hash, c|
+        hash[c[0].to_sym] = c[1]
+        hash
+      end
+      if !object.errors.empty?
+        data = {:errors => object.errors, :attributes => data}
+      end
+      "#{object} #{awesome_hash(data)}"
+    end
+
+    # Format BSON::ObjectId
+    #------------------------------------------------------------------------------
+    def awesome_mongoid_bson_id(object)
+      object.inspect
+    end
   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