improvement: Add multitenancy to and create consistency between gen.html and gen.live (#459)

This deals with adding multitenancy (#310) to the generators. This also makes the prompts (named actor/multitenancy/use actor) consistent between the generators.
---------

Co-authored-by: Trent Graw <candles-ultras.94@icloud.com>

Author: aVikingTrex

lib/ash_phoenix/gen/gen.ex

@@ -43,7 +43,10 @@ defmodule AshPhoenix.Gen do
           resource_plural: :string,
           resource_plural_for_routes: :string,
           actor: :string,
-          no_actor: :boolean
+          no_actor: :boolean,
+          scope: :boolean,
+          tenant: :string,
+          no_tenant: :boolean
         ]
       )
 
@@ -56,6 +59,82 @@ defmodule AshPhoenix.Gen do
     {domain, resource, parsed, rest}
   end
 
+  def prompt_for_multitenancy(opts) do
+    cond do
+      opts[:scope] ->
+        opts
+
+      opts[:no_actor] ->
+        Keyword.put(opts, :actor, nil)
+
+      opts[:actor] || opts[:tenant] ->
+        opts
+
+      true ->
+        if Mix.shell().yes?("Are you using multi-tenancy?") do
+          if Mix.shell().yes?(
+               "Would you like to use scope, or separate actor and tenant? Choose yes for scope, no for separate actor and tenant."
+             ) do
+            Keyword.put(opts, :scope, true)
+          else
+            opts = prompt_for_actor(opts)
+            prompt_for_tenant(opts)
+          end
+        else
+          prompt_for_actor(opts)
+        end
+    end
+  end
+
+  def prompt_for_actor(opts) do
+    if Mix.shell().yes?(
+         "Would you like to name your actor? For example: `current_user`. If you choose no, we will not add any actor logic."
+       ) do
+      actor =
+        Mix.shell().prompt("What would you like to name it? Default: `current_user`")
+        |> String.trim()
+
+      if actor == "" do
+        Keyword.put(opts, :actor, "current_user")
+      else
+        Keyword.put(opts, :actor, actor)
+      end
+    else
+      opts
+    end
+  end
+
+  def prompt_for_tenant(opts) do
+    tenant =
+      Mix.shell().prompt("What would you like to name your tenant? Default: `current_tenant`")
+      |> String.trim()
+
+    if tenant == "" do
+      Keyword.put(opts, :tenant, "current_tenant")
+    else
+      Keyword.put(opts, :tenant, tenant)
+    end
+  end
+
+  def actor_opt(opts, assigns_source) do
+    cond do
+      opts[:scope] ->
+        ", scope: #{assigns_source}.scope"
+
+      opts[:actor] && opts[:tenant] ->
+        ", actor: #{assigns_source}.#{opts[:actor]}, tenant: #{assigns_source}.#{opts[:tenant]}"
+
+      opts[:actor] ->
+        ", actor: #{assigns_source}.#{opts[:actor]}"
+
+      opts[:tenant] ->
+        ", tenant: #{assigns_source}.#{opts[:tenant]}"
+
+      true ->
+        ""
+    end
+  end
+
   defp plural_name!(resource, opts) do
     plural_name =
       opts[:resource_plural] ||

lib/ash_phoenix/gen/live.ex

@@ -33,22 +33,8 @@ if Code.ensure_loaded?(Igniter) do
       Code.ensure_compiled!(resource)
 
       opts =
-        if !opts[:actor] && opts[:interactive?] && !opts[:no_actor] do
-          if Mix.shell().yes?(
-               "Would you like to name your actor? For example: `current_user`. If you choose no, we will not add any actor logic."
-             ) do
-            actor =
-              Mix.shell().prompt("What would you like to name it? Default: `current_user`")
-              |> String.trim()
-
-            if actor == "" do
-              Keyword.put(opts, :actor, "current_user")
-            else
-              Keyword.put(opts, :actor, actor)
-            end
-          else
-            opts
-          end
+        if opts[:interactive?] do
+          AshPhoenix.Gen.prompt_for_multitenancy(opts)
         else
           opts
         end
@@ -74,7 +60,9 @@ if Code.ensure_loaded?(Igniter) do
           resource: inspect(resource),
           web_module: inspect(web_module(igniter)),
           actor: opts[:actor],
-          actor_opt: actor_opt(opts)
+          scope: opts[:scope],
+          tenant: opts[:tenant],
+          actor_opt: AshPhoenix.Gen.actor_opt(opts, "socket.assigns")
         ]
         |> add_resource_assigns(resource, opts)
 
