Merge pull request #17 from ohbarye/docs

Documentation 📖

CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [0.1.0] - 2024-04-13
+
+- Implement basic primitive arbitraries
+- Implement composite arbitraries
+- Support shrinking
+- Support multiple concurrency methods
+    - Ractor
+    - Process
+    - Thread
+    - None (Run tests sequentially)
+- Documentation
+    - Add better examples
+    - Arbitrary usage
+    - Configuration
+
 ## [0.0.1] - 2024-01-27
 
-- Initial release
+- Initial release (Proof of concept)

README.md

@@ -1,130 +1,291 @@
 # Property-Based Testing in Ruby
 
-⚠️ This gem is currently in the proof of concept phase. It's experimental and not production quality for now!
+[![Gem Version](https://badge.fury.io/rb/pbt.svg)](https://rubygems.org/gems/pbt)
+[![Build Status](https://github.com/ohbarye/pbt/actions/workflows/main.yml/badge.svg)](https://github.com/ohbarye/pbt/actions/workflows/main.yml)
+[![RubyDoc](https://img.shields.io/badge/%F0%9F%93%9ARubyDoc-documentation-informational.svg)](https://www.rubydoc.info/gems/pbt)
 
-A property-based testing tool for Ruby, utilizing Ractor for parallelizing test cases.
+An experimental property-based testing tool for Ruby that allows you to run test cases in parallel.
+
+PBT stands for Property-Based Testing.
+
+## What's Property-Based Testing?
+
+Property-Based Testing is a testing methodology that focuses on the properties a system should always satisfy, rather than checking individual examples. Instead of writing tests for predefined inputs and outputs, PBT allows you to specify the general characteristics that your code should adhere to and then automatically generates a wide range of inputs to verify these properties.
+
+The key benefits of property-based testing include the ability to cover more edge cases and the potential to discover bugs that traditional example-based tests might miss. It's particularly useful for identifying unexpected behaviors in your code by testing it against a vast set of inputs, including those you might not have considered.
+
+For a more in-depth understanding of Property-Based Testing, please refer to external resources.
+
+- Original ideas
+  - [Property-based testing of privileged programs](https://ieeexplore.ieee.org/document/367311) (1994)
+  - [Property-based testing: a new approach to testing for assurance](https://dl.acm.org/doi/abs/10.1145/263244.263267) (1997)
+  - [QuickCheck: a lightweight tool for random testing of Haskell programs](https://dl.acm.org/doi/10.1145/351240.351266) (2000)
+- Rather new introductory resources
+  - Fred Hebert's book [Property-Based Testing With PropEr, Erlang and Elixir](https://propertesting.com/).
+  - [fast-check - Why Property-Based?](https://fast-check.dev/docs/introduction/why-property-based/)
 
 ## Installation
 
-```shell
-$ gem install pbt
+Add this line to your application's Gemfile and run `bundle install`.
+
+```ruby
+gem 'pbt'
 ```
 
-If you want to use concurrency methods other than Ractor (`process`, `thread`), you need to install [parallel](https://github.com/grosser/parallel) gem as well.
+If you want to use multi-processes or multi-threads (other than Ractor) as workers to run tests, install the [parallel](https://github.com/grosser/parallel) gem.
 
-```shell
-$ gem install parallel
+```ruby
+gem 'parallel'
 ```
 
-## Usage
+Off course you can install with `gem intstall pbt`.
+
+## Basic Usage
+
+### Simple property
 
 ```ruby
 # Let's say you have a method that returns just a multiplicative inverse.
 def multiplicative_inverse(number)
   Rational(1, number)
 end
 
-RSpec.describe Pbt do
-  it "works" do
-    Pbt.assert do
-      # The given block is executed 100 times with different random numbers.
-      # Besides, the block runs in parallel by Ractor.
-      Pbt.property(Pbt.integer) do |number|
-        result = multiplicative_inverse(number)
-        raise "Result should be the multiplicative inverse of the number" if result * number != 1
-      end
-    end
-
-    # If the function has a bug, the test fails with a counterexample.
-    # For example, the multiplicative_inverse method doesn't work for 0 regardless of the behavior is intended or not.
-    #
-    # Pbt::PropertyFailure:
-    #   Property failed after 23 test(s)
-    #   { seed: 11001296583699917659214176011685741769 }
-    #   Counterexample: 0
-    #   Shrunk 3 time(s)
-    #   Got ZeroDivisionError: divided by 0
+Pbt.assert do
+  # The given block is executed 100 times with different random numbers.
+  # Besides, the block runs in parallel by Ractor.
+  Pbt.property(Pbt.integer) do |number|
+    result = multiplicative_inverse(number)
+    raise "Result should be the multiplicative inverse of the number" if result * number != 1
   end
 end
+
+# If the function has a bug, the test fails with a counterexample.
+# For example, the multiplicative_inverse method doesn't work for 0 regardless of the behavior is intended or not.
+#
+# Pbt::PropertyFailure:
+#   Property failed after 23 test(s)
+#   { seed: 11001296583699917659214176011685741769 }
+#   Counterexample: 0
+#   Shrunk 3 time(s)
+#   Got ZeroDivisionError: divided by 0
 ```
 
+### Explain The Snippet
+
+The above snippet is very simple but contains the basic components.
+
+#### Runner
+
+`Pbt.assert` is the runner. The runner interprets and executes the given property. `Pbt.assert` takes a property and runs it multiple times. If the property fails, it tries to shrink the input that caused the failure.
+
+#### Property
+
+The snippet above declared a property by calling `Pbt.property`. The property describes the following:
+
+1. What the user wants to evaluate. This corresponds to the block (let's call this `predicate`) enclosed by `do` `end`
+2. How to generate inputs for the predicate — using `Arbitrary`
+
+The `predicate` block is a function that directly asserts, taking values generated by `Arbitrary` as input.
+
+#### Arbitrary
+
+Arbitrary generates random values. It is also responsible for shrinking those values if asked to shrink a failed value as input.
+
+Here, we used only one type of arbitrary, `Pbt.integer`. There are many other built-in arbitraries, and you can create a variety of inputs by combining existing ones.
+
+#### Shrink
+
+In PBT, If a test fails, it attempts to shrink the case that caused the failure into a form that is easier for humans to understand.
+In other words, instead of stopping the test itself the first time it fails and reporting the failed value, it tries to find the minimal value that causes the error.
+
+When there is a test that fails when given an even number, a counterexample of `2` is simpler and easier to understand than `432743417662`.
+
 ### Arbitrary
 
-TBA
+There are many built-in arbitraries in `Pbt`. You can use them to generate random values for your tests. Here are some representative arbitraries.
+
+#### Primitives
+
+```ruby
+rng = Random.new(
 
-### Configuration
+Pbt.integer.generate(rng) # => 42
+Pbt.integer(min: -1, max: 8).generate(rng) # => Integer between -1 and 8
 
-TBA
+Pbt.symbol.generate(rng) # => :atq
 
-### Concurrent methods
+Pbt.ascii_char.generate(rng) # => "a"
+Pbt.ascii_string.generate(rng) # => "aagjZfao"
 
-Pbt supports 3 concurrency methods and 1 sequential one. You can choose one of them by setting the `concurrency_method` option.
+Pbt.boolean.generate(rng) # => true or false
+Pbt.constant(42).generate(rng) # => 42 always
+```
 
-#### Ractor
+#### Composites
 
 ```ruby
-Pbt.assert(params: { concurrency_method: :ractor }) do
-  Pbt.property(Pbt.integer) do |number|
+rng = Random.new
+
+Pbt.array(Pbt.integer).generate(rng) # => [121, -13141, 9825]
+Pbt.array(Pbt.integer, max: 1, empty: true).generate(rng) # => [] or [42] etc.
+
+Pbt.tuple(Pbt.symbol, Pbt.integer).generate(rng) # => [:atq, 42]
+
+Pbt.fixed_hash(x: Pbt.symbol, y: Pbt.integer).generate(rng) # => {x: :atq, y: 42}
+Pbt.hash(Pbt.symbol, Pbt.integer).generate(rng) # => {atq: 121, ygab: -1142}
+
+Pbt.one_of(:a, 1, 0.1).generate(rng) # => :a or 1 or 0.1
+````
+
+See [ArbitraryMethods](https://github.com/ohbarye/pbt/blob/main/lib/pbt/arbitrary/arbitrary_methods.rb) module for more details.
+
+## Configuration
+
+You can configure `Pbt` by calling `Pbt.configure` before running tests.
+
+```ruby
+Pbt.configure do |config|
+  # Whether to print verbose output. Default is `false`.
+  config.verbose = 100
+
+  # The concurrency method to use. :ractor`, `:thread`, `:process` and `:none` are supported. Default is `:ractor`.
+  config.worker = :ractor
+
+  # The number of runs to perform. Default is `100`.
+  config.num_runs = 100
+
+  # The seed to use for random number generation.
+  # It's useful to reproduce failed test with the seed you'd pick up from failure messages. Default is a random seed.
+  config.seed = 42
+
+  # Whether to report exceptions in threads.
+  # It's useful to suppress error logs on Ractor that reports many errors. Default is `false`.
+  config.thread_report_on_exception = false
+end
+```
+
+Or, you can pass the configuration to `Pbt.assert` as an argument.
+
+```ruby
+Pbt.assert(num_runs: 100, seed: 42) do
+  # ...
+end
+```
+
+## Concurrent methods
+
+One of the key features of `Pbt` is its ability to rapidly execute test cases in parallel or concurrently, using a large number of values (by default, `100`) generated by `Arbitrary`.
+
+For concurrent processing, you can specify any of the three workers—`:ractor`, `:process`, or `:thread`—using the `worker` option. Alternatively, choose `:none` for serial execution.
+
+`Pbt` supports 3 concurrency methods and 1 sequential one. You can choose one of them by setting the `worker` option.
+
+### Ractor
+
+```ruby
+Pbt.assert(worker: :ractor) do
+  Pbt.property(Pbt.integer) do |n|
     # ...
   end
 end
 ```
 
-#### Process
+#### Limitation
+
+Please note that Ractor support is an experimental feature of this gem. Due to Ractor's limitations, you may encounter some issues when using it.
+
+For example, you cannot access anything out of block.
 
 ```ruby
-Pbt.assert(params: { concurrency_method: :process }) do
-  Pbt.property(Pbt.integer) do |number|
+a = 1
+
+Pbt.assert(worker: :ractor) do
+  Pbt.property(Pbt.integer) do |n|
+    # You cannot access `a` here because this block is executed in a Ractor and it doesn't allow implicit sharing of objects.
+    a + n # => Ractor::RemoteError (can not share object between ractors)
+  end
+end
+```
+
+You cannot use any methods provided by test frameworks like `expect` or `assert` because they are not available in a Ractor.
+
+```ruby
+it do
+  Pbt.assert(worker: :ractor) do
+    Pbt.property(Pbt.integer) do |n|
+      # This is not possible because `self` if a Ractor here.
+      expect(n).to be_an(Integer) # => Ractor::RemoteError (cause by NoMethodError for `expect` or `be_an`)
+    end
+  end
+end
+```
+
+### Process
+
+```ruby
+Pbt.assert(worker: :process) do
+  Pbt.property(Pbt.integer) do |n|
     # ...
   end
 end
 ```
 
-#### Thread
+### Thread
 
 ```ruby
-Pbt.assert(params: { concurrency_method: :thread }) do
-  Pbt.property(Pbt.integer) do |number|
+Pbt.assert(worker: :thread) do
+  Pbt.property(Pbt.integer) do |n|
     # ...
   end
 end
 ```
 
-#### None
+### None
 
 ```ruby
-Pbt.assert(params: { concurrency_method: :none }) do
-  Pbt.property(Pbt.integer) do |number|
+Pbt.assert(worker: :none) do
+  Pbt.property(Pbt.integer) do |n|
     # ...
   end
 end
 ```
 
 ## TODOs
 
-- [x] Enable to combine arbitraries (e.g. `Pbt.array(Pbt.integer)`)
+Once this project finishes the following, we will release v1.0.0.
+
+- [x] Implement basic primitive arbitraries
+- [x] Implement composite arbitraries
 - [x] Support shrinking
-- [x] Implement basic arbitraries
-  - https://proper-testing.github.io/apidocs/
-  - https://fast-check.dev/docs/core-blocks/arbitraries/
 - [x] Support multiple concurrency methods
   - [x] Ractor
   - [x] Process
   - [x] Thread
   - [x] None (Run tests sequentially)
+- [x] Documentation
+  - [x] Add better examples
+  - [x] Arbitrary usage
+  - [x] Configuration
 - [ ] Rich report like verbose mode
-- [ ] Allow to use assertions provided by RSpec etc. if possible
-  - It'd be so hard to pass assertions like `expect`, `assert` to a Ractor. But it's worth trying at least for `process`, `thread` concurrency methods.
-- [ ] Documentation
-  - [ ] Add better examples
-  - [ ] Arbitrary usage
-  - [ ] Configuration
+- [ ] Allow to use expectations and matchers provided by test framework in Ractor if possible.
+  - It'd be so hard to pass assertions like `expect`, `assert` to a Ractor.
+- [ ] Benchmark
+- [ ] More parallelism or faster execution if possible
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Setup
+
+```shell
+bin/setup
+bundle exec rake # Run tests and lint at once
+```
 
-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).
+### Test
+
+```shell
+bundle exec rspec
+```
 
 ### Lint
 
@@ -134,12 +295,24 @@ bundle exec rake standard:fix
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ohbarye/pbt. 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/[USERNAME]/pbt/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ohbarye/pbt. 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/ohbarye/pbt/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+## Credits
+
+This project draws a lot of inspiration from other testing tools, namely
+
+- [fast-check](https://fast-check.dev/)
+- [Loupe](https://github.com/vinistock/loupe)
+- [RSpec](https://github.com/rspec/rspec)
+- [Minitest](https://github.com/seattlerb/minitest)
+- [Parallel](https://github.com/grosser/parallel)
+- [PropCheck for Ruby](https://github.com/Qqwy/ruby-prop_check)
+- [PropCheck for Elixir](https://github.com/alfert/propcheck)
+
 ## Code of Conduct
 
 Everyone interacting in the Pbt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ohbarye/pbt/blob/master/CODE_OF_CONDUCT.md).