Merge pull request #44 from gfx/inspect

support p and pp for CommonMarker::Node
gjtorikian · Apr 22, 2017 · f44edb4 · f44edb4
2 parents 8de8518 + b29e92e
commit f44edb4
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 0 deletions.
diff --git a/lib/commonmarker/node.rb b/lib/commonmarker/node.rb
@@ -1,6 +1,9 @@
+require 'commonmarker/node/inspect'
+
 module CommonMarker
   class Node
     include Enumerable
+    include Inspect
 
     # Public: An iterator that "walks the tree," descending into children recursively.
     #

diff --git a/lib/commonmarker/node/inspect.rb b/lib/commonmarker/node/inspect.rb
@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'pp'
+
+module CommonMarker
+  class Node
+    module Inspect
+      PP_INDENT_SIZE = 2
+
+      def inspect
+        PP.pp(self, String.new, Float::INFINITY)
+      end
+
+      # @param [PrettyPrint] pp
+      def pretty_print(pp)
+        pp.group(PP_INDENT_SIZE, "#<#{self.class}(#{type}):", '>') do
+          pp.breakable
+
+          attrs = %i[
+            sourcepos
+            string_content
+            url
+            title
+            header_level
+            list_type
+            list_start
+            list_tight
+            fence_info
+          ].map do |name|
+            begin
+              [name, __send__(name)]
+            rescue NodeError
+              nil
+            end
+          end.compact
+
+          pp.seplist(attrs) do |name, value|
+            pp.text "#{name}="
+            pp.pp value
+          end
+
+          if first_child
+            pp.breakable
+            pp.group(PP_INDENT_SIZE) do
+              children = []
+              node = first_child
+              while node
+                children << node
+                node = node.next
+              end
+              pp.text 'children='
+              pp.pp children
+            end
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/test/test_node.rb b/test/test_node.rb
@@ -78,4 +78,12 @@ def test_walk_and_delete_node
     end
     assert_equal "<p>Hi there, I am mostly text!</p>\n", @doc.to_html
   end
+
+  def test_inspect
+    assert_match /#<CommonMarker::Node\(document\):/, @doc.inspect
+  end
+
+  def test_pretty_print
+    assert_match /#<CommonMarker::Node\(document\):/, PP.pp(@doc, '')
+  end
 end