Mark dependencies as requiring compilation every time they are fetched

Author: José Valim

lib/mix/lib/mix/deps.ex

@@ -209,7 +209,7 @@ defmodule Mix.Deps do
   def format_status(Mix.Dep[status: { :noappfile, path }]),
     do: "could not find an app file at #{Path.relative_to_cwd(path)}, " <>
         "this may happen when you specified the wrong application name in your deps " <>
-        "or if the dependency did not compile (which can be amended with `mix deps.compile`)"
+        "or if the dependency did not compile (which can be amended with `#{mix_env_var}mix deps.compile`)"
 
   def format_status(Mix.Dep[status: { :invalidapp, path }]),
     do: "the app file at #{Path.relative_to_cwd(path)} is invalid"
@@ -229,6 +229,9 @@ defmodule Mix.Deps do
   def format_status(Mix.Dep[status: :nolock]),
     do: "the dependency is not locked"
 
+  def format_status(Mix.Dep[status: :compile]),
+    do: "the dependency build is outdated, please run `#{mix_env_var}mix deps.compile`"
+
   def format_status(Mix.Dep[app: app, status: { :divergedreq, other }] = dep) do
     "the dependency #{app} defined\n" <>
     "#{dep_status(dep)}" <>
@@ -251,14 +254,14 @@ defmodule Mix.Deps do
 
   def format_status(Mix.Dep[status: { :unavailable, _ }, scm: scm]) do
     if scm.fetchable? do
-      "the dependency is not available, run `mix deps.get`"
+      "the dependency is not available, run `#{mix_env_var}mix deps.get`"
     else
       "the dependency is not available"
     end
   end
 
   def format_status(Mix.Dep[status: { :elixirlock, _ }]),
-    do: "the dependency is built with an out-of-date elixir version, run `mix deps.get`"
+    do: "the dependency is built with an out-of-date elixir version, run `#{mix_env_var}mix deps.get`"
 
   defp dep_status(Mix.Dep[app: app, requirement: req, opts: opts, from: from]) do
     info = { app, req, Dict.drop(opts, [:dest, :lock, :env, :build]) }
@@ -302,16 +305,6 @@ defmodule Mix.Deps do
   def available?(Mix.Dep[status: { :unavailable, _ }]),  do: false
   def available?(Mix.Dep[]), do: true
 
