Changes between Version 8 and Version 9 of Methods

Timestamp:

12/03/13 09:24:01 (11 years ago)

Author:

hopscc

Comment:

--

Methods

@@ -66 +66 @@
 sum takes a variable number of integer args and returns an integer.
 
+== Tests, Contracts and Code ==
+
+The above refers to simple method code or method body code. [[BR]]
+You can also specify Tests (for the method) and contract requirements on the method. [[BR]]
+To do this the method is tagged with named clauses: [[BR]]
+  * '''test''' clauses for any tests, 
+  * '''require''' and '''ensure''' clauses for the pre and post conditions specifying the method contracts and a 
+  * '''body''' clause for the method code. [[BR]] 
+
+If given, the order of these clauses must be :
+  * Test clauses
+  * contract clauses (require and/or ensure)
+  * body clause
+ 
 == Special Methods ==
 These are named methods on a class that have some special responsibility or relationship to the Object Model[[BR]]
@@ -157 +171 @@
    .counter += 1 #method body - not additionally indented
    .val += i
-   return .val     
+   return .val 
+
+# Heres a full example giving all the clauses
+def simpleBump(i as int) as int
+   require  # prerequisite contract - in indented clause (1 or many expressions)
+      i >0               
+   ensure   # postcondition contract - in indented clause (1 or many expressions)
+      .val > old .val  
+   test          # unit test clause
+       a = Inst()
+       assert a.counter == 0
+       assert a.val == 0
+       a.simpleBump(1)
+       assert a.counter ==1
+       assert a.val == 1
+   test num2         # another unit test clause (named)
+       a = Inst()
+       a.simpleBump(2)
+       assert a.counter == 1
+       assert a.val == 2
+
+   body            #method body - tagged and additionally indented
+      .counter += 1 
+      .val += i
+      return .val     
+     
 }}} 
+
+Return to LanguageTopics