org.scalatest.verb

trait MustVerb

[source: org/scalatest/verb/MustVerb.scala]

trait MustVerb
extends AnyRef
Provides an implicit conversion that adds must 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)" must "be empty" in { ... }
                        ^
 

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

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

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

 "A Stack (when empty)" must { ...
                        ^
 

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" must 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 must methods on String in the MustMatchers trait. By contrast, there is no conflict with the separate MustVerb trait approach, because:

  1. FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec mix in MustVerb directly, and
  2. MustMatchers extends MustVerb, overriding the convertToStringMustWrapper implicit conversion function.

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

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

Author
Bill Venners
Direct Known Subclasses:
FlatSpec, WordSpec, FixtureFlatSpec, FixtureWordSpec, MustMatchers

Method Summary
implicit def convertToStringMustWrapper (o : java.lang.String) : StringMustWrapperForVerb
Implicitly converts an object of type String to a StringMustWrapper, to enable must methods to be invokable on that object.
Methods inherited from AnyRef
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized
Methods inherited from Any
==, !=, isInstanceOf, asInstanceOf
Class Summary
class StringMustWrapperForVerb (left : java.lang.String) extends AnyRef
This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec.
Method Details
implicit def convertToStringMustWrapper(o : java.lang.String) : StringMustWrapperForVerb
Implicitly converts an object of type String to a StringMustWrapper, to enable must methods to be invokable on that object.


Copyright (C) 2001-2009 Artima, Inc. All rights reserved.