Added string regex matcher

sf105 · sf105 · commit 5e51a70c5928 · 2016-04-07T12:03:22.000+02:00
diff --git a/hamcrest-core/src/main/java/org/hamcrest/core/StringRegularExpression.java b/hamcrest-core/src/main/java/org/hamcrest/core/StringRegularExpression.java
@@ -0,0 +1,68 @@
+/**
+ *
+ */
+package org.hamcrest.core;
+
+import java.util.regex.Pattern;
+
+import org.hamcrest.Description;
+import org.hamcrest.Matcher;
+import org.hamcrest.TypeSafeDiagnosingMatcher;
+
+/**
+ * @author borettim
+ * @author sf105
+ *
+ */
+public class StringRegularExpression extends TypeSafeDiagnosingMatcher<String> {
+
+  protected StringRegularExpression(Pattern pattern) {
+    this.pattern = pattern;
+  }
+
+  private Pattern pattern;
+
+  @Override
+  public void describeTo(Description description) {
+    description.appendText("a string matching the pattern ").appendValue(pattern);
+  }
+
+  @Override
+  protected boolean matchesSafely(String actual, Description mismatchDescription) {
+    if (!pattern.matcher(actual).matches()) {
+      mismatchDescription.appendText("the string was ").appendValue(actual);
+      return false;
+    }
+    return true;
+  }
+
+  /**
+   * Validate a string with a {@link java.util.regex.Pattern}.
+   *
+   * <pre>
+   * assertThat(&quot;abc&quot;, matchesRegex(Pattern.compile(&quot;&circ;[a-z]$&quot;));
+   * </pre>
+   *
+   * @param pattern
+   *            the pattern to be used.
+   * @return The matcher.
+   */
+  public static Matcher<String> matchesRegex(Pattern pattern) {
+    return new StringRegularExpression(pattern);
+  }
+
+  /**
+   * Validate a string with a regex.
+   *
+   * <pre>
+   * assertThat(&quot;abc&quot;, matchesRegex(&quot;&circ;[a-z]+$&quot;));
+   * </pre>
+   *
+   * @param regex
+   *            The regex to be used for the validation.
+   * @return The matcher.
+   */
+  public static Matcher<String> matchesRegex(String regex) {
+    return matchesRegex(Pattern.compile(regex));
+  }
+}
diff --git a/hamcrest-core/src/test/java/org/hamcrest/core/StringRegularExpressionTest.java b/hamcrest-core/src/test/java/org/hamcrest/core/StringRegularExpressionTest.java
@@ -0,0 +1,25 @@
+package org.hamcrest.core;
+
+import org.hamcrest.AbstractMatcherTest;
+import org.hamcrest.Matcher;
+
+import static org.hamcrest.core.StringRegularExpression.matchesRegex;
+
+/**
+ * @author Steve Freeman 2016 http://www.hamcrest.com
+ */
+public class StringRegularExpressionTest extends AbstractMatcherTest {
+  public final Matcher<String> matcher = matchesRegex("^[0-9]+$");
+
+  @Override
+  protected Matcher<?> createMatcher() { return matcher; }
+
+
+  public void testMatchingRegex() {
+    assertMatches(matcher, "12");
+    assertDoesNotMatch(matcher, "abc");
+
+    assertDescription("a string matching the pattern <^[0-9]+$>", matcher);
+    assertMismatchDescription("the string was \"bcd\"", matcher, "bcd");
+  }
+}
diff --git a/hamcrest-library/src/main/java/org/hamcrest/Matchers.java b/hamcrest-library/src/main/java/org/hamcrest/Matchers.java
@@ -1,6 +1,9 @@
 package org.hamcrest;
 
 import org.hamcrest.collection.ArrayMatching;
+import org.hamcrest.core.StringRegularExpression;
+
+import java.util.regex.Pattern;
 
 @SuppressWarnings("unused")
 public class Matchers {
@@ -536,6 +539,36 @@ public static org.hamcrest.Matcher<java.lang.String> endsWithIgnoringCase(java.l
     return org.hamcrest.core.StringEndsWith.endsWithIgnoringCase(suffix);
   }
 
+  /**
+   * Validate a string with a {@link java.util.regex.Pattern}.
+   *
+   * <pre>
+   * assertThat(&quot;abc&quot;, matchesRegex(Pattern.compile(&quot;&circ;[a-z]$&quot;));
+   * </pre>
+   *
+   * @param pattern
+   *            the pattern to be used.
+   * @return The matcher.
+   */
+  public static Matcher<String> matchesRegex(Pattern pattern) {
+    return StringRegularExpression.matchesRegex(pattern);
+  }
+
+  /**
+   * Validate a string with a regex.
+   *
+   * <pre>
+   * assertThat(&quot;abc&quot;, matchesRegex(&quot;&circ;[a-z]+$&quot;));
+   * </pre>
+   *
+   * @param regex
+   *            The regex to be used for the validation.
+   * @return The matcher.
+   */
+  public static Matcher<String> matchesRegex(String regex) {
+    return StringRegularExpression.matchesRegex(Pattern.compile(regex));
+  }
+
   /**
    * Creates a matcher that matches arrays whose elements are satisfied by the specified matchers.  Matches
    * positively only if the number of matchers specified is equal to the length of the examined array and
