org.specs2.matcher.ExpectationsDescription.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of specs2-matcher_3 Show documentation
specs2-matcher
The newest version!
package org.specs2
package matcher

import text.Sentences.*
import execute.{ResultExecution, AsResult, Result}
import scala.util.NotGiven
import scala.annotation.*

trait ExpectationsDescription extends ExpectationsCreation:

  extension [T: AsResult](description: String)(using not: NotGiven[NoExpectationsDescription])
    def ==>(result: =>T): Result = <==>(result)
    def <==>(result: =>T): Result = checkResultFailure {
      val r = ResultExecution.execute(AsResult(result))
      r match
        case i if i.isError || i.isFailure =>
          i.updateMessage(m => negateSentence(description) + " because " + m)
        case other =>
          other.updateMessage(m => description + " <=> " + m)
    }

  /** describe a value with the aka method */
  extension [T](value: =>T)(using not: NotGiven[NoValueDescription])
    /** @return
      *   an expectable with its toString method as an alias description this is useful to preserve the original value
      *   when the matcher using it is adapting the value
      */
    infix def aka: Expectable[T] = aka(value.toString)

    /** @return an expectable with an alias description */
    infix def aka(alias: =>String): Expectable[T] = createExpectable(value, alias)

    /** @return an expectable with an alias description, after the value string */
    infix def post(alias: =>String): Expectable[T] = as((_: String) + " " + alias)

    /** @return an expectable with an alias description, after the value string */
    infix def as(alias: String => String): Expectable[T] = createExpectable(value, alias)

    /** @return an expectable with a function to show the element T */
    @targetName("showAsFunction")
    infix def showAs(show: T => String): Expectable[T] =
      lazy val v = value
      createExpectableWithShowAs(v, show(v))

  /** describe a value with the aka method */
  extension [T](value: =>T)(using not: NotGiven[NoValueDescription], show: T => String)
    /** @return an expectable with a function to show the element T */
    infix def showAs: Expectable[T] =
      lazy val v = value
      Expectable(actual = () => v, checker = Checker.pass, showValue = Some(_ => show(v)))

object ExpectationsDescription extends ExpectationsDescription

trait NoExpectationsDescription:
  given NoExpectationsDescription = ???

trait NoValueDescription:
  given NoValueDescription = ???