Add LiveViewNative.LiveView dispatch_to

This allows for finer grain control over which module the rendering
dispatches to

CHANGELOG.md

@@ -22,6 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - `LiveViewNative.Component` no longer imports `Phoenix.Component.to_form/2`
+- `LiveViewNative.LiveView` now requires the `dispatch_to` function to determine which module will be used for rendering
 
 ### Fixed
 

lib/live_view_native/live_view.ex

@@ -19,16 +19,17 @@ defmodule LiveViewNative.LiveView do
 
       defmodule MyAppWeb.HomeLive do
         use MyAppWeb, :live_view
-        use LiveViewNative,
+        use LiveViewNative.LiveView,
           formats: [:swiftui, :jetpack],
           layouts: [
             swiftui: {MyAppWeb.Layouts.SwiftUI, :app},
             jetpack: {MyAppWeb.Layouts.Jetpack, :app}
-          ]
+          ],
+          dispatch_to: &Module.concat/2
       end
 
   ## Options
-      * `:formats` - the formats this LiveView will delegate to
+    * `:formats` - the formats this LiveView will delegate to
       a render component. For example, specifying `formats: [:swiftui, jetpack]`
       for a LiveView named `MyAppWeb.HomeLive` will
       invoke `MyAppWeb.HomeLive.SwiftUI` and `MyAppWeb.HomeLivew.Jetpack` when
@@ -38,19 +39,37 @@ defmodule LiveViewNative.LiveView do
 
     * `:layouts` - which layouts to render for each format,
       for example: `[swiftui: {MyAppWeb.Layouts.SwiftUI, :app}]`
