Trait

org.scalatest.words

WillVerb

Related Doc: package words

Permalink

trait WillVerb extends AnyRef

Provides an implicit conversion that adds will methods to String to support the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.

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

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

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

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

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

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

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

def provide = afterWord("provide")

"The ScalaTest Matchers DSL" will provide {
                             ^

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

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

Also, because the class of the result of the overriding convertToStringWillWrapper implicit conversion method provided in Matchers extends this trait's StringWillWrapperForVerb class, the four uses of will provided here are still available. These four will are in fact available to any class that mixes in Matchers, but each takes an implicit parameter that is provided only in FlatSpec and fixture.FlatSpec, or WordSpec and fixture.WordSpec.

Source
WillVerb.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. WillVerb
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. trait StringWillWrapperForVerb extends AnyRef

    Permalink

    This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.

    This class supports the syntax of FlatSpec, WordSpec, fixture.FlatSpec, and fixture.WordSpec.

    This class is used in conjunction with an implicit conversion to enable will methods to be invoked on Strings.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. implicit def convertToStringWillWrapper(o: String): StringWillWrapperForVerb

    Permalink

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

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

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  16. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  17. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  18. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped