org.scalatest.verb

ShouldVerb

trait ShouldVerb extends AnyRef

Provides an implicit conversion that adds should methods to String to support the syntax of FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec.

For example, this trait enables syntax such as the following test registration in FlatSpec and FixtureFlatSpec:

"A Stack (when empty)" should "be empty" in { ... }
                       

It also enables syntax such as the following shared test registration in FlatSpec and FixtureFlatSpec:

"A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
                          

In addition, it supports the registration of subject descriptions in WordSpec and FixtureWordSpec, such as:

"A Stack (when empty)" should { ...
                       

And finally, it also supportds the registration of subject descriptions with after words in WordSpec and FixtureWordSpec. For example:

   def provide = afterWord("provide")

"The ScalaTest Matchers DSL" should provide {

The reason this implicit conversion is provided in a separate trait, instead of being provided directly in FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec, is because an implicit conversion provided directly would conflict with the implicit conversion that provides should methods on String in the ShouldMatchers trait. By contrast, there is no conflict with the separate ShouldVerb trait approach, because:

  1. FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec mix in ShouldVerb directly, and
  2. ShouldMatchers extends ShouldVerb, overriding the convertToStringShouldWrapper implicit conversion function.

So whether or not a FlatSpec, WordSpec, FixtureFlatSpec, or FixtureWordSpec mixes in ShouldMatchers, there will only be one implicit conversion in scope that adds should methods to Strings.

Also, because the class of the result of the overriding convertToStringShouldWrapper implicit conversion method provided in ShouldMatchers extends this trait's StringShouldWrapperForVerb class, the four uses of should provided here are still available. These four should are in fact available to any class that mixes in ShouldMatchers, but each takes an implicit parameter that is provided only in FlatSpec and FixtureFlatSpec, or WordSpec and FixtureWordSpec.

known subclasses: ShouldMatchers, FixtureWordSpec, FixtureFlatSpec, WordSpec, FlatSpec

Inherits

  1. AnyRef
  2. Any

Type Members

  1. class StringShouldWrapperForVerb extends AnyRef

    This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec

Value Members

  1. def convertToStringShouldWrapper(o: String): StringShouldWrapperForVerb

    Implicitly converts an object of type String to a StringShouldWrapperForVerb, to enable should methods to be invokable on that object

    Implicitly converts an object of type String to a StringShouldWrapperForVerb, to enable should methods to be invokable on that object.

    attributes: implicit
  2. 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
  3. 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
  4. 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: AnyRef ⇐ Any