smee_view

defmodule SmeeView.Aspects.NameIDFormat do

  @moduledoc """
  Represents and processes <NameIDFormat> elements in entity metadata as Aspect structs.

  The functions in this module are intended to be applied to individual Aspect structs - for extracting and processing
  collections of these records please use the matching View module.
  """

  @type t :: %__MODULE__{
               uri: binary()
             }

  @derive Jason.Encoder
  defstruct [
    uri: nil
  ]

  use SmeeView.Aspects.AspectCommon, features: [:prid]

  @doc """
  Returns the value of the nameid as a string

  ```
  #{
    String.split("#{__MODULE__}", ".")
    |> List.last()
  }.nameid(aspect)
  # => "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
  ```
  """
  @spec nameid(aspect :: __MODULE__.t()) :: binary()
  def nameid(aspect) do
    aspect.uri
  end

  @doc """
  Returns the value of the nameid as a string

  ```
  #{
    String.split("#{__MODULE__}", ".")
    |> List.last()
  }.text(aspect)
  # => "urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
  ```
  """
  @spec text(aspect :: __MODULE__.t()) :: binary()
  def text(aspect) do
    aspect.uri
  end

  #######################################################################################

end