prop_check 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e5aeef61ddf82569ca885327d32b9fe8fd939f2fdbef48709cb19504b5cf041
-  data.tar.gz: d914dcac32f7a3a976661a0280c71f0a7a665411550aed9902317b04c82ee290
+  metadata.gz: aaa23e40547bec5672e806d62c567947cd596e1c11ed2bc80fbe6912cd75a777
+  data.tar.gz: a0263cddf3efb8ee55f29395004915c38b6e78c7fc7bbf2c1b456f344013b8da
 SHA512:
-  metadata.gz: 85c5b76ac37ba8e03b2c41c04c4cc359844fa2e52d0af8893787531c23f3a54b046eb7eed13b055fed44c8983f87cbfe492d1524746624a3744300a73caf01da
-  data.tar.gz: 9beb7ac4e605c72cc8e9b3907e727ae532c2eec4a530b6a9b7c31445135e37c8849c9f186d4571aaf38c24e28989ebe856ed2e5e873baf2ed7b740a73561dae7
+  metadata.gz: b7976fb344d4c7135cd858ca86606beb97cd9e9f57c40e2bb322a3c76287de46491d4feb1dd3a65158ffef8ea98894490edc7eb9bc506d80ddb110b2f026de8d
+  data.tar.gz: f80bffd3b08d1a1cf120a70645b548c2f70b540ae5be317b7635f7416cc4e7be94d3a1bfca10acd117166e08fd0a0c6cd8ab08bf68097182fc064519600cfb55

data/.gitignore

@@ -11,4 +11,5 @@
 .rspec_status
 
 # .gem version files
-*.gem
+*.gem
+Gemfile.lock

data/Gemfile

@@ -3,6 +3,9 @@ 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
-gem 'awesome_print', require: true
+gem "bundler", "~> 2.0"
+gem "rake", "~> 12.3", require: false, group: :test
+gem "rspec", "~> 3.0", require: false, group: :test
+gem "doctest-rspec", require: false, group: :test
+gem "simplecov", require: false, group: :test
+

data/README.md

@@ -27,6 +27,7 @@ Before releasing this gem on Rubygems, the following things need to be finished:
  - [x] Look into customization of settings from e.g. command line arguments.
 - [x] Good, unicode-compliant, string generators.
 - [x] Filtering generator outputs.
+- [x] Before/after/around hooks to add setup/teardown logic to be called before/after/around each time a check is run with new data.
 
 # Nice-to-haves
  
@@ -87,7 +88,8 @@ Here we check if `naive_average` indeed always returns an integer for all arrays
 def naive_average(array)
   array.sum / array.length
 end
-
+```
+```ruby
 # And then in a test case:
 include PropCheck::Generators
 PropCheck.forall(numbers: array(integer)) do |numbers:|
@@ -96,6 +98,19 @@ PropCheck.forall(numbers: array(integer)) do |numbers:|
     raise "Expected the average to be an integer!"
   end
 end
+
+# Or if you e.g. are using RSpec:
+describe "#naive_average" do
+  include PropCheck
+  include PropCheck::Generators
+
+  it "returns an integer for any input" do
+    forall(numbers: array(integer)) do |numbers:|
+      result = naive_average(numbers)      
+      expect(result).to be_a(Integer)
+    end
+  end
+end
 ```
 
 When running this particular example PropCheck very quickly finds out that we have made a programming mistake:

data/lib/prop_check/hooks.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+##
+# Contains the logic to combine potentially many before/after/around hooks
+# into a single pair of procedures called `before` and `after`.
+#
+# _Note: This module is an implementation detail of PropCheck._
+#
+# These can be invoked by manually calling `#before` and `#after`.
+# Important:
+# - Always call first `#before` and then `#after`.
+#   This is required to make sure that `around` callbacks will work properly.
+# - Make sure that if you call `#before`, to also call `#after`.
+#   It is thus highly recommended to call `#after` inside an `ensure`.
+#   This is to make sure that `around` callbacks indeed perform their proper cleanup.
+#
+# Alternatively, check out `PropCheck::Hooks::Enumerable` which allows
+# wrapping the elements of an enumerable with hooks.
+class PropCheck::Hooks
+  # attr_reader :before, :after, :around
+  def initialize()
+    @before = proc {}
+    @after = proc {}
+    @around = proc { |*args, &block| block.call(*args) }
+  end
+
+  def wrap_enum(enumerable)
+    PropCheck::Hooks::Enumerable.new(enumerable, self)
+  end
+
+
+  ##
+  # Wraps a block with all hooks that were configured this far.
+  #
+  # This means that whenever the block is called,
+  # the before/around/after hooks are called before/around/after it.
+  def wrap_block(&block)
+    proc { |*args| call(*args, &block) }
+  end
+
+  ##
+  # Wraps a block with all hooks that were configured this far,
+  # and immediately calls it using the given `*args`.
+  #
+  # See also #wrap_block
+  def call(*args, &block)
+    begin
+      @before.call()
+      @around.call do
+        block.call(*args)
+      end
+    ensure
+      @after.call()
+    end
+  end
+
+  ##
+  # Adds `hook` to the `before` proc.
+  # It is called after earlier-added `before` procs.
+  def add_before(&hook)
+    old_before = @before
+    @before = proc {
+      old_before.call
+      hook.call
+    }
+  end
+
+  ##
+  # Adds `hook` to the `after` proc.
+  # It is called before earlier-added `after` procs.
+  def add_after(&hook)
+    old_after = @after
+    @after = proc {
+      hook.call
+      old_after.call
+    }
+  end
+
+  ##
+  # Adds `hook` to the `around` proc.
+  # It is called _inside_ earlier-added `around` procs.
+  def add_around(&hook)
+    old_around = @around
+    @around = proc do |&block|
+      old_around.call do |*args|
+        hook.call(*args, &block)
+      end
+    end
+  end
+
+  ##
+  # Wraps enumerable `inner` with a `PropCheck::Hooks` object
+  # such that the before/after/around hooks are called
+  # before/after/around each element that is fetched from `inner`.
+  #
+  # This is very helpful if you need to perform cleanup logic
+  # before/after/around e.g. data is generated or fetched.
+  #
+  # Note that whatever is after a `yield` in an `around` hook
+  # is not guaranteed to be called (for instance when a StopIteration is raised).
+  # Thus: make sure you use `ensure` to clean up resources.
+  class Enumerable
+    include ::Enumerable
+
+    def initialize(inner, hooks)
+      @inner = inner
+      @hooks = hooks
+    end
+
+    def each(&task)
+      return to_enum(:each) unless block_given?
+
+      enum = @inner.to_enum
+
+      wrapped_yielder = @hooks.wrap_block do
+        yield enum.next(&task)
+      end
+
+      loop(&wrapped_yielder)
+    end
+  end
+end

