contract 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 015f97c2285dac2ec81370f391be68fe2f0e0e12
+  data.tar.gz: 3769a9e66a2c4dd76426f1df7c101689d69d1983
+SHA512:
+  metadata.gz: 4f01f554ff61a8002c853b699b9ea393fac00585560143e396fdad79b6953220e893a9b21b298962ca5eac3158af7719ae0b73f2dbbacbe916a220dd099f4cc3
+  data.tar.gz: b28b4edaca9aa181c37189d8abd1613d03857e67379c6b3d0595841f11fb4ba54f3cd788160b2a36dfc4c42669304cf470b9c0dc965852c7aae82fb9eb0bdecf

data/.gems

@@ -0,0 +1 @@
+cutest -v 1.2.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Michel Martens
+
+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,44 @@
+# Contract helper
+
+This module provides a way to define contracts in functions, and
+return a value based on a series of user defined verifications.
+
+## Usage
+
+The functions of a contract can be used directly from the
+`Contract` module:
+
+``` ruby
+class Foo
+  def foo(a, b)
+    Contract.define do
+      Contract.verify(Numeric === a)
+      Contract.verify(Numeric === b)
+
+      a * b
+    end
+  end
+end
+```
+
+``` ruby
+class Bar
+  include Contract
+
+  def bar(a, b)
+    contract do
+      verify(Numeric === a)
+      verify(Numeric === b)
+
+      a * b
+    end
+  end
+end
+```
+
+When the `Contract` module is included, the methods `contract` and
+`verify` become available.
+
+## Installation
+
+      $ gem install contract

data/contract.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name              = "contract"
+  s.version           = "0.0.1"
+  s.summary           = "Contract helper"
+  s.description       = "Contract helper"
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "http://github.com/soveran/contract"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest"
+end

data/lib/contract.rb

@@ -0,0 +1,29 @@
+# Provides a way to define contracts for a given function.
+# The methods `define` and `verify` can be used directly.
+# If the `Contract` module is included in a class, the
+# methods `contract` and `verify` are added.
+module Contract
+
+  # Returns the value of the block
+  # if all verifications pass
+  def self.define(&block)
+    catch(:contract) do
+      yield
+    end
+  end
+
+  # Fails unless value is true
+  def self.verify(value)
+    value || throw(:contract, false)
+  end
+
+  # Shorthand for Contract.define
+  def contract(&block)
+    Contract.define(&block)
+  end
+
+  # Shorthand for Contract.verify
+  def verify(value)
+    Contract.verify(value)
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+test:
+	cutest ./test/*.rb
+
+.PHONY: test

data/test/contract_test.rb

@@ -0,0 +1,35 @@
+require_relative "../lib/contract"
+
+class Foo
+  def foo(a, b)
+    Contract.define do
+      Contract.verify(Numeric === a)
+      Contract.verify(Numeric === b)
+
+      a * b
+    end
+  end
+end
+
+class Bar
+  include Contract
+
+  def bar(a, b)
+    contract do
+      verify(Numeric === a)
+      verify(Numeric === b)
+
+      a * b
+    end
+  end
+end
+
+test "direct" do
+  assert_equal 6,     Foo.new.foo(2, 3)
+  assert_equal false, Foo.new.foo(2, "3")
+end
+
+test "included" do
+  assert_equal 6,     Bar.new.bar(2, 3)
+  assert_equal false, Bar.new.bar(2, "3")
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: contract
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Contract helper
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- LICENSE
+- README.md
+- contract.gemspec
+- lib/contract.rb
+- makefile
+- test/contract_test.rb
+homepage: http://github.com/soveran/contract
+licenses: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Contract helper
+test_files: []