Merge pull request #94 from Timmmm/user/timh/fix_tables_and_lists

Fix tagging of tables and lists

Author: james-ball-qualcomm

converters/tags.rb

@@ -31,7 +31,8 @@ def initialize(backend, opts = {})
     @prefix = opts[:document].attributes.fetch("tags-match-prefix", "")
   end
 
-  # `node` is an `AbstractNode`.
+  # node: AbstractNode
+  # returns: String
   def convert(node, transform = node.node_name, opts = nil)
     if transform == "document" then
       # This is the top level node. First clear the outputs.
@@ -75,14 +76,16 @@ def convert(node, transform = node.node_name, opts = nil)
       end
 
       # Recursively get the text content of this node.
-      content = if node.inline? then node.text else node.content end
+      content = node_text_content(node)
 
       # Capture the content in the tag map and section tree if
       # this node is tagged appropriately.
       unless node.id.nil?
         if node.id.start_with?(@prefix)
           raise "Duplicate tag name '#{node.id}'" unless @tag_map[node.id].nil?
-          @tag_map[node.id] = content
+          raise "Tag '#{node.id}' content should be a String but it is #{content.class}" unless content.is_a?(String)
+
+          @tag_map[node.id] = content.strip()
           @section_stack.last["tags"] << node.id
         end
       end
@@ -96,4 +99,65 @@ def convert(node, transform = node.node_name, opts = nil)
       content
     end
   end
+
+  private
+
+  # Return the text content of a node. Adapted from `text-converter.rb`
+  # in the docs: https://docs.asciidoctor.org/asciidoctor/latest/convert/custom/
+  #
+  # node: AbstractNode
+  # returns: String
+  def node_text_content(node)
+    content_or_nil = case node.node_name
+    when "document"
+      raise "node_text_content(document) should be unreachable"
+    when "section"
+      "\n" + [node.title, node.content].join("\n").rstrip()
+    when "paragraph"
+      "\n" + normalize_space(node.content)
+    when "ulist", "olist", "colist"
+      "\n" + node.items.map do |item|
+        normalize_space(item.text) + (item.blocks? ? "\n" + item.content : "")
+      end.join("\n")
+    when "dlist"
+      "\n" + node.items.map do |terms, dd|
+        terms.map(&:text).join(", ") +
+          (dd&.text? ? "\n" + normalize_space(dd.text) : "") +
+          (dd&.blocks? ? "\n" + dd.content : "")
+      end.join("\n")
+    when "table"
+      # This code was wrong in the docs. This is adapted from the HTML5 converter.
+      "\n" + node.rows.to_h.map do |tsec, rows|
+        rows.map do |row|
+          row.map do |cell|
+            if tsec == :head
+              cell.text
+            else
+              case cell.style
+              when :asciidoc
+                cell.content
+              when :literal
+                cell.text
+              else
+                # In this case it is an array of paragraphs.
+                cell.content.join("\n")
+              end
+            end
+            # Separate cells by |.
+          end.join("|")
+          # Separate rows by newlines.
+        end.join("\n")
+        # Separate table sections by ===.
+      end.join("\n===\n")
+    else
+      node.inline? ? node.text : ["\n", node.content].compact.join
+    end
+
+    content_or_nil.nil? ? "" : content_or_nil
+  end
+
+  # Convert spaces to newlines.
+  def normalize_space text
+    text.tr("\n", " ")
+  end
 end

tests/norm-rule/test.adoc

@@ -26,7 +26,16 @@ Next paragraph
 | [[norm:table-cell-no-tag-just-anchor]] cell contents | next cell
 |===
 
-== Chapter 2
+[[norm:normal-table]]
+[cols="1,1"]
+|===
+|Header 1|Header 2
+
+|Cell in column 1, row 1 |Cell in column 2, row 1
+|Cell in column 1, row 2 |Cell in column 2, row 2
+|===
+
+== Chapter 2 - Tagging list items
 
 [[norm:unordered-list-heading]]
 Unordered List:
@@ -35,6 +44,13 @@ Unordered List:
 * [[norm:unordered-item-2-no-tag]] Unordered Item 2
 * Unordered Item 3
 
+[[norm:unordered-list-entire]]
+Entire Unordered List:
+
+* Entire Unordered Item 1
+* Entire Unordered Item 2
+* Entire Unordered Item 3
+
 [[norm:ordered-list-heading]]
 Ordered List:
 
@@ -54,6 +70,8 @@ Description-3::
 [[norm:description-item-3]]
 Description Item 3
 
+== Chapter 3 - Tagging admonitions
+
 NOTE: [[norm-note-1]] Single paragraph note
 
 [NOTE]
@@ -66,3 +84,21 @@ Multi-paragraph note 2
 [[norm:note-3]]
 Multi-paragraph note 3
 ====
+
+== Chapter 4 - Tagging entire list
+
+[[norm:fruit-color]]
+Bananas::
+Generally yellow in color
+Apples::
+Generally red in color
+
+[#norm:Zca_misa_c]#MISA.C is set if the following extensions are selected:#
+
+[[norm:Zca_misa_c_list]]
+* Zca and not F
+* Zca, Zcf and F (but not D) is specified (RV32 only)
+* Zca, Zcf and Zcd if D is specified (RV32 only)
+** this configuration excludes Zcmp, Zcmt
+* Zca, Zcd if D is specified (RV64 only)
+** this configuration excludes Zcmp, Zcmt