mix run now properly sets System.argv

Author: José Valim

CHANGELOG.md

@@ -18,6 +18,7 @@
   * [Mix] Allow coverage tool to be pluggable via the `:test_coverage` configuration
   * [Mix] Add `mix cmd` as a convenience to run a command recursively in child apps in an umbrella application
   * [Mix] Support `umbrella: true` in dependencies as a convenience for setting up umbrella path deps
+  * [Mix] `mix run` now behaves closer to the `elixir` command and properly mangles the ARGV
   * [String] Add `String.reverse/1`
 
 * bug fix

lib/elixir/lib/kernel/cli.ex

@@ -11,7 +11,7 @@ defmodule Kernel.CLI do
     argv = lc arg inlist argv, do: :unicode.characters_to_binary(arg)
 
     { config, argv } = process_argv(argv, Kernel.CLI.Config.new)
-    :elixir_code_server.cast({ :argv, argv })
+    System.argv(argv)
 
     run fn ->
       command_results = Enum.map(Enum.reverse(config.commands), process_command(&1, config))

lib/elixir/lib/option_parser.ex

@@ -100,7 +100,7 @@ defmodule OptionParser do
     parse(argv, aliases, switches, [], [], all)
   end
 
-  defp parse(["-" <> option|t], aliases, switches, dict, args, all) do
+  defp parse(["-" <> option|t], aliases, switches, dict, args, all) when option != "-" do
     { option, kinds, value } = normalize_option(option, switches, aliases)
 
     if nil?(value) do

lib/elixir/lib/system.ex

@@ -78,6 +78,15 @@ defmodule System do
     :elixir_code_server.call :argv
   end
 
+  @doc """
+  Changes the list of command-line arguments. Use it with caution,
+  as it destory any previous argv information.
+  """
+  @spec argv([String.t]) :: :ok
+  def argv(argv) do
+    :elixir_code_server.cast({ :argv, argv })
+  end
+
   @doc """
   Returns the current working directory or `nil` if one
   is not available.

lib/elixir/test/elixir/option_parser_test.exs

@@ -101,6 +101,11 @@ defmodule OptionParserTest do
     assert options == { [source: "from_docs/"], ["test/enum_test.exs", "--verbose"] }
   end
 
+  test "stops on --" do
+    options = OptionParser.parse_head(["--source", "from_docs/", "--", "1", "2", "3"])
+    assert options == { [source: "from_docs/"], ["--", "1", "2", "3"] }
+  end
+
   test "goes beyond the first non option arguments" do
     options = OptionParser.parse(["--source", "from_docs/", "test/enum_test.exs", "--verbose"])
     assert options == { [source: "from_docs/", verbose: true], ["test/enum_test.exs"] }

lib/mix/lib/mix/tasks/run.ex

@@ -4,10 +4,21 @@ defmodule Mix.Tasks.Run do
   @shortdoc "Run the given file or expression"
 
   @moduledoc """
-  Runs the given file or expession in the context of the application.
+  Runs the given file or expression in the context of the application.
 
-  Before running the code, it invokes the app.start task
-  which defaults to compile and load your project.
+  Before running the code, it invokes the `app.start` task which compiles
+  and loads your project.
+
+  It is the goal of this task to provide a subset of the functionality
+  existent in the `elixir` executable, including setting up the `System.argv`:
+
+      mix run -e Hello.world
+      mix run my_script.exs arg1 arg2 arg3
+
+  Many command line options need to be passed to the `elixir` executable
+  directly, which can be done as follows:
+
+      elixir --sname hello -S mix run -e "My.code"
 
   ## Command line options
 
@@ -18,16 +29,6 @@ defmodule Mix.Tasks.Run do
   * `--no-compile` - Does not compile even if files require compilation
   * `--no-start` - Does not start applications after compilation
 
