rantly 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8db5bd7182d7f9e17c430588587617eaa712dd6d
-  data.tar.gz: 5812264178d1640909ba3ea004b777ecea8e78e6
+  metadata.gz: 9f2c8ec7d03b419778a6671029bf86bf946d4e06
+  data.tar.gz: 3363b988ec1f4a7ee3a03f22f99f41b3783c20eb
 SHA512:
-  metadata.gz: 36ffb950c9e4f23e5a7e02183bf7a4e7de2c35eac5431ffb4adb96266289097133c44ee7de1dd56db18a6553f45e36b580de1f4c91b9f1ad413adfae6b9a3744
-  data.tar.gz: b04342e87f28f5ef185ee6798bb8e7a119444c27d4b1fb0146cccd3e43ca13654fba3925ecc7914501b3336ead47055fa147d74f83874fb26b236a2522474f14
+  metadata.gz: aa41245990c513af23ca3830db8403d4fb7e3108ef2216aa562399e6c590baafc11d3be1970b0c9fdc8c785366535c67901bd4cd6e61a39b135e887a3da60ae5
+  data.tar.gz: 593f20b00e41d467c213372b031578921fdbd4bb6bd5295ae85ffb389c1c62c9b8a7e981034fb9b52b1c356dc552acbb38aaa6af3d5c9d629eaf487617d5ecbf

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Change Log
+All notable changes to rantly will be documented in this file. The curated log begins at changes to version 0.4.0.
+
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [1.0.0][1.0.0] - 2016-07-06
+### Added
+- Trying harder to shrink collections instead of giving up on first success of property (thanks [Eric Bischoff][Eric Bischoff]).
+- Added convenience classes Deflating and Tuple for more control on shrinking (thanks [Eric Bischoff][Eric Bischoff]).
+- Added usage examples for Deflating and Tuple shrinking strategies (thanks [Oleksii Fedorov][Oleksii Fedorov]).
+- `Property#check` will now use the `RANTLY_COUNT` environment variable to control the number of values generated (thanks [Jamie English][Jamie English]).
+
+### Major changes
+- Array shrink was removed in favor of Tuple and Deflating.
+
+## [0.3.2][0.3.2] - 2015-09-16
+### Added
+- Ability to shrink an object (`Integer`, `String`, `Array`, `Hash`). This is useful in finding the minimum value that fails a property check condition.
+
+### Changed
+- Improved RSpec and Minitest test extensions.
+- Improved readability and execution of test suite ([Issue #4][4]).
+- Updates to documentation.
+
+[1.0.0]:           https://github.com/abargnesi/rantly/compare/0.3.2...1.0.0
+[0.3.2]:           https://github.com/abargnesi/rantly/compare/0.3.1...0.3.2
+[4]:               https://github.com/abargnesi/rantly/issues/13
+[Eric Bischoff]:   https://github.com/Bischoff
+[Jamie English]:   https://github.com/english
+[Oleksii Fedorov]: https://github.com/waterlink

data/README.textile

@@ -1,26 +1,12 @@
-!https://travis-ci.org/hayeah/rantly.png?branch=master!:https://travis-ci.org/hayeah/rantly
+!https://badge.fury.io/rb/rantly.svg!:https://badge.fury.io/rb/rantly
 
-h1. Repository move (Beginning 2015-07-07)
-
-The official _rantly_ repository has moved from "hayeah/rantly":https://github.com/hayeah/rantly to "abargnesi/rantly":https://github.com/abargnesi/rantly. The creator of _rantly_ is "Howard Yeh":https://github.com/hayeah. "Anthony Bargnesi":https://github.com/abargnesi is the current maintainer.
-
-New development will occur in "abargnesi/rantly":https://github.com/abargnesi/rantly.
-
-The transition plan is as follows:
-
-* [x] Investigate and move open issues from "hayeah/rantly":https://github.com/hayeah/rantly to "abargnesi/rantly":https://github.com/abargnesi/rantly.
-* [x] Evaluate and likely merge pull requests into hayeah/rantly. Push these changes to "abargnesi/rantly":https://github.com/abargnesi/rantly.
-* [x] Move over any closed issues that have relevant discourse.
-* [ ] Fix open issues.
-* [x] Push new gem version after testing functionality.
-* [ ] Continue new development; Changes will be pushed back upstream to "hayeah/rantly":https://github.com/hayeah/rantly over the course of the next month.
-* [x] Added CHANGELOG markdown file. Includes what was added between 0.3.1 (2011-12-15) and 0.3.2 (2015-09-16).
+!https://travis-ci.org/abargnesi/rantly.svg?branch=master!:https://travis-ci.org/abargnesi/rantly
 
 h1. Imperative Random Data Generator and Quickcheck
 
-You can use Rant to generate random test data, and use its Test::Unit extension for property-based testing.
+You can use Rantly to generate random test data, and use its Test::Unit extension for property-based testing.
 
-Rant is basically a recursive descent interpreter, each of its method returns a random value of some type (string, integer, float, etc.).
+Rantly is basically a recursive descent interpreter, each of its method returns a random value of some type (string, integer, float, etc.).
 
 Its implementation has no alien mathematics inside. Completely side-effect-free-free.
 
@@ -331,6 +317,26 @@ property_of {
 }
 </code></pre>
 
+To control the number of property tests to generate, you have three options. In order of precedence:
+
+# Pass an integer argument to @check@
+
+<pre><code>
+property_of {
+  integer
+}.check(9000) { |i|
+  assert_kind_of Integer, i
+}
+</code></pre>
+
+#_ Set the @RANTLY_COUNT@ environment variable
+
+<pre><code>
+RANTLY_COUNT=9000 ruby my_property_test.rb
+</code></pre>
+
+#_ If neither of the above are set, the default will be to run the @check@ block 100 times.
+
 If you wish to have quiet output from Rantly, set environmental variable:
 <pre><code>
 RANTLY_VERBOSE=0 # silent
@@ -345,13 +351,19 @@ Shrinking reduces the value of common types to some terminal lower bound. These
 For example a <code>String</code> is shrinkable until it is empty (e.g. <code>""</code>),
 
 <pre><code>
-"foo".shrink               # => "fo"
-"foo".shrink.shrink        # => "f"
-"foo".shrink.shrink.shrink # => ""
-"".shrinkable?             # => false
+"foo".shrinkable?     # => true
+"foo".shrink          # => "fo"
+"fo".shrink           # => "f"
+"f".shrink            # => ""
+"".shrinkable?        # => false
 </code></pre>
 
-Shrinking allows <code>Property#check</code> to find the minimum value that still fails the condition.
+Shrinking allows <code>Property#check</code> to find a reduced value that still fails the condition. The value is not truely minimal because:
+
+* we do not perform a complete in-depth traversal of the failure tree
+* we limit the search to a maximum 1024 shrinking operations
+
+but is usually reduced enough to start debugging.
 
 Enable shrinking with
 
@@ -359,8 +371,29 @@ Enable shrinking with
 require 'rantly/shrinks'
 </code></pre>
 
+Use <code>Tuple</code> class if you want an array whose elements are individually shrinked, but are not removed. Example:
+
+<pre><code>
+property_of {
+  len = range(0, 10)
+  Tuple.new( array(len) { integer } )
+}.check {
+  # .. property check here ..
+}
+</code></pre>
+
+Use <code>Deflating</code> class if you want an array whose elements are individully shrinked whenever possible, and removed otherwise. Example:
+
+<pre><code>
+property_of {
+  len = range(0, 10)
+  Deflated.new( array(len) { integer } )
+}.check {
+  # .. property check here ..
+}
+</code></pre>
 
-That's about it. Enjoy :)
+Normal arrays or hashes are not shrinked.
 
 
 h1. Copyright

data/Rakefile

@@ -6,9 +6,9 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "rantly"
     gem.summary = %Q{Ruby Imperative Random Data Generator and Quickcheck}
-    gem.email = ["hayeah@gmail.com", "abargnesi@gmail.com"]
+    gem.email = ["hayeah@gmail.com", "abargnesi@gmail.com", "ebischoff@nerim.net"]
     gem.homepage = "https://github.com/abargnesi/rantly"
-    gem.authors = ["Howard Yeh", "Anthony Bargnesi"]
+    gem.authors = ["Howard Yeh", "Anthony Bargnesi", "Eric Bischoff"]
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :build: 
-:major: 0
-:minor: 3
-:patch: 2
+:major: 1
+:minor: 0
+:patch: 0

data/lib/rantly/property.rb

@@ -6,6 +6,7 @@ class Rantly::Property
   attr_reader :failed_data, :shrunk_failed_data, :io
 
   VERBOSITY = ENV.fetch('RANTLY_VERBOSE'){ 1 }.to_i
+  RANTLY_COUNT = ENV.fetch('RANTLY_COUNT'){ 100 }.to_i
 
   def io
     @io ||= if VERBOSITY >= 1
@@ -23,7 +24,7 @@ class Rantly::Property
     @property = property
   end
 
-  def check(n=100,limit=10,&assertion)
+  def check(n=RANTLY_COUNT,limit=10,&assertion)
     i = 0
     test_data = nil
     begin
@@ -46,30 +47,39 @@ class Rantly::Property
       pretty_print test_data
       @failed_data = test_data
       if @failed_data.respond_to?(:shrink)
-        @shrunk_failed_data = shrinkify(assertion, @failed_data)
-        io.puts "minimal failed data is:"
+        @shrunk_failed_data, @depth = shrinkify(assertion, @failed_data)
+        io.puts "minimal failed data (depth #{@depth}) is:"
         pretty_print @shrunk_failed_data
       end
       raise boom
     end
   end
 
-  # return the first success case
-  def shrinkify(assertion, data)
-    # We assume that data.shrink is non-destructive
-    return data if !data.shrinkable?
-    val = data.shrink
-    begin
-      assertion.call(val)
-      io.puts "found a reduced success:"
-      pretty_print val
-      return data
-    rescue Exception
-      io.puts "found a reduced failure case:"
-      pretty_print val
-      # recursively shrink failure case
-      return shrinkify(assertion,val)
+  # Explore the failures tree
+  def shrinkify(assertion, data, depth=0, iteration=0)
+    io.puts "Shrinking at depth #{depth}:"
+    pretty_print data
+
+    min_data = data
+    max_depth = depth
+    if data.shrinkable?
+      while iteration < 1024 do
+        # We assume that data.shrink is non-destructive
+        shrunk_data = data.shrink
+        begin
+          assertion.call(shrunk_data)
+        rescue Exception
+          # If the assertion was verified, recursively shrink failure case
+          branch_data, branch_depth, iteration = shrinkify(assertion, shrunk_data, depth + 1, iteration + 1)
+          if branch_depth > max_depth
+            min_data = branch_data
+            max_depth = branch_depth
+          end
+        end
+        break if !data.retry?
+      end
     end
+    return min_data, max_depth, iteration
   end
 
   def report

data/lib/rantly/shrinks.rb

@@ -1,11 +1,22 @@
+# Integer : shrink to zero
 class Integer
   def shrink
-    if self < 0 then (self / 2).floor + 1
-    elsif self <= 10 && self > 0 then self - 1
-    elsif self > 0 then ((self + 1) / 2).ceil - 1
+    shrunk = if self > 8
+      self / 2
+    elsif self > 0
+      self - 1
+    elsif self < -8
+      (self + 1) / 2
+    elsif self < 0
+      self + 1
     else
-      return 0
+      0
     end
+    return shrunk
+  end
+
+  def retry?
+    false
   end
 
   def shrinkable?
@@ -13,16 +24,19 @@ class Integer
   end
 end
 
+# String : shrink to ""
 class String
   def shrink
+    shrunk = self.dup
     if self.size > 0
       idx = Random::rand(self.size)
-      shrunk = self.dup
       shrunk[idx] = ""
-      return shrunk
-    else
-      return ""
     end
+    return shrunk
+  end
+
+  def retry?
+    false
   end
 
   def shrinkable?
@@ -30,26 +44,129 @@ class String
   end
 end
 
-class Array
+# Array where elements can be shrunk but not removed
+class Tuple
+  def initialize(a)
+    @array = a
+    @position = a.size - 1
+  end
+
+  def [](i)
+    @array[i]
+  end
+
+  def []=(i, value)
+    @array[i] = value
+  end
+
+  def length
+    @array.length
+  end
+
+  def size
+    self.length
+  end
+
+  def to_s
+    @array.to_s.insert(1, "T ")
+  end
+
+  def inspect
+    self.to_s
+  end
+
+  def each(&block)
+    @array.each(&block)
+  end
+
+  def array
+    return @array
+  end
+
   def shrink
-    idx = find_index{|e| e.respond_to?(:shrinkable?) && e.shrinkable?}
-    if idx != nil
-      clone = self.dup
-      clone[idx] = clone[idx].shrink
-      return clone
-    elsif !self.empty?
-      i = Random::rand(self.length)
-      a2 = self.dup
-      a2.delete_at(i)
-      return a2
-    else
-      return self
+    shrunk = @array.dup
+    while @position >= 0
+      e = @array.at(@position)
+      if e.respond_to?(:shrinkable?) && e.shrinkable?
+        break
+      end
+      @position -= 1
+    end
+    if @position >= 0
+      shrunk[@position] = e.shrink
+      @position -= 1
+    end
+    return Tuple.new(shrunk)
+  end
+
+  def retry?
+    @position >= 0
+  end
+
+  def shrinkable?
+    @array.any? {|e| e.respond_to?(:shrinkable?) && e.shrinkable? }
+  end
+end
+
+# Array where the elements that can't be shrunk are removed
+class Deflating
+  def initialize(a)
+    @array = a
+    @position = a.size - 1
+  end
+
+  def [](i)
+    @array[i]
+  end
+
+  def []=(i, value)
+    @array[i] = value
+  end
+
+  def length
+    @array.length
+  end
+
+  def size
+    self.length
+  end
+
+  def to_s
+    @array.to_s.insert(1, "D ")
+  end
+
+  def inspect
+    self.to_s
+  end
+
+  def each(&block)
+    @array.each(&block)
+  end
+
+  def array
+    return @array
+  end
+
+  def shrink
+    shrunk = @array.dup
+    if @position >= 0
+      e = @array.at(@position)
+      if e.respond_to?(:shrinkable?) && e.shrinkable?
+        shrunk[@position] = e.shrink
+      else
+        shrunk.delete_at(@position)
+      end
+      @position -= 1
     end
+    return Deflating.new(shrunk)
+  end
+
+  def retry?
+    @position >= 0
   end
 
   def shrinkable?
-    self.any?{|e| e.respond_to?(:shrinkable?) && e.shrinkable? } ||
-      !self.empty?
+    !@array.empty?
   end
 end
 

data/rantly.gemspec

@@ -2,20 +2,21 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rantly 0.3.2 ruby lib
+# stub: rantly 1.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rantly"
-  s.version = "0.3.2"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
-  s.authors = ["Howard Yeh", "Anthony Bargnesi"]
-  s.date = "2015-09-16"
-  s.email = ["hayeah@gmail.com", "abargnesi@gmail.com"]
+  s.authors = ["Howard Yeh", "Anthony Bargnesi", "Eric Bischoff"]
+  s.date = "2016-07-06"
+  s.email = ["hayeah@gmail.com", "abargnesi@gmail.com", "ebischoff@nerim.net"]
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.textile"
+    "README.textile",
+    "CHANGELOG.md"
   ]
   s.files = [
     ".document",
@@ -23,6 +24,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "LICENSE",
     "README.textile",
+    "CHANGELOG.md",
     "Rakefile",
     "VERSION.yml",
     "lib/rantly.rb",

data/test/shrinks_test.rb

@@ -47,24 +47,24 @@ describe String do
   end
 end
 
-describe Array do
+describe Tuple do
 
-  it "not be able to shrink empty array" do
-    assert ![].shrinkable?
+  it "not be able to shrink empty tuple" do
+    assert !Tuple.new([]).shrinkable?
   end
 
-  it "shrink array by trying to shrink the first shrinkable element available" do
-    assert_equal [0,1], [1,1].shrink
-    assert_equal [0,0,1], [0,1,1].shrink
+  it "shrink tuple by trying to shrink the last shrinkable element available" do
+    assert_equal [1,0], Tuple.new([1,1]).shrink.array
+    assert_equal [1,0,0], Tuple.new([1,1,0]).shrink.array
   end
 
-  it "shrink array by 1 if none of the element in it is shrinkable" do
+  it "do not remove element from array when no element is shrinkable" do
     property_of {
       n = integer(1..10)
-      a = Array.new(n,0)
+      a = Tuple.new(Array.new(n,0))
       [n,a]
     }.check { |n,a|
-      assert_equal n-1, a.shrink.length
+      assert_equal n, a.shrink.length
     }
   end
 end
@@ -92,17 +92,17 @@ describe "Shrinker Test" do
     # The property we try to test is that non of the element is
     # larger than 1, and the array's length is less than 4.
     test = property_of {
-      a = Array.new(10,1)
+      a = Deflating.new(Array.new(10,1))
       i = Random::rand(a.length)
       a[i] = 1
       a
     }
     assert_raises MiniTest::Assertion do
       test.check { |a|
-        assert(!a.any? { |e| e > 0 } && a.length < 4,"contains 1")
+        assert(!a.array.any? { |e| e > 0 } && a.length < 4,"contains 1")
       }
     end
 
-    assert_equal [0,0,0,0], test.shrunk_failed_data
+    assert_equal [1], test.shrunk_failed_data.array
   end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rantly
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Howard Yeh
 - Anthony Bargnesi
+- Eric Bischoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -71,14 +72,17 @@ description:
 email:
 - hayeah@gmail.com
 - abargnesi@gmail.com
+- ebischoff@nerim.net
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE
 - README.textile
+- CHANGELOG.md
 files:
 - ".document"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.textile
@@ -119,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby Imperative Random Data Generator and Quickcheck