awesome_print 0.2.1 → 0.4.0

data/lib/ap/core_ext/method.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2010-2011 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
+#------------------------------------------------------------------------------
+#
+# Method#name was intorduced in Ruby 1.8.7 so we define it here as necessary.
+#
+unless nil.method(:class).respond_to?(:name)
+  class Method
+    def name
+      inspect.split(/[#.>]/)[-1]
+    end
+  end
+
+  class UnboundMethod
+    def name
+      inspect.split(/[#.>]/)[-1]
+    end
+  end
+end

data/lib/ap/core_ext/object.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2010-2011 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:
+  # 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!
+    end
+  end
+end

data/lib/ap/core_ext/string.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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
@@ -11,13 +11,14 @@ class String
   #    1 => bright
   #    0 => normal
 
-  [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each_with_index do |color, i|
-    if STDOUT.tty? && ENV['TERM'] && ENV['TERM'] != 'dumb'
-      define_method color          do "\033[1;#{30+i}m#{self}\033[0m" end
-      define_method :"#{color}ish" do "\033[0;#{30+i}m#{self}\033[0m" end
-    else
-      define_method color do self end
-      alias_method :"#{color}ish", color 
+  %w(gray red green yellow blue purple cyan white).zip(
+  %w(black darkred darkgreen brown navy darkmagenta darkcyan slategray)).each_with_index do |(color, shade), i|
+    define_method color do |*html|
+      html[0] ? %Q|<pre style="color:#{color}">#{self}</pre>| : "\033[1;#{30+i}m#{self}\033[0m"
+    end
+
+    define_method "#{color}ish" do |*html|
+      html[0] ? %Q|<pre style="color:#{shade}">#{self}</pre>| : "\033[0;#{30+i}m#{self}\033[0m"
     end
   end
 

data/lib/ap/mixin/action_view.rb

@@ -1,38 +1,17 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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 AwesomePrintActionView
 
-  def self.included(base)
-    unless base.const_defined?(:AP_ANSI_TO_HTML)
-      hash = {} # Build ANSI => HTML color map.
-      [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each_with_index do |color, i|
-        hash["\033[1;#{30+i}m"] = color
-      end
-      [ :black, :darkred, :darkgreen, :brown, :navy, :darkmagenta, :darkcyan, :slategray ].each_with_index do |color, i|
-        hash["\033[0;#{30+i}m"] = color
-      end
-      base.const_set(:AP_ANSI_TO_HTML, hash.freeze)
-    end
-  end
-
+  # Use HTML colors and add default "debug_dump" class to the resulting HTML.
   def ap_debug(object, options = {})
-    formatted = h(object.ai(options))
-
-    unless options[:plain]
-      self.class::AP_ANSI_TO_HTML.each do |key, value|
-        formatted.gsub!(key, %Q|<font color="#{value}">|)
-      end
-      formatted.gsub!("\033[0m", "</font>")
-    end
-
-    content_tag(:pre, formatted, :class => "debug_dump")
+    object.ai(options.merge(:html => true)).sub(/^<pre([\s>])/, '<pre class="debug_dump"\\1')
   end
 
   alias_method :ap, :ap_debug
 
 end
 
-ActionView::Base.send(:include, AwesomePrintActionView) if defined?(::ActionView)
+ActionView::Base.send(:include, AwesomePrintActionView) if defined?(ActionView)

data/lib/ap/mixin/active_record.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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,8 @@ module AwesomePrintActiveRecord
   #------------------------------------------------------------------------------
   def printable_with_active_record(object)
     printable = printable_without_active_record(object)
+    return printable if !defined?(ActiveRecord::Base)
+
     if printable == :self
       if object.is_a?(ActiveRecord::Base)
         printable = :active_record_instance
@@ -27,6 +29,8 @@ module AwesomePrintActiveRecord
   # Format ActiveRecord instance object.
   #------------------------------------------------------------------------------
   def awesome_active_record_instance(object)
+    return object.inspect if !defined?(ActiveSupport::OrderedHash)
+
     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
@@ -37,17 +41,14 @@ module AwesomePrintActiveRecord
   # Format ActiveRecord class object.
   #------------------------------------------------------------------------------
   def awesome_active_record_class(object)
-    if object.respond_to?(:columns)
-      data = object.columns.inject(ActiveSupport::OrderedHash.new) do |hash, c|
-        hash[c.name.to_sym] = c.type
-        hash
-      end
-      "class #{object} < #{object.superclass} " << awesome_hash(data)
-    else
-      object.inspect
+    return object.inspect if !defined?(ActiveSupport::OrderedHash) || !object.respond_to?(:columns)
+
+    data = object.columns.inject(ActiveSupport::OrderedHash.new) do |hash, c|
+      hash[c.name.to_sym] = c.type
+      hash
     end
+    "class #{object} < #{object.superclass} " << awesome_hash(data)
   end
-  
 end
 
 AwesomePrint.send(:include, AwesomePrintActiveRecord)

data/lib/ap/mixin/active_support.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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,8 @@ module AwesomePrintActiveSupport
   #------------------------------------------------------------------------------
   def printable_with_active_support(object)
     printable = printable_without_active_support(object)
+    return printable if !defined?(ActiveSupport::TimeWithZone) || !defined?(HashWithIndifferentAccess)
+
     if printable == :self
       if object.is_a?(ActiveSupport::TimeWithZone)
         printable = :active_support_time

data/lib/ap/mixin/mongo_mapper.rb

@@ -0,0 +1,54 @@
+# Copyright (c) 2010-2011 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 AwesomePrintMongoMapper
+
+  def self.included(base)
+    base.send :alias_method, :printable_without_mongo_mapper, :printable
+    base.send :alias_method, :printable, :printable_with_mongo_mapper
+  end
+
+  # Add MongoMapper class names to the dispatcher pipeline.
+  #------------------------------------------------------------------------------
+  def printable_with_mongo_mapper(object)
+    printable = printable_without_mongo_mapper(object)
+    return printable if !defined?(MongoMapper::Document)
+
+    if printable == :self
+      if object.is_a?(MongoMapper::Document) || object.is_a?(MongoMapper::EmbeddedDocument)
+        printable = :mongo_mapper_instance
+      end
+    elsif printable == :class && (object.ancestors & [MongoMapper::Document, MongoMapper::EmbeddedDocument]).size > 0
+      printable = :mongo_mapper_class
+    end
+    printable
+  end
+
+  # Format MongoMapper instance object.
+  #------------------------------------------------------------------------------
+  def awesome_mongo_mapper_instance(object)
+    return object.inspect if !defined?(ActiveSupport::OrderedHash)
+
+    data = object.keys.keys.sort_by{|k| k}.inject(ActiveSupport::OrderedHash.new) do |hash, name|
+      hash[name] = object[name]
+      hash
+    end
+    "#{object} " + awesome_hash(data)
+  end
+
+  # Format MongoMapper class object.
+  #------------------------------------------------------------------------------
+  def awesome_mongo_mapper_class(object)
+    return object.inspect if !defined?(ActiveSupport::OrderedHash) || !object.respond_to?(:keys)
+
+    data = object.keys.sort_by{|k| k}.inject(ActiveSupport::OrderedHash.new) do |hash, c|
+      hash[c.first] = (c.last.type || "undefined").to_s.underscore.intern
+      hash
+    end
+    "class #{object} < #{object.superclass} " << awesome_hash(data)
+  end
+end
+
+AwesomePrint.send(:include, AwesomePrintMongoMapper)

data/lib/ap.rb

@@ -1,15 +1,24 @@
-# Copyright (c) 2010 Michael Dvorkin
+# Copyright (c) 2010-2011 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 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/core_ext/logger" if defined?(::Logger) or defined?(::ActiveSupport::BufferedLogger)
+#
+# AwesomePrint might be loaded implicitly through ~/.irbrc so do nothing
+# for subsequent requires.
+#
+unless defined?(AwesomePrint)
+  %w(array string method object class kernel).each do |file|
+    require File.dirname(__FILE__) + "/ap/core_ext/#{file}"
+  end
 
-require File.dirname(__FILE__) + "/ap/mixin/action_view" if defined?(::ActionView)
-require File.dirname(__FILE__) + "/ap/mixin/active_record" if defined?(::ActiveRecord)
-require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(::ActiveSupport)
+  require File.dirname(__FILE__) + "/ap/awesome_print"
+  require File.dirname(__FILE__) + "/ap/core_ext/logger"   if defined?(Logger)
+  require File.dirname(__FILE__) + "/ap/mixin/action_view" if defined?(ActionView)
 
+  # Load the following under normal circumstatnces as well as in Rails
+  # console when required from ~/.irbrc.
+  require File.dirname(__FILE__) + "/ap/mixin/active_record"  if defined?(ActiveRecord)  || (defined?(IRB) && ENV['RAILS_ENV'])
+  require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(ActiveSupport) || (defined?(IRB) && ENV['RAILS_ENV'])
+  require File.dirname(__FILE__) + "/ap/mixin/mongo_mapper"   if defined?(MongoMapper)
+end

data/lib/awesome_print.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2010-2011 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
+#------------------------------------------------------------------------------
+#
+# This is the copy of original 'ap.rb' file that matches the gem name. It makes
+# it possible to omit the :require part in bundler's Gemfile:
+#
+# gem 'awesome_print', '>= 0.4.0'
+#
+unless defined?(AwesomePrint)
+  %w(array string method object class kernel).each do |file|
+    require File.dirname(__FILE__) + "/ap/core_ext/#{file}"
+  end
+
+  require File.dirname(__FILE__) + "/ap/awesome_print"
+  require File.dirname(__FILE__) + "/ap/core_ext/logger"   if defined?(Logger)
+  require File.dirname(__FILE__) + "/ap/mixin/action_view" if defined?(ActionView)
+
+  # Load the following under normal circumstatnces as well as in Rails
+  # console when required from ~/.irbrc.
+  require File.dirname(__FILE__) + "/ap/mixin/active_record"  if defined?(ActiveRecord)  || (defined?(IRB) && ENV['RAILS_ENV'])
+  require File.dirname(__FILE__) + "/ap/mixin/active_support" if defined?(ActiveSupport) || (defined?(IRB) && ENV['RAILS_ENV'])
+  require File.dirname(__FILE__) + "/ap/mixin/mongo_mapper"   if defined?(MongoMapper)
+end

data/rails/init.rb

@@ -1 +1,9 @@
-require File.join(File.dirname(__FILE__), "..", "init")
+# Copyright (c) 2010-2011 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
+#------------------------------------------------------------------------------
+#
+# Load awesome_print when installed as Rails 2.3.x plugin.
+#
+require File.join(File.dirname(__FILE__), "..", "init") unless defined?(AwesomePrint)

data/spec/action_view_spec.rb

@@ -1,35 +1,25 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-require 'action_view'
-require 'ap/mixin/action_view'
+begin
+  require 'action_view'
+  require 'ap/mixin/action_view'
 
-describe "AwesomePrint ActionView extensions" do
-  before(:each) do
-    @view = ActionView::Base.new
-  end
+  describe "AwesomePrint ActionView extension" do
+    before(:each) do
+      @view = ActionView::Base.new
+    end
     
-  it "should wrap ap output with <pre> tag" do
-    obj = 42
-    @view.ap(obj, :plain => true).should == '<pre class="debug_dump">42</pre>'
-  end
-
-  it "should encode HTML entities" do
-    obj = "  &<hello>"
-    @view.ap(obj, :plain => true).should == '<pre class="debug_dump">&quot;  &amp;&lt;hello&gt;&quot;</pre>'
-  end
-
-  it "should convert primary ANSI colors to HTML" do
-    obj = 42
-    [ :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white ].each do |color|
-      @view.ap(obj, :color => { :fixnum => color }).should == %Q|<pre class="debug_dump"><font color="#{color}">42</font></pre>|
+    it "uses HTML and adds 'debug_dump' class to plain <pre> tag" do
+      markup = rand
+      @view.ap(markup, :plain => true).should == %Q|<pre class="debug_dump">#{markup}</pre>|
     end
-  end
 
-  it "should convert mixed ANSI colors to HTML" do
-    obj = 42
-    [ :grayish, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :whiteish, :black, :pale ].zip(
-    [ :black, :darkred, :darkgreen, :brown, :navy, :darkmagenta, :darkcyan, :slategray, :black, :slategray ]) do |ansi, html|
-      @view.ap(obj, :color => { :fixnum => ansi }).should == %Q|<pre class="debug_dump"><font color="#{html}">42</font></pre>|
+    it "uses HTML and adds 'debug_dump' class to colorized <pre> tag" do
+      markup = ' &<hello>'
+      @view.ap(markup).should == '<pre class="debug_dump" style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</pre>'
     end
   end
+
+rescue LoadError
+  puts "Skipping ActionView specs..."
 end

data/spec/active_record_spec.rb

@@ -1,94 +1,110 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-require 'active_record'
-require 'ap/mixin/active_record'
+begin
+  require 'active_record'
+  require 'ap/mixin/active_record'
 
+  if defined?(::ActiveRecord)
 
-if defined?(::ActiveRecord)
-
-  # Create tableless ActiveRecord model.
-  #------------------------------------------------------------------------------
-  class User < ActiveRecord::Base
-    def self.columns()
-      @columns ||= []
-    end
+    # 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.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
+      column :id, :integer
+      column :name, :string
+      column :rank, :integer
+      column :admin, :boolean
+      column :created_at, :datetime
 
-    def self.table_exists?
-      true
+      def self.table_exists?
+        true
+      end
     end
-  end
   
-  class SubUser < User
-    def self.columns
-      User.columns
+    class SubUser < User
+      def self.columns
+        User.columns
+      end
     end
-  end
   
-  describe "AwesomePrint/ActiveRecord" do
-    before(:each) do
-      stub_dotfile!
-    end
-
-    #------------------------------------------------------------------------------
-    describe "ActiveRecord instance" do
+    describe "AwesomePrint/ActiveRecord" 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)
+        stub_dotfile!
       end
 
-      it "display single record" do
-        out = @ap.send(:awesome, @diana)
-        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+      #------------------------------------------------------------------------------
+      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)
+          str = <<-EOS.strip
 #<User:0x01234567> {
             :id => nil,
           :name => "Diana",
           :rank => 1,
          :admin => false,
-    :created_at => Sat Oct 10 12:30:00 UTC 1992
+    :created_at => ?
 }
 EOS
-      end
+          if RUBY_VERSION.to_f < 1.9
+            str.sub!('?', 'Sat Oct 10 12:30:00 UTC 1992')
+          else
+            str.sub!('?', '1992-10-10 12:30:00 UTC')
+          end
+
+          out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+        end
 
-      it "display multiple records" do
-        out = @ap.send(:awesome, [ @diana, @laura ])
-        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+        it "display multiple records" do
+          out = @ap.send(:awesome, [ @diana, @laura ])
+          str = <<-EOS.strip
 [
     [0] #<User:0x01234567> {
                 :id => nil,
               :name => "Diana",
               :rank => 1,
              :admin => false,
-        :created_at => Sat Oct 10 12:30:00 UTC 1992
+        :created_at => ?
     },
     [1] #<User:0x01234567> {
                 :id => nil,
               :name => "Laura",
               :rank => 2,
              :admin => true,
-        :created_at => Mon May 26 14:15:00 UTC 2003
+        :created_at => !
     }
 ]
 EOS
+          if RUBY_VERSION.to_f < 1.9
+            str.sub!('?', 'Sat Oct 10 12:30:00 UTC 1992')
+            str.sub!('!', 'Mon May 26 14:15:00 UTC 2003')
+          else
+            str.sub!('?', '1992-10-10 12:30:00 UTC')
+            str.sub!('!', '2003-05-26 14:15:00 UTC')
+          end
+
+          out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+        end
       end
-    end
 
-    #------------------------------------------------------------------------------
-    describe "ActiveRecord class" do
-      it "should print the class" do
-        @ap = AwesomePrint.new(:plain => true)
-        @ap.send(:awesome, User).should == <<-EOS.strip
+      #------------------------------------------------------------------------------
+      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,
@@ -96,13 +112,12 @@ class User < ActiveRecord::Base {
          :admin => :boolean,
     :created_at => :datetime
 }
-        EOS
-  
-end
+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
+        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,
@@ -110,9 +125,12 @@ class SubUser < User {
          :admin => :boolean,
     :created_at => :datetime
 }
-  EOS
-  
+EOS
+        end
       end
     end
   end
+
+rescue LoadError
+  puts "Skipping ActiveRecord specs..."
 end