assert 2.3.3 → 2.4.0

data/README.md

@@ -250,6 +250,90 @@ Assert.configure do |config|
 end
 ```
 
+### Pretty Printing values in fail messages
+
+By default, Assert uses `inspect` when outputting value details in failure messages.  At times you may want to pretty-print complex objects as their inspect value is not very human-readable.  You can tell Assert to pretty print the assertion objects instead.
+
+In user/local settings file:
+
+```ruby
+Assert.configure do |config|
+  config.pp_objects true
+end
+```
+
+Using the CLI:
+
+```sh
+$ assert [-p|--pp-objects|--no-pp-objects]
+```
+
+#### Default pretty print processor
+
+Assert uses the stdlib's `PP.pp` to pretty print objects by default.  This is provided by the `Assert::Utils.stdlib_pp_proc` util.
+
+Using the default `inspect` (no pretty print):
+
+```
+$ assert
+
+FAIL: a test that fails should fail
+Expected nil, not {:now_usec=>164055, :string=>"a really really really really really really really really long string", :now=>Thu Nov 14 10:28:49 -0600 2013}.
+```
+
+Using the default pretty printing (`Assert::Utils.stdlib_pp_proc`):
+
+```
+$ assert -p
+
+FAIL: a test that fails should fail
+Expected nil, not
+{:now_usec=>45127,
+ :string=>
+  "a really really really really really really really really long string",
+ :now=>Thu Nov 14 10:28:35 -0600 2013}
+.
+```
+
+You can customize the width used by `PP.pp` by overriding the default `pp_proc` setting:
+
+```ruby
+# set PP.pp width used to 1
+Assert.configure do |config|
+  config.pp_proc Assert::Utils.stdlib_pp_proc(1)
+end
+```
+```
+$ assert -p
+
+FAIL: a test that fails should fail
+Expected nil, not
+{:now_usec=>
+  984698,
+ :string=>
+  "a really really really really really really really really long string",
+ :now=>
+  Thu Nov 14 10:30:52 -0600 2013}
+.
+```
+
+You can provide you own custom pretty-print processor if you like:
+
+```ruby
+# set not a very useful pretty print processor
+Assert.configure do |config|
+  config.pp_proc Proc.new{ |obj| "herp derp" }
+end
+```
+```
+$ assert -p
+
+FAIL: a test that fails should fail
+Expected nil, not herp derp.
+```
+
+Use this if you prefer a 3rd-party tool (like awesome_print or something) over the stdlib `PP.pp` for pretty printing.
+
 ## Viewing Test Results
 
 `Assert::View::DefaultView` is the default handler for viewing test results.  Its output goes something like this:

data/lib/assert.rb

@@ -1,6 +1,7 @@
 require 'singleton'
 require 'assert/version'
 
+require 'assert/utils'
 require 'assert/view'
 require 'assert/suite'
 require 'assert/runner'
@@ -33,8 +34,8 @@ module Assert
     end
 
     settings :view, :suite, :runner, :test_dir, :test_helper, :changed_files
-    settings :runner_seed, :capture_output, :halt_on_fail, :changed_only
-    settings :debug
+    settings :runner_seed, :pp_proc, :use_diff_proc, :run_diff_proc
+    settings :capture_output, :halt_on_fail, :changed_only, :pp_objects, :debug
 
     def initialize
       @view   = Assert::View::DefaultView.new($stdout)
@@ -45,10 +46,16 @@ module Assert
       @changed_files = Assert::AssertRunner::DEFAULT_CHANGED_FILES_PROC
 
       # default option values
-      @runner_seed    = begin; srand; srand % 0xFFFF; end.to_i
+      @runner_seed   = begin; srand; srand % 0xFFFF; end.to_i
+      @pp_proc       = Assert::U.stdlib_pp_proc
+      @use_diff_proc = Assert::U.default_use_diff_proc
+      @run_diff_proc = Assert::U.syscmd_diff_proc
+
+      # mode flags
       @capture_output = false
       @halt_on_fail   = true
       @changed_only   = false
+      @pp_objects     = false
       @debug          = false
     end
 

data/lib/assert/assertions.rb

@@ -1,4 +1,7 @@
+require 'assert/utils'
+
 module Assert
+
   module Assertions
 
     def assert_block(desc = nil)
@@ -12,53 +15,69 @@ module Assert
 
     def assert_empty(collection, desc = nil)
       assert(collection.empty?, desc) do
-        "Expected #{collection.inspect} to be empty."
+        "Expected #{Assert::U.show(collection)} to be empty."
       end
     end
 
     def assert_not_empty(collection, desc = nil)
       assert(!collection.empty?, desc) do
-        "Expected #{collection.inspect} to not be empty."
+        "Expected #{Assert::U.show(collection)} to not be empty."
       end
     end
     alias_method :refute_empty, :assert_not_empty
 
-    def assert_equal(expected, actual, desc = nil)
-      assert(actual == expected, desc) do
-        "Expected #{expected.inspect}, not #{actual.inspect}."
+    def assert_equal(exp, act, desc = nil)
+      assert(act == exp, desc) do
+        exp_show = Assert::U.show_for_diff(exp)
+        act_show = Assert::U.show_for_diff(act)
+
+        if Assert.config.use_diff_proc.call(exp_show, act_show)
+          "Expected does not equal actual, diff:\n"\
+          "#{Assert.config.run_diff_proc.call(exp_show, act_show)}"
+        else
+          "Expected #{Assert::U.show(exp)}, not #{Assert::U.show(act)}."
+        end
       end
     end
 
-    def assert_not_equal(expected, actual, desc = nil)
-      assert(actual != expected, desc) do
-        "#{actual.inspect} not expected to equal #{expected.inspect}."
+    def assert_not_equal(exp, act, desc = nil)
+      assert(act != exp, desc) do
+        exp_show = Assert::U.show_for_diff(exp)
+        act_show = Assert::U.show_for_diff(act)
+
+        if Assert.config.use_diff_proc.call(exp_show, act_show)
+          "Expected equals actual, diff:\n"\
+          "#{Assert.config.run_diff_proc.call(exp_show, act_show)}"
+        else
+          "#{Assert::U.show(act)} not expected to equal #{Assert::U.show(exp)}."
+        end
       end
     end
     alias_method :refute_equal, :assert_not_equal
 
     def assert_file_exists(file_path, desc = nil)
       assert(File.exists?(File.expand_path(file_path)), desc) do
-        "Expected #{file_path.inspect} to exist."
+        "Expected #{Assert::U.show(file_path)} to exist."
       end
     end
 
     def assert_not_file_exists(file_path, desc = nil)
       assert(!File.exists?(File.expand_path(file_path)), desc) do
-        "Expected #{file_path.inspect} to not exist."
+        "Expected #{Assert::U.show(file_path)} to not exist."
       end
     end
     alias_method :refute_file_exists, :assert_not_file_exists
 
     def assert_includes(object, collection, desc = nil)
       assert(collection.include?(object), desc) do
-        "Expected #{collection.inspect} to include #{object.inspect}."
+        "Expected #{Assert::U.show(collection)} to include #{Assert::U.show(object)}."
       end
     end
     alias_method :assert_included, :assert_includes
 
     def assert_not_includes(object, collection, desc = nil)
       assert(!collection.include?(object), desc) do
-        "Expected #{collection.inspect} to not include #{object.inspect}."
+        "Expected #{Assert::U.show(collection)} to not include #{Assert::U.show(object)}."
       end
     end
     alias_method :assert_not_included, :assert_not_includes
@@ -67,52 +86,52 @@ module Assert
 
     def assert_instance_of(klass, instance, desc = nil)
       assert(instance.instance_of?(klass), desc) do
-        "Expected #{instance.inspect} (#{instance.class}) to be an instance of #{klass}."
+        "Expected #{Assert::U.show(instance)} (#{instance.class}) to be an instance of #{klass}."
       end
     end
 
     def assert_not_instance_of(klass, instance, desc = nil)
       assert(!instance.instance_of?(klass), desc) do
-        "#{instance.inspect} (#{instance.class}) not expected to be an instance of #{klass}."
+        "#{Assert::U.show(instance)} (#{instance.class}) not expected to be an instance of #{klass}."
       end
     end
     alias_method :refute_instance_of, :assert_not_instance_of
 
     def assert_kind_of(klass, instance, desc=nil)
       assert(instance.kind_of?(klass), desc) do
-        "Expected #{instance.inspect} (#{instance.class}) to be a kind of #{klass}."
+        "Expected #{Assert::U.show(instance)} (#{instance.class}) to be a kind of #{klass}."
       end
     end
 
     def assert_not_kind_of(klass, instance, desc=nil)
       assert(!instance.kind_of?(klass), desc) do
-        "#{instance.inspect} not expected to be a kind of #{klass}."
+        "#{Assert::U.show(instance)} not expected to be a kind of #{klass}."
       end
     end
     alias_method :refute_kind_of, :assert_not_kind_of
 
-    def assert_match(expected, actual, desc=nil)
-      exp = String === expected && String === actual ? /#{Regexp.escape(expected)}/ : expected
-      assert(actual =~ exp, desc) do
-        "Expected #{actual.inspect} to match #{expected.inspect}."
+    def assert_match(exp, act, desc=nil)
+      exp_regex = String === exp && String === act ? /#{Regexp.escape(exp)}/ : exp
+      assert(act =~ exp_regex, desc) do
+        "Expected #{Assert::U.show(act)} to match #{Assert::U.show(exp)}."
       end
     end
 
-    def assert_not_match(expected, actual, desc=nil)
-      exp = String === expected && String === actual ? /#{Regexp.escape(expected)}/ : expected
-      assert(actual !~ exp, desc) do
-        "#{actual.inspect} not expected to match #{expected.inspect}."
+    def assert_not_match(exp, act, desc=nil)
+      exp = String === exp && String === act ? /#{Regexp.escape(exp)}/ : exp
+      assert(act !~ exp, desc) do
+        "#{Assert::U.show(act)} not expected to match #{Assert::U.show(exp)}."
       end
     end
     alias_method :refute_match, :assert_not_match
     alias_method :assert_no_match, :assert_not_match
 
     def assert_nil(object, desc=nil)
-      assert(object.nil?, desc){ "Expected nil, not #{object.inspect}." }
+      assert(object.nil?, desc){ "Expected nil, not #{Assert::U.show(object)}." }
     end
 
     def assert_not_nil(object, desc=nil)
-      assert(!object.nil?, desc){ "Expected #{object.inspect} to not be nil." }
+      assert(!object.nil?, desc){ "Expected #{Assert::U.show(object)} to not be nil." }
     end
     alias_method :refute_nil, :assert_not_nil
 
@@ -133,29 +152,31 @@ module Assert
 
     def assert_respond_to(method, object, desc=nil)
       assert(object.respond_to?(method), desc) do
-        "Expected #{object.inspect} (#{object.class}) to respond to `#{method}`."
+        "Expected #{Assert::U.show(object)} (#{object.class}) to respond to `#{method}`."
       end
     end
     alias_method :assert_responds_to, :assert_respond_to
 
     def assert_not_respond_to(method, object, desc=nil)
       assert(!object.respond_to?(method), desc) do
