rdbc 0.0.1 → 0.0.2

data/README

@@ -4,11 +4,55 @@ 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
@@ -37,13 +81,13 @@ are met:
 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 
+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

@@ -5,19 +5,24 @@ require 'rake/testtask'
 
 task :default => [:test]
 
+task :all =>  [:test, :doc, :package]
+
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
-  t.test_files = 'test/suite.rb'
+  t.test_files = FileList['test/**/*test.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']
+  t.rdoc_files.include('README', 'lib/**/*.rb')
+  t.options = [
+    '--all',
+    '--charset', 'utf8',
+    '--main', 'README',
+    '--title', 'Design by Contract for Ruby'
+  ]
 end
 
 
@@ -26,10 +31,15 @@ spec = Gem::Specification.new do |s|
   s.email = 'armin.joellenbeck@googlemail.com'
   s.name = 'rdbc'
   s.summary = 'Design by Contract for Ruby.'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   s.has_rdoc = true
   s.extra_rdoc_files << 'README'
-  s.rdoc_options = ['--main', 'README', '--all', '--charset', 'utf8']
+  s.rdoc_options = [
+    '--all',
+    '--charset', 'utf8',
+    '--main', 'README',
+    '--title', 'Design by Contract for Ruby'
+  ]
   s.files = FileList['lib/**/*', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
 end
 

data/lib/design_by_contract.rb

@@ -2,15 +2,15 @@ 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
@@ -28,12 +28,38 @@ class Class
       @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
@@ -48,7 +74,7 @@ module DesignByContract
       @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
@@ -78,17 +104,17 @@ module DesignByContract
     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
@@ -106,36 +132,9 @@ module DesignByContract
           ('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

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: rdbc
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2007-02-17 00:00:00 +01:00
+  version: 0.0.2
+date: 2007-09-22 00:00:00 +02:00
 summary: Design by Contract for Ruby.
 require_paths: 
 - lib
@@ -32,19 +32,20 @@ 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/stack.rb
-- test/suite.rb
 test_files: []
 
 rdoc_options: 
-- --main
-- README
 - --all
 - --charset
 - utf8
+- --main
+- README
+- --title
+- Design by Contract for Ruby
 extra_rdoc_files: 
 - README
 executables: []

data/test/suite.rb

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