test-unit 3.1.5 → 3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 86673156c68b86e03890136de7cac26b04ebf6ba
-  data.tar.gz: e2e15e416b83d09eee253273f981ef4a9c2566f5
+SHA256:
+  metadata.gz: 229f08041ec90505679800d12fdf5fca1f70623f5d4b91b54ee5e75bb171efe5
+  data.tar.gz: 5d51111b001089cf72b69c4df3e11a8d590e8be03497ffa22b9f5bc48219296a
 SHA512:
-  metadata.gz: e6d3ea4e758eb002dad57e91d1db3a7f71ff12e1a6428c115db9c619cbd9b054606f74a8b9aeed216c6ab9d9a37d257d6f4521d9dcfbfa60966073c41b0b67fc
-  data.tar.gz: 09d14bdfc97c567d50c1b2feaac261cad406256c86bbe9be809c48f012dd845a76be20bd94e29190ce77580bfee96ddbc94f0f309b990eb97521cd22d72b9b59
+  metadata.gz: 2b655e8a13f61513ef4b4574766fb94003416890d3b30f1bed2831c2a48d6606705752bb100dd15bbdcfcdc76f2c87bd8c086b8b7b6c6223982e81b93e9d91c4
+  data.tar.gz: 16293a67ec4a26eb23c7f57784dba2ef5c76f5fb952645a7a1654db217f4e12791424ca6264395ae7c2669560af3ecbc560f23ae27c7cdbaa7268474911d519d

data/BSDL

@@ -0,0 +1,24 @@
+Copyright (C) 2003-2007 Nathaniel Talbott. All rights reserved.
+Copyright (C) 2008 Ryan Davis. All rights reserved.
+Copyright (C) 2008-2020 Sutou Kouhei. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/COPYING

@@ -2,63 +2,63 @@ test-unit is copyrighted free software by Kouhei Sutou
 <kou@cozmixng.org>, Ryan Davis <ryand-ruby@zenspider.com>
 and Nathaniel Talbott <nathaniel@talbott.ws>.
 
-You can redistribute it and/or modify it under either the terms of the GPL
-version 2 (see the file GPL), or the conditions below:
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
 
-  1. You may make and give away verbatim copies of the source form of the
-     software without restriction, provided that you duplicate all of the
-     original copyright notices and associated disclaimers.
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
 
-  2. You may modify your copy of the software in any way, provided that
-     you do at least ONE of the following:
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
 
-       a) place your modifications in the Public Domain or otherwise
-          make them Freely Available, such as by posting said
-	  modifications to Usenet or an equivalent medium, or by allowing
-	  the author to include your modifications in the software.
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
 
-       b) use the modified software only within your corporation or
-          organization.
+   b. use the modified software only within your corporation or
+      organization.
 
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
 
-       d) make other distribution arrangements with the author.
+   d. make other distribution arrangements with the author.
 
-  3. You may distribute the software in object code or binary form,
-     provided that you do at least ONE of the following:
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
 
-       a) distribute the binaries and library files of the software,
-	  together with instructions (in the manual page or equivalent)
-	  on where to get the original distribution.
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
 
-       b) accompany the distribution with the machine-readable source of
-	  the software.
+   b. accompany the distribution with the machine-readable source of
+      the software.
 
-       c) give non-standard binaries non-standard names, with
-          instructions on where to get the original software distribution.
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
 
-       d) make other distribution arrangements with the author.
+   d. make other distribution arrangements with the author.
 
-  4. You may modify and include the part of the software into any other
-     software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under these terms.
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
 
-     For the list of those files and their copying conditions, see the
-     file LEGAL.
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
 
-  5. The scripts and library files supplied as input to or produced as 
-     output from the software do not automatically fall under the
-     copyright of the software, but belong to whomever generated them, 
-     and may be sold commercially, and may be aggregated with this
-     software.
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
 
-  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
-     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-     PURPOSE.
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.
 
 Exceptions
 ----------
 
-  * lib/test/unit/diff.rb: PSFL
+  * lib/test/unit/diff.rb: This license and PSF license

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)
+[![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+)
 
 * http://test-unit.github.io/
 * https://github.com/test-unit/test-unit
@@ -10,31 +10,42 @@
 
 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.
 
+test-unit ships as part of Ruby as a bundled gem. To check which version is included, see https://stdgems.org/test-unit/.
+It's only necessary to install the gem if you need a newer version.
+
+test-unit is the original Ruby unit testing library, and is still active.
+It is one of two unit testing libraries bundled with Ruby, the other being [minitest](https://github.com/minitest/minitest).
+
+When deciding which to use, consider:
+
+* test-unit is strict about backwards compatibility. A backwards-incompatible change would be considered a bug.
+* test-unit aims to support old Ruby versions, even if EOL.
+
 ## 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
+  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
   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 +54,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
@@ -51,17 +62,13 @@ If you want to use full Test::Unit features:
 
 ## License
 
-(The Ruby License)
-
-This software is distributed under the same terms as ruby.
+This software is distributed under either the terms of new Ruby
+License or BSDL. See the file [COPYING](COPYING).
 
 Exception:
 
-  * lib/test/unit/diff.rb is a double license of the Ruby license and
-    PSF license.
-
-  * lib/test-unit.rb is a dual license of the Ruby license and LGPLv2.1
-    or later.
+  * lib/test/unit/diff.rb is a triple license of (the new Ruby license
+    or BSDL) and PSF license.
 
 ## Authors
 
@@ -77,7 +84,7 @@ Exception:
 
 ### Images
 
-* Mayu & Co.: kinotan icons: http://cocooooooon.com/kinotan/
+* Mayu & Co.: kinotan icons
 
 ## Thanks
 

data/Rakefile

@@ -1,23 +1,18 @@
 # -*- ruby -*-
 #
-# Copyright (C) 2008-2013  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
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+# Copyright (C) 2008-2017  Kouhei Sutou <kou@clear-code.com>
 
 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"
@@ -29,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
@@ -58,14 +52,17 @@ 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
+
+namespace :doc do
+  task :add_permalink do
+    news_md = File.read("doc/text/news.md")
+    applied_permalink = news_md.gsub(/(?<pre>\[GitHub#(?<ref>\d+)\])(?!\()/) do
+      "#{Regexp.last_match[:pre]}(https://github.com/test-unit/test-unit/issues/#{Regexp.last_match[:ref]})"
+    end
+
+    File.write("doc/text/news.md", applied_permalink)
+  end
+end

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 information
+
+Let's read the official document.
+
+* [test-unit](https://test-unit.github.io/index.html)