@@ -296,13 +284,13 @@ if Code.ensure_loaded?(Igniter) do
           nil ->
             """
             #{short_name} = #{get_by_pkey}
-            Ash.destroy!(#{short_name}#{actor_opt(opts)})
+            Ash.destroy!(#{short_name}#{AshPhoenix.Gen.actor_opt(opts, "socket.assigns")})
             """
 
           interface ->
             """
             #{short_name} = #{get_by_pkey}
-            #{inspect(resource)}.#{interface.name}!(#{short_name}#{actor_opt(opts)})
+            #{inspect(resource)}.#{interface.name}!(#{short_name}#{AshPhoenix.Gen.actor_opt(opts, "socket.assigns")})
             """
         end
       end
@@ -316,18 +304,10 @@ if Code.ensure_loaded?(Igniter) do
       end)
       |> case do
         nil ->
-          "Ash.get!(#{inspect(resource)}, #{pkey}#{actor_opt(opts)})"
+          "Ash.get!(#{inspect(resource)}, #{pkey}#{AshPhoenix.Gen.actor_opt(opts, "socket.assigns")})"
 
         interface ->
-          "#{inspect(resource)}.#{interface.name}!(#{pkey}#{actor_opt(opts)})"
-      end
-    end
-
-    defp actor_opt(opts) do
-      if opts[:actor] do
-        ", actor: socket.assigns.#{opts[:actor]}"
-      else
-        ""
+          "#{inspect(resource)}.#{interface.name}!(#{pkey}#{AshPhoenix.Gen.actor_opt(opts, "socket.assigns")})"
       end
     end
 

lib/mix/tasks/ash_phoenix.gen.html.ex

@@ -31,7 +31,9 @@ defmodule Mix.Tasks.AshPhoenix.Gen.Html do
     not_umbrella!()
     Mix.Task.run("compile")
 
-    {domain, resource, opts, _} = AshPhoenix.Gen.parse_opts(args)
+    {domain, resource, parsed_opts, _} = AshPhoenix.Gen.parse_opts(args)
+
+    parsed_opts = AshPhoenix.Gen.prompt_for_multitenancy(parsed_opts)
 
     singular = to_string(Ash.Resource.Info.short_name(resource))
 
@@ -40,8 +42,13 @@ defmodule Mix.Tasks.AshPhoenix.Gen.Html do
       full_resource: resource,
       full_domain: domain,
       singular: singular,
-      plural: opts[:resource_plural],
-      plural_for_routes: opts[:resource_plural_for_routes] || opts[:resource_plural]
+      plural: parsed_opts[:resource_plural],
+      plural_for_routes:
+        parsed_opts[:resource_plural_for_routes] || parsed_opts[:resource_plural],
+      actor: parsed_opts[:actor],
+      scope: parsed_opts[:scope],
+      tenant: parsed_opts[:tenant],
+      actor_opt: AshPhoenix.Gen.actor_opt(parsed_opts, "conn.assigns")
     }
 
     if Code.ensure_loaded?(resource) do
@@ -80,6 +87,7 @@ defmodule Mix.Tasks.AshPhoenix.Gen.Html do
     |> Keyword.merge(
       route_prefix: to_string(opts[:plural_for_routes]),
       app_name: app_name(),
+      actor_opt: opts[:actor_opt] || "",
       attributes: attributes(resource),
       update_attributes: update_attributes(resource),
       create_attributes: create_attributes(resource)

lib/mix/tasks/ash_phoenix.gen.live.ex

@@ -42,6 +42,9 @@ if Code.ensure_loaded?(Igniter) do
           resourceplural: :string,
           resource_plural: :string,
           resource_plural_for_routes: :string,
+          scope: :boolean,
+          tenant: :string,
+          no_tenant: :boolean,
           phx_version: :string
         ],
         # Default values for the options in the `schema`.

priv/templates/ash_phoenix.gen.html/controller.ex.eex

@@ -4,17 +4,17 @@ defmodule <%= @app_name %>Web.<%= @resource %>Controller do
   alias <%= inspect @full_resource %>
 
   def index(conn, _params) do
-    <%= @plural %> = Ash.read!(<%= @resource %>)
+    <%= @plural %> = Ash.read!(<%= @resource %><%= @actor_opt %>)
     render(conn, :index, <%= @plural %>: <%= @plural %>)
   end
 
   def new(conn, _params) do
-    render(conn, :new, form: create_form())
+    render(conn, :new, form: create_form(conn))
   end
 
   def create(conn, %{"<%= @singular %>" => <%= @singular %>_params}) do
     <%= @singular %>_params
