Box.Generator behaviour (box v0.15.1)

Behaviour for generating random values. Generators needs to implement this behaviour.

Summary

generator()

Module implementing the Galerie.Generator behaviour

generate(t)

generate(arg)

Generates a unique value using the provided generator. Option :schema is required to validate the presence of the value.

@type generate_option() ::
  {:max_tries, non_neg_integer()} | {:exists?, (any() -> boolean())}

@type generator() :: {module(), Keyword.t()}

Module implementing the Galerie.Generator behaviour

@callback generate(Keyword.t()) :: String.t()

@spec unique(generator(), [generate_option() | {atom(), any()}]) :: String.t()

Generates a unique value using the provided generator. Option :schema is required to validate the presence of the value.

iex> genereate(Alphanumerical, exists?: fn value -> Repo.exists?(where(Book, [book], book.code == ^value)) end)

The above example will validate that the generated value doesn't exist as a :reset_password_token in the User scheme