-        "#{object.inspect} (#{object.class}) not expected to respond to `#{method}`."
+        "#{Assert::U.show(object)} (#{object.class}) not expected to respond to `#{method}`."
       end
     end
     alias_method :assert_not_responds_to, :assert_not_respond_to
     alias_method :refute_respond_to, :assert_not_respond_to
     alias_method :refute_responds_to, :assert_not_respond_to
 
-    def assert_same(expected, actual, desc=nil)
-      assert(actual.equal?(expected), desc) do
-        "Expected #{actual} (#{actual.object_id}) to be the same as #{expected} (#{expected.object_id})."
+    def assert_same(exp, act, desc=nil)
+      assert(act.equal?(exp), desc) do
+        "Expected #{Assert::U.show(act)} (#{act.object_id})"\
+        " to be the same as #{Assert::U.show(exp)} (#{exp.object_id})."
       end
     end
 
-    def assert_not_same(expected, actual, desc=nil)
-      assert(!actual.equal?(expected), desc) do
-        "#{actual} (#{actual.object_id}) not expected to be the same as #{expected} (#{expected.object_id})."
+    def assert_not_same(exp, act, desc=nil)
+      assert(!act.equal?(exp), desc) do
+        "#{Assert::U.show(act)} (#{act.object_id})"\
+        " not expected to be the same as #{Assert::U.show(exp)} (#{exp.object_id})."
       end
     end
     alias_method :refute_same, :assert_not_same
