pbt 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1a5d4c94783e479474b521113dcad84959db11c6139780031cf52aff6748e61
-  data.tar.gz: eb112f231d4417963341fb36b585c9b0d4fa8b14f0ac726c51b80c7424542cb1
+  metadata.gz: 129484c73e5be7741c4bbf70c2ab374a0e48f28926c3cd4b6b3ca004c1037b98
+  data.tar.gz: 83ec64585e4b33bfad802b262784b0507f341621764099279af3f6faeda273fa
 SHA512:
-  metadata.gz: e40bde143e84c6ed1fa76cf69f3ed93261bcdae70a229359ea996190c63c24ff9b7155f9974a0d4a39c8430fb17e935539631e463a072af30439b5805c939021
-  data.tar.gz: d082a2078753d09bf19a1bfc41931258a19db3842590c7f366a1f5fece9097b3a6668db096baa9a679ab0026df05e45ac1f03f14ceca0f1b7aeb635bc1f82c83
+  metadata.gz: 3c61fa019e0aff56404f4c3346b039615c368e175e98407f118be9ef55060e61f4ebacbd6cec79b5e0834cfec2550fdbdf6952be47eeacb1437455f5fd54dd5b
+  data.tar.gz: 209b104767846e73d8db2b94d0b4c9e2e9528c695e9d4cb766d6845de7e8c1556e523b172461c693c77e6deea3f0a764dd51c8e2a17611a2914760146e399bcc

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.4.2] - 2024-05-23
+
+- Fix Prism `LoadError` message [#27](https://github.com/ohbarye/pbt/pull/27) by @sambostock
+ 
 ## [0.4.1] - 2024-05-10
 
 - Fix a bug for experimental_ractor_rspec_integration mode. When a test file name starts with a number, it can't be a constant name.

data/README.md

@@ -8,6 +8,8 @@ A property-based testing tool for Ruby with experimental features that allow you
 
 PBT stands for Property-Based Testing.
 
+As for the results of the parallelization experiment, please refer the talk at RubyKaigi 2024: [Unlocking Potential of Property Based Testing with Ractor](https://rubykaigi.org/2024/presentations/ohbarye.html).
+
 ## 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.
@@ -39,29 +41,34 @@ Off course you can install with `gem intstall pbt`.
 ### Simple property
 
 ```ruby
-# Let's say you have a method that returns just a multiplicative inverse.
-def multiplicative_inverse(number)
-  Rational(1, number)
+# Let's say you have your own sort method.
+def sort(array)
+  return array if array.size <= 2 # Here's a bug! It should be 1.
+  pivot, *rest = array
+  left, right = rest.partition { |n| n <= pivot }
+  sort(left) + [pivot] + sort(right)
 end
 
 Pbt.assert do
-  # The given block is executed 100 times with different random numbers.
+  # The given block is executed 100 times with different arrays with 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
+  Pbt.property(Pbt.array(Pbt.integer)) do |numbers|
+    result = sort(numbers)
+    result.each_cons(2) do |x, y|
+      raise "Sort algorithm is wrong." unless x <= y
+    end
   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.
+# If the method has a bug, the test fails and it reports a minimum counterexample.
+# For example, the sort method doesn't work for [0, -1].
 #
 # Pbt::PropertyFailure:
 #   Property failed after 23 test(s)
-#   { seed: 11001296583699917659214176011685741769 }
-#   Counterexample: 0
-#   Shrunk 3 time(s)
-#   Got ZeroDivisionError: divided by 0
+#   seed: 43738985293126714007411539287084402325
+#   counterexample: [0, -1]
+#   Shrunk 40 time(s)
+#   Got RuntimeError: Sort algorithm is wrong.
 ```
 
 ### Explain The Snippet
@@ -92,7 +99,7 @@ Here, we used only one type of arbitrary, `Pbt.integer`. There are many other bu
 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`.
+When there is a test that fails when given an even number, a counterexample of `[0, -1]` is simpler and easier to understand than any complex example like `[-897860, -930517, 577817, -16302, 310864, 856411, -304517, 86613, -78231]`.
 
 ### Arbitrary
 
@@ -103,16 +110,16 @@ There are many built-in arbitraries in `Pbt`. You can use them to generate rando
 ```ruby
 rng = Random.new
 
-Pbt.integer.generate(rng) # => 42
+Pbt.integer.generate(rng)                  # => 42
 Pbt.integer(min: -1, max: 8).generate(rng) # => Integer between -1 and 8
 
-Pbt.symbol.generate(rng) # => :atq
+Pbt.symbol.generate(rng)                   # => :atq
 
-Pbt.ascii_char.generate(rng) # => "a"
-Pbt.ascii_string.generate(rng) # => "aagjZfao"
+Pbt.ascii_char.generate(rng)               # => "a"
+Pbt.ascii_string.generate(rng)             # => "aagjZfao"
 
-Pbt.boolean.generate(rng) # => true or false
-Pbt.constant(42).generate(rng) # => 42 always
+Pbt.boolean.generate(rng)                  # => true or false
+Pbt.constant(42).generate(rng)             # => 42 always
 ```
 
 #### Composites
@@ -120,15 +127,15 @@ Pbt.constant(42).generate(rng) # => 42 always
 ```ruby
 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.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.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.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
+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.
@@ -144,18 +151,18 @@ When a test fails, you'll see a message like below.
 ```text
 Pbt::PropertyFailure:
   Property failed after 23 test(s)
-  { seed: 11001296583699917659214176011685741769 }
-  Counterexample: 0
-  Shrunk 3 time(s)
-  Got ZeroDivisionError: divided by 0
+  seed: 43738985293126714007411539287084402325
+  counterexample: [0, -1]
+  Shrunk 40 time(s)
+  Got RuntimeError: Sort algorithm is wrong.
   # and backtraces
 ```
 
 You can reproduce the failure by passing the seed to `Pbt.assert`.
 
 ```ruby
-Pbt.assert(seed: 11001296583699917659214176011685741769) do
-  Pbt.property(Pbt.integer) do |number|
+Pbt.assert(seed: 43738985293126714007411539287084402325) do
+  Pbt.property(Pbt.array(Pbt.integer)) do |number|
     # your test
   end
 end
@@ -177,25 +184,29 @@ The verbose mode prints the results of each tested values.
 
 ```text
 Encountered failures were:
-- [152477, 666997, -531468, -92182, 623948, 425913, 656138, 856463, -64529]
-- [76239, 666997, -531468, -92182, 623948]
-- [76239, 666997, -531468]
+- [-897860, -930517, 577817, -16302, 310864, 856411, -304517, 86613, -78231]
+- [310864, 856411, -304517, 86613, -78231]
+- [-304517, 86613, -78231]
 (snipped for README)
-- [2, 163]
-- [2, 11]
+- [0, -3]
+- [0, -2]
+- [0, -1]
 
 Execution summary:
-. × [152477, 666997, -531468, -92182, 623948, 425913, 656138, 856463, -64529]
-. . √ [152477, 666997, -531468, -92182, 623948]
-. . √ [-64529]
-. . × [76239, 666997, -531468, -92182, 623948, 425913, 656138, 856463, -64529]
-. . . × [76239, 666997, -531468, -92182, 623948]
+. × [-897860, -930517, 577817, -16302, 310864, 856411, -304517, 86613, -78231]
+. . √ [-897860, -930517, 577817, -16302, 310864]
+. . √ [-930517, 577817, -16302, 310864, 856411]
+. . √ [577817, -16302, 310864, 856411, -304517]
+. . √ [-16302, 310864, 856411, -304517, 86613]
+. . × [310864, 856411, -304517, 86613, -78231]
 (snipped for README)
-. . . . . . . . . . . . . . . . . √ [2, 21]
-. . . . . . . . . . . . . . . . . × [2, 11]
-. . . . . . . . . . . . . . . . . . √ []
-. . . . . . . . . . . . . . . . . . √ [2, 1]
-. . . . . . . . . . . . . . . . . . √ [2, 0]
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . √ [-2]
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . √ []
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . × [0, -1]
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . √ [0]
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . √ [-1]
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . √ []
+. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . √ [0, 0]
 ```
 
 ## Configuration
@@ -365,6 +376,8 @@ Once this project finishes the following, we will release v1.0.0.
 - [ ] Implement frequency arbitrary
 - [ ] Statistics feature to aggregate generated values
 - [ ] Decide DSL
+- [ ] Try Fiber
+- [ ] Stateful property-based testing
 
 ## Development
 

data/lib/pbt/check/rspec_adapter/predicate_block_inspector.rb

@@ -5,7 +5,7 @@ begin
   require "prism"
 rescue LoadError
   raise InvalidConfiguration,
-    "Prism gem (https://github.com/grosser/parallel) is required to use worker `:rator` and `:experimental_ractor_rspec_integration`. Please add `gem 'parallel'` to your Gemfile."
+    "Prism gem (https://github.com/ruby/prism) is required to use worker `:ractor` and `:experimental_ractor_rspec_integration`. Please add `gem 'prism'` to your Gemfile."
 end
 
 module Pbt

data/lib/pbt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Pbt
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pbt
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - ohbarye
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-09 00:00:00.000000000 Z
+date: 2024-05-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Property-Based Testing tool for Ruby, utilizing Ractor for parallelizing