2022-03-28 10:26:35 +13:00
|
|
|
defmodule AshHqWeb.Pages.Docs do
|
2022-08-07 11:22:58 +12:00
|
|
|
@moduledoc "The page for showing documentation"
|
2022-09-13 08:47:14 +12:00
|
|
|
use Surface.LiveComponent
|
2022-03-28 10:26:35 +13:00
|
|
|
|
2022-09-13 11:36:28 +12:00
|
|
|
import AshHqWeb.Helpers
|
|
|
|
|
|
2022-04-01 05:36:44 +13:00
|
|
|
alias AshHqWeb.Components.{CalloutText, DocSidebar, RightNav, Tag}
|
2022-09-13 11:36:28 +12:00
|
|
|
alias AshHqWeb.Components.Docs.{DocPath, Functions, SourceLink}
|
2022-08-07 11:22:58 +12:00
|
|
|
alias AshHqWeb.DocRoutes
|
|
|
|
|
alias Phoenix.LiveView.JS
|
2022-11-17 08:36:05 +13:00
|
|
|
alias Surface.Components.LivePatch
|
2022-06-06 06:03:45 +12:00
|
|
|
require Logger
|
2022-03-28 10:26:35 +13:00
|
|
|
|
2023-01-18 15:33:49 +13:00
|
|
|
prop(change_versions, :event, required: true)
|
|
|
|
|
prop(selected_versions, :map, required: true)
|
|
|
|
|
prop(libraries, :list, default: [])
|
|
|
|
|
prop(uri, :string)
|
|
|
|
|
prop(remove_version, :event)
|
|
|
|
|
prop(add_version, :event)
|
|
|
|
|
prop(change_version, :event)
|
|
|
|
|
prop(params, :map, required: true)
|
|
|
|
|
|
|
|
|
|
data(library, :any)
|
|
|
|
|
data(extension, :any)
|
|
|
|
|
data(docs, :any)
|
|
|
|
|
data(library_version, :any)
|
|
|
|
|
data(guide, :any)
|
|
|
|
|
data(doc_path, :list, default: [])
|
|
|
|
|
data(dsls, :list, default: [])
|
|
|
|
|
data(dsl, :any)
|
|
|
|
|
data(options, :list, default: [])
|
|
|
|
|
data(module, :any)
|
|
|
|
|
data(mix_task, :any)
|
|
|
|
|
data(positional_options, :list)
|
|
|
|
|
data(description, :string)
|
|
|
|
|
data(title, :string)
|
2022-08-29 00:42:24 +12:00
|
|
|
|
2022-03-28 10:26:35 +13:00
|
|
|
@spec render(any) :: Phoenix.LiveView.Rendered.t()
|
|
|
|
|
def render(assigns) do
|
|
|
|
|
~F"""
|
2022-11-16 14:27:24 +13:00
|
|
|
<div class="flex flex-col xl:flex-row justify-center">
|
2022-12-27 22:31:13 +13:00
|
|
|
<head>
|
|
|
|
|
<meta property="og:title" content={@title}>
|
|
|
|
|
<meta property="og:description" content={@description}>
|
|
|
|
|
</head>
|
2022-11-16 18:29:29 +13:00
|
|
|
<div class="xl:hidden sticky top-20 z-40 h-14 bg-white dark:bg-base-dark-850 flex flex-row justify-start w-full space-x-12 items-center border-b border-t border-base-light-300 dark:border-base-dark-700 py-3">
|
2022-09-08 15:51:47 +12:00
|
|
|
<button class="dark:hover:text-base-dark-600" phx-click={show_sidebar()}>
|
2022-03-29 11:05:19 +13:00
|
|
|
<Heroicons.Outline.MenuIcon class="w-8 h-8 ml-4" />
|
|
|
|
|
</button>
|
2022-10-26 17:53:18 +13:00
|
|
|
<button id={"#{@id}-hide"} class="hidden" phx-click={hide_sidebar()} />
|
2022-03-29 11:05:19 +13:00
|
|
|
{#if @doc_path && @doc_path != []}
|
2022-09-13 12:35:59 +12:00
|
|
|
<DocPath doc_path={@doc_path} />
|
2022-03-29 11:05:19 +13:00
|
|
|
{/if}
|
|
|
|
|
</div>
|
2022-11-16 14:27:24 +13:00
|
|
|
<span class="grid xl:hidden z-40">
|
|
|
|
|
<div
|
|
|
|
|
id="mobile-sidebar-container"
|
|
|
|
|
class="hidden fixed transition sidebar-container overflow-y-auto z-40"
|
|
|
|
|
>
|
2022-03-30 05:12:28 +13:00
|
|
|
<DocSidebar
|
|
|
|
|
id="mobile-sidebar"
|
2022-11-16 14:27:24 +13:00
|
|
|
class="max-w-sm"
|
2022-08-31 20:11:15 +12:00
|
|
|
remove_version={@remove_version}
|
2022-03-30 05:12:28 +13:00
|
|
|
libraries={@libraries}
|
|
|
|
|
extension={@extension}
|
2022-03-30 17:40:17 +13:00
|
|
|
module={@module}
|
2022-09-30 05:56:07 +13:00
|
|
|
mix_task={@mix_task}
|
2022-03-30 05:12:28 +13:00
|
|
|
guide={@guide}
|
|
|
|
|
library={@library}
|
|
|
|
|
library_version={@library_version}
|
|
|
|
|
selected_versions={@selected_versions}
|
2022-03-30 17:40:17 +13:00
|
|
|
dsl={@dsl}
|
2022-03-30 05:12:28 +13:00
|
|
|
/>
|
|
|
|
|
</div>
|
|
|
|
|
</span>
|
2022-11-16 14:27:24 +13:00
|
|
|
<div class="grow w-full flex flex-row max-w-[1800px] justify-between md:space-x-12">
|
2022-11-16 18:29:29 +13:00
|
|
|
<div class="sidebar-container sticky overflow-y-auto overflow-x-hidden shrink-0 top-20 xl:border-r xl:border-b xl:border-base-light-300 xl:dark:border-base-dark-700 lg:pr-2 lg:pt-4">
|
2022-09-08 02:48:10 +12:00
|
|
|
<DocSidebar
|
|
|
|
|
id="sidebar"
|
2022-11-16 14:27:24 +13:00
|
|
|
class="hidden xl:block w-80"
|
2022-09-08 02:48:10 +12:00
|
|
|
remove_version={@remove_version}
|
|
|
|
|
module={@module}
|
2022-09-30 05:56:07 +13:00
|
|
|
mix_task={@mix_task}
|
2022-09-08 02:48:10 +12:00
|
|
|
libraries={@libraries}
|
|
|
|
|
extension={@extension}
|
|
|
|
|
guide={@guide}
|
|
|
|
|
library={@library}
|
|
|
|
|
library_version={@library_version}
|
|
|
|
|
selected_versions={@selected_versions}
|
|
|
|
|
dsl={@dsl}
|
|
|
|
|
/>
|
|
|
|
|
</div>
|
2022-03-30 05:12:28 +13:00
|
|
|
<div
|
|
|
|
|
id="docs-window"
|
2023-01-06 18:40:35 +13:00
|
|
|
class="w-full shrink prose max-w-6xl bg-white dark:bg-base-dark-850 dark:prose-invert md:pr-8 md:mt-4 px-4 md:px-auto mx-auto overflow-x-auto overflow-y-hidden"
|
2022-03-30 05:12:28 +13:00
|
|
|
phx-hook="Docs"
|
|
|
|
|
>
|
2022-09-09 15:23:57 +12:00
|
|
|
<div
|
|
|
|
|
id="module-docs"
|
|
|
|
|
class="w-full nav-anchor text-black dark:text-white relative py-4 md:py-auto"
|
|
|
|
|
>
|
2022-07-15 07:09:04 +12:00
|
|
|
{#if @module}
|
2022-09-13 12:35:59 +12:00
|
|
|
<h2>{@module.name} <SourceLink module_or_function={@module} library={@library} library_version={@library_version} /></h2>
|
2022-07-15 07:09:04 +12:00
|
|
|
{/if}
|
2022-09-30 05:56:07 +13:00
|
|
|
{#if @mix_task}
|
|
|
|
|
<h2>{@mix_task.name} <SourceLink
|
|
|
|
|
module_or_function={@mix_task}
|
|
|
|
|
library={@library}
|
|
|
|
|
library_version={@library_version}
|
|
|
|
|
/></h2>
|
|
|
|
|
{/if}
|
2022-11-02 18:29:57 +13:00
|
|
|
<div id={docs_container_id(@doc_path)}>
|
|
|
|
|
{raw(render_replacements(@libraries, @selected_versions, @docs))}
|
|
|
|
|
</div>
|
2022-10-26 17:28:25 +13:00
|
|
|
{#if @extension && !@dsl && !@guide}
|
|
|
|
|
{#case Enum.count_until(Stream.filter(@extension.dsls, &(&1.type == :section)), 2)}
|
|
|
|
|
{#match 0}
|
2022-10-26 17:53:18 +13:00
|
|
|
<div />
|
2022-10-26 17:28:25 +13:00
|
|
|
{#match 1}
|
2022-10-26 17:53:18 +13:00
|
|
|
<h3>
|
|
|
|
|
DSL
|
|
|
|
|
</h3>
|
2022-10-26 17:28:25 +13:00
|
|
|
{#match 2}
|
2022-10-26 17:53:18 +13:00
|
|
|
<h3>
|
|
|
|
|
DSL Sections
|
|
|
|
|
</h3>
|
2022-10-26 17:28:25 +13:00
|
|
|
{/case}
|
|
|
|
|
<ul>
|
|
|
|
|
{#for section <- Enum.filter(@extension.dsls, &(&1.type == :section))}
|
|
|
|
|
<li>
|
2022-11-17 08:36:05 +13:00
|
|
|
<LivePatch to={DocRoutes.doc_link(section, @selected_versions)}>{section.name}</LivePatch>
|
2022-10-26 17:28:25 +13:00
|
|
|
</li>
|
|
|
|
|
{/for}
|
|
|
|
|
</ul>
|
|
|
|
|
{/if}
|
2022-04-01 09:59:53 +13:00
|
|
|
</div>
|
2022-03-30 17:40:17 +13:00
|
|
|
{#if @module}
|
2022-09-16 10:35:33 +12:00
|
|
|
<Functions
|
|
|
|
|
header="Types"
|
|
|
|
|
type={:type}
|
|
|
|
|
functions={@module.functions}
|
|
|
|
|
library={@library}
|
|
|
|
|
library_version={@library_version}
|
|
|
|
|
libraries={@libraries}
|
|
|
|
|
selected_versions={@selected_versions}
|
|
|
|
|
/>
|
2022-09-13 12:35:59 +12:00
|
|
|
<Functions
|
|
|
|
|
header="Callbacks"
|
|
|
|
|
type={:callback}
|
|
|
|
|
functions={@module.functions}
|
|
|
|
|
library={@library}
|
|
|
|
|
library_version={@library_version}
|
|
|
|
|
libraries={@libraries}
|
|
|
|
|
selected_versions={@selected_versions}
|
|
|
|
|
/>
|
|
|
|
|
<Functions
|
|
|
|
|
header="Functions"
|
|
|
|
|
type={:function}
|
|
|
|
|
functions={@module.functions}
|
|
|
|
|
library={@library}
|
|
|
|
|
library_version={@library_version}
|
|
|
|
|
libraries={@libraries}
|
|
|
|
|
selected_versions={@selected_versions}
|
|
|
|
|
/>
|
|
|
|
|
<Functions
|
|
|
|
|
header="Macros"
|
|
|
|
|
type={:macro}
|
|
|
|
|
functions={@module.functions}
|
|
|
|
|
library={@library}
|
|
|
|
|
library_version={@library_version}
|
|
|
|
|
libraries={@libraries}
|
|
|
|
|
selected_versions={@selected_versions}
|
|
|
|
|
/>
|
2022-03-30 17:40:17 +13:00
|
|
|
{/if}
|
2022-07-15 07:09:04 +12:00
|
|
|
{#case modules_in_scope(@dsl, @extension, @libraries, @selected_versions)}
|
|
|
|
|
{#match []}
|
|
|
|
|
{#match imports}
|
|
|
|
|
<h3>Imported Modules</h3>
|
|
|
|
|
{#for mod <- imports}
|
|
|
|
|
<ul>
|
|
|
|
|
<li>
|
2022-11-17 08:36:05 +13:00
|
|
|
<LivePatch to={DocRoutes.doc_link(mod, @selected_versions)}>{mod.name}</LivePatch>
|
2022-07-15 07:09:04 +12:00
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
{/for}
|
|
|
|
|
{/case}
|
|
|
|
|
{#case child_dsls(@extension, @dsl)}
|
|
|
|
|
{#match []}
|
|
|
|
|
{#match children}
|
2022-07-28 07:57:39 +12:00
|
|
|
<h3>
|
|
|
|
|
Nested DSLs
|
|
|
|
|
</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
{#for child <- children}
|
|
|
|
|
<li>
|
2022-11-17 08:36:05 +13:00
|
|
|
<LivePatch to={DocRoutes.doc_link(child, @selected_versions)}>{child.name}</LivePatch>
|
2022-07-28 07:57:39 +12:00
|
|
|
</li>
|
|
|
|
|
{/for}
|
|
|
|
|
</ul>
|
2022-07-15 07:09:04 +12:00
|
|
|
{/case}
|
|
|
|
|
<div class="ml-2">
|
2022-07-28 07:57:39 +12:00
|
|
|
<table>
|
|
|
|
|
{#if !Enum.empty?(@options)}
|
|
|
|
|
{#if Enum.any?(@options, & &1.argument_index)}
|
|
|
|
|
<td colspan="100%">
|
|
|
|
|
<h3>
|
|
|
|
|
Arguments
|
|
|
|
|
</h3>
|
|
|
|
|
</td>
|
2022-07-26 13:24:43 +12:00
|
|
|
<tr>
|
|
|
|
|
<th>Name</th>
|
|
|
|
|
<th>Type</th>
|
2023-01-15 19:48:24 +13:00
|
|
|
{#if @dsl.arg_defaults not in [%{}, nil]}
|
|
|
|
|
<th>Default</th>
|
|
|
|
|
{/if}
|
2022-07-26 13:24:43 +12:00
|
|
|
<th>Doc</th>
|
|
|
|
|
</tr>
|
2022-07-15 07:09:04 +12:00
|
|
|
{#for option <- positional_options(@options)}
|
2022-10-11 19:19:11 +13:00
|
|
|
<tr id={"#{option.sanitized_path}/#{option.name}"}>
|
2022-07-15 07:09:04 +12:00
|
|
|
<td>
|
|
|
|
|
<div class="flex flex-row items-baseline">
|
2022-11-17 08:36:05 +13:00
|
|
|
<LivePatch to={"##{DocRoutes.sanitize_name(option.name)}"}>
|
2022-07-15 07:09:04 +12:00
|
|
|
<Heroicons.Outline.LinkIcon class="h-3 m-3" />
|
2022-11-17 08:36:05 +13:00
|
|
|
</LivePatch>
|
2022-07-28 07:57:39 +12:00
|
|
|
<div class="flex flex-row space-x-2">
|
2022-09-13 12:35:59 +12:00
|
|
|
<CalloutText text={option.name} />
|
2023-01-18 15:33:49 +13:00
|
|
|
{render_tags(assigns, %{
|
|
|
|
|
option
|
|
|
|
|
| required: option.required && !Map.has_key?(@dsl.arg_defaults || %{}, option.name)
|
|
|
|
|
})}
|
2022-07-28 07:57:39 +12:00
|
|
|
</div>
|
2022-07-15 07:09:04 +12:00
|
|
|
</div>
|
|
|
|
|
</td>
|
|
|
|
|
<td>
|
|
|
|
|
{option.type}
|
|
|
|
|
</td>
|
2023-01-15 19:48:24 +13:00
|
|
|
{#if @dsl.arg_defaults not in [%{}, nil]}
|
2023-01-18 15:33:49 +13:00
|
|
|
<th>{Map.get(@dsl.arg_defaults || %{}, option.name)}</th>
|
2023-01-15 19:48:24 +13:00
|
|
|
{/if}
|
2022-07-15 07:09:04 +12:00
|
|
|
<td>
|
2022-09-13 11:36:28 +12:00
|
|
|
{raw(render_replacements(@libraries, @selected_versions, option.html_for))}
|
2022-07-15 07:09:04 +12:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
{/for}
|
2022-07-28 07:57:39 +12:00
|
|
|
{/if}
|
|
|
|
|
<tr>
|
|
|
|
|
<td colspan="100%">
|
|
|
|
|
<h3>
|
|
|
|
|
Options
|
|
|
|
|
</h3>
|
|
|
|
|
</td>
|
|
|
|
|
</tr>
|
2022-07-26 14:17:39 +12:00
|
|
|
<tr>
|
|
|
|
|
<th>Name</th>
|
|
|
|
|
<th>Type</th>
|
2022-12-01 12:53:11 +13:00
|
|
|
<th>Default</th>
|
2022-07-26 14:17:39 +12:00
|
|
|
<th>Doc</th>
|
|
|
|
|
</tr>
|
2022-07-15 07:09:04 +12:00
|
|
|
{#for %{argument_index: nil} = option <- @options}
|
2022-10-11 19:19:11 +13:00
|
|
|
<tr id={"#{option.sanitized_path}/#{option.name}"}>
|
2022-09-13 05:44:52 +12:00
|
|
|
<td id={DocRoutes.sanitize_name(option.name)}>
|
2022-03-30 17:40:17 +13:00
|
|
|
<div class="flex flex-row items-baseline">
|
2022-11-17 08:36:05 +13:00
|
|
|
<LivePatch to={"##{DocRoutes.sanitize_name(option.name)}"}>
|
2022-03-30 17:40:17 +13:00
|
|
|
<Heroicons.Outline.LinkIcon class="h-3 m-3" />
|
2022-11-17 08:36:05 +13:00
|
|
|
</LivePatch>
|
2022-09-13 12:35:59 +12:00
|
|
|
<CalloutText text={option.name} />
|
2022-07-26 18:47:03 +12:00
|
|
|
{render_tags(assigns, option)}
|
2022-03-30 17:40:17 +13:00
|
|
|
</div>
|
|
|
|
|
</td>
|
|
|
|
|
<td>
|
|
|
|
|
{option.type}
|
|
|
|
|
</td>
|
2022-12-01 12:53:11 +13:00
|
|
|
<td>
|
|
|
|
|
{if option.default == "nil", do: nil, else: option.default}
|
|
|
|
|
</td>
|
2022-03-30 17:40:17 +13:00
|
|
|
<td>
|
2022-09-13 11:36:28 +12:00
|
|
|
{raw(render_replacements(@libraries, @selected_versions, option.html_for))}
|
2022-03-30 17:40:17 +13:00
|
|
|
</td>
|
|
|
|
|
</tr>
|
|
|
|
|
{/for}
|
2022-07-28 07:57:39 +12:00
|
|
|
{/if}
|
|
|
|
|
</table>
|
2022-07-15 07:09:04 +12:00
|
|
|
</div>
|
2022-10-23 00:51:22 +13:00
|
|
|
|
2022-11-01 20:20:09 +13:00
|
|
|
<footer class="p-2 sm:justify-center">
|
2022-10-23 00:51:22 +13:00
|
|
|
<div class="md:flex md:justify-around items-center">
|
2022-11-17 08:36:05 +13:00
|
|
|
<LivePatch to="/">
|
2022-10-23 00:51:22 +13:00
|
|
|
<img class="h-6 md:h-10 hidden dark:block" src="/images/ash-framework-dark.png">
|
|
|
|
|
<img class="h-6 md:h-10 dark:hidden" src="/images/ash-framework-light.png">
|
2022-11-17 08:36:05 +13:00
|
|
|
</LivePatch>
|
2022-10-23 00:51:22 +13:00
|
|
|
<a href="https://github.com/ash-project" class="hover:underline">Source</a>
|
|
|
|
|
<a href="https://github.com/ash-project/ash_hq/issues/new/choose" class="hover:underline">Report an issue</a>
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
2022-03-28 10:26:35 +13:00
|
|
|
</div>
|
2022-04-01 05:36:44 +13:00
|
|
|
{#if @module}
|
2022-11-16 14:27:24 +13:00
|
|
|
<div class="sidebar-container hidden lg:block lg:w-80 sticky top-36 xl:top-20 shrink-0 overflow-y-auto overflow-x-hidden dark:bg-base-dark-850 bg-opacity-70 mt-4">
|
2022-04-02 08:11:17 +13:00
|
|
|
<RightNav functions={@module.functions} module={@module.name} />
|
2022-04-01 05:36:44 +13:00
|
|
|
</div>
|
2022-07-28 07:57:39 +12:00
|
|
|
{#else}
|
2022-11-16 14:27:24 +13:00
|
|
|
<!-- empty div to preserve flex row spacing -->
|
2022-07-28 07:57:39 +12:00
|
|
|
<div />
|
2022-04-01 05:36:44 +13:00
|
|
|
{/if}
|
2022-03-28 10:26:35 +13:00
|
|
|
</div>
|
2022-03-30 05:12:28 +13:00
|
|
|
</div>
|
|
|
|
|
"""
|
|
|
|
|
end
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
def update(assigns, socket) do
|
2022-09-30 05:56:07 +13:00
|
|
|
if (assigns[:selected_versions] == socket.assigns[:selected_versions] &&
|
|
|
|
|
Map.get(socket.assigns.library_version || %{}, :id) ==
|
|
|
|
|
Map.get(assigns[:library_version] || %{}, :id)) || !socket.assigns[:loaded_once?] do
|
|
|
|
|
{:ok,
|
|
|
|
|
socket
|
|
|
|
|
|> assign(assigns)
|
|
|
|
|
|> assign(:loaded_once?, false)
|
|
|
|
|
|> load_docs()}
|
|
|
|
|
else
|
|
|
|
|
{:ok,
|
|
|
|
|
socket
|
|
|
|
|
|> assign(assigns)}
|
|
|
|
|
end
|
2022-09-13 08:47:14 +12:00
|
|
|
end
|
|
|
|
|
|
2022-07-15 07:09:04 +12:00
|
|
|
defp modules_in_scope(nil, _, _, _), do: []
|
|
|
|
|
defp modules_in_scope(_, nil, _, _), do: []
|
|
|
|
|
|
|
|
|
|
defp modules_in_scope(dsl, %{dsls: dsls}, libraries, selected_versions) do
|
|
|
|
|
dsl_path = dsl.path ++ [dsl.name]
|
|
|
|
|
|
|
|
|
|
dsls
|
|
|
|
|
|> Enum.filter(fn potential_parent ->
|
|
|
|
|
List.starts_with?(dsl_path, potential_parent.path ++ [potential_parent.name])
|
|
|
|
|
end)
|
|
|
|
|
|> Enum.flat_map(fn dsl ->
|
|
|
|
|
dsl.imports || []
|
|
|
|
|
end)
|
|
|
|
|
|> Enum.flat_map(fn mod_name ->
|
2022-08-07 11:22:58 +12:00
|
|
|
case find_module(libraries, selected_versions, mod_name) do
|
2022-07-15 07:09:04 +12:00
|
|
|
nil ->
|
|
|
|
|
Logger.warn("No such module found called #{inspect(mod_name)}")
|
|
|
|
|
[]
|
|
|
|
|
|
|
|
|
|
module ->
|
|
|
|
|
[module]
|
|
|
|
|
end
|
|
|
|
|
end)
|
|
|
|
|
end
|
|
|
|
|
|
2022-08-07 11:22:58 +12:00
|
|
|
defp find_module(libraries, selected_versions, mod_name) do
|
|
|
|
|
Enum.find_value(libraries, fn library ->
|
2022-10-11 19:24:13 +13:00
|
|
|
version = selected_version(library, selected_versions[library.id])
|
|
|
|
|
|
|
|
|
|
if version do
|
|
|
|
|
Enum.find(version.modules, &(&1.name == mod_name))
|
|
|
|
|
end
|
2022-08-07 11:22:58 +12:00
|
|
|
end)
|
|
|
|
|
end
|
|
|
|
|
|
2022-10-11 19:24:13 +13:00
|
|
|
defp selected_version(library, selected_version) do
|
|
|
|
|
if selected_version == "latest" do
|
|
|
|
|
latest_version(library)
|
|
|
|
|
else
|
|
|
|
|
Enum.find(library.versions, &(&1.id == selected_version))
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2022-07-15 07:09:04 +12:00
|
|
|
defp child_dsls(_, nil), do: []
|
|
|
|
|
defp child_dsls(nil, _), do: []
|
|
|
|
|
|
|
|
|
|
defp child_dsls(%{dsls: dsls}, dsl) do
|
|
|
|
|
dsl_path = dsl.path ++ [dsl.name]
|
|
|
|
|
dsl_path_count = Enum.count(dsl_path)
|
|
|
|
|
|
|
|
|
|
Enum.filter(dsls, fn potential_child ->
|
|
|
|
|
potential_child_path = potential_child.path ++ [potential_child.name]
|
|
|
|
|
|
|
|
|
|
List.starts_with?(potential_child_path, dsl_path) &&
|
|
|
|
|
Enum.count(potential_child_path) - dsl_path_count == 1
|
|
|
|
|
end)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp positional_options(options) do
|
|
|
|
|
options
|
|
|
|
|
|> Enum.filter(& &1.argument_index)
|
|
|
|
|
|> Enum.sort_by(& &1.argument_index)
|
|
|
|
|
end
|
|
|
|
|
|
2022-03-30 05:12:28 +13:00
|
|
|
def path_to_name(path, name) do
|
2022-08-07 11:22:58 +12:00
|
|
|
Enum.map_join(path ++ [name], "-", &DocRoutes.sanitize_name/1)
|
2022-03-30 05:12:28 +13:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp render_tags(assigns, option) do
|
|
|
|
|
~F"""
|
|
|
|
|
{#if option.required}
|
|
|
|
|
<Tag color={:red}>
|
|
|
|
|
Required
|
|
|
|
|
</Tag>
|
|
|
|
|
{/if}
|
|
|
|
|
"""
|
|
|
|
|
end
|
|
|
|
|
|
2022-08-07 11:22:58 +12:00
|
|
|
def show_sidebar(js \\ %JS{}) do
|
|
|
|
|
js
|
2022-03-29 11:05:19 +13:00
|
|
|
|> JS.toggle(
|
|
|
|
|
to: "#mobile-sidebar-container",
|
2022-03-30 05:12:28 +13:00
|
|
|
in: {
|
|
|
|
|
"transition ease-in duration-100",
|
|
|
|
|
"opacity-0",
|
|
|
|
|
"opacity-100"
|
|
|
|
|
},
|
|
|
|
|
out: {
|
|
|
|
|
"transition ease-out duration-75",
|
|
|
|
|
"opacity-100",
|
|
|
|
|
"opacity-0"
|
|
|
|
|
}
|
2022-03-29 11:05:19 +13:00
|
|
|
)
|
2022-03-28 10:26:35 +13:00
|
|
|
end
|
|
|
|
|
|
2022-10-26 17:28:25 +13:00
|
|
|
def hide_sidebar(js \\ %JS{}) do
|
|
|
|
|
js
|
|
|
|
|
|> JS.hide(
|
|
|
|
|
to: "#mobile-sidebar-container",
|
|
|
|
|
transition: {
|
|
|
|
|
"transition ease-out duration-75",
|
|
|
|
|
"opacity-100",
|
|
|
|
|
"opacity-0"
|
|
|
|
|
}
|
|
|
|
|
)
|
|
|
|
|
end
|
|
|
|
|
|
2022-09-30 05:56:07 +13:00
|
|
|
def load_docs(socket) do
|
2022-09-13 12:35:59 +12:00
|
|
|
socket = assign_library(socket)
|
2022-07-15 07:09:04 +12:00
|
|
|
|
2022-09-30 05:56:07 +13:00
|
|
|
dsls_query =
|
|
|
|
|
AshHq.Docs.Dsl
|
|
|
|
|
|> Ash.Query.sort(order: :asc)
|
|
|
|
|
|> load_for_search(socket.assigns[:params]["dsl_path"])
|
|
|
|
|
|
|
|
|
|
options_query =
|
|
|
|
|
AshHq.Docs.Option
|
|
|
|
|
|> Ash.Query.sort(order: :asc)
|
|
|
|
|
|> load_for_search(socket.assigns[:params]["dsl_path"])
|
|
|
|
|
|
|
|
|
|
guides_query =
|
|
|
|
|
AshHq.Docs.Guide
|
|
|
|
|
|> Ash.Query.new()
|
2022-12-15 21:28:03 +13:00
|
|
|
|> load_for_search(Enum.join(List.wrap(socket.assigns[:params]["guide"]), "/"))
|
2022-09-30 05:56:07 +13:00
|
|
|
|
|
|
|
|
modules_query =
|
|
|
|
|
AshHq.Docs.Module
|
|
|
|
|
|> Ash.Query.sort(order: :asc)
|
|
|
|
|
|> load_for_search(socket.assigns[:params]["module"])
|
|
|
|
|
|
|
|
|
|
mix_tasks_query =
|
|
|
|
|
AshHq.Docs.MixTask
|
|
|
|
|
|> Ash.Query.sort(order: :asc)
|
|
|
|
|
|> load_for_search(socket.assigns[:params]["mix_task"])
|
|
|
|
|
|
|
|
|
|
extensions_query =
|
|
|
|
|
AshHq.Docs.Extension
|
|
|
|
|
|> Ash.Query.sort(order: :asc)
|
|
|
|
|
|> Ash.Query.load(options: options_query, dsls: dsls_query)
|
2023-01-18 15:33:49 +13:00
|
|
|
|> load_for_search(
|
|
|
|
|
socket.assigns[:params]["extension"] || socket.assigns[:params]["module"]
|
|
|
|
|
)
|
2022-09-30 05:56:07 +13:00
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
new_libraries =
|
|
|
|
|
socket.assigns.libraries
|
2022-09-30 05:56:07 +13:00
|
|
|
|> Enum.flat_map(fn library ->
|
|
|
|
|
latest_version = AshHqWeb.Helpers.latest_version(library)
|
|
|
|
|
|
|
|
|
|
Enum.filter(library.versions, fn version ->
|
|
|
|
|
(latest_version && version.id == latest_version.id) ||
|
|
|
|
|
version.id == socket.assigns[:selected_versions][library.id] ||
|
|
|
|
|
(socket.assigns[:library_version] &&
|
|
|
|
|
socket.assigns[:library_version].id == version.id) ||
|
|
|
|
|
(socket.assigns.params["version"] &&
|
|
|
|
|
socket.assigns.params["version"] ==
|
|
|
|
|
version.version)
|
|
|
|
|
end)
|
|
|
|
|
end)
|
|
|
|
|
|> AshHq.Docs.load!(
|
|
|
|
|
[
|
|
|
|
|
extensions: extensions_query,
|
|
|
|
|
guides: guides_query,
|
|
|
|
|
modules: modules_query,
|
|
|
|
|
mix_tasks: mix_tasks_query
|
|
|
|
|
],
|
|
|
|
|
lazy?: true
|
|
|
|
|
)
|
|
|
|
|
|> Enum.reduce(socket.assigns.libraries, fn library_version, libraries ->
|
|
|
|
|
Enum.map(libraries, fn library ->
|
|
|
|
|
if library.id == library_version.library_id do
|
|
|
|
|
Map.update!(library, :versions, fn versions ->
|
|
|
|
|
Enum.map(versions, fn current_version ->
|
|
|
|
|
if current_version.id == library_version.id do
|
|
|
|
|
library_version
|
|
|
|
|
else
|
|
|
|
|
current_version
|
|
|
|
|
end
|
|
|
|
|
end)
|
|
|
|
|
end)
|
|
|
|
|
else
|
|
|
|
|
library
|
|
|
|
|
end
|
2022-09-13 08:47:14 +12:00
|
|
|
end)
|
|
|
|
|
end)
|
|
|
|
|
|
|
|
|
|
socket
|
|
|
|
|
|> assign(:libraries, new_libraries)
|
|
|
|
|
|> assign_library()
|
|
|
|
|
|> assign_extension()
|
|
|
|
|
|> assign_guide()
|
|
|
|
|
|> assign_module()
|
2022-09-30 05:56:07 +13:00
|
|
|
|> assign_mix_task()
|
2022-09-13 08:47:14 +12:00
|
|
|
|> assign_dsl()
|
2022-11-04 05:20:51 +13:00
|
|
|
|> assign_fallback_guide()
|
2022-09-13 08:47:14 +12:00
|
|
|
|> assign_docs()
|
|
|
|
|
end
|
|
|
|
|
|
2022-11-04 05:20:51 +13:00
|
|
|
defp assign_fallback_guide(socket) do
|
|
|
|
|
if socket.assigns[:library_version] &&
|
|
|
|
|
!(socket.assigns[:dsl] || socket.assigns[:mix_task] || socket.assigns[:guide] ||
|
|
|
|
|
socket.assigns[:extension] || socket.assigns[:module]) do
|
|
|
|
|
guide =
|
|
|
|
|
Enum.find(socket.assigns.library_version.guides, fn guide ->
|
|
|
|
|
guide.default
|
|
|
|
|
end) ||
|
|
|
|
|
Enum.find(socket.assigns.library_version.guides, fn guide ->
|
|
|
|
|
String.contains?(guide.sanitized_name, "started")
|
|
|
|
|
end) || Enum.at(socket.assigns.library_version.guides, 0)
|
|
|
|
|
|
|
|
|
|
guide = AshHq.Docs.load!(guide, [html_for: %{for: guide.sanitized_name}], lazy?: true)
|
|
|
|
|
|
|
|
|
|
assign(socket, guide: guide)
|
|
|
|
|
else
|
|
|
|
|
socket
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
defp load_for_search(query, docs_for) do
|
|
|
|
|
query
|
|
|
|
|
|> Ash.Query.load(AshHq.Docs.Extensions.Search.load_for_search(query.resource))
|
|
|
|
|
|> deselect_doc_attributes()
|
|
|
|
|
|> load_docs_for(docs_for)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp load_docs_for(query, nil), do: query
|
|
|
|
|
defp load_docs_for(query, []), do: query
|
|
|
|
|
|
2022-09-16 10:35:33 +12:00
|
|
|
defp load_docs_for(_query, true) do
|
|
|
|
|
raise "unreachable"
|
2022-09-13 08:47:14 +12:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp load_docs_for(query, name) when is_list(name) do
|
2022-09-16 10:35:33 +12:00
|
|
|
name = Enum.join(name, "/")
|
|
|
|
|
load_docs_for(query, name)
|
2022-09-13 08:47:14 +12:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp load_docs_for(query, name) do
|
2022-09-16 10:35:33 +12:00
|
|
|
query
|
|
|
|
|
|> Ash.Query.load(html_for: %{for: name})
|
|
|
|
|
|> load_additional_docs(name)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp load_additional_docs(query, name) do
|
|
|
|
|
query.resource
|
|
|
|
|
|> AshHq.Docs.Extensions.RenderMarkdown.render_attributes()
|
|
|
|
|
|> Enum.reduce(query, fn {source, dest}, query ->
|
|
|
|
|
doc_source = AshHq.Docs.Extensions.Search.doc_attribute(query.resource)
|
|
|
|
|
|
|
|
|
|
if doc_source && source == doc_source do
|
|
|
|
|
query
|
|
|
|
|
else
|
|
|
|
|
load = String.to_existing_atom("#{dest}_for")
|
|
|
|
|
Ash.Query.load(query, [{load, %{for: name}}])
|
|
|
|
|
end
|
|
|
|
|
end)
|
2022-09-13 08:47:14 +12:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp deselect_doc_attributes(query) do
|
|
|
|
|
query.resource
|
|
|
|
|
|> AshHq.Docs.Extensions.RenderMarkdown.render_attributes()
|
|
|
|
|
|> Enum.reduce(query, fn {source, target}, query ->
|
|
|
|
|
Ash.Query.deselect(query, [source, target])
|
|
|
|
|
end)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp assign_library(socket) do
|
|
|
|
|
case Enum.find(
|
|
|
|
|
socket.assigns.libraries,
|
|
|
|
|
&(&1.name == socket.assigns.params["library"])
|
|
|
|
|
) do
|
|
|
|
|
nil ->
|
|
|
|
|
socket
|
|
|
|
|
|> assign(:library, nil)
|
|
|
|
|
|> assign(:library_version, nil)
|
|
|
|
|
|
|
|
|
|
library ->
|
|
|
|
|
socket =
|
|
|
|
|
if socket.assigns[:params]["version"] do
|
|
|
|
|
library_version =
|
|
|
|
|
case socket.assigns[:params]["version"] do
|
|
|
|
|
"latest" ->
|
|
|
|
|
AshHqWeb.Helpers.latest_version(library)
|
|
|
|
|
|
|
|
|
|
version ->
|
|
|
|
|
Enum.find(
|
|
|
|
|
library.versions,
|
|
|
|
|
&(&1.version == version)
|
|
|
|
|
)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
if library_version do
|
|
|
|
|
socket =
|
|
|
|
|
assign(
|
|
|
|
|
socket,
|
|
|
|
|
library_version: library_version
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
if socket.assigns.params["version"] != "latest" &&
|
|
|
|
|
(!socket.assigns[:library] ||
|
|
|
|
|
socket.assigns.params["library"] !=
|
|
|
|
|
socket.assigns.library.name) do
|
|
|
|
|
new_selected_versions =
|
|
|
|
|
Map.put(socket.assigns.selected_versions, library.id, library_version.id)
|
|
|
|
|
|
|
|
|
|
socket
|
|
|
|
|
|> assign(selected_versions: new_selected_versions)
|
|
|
|
|
|> push_event("selected-versions", new_selected_versions)
|
|
|
|
|
else
|
|
|
|
|
socket
|
|
|
|
|
end
|
|
|
|
|
else
|
|
|
|
|
assign(socket, :library_version, nil)
|
|
|
|
|
end
|
|
|
|
|
else
|
|
|
|
|
assign(socket, :library_version, nil)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
assign(socket, :library, library)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp assign_extension(socket) do
|
|
|
|
|
if socket.assigns.library_version && socket.assigns[:params]["extension"] do
|
|
|
|
|
extensions = socket.assigns.library_version.extensions
|
|
|
|
|
|
|
|
|
|
assign(socket,
|
|
|
|
|
extension:
|
|
|
|
|
Enum.find(extensions, fn extension ->
|
2022-12-09 19:47:45 +13:00
|
|
|
extension.sanitized_name == socket.assigns[:params]["extension"] ||
|
|
|
|
|
AshHqWeb.DocRoutes.sanitize_name(extension.target) ==
|
|
|
|
|
socket.assigns[:params]["extension"]
|
2022-09-13 08:47:14 +12:00
|
|
|
end)
|
|
|
|
|
)
|
|
|
|
|
else
|
2023-01-18 15:33:49 +13:00
|
|
|
if socket.assigns.library_version && socket.assigns[:params]["module"] do
|
|
|
|
|
extensions = socket.assigns.library_version.extensions
|
|
|
|
|
|
|
|
|
|
assign(socket,
|
|
|
|
|
extension:
|
|
|
|
|
Enum.find(extensions, fn extension ->
|
|
|
|
|
extension.sanitized_name == socket.assigns[:params]["module"] ||
|
|
|
|
|
AshHqWeb.DocRoutes.sanitize_name(extension.target) ==
|
|
|
|
|
socket.assigns[:params]["module"]
|
|
|
|
|
end)
|
|
|
|
|
)
|
|
|
|
|
else
|
|
|
|
|
assign(socket, :extension, nil)
|
|
|
|
|
end
|
2022-09-13 08:47:14 +12:00
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp assign_guide(socket) do
|
2022-11-03 20:58:14 +13:00
|
|
|
guide_route = socket.assigns[:params]["guide"]
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
guide =
|
2022-11-03 20:58:14 +13:00
|
|
|
if guide_route && socket.assigns.library_version do
|
|
|
|
|
guide_route = Enum.map(List.wrap(guide_route), &String.trim_trailing(&1, ".md"))
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
Enum.find(socket.assigns.library_version.guides, fn guide ->
|
2022-11-03 20:58:14 +13:00
|
|
|
matches_path?(guide, guide_route) || matches_name?(guide, guide_route)
|
2022-09-13 08:47:14 +12:00
|
|
|
end)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
assign(socket, :guide, guide)
|
|
|
|
|
end
|
|
|
|
|
|
2022-11-03 20:58:14 +13:00
|
|
|
defp matches_path?(guide, guide_route) do
|
2022-12-15 21:28:03 +13:00
|
|
|
guide.sanitized_route == DocRoutes.sanitize_name(Enum.join(guide_route, "/"), true)
|
2022-11-03 20:58:14 +13:00
|
|
|
end
|
|
|
|
|
|
2022-12-15 21:28:03 +13:00
|
|
|
defp matches_name?(guide, list) do
|
|
|
|
|
guide_name = List.last(list)
|
|
|
|
|
DocRoutes.sanitize_name(guide.name) == DocRoutes.sanitize_name(guide_name)
|
2022-11-03 20:58:14 +13:00
|
|
|
end
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
defp assign_dsl(socket) do
|
|
|
|
|
case socket.assigns[:params]["dsl_path"] do
|
|
|
|
|
nil ->
|
|
|
|
|
assign(socket, :dsl, nil)
|
|
|
|
|
|
|
|
|
|
path ->
|
|
|
|
|
path = Enum.join(path, "/")
|
|
|
|
|
|
|
|
|
|
dsl =
|
|
|
|
|
Enum.find(
|
|
|
|
|
socket.assigns.extension.dsls,
|
|
|
|
|
&(&1.sanitized_path == path)
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
socket
|
|
|
|
|
|> assign(
|
|
|
|
|
:dsl,
|
|
|
|
|
dsl
|
|
|
|
|
)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
defp assign_module(socket) do
|
2023-01-18 15:33:49 +13:00
|
|
|
if !socket.assigns.extension && socket.assigns.library && socket.assigns.library_version &&
|
2022-09-13 08:47:14 +12:00
|
|
|
socket.assigns[:params]["module"] do
|
|
|
|
|
module =
|
|
|
|
|
Enum.find(
|
|
|
|
|
socket.assigns.library_version.modules,
|
|
|
|
|
&(&1.sanitized_name == socket.assigns[:params]["module"])
|
|
|
|
|
)
|
|
|
|
|
|
2022-09-30 05:56:07 +13:00
|
|
|
functions_query =
|
|
|
|
|
AshHq.Docs.Function
|
|
|
|
|
|> Ash.Query.sort(name: :asc, arity: :asc)
|
|
|
|
|
|> load_for_search(socket.assigns[:params]["module"])
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
assign(socket,
|
2022-09-30 05:56:07 +13:00
|
|
|
module: AshHq.Docs.load!(module, [functions: functions_query], lazy?: true)
|
2022-09-13 08:47:14 +12:00
|
|
|
)
|
|
|
|
|
else
|
|
|
|
|
assign(socket, :module, nil)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2022-09-30 05:56:07 +13:00
|
|
|
defp assign_mix_task(socket) do
|
|
|
|
|
if socket.assigns.library && socket.assigns.library_version &&
|
|
|
|
|
socket.assigns[:params]["mix_task"] do
|
|
|
|
|
mix_task =
|
|
|
|
|
Enum.find(
|
|
|
|
|
socket.assigns.library_version.mix_tasks,
|
|
|
|
|
&(&1.sanitized_name == socket.assigns[:params]["mix_task"])
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
assign(socket,
|
|
|
|
|
mix_task: mix_task
|
|
|
|
|
)
|
|
|
|
|
else
|
|
|
|
|
assign(socket, :mix_task, nil)
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
defp assign_docs(socket) do
|
|
|
|
|
cond do
|
|
|
|
|
socket.assigns.module ->
|
2023-01-18 15:33:49 +13:00
|
|
|
send(self(), {:page_title, socket.assigns.module.name})
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
assign(socket,
|
|
|
|
|
docs: socket.assigns.module.html_for,
|
2022-12-27 22:31:13 +13:00
|
|
|
title: "Module: #{socket.assigns.module.name}",
|
|
|
|
|
description: "View the documentation for #{socket.assigns.module.name} on Ash HQ.",
|
2022-09-13 08:47:14 +12:00
|
|
|
doc_path: [socket.assigns.library.name, socket.assigns.module.name],
|
|
|
|
|
options: []
|
|
|
|
|
)
|
2022-09-30 05:56:07 +13:00
|
|
|
|
|
|
|
|
socket.assigns.mix_task ->
|
2023-01-18 17:53:21 +13:00
|
|
|
send(self(), {:page_title, socket.assigns.mix_task.name})
|
2023-01-18 15:33:49 +13:00
|
|
|
|
2022-09-30 05:56:07 +13:00
|
|
|
assign(socket,
|
|
|
|
|
docs: socket.assigns.mix_task.html_for,
|
2022-12-27 22:31:13 +13:00
|
|
|
title: "Mix Task: #{socket.assigns.mix_task.name}",
|
|
|
|
|
description: "View the documentation for #{socket.assigns.mix_task.name} on Ash HQ.",
|
2022-09-30 05:56:07 +13:00
|
|
|
doc_path: [socket.assigns.library.name, socket.assigns.mix_task.name],
|
|
|
|
|
options: []
|
|
|
|
|
)
|
2022-09-13 08:47:14 +12:00
|
|
|
|
|
|
|
|
socket.assigns.dsl ->
|
2023-01-18 17:53:21 +13:00
|
|
|
send(self(), {:page_title, socket.assigns.dsl.name})
|
2023-01-18 15:33:49 +13:00
|
|
|
|
2022-12-27 22:31:13 +13:00
|
|
|
meta_name =
|
|
|
|
|
Enum.join(
|
|
|
|
|
[
|
|
|
|
|
socket.assigns.library.name,
|
|
|
|
|
socket.assigns.extension.name
|
|
|
|
|
] ++ socket.assigns.dsl.path ++ [socket.assigns.dsl.name],
|
|
|
|
|
" > "
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
meta_type = String.capitalize(to_string(socket.assigns.dsl.type))
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
assign(socket,
|
|
|
|
|
docs: socket.assigns.dsl.html_for,
|
2022-12-27 22:31:13 +13:00
|
|
|
title: "DSL #{meta_type}: #{meta_name}",
|
|
|
|
|
description: "View the documentation for DSL #{meta_type}: #{meta_name} on Ash HQ.",
|
2022-09-13 08:47:14 +12:00
|
|
|
doc_path:
|
|
|
|
|
[
|
|
|
|
|
socket.assigns.library.name,
|
|
|
|
|
socket.assigns.extension.name
|
|
|
|
|
] ++ socket.assigns.dsl.path ++ [socket.assigns.dsl.name],
|
|
|
|
|
options:
|
|
|
|
|
Enum.filter(
|
|
|
|
|
socket.assigns.extension.options,
|
|
|
|
|
&(&1.path == socket.assigns.dsl.path ++ [socket.assigns.dsl.name])
|
|
|
|
|
)
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
socket.assigns.extension ->
|
2023-01-18 17:53:21 +13:00
|
|
|
send(self(), {:page_title, socket.assigns.extension.name})
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
assign(socket,
|
|
|
|
|
docs: socket.assigns.extension.html_for,
|
2022-12-27 22:31:13 +13:00
|
|
|
title: "Extension: #{socket.assigns.extension.name}",
|
|
|
|
|
description: "View the documentation for #{socket.assigns.extension.name} on Ash HQ.",
|
2022-09-13 08:47:14 +12:00
|
|
|
doc_path: [socket.assigns.library.name, socket.assigns.extension.name],
|
|
|
|
|
options: []
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
socket.assigns.guide ->
|
2023-01-18 17:53:21 +13:00
|
|
|
send(self(), {:page_title, socket.assigns.guide.name})
|
|
|
|
|
|
2022-09-13 08:47:14 +12:00
|
|
|
assign(socket,
|
2022-12-27 22:31:13 +13:00
|
|
|
title: "Guide: #{socket.assigns.guide.name}",
|
2022-09-13 08:47:14 +12:00
|
|
|
docs: socket.assigns.guide.html_for,
|
2022-12-27 22:31:13 +13:00
|
|
|
description: "Read the \"#{socket.assigns.guide.name}\" guide on Ash HQ",
|
2022-09-13 08:47:14 +12:00
|
|
|
doc_path: [socket.assigns.library.name, socket.assigns.guide.name],
|
|
|
|
|
options: []
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
true ->
|
2022-12-27 22:31:13 +13:00
|
|
|
assign(socket,
|
|
|
|
|
docs: "",
|
|
|
|
|
title: "Ash Framework",
|
|
|
|
|
description: default_description(),
|
|
|
|
|
doc_path: [],
|
|
|
|
|
dsls: [],
|
|
|
|
|
options: []
|
|
|
|
|
)
|
2022-09-13 08:47:14 +12:00
|
|
|
end
|
|
|
|
|
end
|
2022-11-02 18:29:57 +13:00
|
|
|
|
2022-12-27 22:31:13 +13:00
|
|
|
# defp description(html) do
|
|
|
|
|
# This isn't predictably good content to put in a snippet :(
|
|
|
|
|
# html
|
|
|
|
|
# |> Floki.parse_fragment()
|
|
|
|
|
# |> elem(1)
|
|
|
|
|
# |> Floki.text()
|
|
|
|
|
# |> String.split("\n", trim: true)
|
|
|
|
|
# |> Stream.map(&String.trim/1)
|
|
|
|
|
# |> Stream.map(&String.replace(&1, ~r/{{.*(?!}})$/, ""))
|
|
|
|
|
# |> Stream.reject(&(&1 == ""))
|
|
|
|
|
# |> Stream.take(4)
|
|
|
|
|
# |> Enum.join("\n")
|
|
|
|
|
# rescue
|
|
|
|
|
# _ ->
|
|
|
|
|
# default_description()
|
|
|
|
|
# end
|
|
|
|
|
|
|
|
|
|
defp default_description do
|
|
|
|
|
"A declarative foundation for ambitious Elixir applications. Model your domain, derive the rest."
|
|
|
|
|
end
|
|
|
|
|
|
2022-11-02 18:29:57 +13:00
|
|
|
# workaround for https://github.com/patrick-steele-idem/morphdom/pull/231
|
|
|
|
|
# Adding a unique ID on the container for the rendered docs prevents morphdom
|
|
|
|
|
# merging them incorrectly.
|
|
|
|
|
defp docs_container_id(doc_path) do
|
|
|
|
|
["docs-container" | doc_path]
|
|
|
|
|
|> Enum.join("-")
|
|
|
|
|
|> String.replace(~r/[^A-Za-z0-9_]/, "-")
|
|
|
|
|
|> String.downcase()
|
|
|
|
|
end
|
2022-03-28 10:26:35 +13:00
|
|
|
end
|
