README.md in raap-0.4.0 vs README.md in raap-0.5.0

- old
+ new

@@ -1,8 +1,8 @@ # RaaP -![Jacket](https://raw.githubusercontent.com/ksss/raap/main/public/DALL%C2%B7E%202024-03-23%2000.02.29%20-%20Imagine%20a%20scene%20where%20the%20abstract%20concepts%20of%20Ruby%20programming%20and%20property-based%20testing%20blend%20harmoniously.%20Picture%20a%20large%2C%20glowing%20ruby%20crystal%2C%20.webp) +<img src="https://raw.githubusercontent.com/ksss/raap/main/public/jacket.webp" width=400/> ## RBS as a Property RaaP is a property based testing tool. @@ -68,12 +68,21 @@ ``` $ 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 +$ raap 'MyClass' '!MyClass#skip' # Run method MyClass without #skip ``` +``` +$ cat test/raap.txt +MyClass +!MyClass#skip + +$ raap $(cat test/raap.txt) # You can manage the methods to be tested in a file +``` + ## Size Random values are determined based on size. For example, an Integer with size zero is `0` and an Array is `[]`. @@ -101,16 +110,20 @@ You can specify to load specify PATH as RBS. ### `--library lib` -You can specify to load RBS library +You can specify to load RBS library. ### `--require lib` -You can specify require Ruby library +You can specify require Ruby library. +### `--log-level level` + +You can specify log level (debug, info, warn or error). + ### `--timeout sec` You can specify the number of seconds to consider a test case as a timeout. ### `--size-from int` @@ -122,9 +135,14 @@ You can specify size of end. ### `--size-by int` You can specify size of step like `Integer#step: (to: Integer, by: Integer)`. + +### `--allow-private` + +By default, raap only validates public methods. +However, by setting this option, it is possible to intentionally validate private methods in the RBS. ## First support is CLI In RaaP, usage through the CLI is the primary support focus, and efforts are made to maintain compatibility. The use of the library's code (such as `RaaP::Type`) does not guarantee compatibility.