data/lib/prop_check/property.rb

@@ -2,6 +2,7 @@ require 'stringio'
 require "awesome_print"
 
 require 'prop_check/property/configuration'
+require 'prop_check/hooks'
 module PropCheck
   ##
   # Run properties
@@ -67,6 +68,7 @@ module PropCheck
       @kwbindings = kwbindings
       @condition = proc { true }
       @config = self.class.configuration
+      @hooks = PropCheck::Hooks.new
     end
 
     ##
@@ -103,13 +105,28 @@ module PropCheck
     # Only filter if you have few inputs to reject. Otherwise, improve your generators.
     def where(&condition)
       original_condition = @condition.dup
-      @condition = proc do |**kwargs|
-        original_condition.call(**kwargs) && condition.call(**kwargs)
+      @condition = proc do |*args|
+        original_condition.call(*args) && condition.call(*args)
       end
 
       self
     end
 
+    def before(&hook)
+      @hooks.add_before(&hook)
+      self
+    end
+
+    def after(&hook)
+      @hooks.add_after(&hook)
+      self
+    end
+
+    def around(&hook)
+      @hooks.add_around(&hook)
+      self
+    end
+
     ##
     # Checks the property (after settings have been altered using the other instance methods in this class.)
     def check(&block)
@@ -127,7 +144,7 @@ module PropCheck
       n_successful = 0
 
       # Loop stops at first exception
-      attempts_enumerator(binding_generator).each do |generator_result|
+      attempts_enum(binding_generator).each do |generator_result|
         n_runs += 1
         check_attempt(generator_result, n_successful, &block)
         n_successful += 1
@@ -182,10 +199,15 @@ module PropCheck
       raise e, output_string, e.backtrace
     end
 
-    private def attempts_enumerator(binding_generator)
+    private def attempts_enum(binding_generator)
+        @hooks
+        .wrap_enum(raw_attempts_enum(binding_generator))
+        .lazy
+        .take(@config.n_runs)
+    end
 
+    private def raw_attempts_enum(binding_generator)
       rng = Random::DEFAULT
-      n_runs = 0
       size = 1
       (0...@config.max_generate_attempts)
         .lazy
@@ -193,12 +215,10 @@ module PropCheck
         .reject { |val| val.root.any? { |elem| elem == :"_PropCheck.filter_me" }}
         .select { |val| @condition.call(*val.root) }
         .map do |result|
-          n_runs += 1
           size += 1
 
           result
         end
-        .take_while { n_runs <= @config.n_runs }
     end
 
     private def show_problem_output(problem, generator_results, n_successful, &block)
@@ -253,7 +273,7 @@ module PropCheck
       parent_siblings = nil
       problem_exception = nil
       shrink_steps = 0
-      (0..@config.max_shrink_steps).each do
+      @hooks.wrap_enum(0..@config.max_shrink_steps).lazy.each do
         begin
           sibling = siblings.next
         rescue StopIteration

data/lib/prop_check/version.rb

@@ -1,3 +1,3 @@
 module PropCheck
-  VERSION = "0.9.0"
+  VERSION = '0.10.0'
 end

data/prop_check.gemspec

@@ -36,7 +36,5 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.5.1'
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency 'awesome_print', '~> 1.8'
 end

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: prop_check
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Qqwy/Wiebe-Marten Wijnja
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '1.8'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.8'
 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
@@ -71,7 +43,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -82,6 +53,7 @@ files:
 - lib/prop_check/generators.rb
 - lib/prop_check/helper.rb
 - lib/prop_check/helper/lazy_append.rb
+- lib/prop_check/hooks.rb
 - lib/prop_check/lazy_tree.rb
 - lib/prop_check/property.rb
 - lib/prop_check/property/configuration.rb

data/Gemfile.lock

@@ -1,50 +0,0 @@
-PATH
-  remote: .
-  specs:
-    prop_check (0.9.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    awesome_print (1.8.0)
-    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 (12.3.3)
-    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
-  awesome_print
-  bundler (~> 2.0)
-  doctest-rspec
-  prop_check!
-  rake (~> 12.3)
-  rspec (~> 3.0)
-  simplecov
-
-BUNDLED WITH
-   2.1.4