@@ -213,8 +234,8 @@ module Assert
         if @exception
           backtrace = Assert::Result::Backtrace.new(@exception.backtrace)
           [ raised_msg,
-            "Class: <#{@exception.class}>",
-            "Message: <#{@exception.message.inspect}>",
+            "Class: `#{@exception.class}`",
+            "Message: `#{@exception.message.inspect}`",
             "---Backtrace---",
             backtrace.filtered.to_s,
             "---------------"
@@ -238,4 +259,5 @@ module Assert
     end
 
   end
+
 end

data/lib/assert/cli.rb

@@ -25,6 +25,7 @@ module Assert
     end
 
     def initialize(*args)
+      @args = args
       @cli = CLIRB.new do
         option 'runner_seed', 'Use a given seed to run tests', {
           :abbrev => 's', :value => Fixnum
@@ -38,14 +39,17 @@ module Assert
         option 'changed_only', 'only run test files with changes', {
           :abbrev => 'c'
         }
+        option 'pp_objects', 'pretty-print objects in fail messages', {
+          :abbrev => 'p'
+        }
         # show loaded test files, cli err backtraces, etc
         option 'debug', 'run in debug mode'
       end
-      @cli.parse!(args)
     end
 
     def run
       begin
+        @cli.parse!(@args)
         Assert::AssertRunner.new(@cli.args, @cli.opts).run
       rescue CLIRB::HelpExit
         puts help

data/lib/assert/context.rb

@@ -1,3 +1,4 @@
+require 'assert/utils'
 require 'assert/suite'
 require 'assert/assertions'
 require 'assert/result'
@@ -174,19 +175,19 @@ module Assert
     # check if the assertion is a truthy value, if so create a new pass result, otherwise
     # create a new fail result with the desc and what failed msg.
     # all other assertion helpers use this one in the end
-    def assert(assertion, fail_desc = nil)
+    def assert(assertion, desc = nil)
       if assertion
         pass
       else
-        what_failed_msg = block_given? ? yield : "Failed assert: assertion was <#{assertion.inspect}>."
-        fail(fail_message(fail_desc, what_failed_msg))
+        what = block_given? ? yield : "Failed assert: assertion was `#{Assert::U.show(assertion)}`."
+        fail(fail_message(desc, what))
       end
     end
 
     # the opposite of assert, check if the assertion is a false value, if so create a new pass
     # result, otherwise create a new fail result with the desc and it's what failed msg
     def assert_not(assertion, fail_desc = nil)
-      assert(!assertion, fail_desc){ "Failed assert_not: assertion was <#{assertion.inspect}>." }
+      assert(!assertion, fail_desc){ "Failed assert_not: assertion was `#{Assert::U.show(assertion)}`." }
     end
     alias_method :refute, :assert_not
 

data/lib/assert/result.rb

@@ -63,7 +63,7 @@ module Assert::Result
     end
 
     def inspect
-      "#<#{self.class} @message=#{self.message.inspect}>"
+      "#<#{self.class}:#{'0x0%x' % (object_id << 1)} @message=#{self.message.inspect}>"
     end
 
   end

data/lib/assert/test.rb

@@ -78,7 +78,7 @@ module Assert
       attributes_string = ([ :name, :context_info, :results ].collect do |attr|
         "@#{attr}=#{self.send(attr).inspect}"
       end).join(" ")
-      "#<#{self.class} #{attributes_string}>"
+      "#<#{self.class}:#{'0x0%x' % (object_id << 1)} #{attributes_string}>"
     end
 
     protected

data/lib/assert/utils.rb

@@ -0,0 +1,70 @@
+require 'assert'
+
+module Assert
+
+  module Utils
+
+    # show objects in a human-readable manner.  Either inspects or pretty-prints
+    # them depending on settings.
+
+    def self.show(obj)
+      out = Assert.config.pp_objects ? Assert.config.pp_proc.call(obj) : obj.inspect
+      out = out.encode(Encoding.default_external) if defined?(Encoding)
+      out
+    end
+
+    # show objects in a human-readable manner and make the output diff-able. This
+    # expands on the basic `show` util by escaping newlines and making object id
+    # hex-values generic.
+
+    def self.show_for_diff(obj)
+      show(obj).gsub(/\\n/, "\n").gsub(/:0x[a-fA-F0-9]{4,}/m, ':0xXXXXXX')
+    end
+
+    # open a tempfile and yield it
+
+    def self.tempfile(name, content)
+      require "tempfile"
+      Tempfile.open(name) do |tmpfile|
+        tmpfile.puts(content); tmpfile.flush
+        yield tmpfile if block_given?
+      end
+    end
+
+    # Get a proc that uses stdlib `PP.pp` to pretty print objects
+
+    def self.stdlib_pp_proc(width = nil)
+      require 'pp'
+      Proc.new{ |obj| "\n#{PP.pp(obj, '', width || 79).strip}\n" }
+    end
+
+    # Return true if if either show output has newlines or is bigger than 29 chars
+
+    def self.default_use_diff_proc
+      Proc.new do |exp_show_output, act_show_output|
+        exp_show_output.include?("\n") || exp_show_output.size > 29 ||
+        act_show_output.include?("\n") || act_show_output.size > 29
+      end
+    end
+
+    def self.syscmd_diff_proc(syscmd = "diff --unified=-1")
+      Proc.new do |exp_show_output, act_show_output|
+        result = ""
+        tempfile('exp_show_output', exp_show_output) do |a|
+          tempfile('act_show_output', act_show_output) do |b|
+            result = `#{syscmd} #{a.path} #{b.path}`
+            result.sub!(/^\-\-\- .+/, "--- expected")
+            result.sub!(/^\+\+\+ .+/, "+++ actual")
+            result = "--- expected\n+++ actual" if result.empty?
+          end
+        end
+        result
+      end
+    end
+
+  end
+
+  # alias for brevity
+  U = Utils
+
+end

data/lib/assert/version.rb

@@ -1,3 +1,3 @@
 module Assert
-  VERSION = "2.3.3"
+  VERSION = "2.4.0"
 end

data/test/helper.rb

@@ -2,7 +2,8 @@
 # put any test helpers here
 
 # add the root dir to the load path
-$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
+ROOT_PATH = File.expand_path("../..", __FILE__)
+$LOAD_PATH.unshift(ROOT_PATH)
 
 # require pry for debugging (`binding.pry`)
 require 'pry'

data/test/support/diff_a.txt

@@ -0,0 +1,3 @@
+This is a file
+  that is being
+diff'd.

data/test/support/diff_b.txt

@@ -0,0 +1,3 @@
+This is a file
+  that will be
+diff'd.

data/test/unit/assert_tests.rb

@@ -1,7 +1,9 @@
 require 'assert'
+
 require 'assert/view/default_view'
 require 'assert/runner'
 require 'assert/suite'
+require 'assert/utils'
 
 module Assert
 
@@ -31,7 +33,8 @@ module Assert
     subject { Config }
 
     should have_imeths :suite, :view, :runner, :test_dir, :test_helper, :changed_files
-    should have_imeths :runner_seed, :capture_output, :halt_on_fail, :changed_only
+    should have_imeths :runner_seed, :pp_proc, :use_diff_proc, :run_diff_proc
+    should have_imeths :capture_output, :halt_on_fail, :changed_only, :pp_objects
     should have_imeths :debug, :apply
 
     should "default the view, suite, and runner" do
@@ -40,6 +43,13 @@ module Assert
       assert_kind_of Assert::Runner, subject.runner
     end
 
+    should "default the optional values" do
+      assert_not_nil subject.runner_seed
+      assert_not_nil subject.pp_proc
+      assert_not_nil subject.use_diff_proc
+      assert_not_nil subject.run_diff_proc
+    end
+
   end
 
 end

data/test/unit/assertions/assert_empty_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertEmptyTests < Assert::Context
@@ -23,7 +25,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[1]}\nExpected #{@args[0].inspect} to be empty."
+      exp = "#{@args[1]}\nExpected #{Assert::U.show(@args[0])} to be empty."
       assert_equal exp, subject.fail_results.first.message
     end
 
@@ -49,7 +51,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[1]}\nExpected #{@args[0].inspect} to not be empty."
+      exp = "#{@args[1]}\nExpected #{Assert::U.show(@args[0])} to not be empty."
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/assertions/assert_equal_tests.rb

