test-unit 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6d7db2480ed758082e59182df3607410a66eb81c5c3433b3dd76bd1cf31e5f3
-  data.tar.gz: e25d8749320d74cef4eb57f44acee0d7797bab72568e1e3cdf9b23249b1ebf97
+  metadata.gz: 93aaef767a30d0882b6048299d858f799ea416bfdccc9daef7d2686b5a913f98
+  data.tar.gz: 00a5b7f5ccfe50603d4d1b926424b3d8336c21b3126e0dc324b17f156a48ef6a
 SHA512:
-  metadata.gz: 4b18901db0bab8ecfbba34de97e02163598b729e6be44a176ebfb1b06586e7f9079fe674f18275e2c06dfedea024a88bb06596040b250bfa6f5d2ae40e99c181
-  data.tar.gz: 1a6ebdaeebe74f649aa06f94e205d216300aeb018f762b2082382cbef405e5482a03a8095b2b3b86210ad6379bce8ba481b7fd25dec60a15b8206340c18b45a8
+  metadata.gz: a8edd6f065bf74bd4ead4dc49c6a96a635c92cfec4f7089202e658361a715d003b2c0422b58f8e97a84f7fa4ec90b137343e4737ef81741c32cb53c1191c182b
+  data.tar.gz: be3541d1116d75979c82060d17278e40397adc8df4dea96b982fc5b61583749b975d1cdfcfbc634dc1f4045c8d7994575897e38ccc78c785049ea6673d973f67

data/doc/text/news.md

@@ -1,5 +1,18 @@
 # News
 
