org.specs2.text

Type members

Classlikes

case class AddedLine(line: NumberedLine) extends LineComparison

return all the differences

return all the differences

final case class AnsiColor(color: String) extends AnyVal

This trait provides AnsiColors codes for the OutputReporter

This trait provides AnsiColors codes for the OutputReporter

See also:
Companion:
object
object AnsiColors extends AnsiColors
Companion:
class
trait Colors

This trait defines the colors which can be used to output text on the console

This trait defines the colors which can be used to output text on the console

The textColor ... statsColor define the AnsiColor to use The text ... stats methods taking a String as a parameter are inserting control characters to change the string color

trait ColorsMap

Definition of abbreviated color names

Definition of abbreviated color names

Companion:
object
object ColorsMap extends ColorsMap
Companion:
class
class ConsoleColors extends AnsiColors with Colors

This class defines the colors to use to print out text on the Console with defaults as AnsiColors for a dark background console

This class defines the colors to use to print out text on the Console with defaults as AnsiColors for a dark background console

This trait represents the difference between 2 "contents"

This trait represents the difference between 2 "contents"

case class DeletedLine(line: NumberedLine) extends LineComparison

This object help shortening strings between differences when the strings are too long

This object help shortening strings between differences when the strings are too long

Companion:
object
Companion:
class

A trait to filter results of a difference check

A trait to filter results of a difference check

This trait provides some syntactic sugar to create a DifferenceFilter to take only the first n differences:

This trait provides some syntactic sugar to create a DifferenceFilter to take only the first n differences:

10.differences == FirstNDifferencesFilter(10)

case class DifferencesClips(clipSize: Int) extends DifferenceFilter

return all only changes + some context

return all only changes + some context

case class DifferentLine(line1: NumberedLine, line2: NumberedLine) extends LineComparison
case class FirstDifferences(n: Int) extends SomeDifferences

return the first n differences

return the first n differences

trait FromString[T]

This typeclass is used to describe any instance which can be decoded from a String.

This typeclass is used to describe any instance which can be decoded from a String.

It can be used to pass string properties in SystemProperties and decode them in a specific way

Companion:
object
object FromString
Companion:
class
object Indent

various functions for working out indentation

various functions for working out indentation

class Interpolated(stringContent: String, texts: Seq[String])

This class extracts interpolated expressions from an interpolated string, given the string content and the text pieces in between the interpolated expressions

This class extracts interpolated expressions from an interpolated string, given the string content and the text pieces in between the interpolated expressions

This color scheme can be used with a white background

This color scheme can be used with a white background

sealed trait LineComparison

case classes for the representation of lines which are different: not found, missing, misplaced

case classes for the representation of lines which are different: not found, missing, misplaced

Companion:
object
Companion:
class
trait LinesContent[L1]

Any type T with a name and representable as a sequence of Strings

Any type T with a name and representable as a sequence of Strings

Companion:
object
Companion:
class
case class LinesContentDifference(lines1: Seq[String], lines2: Seq[String], all: Boolean, ordered: Boolean) extends ContentDifference

This class shows the differences between 2 sequences of lines.

This class shows the differences between 2 sequences of lines.

  • if all is false we expect possibly more lines in lines2
  • if ordered is false we expect the lines of lines1 to appear in any order in lines2
Companion:
object
case class ListLinesContent[A]() extends LinesContent[List[A]]
case class MappedColors(colors: Map[String, AnsiColor]) extends ConsoleColors

This class takes colors from a map, using default colors if some values are missing

This class takes colors from a map, using default colors if some values are missing

Companion:
object

Factory method to create MappedColors 'colors' attribute

Factory method to create MappedColors 'colors' attribute

Companion:
class

mix-in this trait to remove the implicit provided by the DifferenceFilters trait

mix-in this trait to remove the implicit provided by the DifferenceFilters trait

case class NumberedLine(lineNumber: Int, line: String)
Companion:
object
Companion:
class
abstract class RegexExtractor[P, T](var fullRegex: String, var groupRegex: String)

A Regular expression step which takes a text and extracts meaningful values according to a regular expression:

A Regular expression step which takes a text and extracts meaningful values according to a regular expression:

  • either a user-defined expression for the full text to extract: e.g. "Given the following number: (.*)"
  • or a default regex for groups capturing value delimited with ${}

It provides methods to extract either all the groups as a list, or a number of values as a tuple

Companion:
object
Companion:
class
trait Regexes

This trait provides utility functions for working with regexes

This trait provides utility functions for working with regexes

Companion:
object
object Regexes extends Regexes
Companion:
class
case class SameLine(line: NumberedLine) extends LineComparison
trait Sentences

This does some simple replacements in sentences to negate them.

This does some simple replacements in sentences to negate them.

For example: the cat must sleep => the cat must not sleep

Companion:
object
object Sentences extends Sentences
Companion:
class
case class SeqLinesContent[A]() extends LinesContent[Seq[A]]

Default implementation for reading lines out of a Seq

Default implementation for reading lines out of a Seq

case class Show1[T1](show1: T1 => String)
case class Show10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10](show1: T1 => String, show2: T2 => String, show3: T3 => String, show4: T4 => String, show5: T5 => String, show6: T6 => String, show7: T7 => String, show8: T8 => String, show9: T9 => String, show10: T10 => String)
case class Show2[T1, T2](show1: T1 => String, show2: T2 => String)
case class Show3[T1, T2, T3](show1: T1 => String, show2: T2 => String, show3: T3 => String)
case class Show4[T1, T2, T3, T4](show1: T1 => String, show2: T2 => String, show3: T3 => String, show4: T4 => String)
case class Show5[T1, T2, T3, T4, T5](show1: T1 => String, show2: T2 => String, show3: T3 => String, show4: T4 => String, show5: T5 => String)
case class Show6[T1, T2, T3, T4, T5, T6](show1: T1 => String, show2: T2 => String, show3: T3 => String, show4: T4 => String, show5: T5 => String, show6: T6 => String)
case class Show7[T1, T2, T3, T4, T5, T6, T7](show1: T1 => String, show2: T2 => String, show3: T3 => String, show4: T4 => String, show5: T5 => String, show6: T6 => String, show7: T7 => String)
case class Show8[T1, T2, T3, T4, T5, T6, T7, T8](show1: T1 => String, show2: T2 => String, show3: T3 => String, show4: T4 => String, show5: T5 => String, show6: T6 => String, show7: T7 => String, show8: T8 => String)
case class Show9[T1, T2, T3, T4, T5, T6, T7, T8, T9](show1: T1 => String, show2: T2 => String, show3: T3 => String, show4: T4 => String, show5: T5 => String, show6: T6 => String, show7: T7 => String, show8: T8 => String, show9: T9 => String)
object ShowText

return some of the differences, filtered with a function

return some of the differences, filtered with a function

The EditDistance trait provides methods to compute and display the shortest distance between 2 strings.

The EditDistance trait provides methods to compute and display the shortest distance between 2 strings.

Usage:

showDistance("kitten", "sitting") // returns ("(k)itt(e)n", "(s)itt(i)n(g)")

// with different separators
showDistance("kitten", "sitting", "[]") // returns ("[k]itt[e]n", "[s]itt[i]n[g]")
Companion:
object
case class TextTable(header: Seq[String], lines: Seq[Seq[String]], separator: String)

Textual representation of a table with a table and some lines.

Textual representation of a table with a table and some lines.

It is expected that the size of the header and all the lines are the same.

The main purpose of this class is to:

  • display equal-length cells on each column
  • allow line breaks in cells for each line
Companion:
object
object TextTable
Companion:
class