File: README.md

package info (click to toggle)
ruby-minitest-power-assert 0.3.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 104 kB
  • sloc: ruby: 82; makefile: 4
file content (58 lines) | stat: -rw-r--r-- 1,884 bytes parent folder | download
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
# Minitest::PowerAssert

[![Gem Version](https://badge.fury.io/rb/minitest-power_assert.svg)](https://rubygems.org/gems/minitest-power_assert)
[![Build Status](https://travis-ci.org/hsbt/minitest-power_assert.svg)](https://travis-ci.org/hsbt/minitest-power_assert)

A Power Assert implementation for Minitest. This gem is inspired by the [test-unit-power_assert](https://github.com/k-tsj/test-unit-power_assert) gem.

## Installation

Add this line to your application's Gemfile:

    gem 'minitest-power_assert'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install minitest-power_assert

## Usage

see [testcase](https://github.com/hsbt/minitest-power_assert/blob/master/test/test_power_assert.rb)

### Basic Testcase

The `minitest-power_assert` gem overrides the `#assert` method. In order to use power assert, call the assert method with a block:

```ruby
class TestPowerAssert < Minitest::Test
  def test_power_assert_failed
    assert { "0".class == "3".to_i.times.map {|i| i + 1 }.class }
  end
end
```

If the test above fails, it displays a test result with detailed information about variables:

```shell
  1) Failure:
TestPowerAssert#test_power_assert_failed [test/test_power_assert.rb:10]:
    assert { "0".class == "3".to_i.times.map {|i| i + 1 }.class }
                 |            |    |     |                |
                 |            |    |     |                Array
                 |            |    |     [1, 2, 3]
                 |            |    #<Enumerator: 3:times>
                 |            3
                 String
```

## Contributing

1. Fork it ( https://github.com/hsbt/minitest-power_assert/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request