rubyqc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ff877141825f4a8516b956d216de5dcae3a9ae9
-  data.tar.gz: 0284ea73671c159c38a5a8c6249e477159666c1f
+  metadata.gz: 69a41de60f5a0b9675a0633fadaf4961e743661d
+  data.tar.gz: 5ec783f8ba6d9f68e0a58d2c5603d7b73da8e649
 SHA512:
-  metadata.gz: a0e49da081b1af4fc05e43be982395ba6fe0521013589c0e244b148873ab2ba7eb7ca3fecf9515ff6454f75c27b5ef9c14998df181c40659830bf8f0b2979273
-  data.tar.gz: c4427a5669c4c7d9c7085e562c6d4f1d1aa4ef833513ac893f9fbd9d3efdb7beee07bc5da82de126252c39bdd75b593ce2875c30d8dcad1ab9f2ad181cd37290
+  metadata.gz: fd3c8b14af326d8c19714f6172239bab8568e69d7cdb2fee46c525127532e63cc5bade28450efb0c0ec6378ac61143cfe0933d27ed2e15cff24cd5698fc03803
+  data.tar.gz: 1884e6da6b62adaf3ecfd71918c589988c7a1878bd59b36039b79d90c0f19a9ce2f75432e3ade0ca4e1793d1d2eb1ff46b45a629f6ef2ea95469e003989fa411

data/.travis.yml

@@ -4,6 +4,6 @@ script: 'ruby -r bundler/setup -S rake test'
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - ruby
   - rbx
   - jruby

data/CHANGES.md

@@ -0,0 +1,11 @@
+# CHANGES
+
+## RubyQC 0.0.2 -- 2014-04-18
+
+* Renamed one_of to oneof
+* Added forall, booleans, and someof
+* Implemented a lot of rubyqc methods
+
+## RubyQC 0.0.1 -- 2014-01-30
+
+* Birthday!

data/README.md

@@ -70,7 +70,7 @@ it and raise our level of confidence about correctness.
 
 ## REQUIREMENTS:
 
-* Tested with MRI (official CRuby) 2.0.0, 2.1.0, Rubinius and JRuby.
+* Tested with MRI (official CRuby), Rubinius and JRuby.
 
 ## INSTALLATION:
 
@@ -78,6 +78,8 @@ it and raise our level of confidence about correctness.
 
 ## SYNOPSIS:
 
+### RubyQC::API.check
+
 Here's a quick example using [Bacon][]. 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.
@@ -130,9 +132,36 @@ class Fixnum
 end
 ```
 
-You get the idea. See next section for the list of built-in generators.
+You get the idea.
+
+### RubyQC::API.forall
 
-### Kernel
+Other than `check`, we also have `forall` which would iterate through all the
+possible choices in case you would simply like to test all combinations.
+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
+      arr = [0]
+      forall(booleans, [arr, [0]], [arr, [1]]) do |flag, a, b|
+        h = {}
+        h.compare_by_identity if flag
+        h[a] = h[b] = true
+
+        if (flag && a.object_id != b.object_id) || a != b
+          h.size.should == 2
+        else
+          h.size.should == 1
+        end
+      end
+    end
+  end
+end
+```
+
+### Kernel generator
 
 The very default generator would simply return the instance itself.
 So if there's no generator defined for a given class or instance, it
@@ -142,7 +171,7 @@ would merely take `self`.
 true.rubyqc # true
 ```
 
-### Class
+### Class generator
 
 This default generator for classes would simply return a new instance via
 `new` method. This could fail if the `initialize` method for the particular
@@ -152,7 +181,7 @@ class does not take zero argument.
 Object.rubyqc # kind_of?(Object)
 ```
 
-### Fixnum, Bignum, and Integer
+### Fixnum, Bignum, and Integer generator
 
 This would give you a random integer. Fixnum and Bignum would guarantee to
 give you the particular class, whereas Integer would give you either a Fixnum
@@ -162,7 +191,7 @@ or Bignum.
 Fixnum.rubyqc # kind_of?(Fixnum)
 ```
 
-### array
+### array generator
 
 We also have instance level generator, which was used in the first example.
 The array instance generator would recursively call `rubyqc` for all elements
@@ -172,7 +201,7 @@ of the array, and collect the results.
 [Fixnum, Fixnum].rubyqc # [kind_of?(Fixnum), kind_of?(Fixnum)]
 ```
 
-### hash
+### hash generator
 
 This also applies to hashes which would do the same thing as arrays for the
 values, keeping the key.
