Make it explicit that some tasks require a project to be defined

José Valim · José Valim · commit 1e90076738e7 · 2013-07-27T10:43:41.000+02:00
diff --git a/lib/mix/lib/mix/deps/retriever.ex b/lib/mix/lib/mix/deps/retriever.ex
@@ -9,10 +9,9 @@ defmodule Mix.Deps.Retriever do
   as a `Mix.Dep` record.
   """
   def children() do
-    # Don't run recursively for the top-level project
     scms = Mix.SCM.available
     from = current_source(:mix)
-    (Mix.project[:deps] || []) |> Enum.map(update(&1, scms, from))
+    Enum.map(Mix.project[:deps], update(&1, scms, from))
   end
 
   @doc """
@@ -157,7 +156,7 @@ defmodule Mix.Deps.Retriever do
       ]
     else
       supported = Enum.join scms, ", "
-      raise Mix.Error, message: "did not specify a supported scm, expected one of: " <> supported
+      raise Mix.Error, message: "#{inspect Mix.Project.get} did not specify a supported scm, expected one of: " <> supported
     end
   end
 
@@ -231,7 +230,7 @@ defmodule Mix.Deps.Retriever do
   end
 
   defp invalid_dep_format(dep) do
-    raise Mix.Error, message: %b(dependency specified in the wrong format: #{inspect dep}, ) <>
+    raise Mix.Error, message: %b(Dependency specified in the wrong format: #{inspect dep}, ) <>
       %b(expected { app :: atom, opts :: Keyword.t } | { app :: atom, requirement :: String.t, opts :: Keyword.t })
   end
 end
diff --git a/lib/mix/lib/mix/exceptions.ex b/lib/mix/lib/mix/exceptions.ex
@@ -11,7 +11,7 @@ defexception Mix.InvalidTaskError, task: nil, mix_error: true do
 end
 
 defexception Mix.NoProjectError, mix_error: true,
-  message: "Could not find a Mix.Project"
+  message: "Could not find a Mix.Project, please ensure a mix.exs file is available"
 
 defexception Mix.Error, mix_error: true, message: nil
 
diff --git a/lib/mix/lib/mix/project.ex b/lib/mix/lib/mix/project.ex
@@ -271,16 +271,17 @@ defmodule Mix.Project do
   defp default_config do
     [ compile_path: "ebin",
       default_task: "run",
+      deps: [],
       deps_path: "deps",
       elixirc_exts: [:ex],
       elixirc_paths: ["lib"],
       elixirc_watch_exts: [:ex, :eex, :exs],
-      load_paths: [],
-      lockfile: "mix.lock",
-      preferred_cli_env: [{ "test", :test }],
       erlc_paths: ["src"],
       erlc_include_path: "include",
-      erlc_options: [:debug_info] ]
+      erlc_options: [:debug_info],
+      load_paths: [],
+      lockfile: "mix.lock",
+      preferred_cli_env: [{ "test", :test }] ]
   end
 
   defp get_project_config(nil), do: []
diff --git a/lib/mix/lib/mix/scm/git.ex b/lib/mix/lib/mix/scm/git.ex
@@ -132,7 +132,7 @@ defmodule Mix.SCM.Git do
 
   defp run_cmd_or_raise(command) do
     if Mix.shell.cmd(command) != 0 do
-      raise Mix.Error, message: "command `#{command}` failed"
+      raise Mix.Error, message: "Command `#{command}` failed"
     end
     true
   end
diff --git a/lib/mix/lib/mix/scm/path.ex b/lib/mix/lib/mix/scm/path.ex
@@ -40,7 +40,7 @@ defmodule Mix.SCM.Path do
 
   def checkout(opts) do
     path = Mix.Utils.relative_to_cwd opts[:dest]
-    raise Mix.Error, message: "cannot checkout path dependency, expected a dependency at #{path}"
+    raise Mix.Error, message: "Cannot checkout path dependency, expected a dependency at #{path}"
   end
 
   def update(opts) do
diff --git a/lib/mix/lib/mix/tasks/archive.ex b/lib/mix/lib/mix/tasks/archive.ex
@@ -34,8 +34,8 @@ defmodule Mix.Tasks.Archive do
       app = Mix.project[:app] ->
         Mix.Archive.name(app, Mix.project[:version])
       true ->
-        raise Mix.Error, message: "Could not create archive without a name. " <>
-          "Please pass -o as an option"
+        raise Mix.Error, message: "Could not create archive without a name, " <>
+          "please pass -o as an option"
     end
 
     Mix.Archive.create(archive_file)
diff --git a/lib/mix/lib/mix/tasks/deps.clean.ex b/lib/mix/lib/mix/tasks/deps.clean.ex
@@ -16,6 +16,8 @@ defmodule Mix.Tasks.Deps.Clean do
   import Mix.Deps, only: [all: 0, by_name: 1, format_dep: 1]
 
   def run(args) do
+    Mix.Project.get! # Require the project to be available
+
     { opts, args } = OptionParser.parse(args, switches: [unlock: :boolean, all: :boolean])
 
     cond do
diff --git a/lib/mix/lib/mix/tasks/deps.compile.ex b/lib/mix/lib/mix/tasks/deps.compile.ex
@@ -28,6 +28,8 @@ defmodule Mix.Tasks.Deps.Compile do
                            depending: 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) do
       { _, [] } ->
         do_compile Enum.filter(all, available?(&1))