+
+    * `:dispatch_to` - a function that takes the parent LiveView module
+      and the format's `plugin.module_suffix` and will determine
+      which module the `render/1` function will be called on
   """
   defmacro __using__(opts) do
     quote do
       on_mount {LiveViewNative.ContentNegotiator, :call}
-      @native_opts unquote(opts)
+      @native_opts unquote(Keyword.take(opts, [:formats, :layouts, :dispatch_to]))
       @before_compile LiveViewNative.LiveView
     end
   end
 
+  defp can_dispatch?(nil), do: false
+  defp can_dispatch?(dispatch_fn) when is_function(dispatch_fn),
+    do: Function.info(dispatch_fn)[:arity] == 2
+  defp can_dispatch?(_dispatch_fn), do: false
+
   @doc false
   defmacro __before_compile__(%{module: module} = env) do
     opts = Module.get_attribute(module, :native_opts)
     formats = opts[:formats]
+    dispatch_fn = opts[:dispatch_to]
+    if (!can_dispatch?(dispatch_fn)) do
+      raise """
+      A function with arity 2 must be passed to `dispatch_to` for `use LiveViewNative.LiveView` on module #{inspect(module)}.
+      You passed #{inspect(dispatch_fn)}
+
+      See docmentation for `LiveViewNative.LiveView.__using__/1`
+      """
+    end
     fallback_layouts = normalize_layouts(opts[:layouts])
 
     cond do
@@ -59,7 +78,7 @@ defmodule LiveViewNative.LiveView do
           Enum.reduce(formats, {%{}, %{}}, fn(format, {layouts, render_withs}) ->
             case LiveViewNative.fetch_plugin(format) do
               {:ok, plugin} ->
-                render_module = Module.concat(module, plugin.module_suffix)
+                render_module = dispatch_fn.(module, plugin.module_suffix)
                 fallback_layout = fallback_layouts[format]
                 render_with = Function.capture(render_module, :render, 1)
 

priv/templates/lvn.gen/app_name_native.ex

@@ -50,7 +50,8 @@ defmodule <%= inspect context.native_module %> do
         layouts: [<%= if plugins? do %><%= for plugin <- plugins do %>
           <%= plugin.format %>: {<%= inspect(Module.concat([context.web_module, Layouts, plugin.module_suffix])) %>, :app}<%= unless last?.(plugins, plugin) do %>,<% end %><% end %><% else %>
           # swiftui: {<%= inspect(Module.concat([context.web_module, Layouts, SwiftUI])) %>, :app}<% end %>
-        ]
+        ],
+        dispatch_to: &Module.concat/2
 
       unquote(verified_routes())
     end

test/support/live/cids_destroyed_live.ex

@@ -2,7 +2,8 @@ defmodule LiveViewNativeTest.CidsDestroyedLive do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   defmodule GameBoy do
     use LiveViewNative.Component,

test/support/live/component_and_nested_in_live.ex

@@ -2,7 +2,8 @@ defmodule LiveViewNativeTest.ComponentAndNestedInLive do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   defmodule GameBoy do
     use LiveViewNative.Component,
@@ -13,7 +14,8 @@ defmodule LiveViewNativeTest.ComponentAndNestedInLive do
       use Phoenix.LiveView
 
       use LiveViewNative.LiveView,
-        formats: [:gameboy]
+        formats: [:gameboy],
+        dispatch_to: &Module.concat/2
 
       defmodule GameBoy do
         use LiveViewNative.Component,

test/support/live/component_in_live.ex

@@ -2,7 +2,8 @@ defmodule LiveViewNativeTest.ComponentInLive.Root do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   def mount(_params, _session, socket) do
     {:ok, assign(socket, :enabled, true)}
@@ -30,7 +31,8 @@ defmodule LiveViewNativeTest.ComponentInLive.Live do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   def render(assigns) do
     ~H"In HTML 2"

test/support/live/components.ex

@@ -251,7 +251,8 @@ defmodule LiveViewNativeTest.WithComponentLive do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   def render(assigns), do: ~H"In HTML"
 
@@ -315,7 +316,8 @@ defmodule LiveViewNativeTest.WithMultipleTargets do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   def render(assigns), do: ~H"In HTML"
 
@@ -369,7 +371,8 @@ defmodule LiveViewNativeTest.WithLogOverride do
   use Phoenix.LiveView, log: :warning
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   def render(assigns), do: ~H"In HTML"
 
@@ -391,7 +394,8 @@ defmodule LiveViewNativeTest.WithLogDisabled do
   use Phoenix.LiveView, log: false
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   def render(assigns), do: ~H"In HTML"
 

test/support/live/general.ex

@@ -2,7 +2,8 @@ defmodule LiveViewNativeTest.ThermostatLive do
   use Phoenix.LiveView, container: {:article, class: "thermo"}, namespace: Phoenix.LiveViewTest
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   alias LiveViewNativeTest.ClockLive
 
@@ -102,7 +103,8 @@ defmodule LiveViewNativeTest.ClockLive do
   use Phoenix.LiveView, container: {:section, class: "clock"}
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   alias LiveViewNativeTest.ClockControlsLive
 
@@ -151,7 +153,8 @@ defmodule LiveViewNativeTest.ClockControlsLive do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   defmodule GameBoy do
     use LiveViewNative.Component,
@@ -179,7 +182,8 @@ end
 defmodule LiveViewNativeTest.DashboardLive do
   use Phoenix.LiveView, container: {:div, class: inspect(__MODULE__)}
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
     defmodule GameBoy do
       use LiveViewNative.Component,
@@ -204,7 +208,8 @@ end
 defmodule LiveViewNativeTest.AssignAsyncLive do
   use Phoenix.LiveView
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   on_mount({__MODULE__, :defaults})
 

test/support/live/inline_live.ex

@@ -42,7 +42,8 @@ defmodule LiveViewNativeTest.InlineLive do
     formats: [:gameboy, :switch],
     layouts: [
       gameboy: {LiveViewNativeTest.GameBoyLayouts, :app}
-    ]
+    ],
+    dispatch_to: &Module.concat/2
 
   def mount(_params, _session, socket) do
     {:ok, assign(socket, :count, 100)}

test/support/live/params.ex

@@ -2,7 +2,8 @@ defmodule LiveViewNativeTest.ParamCounterLive do
   use Phoenix.LiveView
 
   use LiveViewNative.LiveView,
-    formats: [:gameboy]
+    formats: [:gameboy],
+    dispatch_to: &Module.concat/2
 
   defmodule GameBoy do
     use LiveViewNative.Component,

test/support/live/template_live.ex

@@ -18,7 +18,8 @@ defmodule LiveViewNativeTest.TemplateLive do
     formats: [:gameboy, :switch],
     layouts: [
       gameboy: {LiveViewNativeTest.GameBoyLayouts, :app}
-    ]
+    ],
+    dispatch_to: &Module.concat/2
 
   def mount(_params, _session, socket) do
     {:ok, assign(socket, :count, 200)}