awesome_print 0.2.1 → 0.3.0

data/CHANGELOG

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

data/README.md

@@ -8,10 +8,10 @@ objects and usage within Rails templates are supported via included mixins.
     $ gem install awesome_print
 
     # Installing as Rails plugin
-    $ ruby script/plugin install http://github.com/michaeldv/awesome_print_.git
+    $ ruby script/plugin install http://github.com/michaeldv/awesome_print.git
 
     # Cloning the repository
-    $ git clone git://github.com/michaeldv/awesome_print_.git
+    $ git clone git://github.com/michaeldv/awesome_print.git
 
 ### Usage ###
 
@@ -86,6 +86,47 @@ Supported color names:
     $ ruby 3.rb
     [ false, 42, [ "forty", "two" ], [...] ]
 
+    $ cat > 4.rb
+    require "ap"
+    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 "ap"
+    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
+    ]
+
 ### Example (Rails console) ###
     $ ruby script/console
     Loading development environment (Rails 2.3.5)
@@ -150,10 +191,19 @@ lines into your ~/.irbrc file:
 
 	require "rubygems"
 	require "ap"
-	IRB::Irb.class_eval do
-	  def output_value
-	    ap @context.last_value
+
+	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
 
 ### Logger Convenience Method ###
@@ -190,6 +240,12 @@ For example:
       }
     }
 
+### Running Specs ###
+
+    $ rake spec                           # Entire spec suite.
+    $ ruby -rubygems spec/logger_spec.rb  # Individual spec file (Ruby 1.8.7 and RSpec 1.3+)
+    $ rspec spec/logger_spec.rb           # Individual spec file (Ruby 1.9.2 and RSpec 2.0+)
+
 ### Note on Patches/Pull Requests ###
 * Fork the project on Github.
 * Make your feature addition or bug fix.
@@ -200,7 +256,9 @@ For example:
 ### Contributors ###
 
 * Daniel Bretoi -- http://github.com/danielb2
-* eregon -- http://github.com/eregon
+* Eloy Duran -- http://github.com/alloy
+* Benoit Daloze -- http://github.com/eregon
+* Sean Gallagher -- http://github.com/torandu
 * Tobias Crawley -- http://github.com/tobias
 
 ### License ###

data/Rakefile

@@ -11,7 +11,11 @@ begin
     gem.email = "mike@dvorkin.net"
     gem.homepage = "http://github.com/michaeldv/awesome_print"
     gem.authors = ["Michael Dvorkin"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    if RUBY_VERSION.to_f >= 1.9
+      gem.add_development_dependency "rspec", ">= 2.0.0"
+    else
+      gem.add_development_dependency "rspec", ">= 1.3.0"
+    end
     gem.files = FileList["[A-Z]*", "lib/**/*.rb", "rails/*.rb", "spec/*", "init.rb"]
     gem.has_rdoc = false
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -21,16 +25,30 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
+if RUBY_VERSION.to_f >= 1.9
+  require "rspec/core/rake_task" # RSpec 2.0
+  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
+else
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new(:spec) do |spec|
+    spec.libs << 'lib' << 'spec'
+    spec.spec_opts = ['--color']
+    spec.spec_files = FileList['spec/**/*_spec.rb']
+  end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+  Spec::Rake::SpecTask.new(:rcov) do |spec|
+    spec.libs << 'lib' << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov = true
+  end
 end
 
 task :spec => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/ap.rb

@@ -3,7 +3,10 @@
 # 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/array"
 require File.dirname(__FILE__) + "/ap/core_ext/string"
+require File.dirname(__FILE__) + "/ap/core_ext/object"
+require File.dirname(__FILE__) + "/ap/core_ext/class"
 require File.dirname(__FILE__) + "/ap/core_ext/kernel"
 require File.dirname(__FILE__) + "/ap/awesome_print"
 

data/lib/ap/awesome_print.rb

@@ -6,14 +6,15 @@
 require "shellwords"
 
 class AwesomePrint
-  AP = :__awesome_print__
-  CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational, :struct ]
+  AP = :__awesome_print__ unless defined?(AwesomePrint::AP)
+  CORE = [ :array, :hash, :class, :file, :dir, :bigdecimal, :rational, :struct, :method, :unboundmethod ] unless defined?(AwesomePrint::CORE)
 
   def initialize(options = {})
     @options = { 
       :multiline => true,
       :plain     => false,
       :indent    => 4,
+      :index     => true,
       :color     => { 
         :array      => :white,
         :bigdecimal => :blue,
@@ -28,7 +29,9 @@ class AwesomePrint
         :string     => :yellowish,
         :symbol     => :cyanish,
         :time       => :greenish,
-        :trueclass  => :green
+        :trueclass  => :green,
+        :method     => :purpleish,
+        :args       => :pale
       }
     }
 
