gen-test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84646aec5140b201837409f37dc51fd298c8fb5aff1c0c5d7026068c2aa7ebbd
+  data.tar.gz: ed3b318092f96b74707c9426c9f59536e47071bc1ec68de5d1deeef7d25125bd
+SHA512:
+  metadata.gz: e9b4811b8ff6bdda4268092759793053f7d1af6a74ba1ddfeff540917f8b3b92639fd32c3d77ca32e03f38efaa7df1f77c609eb564ca67b978673b2480906a6f
+  data.tar.gz: e4ff31c90d8dffd0398ab0a965c222084f1751e6ede57c8202d351bdab69ba52baeda73394f57d36a9a299df00180a6a9a144dfc25515cc0a3c2338779f56906

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.rakeTasks
+*.iml

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gen-test.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    gen-test (0.1.0)
+      faker (~> 1.9.6)
+      regexp-examples (~> 1.5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    faker (1.9.6)
+      i18n (>= 0.7)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    rake (10.5.0)
+    regexp-examples (1.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    yard (0.9.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  gen-test!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  yard (~> 0.9.24)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Delon Newman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+Gen::Test
+=========
+
+Generative, property based testing for Ruby
+
+Synopsis
+========
+    
+```ruby
+AddOne = lambda { |x| x + 1 }
+
+class AddOneTest < Minitest::Test
+  include Gen::Test
+
+  def test_incremented_for_all_integers
+    for_all Integer do |int|
+      inc = AddOne[int]
+      assert_equal(inc, int + 1)
+    end
+  end
+end
+```
+
+Why?
+====
+
+Generative testing has much value for unit, acceptance and integration testing over TDD and BDD, while it's
+value doesn't come for free.
+[Others](https://www.youtube.com/watch?v=r5i_OiZw6Sw) [argue](http://www.quviq.com/products/quickcheck-for-c/)
+this point well.
+
+There seemed to be a need simple, extensible, implementation for Ruby, that wasn't a DSL or a framework. This
+module is still very incomplete, but it's proven useful.
+
+Install
+=======
+
+    > gem install gen-test
+
+or, add
+
+    gem 'gen-test'
+
+to your Gemfile.
+
+See Also
+========
+
+- For Clojure [test.check](https://github.com/clojure/test.check)
+- For Haskell (the original version) [QuickCheck](https://hackage.haskell.org/package/QuickCheck)
+- For Erlang (the most complete version) [QuickCheck](http://www.quviq.com/products/erlang-quickcheck/)
+
+- There's quite a few different versions for [Ruby](https://rubygems.org/search?utf8=%E2%9C%93&query=quickcheck)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/gen-test.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gen/test/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gen-test"
+  spec.version       = Gen::Test::VERSION
+  spec.authors       = ["Delon Newman"]
+  spec.email         = ["contact@delonnewman.name"]
+
+  spec.summary       = %q{Generative / Property testing}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/delonnewman/gen-test"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}#changelog"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "faker", "~> 1.9.6"
+  spec.add_runtime_dependency "regexp-examples", "~> 1.5.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9.24"
+end

data/lib/ext_core.rb

@@ -0,0 +1,222 @@
+require 'date'
+require 'faker'
+require 'regexp-examples'
+
+# Some extentions to the core Object class
+class Object
+  # Return self
+  def generate(*_args)
+    self
+  end
+end
+
+# Some extentions to the core String class
+class String
+  # Randomly generate a String
+  #
+  # @see Faker::String
+  # @return [String]
+  # TODO: add filtering
+  def self.generate(*_args)
+    Faker::String.random
+  end
+end
+
+# Some extentions to the core Symbol class
+class Symbol
+
+  # Randomly generate a Symbol
+  #
+  # @see String#generate
+  # @return [Symbol]
+  def self.generate(*_args)
+    String.generate.to_sym
+  end
+end
+
+# Some extentions to the core Float class
+class Float
+
+  # Randomly generate a Float instance
+  #
+  # @return [Float]
+  def self.generate(*_args)
+    Random.rand(10e10)
+  end
+end
+
+# Some extentions to the core Integer class
+class Integer
+  # Randomly generate an Integer
+  #
+  # @return [Integer]
+  def self.generate(min: nil, max: nil, bit_length: nil)
+    i = Random.rand(10e10).to_i
+    if !min.nil? or !max.nil? or !bit_length.nil?
+      while i > max or i < min or i.bit_length > bit_length
+        i = Random.rand(10e10).to_i
+      end
+    end
+
+    if Random.rand < 0.5
+      i
+    else
+      i * -1
+    end
+  end
+end
+
+# Some extentions to the core FalseClass
+class FalseClass
+  # Return false
+  def self.generate(*_args)
+    false
+  end
+end
+
+# Some extentions to the core TrueClass
+class TrueClass
+  # Return true
+  def self.generate(*_args)
+    true
+  end
+end
+
+# Some extentions to the core NilClass
+class NilClass
+  # Return nil
+  def self.generate(*_args)
+    nil
+  end
+end
+
+# Some extentions to the core Array class
+class Array
+  DEFAULT_GENERATIVE_TYPES = [
+      Integer,
+      String,
+      Float,
+      FalseClass,
+      TrueClass,
+      NilClass
+  ]
+
+  # Randomly generate an Array
+  def self.generate(min: 0, max: 30, type: nil)
+    (0..Faker::Number.between(min, max)).map do
+      if type.nil?
+        DEFAULT_GENERATIVE_TYPES.sample.generate
+      else
+        type.generate
+      end
+    end
+  end
+
+  # Randomly generate an Array from an Array instance, use the values of the array as generators.
+  #
+  # @example
+  #     [Integer, Float, String].generate => [2341234, 2.24, "asdfawqsafdrawdsfasds"]
+  #
+  # @return [Array]
+  def generate
+    map(&:generate)
+  end
+end
+
+# Some extentions to the core Set class
+class Set
+  # Randomly generate a Set
+  def self.generate(*args)
+    new(Array.generate(*args))
+  end
+
+  # Randomly select an element of the Set
+  def generate(*_args)
+    to_a.sample
+  end
+end
+
+# Some extentions to the core Hash class
+class Hash
+  DEFAULT_GENERATIVE_KEY_TYPES = [
+      Symbol,
+      String,
+      Integer
+  ]
+
+  DEFAULT_GENERATIVE_VALUE_TYPES = [
+      Integer,
+      String,
+      Float,
+      FalseClass,
+      TrueClass,
+      NilClass
+  ]
+
+  # Randomly generate a Hash
+  def self.generate(min: 0, max: 30, key_type: nil, value_type: nil)
+    (0..Faker::Number.between(min, max)).reduce({}) do |h, _|
+      kt = key_type || DEFAULT_GENERATIVE_KEY_TYPES.sample
+      vt = value_type || DEFAULT_GENERATIVE_VALUE_TYPES.sample
+      h.merge(kt.generate => vt.generate)
+    end
+  end
+
+  def generate(*_args)
+    transform_values(&:generate)
+  end
+end
+
+# Some extentions to the core Range class
+class Range
+  # Randomly generate a value within the range
+  def generate(*_args)
+    if first.is_a? Numeric and last.is_a? Numeric
+      Faker::Number.between(first, last)
+    else
+      to_a.sample
+    end
+  end
+end
+
+class Regexp
+  def generate
+    random_example
+  end
+end
+
+class DateTime
+  def self.generate(*args)
+    if args.empty?
+      Time.at(Faker::Number.between(0, Time.now.to_i))
+    else
+      Faker::Time.between(*args)
+    end.to_datetime
+  end
+end
+
+class Date
+  def self.generate(*args)
+    if args.empty?
+      Time.at(Faker::Number.between(0, Time.now.to_i))
+    else
+      Faker::Date.between(*args)
+    end.to_date
+  end
+end
+
+class Time
+  def self.generate(*args)
+    if args.empty?
+      Time.at(Faker::Number.between(0, Time.now.to_i))
+    else
+      Faker::Time.between(*args)
+    end.to_time
+  end
+end
+
+class Proc
+  def generate(*args)
+    call(*args)
+  end
+end

data/lib/gen.rb

@@ -0,0 +1,49 @@
+module Gen
+  class Generator
+    def initialize(gen = nil, &blk)
+      @gen = gen || blk or raise "A proc or a block is required"
+    end
+
+    def generate
+      @gen.call
+    end
+    alias call generate
+  end
+
+  def generator?(val)
+    val.respond_to?(:generate)
+  end
+
+  def sample(gen, n = 10)
+    (0..n).map { generate(gen) }
+  end
+
+  def where(gen, pred, max_tries = 10)
+    Generator.new do
+      tries = 0
+      until (val = generate(gen)) and pred.call(val)
+        tries += 1
+        if tries >= max_tries
+          raise "We've tried generating a value from #{gen.inspect} with #{pred.inspect} #{max_tries} times and failed"
+        end
+      end
+      val
+    end
+  end
+
+  def one_of(generators)
+    generate(generators.to_a.sample)
+  end
+
+  def generate(generator)
+    if generator.respond_to?(:call)
+      generator.call
+    elsif generator.respond_to?(:generate)
+      generator.generate
+    else
+      generator
+    end
+  end
+
+  module_function :generator?, :sample, :generate, :where, :one_of
+end

data/lib/gen/test.rb

@@ -0,0 +1,48 @@
+require_relative '../gen'
+require_relative '../ext_core'
+
+module Gen
+  module Test
+    LOWER_BOUND = ENV.fetch('TEST_LOWER_BOUND', 10).to_i
+    UPPER_BOUND = ENV.fetch('TEST_UPPER_BOUND', 20).to_i
+  
+    def self.included(base)
+      base.include(Gen)
+    end
+
+    def for_all(*generators)
+      for_n([LOWER_BOUND, UPPER_BOUND], *generators, &Proc.new)
+    end
+  
+    def for_any(*generators)
+      for_n(1, *generators, &Proc.new)
+    end
+    alias for_one for_any
+  
+    def for_n(n, *generators)
+      if block_given?
+        n = Faker::Number.between(n.first, n.last) if n.respond_to?(:first) and n.respond_to?(:last)
+        n.times do
+          yield(*generators.map(&Gen.method(:generate)))
+        end
+      else
+        raise 'A block is expected with a property definition'
+      end
+    end
+  
+    def for_each(*collections)
+      unless collections.empty?
+        size = collections.first.size
+        raise "All collections must be the same size" unless collections.all? { |c| c.size == size }
+        zipped = collections.first.zip(*collections.drop(1))
+        if block_given?
+          zipped.each do |generators|
+            yield(*generators.map { |g| Gen.generate(g) })
+          end
+        else
+          raise 'A block is expected with a property definition'
+        end
+      end
+    end
+  end
+end

data/lib/gen/test/version.rb

@@ -0,0 +1,5 @@
+module Gen
+  module Test
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: gen-test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Delon Newman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.9.6
+- !ruby/object:Gem::Dependency
+  name: regexp-examples
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.24
+description: Generative / Property testing
+email:
+- contact@delonnewman.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- gen-test.gemspec
+- lib/ext_core.rb
+- lib/gen.rb
+- lib/gen/test.rb
+- lib/gen/test/version.rb
+homepage: https://github.com/delonnewman/gen-test
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/delonnewman/gen-test
+  source_code_uri: https://github.com/delonnewman/gen-test
+  changelog_uri: https://github.com/delonnewman/gen-test#changelog
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Generative / Property testing
+test_files: []