prop_check 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a8b10e33dfef86ed35b2a13ff0261552bbd2c7d7f39a6fa6997bedb4c57651f
-  data.tar.gz: c2400550a28e15baa8b4d7323adea18ec3aa858384f774b76c59f6ff87f38c82
+  metadata.gz: 4beba1b773706a7e7f75696a7040667172e44646246dc9ccdbc87faa03f70f55
+  data.tar.gz: 2c6e0c8aabc7c9c69da74c11ad2e79461ed5f6e1c5e550b0eb32923366f84c84
 SHA512:
-  metadata.gz: 758c27825f78f4d51ad6ff076f5866d2c0d7ee0a0b6f150b4247d9acb6804676c10d1223278506a2c1f2b1ecd683d8951f4c2331d6e0063cd8039fd6dedbdd94
-  data.tar.gz: f3db2b04c823a7bc29afa6dd23e58c1c7696873d836b2f42ad0af70f150ba623fbd67b8204e521c544e0a7600bd094c0b4971d6f2ceac37c456e1a050716aac5
+  metadata.gz: 25a28c29aaedcfcff34a5fa8f3c7164b6df7536eed2134416467dd46b7c8502530c6511cf6b54d0ca2f1b8ee3b59ffaa62dc6a132667a0179f0dbead7fcf6b41
+  data.tar.gz: d9d9790f110d56920570e25d2ed2b6ee0657ec99bc46b509593215405fe19de6545ecaa990a096fd75259d9122c7a7404a9f2e6194cc808707ed01f8489201ed

data/.travis.yml

@@ -4,4 +4,15 @@ language: ruby
 cache: bundler
 rvm:
   - 2.5.1
-before_install: gem install bundler -v 2.0.1
+before_install: gem install bundler -v 2.0.2
+env:
+  global:
+    - CC_TEST_REPORTER_ID=9d18f5b43e49eecd6c3da64d85ea9c765d3606c129289d7c8cadf6d448713311
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prop_check (0.6.0)
+    prop_check (0.6.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,6 +2,11 @@
 
 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)
