contracts 0.1.2 → 0.1.3

data/lib/builtin_contracts.rb

@@ -312,6 +312,15 @@ module Contracts
     end
   end
 
+  # Takes a Contract.
+  # The contract passes if the contract passes or the given value is nil.
+  # Maybe(foo) is equivalent to Or[foo, nil].
+  class Maybe < Or
+    def initialize(*vals)
+      super(*(vals + [nil]))
+    end
+  end
+
   class ::Hash
     def testable?
       self.values.all? do |val|

data/lib/contracts.rb

@@ -1,5 +1,6 @@
 require 'decorators'
 require 'builtin_contracts'
+
 module Contracts
   def self.included(base)
     common base
@@ -15,6 +16,15 @@ module Contracts
       def Contract(*args)
         self.class.Contract(*args)
       end
+
+      def functype(funcname)
+        contracts = self.class.decorated_methods[funcname]
+        if contracts.nil? || contracts.empty?
+          "No contract for #{self.class}.#{funcname}"
+        else
+          "#{funcname} :: #{contracts[0]}"
+        end
+      end
     end
   end    
 end
@@ -22,7 +32,7 @@ end
 # This is the main Contract class. When you write a new contract, you'll
 # write it as:
 #
-#   Contract [contract names]
+#   Contract [contract names] => return_value
 #
 # This class also provides useful callbacks and a validation method.
 class Contract < Decorator
@@ -38,6 +48,10 @@ class Contract < Decorator
     @klass, @method, @contracts = klass, method, contracts
   end
 
+  def to_s
+    (contracts[0, contracts.size - 1].join(", ") + " => #{contracts[-1]}").gsub("Contracts::", "")
+  end
+
   # Given a hash, prints out a failure message.
   # This function is used by the default #failure_callback method
   # and uses the hash passed into the failure_callback method.

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: contracts
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors: 
 - Aditya Bhargava
@@ -15,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-07 00:00:00 -07:00
-default_executable: 
+date: 2012-06-07 00:00:00 Z
 dependencies: []
 
 description: This library provides contracts for Ruby. Contracts let you clearly express how your code behaves, and free you from writing tons of boilerplate, defensive code.
@@ -31,10 +25,7 @@ files:
 - lib/builtin_contracts.rb
 - lib/contracts.rb
 - lib/decorators.rb
-- lib/foo.rb
-- lib/test.rb
 - lib/testable.rb
-has_rdoc: true
 homepage: http://github.com/egonSchiele/contracts.ruby
 licenses: []
 
@@ -48,23 +39,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Contracts for Ruby.

data/lib/foo.rb

@@ -1,9 +0,0 @@
-require 'contracts'
-include Contracts
-
-Contract None => Num
-def add
-  4
-end
-
-p add

data/lib/test.rb

@@ -1,60 +0,0 @@
-require 'contracts'
-require 'testable'
-include Contracts
-
-class Object
-
-  Contract Num, Num
-  def double(x)
-    x * 2
-  end
-
-  # bug: the `b` here doesn't get typechecked and throws an error.
-  Contract Num, Num, Num
-  def add(a, b="hello!")
-    a + b
-  end
-
-  Contract Proc, nil
-  def run(&blk)
-    puts "running:"
-    blk.call
-  end
-
-  Contract Method, Num
-  def call(func)
-    func.call
-  end
-
-  Contract Args[Num], Num
-  def sum(*vals)
-    vals.inject(0) do |acc, v|
-      acc + v
-    end
-  end
-
-  Contract ({ :age => Num, :name => String }), nil
-  def person(data)
-    p data
-  end
-
-  Contract Num, Num
-  def test(x)
-    x + 2
-  end
-end
-
-# this doesn't work
-# p Object.send(:sum, 1, 2)
-
-# but this does:
-# p send(:sum, 1, 2)
-#
-# why???
-
-Testable.check_all
-# Testable.check(method(:double))
-
-# p Object.test(5)
-#
-Object.Hello