-  @doc """
-  Checks if a dependency can be compiled.
-
-  All available dependencies can be compiled except for
-  umbrella applications.
-  """
-  def compilable?(Mix.Dep[manager: manager, extra: extra] = dep) do
-    available?(dep) and (manager != :mix or !extra[:umbrella?])
-  end
-
   @doc """
   Checks if a dependency is out of date, also considering its
   lock status. Therefore, be sure to call `check_lock` before
@@ -395,6 +388,14 @@ defmodule Mix.Deps do
 
   ## Helpers
 
+  defp mix_env_var do
+    if Mix.env == :dev do
+      ""
+    else
+      "MIX_ENV=#{Mix.env} "
+    end
+  end
+
   defp to_app_names(given) do
     Enum.map given, fn(app) ->
       if is_binary(app), do: binary_to_atom(app), else: app

lib/mix/lib/mix/deps/fetcher.ex

@@ -83,10 +83,21 @@ defmodule Mix.Deps.Fetcher do
     lock = Dict.merge(old_lock, new_lock)
     Mix.Deps.Lock.write(lock)
 
+    require_compilation(deps)
     do_compile(deps, opts)
     { apps, all_deps }
   end
 
+  defp require_compilation(deps) do
+    envs = Mix.Project.build_path
+           |> Path.join("*/lib")
+           |> Path.wildcard()
+
+    lc Mix.Dep[app: app] inlist deps, env inlist envs do
+      File.touch Path.join [env, app, ".compile"]
+    end
+  end
+
   defp do_compile(deps, opts) do
     apps = Enum.map(deps, &(&1.app)) |> Enum.uniq
 

lib/mix/lib/mix/deps/loader.ex

@@ -123,8 +123,12 @@ defmodule Mix.Deps.Loader do
   end
 
   defp scm_status(scm, opts) do
-    if scm.checked_out? opts do
-      { :ok, nil }
+    if scm.checked_out?(opts) do
+      if File.exists?(Path.join(opts[:build], ".compile")) do
+        :compile
+      else
+        { :ok, nil }
+      end
     else
       { :unavailable, opts[:dest] }
     end

lib/mix/lib/mix/tasks/deps.check.ex

@@ -20,7 +20,7 @@ defmodule Mix.Tasks.Deps.Check do
     all  = Enum.map loaded, &check_lock(&1, lock)
 
     prune_deps(all)
-    { not_ok, recompile } = partition_deps(all, [], [])
+    { not_ok, compile } = partition_deps(all, [], [])
 
     cond do
       not_ok != [] ->
@@ -33,28 +33,27 @@ defmodule Mix.Tasks.Deps.Check do
         end
 
         raise Mix.Error, message: "Can't continue due to errors on dependencies"
-      recompile == [] or "--no-compile" in args ->
+      compile == [] or "--no-compile" in args ->
         :ok
       true ->
-        Mix.Task.run "deps.compile", Enum.map(recompile, & &1.app)
+        Mix.Task.run "deps.compile", Enum.map(compile, & &1.app)
     end
   end
 
-  defp partition_deps([Mix.Dep[status: { :ok, _ }]|deps], not_ok, recompile) do
-    partition_deps(deps, not_ok, recompile)
-  end
+  defp partition_deps([Mix.Dep[status: { :ok, _ }]|deps], not_ok, compile),
+    do: partition_deps(deps, not_ok, compile)
 
-  defp partition_deps([Mix.Dep[status: { :noappfile, _ }] = dep|deps], not_ok, recompile) do
-    partition_deps(deps, not_ok, [dep|recompile])
-  end
+  defp partition_deps([Mix.Dep[status: :compile] = dep|deps], not_ok, compile),
+    do: partition_deps(deps, not_ok, [dep|compile])
 
-  defp partition_deps([dep|deps], not_ok, recompile) do
-    partition_deps(deps, [dep|not_ok], recompile)
-  end
+  defp partition_deps([Mix.Dep[status: { :noappfile, _ }] = dep|deps], not_ok, compile),
+    do: partition_deps(deps, not_ok, [dep|compile])
 
-  defp partition_deps([], not_ok, recompile) do
-    { not_ok, recompile }
-  end
+  defp partition_deps([dep|deps], not_ok, compile),
+    do: partition_deps(deps, [dep|not_ok], compile)
+
+  defp partition_deps([], not_ok, compile),
+    do: { not_ok, compile }
 
   # If the build is per environment, we should be able to look
   # at all dependencies and remove the builds that no longer

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

@@ -27,7 +27,7 @@ defmodule Mix.Tasks.Deps.Compile do
 
   """
 
-  import Mix.Deps, only: [loaded: 0, compilable?: 1, loaded_by_name: 1,
+  import Mix.Deps, only: [loaded: 0, available?: 1, loaded_by_name: 1,
                           format_dep: 1, make?: 1, mix?: 1, rebar?: 1]
 
   def run(args) do
@@ -41,6 +41,12 @@ defmodule Mix.Tasks.Deps.Compile do
     end
   end
 
+  # All available dependencies can be compiled
+  # except for umbrella applications.
+  defp compilable?(Mix.Dep[manager: manager, extra: extra] = dep) do
+    available?(dep) and (manager != :mix or !extra[:umbrella?])
+  end
+
   defp do_run(deps, run_opts) do
     shell  = Mix.shell
     config = Mix.Project.deps_config
@@ -69,6 +75,7 @@ defmodule Mix.Tasks.Deps.Compile do
         end
 
         unless mix?(dep), do: build_structure(dep, config)
+        File.rm(Path.join(opts[:build], ".compile"))
         compiled
       end
 

lib/mix/test/mix/tasks/deps_test.exs

@@ -122,6 +122,17 @@ defmodule Mix.Tasks.DepsTest do
     end
   end
 
+  test "marks dependencies as needing compilation but automatically compile them on check" do
+    Mix.Project.push SuccessfulDepsApp
+
+    in_fixture "deps_status", fn ->
+      File.touch!("_build/dev/lib/ok/.compile")
+      Mix.Tasks.Deps.Check.run []
+      assert_received { :mix_shell, :info, ["* Compiling ok"] }
+      refute File.exists?("_build/dev/lib/ok/.compile")
+    end
+  end
+
   test "checks list of dependencies and their status on failure" do
     Mix.Project.push DepsApp
 
@@ -436,8 +447,6 @@ defmodule Mix.Tasks.DepsTest do
 
       message = "* Updating git_repo (#{fixture_path("git_repo")})"
       assert_received { :mix_shell, :info, [^message] }
-
-      Mix.Tasks.Deps.Check.run []
     end
   after
     purge [GitRepo, GitRepo.Mix]