delimit

defmodule Delimit do
  @moduledoc """
  Delimit: A library for defining and working with delimited data files.

  Delimit allows you to define a schema for delimited data files (CSV, TSV, etc.)
  and provides functions for reading, writing, and manipulating that data.
  The library automatically generates structs based on your schema definition,
  complete with proper typespecs.

  ## Example

      defmodule MyApp.Person do
        use Delimit

        layout do
          field :first_name, :string
          field :last_name, :string
          field :age, :integer
          field :birthday, :date, format: "YYYY-MM-DD"
          field :active, :boolean
        end
      end

      # Read data from a file (auto-detects CSV format)
      people = MyApp.Person.read("people.csv")
      
      # Read data with explicit format (tab-separated values)
      people = MyApp.Person.read("people.tsv", format: :tsv)

      # Write data to a file
      MyApp.Person.write("new_people.csv", people)
      
      # Write data with explicit format (pipe-separated values)
      MyApp.Person.write("new_people.psv", people, format: :psv)

      # Work with a specific record
      first_person = Enum.at(people, 0)
      IO.puts("Name: \#{first_person.first_name} \#{first_person.last_name}")
  """

  # Module aliases can be added here as needed

  @doc false
  defmacro __using__(_opts) do
    quote do
      import Delimit, only: [layout: 1]

      @delimit_schema Delimit.Schema.new(__MODULE__)
      @delimit_field_types %{}

      Module.register_attribute(__MODULE__, :delimit_field_types, accumulate: false)

      @before_compile Delimit
    end
  end

  @doc """
  Defines the layout of a delimited file.

  ## Example

      layout do
        field :first_name, :string
        field :last_name, :string
        field :age, :integer
      end
  """
  defmacro layout(do: block) do
    quote do
      import Delimit, only: []
      import Delimit, only: [field: 2, field: 3, embeds_one: 2, embeds_one: 3]

      unquote(block)
    end
  end

  @doc """
  Defines a field in the schema.

  ## Parameters

    * `name` - The name of the field as atom
    * `type` - The data type of the field (:string, :integer, :float, etc.)

  ## Example

      field :first_name, :string
  """
  defmacro field(name, type) do
    quote do
      @delimit_schema Delimit.Schema.add_field(@delimit_schema, unquote(name), unquote(type))
      @delimit_field_types Map.put(
                             @delimit_field_types,
                             unquote(name),
                             Delimit.Schema.type_to_typespec(unquote(type))
                           )
    end
  end

  @doc """
  Defines a field in the schema with options.

  ## Parameters

    * `name` - The name of the field as atom
    * `type` - The data type of the field (:string, :integer, :float, etc.)
    * `opts` - Options for the field

  ## Options

    * `:format` - Format string for date/time fields
    * `:default` - Default value if the field is missing
    * `:nil_on_empty` - If true, empty strings become nil (default: true)
    * `:true_values` - List of values to interpret as true for boolean fields
    * `:false_values` - List of values to interpret as false for boolean fields
    * `:read_fn` - Custom function to parse the raw field value
    * `:write_fn` - Custom function to convert the field value to string
    * `:label` - Custom header label for this field (instead of the field name)
    * `:struct_type` - The type to use in the struct (different from file type)

  ## Example

      field :birthday, :date, format: "YYYY-MM-DD"
      field :active, :boolean, true_values: ["Y", "YES"], false_values: ["N", "NO"]
      field :email, :string, label: "contact_email"
      field :tags, :string, read_fn: &split_tags/1, write_fn: &join_tags/1, struct_type: {:list, :string}
  """
  defmacro field(name, type, opts) do
    quote do
      @delimit_schema Delimit.Schema.add_field(
                        @delimit_schema,
                        unquote(name),
                        unquote(type),
                        unquote(opts)
                      )

      # Get the proper type for the struct field
      field_type =
        if Keyword.has_key?(unquote(opts), :struct_type) do
          struct_type = Keyword.get(unquote(opts), :struct_type)
          Delimit.Schema.type_to_typespec(struct_type)
        else
          Delimit.Schema.type_to_typespec(unquote(type))
        end

      @delimit_field_types Map.put(@delimit_field_types, unquote(name), field_type)
    end
  end

  @doc """
  Defines an embedded schema.

  ## Parameters

    * `name` - The name for the embedded schema
    * `module` - The module defining the embedded schema

  ## Example

      embeds_one :address, MyApp.Address
      embeds_one :billing_address, MyApp.Address, prefix: "billing"
  """
  defmacro embeds_one(name, module) do
    quote do
      @delimit_schema Delimit.Schema.add_embed(@delimit_schema, unquote(name), unquote(module))
    end
  end

  @doc """
  Defines an embedded schema with options.

  ## Parameters

    * `name` - The name for the embedded schema
    * `module` - The module defining the embedded schema
    * `opts` - Options for the embedded schema

  ## Options

    * `:prefix` - Prefix to add to field headers (default: field name + "_")

  ## Example

      embeds_one :address, MyApp.Address, prefix: "addr_"
  """
  defmacro embeds_one(name, module, opts) do
    quote do
      @delimit_schema Delimit.Schema.add_embed(
                        @delimit_schema,
                        unquote(name),
                        unquote(module),
                        unquote(opts)
                      )
    end
  end

  @doc false
  defmacro __before_compile__(env) do
    module = env.module
    schema = Module.get_attribute(module, :delimit_schema)
    field_types = Module.get_attribute(module, :delimit_field_types)

    # Ensure we have a valid schema and field_types
    if is_nil(schema) or !is_map(schema) do
      raise "Invalid schema found in module #{module}"
    end

    # Extract field information for struct and type definitions
    fields =
      schema.fields
      |> Enum.filter(fn field -> field.type != :embed end)
      |> Enum.map(fn field ->
        default_value = field.opts[:default]
        {field.name, default_value}
      end)

    # Create type specs for each field
    field_type_specs =
      Enum.map(fields, fn {field_name, _default} ->
        type_spec = Map.get(field_types, field_name, quote(do: any()))
        {field_name, type_spec}
      end)

    # Get the module doc or default - ensure it's a string to avoid protocol errors
    module_doc =
      case Module.get_attribute(module, :moduledoc) do
        nil -> "Generated struct for delimited data."
        false -> false
        doc when is_binary(doc) -> doc
        _other -> "Generated struct for delimited data."
      end

    # Use simple docs to avoid String.Chars protocol errors with complex types
    complete_doc = module_doc
    complete_typedoc = "Struct representing a record in a delimited file."

    quote do
      @moduledoc unquote(complete_doc)

      # Define struct for this module
      defstruct(unquote(Macro.escape(fields)))

      # Define type for this struct
      @typedoc unquote(complete_typedoc)
      @type t :: %__MODULE__{
              unquote_splicing(field_type_specs)
            }

      # Store the schema in a module attribute accessible at runtime
      def __delimit_schema__ do
        @delimit_schema
      end

      @doc """
      Reads delimited data from a file.

      ## Parameters

        * `path` - Path to the delimited file
        * `opts` - Options for reading (headers, delimiter, escape, etc.)

      ## Returns

        * List of structs with parsed data based on schema

      ## Examples

          iex> MyApp.Person.read("people.csv")
          [%MyApp.Person{first_name: "John", last_name: "Doe", age: 42}, ...]
      
          iex> MyApp.Person.read("people.tsv", format: :tsv)
          [%MyApp.Person{first_name: "John", last_name: "Doe", age: 42}, ...]
      """
      @spec read(Path.t(), Keyword.t()) :: [t()]
      def read(path, opts \\ []) do
        Delimit.Reader.read_file(__delimit_schema__(), path, opts)
      end

      @doc """
      Reads delimited data from a string.

      ## Parameters

        * `string` - String containing delimited data
        * `opts` - Options for reading (headers, delimiter, escape, etc.)

      ## Returns

        * List of structs with parsed data based on schema

      ## Examples

          iex> csv = "first_name,last_name\\nJohn,Doe"
          iex> MyApp.Person.read_string(csv)
          [%MyApp.Person{first_name: "John", last_name: "Doe"}]
      """
      @spec read_string(binary(), Keyword.t()) :: [t()]
      def read_string(string, opts \\ []) do
        Delimit.Reader.read_string(__delimit_schema__(), string, opts)
      end

      @doc """
      Streams delimited data from a file.

      ## Parameters

        * `path` - Path to the delimited file
        * `opts` - Options for reading (headers, delimiter, escape, etc.)

      ## Returns

        * Stream of structs with parsed data based on schema

      ## Examples

          iex> MyApp.Person.stream("large_file.csv")
          iex> |> Stream.take(10)
          iex> |> Enum.to_list()
          [%MyApp.Person{first_name: "John", last_name: "Doe"}, ...]
      """
      @spec stream(Path.t(), Keyword.t()) :: Enumerable.t()
      def stream(path, opts \\ []) do
        Delimit.Reader.stream_file(__delimit_schema__(), path, opts)
      end

      @doc """
      Writes delimited data to a file.

      ## Parameters

        * `path` - Path to the output file
        * `data` - List of structs to write
        * `opts` - Options for writing (headers, delimiter, escape, line_ending, etc.)

      ## Returns

        * `:ok` on success

      ## Examples

          iex> people = [%MyApp.Person{first_name: "John", last_name: "Doe"}]
          iex> MyApp.Person.write("people.csv", people)
          :ok
      
          iex> people = [%MyApp.Person{first_name: "John", last_name: "Doe"}]
          iex> MyApp.Person.write("people.psv", people, format: :psv)
          :ok
      """
      @spec write(Path.t(), [t()], Keyword.t()) :: :ok
      def write(path, data, opts \\ []) do
        Delimit.Writer.write_file(__delimit_schema__(), path, data, opts)
      end

      @doc """
      Writes delimited data to a string.

      ## Parameters

        * `data` - List of structs to write
        * `opts` - Options for writing (headers, delimiter, escape, line_ending, etc.)

      ## Returns

        * String containing the delimited data

      ## Examples

          iex> people = [%MyApp.Person{first_name: "John", last_name: "Doe"}]
          iex> MyApp.Person.write_string(people)
          "first_name,last_name\\nJohn,Doe\\n"
      """
      @spec write_string([t()], Keyword.t()) :: binary()
      def write_string(data, opts \\ []) do
        Delimit.Writer.write_string(__delimit_schema__(), data, opts)
      end

      @doc """
      Streams delimited data to a file.

      ## Parameters

        * `path` - Path to the output file
        * `data_stream` - Stream of structs to write
        * `opts` - Options for writing (headers, delimiter, escape, line_ending, etc.)

      ## Returns

        * `:ok` on success

      ## Examples

          iex> stream = Stream.map(1..100, &(%MyApp.Person{first_name: "User \#{&1}"}))
          iex> MyApp.Person.stream_to_file("people.csv", stream)
          :ok
      """
      @spec stream_to_file(Path.t(), Enumerable.t(), Keyword.t()) :: :ok
      def stream_to_file(path, data_stream, opts \\ []) do
        Delimit.Writer.stream_to_file(__delimit_schema__(), path, data_stream, opts)
      end
    end
  end
end