mobilizon/mix.exs

defmodule Mobilizon.Mixfile do
  use Mix.Project

  @version "0.0.1-dev"

  def project do
    [
      app: :mobilizon,
      version: @version,
      elixir: "~> 1.4",
      elixirc_paths: elixirc_paths(Mix.env()),
      compilers: [:phoenix, :gettext] ++ Mix.compilers(),
      start_permanent: Mix.env() == :prod,
      aliases: aliases(),
      deps: deps(),
      test_coverage: [tool: ExCoveralls],
      preferred_cli_env: [
        coveralls: :test,
        "coveralls.detail": :test,
        "coveralls.post": :test,
        "coveralls.html": :test,
        vcr: :test,
        "vcr.delete": :test,
        "vcr.check": :test,
        "vcr.show": :test
      ],
      name: "Mobilizon",
      source_url: "https://framagit.org/tcit/mobilizon",
      homepage_url: "https://framagit.org/tcit/mobilizon",
      docs: docs()
    ]
  end

  # Configuration for the OTP application.
  #
  # Type `mix help compile.app` for more information.
  def application do
    [
      mod: {Mobilizon.Application, []},
      extra_applications: [:logger, :runtime_tools, :guardian, :bamboo, :geolix, :crypto, :cachex]
    ]
  end

  # Specifies which paths to compile per environment.
  defp elixirc_paths(:test), do: ["lib", "test/support"]
  defp elixirc_paths(:dev), do: ["lib", "test/support/factory.ex"]
  defp elixirc_paths(_), do: ["lib"]

  # Specifies your project dependencies.
  #
  # Type `mix help deps` for examples and options.
  defp deps do
    [
      {:phoenix, "~> 1.4.0"},
      {:phoenix_pubsub, "~> 1.0"},
      {:phoenix_ecto, "~> 4.0"},
      {:postgrex, ">= 0.0.0"},
      {:phoenix_html, "~> 2.10"},
      {:gettext, "~> 0.11"},
      {:cowboy, "~> 2.6"},
      {:guardian, "~> 1.2"},
      {:guardian_db, "~> 2.0"},
      {:argon2_elixir, "~> 2.0"},
      {:cors_plug, "~> 2.0"},
      {:ecto_autoslug_field, "~> 1.0"},
      {:rsa_ex, "~> 0.1"},
      {:geo, "~> 3.0"},
      {:geo_postgis, "~> 3.1"},
      {:timex, "~> 3.0"},
      {:icalendar, github: "tcitworld/icalendar"},
      {:exgravatar, "~> 2.0.1"},
      {:httpoison, "~> 1.0"},
      {:json_ld, "~> 0.3"},
      {:jason, "~> 1.1"},
      {:ex_crypto, "~> 0.10.0"},
      {:http_sign, "~> 0.1.1"},
      {:ecto_enum, "~> 1.0"},
      {:ex_ical, "~> 0.2"},
      {:bamboo, "~> 1.0"},
      {:bamboo_smtp, "~> 1.6.0"},
      {:geolix, "~> 0.16"},
      {:absinthe, "~> 1.4.16"},
      {:absinthe_phoenix, "~> 1.4.0"},
      {:absinthe_plug, "~> 1.4.6"},
      {:absinthe_ecto, "~> 0.1.3"},
      {:dataloader, "~> 1.0.6"},
      {:arc, "~> 0.11.0"},
      {:arc_ecto, "~> 0.11.0"},
      {:plug_cowboy, "~> 2.0"},
      {:atomex, "0.3.0"},
      {:cachex, "~> 3.1"},
      {:earmark, "~> 1.3.1"},
      {:geohax, "~> 0.3.0"},
      # Dev and test dependencies
      {:phoenix_live_reload, "~> 1.2", only: :dev},
      {:ex_machina, "~> 2.3", only: [:dev, :test]},
      {:excoveralls, "~> 0.10", only: :test},
      {:ex_doc, "~> 0.16", only: [:dev, :test], runtime: false},
      {:mix_test_watch, "~> 0.5", only: :dev, runtime: false},
      {:ex_unit_notifier, "~> 0.1", only: :test},
      {:dialyxir, "~> 1.0.0-rc.4", only: [:dev], runtime: false},
      {:exvcr, "~> 0.10", only: :test},
      {:credo, "~> 1.0.0", only: [:dev, :test], runtime: false},
      {:mock, "~> 0.3.0", only: :test},
      {:elixir_feed_parser, "~> 2.1.0", only: :test}
    ]
  end

  # Aliases are shortcuts or tasks specific to the current project.
  # For example, to create, migrate and run the seeds file at once:
  #
  #     $ mix ecto.setup
  #
  # See the documentation for `Mix` for more info on aliases.
  defp aliases do
    [
      "ecto.setup": ["ecto.create", "ecto.migrate", "run priv/repo/seeds.exs"],
      "ecto.reset": ["ecto.drop", "ecto.setup"],
      test: ["ecto.create --quiet", "ecto.migrate", "test"]
    ]
  end

  defp docs() do
    [
      source_ref: "v#{@version}",
      extra_section: "GUIDES",
      main: "introduction",
      api_reference: false,
      groups_for_modules: groups_for_modules(),
      extras: extras(),
      groups_for_extras: groups_for_extras(),
      nest_modules_by_prefix: [
        Mobilizon,
        MobilizonWeb,
        Mobilizon.Service.Geospatial,
        MobilizonWeb.Resolvers,
        MobilizonWeb.Schema,
        Mobilizon.Service
      ]
    ]
  end

  defp extras() do
    [
      "support/guides/development/development.md",
      "support/guides/development/tests.md",
      "support/guides/development/styleguide.md",
      "support/guides/install/install.md",
      "support/guides/install/dependencies.md",
      "support/guides/install/docker.md",
      "support/guides/introduction.md",
      "support/guides/contributing.md",
      "support/guides/code_of_conduct.md"
    ]
  end

  defp groups_for_modules() do
    [
      Models: [
        Mobilizon.Actors,
        Mobilizon.Actors.Actor,
        Mobilizon.Actors.ActorOpennessEnum,
        Mobilizon.Actors.ActorTypeEnum,
        Mobilizon.Actors.MemberRoleEnum,
        Mobilizon.Actors.Bot,
        Mobilizon.Actors.Follower,
        Mobilizon.Actors.Member,
        Mobilizon.Addresses,
        Mobilizon.Addresses.Address,
        Mobilizon.Events,
        Mobilizon.Events.Event,
        Mobilizon.Events.Comment,
        Mobilizon.Events.FeedToken,
        Mobilizon.Events.Participant,
        Mobilizon.Events.Session,
        Mobilizon.Events.Tag,
        Mobilizon.Events.TagRelations,
        Mobilizon.Events.Track,
        Mobilizon.Event.EventCategoryEnum,
        Mobilizon.Events.CommentVisibilityEnum,
        Mobilizon.Events.EventStatusEnum,
        Mobilizon.Events.EventVisibilityEnum,
        Mobilizon.Events.JoinOptionsEnum,
        Mobilizon.Events.ParticipantRoleEnum,
        Mobilizon.Events.Tag.TitleSlug,
        Mobilizon.Events.Tag.TitleSlug.Type,
        Mobilizon.Events.TagRelation,
        Mobilizon.Users,
        Mobilizon.Users.User,
        Mobilizon.Users.UserRoleEnum,
        Mobilizon.Users.Guards,
        Mobilizon.Activity,
        Mobilizon.Ecto,
        Mobilizon.Repo
      ],
      APIs: [
        MobilizonWeb.API.Comments,
        MobilizonWeb.API.Events,
        MobilizonWeb.API.Groups,
        MobilizonWeb.API.Search,
        MobilizonWeb.API.Utils
      ],
      Web: [
        MobilizonWeb,
        MobilizonWeb.PageView,
        MobilizonWeb.Router,
        MobilizonWeb.Router.Helpers,
        MobilizonWeb.AuthErrorHandler,
        MobilizonWeb.AuthPipeline,
        MobilizonWeb.ChangesetView,
        MobilizonWeb.Context,
        MobilizonWeb.Endpoint,
        MobilizonWeb.ErrorHelpers,
        MobilizonWeb.ErrorView,
        MobilizonWeb.FallbackController,
        MobilizonWeb.FeedController,
        MobilizonWeb.Gettext,
        MobilizonWeb.Guardian,
        MobilizonWeb.Guardian.Plug,
        MobilizonWeb.JsonLD.ObjectView,
        MobilizonWeb.PageController,
        MobilizonWeb.UploadPlug,
        MobilizonWeb.Uploaders.Avatar,
        MobilizonWeb.Uploaders.Category,
        MobilizonWeb.Uploaders.Category.Type
      ],
      Geospatial: [
        Mobilizon.Service.Geospatial,
        Mobilizon.Service.Geospatial.Addok,
        Mobilizon.Service.Geospatial.GoogleMaps,
        Mobilizon.Service.Geospatial.MapQuest,
        Mobilizon.Service.Geospatial.Nominatim,
        Mobilizon.Service.Geospatial.Photon,
        Mobilizon.Service.Geospatial.Provider
      ],
      GraphQL: [
        MobilizonWeb.Resolvers.Address,
        MobilizonWeb.Resolvers.Comment,
        MobilizonWeb.Resolvers.Event,
        MobilizonWeb.Resolvers.FeedToken,
        MobilizonWeb.Resolvers.Group,
        MobilizonWeb.Resolvers.Person,
        MobilizonWeb.Resolvers.Search,
        MobilizonWeb.Resolvers.Tag,
        MobilizonWeb.Resolvers.User,
        MobilizonWeb.Schema,
        MobilizonWeb.Schema.ActorInterface,
        MobilizonWeb.Schema.Actors.FollowerType,
        MobilizonWeb.Schema.Actors.GroupType,
        MobilizonWeb.Schema.Actors.MemberType,
        MobilizonWeb.Schema.Actors.PersonType,
        MobilizonWeb.Schema.AddressType,
        MobilizonWeb.Schema.CommentType,
        MobilizonWeb.Schema.Custom.Point,
        MobilizonWeb.Schema.Custom.UUID,
        MobilizonWeb.Schema.EventType,
        MobilizonWeb.Schema.Events.FeedTokenType,
        MobilizonWeb.Schema.Events.ParticipantType,
        MobilizonWeb.Schema.SortType,
        MobilizonWeb.Schema.TagType,
        MobilizonWeb.Schema.UserType,
        MobilizonWeb.Schema.Utils
      ],
      ActivityPub: [
        MobilizonWeb.ActivityPub.ActorView,
        MobilizonWeb.ActivityPub.ObjectView,
        MobilizonWeb.ActivityPubController,
        Mobilizon.Service.ActivityPub,
        Mobilizon.Service.ActivityPub.Transmogrifier,
        Mobilizon.Service.ActivityPub.Utils,
        MobilizonWeb.HTTPSignaturePlug,
        MobilizonWeb.WebFingerController,
        MobilizonWeb.NodeInfoController,
        Mobilizon.Service.HTTPSignatures,
        Mobilizon.Service.WebFinger,
        Mobilizon.Service.XmlBuilder,
        Mobilizon.Service.Federator
      ],
      Services: [
        Mobilizon.Service.EmailChecker,
        Mobilizon.Service.Export.Feed,
        Mobilizon.Service.Export.ICalendar,
        Mobilizon.Service.Metadata,
        Mobilizon.Service.Formatter,
        Mobilizon.Service.Users.Tools
      ],
      Tools: [
        Mobilizon.Application,
        Mobilizon.Factory,
        Mobilizon.Mailer,
        Mobilizon.EmailView,
        Mobilizon.Email.User
      ]
    ]
  end

  defp groups_for_extras() do
    [
      Introduction: [
        "support/guides/introduction.md",
        "support/guides/contributing.md",
        "support/guides/code_of_conduct.md"
      ],
      Development: [
        "support/guides/development/development.md",
        "support/guides/development/tests.md",
        "support/guides/development/styleguide.md"
      ],
      Production: [
        "support/guides/install/install.md",
        "support/guides/install/docker.md",
        "support/guides/install/dependencies.md"
      ]
    ]
  end
end