awesome_print 1.6.1 → 1.7.0

data/lib/awesome_print/version.rb

@@ -5,6 +5,6 @@
 #------------------------------------------------------------------------------
 module AwesomePrint
   def self.version
-    "1.6.1"
+    '1.7.0'
   end
 end

data/spec/active_record_helper.rb

@@ -1,34 +1,24 @@
-require 'active_record'
-
-# Required to use the column support
-module Rails
-  def self.env
-    {}
+if ExtVerifier.has_rails?
+  # Required to use the column support
+  module Rails
+    def self.env
+      {}
+    end
   end
-end
-
-# Establish connection to in-memory SQLite DB
-ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
-
-# Create the users table
-ActiveRecord::Migration.verbose = false
-ActiveRecord::Migration.create_table :users do |t|
-  t.string :name
-  t.integer :rank
-  t.boolean :admin
-  t.datetime :created_at
-end
-
-# Create models
-class User < ActiveRecord::Base; end
-class SubUser < User; end
 
+  # Establish connection to in-memory SQLite DB
+  ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 
-# Helper methods
-# ##############
+  # Create the users table
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Migration.create_table :users do |t|
+    t.string :name
+    t.integer :rank
+    t.boolean :admin
+    t.datetime :created_at
+  end
 
-# we only work with ActiveRecord 2+
-def is_usable_activerecord?
-  defined?(ActiveRecord::VERSION::MAJOR) && ActiveRecord::VERSION::MAJOR >= 2
+  # Create models
+  class User < ActiveRecord::Base; end
+  class SubUser < User; end
 end
-

data/spec/colors_spec.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "AwesomePrint" do
+RSpec.describe "AwesomePrint" do
   def stub_tty!(output = true, stream = STDOUT)
     if output
       stream.instance_eval { def tty?;  true; end }

data/spec/formats_spec.rb

@@ -1,9 +1,9 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 require "bigdecimal"
 require "rational"
 require "set"
 
-describe "AwesomePrint" do
+RSpec.describe "AwesomePrint" do
   before do
     stub_dotfile!
   end
@@ -451,11 +451,11 @@ EOS
 
   #------------------------------------------------------------------------------
   describe "Class" do
-    it "shoud show superclass (plain)" do
+    it "should show superclass (plain)" do
       expect(self.class.ai(:plain => true)).to eq("#{self.class} < #{self.class.superclass}")
     end
 
-    it "shoud show superclass (color)" do
+    it "should show superclass (color)" do
       expect(self.class.ai).to eq("#{self.class} < #{self.class.superclass}".yellow)
     end
   end
@@ -576,56 +576,44 @@ EOS
 
     it "plain multiline" do
       s1 = <<-EOS.strip
-{
-    :address => "1313 Mockingbird Lane",
-       :name => "Herman Munster"
-}
+    address = \"1313 Mockingbird Lane\",
+    name = \"Herman Munster\"
 EOS
       s2 = <<-EOS.strip
-{
-       :name => "Herman Munster",
-    :address => "1313 Mockingbird Lane"
-}
+    name = \"Herman Munster\",
+    address = \"1313 Mockingbird Lane\"
 EOS
-      expect(@struct.ai(:plain => true)).to satisfy { |match| match == s1 || match == s2 }
+      expect(@struct.ai(:plain => true)).to satisfy { |out| out.match(s1) || out.match(s2) }
     end
 
     it "plain multiline indented" do
       s1 = <<-EOS.strip
-{
- :address => "1313 Mockingbird Lane",
-    :name => "Herman Munster"
-}
+ address = "1313 Mockingbird Lane",
+ name = "Herman Munster"
 EOS
       s2 = <<-EOS.strip
-{
-    :name => "Herman Munster",
- :address => "1313 Mockingbird Lane"
-}
+ name = "Herman Munster",
+ address = "1313 Mockingbird Lane"
 EOS
-      expect(@struct.ai(:plain => true, :indent => 1)).to satisfy { |match| match == s1 || match == s2 }
+      expect(@struct.ai(:plain => true, :indent => 1)).to satisfy { |out| out.match(s1) || out.match(s2) }
     end
 
     it "plain single line" do
-      s1 = "{ :address => \"1313 Mockingbird Lane\", :name => \"Herman Munster\" }"
-      s2 = "{ :name => \"Herman Munster\", :address => \"1313 Mockingbird Lane\" }"
-      expect(@struct.ai(:plain => true, :multiline => false)).to satisfy { |match| match == s1 || match == s2 }
+      s1 = "address = \"1313 Mockingbird Lane\", name = \"Herman Munster\""
+      s2 = "name = \"Herman Munster\", address = \"1313 Mockingbird Lane\""
+      expect(@struct.ai(:plain => true, :multiline => false)).to satisfy { |out| out.match(s1) || out.match(s2) }
     end
 
     it "colored multiline (default)" do
       s1 = <<-EOS.strip
