ryansch-awesome_print 1.0.2.1

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

@@ -0,0 +1,77 @@
+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)
+  - Added AwesomePrint.force_colors! to allow color output on demand (Andrew O'Brien)
+  - Added MongoMapper formatter mixin (Elpizo Choi)
+  - Fixed formatting of methods array when object#method is overridden
+  - Fixed potential stack errors by checking whether AwesomePrint is already loaded
+  - Improved Ruby 1.8.6 and 1.8.7 compatibility
+  - Improved Windows compatibility (Viktar Basharymau)
+
+0.3.2
+  - Make sure Rails mixins get loaded in Rails console when required from .irbrc
+  - Fixed an issue with classes that define their own #send method (ex: Socket)
+  - Fixed compatibility issue with Liquid gem that defines Module#liquid_methods
+  - Fixed hash spec for Ruby < 1.9 where order of hash keys is not guaranteed
+  - Added :sorted_hash_keys option to sort hash keys (Ed Ruder)
+
+0.3.1 RubyConf X edition
+  - Fixed Ruby 1.8.6 compatibility issues (thanks, Tim!)
+  - Fixed stack overflow issue with Rails 2.3.x console
+
+0.3.0
+  - Display object.methods and family in human readable format
+  - Objects inherited from Array, Hash, File, Dir, and Struct are shown as their base class
+  - Added option to suppress array index in output (Sean Gallagher)
+  - Updated README on how to set up ~/.irbrc for MacRuby (Eloy Duran)
+  - Specs pass 100% with Ruby 1.8.7/RSpec 1.3 and Ruby 1.9.2/RSpec 2.0
+
+0.2.1
+  - ap can now be used within Rails templates (ex. <%= ap object %>)
+  - Added support for printing Struct
+
+0.2.0
+  - Added support for logger.ap (including Rails logger)
+  - Added support for HashWithIndifferentAccess from ActiveSupport
+  - ap now works with scripts that use ActiveRecord/ActiveSupport outside Rails
+  - ap now correctly shows file and directory names with fancy characters (shell escape)
+
+0.1.4
+  - Format BigDecimal and Rational objects as Float scalars
+  - Explicit options parameter can override custom defaults
+  - Custom defaults are not interfering when running specs
+  - Custom defaults now work correctly with Ruby 1.9.x
+
+0.1.3
+  - Added support for setting custom defaults in ~/.aprc
+  
+0.1.2
+  - Correctly handle empty arrays and hashes
+  - Use alias_method instead of alias (fixes non-tty method aliasing)
+  - Added awesome_inspect method
+
+0.1.1
+  - Added support for tableless ActiveRecord models
+  - Left align hash keys if @options[:indent] is negative
+  
+0.1.0
+  - Initial Release.
+  

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/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010-2011 Michael Dvorkin
+twitter.com/mid
+%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,339 @@
+## Awesome Print ##
+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.
+
+### Installation ###
+    # Installing as Ruby gem
+    $ gem install awesome_print
+
+    # Cloning the repository
+    $ git clone git://github.com/michaeldv/awesome_print.git
+
+### Usage ###
+
+    require "awesome_print"
+    ap object, options = {}
+
+Default options:
+
+    :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,
+      :bigdecimal => :blue,
+      :class      => :yellow,
+      :date       => :greenish,
+      :falseclass => :red,
+      :fixnum     => :blue,
+      :float      => :blue,
+      :hash       => :pale,
+      :keyword    => :cyan,
+      :method     => :purpleish,
+      :nilclass   => :red,
+      :string     => :yellowish,
+      :struct     => :pale,
+      :symbol     => :cyanish,
+      :time       => :greenish,
+      :trueclass  => :green,
+      :variable   => :cyanish
+    }
+
+Supported color names:
+
+    :gray, :red, :green, :yellow, :blue, :purple, :cyan, :white
+    :black, :redish, :greenish, :yellowish, :blueish, :purpleish, :cyanish, :pale
+
+### Examples ###
+    $ cat > 1.rb
+    require "awesome_print"
+    data = [ false, 42, %w(forty two), { :now => Time.now, :class => Time.now.class, :distance => 42e42 } ]
+    ap data
+    ^D
+    $ ruby 1.rb
+    [
+        [0] false,
+        [1] 42,
+        [2] [
+            [0] "forty",
+            [1] "two"
+        ],
+        [3] {
+               :class => Time < Object,
+                 :now => Fri Apr 02 19:55:53 -0700 2010,
+            :distance => 4.2e+43
+        }
+    ]
+
+    $ cat > 2.rb
+    require "awesome_print"
+    data = { :now => Time.now, :class => Time.now.class, :distance => 42e42 }
+    ap data, :indent => -2  # <-- Left align hash keys.
+    ^D
+    $ ruby 2.rb
+    {
+      :class    => Time < Object,
+      :now      => Fri Apr 02 19:55:53 -0700 2010,
+      :distance => 4.2e+43
+    }
+
+    $ cat > 3.rb
+    require "awesome_print"
+    data = [ false, 42, %w(forty two) ]
+    data << data  # <-- Nested array.
+    ap data, :multiline => false
+    ^D
+    $ ruby 3.rb
+    [ false, 42, [ "forty", "two" ], [...] ]
+
+    $ cat > 4.rb
+    require "awesome_print"
+    class Hello
+      def self.world(x, y, z = nil, &blk)
+      end
+    end
+    ap Hello.methods - Class.methods
+    ^D
+    $ ruby 4.rb
+    [
+        [0] world(x, y, *z, &blk) Hello
+    ]
+
+    $ cat > 5.rb
+    require "awesome_print"
+    ap (''.methods - Object.methods).grep(/!/)
+    ^D
+    $ ruby 5.rb
+    [
+        [ 0] capitalize!()           String
+        [ 1]      chomp!(*arg1)      String
+        [ 2]       chop!()           String
+        [ 3]     delete!(*arg1)      String
+        [ 4]   downcase!()           String
+        [ 5]     encode!(*arg1)      String
+        [ 6]       gsub!(*arg1)      String
+        [ 7]     lstrip!()           String
+        [ 8]       next!()           String
+        [ 9]    reverse!()           String
+        [10]     rstrip!()           String
+        [11]      slice!(*arg1)      String
+        [12]    squeeze!(*arg1)      String
+        [13]      strip!()           String
+        [14]        sub!(*arg1)      String
+        [15]       succ!()           String
+        [16]   swapcase!()           String
+        [17]         tr!(arg1, arg2) String
+        [18]       tr_s!(arg1, arg2) String
+        [19]     upcase!()           String
+    ]
+
+    $ cat > 6.rb
+    require "awesome_print"
+    ap 42 == ap(42)
+    ^D
+    $ 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
+    rails> require "awesome_print"
+    rails> ap Account.all(:limit => 2)
+    [
+        [0] #<Account:0x1033220b8> {
+                         :id => 1,
+                    :user_id => 5,
+                :assigned_to => 7,
+                       :name => "Hayes-DuBuque",
+                     :access => "Public",
+                    :website => "http://www.hayesdubuque.com",
+            :toll_free_phone => "1-800-932-6571",
+                      :phone => "(111)549-5002",
+                        :fax => "(349)415-2266",
+                 :deleted_at => nil,
+                 :created_at => Sat, 06 Mar 2010 09:46:10 UTC +00:00,
+                 :updated_at => Sat, 06 Mar 2010 16:33:10 UTC +00:00,
+                      :email => "info@hayesdubuque.com",
+            :background_info => nil
+        },
+        [1] #<Account:0x103321ff0> {
+                         :id => 2,
+                    :user_id => 4,
+                :assigned_to => 4,
+                       :name => "Ziemann-Streich",
+                     :access => "Public",
+                    :website => "http://www.ziemannstreich.com",
+            :toll_free_phone => "1-800-871-0619",
+                      :phone => "(042)056-1534",
+                        :fax => "(106)017-8792",
+                 :deleted_at => nil,
+                 :created_at => Tue, 09 Feb 2010 13:32:10 UTC +00:00,
+                 :updated_at => Tue, 09 Feb 2010 20:05:01 UTC +00:00,
+                      :email => "info@ziemannstreich.com",
+            :background_info => nil
+        }
+    ]
+    rails> ap Account
+    class Account < ActiveRecord::Base {
+                     :id => :integer,
+                :user_id => :integer,
+            :assigned_to => :integer,
+                   :name => :string,
+                 :access => :string,
+                :website => :string,
+        :toll_free_phone => :string,
+                  :phone => :string,
+                    :fax => :string,
+             :deleted_at => :datetime,
+             :created_at => :datetime,
+             :updated_at => :datetime,
+                  :email => :string,
+        :background_info => :string
+    }
+    rails>
+
+### IRB integration ###
+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
+
+### 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:
+
+    logger.ap object
+
+By default, this logs at the :debug level. You can override that globally with:
+
+    :log_level => :info
+
+in the custom defaults (see below). You can also override on a per call basis with:
+
+    logger.ap object, :warn
+
+### ActionView Convenience Method ###
+awesome_print adds the 'ap' method to the ActionView::Base class making it available
+within Rails templates. For example:
+
+    <%= ap @accounts.first %>   # ERB
+    != ap @accounts.first       # HAML
+
+With other web frameworks (ex: in Sinatra templates) you can explicitly request HTML
+formatting:
+
+    <%= ap @accounts.first, :html => true %>
+
+### Setting Custom Defaults ###
+You can set your own default options by creating ``.aprc`` file in your home
+directory. Within that file assign your  defaults to ``AwesomePrint.defaults``.
+For example:
+
+    # ~/.aprc file.
+    AwesomePrint.defaults = {
+      :indent => -2,
+      :color => {
+        :hash  => :pale,
+        :class => :white
+      }
+    }
+
+### Running Specs ###
+
+    $ gem install rspec           # RSpec 2.x is the requirement.
+    $ rake spec                   # Run the entire spec suite.
+    $ rspec spec/logger_spec.rb   # Run individual spec file.
+
+### Note on Patches/Pull Requests ###
+* Fork the project on Github.
+* 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.
+
+### 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
+* 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
+* Tobias Crawley -- http://github.com/tobias
+* Viktar Basharymau -- https://github.com/DNNX
+
+### License ###
+Copyright (c) 2010-2011 Michael Dvorkin
+
+twitter.com/mid
+
+%w(mike dvorkin.net) * "@" || %w(mike fatfreecrm.com) * "@"
+
+Released under the MIT license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/ap.rb

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

