Merge pull request #2079 from ericmj/mix-dep-only

Add `:only` dep option to filter on environments

Author: ericmj

CHANGELOG.md

@@ -7,6 +7,7 @@
   * [IEx] Allow prompt configuration with the `:prompt` option
   * [Kernel] Support `ERL_PATH` in `bin/elixir`
   * [Map] Add a Map module and support R17 maps and structs
+  * [Mix] Add dependency option `:only` to specify its environment
   * [Regex] Regexes no longer need the "g" option when there is a need to use named captures
   * [StringIO] Add a `StringIO` module that allows a String to be used as IO device
   * [System] Add `System.delete_env/1` to remove a variable from the environment

lib/mix/lib/mix/deps.ex

@@ -50,6 +50,8 @@ defmodule Mix.Deps do
   * `:compile` - A command to compile the dependency, defaults to a mix,
                  rebar or make command
   * `:optional` - The dependency is optional and used only to specify requirements
+  * `:only` - The dependency will only belong to the given environments, use when
+              declaring dev or test only dependencies
 
   ## Git options (`:git`)
 
@@ -87,7 +89,7 @@ defmodule Mix.Deps do
   This function raises an exception if any of the dependencies
   provided in the project are in the wrong format.
   """
-  defdelegate children(), to: Mix.Deps.Loader
+  defdelegate children(otps), to: Mix.Deps.Loader
 
   @doc """
   Returns loaded dependencies recursively as a `Mix.Dep` record.
@@ -97,8 +99,8 @@ defmodule Mix.Deps do
   This function raises an exception if any of the dependencies
   provided in the project are in the wrong format.
   """
-  def loaded do
-    { deps, _ } = Mix.Deps.Converger.all(nil, fn(dep, acc) -> { dep, acc } end)
+  def loaded(opts) do
+    { deps, _ } = Mix.Deps.Converger.all(nil, opts, fn(dep, acc) -> { dep, acc } end)
     Mix.Deps.Converger.topsort(deps)
   end
 
@@ -111,7 +113,9 @@ defmodule Mix.Deps do
   This function raises an exception if any of the dependencies
   provided in the project are in the wrong format.
   """
-  def loaded_by_name(given, all_deps \\ loaded) do
+  def loaded_by_name(given, all_deps \\ nil, opts) do
+    all_deps = all_deps || loaded(opts)
+
     # Ensure all apps are atoms
     apps = to_app_names(given)
 
@@ -141,29 +145,31 @@ defmodule Mix.Deps do
   The callback expects the current dependency and the accumulator
   as arguments. The accumulator is returned as result.
 
+  See `Mix.Deps.Converger.all/3` for options.
+
   ## Exceptions
 
   This function raises an exception if any of the dependencies
   provided in the project are in the wrong format.
   """
-  def unloaded(acc, callback) do
-    { deps, acc } = Mix.Deps.Converger.all(acc, callback)
+  def unloaded(acc, opts, callback) do
+    { deps, acc } = Mix.Deps.Converger.all(acc, opts, callback)
     { Mix.Deps.Converger.topsort(deps), acc }
   end
 
   @doc """
   Receives a list of dependency names and maps and reduces over
-  them.
+  them. See `unloaded`.
 
   ## Exceptions
 
   This function raises an exception if any of the dependencies
   provided in the project are in the wrong format.
   """
-  def unloaded_by_name(given, acc, callback) do
+  def unloaded_by_name(given, acc, opts, callback) do
     names = to_app_names(given)
 
-    unloaded(acc, fn(dep, acc) ->
+    unloaded(acc, opts, fn(dep, acc) ->
       if dep.app in names do
         callback.(dep, acc)
       else
@@ -254,7 +260,7 @@ 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_env_var}mix deps.get`"
+      "the dependency is not available, run `mix deps.get`"
     else
       "the dependency is not available"
     end

lib/mix/lib/mix/deps/converger.ex

@@ -38,9 +38,11 @@ defmodule Mix.Deps.Converger do
   including nested dependencies. There is a callback
   that is invoked for each dependency and must return
   an updated dependency in case some processing is done.
+
+  See `Mix.Deps.Loader.children/1` for options.
   """
