p

org.specs2

control

package control

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. control
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Action[A] = Eff[ActionStack, A]
  2. case class ActionException (warnings: List[String], message: Option[String], throwable: Option[Throwable]) extends Exception with Product with Serializable

    This exception class is used when an Action is transformed to a Task to avoid losing information

  3. type ActionStack = EffectsCons[control.eff.ErrorEffect.ErrorOrOk, control.eff.all.|:[Console, control.eff.all.|:[Warnings, control.eff.all.|:[control.eff.all.Eval, NoEffect]]]]

    Action type, using a logger as a reader and no writer

  4. trait Debug extends ImplicitParameters

    This trait provides simple a way to print out any object to the console:

    This trait provides simple a way to print out any object to the console:

    "this string".pp must_== "this string"

    will print 'this string' and pass it to the rest of the expectation

  5. trait Exceptions extends AnyRef

    This trait provides methods to catch exceptions and transform them into values which can be passed to further computations.

    This trait provides methods to catch exceptions and transform them into values which can be passed to further computations.

    It uses the facilities found in the scala.util.control.Exception object while providing a more concise api on some use cases.

    See also

    org.specs2.control.ExceptionsSpec for examples

  6. trait ExecutionOrigin extends Stacktraces

    This trait is used primarily to change the junit behavior depending on the execution environment

  7. trait Functions extends AnyRef

    This trait provides utility methods for functions

  8. trait HasStackTrace extends AnyRef

    This trait describes something which has a stackTrace with:

    This trait describes something which has a stackTrace with:

    • a list of stacktrace element

    This is used to provide a common interface to execute.Failure and execute.Error

  9. trait ImplicitParameters extends AnyRef

    This trait is used to abuse method overloading and allow some of the methods in specs2 DSL to be applicable to various parameters.

    This trait is used to abuse method overloading and allow some of the methods in specs2 DSL to be applicable to various parameters.

    For example in a mutable specification, the >> method is overloaded for lots of different arguments:

    • result
    • function of the Environment
    • function of the Command line
    • ...
  10. case class IncludeExcludeStackTraceFilter (include: Seq[String], exclude: Seq[String]) extends StackTraceFilter with Product with Serializable

    Implementation of the StackTraceFilter trait with a list of include/exclude patterns

  11. trait LanguageFeatures extends AnyRef

    implicits and postfix ops are automatically mixed in specs2 specifications for convenience.

    implicits and postfix ops are automatically mixed in specs2 specifications for convenience. If you *really* don't want that you can override this behaviour by using the NoLanguageFeatures trait

  12. class LazyParameter [+T] extends AnyRef

    class holding a value to be evaluated lazily

  13. trait LazyParameters extends AnyRef

    This trait can be used to allow some function to be called with varargs, with values being evaluated lazily:

    This trait can be used to allow some function to be called with varargs, with values being evaluated lazily:

    def method[T](values: LazyParameter[T]*) = {
      values.toStream // use the toStream method to consume the values lazily
    }
    // usage
    method(exp1, exp2, exp3)

    Note that the values are really evaluated once, unlike a by-name parameter.

  14. case class LazyValue [T](t: () ⇒ T) extends Product with Serializable

    This class simply encapsulates a lazy value which will be only evaluated once

    This class simply encapsulates a lazy value which will be only evaluated once

    See also

    org.specs2.specification.process.RandomSequentialExecution for an example of use

  15. type Logger = (String) ⇒ Unit

    Actions logging

  16. case class NamedThreadFactory (namePrefix: String, group: ThreadGroup = Thread.currentThread.getThreadGroup, priority: Int = Thread.currentThread.getPriority) extends ThreadFactory with Product with Serializable

    This factory creates named threads which can be prefixed by "specs2" to track the threads used by specs2 for the specification execution

    This factory creates named threads which can be prefixed by "specs2" to track the threads used by specs2 for the specification execution

    Contributed by @jedws

  17. trait NoDebug extends Debug

    Use this trait to disable the pp method on objects

  18. trait NoLanguageFeatures extends LanguageFeatures
  19. trait NoNumberOfTimes extends NumberOfTimes
  20. trait NumberOfTimes extends AnyRef

    Syntactic sugar to execute an action a given number of times

  21. trait Properties extends AnyRef
  22. case class Property [T](value: () ⇒ Option[T], evaluated: Boolean = false, evaluatedValue: Option[T] = None) extends Product with Serializable

    This class represents values which are evaluated lazily and which may even be missing.

    This class represents values which are evaluated lazily and which may even be missing.

    It has Option-like function and can be also converted to an Either object

  23. trait SomeTimeout extends AnyRef
  24. trait StackTraceFilter extends AnyRef

    This trait filters an Exception stacktrace

  25. trait Stacktraces extends AnyRef

    Utility methods to determine the origin of the execution of the current code

  26. trait Throwablex extends AnyRef

    This trait adds some utility methods to Throwable objects.

  27. case class Times (n: Int) extends Product with Serializable
  28. case class TraceLocation (path: String, fileName: String, className: String, methodName: String, lineNumber: Int) extends Product with Serializable
  29. case class UserException (message: String, throwable: Throwable) extends Exception with Product with Serializable

    This exception class is used to notify the user of instantiation errors

  30. implicit class actionOps [T] extends AnyRef
  31. implicit class actionToTask [T] extends AnyRef

    An Action[T] can be converted to a Task[T]

  32. implicit class ioActionToOption [T] extends AnyRef

    execute an action with no logging and return an option

  33. implicit class taskToAction [T] extends AnyRef

    A Task[T] (the result of running a Process[Task, T] for example) can be converted to an Action[T]

