removed ModuleNode.docs struct field, updated tests

Author: lud

formatters/html/dist/html-elixir-462OCYHX.css

@@ -7,7 +7,7 @@ defmodule ExDoc.Formatter.HTML.Assets do
     |> Path.wildcard()
     |> Enum.map(fn path ->
       Module.put_attribute(__CALLER__.module, :external_resource, path)
-      {Path.basename(path), File.read!(path)}
+      {Path.basename(path), "File.read!(#{path})"}
     end)
   end
 

formatters/html/dist/html-elixir-BHUPNQFZ.css

@@ -44,7 +44,12 @@ defmodule ExDoc.Formatter.HTML.SearchData do
     page = URI.encode(node.id) <> ".html"
     {intro, sections} = extract_sections(node.source_format, node, "module-")
     module = encode(page, node.title, node.type, intro)
-    docs = Enum.flat_map(node.docs, &node_child(&1, node, page))
+
+    docs =
+      node.docs_groups
+      |> Enum.flat_map(& &1.docs)
+      |> Enum.flat_map(&node_child(&1, node, page))
+
     [module] ++ render_sections(sections, page, node.title, node.type) ++ docs
   end
 

formatters/html/dist/html-elixir-KV3YOVJ3.css

@@ -17,7 +17,6 @@ defmodule ExDoc.ModuleNode do
             source_path: nil,
             source_url: nil,
             docs_groups: [],
-            docs: [],
             typespecs: [],
             type: nil,
             language: nil,
@@ -42,7 +41,6 @@ defmodule ExDoc.ModuleNode do
           source_path: String.t() | nil,
           source_url: String.t() | nil,
           docs_groups: [ExDoc.DocGroupNode.t()],
-          docs: [ExDoc.DocNode.t()],
           typespecs: [ExDoc.DocNode.t()],
           type: atom(),
           language: module(),

formatters/html/dist/html-erlang-DQDXQC7W.css

@@ -167,7 +167,6 @@ defmodule ExDoc.Retriever do
       type: module_data.type,
       deprecated: metadata[:deprecated],
       docs_groups: docs_groups,
-      docs: docs,
       doc: normalize_doc_ast(doc_ast, "module-"),
       source_doc: source_doc,
       source_format: format,

formatters/html/dist/html-erlang-NAGTPUO7.css

@@ -1,6 +1,7 @@
 defmodule ExDoc.Retriever.ElixirTest do
   use ExUnit.Case, async: true
-  alias ExDoc.{Retriever, DocAST}
+  alias ExDoc.ModuleNode
+  alias ExDoc.{Retriever, DocAST, DocGroupNode}
   import TestHelper
 
   @moduletag :tmp_dir
@@ -36,11 +37,12 @@ defmodule ExDoc.Retriever.ElixirTest do
                title: "Mod",
                type: :module,
                typespecs: [],
-               docs: [empty_doc_and_specs, function, macro],
+               docs_groups: [functions_group],
                annotations: [:public]
              } = mod
 
       assert DocAST.to_string(mod.doc) == "<p>Mod docs.</p>"
