lib/faker/commerce/pt_br.ex

defmodule Faker.Commerce.PtBr do
  import Faker, only: [sampler: 2]

  @moduledoc """
  Functions for generating commerce related data in Brazilian Portuguese.
  """

  alias Faker.Color.PtBr, as: Color

  @doc """
  Returns a random color.

  ## Examples

      iex> Faker.Commerce.PtBr.color()
      "Vermelho(a)"
      iex> Faker.Commerce.PtBr.color()
      "Verde"
      iex> Faker.Commerce.PtBr.color()
      "Marrom"
      iex> Faker.Commerce.PtBr.color()
      "Rosa"
  """
  @spec color() :: String.t()
  def color do
    # As in Brazilian Portuguese we have feminine and masculine words, this function suffixes an (a)
    # when a color name ends with an 'o'.
    # Words ending with an 'o' are masculine words, but when we suffice an (a), we are saying the word
    # can be either feminine or masculine.

    color = Color.name()

    color
    |> String.split("", trim: true)
    |> List.last()
    |> case do
      "o" -> color <> "(a)"
      _ -> color
    end
  end

  @doc """
  Returns a random department

  ## Examples

      iex> Faker.Commerce.PtBr.department()
      "Eletrônicos, TV e Áudio"
      iex> Faker.Commerce.PtBr.department()
      "Alimentos e bebidas"
      iex> Faker.Commerce.PtBr.department()
      "Livros"
      iex> Faker.Commerce.PtBr.department()
      "Beleza e cuidados pessoais"
  """
  @spec department() :: String.t()
  sampler(:department, [
    "Academia",
    "Alimentos e bebidas",
    "Automotivo",
    "Bebês",
    "Beleza e cuidados pessoais",
    "Brinquedos",
    "Casa, Jardim e Limpeza",
    "Celulares",
    "Computadores e Informática",
    "Cozinha",
    "Eletrônicos, TV e Áudio",
    "Esportes, Aventura e Lazer",
    "Ferramentas e Construção",
    "Filmes, Séries e Música",
    "Games e Consoles",
    "Livros",
    "Papelaria e Escritório",
    "Pet Shop",
    "Roupas, Calçados e Acessórios",
    "Saúde e Bem-estar"
  ])

  @doc """
  Returns a complete product name, based on product adjectives, product
  materials, product names

  ## Examples

      iex> Faker.Commerce.PtBr.product_name()
      "Cadeira Gigante de Algodão"
      iex> Faker.Commerce.PtBr.product_name()
      "Computador de Granito"
      iex> Faker.Commerce.PtBr.product_name()
      "Bolsa Médio(a)"
      iex> Faker.Commerce.PtBr.product_name()
      "Escrivaninha Grande"
  """
  @spec product_name() :: String.t()
  def product_name, do: product_name(Faker.random_between(0, 5))

  defp product_name(0) do
    "#{product_name_product()} #{product_name_adjective()} de #{product_name_material()}"
  end

  defp product_name(1) do
    "#{product_name_product()} #{color()} #{product_name_adjective()} de #{product_name_material()}"
  end

  defp product_name(2), do: "#{product_name_product()} #{product_name_adjective()}"
  defp product_name(3), do: "#{product_name_product()} #{color()} #{product_name_adjective()}"
  defp product_name(4), do: "#{product_name_product()} de #{product_name_material()}"
  defp product_name(5), do: "#{product_name_product()} #{color()} de #{product_name_material()}"

  @doc """
  Returns a random adjective for a product

  ## Examples

      iex> Faker.Commerce.PtBr.product_name_adjective()
      "Gigante"
      iex> Faker.Commerce.PtBr.product_name_adjective()
      "Rústico(a)"
      iex> Faker.Commerce.PtBr.product_name_adjective()
      "Gigante"
      iex> Faker.Commerce.PtBr.product_name_adjective()
      "Elegante"
  """
  @spec product_name_adjective() :: String.t()
  sampler(
    :product_name_adjective,
    [
      "Aerodinâmico",
      "Durável",
      "Elegante",
      "Ergonômico(a)",
      "Gigante",
      "Grande",
      "Inteligente",
      "Luxo",
      "Médio(a)",
      "Pequeno(a)",
      "Prático",
      "Rústico(a)",
      "Simples"
    ]
  )

  @doc """
  Returns a random product material

  ## Examples

      iex> Faker.Commerce.PtBr.product_name_material()
      "Plástico"
      iex> Faker.Commerce.PtBr.product_name_material()
      "Aço"
      iex> Faker.Commerce.PtBr.product_name_material()
      "Concreto"
      iex> Faker.Commerce.PtBr.product_name_material()
      "Algodão"
  """
  @spec product_name_material() :: String.t()
  sampler(:product_name_material, [
    "Algodão",
    "Aço",
    "Borracha",
    "Concreto",
    "Granito",
    "Madeira",
    "Plástico",
    "Silicone"
  ])

  @doc """
  Returns a random product name

  ## Examples

      iex> Faker.Commerce.PtBr.product_name_product()
      "Guarda-roupa"
      iex> Faker.Commerce.PtBr.product_name_product()
      "Cadeira"
      iex> Faker.Commerce.PtBr.product_name_product()
      "Cobertor"
      iex> Faker.Commerce.PtBr.product_name_product()
      "Sandália"
  """
  @spec product_name_product() :: String.t()
  sampler(:product_name_product, [
    "Armário",
    "Aspirador de pó",
    "Balcão",
    "Bolsa",
    "Barraca",
    "Cadeira",
    "Caderno",
    "Calça",
    "Cama",
    "Camiseta",
    "Carro",
    "Celular",
    "Chapéu",
    "Cobertor",
    "Computador",
    "Escrivaninha",
    "Estante",
    "Gorro",
    "Guarda-roupa",
    "Guitarra",
    "Luva",
    "Mesa",
    "Mochila",
    "Notebook",
    "Pia",
    "Piano",
    "Porta-jóias",
    "Quadro",
    "Sandália",
    "Sapato",
    "Saxofone",
    "Tênis",
    "Teclado",
    "Violão"
  ])
end