@@ -1,10 +1,12 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertEqualTests < Assert::Context
-    desc "the assert_equal helper"
+    desc "`assert_equal`"
     setup do
       desc = @desc = "assert equal fail desc"
       args = @args = [ '1', '2', desc ]
@@ -23,14 +25,14 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[2]}\nExpected #{@args[0].inspect}, not #{@args[1].inspect}."
+      exp = "#{@args[2]}\nExpected #{Assert::U.show(@args[0])}, not #{Assert::U.show(@args[1])}."
       assert_equal exp, subject.fail_results.first.message
     end
 
   end
 
   class AssertNotEqualTests < Assert::Context
-    desc "the assert_not_equal helper"
+    desc "`assert_not_equal`"
     setup do
       desc = @desc = "assert not equal fail desc"
       args = @args = [ '1', '1', desc ]
@@ -50,7 +52,67 @@ module Assert::Assertions
 
     should "have a fail message with custom and generic explanations" do
       exp = "#{@args[2]}\n"\
-            "#{@args[1].inspect} not expected to equal #{@args[0].inspect}."
+            "#{Assert::U.show(@args[1])} not expected to equal #{Assert::U.show(@args[0])}."
+      assert_equal exp, subject.fail_results.first.message
+    end
+
+  end
+
+  class DiffTests < Assert::Context
+    desc "with objects that should use diff when showing"
+    setup do
+      @exp_obj = "I'm a\nstring"
+      @act_obj = "I am a \nstring"
+
+      @exp_obj_show = Assert::U.show_for_diff(@exp_obj)
+      @act_obj_show = Assert::U.show_for_diff(@act_obj)
+
+      @orig_use_diff_proc = Assert.config.use_diff_proc
+      @orig_run_diff_proc = Assert.config.run_diff_proc
+
+      Assert.config.use_diff_proc(Assert::U.default_use_diff_proc)
+      Assert.config.run_diff_proc(Assert::U.syscmd_diff_proc)
+    end
+    teardown do
+      Assert.config.use_diff_proc(@orig_use_diff_proc)
+      Assert.config.run_diff_proc(@orig_run_diff_proc)
+    end
+
+  end
+
+  class AssertEqualDiffTests < DiffTests
+    desc "`assert_equal`"
+    setup do
+      exp_obj, act_obj = @exp_obj, @act_obj
+      @test = Factory.test do
+        assert_equal(exp_obj, act_obj)
+      end
+      @test.run
+    end
+    subject{ @test }
+
+    should "include diff output in the fail messages" do
+      exp = "Expected does not equal actual, diff:\n"\
+            "#{Assert::U.syscmd_diff_proc.call(@exp_obj_show, @act_obj_show)}"
+      assert_equal exp, subject.fail_results.first.message
+    end
+
+  end
+
+  class AssertNotEqualDiffTests < DiffTests
+    desc "`assert_not_equal`"
+    setup do
+      exp_obj, act_obj = @exp_obj, @act_obj
+      @test = Factory.test do
+        assert_not_equal(exp_obj, exp_obj)
+      end
+      @test.run
+    end
+    subject{ @test }
+
+    should "include diff output in the fail messages" do
+      exp = "Expected equals actual, diff:\n"\
+            "#{Assert::U.syscmd_diff_proc.call(@exp_obj_show, @exp_obj_show)}"
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/assertions/assert_file_exists_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertFileExistsTests < Assert::Context
@@ -23,7 +25,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[1]}\nExpected #{@args[0].inspect} to exist."
+      exp = "#{@args[1]}\nExpected #{Assert::U.show(@args[0])} to exist."
       assert_equal exp, subject.fail_results.first.message
     end
 
