New functionality and refactoring coming out of jMock 2 development.

npryce · npryce · commit b60caab9f140 · 2006-08-24T16:04:07.000Z
Added appendValueList methods to the Description interface and StringDescription class
Moved java bean constraints into org.hamcrest.beans
diff --git a/.classpath b/.classpath
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" path="src/api"/>
+	<classpathentry kind="src" path="src/examples"/>
+	<classpathentry kind="src" path="src/integration"/>
+	<classpathentry kind="src" path="src/library"/>
+	<classpathentry kind="src" path="src/unit-test"/>
+	<classpathentry kind="lib" path="lib/integration/easymock-2.2.jar"/>
+	<classpathentry kind="lib" path="lib/integration/jmock-1.10RC1.jar"/>
+	<classpathentry kind="lib" path="lib/integration/junit-3.8.1.jar"/>
+	<classpathentry kind="lib" path="lib/integration/junit-4.0.jar"/>
+	<classpathentry kind="lib" path="lib/integration/testng-4.6-jdk15.jar"/>
+	<classpathentry kind="lib" path="lib/library/jaxen-1.1-beta-4.jar"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+	<classpathentry kind="output" path="classes"/>
+</classpath>
diff --git a/.project b/.project
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>hamcrest-java</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>
diff --git a/src/api/org/hamcrest/Description.java b/src/api/org/hamcrest/Description.java
@@ -11,10 +11,21 @@ public interface Description {
      * Append some plain text to the description.
      */
     Description appendText(String text);
-
+    
     /**
      * Append an arbitary value to the description.
      */
     Description appendValue(Object value);
+    
+    /**
+     * Append a list of values to the description.
+     */
+    <T> Description appendValueList(String start, String separator, String end,
+    							    T... values);
 
+    /**
+     * Append a list of values to the description.
+     */
+    <T> Description appendValueList(String start, String separator, String end,
+    							    Iterable<T> values);
 }
diff --git a/src/api/org/hamcrest/Matcher.java b/src/api/org/hamcrest/Matcher.java
@@ -6,18 +6,16 @@
  * A matcher over acceptable values. A matcher should be able to describe itself to give feedback when it fails.
  */
 public interface Matcher<T> {
-
     /**
-     * Evaluates the matcher for argument <var>o</var>.
+     * Evaluates the matcher for argument <var>item</var>.
      *
      * @param item the object against which the matcher is evaluated.
-     * @return <code>true</code> if <var>o</var> matcher, otherwise <code>false</code>.
+     * @return <code>true</code> if <var>item</var> matches, otherwise <code>false</code>.
      */
     boolean match(T item);
 
     /**
      * Describes this matcher.
      */
     void describeTo(Description description);
-
 }
diff --git a/src/library/org/hamcrest/beans/HasProperty.java b/src/library/org/hamcrest/beans/HasProperty.java
@@ -1,6 +1,6 @@
 /*  Copyright (c) 2000-2006 hamcrest.org
  */
-package org.hamcrest.object;
+package org.hamcrest.beans;
 
 import org.hamcrest.Description;
 import org.hamcrest.Matcher;
@@ -26,7 +26,7 @@ public HasProperty(String propertyName) {
         this.propertyName = propertyName;
     }
 
