feat: site assign (#20)

Author: mhanberg

README.md

@@ -31,6 +31,16 @@ Documentation can be found at <https://hexdocs.pm/tableau>.
 
 The examples in the README use the [Temple](https://github.com/mhanberg/temple) library to demonstrate that Tableau can be used with any markup language of your choice. You could easily use the builtin EEx, or use HEEx, Surface, or HAML.
 
+### Layouts
+
+Layouts are modules that use the `use Tableau.Layout` macro.
+
+Layouts have assess to the `@site` and `@page` assign.
+
+The `@site` assign contains your site's config.
+
+The `@page` assign contains all the options passed to the `use Tableau.Page` macro.
+
 ```elixir
 defmodule MySite.RootLayout do
   use Tableau.Layout
@@ -47,6 +57,10 @@ defmodule MySite.RootLayout do
           meta http_equiv: "X-UA-Compatible", content: "IE=edge"
           meta name: "viewport", content: "width=device-width, initial-scale=1.0"
 
+          title do
+            @page.some_assign
+          end
+
           link rel: "stylesheet", href: "/css/site.css"
         end
 
@@ -77,11 +91,21 @@ end
 
 #### Page
 
+Pages are modules that use the `use Tableau.Page` macro.
+
+Required options:
+
+* `:layout` - which layout module to use.
+* `:permalink` - the permalink of the page
+
+Any remaining options are arbitrary and will be available under the `@page` assign available to layout and page templates.
+
 ```elixir
 defmodule MySite.AboutPage do
   use Tableau.Page,
     layout: MySite.RootLayout,
-    permalink: "/about"
+    permalink: "/about",
+    some_assign: "foo"
 
   import Temple
 
@@ -186,7 +210,8 @@ Other static assets can be copied into the "out" directory by placing them in an
 This directory can be configured.
 
 ```elixir
-config :tableau, :include, "static"
+config :tableau, :config,
+  include_dir: "static"
 ```
 
 ### Development

lib/mix/tasks/tableau.build.ex

@@ -6,10 +6,12 @@ defmodule Mix.Tasks.Tableau.Build do
   @moduledoc "Task to build the tableau site"
   @shortdoc "Builds the site"
 
-  @include_dir Application.compile_env(:tableau, :include, "extra")
+  @config Application.compile_env(:tableau, :config, %{})
 
   @impl Mix.Task
   def run(argv) do
+    {:ok, config} = Tableau.Config.new(@config)
+    site = %{config: config}
     Mix.Task.run("app.start", ["--preload-modules"])
 
     {opts, _argv} = OptionParser.parse!(argv, strict: [out: :string])
@@ -19,7 +21,7 @@ defmodule Mix.Tasks.Tableau.Build do
     mods = :code.all_available()
 
     for module <- pre_build_extensions(mods) do
-      with :error <- module.run(%{site: %{}}) do
+      with :error <- module.run(%{site: site}) do
         Logger.error("#{inspect(module)} failed to run")
       end
     end
@@ -28,8 +30,17 @@ defmodule Mix.Tasks.Tableau.Build do
     graph = Tableau.Graph.new(mods)
     File.mkdir_p!(out)
 
-    for mod <- Graph.vertices(graph), {:ok, :page} == Tableau.Graph.Node.type(mod) do
-      content = Tableau.Document.render(graph, mod, %{site: %{}})
+    pages =
+      for mod <- Graph.vertices(graph), {:ok, :page} == Tableau.Graph.Node.type(mod) do
+        {mod, Map.new(mod.__tableau_opts__() || [])}
+      end
+
+    {mods, pages} = Enum.unzip(pages)
+
+    site = Map.put(site, :pages, pages)
+
+    for mod <- mods do
+      content = Tableau.Document.render(graph, mod, %{site: site})
       permalink = mod.__tableau_permalink__()
       dir = Path.join(out, permalink)
 
@@ -38,8 +49,8 @@ defmodule Mix.Tasks.Tableau.Build do
       File.write!(Path.join(dir, "index.html"), content)
     end
 
-    if File.exists?(@include_dir) do
-      File.cp_r!(@include_dir, out)
+    if File.exists?(config.include_dir) do
+      File.cp_r!(config.include_dir, out)
     end
   end
 

lib/tableau/config.ex

@@ -0,0 +1,17 @@
+defmodule Tableau.Config do
+  @moduledoc false
+
+  import Schematic
+
+  defstruct include_dir: "extra"
+
+  def new(config) do
+    unify(schematic(), config)
+  end
+
+  defp schematic do
+    schema(__MODULE__, %{
+      optional(:include_dir) => str()
+    })
+  end
+end

lib/tableau/document.ex

@@ -10,7 +10,7 @@ defmodule Tableau.Document do
       quote do
         case unquote(inner_content) do
           [{module, page_assigns} | rest] ->
-            module.template(Map.merge(page_assigns, %{inner_content: rest}))
+            module.template(%{page: page_assigns, inner_content: rest})
 
           [] ->
             nil
@@ -31,10 +31,9 @@ defmodule Tableau.Document do
           raise "Failed to find layout path for #{inspect(module)}"
       end
 
-    page_assigns = Map.new(module.__tableau_extra__() || [])
+    page_assigns = Map.new(module.__tableau_opts__() || [])
     mods = for mod <- mods, do: {mod, page_assigns}
-    new_assigns = Map.merge(page_assigns, %{inner_content: mods})
 
-    root.template(Map.merge(assigns, new_assigns))
+    root.template(Map.merge(assigns, %{inner_content: mods, page: page_assigns}))
   end
 end

lib/tableau/page.ex

@@ -32,15 +32,16 @@ defmodule Tableau.Page do
   @callback template(assigns()) :: template()
 
   defmacro __using__(opts) do
-    opts = Keyword.validate!(opts, [:layout, :permalink, extra: []])
+    layout = Keyword.fetch!(opts, :layout)
+    permalink = Keyword.fetch!(opts, :permalink)
 
     quote do
       @behaviour unquote(__MODULE__)
 
       def __tableau_type__, do: :page
-      def __tableau_parent__, do: unquote(opts[:layout])
-      def __tableau_permalink__, do: unquote(opts[:permalink])
-      def __tableau_extra__, do: unquote(opts[:extra])
+      def __tableau_parent__, do: unquote(layout)
+      def __tableau_permalink__, do: unquote(permalink)
+      def __tableau_opts__, do: unquote(opts)
     end
   end
 end

mix.exs

@@ -32,14 +32,14 @@ defmodule Tableau.MixProject do
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
+      {:ex_doc, ">= 0.0.0", only: :dev},
+      {:file_system, "~> 0.2"},
       {:libgraph, "~> 0.16.0"},
       {:plug_cowboy, "~> 2.0"},
       {:plug_static_index_html, "~> 1.0"},
-      {:file_system, "~> 0.2"},
-      {:ex_doc, ">= 0.0.0", only: :dev},
+      {:schematic, "~> 0.3"},
       # {:yaml_front_matter, "~> 1.0"},
       # {:jason, "~> 1.4"},
-      # {:toml, "~> 0.6.2"},
       # {:req, "~> 0.3", only: :test},
       # {:bypass, "~> 2.0", only: :test},
       # {:earmark, "~> 1.4"},

mix.lock

@@ -17,5 +17,6 @@
   "plug_crypto": {:hex, :plug_crypto, "1.2.2", "05654514ac717ff3a1843204b424477d9e60c143406aa94daf2274fdd280794d", [:mix], [], "hexpm", "87631c7ad914a5a445f0a3809f99b079113ae4ed4b867348dd9eec288cecb6db"},
   "plug_static_index_html": {:hex, :plug_static_index_html, "1.0.0", "840123d4d3975585133485ea86af73cb2600afd7f2a976f9f5fd8b3808e636a0", [:mix], [{:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm", "79fd4fcf34d110605c26560cbae8f23c603ec4158c08298bd4360fdea90bb5cf"},
   "ranch": {:hex, :ranch, "1.8.0", "8c7a100a139fd57f17327b6413e4167ac559fbc04ca7448e9be9057311597a1d", [:make, :rebar3], [], "hexpm", "49fbcfd3682fab1f5d109351b61257676da1a2fdbe295904176d5e521a2ddfe5"},
-  "telemetry": {:hex, :telemetry, "1.1.0", "a589817034a27eab11144ad24d5c0f9fab1f58173274b1e9bae7074af9cbee51", [:rebar3], [], "hexpm", "b727b2a1f75614774cff2d7565b64d0dfa5bd52ba517f16543e6fc7efcc0df48"},
+  "schematic": {:hex, :schematic, "0.3.0", "936df3904d0d17de543530fbe8e7ea8f7e3b7f0a5da0fedfa85440a2ca77bdfc", [:mix], [{:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "bd6dafb8792f77e4b321ba529572bd97792a3a6b7cec75d736b7ecc4031dff9e"},
+  "telemetry": {:hex, :telemetry, "1.2.1", "68fdfe8d8f05a8428483a97d7aab2f268aaff24b49e0f599faa091f1d4e7f61c", [:rebar3], [], "hexpm", "dad9ce9d8effc621708f99eac538ef1cbe05d6a874dd741de2e689c47feafed5"},
 }

test/mix/tasks/tableau.build_test.exs

@@ -24,7 +24,7 @@ defmodule Mix.Tasks.Tableau.BuildTest.About do
   def __tableau_type__, do: :page
   def __tableau_parent__, do: InnerLayout
   def __tableau_permalink__, do: "/about"
-  def __tableau_extra__, do: []
+  def __tableau_opts__, do: []
 
   EEx.function_from_string(
     :def,
@@ -46,7 +46,7 @@ defmodule Mix.Tasks.Tableau.BuildTest.Index do
   def __tableau_type__, do: :page
   def __tableau_parent__, do: InnerLayout
   def __tableau_permalink__, do: "/"
-  def __tableau_extra__, do: []
+  def __tableau_opts__, do: []
 
   EEx.function_from_string(
     :def,

test/tableau/document_test.exs

@@ -6,13 +6,13 @@ defmodule Tableau.DocumentTest.About do
   def __tableau_type__, do: :page
   def __tableau_parent__, do: InnerLayout
   def __tableau_permalink__, do: "/about"
-  def __tableau_extra__, do: [yo: "lo"]
+  def __tableau_opts__, do: [yo: "lo"]
 
   EEx.function_from_string(
     :def,
     :template,
     ~g'''
-    <div id="<%= @yo %>">
+    <div id="<%= @page.yo %>">
       hi
     </div>
     '''html,
@@ -28,7 +28,7 @@ defmodule Tableau.DocumentTest.Index do
   def __tableau_type__, do: :page
   def __tableau_parent__, do: InnerLayout
   def __tableau_permalink__, do: "/"
-  def __tableau_extra__, do: []
+  def __tableau_opts__, do: []
 
   EEx.function_from_string(
     :def,

test/tableau/graph/node_test.exs

@@ -9,7 +9,7 @@ defmodule Tableau.Graph.NodeTest do
     def __tableau_type__, do: :page
     def __tableau_parent__, do: Layout
     def __tableau_permalink__, do: "/about"
-    def __tableau_extra__, do: []
+    def __tableau_opts__, do: []
 
     def template(_) do
       ""

test/tableau/graph_test.exs

@@ -7,7 +7,7 @@ defmodule Tableau.GraphTest do
     def __tableau_type__, do: :page
     def __tableau_parent__, do: InnerLayout
     def __tableau_permalink__, do: "/about"
-    def __tableau_extra__, do: []
+    def __tableau_opts__, do: []
 
     def template(_), do: ""
   end
@@ -18,7 +18,7 @@ defmodule Tableau.GraphTest do
     def __tableau_type__, do: :page
     def __tableau_parent__, do: RootLayout
     def __tableau_permalink__, do: "/about"
-    def __tableau_extra__, do: []
+    def __tableau_opts__, do: []
     def template(_), do: ""
   end