+## 3.3.1 - 2019-03-27 {#version-3-3-1}
+
+### Improvements
+
+  * Added support for `Test::Unit::AssertionFailedError#user_message`
+    for not only `assert_equal` and `assert_raise` but also all
+    assertions.
+    [GitHub#162][Reported by xgraffm]
+
+### Thanks
+
+  * xgraffm
+
 ## 3.3.0 - 2019-01-23 {#version-3-3-0}
 
 ### Improvements

data/lib/test/unit/assertions.rb

@@ -32,9 +32,9 @@ module Test
     #
     # @example Example Custom Assertion
     #
-    #   def deny(boolean, message = nil)
-    #     message = build_message message, '<?> is not false or nil.', boolean
-    #     assert_block message do
+    #   def deny(boolean, message=nil)
+    #     message = build_message(message, '<?> is not false or nil.', boolean)
+    #     assert_block(message) do
     #       not boolean
     #     end
     #   end
@@ -52,7 +52,11 @@ module Test
       def assert_block(message="assert_block failed.")
         _wrap_assertion do
           if (! yield)
-            raise AssertionFailedError.new(message.to_s)
+            options = {}
+            if message.respond_to?(:user_message)
+              options[:user_message] = message.user_message
+            end
+            raise AssertionFailedError.new(message.to_s, options)
           end
         end
       end
@@ -239,7 +243,7 @@ EOT
         begin
           assert_block(full_message) { expected == actual }
         rescue AssertionFailedError => failure
-          _set_failed_information(failure, expected, actual, message)
+          _set_failed_information(failure, expected, actual)
           raise failure # For JRuby. :<
         end
       end
@@ -275,8 +279,7 @@ EOT
                 assert_exception_helper.expected?(actual_exception)
             end
           rescue AssertionFailedError => failure
-            _set_failed_information(failure, expected, actual_exception,
-                                    message)
+            _set_failed_information(failure, expected, actual_exception)
             raise failure # For JRuby. :<
           end
         end
@@ -319,7 +322,7 @@ EOT
       #   assert_instance_of(String, 'foo')            # -> pass
       #   assert_instance_of([Fixnum, NilClass], 100)  # -> pass
       #   assert_instance_of([Numeric, NilClass], 100) # -> fail
-      def assert_instance_of(klass, object, message="")
+      def assert_instance_of(klass, object, message=nil)
         _wrap_assertion do
           if klass.is_a?(Array)
             klasses = klass
@@ -355,7 +358,7 @@ EOT
       #   assert_not_instance_of([Numeric, NilClass], 100)   # -> fail
       #
       # @since 3.0.0
-      def assert_not_instance_of(klass, object, message="")
+      def assert_not_instance_of(klass, object, message=nil)
         _wrap_assertion do
           if klass.is_a?(Array)
             klasses = klass
@@ -390,7 +393,7 @@ EOT
       #
       # @example
       #   assert_nil [1, 2].uniq!
-      def assert_nil(object, message="")
+      def assert_nil(object, message=nil)
         full_message = build_message(message, <<EOT, object)
 <?> was expected to be nil.
 EOT
@@ -406,7 +409,7 @@ EOT
       #   assert_kind_of(Object, 'foo')                # -> pass
       #   assert_kind_of([Fixnum, NilClass], 100)      # -> pass
       #   assert_kind_of([Fixnum, NilClass], "string") # -> fail
-      def assert_kind_of(klass, object, message="")
+      def assert_kind_of(klass, object, message=nil)
         _wrap_assertion do
           if klass.is_a?(Array)
             klasses = klass
@@ -444,7 +447,7 @@ EOT
       #   assert_not_kind_of([Fixnum, NilClass], 100) # -> fail
       #
       # @since 3.0.0
-      def assert_not_kind_of(klass, object, message="")
+      def assert_not_kind_of(klass, object, message=nil)
         _wrap_assertion do
           if klass.is_a?(Array)
             klasses = klass
@@ -479,7 +482,7 @@ EOT
       #
       # @example
       #   assert_respond_to 'bugbear', :slice
-      def assert_respond_to(object, method, message="")
+      def assert_respond_to(object, method, message=nil)
         _wrap_assertion do
           full_message = build_message(message,
                                        "<?>.kind_of\\?(Symbol) or\n" +
@@ -502,7 +505,7 @@ EOT
       # @example
       #   assert_not_respond_to('bugbear', :nonexistence) # -> pass
       #   assert_not_respond_to('bugbear', :size)         # -> fail
-      def assert_not_respond_to(object, method, message="")
+      def assert_not_respond_to(object, method, message=nil)
         _wrap_assertion do
           full_message = build_message(message,
                                        "<?>.kind_of\\?(Symbol) or\n" +
@@ -529,7 +532,7 @@ EOT
       #
       # @example
       #   assert_match(/\d+/, 'five, 6, seven')
-      def assert_match(pattern, string, message="")
+      def assert_match(pattern, string, message=nil)
         _wrap_assertion do
           pattern = case(pattern)
             when String
@@ -551,7 +554,7 @@ EOT
       # @example
       #   o = Object.new
       #   assert_same o, o
-      def assert_same(expected, actual, message="")
+      def assert_same(expected, actual, message=nil)
         full_message = build_message(message, <<EOT, expected, expected.__id__, actual, actual.__id__)
 <?>
 with id <?> was expected to be equal\\? to
@@ -568,7 +571,7 @@ EOT
       #
       # @example
       #   assert_operator 5, :>=, 4
-      def assert_operator(object1, operator, object2, message="")
+      def assert_operator(object1, operator, object2, message=nil)
         _wrap_assertion do
           full_message = build_message(nil, "<?>\ngiven as the operator for #assert_operator must be a Symbol or #respond_to\\?(:to_str).", operator)
           assert_block(full_message){operator.kind_of?(Symbol) || operator.respond_to?(:to_str)}
@@ -591,7 +594,7 @@ EOT
       #   assert_not_operator(5, :>, 4) # => fail
       #
       # @since 3.0.0
-      def assert_not_operator(object1, operator, object2, message="")
+      def assert_not_operator(object1, operator, object2, message=nil)
         _wrap_assertion do
           full_message = build_message(nil, "<?>\ngiven as the operator for #assert_not_operator must be a Symbol or #respond_to\\?(:to_str).", operator)
           assert_block(full_message){operator.kind_of?(Symbol) || operator.respond_to?(:to_str)}
@@ -653,7 +656,7 @@ EOT
       #
       # @example
       #   assert_not_same Object.new, Object.new
-      def assert_not_same(expected, actual, message="")
+      def assert_not_same(expected, actual, message=nil)
         full_message = build_message(message, <<EOT, expected, expected.__id__, actual, actual.__id__)
 <?>
 with id <?> was expected to not be equal\\? to
@@ -673,7 +676,7 @@ EOT
       #
       # @example
       #   assert_not_equal 'some string', 5
-      def assert_not_equal(expected, actual, message="")
+      def assert_not_equal(expected, actual, message=nil)
         full_message = build_message(message,
                                      "<?> was expected to be != to\n<?>.",
                                      expected, actual)
@@ -690,7 +693,7 @@ EOT
       #
       # @example
       #   assert_not_nil '1 two 3'.sub!(/two/, '2')
-      def assert_not_nil(object, message="")
+      def assert_not_nil(object, message=nil)
         full_message = build_message(message,
                                      "<?> was expected to not be nil.",
                                      object)
@@ -708,7 +711,7 @@ EOT
       # @example
       #   assert_not_match(/two/, 'one 2 three')   # -> pass
       #   assert_not_match(/three/, 'one 2 three') # -> fail
-      def assert_not_match(regexp, string, message="")
+      def assert_not_match(regexp, string, message=nil)
         _wrap_assertion do
           assert_instance_of(Regexp, regexp,
                              "<REGEXP> in assert_not_match(<REGEXP>, ...) " +
@@ -792,7 +795,7 @@ EOT
       #   assert_throw(:done) do
       #     throw(:done)
       #   end
-      def assert_throw(expected_object, message="", &proc)
+      def assert_throw(expected_object, message=nil, &proc)
         _wrap_assertion do
           begin
             catch([]) {}
@@ -838,7 +841,7 @@ EOT
       #  assert_nothing_thrown do
       #    [1, 2].uniq
       #  end
-      def assert_nothing_thrown(message="", &proc)
+      def assert_nothing_thrown(message=nil, &proc)
         _wrap_assertion do
           assert(block_given?, "Should have passed a block to assert_nothing_thrown")
           begin
@@ -1617,11 +1620,12 @@ EOT
       alias_method :refute_empty, :assert_not_empty
 
       ##
-      # Builds a failure message.  +head+ is added before the +template+ and
-      # +arguments+ replaces the '?'s positionally in the template.
-      def build_message(head, template=nil, *arguments)
+      # Builds a failure message.  +user_message+ is added before the
+      # +template+ and +arguments+ replaces the '?'s positionally in
+      # the template.
+      def build_message(user_message, template=nil, *arguments)
         template &&= template.chomp
-        return AssertionMessage.new(head, template, arguments)
+        return AssertionMessage.new(user_message, template, arguments)
       end
 
       private
@@ -1688,12 +1692,11 @@ EOT
         end
       end
 
-      def _set_failed_information(failure, expected, actual, user_message)
+      def _set_failed_information(failure, expected, actual)
         failure.expected = expected
         failure.actual = actual
         failure.inspected_expected = AssertionMessage.convert(expected)
         failure.inspected_actual = AssertionMessage.convert(actual)
-        failure.user_message = user_message
       end
 
       class AssertionMessage
@@ -2071,8 +2074,8 @@ EOT
 
         include Util::BacktraceFilter
 
-        def initialize(head, template_string, parameters)
-          @head = head
+        def initialize(user_message, template_string, parameters)
+          @user_message = user_message
           @template_string = template_string
           @parameters = parameters
         end
@@ -2085,24 +2088,28 @@ EOT
           @template ||= Template.create(@template_string)
         end
 
-        def add_period(string)
-          (string =~ /\.\Z/ ? string : string + '.')
+        def user_message
+          return nil unless @user_message
+          message = @user_message
+          message = message.call if message.respond_to?(:call)
+          message.to_s
         end
 
         def to_s
           message_parts = []
-          if (@head)
-            head = @head
-            head = head.call if head.respond_to?(:call)
-            head = head.to_s
-            unless(head.empty?)
-              message_parts << add_period(head)
-            end
+          head = user_message
+          if head and not head.empty?
+            message_parts << add_period(head)
           end
           tail = template.result(@parameters.collect{|e| convert(e)})
           message_parts << tail unless(tail.empty?)
           message_parts.join("\n")
         end
+
+        private
+        def add_period(string)
+          (string =~ /\.\Z/ ? string : string + '.')
+        end
       end
 
       class AssertExceptionHelper

data/lib/test/unit/version.rb

@@ -1,5 +1,5 @@
 module Test
   module Unit
-    VERSION = "3.3.0"
+    VERSION = "3.3.1"
   end
 end

data/test/test-assertions.rb

@@ -32,6 +32,7 @@ module Test
           return_value = yield
           failed = false
         rescue AssertionFailedError => error
+          return_value = error
           actual_message = error.message
         end
         @catch_assertions = false
@@ -1168,9 +1169,10 @@ EOM
           assert_true(1)
         end
 
-        check_fail("message.\n<true> expected but was\n<nil>") do
+        exception = check_fail("message.\n<true> expected but was\n<nil>") do
           assert_true(nil, "message")
         end
+        assert_equal("message", exception.user_message)
       end
 
       def test_assert_false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-unit
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Kouhei Sutou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: power_assert
@@ -231,48 +231,49 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: An xUnit family unit testing framework for Ruby.
 test_files:
-- test/run-test.rb
-- test/testunit-test-util.rb
-- test/test-priority.rb
-- test/test-test-suite.rb
-- test/test-error.rb
-- test/test-notification.rb
+- test/test-code-snippet.rb
 - test/test-fault-location-detector.rb
-- test/test-test-suite-creator.rb
-- test/test-data.rb
-- test/util/test-output.rb
-- test/util/test_backtracefilter.rb
-- test/util/test_procwrapper.rb
-- test/util/test_observable.rb
-- test/util/test-method-owner-finder.rb
+- test/test-attribute.rb
+- test/test-priority.rb
+- test/test-color-scheme.rb
 - test/test-failure.rb
-- test/test-pending.rb
-- test/test-test-case.rb
-- test/test-attribute-matcher.rb
-- test/test-omission.rb
 - test/test-color.rb
 - test/ui/test_testrunmediator.rb
-- test/test-fixture.rb
-- test/test-attribute.rb
-- test/test-code-snippet.rb
-- test/collector/test_objectspace.rb
-- test/collector/test-load.rb
-- test/collector/test-descendant.rb
-- test/collector/test_dir.rb
-- test/test-color-scheme.rb
-- test/test-assertions.rb
-- test/fixtures/plus.csv
-- test/fixtures/header-label.csv
+- test/test-attribute-matcher.rb
+- test/test-test-suite.rb
+- test/test-test-suite-creator.rb
+- test/test-diff.rb
+- test/test-emacs-runner.rb
+- test/test-data.rb
+- test/fixtures/header.csv
 - test/fixtures/header.tsv
 - test/fixtures/no-header.tsv
-- test/fixtures/header.csv
-- test/fixtures/header-label.tsv
+- test/fixtures/plus.csv
 - test/fixtures/no-header.csv
-- test/test-emacs-runner.rb
+- test/fixtures/header-label.tsv
+- test/fixtures/header-label.csv
+- test/test-assertions.rb
 - test/test-test-result.rb
-- test/test-diff.rb
+- test/testunit-test-util.rb
+- test/collector/test-load.rb
+- test/collector/test_dir.rb
+- test/collector/test_objectspace.rb
+- test/collector/test-descendant.rb
+- test/test-error.rb
+- test/run-test.rb
+- test/test-pending.rb
+- test/test-fixture.rb
+- test/util/test-output.rb
+- test/util/test-method-owner-finder.rb
+- test/util/test_observable.rb
+- test/util/test_procwrapper.rb
+- test/util/test_backtracefilter.rb
+- test/test-notification.rb
+- test/test-omission.rb
+- test/test-test-case.rb