armin-joellenbeck-rdbc 0.0.5 → 0.0.6

data/Rakefile

@@ -1,17 +1,11 @@
-require 'spec/rake/spectask'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
 
 
-task :default => [:spec]
+task :default => :rubydoctest
 
 
-task :all =>  [:spec, :doc, :package]
-
-
-Spec::Rake::SpecTask.new do |t|
-  t.libs << 'spec' << 'examples' << 'lib'
-end
+task :all =>  [:doc, :package]
 
 
 Rake::RDocTask.new(:doc) do |t|
@@ -29,3 +23,9 @@ end
 
 Rake::GemPackageTask.new(eval(File.read('rdbc.gemspec'))) do |pkg|
 end
+
+
+task :rubydoctest do
+  files = Dir['lib/**/*.rb','examples/**/*.rb'].join(' ')
+  sh "RUBYLIB=examples:lib:$RUBYLIB rubydoctest #{files}"
+end

data/examples/stack.rb

@@ -8,37 +8,72 @@ class Stack
   end
 
   def initialize
-    @elements = []
+    @objects = []
   end
 
   def initialize_copy(orig)
-    @elements = orig.elements
+    @objects = orig.objects
   end
 
-  def elements
-    @elements.dup
+  def objects
+    @objects.dup
   end
 
   def size
-    @elements.size
+    @objects.size
   end
 
+  # doctest: A new Stack should be empty.
+  #   >> stack = Stack.new
+  #   >> stack.empty?
+  #   => true
   def empty?
     size == 0
   end
 
+  # doctest: A new Stack should have no object on top.
+  #   >> stack = Stack.new
+  #   >> begin
+  #   ?>   stack.top
+  #   ?> rescue Test::Unit::AssertionFailedError
+  #   ?>   true
+  #   ?> else
+  #   ?>   false
+  #   ?> end
+  #   => true
   def top
-    @elements.last
+    @objects.last
   end
 
-  def push(element)
-    @elements.push(element)
-    nil
+  # doctest: From a new Stack no object can be popped.
+  #   >> stack = Stack.new
+  #   >> begin
+  #   ?>   stack.pop
+  #   ?> rescue Test::Unit::AssertionFailedError
+  #   ?>   true
+  #   ?> else
+  #   ?>   false
+  #   ?> end
+  #   => true
+  def pop
+    @objects.pop
   end
 
-  def pop
-    raise NoPopForEmptyStack if empty?
-    @elements.pop
+  # doctest: A pushed object should be on the top.
+  #   >> stack = Stack.new
+  #   >> object = Object.new
+  #   >> stack.push(object)
+  #   >> stack.empty?
+  #   => false
+  #   >> stack.top
+  #   => object
+  #   >> stack.pop
+  #   => object
+  #   >> stack.empty?
+  #   => true
+  def push(object)
+    @objects.push(object)
+    nil
   end
 
 end

data/examples/stack_contract.rb

@@ -2,17 +2,17 @@ require 'contract'
 
 class StackContract < Contract
 
-  def push_post(stack_pre, stack, exception, result, element)
+  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
 
-  def pop_pre(stack)
+  pre :pop do |stack|
     assert_operator(stack.size, :>=, 0)
   end
 
-  def pop_post(stack_pre, stack, exception, result)
+  post :pop do |stack_pre, stack, exception, result|
     if stack_pre.empty?
       assert_kind_of(Stack::NoPopForEmptyStack, exception)
     else
@@ -21,15 +21,15 @@ class StackContract < Contract
     end
   end
 
-  def top_pre(stack)
+  pre :top do |stack|
     assert_operator(stack.size, :>=, 1)
   end
 
-  def top_post(stack_pre, stack, exception, result)
+  post :top do |stack_pre, stack, exception, result|
     assert_equal(stack_pre.size, stack.size)
   end
 
-  def invariant(stack)
+  invariant do |stack|
     assert_operator(stack.size, :>=, 0)
   end
 

data/lib/contract.rb

@@ -1,22 +1,35 @@
 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
 
+end
 
