ryansch-awesome_print 1.0.2.1

data/spec/methods_spec.rb

@@ -0,0 +1,458 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Single method" do
+  before do
+    stub_dotfile!
+  end
+
+  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
+  before do
+    stub_dotfile!
+  end
+
+  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
+  before do
+    stub_dotfile!
+  end
+
+  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
+    before do
+      stub_dotfile!
+    end
+
+    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
+    stub_dotfile!
+    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
+    stub_dotfile!
+    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
+    stub_dotfile!
+    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
+    stub_dotfile!
+    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
+
+  # See https://github.com/michaeldv/awesome_print/issues/30 for details.
+  it "grepping methods and converting them to_sym should work as expected" do
+    class Hello
+      private
+      def him; end
+
+      def his
+        private_methods.grep(/^h..$/) { |n| n.to_sym }
+      end
+
+      def her
+        private_methods.grep(/^.e.$/) { |n| n.to_sym }
+      end
+    end
+
+    hello = Hello.new
+    (hello.send(:his) - hello.send(:her)).sort_by { |x| x.to_s }.should == [ :him, :his ]
+  end
+
+  it "appending garbage to methods array should not raise error" do
+    arr = 42.methods << [ :wtf ]
+    arr.ai(:plain => true).should_not raise_error(TypeError)
+    if RUBY_VERSION < '1.9.2'
+      arr.ai(:plain => true).should =~ /\s+wtf\(\?\)\s+\?/      # [ :wtf ].to_s => "wtf"
+    else
+      arr.ai(:plain => true).should =~ /\s+\[:wtf\]\(\?\)\s+\?/ # [ :wtf ].to_s => [:wtf]
+    end
+  end
+end

data/spec/objects_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Single method" do
+  before do
+    stub_dotfile!
+  end
+
+  after do
+    Object.instance_eval{ remove_const :Hello } if defined?(Hello)
+  end
+
+  describe "object" do
+    it "attributes" do
+      class Hello
+        attr_reader   :abra
+        attr_writer   :ca
+        attr_accessor :dabra
+
+        def initialize
+          @abra, @ca, @dabra = 1, 2, 3
+        end
+      end
+
+      out = Hello.new.ai(:plain => true)
+      str = <<-EOS.strip
+#<Hello:0x01234567
+    attr_accessor :dabra = 3,
+    attr_reader :abra = 1,
+    attr_writer :ca = 2
+>
+EOS
+      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+    end
+
+    it "instance variables" do
+      class Hello
+        def initialize
+          @abra, @ca, @dabra = 1, 2, 3
+        end
+      end
+
+      out = Hello.new.ai(:plain => true)
+      str = <<-EOS.strip
+#<Hello:0x01234567
+    @abra = 1,
+    @ca = 2,
+    @dabra = 3
+>
+EOS
+      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+    end
+
+    it "attributes and instance variables" do
+      class Hello
+        attr_reader   :abra
+        attr_writer   :ca
+        attr_accessor :dabra
+
+        def initialize
+          @abra, @ca, @dabra = 1, 2, 3
+          @scooby, @dooby, @doo = 3, 2, 1
+        end
+      end
+
+      out = Hello.new.ai(:plain => true)
+      str = <<-EOS.strip
+#<Hello:0x01234567
+    @doo = 1,
+    @dooby = 2,
+    @scooby = 3,
+    attr_accessor :dabra = 3,
+    attr_reader :abra = 1,
+    attr_writer :ca = 2
+>
+EOS
+      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+# 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
+#------------------------------------------------------------------------------
+#
+# Running specs from the command line:
+#   $ 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 'awesome_print'
+
+def stub_dotfile!
+  dotfile = File.join(ENV["HOME"], ".aprc")
+  File.should_receive(:readable?).at_least(:once).with(dotfile).and_return(false)
+end
+
+# The following is needed for the Infinity Test. It runs tests as subprocesses,
+# which sets STDOUT.tty? to false and would otherwise prematurely disallow colors.
+### AwesomePrint.force_colors!
+
+# Ruby 1.8.6 only: define missing String methods that are needed for the specs to pass.
+if RUBY_VERSION < '1.8.7'
+  class String
+    def shellescape # Taken from Ruby 1.9.2 standard library, see lib/shellwords.rb.
+      return "''" if self.empty?
+      str = self.dup
+      str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")
+      str.gsub!(/\n/, "'\n'")
+      str
+    end
+
+    def start_with?(*prefixes)
+      prefixes.each do |prefix|
+        prefix = prefix.to_s
+        return true if prefix == self[0, prefix.size]
+      end
+      false
+    end
+
+    def end_with?(*suffixes)
+      suffixes.each do |suffix|
+        suffix = suffix.to_s
+        return true if suffix == self[-suffix.size, suffix.size]
+      end
+      false
+    end
+  end
+end