armin-joellenbeck-rdbc 0.0.7 → 0.1.0

data/{README → README.rdoc}

@@ -6,20 +6,14 @@ This library supports Design by Contract for Ruby.
 
 Install the *rdbc* gem itself by the following command:
 
-  $ gem install rdbc
+  $ gem install armin-joellenbeck-rdbc --source http://gems.github.com
 
 =Usage
 
 A a standard example for Design by Contract consider the following Stack
 class and its contract StackContract.
 
-===stack.rb
-
-  :include:examples/stack.rb
-
-===stack_contract.rb
-
-  :include:examples/stack_contract.rb
+  :include:spec/stack_spec.rb
 
 The mechanics are really simple. There is the class Stack.
 For instances of this class you can define a contract by subclassing
@@ -29,24 +23,26 @@ 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
+Then the following happens when a method of a Stack 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
 Stack.
 
@@ -54,9 +50,6 @@ In any of these contract methods you can use assertions as in Test::Unit tests.
 When an assertion fails, the exception Test::Unit::AssertionFailedError
 is raised.
 
-When the method is an operator the *_pre* and  *_post* suffixes are appended
-to the names of the operator according to the constant #Translate::OPERATOR.
-
 =Support
 
 The project home is at
@@ -71,7 +64,7 @@ Feel free to send:
 
 =Copyright
 
-Copyright (c) 2007 - 2008 by Armin Jöllenbeck
+Copyright (c) 2007 - 2009 by Armin Jöllenbeck
 <armin@joellenbeck.net[mailto:armin@joellenbeck.net]>
 
 All rights reserved.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: armin-joellenbeck-rdbc
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors: 
 - Armin Joellenbeck
@@ -9,18 +9,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-27 00:00:00 -07:00
+date: 2009-05-16 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: armin-joellenbeck-decorator
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+dependencies: []
+
 description: ""
 email: armin@joellenbeck.net
 executables: []
@@ -28,16 +20,9 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
-files: 
-- README
-- Rakefile
-- rdbc.gemspec
-- examples/stack_contract.rb
-- examples/stack.rb
-- lib/contract.rb
-- lib/translate.rb
-- lib/contract_decorator.rb
+- README.rdoc
+files: []
+
 has_rdoc: true
 homepage: http://github.com/armin-joellenbeck/rdbc/tree/master
 post_install_message: 
@@ -46,7 +31,7 @@ rdoc_options:
 - --charset
 - utf8
 - --main
-- README
+- README.rdoc
 - --title
 - Design by Contract for Ruby
 require_paths: 

data/Rakefile

@@ -1,32 +0,0 @@
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'spec/rake/spectask'
-
-task :default => 'spec'
-
-task :all =>  [:clobber, :spec, :doc, :package]
-
-Spec::Rake::SpecTask.new do |t|
-  t.libs << 'spec' << 'examples' << 'lib'
-  t.spec_opts << '--diff' << 'unified'
-  t.spec_opts << '--format' << 'progress'
-end
-
-Rake::RDocTask.new(:doc) do |t|
-  t.rdoc_dir = 'doc'
-  t.rdoc_files.include('README', 'lib/**/*.rb')
-  t.options = [
-    '--all',
-    '--charset', 'utf8',
-    '--inline-source',
-    '--main', 'README',
-    '--title', 'Design by Contract for Ruby'
-  ]
-end
-
-Rake::GemPackageTask.new(eval(File.read('rdbc.gemspec'))) do |pkg|
-end
-
-task :auto do
-  sh 'RUBYLIB=spec:examples:lib:$RUBYLIB autospec'
-end

data/examples/stack.rb

@@ -1,43 +0,0 @@
-require 'stack_contract'
-
-class Stack
-
-  contract StackContract
-
-  class NoPopForEmptyStack < RuntimeError
-  end
-
-  def initialize
-    @objects = []
-  end
-
-  def initialize_copy(orig)
-    @objects = orig.objects
-  end
-
-  def objects
-    @objects.dup
-  end
-
-  def size
-    @objects.size
-  end
-
-  def empty?
-    size == 0
-  end
-
-  def top
-    @objects.last
-  end
-
-  def pop
-    @objects.pop
-  end
-
-  def push(object)
-    @objects.push(object)
-    nil
-  end
-
-end

data/examples/stack_contract.rb

