test-unit 3.2.0 → 3.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f9cfd2190829c1b6c4c0905528cdb5fc4a268628
-  data.tar.gz: bf46e41d08f2611ac2525eaff7d8cbe80abdbb36
+SHA256:
+  metadata.gz: b7aaedb309f50feea0367554eeef8b79f0daf6edb5c75c4b66df9e990c35d371
+  data.tar.gz: 17bd1f32e290087d6b57cf5337dbd8cc8259896671ef1cc6c23b15579e52698b
 SHA512:
-  metadata.gz: 614e4c8a515908878c257ae37d231a44cf2044b127d61c65d0d8aba63d1cf67494a13c21e73e62c093e6d7c43af65ffc6ca2c425c65bf26922c10bea33008d78
-  data.tar.gz: 9bfde8f312ac6c198c2270ab32baf1e905e365e2bd36d40598d77a8ee39cac4b783bd88c9e5dc824a9e9ac7fe15e3b4730a34c0762c6c277046471457f59a932
+  metadata.gz: d86d52e5ed5bc4930f6b26f76d0294cb2e50261f16495649e75eb79ab2631cd23c2bfd6602ede230384f3971e9f780f87a8324ca15a0b3a09866a1c449641e55
+  data.tar.gz: 26975998cc3e8c4c6e5d372b3d3e51316e2709508fdb5ebd87083dcf658941f4b038bcc4f6e1f714ba891a14c1ccbca5ec5e197065a45163dcfd5861cd5b6c15

data/COPYING

@@ -61,4 +61,7 @@ version 2 (see the file GPL), or the conditions below:
 Exceptions
 ----------
 
-  * lib/test/unit/diff.rb: PSFL
+  * lib/test/unit/diff.rb: This license, PSF license and/or LGPLv2.1
+    or later
+
+  * lib/test-unit.rb: This license and/or LGPLv2.1 or later

data/README.md

@@ -1,7 +1,7 @@
 # test-unit
 
