asciidoctor-rfc 0.8.0 → 0.8.2

data/lib/asciidoctor/rfc/v3/base.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 module Asciidoctor
   module RFC::V3
     module Base
@@ -29,7 +31,6 @@ module Asciidoctor
       #   == Appendix
       def document(node)
         $seen_back_matter = false
-        $seen_abstract = false
         # If this is present, then BCP14 keywords in boldface are not assumed to be <bcp14> tags. By default they are.
         $bcp_bold = !(node.attr? "no-rfc-bold-bcp14")
         $smart_quotes = (node.attr("smart-quotes") != "false")
@@ -57,6 +58,7 @@ module Asciidoctor
           'xml:lang':     node.attr("xml-lang"),
           prepTime:       preptime,
           version:        "3",
+          'xmlns:xi':        "http://www.w3.org/2001/XInclude",
         }
 
         rfc_open = noko { |xml| xml.rfc **attr_code(rfc_attributes) }.join.gsub(/\/>$/, ">")
@@ -80,26 +82,21 @@ module Asciidoctor
                    result.map { |e| e =~ /<\/front><middle1>/ ? "</front><middle>" : e }
                  end
         ret = result * "\n"
-        ret = set_pis(node, Nokogiri::XML(ret)).to_xml
-        ret = cleanup ret
-        Validate::validate(ret)
-        ret
+        ret = cleanup(ret)
+        ret1 = Nokogiri::XML(ret)
+        ret1 = set_pis(node, ret1)
+        ret1 = insert_biblio(node, ret1) unless node.attr("biblio-dir").nil? || node.attr("biblio-dir").empty?
+        Validate::validate(ret1)
+        ret1 = resolve_references(node, ret1)
+        # Validate::validate(ret1)
+        ret1.to_xml
       end
 
-      def set_pis(node, doc)
-        # Below are generally applicable Processing Instructions (PIs)
-        # that most I-Ds might want to use. (Here they are set differently than
-        # their defaults in xml2rfc v1.32)
-        rfc_pis = common_rfc_pis(node)
-
-        doc.create_internal_subset("rfc", nil, "rfc2629.dtd")
-        rfc_pis.each_pair do |k, v|
-          pi = Nokogiri::XML::ProcessingInstruction.new(doc,
-                                                        "rfc",
-                                                        "#{k}=\"#{v}\"")
-          doc.root.add_previous_sibling(pi)
+      def resolve_references(node, doc)
+        extract_entities(node, doc).each do |entity|
+          # TODO actual XML
+          entity[:node].replace("<xi:include href='#{entity[:url]}' parse='text'/>")
         end
-
         doc
       end
 
@@ -110,7 +107,7 @@ module Asciidoctor
       def link(node)
         result = []
         result << noko do |xml|
-          links = (node.attr("link") || "").split(/,/)
+          links = (node.attr("link") || "").split(/,\s*/)
           links.each do |link|
             matched = /^(?<href>\S+)\s+(?<rel>\S+)$/.match link
             link_attributes = {
@@ -132,15 +129,16 @@ module Asciidoctor
       end
 
       BCP_KEYWORDS = [
-        'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT',
-        'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', 'OPTIONAL'
-      ]
+        "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+        "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "OPTIONAL"
+      ].freeze
+
       def inline_quoted(node)
         noko do |xml|
           case node.type
           when :emphasis then xml.em node.text
           when :strong
-            if $bcp_bold && BCP_KEYWORDS.exist?(node.text)
+            if $bcp_bold && BCP_KEYWORDS.include?(node.text)
               xml.bcp14 node.text
             else
               xml.strong node.text
@@ -156,6 +154,8 @@ module Asciidoctor
             # [bcp14]#MUST NOT#
             if node.role == "bcp14"
               xml.bcp14 node.text.upcase
+            elsif node.role == "comment"
+              xml.comment " " + node.text + " "
             else
               xml << node.text
             end
@@ -168,11 +168,10 @@ module Asciidoctor
       #   [keepWithNext=true,keepWithPrevious=true] (optional)
       #   Text
       def paragraph(node)
-        result = []
-
-        if (node.parent.context == :preamble) && !$seen_abstract
-          $seen_abstract = true
-          result << "<abstract>"
+        if node.role == "comment"
+          return noko do |xml|
+            xml.comment " " + [flatten_rawtext(node)].flatten.join("\n") + " "
+          end.join("\n")
         end
 
         t_attributes = {
@@ -180,13 +179,56 @@ module Asciidoctor
           keepWithNext: node.attr("keep-with-next"),
           keepWithPrevious: node.attr("keep-with-previous"),
         }
-
-        result << noko do |xml|
+        return noko do |xml|
           xml.t **attr_code(t_attributes) do |xml_t|
             xml_t << node.content
           end
+        end.join("\n")
+      end
+
+      def ref_section(node)
+        result = []
+        $processing_reflist = true
+        references_attributes = {
+          anchor: node.id,
+        }
+
+        if node.blocks.empty?
+          result << noko do |xml|
+            xml.references **references_attributes do |xml_references|
+              xml_references.name node.title unless node.title.nil?
+            end
+          end
+        end
+        node.blocks.each do |block|
+          if block.context == :section
+            result << section(block)
+          elsif block.context == :pass
+            # we are assuming a single contiguous :pass block of XML
+            result << noko do |xml|
+              xml.references **references_attributes do |xml_references|
+                xml_references.name node.title unless node.title.nil?
+                # xml_references << reflist(block).join("\n")
+                # NOTE: we're allowing the user to do more or less whathever
+                #   in the passthrough since the xpath below just fishes out ALL
+                #   <reference>s in an unrooted fragment, regardless of structure.
+                Nokogiri::XML::DocumentFragment.
+                  parse(block.content).xpath(".//reference").
+                  each { |reference| xml_references << reference.to_xml }
+              end
+            end
+          elsif block.context == :ulist
+            block.items.each(&:text)
+            # we only process the item for its displayreferences
+          end
         end
 
+        unless $xreftext.empty? || $seen_back_matter
+          result = result.unshift($xreftext.keys.map { |k| %(<displayreference target="#{k}" to="#{$xreftext[k]}"/>) })
+        end
+        result = result.unshift("</middle><back>") unless $seen_back_matter
+        $processing_reflist = false
+        $seen_back_matter = true
         result
       end
 
@@ -204,65 +246,11 @@ module Asciidoctor
       #   * [[[ref1]]] Ref [must provide references as list]
       #   * [[[ref2]]] Ref
       def section(node)
-        result = []
         if node.attr("style") == "bibliography" ||
             node.parent.context == :section && node.parent.attr("style") == "bibliography"
-          $processing_reflist = true
-
-          references_attributes = {
-            anchor: node.id,
-          }
-=begin
-          result << noko do |xml|
-            xml.references **attr_code(references_attributes) do |references_xml|
-              references_xml.name node.title unless node.title.nil?
-              node.blocks.each { |b| references_xml << reflist(b).join }
-            end
-          end
-
-          anchor_attribute = node.id.nil? ? nil : " anchor=\"#{node.id}\""
-          result << "<references#{anchor_attribute}>"
-          result << "<name>#{node.title}</name>" unless node.title.nil?
-          # require that references be a :pass xml block
-          # potentially with an initial block of display reference equivalences
-          node.blocks.each do |b|
-            if b.context == :pass
-              result << reflist(b)
-            elsif b.context == :section
-              result << node.content
-            elsif b.context == :ulist
-              b.items.each do |i|
-                i.text # we only process the item for its displayreferences
-              end
-            end
-          end
-          result << "</references>"
-=end
-          node.blocks.each do |block|
-            if block.context == :section
-              result << section(block)
-            elsif block.context == :pass
-              # we are assuming a single contiguous :pass block of XML
-              result << noko do |xml|
-                xml.references **attr_code(references_attributes) do |xml_references|
-                  xml_references.name node.title unless node.title.nil?
-                  xml_references << reflist(block).join
-                end
-              end
-            elsif block.context == :ulist
-              block.items.each do |i|
-                i.text # we only process the item for its displayreferences
-              end
-            end
-          end
-
-          unless $xreftext.empty? || $seen_back_matter
-            result = result.unshift($xreftext.keys.map { |k| %(<displayreference target="#{k}" to="#{$xreftext[k]}"/>) })
-          end
-          result = result.unshift("</middle><back>") unless $seen_back_matter
-          $processing_reflist = false
-          $seen_back_matter = true
+          result = ref_section(node)
         else
+          result = []
           if node.attr("style") == "appendix"
             result << "</middle><back>" unless $seen_back_matter
             $seen_back_matter = true
@@ -333,22 +321,7 @@ module Asciidoctor
             end
           end
         end
-        unless $smart_quotes
-          xmldoc.traverse do |node|
-            if node.text?
-              node.content = node.content.tr("\u2019", "'")
-              node.content = node.content.gsub(/\&#8217;/, "'")
-              node.content = node.content.gsub(/\&#x2019;/, "'")
-            elsif node.element?
-              node.attributes.each do |k, v|
-                node.set_attribute(k, v.content.tr("\u2019", "'"))
-                node.set_attribute(k, v.content.gsub(/\&#8217;/, "'"))
-                node.set_attribute(k, v.content.gsub(/\&#x2019;/, "'"))
-              end
-            end
-          end
-        end
-
+        xmldoc = smart_quote_cleanup(xmldoc) unless $smart_quotes
         xmldoc.to_xml(encoding: "US-ASCII")
       end
     end

data/lib/asciidoctor/rfc/v3/blocks.rb

@@ -1,4 +1,5 @@
 require "htmlentities"
+require "uri"
 
 module Asciidoctor
   module RFC::V3
@@ -66,7 +67,6 @@ module Asciidoctor
         end
       end
 
-
       # Syntax:
       #   [[id]]
       #   [quote, attribution, citation info] # citation info limited to URL
@@ -119,11 +119,6 @@ module Asciidoctor
       def admonition(node)
         result = []
         if node.parent.context == :preamble
-          if $seen_abstract
-            result << "</abstract>"
-            $seen_abstract = false
-          end
-
           note_attributes = {
             removeInRFC: node.attr("remove-in-rfc"),
           }
@@ -144,7 +139,7 @@ module Asciidoctor
           cref_contents = node.blocks? ? flatten(node) : node.content
           cref_contents = [cref_contents].flatten.join("\n")
           warn <<~WARNING_MESSAGE if node.blocks?
-            asciidoctor: WARNING: comment can not contain blocks of text in XML RFC:\n #{node.content}
+            asciidoctor: WARNING (#{current_location(node)}): comment can not contain blocks of text in XML RFC:\n #{node.content}
           WARNING_MESSAGE
 
           result << noko do |xml|
@@ -162,8 +157,11 @@ module Asciidoctor
       #   Sidebar
       #   ****
       def sidebar(node)
+        aside_attributes = {
+          anchor: node.id,
+        }
         noko do |xml|
-          xml.aside anchor: node.id do |xml_aside|
+          xml.aside **attr_code(aside_attributes) do |xml_aside|
             xml_aside << node.content
           end
         end
@@ -177,7 +175,7 @@ module Asciidoctor
       def example(node)
         node.blocks.each do |b|
           unless %i{listing image literal stem}.include? b.context
-            warn "asciidoctor: WARNING: examples (figures) should only contain listings (sourcecode), images (artwork), or literal (artwork):\n#{b.lines}"
+            warn "asciidoctor: WARNING (#{current_location(b)}): examples (figures) should only contain listings (sourcecode), images (artwork), or literal (artwork):\n#{b.lines}"
           end
         end
 

data/lib/asciidoctor/rfc/v3/converter.rb

@@ -35,7 +35,6 @@ module Asciidoctor
       register_for "rfc3"
 
       $seen_back_matter = false
-      $seen_abstract = false
       $xreftext = {}
 
       def initialize(backend, opts)

data/lib/asciidoctor/rfc/v3/front.rb

@@ -22,8 +22,13 @@ module Asciidoctor
         return if docname.nil? || docname&.empty?
         is_rfc = docname =~ /^rfc-?/i || node.attr("doctype") == "rfc"
 
-        name = is_rfc ? docname.gsub(/^rfc-?/i, "") : docname
-        nameattr = is_rfc ? "RFC" : "Internet-Draft"
+        if is_rfc
+          name = docname.gsub(/^rfc-?/i, "") 
+          nameattr = "RFC" 
+        else
+          name = docname
+          nameattr = "Internet-Draft"
+        end
         value = name.gsub(/\.[^\/]+$/, "")
 
         seriesInfo_attributes = {
@@ -37,7 +42,7 @@ module Asciidoctor
         intendedstatus = node.attr("intended-series")
         if !is_rfc && !intendedstatus.nil?
           unless intendedstatus =~ /^(standard|full-standard|bcp|fyi|informational|experimental|historic)$/
-            warn %(asciidoctor: WARNING: disallowed value for intended-series: #{intendedstatus})
+            warn %(asciidoctor: WARNING (#{current_location(node)}): disallowed value for intended-series in document header: #{intendedstatus})
           end
           seriesInfo_attributes = {
             name: "",
@@ -53,14 +58,16 @@ module Asciidoctor
           if m.nil?
             rfcstatus = "exp" if rfcstatus == "experimental"
             rfcstatus = "info" if rfcstatus == "informational"
-            warn %(asciidoctor: WARNING: disallowed value for intended-series with no series number: #{rfcstatus}) unless rfcstatus =~ /^(info|exp|historic)$/
+            warn %(asciidoctor: WARNING (#{current_location(node)}): disallowed value for intended-series in document header with no series number: #{rfcstatus}) unless rfcstatus =~ /^(info|exp|historic)$/
           else
-            warn %(asciidoctor: WARNING: disallowed value for intended-series with series number: #{m[1]}) unless m[1] =~ /^(standard|full-standard|bcp)$/
+            rfcstatus = m[1]
+            value = m[2]
+            warn %(asciidoctor: WARNING (#{current_location(node)}): disallowed value for intended-series in document header with series number: #{rfcstatus}) unless rfcstatus =~ /^(standard|full-standard|bcp)$/
           end
           seriesInfo_attributes = {
             name: "",
-            status: m.nil? ? rfcstatus : m[1],
-            value: m.nil? ? value : m[2],
+            status: rfcstatus,
+            value: value,
           }
           xml.seriesInfo **attr_code(seriesInfo_attributes)
         end

data/lib/asciidoctor/rfc/v3/inline_anchor.rb

@@ -12,7 +12,7 @@ module Asciidoctor
         when :ref
           inline_anchor_ref node
         else
-          warn %(asciidoctor: WARNING: unknown anchor type: #{node.type.inspect})
+          warn %(asciidoctor: WARNING (#{current_location(node)}): unknown anchor type: #{node.type.inspect})
         end
       end
 
@@ -30,7 +30,8 @@ module Asciidoctor
             relative: node.attributes["path"].nil? ? nil : node.attributes["fragment"],
             section: matched[:section],
             displayFormat: matched[:format],
-            target: node.target.gsub(/\..*$/, "").gsub(/^#/, ""),
+            # fragment inserts file suffix, e.g. rfc2911#fragment becomes rfc2911.xml#fragment
+            target: node.target.gsub(/^#/, "").gsub(/(.)(\.xml)?#.*$/, "\\1"),
           }
 
           noko do |xml|
@@ -38,14 +39,17 @@ module Asciidoctor
           end.join
         else
           xref_contents = node.text
+          matched = /^format=(?<format>counter|title|none|default)(?<text>:\s*.*)?$/.match xref_contents
+          xref_contents = if matched.nil?
+                            xref_contents
+                          else
+                            matched[:text].nil? ? "" : matched[:text].gsub(/^:\s*/, "")
+                          end
 
-          matched = /^format=(?<format>counter|title|none|default):\s*(?<text>.*)$/.match xref_contents
-
-          xref_contents = matched[:text] if matched
-
+          warn %(asciidoctor: WARNING (#{current_location(node)}): fragments not supported on crossreferences in v3 without relref: #{node.target} #{node.text}) if node.target =~ /.#/
           xref_attributes = {
             format: matched&.[](:format),
-            target: node.target.gsub(/^#/, ""),
+            target: node.target.gsub(/^#/, "").gsub(/(.)(\.xml)?#.*$/, "\\1"),
           }
 
           noko do |xml|
@@ -56,7 +60,6 @@ module Asciidoctor
 
       def inline_anchor_link(node)
         eref_contents = node.target == node.text ? nil : node.text
-
         eref_attributes = {
           target: node.target,
         }
@@ -79,7 +82,7 @@ module Asciidoctor
       end
 
       def inline_anchor_ref(node)
-          warn %(asciidoctor: WARNING: anchor "#{node.id}" is not in a place where XML RFC will recognise it as an anchor attribute)
+        warn %(asciidoctor: WARNING (#{current_location(node)}): anchor "#{node.id}" is not in a place where XML RFC will recognise it as an anchor attribute)
       end
     end
   end

data/lib/asciidoctor/rfc/v3/lists.rb

@@ -8,37 +8,37 @@ module Asciidoctor
       #     * [[[ref4]]] C
       #     * [[[ref4]]] D
       # @note ulist repurposed as reference list
-#      def reflist(node)
-#        result = []
-#        if node.context == :ulist
-#          node.items.each do |item|
-#            # we expect the biblio anchor to be right at the start of the reference
-#            if item.blocks?
-#              # we expect any list to be embedded, and only one level of embedding
-#              # we expect no content in the referencegroup line other than the bibliographic anchor
-#              result << "<referencegroup>#{item.text}".gsub(/<referencegroup>\s*\[?<bibanchor="([^"]+)">\]?.*$/, "<referencegroup anchor=\"\\1\">")
-#              item.blocks.each { |b| result << reflist(b) }
-#              result << "</referencegroup>"
-#            else
-#              # quoteTitle = get_header_attribute item, "quoteTitle"
-#              # target = get_header_attribute item, "target"
-#              # annotation = get_header_attribute item, "annotation"
-#              # FIXME: [[[x]]] within embedded list is processed as [<bibref>]
-#              result << "<reference>#{item.text}</refcontent></reference>".gsub(/<reference>\s*\[?<bibanchor="([^"]+)">\]?\s*/, "<reference anchor=\"\\1\"><refcontent>")
-#            end
-#          end
-#        elsif node.context == :pass
-#          # we expect raw xml
-#          node.lines.each do |item|
-#            # undo XML substitution
-#            ref = item.gsub(/\&lt;/, "<").gsub(/\&gt;/, ">")
-#            result << ref
-#          end
-#        else
-#          warn %(asciidoctor: WARNING: references are not a ulist or raw XML: #{node.context})
-#        end
-#        result
-#      end
+      #      def reflist(node)
+      #        result = []
+      #        if node.context == :ulist
+      #          node.items.each do |item|
+      #            # we expect the biblio anchor to be right at the start of the reference
+      #            if item.blocks?
+      #              # we expect any list to be embedded, and only one level of embedding
+      #              # we expect no content in the referencegroup line other than the bibliographic anchor
+      #              result << "<referencegroup>#{item.text}".gsub(/<referencegroup>\s*\[?<bibanchor="([^"]+)">\]?.*$/, "<referencegroup anchor=\"\\1\">")
+      #              item.blocks.each { |b| result << reflist(b) }
+      #              result << "</referencegroup>"
+      #            else
+      #              # quoteTitle = get_header_attribute item, "quoteTitle"
+      #              # target = get_header_attribute item, "target"
+      #              # annotation = get_header_attribute item, "annotation"
+      #              # FIXME: [[[x]]] within embedded list is processed as [<bibref>]
+      #              result << "<reference>#{item.text}</refcontent></reference>".gsub(/<reference>\s*\[?<bibanchor="([^"]+)">\]?\s*/, "<reference anchor=\"\\1\"><refcontent>")
+      #            end
+      #          end
+      #        elsif node.context == :pass
+      #          # we expect raw xml
+      #          node.lines.each do |item|
+      #            # undo XML substitution
+      #            ref = item.gsub(/\&lt;/, "<").gsub(/\&gt;/, ">")
+      #            result << ref
+      #          end
+      #        else
+      #          warn %(asciidoctor: WARNING: references are not a ulist or raw XML: #{node.context})
+      #        end
+      #        result
+      #      end
 
       # Syntax:
       #   [[id]]
@@ -48,11 +48,6 @@ module Asciidoctor
       def ulist(node)
         result = []
 
-        if node.parent.context == :preamble && !$seen_abstract
-          $seen_abstract = true
-          result << "<abstract>"
-        end
-
         result << noko do |xml|
           ul_attributes = {
             anchor: node.id,
@@ -100,10 +95,6 @@ module Asciidoctor
       #   . B
       def olist(node)
         result = []
-        if node.parent.context == :preamble && !$seen_abstract
-          $seen_abstract = true
-          result << "<abstract>"
-        end
 
         result << noko do |xml|
           type = OLIST_TYPES[node.style.to_sym]
@@ -145,11 +136,6 @@ module Asciidoctor
       def dlist(node)
         result = []
 
-        if node.parent.context == :preamble && !$seen_abstract
-          $seen_abstract = true
-          result << "<abstract>"
-        end
-
         result << noko do |xml|
           dl_attributes = {
             anchor: node.id,