nebulex

defmodule Nebulex.MixProject do
  use Mix.Project

  @source_url "https://github.com/elixir-nebulex/nebulex"
  @version "3.0.2"

  def project do
    [
      app: :nebulex,
      version: @version,
      elixir: "~> 1.12",
      elixirc_paths: elixirc_paths(Mix.env()),
      aliases: aliases(),
      deps: deps(),

      # Testing
      test_coverage: [tool: ExCoveralls, export: "test-coverage"],
      test_ignore_filters: [~r{test/(shared|support)/.*\.exs}],

      # Dialyzer
      dialyzer: dialyzer(),

      # Hex
      description: "In-memory and distributed caching toolkit for Elixir",
      package: package(),

      # Docs
      name: "Nebulex",
      docs: docs()
    ]
  end

  defp elixirc_paths(:test), do: ["lib", "test/dialyzer"]
  defp elixirc_paths(_), do: ["lib"]

  def cli do
    [
      preferred_envs: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.post": :test,
        "coveralls.html": :test,
        "coveralls.json": :test,
        "test.ci": :test
      ]
    ]
  end

  def application do
    [
      extra_applications: [:eex],
      mod: {Nebulex.Application, []}
    ]
  end

  defp deps do
    [
      # Required
      {:nimble_options, "~> 0.5 or ~> 1.0"},

      # Optional
      {:decorator, "~> 1.4", optional: true},
      {:telemetry, "~> 0.4 or ~> 1.0", optional: true},

      # Test & Code Analysis
      {:excoveralls, "~> 0.18", only: :test},
      {:credo, "~> 1.7", only: [:dev, :test], runtime: false},
      {:dialyxir, "~> 1.4", only: [:dev, :test], runtime: false},
      {:sobelow, "~> 0.14", only: [:dev, :test], runtime: false},
      {:stream_data, "~> 1.2", only: [:dev, :test]},
      {:mimic, "~> 2.3", only: :test},
      {:doctor, "~> 0.22", only: [:dev, :test]},

      # Benchmark Test
      {:benchee, "~> 1.5", only: [:dev, :test]},
      {:benchee_html, "~> 1.0", only: [:dev, :test]},

      # Docs
      {:ex_doc, "~> 0.40", only: [:dev, :test], runtime: false},
      {:makeup_diff, "~> 0.1", only: [:dev, :test], runtime: false}
    ]
  end

  defp aliases do
    [
      bench: "run benchmarks/benchmark.exs",
      "test.ci": [
        "deps.unlock --check-unused",
        "compile --warnings-as-errors",
        "format --check-formatted",
        "credo --strict",
        "coveralls.html",
        "sobelow --skip --exit Low",
        "dialyzer --format short",
        "doctor"
      ]
    ]
  end

  defp package do
    [
      name: :nebulex,
      maintainers: ["Carlos Bolanos"],
      licenses: ["MIT"],
      links: %{
        "Changelog" => "#{@source_url}/blob/master/CHANGELOG.md",
        "GitHub" => @source_url
      },
      files: ~w(lib usage-rules .formatter.exs mix.exs README* CHANGELOG* LICENSE* CONTRIBUTING*)
    ]
  end

  defp docs do
    [
      main: "Nebulex",
      source_ref: "v#{@version}",
      canonical: "https://hexdocs.pm/nebulex",
      source_url: @source_url,
      extra_section: "GUIDES",
      extras: extras(),
      groups_for_extras: groups_for_extras(),
      groups_for_docs: [
        # Caching decorators
        group_for_function("Decorator API"),
        group_for_function("Decorator Helpers"),
        group_for_function("Decorator Advanced Functions"),

        # Cache API
        group_for_function("User callbacks"),
        group_for_function("Runtime API"),
        group_for_function("KV API"),
        group_for_function("Query API"),
        group_for_function("Transaction API"),
        group_for_function("Info API"),
        group_for_function("Observable API")
      ],
      groups_for_modules: [
        # Nebulex,
        # Nebulex.Cache,
        # Nebulex.Event,
        # Nebulex.Event.CacheEntryEvent,

        "Caching decorators": [
          Nebulex.Caching,
          Nebulex.Caching.Decorators,
          Nebulex.Caching.Decorators.Context
        ],
        "Adapter specification": [
          Nebulex.Adapter,
          Nebulex.Adapter.KV,
          Nebulex.Adapter.Queryable,
          Nebulex.Adapter.Transaction,
          Nebulex.Adapter.Info,
          Nebulex.Adapter.Observable
        ],
        "Built-in adapters": [
          Nebulex.Adapters.Nil
        ],
        "Built-in info implementation": [
          Nebulex.Adapters.Common.Info,
          Nebulex.Adapters.Common.Info.Stats
        ],
        "Telemetry handlers": [
          Nebulex.Telemetry.CacheEntryHandler,
          Nebulex.Telemetry.CacheStatsCounterHandler
        ],
        Utilities: [
          Nebulex.Telemetry,
          Nebulex.Time,
          Nebulex.Utils
        ]
      ]
    ]
  end

  defp extras do
    [
      # Introduction
      "guides/introduction/getting-started.md",
      "guides/introduction/nbx-adapters.md",

      # Learning
      "guides/learning/cache-usage-patterns.md",
      "guides/learning/declarative-caching.md",
      "guides/learning/info-api.md",
      "guides/learning/creating-new-adapter.md",

      # Upgrading
      "guides/upgrading/v3.0.md"
    ]
  end

  defp groups_for_extras do
    [
      Introduction: ~r{guides/introduction/[^\/]+\.md},
      Learning: ~r{guides/learning/[^\/]+\.md},
      Upgrading: ~r{guides/upgrading/.*}
    ]
  end

  defp group_for_function(group), do: {String.to_atom(group), &(&1[:group] == group)}

  defp dialyzer do
    [
      plt_add_apps: [:mix, :telemetry, :ex_unit],
      plt_file: {:no_warn, "priv/plts/" <> plt_file_name()},
      flags: [
        :unmatched_returns,
        :error_handling,
        :extra_return,
        :no_opaque,
        :no_return
      ]
    ]
  end

  defp plt_file_name do
    "dialyzer-#{Mix.env()}-Elixir-#{System.version()}-OTP-#{System.otp_release()}.plt"
  end
end