mrproper 0.0.1

data/README.md

@@ -0,0 +1,106 @@
+# MrProper
+
+MrProper is a [MiniTest](http://rubydoc.info/stdlib/minitest/1.9.2/frames)-based library to do Property Based Testing a la [Haskell](http://haskell.org/haskellwiki/Haskell)'s [QuickCheck](http://hackage.haskell.org/package/QuickCheck).
+
+Property Based Testing is an alternative approach to unit testing for testing functional style functions/methods. Instead of using examples and testing the return value of your function for each example, you:
+
+1. Define the kind of data your function/method is supposed to accept
+2. Define predicates (properties) your function/method is supposed to comply with
+
+Then MrProper uses that info to randomly check lots of test cases so that you can find extra edge cases you might have forgotten in your unit tests or implementation.
+
+In order to do so, MrProper provides a very simple DSL, with just three methods, `properties`, `data` and `property`. For example, we could describe a `double` function in terms of properties:
+
+    require 'mrproper'
+    
+    properties 'double' do
+      data Integer
+      data Float
+      
+      property 'is the same as adding twice' do |data|
+        assert_equal data + data, double(data)
+      end
+    end
+
+## Running the properties
+
+After implementing `double` (we'll leave that as an exercise `;)`), we run the properties as a regular MiniTest test file:
+
+    $ testrb double_properties.rb
+    Run options: 
+
+    # Running tests:
+
+    .
+
+    Finished tests in 0.001625s, 615.3846 tests/s, 123076.9231 assertions/s.
+
+    1 tests, 200 assertions, 0 failures, 0 errors, 0 skips
+    
+Only one test runs, but notice the insane number of assertions: a lot of random `Integer` and `Float` values generated for you.
+
+If we happen to have a buggy `double` implementation which fails for numbers greater than 20 (we're crappy developers, thats why we want tests!), MrProper will tell you the first case it finds that proves the property false:
+
+    def double(i)
+      return -666 if i > 20
+      i * 2
+    end
+
+And run the properties again:
+
+    $ testrb double_properties.rb
+    Run options: 
+
+    # Running tests:
+
+    F
+
+    Finished tests in 0.030735s, 32.5362 tests/s, 97.6086 assertions/s.
+
+      1) Failure:
+    test_property: "is the same as adding twice"
+    Property "is the same as adding twice" is falsable for data 39
+    Expected: 78
+      Actual: -666
+
+    1 tests, 3 assertions, 1 failures, 0 errors, 0 skips
+    
+## Data generation DSL
+
+In addition to plain class names, we can feed `data` with more or less complex expressions to define data structures:
+
+    data [String]               # generates arrays of strings such as
+                                # ["QC", "QyNYF", "ZRHehcux", "HPos"]
+                                # ["arnyaZWp", "U"] (or [])
+    data [Integer, String]      # generates arrays of one integer and
+                                # one string such as [-89, "cDoZZRzGco"]
+                                # or [-44, "eB"]
+    data [[Float]]              # generates arrays of arrays of floats
+                                # such as [[0.12, 3.41], [-2.31]]
+    data({Symbol => String})    # generates hashes whose keys are symbols
+                                # and whose values are strings such as
+                                # {:tR=>"m", :aSKnsndwWK=>"QUrGwAAh"}
+                                # (in the hashes example, we need to use
+                                # parenthesis because otherwise the Ruby
+                                # parser thinks we're defining a block `;)`)
+    data({String => [Integer]}) # generates hashes whose keys are strings
+                                # and whose values are arrays of integers
+
+In case this is not enough, you can just use a block and do whatever you want to generate the data:
+
+    data do
+      rand > 0.5 ? Wadus.new(rand(9)) : FooBar.new(rand(9))
+    end
+
+## Todo
+
+* Make it work in other rubies than 1.9.3
+
+## License
+
+Released under the [MIT license](http://github.com/porras/property/blob/master/LICENSE)
+
+## Credits
+
+Created during [railscamp-es](https://rails-camp-es.jottit.com/) '2011 by Sergio Gil ([@porras](http://github.com/porras)) and Mari Carmen Gutiérrez ([@valakirka](http://github.com/valakirka)), with ideas from Luismi Cavallé ([@cavalle](http://github.com/cavalle)) and feedback from many other atendees. Thank you everyone!
+

data/lib/mrproper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'mrproper/base'
+require 'mrproper/dsl'
+require 'mrproper/core_extensions/string_extensions'
+
+include MrProper

data/lib/mrproper/base.rb

@@ -0,0 +1,25 @@
+module MrProper
+  
+  def properties(name, &block)
+    dsl = MrProper::DSL.new
+    dsl.instance_eval(&block)
+    Class.new(MiniTest::Unit::TestCase).class_eval do
+      include PropertiesHelper if const_defined?(:PropertiesHelper)
+      dsl.properties.each do |message, test_block|
+        define_method "test_property: #{message.inspect}" do
+          dsl.data_blocks.each do |data_block|
+            TESTS_PER_PROPERTY.times do
+              data = data_block.call
+              begin
+                instance_exec(data, &test_block)
+              rescue MiniTest::Assertion => e
+                raise MiniTest::Assertion.new("Property #{message.inspect} is falsable for data #{data.inspect}\n#{e.message}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+  
+end

data/lib/mrproper/core_extensions/string_extensions.rb

@@ -0,0 +1,7 @@
+class String
+  @@chars ||= ('a'..'z').to_a + ('A'..'Z').to_a
+  
+  def self.random(size = 8)
+    (0..size).map{ @@chars[rand(@@chars.length)] }.join
+  end
+end

data/lib/mrproper/dsl.rb

@@ -0,0 +1,61 @@
+module MrProper
+  
+  TESTS_PER_PROPERTY = 100
+  
+  class DSL
+    
+    attr_reader :properties, :data_blocks
+    
+    def initialize
+      @properties = []
+      @data_blocks = []
+    end
+    
+    def data(spec = nil, &block)
+      @data_blocks << data_block(spec, &block)
+    end
+    
+    def property(message, &block)
+      @properties << [message, block]
+    end
+    
+    private
+    
+    def data_block(spec = nil, &block)
+      return block if block_given?
+      
+      case spec
+      when Array
+        if spec.size == 1
+          Proc.new { rand(20).times.map { data_block(spec.first).call } }
+        else
+          Proc.new { spec.map { |spec| data_block(spec).call }}
+        end
+      when Hash
+        Proc.new do
+          {}.tap do |h|
+            rand(20).times.each do
+              h[data_block(spec.keys.first).call] = data_block(spec.values.first).call
+            end
+          end
+        end
+      when Class
+        if spec == Integer
+          Proc.new { rand(1000) - 500 }
+        elsif spec == Float
+          Proc.new { rand * 10 - 10 }
+        elsif spec == String
+          Proc.new { String.random(rand(10)) }
+        elsif spec == Symbol
+          Proc.new { data_block(String).call.to_sym }
+        elsif spec == NilClass
+          Proc.new { nil }
+        end
+      else
+        Proc.new { spec }
+      end
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: mrproper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sergio Gil
+- Mari Carmen Gutiérrez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-06 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: sgilperez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/mrproper/base.rb
+- lib/mrproper/core_extensions/string_extensions.rb
+- lib/mrproper/dsl.rb
+- lib/mrproper.rb
+homepage: http://github.com/porras/mrproper
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Property Based Testing library
+test_files: []