org.specs.specification.SpecificationSystems.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of specs_2.8.0.Beta1-RC8
specs is a Behaviour-Driven-Design framework
The newest version!
/**
 * Copyright (c) 2007-2009 Eric Torreborre 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software. Neither the name of specs nor the names of its contributors may be used to endorse or promote
 * products derived from this software without specific prior written permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
 * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
package org.specs.specification

/**
 * This trait abstracts the building and storing of the systems of a Specification.
 */
trait SpecificationSystems { this: BaseSpecification =>
  /** list of systems under test */
  private[specs] var systemsList : List[Sus] = Nil
  /** @return the list of systems under test */
  def systems = systemsList

  /**
   * implicit definition allowing to declare a new system under test described by a string desc

   * Usage: "my system under test" should {}

   * Alternatively, it could be created with:
   * specify("my system under test").should {}
   */
  implicit def specifySus(desc: String): SpecifiedSus = {
    new SpecifiedSus(addSus(new Sus(desc, this)))
  }
  def specify(desc: String): Sus = specifySus(desc).sus
  /** 
   * this class is used instead of using the Sus directly in order to make sure that only "should" and "can" are added
   * to Strings
   */
  class SpecifiedSus(val sus: Sus) {
    def should(a: =>Examples) = sus.should(a)
    def should(a: PrefixedExamples) = sus.should(a)
    def should(a: =>Unit) = sus.should(a)
    def can(a: =>Examples) = sus.can(a)
    def can(a: PrefixedExamples) = sus.can(a)
    def can(a: =>Unit) = sus.can(a)
  }
  /**
   * specifies an anonymous Sus included in this specification
   */
  def specify: Sus = {
    addSus(new Sus(this))
  }
  /** 
   * add a new Sus to this specification
   */
  private[specs] def addSus(sus: Sus): Sus = {
    addChild(sus)
    systemsList = systemsList ::: List(sus)
    sus
  }
  /**
   * add a textual complement to the sus verb.
   * For example, it is possible to declare:
   * "the system" should provide {...}
   * if the following function is declared:
   * def provide = addToSusVerb("provide")
   */
  def addToSusVerb(complement: String) = new PrefixedExamples(complement)
}
/**
 * This class represents a list of examples which a prefixed by a common word, like "provide".
 * 
 * When passed to the "should" or "can" method of a sus, the prefix is added to the sus verb
 * to form the expected full verb like "should provide"
 */
private [specification] case class PrefixedExamples(prefix: String, example: Option[() => Examples] = None) {
  def apply(e: =>Examples) = PrefixedExamples(prefix, Some(() => e))
  def prepend(verb: String) = verb + " " + prefix 
}