awesome_print 1.0.1 → 1.0.2

data/CHANGELOG

@@ -1,3 +1,10 @@
+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
 

data/README.md

@@ -229,7 +229,7 @@ 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"
@@ -248,6 +248,15 @@ lines into your ~/.irbrc file:
 	  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 "rubygems"
+	require "awesome_print"
+	
+	Pry.print = proc { |output, value| output.puts value.ai }
+
 ### Logger Convenience Method ###
 awesome_print adds the 'ap' method to the Logger and ActiveSupport::BufferedLogger classes
 letting you call:
@@ -266,7 +275,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:

data/lib/awesome_print.rb

@@ -23,7 +23,7 @@ unless defined?(AwesomePrint)
   require File.dirname(__FILE__) + "/awesome_print/ext/active_support" if defined?(ActiveSupport) || (defined?(IRB) && ENV['RAILS_ENV'])
 
   # Load remaining extensions.
-  require File.dirname(__FILE__) + "/awesome_print/ext/action_view"    if defined?(ActionView)
+  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)
   require File.dirname(__FILE__) + "/awesome_print/ext/nokogiri"       if defined?(Nokogiri)

data/lib/awesome_print/core_ext/class.rb

@@ -4,14 +4,19 @@
 # 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/logger.rb

@@ -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/object.rb

@@ -4,14 +4,19 @@
 # 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/ext/action_view.rb

@@ -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

@@ -15,7 +15,11 @@ 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
       end
       cast
@@ -23,6 +27,26 @@ module AwesomePrint
 
     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

@@ -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 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/mongoid.rb

@@ -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 object.is_a?(::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/formatter.rb

@@ -25,12 +25,13 @@ module AwesomePrint
       awesome = if core_class != :self
         send(:"awesome_#{core_class}", object) # Core formatters.
       else
-        awesome_self(object, type) # Catch all that falls back on object.inspect.
+        awesome_self(object, type) # Catch all that falls back to object.inspect.
       end
       @options[:html] ? "<pre>#{awesome}</pre>" : awesome
     end
 
-    # Hook this when adding custom formatters.
+    # Hook this when adding custom formatters. Check out lib/awesome_print/ext
+    # directory for custom formatters that ship with awesome_print.
     #------------------------------------------------------------------------------
     def cast(object, type)
       CORE.grep(type)[0] || :self
@@ -212,17 +213,20 @@ module AwesomePrint
     # Format object.methods array.
     #------------------------------------------------------------------------------
     def methods_array(a)
+      a.sort! { |x, y| x.to_s <=> y.to_s }                  # Can't simply a.sort! because of o.methods << [ :blah ]
       object = a.instance_variable_get('@__awesome_methods__')
       tuples = a.map do |name|
-        tuple = if object.respond_to?(name, true)         # Is this a regular method?
-          the_method = object.method(name) rescue nil     # Avoid potential ArgumentError if object#method is overridden.
-          if the_method && the_method.respond_to?(:arity) # Is this original object#method?
-            method_tuple(the_method)                      # Yes, we are good.
+        if name.is_a?(Symbol) || name.is_a?(String)         # Ignore garbage, ex. 42.methods << [ :blah ]
+          tuple = if object.respond_to?(name, true)         # Is this a regular method?
+            the_method = object.method(name) rescue nil     # Avoid potential ArgumentError if object#method is overridden.
+            if the_method && the_method.respond_to?(:arity) # Is this original object#method?
+              method_tuple(the_method)                      # Yes, we are good.
+            end
+          elsif object.respond_to?(:instance_method)        # Is this an unbound method?
+            method_tuple(object.instance_method(name))
           end
-        elsif object.respond_to?(:instance_method)        # Is this an unbound method?
-          method_tuple(object.instance_method(name))
         end
-        tuple || [ name.to_s, '(?)', '' ]                 # Return WTF default if all the above fails.
+        tuple || [ name.to_s, '(?)', '?' ]                  # Return WTF default if all the above fails.
       end
 
       width = (tuples.size - 1).to_s.size
@@ -259,14 +263,27 @@ module AwesomePrint
         args[-1] = "*#{args[-1]}" if method.arity < 0
       end
 
-      if method.to_s =~ /(Unbound)*Method: (.*?)[#\.]/
-        owner = "#{$2}#{$1 ? '(unbound)' : ''}".gsub('(', ' (')
+      # method.to_s formats to handle:
+      #
+      # #<Method: Fixnum#zero?>
+      # #<Method: Fixnum(Integer)#years>
+      # #<Method: User(#<Module:0x00000103207c00>)#_username>
+      # #<Method: User(id: integer, username: string).table_name>
+      # #<Method: User(id: integer, username: string)(ActiveRecord::Base).current>
+      # #<UnboundMethod: Hello#world>
+      #
+      if method.to_s =~ /(Unbound)*Method: (.*)[#\.]/
+        unbound, klass = $1 && '(unbound)', $2
+        if klass && klass =~ /(\(\w+:\s.*?\))/  # Is this ActiveRecord-style class?
+          klass.sub!($1, '')                    # Yes, strip the fields leaving class name only.
+        end
+        owner = "#{klass}#{unbound}".gsub('(', ' (')
       end
 
       [ method.name.to_s, "(#{args.join(', ')})", owner.to_s ]
     end
 
-    # Format hash keys as plain string regardless of underlying data type.
+    # Format hash keys as plain strings regardless of underlying data type.
     #------------------------------------------------------------------------------
     def plain_single_line
       plain, multiline = @options[:plain], @options[:multiline]
@@ -314,7 +331,25 @@ module AwesomePrint
       ' ' * (@indentation - @options[:indent].abs)
     end
 
-    # To support limited output.
+    # To support limited output, for example:
+    #
+    # ap ('a'..'z').to_a, :limit => 3
+    # [
+    #     [ 0] "a",
+    #     [ 1] .. [24],
+    #     [25] "z"
+    # ]
+    #
+    # ap (1..100).to_a, :limit => true # Default limit is 7.
+    # [
+    #     [ 0] 1,
+    #     [ 1] 2,
+    #     [ 2] 3,
+    #     [ 3] .. [96],
+    #     [97] 98,
+    #     [98] 99,
+    #     [99] 100
+    # ]
     #------------------------------------------------------------------------------
     def should_be_limited?
       @options[:limit] == true or (@options[:limit].is_a?(Fixnum) and @options[:limit] > 0)
@@ -345,6 +380,5 @@ module AwesomePrint
         temp
       end
     end
-
   end
 end

data/lib/awesome_print/version.rb

@@ -5,6 +5,6 @@
 #------------------------------------------------------------------------------
 module AwesomePrint
   def self.version
-    '1.0.1'
+    '1.0.2'
   end
 end

data/spec/methods_spec.rb

@@ -445,4 +445,14 @@ describe "Methods arrays" do
     hello = Hello.new
     (hello.send(:his) - hello.send(:her)).sort_by { |x| x.to_s }.should == [ :him, :his ]
   end
+
+  it "appending garbage to methods array should not raise error" do
+    arr = 42.methods << [ :wtf ]
+    arr.ai(:plain => true).should_not raise_error(TypeError)
+    if RUBY_VERSION < '1.9.2'
+      arr.ai(:plain => true).should =~ /\s+wtf\(\?\)\s+\?/      # [ :wtf ].to_s => "wtf"
+    else
+      arr.ai(:plain => true).should =~ /\s+\[:wtf\]\(\?\)\s+\?/ # [ :wtf ].to_s => [:wtf]
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: awesome_print
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-08 00:00:00 Z
+date: 2011-12-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec