I really want the student to be able to delete or comment out the fail() methods in AboutKoans. So, add the ability to mark those Koans as "don't require an assert" in PathToEnlightenment.xml.

Author: DavidWhitlock

koans/app/config/PathToEnlightenment.xml

@@ -2,8 +2,8 @@
 <packages>
     <package pkg="beginner" name="Novice">
         <suite class="AboutKoans">
-        <koan name="findAboutKoansFile" displayIncompleteKoanException="false" />
-        <koan name="definitionOfKoanCompletion" displayIncompleteKoanException="false" />
+        <koan name="findAboutKoansFile" displayIncompleteKoanException="false" requireAssertion="false" />
+        <koan name="definitionOfKoanCompletion" displayIncompleteKoanException="false" requireAssertion="false" />
         </suite>
         <suite class="AboutAssertions"/>
         <suite class="AboutEquality"/>

koans/pom.xml

@@ -64,7 +64,7 @@
     <dependency>
       <groupId>io.github.davidwhitlock.joy.com.sandwich</groupId>
       <artifactId>koans-lib</artifactId>
-      <version>1.2.3</version>
+      <version>1.3.0-SNAPSHOT</version>
     </dependency>
   </dependencies>
   <properties>

lib/src/main/java/com/sandwich/koan/KoanMethod.java

@@ -11,6 +11,7 @@ public class KoanMethod {
 	private final transient Method method;
 	private final String lesson;
 	private final boolean displayIncompleteException;
+	private final boolean requiresAssertion;
 	private static final KoanSuiteCompilationListener listener = new KoanSuiteCompilationListener();
 
 	private KoanMethod(KoanElementAttributes koanAttributes) throws SecurityException, NoSuchMethodException{
@@ -26,27 +27,33 @@ public static KoanMethod getInstance(KoanElementAttributes koanAttributes){
 	}
 
 	public static KoanMethod getInstance(Method method){
-		return new KoanMethod(null, method, true);
+		return new KoanMethod(null, method, true, true);
+	}
+
+	public static KoanMethod getInstance(Method method, boolean requiresAssertion){
+		return new KoanMethod(null, method, true, requiresAssertion);
 	}
 
 	public static KoanMethod getInstance(String lesson, Method method){
-		return new KoanMethod(lesson, method, true);
+		return new KoanMethod(lesson, method, true, true);
 	}
 
-	private KoanMethod(String lesson, Method method, boolean displayIncompleteException){
+	private KoanMethod(String lesson, Method method, boolean displayIncompleteException, boolean requiresAssertion){
 		if(method == null){
 			throw new IllegalArgumentException("method may not be null");
 		}
 		this.method = method;
 		this.lesson = new RbVariableInjector(lesson, method).injectLessonVariables();
 		this.displayIncompleteException = displayIncompleteException;
+		this.requiresAssertion = requiresAssertion;
 	}
 
 	public KoanMethod(String lesson, KoanElementAttributes koanAttributes) throws SecurityException, NoSuchMethodException {
 		this(	lesson, 
 				KoanClassLoader.getInstance().loadClass(koanAttributes.className, listener)
 					.getMethod(koanAttributes.name),
-				!"false".equalsIgnoreCase(koanAttributes.displayIncompleteKoanException));
+				!"false".equalsIgnoreCase(koanAttributes.displayIncompleteKoanException),
+				!"false".equalsIgnoreCase(koanAttributes.requireAssertion));
 	}
 
 	public String getLesson() {
@@ -60,9 +67,13 @@ public Method getMethod() {
 	public boolean displayIncompleteException() {
 		return displayIncompleteException;
 	}
+
+	public boolean requiresAssertion() {
+		return requiresAssertion;
+	}
 
 	public KoanMethod clone(Method method){
-		return new KoanMethod(lesson, method, displayIncompleteException);
+		return new KoanMethod(lesson, method, displayIncompleteException, requiresAssertion);
 	}
 
 	@Override public String toString(){
@@ -75,6 +86,7 @@ public int hashCode() {
 		final int prime = 31;
 		int result = 1;
 		result = prime * result + (displayIncompleteException ? 1231 : 1237);
+		result = prime * result + (requiresAssertion ? 1231 : 1237);
 		result = prime * result + ((lesson == null) ? 0 : lesson.hashCode());
 		return result;
 	}
@@ -90,6 +102,8 @@ public boolean equals(Object obj) {
 		KoanMethod other = (KoanMethod) obj;
 		if (displayIncompleteException != other.displayIncompleteException)
 			return false;
+		if (requiresAssertion != other.requiresAssertion)
+			return false;
 		if (lesson == null) {
 			if (other.lesson != null)
 				return false;

lib/src/main/java/com/sandwich/koan/path/xmltransformation/KoanElementAttributes.java

@@ -3,11 +3,12 @@
 
 public class KoanElementAttributes{
 
-	public String name, displayIncompleteKoanException, className;
+	public String name, displayIncompleteKoanException, requireAssertion, className;
 
-	public KoanElementAttributes(String name, String displayIncompleteKoanException, String className){
+	public KoanElementAttributes(String name, String displayIncompleteKoanException, String requireAssertion, String className){
 		this.name = name;
 		this.displayIncompleteKoanException = displayIncompleteKoanException;
+		this.requireAssertion = requireAssertion;
 		this.className = className;
 	}
 
@@ -21,6 +22,8 @@ public int hashCode() {
 				* result
 				+ ((displayIncompleteKoanException == null) ? 0
 						: displayIncompleteKoanException.hashCode());
+		result = prime * result
+				+ ((requireAssertion == null) ? 0 : requireAssertion.hashCode());
 		result = prime * result + ((name == null) ? 0 : name.hashCode());
 		return result;
 	}
@@ -45,6 +48,11 @@ public boolean equals(Object obj) {
 		} else if (!displayIncompleteKoanException
 				.equals(other.displayIncompleteKoanException))
 			return false;
+		if (requireAssertion == null) {
+			if (other.requireAssertion != null)
+				return false;
+		} else if (!requireAssertion.equals(other.requireAssertion))
+			return false;
 		if (name == null) {
 			if (other.name != null)
 				return false;
@@ -57,7 +65,8 @@ public boolean equals(Object obj) {
 	public String toString() {
 		return "KoanElementAttributes [name=" + name
 				+ ", displayIncompleteKoanException="
-				+ displayIncompleteKoanException + ", className=" + className
+				+ displayIncompleteKoanException + ", requireAssertion="
+				+ requireAssertion + ", className=" + className
 				+ "]";
 	}
 

lib/src/main/java/com/sandwich/koan/path/xmltransformation/XmlToPathTransformerImpl.java

@@ -95,11 +95,14 @@ Map<String, KoanElementAttributes> extractKoansAndRawLessons(
 						.getNamedItem("displayIncompleteKoanException");
 				String displayIncompleteKoanException = displayKoanIncompleteExceptionNode == null ? null
 						: displayKoanIncompleteExceptionNode.getNodeValue();
+				Node requireAssertionNode = attributes.getNamedItem("requireAssertion");
+				String requireAssertion = requireAssertionNode == null ? null
+						: requireAssertionNode.getNodeValue();
 				if (rawKoanAttributesByMethodName.containsKey(name)) {
 					throw new DuplicateKoanException(className, name);
 				}
 				rawKoanAttributesByMethodName.put(name, new KoanElementAttributes(
-					name, displayIncompleteKoanException, className));
+					name, displayIncompleteKoanException, requireAssertion, className));
 			}
 		}
 		return rawKoanAttributesByMethodName;
@@ -113,4 +116,3 @@ public DuplicateKoanException(String className, String name){
 	}
 
 }
-

lib/src/main/java/com/sandwich/koan/runner/KoanMethodRunner.java

@@ -32,7 +32,7 @@ public static KoanMethodResult run(Object suite, KoanMethod koan){
 			Method method = koan.getMethod();
 			method.setAccessible(true);
 			method.invoke(suite);
-			if(!Assert.wasAssertionInvoked()){
+			if(koan.requiresAssertion() && !Assert.wasAssertionInvoked()){
 				return new KoanMethodResult(koan, NO_ASSERTION_MESSAGE, null);
 			}
 		} catch (Throwable t) {

lib/src/test/java/com/sandwich/koan/path/CommandLineTestCase.java

@@ -105,7 +105,7 @@ protected Path stubAllKoans(String packageName, List<String> path){
 			KoanSuiteCompilationListener listener = new KoanSuiteCompilationListener();
 			for(Method m : loader.loadClass(suite, listener).getMethods()){
 				if(m.getAnnotation(Koan.class) != null){
-					methodsByName.put(m.getName(), new KoanElementAttributes(m.getName(), "", m.getDeclaringClass().getName()));
+					methodsByName.put(m.getName(), new KoanElementAttributes(m.getName(), "", "", m.getDeclaringClass().getName()));
 				}
 			}
 			tempSuitesAndMethods.put(suite, methodsByName);

lib/src/test/java/com/sandwich/koan/runner/KoanMethodRunnerTest.java

@@ -42,4 +42,12 @@ public void assertionTrackingResetsBetweenKoans() throws Exception {
 		assertTrue(first.isPassed());
 		assertFalse(second.isPassed());
 	}
+
+	@Test
+	public void koanWithoutAssertionCanBeAllowedToPass() throws Exception {
+		KoanMethodResult result = KoanMethodRunner.run(
+			new NoAssertionKoan(),
+			KoanMethod.getInstance(NoAssertionKoan.class.getDeclaredMethod("koan"), false));
+		assertTrue(result.isPassed());
+	}
 }