armin-joellenbeck-rdbc 0.2.2 → 0.2.3

data/Rakefile

@@ -0,0 +1,37 @@
+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' << 'lib'
+  t.ruby_opts << '-r' << 'spec_helper' << '-r' << 'rdbc'
+  t.spec_opts << 
+    '--color' <<
+    '--diff' << 'unified' <<
+    '--format' << 'progress'
+end
+
+Spec::Rake::SpecTask.new(:heckle) do |t|
+  t.libs << 'spec' << 'lib'
+  t.ruby_opts << '-r' << 'spec_helper' << '-r' << 'rdbc'
+  t.spec_opts << '--heckle' << ENV['HECKLE']
+end
+
+Rake::RDocTask.new(:doc) do |t|
+  t.rdoc_dir = 'doc'
+  t.rdoc_files.include('README.rdoc', 'lib/**/*.rb')
+  t.options = [
+    '--all',
+    '--charset', 'utf8',
+    '--inline-source',
+    '--main', 'README.rdoc',
+    '--title', 'Design by Contract for Ruby'
+  ]
+end
+
+Rake::GemPackageTask.new(eval(File.read('rdbc.gemspec'))) do |pkg|
+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

data/lib/rdbc/contract.rb

@@ -0,0 +1,48 @@
+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
+    
+    class AssertionFailed < RuntimeError
+    end
+
+    def assert(condition)
+      raise AssertionFailed unless condition
+    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,25 @@
+module Rdbc
+  class Decorator
+    def initialize(object, contract)
+      @object = object
+      @contract = contract
+    end
+
+    def method_missing(method, *args)
+      object_pre = @object.clone
+      @contract.send_method_pre(method, @object, *args)
+      exception = nil
+      begin
+        result = @object.send(method, *args)
+      rescue => exception
+      end
+      @contract.send_invariant(@object)
+      @contract.send_method_post(method, object_pre, @object, exception, result, *args)
+      if exception.nil?
+        result
+      else
+        raise exception
+      end
+    end
+  end
+end

data/lib/rdbc/translating.rb

@@ -0,0 +1,51 @@
+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)
+      operator = operator(method)
+      ( type.to_s + '_' +
+        if operator.nil?
+          method.to_s
+        else
+          'op_' + operator.to_s
+        end
+      ).to_sym
+    end
+
+    def operator(method)
+      {
+        :[]  => :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
+      }[method]
+    end
+  end
+end

data/spec/contract_spec.rb

@@ -0,0 +1,2 @@
+describe Rdbc::Contract do
+end

data/spec/decorator_spec.rb

@@ -0,0 +1,13 @@
+describe Rdbc::Decorator, 'calling the method :foo' do
+  before do
+    @object = Object.new
+    stub(@object).foo(:argument) { :result }
+    @contract = Rdbc::Contract.new
+    @decorator = Rdbc::Decorator.new(@object, @contract)
+  end
+  
+  it 'should delegate to method :foo of the decorated object' do
+    mock(@object).foo(:argument) { :result }
+    @decorator.foo(:argument).should be_equal(:result)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+
+require 'rr'
+require 'spec'
+
+Spec::Runner.configure do |config|
+  config.mock_with :rr
+end

data/spec/stack_spec.rb

@@ -0,0 +1,96 @@
+class StackContract < Rdbc::Contract
+
+  post :push do |stack_pre, stack, exception, result, element|
+    assert(result.nil?)
+    assert(stack.top == element)
+    assert(stack.size ==stack_pre.size + 1)
+  end
+
+  pre :pop do |stack|
+    assert(stack.size >= 1)
+  end
+
+  post :pop do |stack_pre, stack, exception, result|
+    assert(result.nil?)
+    assert(stack_pre.size - 1 == stack.size)
+  end
+
+  pre :top do |stack|
+    assert(stack.size >= 1)
+  end
+
+  post :top do |stack_pre, stack, exception, result|
+    assert(stack_pre.size == stack.size)
+  end
+
+  invariant do |stack|
+    assert(stack.size >= 0)
+  end
+
+end
+
+
+class Stack
+
+  contract StackContract
+
+  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
+    nil
+  end
+
+  def push(object)
+    @objects.push(object)
+    nil
+  end
+
+end
+
+
+describe 'A new Stack' do
+  before do
+    @stack = Stack.new
+  end
+
+  it 'should be empty.' do
+    @stack.empty?
+  end
+
+  it 'should have no object on its top' do
+     lambda{@stack.top}.should raise_error(Rdbc::Contract::AssertionFailed)
+  end
+
+  it 'should be so that no object can be popped' do
+     lambda{@stack.pop}.should raise_error(Rdbc::Contract::AssertionFailed)
+  end
+
+  it 'A pushed object should be on the top' do
+    object = Object.new
+    @stack.push(object)
+    @stack.top.should equal(object)
+  end
+end

data/spec/translating_spec.rb

@@ -0,0 +1,46 @@
+describe Rdbc::Translating do
+  before do
+    @translator = Object.new
+    @translator.extend(Rdbc::Translating)
+  end
+  
+  it 'should give the pre method for a normal method' do
+    @translator.method_pre(:method).should == :pre_method 
+  end
+
+  it 'should give the pre method for a question method' do
+    @translator.method_pre(:method?).should == :pre_method?
+  end
+
+  it 'should give the pre method for an exclamation method' do
+    @translator.method_pre(:method!).should == :pre_method!
+  end
+  
+  it 'should give the pre method for an assignment method' do
+    @translator.method_pre(:method=).should == :pre_method=
+  end
+
+  it 'should give the pre method for an operator' do
+    @translator.method_pre(:+).should == :pre_op_plus
+  end
+
+  it 'should give the post method for a normal method' do
+    @translator.method_post(:method).should == :post_method
+  end
+
+  it 'should give the post method for a question method' do
+    @translator.method_post(:method?).should == :post_method?
+  end
+
+  it 'should give the post method for an exclamation method' do
+    @translator.method_post(:method!).should == :post_method!
+  end
+
+  it 'should give the post method for an assignment method' do
+    @translator.method_post(:method=).should == :post_method=
+  end
+
+  it 'should give the post method for an operator' do
+    @translator.method_post(:+).should == :post_op_plus
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: armin-joellenbeck-rdbc
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Armin Joellenbeck
@@ -21,8 +21,18 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-files: []
-
+files: 
+- README.rdoc
+- Rakefile
+- lib/rdbc.rb
+- lib/rdbc/contract.rb
+- lib/rdbc/decorator.rb
+- lib/rdbc/translating.rb
+- spec/spec_helper.rb
+- spec/stack_spec.rb
+- spec/contract_spec.rb
+- spec/decorator_spec.rb
+- spec/translating_spec.rb
 has_rdoc: true
 homepage: http://github.com/armin-joellenbeck/rdbc/tree/master
 post_install_message: