Merge pull request #454 from padde/fix-autolink-anchors

Fix autolink anchors for non URL safe function names

Author: josevalim

lib/ex_doc/formatter/html/autolink.ex

@@ -208,8 +208,10 @@ defmodule ExDoc.Formatter.HTML.Autolink do
     |> List.flatten()
     |> Enum.filter(&(&1 in locals))
     |> Enum.reduce(bin, fn (x, acc) ->
+         {prefix, _, function_name, arity} = split_function(x)
          escaped = Regex.escape(x)
-         Regex.replace(~r/(?<!\[)`(\s*(#{escaped})\s*)`(?!\])/, acc, "[`\\1`](#\\2)")
+         Regex.replace(~r/(?<!\[)`(\s*#{escaped}\s*)`(?!\])/, acc,
+           "[`#{function_name}/#{arity}`](##{prefix}#{enc_h function_name}/#{arity})")
        end)
   end
 
@@ -250,7 +252,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
          {prefix, mod_str, function_name, arity} = split_function(x)
          escaped = Regex.escape(x)
          Regex.replace(~r/(?<!\[)`(\s*#{escaped}\s*)`(?!\])/, acc,
-           "[`#{mod_str}.#{function_name}/#{arity}`](#{mod_str}.html##{prefix}#{function_name}/#{arity})")
+           "[`#{mod_str}.#{function_name}/#{arity}`](#{mod_str}.html##{prefix}#{enc_h function_name}/#{arity})")
        end)
   end
 

test/ex_doc/formatter/html/autolink_test.exs

@@ -10,7 +10,7 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
     assert Autolink.local_doc("`example/2` then `example/2`",
       ["example/2"]) == "[`example/2`](#example/2) then [`example/2`](#example/2)"
     assert Autolink.local_doc("`  spaces/0  `", ["spaces/0"]) ==
-      "[`  spaces/0  `](#spaces/0)"
+      "[`spaces/0`](#spaces/0)"
     assert Autolink.local_doc("`example/1` and `example/2`",
       ["example/1", "example/2"]) == "[`example/1`](#example/1) and [`example/2`](#example/2)"
     assert Autolink.local_doc("`funny_name\?/1` and `funny_name!/2`",
@@ -33,6 +33,7 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
     assert Autolink.local_doc("`!/1`", ["!/1"]) === "[`!/1`](#!/1)"
     assert Autolink.local_doc("`../2`", ["../2"]) === "[`../2`](#../2)"
     assert Autolink.local_doc("`--/2`", ["--/2"]) === "[`--/2`](#--/2)"
+    assert Autolink.local_doc("`<<>>/1`", ["<<>>/1"]) === "[`<<>>/1`](#%3C%3C%3E%3E/1)"
   end
 
   # project_functions
@@ -61,6 +62,7 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
     assert Autolink.project_functions("`Mod.!/1`", ["Mod.!/1"]) === "[`Mod.!/1`](Mod.html#!/1)"
     assert Autolink.project_functions("`Mod.../2`", ["Mod.../2"]) === "[`Mod.../2`](Mod.html#../2)"
     assert Autolink.project_functions("`Mod.--/2`", ["Mod.--/2"]) === "[`Mod.--/2`](Mod.html#--/2)"
+    assert Autolink.project_functions("`Mod.<<>>/1`", ["Mod.<<>>/1"]) === "[`Mod.<<>>/1`](Mod.html#%3C%3C%3E%3E/1)"
   end
 
   test "autolink creates links for callbacks" do