minitest-proptest 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0596e6f6a66614dba0199eccc4e18a5bf6b869fd0db46dff7636a8772eacb75b'
-  data.tar.gz: a956c579c5bb355a5b687f64109917918870dd7dac1323a18a72d44e4ca623a6
+  metadata.gz: 61aa3a3421a7b1996cf35540600199e11d18bbf5959d96866f994be97f372bcf
+  data.tar.gz: f89adae15e67f595c56f274d034b18e3e325fe097865ef60f42a7d49f7509214
 SHA512:
-  metadata.gz: d6206c7a778b9b55e0674e204afea71721eb8b6e4fe2257691cc1cefd5e76885eff08d648f9a61172806872f1abe5f1b232186fcc803e6fcc560241fd71fac8c
-  data.tar.gz: 1ca1d04ddcdecb9f661e0af6cffc87dda30af6a9b06bb6fe406a5f27ec445a0cf3cd9ac4d9050b4a243ab40d76d066358f6cf9612181cc546a2076b76a7d9041
+  metadata.gz: 6c114584acb4f0d59d93958c65e665a5acde52dce3083f1a1343e8cc85962ec11f4e8e582821bf86002cb2e02cfe45d255fe653450944fdc573112168a734520
+  data.tar.gz: 4f23345243cb106aa1fca9e4d9a4c87c6c20e22407e2564990de246cb81c95f96a2e8138a3991121ab24a2b2bfa9bf5066a7cdc3b639f0880d6e1170bd214652

data/lib/minitest/proptest/property.rb

@@ -14,6 +14,10 @@ module Minitest
       def initialize(
         # The function which proves the property
         test_proc,
+        # The file in which our property lives
+        filename,
+        # The method containing our property
+        methodname,
         # Any class which provides `rand` accepting both an Integer and a Range
         # is acceptable.  The default value is Ruby's standard Mersenne Twister
         # implementation.
@@ -33,6 +37,8 @@ module Minitest
         previous_failure: []
       )
         @test_proc         = test_proc
+        @filename          = filename
+        @methodname        = methodname
         @random            = random.call
         @generator         = ::Minitest::Proptest::Gen.new(@random)
         @max_success       = max_success
@@ -50,6 +56,7 @@ module Minitest
         @generated         = []
         @arbitrary         = nil
         @previous_failure  = previous_failure.to_a
+        @local_variables   = {}
       end
 
       def run!
@@ -58,21 +65,6 @@ module Minitest
         shrink!
       end
 
-      def arbitrary(*classes)
-        if @arbitrary
-          @arbitrary.call(*classes)
-        else
-          a = @generator.for(*classes)
-          @generated << a
-          @status = Status.overrun unless @generated.length <= @max_size
-          a.value
-        end
-      end
-
-      def where(&b)
-        @valid_test_case &= b.call
-      end
-
       def explain
         prop = if @status.valid?
                  'The property was proved to satsfaction across ' \
@@ -88,10 +80,20 @@ module Minitest
                elsif @status.unknown?
                  'The property has not yet been tested.'
                elsif @status.interesting?
-                 'The property has found the following counterexample after ' \
-                   "#{@valid_test_cases} valid " \
-                   "example#{@valid_test_cases == 1 ? '' : 's'}:\n" \
-                   "#{@generated.map(&:value).inspect}"
+                 info = 'A counterexample to a property has been found after ' \
+                        "#{@valid_test_cases} valid " \
+                        "example#{@valid_test_cases == 1 ? '' : 's'}.\n"
+                 var_info = if @local_variables.empty?
+                              'Variables local to the property were unable ' \
+                                'to be determined.  This is usually a bug.'
+                            else
+                              "The values at the time of the failure were:\n"
+                            end
+                 vars = @local_variables
+                        .map { |k, v| "\t#{k}: #{v.inspect}" }
+                        .join("\n")
+
+                 info + var_info + vars
                elsif @status.exhausted?
                  "The property was unable to generate #{@max_success} test " \
                    'cases before generating ' \
@@ -112,6 +114,21 @@ module Minitest
 
       private
 
+      def arbitrary(*classes)
+        if @arbitrary
+          @arbitrary.call(*classes)
+        else
+          a = @generator.for(*classes)
+          @generated << a
+          @status = Status.overrun unless @generated.length <= @max_size
+          a.value
+        end
+      end
+
+      def where(&b)
+        @valid_test_case &= b.call
+      end
+
       def iterate!
         while continue_iterate? && @result.nil? && @valid_test_cases <= @max_success
           @valid_test_case = true
@@ -198,6 +215,17 @@ module Minitest
         candidates     = @generated.map(&:shrink_candidates)
         old_arbitrary  = @arbitrary
 
+        local_variables = {}
+        tracepoint = TracePoint.new(:b_return) do |trace|
+          if trace.path == @filename && trace.method_id.to_s == @methodname
+            b     = trace.binding
+            vs    = b.local_variables
+            known = vs.to_h { |lv| [lv.to_s, b.local_variable_get(lv)] }
+            local_variables.delete_if { true }
+            local_variables.merge!(known)
+          end
+        end
+
         to_test = candidates
                   .map    { |x| x.map { |y| [y] } }
                   .reduce { |c, e| c.flat_map { |a| e.map { |b| a + b } } }
@@ -223,6 +251,7 @@ module Minitest
           @generator = ::Minitest::Proptest::Gen.new(@random)
           if to_test[run[:run]].map(&:first).reduce(&:+) < best_score
             success = begin
+                        tracepoint.enable
                         instance_eval(&@test_proc)
                       rescue Minitest::Assertion
                         false
@@ -232,10 +261,12 @@ module Minitest
                         @status = Status.invalid
                         @excption = e
                         break
+                      ensure
+                        tracepoint.disable
                       end
 
             if !success && @valid_test_case
-              # The first hit is guaranteed to be the best scoring due to the
+              # The first hit is guaranteed to be the best scoring since the
               # shrink candidates are pre-sorted.
               best_generated = @generated
               break
@@ -245,12 +276,14 @@ module Minitest
           @calls    += 1
           run[:run] += 1
         end
+
         # Clean up after we're done
-        @generated = best_generated
-        @result    = best_generated
-        @generator = old_generator
-        @random    = old_random
-        @arbitrary = old_arbitrary
+        @generated       = best_generated
+        @result          = best_generated
+        @generator       = old_generator
+        @random          = old_random
+        @arbitrary       = old_arbitrary
+        @local_variables = local_variables
       end
 
       def continue_iterate?

data/lib/minitest/proptest/version.rb

@@ -2,6 +2,6 @@
 
 module Minitest
   module Proptest
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

data/lib/minitest/proptest_plugin.rb

@@ -63,6 +63,8 @@ module Minitest
 
       prop = Minitest::Proptest::Property.new(
         f,
+        file,
+        methodname,
         random: random_thunk,
         max_success: Proptest.max_success,
         max_discard_ratio: Proptest.max_discard_ratio,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minitest-proptest
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tina Wuest
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest