rubyqc 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69a41de60f5a0b9675a0633fadaf4961e743661d
-  data.tar.gz: 5ec783f8ba6d9f68e0a58d2c5603d7b73da8e649
+  metadata.gz: 2cdbaeefbc325257c82c18d84d307384ccbb88a8
+  data.tar.gz: 5a745da2b4e4266025c3526fe25b71f8076407bc
 SHA512:
-  metadata.gz: fd3c8b14af326d8c19714f6172239bab8568e69d7cdb2fee46c525127532e63cc5bade28450efb0c0ec6378ac61143cfe0933d27ed2e15cff24cd5698fc03803
-  data.tar.gz: 1884e6da6b62adaf3ecfd71918c589988c7a1878bd59b36039b79d90c0f19a9ce2f75432e3ade0ca4e1793d1d2eb1ff46b45a629f6ef2ea95469e003989fa411
+  metadata.gz: 7f4d722f681f47670d3819f29711a74db02f83fb5f96ce2b945588ffbedd38ec5f44742c4df44747eb8fb1ad6406906aaa1b5885ff200aba9dc15e9eaedc2fba
+  data.tar.gz: 95ad3bc090723bcc5511660adeb793323a206931266d3ea18f50ebbf7d47bb08d3155ef77621359ca6e24d347971ddf36b4c3929dbec68ed3b2a57dc15911a07

data/.travis.yml

@@ -1,9 +1,10 @@
-before_install: 'git submodule update --init'
-script: 'ruby -r bundler/setup -S rake test'
 
+language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
   - ruby
-  - rbx
+  - rbx-2
   - jruby
+
+script: 'ruby -r bundler/setup -S rake test'

data/CHANGES.md

@@ -1,5 +1,11 @@
 # CHANGES
 
+## RubyQC 0.0.3 -- 2014-08-01
+
+* Introduce Modifier#parallel to run in parallel.
+* Introduce Proc#rubyqc.
+* Changed that API.someof and API.oneof simply accept an array.
+
 ## RubyQC 0.0.2 -- 2014-04-18
 
 * Renamed one_of to oneof

data/Gemfile

@@ -4,7 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake'
-gem 'bacon'
+gem 'pork'
+gem 'muack'
 
 platform :rbx do
   gem 'rubysl-singleton' # used in rake

data/README.md

@@ -80,20 +80,19 @@ it and raise our level of confidence about correctness.
 
 ### RubyQC::API.check
 
-Here's a quick example using [Bacon][]. We check if `Array#sort` has the
+Here's a quick example using [Pork][]. We check if `Array#sort` has the
 property that the front elements of the result array would be `<=` than
 the rear elements of the result array for all arrays.
 
 ``` ruby
-require 'bacon'
+require 'pork/auto'
 require 'rubyqc'
 
-Bacon.summary_on_exit
 include RubyQC::API
 
 describe Array do
   describe 'sort' do
-    should 'Any front elements should be <= any rear elements' do
+    would 'Any front elements should be <= any rear elements' do
       check([Fixnum]*100).times(10) do |array|
         array.sort.each_cons(2).each{ |x, y| x.should <= y }
       end
@@ -102,7 +101,7 @@ describe Array do
 end
 ```
 
-[Bacon]: https://github.com/chneukirchen/bacon
+[Pork]: https://github.com/godfat/pork
 
 Basically, `RubyQC::API.check` would merely take the arguments and
 generate the instances via `rubyqc` method. Here the generated array
@@ -143,7 +142,7 @@ Here's an example for checking compare_by_identity:
 ``` ruby
 describe Hash do
   describe 'compare_by_identity' do
-    should 'Treat diff arr with the same contents diff when set' do
+    would 'Treat diff arr with the same contents diff when set' do
       arr = [0]
       forall(booleans, [arr, [0]], [arr, [1]]) do |flag, a, b|
         h = {}
@@ -238,11 +237,11 @@ class User < Struct.new(:id, :name)
 end
 
 describe 'User.rubyqc' do
-  should 'Generate random users' do
+  would 'Generate random users' do
     check(User) do |user|
-      user     .should.kind_of User
-      user.id  .should.kind_of Fixnum
-      user.name.should.kind_of String
+      user     .should.kind_of? User
+      user.id  .should.kind_of? Fixnum
+      user.name.should.kind_of? String
     end
   end
 end

data/lib/rubyqc.rb

@@ -1,3 +1,16 @@
 
 require 'rubyqc/api'
 require 'rubyqc/prelude'
+
+module RubyQC
+  singleton_class.module_eval do
+    attr_writer :default_times, :default_parallel
+    def default_times
+      @default_times || 10
+    end
+
+    def default_parallel
+      @default_parallel || 1
+    end
+  end
+end

data/lib/rubyqc/api.rb

@@ -34,11 +34,11 @@ module RubyQC
       end
     end
 
-    def someof num, *args
+    def someof num, args
       SomeOf.new(num, args)
     end
 
-    def oneof *args
+    def oneof args
       OneOf.new(args)
     end
   end

data/lib/rubyqc/error.rb

@@ -0,0 +1,11 @@
+
+module RubyQC
+  class Error < RuntimeError
+    attr_reader :times, :errors
+    def initialize times, errors
+      @times, @errors = times, errors
+      super("RubyQC::Error: #{errors.size} errors out of #{times}:" \
+            " #{errors.inspect}")
+    end
+  end
+end

data/lib/rubyqc/modifier.rb

@@ -1,21 +1,65 @@
 
+require 'rubyqc/error'
+
 module RubyQC
-  class Modifier
+  class Modifier < Struct.new(:args, :errors, :cases, :threads)
     def initialize args, &block
-      @args  = args
-      @times = 10
+      super(args, [], RubyQC.default_times, RubyQC.default_parallel)
       run(&block)
     end
 
     def times t, &block
-      @times = t
+      raise ArgumentError.new(
+        "Must run at least once, but got: #{t}") if t <= 0
+      self.cases = t
+      run(&block)
+    end
+
+    def parallel t, &block
+      raise ArgumentError.new(
+        "Must have at least 1 thread, but got: #{t}") if t <= 0
+      self.threads = t
       run(&block)
     end
 
-    def run
-      @times.times{
-        yield(*@args.map(&:rubyqc))
-      } if block_given?
+    private
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+    def run &block
+      if !block_given?
+        # waiting for block to be given
+      elsif threads == 1
+        run_thread(cases, &block)
+      else
+        divided = cases / threads
+        mod     = cases % threads
+
+        ts = (threads - 1).times.map{
+          Thread.new{ run_thread(divided, &block) }
+        } + [Thread.new{ run_thread(divided + mod, &block) }]
+        ts.each(&:join)
+
+        raise Error.new(cases, errors) unless errors.empty?
+      end
+
+      self
+    end
+
+    def run_thread t
+      t.times do
+        if Thread.current == Thread.main
+          # we raise errors immediately if we're not running in parallels
+          yield(*args.map(&:rubyqc))
+        else
+          begin
+            yield(*args.map(&:rubyqc))
+          rescue Exception => e
+            mutex.synchronize{ errors << e }
+          end
+        end
+      end
     end
   end
 end

data/lib/rubyqc/prelude.rb

@@ -263,6 +263,12 @@ class Range
   end
 end
 
+class Proc
+  def rubyqc
+    call
+  end
+end
+
 # TODO
 class Regexp
   def rubyqc

data/lib/rubyqc/test.rb

@@ -1,21 +1,15 @@
 
-require 'bacon'
+require 'pork/auto'
+require 'muack'
 require 'rubyqc'
 
-Bacon.summary_on_exit
-include RubyQC::API
+# enough of NameError: method `old_init' not defined in SortedSet
+require 'set'
+Set.new
 
-module Kernel
-  def eq? rhs
-    self == rhs
-  end
-end
+Pork::Executor.__send__(:include, RubyQC::API, Muack::API)
 
-class Should
-  def self.rubyqc
-    new(Class.rubyqc.rubyqc)
-  end
-end
+RubyQC.default_parallel = 4
 
 def verify_generated generated, spec
   if spec.empty?
@@ -60,8 +54,8 @@ end
 
 def verify_other generated, spec
   if spec.kind_of?(Class)
-    generated.should.kind_of spec
+    generated.should.kind_of? spec
   else
-    generated.should.eq      spec
+    generated.should.eq       spec
   end
 end

data/lib/rubyqc/version.rb

@@ -1,4 +1,4 @@
 
 module RubyQC
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/rubyqc.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: rubyqc 0.0.2 ruby lib
+# stub: rubyqc 0.0.3 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rubyqc"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-04-18"
+  s.date = "2014-08-01"
   s.description = "RubyQC -- A conceptual [QuickCheck][] library for Ruby.\n\nIt's not a faithful port since Hsakell is totally different than Ruby.\nHowever it's still benefit to use some of the ideas behind QuickCheck,\nand we could also use RubyQC for generating arbitrary objects.\n\n[QuickCheck]: http://en.wikipedia.org/wiki/QuickCheck"
   s.email = ["godfat (XD) godfat.org"]
   s.files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   "lib/rubyqc.rb",
   "lib/rubyqc/all.rb",
   "lib/rubyqc/api.rb",
+  "lib/rubyqc/error.rb",
   "lib/rubyqc/modifier.rb",
   "lib/rubyqc/prelude.rb",
   "lib/rubyqc/stdlib.rb",
