Remove compile-time dep between examples and subjects (#774)

Author: msaraiva

lib/surface/catalogue.ex

@@ -67,17 +67,23 @@ defmodule Surface.Catalogue do
 
   @doc false
   def get_metadata(module) do
-    case Code.fetch_docs(module) do
-      {:docs_v1, _, _, "text/markdown", docs, %{catalogue: meta}, _} ->
-        doc =
-          if :hidden == docs,
-            do: "",
-            else: Map.get(docs, "en")
+    if Code.ensure_loaded?(module) and function_exported?(module, :__catalogue__, 0) do
+      meta = module.__catalogue__()
 
-        meta |> Map.new() |> Map.put(:doc, doc)
+      case Code.fetch_docs(module) do
+        {:docs_v1, _, _, "text/markdown", docs, _, _} ->
+          doc =
+            if :hidden == docs,
+              do: "",
+              else: Map.get(docs, "en")
 
-      _ ->
-        nil
+          meta |> Map.new() |> Map.put(:doc, doc)
+
+        _ ->
+          meta |> Map.new()
+      end
+    else
+      nil
     end
   end
 

lib/surface/catalogue/examples.ex

@@ -95,18 +95,20 @@ defmodule Surface.Catalogue.Examples do
     subject = Surface.Catalogue.fetch_subject!(opts, __MODULE__, __CALLER__)
     Module.register_attribute(__CALLER__.module, :__examples__, accumulate: true)
 
+    lv_opts = Keyword.drop(opts, [:subject, :catalogue, :height, :title, :body, :direction, :code_perc, :assert])
+
     quote do
       @after_compile unquote(__MODULE__)
       @__use_line__ unquote(__CALLER__.line)
       @before_compile unquote(__MODULE__)
       @on_definition unquote(__MODULE__)
 
-      use Surface.LiveView, unquote(opts)
+      use Surface.LiveView, unquote(lv_opts)
 
       alias unquote(subject)
       require Surface.Catalogue.Data, as: Data
 
-      @__example_config__ unquote(opts)
+      @__example_config__ unquote(Macro.escape(opts))
 
       import Surface, except: [sigil_F: 2]
 
@@ -141,12 +143,15 @@ defmodule Surface.Catalogue.Examples do
       |> Enum.reverse()
 
     quote do
-      @moduledoc catalogue: [
-                   type: :example,
-                   subject: unquote(subject),
-                   config: unquote(config),
-                   examples_configs: unquote(examples_configs)
-                 ]
+      @doc false
+      def __catalogue__ do
+        [
+          type: :example,
+          subject: unquote(subject),
+          config: unquote(config),
+          examples_configs: unquote(examples_configs)
+        ]
+      end
     end
   end
 

lib/surface/catalogue/live_example.ex

@@ -56,13 +56,15 @@ defmodule Surface.Catalogue.LiveExample do
   defmacro __using__(opts) do
     subject = Surface.Catalogue.fetch_subject!(opts, __MODULE__, __CALLER__)
 
+    lv_opts = Keyword.drop(opts, [:subject, :catalogue, :height, :title, :body, :direction, :code_perc, :assert])
+
     quote do
-      @__example_config__ unquote(opts)
+      @__example_config__ unquote(Macro.escape(opts))
       @__use_line__ unquote(__CALLER__.line)
       @after_compile unquote(__MODULE__)
       @before_compile unquote(__MODULE__)
 
-      use Surface.LiveView, unquote(opts)
+      use Surface.LiveView, unquote(lv_opts)
 
       alias unquote(subject)
       require Surface.Catalogue.Data, as: Data
@@ -104,12 +106,15 @@ defmodule Surface.Catalogue.LiveExample do
     ]
 
     quote do
-      @moduledoc catalogue: [
-                   type: :example,
-                   subject: unquote(subject),
-                   config: unquote(config),
-                   examples_configs: unquote(examples_configs)
-                 ]
+      @doc false
+      def __catalogue__ do
+        [
+          type: :example,
+          subject: unquote(subject),
+          config: unquote(config),
+          examples_configs: unquote(examples_configs)
+        ]
+      end
     end
   end
 

lib/surface/catalogue/playground.ex

@@ -53,13 +53,15 @@ defmodule Surface.Catalogue.Playground do
   defmacro __using__(opts) do
     subject = Surface.Catalogue.fetch_subject!(opts, __MODULE__, __CALLER__)
 
+    lv_opts = Keyword.drop(opts, [:subject, :catalogue, :height, :title, :body, :direction, :code_perc, :assert])
+
     quote do
       @config unquote(opts)
       @after_compile unquote(__MODULE__)
       @__use_line__ unquote(__CALLER__.line)
       @before_compile unquote(__MODULE__)
 
-      use Surface.LiveView, unquote(opts)
+      use Surface.LiveView, unquote(lv_opts)
 
       alias unquote(subject)
       require Surface.Catalogue.Data, as: Data
@@ -129,11 +131,14 @@ defmodule Surface.Catalogue.Playground do
 
     common_ast =
       quote do
-        @moduledoc catalogue: [
-                     type: :playground,
-                     subject: unquote(subject),
-                     config: unquote(config)
-                   ]
+        @doc false
+        def __catalogue__ do
+          [
+            type: :playground,
+            subject: unquote(subject),
+            config: unquote(config)
+          ]
+        end
 
         data props, :keyword, default: unquote(Macro.escape(props_data))
         data slots, :keyword, default: unquote(slots_data)