prop_check 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: add08010531772da827ece44a91bdeb52d259374cf9bb966f05104f29e5a8ae8
+  data.tar.gz: 246d3a3df6d8c53f198f489dcd6174160379dfe504558c79932bd0d0c78a2733
+SHA512:
+  metadata.gz: 6b95914aab13287ce63e98a21db6add53a05f5944d432206e706d8ba6a748ea9fd243f2b1d4044456b68111c3adb0dc41e1cd9a829383145d2590b0ea1a82b28
+  data.tar.gz: 86d94f972980c806721f39a914a8d527364809b532a940c826e050e59ee5b4661b57824e74da950537ae6d6ff2c0046b048f64a9a5a6ad197e4c94f937cc3ba8

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 120
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at w-m@wmcode.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in prop_check.gemspec
+gemspec
+
+gem 'simplecov', require: false, group: :test
+gem 'doctest-rspec', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    prop_check (0.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    docile (1.3.2)
+    doctest-core (0.0.2)
+    doctest-rspec (0.0.3)
+      doctest-core (~> 0.0.2)
+      rspec
+    json (2.2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  doctest-rspec
+  prop_check!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Qqwy/Wiebe-Marten Wijnja
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# PropCheck
+
+PropCheck allows you to do Property Testing in Ruby.
+
+It features:
+
+- Generators for common datatypes.
+- An easy DSL to define your own generators (by combining existing ones, or completely custom).
+- Shrinking to a minimal counter-example on failure.
+
+
+## TODOs before release
+
+Before releasing this gem on Rubygems, the following things need to be finished:
+
+- [x]  Finalize the testing DSL.
+- [x] Testing the library itself (against known 'true' axiomatically correct Ruby code.)
+- [x] Customization of common settings
+ - [x] Filtering generators. 
+  - [x] Customize the max. of samples to run.
+  - [x] Stop after a ludicrous amount of generator runs, to prevent malfunctioning (infinitely looping) generators from blowing up someone's computer.
+ - [x] Look into customization of settings from e.g. command line arguments.
+- [x] Good, unicode-compliant, string generators.
+- [ ] Filtering generator outputs.
+
+# Nice-to-haves
+ 
+- [ ] Basic integration with RSpec. See also https://groups.google.com/forum/#!msg/rspec/U-LmL0OnO-Y/iW_Jcd6JBAAJ for progress on this.
+ - [ ] `aggregate` , `resize` and similar generator-modifying calls (c.f. PropEr's variants of these) which will help with introspection/metrics.
+ - [ ] Integration with other Ruby test frameworks.
+ - Stateful property testing. If implemented at some point, will probably happen in a separate add-on library.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prop_check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prop_check
+
+## Usage
+
+
+### Using PropCheck for basic testing
+
+Propcheck exposes the `forall` method.
+It takes generators as keyword arguments and a block to run.
+Inside the block, each of the names in the keyword-argument-list is available by its name.
+
+_(to be precise: a method on the execution context is defined which returns the current generated value for that name)_
+
+Raise an exception from the block if there is a problem. If there is no problem, just return normally.
+
+```ruby
+# testing that Enumerable#sort sorts in ascending order
+PropCheck.forall(numbers: array(integer())) do
+  sorted_numbers = numbers.sort
+  
+  # Check that no number is smaller than the previous number
+  sorted_numbers.each_cons(2) do |former, latter| 
+    raise "Elements are not sorted! #{latter} is < #{former}" if latter < former
+  end
+end
+```
+
+#### Shrinking
+
+When a failure is found, PropCheck will re-run the block given to `forall` to test
+'smaller' inputs, in an attempt to give you a minimal counter-example,
+from which the problem can be easily understood.
+
+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:
+- `x = 100`(fails),`
+- x = 50`(fails), 
+- `x = 25`(fails), 
+- `x = 12`(fails), 
+- `x = 6`(fails), 
+- `x = 3`(fails), 
+- `x = 1` (succeeds), `x = 2` (fails).
+
+and thus the simplified case of `x = 2` is shown in the output.
+
+The documentation of the provided generators explain how they shrink.
+A short summary:
+- Integers shrink to numbers closer to zero.
+- Negative integers also attempt their positive alternative.
+- Floats shrink similarly to integers.
+- Arrays and hashes shrink to fewer elements, as well as shrinking their elements.
+- Strings shrink to shorter strings, as well as characters earlier in their alphabet.
+
+
+### Writing Custom Generators
+
+PropCheck comes bundled with a bunch of common generators, for:
+- integers
+- floats
+- strings
+- symbols
+- arrays
+- hashes
+etc.
+
+However, you can easily adapt them to generate your own datatypes:
+
+#### Generator#wrap
+
+Always returns the given value. No shrinking.
+
+#### Generator#map
+
+Allows you to take the result of one generator and transform it into something else.
+    
+    >> Generators.choose(32..128).map(&:chr).call(10, Random.new(42))
+    => "S"
+
+#### Generator#bind
+
+Allows you to create one or another generator conditionally on the output of another generator.
+
+    >> Generators.integer.bind { |a| Generators.integer.bind { |b| Generator.wrap([a , b]) } }.call(100, Random.new(42))
+    => [2, 79]
+
+
+#### Generators.one_of
+
+Useful if you want to be able to generate a value to be one of multiple possibilities:
+
+    
+    >> Generators.one_of(Generators.constant(true), Generators.constant(false)).sample(5, size: 10, rng: Random.new(42))
+    => [true, false, true, true, true]
+
+(note that for this example, you can also use `Generators.boolean`. The example happens to show how it is implemented under the hood.)
+
+#### Generators.frequency
+
+If `one_of` does not give you enough flexibility because you want some results to be more common than others,
+you can use `Generators.frequency` which takes a hash of (integer_frequency => generator) keypairs.
+
+    >> Generators.frequency(5 => Generators.integer, 1 => Generators.printable_ascii_char).sample(size: 10, rng: Random.new(42))
+    => [4, -3, 10, 8, 0, -7, 10, 1, "E", 10]
+
+#### Others
+
+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.
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Qqwy/ruby-prop_check . This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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/[USERNAME]/prop_check/blob/master/CODE_OF_CONDUCT.md).
+
+## Attribution and Thanks
+
+I want to thank the original creators of QuickCheck (Koen Claessen, John Hughes) as well as the authors of many great property testing libraries that I was/am able to use as inspiration.
+I also want to greatly thank Thomasz Kowal who made me excited about property based testing [with his great talk about stateful property testing](https://www.youtube.com/watch?v=q0wZzFUYCuM), 
+as well as Fred Herbert for his great book [Property-Based Testing with PropEr, Erlang and Elixir](https://propertesting.com/) which is really worth the read (regardless of what language you are using).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prop_check"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prop_check.rb

@@ -0,0 +1,17 @@
+require "prop_check/version"
+require 'prop_check/property'
+require 'prop_check/generator'
+require 'prop_check/generators'
+require 'prop_check/helper'
+module PropCheck
+  class Error < StandardError; end
+  class UserError < Error; end
+  class GeneratorExhaustedError < UserError; end
+  class MaxShrinkStepsExceededError < UserError; end
+
+  extend self
+
+  def forall(*args, **kwargs, &block)
+    PropCheck::Property.forall(*args, **kwargs, &block)
+  end
+end

data/lib/prop_check/generator.rb

@@ -0,0 +1,95 @@
+module PropCheck
+  ##
+  # A `Generator` is a special kind of 'proc' that,
+  # given a size an random number generator state,
+  # will generate a (finite) LazyTree of output values:
+  #
+  # The root of this tree is the value to be used during testing,
+  # and the children are 'smaller' values related to the root,
+  # to be used during the shrinking phase.
+  class Generator
+    @@default_size = 10
+    @@default_rng = Random.new
+
+    ##
+    # Being a special kind of Proc, a Generator wraps a block.
+    def initialize(&block)
+      @block = block
+    end
+
+    ##
+    # Given a `size` (integer) and a random number generator state `rng`,
+    # generate a LazyTree.
+    def generate(size = @@default_size, rng = @@default_rng)
+      @block.call(size, rng)
+    end
+
+    ##
+    # Generates a value, and only return this value
+    # (drop information for shrinking)
+    #
+    #   >> Generators.integer.call(1000, Random.new(42))
+    #   => 126
+    def call(size = @@default_size, rng = @@default_rng)
+      generate(size, rng).root
+    end
+
+    ##
+    # Returns `num_of_samples` values from calling this Generator.
+    # This is mostly useful for debugging if a generator behaves as you intend it to.
+    def sample(num_of_samples = 10, size: @@default_size, rng: @@default_rng)
+      num_of_samples.times.map do
+        call(size, rng)
+      end
+    end
+
+    ##
+    # Creates a 'constant' generator that always returns the same value,
+    # regardless of `size` or `rng`.
+    #
+    # Keen readers may notice this as the Monadic 'pure'/'return' implementation for Generators.
+    #
+    #   >> Generators.integer.bind { |a| Generators.integer.bind { |b| Generator.wrap([a , b]) } }.call(100, Random.new(42))
+    #   => [2, 79]
+    def self.wrap(val)
+      Generator.new { |_size, _rng| LazyTree.wrap(val) }
+    end
+
+    ##
+    # Create a generator whose implementation depends on the output of another generator.
+    # this allows us to compose multiple generators.
+    #
+    # Keen readers may notice this as the Monadic 'bind' (sometimes known as '>>=') implementation for Generators.
+    #
+    #   >> Generators.integer.bind { |a| Generators.integer.bind { |b| Generator.wrap([a , b]) } }.call(100, Random.new(42))
+    #   => [2, 79]
+    def bind(&generator_proc)
+      # Generator.new do |size, rng|
+      #   outer_result = generate(size, rng)
+      #   outer_result.map do |outer_val|
+      #     inner_generator = generator_proc.call(outer_val)
+      #     inner_generator.generate(size, rng)
+      #   end.flatten
+      # end
+      Generator.new do |size, rng|
+        outer_result = generate(size, rng)
+        outer_result.bind do |outer_val|
+          inner_generator = generator_proc.call(outer_val)
+          inner_generator.generate(size, rng)
+        end
+      end
+    end
+
+    ##
+    # Creates a new Generator that returns a value by running `proc` on the output of the current Generator.
+    #
+    #   >> Generators.choose(32..128).map(&:chr).call(10, Random.new(42))
+    #   => "S"
+    def map(&proc)
+      Generator.new do |size, rng|
+        result = self.generate(size, rng)
+        result.map(&proc)
+      end
+    end
+  end
+end