@@ -39,14 +40,16 @@ Gem::Specification.new do |s|
   "task/README.md",
   "task/gemgem.rb",
   "test/test_api.rb",
-  "test/test_kind_of.rb",
+  "test/test_modifier.rb",
+  "test/test_prelude.rb",
   "test/test_readme.rb"]
   s.homepage = "https://github.com/godfat/rubyqc"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.2.2"
+  s.rubygems_version = "2.4.1"
   s.summary = "RubyQC -- A conceptual [QuickCheck][] library for Ruby."
   s.test_files = [
   "test/test_api.rb",
-  "test/test_kind_of.rb",
+  "test/test_modifier.rb",
+  "test/test_prelude.rb",
   "test/test_readme.rb"]
 end

data/task/gemgem.rb

@@ -34,7 +34,7 @@ module Gemgem
       s.executables = bin_files
     end
     spec_create.call(spec)
-    spec.homepage = "https://github.com/godfat/#{spec.name}"
+    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
     self.spec = spec
   end
 
@@ -227,10 +227,6 @@ end # of gem namespace
 desc 'Run tests'
 task :test do
   next if Gemgem.test_files.empty?
-
-  require 'bacon'
-  Bacon.extend(Bacon::TestUnitOutput)
-  Bacon.summary_on_exit
   Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
 end
 

data/test/test_api.rb

@@ -3,12 +3,12 @@ require 'rubyqc/test'
 require 'rubyqc/all'
 
 describe RubyQC::API do
-  should 'oneof' do
+  would 'oneof' do
     check([Class]*5) do |klasses|
-      klasses -= [Should] # bacon's Should won't work...
-      check(oneof(*klasses)) do |obj|
+      # klasses -= [Pork::Should] # bacon's Should won't work...
+      check(oneof(klasses)) do |obj|
         begin
-          klasses.find{ |klass| obj.kind_of?(klass) }.should.not.nil
+          klasses.find{ |klass| obj.kind_of?(klass) }.should.not.nil?
         rescue => e
           warn "Cannot find #{obj} in #{klasses}: #{e}"
           raise
@@ -17,38 +17,49 @@ describe RubyQC::API do
     end
   end
 
+  would 'someof' do
+    check(2..5, 6..10) do |n, m|
+      check([Fixnum]*m) do |numbers|
+        check(someof(n, numbers)) do |nums|
+          nums.size.should.eq n
+          nums.should.all?{ |nn| numbers.should.include? nn }
+        end
+      end
+    end
+  end
+
   describe 'forall' do
-    should 'hard code' do
+    would 'hard code' do
       times = 0
       forall([1,2], [3,4], [5,6]) do |a, b, c|
         times += 1
-        [1,2].should.include a
-        [3,4].should.include b
-        [5,6].should.include c
+        [1,2].should.include? a
+        [3,4].should.include? b
+        [5,6].should.include? c
       end
       times.should.eq 2**3
     end
 
-    should 'check' do
+    would 'check' do
       check([Fixnum, Fixnum], [Fixnum, Fixnum], [Fixnum, Fixnum]) do |a, b, c|
         times = 0
         forall(a, b, c) do |aa, bb, cc|
           times += 1
-          a.should.include aa
-          b.should.include bb
-          c.should.include cc
+          a.should.include? aa
+          b.should.include? bb
+          c.should.include? cc
         end
         times.should.eq 2**3
       end
     end
 
-    should 'check check' do
+    would 'check check' do
       check(1..5, 1..5) do |n, m|
         check([[Fixnum]*n.abs]*m.abs) do |a|
           times = 0
           forall(*a) do |*aa|
             times += 1
-            a.zip(aa).each{ |(b, bb)| b.should.include bb }
+            a.zip(aa).each{ |(b, bb)| b.should.include? bb }
           end
           times.should.eq n**m
         end

data/test/test_modifier.rb

@@ -0,0 +1,66 @@
+
+require 'rubyqc/test'
+
+describe RubyQC::Modifier do
+  would 'times' do
+    check(2..10) do |times|
+      t = 0
+      m = Mutex.new
+      check.times(times){ m.synchronize{ t += 1 } }
+      t.should.eq times
+    end
+  end
+
+  describe 'parallel' do
+    would 'have correct times' do
+      check(5..11, 2..4).parallel(1) do |times, parallel|
+        mutex = Mutex.new
+        array = []
+        mock(Thread).new.times(parallel)
+
+        check.times(times).parallel(parallel) do
+          mutex.synchronize{ array << true }
+        end
+
+        Muack.verify.should.eq true
+        array.size.should.eq times
+      end
+    end
+
+    would 'raise error immediately if not running in parallels' do
+      begin
+        t = -1
+        check.times(10).parallel(1) do
+          t += 1
+          raise 'boom'
+        end
+      rescue => e
+        t      .should.eq 0
+        e.class.should.eq RuntimeError
+      end
+    end
+
+    would 'capture errors and report if we are running in parallels' do
+      check(4..8) do |parallel|
+        check(1..parallel) do |errors|
+          t = -1
+          m = Mutex.new
+          begin
+            check.times(10).parallel(parallel) do
+              m.synchronize do
+                t += 1
+                raise t.to_s if t < errors
+              end
+            end
+          rescue RubyQC::Error => e
+            e.times      .should.eq RubyQC.default_times
+            e.errors.size.should.eq errors
+            e.errors.map(&:message).sort.each.with_index do |msg, index|
+              msg.should.eq index.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_prelude.rb

