handshake 0.2.1 → 0.3.0

data/Manifest.txt

@@ -10,3 +10,4 @@ lib/handshake/inheritable_attributes.rb
 lib/handshake/proxy_self.rb
 lib/handshake/version.rb
 test/tc_handshake.rb
+test/tc_disable_handshake.rb

data/README.txt

@@ -5,6 +5,9 @@ It's intended to allow Ruby developers to apply simple, clear constraints
 to their methods and classes.  Handshake is written by Brian Guthrie
 (btguthrie@gmail.com) and lives at http://handshake.rubyforge.org.
 
+Contracts defined with Handshake are not enforced unless the global $DEBUG
+flag is set.
+
 === Features
 
 * Method signature contracts

data/lib/handshake/version.rb

@@ -1,8 +1,8 @@
 module Handshake # :nodoc:
   module VERSION # :nodoc:
     MAJOR = 0
-    MINOR = 2
-    TINY  = 1
+    MINOR = 3
+    TINY  = 0
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/lib/handshake.rb

@@ -46,6 +46,10 @@ module Handshake
     base.class_inheritable_hash :method_contracts
     base.write_inheritable_hash :method_contracts, {}
 
+    # No contracts will ever be checked if we return now, so it's a good place
+    # to put the $DEBUG flag check.
+    return unless $DEBUG
+
     class << base
       alias :instantiate :new
       # Override the class-level new method of every class that includes

data/test/tc_disable_handshake.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'handshake'
+
+# The purpose of this test case is to ensure that when the $DEBUG flag is not
+# set contracts may still be declared without raising a syntax error, although
+# they are not enforced.
+class TestDisableHandshake < Test::Unit::TestCase
+
+  class ComprehensiveContracts
+    include Handshake
+
+    invariant("foo must always be true") { @foo == true }
+ 
+    contract /foo/ => /bar/ 
+    before do |arg|
+      assert_equal "foo", arg
+    end
+    after do |arg, returned|
+      assert_equal "bar", returned
+    end
+    def call(str); "baz"; end
+  end
+
+  def test_contracts_not_enforced
+    assert_nothing_raised { ComprehensiveContracts.new }
+    assert_nothing_raised { ComprehensiveContracts.new.call 3 }
+  end
+
+end

data/test/tc_handshake.rb

@@ -1,28 +1,8 @@
-# test_handshake.rb
-# Copyright (c) 2007 Brian Guthrie
-# 
-# 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.
-
 require 'test/unit'
 require 'handshake'
 
+$DEBUG = true
+
 class TestContract < Test::Unit::TestCase
 
   class InvariantDeclarations

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: handshake
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-05-02 00:00:00 -04:00
+  version: 0.3.0
+date: 2007-05-03 00:00:00 -04:00
 summary: Handshake is a simple design-by-contract system for Ruby.
 require_paths: 
 - lib
@@ -40,7 +40,9 @@ files:
 - lib/handshake/proxy_self.rb
 - lib/handshake/version.rb
 - test/tc_handshake.rb
+- test/tc_disable_handshake.rb
 test_files: 
+- test/tc_disable_handshake.rb
 - test/tc_handshake.rb
 rdoc_options: []