-{
-    :address\e[0;37m => \e[0m\e[0;33m\"1313 Mockingbird Lane\"\e[0m,
-       :name\e[0;37m => \e[0m\e[0;33m\"Herman Munster\"\e[0m
-}
+    address\e[0;37m = \e[0m\e[0;33m\"1313 Mockingbird Lane\"\e[0m,
+    name\e[0;37m = \e[0m\e[0;33m\"Herman Munster\"\e[0m
 EOS
       s2 = <<-EOS.strip
-{
-       :name\e[0;37m => \e[0m\e[0;33m\"Herman Munster\"\e[0m,
-    :address\e[0;37m => \e[0m\e[0;33m\"1313 Mockingbird Lane\"\e[0m
-}
+    name\e[0;37m = \e[0m\e[0;33m\"Herman Munster\"\e[0m,
+    address\e[0;37m = \e[0m\e[0;33m\"1313 Mockingbird Lane\"\e[0m
 EOS
-      expect(@struct.ai).to satisfy { |match| match == s1 || match == s2 }
+      expect(@struct.ai).to satisfy { |out| out.include?(s1) || out.include?(s2) }
     end
   end
 
@@ -708,5 +696,56 @@ EOS
       my = My.new
       expect { my.methods.ai(:plain => true) }.not_to raise_error
     end
+
+    describe "should handle a class that defines its own #to_hash method" do
+      it "that takes arguments" do
+        class My
+          def to_hash(a, b)
+          end
+        end
+
+        my = My.new
+        expect { my.ai(:plain => true) }.not_to raise_error
+      end
+
+      it "that returns nil" do
+        class My
+          def to_hash()
+            return nil
+          end
+        end
+
+        my = My.new
+        expect { my.ai(:plain => true) }.not_to raise_error
+      end
+
+      it "that returns an object that doesn't support #keys" do
+        class My
+          def to_hash()
+            object = Object.new
+            object.define_singleton_method('[]') { return nil }
+
+            return object
+          end
+        end
+
+        my = My.new
+        expect { my.ai(:plain => true) }.not_to raise_error
+      end
+
+      it "that returns an object that doesn't support subscripting" do
+        class My
+          def to_hash()
+            object = Object.new
+            object.define_singleton_method(:keys) { return [:foo] }
+
+            return object
+          end
+        end
+
+        my = My.new
+        expect { my.ai(:plain => true) }.not_to raise_error
+      end
+    end
   end
 end

data/spec/methods_spec.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "Single method" do
+RSpec.describe "Single method" do
   before do
     stub_dotfile!
   end
@@ -80,7 +80,7 @@ describe "Single method" do
   end
 end
 
-describe "Object methods" do
+RSpec.describe "Object methods" do
   before do
     stub_dotfile!
   end
@@ -202,7 +202,7 @@ describe "Object methods" do
   end
 end
 
-describe "Class methods" do
+RSpec.describe "Class methods" do
   before do
     stub_dotfile!
   end
@@ -313,7 +313,7 @@ describe "Class methods" do
 end
 
 if RUBY_VERSION >= '1.9.2'
-  describe "Ruby 1.9.2+ Method#parameters" do
+  RSpec.describe "Ruby 1.9.2+ Method#parameters" do
     before do
       stub_dotfile!
     end
@@ -364,7 +364,7 @@ if RUBY_VERSION >= '1.9.2'
   end
 end
 
-describe "Methods arrays" do
+RSpec.describe "Methods arrays" do
   after do
     Object.instance_eval{ remove_const :Hello } if defined?(Hello)
     Object.instance_eval{ remove_const :World } if defined?(World)

data/spec/misc_spec.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "AwesomePrint" do
+RSpec.describe "AwesomePrint" do
 
   describe "Misc" do
     before do
@@ -204,6 +204,7 @@ EOS
   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 }
@@ -211,6 +212,7 @@ EOS
 
     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 }

data/spec/objects_spec.rb

@@ -1,6 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "Objects" do
+RSpec.describe "Objects" do
   before do
     stub_dotfile!
   end
@@ -24,13 +24,13 @@ describe "Objects" do
       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
-      expect(out.gsub(/0x([a-f\d]+)/, "0x01234567")).to eq(str)
+      expect(out).to be_similar_to(str)
       expect(hello.ai(:plain => true, :raw => false)).to eq(hello.inspect)
     end
 
@@ -44,13 +44,13 @@ EOS
       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
-      expect(out.gsub(/0x([a-f\d]+)/, "0x01234567")).to eq(str)
+      expect(out).to be_similar_to(str)
       expect(hello.ai(:plain => true, :raw => false)).to eq(hello.inspect)
     end
 
@@ -69,7 +69,7 @@ EOS
       hello = Hello.new
       out = hello.ai(:plain => true, :raw => true)
       str = <<-EOS.strip
-#<Hello:0x01234567
+#<Hello:placeholder_id
     @doo = 1,
     @dooby = 2,
     @scooby = 3,
@@ -78,7 +78,51 @@ EOS
     attr_writer :ca = 2
 >
 EOS
-      expect(out.gsub(/0x([a-f\d]+)/, "0x01234567")).to eq(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

data/spec/spec_helper.rb

@@ -14,14 +14,62 @@
 # $ 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'))
-require 'awesome_print'
 
 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")
   expect(File).to receive(:readable?).at_least(:once).with(dotfile).and_return(false)
@@ -33,36 +81,3 @@ def capture!
 ensure
   $stdout = standard
 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