# RaaP

## RBS as a Property

RaaP is a property based testing tool.

RaaP considers the RBS as a test case.

It generates random values for the method arguments for each type, and then calls the method.

The return value of the method is checked to see if it matches the type, if not, the test fails.

If you write an RBS, it becomes a test case.

## Installation

TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

## Usage

```
$ raap 'MyClass'                  # Run only RBS of MyClass
$ raap 'MyClass::*'               # Run each class under MyClass
$ raap 'MyClass.singleton_method' # Run only MyClass.singleton_method
$ raap 'MyClass#instance_method'  # Run only MyClass#instance_method
```

## Size

Random values are determined based on size.

For example, an Integer with size zero is `0` and an Array is `[]`.

RaaP, like other property-based tests, changes the size 100 times from 0 to 99 by default to generate test data.

## Options

### `-I PATH` or `--include PATH`

You can specify to load specify PATH as RBS.

### `--library lib`

You can specify to load RBS library

### `--require lib`

You can specify require Ruby library

### `--timeout sec`

You can specify the number of seconds to consider a test case as a timeout.

### `--size-from int`

You can specify size of start.

### `--size-to int`

You can specify size of end.

### `--size-by int`

You can specify size of step like `Integer#step: (to: Integer, by: Integer)`.

## Achievements

RaaP has already found many RBS mistakes and bug in CRuby during the development phase.

* https://github.com/ruby/rbs/pull/1704
* https://github.com/ruby/rbs/pull/1706
* https://bugs.ruby-lang.org/issues/20292
* https://github.com/ruby/rbs/pull/1768
* https://github.com/ruby/rbs/pull/1769
* https://github.com/ruby/rbs/pull/1770
* https://github.com/ruby/rbs/pull/1771

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ksss/raap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ksss/raap/blob/main/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Raap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ksss/raap/blob/main/CODE_OF_CONDUCT.md).

# TODO

- Embed testing tool.
- Implement skip solution.
- Configure by YAML?
- Support recursive type.