@@ -117,7 +119,7 @@ defmodule Mix.Tasks.Deps.Compile do
     shell.info "I can install a local copy which is just used by mix"
 
     unless shell.yes?("Shall I install this local copy?") do
-      raise Mix.Error, message: "could not find rebar to compile " <>
+      raise Mix.Error, message: "Could not find rebar to compile " <>
         "dependency #{app}, please ensure rebar is available"
     end
 
@@ -127,7 +129,7 @@ defmodule Mix.Tasks.Deps.Compile do
 
   defp do_command(app, command, extra // "") do
     if Mix.shell.cmd("#{command} #{extra}") != 0 do
-      raise Mix.Error, message: "could not compile dependency #{app}, #{command} command failed. " <>
+      raise Mix.Error, message: "Could not compile dependency #{app}, #{command} command failed. " <>
         "If you want to recompile this dependency, please run: mix deps.compile #{app}"
     end
   end
@@ -139,7 +141,7 @@ defmodule Mix.Tasks.Deps.Compile do
   defp do_compile(app, command) when is_binary(command) do
     Mix.shell.info("#{app}: #{command}")
     if Mix.shell.cmd(command) != 0 do
-      raise Mix.Error, message: "could not compile dependency #{app}, custom #{command} command failed. " <>
+      raise Mix.Error, message: "Could not compile dependency #{app}, custom #{command} command failed. " <>
         "If you want to recompile this dependency, please run: mix deps.compile #{app}"
     end
   end
diff --git a/lib/mix/lib/mix/tasks/deps.ex b/lib/mix/lib/mix/tasks/deps.ex
@@ -16,6 +16,8 @@ defmodule Mix.Tasks.Deps do
 
   """
   def run(_) do
+    Mix.Project.get! # Require the project to be available
+
     shell = Mix.shell
     lock  = Mix.Deps.Lock.read
 
diff --git a/lib/mix/lib/mix/tasks/deps.get.ex b/lib/mix/lib/mix/tasks/deps.get.ex
@@ -19,6 +19,8 @@ defmodule Mix.Tasks.Deps.Get do
   import Mix.Deps, only: [all: 2, by_name: 1, format_dep: 1, check_lock: 2, out_of_date?: 1]
 
   def run(args) do
+    Mix.Project.get! # Require the project to be available
+
     { opts, rest } = OptionParser.parse(args, switches: [no_compile: :boolean, quiet: :boolean])
 
     if rest != [] do
diff --git a/lib/mix/lib/mix/tasks/deps.unlock.ex b/lib/mix/lib/mix/tasks/deps.unlock.ex
@@ -12,6 +12,7 @@ defmodule Mix.Tasks.Deps.Unlock do
   """
 
   def run(args) do
+    Mix.Project.get! # Require the project to be available
     { opts, args } = OptionParser.parse(args, switches: [unlock: :boolean, all: :boolean])
 
     cond do
diff --git a/lib/mix/lib/mix/tasks/deps.update.ex b/lib/mix/lib/mix/tasks/deps.update.ex
@@ -23,6 +23,7 @@ defmodule Mix.Tasks.Deps.Update do
                            depending: 2, format_dep: 1 ]
 
   def run(args) do
+    Mix.Project.get! # Require the project to be available
     { opts, rest } = OptionParser.parse(args, switches: [no_compile: :boolean, all: :boolean])
 
     cond do
@@ -73,7 +74,7 @@ defmodule Mix.Tasks.Deps.Update do
 
   defp check_unavailable!(dep) do
     unless available?(dep) do
