Skip to content

Commit 9c3825a

Browse files
committed
Change Ruby Test to Rubytest. [doc]
1 parent 3ab59e3 commit 9c3825a

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Ruby Test
1+
# Rubytest
22

33
[Homepage](http://rubyworks.github.com/rubytest) /
44
[User Guide](http://wiki.github.com/rubyworks/rubytest) /
@@ -11,25 +11,27 @@
1111

1212
## Description
1313

14-
Ruby Test is a universal test harness for Ruby developers. You can think
15-
of Ruby Test as a *meta test framework*. It defines a straight-forward
16-
specification that any test framework can utilize as it's back-end.
17-
This makes it almost trivial to implement new test frameworks. Ruby Test
18-
further allows tests from various frameworks to all run through a single
19-
uniform user interface in a single pass.
14+
Rubytest is a universal test harness for Ruby development. Think
15+
of Rubytest as a *testing meta-framework*. It defines a straight-forward
16+
specification that anyone can use to create their own testing DSLs
17+
quickily and easily. This can be used for testing end applcations or it
18+
can be used by test framework as a backend.
19+
In addition, since all Rubytest controls the backend, multiple frameworks
20+
can be used in a single test suite all of which can run through a single
21+
uniform interface in a process.
2022

2123

2224
## Specification
2325

2426
The universal access point for testing is the `$TEST_SUITE` global array. A test
2527
framework need only add compliant test objects to `$TEST_SUITE`.
26-
Ruby Test will iterate through these objects. If a test object responds to
28+
Rubytest will iterate through these objects. If a test object responds to
2729
`#call`, it is run as a test procedure. If it responds to `#each` it is iterated
2830
over as a test case with each entry handled in the same manner. All test
2931
objects must respond to `#to_s` so their description can be used in test
3032
reports.
3133

32-
Ruby Test handles assertions with [BRASS](http://rubyworks.github.com/brass)
34+
Rubytest handles assertions with [BRASS](http://rubyworks.github.com/brass)
3335
compliance. Any raised exception that responds to `#assertion?` in the
3436
affirmative is taken to be a failed assertion rather than simply an error.
3537
A test framework may raise a `NotImplementedError` to have a test recorded
@@ -40,18 +42,18 @@ to indicate the urgency of the pending test. Priorities of -1 or lower
4042
will generally not be brought to the attention of testers unless explicitly
4143
configured to do so.
4244

43-
That is the crux of Ruby Test specification. Ruby Test supports some
45+
That is the crux of Rubytest specification. Rubytest supports some
4446
additional features that can makes its usage even more convenient.
4547
See the [Wiki](http://github.com/rubyworks/test/wiki) for further details.
4648

4749

4850
## Installation
4951

50-
Ruby Test is available as a Gem package.
52+
Rubytest is available as a Gem package.
5153

5254
$ gem install rubytest
5355

54-
Ruby Test is compliant with Setup.rb layout standard, so it can
56+
Rubytest is compliant with Setup.rb layout standard, so it can
5557
also be installed in an FHS compliant fashion if necessary.
5658

5759

@@ -61,8 +63,8 @@ There are a few ways to run tests.
6163

6264
### Via Runner Scripts
6365

64-
Out of the box Ruby Test doesn't provide any special means for doing so,
65-
you simply write you own runner script using the Ruby Test API.
66+
Out of the box Rubytest doesn't provide any special means for doing so,
67+
you simply write you own runner script using the Rubytest API.
6668
Here is the basic example:
6769

6870
require 'rubytest'
@@ -119,7 +121,7 @@ See the Wiki for more detailed information on the different ways to run tests.
119121

120122
## Requirements
121123

122-
Ruby Test uses the [ANSI](http://rubyworks.github.com/ansi) gem for color output.
124+
Rubytest uses the [ANSI](http://rubyworks.github.com/ansi) gem for color output.
123125

124126
Because of the "foundational" nature of this library we will look at removing
125127
this dependency for future versions, but for early development the
@@ -128,9 +130,9 @@ requirements does the job and does it well.
128130

129131
## Development
130132

131-
Ruby Test is still a bit of a "nuby" gem. Please feel OBLIGATED to help improve it ;-)
133+
Rubytest is still a bit of a "nuby" gem. Please feel OBLIGATED to help improve it ;-)
132134

133-
Ruby Test is a [Rubyworks](http://rubyworks.github.com) project. If you can't
135+
Rubytest is a [Rubyworks](http://rubyworks.github.com) project. If you can't
134136
contribute code, you can still help out by contributing to our development fund.
135137

136138

0 commit comments

Comments
 (0)