@@ -0,0 +1,34 @@
+
+require 'rubyqc/test'
+
+describe 'prelude' do
+  would 'lambda' do
+    i = 0
+    k = 0
+    check(lambda{ i += 1 }).parallel(1) do |j|
+      k += 1
+      i.should.eq j
+      i.should.eq k
+    end
+  end
+
+  describe 'kind_of' do
+    [Fixnum, Bignum, Array, Integer, Class].each do |klass|
+      would klass.name do
+        check(klass){ |obj| obj.should.kind_of?(klass) }
+      end
+    end
+
+    [[], [Fixnum], [Fixnum, Array],
+     {}, {:a => 0}, {'b' => 1}, {2 => Integer},
+     {nil => [Fixnum]}, {true => {false => [Bignum]}}
+    ].each do |spec|
+
+      would spec.inspect do
+        check(spec) do |generated|
+          verify_generated(generated, spec)
+        end
+      end
+    end
+  end
+end

data/test/test_readme.rb

@@ -3,7 +3,7 @@ require 'rubyqc/test'
 
 describe Array do
   describe 'sort' do
-    should 'Any front elements should be <= any rear elements' do
+    would 'Any front elements should be <= any rear elements' do
       check([Fixnum]*100).times(10) do |array|
         array.sort.each_cons(2).each{ |x, y| x.should <= y }
       end
@@ -13,7 +13,7 @@ end
 
 describe Hash do
   describe 'compare_by_identity' do
-    should 'Treat diff arr with the same contents diff when set' do
+    would 'Treat diff arr with the same contents diff when set' do
       arr = [0]
       forall(booleans, [arr, [0]], [arr, [1]]) do |flag, a, b|
         h = {}
@@ -37,11 +37,11 @@ class User < Struct.new(:id, :name)
 end
 
 describe 'User.rubyqc' do
-  should 'Generate random users' do
+  would 'Generate random users' do
     check(User) do |user|
-      user     .should.kind_of User
-      user.id  .should.kind_of Fixnum
-      user.name.should.kind_of String
+      user     .should.kind_of? User
+      user.id  .should.kind_of? Fixnum
+      user.name.should.kind_of? String
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyqc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-18 00:00:00.000000000 Z
+date: 2014-08-01 00:00:00.000000000 Z
 dependencies: []
 description: |-
   RubyQC -- A conceptual [QuickCheck][] library for Ruby.
@@ -35,6 +35,7 @@ files:
 - lib/rubyqc.rb
 - lib/rubyqc/all.rb
 - lib/rubyqc/api.rb
+- lib/rubyqc/error.rb
 - lib/rubyqc/modifier.rb
 - lib/rubyqc/prelude.rb
 - lib/rubyqc/stdlib.rb
@@ -51,7 +52,8 @@ files:
 - task/README.md
 - task/gemgem.rb
 - test/test_api.rb
-- test/test_kind_of.rb
+- test/test_modifier.rb
+- test/test_prelude.rb
 - test/test_readme.rb
 homepage: https://github.com/godfat/rubyqc
 licenses:
@@ -73,11 +75,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: RubyQC -- A conceptual [QuickCheck][] library for Ruby.
 test_files:
 - test/test_api.rb
-- test/test_kind_of.rb
+- test/test_modifier.rb
+- test/test_prelude.rb
 - test/test_readme.rb

data/test/test_kind_of.rb

@@ -1,22 +0,0 @@
-
-require 'rubyqc/test'
-
-describe 'kind_of' do
-  [Fixnum, Bignum, Array, Integer, Class].each do |klass|
-    should klass.name do
-      check(klass){ |obj| obj.should.kind_of(klass) }
-    end
-  end
-
-  [[], [Fixnum], [Fixnum, Array],
-   {}, {:a => 0}, {'b' => 1}, {2 => Integer},
-   {nil => [Fixnum]}, {true => {false => [Bignum]}}
-  ].each do |spec|
-
-    should spec.inspect do
-      check(spec) do |generated|
-        verify_generated(generated, spec)
-      end
-    end
-  end
-end