+      assert %DocGroupNode{docs: [empty_doc_and_specs, function, macro]} = functions_group
 
       assert %ExDoc.DocNode{
                arity: 0,
@@ -87,7 +89,7 @@ defmodule ExDoc.Retriever.ElixirTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([Mod], %ExDoc.Config{})
-      [foo] = mod.docs
+      [%{docs: [foo]}] = mod.docs_groups
 
       assert foo.id == "foo/2"
       assert foo.defaults == [foo: 1]
@@ -103,7 +105,7 @@ defmodule ExDoc.Retriever.ElixirTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([Mod], %ExDoc.Config{})
-      [macro] = mod.docs
+      [%{docs: [macro]}] = mod.docs_groups
 
       assert macro.id == "macro/1"
       assert macro.annotations == ["macro"]
@@ -131,7 +133,8 @@ defmodule ExDoc.Retriever.ElixirTest do
       {[mod], []} = Retriever.docs_from_modules([Mod], config)
       assert mod.type == :behaviour
 
-      [callback1, macrocallback1, optional_callback1] = mod.docs
+      assert [%DocGroupNode{docs: [callback1, macrocallback1, optional_callback1]}] =
+               mod.docs_groups
 
       assert callback1.id == "c:callback1/0"
       assert callback1.signature == "callback1()"
@@ -178,7 +181,7 @@ defmodule ExDoc.Retriever.ElixirTest do
       """)
 
       {[impl], []} = Retriever.docs_from_modules([Impl], %ExDoc.Config{})
-      [callback1, optional_callback1] = impl.docs
+      assert [%DocGroupNode{docs: [callback1, optional_callback1]}] = impl.docs_groups
 
       assert callback1.id == "callback1/0"
       assert callback1.type == :function
@@ -204,7 +207,7 @@ defmodule ExDoc.Retriever.ElixirTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([Mod], %ExDoc.Config{})
-      [opaque1, type1] = mod.docs
+      [%{docs: [opaque1, type1]}] = mod.docs_groups
 
       assert type1.id == "t:type1/0"
       assert type1.signature == "type1()"
@@ -238,7 +241,8 @@ defmodule ExDoc.Retriever.ElixirTest do
       {[mod], []} = Retriever.docs_from_modules([Mod, Mod.Atom], %ExDoc.Config{})
       assert mod.type == :protocol
 
-      [foo, t] = mod.docs
+      assert [%{title: "Types", docs: [t]}, %{title: "Functions", docs: [foo]}] = mod.docs_groups
+
       assert foo.id == "foo/1"
       assert t.id == "t:t/0"
     end
@@ -252,7 +256,7 @@ defmodule ExDoc.Retriever.ElixirTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([MyStruct], %ExDoc.Config{})
-      [my_struct] = mod.docs
+      [%{docs: [my_struct]}] = mod.docs_groups
 
       assert my_struct.id == "__struct__/0"
       assert my_struct.annotations == ["struct"]
@@ -285,7 +289,7 @@ defmodule ExDoc.Retriever.ElixirTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([Mod], %ExDoc.Config{})
-      [downcase, upcase] = mod.docs
+      [%{docs: [downcase, upcase]}] = mod.docs_groups
 
       assert downcase.id == "downcase/1"
       assert downcase.signature == "downcase(str)"
@@ -306,7 +310,7 @@ defmodule ExDoc.Retriever.ElixirTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([Signatures], %ExDoc.Config{})
-      [remote] = mod.docs
+      [%{docs: [remote]}] = mod.docs_groups
 
       assert remote.signature == "remote(options)"
     end
@@ -368,23 +372,23 @@ defmodule ExDoc.Retriever.ElixirTest do
 
       {[mod], []} = Retriever.docs_from_modules([Mod], %ExDoc.Config{})
 
-      overlapping_defaults_2 = Enum.find(mod.docs, &(&1.id == "overlapping_defaults/2"))
-      overlapping_defaults_3 = Enum.find(mod.docs, &(&1.id == "overlapping_defaults/3"))
+      overlapping_defaults_2 = find_doc(mod, &(&1.id == "overlapping_defaults/2"))
+      overlapping_defaults_3 = find_doc(mod, &(&1.id == "overlapping_defaults/3"))
       assert overlapping_defaults_2.defaults == []
       assert overlapping_defaults_3.defaults == []
 
-      two_defaults_2 = Enum.find(mod.docs, &(&1.id == "two_defaults/2"))
-      two_defaults_4 = Enum.find(mod.docs, &(&1.id == "two_defaults/4"))
+      two_defaults_2 = find_doc(mod, &(&1.id == "two_defaults/2"))
+      two_defaults_4 = find_doc(mod, &(&1.id == "two_defaults/4"))
       assert two_defaults_2.defaults == []
       assert two_defaults_4.defaults == [{:two_defaults, 3}]
 
-      special_case_2 = Enum.find(mod.docs, &(&1.id == "special_case/2"))
-      special_case_4 = Enum.find(mod.docs, &(&1.id == "special_case/4"))
+      special_case_2 = find_doc(mod, &(&1.id == "special_case/2"))
+      special_case_4 = find_doc(mod, &(&1.id == "special_case/4"))
       assert special_case_2.defaults == []
       assert special_case_4.defaults == [special_case: 1, special_case: 3]
 
-      in_the_middle_2 = Enum.find(mod.docs, &(&1.id == "in_the_middle/2"))
-      in_the_middle_3 = Enum.find(mod.docs, &(&1.id == "in_the_middle/3"))
+      in_the_middle_2 = find_doc(mod, &(&1.id == "in_the_middle/2"))
+      in_the_middle_3 = find_doc(mod, &(&1.id == "in_the_middle/3"))
       assert in_the_middle_2.defaults == []
       assert in_the_middle_3.defaults == []
     end
@@ -408,16 +412,22 @@ defmodule ExDoc.Retriever.ElixirTest do
                Retriever.docs_from_modules([Mod], %ExDoc.Config{})
 
       assert %ExDoc.DocNode{annotations: ["since 1.0.0"]} =
-               Enum.find(mod.docs, &(&1.id == "t:t/0"))
+               find_doc(mod, &(&1.id == "t:t/0"))
 
       assert %ExDoc.DocNode{annotations: ["since 1.0.0"]} =
-               Enum.find(mod.docs, &(&1.id == "c:cb/0"))
+               find_doc(mod, &(&1.id == "c:cb/0"))
 
       assert %ExDoc.DocNode{annotations: ["since 1.0.0"]} =
-               Enum.find(mod.docs, &(&1.id == "function/0"))
+               find_doc(mod, &(&1.id == "function/0"))
 
       assert %ExDoc.DocNode{annotations: ["since 1.0.0", "macro"]} =
-               Enum.find(mod.docs, &(&1.id == "macro/0"))
+               find_doc(mod, &(&1.id == "macro/0"))
     end
   end
+
+  defp find_doc(%ModuleNode{} = mod, predicate) do
+    mod.docs_groups
+    |> Stream.flat_map(& &1.docs)
+    |> Enum.find(predicate)
+  end
 end

formatters/html/dist/html-erlang-U4PKJ7EN.css

@@ -1,6 +1,6 @@
 defmodule ExDoc.Retriever.ErlangTest do
   use ExUnit.Case, async: true
-  alias ExDoc.{Retriever, DocAST, Language.Erlang}
+  alias ExDoc.{Retriever, DocAST, Language.Erlang, DocGroupNode}
   import TestHelper
 
   @moduletag :tmp_dir
@@ -58,8 +58,9 @@ defmodule ExDoc.Retriever.ErlangTest do
                deprecated: nil,
                moduledoc_line: 2,
                moduledoc_file: moduledoc_file,
-               docs: [equiv_function2, function1, function2],
-               docs_groups: [%{title: "Functions"}],
+               docs_groups: [
+                 %DocGroupNode{title: "Functions", docs: [equiv_function2, function1, function2]}
+               ],
                group: nil,
                id: "mod",
                language: ExDoc.Language.Erlang,
@@ -153,8 +154,11 @@ defmodule ExDoc.Retriever.ErlangTest do
                deprecated: nil,
                moduledoc_line: 6,
                moduledoc_file: moduledoc_file,
-               docs: [type, callback, function],
-               docs_groups: [%{title: "Types"}, %{title: "Callbacks"}, %{title: "Functions"}],
+               docs_groups: [
+                 %DocGroupNode{title: "Types", docs: [type]},
+                 %DocGroupNode{title: "Callbacks", docs: [callback]},
+                 %DocGroupNode{title: "Functions", docs: [function]}
+               ],
                group: nil,
                id: "mod",
                language: ExDoc.Language.Erlang,
@@ -219,7 +223,7 @@ defmodule ExDoc.Retriever.ErlangTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([:mod], default_config())
-      assert [_] = mod.docs
+      [%{docs: [_]}] = mod.docs_groups
     end
 
     test "callbacks", c do
@@ -239,7 +243,7 @@ defmodule ExDoc.Retriever.ErlangTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([:mod], default_config())
-      [callback1, equiv_callback1, optional_callback1] = mod.docs
+      [%{docs: [callback1, equiv_callback1, optional_callback1]}] = mod.docs_groups
 
       assert callback1.id == "c:callback1/0"
       assert callback1.type == :callback
@@ -286,7 +290,7 @@ defmodule ExDoc.Retriever.ErlangTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([:mod], default_config())
-      [equiv_type1, nominal1, opaque1, type1] = mod.docs
+      [%{docs: [equiv_type1, nominal1, opaque1, type1]}] = mod.docs_groups
 
       assert opaque1.id == "t:opaque1/0"
       assert opaque1.type == :opaque
@@ -345,7 +349,11 @@ defmodule ExDoc.Retriever.ErlangTest do
 
       {[mod], []} = Retriever.docs_from_modules([:mod], default_config())
 
-      [callback, function, type] = mod.docs
+      assert [
+               %{title: "Types", docs: [type]},
+               %{title: "Callbacks", docs: [callback]},
+               %{title: "Functions", docs: [function]}
+             ] = mod.docs_groups
 
       assert hd(function.specs)
              |> Erlang.autolink_spec(current_module: :mod, current_kfa: {:function, :function, 0}) ==
@@ -392,8 +400,7 @@ defmodule ExDoc.Retriever.ErlangTest do
       %ExDoc.ModuleNode{
         deprecated: nil,
         moduledoc_line: _,
-        docs: [function1, function2],
-        docs_groups: [%{title: "Functions"}],
+        docs_groups: [%DocGroupNode{title: "Functions", docs: [function1, function2]}],
         group: nil,
         id: "mod",
         language: ExDoc.Language.Erlang,
@@ -448,7 +455,7 @@ defmodule ExDoc.Retriever.ErlangTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([:mod], default_config())
-      assert [_] = mod.docs
+      [%{docs: [_]}] = mod.docs_groups
     end
 
     test "callbacks", c do
@@ -466,7 +473,7 @@ defmodule ExDoc.Retriever.ErlangTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([:mod], default_config())
-      [callback1, optional_callback1] = mod.docs
+      [%{docs: [callback1, optional_callback1]}] = mod.docs_groups
 
       assert callback1.id == "c:callback1/0"
       assert callback1.type == :callback
@@ -499,7 +506,7 @@ defmodule ExDoc.Retriever.ErlangTest do
       """)
 
       {[mod], []} = Retriever.docs_from_modules([:mod], default_config())
-      [nominal1, opaque1, type1] = mod.docs
+      [%{docs: [nominal1, opaque1, type1]}] = mod.docs_groups
 
       assert opaque1.id == "t:opaque1/0"
       assert opaque1.type == :opaque