-      raise Mix.Error, message: "cannot update dependency #{dep.app} because " <>
+      raise Mix.Error, message: "Cannot update dependency #{dep.app} because " <>
         "it isn't available, run `mix deps.get` first"
     end
     dep
diff --git a/lib/mix/lib/mix/tasks/do.ex b/lib/mix/lib/mix/tasks/do.ex
@@ -17,7 +17,7 @@ defmodule Mix.Tasks.Do do
   def run(args) do
     Enum.each(gather_commands(args), function do
       [task|args] -> Mix.Task.run task, args
-      [] -> raise Mix.Error, message: "no expression between commas"
+      [] -> raise Mix.Error, message: "No expression between commas"
     end)
   end
 
diff --git a/lib/mix/lib/mix/tasks/escriptize.ex b/lib/mix/lib/mix/tasks/escriptize.ex
@@ -51,6 +51,9 @@ defmodule Mix.Tasks.Escriptize do
   def run(args) do
     { opts, _ } = OptionParser.parse(args, switches: [force: :boolean, no_compile: :boolean])
 
+    # Require the project to be available
+    Mix.Project.get!
+
     unless opts[:no_compile] do
       Mix.Task.run :compile, args
     end
diff --git a/lib/mix/lib/mix/tasks/local.install.ex b/lib/mix/lib/mix/tasks/local.install.ex
@@ -36,7 +36,7 @@ defmodule Mix.Tasks.Local.Install do
       path = Mix.Archive.name(Mix.project[:app], Mix.project[:version])
 
       unless File.exists?(path) do
-        raise Mix.Error, message: "expected PATH to be given, please use `mix local.install PATH`"
+        raise Mix.Error, message: "Expected PATH to be given, please use `mix local.install PATH`"
       end
     end
 
diff --git a/lib/mix/lib/mix/tasks/local.uninstall.ex b/lib/mix/lib/mix/tasks/local.uninstall.ex
@@ -26,7 +26,7 @@ defmodule Mix.Tasks.Local.Uninstall do
              "Do you want to remove this archive?") do
           do_uninstall(archive)
         else
-          raise Mix.Error, message: "cannot uninstall task #{task}"
+          raise Mix.Error, message: "Cannot uninstall task #{task}"
         end
     end
   end
diff --git a/lib/mix/lib/mix/tasks/new.ex b/lib/mix/lib/mix/tasks/new.ex
@@ -41,7 +41,7 @@ defmodule Mix.Tasks.New do
 
     case argv do
       [] ->
-        raise Mix.Error, message: "expected PATH to be given, please use `mix new PATH`"
+        raise Mix.Error, message: "Expected PATH to be given, please use `mix new PATH`"
       [path|_] ->
         name = Path.basename(Path.expand(path))
         check_project_name!(name)
@@ -120,7 +120,7 @@ defmodule Mix.Tasks.New do
 
   defp check_project_name!(name) do
     unless name =~ %r/^[a-z][\w_]*$/ do
-      raise Mix.Error, message: "project path must start with a letter and have only lowercase letters, numbers and underscore"
+      raise Mix.Error, message: "Project path must start with a letter and have only lowercase letters, numbers and underscore"
     end
   end
 
diff --git a/lib/mix/lib/mix/tasks/run.ex b/lib/mix/lib/mix/tasks/run.ex
@@ -35,6 +35,9 @@ defmodule Mix.Tasks.Run do
       aliases: [r: :require, pr: :parallel_require, e: :eval],
       switches: [parallel_require: :keep, require: :keep])
 
+    # Require the project to be available
+    Mix.Project.get!
+
     Mix.Task.run "app.start", args
 
     file =
diff --git a/lib/mix/lib/mix/utils.ex b/lib/mix/lib/mix/utils.ex
@@ -339,7 +339,7 @@ defmodule Mix.Utils do
     cond do
       is_url?(path)  -> read_url(path)
       is_file?(path) -> read_file(path)
-      :else          -> raise Mix.Error, message: "expected #{path} to be a url or a local file path"
+      :else          -> raise Mix.Error, message: "Expected #{path} to be a url or a local file path"
     end
   end
 
@@ -358,9 +358,9 @@ defmodule Mix.Utils do
       { :ok, { { _, status, _ }, _, body } } when status in 200..299 ->
         iolist_to_binary(body)
       { :ok, { { _, status, _ }, _, _ } } ->
