ash_hq/lib/ash_hq_web/doc_routes.ex

92 lines
2.4 KiB
Elixir
Raw Normal View History

defmodule AshHqWeb.DocRoutes do
@moduledoc "Helpers for routing to results of searches"
2023-02-21 18:52:45 +13:00
2022-04-08 18:59:39 +12:00
def doc_link(entity, selected_versions \\ %{})
2022-03-30 17:40:17 +13:00
2022-04-08 18:59:39 +12:00
def doc_link(%AshHq.Docs.Library{name: name}, _selected_version) do
"https://hexdocs.pm/#{name}"
2022-03-30 17:40:17 +13:00
end
def doc_link(
%AshHq.Docs.MixTask{
library_name: library_name,
module_name: module_name
},
_selected_versions
) do
"https://hexdocs.pm/#{library_name}/#{module_name}.html"
end
2022-04-08 18:59:39 +12:00
def doc_link(
%AshHq.Docs.Module{
library_name: library_name,
name: name
2022-04-08 18:59:39 +12:00
},
_selected_versions
2022-04-08 18:59:39 +12:00
) do
"https://hexdocs.pm/#{library_name}/#{name}.html"
2022-03-30 17:40:17 +13:00
end
2022-04-08 18:59:39 +12:00
def doc_link(
%AshHq.Docs.Function{
name: name,
2022-04-08 18:59:39 +12:00
arity: arity,
module_name: module_name,
library_name: library_name
2022-04-08 18:59:39 +12:00
},
_selected_versions
2022-04-08 18:59:39 +12:00
) do
"https://hexdocs.pm/#{library_name}/#{module_name}.html##{name}/#{arity}"
2022-03-30 17:40:17 +13:00
end
2022-04-08 18:59:39 +12:00
def doc_link(
%AshHq.Docs.Guide{
route: route,
library_version: %{
library_name: library_name,
version: version,
library_id: library_id
}
},
selected_versions
) do
"/docs/guides/#{library_name}/#{version(version, library_id, selected_versions)}/#{route}"
2022-03-29 08:47:43 +13:00
end
def doc_link(%AshHq.Docs.LibraryVersion{}, _selected_versions) do
raise "Shouldn't be called anymore"
2022-03-30 05:12:28 +13:00
end
2022-04-08 18:59:39 +12:00
def doc_link(
%AshHq.Docs.Extension{
library_version: %{
library_name: library_name
2022-04-08 18:59:39 +12:00
},
module: module
2022-04-08 18:59:39 +12:00
},
_selected_versions
2022-04-08 18:59:39 +12:00
) do
"https://hexdocs.pm/#{library_name}/#{module}.html"
2022-03-28 10:26:35 +13:00
end
2023-02-21 18:52:45 +13:00
def doc_link(item, _selected_versions) do
"https://hexdocs.pm/#{item.library_name}/dsl-#{sanitize_name(String.trim_trailing(item.extension_module, ".Dsl"))}.html##{String.replace(item.sanitized_path, "/", "-")}"
2022-04-08 18:59:39 +12:00
end
defp version(version_name, library_id, selected_versions) do
if selected_versions[library_id] == "latest" do
"latest"
else
version_name
2022-03-28 10:26:35 +13:00
end
end
2022-03-30 05:12:28 +13:00
def sanitize_name(name, allow_forward_slash? \\ false) do
if allow_forward_slash? do
String.downcase(String.replace(to_string(name), ~r/[^A-Za-z0-9\/_]/, "-"))
else
String.downcase(String.replace(to_string(name), ~r/[^A-Za-z0-9_]/, "-"))
end
2022-03-30 05:12:28 +13:00
end
2022-03-28 10:26:35 +13:00
end