Add :archives option to Mix.Project

Author: José Valim

lib/mix/lib/mix/tasks/app.start.ex

@@ -21,6 +21,7 @@ defmodule Mix.Tasks.App.Start do
     * `--permanent` - start the application as permanent
     * `--no-compile` - do not compile even if files require compilation
     * `--no-protocols` - do not load consolidated protocols
+    * `--no-archives-check` - do not check archives
     * `--no-deps-check` - do not check dependencies
     * `--no-elixir-version-check` - do not check Elixir version
     * `--no-start` - do not start applications after compilation

lib/mix/lib/mix/tasks/archive.check.ex

@@ -0,0 +1,55 @@
+defmodule Mix.Tasks.Archive.Check do
+  use Mix.Task
+
+  @moduledoc """
+  Checks all archives are available.
+
+  Mix projects can specify required archives using
+  the `:archives` option:
+
+      archives: [{:foo, "~> 1.0.0"}]
+
+  This task guarantees this option is respected.
+  """
+  def run(_) do
+    archives = Mix.Project.config[:archives] || []
+
+    Enum.each archives, fn tuple ->
+      {archive, req} = parse_archive(tuple)
+      _   = Application.load(archive)
+      vsn = Application.spec(archive, :vsn)
+      cond do
+        is_nil(vsn) ->
+          Mix.raise "Archive \"#{archive}\" could not be found. " <>
+                    "Please make sure the archive is installed locally."
+        not Version.match?(List.to_string(vsn), req) ->
+          Mix.raise "Archive \"#{archive}-#{vsn}\" does not match requirement #{req}. " <>
+                    "Please update your archive version accordingly."
+        true ->
+          :ok
+      end
+    end
+  end
+
+  defp parse_archive({archive, req}) when is_atom(archive) and is_binary(req) do
+    case Version.parse_requirement(req) do
+      {:ok, req} ->
+        {archive, req}
+      :error ->
+        Mix.raise "Invalid requirement #{req} for archive \"#{archive}\""
+    end
+  end
+
+  defp parse_archive(other) do
+    Mix.raise """
+    Expected archive to be in the format:
+
+        {app :: atom, requirement :: binary}
+
+    got:
+
+        #{inspect other}
+
+    """
+  end
+end

lib/mix/lib/mix/tasks/clean.ex

@@ -47,7 +47,7 @@ defmodule Mix.Tasks.Clean do
 
   # Loadpaths without checks because compilers may be defined in deps.
   defp loadpaths! do
-    Mix.Task.run "loadpaths", ["--no-elixir-version-check", "--no-deps-check"]
+    Mix.Task.run "loadpaths", ["--no-elixir-version-check", "--no-deps-check", "--no-archives-check"]
     Mix.Task.reenable "loadpaths"
   end
 end

lib/mix/lib/mix/tasks/compile.ex

@@ -41,9 +41,10 @@ defmodule Mix.Tasks.Compile do
 
   ## Command line options
 
-    * `--list`          - list all enabled compilers
-    * `--no-deps-check` - skip checking of dependencies
-    * `--force`         - force compilation
+    * `--list`              - list all enabled compilers
+    * `--no-archives-check` - skip checking of archives
+    * `--no-deps-check`     - skip checking of dependencies
+    * `--force`             - force compilation
 
   """
   @spec run(OptionParser.argv) :: :ok | :noop
@@ -96,7 +97,7 @@ defmodule Mix.Tasks.Compile do
 
   # Loadpaths without checks because compilers may be defined in deps.
   defp loadpaths! do
-    Mix.Task.run "loadpaths", ["--no-elixir-version-check", "--no-deps-check"]
+    Mix.Task.run "loadpaths", ["--no-elixir-version-check", "--no-deps-check", "--no-archives-check"]
     Mix.Task.reenable "loadpaths"
   end
 

lib/mix/lib/mix/tasks/help.ex

@@ -109,7 +109,7 @@ defmodule Mix.Tasks.Help do
 
   # Loadpaths without checks because tasks may be defined in deps.
   defp loadpaths! do
-    Mix.Task.run "loadpaths", ["--no-elixir-version-check", "--no-deps-check"]
+    Mix.Task.run "loadpaths", ["--no-elixir-version-check", "--no-deps-check", "--no-archives-check"]
     Mix.Task.reenable "loadpaths"
   end
 

lib/mix/lib/mix/tasks/loadpaths.ex

@@ -6,6 +6,7 @@ defmodule Mix.Tasks.Loadpaths do
 
   ## Command line options
 
+    * `--no-archives-check` - do not check archive
     * `--no-deps-check` - do not check dependencies
     * `--no-elixir-version-check` - do not check Elixir version
 
@@ -19,6 +20,10 @@ defmodule Mix.Tasks.Loadpaths do
       check_elixir_version(config, args)
     end
 
+    unless "--no-archives-check" in args do
+      Mix.Task.run "archive.check", args
+    end
+
     # --no-deps is used only internally. It has not purpose
     # from Mix.CLI because the CLI itself already loads deps.
     unless "--no-deps" in args do