ever_faker

defmodule EverFaker.Team.En do
  import EverFaker, only: [sampler: 2]
  alias EverFaker.Address

  @moduledoc """
  Functions for generating team related data in English
  """

  @doc """
  Returns a string of the form [state] [creature]

  ## Examples

      iex> EverFaker.Team.En.name()
      "Hawaii cats"
      iex> EverFaker.Team.En.name()
      "Oklahoma banshees"
      iex> EverFaker.Team.En.name()
      "Texas elves"
      iex> EverFaker.Team.En.name()
      "Iowa fishes"
  """
  @spec name() :: String.t()
  def name, do: "#{Address.state()} #{creature()}"

  @doc """
  Returns a random creature name

  ## Examples

      iex> EverFaker.Team.En.creature()
      "prophets"
      iex> EverFaker.Team.En.creature()
      "cats"
      iex> EverFaker.Team.En.creature()
      "enchanters"
      iex> EverFaker.Team.En.creature()
      "banshees"
  """
  @spec creature() :: String.t()
  sampler(:creature, [
    "ants",
    "banshees",
    "bats",
    "bears",
    "bees",
    "birds",
    "black cats",
    "buffalo",
    "cats",
    "cattle",
    "chickens",
    "chimeras",
    "conspirators",
    "crows",
    "dogs",
    "dolphins",
    "dragons",
    "druids",
    "ducks",
    "dwarves",
    "elephants",
    "elves",
    "enchanters",
    "exorcists",
    "fishes",
    "foes",
    "foxes",
    "frogs",
    "geese",
    "ghosts",
    "giants",
    "gnomes",
    "goats",
    "goblins",
    "gooses",
    "griffins",
    "horses",
    "kangaroos",
    "lions",
    "lycanthropes",
    "monkeys",
    "nemesis",
    "ogres",
    "oracles",
    "owls",
    "oxen",
    "penguins",
    "people",
    "pigs",
    "prophets",
    "rabbits",
    "sheep",
    "sons",
    "sorcerors",
    "spiders",
    "spirits",
    "tigers",
    "vampires",
    "vixens",
    "warlocks",
    "werewolves",
    "whales",
    "witches",
    "wolves",
    "worshipers",
    "zebras",
    "zombies"
  ])
end