Skip to content

Rewrite Autolink tests to use project_doc/2 #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 22, 2018
Merged

Rewrite Autolink tests to use project_doc/2 #908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 15 additions & 19 deletions lib/ex_doc/formatter/html/autolink.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,22 +107,14 @@ defmodule ExDoc.Formatter.HTML.Autolink do

This is the main API to autolink any project documentation.
"""
def project_doc(bin, compiled) when is_binary(bin) do
project_doc(bin, nil, [], compiled)
end
def project_doc(nil, _compiled), do: nil
def project_doc(string, compiled) when is_binary(string) and is_map(compiled) do
config =
compiled
|> Map.put_new(:module_id, nil)
|> Map.put_new(:locals, [])

defp project_doc(nil, _module_id, _locals, _compiled) do
nil
end

defp project_doc(bin, module_id, locals, compiled) when is_binary(bin) do
options =
Map.merge(compiled, %{
module_id: module_id,
locals: locals
})

link_everything(bin, options)
link_everything(string, config)
end

@doc """
Expand All @@ -146,19 +138,23 @@ defmodule ExDoc.Formatter.HTML.Autolink do
do: prefix <> entry

types = Enum.map(module.typespecs, &("t:" <> &1.id))
locals = funs ++ types

moduledoc = project_doc(module.doc, module.id, locals, compiled)
compiled =
compiled
|> Map.put(:module_id, module.id)
|> Map.put(:locals, funs ++ types)

moduledoc = project_doc(module.doc, compiled)

docs =
for module_node <- module.docs do
doc = project_doc(module_node.doc, module.id, locals, compiled)
doc = project_doc(module_node.doc, compiled)
%{module_node | doc: doc}
end

typedocs =
for module_node <- module.typespecs do
doc = project_doc(module_node.doc, module.id, locals, compiled)
doc = project_doc(module_node.doc, compiled)
%{module_node | doc: doc}
end

Expand Down
Loading