@@ -1,36 +0,0 @@
-require 'contract'
-
-class StackContract < Contract
-
-  post :push do |stack_pre, stack, exception, result, element|
-    assert_nil(result)
-    assert_equal(element, stack.top)
-    assert_equal(stack.size, stack_pre.size + 1)
-  end
-
-  pre :pop do |stack|
-    assert_operator(stack.size, :>=, 0)
-  end
-
-  post :pop do |stack_pre, stack, exception, result|
-    if stack_pre.empty?
-      assert_kind_of(Stack::NoPopForEmptyStack, exception)
-    else
-      assert_equal(stack_pre.top, result)
-      assert_equal(stack_pre.size - 1, stack.size)
-    end
-  end
-
-  pre :top do |stack|
-    assert_operator(stack.size, :>=, 1)
-  end
-
-  post :top do |stack_pre, stack, exception, result|
-    assert_equal(stack_pre.size, stack.size)
-  end
-
-  invariant do |stack|
-    assert_operator(stack.size, :>=, 0)
-  end
-
-end

data/lib/contract.rb

@@ -1,35 +0,0 @@
-require 'test/unit/assertions'
-
-require 'contract_decorator'
-
-
-class Contract
-
-  class << self
-
-    def pre(method, &block)
-      define_method(Translate.method_pre(method), &block)
-    end
-
-    def post(method, &block)
-      define_method(Translate.method_post(method), &block)
-    end
-
-    def invariant(&block)
-      define_method(:invariant, &block)
-    end
-
-  end
-
-  include Test::Unit::Assertions
-
-end
-
-
-class Class
-
-  def contract(contract_class)
-    decorate ContractDecorator(contract_class)
-  end
-
-end

data/lib/contract_decorator.rb

@@ -1,60 +0,0 @@
-require 'rubygems'
-require 'decorator'
-
-require 'translate'
-
-
-class ContractDecorator < Decorator
-
-  class << self
-    attr_accessor :contract_class
-  end
-
-  def initialize(object)
-    super(object)
-    @contract = self.__class__.contract_class.new
-  end
-
-  def method_missing(method, *args)
-    # clone the object under contract for use in the pre condition
-    object_pre = @object.clone
-
-    # call pre condition
-    method_pre = Translate.method_pre(method)
-    if @contract.respond_to?(method_pre)
-      @contract.send(method_pre, @object, *args)
-    end
-
-    # call the wrapped method
-    exception = nil
-    begin
-      result = @object.send(method, *args)
-    rescue => exception
-    end
-
-    # call the invariant condition
-    if @contract.respond_to?(:invariant)
-      @contract.invariant(@object)
-    end
-
-    # call the post condition
-    method_post = Translate.method_post(method)
-    if @contract.respond_to?(method_post)
-      @contract.send(method_post, object_pre, @object, exception, result, *args)
-    end
-
-    # return the return value of the wrapped method call or raise the exception
-    if exception.nil?
-      result
-    else
-      raise exception
-    end
-  end
-
-end
-
-def ContractDecorator(contract_class)
-  klass = Class.new(ContractDecorator)
-  klass.contract_class = contract_class
-  klass
-end

data/lib/translate.rb

@@ -1,58 +0,0 @@
-module Translate
-
-  def self.method_pre(method)
-     method_with_suffix(method, :pre)
-  end
-
-  def self.method_post(method)
-    method_with_suffix(method, :post)
-  end
-
-private
-
-  def self.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
-
-  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

data/rdbc.gemspec

@@ -1,26 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = 'rdbc'
-  s.version = '0.0.7'
-  s.summary = 'Design by Contract for Ruby.'
-  s.author = 'Armin Joellenbeck'
-  s.email = 'armin@joellenbeck.net'
-  s.homepage = 'http://github.com/armin-joellenbeck/rdbc/tree/master'
-  s.description = <<-EOF
-  EOF
-  s.files = Dir.glob([
-    'README',
-    'Rakefile',
-    '*.gemspec',
-    'examples/**/*',
-    'lib/**/*',
-  ])
-  s.has_rdoc = true
-  s.extra_rdoc_files << 'README'
-  s.rdoc_options = [
-    '--all',
-    '--charset', 'utf8',
-    '--main', 'README',
-    '--title', 'Design by Contract for Ruby'
-  ]
-  s.add_dependency('armin-joellenbeck-decorator')
-end