+[![Build Status](https://travis-ci.org/Qqwy/ruby-prop_check.svg?branch=master)](https://travis-ci.org/Qqwy/ruby-prop_check)
+[![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/PropCheck)
+
 It features:
 
 - Generators for common datatypes.
@@ -157,6 +162,9 @@ 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)
+
 ## 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.

data/lib/prop_check.rb

@@ -3,14 +3,26 @@ require 'prop_check/property'
 require 'prop_check/generator'
 require 'prop_check/generators'
 require 'prop_check/helper'
+##
+# Main module of the PropCheck library.
+#
+# You probably want to look at the documentation of
+# PropCheck::Generator and PropCheck::Generators
+# to find out more about how to use generators.
 module PropCheck
-  class Error < StandardError; end
-  class UserError < Error; end
-  class GeneratorExhaustedError < UserError; end
-  class MaxShrinkStepsExceededError < UserError; end
+  module Errors
+    class Error < StandardError; end
+    class UserError < Error; end
+    class GeneratorExhaustedError < UserError; end
+    class MaxShrinkStepsExceededError < UserError; end
+  end
 
   extend self
 
+  ##
+  # Runs a property.
+  #
+  # See the README for more details.
   def forall(*args, **kwargs, &block)
     PropCheck::Property.forall(*args, **kwargs, &block)
   end

data/lib/prop_check/generators.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
 require 'prop_check/generator'
 require 'prop_check/lazy_tree'
 module PropCheck
@@ -116,27 +119,40 @@ module PropCheck
     end
 
     ##
-    # Generates floating point numbers
+    # Generates floating-point numbers
     # These start small (around 0)
     # and become more extreme (large positive and large negative numbers)
     #
+    # Will only generate 'reals',
+    # that is: no infinity, no NaN,
+    # no numbers testing the limits of floating-point arithmetic.
     #
     # Shrinks to numbers closer to zero.
     #
-    # TODO testing for NaN, Infinity?
-    def float
-      # integer.bind do |a|
-      #   integer.bind do |b|
-      #     integer.bind do |c|
-      #       Generator.wrap(fraction(a, b, c))
-      #     end
-      #   end
-      # end
+    #    >> Generators.real_float().sample(10, size: 10, rng: Random.new(42))
+    #    => [-2.2, -0.2727272727272727, 4.0, 1.25, -3.7272727272727275, -8.833333333333334, -8.090909090909092, 1.1428571428571428, 0.0, 8.0]
+    def real_float
       tuple(integer, integer, integer).map do |a, b, c|
         fraction(a, b, c)
       end
     end
 
+    @special_floats = [Float::NAN, Float::INFINITY, -Float::INFINITY, Float::MAX, Float::MIN, 0.0.next_float, 0.0.prev_float]
+    ##
+    # Generates floating-point numbers
+    # Will generate NaN, Infinity, -Infinity,
+    # as well as Float::EPSILON, Float::MAX, Float::MIN,
+    # 0.0.next_float, 0.0.prev_float,
+    # to test the handling of floating-point edge cases.
+    # Approx. 1/100 generated numbers is a special one.
+    #
+    # Shrinks to smaller, real floats.
+    #    >> Generators.float().sample(10, size: 10, rng: Random.new(42))
+    #    => [4.0, 9.555555555555555, 0.0, -Float::INFINITY, 5.5, -5.818181818181818, 1.1428571428571428, 0.0, 8.0, 7.857142857142858]
+    def float
+      frequency(99 => real_float, 1 => one_of(*@special_floats.map(&method(:constant))))
+    end
+
     ##
     # Picks one of the given generators in `choices` at random uniformly every time.
     #
@@ -156,6 +172,9 @@ module PropCheck
     # (representing the relative frequency of this generator)
     # and values to be generators.
     #
+    # Side note: If you want to use the same frequency number for multiple generators,
+    # Ruby syntax requires you to send an array of two-element arrays instead of a hash.
+    #
     # Shrinks to arbitrary elements (since hashes are not ordered).
     #
     #   >> Generators.frequency(5 => Generators.integer, 1 => Generators.printable_ascii_char).sample(size: 10, rng: Random.new(42))
@@ -174,7 +193,7 @@ module PropCheck
     #
     # Shrinks element generators, one at a time (trying last one first).
     #
-    #   >> Generators.tuple(Generators.integer, Generators.float).call(10, Random.new(42))
+    #   >> Generators.tuple(Generators.integer, Generators.real_float).call(10, Random.new(42))
     #   => [-4, 13.0]
     def tuple(*generators)
       Generator.new do |size, rng|
@@ -191,7 +210,7 @@ module PropCheck
     #
     # Shrinks element generators.
     #
-    #    >> Generators.fixed_hash(a: Generators.integer(), b: Generators.float(), c: Generators.integer()).call(10, Random.new(42))
+    #    >> Generators.fixed_hash(a: Generators.integer(), b: Generators.real_float(), c: Generators.integer()).call(10, Random.new(42))
     #    => {:a=>-4, :b=>13.0, :c=>-3}
     def fixed_hash(hash)
       keypair_generators =
@@ -242,7 +261,9 @@ module PropCheck
     # containing one of a..z, A..Z, 0..9
     #
     # Shrinks towards lowercase 'a'.
-    # 
+    #
+    #    >> Generators.alphanumeric_char.sample(5, size: 10, rng: Random.new(42))
+    #    => ["M", "Z", "C", "o", "Q"]
     def alphanumeric_char
       one_of(*@alphanumeric_chars.map(&method(:constant)))
     end
@@ -250,7 +271,11 @@ module PropCheck
     ##
     # Generates a string
     # containing only the characters a..z, A..Z, 0..9
+    #
     # Shrinks towards fewer characters, and towards lowercase 'a'.
+    #
+    #    >> Generators.alphanumeric_string.sample(5, size: 10, rng: Random.new(42))
+    #    => ["ZCoQ", "8uM", "wkkx0JNx", "v0bxRDLb", "Gl5v8RyWA6"]
     def alphanumeric_string
       array(alphanumeric_char).map(&:join)
     end
@@ -272,7 +297,11 @@ module PropCheck
     ##
     # Generates strings
     # from the printable ASCII character set.
+    #
     # Shrinks towards fewer characters, and towards ' '.
+    #
+    #    >> Generators.printable_ascii_string.sample(5, size: 10, rng: Random.new(42))
+    #    => ["S|.g", "rvjjw7\"5T!", "=", "!_[4@", "Y"]
     def printable_ascii_string
       array(printable_ascii_char).map(&:join)
     end
@@ -295,7 +324,11 @@ module PropCheck
     ##
     # Generates a single-character string
     # from the printable ASCII character set.
+    #
     # Shrinks towards '\n'.
+    #
+    #    >> Generators.ascii_char.sample(size: 10, rng: Random.new(42))
+    #    => ["d", "S", "|", ".", "g", "\\", "4", "d", "r", "v"]
     def ascii_char
       one_of(*@ascii_chars.map(&method(:constant)))
     end
@@ -303,7 +336,11 @@ module PropCheck
     ##
     # Generates strings
     # from the printable ASCII character set.
+    #
     # Shrinks towards fewer characters, and towards '\n'.
+    #
+    #    >> Generators.ascii_string.sample(5, size: 10, rng: Random.new(42))
+    #    => ["S|.g", "drvjjw\b\a7\"", "!w=E!_[4@k", "x", "zZI{[o"]
     def ascii_string
       array(ascii_char).map(&:join)
     end
@@ -321,6 +358,8 @@ module PropCheck
     #
     # Shrinks towards characters with lower codepoints, e.g. ASCII
     #
+    #    >> Generators.printable_char.sample(size: 10, rng: Random.new(42))
+    #    => ["吏", "", "", "", "", "", "", "", "", "Ȍ"]
     def printable_char
       one_of(*@printable_chars.map(&method(:constant)))
     end
@@ -331,6 +370,8 @@ module PropCheck
     #
     # Shrinks towards shorter strings, and towards characters with lower codepoints, e.g. ASCII
     #
+    #    >> Generators.printable_string.sample(5, size: 10, rng: Random.new(42))
+    #    => ["", "Ȍ", "𐁂", "Ȕ", ""]
     def printable_string
       array(printable_char).map(&:join)
     end
@@ -341,6 +382,8 @@ module PropCheck
     #
     # Shrinks towards characters with lower codepoints, e.g. ASCII
     #
+    #    >> Generators.printable_char.sample(size: 10, rng: Random.new(42))
+    #    => ["吏", "", "", "", "", "", "", "", "", "Ȍ"]
     def char
       choose(0..0x10FFFF).map do |num|
         [num].pack('U')
@@ -353,6 +396,8 @@ module PropCheck
     #
     # Shrinks towards characters with lower codepoints, e.g. ASCII
     #
+    #    >> Generators.string.sample(5, size: 10, rng: Random.new(42))
+    #    => ["\u{A3DB3}𠍜\u{3F46A}\u{1AEBC}", "􍙦𡡹󴇒\u{DED74}𪱣\u{43E97}ꂂ\u{50695}􏴴\u{C0301}", "\u{4FD9D}", "\u{C14BF}\u{193BB}𭇋󱣼\u{76B58}", "𦐺\u{9FDDB}\u{80ABB}\u{9E3CF}𐂽\u{14AAE}"]
     def string
       array(char).map(&:join)
     end
@@ -361,7 +406,9 @@ module PropCheck
     # Generates either `true` or `false`
     #
     # Shrinks towards `false`
-    # 
+    #
+    #    >> Generators.boolean.sample(5, size: 10, rng: Random.new(42))
+    #    => [false, true, false, false, false]
     def boolean
       one_of(constant(false), constant(true))
     end
@@ -370,6 +417,9 @@ module PropCheck
     # Generates always `nil`.
     #
     # Does not shrink.
+    #
+    #    >> Generators.nil.sample(5, size: 10, rng: Random.new(42))
+    #    => [nil, nil, nil, nil, nil]
     def nil
       constant(nil)
     end
@@ -379,15 +429,34 @@ module PropCheck
     #
     # Shrinks towards `nil`.
     #
+    #    >> Generators.falsey.sample(5, size: 10, rng: Random.new(42))
+    #    => [nil, false, nil, nil, nil]
     def falsey
       one_of(constant(nil), constant(false))
     end
 
+    ##
+    # Generates symbols consisting of lowercase letters and potentially underscores.
+    #
+    # Shrinks towards shorter symbols and the letter 'a'.
+    #
+    #    >> Generators.simple_symbol.sample(5, size: 10, rng: Random.new(42))
+    #    => [:tokh, :gzswkkxudh, :vubxlfbu, :lzvlyq__jp, :oslw]
+    def simple_symbol
+      alphabet = ('a'..'z').to_a
+      alphabet << '_'
+      array(one_of(*alphabet.map(&method(:constant))))
+        .map(&:join)
+        .map(&:to_sym)
+    end
+
     ##
     # Generates common terms that are not `nil` or `false`.
     #
     # Shrinks towards simpler terms, like `true`, an empty array, a single character or an integer.
     #
+    #    >> Generators.truthy.sample(5, size: 10, rng: Random.new(42))
+    #    => [[4, 0, -3, 10, -4, 8, 0, 0, 10], -3, [5.5, -5.818181818181818, 1.1428571428571428, 0.0, 8.0, 7.857142857142858, -0.6666666666666665, 5.25], [], ["\u{9E553}\u{DD56E}\u{A5BBB}\u{8BDAB}\u{3E9FC}\u{C4307}\u{DAFAE}\u{1A022}\u{938CD}\u{70631}", "\u{C4C01}\u{32D85}\u{425DC}"]]
     def truthy
       one_of(constant(true),
              constant([]),
@@ -399,7 +468,7 @@ module PropCheck
              array(float),
              array(char),
              array(string),
-             hash(symbol, integer),
+             hash(simple_symbol, integer),
              hash(string, integer),
              hash(string, string)
             )
@@ -408,6 +477,9 @@ module PropCheck
     ##
     # Generates whatever `other_generator` generates
     # but sometimes instead `nil`.`
+    #
+    #    >> Generators.nillable(Generators.integer).sample(20, size: 10, rng: Random.new(42))
+    #    => [9, 10, 8, 0, 10, -3, -8, 10, 1, -9, -10, nil, 1, 6, nil, 1, 9, -8, 8, 10]
     def nillable(other_generator)
       frequency(9 => other_generator, 1 => constant(nil))
     end

data/lib/prop_check/helper/lazy_append.rb

@@ -0,0 +1,18 @@
+module PropCheck
+  module Helper
+    ##
+    # A refinement for enumerators
+    # to allow lazy appending of two (potentially lazy) enumerators:
+    #   >> [1,2,3].lazy_append([4,5.6]).to_a
+    #   => [1,2,3,4,5,6]
+    module LazyAppend
+      refine Enumerable do
+        ##   >> [1,2,3].lazy_append([4,5.6]).to_a
+        ##   => [1,2,3,4,5,6]
+        def lazy_append(other_enumerator)
+          [self, other_enumerator].lazy.flat_map(&:lazy)
+        end
+      end
+    end
+  end
+end

data/lib/prop_check/lazy_tree.rb

@@ -1,22 +1,13 @@
-##
-# A refinement for enumerators
-# to allow lazy appending of two (potentially lazy) enumerators:
-module LazyAppend
-  refine Enumerable do
-    ##   >> [1,2,3].lazy_append([4,5.6]).to_a
-    ##   => [1,2,3,4,5,6]
-    def lazy_append(other_enumerator)
-      [self, other_enumerator].lazy.flat_map(&:lazy)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'prop_check/helper/lazy_append'
 
 module PropCheck
   ##
   # A Rose tree with the root being eager,
   # and the children computed lazily, on demand.
   class LazyTree
-    using LazyAppend
+    using PropCheck::Helper::LazyAppend
 
     attr_accessor :root, :children
     def initialize(root, children = [].lazy)

data/lib/prop_check/property.rb

@@ -3,8 +3,19 @@ require 'stringio'
 require 'prop_check/property/configuration'
 require 'prop_check/property/check_evaluator'
 module PropCheck
+  ##
+  # Run properties
   class Property
 
+    ##
+    # Call this with a keyword argument list of (symbol => generators) and a block.
+    # The block will then be executed many times, with the respective symbol names
+    # being defined as having a single generated value.
+    #
+    # If you do not pass a block right away,
+    # a Property object is returned, which you can call the other instance methods
+    # of this class on before finally passing a block to it using `#check`.
+    # (so `forall(a: Generators.integer) do ... end` and forall(a: Generators.integer).check do ... end` are the same)
     def self.forall(**bindings, &block)
 
       property = new(bindings)
@@ -14,10 +25,19 @@ module PropCheck
       property
     end
 
+    ##
+    # Returns the default configuration of the library as it is configured right now
+    # for introspection.
+    #
+    # For the configuration of a single property, check its `configuration` instance method.
+    # See PropCheck::Property::Configuration for more info on available settings.
     def self.configuration
       @configuration ||= Configuration.new
     end
 
+    ##
+    # Yields the library's configuration object for you to alter.
+    # See PropCheck::Property::Configuration for more info on available settings.
     def self.configure
       yield(configuration)
     end
@@ -32,10 +52,22 @@ module PropCheck
       @config = self.class.configuration
     end
 
+    ##
+    # Returns the configuration of this property
+    # for introspection.
+    #
+    # See PropCheck::Property::Configuration for more info on available settings.
     def configuration
       @config
     end
 
+    ##
+    # Allows you to override the configuration of this property
+    # by giving a hash with new settings.
+    #
+    # If no other changes need to occur before you want to check the property,
+    # you can immediately pass a block to this method.
+    # (so `forall(a: Generators.integer).with_config(verbose: true) do ... end` is the same as `forall(a: Generators.integer).with_config(verbose: true).check do ... end`)
     def with_config(**config, &block)
       @config = @config.merge(config)
 
@@ -44,13 +76,23 @@ module PropCheck
       self
     end
 
-    def where(&new_condition)
+    ##
+    # filters the generator using the  given `condition`.
+    # The final property checking block will only be run if the condition is truthy.
+    #
+    # If wanted, multiple `where`-conditions can be specified on a property.
+    # Be aware that if you filter away too much generated inputs,
+    # you might encounter a GeneratorExhaustedError.
+    # Only filter if you have few inputs to reject. Otherwise, improve your generators.
+    def where(&condition)
       original_condition = @condition.dup
-      @condition = -> { instance_exec(&original_condition) && instance_exec(&new_condition) }
+      @condition = -> { instance_exec(&original_condition) && instance_exec(&condition) }
 
       self
     end
 
+    ##
+    # Checks the property (after settings have been altered using the other instance methods in this class.)
     def check(&block)
       binding_generator = PropCheck::Generators.fixed_hash(bindings)
 
@@ -70,7 +112,7 @@ module PropCheck
     private def ensure_not_exhausted!(n_runs)
       return if n_runs >= @config.n_runs
 
-      raise GeneratorExhaustedError, """
+      raise Errors::GeneratorExhaustedError, """
         Could not perform `n_runs = #{@config.n_runs}` runs,
         (exhausted #{@config.max_generate_attempts} tries)
         because too few generator results were adhering to
@@ -131,7 +173,7 @@ module PropCheck
     private def show_problem_output(problem, generator_results, n_successful, &block)
       output = @config.verbose ? STDOUT : StringIO.new
       output = pre_output(output, n_successful, generator_results.root, problem)
-      shrunken_result, shrunken_exception, n_shrink_steps = shrink2(generator_results, output, &block)
+      shrunken_result, shrunken_exception, n_shrink_steps = shrink(generator_results, output, &block)
       output = post_output(output, n_shrink_steps, shrunken_result, shrunken_exception)
 
       [output, shrunken_result, shrunken_exception, n_shrink_steps]
@@ -168,7 +210,7 @@ module PropCheck
       end.join(", ")
     end
 
-    private def shrink2(bindings_tree, io, &fun)
+    private def shrink(bindings_tree, io, &fun)
       io.puts 'Shrinking...' if @config.verbose
       problem_child = bindings_tree
       siblings = problem_child.children.lazy
@@ -191,11 +233,11 @@ module PropCheck
 
         begin
           CheckEvaluator.new(sibling.root, &fun).call
-        rescue Exception => problem
+        rescue Exception => e
           problem_child = sibling
           parent_siblings = siblings
           siblings = problem_child.children.lazy
-          problem_exception = problem
+          problem_exception = e
         end
       end
 

data/lib/prop_check/version.rb

@@ -1,3 +1,3 @@
 module PropCheck
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop_check
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Qqwy/Wiebe-Marten Wijnja
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - lib/prop_check/generator.rb
 - lib/prop_check/generators.rb
 - lib/prop_check/helper.rb
+- lib/prop_check/helper/lazy_append.rb
 - lib/prop_check/lazy_tree.rb
 - lib/prop_check/property.rb
 - lib/prop_check/property/check_evaluator.rb