StringVerbBehaveLikeInvocation.scala

/*
 * Copyright 2001-2013 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalatest.verbs

import org.scalactic._

/**
 * Class that provides a role-specific type for an implicit conversion used to support
 * the registration of subject descriptions in <code>FlatSpec</code> and <code>FreeSpec</code> styles.
 *
 * <p>
 * For example, this class enables syntax such as the following in <code>WordSpec</code>
 * and <code>fixture.WordSpec</code>:
 * </p>
 *
 * <pre class="stHighlighted">
 * <span class="stQuotedString">"A Stack (when empty)"</span> should { ...
 *                        ^
 * </pre>
 *
 * This <code>should</code> method, which is provided in <code>ShouldVerb</code>, needs an implicit parameter
 * of type <code>StringVerbBlockRegistration</code>.
 *
 * @author Bill Venners
 */
abstract class StringVerbBehaveLikeInvocation {

  /**
   * Registers a subject description in <code>WordSpec</code> and <code>fixture.WordSpec</code>.
   *
   * <p>
   * For example, this class enables syntax such as the following in <code>WordSpec</code>
   * and <code>fixture.WordSpec</code>:
   * </p>
   *
   * <pre class="stHighlighted">
   * <span class="stQuotedString">"A Stack (when empty)"</span> should { ...
   *                        ^
   * </pre>
   *
   */
  def apply(subject: String, pos: source.Position): BehaveWord
}