defmodule AshHqWeb.Pages.Docs do @moduledoc "The page for showing documentation" use Surface.Component alias AshHq.Docs.Extensions.RenderMarkdown alias AshHqWeb.Components.{CalloutText, DocSidebar, RightNav, Tag} alias AshHqWeb.DocRoutes alias Phoenix.LiveView.JS require Logger prop change_versions, :event, required: true prop selected_versions, :map, required: true prop libraries, :list, default: [] prop uri, :string prop sidebar_state, :map, required: true prop collapse_sidebar, :event, required: true prop expand_sidebar, :event, required: true prop library, :any prop extension, :any prop docs, :any prop library_version, :any prop guide, :any prop doc_path, :list, default: [] prop dsls, :list, default: [] prop dsl, :any prop options, :list, default: [] prop module, :any @spec render(any) :: Phoenix.LiveView.Rendered.t() def render(assigns) do ~F"""
{#if @doc_path && @doc_path != []}
{#case @doc_path} {#match [item]}
{item}
{#match path} {#for item <- :lists.droplast(path)} {item} {/for} {List.last(path)} {/case}
{/if}
""" end defp render_source_code_link(assigns, module_or_function, library, library_version) do ~F""" {#if module_or_function.file} {""} {/if} """ end 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 -> case find_module(libraries, selected_versions, mod_name) do nil -> Logger.warn("No such module found called #{inspect(mod_name)}") [] module -> [module] end end) end defp find_module(libraries, selected_versions, mod_name) do Enum.find_value(libraries, fn library -> Enum.find_value(library.versions, fn version -> if version.id == selected_versions[library.id] do Enum.find(version.modules, &(&1.name == mod_name)) end end) end) end 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 defp render_functions(assigns, functions, type, header) do ~F""" {#case Enum.filter(functions, &(&1.type == type))} {#match []} {#match functions}

{header}

{#for function <- functions}

{#for head <- function.heads} {head} {/for} {raw(render_replacements(assigns, RenderMarkdown.as_html!(function.html_for, false)))}

{/for} {/case} """ end defp source_link(%AshHq.Docs.Module{file: file}, library, library_version) do "https://github.com/ash-project/#{library.name}/tree/#{library_version.version}/#{file}" end defp source_link(%AshHq.Docs.Function{file: file, line: line}, library, library_version) do if line do "https://github.com/ash-project/#{library.name}/tree/#{library_version.version}/#{file}#L#{line}" else "https://github.com/ash-project/#{library.name}/tree/#{library_version.version}/#{file}" end end def path_to_name(path, name) do Enum.map_join(path ++ [name], "-", &DocRoutes.sanitize_name/1) end defp render_tags(assigns, option) do ~F""" {#if option.required} Required {/if} """ end def show_sidebar(js \\ %JS{}) do js |> JS.toggle( to: "#mobile-sidebar-container", in: { "transition ease-in duration-100", "opacity-0", "opacity-100" }, out: { "transition ease-out duration-75", "opacity-100", "opacity-0" } ) end defp render_replacements(_assigns, nil), do: "" defp render_replacements(assigns, docs) do docs |> render_links(assigns) |> render_mix_deps(assigns) end defp render_mix_deps(docs, assigns) do String.replace(docs, ~r/^(?!\<\/code\>){{mix_dep:.*}}/, fn text -> try do "{{mix_dep:" <> library = String.trim_trailing(text, "}}") render_mix_dep(assigns, library, text) rescue e -> Logger.error("Invalid link #{inspect(e)}") text end end) end defp render_mix_dep(assigns, library, source) do library = Enum.find(assigns[:libraries], &(&1.name == library)) || raise "No such library in link: #{source}" selected_versions = assigns[:selected_versions] version = if selected_versions[library.id] == "latest" do AshHqWeb.Helpers.latest_version(library) else case Enum.find(library.versions, &(&1.id == selected_versions[library.id])) do nil -> nil version -> version end end if version.branch do ~s({:#{library.name}, github: "ash-project/#{library.name}", branch: "#{version}"}) else case Version.parse(version) do {:ok, %{major: major, minor: minor, patch: 0}} -> ~s({:#{library.name}, "~> #{major}.#{minor}"}) {:ok, version} -> ~s({:#{library.name}, "~> #{version}"}) end end end defp render_links(docs, assigns) do String.replace(docs, ~r/(?!){{link:.*}}(?!<\/code>)/, fn text -> try do "{{link:" <> rest = String.trim_trailing(text, "}}") [library, type, item] = String.split(rest, ":") render_link(assigns, library, type, item, text) rescue e -> Logger.error("Invalid link #{inspect(e)}") text end end) end defp render_link(assigns, library, type, item, source) do library = Enum.find(assigns[:libraries], &(&1.name == library)) || raise "No such library in link: #{source}" selected_versions = assigns[:selected_versions] version = if selected_versions[library.id] in ["latest", nil, ""] do Enum.find(library.versions, &String.contains?(&1.version, ".")) || AshHqWeb.Helpers.latest_version(library) else case Enum.find(library.versions, &(&1.id == selected_versions[library.id])) do nil -> nil version -> version end end if is_nil(version) do raise "no version for library" else case type do "guide" -> guide = Enum.find(version.guides, &(&1.name == item)) || raise "No such guide in link: #{source}" """ #{item} """ "dsl" -> name = item |> String.split("/") |> Enum.join(".") """ #{name} """ "module" -> """ #{item} """ "extension" -> """ #{item} """ type -> raise "unimplemented link type #{inspect(type)} in #{source}" end end end end