improvement: support new PendingCodegen error

Author: zachdaniel

.tool-versions

@@ -1,2 +1,2 @@
-erlang 26.0.2
-elixir 1.18.4
+erlang 27.0.1
+elixir 1.18.4-otp-27

lib/data_layer.ex

@@ -391,7 +391,7 @@ defmodule AshSqlite.DataLayer do
   end
 
   def codegen(args) do
-    # TODO: take args that we care about
+    Mix.Task.reenable("ash_sqlite.generate_migrations")
     Mix.Task.run("ash_sqlite.generate_migrations", args)
   end
 

lib/migration_generator/migration_generator.ex

@@ -3,8 +3,6 @@ defmodule AshSqlite.MigrationGenerator do
 
   require Logger
 
-  import Mix.Generator
-
   alias AshSqlite.MigrationGenerator.{Operation, Phase}
 
   defstruct snapshot_path: nil,
@@ -40,10 +38,45 @@ defmodule AshSqlite.MigrationGenerator do
       |> Enum.map(& &1.repo)
       |> Enum.uniq()
 
-    Mix.shell().info("\nExtension Migrations: ")
-    create_extension_migrations(repos, opts)
-    Mix.shell().info("\nGenerating Migrations:")
-    create_migrations(snapshots, opts)
+    extension_migration_files =
+      create_extension_migrations(repos, opts)
+
+    migration_files =
+      create_migrations(snapshots, opts)
+
+    files = extension_migration_files ++ migration_files
+
+    case files do
+      [] ->
+        if !opts.check || opts.dry_run do
+          Mix.shell().info(
+            "No changes detected, so no migrations or snapshots have been created."
+          )
+        end
+
+        :ok
+
+      files ->
+        cond do
+          opts.check ->
+            raise Ash.Error.Framework.PendingCodegen,
+              diff: files
+
+          opts.dry_run ->
+            Mix.shell().info(
+              files
+              |> Enum.sort_by(&elem(&1, 0))
+              |> Enum.map_join("\n\n", fn {file, contents} ->
+                "#{file}\n#{contents}"
+              end)
+            )
+
+          true ->
+            Enum.each(files, fn {file, contents} ->
+              Mix.Generator.create_file(file, contents, force?: true)
+            end)
+        end
+    end
   end
 
   @doc """
@@ -195,8 +228,7 @@ defmodule AshSqlite.MigrationGenerator do
         |> Enum.map(fn {_name, extension} -> extension end)
 
       if Enum.empty?(to_install) do
-        Mix.shell().info("No extensions to install")
-        :ok
+        []
       else
         {module, migration_name} =
           case to_install do
@@ -276,43 +308,19 @@ defmodule AshSqlite.MigrationGenerator do
 
         contents = format(contents, opts)
 
-        if opts.dry_run do
-          Mix.shell().info(snapshot_contents)
-          Mix.shell().info(contents)
-
-          if opts.check do
-            Mix.shell().error("""
-            Migrations would have been generated, but the --check flag was provided.
-
-            To see what migration would have been generated, run with the `--dry-run`
-            option instead. To generate those migrations, run without either flag.
-            """)
-
-            exit({:shutdown, 1})
-          end
-        else
-          if opts.check do
-            Mix.shell().error("""
-            Migrations would have been generated, but the --check flag was provided.
-
-            To see what migration would have been generated, run with the `--dry-run`
-            option instead. To generate those migrations, run without either flag.
-            """)
-
-            exit({:shutdown, 1})
-          end
-
-          create_file(snapshot_file, snapshot_contents, force: true)
-          create_file(migration_file, contents)
-        end
+        [
+          {snapshot_file, snapshot_contents},
+          {migration_file, contents}
+        ]
       end
     end
+    |> List.flatten()
   end
 
   defp create_migrations(snapshots, opts) do
     snapshots
     |> Enum.group_by(& &1.repo)
-    |> Enum.each(fn {repo, snapshots} ->
+    |> Enum.flat_map(fn {repo, snapshots} ->
       deduped = deduplicate_snapshots(snapshots, opts)
 
       snapshots_with_operations =
@@ -327,11 +335,7 @@ defmodule AshSqlite.MigrationGenerator do
       |> Enum.uniq()
       |> case do
         [] ->
-          Mix.shell().info(
-            "No changes detected, so no migrations or snapshots have been created."
-          )
-
-          :ok
+          []
 
         operations ->
           dev_migrations = get_dev_migrations(opts, repo)
@@ -350,23 +354,15 @@ defmodule AshSqlite.MigrationGenerator do
             end
           end
 
-          if opts.check do
-            IO.puts("""
-            Migrations would have been generated, but the --check flag was provided.
+          migration_files =
+            operations
+            |> organize_operations
+            |> build_up_and_down()
+            |> migration(repo, opts)
 