@@ -47,18 +50,23 @@ class AwesomePrint
   def awesome_array(a)
     return "[]" if a == []
 
-    if @options[:multiline]
+    if a.instance_variable_defined?('@__awesome_methods__')
+      methods_array(a)
+    elsif @options[:multiline]
       width = (a.size - 1).to_s.size 
       data = a.inject([]) do |arr, item|
-        index = colorize("#{indent}[#{arr.size.to_s.rjust(width)}] ", :array)
+        index = if @options[:index]
+          colorize("#{indent}[#{arr.size.to_s.rjust(width)}] ", :array)
+        else
+          colorize(indent, :array)
+        end
         indented do
           arr << (index << awesome(item))
         end
       end
       "[\n" << data.join(",\n") << "\n#{outdent}]"
     else
-      data = a.inject([]) { |arr, item| arr << awesome(item) }
-      "[ #{data.join(', ')} ]"
+      "[ " << a.map{ |item| awesome(item) }.join(", ") << " ]"
     end
   end
 
@@ -67,23 +75,23 @@ class AwesomePrint
   def awesome_hash(h)
     return "{}" if h == {}
 
-    data = h.keys.inject([]) do |arr, key|
+    data = h.keys.map do |key|
       plain_single_line do
-        arr << [ awesome(key), h[key] ]
+        [ awesome(key), h[key] ]
       end
     end
       
     width = data.map { |key, | key.size }.max || 0
     width += @indentation if @options[:indent] > 0
   
-    data = data.inject([]) do |arr, (key, value)|
+    data = data.map do |key, value|
       if @options[:multiline]
         formatted_key = (@options[:indent] >= 0 ? key.rjust(width) : indent + key.ljust(width))
       else
         formatted_key = key
       end
       indented do
-        arr << (formatted_key << colorize(" => ", :hash) << awesome(value))
+        formatted_key << colorize(" => ", :hash) << awesome(value)
       end
     end
     if @options[:multiline]
@@ -132,10 +140,18 @@ class AwesomePrint
   end
   alias :awesome_rational :awesome_bigdecimal
 
+  # Format a method.
+  #------------------------------------------------------------------------------
+  def awesome_method(m)
+    name, args, owner = method_tuple(m)
+    "#{colorize(owner, :class)}##{colorize(name, :method)}#{colorize(args, :args)}"
+  end
+  alias :awesome_unboundmethod :awesome_method
+
   # Catch all method to format an arbitrary object.
   #------------------------------------------------------------------------------
   def awesome_self(object, appear = {})
-    colorize(object.inspect << appear[:with].to_s, appear[:as] || declassify(object))
+    colorize(object.inspect.to_s << appear[:with].to_s, appear[:as] || declassify(object))
   end
 
   # Dispatcher that detects data nesting and invokes object-aware formatter.
@@ -153,6 +169,38 @@ class AwesomePrint
     end
   end
 
+  # Format object.methods array.
+  #------------------------------------------------------------------------------
+  def methods_array(a)
+    object = a.instance_variable_get('@__awesome_methods__')
+    tuples = a.map do |name|
+      if object.respond_to?(name, true)           # Regular method?
+        method_tuple(object.method(name))
+      elsif object.respond_to?(:instance_method)  # Unbound method?
+        method_tuple(object.instance_method(name))
+      else                                        # WTF method.
+        [ name.to_s, '(?)', '' ]
+      end
+    end
+
+    width = (tuples.size - 1).to_s.size
+    name_width = tuples.map { |item| item[0].size }.max || 0
+    args_width = tuples.map { |item| item[1].size }.max || 0
+
+    data = tuples.inject([]) do |arr, item|
+      index = if @options[:index]
+        "#{indent}[#{arr.size.to_s.rjust(width)}]"
+      else
+        indent
+      end
+      indented do
+        arr << "#{index} #{colorize(item[0].rjust(name_width), :method)}#{colorize(item[1].ljust(args_width), :args)} #{colorize(item[2], :class)}"
+      end
+    end
+
+    "[\n" << data.join("\n") << "\n#{outdent}]"
+  end
+
   # Format nested data, for example:
   #   arr = [1, 2]; arr << arr
   #   => [1,2, [...]]