-require 'object'
-require 'proxy'
 
 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 = Proxy.new(object, contract)
-    end
+  def contract(contract_class)
+    decorator ContractDecorator(contract_class)
   end
 
 end

data/lib/{proxy.rb → contract_decorator.rb}

@@ -1,10 +1,16 @@
+require 'decorator'
 require 'translate'
 
-class Proxy
 
-  def initialize(object, contract)
-    @object = object
-    @contract = contract
+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)
@@ -44,3 +50,9 @@ class Proxy
   end
 
 end
+
+def ContractDecorator(contract_class)
+  klass = Class.new(ContractDecorator)
+  klass.contract_class = contract_class
+  klass
+end

data/lib/decorator.rb

@@ -0,0 +1,31 @@
+class Decorator
+
+  attr_reader :object
+
+  # doctest: A Decorator should be initialized with thr decorated object.
+  #   >> object = Object.new
+  #   >> decorator = Decorator.new(object)
+  #   >> decorator.object == object
+  #   => true
+  def initialize(object)
+    @object = object
+  end
+
+  def method_missing(method, *args)
+    @object.send(method, *args)
+  end
+
+end
+
+
+class Class
+
+  def decorator(decorator_class)
+    old_new = self.method(:new)
+    (class << self; self; end).send(:define_method, :new) do |*args|
+      object = old_new.call(*args)
+      decorator_class.new(object)
+    end
+  end
+
+end

data/lib/translate.rb

@@ -1,5 +1,71 @@
 module Translate
 
+  # doctest: Translate should give the pre method for a normal method
+  #   >> Translate.method_pre(:method)
+  #   => :method_pre
+  #
+  # doctest: Translate should give the pre method for a question method
+  #   >> Translate.method_pre(:method?)
+  #   => :method_pre?
+  #
+  # doctest: Translate should give the pre method for an exclamation method
+  #   >> Translate.method_pre(:method!)
+  #   => :method_pre!
+  #
+  # doctest: Translate should give the pre method for an assignment method
+  #   >> Translate.method_pre(:method=)
+  #   => :method_pre=
+  #
+  # doctest: Translate should give the pre method for an operator
+  #   >> Translate.method_pre(:+)
+  #   => :op_plus_pre
+  def self.method_pre(method)
+     method_with_suffix(method, :pre)
+  end
+
+  # doctest: Translate should give the post method for a normal method
+  #   >> Translate.method_post(:method)
+  #   => :method_post
+  #
+  # doctest: Translate should give the post method for a question method
+  #   >> Translate.method_post(:method?)
+  #   => :method_post?
+  #
+  # doctest: Translate should give the post method for an exclamation method
+  #   >> Translate.method_post(:method!)
+  #   => :method_post!
+  #
+  # doctest: Translate should give the post method for an assignment method
+  #   >> Translate.method_post(:method=)
+  #   => :method_post=
+  #
+  # doctest: Translate should give the post method for an operator
+  #   >> Translate.method_post(:+)
+  #   => :op_plus_post
+  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,
@@ -27,30 +93,4 @@ module Translate
     :=~  => :match
   }
 
-  def self.method_pre(method)
-    method_with_suffix(method, :pre)
-  end
-
-  def self.method_post(method)
-    method_with_suffix(method, :post)
-  end
-
-  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
-
 end

data/rdbc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rdbc'
-  s.version = '0.0.5'
+  s.version = '0.0.6'
   s.summary = 'Design by Contract for Ruby.'
   s.author = 'Armin Joellenbeck'
   s.email = 'armin@joellenbeck.net'
@@ -13,7 +13,6 @@ Gem::Specification.new do |s|
     '*.gemspec',
     'examples/**/*',
     'lib/**/*',
-    'spec/**/*'
   ])
   s.has_rdoc = true
   s.extra_rdoc_files << 'README'
@@ -23,4 +22,5 @@ Gem::Specification.new do |s|
     '--main', 'README',
     '--title', 'Design by Contract for Ruby'
   ]
