File: README.markdown

package info (click to toggle)
ruby-contest 0.1.3-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 112 kB
  • sloc: ruby: 196; makefile: 2
file content (116 lines) | stat: -rw-r--r-- 2,830 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
Contest
=======

Contexts for Test::Unit.

Description
-----------

Write declarative tests using nested contexts without performance penalties. Contest is less than 100 lines of code and gets the job done.

Usage
-----

Declare your tests as you would in RSpec or Shoulda:

    require 'contest'

    class SomeTest < Test::Unit::TestCase
      setup do
        @value = 1
      end

      teardown do
        @value = nil
      end

      test "sample test" do
        assert_equal 1, @value
      end

      context "a context" do
        setup do
          @value += 1
        end

        test "more tests" do
          assert_equal 2, @value
        end

        context "a nested context" do
          setup do
            @value += 1
          end

          test "yet more tests" do
            assert_equal 3, @value
          end
        end
      end
    end

For your convenience, `context` is aliased as `describe` and `test` is aliased as `should`, so this is valid:

    class SomeTest < Test::Unit::TestCase
      setup do
        @value = 1
      end

      describe "something" do
        setup do
          @value += 1
        end

        should "equal 2" do
          assert_equal 2, @value
        end
      end
    end

You can run it normally, it's Test::Unit after all. If you want to run a particular test, say "yet more tests", try this:

    $ testrb my_test.rb -n test_yet_more_tests

Or with a regular expression:

    $ testrb my_test.rb -n /yet_more_tests/

Installation
------------

    $ sudo gem install contest

If you want to use it with Rails, add this to config/environment.rb:

    config.gem "contest"

Then you can vendor the gem:

    rake gems:install
    rake gems:unpack

License
-------

Copyright (c) 2009 Damian Janowski and Michel Martens for Citrusbyte

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.