@@ -174,13 +222,17 @@ class AwesomePrint
     CORE.grep(declassify(object))[0] || :self
   end
 
-  # Turn class name into symbol, ex: Hello::World => :hello_world.
+  # Turn class name into symbol, ex: Hello::World => :hello_world. Classes that
+  # inherit from Array, Hash, File, Dir, and Struct are treated as the base class.
   #------------------------------------------------------------------------------
   def declassify(object)
-    if object.is_a?(Struct)
-      :struct
-    else
-      object.class.to_s.gsub(/:+/, "_").downcase.to_sym
+    case object
+    when Array  then :array
+    when Hash   then :hash
+    when File   then :file
+    when Dir    then :dir
+    when Struct then :struct
+    else object.class.to_s.gsub(/:+/, "_").downcase.to_sym
     end
   end
 
@@ -194,6 +246,32 @@ class AwesomePrint
     end
   end
 
+  # Return [ name, arguments, owner ] tuple for a given method.
+  #------------------------------------------------------------------------------
+  def method_tuple(method)
+    if method.respond_to?(:parameters) # Ruby 1.9.2+
+      # See http://ruby.runpaint.org/methods#method-objects-parameters
+      args = method.parameters.inject([]) do |arr, (type, name)|
+        name ||= (type == :block ? 'block' : "arg#{arr.size + 1}")
+        arr << case type
+          when :req        then name.to_s
+          when :opt, :rest then "*#{name}"
+          when :block      then "&#{name}"
+          else '?'
+        end
+      end
+    else # See http://ruby-doc.org/core/classes/Method.html#M001902
+      args = method.arity.abs.times.map { |i| "arg#{i+1}" }
+      args[-1] = "*#{args[-1]}" if method.arity < 0
+    end
+
+    if method.to_s =~ /(Unbound)*Method: (.*?)[#\.]/
+      owner = "#{$2}#{$1 ? '(unbound)' : ''}".gsub('(', ' (')
+    end
+
+    [ method.name.to_s, "(#{args.join(', ')})", owner.to_s ]
+  end
+
   # Format hash keys as plain string regardless of underlying data type.
   #------------------------------------------------------------------------------
   def plain_single_line

data/lib/ap/core_ext/array.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2010 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: twitter.com/mid :-)
+#
+class Array #:nodoc:
+  [ :-, :& ].each do |operator|
+    alias :"original_#{operator.object_id}" :"#{operator}"
+    define_method operator do |*args|
+      arr = self.send(:"original_#{operator.object_id}", *args)
+      if self.instance_variable_defined?('@__awesome_methods__')
+        arr.instance_variable_set('@__awesome_methods__', self.instance_variable_get('@__awesome_methods__'))
+        arr.sort!
+      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 1993 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) { |match| eval("%Q/#{match}/ =~ #{pattern.inspect}", blk.binding); yield match }
+    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/ap/core_ext/class.rb

@@ -0,0 +1,15 @@
+# Copyright (c) 2010 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:
+  methods.grep(/instance_methods$/) do |name|
+    alias :"original_#{name}" :"#{name}"
+    define_method name do |*args|
+      methods = self.send(:"original_#{name}", *args)
+      methods.instance_variable_set('@__awesome_methods__', self) # Evil?!
+      methods.sort!
+    end
+  end
+end

data/lib/ap/core_ext/object.rb

@@ -0,0 +1,17 @@
+# Copyright (c) 2010 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:
+  methods.grep(/methods$/) do |name|
+    next if name.to_s.include? 'instance' # Instance methods are trapped in Class.
+
+    alias :"original_#{name}" :"#{name}"
+    define_method name do |*args|
+      methods = self.send(:"original_#{name}", *args)
+      methods.instance_variable_set('@__awesome_methods__', self) # Evil?!
+      methods.sort!
+    end
+  end
+end

data/lib/awesome_print.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2010 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.2.1', :require => 'ap'
+# gem 'awesome_print', '>= 3.0.0'
+#
+require File.dirname(__FILE__) + "/ap/core_ext/array"
+require File.dirname(__FILE__) + "/ap/core_ext/string"
+require File.dirname(__FILE__) + "/ap/core_ext/object"
+require File.dirname(__FILE__) + "/ap/core_ext/class"
+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)
+
+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)
+