-  def all(rest, callback) do
-    main      = Mix.Deps.Loader.children
+  def all(rest, opts, callback) do
+    main      = Mix.Deps.Loader.children(opts)
     apps      = Enum.map(main, &(&1.app))
     converger = Mix.RemoteConverger.get
 

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

@@ -11,18 +11,24 @@ defmodule Mix.Deps.Fetcher do
 
   @doc """
   Fetches all dependencies.
+
+  See `Mix.Deps.unloaded/3` for options.
   """
-  def all(old_lock, new_lock) do
-    { apps, _deps } = do_finalize Mix.Deps.unloaded({ [], new_lock }, &do_fetch/2), old_lock
+  def all(old_lock, new_lock, opts) do
+    deps = Mix.Deps.unloaded({ [], new_lock }, opts, &do_fetch/2)
+    { apps, _deps } = do_finalize(deps, old_lock, opts)
     apps
   end
 
   @doc """
   Fetches the dependencies with the given names and their children recursively.
+
+  See `Mix.Deps.unloaded_by_name/4` for options.
   """
-  def by_name(names, old_lock, new_lock) do
-    { apps, deps } = do_finalize Mix.Deps.unloaded_by_name(names, { [], new_lock }, &do_fetch/2), old_lock
-    Mix.Deps.loaded_by_name(names, deps) # Check all given dependencies are loaded or fail
+  def by_name(names, old_lock, new_lock, opts) do
+    deps = Mix.Deps.unloaded_by_name(names, { [], new_lock }, opts, &do_fetch/2)
+    { apps, deps } = do_finalize(deps, old_lock, opts)
+    Mix.Deps.loaded_by_name(names, deps, opts) # Check all given dependencies are loaded or fail
     apps
   end
 
@@ -63,9 +69,9 @@ defmodule Mix.Deps.Fetcher do
   defp out_of_date?(Mix.Dep[status: { :unavailable, _ }]),  do: true
   defp out_of_date?(Mix.Dep[]),                             do: false
 
-  defp do_finalize({ all_deps, { apps, new_lock } }, old_lock) do
+  defp do_finalize({ all_deps, { apps, new_lock } }, old_lock, opts) do
     # Let's get the loaded versions of deps
-    deps = Mix.Deps.loaded_by_name(apps, all_deps)
+    deps = Mix.Deps.loaded_by_name(apps, all_deps, opts)
 
     # Do not mark dependencies that are not available
     deps = Enum.filter(deps, &available?/1)

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

@@ -8,12 +8,29 @@ defmodule Mix.Deps.Loader do
   Gets all direct children of the current `Mix.Project`
   as a `Mix.Dep` record. Umbrella project dependencies
   are included as children.
+
+  By default, it will filter all dependencies that does not match
+  current environment, behaviour can be overriden via options.
+
+  ## Options
+
+  * `:env` - Filter dependencies on given environments
   """
-  def children do
+  def children(opts) do
     scms = Mix.SCM.available
     from = Path.absname("mix.exs")
-    Enum.map(Mix.project[:deps] || [], &to_dep(&1, scms, from)) ++
-             Mix.Deps.Umbrella.unloaded
+    deps = Enum.map(Mix.project[:deps] || [], &to_dep(&1, scms, from))
+
+    # Filter deps not matching mix environment
+    if env = opts[:env] do
+      deps =
+        Enum.filter(deps, fn Mix.Dep[opts: opts] ->
+          only = opts[:only]
+          if only, do: env in List.wrap(only), else: true
+        end)
+    end
+
+    deps ++ Mix.Deps.Umbrella.unloaded
   end
 
   @doc """
@@ -173,6 +190,7 @@ defmodule Mix.Deps.Loader do
                         "are running on v#{System.version}, please run mix deps.update #{dep.app} to update it"
       end
 
+      children = children(env: opts[:env] || :prod)
       { dep.manager(:mix).opts(opts).extra(umbrella: umbrella?), children }
     end)
   end

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

@@ -284,7 +284,7 @@ defmodule Mix.Tasks.Compile.Elixir do
   defp path_deps_changed?(manifest) do
     manifest = Path.absname(manifest)
 
