prop_check 0.18.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba078df3937d6f069a4ed24e9aaed9617dc1eb03139be0189e51b060b11a75ba
-  data.tar.gz: 0fe77f31d282754df6712aafae7995e82e99d9ee86f8ad12bd060596147dafe1
+  metadata.gz: 4c85d7bb545c99b3953f68f42a7e37e14b96ddde115b42670689aa7094dfef42
+  data.tar.gz: efe151cb45c09d94d7e987d490096a321488832bc8d8041ab513ee64b71335d9
 SHA512:
-  metadata.gz: e49791f3e5a380e822f4d86f39444a09e26828c4b1ea7c90d298c9eedcc14d8c6fdc05864439e1984b0cead4183beb1ae108bee82c7ce6dccbe11aae5efbd248
-  data.tar.gz: cddd15cf550e166ec93d15fa2ffdf07a68646aa6750d544b6a5cf64c9bfb44177b638e6ff1df2ce25e28105df05aa838534e6eaafadefb7688aed32dae9d3bbc
+  metadata.gz: b5d180fe6141074ef202fba5c251a96492c2e5ad9706491ec615df1e5010c12623e3c5b53b8adaa5e75435df9ec48a464543672e33c81af4b18528da6f184860
+  data.tar.gz: a4b2e62dee58f53bc291202cbae157119eba7858f24b70ea5eb8790e578eceb0f2b140c1e5707c68037fcc09c2dddd17f57970de45fb3271503322a4de25fe05

data/.github/workflows/run_tests.yaml

@@ -15,7 +15,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+        # 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', '3.2']
 
     steps:
     - uses: actions/checkout@v3
@@ -27,5 +28,9 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake
+    - name: Run tests & push test coverage to Codeclimate
+      uses: paambaati/codeclimate-action@v3.2.0
+      env:
+        CC_TEST_REPORTER_ID: '9d18f5b43e49eecd6c3da64d85ea9c765d3606c129289d7c8cadf6d448713311'
+      with:
+        coverageCommand: bundle exec rake

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.1
+ruby 2.7.6

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+- 0.18.2
+  - Documentation updates:
+    - PR #18: Adding an example of using prop_check with the `test-unit` testing framework to the README. Thank you, @niku!
+    - PR #17, #18, #21: fixing typos in various parts of the documentation. Thank you, @meganemura, @niku and @harlantwood!
+- 0.18.1
+  - Fixes:
+    - Compatibility with Ruby 3.2:
+      - Use `Random` instead of no-longer-available `Random::DEFAULT` on Ruby 3.x.
+      - Ensure when a hash is passed (such as in `PropCheck.forall(hash_of(integer, string)) { |hash| ... }` that when an empty hash is generated, `hash` is still `{}` and not `nil`. ([Ruby 3.x treats `fun(**{})` differently than Ruby 2.x](https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/#other-minor-changes-empty-hash))
 - 0.18.0
   - Features:
     - Allows calling `PropCheck::Property#check` without a block, which will just return `self`. This is useful for writing wrapper functions that use `before/after/around/with_config` etc hooks which might themselves optionally want a block so they can be chained. (See the `forall_with_db` snippet in the README for an example)

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

@@ -156,6 +156,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:
@@ -250,7 +267,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 +279,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
@@ -309,13 +326,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
 

data/lib/prop_check/generator.rb

@@ -9,7 +9,14 @@ module PropCheck
   # to be used during the shrinking phase.
   class Generator
     @@default_size = 10
-    @@default_rng = Random.new
+    @@default_rng =
+      # Backwards compatibility: Random::DEFAULT is deprecated in Ruby 3.x
+      # but required in Ruby 2.x and 1.x
+      if RUBY_VERSION.to_i >= 3
+        Random
+      else
+        Random::DEFAULT
+      end
     @@max_consecutive_attempts = 100
     @@default_kwargs = { size: @@default_size, rng: @@default_rng,
                          max_consecutive_attempts: @@max_consecutive_attempts }
@@ -115,7 +122,9 @@ module PropCheck
     # This can be used to inspect the configuration inside a `#map` or `#where`
     # and act on it.
     #
-    #  >> Generators.choose(0..100).with_config.map { |int, conf| Date.jd(conf[:default_epoch].jd + int) }.call(size: 10, rng: Random.new(42), config: PropCheck::Property::Configuration.new)
+    #  >> example_config = PropCheck::Property::Configuration.new(default_epoch: Date.new(2022, 11, 22))
+    #  >> generator = Generators.choose(0..100).with_config.map { |int, conf| Date.jd(conf[:default_epoch].jd + int) }
+    #  >> generator.call(size: 10, rng: Random.new(42), config: example_config)
     #  => Date.new(2023, 01, 12)
     def with_config
       Generator.new do |**kwargs|

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/helper.rb

@@ -33,6 +33,9 @@ module PropCheck
     end
 
     def call_splatted(val, &block)
+      # Handle edge case where Ruby >= 3 behaves differently than Ruby <= 2
+      # c.f. https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0/#other-minor-changes-empty-hash
+      return block.call({}) if val.is_a?(Hash) && val.empty?
       return block.call(**val) if val.is_a?(Hash) && val.keys.all? { |k| k.is_a?(Symbol) }
 
       block.call(val)

data/lib/prop_check/property.rb

@@ -332,7 +332,7 @@ c.f. https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-k
     end
 
     private def raw_attempts_enum(binding_generator)
-      rng = Random::DEFAULT
+      rng = Random.new
       size = 1
       (0...@config.max_generate_attempts)
         .lazy

data/lib/prop_check/version.rb

@@ -1,3 +1,3 @@
 module PropCheck
-  VERSION = '0.18.0'
+  VERSION = '0.18.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop_check
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.2
 platform: ruby
 authors:
 - Qqwy/Wiebe-Marten Wijnja
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2024-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -43,6 +43,7 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Justfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -68,7 +69,7 @@ metadata:
   homepage_uri: https://github.com/Qqwy/ruby-prop_check/
   source_code_uri: https://github.com/Qqwy/ruby-prop_check/
   changelog_uri: https://github.com/Qqwy/ruby-prop_check/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: PropCheck allows you to do property-based testing, including shrinking.
 test_files: []