-            To see what migration would have been generated, run with the `--dry-run`
-            option instead. To generate those migrations, run without either flag.
-            """)
+          snapshot_files = create_new_snapshot(snapshots, repo_name(repo), opts)
 
-            exit({:shutdown, 1})
-          end
-
-          operations
-          |> organize_operations
-          |> build_up_and_down()
-          |> write_migration!(repo, opts)
-
-          create_new_snapshot(snapshots, repo_name(repo), opts)
+          [migration_files] ++ snapshot_files
       end
     end)
   end
@@ -844,7 +840,7 @@ defmodule AshSqlite.MigrationGenerator do
     repo |> Module.split() |> List.last() |> Macro.underscore()
   end
 
-  defp write_migration!({up, down}, repo, opts) do
+  defp migration({up, down}, repo, opts) do
     migration_path = migration_path(opts, repo)
 
     require_name!(opts)
@@ -905,35 +901,7 @@ defmodule AshSqlite.MigrationGenerator do
     """
 
     try do
-      contents = format(contents, opts)
-
-      if opts.dry_run do
-        Mix.shell().info(contents)
-
-        if opts.check do
-          Mix.shell().error("""
-          Migrations would have been generated, but the --check flag was provided.
-
-          To see what migration would have been generated, run with the `--dry-run`
-          option instead. To generate those migrations, run without either flag.
-          """)
-
-          exit({:shutdown, 1})
-        end
-      else
-        if opts.check do
-          Mix.shell().error("""
-          Migrations would have been generated, but the --check flag was provided.
-
-          To see what migration would have been generated, run with the `--dry-run`
-          option instead. To generate those migrations, run without either flag.
-          """)
-
-          exit({:shutdown, 1})
-        end
-
-        create_file(migration_file, contents)
-      end
+      {migration_file, format(contents, opts)}
     rescue
       exception ->
         reraise(
@@ -979,29 +947,30 @@ defmodule AshSqlite.MigrationGenerator do
   end
 
   defp create_new_snapshot(snapshots, repo_name, opts) do
-    unless opts.dry_run do
-      Enum.each(snapshots, fn snapshot ->
-        snapshot_binary = snapshot_to_binary(snapshot)
+    Enum.map(snapshots, fn snapshot ->
+      snapshot_binary = snapshot_to_binary(snapshot)
 
-        snapshot_folder =
-          opts
-          |> snapshot_path(snapshot.repo)
-          |> Path.join(repo_name)
+      snapshot_folder =
+        opts
+        |> snapshot_path(snapshot.repo)
+        |> Path.join(repo_name)
 
-        dev = if opts.dev, do: "_dev"
-        snapshot_file = Path.join(snapshot_folder, "#{snapshot.table}/#{timestamp()}#{dev}.json")
+      dev = if opts.dev, do: "_dev"
 
-        File.mkdir_p(Path.dirname(snapshot_file))
-        File.write!(snapshot_file, snapshot_binary, [])
+      snapshot_file =
+        Path.join(snapshot_folder, "#{snapshot.table}/#{timestamp()}#{dev}.json")
 
-        old_snapshot_folder = Path.join(snapshot_folder, "#{snapshot.table}#{dev}.json")
+      old_snapshot_folder = Path.join(snapshot_folder, "#{snapshot.table}#{dev}.json")
 
-        if File.exists?(old_snapshot_folder) do
-          new_snapshot_folder = Path.join(snapshot_folder, "#{snapshot.table}/initial#{dev}.json")
-          File.rename(old_snapshot_folder, new_snapshot_folder)
-        end
-      end)
-    end
+      if File.exists?(old_snapshot_folder) do
+        new_snapshot_folder = Path.join(snapshot_folder, "#{snapshot.table}/initial#{dev}.json")
+        File.rename(old_snapshot_folder, new_snapshot_folder)
+      end
+
+      File.mkdir_p(Path.dirname(snapshot_file))
+
+      {snapshot_file, snapshot_binary}
+    end)
   end
 
   @doc false
@@ -2108,10 +2077,14 @@ defmodule AshSqlite.MigrationGenerator do
   end
 
   defp renaming?(table, removing, opts) do
-    if opts.no_shell? do
-      raise "Unimplemented: cannot determine: Are you renaming #{table}.#{removing.source}? without shell input"
+    if opts.dev do
+      false
     else
-      Mix.shell().yes?("Are you renaming #{table}.#{removing.source}?")
+      if opts.no_shell? do
+        raise "Unimplemented: cannot determine: Are you renaming #{table}.#{removing.source}? without shell input"
+      else
+        Mix.shell().yes?("Are you renaming #{table}.#{removing.source}?")
+      end
     end
   end
 

mix.exs

@@ -130,7 +130,8 @@ defmodule AshSqlite.MixProject do
       {:ecto_sqlite3, "~> 0.12"},
       {:ecto, "~> 3.9"},
       {:jason, "~> 1.0"},
-      {:ash, ash_version("~> 3.4 and >= 3.4.58")},
+      # {:ash, ash_version("~> 3.4 and >= 3.4.58")},
+      {:ash, github: "ash-project/ash", override: true},
       {:ash_sql, ash_sql_version("~> 0.2 and >= 0.2.20")},
       {:igniter, "~> 0.5 and >= 0.5.16", optional: true},
       {:simple_sat, ">= 0.0.0", only: [:dev, :test]},
@@ -144,25 +145,6 @@ defmodule AshSqlite.MixProject do
     ]
   end
 
