org.scalatest.verb

trait ShouldVerb

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

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.

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

Method Summary
implicit def convertToStringShouldWrapper (o : java.lang.String) : StringShouldWrapperForVerb
Implicitly converts an object of type String to a StringShouldWrapperForVerb, to enable should 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 StringShouldWrapperForVerb (left : java.lang.String) extends AnyRef
This class supports the syntax of FlatSpec, WordSpec, FixtureFlatSpec, and FixtureWordSpec.
Method Details
implicit def convertToStringShouldWrapper(o : java.lang.String) : StringShouldWrapperForVerb
Implicitly converts an object of type String to a StringShouldWrapperForVerb, to enable should methods to be invokable on that object.


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