-[![](https://badge.fury.io/rb/test-unit.png)](http://badge.fury.io/rb/test-unit)
-[![](https://travis-ci.org/test-unit/test-unit.png?branch=master)](https://travis-ci.org/test-unit/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)
 
 * http://test-unit.github.io/
 * https://github.com/test-unit/test-unit
@@ -10,31 +10,31 @@
 
 An xUnit family unit testing framework for Ruby.
 
-Test::Unit (test-unit) is unit testing framework for Ruby, based on xUnit
+test-unit (Test::Unit) is unit testing framework for Ruby, based on xUnit
 principles. These were originally designed by Kent Beck, creator of extreme
 programming software development methodology, for Smalltalk's SUnit. It allows
 writing tests, checking results and automated testing in Ruby.
 
 ## Features
 
-* Test::Unit 1.2.3 is the original Test::Unit, taken
+* test-unit 1.2.3 is the original test-unit, taken
   straight from the ruby distribution. It is being
   distributed as a gem to allow tool builders to use it as a
   stand-alone package. (The test framework in ruby is going
   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
+  compatiblity 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
   runner. (Tk, GTK+ and Fox) test-unit-full gem package
-  provides for installing all Test::Unit related gems
+  provides for installing all test-unit related gems
   easily.
 
 ## How To
 
-* [How To](doc/text/how-to.md) (link for GitHub)
+* [How To](https://github.com/test-unit/test-unit/blob/master/doc/text/how-to.md) (link for GitHub)
 * {file:doc/text/how-to.md How To} (link for YARD)
 
 ## Install
@@ -43,7 +43,7 @@ writing tests, checking results and automated testing in Ruby.
 % sudo gem install test-unit
 </pre>
 
-If you want to use full Test::Unit features:
+If you want to use full test-unit features:
 
 <pre>
 % sudo gem install test-unit-full
@@ -57,8 +57,8 @@ This software is distributed under the same terms as ruby.
 
 Exception:
 
-  * lib/test/unit/diff.rb is a double license of the Ruby license and
-    PSF license.
+  * lib/test/unit/diff.rb is a triple license of the Ruby license,
+    PSF license and LGPLv2.1 or later.
 
   * lib/test-unit.rb is a dual license of the Ruby license and LGPLv2.1
     or later.
@@ -77,7 +77,7 @@ Exception:
 
 ### Images
 
-* Mayu & Co.: kinotan icons: http://cocooooooon.com/kinotan/
+* Mayu & Co.: kinotan icons
 
 ## Thanks
 

data/Rakefile

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 #
-# Copyright (C) 2008-2013  Kouhei Sutou <kou@clear-code.com>
+# Copyright (C) 2008-2017  Kouhei Sutou <kou@clear-code.com>
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -18,6 +18,15 @@
 
 Encoding.default_internal = "UTF-8" if defined?(Encoding.default_internal)
 
+# TODO: Remove me when we drop Ruby 1.9 support.
+unless "".respond_to?(:b)
+  class String
+    def b
+      dup.force_encoding("ASCII-8BIT")
+    end
+  end
+end
+
 require "erb"
 require "yaml"
 require "rubygems"

data/doc/text/getting-started.md

@@ -0,0 +1,246 @@
+## 1. First step of the `test-unit`
+
+Let's getting start `test-unit`.
+
+This document creates an example gem package called `sample` with the `test-unit` testing framework.
+
+## 2. Install bundler and test-unit.
+
+* First, install the `bundler` gem for generating gem template.
+* Second, install the `test-unit` itself.
+
+~~~
+!!!plain
+gem install bundler
+gem install test-unit
+~~~
+
+The `gem list` command output installed packages.
+You will find the following lines.
+
+~~~
+!!!plain
+gem list
+...
+bundler (1.14.6)
+...
+test-unit (3.2.3)
+~~~
+
+## 3. Create gem template.
+
+Next, create a gem template using `bundler` command.
+This command generates package skeleton with a testing framework.
+However, this command can't generate test templates for `test-unit`.
+
+So, First create gem template with the `minitest` testing framework.
+(It's similar to `unit-test`).
+After that, replace some files for `test-unit`.
+
+The `bundle gem -t minitest sample` command will generate the following files.
+
+~~~
+!!!plain
+.
+|-- Gemfile
+|-- README.md
+|-- Rakefile
+|-- bin
+|   |-- console
+|   `-- setup
+|-- lib
+|   |-- sample
+|   |   `-- version.rb
+|   `-- sample.rb
+|-- sample.gemspec  # <- Modify
+`-- test
+    |-- sample_test.rb # <- Modify
+    `-- test_helper.rb # <- Modify
+~~~
+
+## 4. Edit files for `test-unit`
+
+### 4.1. Edit gemspec
+
+Edit `sample.gemspec` like the below.
+Replace `minitest` line to `test-unit`.
+
+Before
+
+~~~
+!!!ruby
+  spec.add_development_dependency "minitest", "~> 5.0"
+~~~
+
+After
+
+~~~
+!!!ruby
+  spec.add_development_dependency "test-unit", "~> 3.2.3"
+~~~
+
+### 4.2. Edit `test/test_helper.rb`
+
+Next, edit the `test/test_helper.rb` file.
+
+Before
+
+~~~
+!!!ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sample'
+
+require 'minitest/autorun' # <-- Modify this line.
+~~~
+
+After
+
+~~~
+!!!ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sample'
+
+require 'test/unit' # <-- After modification.
+~~~
+
+### 4.3 Rakefile (No edit)
+
+This file doesn't need to modify.
+The output is the below.
+
+~~~
+!!!ruby
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+~~~
+
+### 4.4 Edit `test/sample_test.rb`
+
+The bundler generate the file `test/sample_test.rb`.
+This file originally templates for `minitest`.
+
+Let's modify this file for `test-unit`
+
+before
+
+~~~
+!!!ruby
+require 'test_helper'
+
+class SampleTest < Minitest::Test # <- Modify here
+  def test_that_it_has_a_version_number
+    refute_nil ::Sample::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end
+~~~
+
+After
+
+~~~
+!!!ruby
+require 'test_helper'
+
+class SampleTest < Test::Unit::TestCase # <- After modification
+  def test_that_it_has_a_version_number
+    refute_nil ::Sample::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end
+~~~
+
+## 5. Execute test.
+
+The `rake test` command execute test scenarios in the `test` directory.
+Now it tries to two tests. One will success the other one fails.
+
+~~~
+!!!plain
+rake test
+Loaded suite
+/path/to/ruby/lib/ruby/gems/2.3.0/gems/rake-12.0.0/lib/rake/rake_test_loader
+Started
+F
+================================================================================
+Failure: <false> is not true.
+test_it_does_something_useful(SampleTest)
+/path/to/sample/test/sample_test.rb:9:in `test_it_does_something_useful'
+      6:   end
+      7:
+      8:   def test_it_does_something_useful
+  =>  9:     assert false
+     10:   end
+     11: end
+================================================================================
+.
+
+Finished in 0.011521 seconds.
+--------------------------------------------------------------------------------
+2 tests, 2 assertions, 1 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications
+50% passed
+--------------------------------------------------------------------------------
+173.60 tests/s, 173.60 assertions/s
+rake aborted!
+Command failed with status (1)
+
+Tasks: TOP => test
+(See full trace by running task with --trace)
+~~~
+
+## 6. Create original tests.
+
+Let's create your original tests with the following rules.
+
+* Create a test file in the `test` directory.
+* The file needs suffix  `xxx_test.rb`.
+* You can put test file into the subdirectory like `test/sub`.
+
+Example directory layout.
+
+~~~
+!!!plain
+test
+|-- sample_test.rb
+|-- sub
+|   `-- sample2_test.rb
+`-- test_helper.rb
+~~~
+
+Example test file in the sub directory.
+
+~~~
+!!!ruby
+require 'test_helper'
+
+module Sub
+  class Sample2Test < Test::Unit::TestCase
+    def test_that_it_has_a_version_number
+      refute_nil ::Sample::VERSION
+    end
+
+    def test_it_does_something_useful
+      assert false
+    end
+  end
+end
+~~~
+
+## 7. For more inforomation
+
+Let's read the official document.
+
+* [test-unit](http://test-unit.github.io/index.html)

data/doc/text/news.md

@@ -1,5 +1,376 @@
 # News
 
+## 3.3.6 - 2020-06-10 {#version-3-3-6}
+
+### Improvements
+
+  * `name`, `--ignore-name`:
+
+     * Added support for regular expression options.
+
+     * Added support for matching with class name in exact match mode.
+       [Reported by Jun Aruga]
+
+  * Updated ruby-talk mailing list information
+    [GitHub#168][Patch by Chris Kampmeier]
+
+### Thanks
+
+  * Chris Kampmeier
+
+  * Jun Aruga
+
+## 3.3.5 - 2020-01-10 {#version-3-3-5}
+
+### Improvements
+
+  * Improved code snippet showing with different default external encoding.
+    [GitHub#166][Patch by Yuta Iwama]
+
+### Thanks
+
+  * Yuta Iwama
+
+## 3.3.4 - 2019-09-30 {#version-3-3-4}
+
+### Improvements
+
+  * Converted markup format to Markdown from RDoc.
+    [GitHub#164][Patch by OGAWA KenIchi]
+
+  * test: Stopped to depend on `Time#inspect` format.
+    [GitHub#165][Reported by Benoit Daloze]
+
+### Thanks
+
+  * OGAWA KenIchi
+
+  * Benoit Daloze
+
+## 3.3.3 - 2019-05-10 {#version-3-3-3}
+
+### Fixed
+
+  * Fixed a bug that priority mode with test case name that uses
+    special characters such as `?` can't be used on Windows.
+
+## 3.3.2 - 2019-04-11 {#version-3-3-2}
+
+### Fixes
+
+  * Fixed a bug that `Test::Unit::Collector::Load` doesn't load test
+    files under sub directories when these files have the same base
+    name as test files in upper directories.
+    [Reported by Kenta Murata]
+
+### Thanks
+
+  * Kenta Murata
+
+## 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
+
+  * Added support for auto test run when all tests are defined in
+    modules.
+
+  * Added support for defining methods to test case class in multiple
+    threads.
+    [GitHub#159][Reported by Charles Oliver Nutter]
+
+  * Suppressed warnings on Ruby 2.5.
+    [GitHub#160][Reported by Daniel Berger]
+
+  * Suppressed warnings on Ruby 2.7.
+
+### Fixes
+
+  * Fixed a code snippet fetch failure when source code isn't UTF-8
+    and the default external encoding is set to not UTF-8.
+    [GitHub#161][Reported by masa kunikata]
+
+### Thanks
+
+  * Charles Oliver Nutter
+
+  * Daniel Berger
+
+  * masa kunikata
+
+## 3.2.9 - 2018-12-01 {#version-3-2-9}
+
+### Improvements
+
+  * Added support for data generation by method. `data_#{test_name}`
+    is called to generate data for `test_name` test.
+
+  * Added support for data matrix generation.
+
+    Example:
+
+    ```ruby
+    data(:a, [0, 1, 2])
+    data(:b, [:x, :y])
+    def test_data(data)
+    end
+    ```
+
+    This example generates the following data matrix:
+
+      * label: `"a: 0, b: :x"`, data: `{a: 0, b: :x}`
+      * label: `"a: 0, b: :y"`, data: `{a: 0, b: :y}`
+      * label: `"a: 1, b: :x"`, data: `{a: 1, b: :x}`
+      * label: `"a: 1, b: :y"`, data: `{a: 1, b: :y}`
+      * label: `"a: 2, b: :x"`, data: `{a: 2, b: :x}`
+      * label: `"a: 2, b: :y"`, data: `{a: 2, b: :y}`
+
+  * Added `Test::Unit::TestCase#data` that returns the current data.
+
+  * Added support for using test method that doesn't have no
+    parameters as data driven test.
+
+    Example:
+
+    ```ruby
+    data("label", :value)
+    def test_data # Available since this release
+      p data # :value
+    end
+    ```
+
+  * Added support for `:keep` option to `Test::Unit::TestCase.data`.
+
+  * Added support for `:group` option to
+    `Test::Unit::TestCase.data`. It's useful to generate multiple data
+    matrix groups.
+
+    ```ruby
+    # Group1
+    data(:a, [0, 1, 2], group: :g1)
+    data(:b, [:x, :y], group: :g1)
+    # Group2
+    data(:a, [:x, :y], group: :g2)
+    data(:c, [-1, -2], group: :g2)
+    def test_data(data)
+    end
+    ```
+
+    This example generates the following data matrix:
+
+      * label: `"group: :g1, a: 0, b: :x"`, data: `{a: 0, b: :x}`
+      * label: `"group: :g1, a: 0, b: :y"`, data: `{a: 0, b: :y}`
+      * label: `"group: :g1, a: 1, b: :x"`, data: `{a: 1, b: :x}`
+      * label: `"group: :g1, a: 1, b: :y"`, data: `{a: 1, b: :y}`
+      * label: `"group: :g1, a: 2, b: :x"`, data: `{a: 2, b: :x}`
+      * label: `"group: :g1, a: 2, b: :y"`, data: `{a: 2, b: :y}`
+      * label: `"group: :g2, a: :x, b: -1"`, data: `{a: :x, b: -1}`
+      * label: `"group: :g2, a: :x, b: -2"`, data: `{a: :x, b: -2}`
+      * label: `"group: :g2, a: :y, b: -1"`, data: `{a: :y, b: -1}`
+      * label: `"group: :g2, a: :y, b: -2"`, data: `{a: :y, b: -2}`
+
+## 3.2.8 - 2018-05-13 {#version-3-2-8}
+
+### Improvements
+
+  * [UI][console]: Changed to put code snippet before backtrace on
+    reverse mode.
+
+## 3.2.7 - 2017-12-12 {#version-3-2-7}
+
+### Improvements
+
+  * Added source code link to gemspec.
+    [GitHub#157][Patch by Grey Baker]
+
+  * Changed to use SVG image for badges in README.
+    [GitHub#158][Patch by Olle Jonsson]
+
+  * [UI][console]: Added `--reverse-output` option to output fault
+    details in reverse like Ruby 2.5. It's enabled by default only for
+    tty output.
+
+### Fixes
+
+  * Fixed a typo.
+    [GitHub#156][Patch by masa kunikata]
+
+  * [UI][console]: Fixed a bug that broken align in verbose mode.
+
+### Thanks
+
+  * masa kunikata
+
+  * Grey Baker
+
+  * Olle Jonsson
+
+## 3.2.6 - 2017-09-21 {#version-3-2-6}
+
+### Improvements
+
+  * Changed test file require failure to error from omission.
+    [GitHub#154][Patch by naofumi-fujii]
+
+### Thanks
+
+  * naofumi-fujii
+
+## 3.2.5 - 2017-06-24 {#version-3-2-5}
+
+### Improvements
+
+  * Supported `--enable-frozen-string-literal` `ruby` option.
+    [GitHub#149][Reported by Pat Allan]
+
+### Thanks
+
+  * Pat Allan
+
+## 3.2.4 - 2017-05-23 {#version-3-2-4}
+
+### Improvements
+
+  * Updated tests for Ruby 2.4. [GitHUb#136][Patch by Kazuki Tsujimoto]
+
+  * Supported power\_assert 1.0.0. [GitHub#137][Patch by Kazuki Tsujimoto]
+
+  * Added the getting started document.
+    [GitHub#139][GitHub#141][Patch by Hiroyuki Sato]
+
+  * Added the document for `attribute`.
+    [GitHub#143][Patch by Fumiaki MATSUSHIMA]
+
+  * Improved a link for GitHub. [GitHub#144][Patch by rochefort]
+
+  * Updated `.travis.yml`. [GitHub#145][Patch by Jun Aruga]
+
+### Fixes
+
+  * Fixed a contributor name. [GitHub#131][Patch by Akira Matsuda]
+
+  * Fixed typos in document. [GitHub#132][Patch by Akira Matsuda]
+
+  * Fixed typos in document. [GitHub#134][Patch by Yuji Yaginuma]
+
+  * Fixed a bug that data label with "(" isn't supported.
+    [GitHub#135][Reported by Kazuki Tsujimoto]
+
+  * Fixed assertion message in English.
+    [GitHub#133][Reported by Khalil Fazal]
+
+  * Fixed a typo in typo fix. [GitHub#138][Patch by kami]
+
+  * Fixed a bug that target location finder may return wrong
+    location. [GitHub#146][Patch by Yuki Ito]
+
+  * Fixed a bug that `--no-show-detail-immediately` raises an error.
+    [GitHub#147][Reported by MSP-Greg]
+
+### Thanks
+
+  * Akira Matsuda
+
+  * Yuji Yaginuma
+
+  * Kazuki Tsujimoto
+
+  * Khalil Fazal
+
+  * kami
+
+  * Hiroyuki Sato
+
+  * Fumiaki MATSUSHIMA
+
+  * rochefort
+
+  * Jun Aruga
+
+  * Yuki Ito
+
+  * MSP-Greg
+
+## 3.2.3 - 2016-11-25 {#version-3-2-3}
+
+### Fixes
+
+  * Fixed a bug that `--order` isn't applied.
+    [GitHub#129][Reported by Vít Ondruch]
+
+### Thanks
+
+  * Vít Ondruch
+
+## 3.2.2 - 2016-11-02 {#version-3-2-2}
+
+### Improvements
+
+  * Improved Travis CI configuration.
+    [GitHub#123][Patch by Ryunosuke Sato]
+
+  * Supported Java native exception.
+    [GitHub#126][Reported by Bob Saveland]
+
+### Fixes
+
+  * doc: Fixed markup. [GitHub#127][Patch by Tomohiro Hashidate]
+
+  * Fixed a bug that `--location=LINE` may not detect a test when
+    fixtures are defined before any tests:
+
+        1 class MyTestCase < Test::Unit::TestCase
+        2   setup do
+        3   end
+        4
+        5   test "xxx" do
+        6   end
+        7 end
+
+    `--location=5` couldn't find the `xxx` test.
+
+    [Reported by Ryota Sasabe]
+
+### Thanks
+
+  * Ryunosuke Sato
+
+  * Tomohiro Hashidate
+
+  * Bob Saveland
+
+  * Ryota Sasabe
+
+## 3.2.1 - 2016-07-19 {#version-3-2-1}
+
+### Improvements
+
+  * Clarified lib/test/unit/diff.rb license. It's a triple license of
+    the Ruby license, PSF license and LGPLv2.1 or later.
+    [Reported by Luisa Pace]
+
+  * Reported norification when data driven test doesn't have
+    parameter.
+    [GitHub#122][Reported by Satoshi "Moris" Tagomori]
+
+### Thanks
+
+  * Luisa Pace
+
+  * Satoshi "Moris" Tagomori
+
 ## 3.2.0 - 2016-06-12 {#version-3-2-0}
 
 ### Improvements
@@ -505,7 +876,7 @@ It's a release for minitest compatibility and bug fix.
 
   * Allowed use of test for inheritance in ActionController::TestCase.
     [GitHub#42] [Patch by David Rasch]
-  * Ensured evaluating at_exist block in top level.
+  * Ensured evaluating at_exit block in top level.
     In IRB context, exit() specifies irb_exit().
     [test-unit-users-en:00089] [Reported by Daniel Berger]
   * Fixed a bug that decoration style description is ignored.