Value Members

  1. implicit def ConsoleMember: Aux[Console, ActionStack, control.eff.all.|:[control.eff.ErrorEffect.ErrorOrOk, control.eff.all.|:[Warnings, control.eff.all.|:[control.eff.all.Eval, NoEffect]]]]
  2. implicit def ErrorMember: Aux[control.eff.ErrorEffect.ErrorOrOk, ActionStack, control.eff.all.|:[Console, control.eff.all.|:[Warnings, control.eff.all.|:[control.eff.all.Eval, NoEffect]]]]
  3. implicit def EvalMember: Aux[control.eff.all.Eval, ActionStack, control.eff.all.|:[control.eff.ErrorEffect.ErrorOrOk, control.eff.all.|:[Console, control.eff.all.|:[Warnings, NoEffect]]]]
  4. implicit def WarningsMember: Aux[Warnings, ActionStack, control.eff.all.|:[control.eff.ErrorEffect.ErrorOrOk, control.eff.all.|:[Console, control.eff.all.|:[control.eff.all.Eval, NoEffect]]]]
  5. implicit def actionAsResult[T](implicit arg0: AsResult[T]): AsResult[Action[T]]

    This implicit allows an Action[result] to be used inside an example.

    This implicit allows an Action[result] to be used inside an example.

    For example to read a database.

  6. def attemptExecuteAction[A](action: Eff[ActionStack, A], printer: (String) ⇒ Unit = s => ()): \/[Throwable, (\/[control.eff.ErrorEffect.Error, A], List[String])]
  7. lazy val consoleLogging: (String) ⇒ Unit
  8. def executeAction[A](action: Eff[ActionStack, A], printer: (String) ⇒ Unit = s => ()): (\/[control.eff.ErrorEffect.Error, A], List[String])
  9. implicit def ioResultAsResult[T](implicit arg0: AsResult[T]): AsResult[IO[T]]

    This implicit allows any IO[Result] to be used inside an example:

    This implicit allows any IO[Result] to be used inside an example:

    "this should work" in { IO(success) }

  10. lazy val noLogging: (String) ⇒ Unit
  11. def runAction[A](action: Eff[ActionStack, A], printer: (String) ⇒ Unit = s => ()): \/[control.eff.ErrorEffect.Error, A]
  12. def warnAndFail[R <: Effects, A](message: String, failureMessage: String)(implicit m1: <=[Warnings, R], m2: <=[control.eff.ErrorEffect.ErrorOrOk, R]): Eff[R, A]

    warn the user about something that is probably wrong on his side, this is not a specs2 bug, then fail to stop all further computations

  13. object Actions
  14. object Debug extends Debug
  15. object DefaultStackTraceFilter extends IncludeExcludeStackTraceFilter with ExecutionOrigin

    default filter for specs2 runs

  16. object Exceptions extends Exceptions
  17. object Executable

    Execute external commands

  18. object ExecutionOrigin extends ExecutionOrigin
  19. object Functions extends Functions
  20. object FutureInstances
  21. object ImplicitParameters extends ImplicitParameters
  22. object IncludeExcludeStackTraceFilter extends Serializable

    Factory object to build a stack trace filter from include/exclude expressions:

    Factory object to build a stack trace filter from include/exclude expressions:

    .*specs2 ==> include .*specs2 traces .*specs2/scala.* ==> include .*specs2 traces, exclude scala.* traces .*specs2,scala/scalaz,eclipse ==> include .*specs2,scala traces, exclude scalaz and eclipse traces

  23. object LazyParameters extends LazyParameters
  24. object NoStackTraceFilter extends StackTraceFilter

    This filter doesn't do anything

  25. object NumberOfTimes extends NumberOfTimes
  26. object Properties extends Properties
  27. object Property extends Serializable

    Companion object to create properties with possibly no initial value

  28. object SomeTimeout extends SomeTimeout
  29. object StackTraceFilter
  30. object Stacktraces extends Stacktraces
  31. object Throwables
  32. object Throwablex extends Throwablex
  33. object TraceLocation extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped