asciidoctor-rfc 0.8.0 → 0.8.2

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

@@ -88,7 +88,7 @@ module Asciidoctor
         else
           d = Date.iso8601 revdate
           date_attributes = {
-            day: d.day,
+            day: d.day.to_s.gsub(/^0/, ""),
             month: Date::MONTHNAMES[d.month],
             year: d.year,
           }
@@ -104,13 +104,13 @@ module Asciidoctor
         revdate = node.attr("revdate") || node.attr("date")
         if revdate.nil?
           revdate = DateTime.now.iso8601
-          warn %(asciidoctor: WARNING: revdate attribute missing from header, provided current date)
+          warn %(asciidoctor: WARNING (#{current_location(node)}): revdate attribute missing from header, provided current date)
         end
         unless revdate.nil?
           begin
             date1(revdate, xml)
           rescue ArgumentError # invalid date
-            warn %(asciidoctor: WARNING: invalid date in header, provided current date)
+            warn %(asciidoctor: WARNING (#{current_location(node)}): invalid date in header, provided current date)
             date1(DateTime.now.iso8601, xml)
           end
         end

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

@@ -1,3 +1,5 @@
+require "pp"
+# coding: utf-8
 module Asciidoctor
   module RFC::V2
     module Base
@@ -33,7 +35,6 @@ module Asciidoctor
       #   == Appendix
       def document(node)
         $seen_back_matter = false
-        $seen_abstract = false
         $smart_quotes = (node.attr("smart-quotes") != "false")
         $inline_definition_lists = (node.attr("inline-definition-lists") == "true")
 
@@ -86,10 +87,25 @@ module Asciidoctor
                  end
 
         ret = result * "\n"
-        ret = set_pis(node, Nokogiri::XML(ret)).to_xml
         ret = cleanup(ret)
-        Validate::validate(ret)
-        ret
+        ret1 = Nokogiri::XML(ret)
+        # Validate::validate(ret1)
+        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 resolve_references(node, doc)
+        extract_entities(node, doc).each do |entity|
+          Nokogiri::XML::EntityDecl::new(entity[:entity], doc,
+                                         Nokogiri::XML::EntityDecl::EXTERNAL_GENERAL_PARSED,
+                                         nil, entity[:url], nil)
+          entity[:node].replace(Nokogiri::XML::EntityReference.new(doc, entity[:entity]))
+        end
+        doc
       end
 
       def inline_break(node)
@@ -120,6 +136,8 @@ module Asciidoctor
             # [bcp14]#MUST NOT#
             if node.role == "bcp14"
               xml.spanx node.text.upcase, style: "strong"
+            elsif node.role == "comment"
+              xml.comment " " + node.text + " "
             else
               xml << node.text
             end
@@ -131,33 +149,26 @@ module Asciidoctor
       #   [[id]]
       #   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 = {
           anchor: node.id,
         }
 
-        result << noko do |xml|
+        noko do |xml|
           xml.t **attr_code(t_attributes) do |xml_t|
             xml_t << node.content
           end
-        end
-        result
+        end.join("\n")
       end
 
       def verse(node)
         result = []
 
-        if (node.parent.context == :preamble) && !$seen_abstract
-          $seen_abstract = true
-          result << "<abstract>"
-        end
-
         t_attributes = {
           anchor: node.id,
         }
@@ -194,26 +205,28 @@ module Asciidoctor
           references_attributes = {
             title: node.title,
           }
-
+          if node.blocks.empty?
+            result << noko { |xml| xml.references **references_attributes }
+          end
           node.blocks.each do |block|
             if block.context == :section
               result << node.content
             elsif block.context == :pass
-              # we are assuming a single contiguous :pass block of XML
+              # NOTE: references are assumed to be found in a single passthrough
+              #   block containing <reference> tags.
+
               result << noko do |xml|
-                xml.references **attr_code(references_attributes) do |xml_references|
-                  xml_references << reflist(block).join
+                xml.references **references_attributes do |xml_references|
+                  # 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
             end
           end
-=begin
-          result << noko do |xml|
-            xml.references **attr_code(references_attributes) do |xml_references|
-              node.blocks.each { |b| xml_references << reflist(b).join }
-            end
-          end
-=end
 
           result = result.unshift("</middle><back>") unless $seen_back_matter
           $processing_reflist = false
@@ -226,7 +239,7 @@ module Asciidoctor
 
           section_attributes = {
             anchor: node.id,
-            title: node.title,
+            title: node.title.gsub(/<[^>]+>/, ""),
           }
 
           result << noko do |xml|
@@ -259,7 +272,10 @@ module Asciidoctor
 
         noko do |xml|
           if node.parent.context != :example
-            xml.figure do |xml_figure|
+            figure_attributes = {
+              anchor: node.id,
+            }
+            xml.figure **attr_code(figure_attributes) do |xml_figure|
               xml_figure.artwork **attr_code(artwork_attributes)
             end
           else
@@ -289,25 +305,20 @@ module Asciidoctor
             end
           end
         end
-
-        xmldoc.root = merge_vspace(xmldoc.root)
-
-        # smart quotes: handle smart apostrophe
-        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
+        # any instances of spanx must be stripped of any internal tags
+        spanxs = xmldoc.xpath("//spanx[descendant::*]")
+        while !spanxs.empty?
+          spanx = spanxs[0]
+          spanx_text = ""
+          spanx.traverse do |node|
+            spanx_text = spanx_text + node.text.gsub(/<[^>]+>/, "") if node.text?
           end
+          spanx.children = spanx_text
+          spanxs = xmldoc.xpath("//spanx[descendant::*]")
         end
+
+        xmldoc.root = merge_vspace(xmldoc.root)
+        xmldoc = smart_quote_cleanup(xmldoc) unless $smart_quotes
         xmldoc.to_xml(encoding: "US-ASCII")
       end
 
@@ -319,21 +330,18 @@ module Asciidoctor
         end
 
         counter = 0
-        while counter < nodes.size do
+        while counter < nodes.size
           if nodes[counter].name == "vspace"
             blankLines = 0
-            while counter < nodes.size && nodes[counter].name == "vspace" do
-                if nodes[counter][:blankLines].nil?
-                  blankLines += 1
-                else
-                  blankLines +=  nodes[counter][:blankLines].to_i + 1
-                end
-                if counter+1 < nodes.size && nodes[counter+1].text?
-                  if nodes[counter+1].text =~ /\A[\n ]+\Z/m
-                    counter += 1
-                  end
-                end
+            while counter < nodes.size && nodes[counter].name == "vspace"
+              blankLines += 1
+              if nodes[counter][:blankLines].nil?
+                blankLines += nodes[counter][:blankLines].to_i
+              end
+              if counter + 1 < nodes.size && nodes[counter + 1].text? && nodes[counter + 1].text =~ /\A[\n ]+\Z/m
                 counter += 1
+              end
+              counter += 1
             end
             counter -= 1 if counter == nodes.size
             newnodes << noko do |xml|
@@ -341,33 +349,14 @@ module Asciidoctor
             end.join
           else
             newnodes << merge_vspace(nodes[counter])
-            nodes[counter].remove
             counter += 1
           end
-
-          node.children.remove
-          newnodes.each do |item|
-            node.add_child(item)
-          end
         end
-        node
-      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)
+        node.children.remove
+        newnodes.each do |item|
+          node.add_child(item)
         end
-
-        doc
+        node
       end
 
       # replace any <t>text</t> instances with <vspace blankLines="1"/>text

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

@@ -34,7 +34,10 @@ module Asciidoctor
 
         ret = noko do |xml|
           if node.parent.context != :example
-            xml.figure do |xml_figure|
+            figure_attributes = {
+              anchor: node.id,
+            }
+            xml.figure **attr_code(figure_attributes) do |xml_figure|
               xml_figure.artwork artwork_content, **attr_code(artwork_attributes)
             end
           else
@@ -58,7 +61,10 @@ module Asciidoctor
 
         ret = noko do |xml|
           if node.parent.context != :example
-            xml.figure do |xml_figure|
+            figure_attributes = {
+              anchor: node.id,
+            }
+            xml.figure **attr_code(figure_attributes) do |xml_figure|
               xml_figure.artwork artwork_content, **attr_code(artwork_attributes)
             end
           else
@@ -68,7 +74,6 @@ module Asciidoctor
         ret
       end
 
-
       # Syntax:
       #   = Title
       #   Author
@@ -95,11 +100,6 @@ module Asciidoctor
       def admonition(node)
         result = []
         if node.parent.context == :preamble
-          if $seen_abstract
-            result << "</abstract>"
-            $seen_abstract = false
-          end
-
           note_attributes = {
             # default title provided: title is mandatory
             title: (node.title.nil? ? "NOTE" : node.title),
@@ -122,7 +122,7 @@ module Asciidoctor
           cref_contents = flatten_rawtext(node)
           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 (#{node.lineno}): comment can not contain blocks of text in XML RFC:\n #{node.content}
           WARNING_MESSAGE
 
           result << noko do |xml|
@@ -206,7 +206,10 @@ module Asciidoctor
 
         noko do |xml|
           if node.parent.context != :example
-            xml.figure do |xml_figure|
+            figure_attributes = {
+              anchor: node.id,
+            }
+            xml.figure **attr_code(figure_attributes) do |xml_figure|
               xml_figure.artwork sourcecode_content, **attr_code(sourcecode_attributes)
             end
           else
@@ -214,6 +217,26 @@ module Asciidoctor
           end
         end
       end
+
+      def quote(node)
+        result = []
+        if node.blocks?
+          node.blocks.each do |b|
+            result << send(b.context, b)
+          end
+        else
+          result = paragraph(node)
+        end
+        if node.attr("citetitle") || node.attr("attribution")
+          cite = node.attr("attribution") || ""
+          cite += ", " if node.attr("citetitle") && node.attr("attribution")
+          cite += (node.attr("citetitle") || "")
+          cite = "-- " + cite
+          result << "<t>#{cite}</t>"
+        end
+        result
+      end
+
     end
   end
 end

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

@@ -35,7 +35,6 @@ module Asciidoctor
       register_for "rfc2"
 
       $seen_back_matter = false
-      $seen_abstract = false
       $xreftext = {}
 
       def initialize(backend, opts)
@@ -56,8 +55,6 @@ module Asciidoctor
       alias_method :inline_kbd, :skip
       alias_method :inline_menu, :skip
       alias_method :inline_image, :skip
-
-      alias_method :quote, :paragraph
     end
   end
 end

data/lib/asciidoctor/rfc/v2/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
 
@@ -24,43 +24,58 @@ module Asciidoctor
           # render equivalent in v2
           matched = /(?<section>\S+)\s+(?<format>[a-z]+)(: )?(?<text>.*)$/.match node.text
 
-          target = node.target.gsub(/\..*$/, "").gsub(/^#/, "")
-          reftarget = target
-          reftarget = "#{target}##{node.attributes['fragment']}" unless node.attributes["path"].nil?
+          # fragment inserts file suffix, e.g. rfc2911#fragment becomes rfc2911.xml#fragment
+          target = node.target.gsub(/^#/, "").gsub(/(.)(\.xml)?#.*$/, "\\1")
+          # reftarget = target
+          warn %(asciidoctor: WARNING (#{current_location(node)}): fragments not supported on crossreferences in v2: #{node.target} #{node.text}) if node.target =~ /.#/
+          # reftarget = "#{target}##{node.attributes['fragment']}" unless node.attributes["path"].nil?
 
-          xref_contents = case matched[:format]
-                          when "of"
-                            "Section #{matched[:section]} of [#{target}]"
-                          when "comma"
-                            "[#{target}], Section #{matched[:section]}"
-                          when "parens"
-                            "[#{target}] (Section #{matched[:section]})"
-                          when "bare"
-                            matched[:section]
-                          end
+          xref_contents = ""
+          case matched[:format]
+          when "of"
+            prefix = "Section #{matched[:section]} of "
+          when "comma"
+            suffix = ", Section #{matched[:section]}"
+          when "parens"
+            suffix = " (Section #{matched[:section]})"
+          when "bare"
+            xref_contents = matched[:section]
+          end
           unless matched[:text].empty?
-            xref_contents = "#{xref_contents}: #{matched[:text]}"
+            xref_contents = if xref_contents.empty?
+                              matched[:text].to_s
+                            else
+                              "#{xref_contents}: #{matched[:text]}"
+                            end
           end
 
           xref_attributes = {
-            target: reftarget,
+            target: target,
           }.reject { |_, value| value.nil? }
 
         else
 
-          matched = /^format=(?<format>counter|title|none|default):\s*(?<text>.*)$/.match node.text
-          xref_contents = matched.nil? ? node.text : matched[:text]
+          matched = /^format=(?<format>counter|title|none|default)(?<text>:\s*.*)?$/.match node.text
+          xref_contents = if matched.nil?
+                            node.text
+                          else
+                            matched[:text].nil? ? "" : matched[:text].gsub(/^:\s*/, "")
+                          end
           matched ||= {}
 
+          warn %(asciidoctor: WARNING (#{current_location(node)}): fragments not supported on crossreferences in v2: #{node.target} #{node.text}) if node.target =~ /.#/
           xref_attributes = {
-            target: node.target.gsub(/^#/, ""),
+            # fragment inserts file suffix, e.g. rfc2911#fragment becomes rfc2911.xml#fragment
+            target: node.target.gsub(/^#/, "").gsub(/(.)(\.xml)?#.*$/, "\\1"),
             format: matched[:format],
             align: node.attr("align"),
           }
         end
 
         noko do |xml|
+          xml << prefix unless prefix.nil? || prefix.empty?
           xml.xref xref_contents, **attr_code(xref_attributes)
+          xml << suffix unless suffix.nil? || suffix.empty?
         end.join
       end
 
@@ -89,7 +104,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