Title: [1543] trunk/core/jbehave-core/src/behaviour/java/org/jbehave/scenario: JBEHAVE-238: Added javadocs and better coverage.
Revision
1543
Author
mauro
Date
2010-02-06 01:31:20 -0600 (Sat, 06 Feb 2010)

Log Message

JBEHAVE-238:  Added javadocs and better coverage.

Modified Paths

Added Paths

Diff

Added: trunk/core/jbehave-core/src/behaviour/java/org/jbehave/scenario/definition/KeywordsBehaviour.java (0 => 1543)

--- trunk/core/jbehave-core/src/behaviour/java/org/jbehave/scenario/definition/KeywordsBehaviour.java	                        (rev 0)
+++ trunk/core/jbehave-core/src/behaviour/java/org/jbehave/scenario/definition/KeywordsBehaviour.java	2010-02-06 07:31:20 UTC (rev 1543)
@@ -0,0 +1,41 @@
+package org.jbehave.scenario.definition;
+
+import static org.junit.Assert.assertEquals;
+
+import java.io.IOException;
+import java.util.HashMap;
+
+import org.jbehave.scenario.definition.KeyWords.InsufficientKeywordsException;
+import org.jbehave.scenario.definition.KeyWords.KeywordNotFoundException;
+import org.junit.Test;
+
+public class KeywordsBehaviour {
+
+    @Test
+    public void shouldHaveAllKeywordsSetByDefault() throws IOException {
+        KeyWords keywords = new KeyWords();
+        assertEquals("Scenario:", keywords.scenario());
+        assertEquals("GivenScenarios:", keywords.givenScenarios());
+        assertEquals("Examples:", keywords.examplesTable());
+        assertEquals("Example:", keywords.examplesTableRow());
+        assertEquals("Given", keywords.given());
+        assertEquals("When", keywords.when());
+        assertEquals("Then", keywords.then());
+        assertEquals("And", keywords.and());
+        assertEquals("!--", keywords.ignorable());
+        assertEquals("PENDING", keywords.pending());
+        assertEquals("NOT PERFORMED", keywords.notPerformed());
+        assertEquals("FAILED", keywords.failed());
+    }
+
+    @Test(expected=KeywordNotFoundException.class)
+    public void shouldFailIfSomeKeywordIsMissingInMapConstructor() throws IOException {
+        new KeyWords(new HashMap<String, String>());
+    }
+
+    @Test(expected=InsufficientKeywordsException.class)
+    public void shouldFailIfSomeKeywordIsMissingInVarargConstructor() throws IOException {
+        new KeyWords("scenario", "givenScenario", "examples", "given", "when", "then", "and", "!--");
+    }
+
+}

Modified: trunk/core/jbehave-core/src/main/java/org/jbehave/scenario/definition/KeyWords.java (1542 => 1543)

--- trunk/core/jbehave-core/src/main/java/org/jbehave/scenario/definition/KeyWords.java	2010-02-05 17:35:19 UTC (rev 1542)
+++ trunk/core/jbehave-core/src/main/java/org/jbehave/scenario/definition/KeyWords.java	2010-02-06 07:31:20 UTC (rev 1543)
@@ -10,8 +10,9 @@
 
 /**
  * Provides the keywords which allow parsers to find steps in scenarios and
- * match those steps with candidates through the annotations (Given, When and Then)
- * or though other keywords (And, "!--").  It also provides keywords used in reporting.  
+ * match those steps with candidates through the annotations (Given, When and
+ * Then) or though other keywords (And, "!--"). It also provides keywords used
+ * in reporting.
  */
 public class KeyWords {
 
@@ -62,19 +63,33 @@
         return keywords;
     }
 
+    /**
+     * Creates KeyWords with default values {...@link #defaultKeywords()}.
+     */
     public KeyWords() {
         this(defaultKeywords());
     }
 
+    /**
+     * Creates KeyWords with provided values and default encoder
+     * 
+     * @param keywords the Map of keywords indexed by their name
+     */
     public KeyWords(Map<String, String> keywords) {
         this(keywords, new StringEncoder());
     }
 
+    /**
+     * Creates a KeyWords from the map provided.  
+     * 
+     * @param keywords the Map of keywords indexed by their name
+     * @param encoder the StringEncoder used to encode the values
+     */
     public KeyWords(Map<String, String> keywords, StringEncoder encoder) {
         this.scenario = keyword(SCENARIO, keywords);
-        this.givenScenarios =  keyword(GIVEN_SCENARIOS, keywords);
+        this.givenScenarios = keyword(GIVEN_SCENARIOS, keywords);
         this.examplesTable = keyword(EXAMPLES_TABLE, keywords);
-        this.given =  keyword(GIVEN, keywords);
+        this.given = keyword(GIVEN, keywords);
         this.when = keyword(WHEN, keywords);
         this.then = keyword(THEN, keywords);
         this.and = keyword(AND, keywords);
@@ -83,19 +98,31 @@
         this.notPerformed = keyword(NOT_PERFORMED, keywords);
         this.failed = keyword(FAILED, keywords);
         this.examplesTableRow = keyword(EXAMPLES_TABLE_ROW, keywords);
-        this.others = new String[]{and, ignorable};
+        this.others = new String[] { and, ignorable };
         this.encoder = encoder;
     }
 
     private String keyword(String name, Map<String, String> keywords) {
         String keyword = keywords.get(name);
-        if ( keyword == null ){
+        if (keyword == null) {
             throw new KeywordNotFoundException(name, keywords);
         }
-        return keyword;        
+        return keyword;
     }
 
     /**
+     * Legacy constructor for KeyWords that provids explicitly the keywords
+     * values. The {...@link others} vararg must include 6 additional keywords
+     * (and, ignorable, pending, notPerformed, failed, examplesTableRow).
+     * 
+     * @param scenario
+     * @param givenScenarios
+     * @param examplesTable
+     * @param given
+     * @param when
+     * @param then
+     * @param others
+     * 
      * @deprecated Use KeyWords(Map<String,String>, StringEncoder)
      */
     public KeyWords(String scenario, String givenScenarios, String examplesTable, String given, String when,
@@ -107,8 +134,7 @@
         this.when = when;
         this.then = then;
         if (others.length < 6) {
-            throw new IllegalArgumentException("Insufficient keywords: " + asList(others) + ", but requires another "
-                    + (6 - others.length));
+            throw new InsufficientKeywordsException(others);
         }
         this.and = others[0];
         this.ignorable = others[1];
@@ -182,8 +208,18 @@
     public static final class KeywordNotFoundException extends RuntimeException {
 
         public KeywordNotFoundException(String name, Map<String, String> keywords) {
-            super("Keyword "+name+" not found amongst "+keywords);
+            super("Keyword " + name + " not found amongst " + keywords);
         }
-        
+
     }
+
+    @SuppressWarnings("serial")
+    public static final class InsufficientKeywordsException extends RuntimeException {
+
+        public InsufficientKeywordsException(String... others) {
+            super("Insufficient keywords: " + asList(others) + ", but requires another " + (6 - others.length));
+        }
+
+    }
+
 }


To unsubscribe from this list please visit:

http://xircles.codehaus.org/manage_email

Reply via email to