@@ -49,7 +51,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[1]}\nExpected #{@args[0].inspect} to not exist."
+      exp = "#{@args[1]}\nExpected #{Assert::U.show(@args[0])} to not exist."
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/assertions/assert_includes_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertIncludesTests < Assert::Context
@@ -24,7 +26,7 @@ module Assert::Assertions
 
     should "have a fail message with custom and generic explanations" do
       exp = "#{@args[2]}\n"\
-            "Expected #{@args[1].inspect} to include #{@args[0].inspect}."
+            "Expected #{Assert::U.show(@args[1])} to include #{Assert::U.show(@args[0])}."
       assert_equal exp, subject.fail_results.first.message
     end
 
@@ -51,7 +53,7 @@ module Assert::Assertions
 
     should "have a fail message with custom and generic explanations" do
       exp = "#{@args[2]}\n"\
-            "Expected #{@args[1].inspect} to not include #{@args[0].inspect}."
+            "Expected #{Assert::U.show(@args[1])} to not include #{Assert::U.show(@args[0])}."
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/assertions/assert_instance_of_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertInstanceOfTests < Assert::Context
@@ -23,7 +25,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[2]}\nExpected #{@args[1].inspect} (#{@args[1].class}) to"\
+      exp = "#{@args[2]}\nExpected #{Assert::U.show(@args[1])} (#{@args[1].class}) to"\
             " be an instance of #{@args[0]}."
       assert_equal exp, subject.fail_results.first.message
     end
@@ -50,7 +52,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[2]}\n#{@args[1].inspect} (#{@args[1].class}) not expected to"\
+      exp = "#{@args[2]}\n#{Assert::U.show(@args[1])} (#{@args[1].class}) not expected to"\
             " be an instance of #{@args[0]}."
       assert_equal exp, subject.fail_results.first.message
     end

data/test/unit/assertions/assert_kind_of_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertKindOfTests < Assert::Context
@@ -23,7 +25,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[2]}\nExpected #{@args[1].inspect} (#{@args[1].class}) to"\
+      exp = "#{@args[2]}\nExpected #{Assert::U.show(@args[1])} (#{@args[1].class}) to"\
             " be a kind of #{@args[0]}."
       assert_equal exp, subject.fail_results.first.message
     end
@@ -50,7 +52,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[2]}\n#{@args[1].inspect} not expected to be a kind of #{@args[0]}."
+      exp = "#{@args[2]}\n#{Assert::U.show(@args[1])} not expected to be a kind of #{@args[0]}."
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/assertions/assert_match_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertMatchTests < Assert::Context
@@ -23,7 +25,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[2]}\nExpected #{@args[1].inspect} to match #{@args[0].inspect}."
+      exp = "#{@args[2]}\nExpected #{Assert::U.show(@args[1])} to match #{Assert::U.show(@args[0])}."
       assert_equal exp, subject.fail_results.first.message
     end
 
@@ -49,7 +51,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[2]}\n#{@args[1].inspect} not expected to match #{@args[0].inspect}."
+      exp = "#{@args[2]}\n#{Assert::U.show(@args[1])} not expected to match #{Assert::U.show(@args[0])}."
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/assertions/assert_nil_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertNilTests < Assert::Context
@@ -23,7 +25,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[1]}\nExpected nil, not #{@args[0].inspect}."
+      exp = "#{@args[1]}\nExpected nil, not #{Assert::U.show(@args[0])}."
       assert_equal exp, subject.fail_results.first.message
     end
 
@@ -49,7 +51,7 @@ module Assert::Assertions
     end
 
     should "have a fail message with custom and generic explanations" do
-      exp = "#{@args[1]}\nExpected #{@args[0].inspect} to not be nil."
+      exp = "#{@args[1]}\nExpected #{Assert::U.show(@args[0])} to not be nil."
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/assertions/assert_respond_to_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertRespondToTest < Assert::Context
@@ -24,7 +26,7 @@ module Assert::Assertions
 
     should "have a fail message with custom and generic explanations" do
       exp = "#{@args[2]}\n"\
-            "Expected #{@args[1].inspect} (#{@args[1].class})"\
+            "Expected #{Assert::U.show(@args[1])} (#{@args[1].class})"\
             " to respond to `#{@args[0]}`."
       assert_equal exp, subject.fail_results.first.message
     end
@@ -52,7 +54,7 @@ module Assert::Assertions
 
     should "have a fail message with custom and generic explanations" do
       exp = "#{@args[2]}\n"\
-            "#{@args[1].inspect} (#{@args[1].class})"\
+            "#{Assert::U.show(@args[1])} (#{@args[1].class})"\
             " not expected to respond to `#{@args[0]}`."
       assert_equal exp, subject.fail_results.first.message
     end

data/test/unit/assertions/assert_same_tests.rb

@@ -1,6 +1,8 @@
 require 'assert'
 require 'assert/assertions'
 
+require 'assert/utils'
+
 module Assert::Assertions
 
   class AssertSameTest < Assert::Context
@@ -25,8 +27,8 @@ module Assert::Assertions
 
     should "have a fail message with custom and generic explanations" do
       exp = "#{@args[2]}\n"\
-            "Expected #{@args[1].inspect} (#{@args[1].object_id})"\
-            " to be the same as #{@args[0].inspect} (#{@args[0].object_id})."
+            "Expected #{Assert::U.show(@args[1])} (#{@args[1].object_id})"\
+            " to be the same as #{Assert::U.show(@args[0])} (#{@args[0].object_id})."
       assert_equal exp, subject.fail_results.first.message
     end
 
@@ -54,8 +56,8 @@ module Assert::Assertions
 
     should "have a fail message with custom and generic explanations" do
       exp = "#{@args[2]}\n"\
-            "#{@args[1].inspect} (#{@args[1].object_id}) not expected"\
-            " to be the same as #{@args[0].inspect} (#{@args[0].object_id})."
+            "#{Assert::U.show(@args[1])} (#{@args[1].object_id}) not expected"\
+            " to be the same as #{Assert::U.show(@args[0])} (#{@args[0].object_id})."
       assert_equal exp, subject.fail_results.first.message
     end
 

data/test/unit/context_tests.rb

@@ -1,9 +1,11 @@
 require 'assert'
 require 'assert/context'
 
+require 'assert/utils'
+
 class Assert::Context
 
-  class BasicTests < Assert::Context
+  class UnitTests < Assert::Context
     desc "Assert context"
     setup do
       @test = Factory.test
@@ -27,7 +29,7 @@ class Assert::Context
 
   end
 
-  class SkipTests < BasicTests
+  class SkipTests < UnitTests
     desc "skip method"
     setup do
       @skip_msg = "I need to implement this in the future."
@@ -44,7 +46,7 @@ class Assert::Context
 
   end
 
-  class IgnoreTests < BasicTests
+  class IgnoreTests < UnitTests
     desc "ignore method"
     setup do
       @ignore_msg = "Ignore this for now, will do later."
@@ -59,7 +61,7 @@ class Assert::Context
 
   end
 
-  class PassTests < BasicTests
+  class PassTests < UnitTests
     desc "pass method"
     setup do
       @pass_msg = "That's right, it works."
@@ -74,7 +76,7 @@ class Assert::Context
 
   end
 
-  class FlunkTests < BasicTests
+  class FlunkTests < UnitTests
     desc "flunk method"
     setup do
       @flunk_msg = "It flunked."
@@ -89,7 +91,7 @@ class Assert::Context
 
   end
 
-  class FailTests < BasicTests
+  class FailTests < UnitTests
     desc "fail method"
     setup do
       @result = @context.fail
@@ -137,7 +139,7 @@ class Assert::Context
 
   end
 
-  class AssertTests < BasicTests
+  class AssertTests < UnitTests
     desc "assert method"
     setup do
       @fail_desc = "my fail desc"
@@ -153,6 +155,17 @@ class Assert::Context
     should "return a fail result given a `false` assertion" do
       result = subject.assert(false, @fail_desc){ @what_failed }
       assert_kind_of Assert::Result::Fail, result