-    deps = Enum.filter(Mix.Deps.children, fn(Mix.Dep[] = dep) ->
+    deps = Enum.filter(Mix.Deps.children([]), fn(Mix.Dep[] = dep) ->
       dep.scm == Mix.SCM.Path
     end)
 

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

@@ -1,7 +1,7 @@
 defmodule Mix.Tasks.Deps.Check do
   use Mix.Task
 
-  import Mix.Deps, only: [loaded: 0, loaded_by_name: 1, format_dep: 1,
+  import Mix.Deps, only: [loaded: 1, loaded_by_name: 2, format_dep: 1,
                           format_status: 1, check_lock: 2, ok?: 1]
 
   @moduledoc """
@@ -20,7 +20,7 @@ defmodule Mix.Tasks.Deps.Check do
   def run(args) do
     { opts, _, _ } = OptionParser.parse(args, switches: [quiet: :boolean])
     lock = Mix.Deps.Lock.read
-    all  = Enum.map loaded, &check_lock(&1, lock)
+    all  = Enum.map(loaded(env: Mix.env), &check_lock(&1, lock))
 
     prune_deps(all)
     { not_ok, compile } = partition_deps(all, [], [])
@@ -34,7 +34,7 @@ defmodule Mix.Tasks.Deps.Check do
         Mix.Tasks.Deps.Compile.compile(compile, opts)
         show_not_ok compile
                     |> Enum.map(& &1.app)
-                    |> loaded_by_name
+                    |> loaded_by_name(env: Mix.env)
                     |> Enum.filter(&(not ok?(&1)))
     end
   end

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

@@ -15,7 +15,7 @@ defmodule Mix.Tasks.Deps.Clean do
     Mix.Project.get! # Require the project to be available
 
     { opts, args, _ } = OptionParser.parse(args, switches: [unlock: :boolean, all: :boolean])
-    loaded = Mix.Deps.loaded
+    loaded = Mix.Deps.loaded(env: Mix.env)
 
     cond do
       opts[:all] ->

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

@@ -27,17 +27,17 @@ defmodule Mix.Tasks.Deps.Compile do
 
   """
 
-  import Mix.Deps, only: [loaded: 0, available?: 1, loaded_by_name: 1,
+  import Mix.Deps, only: [loaded: 1, available?: 1, loaded_by_name: 2,
                           format_dep: 1, make?: 1, mix?: 1, rebar?: 1]
 
   def run(args) do
     Mix.Project.get! # Require the project to be available
 
     case OptionParser.parse(args, switches: [quiet: :boolean]) do
       { opts, [], _ } ->
-        compile(Enum.filter(loaded, &compilable?/1), opts)
+        compile(Enum.filter(loaded(env: Mix.env), &compilable?/1), opts)
       { opts, tail, _ } ->
-        compile(loaded_by_name(tail), opts)
+        compile(loaded_by_name(tail, env: Mix.env), opts)
     end
   end
 

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

@@ -1,7 +1,7 @@
 defmodule Mix.Tasks.Deps do
   use Mix.Task
 
-  import Mix.Deps, only: [loaded: 0, format_dep: 1, format_status: 1, check_lock: 2]
+  import Mix.Deps, only: [loaded: 1, format_dep: 1, format_status: 1, check_lock: 2]
 
   @shortdoc "List dependencies and their status"
 
@@ -13,14 +13,24 @@ defmodule Mix.Tasks.Deps do
       [locked at REF]
       STATUS
 
+  ## Command line options
+
+  * `--all` - check all dependencies, regardless of specified environment
   """
-  def run(_) do
+  def run(args) do
     Mix.Project.get! # Require the project to be available
+    { opts, _, _ } = OptionParser.parse(args)
+
+    if opts[:all] do
+      loaded_opts = []
+    else
+      loaded_opts = [env: Mix.env]
+    end
 
     shell = Mix.shell
     lock  = Mix.Deps.Lock.read
 
-    Enum.each loaded, fn(Mix.Dep[scm: scm] = dep) ->
+    Enum.each loaded(loaded_opts), fn(Mix.Dep[scm: scm] = dep) ->
       dep = check_lock(dep, lock)
       shell.info "* #{format_dep(dep)}"
       if formatted = scm.format_lock(dep.opts) do