data/lib/awesome_print/core_ext/array.rb

@@ -0,0 +1,71 @@
+# 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
+#------------------------------------------------------------------------------
+#
+# The following makes it possible to invoke awesome_print while performing
+# operations on method arrays, ex:
+#
+#   ap [].methods - Object.methods
+#   ap ''.methods.grep(/!|\?/)
+#
+# If you could think of a better way please let me know :-)
+#
+class Array #:nodoc:
+  [ :-, :& ].each do |operator|
+    original_operator = instance_method(operator)
+
+    define_method operator do |*args|
+      arr = original_operator.bind(self).call(*args)
+      if self.instance_variable_defined?('@__awesome_methods__')
+        arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
+        arr.sort! { |a, b| a.to_s <=> b.to_s }  # Need the block since Ruby 1.8.x can't sort arrays of symbols.
+      end
+      arr
+    end
+  end
+  #
+  # Intercepting Array#grep needs a special treatment since grep accepts
+  # an optional block.
+  #
+  alias :original_grep :grep
+  def grep(pattern, &blk)
+    #
+    # The following looks rather insane and I've sent numerous hours trying
+    # to figure it out. The problem is that if grep gets called with the
+    # block, for example:
+    #
+    #    [].methods.grep(/(.+?)_by/) { $1.to_sym }
+    #
+    # ...then simple:
+    #
+    #    original_grep(pattern, &blk)
+    #
+    # doesn't set $1 within the grep block which causes nil.to_sym failure.
+    # The workaround below has been tested with Ruby 1.8.7/Rails 2.3.8 and
+    # Ruby 1.9.2/Rails 3.0.0. For more info see the following thread dating
+    # back to 2003 when Ruby 1.8.0 was as fresh off the grill as Ruby 1.9.2
+    # is in 2010 :-)
+    #
+    # http://www.justskins.com/forums/bug-when-rerouting-string-52852.html
+    #
+    # BTW, if you figure out a better way of intercepting Array#grep please
+    # let me know: twitter.com/mid -- or just say hi so I know you've read
+    # the comment :-)
+    #
+    arr = unless blk
+      original_grep(pattern)
+    else
+      original_grep(pattern) do |match|
+        eval("%Q/#{match.to_s.gsub('/', '\/')}/ =~ #{pattern.inspect}", blk.binding)
+        yield match
+      end
+    end
+    if self.instance_variable_defined?('@__awesome_methods__')
+      arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
+      arr.reject! { |item| !(item.is_a?(Symbol) || item.is_a?(String)) } # grep block might return crap.
+    end
+    arr
+  end
+end

data/lib/awesome_print/core_ext/class.rb

@@ -0,0 +1,22 @@
+# 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 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)
+      methods
+    end
+  end
+end

data/lib/awesome_print/core_ext/kernel.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
+#------------------------------------------------------------------------------
+module Kernel
+
+  def ai(options = {})
+    ap = AwesomePrint::Inspector.new(options)
+    ap.awesome self
+  end
+  alias :awesome_inspect :ai
+
+  def ap(object, options = {})
+    puts object.ai(options)
+    object
+  end
+  alias :awesome_print :ap
+
+  module_function :ap
+end

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

@@ -0,0 +1,22 @@
+# 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:
+  #
+  # 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)
+      methods
+    end
+  end
+end