+    end
+
+    should "pp the assertion value in the fail message by default" do
+      exp_default_what = "Failed assert: assertion was `#{Assert::U.show(false)}`."
+      result = subject.assert(false, @fail_desc)
+
+      assert_equal [@fail_desc, exp_default_what].join("\n"), result.message
+    end
+
+    should "use a custom fail message if one is given" do
+      result = subject.assert(false, @fail_desc){ @what_failed }
       assert_equal [@fail_desc, @what_failed].join("\n"), result.message
     end
 
@@ -166,23 +179,28 @@ class Assert::Context
 
   end
 
-  class AssertNotTests < BasicTests
+  class AssertNotTests < UnitTests
     desc "assert_not method"
     setup do
       @fail_desc = "my fail desc"
-      @what_failed = "Failed assert_not: assertion was <true>."
+    end
+
+    should "return a pass result given a `false` assertion" do
+      result = subject.assert_not(false, @fail_desc)
+      assert_kind_of Assert::Result::Pass, result
+      assert_nil result.message
     end
 
     should "return a fail result given a `true` assertion" do
       result = subject.assert_not(true, @fail_desc)
       assert_kind_of Assert::Result::Fail, result
-      assert_equal [@fail_desc, @what_failed].join("\n"), result.message
     end
 
-    should "return a pass result given a `false` assertion" do
-      result = subject.assert_not(false, @fail_desc)
-      assert_kind_of Assert::Result::Pass, result
-      assert_nil result.message
+    should "pp the assertion value in the fail message by default" do
+      exp_default_what = "Failed assert_not: assertion was `#{Assert::U.show(true)}`."
+      result = subject.assert_not(true, @fail_desc)
+
+      assert_equal [@fail_desc, exp_default_what].join("\n"), result.message
     end
 
     should "return a fail result given a \"truthy\" assertion" do
@@ -195,7 +213,7 @@ class Assert::Context
 
   end
 
-  class SubjectTests < BasicTests
+  class SubjectTests < UnitTests
     desc "subject method"
     setup do
       expected = @expected = "amazing"
@@ -213,7 +231,7 @@ class Assert::Context
 
   end
 
-  class WithBacktraceTests < BasicTests
+  class WithBacktraceTests < UnitTests
     desc "with_backtrace method"
     setup do
       @from_bt = ['called_from_here']
@@ -240,7 +258,7 @@ class Assert::Context
 
   end
 
-  class InspectTests < BasicTests
+  class InspectTests < UnitTests
     desc "inspect method"
     setup do
       @expected = "#<#{@context.class}>"

data/test/unit/result_tests.rb

@@ -61,7 +61,8 @@ module Assert::Result
     end
 
     should "show only its class and message when inspected" do
-      exp = "#<#{subject.class} @message=#{subject.message.inspect}>"
+      exp = "#<#{subject.class}:#{'0x0%x' % (subject.object_id << 1)}"\
+            " @message=#{subject.message.inspect}>"
       assert_equal exp, subject.inspect
     end
 

data/test/unit/test_tests.rb

@@ -39,7 +39,7 @@ class Assert::Test
       attrs_string = [:name, :context_info, :results].collect do |method|
         "@#{method}=#{subject.send(method).inspect}"
       end.join(" ")
-      expected = "#<#{subject.class} #{attrs_string}>"
+      expected = "#<#{subject.class}:#{'0x0%x' % (subject.object_id << 1)} #{attrs_string}>"
       assert_equal expected, subject.inspect
     end
 

data/test/unit/utils_tests.rb