@@ -181,7 +210,7 @@ values, keeping the key.
 {:fixnum => Fixnum}.rubyqc # {:fixnum => kind_of?(Fixnum)}
 ```
 
-### range
+### range generator
 
 Fixnum would actually give a very large or very small (negative) number in
 most cases. If you want to have a number with specific range, use a range
@@ -199,10 +228,32 @@ combinators we need to have a unified interface.
 Just define `rubyqc` method for your classes or instances. This weird name
 was simply chosen to avoid name conflicting since we don't have [typeclass][]
 in Ruby, and it's quite natural to open and insert new methods into classes
-in Ruby.
+in Ruby. Here's a quick example:
+
+``` ruby
+class User < Struct.new(:id, :name)
+  def self.rubyqc
+    new(Fixnum.rubyqc, String.rubyqc)
+  end
+end
+
+describe 'User.rubyqc' do
+  should '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
+    end
+  end
+end
+```
 
 [typeclass]: http://learnyouahaskell.com/types-and-typeclasses
 
+### Implementation reference
+
+[QuickCheck.hs](http://www.cse.chalmers.se/~rjmh/QuickCheck/QuickCheck.hs)
+
 ## CONTRIBUTORS:
 
 * Lin Jen-Shin (@godfat)

data/lib/rubyqc.rb

@@ -1,16 +1,3 @@
 
+require 'rubyqc/api'
 require 'rubyqc/prelude'
-require 'rubyqc/modifier'
-
-module RubyQC
-  module API
-    module_function
-    def check *args, &block
-      RubyQC::Modifier.new(args, &block)
-    end
-
-    def one_of *args
-      args.sample
-    end
-  end
-end

data/lib/rubyqc/all.rb

@@ -0,0 +1,3 @@
+
+require 'rubyqc'
+require 'rubyqc/stdlib'

data/lib/rubyqc/api.rb

@@ -0,0 +1,45 @@
+
+require 'rubyqc/modifier'
+
+module RubyQC
+  module API
+    module_function
+    def check *args, &block
+      RubyQC::Modifier.new(args, &block)
+    end
+
+    def forall *args, &block
+      args[0].product(*args[1..-1]).each do |val|
+        yield(*val)
+      end
+    end
+
+    def booleans
+      [true, false]
+    end
+
+    class SomeOf < Struct.new(:num, :args)
+      def rubyqc
+        args.sample(num).rubyqc
+      end
+    end
+
+    class OneOf < SomeOf
+      def initialize args
+        super(1, args)
+      end
+
+      def rubyqc
+        super.first
+      end
+    end
+
+    def someof num, *args
+      SomeOf.new(num, args)
+    end
+
+    def oneof *args
+      OneOf.new(args)
+    end
+  end
+end

data/lib/rubyqc/prelude.rb

@@ -1,6 +1,11 @@
 
 module RubyQC
-  FixnumMax = 2 ** (0.size * 8 - 2) - 1
+  big = 2 ** (0.size * 8 - 2)
+  FixnumMax = if big.kind_of?(Bignum)
+                big - 1
+              else # probably jruby...
+                2 ** (0.size * 8 - 1) - 1
+              end
   FixnumMin = - FixnumMax - 1
   FixnumSuc = FixnumMax + 1
   BignumMax = FixnumMax * 10
@@ -20,6 +25,9 @@ end
 class Class
   def rubyqc
     new
+  rescue => e
+    warn "Cannot new #{self}: #{e}"
+    raise
   end
 end
 
@@ -65,17 +73,15 @@ class UnboundMethod
   end
 end
 
-# TODO
 class Binding
   def self.rubyqc
     binding
   end
 end
 
-# TODO
 class Symbol
   def self.rubyqc
-    String.rubyqc.to_sym
+    all_symbols.sample
   end
 end
 
@@ -85,15 +91,16 @@ class Encoding
   end
 end
 
-# TODO
 class Dir
   def self.rubyqc
-    Dir.open(__dir__)
+    Dir.open(File.dirname($LOADED_FEATURES.sample))
   end
 end
 
 class File
   def self.rubyqc
+    File.open($LOADED_FEATURES.sample)
+  rescue Errno::ENOENT # e.g. thread.rb, enumerator.so
     File.open(__FILE__)
   end
 end
@@ -125,9 +132,10 @@ end
 
 class Class
   def self.rubyqc
-    Object.constants.map{ |name|
-      unless [:Class, :BasicObject, :Data,
-              :Config, :RubyVM, :TracePoint].include?(name)
+    Object.constants.map{ |name|                 # rubinius # jruby
+      if ![:BasicObject, :Class, :Config, :Data, :Autoload, :Continuation,
+           :RubyVM, :Struct, :WeakRef, :TracePoint].include?(name) &&
+         name !~ /Java/
         const_get(name)
       end
     }.select{ |const| const.kind_of?(Class) }.sample
@@ -197,27 +205,27 @@ class Float
   end
 end
 
-class Thread::SizedQueue
+class Fiber
   def self.rubyqc
-    new(rand(0..100))
+    new(&Proc.rubyqc)
   end
 end
 
-class Fiber
+class Thread
   def self.rubyqc
     new(&Proc.rubyqc)
   end
 end
 
-class Thread
+class SizedQueue
   def self.rubyqc
-    new(&Proc.rubyqc)
+    new(rand(1..100))
   end
 end
 
 class SignalException
   def self.rubyqc
-    new(rand(0..32))
+    new(rand(0..31))
   end
 end
 

data/lib/rubyqc/stdlib.rb

@@ -0,0 +1,8 @@
+
+require 'rubyqc/stdlib/delegate'
+require 'rubyqc/stdlib/pathname'
+require 'rubyqc/stdlib/socket'
+require 'rubyqc/stdlib/stringio'
+require 'rubyqc/stdlib/strscan'
+require 'rubyqc/stdlib/tempfile'
+require 'rubyqc/stdlib/weakref'

data/lib/rubyqc/stdlib/delegate.rb

@@ -0,0 +1,14 @@
+
+require 'delegate'
+
+class Delegator
+  def self.rubyqc
+    SimpleDelegator.rubyqc
+  end
+end
+
+class SimpleDelegator
+  def self.rubyqc
+    new(Class.rubyqc.rubyqc)
+  end
+end

data/lib/rubyqc/stdlib/pathname.rb

@@ -0,0 +1,8 @@
+
+require 'pathname'
+
+class Pathname
+  def self.rubyqc
+    new(File.dirname($LOADED_FEATURES.sample))
+  end
+end

data/lib/rubyqc/stdlib/socket.rb

@@ -0,0 +1,60 @@
+
+require 'socket'
+
+class Addrinfo
+  def self.rubyqc
+    Socket.ip_address_list.sample
+  end
+end if Object.const_defined?(:Addrinfo) # rubinius does not have this class
+
+class Socket
+  def self.rubyqc
+    for_fd(BasicSocket.rubyqc.fileno)
+  end
+end
+
+class BasicSocket
+  def self.rubyqc
+    [UNIXSocket, IPSocket].sample.rubyqc
+  end
+end
+
+class IPSocket
+  def self.rubyqc
+    [TCPSocket, UDPSocket].sample.rubyqc
+  end
+end
+
+class UNIXServer
+  def self.rubyqc
+    require 'tempfile'
+    tmp  = Tempfile.new('sock')
+    path = tmp.path
+    tmp.close!
+    new(path)
+  end
+end
+
+class UNIXSocket
+  def self.rubyqc
+    new(UNIXServer.rubyqc.path)
+  end
+end
+
+class TCPServer
+  def self.rubyqc
+    new(0)
+  end
+end
+
+class TCPSocket
+  def self.rubyqc
+    new(*TCPServer.rubyqc.addr[1..2].reverse)
+  end
+end
+
+class UDPSocket
+  def self.rubyqc
+    new
+  end
+end

data/lib/rubyqc/stdlib/stringio.rb

@@ -0,0 +1,8 @@
+
+require 'stringio'
+
+class StringIO
+  def self.rubyqc
+    new(String.rubyqc)
+  end
+end

data/lib/rubyqc/stdlib/strscan.rb

@@ -0,0 +1,8 @@
+
+require 'strscan'
+
+class StringScanner
+  def self.rubyqc
+    new(String.rubyqc)
+  end
+end

data/lib/rubyqc/stdlib/tempfile.rb

@@ -0,0 +1,8 @@
+
+require 'tempfile'
+
+class Tempfile
+  def self.rubyqc
+    new('rubyqc')
+  end
+end

data/lib/rubyqc/stdlib/weakref.rb

@@ -0,0 +1,13 @@
+
+require 'weakref'
+
+# In MRI, WeakRef is a Delegator, so this is not really needed.
+# But in Rubinius, WeakRef is not a Delegator, therefore we need
+# to provide the exact same implementation here.
+class WeakRef
+  def self.rubyqc
+    # Since Rubinius use BasicObject to implement WeakRef, it can't see
+    # Object::Class but ::Class.
+    new(::Class.rubyqc.rubyqc)
+  end
+end

data/lib/rubyqc/version.rb

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

data/rubyqc.gemspec

@@ -1,27 +1,38 @@
 # -*- encoding: utf-8 -*-
-# stub: rubyqc 0.0.1 ruby lib
+# stub: rubyqc 0.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rubyqc"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   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-01-30"
+  s.date = "2014-04-18"
   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 = [
   ".gitignore",
   ".gitmodules",
   ".travis.yml",
+  "CHANGES.md",
   "Gemfile",
   "LICENSE",
   "README.md",
   "Rakefile",
   "lib/rubyqc.rb",
+  "lib/rubyqc/all.rb",
+  "lib/rubyqc/api.rb",
   "lib/rubyqc/modifier.rb",
   "lib/rubyqc/prelude.rb",
+  "lib/rubyqc/stdlib.rb",
+  "lib/rubyqc/stdlib/delegate.rb",
+  "lib/rubyqc/stdlib/pathname.rb",
+  "lib/rubyqc/stdlib/socket.rb",
+  "lib/rubyqc/stdlib/stringio.rb",
+  "lib/rubyqc/stdlib/strscan.rb",
+  "lib/rubyqc/stdlib/tempfile.rb",
+  "lib/rubyqc/stdlib/weakref.rb",
   "lib/rubyqc/test.rb",
   "lib/rubyqc/version.rb",
   "rubyqc.gemspec",
@@ -32,7 +43,7 @@ Gem::Specification.new do |s|
   "test/test_readme.rb"]
   s.homepage = "https://github.com/godfat/rubyqc"
   s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.2.1"
+  s.rubygems_version = "2.2.2"
   s.summary = "RubyQC -- A conceptual [QuickCheck][] library for Ruby."
   s.test_files = [
   "test/test_api.rb",

data/test/test_api.rb

@@ -1,11 +1,57 @@
 
 require 'rubyqc/test'
+require 'rubyqc/all'
 
 describe RubyQC::API do
-  should 'one_of' do
+  should 'oneof' do
     check([Class]*5) do |klasses|
-      check(one_of(*klasses)) do |obj|
-        klasses.find{ |klass| obj.kind_of?(klass) }.should.not.nil
+      klasses -= [Should] # bacon's Should won't work...
+      check(oneof(*klasses)) do |obj|
+        begin
+          klasses.find{ |klass| obj.kind_of?(klass) }.should.not.nil
+        rescue => e
+          warn "Cannot find #{obj} in #{klasses}: #{e}"
+          raise
+        end
+      end
+    end
+  end
+
+  describe 'forall' do
+    should '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
+      end
+      times.should.eq 2**3
+    end
+
+    should '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
+        end
+        times.should.eq 2**3
+      end
+    end
+
+    should '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 }
+          end
+          times.should.eq n**m
+        end
       end
     end
   end

data/test/test_readme.rb

@@ -10,3 +10,38 @@ describe Array do
     end
   end
 end
+
+describe Hash do
+  describe 'compare_by_identity' do
+    should 'Treat diff arr with the same contents diff when set' do
+      arr = [0]
+      forall(booleans, [arr, [0]], [arr, [1]]) do |flag, a, b|
+        h = {}
+        h.compare_by_identity if flag
+        h[a] = h[b] = true
+
+        if (flag && a.object_id != b.object_id) || a != b
+          h.size.should.eq 2
+        else
+          h.size.should.eq 1
+        end
+      end
+    end
+  end
+end
+
+class User < Struct.new(:id, :name)
+  def self.rubyqc
+    new(Fixnum.rubyqc, String.rubyqc)
+  end
+end
+
+describe 'User.rubyqc' do
+  should '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
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyqc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies: []
 description: |-
   RubyQC -- A conceptual [QuickCheck][] library for Ruby.
@@ -27,13 +27,24 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/rubyqc.rb
+- lib/rubyqc/all.rb
+- lib/rubyqc/api.rb
 - lib/rubyqc/modifier.rb
 - lib/rubyqc/prelude.rb
+- lib/rubyqc/stdlib.rb
+- lib/rubyqc/stdlib/delegate.rb
+- lib/rubyqc/stdlib/pathname.rb
+- lib/rubyqc/stdlib/socket.rb
+- lib/rubyqc/stdlib/stringio.rb
+- lib/rubyqc/stdlib/strscan.rb
+- lib/rubyqc/stdlib/tempfile.rb
+- lib/rubyqc/stdlib/weakref.rb
 - lib/rubyqc/test.rb
 - lib/rubyqc/version.rb
 - rubyqc.gemspec
@@ -62,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: RubyQC -- A conceptual [QuickCheck][] library for Ruby.