alembic

defmodule Alembic.Mixfile do
  use Mix.Project

  # Functions

  # Configuration for the OTP application
  #
  # Type "mix help compile.app" for more information
  def application do
    [applications: [:logger, :poison]]
  end

  def project do
    [
      app: :alembic,
      build_embedded: Mix.env == :prod,
      description: description(),
      deps: deps(),
      docs: docs(),
      elixir: "~> 1.2",
      elixirc_paths: elixirc_paths(Mix.env),
      name: "Alembic",
      package: package(),
      preferred_cli_env: [
        "coveralls": :test,
        "coveralls.circle": :test,
        "coveralls.detail": :test,
        "coveralls.html": :test,
        "coveralls.post": :test
      ],
      source_url: "https://github.com/C-S-D/alembic",
      start_permanent: Mix.env == :prod,
      test_coverage: [tool: ExCoveralls],
      version: "3.2.0"
    ]
  end

  ## Private Functions

  # Dependencies can be Hex packages:
  #
  #   {:mydep, "~> 0.3.0"}
  #
  # Or git/path repositories:
  #
  #   {:mydep, git: "https://github.com/elixir-lang/mydep.git", tag: "0.1.0"}
  #
  # Type "mix help deps" for more examples and options
  defp deps do
    [
      # static code analysis for style and consistency
      {:credo, "~> 0.7.3", only: [:dev, :test]},
      # success type checker: ensures @type and @spec are valid
      {:dialyze, "~> 0.2.1", only: [:dev, :test]},
      # markdown to HTML converter for ex_doc
      {:earmark, "~> 1.0", only: [:dev, :test]},
      # conversion to Ecto.Schema struct
      {:ecto, "~> 2.0"},
      # test coverge tool.  Allow `--cover` option for `mix test`
      {:excoveralls, "~> 0.6.3", only: :test},
      # documentation generation
      {:ex_doc, "~> 0.15.1", only: [:dev, :test]},
      # documentation coverage
      {:inch_ex, "~> 0.5.1", only: [:dev, :test]},
      # formats test output for CircleCI
      {:junit_formatter, "~> 1.0", only: :test},
      # JSON decode and encoding.  Protocols are implemented for Alembic.* structs
      {:poison, "~> 1.5 or ~> 2.0 or ~> 3.0"}
    ]
  end

  defp description do
    """
    A JSONAPI 1.0 library fully-tested against all jsonapi.org examples.  The library generates JSONAPI errors documents
    whenever it encounters a malformed JSONAPI document, so that servers don't need to worry about JSONAPI format
    errors.
    """
  end

  defp docs do
    [
      extras: extras()
    ]
  end

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

  defp extras do
    [
      "CHANGELOG.md",
      "CODE_OF_CONDUCT.md",
      "CONTRIBUTING.md",
      "LICENSE.md",
      "README.md",
      "UPGRADING.md"
    ]
  end

  defp package do
    [
      files: ["lib", "mix.exs" | extras()],
      licenses: ["Apache 2.0"],
      links: %{
        "Docs" => "https://hexdocs.pm/alembic",
        "Github" => "https://github.com/C-S-D/alembic",
      },
      maintainers: ["Luke Imhoff"]
    ]
  end
end