mimicheck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae4576be50e5d4138e65ba6cc07773ca9804bdf8
+  data.tar.gz: 8f6ceb155faa145a8361a090b396c15a87e4b924
+SHA512:
+  metadata.gz: df77dd10f4b890befa9d2eb74ba807c032d1c20795e079d28f6f9afda83f460961ef0c946ebfe90417a0460314deb9dcd45e54757ce4d89196a739423ea325b2
+  data.tar.gz: fe905e4831c1d5aadeed56f7df299fe7c0df5b16caea6f506aa6cd63f4380c8afc1a38d01f46d70765d8bd924f4a7cfb28d313f5e0719904518d13569c065a38

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Documentation:
+  Enabled: false
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+AllCops:
+  Include:
+    - '**/*.gemspec'
+    - '**/Rakefile'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    mimicheck (0.1.0)
+      method_source (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    pry-doc (0.8.0)
+      pry (~> 0.9)
+      yard (~> 0.8)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    slop (3.6.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  method_source (~> 0.8)
+  mimicheck!
+  pry-byebug (~> 3.0)
+  pry-doc (~> 0.8)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Renan Ranelli
+
+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,55 @@
+# MimiCheck
+
+A Quickcheck inspired testing library with dependency injection in mind.
+
+[![Build Status](https://travis-ci.org/rranelli/mimicheck.svg)](https://travis-ci.org/rranelli/mimicheck)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mimicheck'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mimicheck
+
+## Usage
+
+# TODO: ~
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake rspec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/mimicheck.
+
+### Pending Features && TODO
+
+* Add support for the Frequency generator
+* Add a better support for instantiating generators (probably including them in
+a module with factory methods)
+* Add support for shrinking (**big feature**!)
+* Allow better support of "sized" generators. Passing in a range sucks
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mimicheck'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mimicheck/checker.rb

@@ -0,0 +1,58 @@
+module MimiCheck
+  class Checker
+    extend TailCallOptimization
+
+    attr_reader :trials, :property, :generators, :examples
+
+    def self.for(proc, &blk)
+      new(proc || blk).with
+    end
+
+    def with(trials: nil, generators: nil, examples: nil)
+      tap do
+        @trials = trials if trials
+        @generators = generators if generators
+        @examples = examples if examples
+      end
+    end
+
+    def check(gens = nil)
+      check! Array(gens || generators)
+    end
+
+    def check_examples(exs = nil)
+      check_examples! Array(exs || examples)
+    end
+
+    private
+
+    def initialize(property)
+      @property = property
+      @trials = MimiCheck.trials
+      @examples = []
+      @generators = []
+    end
+
+    def check!(gens)
+      exs = (1..trials).map { gens.map(&:call) }
+      check_examples!(exs)
+    end
+
+    def check_examples!(exs)
+      example, *es = exs
+      return MimiCheck::Result::Success.new(property) unless example
+
+      result, error = safe_check(*example)
+      return MimiCheck::Result::Falsified.new(property, error) unless result
+
+      check_examples!(es)
+    end
+    tail_recursive :check_examples!
+
+    def safe_check(*example)
+      [property.call(*example), { example: example }]
+    rescue => error
+      [false, { example: example, error: error }]
+    end
+  end
+end

data/lib/mimicheck/generator/array.rb

@@ -0,0 +1,19 @@
+module MimiCheck
+  module Generator
+    class Array
+      include Generator
+
+      def initialize(generator = default_gen, size_range = 0..20)
+        @generator = generator
+        @size_range = size_range
+      end
+      attr_reader :generator, :size_range
+      private :generator, :size_range
+
+      def generate
+        size = Int.new(size_range).generate
+        (1..size).map(&generator)
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/bool.rb

@@ -0,0 +1,17 @@
+module MimiCheck
+  module Generator
+    class Bool
+      include Generator
+
+      def initialize
+        @elements_gen = Elements.new(true, false)
+      end
+      attr_reader :elements_gen
+      private :elements_gen
+
+      def generate
+        elements_gen.generate
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/byte.rb

@@ -0,0 +1,17 @@
+module MimiCheck
+  module Generator
+    class Byte
+      include Generator
+
+      def initialize
+        @uint_gen = UInt.new(0..255)
+      end
+      attr_reader :uint_gen
+      private :uint_gen
+
+      def generate
+        uint_gen.generate
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/carousel.rb

@@ -0,0 +1,19 @@
+module MimiCheck
+  module Generator
+    class Carousel
+      include Generator
+
+      def initialize(*elements)
+        @elements = elements
+        @current = -1
+      end
+      attr_reader :elements, :current
+      private :elements, :current
+
+      def generate
+        return nil unless elements.size.nonzero?
+        elements[(@current += 1) % elements.size]
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/char.rb

@@ -0,0 +1,17 @@
+module MimiCheck
+  module Generator
+    class Char
+      include Generator
+
+      def initialize
+        @uint_gen = UInt.new(0..128)
+      end
+      attr_reader :uint_gen
+      private :uint_gen
+
+      def generate
+        uint_gen.generate.chr
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/elements.rb

@@ -0,0 +1,17 @@
+module MimiCheck
+  module Generator
+    class Elements
+      include Generator
+
+      def initialize(*elements)
+        @elements = elements
+      end
+      attr_reader :elements
+      private :elements
+
+      def generate
+        elements.sample
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/float.rb

@@ -0,0 +1,20 @@
+module MimiCheck
+  module Generator
+    class Float
+      include Generator
+
+      def initialize(range = -1e10..1e10)
+        @min = range.min
+        @max = range.max
+      end
+
+      attr_reader :min, :max
+      private :min, :max
+
+      def generate
+        fail ArgumentError unless min && max
+        Random.rand * (max - min) + min
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/int.rb

@@ -0,0 +1,17 @@
+module MimiCheck
+  module Generator
+    class Int
+      include Generator
+
+      def initialize(range = -1e9..1e9)
+        @float_gen = Float.new(range)
+      end
+      attr_reader :float_gen
+      private :float_gen
+
+      def generate
+        float_gen.generate.to_i
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/string.rb

@@ -0,0 +1,17 @@
+module MimiCheck
+  module Generator
+    class String
+      include Generator
+
+      def initialize(range = 25)
+        @range = range
+      end
+      attr_reader :range
+      private :range
+
+      def generate
+        Array.new(Char.new, range).join('')
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/such_that.rb

@@ -0,0 +1,22 @@
+module MimiCheck
+  module Generator
+    class SuchThat
+      extend TailCallOptimization
+      include Generator
+
+      def initialize(generator, predicate = nil, &blk)
+        @generator = generator
+        @predicate = predicate || blk
+      end
+      attr_reader :generator, :predicate
+      private :generator, :predicate
+
+      def generate
+        result = generator.call
+        return result if predicate.call(result)
+        generate
+      end
+      tail_recursive :generate
+    end
+  end
+end

data/lib/mimicheck/generator/uint.rb

@@ -0,0 +1,17 @@
+module MimiCheck
+  module Generator
+    class UInt
+      include Generator
+
+      def initialize(range = 0..1e9)
+        @int_gen = Int.new(range)
+      end
+      attr_reader :int_gen
+      private :int_gen
+
+      def generate
+        int_gen.generate.abs
+      end
+    end
+  end
+end

data/lib/mimicheck/generator/wrapper.rb

@@ -0,0 +1,18 @@
+module MimiCheck
+  module Generator
+    class Wrapper
+      include Generator
+
+      def initialize(element)
+        @element = element
+      end
+      attr_reader :element
+      private :element
+
+      def generate
+        return element unless element.respond_to?(:call)
+        element.call
+      end
+    end
+  end
+end

data/lib/mimicheck/generator.rb

@@ -0,0 +1,24 @@
+require_relative 'generator/array'
+require_relative 'generator/bool'
+require_relative 'generator/byte'
+require_relative 'generator/carousel'
+require_relative 'generator/char'
+require_relative 'generator/elements'
+require_relative 'generator/float'
+require_relative 'generator/int'
+require_relative 'generator/string'
+require_relative 'generator/such_that'
+require_relative 'generator/uint'
+require_relative 'generator/wrapper'
+
+module MimiCheck
+  module Generator
+    def call(*)
+      generate
+    end
+
+    def to_proc
+      -> (*) { call }
+    end
+  end
+end

data/lib/mimicheck/result.rb

@@ -0,0 +1,29 @@
+module MimiCheck
+  class Result
+    class Success
+      def initialize(property)
+        @property = property
+      end
+      attr_reader :property
+
+      def ==(other)
+        return false unless other.is_a?(self.class)
+        property == other.property
+      end
+    end
+
+    class Falsified
+      def initialize(property, counter_examples)
+        @property = property
+        @counter_examples = counter_examples
+      end
+      attr_reader :property, :counter_examples
+
+      def ==(other)
+        return false unless other.is_a?(self.class)
+        property == other.property &&
+          counter_examples == other.counter_examples
+      end
+    end
+  end
+end

data/lib/mimicheck/rspec_helper.rb

@@ -0,0 +1,32 @@
+module MimiCheck
+  module RSpecHelper
+    def check(prop, gens = nil)
+      gens = Array(gens || generators)
+
+      result = checker_for(prop).check(gens)
+      expect(result).to eq(MimiCheck::Result::Success.new(prop))
+    end
+
+    def check_with_examples(prop, exs = nil)
+      exs = Array(exs || examples)
+
+      result = checker_for(prop).check_examples(exs)
+      expect(result).to eq(MimiCheck::Result::Success.new(prop))
+    end
+
+    def generators
+      fail 'You must define a list of generators with let(:generators) { ... }'
+    end
+
+    def examples
+      fail 'You must define a list of examples with let(:examples) { ... }'
+    end
+
+    private
+
+    def checker_for(prop, trls = MimiCheck.trials)
+      trls = trials if respond_to?(:trials)
+      MimiCheck::Checker.for(prop).with(trials: trls)
+    end
+  end
+end

data/lib/mimicheck/tail_call_optimization.rb

@@ -0,0 +1,23 @@
+require 'method_source'
+
+module MimiCheck
+  module TailCallOptimization
+    def tail_recursive(name)
+      fn = instance_method(name)
+
+      RubyVM::InstructionSequence.compile_option = {
+        tailcall_optimization: true,
+        trace_instruction: false
+      }
+
+      iseq = RubyVM::InstructionSequence.new(<<-EOS)
+      class #{self}
+        #{fn.source}
+      end
+      EOS
+
+      iseq.eval
+      iseq.disasm
+    end
+  end
+end

data/lib/mimicheck/version.rb

@@ -0,0 +1,3 @@
+module MimiCheck
+  VERSION = '0.1.0'
+end

data/lib/mimicheck.rb

@@ -0,0 +1,13 @@
+require_relative 'mimicheck/tail_call_optimization'
+require_relative 'mimicheck/result'
+require_relative 'mimicheck/checker'
+require_relative 'mimicheck/generator'
+require_relative 'mimicheck/version'
+require_relative 'mimicheck/rspec_helper'
+
+module MimiCheck
+  class << self
+    attr_accessor :trials
+  end
+  self.trials ||= 100
+end

data/mimicheck.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mimicheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mimicheck'
+  spec.version       = MimiCheck::VERSION
+  spec.authors       = ['renan-ranelli']
+  spec.email         = ['renanranelli@gmail.com']
+
+  spec.summary       = 'A Quickcheck-inspired test utilities library'
+  spec.homepage      = 'http://github.com/rranelli/mimicheck'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`
+    .split("\x0")
+    .reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'method_source', '~> 0.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_development_dependency 'pry-byebug', '~> 3.0'
+  spec.add_development_dependency 'pry-doc', '~> 0.8'
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: mimicheck
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- renan-ranelli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: pry-byebug
+  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: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- renanranelli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mimicheck.rb
+- lib/mimicheck/checker.rb
+- lib/mimicheck/generator.rb
+- lib/mimicheck/generator/array.rb
+- lib/mimicheck/generator/bool.rb
+- lib/mimicheck/generator/byte.rb
+- lib/mimicheck/generator/carousel.rb
+- lib/mimicheck/generator/char.rb
+- lib/mimicheck/generator/elements.rb
+- lib/mimicheck/generator/float.rb
+- lib/mimicheck/generator/int.rb
+- lib/mimicheck/generator/string.rb
+- lib/mimicheck/generator/such_that.rb
+- lib/mimicheck/generator/uint.rb
+- lib/mimicheck/generator/wrapper.rb
+- lib/mimicheck/result.rb
+- lib/mimicheck/rspec_helper.rb
+- lib/mimicheck/tail_call_optimization.rb
+- lib/mimicheck/version.rb
+- mimicheck.gemspec
+homepage: http://github.com/rranelli/mimicheck
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Quickcheck-inspired test utilities library
+test_files: []
+has_rdoc: