Live Data Source

.credo.exs

@@ -87,7 +87,7 @@
           # If you don't want TODO comments to cause `mix credo` to fail, just
           # set this value to 0 (zero).
           #
-          {Credo.Check.Design.TagFIXME, []},
+          # {Credo.Check.Design.TagFIXME, []},
 
           #
           ## Readability Checks

dev.exs

@@ -94,32 +94,6 @@ defmodule SamplePhoenix.Endpoint do
   plug SamplePhoenixWeb.Router
 end
 
-defmodule BeaconDataSource do
-  @behaviour Beacon.DataSource.Behaviour
-
-  def live_data(:dev, ["home"], _params) do
-    [img1] = Beacon.MediaLibrary.search(:dev, "dockyard_1")
-
-    %{year: Date.utc_today().year, img1: img1}
-  end
-
-  def live_data(:dy, _path, _params) do
-    %{slogan: "Growth, Uninhibited"}
-  end
-
-  def live_data(_, _, _), do: %{}
-
-  def page_title(:dev, %{page_title: page_title}), do: String.upcase(page_title)
-
-  def page_title(:dy, _), do: "dy"
-
-  def meta_tags(:dev, %{beacon_live_data: %{year: year}, meta_tags: meta_tags}) do
-    [%{"name" => "year", "content" => year} | meta_tags]
-  end
-
-  def meta_tags(:dev, %{meta_tags: meta_tags}), do: meta_tags
-end
-
 defmodule BeaconTagsField do
   use Phoenix.Component
   import BeaconWeb.CoreComponents
@@ -219,6 +193,31 @@ dev_seeds = fn ->
 
   img2 = Beacon.MediaLibrary.upload(metadata)
 
