awesome_print 0.4.0 → 1.0.2

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rvmrc

data/CHANGELOG

@@ -1,3 +1,21 @@
+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)
+  - Improved HTML formatting when :html => true (Daniel Johnson)
+  - Added Mongoid extension (Adam Doppelt)
+  - Added Nokogiri extension (Adam Doppelt)
+  - Removed Jeweler gem dependency
+
 0.4.0
   - 'ap object' now returns the object (Stephan Hagemann)
   - Added :html => true option to enable HTML colors rather that ANSI (ex. Sinatra templates)

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    awesome_print (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    fakefs (0.3.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print!
+  fakefs (>= 0.2.1)
+  rspec (>= 2.6.0)

data/README.md

@@ -1,5 +1,5 @@
 ## Awesome Print ##
-Awesome Print is Ruby library that pretty prints Ruby objects in full color
+Awesome Print is a Ruby library that pretty prints Ruby objects in full color
 exposing their internal structure with proper indentation. Rails ActiveRecord
 objects and usage within Rails templates are supported via included mixins.
 
@@ -7,9 +7,6 @@ objects and usage within Rails templates are supported via included mixins.
     # Installing as Ruby gem
     $ gem install awesome_print
 
-    # Installing as Rails plugin
-    $ ruby script/plugin install http://github.com/michaeldv/awesome_print.git
-
     # Cloning the repository
     $ git clone git://github.com/michaeldv/awesome_print.git
 
@@ -20,26 +17,32 @@ objects and usage within Rails templates are supported via included mixins.
 
 Default options:
 
-    :multiline => true,           # Display in multiple lines.
-    :plain     => false,          # Use colors.
-    :indent    => 4,              # Indent using 4 spaces.
-    :index     => true,           # Display array indices.
-    :html      => false,          # Use ANSI color codes rather than HTML.
-    :sorted_hash_keys => false,   # Do not sort hash keys.
+    :indent     => 4,      # Indent using 4 spaces.
+    :index      => true,   # Display array indices.
+    :html       => false,  # Use ANSI color codes rather than HTML.
+    :multiline  => true,   # Display in multiple lines.
+    :plain      => false,  # Use colors.
+    :sort_keys  => false,  # Do not sort hash keys.
+    :limit      => false,  # Limit large output for arrays and hashes. Set to a boolean or integer.
     :color => {
+      :args       => :pale,
       :array      => :white,
-      :bignum     => :blue,
+      :bigdecimal => :blue,
       :class      => :yellow,
       :date       => :greenish,
       :falseclass => :red,
       :fixnum     => :blue,
       :float      => :blue,
-      :hash       => :gray,
+      :hash       => :pale,
+      :keyword    => :cyan,
+      :method     => :purpleish,
       :nilclass   => :red,
       :string     => :yellowish,
+      :struct     => :pale,
       :symbol     => :cyanish,
       :time       => :greenish,
-      :trueclass  => :green
+      :trueclass  => :green,
+      :variable   => :cyanish
     }
 
 Supported color names:
@@ -137,6 +140,35 @@ Supported color names:
     $ ruby 6.rb
     42
     true
+    $ cat 7.rb
+    require "awesome_print"
+    some_array = (1..1000).to_a
+    ap some_array, :limit => true
+    ^D
+    $ ruby 7.rb
+    [
+        [  0] 1,
+        [  1] 2,
+        [  2] 3,
+        [  3] .. [996],
+        [997] 998,
+        [998] 999,
+        [999] 1000
+    ]
+
+    $ cat 8.rb
+    require "awesome_print"
+    some_array = (1..1000).to_a
+    ap some_array, :limit => 5
+    ^D
+    $ ruby 8.rb
+    [
+        [  0] 1,
+        [  1] 2,
+        [  2] .. [997],
+        [998] 999,
+        [999] 1000
+    ]
 
 ### Example (Rails console) ###
     $ rails console
@@ -197,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"
@@ -216,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:
@@ -234,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:
@@ -270,11 +312,17 @@ For example:
 
 ### Contributors ###
 
+* Adam Doppelt -- https://github.com/gurgeous
 * Andrew O'Brien -- https://github.com/AndrewO
+* Andrew Horsman -- https://github.com/basicxman
+* Benoit Daloze -- http://github.com/eregon
+* Brandon Zylstra -- https://github.com/brandondrew
+* Daniel Johnson -- https://github.com/adhd360
 * Daniel Bretoi -- http://github.com/danielb2
 * Eloy Duran -- http://github.com/alloy
 * Elpizo Choi -- https://github.com/fuJiin
-* Benoit Daloze -- http://github.com/eregon
+* Greg Weber -- https://github.com/gregwebs
+* Jeff Felchner -- https://github.com/jfelchner
 * Sean Gallagher -- http://github.com/torandu
 * Stephan Hagemann -- https://github.com/shageman
 * Tim Harper -- http://github.com/timcharper

data/Rakefile

@@ -1,46 +1,2 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "awesome_print"
-    gem.rubyforge_project = "awesome_print"
-    gem.summary = %Q{Pretty print Ruby objects with proper indentation and colors.}
-    gem.description = %Q{Great Ruby dubugging companion: pretty print Ruby objects to visualize their structure. Supports Rails ActiveRecord objects via included mixin.}
-    gem.email = "mike@dvorkin.net"
-    gem.homepage = "http://github.com/michaeldv/awesome_print"
-    gem.authors = ["Michael Dvorkin"]
-    gem.add_development_dependency "rspec", ">= 2.5.0"
-    gem.files = FileList["[A-Z]*", "lib/**/*.rb", "rails/*.rb", "spec/*", "init.rb"]
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rspec_opts = ['--color']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.rcov = true
-  spec.rcov_opts =  %q[--exclude "spec"]
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
- rdoc.rdoc_dir = 'rdoc'
- rdoc.title = "ap #{version}"
- rdoc.rdoc_files.include('README*')
- rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/ap.rb

@@ -4,21 +4,7 @@
 # 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.
+# Keeping this for backwards compatibility to allow
+# require "ap"
 #
-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
+require File.dirname(__FILE__) + "/awesome_print"

data/lib/{ap → 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/{ap → awesome_print}/core_ext/kernel.rb

@@ -6,8 +6,8 @@
 module Kernel
 
   def ai(options = {})
-    ap = AwesomePrint.new(options)
-    ap.send(:awesome, self)
+    ap = AwesomePrint::Inspector.new(options)
+    ap.awesome self
   end
   alias :awesome_inspect :ai
 

data/lib/awesome_print/core_ext/logger.rb

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

data/lib/{ap → 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/{ap → awesome_print}/core_ext/string.rb

@@ -4,21 +4,24 @@
 # See LICENSE file or http://www.opensource.org/licenses/mit-license.php
 #------------------------------------------------------------------------------
 class String
-
+  #
   # ANSI color codes:
-  # \033 => escape
+  #   \e => escape
   #   30 => color base
   #    1 => bright
   #    0 => normal
-
+  #
+  # For HTML coloring we use <kbd> tag instead of <span> to require monospace
+  # font. Note that beloved <tt> has been removed from HTML5.
+  #
   %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"
+      html[0] ? %Q|<kbd style="color:#{color}">#{self}</kbd>| : "\e[1;#{30+i}m#{self}\e[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"
+      html[0] ? %Q|<kbd style="color:#{shade}">#{self}</kbd>| : "\e[0;#{30+i}m#{self}\e[0m"
     end
   end
 

data/lib/awesome_print/ext/action_view.rb

@@ -0,0 +1,18 @@
+# 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 AwesomePrint
+  module ActionView
+
+    # Use HTML colors and add default "debug_dump" class to the resulting HTML.
+    def ap_debug(object, options = {})
+      object.ai(options.merge(:html => true)).sub(/^<pre([\s>])/, '<pre class="debug_dump"\\1')
+    end
+
+    alias_method :ap, :ap_debug
+  end
+end
+
+ActionView::Base.send(:include, AwesomePrint::ActionView)

data/lib/awesome_print/ext/active_record.rb

@@ -0,0 +1,64 @@
+# 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 AwesomePrint
+  module ActiveRecord
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_active_record, :cast
+      base.send :alias_method, :cast, :cast_with_active_record
+    end
+
+    # Add ActiveRecord class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_active_record(object, type)
+      cast = cast_without_active_record(object, type)
+      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
+    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)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:columns) || object.to_s == "ActiveRecord::Base"
+
+      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
+end
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::ActiveRecord)

data/lib/awesome_print/ext/active_support.rb

@@ -0,0 +1,47 @@
+# 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 AwesomePrint
+  module ActiveSupport
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_active_support, :cast
+      base.send :alias_method, :cast, :cast_with_active_support
+    end
+
+    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)
+          cast = :active_support_time
+        elsif object.is_a?(::HashWithIndifferentAccess)
+          cast = :hash_with_indifferent_access
+        end
+      end
+      cast
+    end
+
+    # Format ActiveSupport::TimeWithZone as standard Time.
+    #------------------------------------------------------------------------------
+    def awesome_active_support_time(object)
+      colorize(object.inspect, :time)
+    end
+
+    # Format HashWithIndifferentAccess as standard Hash.
+    #------------------------------------------------------------------------------
+    def awesome_hash_with_indifferent_access(object)
+      awesome_hash(object)
+    end
+  end
+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

@@ -0,0 +1,38 @@
+# 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 AwesomePrint
+  module MongoMapper
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_mongo_mapper, :cast
+      base.send :alias_method, :cast, :cast_with_mongo_mapper
+    end
+
+    # Add MongoMapper class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_mongo_mapper(object, type)
+      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
+      end
+      cast
+    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.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
+end
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::MongoMapper)

data/lib/awesome_print/ext/mongoid.rb

@@ -0,0 +1,65 @@
+# 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 AwesomePrint
+  module Mongoid
+
+    def self.included(base)
+      base.send :alias_method, :cast_without_mongoid, :cast
+      base.send :alias_method, :cast, :cast_with_mongoid
+    end
+
+    # Add Mongoid class names to the dispatcher pipeline.
+    #------------------------------------------------------------------------------
+    def cast_with_mongoid(object, type)
+      cast = cast_without_mongoid(object, type)
+      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
+
+    # Format Mongoid class object.
+    #------------------------------------------------------------------------------
+    def awesome_mongoid_class(object)
+      return object.inspect if !defined?(::ActiveSupport::OrderedHash) || !object.respond_to?(:fields)
+
+      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
+
+AwesomePrint::Formatter.send(:include, AwesomePrint::Mongoid)