rdbc 0.0.1

data/README

@@ -0,0 +1,49 @@
+=Design by Contract for Ruby
+
+This library supports Design by Contract for Ruby.
+
+=Example
+
+===stack.rb
+  :include:test/stack.rb
+===stack_contract.rb
+  :include:test/stack_contract.rb
+
+=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

@@ -0,0 +1,37 @@
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+
+task :default => [:test]
+
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = 'test/suite.rb'
+end
+
+
+Rake::RDocTask.new(:doc) do |t|
+  t.main = 'README'
+  t.rdoc_files.include('README', 'lib/**/*.rb')
+  t.rdoc_dir = 'doc'
+  t.title = 'Design by Contract for Ruby'
+  t.options = ['--all', '--charset', 'utf8']
+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.1'
+  s.has_rdoc = true
+  s.extra_rdoc_files << 'README'
+  s.rdoc_options = ['--main', 'README', '--all', '--charset', 'utf8']
+  s.files = FileList['lib/**/*', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end

data/lib/design_by_contract.rb

@@ -0,0 +1,141 @@
+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
+
+
+  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
+    
+    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/test/design_by_contract_test.rb

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,41 @@
+require '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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,37 @@
+require 'test/unit'
+
+require '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

data/test/suite.rb

@@ -0,0 +1,12 @@
+require 'find'
+
+
+Find.find('.') do |path|
+  if FileTest.directory?(path) && /\.svn$/ === path
+    Find.prune
+  else
+    if FileTest.file?(path) && /_test\.rb$/ === path
+      require path
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: rdbc
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2007-02-17 00:00:00 +01: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: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Armin Joellenbeck
+files: 
+- lib/design_by_contract.rb
+- Rakefile
+- README
+- test/design_by_contract_test.rb
+- test/stack_contract.rb
+- test/stack_test.rb
+- test/stack.rb
+- test/suite.rb
+test_files: []
+
+rdoc_options: 
+- --main
+- README
+- --all
+- --charset
+- utf8
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+