-  defp ash_version(default_version) do
-    case System.get_env("ASH_VERSION") do
-      nil ->
-        default_version
-
-      "local" ->
-        [path: "../ash", override: true]
-
-      "main" ->
-        [git: "https://github.com/ash-project/ash.git"]
-
-      version when is_binary(version) ->
-        "~> #{version}"
-
-      version ->
-        version
-    end
-  end
-
   defp ash_sql_version(default_version) do
     case System.get_env("ASH_SQL_VERSION") do
       nil ->

mix.lock

@@ -1,5 +1,5 @@
 %{
-  "ash": {:hex, :ash, "3.5.12", "435a6916d47e4ed6eabce886de2443d17af9dd9ca9765a29c73d9e02507b86b3", [:mix], [{:decimal, "~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:ecto, "~> 3.7", [hex: :ecto, repo: "hexpm", optional: false]}, {:ets, "~> 0.8", [hex: :ets, repo: "hexpm", optional: false]}, {:igniter, "~> 0.6", [hex: :igniter, repo: "hexpm", optional: true]}, {:jason, ">= 1.0.0", [hex: :jason, repo: "hexpm", optional: false]}, {:owl, "~> 0.11", [hex: :owl, repo: "hexpm", optional: false]}, {:picosat_elixir, "~> 0.2", [hex: :picosat_elixir, repo: "hexpm", optional: true]}, {:plug, ">= 0.0.0", [hex: :plug, repo: "hexpm", optional: true]}, {:reactor, "~> 0.11", [hex: :reactor, repo: "hexpm", optional: false]}, {:simple_sat, ">= 0.1.1 and < 1.0.0-0", [hex: :simple_sat, repo: "hexpm", optional: true]}, {:spark, ">= 2.2.60 and < 3.0.0-0", [hex: :spark, repo: "hexpm", optional: false]}, {:splode, ">= 0.2.6 and < 1.0.0-0", [hex: :splode, repo: "hexpm", optional: false]}, {:stream_data, "~> 1.0", [hex: :stream_data, repo: "hexpm", optional: false]}, {:telemetry, "~> 1.1", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "503492989c56e33c300d731b3717d1df9eeebba2b9018e5dd9f330db727edb57"},
+  "ash": {:git, "https://github.com/ash-project/ash.git", "e497a90e44f1aa43dde39c7b0f2ef5cb2826da61", []},
   "ash_sql": {:hex, :ash_sql, "0.2.76", "4afac3284194f3d7820b7edc1263ac1eb232a25734406ad7b2284683b9384205", [:mix], [{:ash, "~> 3.5", [hex: :ash, repo: "hexpm", optional: false]}, {:ecto, "~> 3.9", [hex: :ecto, repo: "hexpm", optional: false]}, {:ecto_sql, "~> 3.9", [hex: :ecto_sql, repo: "hexpm", optional: false]}], "hexpm", "f6bc02d8c4cba3f8f9a532e6ff73eaf8a4f7685257646a58fe7a320cfaf10c39"},
   "bunt": {:hex, :bunt, "1.0.0", "081c2c665f086849e6d57900292b3a161727ab40431219529f13c4ddcf3e7a44", [:mix], [], "hexpm", "dc5f86aa08a5f6fa6b8096f0735c4e76d54ae5c9fa2c143e5a1fc7c1cd9bb6b5"},
   "cc_precompiler": {:hex, :cc_precompiler, "0.1.10", "47c9c08d8869cf09b41da36538f62bc1abd3e19e41701c2cea2675b53c704258", [:mix], [{:elixir_make, "~> 0.7", [hex: :elixir_make, repo: "hexpm", optional: false]}], "hexpm", "f6e046254e53cd6b41c6bacd70ae728011aa82b2742a80d6e2214855c6e06b22"},
@@ -43,7 +43,7 @@
   "simple_sat": {:hex, :simple_sat, "0.1.3", "f650fc3c184a5fe741868b5ac56dc77fdbb428468f6dbf1978e14d0334497578", [:mix], [], "hexpm", "a54305066a356b7194dc81db2a89232bacdc0b3edaef68ed9aba28dcbc34887b"},
   "sobelow": {:hex, :sobelow, "0.14.0", "dd82aae8f72503f924fe9dd97ffe4ca694d2f17ec463dcfd365987c9752af6ee", [:mix], [{:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm", "7ecf91e298acfd9b24f5d761f19e8f6e6ac585b9387fb6301023f1f2cd5eed5f"},
   "sourceror": {:hex, :sourceror, "1.10.0", "38397dedbbc286966ec48c7af13e228b171332be1ad731974438c77791945ce9", [:mix], [], "hexpm", "29dbdfc92e04569c9d8e6efdc422fc1d815f4bd0055dc7c51b8800fb75c4b3f1"},
-  "spark": {:hex, :spark, "2.2.61", "64745581832caf136cbd654c1ecef98d291f3d1b347a14411b7d0dc726e3822b", [:mix], [{:igniter, ">= 0.3.64 and < 1.0.0-0", [hex: :igniter, repo: "hexpm", optional: true]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: true]}, {:sourceror, "~> 1.2", [hex: :sourceror, repo: "hexpm", optional: true]}], "hexpm", "cb10300e17f74b41848954d61630fb627f4e0d5acf9aacd7d9f312d5b119d50f"},
+  "spark": {:hex, :spark, "2.2.62", "610502559834465edce437de712bf7e6d59713ad48050789dbef69a798e71a3c", [:mix], [{:igniter, ">= 0.3.64 and < 1.0.0-0", [hex: :igniter, repo: "hexpm", optional: true]}, {:jason, "~> 1.4", [hex: :jason, repo: "hexpm", optional: true]}, {:sourceror, "~> 1.2", [hex: :sourceror, repo: "hexpm", optional: true]}], "hexpm", "726df72e1b9c17401584b4657e75e08a27a1cf6a6effa2486bf1c074da6176a7"},
   "spitfire": {:hex, :spitfire, "0.2.0", "0de1f519a23f65bde40d316adad53c07a9563f25cc68915d639d8a509a0aad8a", [:mix], [], "hexpm", "743daaee2d81a0d8095431729f478ce49b47ea8943c7d770de86704975cb7775"},
   "splode": {:hex, :splode, "0.2.9", "3a2776e187c82f42f5226b33b1220ccbff74f4bcc523dd4039c804caaa3ffdc7", [:mix], [], "hexpm", "8002b00c6e24f8bd1bcced3fbaa5c33346048047bb7e13d2f3ad428babbd95c3"},
   "stream_data": {:hex, :stream_data, "1.2.0", "58dd3f9e88afe27dc38bef26fce0c84a9e7a96772b2925c7b32cd2435697a52b", [:mix], [], "hexpm", "eb5c546ee3466920314643edf68943a5b14b32d1da9fe01698dc92b73f89a9ed"},

test/migration_generator_test.exs

@@ -443,15 +443,15 @@ defmodule AshSqlite.MigrationGeneratorTest do
       [domain: Domain]
     end
 
-    test "returns code(1) if snapshots and resources don't fit", %{domain: domain} do
-      assert catch_exit(
-               AshSqlite.MigrationGenerator.generate(domain,
-                 snapshot_path: "test_snapshot_path",
-                 migration_path: "test_migration_path",
-                 check: true,
-                 auto_name: true
-               )
-             ) == {:shutdown, 1}
+    test "raises an error on pending codegen", %{domain: domain} do
+      assert_raise Ash.Error.Framework.PendingCodegen, fn ->
+        AshSqlite.MigrationGenerator.generate(domain,
+          snapshot_path: "test_snapshot_path",
+          migration_path: "test_migration_path",
+          check: true,
+          auto_name: true
+        )
+      end
 
       refute File.exists?(Path.wildcard("test_migration_path2/**/*_migrate_resources*.exs"))
       refute File.exists?(Path.wildcard("test_snapshots_path2/test_repo/posts/*.json"))