WIP Implement Inspect protocol

Author: vittoriabitton

lib/floki/html_tree.ex

@@ -328,4 +328,52 @@ defmodule Floki.HTMLTree do
       do_reduce(tree, fun.(head_node, acc), fun)
     end
   end
+
+  defimpl Inspect do
+    import Inspect.Algebra
+
+    def inspect(html_tree, opts) do
+      open = "%HTMLTree{"
+      close = "}"
+      container_opts = [separator: "", break: :flex]
+      container_doc(open, html_tree.nodes, close, opts, &fun/2, container_opts)
+    end
+
+    defp fun({tag, attributes, content}, opts) do
+      tag_color = :map
+      attribute_color = :map
+
+      attributes =
+        for {name, value} <- attributes do
+          concat([
+            color(" #{name}=", attribute_color, opts),
+            color("\"#{value}\"", :string, opts)
+          ])
+        end
+        |> concat()
+
+      open =
+        concat([
+          color("<#{tag}", tag_color, opts),
+          attributes,
+          color(">", tag_color, opts)
+        ])
+
+      close = color("</#{tag}>", tag_color, opts)
+      container_opts = [separator: "", break: :strict]
+      container_doc(open, content, close, opts, &fun/2, container_opts)
+    end
+
+    defp fun({:comment, content}, opts) do
+      color("<!-- #{content} -->", :comment, opts)
+    end
+
+    defp fun(string, opts) when is_binary(string) do
+      color(string, :string, opts)
+    end
+
+    defp fun(other, _opts) do
+      raise inspect(other)
+    end
+  end
 end

test/floki/html_tree_test.exs

@@ -256,4 +256,18 @@ defmodule Floki.HTMLTreeTest do
     refute Enum.member?(html_tree, %{html_node3 | type: "marquee"})
     refute Enum.member?(html_tree, 42)
   end
+
+  test "Inspect works with HTMLTree" do
+    html_tree = %HTMLTree{
+      root_nodes_ids: [2, 1],
+      node_ids: [2, 1],
+      nodes: %{
+        1 => %Text{content: "hello", node_id: 1},
+        2 => %Text{content: " world", node_id: 2}
+      }
+    }
+
+    assert inspect(html_tree) ==
+             ~s|%HTMLTree{%Text{content: "hello", node_id: 1}<em>%Text{content: " world", node_id: 2}}|
+  end
 end