properb 0.0.1

data/lib/properb.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "set"
+require_relative "properb/generator"
+require_relative "properb/generators"
+require_relative "properb/rspec"
+require_relative "properb/shrink_tree"
+
+module Properb
+  # This definition is taken from RSpec, in an attempt to remain
+  # consistent with them.
+  module AllExceptionsExceptOnesWeMustNotRescue
+    # These exceptions are dangerous to rescue as rescuing them
+    # would interfere with things we should not interfere with.
+    AVOID_RESCUING = [NoMemoryError, SignalException, Interrupt, SystemExit].freeze
+
+    def self.===(exception)
+      exception.is_a?(Exception) && !AVOID_RESCUING.any? { exception.is_a?(_1) }
+    end
+  end
+
+  def self.rspec_install(config)
+    config.extend Properb::RSpec::ExampleGroupMethods
+    config.include Properb::RSpec::ExampleMethods
+    config.extend Properb::Generators
+  end
+
+  class TestRunner
+    def initialize(block)
+      @block = block
+    end
+
+    def run(values)
+      @block.call(values)
+      true
+    rescue Properb::RSpec::ExampleMethods::AssumptionViolated
+      # These don't count as failures, but they also need to be run
+      # again
+      false
+    rescue AllExceptionsExceptOnesWeMustNotRescue => e
+      string = values.map { |k, v| "#{k} = #{v.inspect}" }.join("\n            ")
+      # Don't leave properb lines in the backtrace - they're not very useful.
+      raise e, <<~MESSAGE, e.backtrace.reject { %r{spec/properb\.rb}.match(_1) }
+        #{e.message}
+
+        with input: #{string}
+      MESSAGE
+    end
+  end
+
+  def self.for_all(generators, size: 0..10, num_tests: 100, assumption_limit: 10, &block)
+    test_runner = TestRunner.new(block)
+
+    random = Random.new
+    generated = nil
+    passed = Set.new
+    generator = Generators.hashmap(generators)
+    current_size = if size.is_a?(Range)
+                     size.min
+                   else
+                     size
+                   end
+    num_tests.times do
+      result = false
+      attempt_number = 0
+      until result
+        if attempt_number >= assumption_limit
+          raise StandardError,
+                "Could not satisfy assumptions after #{assumption_limit} attempts"
+        end
+
+        current_size += 1 if size.is_a?(Range) && size.include?(current_size + 1)
+        generated = generator.generate_value(random, current_size)
+        result = test_runner.run(generated.value)
+        attempt_number += 1
+      end
+      passed << generated.value
+    end
+  rescue AllExceptionsExceptOnesWeMustNotRescue => e
+    exception, = shrink(generated, e, passed, test_runner)
+    raise exception
+  end
+
+  def self.shrink(generated, exception, passed, test_runner)
+    smallest = generated
+    while smallest
+      begin
+        current = nil
+        smallest.children.each do |child|
+          current = child
+          next if passed.include?(current.value)
+
+          if test_runner.run(current.value)
+            passed << current.value
+          else
+            # If the assumptions have failed then we don't learn anything
+            # useful. We process this node's children before continuing,
+            # in the hopes that we get some information from them instead.
+            e, current = shrink(current, exception, passed, test_runner)
+            raise e unless e == exception
+          end
+        end
+        break
+      rescue AllExceptionsExceptOnesWeMustNotRescue => e
+        smallest = current
+        exception = e
+      end
+    end
+    [exception, smallest]
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: properb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Carlo Zancanaro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: |
+  A property-based testing library, in the spirit of Proper in
+  Erlang, with tight integration with RSpec.
+email:
+- carlo@zancanaro.id.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- README.md
+- lib/properb.rb
+- lib/properb/generator.rb
+- lib/properb/generators.rb
+- lib/properb/generators/array_generator.rb
+- lib/properb/generators/choice_generator.rb
+- lib/properb/generators/constant_generator.rb
+- lib/properb/generators/deferred_generator.rb
+- lib/properb/generators/frequencies_generator.rb
+- lib/properb/generators/integer_generator.rb
+- lib/properb/generators/mapped_generator.rb
+- lib/properb/generators/recursive_generator.rb
+- lib/properb/generators/selected_generator.rb
+- lib/properb/generators/sized_generator.rb
+- lib/properb/generators/tuple_generator.rb
+- lib/properb/rspec.rb
+- lib/properb/rspec/example_group_methods.rb
+- lib/properb/rspec/example_methods.rb
+- lib/properb/shrink_tree.rb
+homepage: https://sr.ht/~czan/properb/
+licenses:
+- GPL-3.0-only
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://sr.ht/~czan/properb/
+  source_code_uri: https://sr.ht/~czan/properb/
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Property-based testing in Ruby, with RSpec integration
+test_files: []