data/spec/active_record_spec.rb

@@ -50,37 +50,53 @@ if defined?(::ActiveRecord)
 
       it "display single record" do
         out = @ap.send(:awesome, @diana)
-        out.gsub(/0x([a-f\d]+)/, "0x01234567").should == <<-EOS.strip
+        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
+        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
+        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
 

data/spec/awesome_print_spec.rb

@@ -30,6 +30,23 @@ describe "AwesomePrint" do
         ]
     ]
 ]
+EOS
+      end
+
+    it "plain multiline without index" do
+      @arr.ai(:plain => true, :index => false).should == <<-EOS.strip
+[
+    1,
+    :two,
+    "three",
+    [
+        nil,
+        [
+            true,
+            false
+        ]
+    ]
+]
 EOS
       end
 
@@ -50,6 +67,23 @@ EOS
 EOS
     end
 
+    it "plain multiline indented without index" do
+      @arr.ai(:plain => true, :indent => 2, :index => false).should == <<-EOS.strip
+[
+  1,
+  :two,
+  "three",
+  [
+    nil,
+    [
+      true,
+      false
+    ]
+  ]
+]
+EOS
+    end
+
     it "plain single line" do
       @arr.ai(:plain => true, :multiline => false).should == '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
     end
@@ -110,6 +144,16 @@ EOS
 EOS
     end
 
+    it "plain multiline without index" do
+      @arr.ai(:plain => true, :index => false).should == <<-EOS.strip
+[
+    1,
+    2,
+    [...]
+]
+EOS
+    end
+
     it "plain single line" do
       @arr.ai(:plain => true, :multiline => false).should == "[ 1, 2, [...] ]"
     end
@@ -361,4 +405,75 @@ EOS
   end
 
 
+  #------------------------------------------------------------------------------
+  describe "Misc" do
+    it "handle weird objects that return nil on inspect" do
+      weird = Class.new do
+        def inspect
+          nil
+        end
+      end
+      weird.new.ai(:plain => true).should == ''
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Inherited from standard Ruby classes" do
+    after do
+      Object.instance_eval{ remove_const :My } if defined?(My)
+    end
+
+    it "inherited from Array should be displayed as Array" do
+      class My < Array; end
+
+      my = My.new([ 1, :two, "three", [ nil, [ true, false ] ] ])
+      my.ai(:plain => true).should == <<-EOS.strip
+[
+    [0] 1,
+    [1] :two,
+    [2] "three",
+    [3] [
+        [0] nil,
+        [1] [
+            [0] true,
+            [1] false
+        ]
+    ]
+]
+EOS
+    end
+
+    it "inherited from Hash should be displayed as Hash" do
+      class My < Hash; end
+
+      my = My[ { 1 => { :sym => { "str" => { [1, 2, 3] => { { :k => :v } => Hash } } } } } ]
+      my.ai(:plain => true).should == <<-EOS.strip
+{
+    1 => {
+        :sym => {
+            "str" => {
+                [ 1, 2, 3 ] => {
+                    { :k => :v } => Hash < Object
+                }
+            }
+        }
+    }
+}
+EOS
+    end
+
+    it "inherited from File should be displayed as File" do
+      class My < File; end
+
+      my = File.new('/dev/null')
+      my.ai(:plain => true).should == "#{my.inspect}\n" << `ls -alF #{my.path}`.chop
+    end
+
+    it "inherited from Dir should be displayed as Dir" do
+      class My < Dir; end
+
+      my = My.new('/tmp')
+      my.ai(:plain => true).should == "#{my.inspect}\n" << `ls -alF #{my.path}`.chop
+    end
+  end
 end

data/spec/methods_spec.rb

