es.ex

defmodule Faker.Address.Es do
  import Faker, only: [sampler: 2]

  alias Faker.Person.Es

  @moduledoc """
  Functions for generating addresses in Spanish
  """

  @doc """
  Return random building number.

  ## Examples

      iex> Faker.Address.Es.building_number()
      "s/n."
      iex> Faker.Address.Es.building_number()
      "5"
      iex> Faker.Address.Es.building_number()
      "26"
      iex> Faker.Address.Es.building_number()
      "61"
  """
  @spec building_number() :: String.t()
  def building_number do
    ["s/n.", "#", "##", "#", "##"]
    |> Enum.at(Faker.random_between(0, 4))
    |> Faker.format()
  end

  @doc """
  Return city name.

  ## Examples

      iex> Faker.Address.Es.city()
      "Guillermina"
      iex> Faker.Address.Es.city()
      "Agosto"
      iex> Faker.Address.Es.city()
      "Burgos Alfonso"
      iex> Faker.Address.Es.city()
      "María José"
  """
  @spec city() :: String.t()
  def city do
    city(Faker.random_between(0, 3))
  end

  defp city(0), do: "#{city_prefix()} #{Es.first_name()}"
  defp city(1), do: "#{city_prefix()} #{Es.first_name()}"
  defp city(2), do: "#{Es.first_name()}"
  defp city(3), do: "#{Es.last_name()}"

  @doc """
  Return city prefix.

  ## Examples

      iex> Faker.Address.Es.city_prefix()
      "Vitoria"
      iex> Faker.Address.Es.city_prefix()
      "Oviedo"
      iex> Faker.Address.Es.city_prefix()
      "Talavera de la Reina"
      iex> Faker.Address.Es.city_prefix()
      "Cáceres"
  """
  @spec city_prefix() :: String.t()
  sampler(:city_prefix, [
    "Parla",
    "Telde",
    "Baracaldo",
    "San Fernando",
    "Torrevieja",
    "Lugo",
    "Santiago de Compostela",
    "Gerona",
    "Cáceres",
    "Lorca",
    "Coslada",
    "Talavera de la Reina",
    "El Puerto de Santa María",
    "Cornellá de Llobregat",
    "Avilés",
    "Palencia",
    "Gecho",
    "Orihuela",
    "Pontevedra",
    "Pozuelo de Alarcón",
    "Toledo",
    "El Ejido",
    "Guadalajara",
    "Gandía",
    "Ceuta",
    "Ferrol",
    "Chiclana de la Frontera",
    "Manresa",
    "Roquetas de Mar",
    "Ciudad Real",
    "Rubí",
    "Benidorm",
    "San Sebastían de los Reyes",
    "Ponferrada",
    "Zamora",
    "Alcalá de Guadaira",
    "Fuengirola",
    "Mijas",
    "Sanlúcar de Barrameda",
    "La Línea de la Concepción",
    "Majadahonda",
    "Sagunto",
    "El Prat de LLobregat",
    "Viladecans",
    "Linares",
    "Alcoy",
    "Irún",
    "Estepona",
    "Torremolinos",
    "Rivas-Vaciamadrid",
    "Molina de Segura",
    "Paterna",
    "Granollers",
    "Santa Lucía de Tirajana",
    "Motril",
    "Cerdañola del Vallés",
    "Arrecife",
    "Segovia",
    "Torrelavega",
    "Elda",
    "Mérida",
    "Ávila",
    "Valdemoro",
    "Cuenta",
    "Collado Villalba",
    "Benalmádena",
    "Mollet del Vallés",
    "Puertollano",
    "Madrid",
    "Barcelona",
    "Valencia",
    "Sevilla",
    "Zaragoza",
    "Málaga",
    "Murcia",
    "Palma de Mallorca",
    "Las Palmas de Gran Canaria",
    "Bilbao",
    "Córdoba",
    "Alicante",
    "Valladolid",
    "Vigo",
    "Gijón",
    "Hospitalet de LLobregat",
    "La Coruña",
    "Granada",
    "Vitoria",
    "Elche",
    "Santa Cruz de Tenerife",
    "Oviedo",
    "Badalona",
    "Cartagena",
    "Móstoles",
    "Jerez de la Frontera",
    "Tarrasa, Sabadell",
    "Alcalá de Henares",
    "Pamplona",
    "Fuenlabrada",
    "Almería",
    "San Sebastián",
    "Leganés",
    "Santander",
    "Burgos",
    "Castellón de la Plana",
    "Alcorcón",
    "Albacete",
    "Getafe",
    "Salamanca",
    "Huelva",
    "Logroño",
    "Badajoz",
    "San Cristróbal de la Laguna",
    "León",
    "Tarragona",
    "Cádiz",
    "Lérida",
    "Marbella",
    "Mataró",
    "Dos Hermanas",
    "Santa Coloma de Gramanet",
    "Jaén",
    "Algeciras",
    "Torrejón de Ardoz",
    "Orense",
    "Alcobendas",
    "Reus",
    "Calahorra",
    "Inca"
  ])

  @doc """
  Return country.

  ## Examples

      iex> Faker.Address.Es.country()
      "Cabo Verde"
      iex> Faker.Address.Es.country()
      "Malawi"
      iex> Faker.Address.Es.country()
      "Bielorusia"
      iex> Faker.Address.Es.country()
      "Mali"
  """
  @spec country() :: String.t()
  sampler(:country, [
    "Afganistán",
    "Albania",
    "Argelia",
    "Andorra",
    "Angola",
    "Argentina",
    "Armenia",
    "Aruba",
    "Australia",
    "Austria",
    "Azerbayán",
    "Bahamas",
    "Barein",
    "Bangladesh",
    "Barbados",
    "Bielorusia",
    "Bélgica",
    "Belice",
    "Bermuda",
    "Bután",
    "Bolivia",
    "Bosnia Herzegovina",
    "Botswana",
    "Brasil",
    "Bulgaria",
    "Burkina Faso",
    "Burundi",
    "Camboya",
    "Camerún",
    "Canada",
    "Cabo Verde",
    "Islas Caimán",
    "Chad",
    "Chile",
    "China",
    "Isla de Navidad",
    "Colombia",
    "Comodos",
    "Congo",
    "Costa Rica",
    "Costa de Marfil",
    "Croacia",
    "Cuba",
    "Chipre",
    "República Checa",
    "Dinamarca",
    "Dominica",
    "República Dominicana",
    "Ecuador",
    "Egipto",
    "El Salvador",
    "Guinea Ecuatorial",
    "Eritrea",
    "Estonia",
    "Etiopía",
    "Islas Faro",
    "Fiji",
    "Finlandia",
    "Francia",
    "Gabón",
    "Gambia",
    "Georgia",
    "Alemania",
    "Ghana",
    "Grecia",
    "Groenlandia",
    "Granada",
    "Guadalupe",
    "Guam",
    "Guatemala",
    "Guinea",
    "Guinea-Bisau",
    "Guayana",
    "Haiti",
    "Honduras",
    "Hong Kong",
    "Hungria",
    "Islandia",
    "India",
    "Indonesia",
    "Iran",
    "Irak",
    "Irlanda",
    "Italia",
    "Jamaica",
    "Japón",
    "Jordania",
    "Kazajistan",
    "Kenia",
    "Kiribati",
    "Corea",
    "Kuwait",
    "Letonia",
    "Líbano",
    "Liberia",
    "Liechtenstein",
    "Lituania",
    "Luxemburgo",
    "Macao",
    "Macedonia",
    "Madagascar",
    "Malawi",
    "Malasia",
    "Maldivas",
    "Mali",
    "Malta",
    "Martinica",
    "Mauritania",
    "Méjico",
    "Micronesia",
    "Moldavia",
    "Mónaco",
    "Mongolia",
    "Montenegro",
    "Montserrat",
    "Marruecos",
    "Mozambique",
    "Namibia",
    "Nauru",
    "Nepal",
    "Holanda",
    "Nueva Zelanda",
    "Nicaragua",
    "Niger",
    "Nigeria",
    "Noruega",
    "Omán",
    "Pakistan",
    "Panamá",
    "Papúa Nueva Guinea",
    "Paraguay",
    "Perú",
    "Filipinas",
    "Poland",
    "Portugal",
    "Puerto Rico",
    "Rusia",
    "Ruanda",
    "Samoa",
    "San Marino",
    "Santo Tomé y Principe",
    "Arabia Saudí",
    "Senegal",
    "Serbia",
    "Seychelles",
    "Sierra Leona",
    "Singapur",
    "Eslovaquia",
    "Eslovenia",
    "Somalia",
    "España",
    "Sri Lanka",
    "Sudán",
    "Suriname",
    "Suecia",
    "Suiza",
    "Siria",
    "Taiwan",
    "Tajikistan",
    "Tanzania",
    "Tailandia",
    "Timor-Leste",
    "Togo",
    "Tonga",
    "Trinidad y Tobago",
    "Tunez",
    "Turquia",
    "Uganda",
    "Ucrania",
    "Emiratos Árabes Unidos",
    "Reino Unido",
    "Estados Unidos de América",
    "Uruguay",
    "Uzbekistan",
    "Vanuatu",
    "Venezuela",
    "Vietnam",
    "Yemen",
    "Zambia",
    "Zimbabwe"
  ])

  @doc """
  Return country code.

  ## Examples

      iex> Faker.Address.Es.country_code()
      "ES"
  """
  @spec country_code() :: String.t()
  sampler(:country_code, ["ES"])

  @doc """
  Return random secondary address.

  ## Examples

      iex> Faker.Address.Es.secondary_address()
      "Esc. 154"
      iex> Faker.Address.Es.secondary_address()
      "Esc. 646"
      iex> Faker.Address.Es.secondary_address()
      "Puerta 083"
      iex> Faker.Address.Es.secondary_address()
      "Esc. 970"
  """
  @spec secondary_address() :: String.t()
  def secondary_address do
    ["Esc. ###", "Puerta ###"]
    |> Enum.at(Faker.random_between(0, 1))
    |> Faker.format()
  end

  @doc """
  Return state. But Spain doesn't have states so this calls Faker.Address.Es.region() instead.
  """
  @spec state() :: String.t()
  def state, do: region()

  @doc """
  Return region.[Source](https://www.ine.es/daco/daco42/codmun/cod_ccaa.htm)

  ## Examples

      iex> Faker.Address.Es.region()
      "Extremadura"
      iex> Faker.Address.Es.region()
      "Aragón"
      iex> Faker.Address.Es.region()
      "País Vasco"
      iex> Faker.Address.Es.region()
      "Canarias"
  """

  @spec region() :: String.t()
  sampler(:region, [
    "Andalucía",
    "Aragón",
    "Principado de Asturias",
    "Illes Balears",
    "Canarias",
    "Cantabria",
    "Castilla-La Mancha",
    "Castilla y León",
    "Cataluña",
    "Comunitat Valenciana",
    "Extremadura",
    "Galicia",
    "La Rioja",
    "Comunidad de Madrid",
    "Comunidad Foral de Navarra",
    "País Vasco",
    "La Rioja",
    "Región de Murcia",
    "Ceuta",
    "Melilla"
  ])

  @doc """
  Return state abbr.

  ## Examples

      iex> Faker.Address.Es.state_abbr()
      "Ara"
      iex> Faker.Address.Es.state_abbr()
      "Cbr"
      iex> Faker.Address.Es.state_abbr()
      "Mad"
      iex> Faker.Address.Es.state_abbr()
      "Gal"
  """
  @spec state_abbr() :: String.t()
  sampler(:state_abbr, [
    "And",
    "Ara",
    "Ast",
    "Bal",
    "Can",
    "Cbr",
    "Man",
    "Leo",
    "Cat",
    "Com",
    "Ext",
    "Gal",
    "Rio",
    "Mad",
    "Nav",
    "Vas",
    "Mur"
  ])

  @doc """
  Return street address.

  ## Examples

      iex> Faker.Address.Es.street_address()
      "Arrabal Daniela 26"
      iex> Faker.Address.Es.street_address()
      "Mercado Navarro s/n."
      iex> Faker.Address.Es.street_address()
      "Parque Débora Huerta 05"
      iex> Faker.Address.Es.street_address()
      "Rambla Gutiérrez 02"
  """
  @spec street_address() :: String.t()
  def street_address do
    "#{street_name()} #{building_number()}"
  end

  @doc """
  Return `street_address/0` or if argument is `true` adds `secondary_address/0`.

  ## Examples

      iex> Faker.Address.Es.street_address(true)
      "Arrabal Daniela 26 Esc. 610"
      iex> Faker.Address.Es.street_address(false)
      "Parque Débora Huerta 05"
      iex> Faker.Address.Es.street_address(false)
      "Rambla Gutiérrez 02"
      iex> Faker.Address.Es.street_address(false)
      "Calle Murillo 2"
  """
  @spec street_address(true | any) :: String.t()
  def street_address(true), do: street_address() <> " " <> secondary_address()
  def street_address(_), do: street_address()

  @doc """
  Return street name.

  ## Examples

      iex> Faker.Address.Es.street_name()
      "Arrabal Daniela"
      iex> Faker.Address.Es.street_name()
      "Polígono Javier Acosta"
      iex> Faker.Address.Es.street_name()
      "Urbanización Gerardo Garza"
      iex> Faker.Address.Es.street_name()
      "Ferrocarril Huerta"
  """
  @spec street_name() :: String.t()
  def street_name do
    street_name(Faker.random_between(0, 2))
  end

  defp street_name(0), do: "#{street_prefix()} #{Es.first_name()}"
  defp street_name(1), do: "#{street_prefix()} #{Es.last_name()}"

  defp street_name(2),
    do: "#{street_prefix()} #{Es.first_name()} #{Es.last_name()}"

  @doc """
  Return street suffix.

  ## Examples
      iex> Faker.Address.Es.street_suffix()
      "de arriba"
      iex> Faker.Address.Es.street_suffix()
      "Sur"
      iex> Faker.Address.Es.street_suffix()
      "de abajo"
      iex> Faker.Address.Es.street_suffix()
      "Norte"
  """
  @spec street_suffix() :: String.t()
  sampler(:street_suffix, [
    "Norte",
    "Sur",
    "de arriba",
    "de abajo"
  ])

  @doc """
  Return street prefix.

  ## Examples

      iex> Faker.Address.Es.street_prefix()
      "Carretera"
      iex> Faker.Address.Es.street_prefix()
      "Arrabal"
      iex> Faker.Address.Es.street_prefix()
      "Chalet"
      iex> Faker.Address.Es.street_prefix()
      "Colegio"
  """
  @spec street_prefix() :: String.t()
  sampler(:street_prefix, [
    "Aldea",
    "Apartamento",
    "Arrabal",
    "Arroyo",
    "Avenida",
    "Bajada",
    "Barranco",
    "Barrio",
    "Bloque",
    "Calle",
    "Calleja",
    "Camino",
    "Carretera",
    "Caserio",
    "Colegio",
    "Colonia",
    "Conjunto",
    "Cuesta",
    "Chalet",
    "Edificio",
    "Entrada",
    "Escalinata",
    "Explanada",
    "Extramuros",
    "Extrarradio",
    "Ferrocarril",
    "Glorieta",
    "Gran Subida",
    "Grupo",
    "Huerta",
    "Jardines",
    "Lado",
    "Lugar",
    "Manzana",
    "Masía",
    "Mercado",
    "Monte",
    "Muelle",
    "Municipio",
    "Parcela",
    "Parque",
    "Partida",
    "Pasaje",
    "Paseo",
    "Plaza",
    "Poblado",
    "Polígono",
    "Prolongación",
    "Puente",
    "Puerta",
    "Quinta",
    "Ramal",
    "Rambla",
    "Rampa",
    "Riera",
    "Rincón",
    "Ronda",
    "Rua",
    "Salida",
    "Sección",
    "Senda",
    "Solar",
    "Subida",
    "Terrenos",
    "Torrente",
    "Travesía",
    "Urbanización",
    "Vía",
    "Vía Pública"
  ])

  @doc """
  Return time zone.

  ## Examples

      iex> Faker.Address.Es.time_zone()
      "Australia/Sydney"
      iex> Faker.Address.Es.time_zone()
      "America/Guyana"
      iex> Faker.Address.Es.time_zone()
      "Asia/Kathmandu"
      iex> Faker.Address.Es.time_zone()
      "Europa/Vienna"
  """
  @spec time_zone() :: String.t()
  sampler(:time_zone, [
    "Pacífico/Midway",
    "Pacífico/Pago_Pago",
    "Pacífico/Honolulu",
    "America/Juneau",
    "America/Los_Angeles",
    "America/Tijuana",
    "America/Denver",
    "America/Phoenix",
    "America/Chihuahua",
    "America/Mazatlan",
    "America/Chicago",
    "America/Regina",
    "America/Mexico_City",
    "America/Monterrey",
    "America/Guatemala",
    "America/New_York",
    "America/Indiana/Indianapolis",
    "America/Bogota",
    "America/Lima",
    "America/Halifax",
    "America/Caracas",
    "America/La_Paz",
    "America/Santiago",
    "America/St_Johns",
    "America/Sao_Paulo",
    "America/Argentina/Buenos_Aires",
    "America/Guyana",
    "America/Godthab",
    "Atlantic/South_Georgia",
    "Atlantic/Azores",
    "Atlantic/Cape_Verde",
    "Europa/Dublin",
    "Europa/Lisbon",
    "Europa/London",
    "Africa/Casablanca",
    "Africa/Monrovia",
    "Etc/UTC",
    "Europa/Belgrade",
    "Europa/Bratislava",
    "Europa/Budapest",
    "Europa/Ljubljana",
    "Europa/Prague",
    "Europa/Sarajevo",
    "Europa/Skopje",
    "Europa/Warsaw",
    "Europa/Zagreb",
    "Europa/Brussels",
    "Europa/Copenhagen",
    "Europa/Madrid",
    "Europa/Paris",
    "Europa/Amsterdam",
    "Europa/Berlin",
    "Europa/Rome",
    "Europa/Stockholm",
    "Europa/Vienna",
    "Africa/Algiers",
    "Europa/Bucharest",
    "Africa/Cairo",
    "Europa/Helsinki",
    "Europa/Kiev",
    "Europa/Riga",
    "Europa/Sofia",
    "Europa/Tallinn",
    "Europa/Vilnius",
    "Europa/Athens",
    "Europa/Istanbul",
    "Europa/Minsk",
    "Asia/Jerusalen",
    "Africa/Harare",
    "Africa/Johannesburg",
    "Europa/Moscú",
    "Asia/Kuwait",
    "Asia/Riyadh",
    "Africa/Nairobi",
    "Asia/Baghdad",
    "Asia/Tehran",
    "Asia/Muscat",
    "Asia/Baku",
    "Asia/Tbilisi",
    "Asia/Yerevan",
    "Asia/Kabul",
    "Asia/Yekaterinburg",
    "Asia/Karachi",
    "Asia/Tashkent",
    "Asia/Kolkata",
    "Asia/Kathmandu",
    "Asia/Dhaka",
    "Asia/Colombo",
    "Asia/Almaty",
    "Asia/Novosibirsk",
    "Asia/Rangoon",
    "Asia/Bangkok",
    "Asia/Jakarta",
    "Asia/Krasnoyarsk",
    "Asia/Shanghai",
    "Asia/Chongqing",
    "Asia/Hong_Kong",
    "Asia/Urumqi",
    "Asia/Kuala_Lumpur",
    "Asia/Singapore",
    "Asia/Taipei",
    "Australia/Perth",
    "Asia/Irkutsk",
    "Asia/Ulaanbaatar",
    "Asia/Seoul",
    "Asia/Tokyo",
    "Asia/Yakutsk",
    "Australia/Darwin",
    "Australia/Adelaide",
    "Australia/Melbourne",
    "Australia/Sydney",
    "Australia/Brisbane",
    "Australia/Hobart",
    "Asia/Vladivostok",
    "Pacífico/Guam",
    "Pacífico/Port_Moresby",
    "Asia/Magadan",
    "Pacífico/Noumea",
    "Pacífico/Fiji",
    "Asia/Kamchatka",
    "Pacífico/Majuro",
    "Pacífico/Auckland",
    "Pacífico/Tongatapu",
    "Pacífico/Fakaofo",
    "Pacífico/Apia"
  ])

  @doc """
  Return random postcode.

  ## Examples

      iex> Faker.Address.Es.zip_code()
      "01542"
      iex> Faker.Address.Es.zip_code()
      "64610"
      iex> Faker.Address.Es.zip_code()
      "83297"
      iex> Faker.Address.Es.zip_code()
      "05235"
  """
  @spec zip_code() :: String.t()
  def zip_code do
    ["#####"]
    |> Enum.at(0)
    |> Faker.format()
  end
end