mix.exs

defmodule Hawk.MixProject do
  use Mix.Project

  @version "0.9.0"
  @source_url "https://github.com/Raphexion/hawk"
  @description "Opinionated Phoenix foundation for policy-safe resources across LiveView and JSON:API"

  def project do
    [
      app: :hawk,
      version: @version,
      description: @description,
      elixir: "~> 1.20",
      elixirc_paths: elixirc_paths(Mix.env()),
      start_permanent: Mix.env() == :prod,
      deps: deps(),
      dialyzer: dialyzer(),
      aliases: aliases(),
      test_coverage: test_coverage(),
      docs: docs(),
      package: package()
    ]
  end

  defp package do
    [
      licenses: ["MIT"],
      links: %{"GitHub" => @source_url},
      files: [
        "lib",
        "mix.exs",
        "README.md",
        "guides",
        "LICENSE",
        "CHANGELOG.md",
        ".formatter.exs"
      ]
    ]
  end

  defp docs do
    [
      main: "Hawk",
      source_url: @source_url,
      extras: ["guides/preserves-roots.md"],
      groups_for_modules: [
        "Resource facade": [Hawk.Resource],
        "DSL modules": [
          Hawk.Model,
          Hawk.Reader.Resource,
          Hawk.Reader.FilterSet,
          Hawk.Writer.Resource,
          Hawk.Policy,
          Hawk.Actions,
          Hawk.Query,
          Hawk.JsonApi.Resource,
          Hawk.LiveView.Resource
        ],
        "Adapters & rendering": [
          Hawk.JsonApi.Controller,
          Hawk.JsonApi.Router,
          Hawk.JsonApi.Routes,
          Hawk.JsonApi.Document,
          Hawk.JsonApi.Request,
          Hawk.JsonApi.Schema,
          Hawk.LiveView,
          Hawk.LiveView.Page,
          Hawk.LiveView.AuthorityHook,
          Hawk.OpenApi,
          Hawk.OpenApi.Controller
        ],
        "Runtime values": [
          Hawk.Authority,
          Hawk.Authority.Plug,
          Hawk.Authority.Session,
          Hawk.PhoenixAuth,
          Hawk.MutationContext,
          Hawk.RepositoryBoundary,
          Hawk.Result,
          Hawk.Error,
          Hawk.Errors,
          Hawk.Filter,
          Hawk.Reader.Coordinates
        ],
        "Real-time": [
          Hawk.PubSub,
          Hawk.PubSub.Event,
          Hawk.PubSub.TopicStrategy,
          Hawk.PubSub.DefaultTopics
        ],
        Plans: [Hawk.Plan, Hawk.Plans, Hawk.Plans.Registry, Hawk.Plans.Spec, Hawk.Multi],
        "Validation & contracts": [
          Hawk.Resource.Validation,
          Hawk.Resource.Convention,
          Hawk.Query.Validation,
          Hawk.ResourceContract
        ],
        "Test helpers": [
          Hawk.ResourceContractCase,
          Hawk.JsonApiControllerCase,
          Hawk.Policy.Assertions
        ],
        "Mix tasks": [
          Mix.Tasks.Hawk.Gen.Resource,
          Mix.Tasks.Hawk.Validate,
          Mix.Tasks.Hawk.Openapi,
          Mix.Tasks.Hawk.Plans.Spec
        ]
      ]
    ]
  end

  def cli do
    [
      preferred_envs: [
        "ecto.create": :test,
        "ecto.drop": :test,
        "ecto.migrate": :test,
        "ecto.rollback": :test,
        "ecto.setup": :test,
        "ecto.reset": :test
      ]
    ]
  end

  # Run "mix help compile.app" to learn about applications.
  def application do
    [
      extra_applications: [:logger]
    ]
  end

  defp deps do
    [
      # Hawk provides reusable Ecto/PostgreSQL infrastructure, but host
      # applications own their concrete Repo modules and database config.
      {:ecto, ">= 3.5.0 and < 4.0.0"},
      {:ecto_sql, ">= 3.5.0 and < 4.0.0"},
      {:postgrex, ">= 0.15.0 and < 1.0.0"},
      # Optional: coordinate filters target PostGIS geography(Point, 4326)
      # columns. Host applications opt in by depending on geo_postgis too.
      {:geo_postgis, "~> 3.7", optional: true},
      {:telemetry, "~> 1.0"},
      # Phoenix is a required dependency: Hawk generates JSON:API controllers and
      # LiveView helpers that call Phoenix/Plug directly. Host applications still
      # own their Repo, authentication, and supervision tree.
      {:phoenix, "~> 1.7"},
      {:phoenix_live_view, "~> 1.0"},
      {:phoenix_ecto, "~> 4.0"},
      {:phoenix_pubsub, "~> 2.1"},
      {:jason, "~> 1.4"},
      # Test factories
      {:ex_machina, "~> 2.8", only: :test},
      # Code quality
      {:dialyxir, "~> 1.3", only: [:dev, :test], runtime: false},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      # Documentation
      {:ex_doc, "~> 0.40", only: :docs, runtime: false}
    ]
  end

  defp elixirc_paths(:test), do: ["lib", "test/videdal", "test/support"]
  defp elixirc_paths(_env), do: ["lib"]

  defp aliases do
    [
      "ecto.setup": ["ecto.create --quiet", "ecto.migrate --quiet"],
      "ecto.reset": ["ecto.drop --quiet", "ecto.setup"],
      # `mix test` is the complete local gate: validate every Hawk resource's
      # contract, then run the full suite.
      test: ["hawk.validate", "test"]
    ]
  end

  defp test_coverage do
    [
      summary: [threshold: 85],
      # Cover only the Hawk library itself. The Videdal example app and the
      # Hawk.Test* helpers are compiled under `elixirc_paths(:test)` to
      # exercise Hawk, but they are test fixtures, not shipped code.
      ignore_modules: [~r/^Videdal\b/, Hawk.TestConn, Hawk.TestSocket]
    ]
  end

  defp dialyzer do
    [
      plt_add_apps: [:ex_unit, :mix],
      ignore_warnings: "dialyzer_ignore.exs",
      list_unused_filters: true,
      plt_local_path: "priv/plts/project.plt",
      plt_core_path: "priv/plts/core.plt"
    ]
  end
end