awesome_print 1.0.2 → 1.7.0

data/spec/misc_spec.rb

@@ -0,0 +1,250 @@
+require 'spec_helper'
+
+RSpec.describe "AwesomePrint" do
+
+  describe "Misc" do
+    before do
+      stub_dotfile!
+    end
+
+    it "handle weird objects that return nil on inspect" do
+      weird = Class.new do
+        def inspect
+          nil
+        end
+      end
+      expect(weird.new.ai(:plain => true)).to eq('')
+    end
+
+    it "handle frozen object.inspect" do
+      weird = Class.new do
+        def inspect
+          "ice".freeze
+        end
+      end
+      expect(weird.new.ai(:plain => false)).to eq("ice")
+    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.sort.grep(/^(\d+)\//) { $1 }
+      expect(grepped.ai(:plain => true, :multiline => false)).to eq('[ "1", "2" ]')
+    end
+
+    # See https://github.com/michaeldv/awesome_print/issues/85
+    if RUBY_VERSION >= "1.8.7"
+      it "handle array grep when a method is defined in C and thus doesn't have a binding" do
+        arr = (0..6).to_a
+        grepped = arr.grep(1..4, &:succ)
+        expect(grepped.ai(:plain => true, :multiline => false)).to eq('[ 2, 3, 4, 5 ]')
+      end
+    end
+
+    it "returns value passed as a parameter" do
+      object = rand
+      allow(self).to receive(:puts)
+      expect(ap object).to eq(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')
+      expect { rand.ai }.not_to raise_error
+    end
+
+    it "format ENV as hash" do
+      expect(ENV.ai(:plain => true)).to eq(ENV.to_hash.ai(:plain => true))
+      expect(ENV.ai).to eq(ENV.to_hash.ai)
+    end
+
+    # See https://github.com/michaeldv/awesome_print/issues/134
+    it "IPAddr workaround" do
+      require "ipaddr"
+      ipaddr = IPAddr.new("3ffe:505:2::1")
+      expect(ipaddr.ai).to eq("#<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>")
+    end
+
+    # See https://github.com/michaeldv/awesome_print/issues/139
+    it "Object that overrides == and expects the :id method" do
+      weird = Class.new do
+        # Raises NoMethodError: undefined method `id' when "other" is nil or ENV.
+        def ==(other)
+          self.id == other.id
+        end
+        alias :eql? :==
+      end
+      expect { weird.new.ai }.not_to raise_error
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "HTML output" do
+    before do
+      stub_dotfile!
+    end
+
+    it "wraps ap output with plain <pre> tag" do
+      markup = rand
+      expect(markup.ai(:html => true, :plain => true)).to eq("<pre>#{markup}</pre>")
+    end
+
+    it "wraps ap output with <pre> tag with colorized <kbd>" do
+      markup = rand
+      expect(markup.ai(:html => true)).to eq(%Q|<pre><kbd style="color:blue">#{markup}</kbd></pre>|)
+    end
+
+    it "wraps multiline ap output with <pre> tag with colorized <kbd>" do
+      markup = [ 1, :two, "three" ]
+      expect(markup.ai(:html => true)).to eq <<-EOS.strip
+<pre>[
+    <kbd style="color:white">[0] </kbd><kbd style="color:blue">1</kbd>,
+    <kbd style="color:white">[1] </kbd><kbd style="color:darkcyan">:two</kbd>,
+    <kbd style="color:white">[2] </kbd><kbd style="color:brown">&quot;three&quot;</kbd>
+]</pre>
+EOS
+    end
+
+    it "wraps hash ap output with only an outer <pre> tag" do
+      markup = [ { "hello" => "world" } ]
+      expect(markup.ai(:html => true)).to eq <<-EOS.strip
+<pre>[
+    <kbd style="color:white">[0] </kbd>{
+        &quot;hello&quot;<kbd style="color:slategray"> =&gt; </kbd><kbd style="color:brown">&quot;world&quot;</kbd>
+    }
+]</pre>
+    EOS
+    end
+
+    it "encodes HTML entities (plain)" do
+      markup = ' &<hello>'
+      expect(markup.ai(:html => true, :plain => true)).to eq('<pre>&quot; &amp;&lt;hello&gt;&quot;</pre>')
+    end
+
+    it "encodes HTML entities (color)" do
+      markup = ' &<hello>'
+      expect(markup.ai(:html => true)).to eq('<pre><kbd style="color:brown">&quot; &amp;&lt;hello&gt;&quot;</kbd></pre>')
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "AwesomePrint.defaults" do
+    before do
+      stub_dotfile!
+    end
+
+    after do
+      AwesomePrint.defaults = nil
+    end
+
+    # See https://github.com/michaeldv/awesome_print/issues/98
+    it "should properly merge the defaults" do
+      AwesomePrint.defaults = { :indent => -2, :sort_keys => true }
+      hash = { [0, 0, 255] => :yellow, :red => "rgb(255, 0, 0)", "magenta" => "rgb(255, 0, 255)" }
+      out = hash.ai(:plain => true)
+      expect(out).to eq <<-EOS.strip
+{
+  [ 0, 0, 255 ] => :yellow,
+  "magenta"     => "rgb(255, 0, 255)",
+  :red          => "rgb(255, 0, 0)"
+}
+EOS
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Coexistence with the colorize gem" do
+    before do
+      stub_dotfile!
+    end
+
+    before do # Redefine String#red just like colorize gem does it.
+      @awesome_method = "".method(:red)
+
+      String.instance_eval do
+        define_method :red do   # Method arity is now 0 in Ruby 1.9+.
+          "[red]#{self}[/red]"
+        end
+      end
+    end
+
+    after do # Restore String#red method.
+      awesome_method = @awesome_method
+      String.instance_eval do
+        define_method :red, awesome_method
+      end
+    end
+
+    it "shoud not raise ArgumentError when formatting HTML" do
+      out = "hello".ai(:color => { :string => :red }, :html => true)
+      if RUBY_VERSION >= "1.9"
+        expect(out).to eq(%Q|<pre>[red]<kbd style="color:red">&quot;hello&quot;</kbd>[/red]</pre>|)
+      else
+        expect(out).to eq(%Q|<pre>[red]&quot;hello&quot;[/red]</pre>|)
+      end
+    end
+
+    it "shoud not raise ArgumentError when formatting HTML (shade color)" do
+      out = "hello".ai(:color => { :string => :redish }, :html => true)
+      expect(out).to eq(%Q|<pre><kbd style="color:darkred">&quot;hello&quot;</kbd></pre>|)
+    end
+
+    it "shoud not raise ArgumentError when formatting non-HTML" do
+      out = "hello".ai(:color => { :string => :red }, :html => false)
+      expect(out).to eq(%Q|[red]"hello"[/red]|)
+    end
+
+    it "shoud not raise ArgumentError when formatting non-HTML (shade color)" do
+      out = "hello".ai(:color => { :string => :redish }, :html => false)
+      expect(out).to eq(%Q|\e[0;31m"hello"\e[0m|)
+    end
+  end
+
+  #------------------------------------------------------------------------------
+  describe "Console" do
+    it "should detect IRB" do
+      class IRB; end
+      ENV.delete('RAILS_ENV')
+      expect(AwesomePrint.console?).to eq(true)
+      expect(AwesomePrint.rails_console?).to eq(false)
+      Object.instance_eval{ remove_const :IRB }
+    end
+
+    it "should detect Pry" do
+      class Pry; end
+      ENV.delete('RAILS_ENV')
+      expect(AwesomePrint.console?).to eq(true)
+      expect(AwesomePrint.rails_console?).to eq(false)
+      Object.instance_eval{ remove_const :Pry }
+    end
+
+    it "should detect Rails::Console" do
+      class IRB; end
+      module Rails; class Console; end; end
+      expect(AwesomePrint.console?).to eq(true)
+      expect(AwesomePrint.rails_console?).to eq(true)
+      Object.instance_eval{ remove_const :IRB }
+      Object.instance_eval{ remove_const :Rails }
+    end
+
+    it "should detect ENV['RAILS_ENV']" do
+      class Pry; end
+      ENV["RAILS_ENV"] = "development"
+      expect(AwesomePrint.console?).to eq(true)
+      expect(AwesomePrint.rails_console?).to eq(true)
+      Object.instance_eval{ remove_const :Pry }
+    end
+
+    it "should return the actual object when *not* running under console" do
+      expect(capture! { ap([ 1, 2, 3 ]) }).to eq([ 1, 2, 3 ])
+      expect(capture! { ap({ :a => 1 }) }).to eq({ :a => 1 })
+    end
+
+    it "should return nil when running under console" do
+      class IRB; end
+      expect(capture! { ap([ 1, 2, 3 ]) }).to eq(nil)
+      expect(capture! { ap({ :a => 1 }) }).to eq(nil)
+      Object.instance_eval{ remove_const :IRB }
+    end
+  end
+end

data/spec/objects_spec.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "Single method" do
+RSpec.describe "Objects" do
   before do
     stub_dotfile!
   end
@@ -9,7 +9,7 @@ describe "Single method" do
     Object.instance_eval{ remove_const :Hello } if defined?(Hello)
   end
 
-  describe "object" do
+  describe "Formatting an object" do
     it "attributes" do
       class Hello
         attr_reader   :abra
@@ -21,15 +21,17 @@ describe "Single method" do
         end
       end
 
-      out = Hello.new.ai(:plain => true)
+      hello = Hello.new
+      out = hello.ai(:plain => true, :raw => true)
       str = <<-EOS.strip
-#<Hello:0x01234567
+#<Hello:placeholder_id
     attr_accessor :dabra = 3,
     attr_reader :abra = 1,
     attr_writer :ca = 2
 >
 EOS
-      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+      expect(out).to be_similar_to(str)
+      expect(hello.ai(:plain => true, :raw => false)).to eq(hello.inspect)
     end
 
     it "instance variables" do
@@ -39,15 +41,17 @@ EOS
         end
       end
 
-      out = Hello.new.ai(:plain => true)
+      hello = Hello.new
+      out = hello.ai(:plain => true, :raw => true)
       str = <<-EOS.strip
-#<Hello:0x01234567
+#<Hello:placeholder_id
     @abra = 1,
     @ca = 2,
     @dabra = 3
 >
 EOS
-      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+      expect(out).to be_similar_to(str)
+      expect(hello.ai(:plain => true, :raw => false)).to eq(hello.inspect)
     end
 
     it "attributes and instance variables" do
@@ -62,9 +66,10 @@ EOS
         end
       end
 
-      out = Hello.new.ai(:plain => true)
+      hello = Hello.new
+      out = hello.ai(:plain => true, :raw => true)
       str = <<-EOS.strip
-#<Hello:0x01234567
+#<Hello:placeholder_id
     @doo = 1,
     @dooby = 2,
     @scooby = 3,
@@ -73,7 +78,52 @@ EOS
     attr_writer :ca = 2
 >
 EOS
-      out.gsub(/0x([a-f\d]+)/, "0x01234567").should == str
+      expect(out).to be_similar_to(str)
+      expect(hello.ai(:plain => true, :raw => false)).to eq(hello.inspect)
+    end
+
+    it "without the plain options print the colorized values" do
+      class Hello
+        attr_reader   :abra
+        attr_writer   :ca
+
+        def initialize
+          @abra, @ca = 1, 2
+          @dabra = 3
+        end
+      end
+
+      hello = Hello.new
+      out = hello.ai(:raw => true)
+      str = <<-EOS.strip
+#<Hello:placeholder_id
+    \e[0;36m@dabra\e[0m\e[0;37m = \e[0m\e[1;34m3\e[0m,
+    \e[1;36mattr_reader\e[0m \e[0;35m:abra\e[0m\e[0;37m = \e[0m\e[1;34m1\e[0m,
+    \e[1;36mattr_writer\e[0m \e[0;35m:ca\e[0m\e[0;37m = \e[0m\e[1;34m2\e[0m
+>
+EOS
+      expect(out).to be_similar_to(str)
+      expect(hello.ai(:plain => true, :raw => false)).to eq(hello.inspect)
+    end
+
+    it "with multine as false show inline values" do
+      class Hello
+        attr_reader   :abra
+        attr_writer   :ca
+
+        def initialize
+          @abra, @ca = 1, 2
+          @dabra = 3
+        end
+      end
+
+      hello = Hello.new
+      out = hello.ai(:multiline => false, :plain => true, :raw => true)
+      str = <<-EOS.strip
+#<Hello:placeholder_id @dabra = 3, attr_reader :abra = 1, attr_writer :ca = 2>
+EOS
+      expect(out).to be_similar_to(str)
+      expect(hello.ai(:plain => true, :raw => false)).to eq(hello.inspect)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2010-2011 Michael Dvorkin
+# Copyright (c) 2010-2013 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
@@ -6,46 +6,78 @@
 #
 # Running specs from the command line:
 #   $ rake spec                   # Entire spec suite.
-#   $ rspec spec/logger_spec.rb   # Individual spec file.
+#   $ rspec spec/objects_spec.rb  # Individual spec file.
 #
+# NOTE: To successfully run specs with Ruby 1.8.6 the older versions of
+# Bundler and RSpec gems are required:
+#
+# $ gem install bundler -v=1.0.2
+# $ gem install rspec -v=2.6.0
+#
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each do |file|
+  require file
+end
+
+ExtVerifier.require_dependencies!(%w{rails active_record action_view
+                                  active_support/all mongoid mongo_mapper ripple nobrainer})
+require 'nokogiri'
 require 'awesome_print'
 
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  # TODO: Make specs not order dependent
+  # config.order = :random
+  Kernel.srand config.seed
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+end
+
+# This matcher handles the normalization of objects to replace non deterministic
+# parts (such as object IDs) with simple placeholder strings before doing a
+# comparison with a given string. It's important that this method only matches
+# a string which strictly conforms to the expected object ID format.
+RSpec::Matchers.define :be_similar_to do |expected, options|
+  match do |actual|
+    options ||= {}
+    @actual = normalize_object_id_strings(actual, options)
+    values_match? expected, @actual
+  end
+
+  diffable
+end
+
+# Override the Object IDs with a placeholder so that we are only checking
+# that an ID is present and not that it matches a certain value. This is
+# necessary as the Object IDs are not deterministic.
+def normalize_object_id_strings(str, options)
+  str = str.gsub(/#<(.*?):0x[a-f\d]+/, '#<\1:placeholder_id') unless options[:skip_standard]
+  str = str.gsub(/BSON::ObjectId\('[a-f\d]{24}'\)/, 'placeholder_bson_id') unless options[:skip_bson]
+  str
+end
+
 def stub_dotfile!
   dotfile = File.join(ENV["HOME"], ".aprc")
-  File.should_receive(:readable?).at_least(:once).with(dotfile).and_return(false)
+  expect(File).to 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
+def capture!
+  standard, $stdout = $stdout, StringIO.new
+  yield
+ensure
+  $stdout = standard
 end