-      |> create_form()
+      |> create_form(conn)
       |> AshPhoenix.Form.submit()
       |> case do
         {:ok, <%= @singular %>} ->
@@ -30,21 +30,21 @@ defmodule <%= @app_name %>Web.<%= @resource %>Controller do
   end
 
   def show(conn, %{"id" => id}) do
-    <%= @singular %> = Ash.get!(<%= @resource %>, id)
+    <%= @singular %> = Ash.get!(<%= @resource %>, id<%= @actor_opt %>)
     render(conn, :show, <%= @singular %>: <%= @singular %>)
   end
 
   def edit(conn, %{"id" => id}) do
-    <%= @singular %> = Ash.get!(<%= @resource %>, id)
+    <%= @singular %> = Ash.get!(<%= @resource %>, id<%= @actor_opt %>)
 
-    render(conn, :edit, <%= @singular %>: <%= @singular %>, form: update_form(<%= @singular %>))
+    render(conn, :edit, <%= @singular %>: <%= @singular %>, form: update_form(conn, <%= @singular %>))
   end
 
   def update(conn, %{"<%= @singular %>" => <%= @singular %>_params, "id" => id}) do
-    <%= @singular %> = Ash.get!(<%= @resource %>, id)
+    <%= @singular %> = Ash.get!(<%= @resource %>, id<%= @actor_opt %>)
 
     <%= @singular %>
-    |> update_form(<%= @singular %>_params)
+    |> update_form(conn, <%= @singular %>_params)
     |> AshPhoenix.Form.submit()
     |> case do
       {:ok, <%= @singular %>} ->
@@ -60,19 +60,19 @@ defmodule <%= @app_name %>Web.<%= @resource %>Controller do
   end
 
   def delete(conn, %{"id" => id}) do
-    <%= @singular %> = Ash.get!(<%= @resource %>, id)
-    Ash.destroy!(<%= @singular %>)
+    <%= @singular %> = Ash.get!(<%= @resource %>, id<%= @actor_opt %>)
+    Ash.destroy!(<%= @singular %><%= @actor_opt %>)
 
     conn
     |> put_flash(:info, "<%= @resource %> deleted successfully.")
     |> redirect(to: ~p"/<%= @plural %>")
   end
 
-  defp create_form(params \\ nil) do
-    AshPhoenix.Form.for_create(<%= @resource %>, :create, as: "<%= @singular %>", params: params)
+  defp create_form(conn, params \\ nil) do
+    AshPhoenix.Form.for_create(<%= @resource %>, :create, as: "<%= @singular %>", params: params<%= @actor_opt %>)
   end
 
-  defp update_form(<%= @singular %>, params \\ nil) do
-    AshPhoenix.Form.for_update(<%= @singular %>, :update, as: "<%= @singular %>", params: params)
+  defp update_form(conn, <%= @singular %>, params \\ nil) do
+    AshPhoenix.Form.for_update(<%= @singular %>, :update, as: "<%= @singular %>", params: params<%= @actor_opt %>)
   end
 end

priv/templates/ash_phoenix.gen.live/new/index.ex.eex

@@ -52,10 +52,20 @@ defmodule <%= inspect Module.concat(@web_module, @resource_alias) %>Live.Index d
     {:ok,
       socket
       |> assign(:page_title, "Listing <%= @resource_human_plural %>")
-      <%= if @actor do %>
+      <%= cond do %>
+      <% @scope -> %>
+      |> stream(:<%= @resource_plural %>, Ash.read!(<%= @resource %>, scope: socket.assigns.scope))}
+      <% @actor && @tenant -> %>
+      |> assign_new(:<%= @actor %>, fn -> nil end)
+      |> assign_new(:<%= @tenant %>, fn -> nil end)
+      |> stream(:<%= @resource_plural %>, Ash.read!(<%= @resource %>, actor: socket.assigns[:<%= @actor %>], tenant: socket.assigns[:<%= @tenant %>]))}
+      <% @actor -> %>
       |> assign_new(:<%= @actor %>, fn -> nil end)
       |> stream(:<%= @resource_plural %>, Ash.read!(<%= @resource %>, actor: socket.assigns[:<%= @actor %>]))}
-      <% else %>
+      <% @tenant -> %>
+      |> assign_new(:<%= @tenant %>, fn -> nil end)
+      |> stream(:<%= @resource_plural %>, Ash.read!(<%= @resource %>, tenant: socket.assigns[:<%= @tenant %>]))}
+      <% true -> %>
       |> stream(:<%= @resource_plural %>, Ash.read!(<%= @resource %>))}
       <% end %>
   end