prop_check 0.18.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 117dfaa6197dcb53fd6619ae414452a277d668a34736331169407361dbdcb0bc
-  data.tar.gz: 86a17a6070762151d0e84010c3bdf75569df962c1428fb7008f46cfe685f312c
+  metadata.gz: d97039234e58c965b91cba40c589808d7ac1e4b559355fd4df719edb89f7b837
+  data.tar.gz: a87f0c2377918f4d05c6b1d06838b0581a01b21ddba4a1e74929e046cc33f5d0
 SHA512:
-  metadata.gz: 1d00f635551fc17b870a0f3065040662b85565a19a498d84dbdb76de106f0138d905f2da0fdb89f5ee25e666411abdc7d4d7b61831114d99ed80451471f450f0
-  data.tar.gz: 8ec326b8e39ceed7d587de59c6fac591e91d4429bdef0a9770542643e7a1d5323667f59cf196611cac42324288994096054afc72ea6eb2722640a68c3cc745b6
+  metadata.gz: 6821b9be704593dcf577c8b9e29191e731009358faf0f3f4405b8333e8246681cbc76327bbb4f74d9a748f255ba65e2379cdadf51b3fa601746f2db89ba5e906
+  data.tar.gz: 3aa1b4d7313e5713ec9a2960461f89b7b14f265dabe57fe8c5040ce99450f66a61280e903df50879176a5850c56e802d9650f4c952968ab69c5b0030c1349d74

data/.github/workflows/run_tests.yaml

@@ -15,8 +15,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        # NOTE: Ruby 3.2 is not in here, as `doctest-core` first needs to be updated to support it
-        ruby-version: ['2.6', '2.7', '3.0', '3.1']
+        # NOTE: We're stopping testing Ruby < 3.0 since prop_check version 1.0.0
+        # It will _probably_ still work but as they're end-of-life, no guarantees!
+        ruby-version: ['3.0', '3.1', '3.2']
 
     steps:
     - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+- 1.0.0
