prop_check 0.18.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c85d7bb545c99b3953f68f42a7e37e14b96ddde115b42670689aa7094dfef42
-  data.tar.gz: efe151cb45c09d94d7e987d490096a321488832bc8d8041ab513ee64b71335d9
+  metadata.gz: d97039234e58c965b91cba40c589808d7ac1e4b559355fd4df719edb89f7b837
+  data.tar.gz: a87f0c2377918f4d05c6b1d06838b0581a01b21ddba4a1e74929e046cc33f5d0
 SHA512:
-  metadata.gz: b5d180fe6141074ef202fba5c251a96492c2e5ad9706491ec615df1e5010c12623e3c5b53b8adaa5e75435df9ec48a464543672e33c81af4b18528da6f184860
-  data.tar.gz: a4b2e62dee58f53bc291202cbae157119eba7858f24b70ea5eb8790e578eceb0f2b140c1e5707c68037fcc09c2dddd17f57970de45fb3271503322a4de25fe05
+  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', '3.2']
+        # 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/.tool-versions

@@ -1 +1 @@
-ruby 2.7.6
+ruby 3.1.3

data/CHANGELOG.md

@@ -1,7 +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:
-    - 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!
+    - 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/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.
@@ -218,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:
@@ -239,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, 
@@ -305,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
@@ -348,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/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.2'
+  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.2
+  version: 1.0.0
 platform: ruby
 authors:
-- Qqwy/Wiebe-Marten Wijnja
-autorequire: 
+- Qqwy/Marten Wijnja
+autorequire:
 bindir: exe
 cert_chain: []
 date: 2024-02-17 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'
+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
@@ -69,7 +55,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
@@ -84,8 +70,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: PropCheck allows you to do property-based testing, including shrinking.
 test_files: []