org.scalatest.matchers

BeMatcher

trait BeMatcher[-T] extends (T) ⇒ MatchResult

Trait extended by matcher objects, which may appear after the word be, that can match a value of the specified type. The value to match is passed to the BeMatcher's apply method. The result is a MatchResult. A BeMatcher is, therefore, a function from the specified type, T, to a MatchResult.

Although BeMatcher and Matcher represent very similar concepts, they have no inheritance relationship because Matcher is intended for use right after should or must whereas BeMatcher is intended for use right after be.

As an example, you could create BeMatcher[Int] called odd that would match any odd Int, and one called even that would match any even Int. Given this pair of BeMatchers, you could check whether an Int was odd or even with expressions like:

num should be (odd)
num should not be (even)

Here's is how you might define the odd and even BeMatchers:

trait CustomMatchers {

class OddMatcher extends BeMatcher[Int] { def apply(left: Int) = MatchResult( left % 2 == 1, left.toString + " was even", left.toString + " was odd" ) } val odd = new OddMatcher val even = not (odd) }

// Make them easy to import with: // import CustomMatchers._ object CustomMatchers extends CustomMatchers

These BeMatchers are defined inside a trait to make them easy to mix into any suite or spec that needs them. The CustomMatchers companion object exists to make it easy to bring the BeMatchers defined in this trait into scope via importing, instead of mixing in the trait. The ability to import them is useful, for example, when you want to use the matchers defined in a trait in the Scala interpreter console.

Here's an rather contrived example of how you might use odd and even:

class DoubleYourPleasureSuite extends FunSuite with MustMatchers with CustomMatchers {

def doubleYourPleasure(i: Int): Int = i * 2

test("The doubleYourPleasure method must return proper odd or even values")

val evenNum = 2 evenNum must be (even) doubleYourPleasure(evenNum) must be (even)

val oddNum = 3 oddNum must be (odd) doubleYourPleasure(oddNum) must be (odd) // This will fail } }

The last assertion in the above test will fail with this failure message:

6 was even

For more information on MatchResult and the meaning of its fields, please see the documentation for MatchResult. To understand why BeMatcher is contravariant in its type parameter, see the section entitled "Matcher's variance" in the documentation for Matcher.

Inherits

  1. Function1
  2. AnyRef
  3. Any

Value Members

  1. def andThen[A](g: (MatchResult) ⇒ A): (T) ⇒ A

  2. def apply(left: T): MatchResult

    Check to see if the specified object, left, matches, and report the result in the returned MatchResult

    Check to see if the specified object, left, matches, and report the result in the returned MatchResult. The parameter is named left, because it is usually the value to the left of a should or must invocation. For example, in:

    num should be (odd)
    

    The be (odd) expression results in a regular Matcher that holds a reference to odd, the BeMatcher passed to be. The should method invokes apply on this matcher, passing in num, which is therefore the "left" value. The matcher will pass num (the left value) to the BeMatcher's apply method.

    left

    the value against which to match

    returns

    the MatchResult that represents the result of the match

    attributes: abstract
  3. def compose[A](g: (A) ⇒ T): (A) ⇒ MatchResult

  4. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
  5. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
  6. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: Function1 ⇐ AnyRef ⇐ Any