-  ## Examples
-
-      mix run -e Hello.world
-      mix run -e "Some.function with_args"
-      mix run -r some_file.exs
-
-  Command line options given to the `elixir` executable can be passed as:
-
-      elixir --sname hello -S mix run -e "My.code"
-
   """
   def run(args) do
     { opts, head } = OptionParser.parse_head(args,
@@ -36,6 +37,13 @@ defmodule Mix.Tasks.Run do
 
     Mix.Task.run "app.start", args
 
+    file =
+      case head do
+        ["--"|t] -> System.argv(t); nil
+        [h|t]    -> System.argv(t); h
+        []       -> System.argv([]); nil
+      end
+
     Enum.each opts, fn({ key, value }) ->
       case key do
         :parallel_require ->
@@ -49,10 +57,7 @@ defmodule Mix.Tasks.Run do
       end
     end
 
-    if head != [] do
-      Mix.shell.error "[WARNING] mix run EXPR is deprecated, please use mix run -e EXPR instead"
-      Code.eval_string Enum.join(head, " ")
-    end
+    if file, do: Code.require_file(h)
     if opts[:no_halt], do: :timer.sleep(:infinity)
   end
 

lib/mix/test/mix/cli_test.exs

@@ -7,12 +7,12 @@ defmodule Mix.CLITest do
     in_fixture "only_mixfile", fn ->
       if match? { :win32, _ }, :os.type do
         temp_env = "set MIX_ENV=prod &"
-      else # ie. linux
+      else
         temp_env = "MIX_ENV=prod"
       end
 
-      env = System.cmd %b(#{temp_env} #{elixir_executable} #{mix_executable} run -e "IO.puts Mix.env")
-      assert env =~ "prod"
+      env = System.cmd %b(#{temp_env} #{elixir_executable} #{mix_executable} run -e "IO.inspect { Mix.env, System.argv }" -- 1 2 3)
+      assert env =~ %b({:prod, ["1", "2", "3"]})
     end
   end
 

lib/mix/test/mix/tasks/deps.git_test.exs

@@ -106,7 +106,7 @@ defmodule Mix.Tasks.DepsGitTest do
 
       # We can compile just fine
       Mix.Task.clear
-      Mix.Tasks.Run.run ["1+2"]
+      Mix.Tasks.Run.run ["-e", "1+2"]
 
       # Now let's add a submodules option
       Mix.Project.pop

lib/mix/test/mix/tasks/deps.path_test.exs

@@ -39,7 +39,7 @@ defmodule Mix.Tasks.DepsPathTest do
     in_fixture "deps_status", fn ->
       Mix.Deps.Lock.write [raw_repo: "abcdef"]
       Mix.Tasks.Deps.Compile.run ["raw_repo"]
-      Mix.Tasks.Run.run ["Mix.shell.info", "RawRepo.hello"]
+      Mix.Tasks.Run.run ["-e", "Mix.shell.info RawRepo.hello"]
       assert_received { :mix_shell, :info, ["world"] }
     end
   after

lib/mix/test/mix/tasks/run_test.exs

@@ -18,7 +18,7 @@ defmodule Mix.Tasks.RunTest do
 
     in_fixture "no_mixfile", fn ->
       Mix.Tasks.Deps.Get.run []
-      Mix.Tasks.Run.run ["Mix.shell.info", "GitRepo.hello"]
+      Mix.Tasks.Run.run ["-e", "Mix.shell.info GitRepo.hello"]
       assert_received { :mix_shell, :info, ["World"] }
     end
   after
@@ -30,10 +30,10 @@ defmodule Mix.Tasks.RunTest do
     git_repo = fixture_path("git_repo/lib/git_repo.ex")
 
     in_fixture "no_mixfile", fn ->
-      Mix.Tasks.Run.run ["-r", git_repo, "Mix.shell.info", "GitRepo.hello"]
+      Mix.Tasks.Run.run ["-r", git_repo, "-e", "Mix.shell.info GitRepo.hello"]
       assert_received { :mix_shell, :info, ["World"] }
 
-      Mix.Tasks.Run.run ["-pr", git_repo, "Mix.shell.info", "GitRepo.hello"]
+      Mix.Tasks.Run.run ["-pr", git_repo, "-e", "Mix.shell.info GitRepo.hello"]
       assert_received { :mix_shell, :info, ["World"] }
     end
   end