@@ -0,0 +1,154 @@
+require 'assert'
+require 'assert/utils'
+
+require 'tempfile'
+
+module Assert::Utils
+
+  class UnitTests < Assert::Context
+    desc "Assert::Utils"
+    subject{ Assert::Utils }
+    setup do
+      @objs = [ 1, 'hi there', Hash.new, [:a, :b]]
+    end
+
+    should have_imeths :show, :show_for_diff
+    should have_imeths :tempfile
+    should have_imeths :stdlib_pp_proc, :default_use_diff_proc, :syscmd_diff_proc
+
+  end
+
+  class ShowTests < UnitTests
+    desc "`show`"
+    setup do
+      @orig_pp_objs = Assert.config.pp_objects
+      @orig_pp_proc = Assert.config.pp_proc
+      @new_pp_proc  = Proc.new{ |input| 'herp derp' }
+    end
+    teardown do
+      Assert.config.pp_proc(@orig_pp_proc)
+      Assert.config.pp_objects(@orig_pp_objs)
+    end
+
+    should "use `inspect` to show objs when `pp_objects` setting is false" do
+      Assert.config.pp_objects(false)
+
+      @objs.each do |obj|
+        assert_equal obj.inspect, subject.show(obj)
+      end
+    end
+
+    should "use `pp_proc` to show objs when `pp_objects` setting is true" do
+      Assert.config.pp_objects(true)
+      Assert.config.pp_proc(@new_pp_proc)
+
+      @objs.each do |obj|
+        assert_equal @new_pp_proc.call(obj), subject.show(obj)
+      end
+    end
+
+  end
+
+  class ShowForDiffTests < UnitTests
+    desc "`show_for_diff`"
+    setup do
+      @w_newlines = { :string => "herp derp, derp herp\nherpderpedia" }
+      @w_obj_id = Struct.new(:a, :b).new('aye', 'bee')
+    end
+
+    should "call show, escaping newlines" do
+      exp_out = "{:string=>\"herp derp, derp herp\nherpderpedia\"}"
+      assert_equal exp_out, subject.show_for_diff(@w_newlines)
+    end
+
+    should "make any obj ids generic" do
+      exp_out = "#<struct #<Class:0xXXXXXX> a=\"aye\", b=\"bee\">"
+      assert_equal exp_out, subject.show_for_diff(@w_obj_id)
+    end
+
+  end
+
+  class TempfileTests < UnitTests
+    desc "`tempfile`"
+
+    should "require tempfile, open a tempfile, write the given content, and yield it" do
+      subject.tempfile('a-name', 'some-content') do |tmpfile|
+        assert_equal false, (require 'tempfile')
+        assert tmpfile
+        assert_kind_of Tempfile, tmpfile
+
+        tmpfile.pos = 0
+        assert_equal "some-content\n", tmpfile.read
+      end
+    end
+
+  end
+
+  class StdlibPpProcTests < UnitTests
+    desc "`stdlib_pp_proc`"
+
+    should "build a pp proc that uses stdlib `PP.pp` to pretty print objects" do
+      exp_obj_pps = @objs.map{ |o| "\n#{PP.pp(o, '', 79).strip}\n" }
+      act_obj_pps = @objs.map{ |o| subject.stdlib_pp_proc.call(o) }
+      assert_equal exp_obj_pps, act_obj_pps
+
+      cust_width = 1
+      exp_obj_pps = @objs.map{ |o| "\n#{PP.pp(o, '', cust_width).strip}\n" }
+      act_obj_pps = @objs.map{ |o| subject.stdlib_pp_proc(cust_width).call(o) }
+      assert_equal exp_obj_pps, act_obj_pps
+    end
+
+  end
+
+  class DefaultUseDiffProcTests < UnitTests
+    desc "`default_use_diff_proc`"
+    setup do
+      @longer = "i am a really long string output; use diff when working with me"
+      @newlines = "i have\n newlines"
+    end
+
+    should "be true if either output has newlines or is bigger than 29 chars" do
+      proc = subject.default_use_diff_proc
+
+      assert_not proc.call('', '')
+      assert proc.call(@longer, '')
+      assert proc.call(@newlines, '')
+      assert proc.call('', @longer)
+      assert proc.call('', @newlines)
+      assert proc.call(@longer, @newlines)
+    end
+
+  end
+
+  class SyscmdDiffProc < UnitTests
+    desc "`syscmd_diff_proc`"
+    setup do
+      @diff_a_file = File.join(ROOT_PATH, 'test/support/diff_a.txt')
+      @diff_b_file = File.join(ROOT_PATH, 'test/support/diff_b.txt')
+
+      @diff_a = File.read(@diff_a_file)
+      @diff_b = File.read(@diff_b_file)
+    end
+
+    should "use the diff syscmd to output the diff between the exp/act show output" do
+      exp_diff_out = `diff --unified=-1 #{@diff_a_file} #{@diff_b_file}`.tap do |out|
+        out.sub!(/^\-\-\- .+/, "--- expected")
+        out.sub!(/^\+\+\+ .+/, "+++ actual")
+      end
+
+      assert_equal exp_diff_out, subject.syscmd_diff_proc.call(@diff_a, @diff_b)
+    end
+
+    should "allow you to specify a custom syscmd" do
+      cust_syscmd = 'diff'
+      exp_diff_out = `#{cust_syscmd} #{@diff_a_file} #{@diff_b_file}`.tap do |out|
+        out.sub!(/^\-\-\- .+/, "--- expected")
+        out.sub!(/^\+\+\+ .+/, "+++ actual")
+      end
+
+      assert_equal exp_diff_out, subject.syscmd_diff_proc(cust_syscmd).call(@diff_a, @diff_b)
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: assert
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 31
   prerelease: 
   segments: 
   - 2
-  - 3
-  - 3
-  version: 2.3.3
+  - 4
+  - 0
+  version: 2.4.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-11-11 00:00:00 Z
+date: 2013-11-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: ansi
@@ -63,6 +63,7 @@ files:
 - lib/assert/runner.rb
 - lib/assert/suite.rb
 - lib/assert/test.rb
+- lib/assert/utils.rb
 - lib/assert/version.rb
 - lib/assert/view.rb
 - lib/assert/view/base.rb
@@ -71,6 +72,8 @@ files:
 - lib/assert/view/helpers/common.rb
 - log/.gitkeep
 - test/helper.rb
+- test/support/diff_a.txt
+- test/support/diff_b.txt
 - test/support/inherited_stuff.rb
 - test/system/running_tests.rb
 - test/unit/assert_tests.rb
@@ -96,6 +99,7 @@ files:
 - test/unit/runner_tests.rb
 - test/unit/suite_tests.rb
 - test/unit/test_tests.rb
+- test/unit/utils_tests.rb
 - test/unit/view_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/assert
@@ -133,6 +137,8 @@ specification_version: 3
 summary: Test::Unit style testing framework, just better than Test::Unit.
 test_files: 
 - test/helper.rb
+- test/support/diff_a.txt
+- test/support/diff_b.txt
 - test/support/inherited_stuff.rb
 - test/system/running_tests.rb
 - test/unit/assert_tests.rb
@@ -158,4 +164,5 @@ test_files:
 - test/unit/runner_tests.rb
 - test/unit/suite_tests.rb
 - test/unit/test_tests.rb
+- test/unit/utils_tests.rb
 - test/unit/view_tests.rb