rdbc 0.0.3 → 0.2.5

data/README.rdoc

@@ -0,0 +1,83 @@
+=Rdbc -- Design by Contract for Ruby
+
+This library supports Design by Contract for Ruby.
+
+=Installation
+
+Install the *rdbc* gem itself by the following command:
+
+  $ gem install armin-joellenbeck-rdbc --source http://gems.github.com
+
+=Usage
+
+Given there is a the class Foo.
+For instances of this class you can define a contract by subclassing
+<b>Rdbc::Contract</b>, in the example the contract is named
+FooContract.
+Then connect the class Foo to its contract FooContract by using the line
+  contract FooContract
+in the class definition of Foo.
+
+Then the following happens when a method of a Foo instance is called:
+
+1. the corresponding pre condition is called with the parameters:
+   * the instance itself
+   * the parameters of the method call
+
+2. the method is called
+
+3. the corresponding post condition is called with the parameters:
+   * the instance before the method is called
+   * the instance after the method is called
+   * the return value of the method call
+   * the parameters of the method call
+
+4. the invariant is called with the parameters:
+   * the instance before the method is called
+   * the instance after the method is called
+
+The instance before the execution of *method* in 3. and 4.
+is in fact a copy of the instance before the execution. So you have to implement
+the method *initialize_copy* in the class under contract, i.e. the class
+Foo.
+
+=Support
+
+The project home is at
+GitHub[http://github.com/armin-joellenbeck/rdbc/tree/master]:
+http://github.com/armin-joellenbeck/rdbc/tree/master
+
+Feel free to send:
+* bug reports
+* support requests
+* feature requests
+* patches
+
+=Copyright
+
+Copyright (c) 2007 - 2009 by Armin Jöllenbeck
+<armin@joellenbeck.net[mailto:armin@joellenbeck.net]>
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. The names of the contributors may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/rdbc/contract.rb

@@ -0,0 +1,56 @@
+module Rdbc
+  class Contract
+    class << self
+      include Translating
+    
+      def pre(method, &block)
+        define_method(method_pre(method), &block)
+      end
+
+      def post(method, &block)
+        define_method(method_post(method), &block)
+      end
+
+      def invariant(&block)
+        define_method(:invariant, &block)
+      end
+    end
+    
+    include Translating
+   
+    def delegate_and_verify(object_pre, object)
+      send_method_pre(method, object, *args)
+      begin
+        result = object.send(method, *args)
+      rescue => exception
+        send_invariant(object)
+        send_method_post(method, object_pre, object, exception, result, *args)
+        raise exception
+      else
+        send_invariant(@object)
+        send_method_post(method, object_pre, object, exception, result, *args)
+        result
+      end
+    end
+ 
+    def send_method_pre(method, object, *args)
+      method_pre = method_pre(method)
+      if respond_to?(method_pre)
+        send(method_pre, object, *args)
+      end
+    end
+    
+    def send_invariant(object)
+      if respond_to?(:invariant)
+        invariant(object)
+      end
+    end
+    
+    def send_method_post(method, object_pre, object, exception, result, *args)
+      method_post = method_post(method)
+      if respond_to?(method_post)
+        send(method_post, object_pre, object, exception, result, *args)
+      end
+    end
+  end
+end

data/lib/rdbc/decorator.rb

@@ -0,0 +1,19 @@
+module Rdbc
+  class Decorator
+    instance_methods.reject do |method|
+      /__.*__/ === method
+    end.each do |method|
+      undef_method(method)
+    end
+  
+    def initialize(object, contract)
+      @object = object
+      @contract = contract
+      @contract.send_invariant(@object)
+    end
+
+    def method_missing(method, *args)
+      @contract.delegate_and_verify(@object.clone, @object)
+    end
+  end
+end

data/lib/rdbc/translating.rb

@@ -0,0 +1,50 @@
+module Rdbc
+  module Translating
+    def method_pre(method)
+       method_with_prefix(method, 'pre')
+    end
+
+    def method_post(method)
+      method_with_prefix(method, 'post')
+    end
+
+    def method_with_prefix(method, type)
+      (type + '_' + (operator?(method) ? operator(method) : method.to_s)).to_sym
+    end
+
+    def operator?(method)
+      /^[A-Za-z_]/ !~ method.to_s
+    end
+
+    def operator(method)
+      'op_' + OPERATOR[method]
+    end
+
+    OPERATOR = {
+      :[]  => 'element_read',
+      :[]= => 'element_write',
+      :**  => 'power',
+      :~   => 'not',
+      :+@  => 'unary_plus',
+      :-@  => 'unary_minus',
+      :*   => 'product',
+      :/   => 'quotient',
+      :%   => 'modulo',
+      :+   => 'plus',
+      :-   => 'minus',
+      :>>  => 'right_shift',
+      :<<  => 'left_shift',
+      :&   => 'and',
+      :^   => 'xor',
+      :|   => 'or',
+      :<=  => 'less_or_equal',
+      :<   => 'less',
+      :>   => 'greater',
+      :>=  => 'greater_or_equal',
+      :<=> => 'comparison',
+      :==  => 'eql',
+      :=== => 'case_comparison',
+      :=~  => 'match'
+    }
+  end
+end

data/lib/rdbc.rb

@@ -0,0 +1,16 @@
+module Rdbc
+  autoload 'Contract', 'rdbc/contract'
+  autoload 'Decorator', 'rdbc/decorator'
+  autoload 'Translating', 'rdbc/translating'
+end
+
+
+class Class
+  def contract(contract_class)
+    old_new = self.method(:new)
+    (class << self; self; end).send(:define_method, :new) do |*args|
+      object = old_new.call(*args)
+      Rdbc::Decorator.new(object, contract_class.new)
+    end
+  end
+end

metadata

@@ -1,59 +1,65 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: rdbc
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-09-22 00:00:00 +02:00
-summary: Design by Contract for Ruby.
-require_paths: 
-- lib
-email: armin.joellenbeck@googlemail.com
-homepage: 
-rubyforge_project: 
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.2.5
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Armin Joellenbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "    This library supports Design by Contract for Ruby.\n"
+email: armin@joellenbeck.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
 files: 
-- lib/design_by_contract.rb
-- Rakefile
-- README
-- test/stack.rb
-- test/design_by_contract_test.rb
-- test/stack_contract.rb
-- test/stack_test.rb
-test_files: 
-- test/design_by_contract_test.rb
-- test/stack_test.rb
+- README.rdoc
+- lib/rdbc.rb
+- lib/rdbc/contract.rb
+- lib/rdbc/decorator.rb
+- lib/rdbc/translating.rb
+has_rdoc: true
+homepage: http://github.com/armin-joellenbeck/rdbc/tree/master
+licenses: []
+
+post_install_message: 
 rdoc_options: 
 - --all
 - --charset
 - utf8
 - --main
-- README
+- README.rdoc
 - --title
 - Design by Contract for Ruby
-extra_rdoc_files: 
-- README
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Design by Contract for Ruby.
+test_files: []
 

data/README

@@ -1,93 +0,0 @@
-=Design by Contract for Ruby
-
-This library supports Design by Contract for Ruby.
-
-=Example
-
-A a standard example for Design by Contract consider the following *Stack*
-class and its contract *StackContract*.
-
-===stack.rb
-  :include:test/stack.rb
-===stack_contract.rb
-  :include:test/stack_contract.rb
-
-=Mechanics
-
-The mechanics are really simple. There is the class *Stack*.
-For instances of this class you can define a contract by subclassing
-<b>DesignByContract::Contract</b>, in the example the contract is named
-*StackContract*.
-Then connect the class *Stack* to its contract *StackContract* by using the line
-  contract StackContract
-in the class definition of *Stack*.
-
-Now the following happens for an instance method of Stack. Say its name is
-*method*. When it is called the the following calling of methods happens.
-
-* *method_pre* of the contract is called with the parameters:
-  * the object itself
-  * the parameters of the original method *method*
-* the original *method* is called
-* *method_post* of the contract is called with the parameters:
-  * the object before the execution of the original method
-  * the object after execution the original method
-  * the return value of the original method
-  * the parameters of the original method
-* *invariant* is called with the parameters:
-  * the object before the execution of the original method
-  * the object after execution the method
-
-The object before the execution of *method* in 3. and 4.
-is in fact a copy of the object before the execution. So you have to implement
-the method *initialize_copy* in the class under contract, i.e. the class
-*Stack*.
-
-In any of these contract methods you can use assertions as in Test::Unit tests.
-When an assertion fails, the exception <b>Test::Unit::AssertionFailedError</b>
-is raised.
-
-=Operators
-
-When the method is an operator the *_pre* and  *_post* suffixes are appended
-to the names of the operator according to the constant
-<b>#DesignByContract::OPERATOR</b>.
-
-=Support
-
-The project home is at RubyForge: http://rubyforge.org/projects/rdbc
-
-Feel free to send:
-* bug reports
-* support requests
-* feature requests
-* patches
-
-=Copyright
-
-Copyright (c) 2007 by Armin Jöllenbeck
-<armin.joellenbeck@googlemail.com[mailto:armin.joellenbeck@googlemail.com]>
-
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-3. The names of the contributors may not be used to endorse or promote products
-   derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -1,48 +0,0 @@
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'rake/testtask'
-
-
-task :default => [:test]
-
-task :all =>  [:test, :doc, :package]
-
-
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*test.rb']
-end
-
-
-Rake::RDocTask.new(:doc) do |t|
-  t.rdoc_dir = 'doc'
-  t.rdoc_files.include('README', 'lib/**/*.rb')
-  t.options = [
-    '--all',
-    '--charset', 'utf8',
-    '--main', 'README',
-    '--title', 'Design by Contract for Ruby'
-  ]
-end
-
-
-spec = Gem::Specification.new do |s|
-  s.author = 'Armin Joellenbeck'
-  s.email = 'armin.joellenbeck@googlemail.com'
-  s.name = 'rdbc'
-  s.summary = 'Design by Contract for Ruby.'
-  s.version = '0.0.3'
-  s.has_rdoc = true
-  s.extra_rdoc_files << 'README'
-  s.rdoc_options = [
-    '--all',
-    '--charset', 'utf8',
-    '--main', 'README',
-    '--title', 'Design by Contract for Ruby'
-  ]
-  s.files = FileList['lib/**/*', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
-  s.test_files = FileList['test/**/*_test.rb'].to_a
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-end

data/lib/design_by_contract.rb

@@ -1,140 +0,0 @@
-require 'test/unit/assertions'
-
-
-class Object
-
-  protected
-
-  def singleton_class
-    class << self
-      self
-    end
-  end
-
-  def define_singleton_method(method, &block)
-    singleton_class.send(:define_method, method, &block)
-  end
-
-end
-
-
-class Class
-
-  def contract(klass)
-    @old_new = self.method(:new)
-    self.define_singleton_method(:new) do |*args|
-      object = @old_new.call(*args)
-      contract = klass.new
-      @proxy = DesignByContract::Proxy.new(object, contract)
-    end
-  end
-
-end
-
-
-module DesignByContract
-
-  OPERATOR = {
-    :[]  => :element_read,
-    :[]= => :element_write,
-    :**  => :power,
-    :~   => :not,
-    :+@  => :unary_plus,
-    :-@  => :unary_minus,
-    :*   => :product,
-    :/   => :quotient,
-    :%   => :modulo,
-    :+   => :plus,
-    :-   => :minus,
-    :>>  => :right_shift,
-    :<<  => :left_shift,
-    :&   => :and,
-    :^   => :xor,
-    :|   => :or,
-    :<=  => :less_or_equal,
-    :<   => :less,
-    :>   => :greater,
-    :>=  => :greater_or_equal,
-    :<=> => :comparison,
-    :==  => :eql,
-    :=== => :case_comparison,
-    :=~  => :match
-  }
-
-  class Contract
-    include Test::Unit::Assertions
-  end
-
-
-  class Proxy
-
-    private
-
-    def initialize(object, contract)
-      @object = object
-      @contract = contract
-    end
-
-    def method_missing(method, *args)
-      # duplicate the object under contract for use in the pre condition
-      object_pre = @object.dup
-
-      # call pre condition
-      method_pre = self.class.method_pre(method)
-      if @contract.respond_to?(method_pre)
-        @contract.send(method_pre, @object, *args)
-      end
-
-      # call the wrapped method
-      result = @object.send(method, *args)
-
-      # call the invariant condition
-      if @contract.respond_to?(:invariant)
-        @contract.invariant(object_pre, @object)
-      end
-
-      # call the post condition
-      method_post = self.class.method_post(method)
-      if @contract.respond_to?(method_post)
-        @contract.send(method_post, object_pre, @object, result, *args)
-      end
-
-      # return the return value of the call to the wrapped method
-      result
-    end
-
-    class << self
-
-      def method_pre(method)
-        self.method_with_suffix(method, :pre)
-      end
-
-      def method_post(method)
-        self.method_with_suffix(method, :post)
-      end
-
-      protected
-
-      def method_with_suffix(method, type)
-        operator = OPERATOR[method]
-        suffix = '_' + type.to_s
-        if operator.nil?
-          method_string = method.to_s
-          length = method_string.length
-          head = method_string[0...length-1]
-          tail = method_string[length-1...length]
-          if ['?', '!', '='].include?(tail)
-            (head + suffix + tail).to_sym
-          else
-            (method_string + suffix).to_sym
-          end
-        else
-          ('op_' + operator.to_s + suffix).to_sym
-        end
-      end
-
-    end
-
-  end
-
-end

data/test/design_by_contract_test.rb

@@ -1,34 +0,0 @@
-require 'test/unit'
-
-require 'design_by_contract'
-
-
-class DesignByContractTest < Test::Unit::TestCase
-
-  def assert_method_pre(expected_method_pre, method)
-    assert_equal(expected_method_pre,
-      DesignByContract::Proxy.method_pre(method))
-  end
-
-  def assert_method_post(expected_method_post, method)
-    assert_equal(expected_method_post,
-      DesignByContract::Proxy.method_post(method))
-  end
-
-  def test_method_pre
-    assert_method_pre(:method_pre,  :method)
-    assert_method_pre(:method_pre?, :method?)
-    assert_method_pre(:method_pre!, :method!)
-    assert_method_pre(:method_pre=, :method=)
-    assert_method_pre(:op_plus_pre, :+)
-  end
-
-  def test_method_post
-    assert_method_post(:method_post,  :method)
-    assert_method_post(:method_post?, :method?)
-    assert_method_post(:method_post!, :method!)
-    assert_method_post(:method_post=, :method=)
-    assert_method_post(:op_plus_post, :+)
-  end
-
-end

data/test/stack.rb

@@ -1,41 +0,0 @@
-require File.dirname(__FILE__) + '/stack_contract'
-
-
-class Stack
-
-  contract StackContract
-
-  def initialize
-    @elements = []
-  end
-
-  def initialize_copy(orig)
-    @elements = orig.elements
-  end
-
-  def elements
-    @elements.dup
-  end
-
-  def size
-    @elements.size
-  end
-
-  def empty?
-    self.size == 0
-  end
-
-  def top
-    @elements.last
-  end
-
-  def push(element)
-    @elements.push(element)
-    nil
-  end
-
-  def pop
-    @elements.pop
-  end
-
-end

data/test/stack_contract.rb

@@ -1,33 +0,0 @@
-require 'design_by_contract'
-
-
-class StackContract < DesignByContract::Contract
-
-  def push_post(stack_pre, stack, result, element)
-    assert_nil(result)
-    assert_equal(element, stack.top)
-    assert_equal(stack.size, stack_pre.size + 1)
-  end
-
-  def pop_pre(stack)
-    assert_operator(stack.size, :>=, 1)
-  end
-
-  def pop_post(stack_pre, stack, result)
-    assert_equal(stack_pre.top, result)
-    assert_equal(stack_pre.size - 1, stack.size)
-  end
-
-  def top_pre(stack)
-    assert_operator(stack.size, :>=, 1)
-  end
-
-  def top_post(stack_pre, stack, result)
-    assert_equal(stack_pre.size, stack.size)
-  end
-
-  def invariant(stack_pre, stack)
-    assert_operator(stack.size, :>=, 0)
-  end
-  
-end

data/test/stack_test.rb

@@ -1,37 +0,0 @@
-require 'test/unit'
-
-require File.dirname(__FILE__) + '/stack'
-
-
-class StackTest < Test::Unit::TestCase
-
-  def setup
-    @stack = Stack.new
-  end
-
-  def test_empty
-    assert(@stack.empty?)
-  end
-
-  def test_top
-    assert_raise Test::Unit::AssertionFailedError do
-      @stack.top
-    end
-  end
-
-  def test_pop
-    assert_raise Test::Unit::AssertionFailedError do
-      @stack.pop
-    end
-  end
-
-  def test_push_top_pop
-    element = 0
-    @stack.push(element)
-    assert(!@stack.empty?)
-    assert_equal(element, @stack.top)
-    assert_equal(element, @stack.pop)
-    assert(@stack.empty?)
-  end
-
-end