@@ -0,0 +1,409 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Single method" do
+  after do
+    Object.instance_eval{ remove_const :Hello } if defined?(Hello)
+  end
+
+  it "plain: should handle a method with no arguments" do
+    method = ''.method(:upcase)
+    method.ai(:plain => true).should == 'String#upcase()'
+  end
+
+  it "color: should handle a method with no arguments" do
+    method = ''.method(:upcase)
+    method.ai.should == "\e[1;33mString\e[0m#\e[0;35mupcase\e[0m\e[0;37m()\e[0m"
+  end
+
+  it "plain: should handle a method with one argument" do
+    method = ''.method(:include?)
+    method.ai(:plain => true).should == 'String#include?(arg1)'
+  end
+
+  it "color: should handle a method with one argument" do
+    method = ''.method(:include?)
+    method.ai.should == "\e[1;33mString\e[0m#\e[0;35minclude?\e[0m\e[0;37m(arg1)\e[0m"
+  end
+
+  it "plain: should handle a method with two arguments" do
+    method = ''.method(:tr)
+    method.ai(:plain => true).should == 'String#tr(arg1, arg2)'
+  end
+
+  it "color: should handle a method with two arguments" do
+    method = ''.method(:tr)
+    method.ai.should == "\e[1;33mString\e[0m#\e[0;35mtr\e[0m\e[0;37m(arg1, arg2)\e[0m"
+  end
+
+  it "plain: should handle a method with multiple arguments" do
+    method = ''.method(:split)
+    method.ai(:plain => true).should == 'String#split(*arg1)'
+  end
+
+  it "color: should handle a method with multiple arguments" do
+    method = ''.method(:split)
+    method.ai.should == "\e[1;33mString\e[0m#\e[0;35msplit\e[0m\e[0;37m(*arg1)\e[0m"
+  end
+
+  it "plain: should handle a method defined in mixin" do
+    method = ''.method(:is_a?)
+    method.ai(:plain => true).should == 'String (Kernel)#is_a?(arg1)'
+  end
+
+  it "color: should handle a method defined in mixin" do
+    method = ''.method(:is_a?)
+    method.ai.should == "\e[1;33mString (Kernel)\e[0m#\e[0;35mis_a?\e[0m\e[0;37m(arg1)\e[0m"
+  end
+
+  it "plain: should handle an unbound method" do
+    class Hello
+      def world; end
+    end
+    method = Hello.instance_method(:world)
+    method.ai(:plain => true).should == 'Hello (unbound)#world()'
+  end
+
+  it "color: should handle an unbound method" do
+    class Hello
+      def world(a,b); end
+    end
+    method = Hello.instance_method(:world)
+    if RUBY_VERSION < '1.9.2'
+      method.ai.should == "\e[1;33mHello (unbound)\e[0m#\e[0;35mworld\e[0m\e[0;37m(arg1, arg2)\e[0m"
+    else
+      method.ai.should == "\e[1;33mHello (unbound)\e[0m#\e[0;35mworld\e[0m\e[0;37m(a, b)\e[0m"
+    end
+  end
+end
+
+describe "Object methods" do
+  after do
+    Object.instance_eval{ remove_const :Hello } if defined?(Hello)
+  end
+
+  describe "object.methods" do
+    it "index: should handle object.methods" do
+      out = nil.methods.ai(:plain => true).split("\n").grep(/is_a\?/).first
+      out.should =~ /^\s+\[\s*\d+\]\s+is_a\?\(arg1\)\s+NilClass \(Kernel\)$/
+    end
+
+    it "no index: should handle object.methods" do
+      out = nil.methods.ai(:plain => true, :index => false).split("\n").grep(/is_a\?/).first
+      out.should =~ /^\s+is_a\?\(arg1\)\s+NilClass \(Kernel\)$/
+    end
+  end
+
+  describe "object.public_methods" do
+    it "index: should handle object.public_methods" do
+      out = nil.public_methods.ai(:plain => true).split("\n").grep(/is_a\?/).first
+      out.should =~ /^\s+\[\s*\d+\]\s+is_a\?\(arg1\)\s+NilClass \(Kernel\)$/
+    end
+
+    it "no index: should handle object.public_methods" do
+      out = nil.public_methods.ai(:plain => true, :index => false).split("\n").grep(/is_a\?/).first
+      out.should =~ /^\s+is_a\?\(arg1\)\s+NilClass \(Kernel\)$/
+    end
+  end
+
+  describe "object.private_methods" do
+    it "index: should handle object.private_methods" do
+      out = nil.private_methods.ai(:plain => true).split("\n").grep(/sleep/).first
+      out.should =~ /^\s+\[\s*\d+\]\s+sleep\(\*arg1\)\s+NilClass \(Kernel\)$/
+    end
+
+    it "no index: should handle object.private_methods" do
+      out = nil.private_methods.ai(:plain => true, :index => false).split("\n").grep(/sleep/).first
+      out.should =~ /^\s+sleep\(\*arg1\)\s+NilClass \(Kernel\)$/
+    end
+  end
+
+  describe "object.protected_methods" do
+    it "index: should handle object.protected_methods" do
+      class Hello
+        protected
+        def m1; end
+        def m2; end
+      end
+      Hello.new.protected_methods.ai(:plain => true).should == "[\n    [0] m1() Hello\n    [1] m2() Hello\n]"
+    end
+
+    it "no index: should handle object.protected_methods" do
+      class Hello
+        protected
+        def m3(a,b); end
+      end
+      if RUBY_VERSION < '1.9.2'
+        Hello.new.protected_methods.ai(:plain => true, :index => false).should == "[\n     m3(arg1, arg2) Hello\n]"
+      else
+        Hello.new.protected_methods.ai(:plain => true, :index => false).should == "[\n     m3(a, b) Hello\n]"
+      end
+    end
+  end
+
+  describe "object.private_methods" do
+    it "index: should handle object.private_methods" do
+      class Hello
+        private
+        def m1; end
+        def m2; end
+      end
+      out = Hello.new.private_methods.ai(:plain => true).split("\n").grep(/m\d/)
+      out.first.should =~ /^\s+\[\d+\]\s+m1\(\)\s+Hello$/
+      out.last.should  =~ /^\s+\[\d+\]\s+m2\(\)\s+Hello$/
+    end
+
+    it "no index: should handle object.private_methods" do
+      class Hello
+        private
+        def m3(a,b); end
+      end
+      out = Hello.new.private_methods.ai(:plain => true).split("\n").grep(/m\d/)
+      if RUBY_VERSION < '1.9.2'
+        out.first.should =~ /^\s+\[\d+\]\s+m3\(arg1, arg2\)\s+Hello$/
+      else
+        out.first.should =~ /^\s+\[\d+\]\s+m3\(a, b\)\s+Hello$/
+      end
+    end
+  end
+
+  describe "object.singleton_methods" do
+    it "index: should handle object.singleton_methods" do
+      class Hello
+        class << self
+          def m1; end
+          def m2; end
+        end
+      end
+      out = Hello.singleton_methods.ai(:plain => true).split("\n").grep(/m\d/)
+      out.first.should =~ /^\s+\[\d+\]\s+m1\(\)\s+Hello$/
+      out.last.should  =~ /^\s+\[\d+\]\s+m2\(\)\s+Hello$/
+    end
+
+    it "no index: should handle object.singleton_methods" do
+      class Hello
+        def self.m3(a,b); end
+      end
+      out = Hello.singleton_methods.ai(:plain => true, :index => false).split("\n").grep(/m\d/)
+      if RUBY_VERSION < '1.9.2'
+        out.first.should =~ /^\s+m3\(arg1, arg2\)\s+Hello$/
+      else
+        out.first.should =~ /^\s+m3\(a, b\)\s+Hello$/
+      end
+    end
+  end
+end
+
+describe "Class methods" do
+  after do
+    Object.instance_eval{ remove_const :Hello } if defined?(Hello)
+  end
+
+  describe "class.instance_methods" do
+    it "index: should handle unbound class.instance_methods" do
+      class Hello
+        def m1; end
+        def m2; end
+      end
+      out = Hello.instance_methods.ai(:plain => true).split("\n").grep(/m\d/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\)\s+Hello\s\(unbound\)$/
+      out.last.should  =~ /^\s+\[\s*\d+\]\s+m2\(\)\s+Hello\s\(unbound\)$/
+    end
+
+    it "no index: should handle unbound class.instance_methods" do
+      class Hello
+        def m3(a,b); end
+      end
+      out = Hello.instance_methods.ai(:plain => true, :index => false).split("\n").grep(/m\d/)
+      if RUBY_VERSION < '1.9.2'
+        out.first.should =~ /^\s+m3\(arg1, arg2\)\s+Hello\s\(unbound\)$/
+      else
+        out.first.should =~ /^\s+m3\(a, b\)\s+Hello\s\(unbound\)$/
+      end
+    end
+  end
+
+  describe "class.public_instance_methods" do
+    it "index: should handle class.public_instance_methods" do
+      class Hello
+        def m1; end
+        def m2; end
+      end
+      out = Hello.public_instance_methods.ai(:plain => true).split("\n").grep(/m\d/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\)\s+Hello\s\(unbound\)$/
+      out.last.should  =~ /^\s+\[\s*\d+\]\s+m2\(\)\s+Hello\s\(unbound\)$/
+    end
+
+    it "no index: should handle class.public_instance_methods" do
+      class Hello
+        def m3(a,b); end
+      end
+      out = Hello.public_instance_methods.ai(:plain => true, :index => false).split("\n").grep(/m\d/)
+      if RUBY_VERSION < '1.9.2'
+        out.first.should =~ /^\s+m3\(arg1, arg2\)\s+Hello\s\(unbound\)$/
+      else
+        out.first.should =~ /^\s+m3\(a, b\)\s+Hello\s\(unbound\)$/
+      end
+    end
+  end
+
+  describe "class.protected_instance_methods" do
+    it "index: should handle class.protected_instance_methods" do
+      class Hello
+        protected
+        def m1; end
+        def m2; end
+      end
+      out = Hello.protected_instance_methods.ai(:plain => true).split("\n").grep(/m\d/)
+      out.first.should =~ /^\s+\[\d+\]\s+m1\(\)\s+Hello\s\(unbound\)$/
+      out.last.should  =~ /^\s+\[\d+\]\s+m2\(\)\s+Hello\s\(unbound\)$/
+    end
+
+    it "no index: should handle class.protected_instance_methods" do
+      class Hello
+        protected
+        def m3(a,b); end
+      end
+      out = Hello.protected_instance_methods.ai(:plain => true, :index => false).split("\n").grep(/m\d/)
+      if RUBY_VERSION < '1.9.2'
+        out.first.should =~ /^\s+m3\(arg1, arg2\)\s+Hello\s\(unbound\)$/
+      else
+        out.first.should =~ /^\s+m3\(a, b\)\s+Hello\s\(unbound\)$/
+      end
+    end
+  end
+
+  describe "class.private_instance_methods" do
+    it "index: should handle class.private_instance_methods" do
+      class Hello
+        private
+        def m1; end
+        def m2; end
+      end
+      out = Hello.private_instance_methods.ai(:plain => true).split("\n").grep(/m\d/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\)\s+Hello\s\(unbound\)$/
+      out.last.should  =~ /^\s+\[\s*\d+\]\s+m2\(\)\s+Hello\s\(unbound\)$/
+    end
+
+    it "no index: should handle class.private_instance_methods" do
+      class Hello
+        private
+        def m3(a,b); end
+      end
+      out = Hello.private_instance_methods.ai(:plain => true, :index => false).split("\n").grep(/m\d/)
+      if RUBY_VERSION < '1.9.2'
+        out.first.should =~ /^\s+m3\(arg1, arg2\)\s+Hello\s\(unbound\)$/
+      else
+        out.first.should =~ /^\s+m3\(a, b\)\s+Hello\s\(unbound\)$/
+      end
+    end
+  end
+end
+
+if RUBY_VERSION >= '1.9.2'
+  describe "Ruby 1.9.2+ Method#parameters" do
+    after do
+      Object.instance_eval{ remove_const :Hello } if defined?(Hello)
+    end
+
+    it "()" do
+      class Hello
+        def m1; end
+      end
+      out = Hello.new.methods.ai(:plain => true).split("\n").grep(/m1/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\)\s+Hello$/
+    end
+
+    it ":req" do
+      class Hello
+        def m1(a, b, c); end
+      end
+      out = Hello.new.methods.ai(:plain => true).split("\n").grep(/m1/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(a, b, c\)\s+Hello$/
+    end
+
+    it ":opt" do
+      class Hello
+        def m1(a, b = 1, c = 2); end # m1(a, *b, *c)
+      end
+      out = Hello.new.methods.ai(:plain => true).split("\n").grep(/m1/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(a, \*b, \*c\)\s+Hello$/
+    end
+
+    it ":rest" do
+      class Hello
+        def m1(*a); end # m1(*a)
+      end
+      out = Hello.new.methods.ai(:plain => true).split("\n").grep(/m1/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(\*a\)\s+Hello$/
+    end
+
+    it ":block" do
+      class Hello
+        def m1(a, b = nil, &blk); end # m1(a, *b, &blk)
+      end
+      out = Hello.new.methods.ai(:plain => true).split("\n").grep(/m1/)
+      out.first.should =~ /^\s+\[\s*\d+\]\s+m1\(a, \*b, &blk\)\s+Hello$/
+    end
+  end
+end
+
+describe "Methods arrays" do
+  after do
+    Object.instance_eval{ remove_const :Hello } if defined?(Hello)
+    Object.instance_eval{ remove_const :World } if defined?(World)
+  end
+
+  it "obj1.methods - obj2.methods should be awesome printed" do
+    class Hello
+      def self.m1; end
+    end
+    out = (Hello.methods - Class.methods).ai(:plain => true)
+    out.should == "[\n    [0] m1() Hello\n]"
+  end
+
+  it "obj1.methods & obj2.methods should be awesome printed" do
+    class Hello
+      def self.m1; end
+      def self.m2; end
+    end
+    class World
+      def self.m1; end
+    end
+    out = (Hello.methods & World.methods - Class.methods).ai(:plain => true)
+    out.should == "[\n    [0] m1() Hello\n]"
+  end
+
+  it "obj1.methods.grep(pattern) should be awesome printed" do
+    class Hello
+      def self.m1; end
+      def self.m2; end
+      def self.m3; end
+    end
+    out = Hello.methods.grep(/^m1$/).ai(:plain => true)
+    out.should == "[\n    [0] m1() Hello\n]"
+    out = Hello.methods.grep(/^m\d$/).ai(:plain => true)
+    out.should == "[\n    [0] m1() Hello\n    [1] m2() Hello\n    [2] m3() Hello\n]"
+  end
+
+  it "obj1.methods.grep(pattern, &block) should pass the matching string within the block" do
+    class Hello
+      def self.m_one; end
+      def self.m_two; end
+    end
+
+    out = Hello.methods.grep(/^m_(.+)$/) { $1.to_sym }
+    out.should == [:one, :two]
+  end
+
+  it "obj1.methods.grep(pattern, &block) should be awesome printed" do
+    class Hello
+      def self.m0; end
+      def self.none; end
+      def self.m1; end
+      def self.one; end
+    end
+
+    out = Hello.methods.grep(/^m(\d)$/) { %w(none one)[$1.to_i] }.ai(:plain => true)
+    out.should == "[\n    [0] none() Hello\n    [1]  one() Hello\n]"
+  end
+end

data/spec/spec_helper.rb

@@ -1,11 +1,25 @@
+# Copyright (c) 2010 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
+#------------------------------------------------------------------------------
+#
+# Running specs with Ruby 1.8.7 and RSpec 1.3+:
+#   $ rake spec                           # Entire spec suite.
+#   $ ruby -rubygems spec/logger_spec.rb  # Individual spec file.
+#
+# Running specs with Ruby 1.9.2 and RSpec 2.0+:
+#   $ rake spec                           # Entire spec suite.
+#   $ rspec spec/logger_spec.rb           # Individual spec file.
+#
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ap'
-require 'spec'
-require 'spec/autorun'
-require 'rubygems'
 
-Spec::Runner.configure do |config|
+if RUBY_VERSION.to_f < 1.9
+  require 'spec'
+  require 'spec/autorun'
+  require 'rubygems'
 end
 
 def stub_dotfile!

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Michael Dvorkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-03 00:00:00 -07:00
+date: 2010-11-09 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +26,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
-        - 2
-        - 9
-        version: 1.2.9
+        - 3
+        - 0
+        version: 1.3.0
   type: :development
   version_requirements: *id001
 description: "Great Ruby dubugging companion: pretty print Ruby objects to visualize their structure. Supports Rails ActiveRecord objects via included mixin."
@@ -49,18 +49,22 @@ files:
 - init.rb
 - lib/ap.rb
 - lib/ap/awesome_print.rb
+- lib/ap/core_ext/array.rb
+- lib/ap/core_ext/class.rb
 - lib/ap/core_ext/kernel.rb
 - lib/ap/core_ext/logger.rb
+- lib/ap/core_ext/object.rb
 - lib/ap/core_ext/string.rb
 - lib/ap/mixin/action_view.rb
 - lib/ap/mixin/active_record.rb
 - lib/ap/mixin/active_support.rb
+- lib/awesome_print.rb
 - rails/init.rb
 - spec/action_view_spec.rb
 - spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
 - spec/logger_spec.rb
-- spec/spec.opts
+- spec/methods_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb
 has_rdoc: true
@@ -98,5 +102,6 @@ test_files:
 - spec/active_record_spec.rb
 - spec/awesome_print_spec.rb
 - spec/logger_spec.rb
+- spec/methods_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb

data/spec/spec.opts

@@ -1 +0,0 @@
---color