test-unit 3.4.4 → 3.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf06d094c228d2826f3ffd368b7587dad9844cb59429790157c1d00f963e527
-  data.tar.gz: d5d07e063a929674b11047dee03b185fdf73f926e48aa8830f2f2fa7d4c88b58
+  metadata.gz: ddfd1116eddbfd3b3f9235d50e05f71c37b6327a4f3e79c549962f32b50f5075
+  data.tar.gz: 40c2137c8a8cf1b188a16bc1777456c2f418cbe2fb9af881b465f4a8e1b15625
 SHA512:
-  metadata.gz: 63d7fa4261919b37f31bd412335cc086778622f4ff63e6f645baf7c8440493e3dc2be0206bff51f5a24bb0f5f90122a61db5cbe31b2499360045092069164605
-  data.tar.gz: 50238b29eda4de9e4ece1c64fe3cd9a583ceeb7cb965c4e6660d39017ded8a27579723dfe206f434ff0bbd71dba9085e4af987d83d6bf76cf3ef16a475f31e4b
+  metadata.gz: 7235989cdea7459d1e1f5a43c7c0a70d5b3deeae7efca4b0f804c23d8c50e76de4afb688487716e177d70b2972f49e9df1869dcc567085270f91976c636ff787
+  data.tar.gz: aba5319ba07fc555c698a4d68c702e01a4599f7ee84d4b15461438fec9b30cb265c2d38163e3f0af383c6f7c5c641fa1a03c02e0b33634fe10d7cf0fed3964fb

data/README.md

@@ -1,7 +1,8 @@
 # test-unit
 
-[![](https://badge.fury.io/rb/test-unit.svg)](http://badge.fury.io/rb/test-unit)
-[![](https://travis-ci.org/test-unit/test-unit.svg?branch=master)](https://travis-ci.org/test-unit/test-unit)
+[![Gem Version](https://badge.fury.io/rb/test-unit.png)](http://badge.fury.io/rb/test-unit)
+[![Build Status for Ruby 2.1+](https://github.com/test-unit/test-unit/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/test-unit/test-unit/actions/workflows/test.yml?query=branch%3Amaster+)
+[![Build Status for Ruby 1.9 and 2.0](https://travis-ci.com/test-unit/test-unit.svg?branch=master)](https://travis-ci.com/test-unit/test-unit)
 
 * http://test-unit.github.io/
 * https://github.com/test-unit/test-unit
@@ -24,7 +25,7 @@ writing tests, checking results and automated testing in Ruby.
   to radically change very soon).
 
 * test-unit will be improved actively and may break
-  compatiblity with test-unit 1.2.3. (We will not hope it
+  compatibility with test-unit 1.2.3. (We will not hope it
   if it isn't needed.)
 
 * Some features exist as separated gems like GUI test

data/Rakefile

@@ -24,7 +24,6 @@ require "packnga"
 task :default => :test
 
 base_dir = File.dirname(__FILE__)
-html_base_dir = File.join(base_dir, "doc", "html")
 
 helper = Bundler::GemHelper.new(base_dir)
 def helper.version_tag
@@ -53,14 +52,6 @@ def rake(*arguments)
   ruby($0, *arguments)
 end
 
-namespace :html do
-  desc "Publish HTML to Web site."
-  task :publish do
-    # FIXME Do nothing for now
-    #rsync_to_rubyforge(spec, "#{html_base_dir}/", "")
-  end
-end
-
 task :test do
   ruby("test/run-test.rb")
 end

data/doc/text/getting-started.md

@@ -239,7 +239,7 @@ module Sub
 end
 ~~~
 
-## 7. For more inforomation
+## 7. For more information
 
 Let's read the official document.
 

data/doc/text/news.md

@@ -1,10 +1,35 @@
 # News
 
+## 3.4.5 - 2021-09-04 {#version-3-4-5}
+
+### Improvements
+
+  * Added more metadata to gemspec.
+    [GitHub#183][Patch by Kenichi Kamiya]
+
+  * Removed needless files from gem.
+    [GitHub#184][Patch by Kenichi Kamiya]
+
+  * Updated documents.
+    [GitHub#191][GitHub#192][GitHub#193][GitHub#199][GitHub#200]
+    [GitHub#201][Patch by Kenichi Kamiya]
+
+  * Added `assert_nothing_leaked_memory`.
+
+### Fixes
+
+  * Fixed typos in documents.
+    [GitHub#189][GitHub#190][GitHub#195][GitHub#197][Patch by Kenichi Kamiya]
+
+### Thanks
+
+  * Kenichi Kamiya
+
 ## 3.4.4 - 2021-06-04 {#version-3-4-4}
 
 ### Improvements
 
-  * Rename `assert_all?` to `assert_all`. `assert_all?` is deprecated
+  * Renamed `assert_all?` to `assert_all`. `assert_all?` is deprecated
     but is available.
 
 ## 3.4.3 - 2021-06-04 {#version-3-4-3}

data/lib/test/unit/assertions.rb

@@ -5,6 +5,7 @@
 
 require 'test/unit/assertion-failed-error'
 require 'test/unit/util/backtracefilter'
+require 'test/unit/util/memory-usage'
 require 'test/unit/util/method-owner-finder'
 require 'test/unit/diff'
 
@@ -43,7 +44,7 @@ module Test
 
       ##
       # The assertion upon which all other assertions are based. Passes if the
-      # block yields true.
+      # block yields not false nor nil.
       #
       # @example
       #   assert_block "Couldn't do the thing" do
@@ -454,7 +455,7 @@ EOT
       alias_method :refute_instance_of, :assert_not_instance_of
 
       ##
-      # Passes if `object` is nil.
+      # Passes if `object`.nil?.
       #
       # @example
       #   assert_nil [1, 2].uniq!
@@ -627,7 +628,7 @@ EOT
       ##
       # Compares the `object1` with `object2` using `operator`.
       #
-      # Passes if object1.__send__(operator, object2) is true.
+      # Passes if object1.__send__(operator, object2) is not false nor nil.
       #
       # @example
       #   assert_operator 5, :>=, 4
@@ -647,7 +648,7 @@ EOT
       ##
       # Compares the `object1` with `object2` using `operator`.
       #
-      # Passes if object1.__send__(operator, object2) is not true.
+      # Passes if object1.__send__(operator, object2) is false or nil.
       #
       # @example
       #   assert_not_operator(5, :<, 4) # => pass
@@ -787,7 +788,7 @@ EOT
       alias_method :refute_match, :assert_not_match
 
       ##
-      # Deprecated. Use #assert_not_match instead.
+      # @deprecated Use {#assert_not_match} instead.
       #
       # Passes if `regexp` !~ `string`
       #
@@ -1177,7 +1178,7 @@ EOT
 
       public
       ##
-      # Passes if the method send returns a true value.
+      # Passes if the method `__send__` returns not false nor nil.
       #
       # `send_array` is composed of:
       # * A receiver
@@ -1217,7 +1218,7 @@ EOT
       end
 
       ##
-      # Passes if the method send doesn't return a true value.
+      # Passes if the method `__send__` returns false or nil.
       #
       # `send_array` is composed of:
       # * A receiver
@@ -1267,7 +1268,7 @@ EOT
           assert_block(build_message(message,
                                      "<true> or <false> expected but was\n<?>",
                                      actual)) do
-            [true, false].include?(actual)
+            true == actual || false == actual
           end
         end
       end
@@ -1283,7 +1284,7 @@ EOT
           assert_block(build_message(message,
                                      "<true> expected but was\n<?>",
                                      actual)) do
-            actual == true
+            true == actual
           end
         end
       end
@@ -1299,14 +1300,14 @@ EOT
           assert_block(build_message(message,
                                      "<false> expected but was\n<?>",
                                      actual)) do
-            actual == false
+            false == actual
           end
         end
       end
 
       ##
       # Passes if expression "`expected` `operator`
-      # `actual`" is true.
+      # `actual`" is not false nor nil.
       #
       # @example
       #   assert_compare(1, "<", 10)  # -> pass
@@ -1435,7 +1436,7 @@ EOT
       end
 
       ##
-      # Passes if `object`.`predicate` is _true_.
+      # Passes if `object`.`predicate` is not false nor nil.
       #
       # @example
       #   assert_predicate([], :empty?)  # -> pass
@@ -1457,7 +1458,7 @@ EOT
       end
 
       ##
-      # Passes if `object`.`predicate` is not _true_.
+      # Passes if `object`.`predicate` is false or nil.
       #
       # @example
       #   assert_not_predicate([1], :empty?) # -> pass
@@ -1686,12 +1687,12 @@ EOT
       #   with any `block`.
       #
       #   @example Pass patterns
-      #     assert_all?([1, 2, 3]) {|item| item > 0} # => pass
-      #     assert_all?([1, 2, 3], &:positive?)      # => pass
-      #     assert_all?([]) {|item| false}           # => pass
+      #     assert_all([1, 2, 3]) {|item| item > 0} # => pass
+      #     assert_all([1, 2, 3], &:positive?)      # => pass
+      #     assert_all([]) {|item| false}           # => pass
       #
       #   @example Failure pattern
-      #     assert_all?([0, 1, 2], &:zero?) # => failure
+      #     assert_all([0, 1, 2], &:zero?) # => failure
       #
       #   @param [#each] collection The check target.
       #   @param [String] message The additional user message. It is
@@ -1729,6 +1730,81 @@ EOT
       # @since 3.4.3
       alias_method :assert_all?, :assert_all
 
+      # @overload assert_nothing_leaked_memory(max_increasable_size, target=:physical, message=nil, &block)
+      #
+      #   Asserts that increased memory usage by `block.call` is less
+      #   than `max_increasable_size`. `GC.start` is called before and
+      #   after `block.call`.
+      #
+      #   This assertion may be fragile. Because memory usage is
+      #   depends on the current Ruby process's memory
+      #   usage. Launching a new Ruby process for this will produce
+      #   more stable result but we need to specify target code as
+      #   `String` instead of block for the approach. We choose easy
+      #   to write API approach rather than more stable result
+      #   approach for this case.
+      #
+      #   @example Pass pattern
+      #     require "objspace"
+      #     size_per_object = ObjectSpace.memsize_of("Hello")
+      #     # If memory isn't leaked, physical memory of almost created objects
+      #     # (1000 - 10 objects) must be freed.
+      #     assert_nothing_leaked_memory(size_per_object * 10) do
+      #       1_000.times do
+      #         "Hello".dup
+      #       end
+      #     end # => pass
+      #
+      #   @example Failure pattern
+      #     require "objspace"
+      #     size_per_object = ObjectSpace.memsize_of("Hello")
+      #     strings = []
+      #     assert_nothing_leaked_memory(size_per_object * 10) do
+      #       10_000.times do
+      #         # Created objects aren't GC-ed because they are referred.
+      #         strings << "Hello".dup
+      #       end
+      #     end # => failure
+      #
+      #   @param target [:physical, :virtual] which memory usage is
+      #     used for comparing. `:physical` means physical memory usage
+      #     also known as Resident Set Size (RSS). `:virtual` means
+      #     virtual memory usage.
+      #   @yield [] do anything you want to measure memory usage
+      #     in the block.
+      #   @yieldreturn [void]
+      #   @return [void]
+      #
+      # @since 3.4.5
+      def assert_nothing_leaked_memory(max_increasable_size,
+                                       target=:physical,
+                                       message=nil)
+        _wrap_assertion do
+          GC.start
+          before = Util::MemoryUsage.new
+          unless before.collected?
+            omit("memory usage collection isn't supported on this platform")
+          end
+          yield
+          GC.start
+          after = Util::MemoryUsage.new
+          before_value = before.__send__(target)
+          after_value = after.__send__(target)
+          actual_increased_size = after_value - before_value
+          template = <<-TEMPLATE
+<?> was expected to be less than
+<?>.
+          TEMPLATE
+          full_message = build_message(message,
+                                       template,
+                                       actual_increased_size,
+                                       max_increasable_size)
+          assert_block(full_message) do
+            actual_increased_size < max_increasable_size
+          end
+        end
+      end
+
       ##
       # Builds a failure message.  `user_message` is added before the
       # `template` and `arguments` replaces the '?'s positionally in

data/lib/test/unit/testcase.rb

@@ -447,7 +447,7 @@ module Test
         # @private
         @@method_locations = {}
         # @private
-        @@method_location_mutex = Mutex.new
+        @@method_location_mutex = Thread::Mutex.new
 
         # @private
         def method_locations

data/lib/test/unit/testsuite.rb

@@ -77,7 +77,7 @@ module Test
         @tests -= tests
       end
 
-      # Retuns the rolled up number of tests in this suite;
+      # Returns the rolled up number of tests in this suite;
       # i.e. if the suite contains other suites, it counts the
       # tests within those suites, not the suites themselves.
       def size

data/lib/test/unit/util/memory-usage.rb

@@ -0,0 +1,47 @@
+module Test
+  module Unit
+    module Util
+      class MemoryUsage
+        attr_reader :virtual
+        attr_reader :physical
+        def initialize
+          @virtual = nil
+          @physical = nil
+          collect_data
+        end
+
+        def collected?
+          return false if @virtual.nil?
+          return false if @physical.nil?
+          true
+        end
+
+        private
+        def collect_data
+          collect_data_proc
+        end
+
+        def collect_data_proc
+          status_file = "/proc/self/status"
+          return false unless File.exist?(status_file)
+
+          data = File.binread(status_file)
+          data.each_line do |line|
+            case line
+            when /\AVm(Size|RSS):\s*(\d+)\s*kB/
+              name = $1
+              value = Integer($2, 10) * 1024
+              case name
+              when "Size"
+                @virtual = value
+              when "RSS"
+                @physical = value
+              end
+            end
+          end
+          collected?
+        end
+      end
+    end
+  end
+end

data/lib/test/unit/version.rb

@@ -1,5 +1,5 @@
 module Test
   module Unit
-    VERSION = "3.4.4"
+    VERSION = "3.4.5"
   end
 end

data/lib/test/unit.rb

@@ -324,14 +324,14 @@ module Test # :nodoc:
       # Set true when Test::Unit has run.  If set to true Test::Unit
       # will not automatically run at exit.
       #
-      # @deprecated Use Test::Unit::AutoRunner.need_auto_run= instead.
+      # @deprecated Use {Test::Unit::AutoRunner.need_auto_run=} instead.
       def run=(have_run)
         AutoRunner.need_auto_run = (not have_run)
       end
 
       # Already tests have run?
       #
-      # @deprecated Use Test::Unit::AutoRunner.need_auto_run? instead.
+      # @deprecated Use {Test::Unit::AutoRunner.need_auto_run?} instead.
       def run?
         not AutoRunner.need_auto_run?
       end
@@ -339,7 +339,7 @@ module Test # :nodoc:
       # @api private
       @@at_start_hooks = []
 
-      # Regsiter a hook that is run before running tests.
+      # Register a hook that is run before running tests.
       # To register multiple hooks, call this method multiple times.
       #
       # Here is an example test case:
@@ -425,7 +425,7 @@ module Test # :nodoc:
       # @api private
       @@at_exit_hooks = []
 
-      # Regsiter a hook that is run after running tests.
+      # Register a hook that is run after running tests.
       # To register multiple hooks, call this method multiple times.
       #
       # Here is an example test case:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: test-unit
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.4.5
 platform: ruby
 authors:
 - Kouhei Sutou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: power_assert
@@ -159,6 +159,7 @@ files:
 - lib/test/unit/ui/testrunnerutilities.rb
 - lib/test/unit/ui/xml/testrunner.rb
 - lib/test/unit/util/backtracefilter.rb
+- lib/test/unit/util/memory-usage.rb
 - lib/test/unit/util/method-owner-finder.rb
 - lib/test/unit/util/observable.rb
 - lib/test/unit/util/output.rb
@@ -170,46 +171,6 @@ files:
 - sample/test_adder.rb
 - sample/test_subtracter.rb
 - sample/test_user.rb
-- test/collector/test-descendant.rb
-- test/collector/test-load.rb
-- test/collector/test_dir.rb
-- test/collector/test_objectspace.rb
-- test/fixtures/header-label.csv
-- test/fixtures/header-label.tsv
-- test/fixtures/header.csv
-- test/fixtures/header.tsv
-- test/fixtures/no-header.csv
-- test/fixtures/no-header.tsv
-- test/fixtures/plus.csv
-- test/run-test.rb
-- test/test-assertions.rb
-- test/test-attribute-matcher.rb
-- test/test-attribute.rb
-- test/test-code-snippet.rb
-- test/test-color-scheme.rb
-- test/test-color.rb
-- test/test-data.rb
-- test/test-diff.rb
-- test/test-emacs-runner.rb
-- test/test-error.rb
-- test/test-failure.rb
-- test/test-fault-location-detector.rb
-- test/test-fixture.rb
-- test/test-notification.rb
-- test/test-omission.rb
-- test/test-pending.rb
-- test/test-priority.rb
-- test/test-test-case.rb
-- test/test-test-result.rb
-- test/test-test-suite-creator.rb
-- test/test-test-suite.rb
-- test/testunit-test-util.rb
-- test/ui/test_testrunmediator.rb
-- test/util/test-method-owner-finder.rb
-- test/util/test-output.rb
-- test/util/test_backtracefilter.rb
-- test/util/test_observable.rb
-- test/util/test_procwrapper.rb
 homepage: http://test-unit.github.io/
 licenses:
 - Ruby
@@ -217,6 +178,8 @@ licenses:
 - PSFL
 metadata:
   source_code_uri: https://github.com/test-unit/test-unit
+  documentation_uri: https://test-unit.github.io/test-unit/en/
+  bug_tracker_uri: https://github.com/test-unit/test-unit/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -236,44 +199,4 @@ rubygems_version: 3.3.0.dev
 signing_key: 
 specification_version: 4
 summary: An xUnit family unit testing framework for Ruby.
-test_files:
-- test/collector/test-descendant.rb
-- test/collector/test-load.rb
-- test/collector/test_dir.rb
-- test/collector/test_objectspace.rb
-- test/fixtures/header-label.csv
-- test/fixtures/header-label.tsv
-- test/fixtures/header.csv
-- test/fixtures/header.tsv
-- test/fixtures/no-header.csv
-- test/fixtures/no-header.tsv
-- test/fixtures/plus.csv
-- test/run-test.rb
-- test/test-assertions.rb
-- test/test-attribute-matcher.rb
-- test/test-attribute.rb
-- test/test-code-snippet.rb
-- test/test-color-scheme.rb
-- test/test-color.rb
-- test/test-data.rb
-- test/test-diff.rb
-- test/test-emacs-runner.rb
-- test/test-error.rb
-- test/test-failure.rb
-- test/test-fault-location-detector.rb
-- test/test-fixture.rb
-- test/test-notification.rb
-- test/test-omission.rb
-- test/test-pending.rb
-- test/test-priority.rb
-- test/test-test-case.rb
-- test/test-test-result.rb
-- test/test-test-suite-creator.rb
-- test/test-test-suite.rb
-- test/testunit-test-util.rb
-- test/ui/test_testrunmediator.rb
-- test/util/test-method-owner-finder.rb
-- test/util/test-output.rb
-- test/util/test_backtracefilter.rb
-- test/util/test_observable.rb
-- test/util/test_procwrapper.rb
+test_files: []