tamnoon

defmodule Tamnoon.DOM.NodeCollection do
  @moduledoc """

  Represents a DOM node collection. Accepts two parameters for how to select the nodes,

  `:selector_type` and `:selector_value`. For example, when `:selector_type` is `:children` and

  `:selector_value` is a `t:Tamnoon.DOM.Node.t/0`, it will be equivalent to using

  `element.children()` in JS.





  ## Fields



    * `:selector_type` – an atom indicating the type of selector.

      - Expected values: `:xpath`, `:query`, `:children`.



    * `:selector_value` – the value associated with the selector.

      - `:xpath`: a `t:String.t/0` of the xpath to select by.

      - `:query`: a `t:String.t/0` of the query selector to select by.

      - `:children`: a `t:Tamnoon.DOM.Node.t/0` of the parent node.

  """

  alias Tamnoon.DOM
  import DOM
  use DOM.JsonEncoder, type: :node_collection

  @enforce_keys [:selector_type, :selector_value]
  defstruct [:selector_type, :selector_value]

  @type t :: %__MODULE__{

          selector_type: :xpath | :query | :children,

          selector_value: String.t() | DOM.Node.t()

        }

  @spec is_node_collection?(node_collection :: any()) :: boolean()
  def is_node_collection?(node_collection)

  def is_node_collection?(%DOM.NodeCollection{}), do: true

  def is_node_collection?(%{selector_type: :children, selector_value: %DOM.Node{}}), do: true

  def is_node_collection?(%{selector_type: :xpath, selector_value: value})
    when is_binary(value), do: true

  def is_node_collection?(%{selector_type: :query, selector_value: value})
    when is_binary(value), do: true

  def is_node_collection?(_), do: false

  @doc """

  Constructs a `t:Tamnoon.DOM.NodeCollection.t/0` with the following arguments:



    * `:selector_type` – an atom (`:xpath`, `:query` or `:children`).



    * `:selector_value` – a `t:String.t/0` the value associated with the selector.

      - `:xpath`: a `t:String.t/0` of the xpath to select by.

      - `:query`: a `t:String.t/0` of the query selector to select by.

      - `:children`: a `t:Tamnoon.DOM.Node.t/0` of the parent node.

  """
  @spec new!(node_collection :: term()) :: %DOM.NodeCollection{}
  def new!(%DOM.NodeCollection{} = node_collection), do: node_collection

  def new!(node_collection) do
    validate_type!(node_collection, &is_node_collection?/1, DOM.NodeCollection)

    struct!(DOM.NodeCollection, node_collection)
  end
end