ex_toolkit

defmodule ExToolkit.Naming do
  @moduledoc """
  This module encapsulates common tasks related to processing personal names in
  a standardized format. This module treats names as case-insensitive and
  returns results in a formatted, readable way.
  """

  @doc """
  Shortens the first name to its initial, while preserving the rest of the name.

  This function takes a name (a string of one or more words), and reduces the first name to its initial.
  The rest of the name is preserved. The initial is followed by a period and a space, and then the rest of the name.

  ## Arguments

  - `name`: A string representing a full name, or `nil`.

  ## Examples

      iex> Naming.shorten_firstname(nil)
      ""

      iex> Naming.shorten_firstname("")
      ""

      iex> Naming.shorten_firstname("John")
      "J."

      iex> Naming.shorten_firstname("john")
      "J."

      iex> Naming.shorten_firstname("John Doe")
      "J. Doe"

      iex> Naming.shorten_firstname("john doe")
      "J. Doe"

      iex> Naming.shorten_firstname("john doe jr")
      "J. Doe Jr"
  """
  @spec shorten_firstname(nil | String.t()) :: String.t()
  def shorten_firstname(name) when is_nil(name) or name == "", do: ""

  def shorten_firstname(name) do
    case String.split(name, " ", parts: 2) do
      [first] ->
        [letter | _rest] = String.codepoints(first)
        "#{String.upcase(letter)}."

      [first, rest] ->
        [letter | _rest] = String.codepoints(first)
        "#{String.upcase(letter)}. #{capitalize(rest)}"
    end
  end

  @doc """
  Shortens the last name to its initial, while preserving the rest of the name.

  This function takes a name (a string of one or more words), and reduces the last name to its initial.
  The rest of the name is preserved. The initial is followed by a period and a space.

  ## Arguments

  - `name`: A string representing a full name, or `nil`.

  ## Examples

      iex> Naming.shorten_lastname(nil)
      ""

      iex> Naming.shorten_lastname("")
      ""

      iex> Naming.shorten_lastname("John")
      "John"

      iex> Naming.shorten_lastname("john")
      "John"

      iex> Naming.shorten_lastname("John Doe")
      "John D."

      iex> Naming.shorten_lastname("John Van Doe")
      "John Van D."

      iex> Naming.shorten_lastname("john doe")
      "John D."
  """
  @spec shorten_lastname(nil | String.t()) :: String.t()
  def shorten_lastname(name) when is_nil(name) or name == "", do: ""

  def shorten_lastname(name) do
    name_parts = String.split(String.trim(name), " ")

    case name_parts do
      [] ->
        ""

      [first] ->
        String.capitalize(first)

      names ->
        [last_initial | _rest] = names |> Enum.at(-1) |> String.codepoints()

        first_names = names |> Enum.drop(-1) |> Enum.join(" ") |> capitalize()

        "#{first_names} #{String.upcase(last_initial)}."
    end
  end

  @doc """
  Extracts the initials from a given name.

  This function takes a name (a string of one or more words), and extracts the
  first letter of the first name and the family name.

  ## Arguments

  - `name`: A string representing a full name, or `nil`.

  ## Examples

      iex> Naming.extract_initials(nil)
      ""

      iex> Naming.extract_initials("")
      ""

      iex> Naming.extract_initials("John")
      "J"

      iex> Naming.extract_initials("John Doe")
      "JD"

      iex> Naming.extract_initials("John Nommensen Duchac")
      "JD"
  """
  @spec extract_initials(nil | String.t()) :: String.t()
  def extract_initials(name) when is_nil(name) or name == "", do: ""

  def extract_initials(name) do
    initials =
      name
      |> String.trim()
      |> String.split(" ")
      |> Stream.map(&String.first/1)
      |> Stream.filter(&(&1 != "" and not is_nil(&1)))
      |> Stream.map(&String.trim/1)
      |> Stream.filter(&String.match?(&1, ~r/^\p{L}$/u))
      |> Enum.map(&String.upcase/1)

    case initials do
      [] -> ""
      [first] -> first
      [first | rest] -> first <> Enum.at(rest, -1)
    end
  end

  @doc """
  Extracts and capitalizes the first and last names from a given name.

  ## Arguments

  - `name`: A string representing a full name, or `nil`.

  ## Examples

      iex> Naming.extract_first_last_name(nil)
      ""

      iex> Naming.extract_first_last_name("")
      ""

      iex> Naming.extract_first_last_name("john")
      "John"

      iex> Naming.extract_first_last_name("john doe smith")
      "John Smith"
  """
  @spec extract_first_last_name(nil | String.t()) :: String.t()
  def extract_first_last_name(name) when is_nil(name) or name == "", do: ""

  def extract_first_last_name(name) do
    case to_list_of_names(name) do
      [] -> ""
      [first] -> first
      [first | rest] -> first <> " " <> Enum.at(rest, -1)
    end
  end

  @doc """
  Extracts and capitalizes the first and last names and then shortens the first name from a given name and.

  ## Arguments

  - `name`: A string representing a full name, or `nil`.

  ## Examples

      iex> Naming.extract_short_name(nil)
      ""

      iex> Naming.extract_short_name("")
      ""

      iex> Naming.extract_short_name("john")
      "John"

      iex> Naming.extract_short_name("john doe smith")
      "J. Smith"

      iex> Naming.extract_short_name("john doe smith (funny)")
      "J. Smith"
  """
  @spec extract_short_name(nil | String.t()) :: String.t()
  def extract_short_name(name) when is_nil(name) or name == "", do: ""

  def extract_short_name(name) do
    case to_list_of_names(name) do
      [] -> ""
      [first] -> first
      [first | rest] -> shorten_firstname(first) <> " " <> Enum.at(rest, -1)
    end
  end

  @doc """
  Capitalizes the first letter of each word in a name.

  ## Arguments

  - `name`: A string representing a full name, or `nil`.

  ## Examples

      iex> Naming.capitalize(nil)
      ""

      iex> Naming.capitalize("")
      ""

      iex> Naming.capitalize("john doe")
      "John Doe"

      iex> Naming.capitalize("JOHN DOE")
      "John Doe"

      iex> Naming.capitalize("john nommensen duchac")
      "John Nommensen Duchac"
  """
  @spec capitalize(nil | String.t()) :: String.t()
  def capitalize(name) when is_nil(name) or name == "", do: ""

  def capitalize(name) do
    name
    |> String.trim()
    |> String.split(" ")
    |> Enum.map_join(" ", &String.capitalize/1)
  end

  defp to_list_of_names(name) do
    name
    |> String.trim()
    |> String.split(" ")
    |> Stream.filter(&String.match?(String.slice(&1, 0, 1), ~r/^\p{L}$/u))
    |> Enum.map(&String.capitalize/1)
  end
end