+  home_live_data = Beacon.Content.create_live_data!(%{site: "dev", path: "home"}) |> dbg
+
+  Beacon.Content.create_assign_for_live_data(
+    home_live_data,
+    %{
+      format: :elixir,
+      key: "year",
+      value: """
+      Date.utc_today().year
+      """
+    }
+  )
+
+  Beacon.Content.create_assign_for_live_data(
+    home_live_data,
+    %{
+      format: :elixir,
+      key: "img1",
+      value: """
+      [img1] = Beacon.MediaLibrary.search(:dev, "dockyard_1")
+      img1
+      """
+    }
+  )
+
   page_home =
     Beacon.Content.create_page!(%{
       path: "home",
@@ -982,7 +981,6 @@ end
 dev_site = [
   site: :dev,
   endpoint: SamplePhoenix.Endpoint,
-  data_source: BeaconDataSource,
   extra_page_fields: [BeaconTagsField],
   lifecycle: [upload_asset: [thumbnail: &Beacon.Lifecycle.Asset.thumbnail/2, _480w: &Beacon.Lifecycle.Asset.variant_480w/2]],
   default_meta_tags: [
@@ -1012,7 +1010,7 @@ Task.start(fn ->
     {Beacon,
      sites: [
        dev_site,
-       [site: :dy, endpoint: SamplePhoenix.Endpoint, data_source: BeaconDataSource]
+       [site: :dy, endpoint: SamplePhoenix.Endpoint]
      ]},
     SamplePhoenix.Endpoint
   ]

guides/introduction/installation.md

@@ -159,19 +159,7 @@ For more details please check out the docs: `mix help beacon.install`
     show_sensitive_data_on_connection_error: true
     ```
 
-3. Create a `BeaconDataSource` module that implements `Beacon.DataSource.Behaviour`:
-
-    ```elixir
-    defmodule MyApp.BeaconDataSource do
-      @behaviour Beacon.DataSource.Behaviour
-
-      def live_data(:my_site, ["home"], _params), do: %{vals: ["first", "second", "third"]}
-      def live_data(:my_site, ["blog", blog_slug], _params), do: %{blog_slug_uppercase: String.upcase(blog_slug)}
-      def live_data(_, _, _), do: %{}
-    end
-    ```
-
-4. Edit `lib/my_app_web/router.ex` to add  `use Beacon.Router`, create a new `scope`, and call `beacon_site` in your app router:
+3. Edit `lib/my_app_web/router.ex` to add  `use Beacon.Router`, create a new `scope`, and call `beacon_site` in your app router:
 
     ```elixir
     use Beacon.Router
@@ -184,15 +172,15 @@ For more details please check out the docs: `mix help beacon.install`
 
 Make sure you're not adding the macro `beacon_site` into the existing `scope "/", MyAppWeb`, otherwise requests will fail.
 
-5. Include the `Beacon` supervisor in the list of `children` applications in the file `lib/my_app/application.ex`:
+4. Include the `Beacon` supervisor in the list of `children` applications in the file `lib/my_app/application.ex`:
 
     ```elixir
     @impl true
     def start(_type, _args) do
       children = [
         # ommited others for brevity
         MyAppWeb.Endpoint,
-        {Beacon, sites: [[site: :my_site, endpoint: MyAppWeb.Endpoint, data_source: MyApp.BeaconDataSource]]}
+        {Beacon, sites: [[site: :my_site, endpoint: MyAppWeb.Endpoint]]}
       ]
 
       opts = [strategy: :one_for_one, name: MyApp.Supervisor]
@@ -203,10 +191,10 @@ Make sure you're not adding the macro `beacon_site` into the existing `scope "/"
 For more info on site options, check out `Beacon.start_link/1`.
 
 **Notes**
-- The site identification has to be the same across your environment, in configuration, `beacon_site`, and `live_data`. In this example we're using `:my_site`.
+- The site identification has to be the same across your environment, in configuration and `beacon_site`. In this example we're using `:my_site`.
 - Include it after your app `Endpoint`.
 
-6. Add some seeds in the seeds file `priv/repo/beacon_seeds.exs`:
+5. Add some seeds in the seeds file `priv/repo/beacon_seeds.exs`:
 
     ```elixir
     # Replace "<%= site %>" with your site name.
@@ -217,7 +205,7 @@ For more info on site options, check out `Beacon.start_link/1`.
     #       name: "sample_stylesheet",
     #       content: "body {cursor: zoom-in;}"
     #     })
-    
+
     alias Beacon.Content
 
     Content.create_stylesheet!(%{
@@ -297,6 +285,12 @@ For more info on site options, check out `Beacon.start_link/1`.
     |> Content.create_page!()
     |> Content.publish_page()
 
+    home_live_data = Content.create_live_data!(%{site: "<%= site %>", path: "home"})
+
+    Content.create_assign_for_live_data(home_live_data, %{format: :elixir, key: "vals", value: """
+    ["first", "second", "third"]
+    """})
+
     %{
       path: "blog/:blog_slug",
       site: "<%= site %>",
@@ -313,6 +307,14 @@ For more info on site options, check out `Beacon.start_link/1`.
     }
     |> Content.create_page!()
     |> Content.publish_page()
+
+    blog_live_data = Content.create_live_data!(%{site: "<%= site %>", path: "blog/:blog_slug"})
+
+    Content.create_assign_for_live_data(blog_live_data, %{
+      format: :elixir,
+      key: "blog_slug_uppercase",
+      value: "String.upcase(blog_slug)"
+    })
     ```
 
 6. Include new seeds in the `ecto.setup` alias in `mix.exs`:
@@ -341,7 +343,7 @@ Open http://localhost:4000/my_site/home and note:
 
 - The Header and Footer from the layout
 - The list element from the page
-- The three components rendered with the beacon_live_data from your DataSource
+- The three components rendered with live data assigns
 - The zoom in cursor from the stylesheet
 
 Open http://localhost:4000/my_site/blog/my_first_post and note:

lib/beacon/beacon.ex

@@ -33,7 +33,7 @@ defmodule Beacon do
       # config.exs or runtime.exs
       config :my_app, Beacon,
         sites: [
-          [site: :my_site, endpoint: MyAppWeb.Endpoint, data_source: MyApp.BeaconDataSource]
+          [site: :my_site, endpoint: MyAppWeb.Endpoint]
         ],
         authorization_source: MyApp.AuthorizationPolicy
 

lib/beacon/config.ex

@@ -14,11 +14,6 @@ defmodule Beacon.Config do
   """
   @type endpoint :: module()
 
-  @typedoc """
-  A module that implements `Beacon.DataSource.Behaviour`, used to provide `@assigns` to pages.
-  """
-  @type data_source :: module() | nil
-
   @typedoc """
   A module that implements `Beacon.Authorization.Behaviour`, used to provide authorization rules for the admin backend.
   """
@@ -138,7 +133,6 @@ defmodule Beacon.Config do
   @type t :: %__MODULE__{
           site: Beacon.Types.Site.t(),
           endpoint: endpoint(),
-          data_source: data_source(),
           authorization_source: authorization_source(),
           css_compiler: css_compiler(),
           tailwind_config: tailwind_config(),
@@ -170,7 +164,6 @@ defmodule Beacon.Config do
 
   defstruct site: nil,
             endpoint: nil,
-            data_source: nil,
             authorization_source: Beacon.Authorization.DefaultPolicy,
             css_compiler: Beacon.TailwindCompiler,
             tailwind_config: Path.join(Application.app_dir(:beacon, "priv"), "tailwind.config.js.eex"),
@@ -197,7 +190,6 @@ defmodule Beacon.Config do
   @type option ::
           {:site, Beacon.Types.Site.t()}
           | {:endpoint, endpoint()}
-          | {:data_source, data_source()}
           | {:authorization_source, authorization_source()}
           | {:css_compiler, css_compiler()}
           | {:tailwind_config, tailwind_config()}
@@ -220,8 +212,6 @@ defmodule Beacon.Config do
 
     * `:endpoint` - `t:endpoint/0` (required)
 
-    * `:data_source` - `t:data_source/0` (optional)
-
     * `:authorization_source` - `t:authorization_source/0` (optional).
     Note this config can't be `nil`. Defaults to `Beacon.Authorization.DefaultPolicy`.
 
@@ -261,7 +251,6 @@ defmodule Beacon.Config do
       iex> Beacon.Config.new(
         site: :my_site,
         endpoint: MyAppWeb.Endpoint,
-        data_source: MyApp.SiteDataSource,
         authorization_source: MyApp.SiteAuthnPolicy,
         tailwind_config: Path.join(Application.app_dir(:my_app, "priv"), "tailwind.config.js.eex"),
         template_formats: [
@@ -288,7 +277,6 @@ defmodule Beacon.Config do
       %Beacon.Config{
         site: :my_site,
         endpoint: MyAppWeb.Endpoint,
-        data_source: MyApp.SiteDataSource,
         authorization_source: MyApp.SiteAuthnPolicy,
         css_compiler: Beacon.TailwindCompiler,
         tailwind_config: "/my_app/priv/tailwind.config.js.eex",