<commit_before># RSpec On Tap

[Homepage](http://rubyworks.github.com/rspec-ontap) |
[Source Code](http://github.com/rubyworks/rspec-ontap) |
[Report Issue](http://github.com/rubyworks/rspec-ontap/issues)


## Description

**RSpec On Tap** is a TAP-Y/J formatter for RSpec.

The latest version works with **RSpec 3+ only**.

You can learn more about TAP-Y/J [here](https://github.com/rubyworks/tapout).


## Usage

Usage is simply a matter of requiring the plugin and passing the name of the
format class to the `rspec` command via the `-f` option.

    $ rspec -r rspec/ontap -f RSpec::TapY spec/*.rb

This can be shortened to just:

    $ rspec -f RSpec::TapY spec/*.rb

This works because RSpec will automatically require a related path (in this
case `rspec/tap_y`) is the class if not initially undefined. The library file
`rspec/tap_y` itself simple requires `rspec/ontap`. The same is true for
`rspec/tap_j`.

With TAP-Y output in hand, the `tapout` tool can then be used to produce a
variety of other output formats. First make sure Tapout is installed.

    $ gem install tapout

The, for example:

    $ rspec -f RSpec::TapY spec/*.rb | tapout progress

See the [TapOut project](http://rubyworks.github.com/tapout) for more information.



## Installation

Installation follows the usual pattern:

    $ gem install rspec-ontap


## Copyrights

Copyright (c) 2011 Rubyworks. All Rights Reserved.

RSpecOnTap is distributable in accordance with the *FreeBSD* license.

See LICENSE.txt for details.

<commit_msg>:doc: Update README.<commit_after># RSpec On Tap

[Homepage](http://rubyworks.github.com/rspec-ontap) |
[Source Code](http://github.com/rubyworks/rspec-ontap) |
[Report Issue](http://github.com/rubyworks/rspec-ontap/issues)


## Description

**RSpec On Tap** is a TAP-Y/J formatter for RSpec.

The latest version works with **RSpec 3+ only**.

You can learn more about TAP-Y/J [here](https://github.com/rubyworks/tapout).


## Usage

Usage is simply a matter of requiring the plugin and passing the name of the
format class to the `rspec` command via the `-f` option.

    $ rspec -r rspec/ontap -f RSpec::TapY spec/*.rb

This can be shortened to just:

    $ rspec -f RSpec::TapY spec/*.rb

This works because RSpec will automatically require a related path -- in this
case `rspec/tap_y` -- if the class if initially undefined. The library file
`rspec/tap_y` itself simply requires `rspec/ontap` (the same is true for
`rspec/tap_j`).

With TAP-Y output in hand, the `tapout` tool can then be used to produce a
variety of other output formats. First, make sure Tapout is installed:

    $ gem install tapout

Then, for example:

    $ rspec -f RSpec::TapY spec/*.rb | tapout progress

See the [TapOut project](http://rubyworks.github.com/tapout) for more information.



## Installation

Installation follows the usual pattern:

    $ gem install rspec-ontap

Or using your Gemfile, add something like:

    group :test do
      gem "rspec-ontap", :require => false
    end


## Copyrights

Copyright (c) 2011 Rubyworks. All Rights Reserved.

RSpecOnTap is distributable in accordance with the *FreeBSD* license.

See LICENSE.txt for details.


{'fraction_non_alphanumeric': 0.10275055327220993, 'fraction_numerical': 0.003161555485298767, 'mean_word_length': 3.750750750750751, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5639048', 'n_tokens_mistral': 1068, 'n_tokens_neox': 1001, 'n_words': 388}