+  - Changes:
+    - Pretty-print failures using Ruby's builtin `PP`, so `prop_check` no longer depends on the `awesome_print` gem. (c.f. #19)
+- 0.18.2
+  - Documentation updates:
+    - Adding an example of using prop_check with the `test-unit` testing framework to the README. (c.f. #18, thank you, @niku!)
+    - Fixing typos in various parts of the documentation.  (c.f. #16, #17, #21. Thank you, @meganemura, @niku and @harlantwood!)
 - 0.18.1
   - Fixes:
     - Compatibility with Ruby 3.2:

data/Gemfile

@@ -8,6 +8,6 @@ gem "bundler", "~> 2.0"
 group :test do
   gem "rake", "~> 12.3", require: false
   gem "rspec", "~> 3.0", require: false
-  gem "doctest-rspec", require: false
+  gem "doctest2-rspec", require: false
   gem "simplecov", require: false
 end

data/Justfile

@@ -0,0 +1,16 @@
+setup_and_test: setup test
+
+setup:
+  bin/setup
+
+test:
+  bundle exec rspec
+
+console:
+  bin/console
+
+install:
+  bundle exec rake install
+
+release:
+  bundle exec rake release

data/README.md

@@ -5,7 +5,7 @@ PropCheck allows you to do Property Testing in Ruby.
 [![Gem](https://img.shields.io/gem/v/prop_check.svg)](https://rubygems.org/gems/prop_check)
 [![Ruby RSpec tests build status](https://github.com/Qqwy/ruby-prop_check/actions/workflows/run_tests.yaml/badge.svg)](https://github.com/Qqwy/ruby-prop_check/actions/workflows/run_tests.yaml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/71897f5e6193a5124a53/maintainability)](https://codeclimate.com/github/Qqwy/ruby-prop_check/maintainability)
-[![RubyDoc](https://img.shields.io/badge/%F0%9F%93%9ARubyDoc-documentation-informational.svg)](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/master/)
+[![RubyDoc](https://img.shields.io/badge/%F0%9F%93%9ARubyDoc-documentation-informational.svg)](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/main/)
 
 It features:
 
@@ -14,6 +14,8 @@ It features:
 - Shrinking to a minimal counter-example on failure.
 - Hooks to perform extra set-up/cleanup logic before/after every example case.
 
+It requires _no_ external dependencies, and integrates well with all common test frameworks (see below).
+
 ## What is PropCheck?
 
 PropCheck is a Ruby library to create unit tests which are simpler to write and more powerful when run, finding edge-cases in your code you wouldn't have thought to look for.
@@ -156,6 +158,23 @@ class NaiveAverageTest < MiniTest::Unit::TestCase
 end
 ```
 
+The test case, using test-unit:
+``` ruby
+require "test-unit"
+
+class TestNaiveAverage < Test::Unit::TestCase
+  G = PropCheck::Generators
+
+  def test_that_it_returns_an_integer_for_any_input
+    PropCheck.forall(G.array(G.integer)) do |numbers|
+      result = naive_average(numbers)
+
+      assert_instance_of(Integer, result)
+    end
+  end
+end
+```
+
 The test case, using only vanilla Ruby:
 ```ruby
 # And then in a test case:
@@ -201,16 +220,15 @@ For instance, when a failure happens with the input `x = 100`,
 PropCheck will see if the failure still happens with `x = 50`.
 If it does , it will try `x = 25`. If not, it will try `x = 75`, and so on.
 
-This means if something only goes wrong for `x = 2`, the program will try:
+This means for example that if something only goes for wrong for `x >= 8`, the program will try:
 - `x = 100`(fails),
 - `x = 50`(fails), 
 - `x = 25`(fails), 
 - `x = 12`(fails), 
-- `x = 6`(fails), 
-- `x = 3`(fails), 
-- `x = 1` (succeeds), `x = 2` (fails).
+- `x = 6`(succeeds), `x = 9` (fails)
+- `x = 7`(succeeds), `x = 8` (fails).
 
-and thus the simplified case of `x = 2` is shown in the output.
+and thus the simplified case of `x = 8` is shown in the output.
 
 The documentation of the provided generators explain how they shrink.
 A short summary:
@@ -222,7 +240,7 @@ A short summary:
 
 ### Builtin Generators
 
-PropCheck comes with [many builtin generators in the PropCheck::Generators](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/master/PropCheck/Generators) module.
+PropCheck comes with [many builtin generators in the PropCheck::Generators](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/main/PropCheck/Generators) module.
 
 It contains generators for:
 - (any, positive, negative, etc.) integers, 
@@ -250,7 +268,7 @@ Always returns the given value. No shrinking.
 
 Allows you to take the result of one generator and transform it into something else.
     
-    >> G.choose(32..128).map(&:chr).sample(1, size: 10, Random.new(42))
+    >> G.choose(32..128).map(&:chr).sample(1, size: 10, rng: Random.new(42))
     => ["S"]
 
 #### Generator#bind
@@ -262,7 +280,7 @@ Allows you to create one or another generator conditionally on the output of ano
 
 This is an advanced feature. Often, you can use a combination of `Generators.tuple` and `Generator#map` instead:
 
-    >> G.tuple(integer, integer).sample(1, size: 100, rng: Random.new(42)
+    >> G.tuple(G.integer, G.integer).sample(1, size: 100, rng: Random.new(42))
     => [[2, 79]]
 
 #### Generators.one_of
@@ -288,8 +306,8 @@ you can use `Generators.frequency` which takes a hash of (integer_frequency => g
 There are even more functions in the `Generator` class and the `Generators` module that you might want to use,
 although above are the most generally useful ones.
 
-[PropCheck::Generator documentation](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/master/PropCheck/Generator)
-[PropCheck::Generators documentation](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/master/PropCheck/Generators)
+[PropCheck::Generator documentation](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/main/PropCheck/Generator)
+[PropCheck::Generators documentation](https://www.rubydoc.info/github/Qqwy/ruby-prop_check/main/PropCheck/Generators)
 
 
 ## Usage within Rails / with a database
@@ -309,13 +327,17 @@ Here are some simple recommendations for the best results:
                .check(&block)
   end
 ```
-- Other setup/cleanup should also usually happen around each generated example rather than around the whole test: Instead of using the hooks exposed by RSpec/MiniTest/etc., use the before/after/around hooks exposed by PropCheck.
+- Other setup/cleanup should also usually happen around each generated example rather than around the whole test: Instead of using the hooks exposed by RSpec/MiniTest/test-unit/etc., use the before/after/around hooks exposed by PropCheck.
 
 ## 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.
+After checking out the repo, use the [just](https://github.com/casey/just) command runner for common tasks:
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- `just setup`: Installs dev dependencies
+- `just test`: Runs the test suite
+- `just console`: Opens an IRb console with the gem loaded for experimenting.
+- `just install`: Install the gem on your local machine.
+- `just release`: Create and push a new release to the git repo and Rubygems. (Be sure to increase the version number in `version.rb` first!)
 
 ## Contributing
 
@@ -327,7 +349,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the PropCheck project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Qqwy/ruby-prop_check/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PropCheck project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Qqwy/ruby-prop_check/blob/main/CODE_OF_CONDUCT.md).
 
 ## Attribution and Thanks
 

data/lib/prop_check/generators.rb

@@ -234,7 +234,7 @@ module PropCheck
     end
 
     ##
-    # Generates any nonzerno floating-point number.
+    # Generates any nonzero floating-point number.
     # Will generate special floats (except NaN) from time to time.
     # c.f. #float
     def nonzero_float
@@ -266,7 +266,7 @@ module PropCheck
     end
 
     ##
-    # Generates positive floating point numbers
+    # Generates negative floating point numbers
     # Will generate special floats (except NaN) from time to time.
     # c.f. #float
     def negative_float
@@ -479,7 +479,7 @@ module PropCheck
 
     ##
     #
-    # Alias for `#hash` that does not conflict with a possibly overriden `Object#hash`.
+    # Alias for `#hash` that does not conflict with a possibly overridden `Object#hash`.
     #
     def hash_of(key_generator, value_generator, **kwargs)
       array(tuple(key_generator, value_generator), **kwargs)

data/lib/prop_check/property/output_formatter.rb

@@ -1,5 +1,7 @@
 ##
 # @api private
+require 'pp'
+
 module PropCheck::Property::OutputFormatter
   extend self
 
@@ -32,10 +34,13 @@ module PropCheck::Property::OutputFormatter
   end
 
   def print_roots(lazy_tree_val)
-    if lazy_tree_val.is_a?(Array) && lazy_tree_val.length == 1 && lazy_tree_val[0].is_a?(Hash)
-      lazy_tree_val[0].ai
-    else
-      lazy_tree_val.ai
-    end
+    data =
+      if lazy_tree_val.is_a?(Array) && lazy_tree_val.length == 1 && lazy_tree_val[0].is_a?(Hash)
+        lazy_tree_val[0]
+      else
+        lazy_tree_val
+      end
+
+    PP.pp(data, '')
   end
 end

data/lib/prop_check/property.rb

@@ -1,5 +1,4 @@
 require 'stringio'
-require 'amazing_print'
 
 require 'prop_check/property/configuration'
 require 'prop_check/property/output_formatter'

data/lib/prop_check/version.rb

@@ -1,3 +1,3 @@
 module PropCheck
-  VERSION = '0.18.1'
+  VERSION = '1.0.0'
 end

data/prop_check.gemspec

@@ -6,7 +6,7 @@ require "prop_check/version"
 Gem::Specification.new do |spec|
   spec.name          = "prop_check"
   spec.version       = PropCheck::VERSION
-  spec.authors       = ["Qqwy/Wiebe-Marten Wijnja"]
+  spec.authors       = ["Qqwy/Marten Wijnja"]
   spec.email         = ["w-m@wmcode.nl"]
 
   spec.summary       = %q{PropCheck allows you to do property-based testing, including shrinking.}
@@ -35,6 +35,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.5.1'
-
-  spec.add_dependency 'amazing_print', '~> 1.2'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: prop_check
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Qqwy/Wiebe-Marten Wijnja
+- Qqwy/Marten Wijnja
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: amazing_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+date: 2024-02-17 00:00:00.000000000 Z
+dependencies: []
 description: PropCheck allows you to do property-based testing, including shrinking.
   (akin to Haskell's QuickCheck, Erlang's PropEr, Elixir's StreamData). This means
   that your test are run many times with different, autogenerated inputs, and as soon
@@ -43,6 +29,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Justfile
 - LICENSE.txt
 - README.md
 - Rakefile