awesome_print 0.2.1 → 0.4.0

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
@@ -219,6 +263,45 @@ EOS
     end
   end
 
+  #------------------------------------------------------------------------------
+  describe "Hash with several keys" do
+    before(:each) do
+      @hash = {"b" => "b", :a => "a", :z => "z", "alpha" => "alpha"}
+    end
+
+    it "plain multiline" do
+      out = @hash.ai(:plain => true)
+      if RUBY_VERSION.to_f < 1.9 # Order of @hash keys is not guaranteed.
+        out.should =~ /^\{[^\}]+\}/m
+        out.should =~ /        "b" => "b",?/
+        out.should =~ /         :a => "a",?/
+        out.should =~ /         :z => "z",?/
+        out.should =~ /    "alpha" => "alpha",?$/
+      else
+        out.should == <<-EOS.strip
+{
+        "b" => "b",
+         :a => "a",
+         :z => "z",
+    "alpha" => "alpha"
+}
+EOS
+      end
+    end
+    
+    it "plain multiline with sorted keys" do
+      @hash.ai(:plain => true, :sorted_hash_keys => true).should == <<-EOS.strip
+{
+         :a => "a",
+    "alpha" => "alpha",
+        "b" => "b",
+         :z => "z"
+}
+EOS
+    end
+
+  end
+
   #------------------------------------------------------------------------------
   describe "Negative options[:indent]" do
     before(:each) do
@@ -361,4 +444,137 @@ 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
+
+    # See https://github.com/michaeldv/awesome_print/issues/35
+    it "handle array grep when pattern contains / chapacter" do
+      hash = { "1/x" => 1,  "2//x" => :"2" }
+      grepped = hash.keys.grep(/^(\d+)\//) { $1 }
+      grepped.ai(:plain => true, :multiline => false).should == '[ "1", "2" ]'
+    end
+
+    it "returns value passed as a parameter" do
+      object = rand
+      self.stub!(:puts)
+      (ap object).should == object
+    end
+
+    # Require different file name this time (lib/ap.rb vs. lib/awesome_print).
+    it "several require 'awesome_print' should do no harm" do
+      require File.expand_path(File.dirname(__FILE__) + '/../lib/ap')
+      lambda { rand.ai }.should_not raise_error
+    end
+  end
+
+  describe "HTML output" do
+    it "wraps ap output with plain <pre> tag" do
+      markup = rand
+      markup.ai(:html => true, :plain => true).should == "<pre>#{markup}</pre>"
+    end
+
+    it "wraps ap output with colorized <pre> tag" do
+      markup = rand
+      markup.ai(:html => true).should == %Q|<pre style="color:blue">#{markup}</pre>|
+    end
+
+    it "encodes HTML entities (plain)" do
+      markup = ' &<hello>'
+      markup.ai(:html => true, :plain => true).should == '<pre>&quot; &amp;&lt;hello&gt;&quot;</pre>'
+    end
+
+    it "encodes HTML entities (color)" do
+      markup = ' &<hello>'
+      markup.ai(:html => true).should == '<pre style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</pre>'
+    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') rescue File.new('nul')
+      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
+
+      require 'tmpdir'
+      my = My.new(Dir.tmpdir)
+      my.ai(:plain => true).should == "#{my.inspect}\n" << `ls -alF #{my.path}`.chop
+    end
+
+    it "should handle a class that defines its own #send method" do
+      class My
+        def send(arg1, arg2, arg3); end
+      end
+
+      my = My.new
+      my.methods.ai(:plain => true).should_not raise_error(ArgumentError)
+    end
+
+    it "should handle a class defines its own #method method (ex. request.method)" do
+      class My
+        def method
+          'POST'
+        end
+      end
+
+      my = My.new
+      my.methods.ai(:plain => true).should_not raise_error(ArgumentError)
+    end
+  end
 end

data/spec/colorization_spec.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "AwesomePrint" do
+  before(:each) do
+    stub_dotfile!
+  end
+
+  describe "colorization" do
+    PLAIN = '[ 1, :two, "three", [ nil, [ true, false ] ] ]'
+    COLORIZED = "[ \e[1;34m1\e[0m, \e[0;36m:two\e[0m, \e[0;33m\"three\"\e[0m, [ \e[1;31mnil\e[0m, [ \e[1;32mtrue\e[0m, \e[1;31mfalse\e[0m ] ] ]"
+
+    before(:each) do
+      AwesomePrint.force_colors!(false)
+      ENV['TERM'] = "xterm-colors"
+      ENV.delete('ANSICON')
+      @arr = [ 1, :two, "three", [ nil, [ true, false] ] ]
+    end
+    
+    it "colorizes tty processes by default" do
+      stub_tty!(STDOUT, true)
+
+      @arr.ai(:multiline => false).should == COLORIZED
+    end
+
+    it "colorizes tty processes by default" do
+      stub_tty!(STDOUT, true)
+
+      @arr.ai(:multiline => false).should == COLORIZED
+    end
+
+    
+    it "colorizes processes with ENV['ANSICON'] by default" do
+      stub_tty!(STDOUT, true)
+      ENV['ANSICON'] = "1"
+
+      @arr.ai(:multiline => false).should == COLORIZED
+    end
+
+    it "does not colorize tty processes running in dumb terminals by default" do
+      stub_tty!(STDOUT, true)
+      ENV['TERM'] = "dumb"
+
+      @arr.ai(:multiline => false).should == PLAIN
+    end
+
+    it "does not colorize subprocesses by default" do
+      stub_tty!(STDOUT, false)
+
+      @arr.ai(:multiline => false).should == PLAIN
+    end
+    
+    describe "forced" do
+      before(:each) do
+        AwesomePrint.force_colors!
+      end
+      
+      it "still colorizes tty processes" do
+        stub_tty!(STDOUT, true)
+
+        @arr.ai(:multiline => false).should == COLORIZED
+      end
+      
+      it "colorizes dumb terminals" do
+        stub_tty!(STDOUT, true)
+        ENV["TERM"] = "dumb"
+
+        @arr.ai(:multiline => false).should == COLORIZED
+      end
+
+      it "colorizes subprocess" do
+        stub_tty!(STDOUT, true)
+        @arr.ai(:multiline => false).should == COLORIZED
+      end
+    end
+  end
+  
+  def stub_tty!(stream, value)
+    eval(%{class << stream
+      def tty?
+        #{value}
+      end
+    end})
+  end
+end

data/spec/logger_spec.rb

@@ -6,7 +6,7 @@ require 'ap/core_ext/logger'
 
 describe "AwesomePrint logging extensions" do
   before(:all) do
-    @logger = Logger.new('/dev/null')
+    @logger = Logger.new('/dev/null') rescue Logger.new('nul')
   end
 
   describe "ap method" do