-        raise Mix.Error, message: "could not access url #{path}, got status: #{status}"
+        raise Mix.Error, message: "Could not access url #{path}, got status: #{status}"
       { :error, reason } ->
-        raise Mix.Error, message: "could not access url #{path}, error: #{inspect reason}"
+        raise Mix.Error, message: "Could not access url #{path}, error: #{inspect reason}"
     end
   end
 
diff --git a/lib/mix/test/mix/cli_test.exs b/lib/mix/test/mix/cli_test.exs
@@ -18,6 +18,12 @@ defmodule Mix.CLITest do
 
   test "default task" do
     in_fixture "no_mixfile", fn ->
+      File.write! "mix.exs", """
+      defmodule P do
+        use Mix.Project
+        def project, do: []
+      end
+      """
       output = mix ""
       assert File.regular?("ebin/Elixir.A.beam")
       assert output =~ "Compiled lib/a.ex"
diff --git a/lib/mix/test/mix/tasks/deps.git_test.exs b/lib/mix/test/mix/tasks/deps.git_test.exs
@@ -283,7 +283,7 @@ defmodule Mix.Tasks.DepsGitTest do
       exception = assert_raise Mix.Error, fn ->
         Mix.Tasks.Deps.Get.run []
       end
-      assert exception.message =~ "command `git clone"
+      assert exception.message =~ "Command `git clone"
     end
   after
     Mix.Project.pop
diff --git a/lib/mix/test/mix/tasks/deps_test.exs b/lib/mix/test/mix/tasks/deps_test.exs
@@ -137,20 +137,26 @@ defmodule Mix.Tasks.DepsTest do
   end
 
   test "unlocks all deps" do
+    Mix.Project.push DepsApp
     in_fixture "no_mixfile", fn ->
       Mix.Deps.Lock.write [git_repo: "abcdef"]
       assert Mix.Deps.Lock.read == [git_repo: "abcdef"]
       Mix.Tasks.Deps.Unlock.run ["--all"]
       assert Mix.Deps.Lock.read == []
     end
+  after
+    Mix.Project.pop
   end
 
   test "unlocks specific deps" do
+    Mix.Project.push DepsApp
     in_fixture "no_mixfile", fn ->
       Mix.Deps.Lock.write [git_repo: "abcdef", another: "hash"]
       Mix.Tasks.Deps.Unlock.run ["git_repo", "unknown"]
       assert Mix.Deps.Lock.read == [another: "hash"]
     end
+  after
+    Mix.Project.pop
   end
 
   ## Deps environment
diff --git a/lib/mix/test/mix/tasks/new_test.exs b/lib/mix/test/mix/tasks/new_test.exs
@@ -66,11 +66,11 @@ defmodule Mix.Tasks.NewTest do
 
   test "new with invalid args" do
     in_tmp "new with invalid args", fn ->
-      assert_raise Mix.Error, "project path must start with a letter and have only lowercase letters, numbers and underscore", fn ->
+      assert_raise Mix.Error, "Project path must start with a letter and have only lowercase letters, numbers and underscore", fn ->
         Mix.Tasks.New.run ["007invalid"]
       end
 
-      assert_raise Mix.Error, "expected PATH to be given, please use `mix new PATH`", fn ->
+      assert_raise Mix.Error, "Expected PATH to be given, please use `mix new PATH`", fn ->
         Mix.Tasks.New.run []
       end
     end
diff --git a/lib/mix/test/mix/tasks/run_test.exs b/lib/mix/test/mix/tasks/run_test.exs
@@ -3,6 +3,13 @@ Code.require_file "../../test_helper.exs", __DIR__
 defmodule Mix.Tasks.RunTest do
   use MixTest.Case
 
+  defmodule SimpleApp do
+    def project do
+      [ app: :simple_app,
+        version: "0.1.0" ]
+    end
+  end
+
   defmodule GetApp do
     def project do
       [ app: :get_app,
@@ -27,6 +34,7 @@ defmodule Mix.Tasks.RunTest do
   end
 
   test "run requires before commands" do
+    Mix.Project.push SimpleApp
     git_repo = fixture_path("git_repo/lib/git_repo.ex")
 
     in_fixture "no_mixfile", fn ->
@@ -36,5 +44,7 @@ defmodule Mix.Tasks.RunTest do
       Mix.Tasks.Run.run ["-pr", git_repo, "-e", "Mix.shell.info GitRepo.hello"]
       assert_received { :mix_shell, :info, ["World"] }
     end
+  after
+    Mix.Project.pop
   end
 end