+  s.add_dependency('tablatom-rubydoctest')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: armin-joellenbeck-rdbc
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Armin Joellenbeck
@@ -11,8 +11,16 @@ cert_chain: []
 
 date: 2008-08-13 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tablatom-rubydoctest
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: ""
 email: armin@joellenbeck.net
 executables: []
@@ -27,17 +35,10 @@ files:
 - rdbc.gemspec
 - examples/stack_contract.rb
 - examples/stack.rb
+- lib/decorator.rb
 - lib/contract.rb
 - lib/translate.rb
-- lib/object.rb
-- lib/proxy.rb
-- spec/translate_spec.rb
-- spec/object_spec.rb
-- spec/proxy_spec.rb
-- spec/spec.opts
-- spec/contract_spec.rb
-- spec/stack_contract_spec.rb
-- spec/stack_spec.rb
+- lib/contract_decorator.rb
 has_rdoc: true
 homepage: http://github.com/armin-joellenbeck/rdbc/tree/master
 post_install_message: 

data/lib/object.rb

@@ -1,13 +0,0 @@
-class Object
-
-  def singleton_class
-    class << self
-      self
-    end
-  end
-
-  def define_singleton_method(method, &block)
-    singleton_class.send(:define_method, method, &block)
-  end
-
-end

data/spec/contract_spec.rb

@@ -1,4 +0,0 @@
-require 'contract'
-
-describe Contract do
-end

data/spec/object_spec.rb

@@ -1,4 +0,0 @@
-require 'object'
-
-describe Object do
-end

data/spec/proxy_spec.rb

@@ -1,4 +0,0 @@
-require 'proxy'
-
-describe Proxy do
-end

data/spec/spec.opts

@@ -1,3 +0,0 @@
---colour
---format
-specdoc

data/spec/stack_contract_spec.rb

@@ -1,4 +0,0 @@
-require 'stack_contract'
-
-describe StackContract do
-end

data/spec/stack_spec.rb

@@ -1,30 +0,0 @@
-require 'stack'
-
-describe Stack do
-
-  before do
-    @stack = Stack.new
-  end
-
-  it 'should be empty' do
-    @stack.should be_empty
-  end
-
-  it 'should have no element on top' do
-    lambda { @stack.top }.should raise_error(Test::Unit::AssertionFailedError)
-  end
-
-  it 'should not be possible to pop an element' do
-    lambda { @stack.pop }.should raise_error(Stack::NoPopForEmptyStack)
-  end
-
-  it 'a pushed element should be on the top' do
-    element = 0
-    @stack.push(element)
-    @stack.should_not be_empty
-    @stack.top.should be_equal(element)
-    @stack.pop.should be_equal(element)
-    @stack.should be_empty
-  end
-
-end

data/spec/translate_spec.rb

@@ -1,45 +0,0 @@
-require 'translate'
-
-describe Translate do
-
-  it 'should give the pre method for a normal method' do
-    Translate.method_pre(:method).should == :method_pre
-  end
-
-  it 'should give the pre method for a question method' do
-    Translate.method_pre(:method?).should == :method_pre?
-  end
-
-  it 'should give the pre method for an exclamation method' do
-    Translate.method_pre(:method!).should == :method_pre!
-  end
-
-  it 'should give the pre method for an assignment method' do
-    Translate.method_pre(:method=).should == :method_pre=
-  end
-
-  it 'should give the pre method for an operator' do
-    Translate.method_pre(:+).should == :op_plus_pre
-  end
-
-  it 'should give the post method for a normal method' do
-    Translate.method_post(:method).should == :method_post
-  end
-
-  it 'should give the post method for a question method' do
-    Translate.method_post(:method?).should == :method_post?
-  end
-
-  it 'should give the post method for an exclamation method' do
-    Translate.method_post(:method!).should == :method_post!
-  end
-
-  it 'should give the post method for an assignment method' do
-    Translate.method_post(:method=).should == :method_post=
-  end
-
-  it 'should give the post method for an operator' do
-    Translate.method_post(:+).should == :op_plus_post
-  end
-
-end