-    public boolean match(Object obj) {
+    public boolean match(T obj) {
         try {
             return PropertyUtil.getPropertyDescriptor(propertyName, obj) != null;
         } catch (IntrospectionException e) {
diff --git a/src/library/org/hamcrest/beans/HasPropertyWithValue.java b/src/library/org/hamcrest/beans/HasPropertyWithValue.java
@@ -1,6 +1,6 @@
 /*  Copyright (c) 2000-2006 hamcrest.org
  */
-package org.hamcrest.object;
+package org.hamcrest.beans;
 
 import org.hamcrest.Description;
 import org.hamcrest.Matcher;
@@ -78,7 +78,7 @@ public HasPropertyWithValue(String propertyName, Matcher value) {
     }
 
     @SuppressWarnings({"unchecked"})
-    public boolean match(Object argument) {
+    public boolean match(T argument) {
         try {
             Method readMethod = getReadMethod(argument);
             return readMethod != null
@@ -111,5 +111,4 @@ public void describeTo(Description description) {
     public static <T> Matcher<T> hasProperty(String propertyName, Matcher value) {
         return new HasPropertyWithValue<T>(propertyName, value);
     }
-
 }
diff --git a/src/library/org/hamcrest/beans/PropertyUtil.java b/src/library/org/hamcrest/beans/PropertyUtil.java
@@ -1,6 +1,6 @@
 /*  Copyright (c) 2000-2006 hamcrest.org
  */
-package org.hamcrest.object;
+package org.hamcrest.beans;
 
 import java.beans.BeanInfo;
 import java.beans.IntrospectionException;
diff --git a/src/library/org/hamcrest/core/IsCompatibleType.java b/src/library/org/hamcrest/core/IsCompatibleType.java
diff --git a/src/library/org/hamcrest/core/IsNull.java b/src/library/org/hamcrest/core/IsNull.java
@@ -11,7 +11,7 @@
  * Is the value null?
  */
 public class IsNull<T> implements Matcher<T> {
-    public boolean match(Object o) {
+    public boolean match(T o) {
         return o == null;
     }
 
@@ -26,7 +26,7 @@ public static <T> Matcher<T> isNull() {
 
     @Factory
     public static <T> Matcher<T> isNotNull() {
-        return not((Matcher<T>)isNull());
+        return not(IsNull.<T>isNull());
     }
 }
 
diff --git a/src/library/org/hamcrest/core/Or.java b/src/library/org/hamcrest/core/Or.java
@@ -47,5 +47,4 @@ public void describeTo(Description description) {
     public static <T> Matcher<T> or(Matcher<T>... matchers) {
         return new Or<T>(matchers);
     }
-
 }
diff --git a/src/library/org/hamcrest/internal/ArrayIterator.java b/src/library/org/hamcrest/internal/ArrayIterator.java
@@ -0,0 +1,28 @@
+package org.hamcrest.internal;
+
+import java.lang.reflect.Array;
+import java.util.Iterator;
+
+public class ArrayIterator implements Iterator<Object> {
+	private final Object array;
+	private int currentIndex = 0;
+	
+	public ArrayIterator(Object array) {
+		if (!array.getClass().isArray()) {
+			throw new IllegalArgumentException("not an array");
+		}
+		this.array = array;
+	}
+	
+	public boolean hasNext() {
+		return currentIndex < Array.getLength(array);
+	}
+
+	public Object next() {
+		return Array.get(array, currentIndex++);
+	}
+	
+	public void remove() {
+		throw new UnsupportedOperationException("cannot remove items from an array");
+	}
+}
diff --git a/src/library/org/hamcrest/internal/StringDescription.java b/src/library/org/hamcrest/internal/StringDescription.java
@@ -1,8 +1,9 @@
 package org.hamcrest.internal;
 
-import org.hamcrest.Description;
+import java.util.Arrays;
+import java.util.Iterator;
 
-import java.lang.reflect.Array;
+import org.hamcrest.Description;
 
 public class StringDescription implements Description {
 
@@ -37,21 +38,36 @@ public Description appendValue(Object value) {
         } else if (value instanceof Float) {
             buffer.append('<').append(value).append("F>");
         } else if (value.getClass().isArray()) {
-            buffer.append('[');
-            for (int i = 0; i < Array.getLength(value); i++) {
-                if (i > 0) {
-                    buffer.append(", ");
-                }
-                appendValue(Array.get(value, i));
-            }
-            buffer.append(']');
+        	appendValueList("[",", ","]", new ArrayIterator(value));
         } else {
             buffer.append('<').append(value).append('>');
         }
         return this;
     }
+    
+    public <T> Description appendValueList(String start, String separator, String end, T... values) {
+        return appendValueList(start, separator, end, Arrays.asList(values));
+	}
+    
+	public <T> Description appendValueList(String start, String separator, String end, Iterable<T> values) {
+		return appendValueList(start, separator, end, values.iterator());
+	}
+	
+	private <T> Description appendValueList(String start, String separator, String end, Iterator<T> values) {
+		boolean separate = false;
+		
+        buffer.append(start);
+        while (values.hasNext()) {
+        	if (separate) buffer.append(separator);
+        	appendValue(values.next());
+        	separate = true;
+        }
+        buffer.append(end);
+        
+        return this;
+	}
 
-    private void toJavaSyntax(StringBuffer buffer, String unformatted) {
+	private void toJavaSyntax(StringBuffer buffer, String unformatted) {
         buffer.append('"');
         for (int i = 0; i < unformatted.length(); i++) {
             toJavaSyntax(buffer, unformatted.charAt(i));
diff --git a/src/library/org/hamcrest/number/IsComparableTo.java b/src/library/org/hamcrest/number/IsComparableTo.java
@@ -11,16 +11,15 @@
 /**
  * Is the value less than or greater than another {@link java.lang.Comparable} value?
  */
-public class IsComparableTo<T extends Comparable> implements Matcher<T> {
-
+public class IsComparableTo<T extends Comparable<T>> implements Matcher<T> {
     public static enum Operator {
         LESS_THAN,
         GREATER_THAN
     }
-
+    
     private final Comparable<T> compareTo;
     private final Operator operator;
-
+    
     public IsComparableTo(Comparable<T> compareTo, Operator operator) {
         this.compareTo = compareTo;
         this.operator = operator;
@@ -38,27 +37,27 @@ public void describeTo(Description description) {
     }
 
     @Factory
-    public static <T extends Comparable> Matcher<Comparable<T>> greaterThan(Comparable<T> value) {
+    public static <T extends Comparable<T>> Matcher<T> greaterThan(T value) {
         return comparableTo(value, Operator.GREATER_THAN);
     }
 
     @Factory
-    public static <T extends Comparable> Matcher<Comparable<T>> greaterThanOrEqualTo(Comparable<T> value) {
+    public static <T extends Comparable<T>> Matcher<T> greaterThanOrEqualTo(T value) {
         return or(greaterThan(value), eq(value));
     }
-
+    
     @Factory
-    public static <T extends Comparable> Matcher<Comparable<T>> lessThan(Comparable<T> value) {
+    public static <T extends Comparable<T>> Matcher<T> lessThan(T value) {
         return comparableTo(value, Operator.LESS_THAN);
     }
 
     @Factory
-    public static <T extends Comparable> Matcher<Comparable<T>> lessThanOrEqualTo(Comparable<T> value) {
+    public static <T extends Comparable<T>> Matcher<T> lessThanOrEqualTo(T value) {
         return or(lessThan(value), eq(value));
     }
-
-    private static <T extends Comparable> Matcher<Comparable<T>> comparableTo(Comparable<T> value, Operator operator) {
-        return new IsComparableTo(value, operator);
+    
+    private static <T extends Comparable<T>> Matcher<T> comparableTo(T value, Operator operator) {
+        return new IsComparableTo<T>(value, operator);
     }
 
 }
diff --git a/src/library/org/hamcrest/object/IsCompatibleType.java b/src/library/org/hamcrest/object/IsCompatibleType.java
@@ -0,0 +1,26 @@
+package org.hamcrest.object;
+
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
+import org.hamcrest.Factory;
+
+public class IsCompatibleType<T> implements Matcher<Class<?>> {
+    private final Class<T> type;
+    
+    public IsCompatibleType(Class<T> type) {
+        this.type = type;
+    }
+    
+    public boolean match(Class<?> cls) {
+        return type.isAssignableFrom(cls);
+    }
+    
+    public void describeTo(Description description) {
+        description.appendText("type < ").appendText(type.getName());
+    }
+    
+    @Factory
+    public static <T> Matcher<Class<?>> compatibleType(Class<T> baseType) {
+        return new IsCompatibleType<T>(baseType);
+    }
+}
diff --git a/src/unit-test/org/hamcrest/beans/HasPropertyTest.java b/src/unit-test/org/hamcrest/beans/HasPropertyTest.java
@@ -1,11 +1,13 @@
 /*  Copyright (c) 2000-2006 hamcrest.org
  */
-package org.hamcrest.object;
+package org.hamcrest.beans;
 
 import org.hamcrest.AbstractMatcherTest;
+import org.hamcrest.beans.HasPropertyWithValueTest.BeanWithoutInfo;
+
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.beans.HasProperty.hasProperty;
 import static org.hamcrest.core.IsNot.not;
-import static org.hamcrest.object.HasProperty.hasProperty;
 
 /**
  * @author Iain McGinniss
diff --git a/src/unit-test/org/hamcrest/beans/HasPropertyWithValueTest.java b/src/unit-test/org/hamcrest/beans/HasPropertyWithValueTest.java
@@ -1,23 +1,22 @@
 /*  Copyright (c) 2000-2006 hamcrest.org
  */
-package org.hamcrest.object;
+package org.hamcrest.beans;
 
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.beans.HasPropertyWithValue.hasProperty;
 import static org.hamcrest.core.IsAnything.anything;
 import static org.hamcrest.core.IsEqual.eq;
 import static org.hamcrest.core.IsNot.not;
-import static org.hamcrest.MatcherAssert.assertThat;
-import static org.hamcrest.object.HasPropertyWithValue.hasProperty;
-import org.hamcrest.AbstractMatcherTest;
-import org.hamcrest.Description;
-import org.hamcrest.Matcher;
-import org.hamcrest.core.IsAnything;
-import org.hamcrest.core.IsEqual;
-import org.hamcrest.internal.StringDescription;
 
 import java.beans.IntrospectionException;
 import java.beans.PropertyDescriptor;
 import java.beans.SimpleBeanInfo;
 
+import org.hamcrest.AbstractMatcherTest;
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
+import org.hamcrest.internal.StringDescription;
+
 /**
  * @author Iain McGinniss
  * @author Nat Pryce
diff --git a/src/unit-test/org/hamcrest/object/IsCompatibleTypeTest.java b/src/unit-test/org/hamcrest/object/IsCompatibleTypeTest.java
diff --git a/src/unit-test/org/hamcrest/text/IsEqualIgnoringWhiteSpaceTest.java b/src/unit-test/org/hamcrest/text/IsEqualIgnoringWhiteSpaceTest.java

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`/* Copyright (c) 2000-2006 hamcrest.org`
`2`	`2`	`*/`
`3`		`-package org.hamcrest.object;`
	`3`	`+package org.hamcrest.beans;`
`4`	`4`
`5`	`5`	`import org.hamcrest.Description;`
`6`	`6`	`import org.hamcrest.Matcher;`
`@@ -78,7 +78,7 @@ public HasPropertyWithValue(String propertyName, Matcher value) {`
`78`	`78`	`}`
`79`	`79`
`80`	`80`	`@SuppressWarnings({"unchecked"})`
`81`		`- public boolean match(Object argument) {`
	`81`	`+ public boolean match(T argument) {`
`82`	`82`	`try {`
`83`	`83`	`Method readMethod = getReadMethod(argument);`
`84`	`84`	`return readMethod != null`
`@@ -111,5 +111,4 @@ public void describeTo(Description description) {`
`111`	`111`	`public static <T> Matcher<T> hasProperty(String propertyName, Matcher value) {`
`112`	`112`	`return new HasPropertyWithValue<T>(propertyName, value);`
`113`	`113`	`}`
`114`		`-`
`115`	`114`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`* Is the value null?`
`12`	`12`	`*/`
`13`	`13`	`public class IsNull<T> implements Matcher<T> {`
`14`		`- public boolean match(Object o) {`
	`14`	`+ public boolean match(T o) {`
`15`	`15`	`return o == null;`
`16`	`16`	`}`
`17`	`17`
`@@ -26,7 +26,7 @@ public static <T> Matcher<T> isNull() {`
`26`	`26`
`27`	`27`	`@Factory`
`28`	`28`	`public static <T> Matcher<T> isNotNull() {`
`29`		`- return not((Matcher<T>)isNull());`
	`29`	`+ return not(IsNull.<T>isNull());`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -47,5 +47,4 @@ public void describeTo(Description description) {`
`47`	`47`	`public static <T> Matcher<T> or(Matcher<T>... matchers) {`
`48`	`48`	`return new Or<T>(matchers);`
`49`	`49`	`}`
`50`		`-`
`51`	`50`	`}`