Cleaned up implementation. Additional tests.

Author: jwarwick

lib/ex_doc/html_formatter/autolink.ex

@@ -19,7 +19,8 @@ defmodule ExDoc.HTMLFormatter.Autolink do
  """
  def all(modules) do
  aliases = Enum.map modules, &(&1.module)
- Enum.map modules, &(&1 |> local_docs() |> project_docs(modules) |> all_typespecs(aliases))
+ project_funs = all_functions(modules)
+ Enum.map modules, &(&1 |> local_docs() |> project_docs(project_funs) |> all_typespecs(aliases))
  end
 
  defp local_docs(ExDoc.ModuleNode[] = module) do
@@ -33,8 +34,7 @@ defmodule ExDoc.HTMLFormatter.Autolink do
  module.moduledoc(moduledoc).docs(docs)
  end
 
- defp project_docs(ExDoc.ModuleNode[] = module, all_modules) do
- project_funs = all_functions(all_modules)
+ defp project_docs(ExDoc.ModuleNode[] = module, project_funs) do
  moduledoc = module.moduledoc && project_doc(module.moduledoc, project_funs)
 
  docs = lc node inlist module.docs do
@@ -62,16 +62,12 @@ defmodule ExDoc.HTMLFormatter.Autolink do
  module.typespecs(typespecs).docs(docs)
  end
 
- @doc """
- Given a list of `ModulesNodes`, return a list of all functions defined in those modules.
- """
- def all_functions(modules) do
- m = Enum.map modules, fn (mod) ->
+ defp all_functions(modules) do
+ Enum.flat_map modules, fn (mod) ->
  Enum.map mod.docs, fn (d) ->
  mod.id <> "." <> d.id
  end
  end
- List.flatten m
  end
 
  @doc """
@@ -165,7 +161,7 @@ defmodule ExDoc.HTMLFormatter.Autolink do
  |> List.flatten
  |> Enum.filter(&(&1 in project_funs))
  |> Enum.reduce(bin, fn (x, acc) ->
- {mod_str, function_name, arity} = split_function(x)
+ { mod_str, function_name, arity } = split_function(x)
  escaped = Regex.escape(x)
  Regex.replace(%r/(?<!\[)`(\s*#{escaped}\s*)`(?!\])/, acc, 
  "[`\\1`](#{mod_str}.html##{function_name}/#{arity})")
@@ -174,14 +170,7 @@ defmodule ExDoc.HTMLFormatter.Autolink do
 
  defp split_function(bin) do
  [modules, arity] = String.split(bin, "/")
- rev = modules
- |> String.split(".")
- |> Enum.reverse
- function_name = hd(rev)
- mod_str = rev
- |> tl
- |> Enum.reverse
- |> Enum.join(".")
- {mod_str, function_name, arity}
+ { mod, name } = modules |> String.split(".") |> Enum.split(-1)
+ { Enum.join(mod, "."), hd(name), arity }
  end
 end

test/ex_doc/html_formatter/autolink_test.exs

@@ -49,26 +49,14 @@ defmodule ExDoc.HTMLFormatter.AutolinkTest do
  "[`Mod.funny_name\?/1`](Mod.html#funny_name\?/1) and [`Mod.funny_name!/2`](Mod.html#funny_name!/2)"
  end
 
- # all_functions
-
- test "all_functions returns empty for empty list" do
- assert Autolink.all_functions([]) == []
+ test "autolink doesn't create links for undefined Mod.functions in docs" do
+ assert Autolink.project_doc("`Mod.example/1`", ["Mod.example/2"]) == "`Mod.example/1`"
+ assert Autolink.project_doc("`Mod.example/1`", []) == "`Mod.example/1`"
  end
 
- test "all_functions returns the correct values" do
- defmodule Outer do
- defmodule Inner do
- def inner_one(_a), do: true
- def inner_two, do: true
- end
- def outer_one, do: true
- end
-
- modules = ExDoc.Retriever.docs_from_modules([Outer, Outer.Inner], ExDoc.Config.new)
- modules = Autolink.all_functions modules
- set = HashSet.new modules
- expected = HashSet.new ["ExDoc.HTMLFormatter.AutolinkTest.Outer.outer_one/0", "ExDoc.HTMLFormatter.AutolinkTest.Outer.Inner.inner_one/1", "ExDoc.HTMLFormatter.AutolinkTest.Outer.Inner.inner_two/0"]
- assert set == expected
+ test "autolink doesn't create links for pre-linked Mod.functions docs" do
+ assert Autolink.project_doc("[`Mod.example/1`]()", ["Mod.example/1"]) == "[`Mod.example/1`]()"
+ assert Autolink.project_doc("[the `Mod.example/1`]()", ["Mod.example/1"]) == "[the `Mod.example/1`]()"
  end
 
  # typespec