Machete v0.2.3

View Source Machete.NaiveDateTimeMatcher (Machete v0.2.3)

Defines a matcher that matches NaiveDateTime values

Link to this section Summary

Types

opts()

Describes the arguments that can be passed to this matcher

t()

Describes an instance of this matcher

Functions

naive_datetime(opts \\ [])

Matches against NaiveDateTime values

Link to this section Types

Link to this type

opts()

View Source 
@type opts() :: [
  precision: 0..6,
  exactly: NaiveDateTime.t(),
  roughly: NaiveDateTime.t() | :now,
  before: NaiveDateTime.t() | :now,
  after: NaiveDateTime.t() | :now
]

Describes the arguments that can be passed to this matcher

Link to this opaque

t()

View Source (opaque) 
@opaque t()

Describes an instance of this matcher

Link to this section Functions

Link to this function

naive_datetime(opts \\ [])

View Source 
@spec naive_datetime(opts()) :: t()

Matches against NaiveDateTime values

Takes the following arguments:

  • precision: Requires the matched NaiveDateTime to have the specified microsecond precision
  • exactly: Requires the matched NaiveDateTime to be exactly equal to the specified NaiveDateTime
  • roughly: Requires the matched NaiveDateTime to be within +/- 10 seconds of the specified NaiveDateTime. The atom :now can be used to use the current time as the specified NaiveDateTime
  • before: Requires the matched NaiveDateTime to be before or equal to the specified NaiveDateTime. The atom :now can be used to use the current time as the specified NaiveDateTime
  • after: Requires the matched NaiveDateTime to be after or equal to the specified NaiveDateTime. The atom :now can be used to use the current time as the specified NaiveDateTime

Examples:

iex> assert NaiveDateTime.utc_now() ~> naive_datetime()
true

iex> assert NaiveDateTime.utc_now() ~> naive_datetime(precision: 6)
true

iex> assert ~N[2020-01-01 00:00:00.000000] ~> naive_datetime(exactly: ~N[2020-01-01 00:00:00.000000])
true

iex> assert NaiveDateTime.utc_now() ~> naive_datetime(roughly: :now)
true

iex> assert ~N[2020-01-01 00:00:00.000000] ~> naive_datetime(roughly: ~N[2020-01-01 00:00:05.000000])
true

iex> assert ~N[2020-01-01 00:00:00.000000] ~> naive_datetime(before: :now)
true

iex> assert ~N[2020-01-01 00:00:00.000000] ~> naive_datetime(before: ~N[3000-01-01 00:00:00.000000])
true

iex> assert ~N[3000-01-01 00:00:00.000000] ~> naive_datetime(after: :now)
true

iex> assert ~N[3000-01-01 00:00:00.000000] ~> naive_datetime(after: ~N[2020-01-01 00:00:00.000000])
true