asciidoctor-rfc 0.2.0 → 0.8.0

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

@@ -1,3 +1,5 @@
+require "htmlentities"
+
 module Asciidoctor
   module RFC::V2
     module Blocks
@@ -42,6 +44,31 @@ module Asciidoctor
         ret
       end
 
+      # stem is treated as literal, but with center alignment
+      def stem(node)
+        artwork_attributes = {
+          align: node.attr("align") || "center",
+          type: node.attr("type"),
+          name: node.title,
+          alt: node.attr("alt"),
+        }
+
+        # NOTE: html escaping is performed by Nokogiri
+        artwork_content = node.lines.join("\n")
+
+        ret = noko do |xml|
+          if node.parent.context != :example
+            xml.figure do |xml_figure|
+              xml_figure.artwork artwork_content, **attr_code(artwork_attributes)
+            end
+          else
+            xml.artwork artwork_content, **attr_code(artwork_attributes)
+          end
+        end
+        ret
+      end
+
+
       # Syntax:
       #   = Title
       #   Author
@@ -78,7 +105,7 @@ module Asciidoctor
             title: (node.title.nil? ? "NOTE" : node.title),
           }
 
-          note_contents = [paragraph1(node)].flatten.join("\n")
+          note_contents = HTMLEntities.new.decode([paragraph1(node)].flatten.join("\n"))
 
           result << noko do |xml|
             xml.note **attr_code(note_attributes) do |xml_note|
@@ -137,7 +164,7 @@ module Asciidoctor
           xml.figure **attr_code(figure_attributes) do |xml_figure|
             node.blocks.each do |b|
               case b.context
-              when :listing, :image, :literal
+              when :listing, :image, :literal, :stem
                 xml_figure << send(b.context, b).join("\n")
                 seen_artwork = true
               else

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

@@ -57,7 +57,6 @@ module Asciidoctor
       alias_method :inline_menu, :skip
       alias_method :inline_image, :skip
 
-      alias_method :stem, :literal
       alias_method :quote, :paragraph
     end
   end

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

@@ -37,8 +37,6 @@ module Asciidoctor
                             "[#{target}] (Section #{matched[:section]})"
                           when "bare"
                             matched[:section]
-                          else
-                            "Section #{matched[:section]} of #{target}"
                           end
           unless matched[:text].empty?
             xref_contents = "#{xref_contents}: #{matched[:text]}"
@@ -86,16 +84,12 @@ module Asciidoctor
           end
         end
         # NOTE technically node.text should be node.reftext, but subs have already been applied to text
-        %(<bibanchor="#{node.id}">) # will convert to anchor attribute upstream
+        # %(<bibanchor="#{node.id}">) # will convert to anchor attribute upstream
+        nil
       end
 
       def inline_anchor_ref(node)
-        # If this is within referencegroup, output as bibanchor anyway
-        if $processing_reflist
-          %(<bibanchor="#{node.id}">) # will convert to anchor attribute upstream
-        else
           warn %(asciidoctor: WARNING: anchor "#{node.id}" is not in a place where XML RFC will recognise it as an anchor attribute)
-        end
       end
     end
   end

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

@@ -106,7 +106,7 @@ module Asciidoctor
             # all but last term have empty dd
             terms.each_with_index do |term, idx|
               t_attributes = {
-                hangText: term.text,
+                hangText: flatten_rawtext(term.text).join(' '),
               }
 
               if idx < terms.size - 1
@@ -114,13 +114,16 @@ module Asciidoctor
               else
                 xml_list.t **attr_code(t_attributes) do |xml_t|
                   if !dd.nil?
+                    if dd.text?
+                      # This vspace element is extraneous to the RFC XML spec,
+                      # but is required by IDNITS
+                      xml_t.vspace({blankLines: "1"}) unless $inline_definition_lists
+                      xml_t << dd.text
+                    end
                     if dd.blocks?
-                      xml_t << dd.text if dd.text?
                       # v2 does not support multi paragraph list items;
                       # vspace is used to emulate them
                       xml_t << para_to_vspace(dd.content)
-                    else
-                      xml_t << dd.text
                     end
                   end
                 end

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

@@ -20,7 +20,7 @@ module Asciidoctor
                       when "none"
                         "none"
                       else
-                        "all"
+                        "full"
                       end
 
         warn "asciidoctor: WARNING: grid=rows attribute is not supported on tables" if node.attr("grid") == "rows"

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

@@ -33,6 +33,7 @@ module Asciidoctor
         # 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")
+        $xreftext = {}
         result = []
         result << '<?xml version="1.0" encoding="UTF-8"?>'
 
@@ -89,34 +90,7 @@ module Asciidoctor
         # 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 = {
-          # give errors regarding ID-nits and DTD validation
-          strict: "yes",
-
-          # TOC control
-          # generate a ToC
-          toc: node.attr("toc-include") == "false" ? "no" : "yes",
-
-          # the number of levels of subsections in ToC. default: 3
-          tocdepth: node.attr("toc-depth") || "4",
-
-          # References control
-
-          # use symbolic references tags, i.e, [RFC2119] instead of [1]
-          symrefs: node.attr("sym-refs"),
-
-          # sort the reference entries alphabetically
-          sortrefs: node.attr("sort-refs"),
-
-          # Vertical whitespace control
-          # (using these PIs as follows is recommended by the RFC Editor)
-
-          # do not start each main section on a new page
-          compact: "yes",
-
-          # keep one blank line between list items
-          subcompact: "no",
-        }
+        rfc_pis = common_rfc_pis(node)
 
         doc.create_internal_subset("rfc", nil, "rfc2629.dtd")
         rfc_pis.each_pair do |k, v|
@@ -157,12 +131,16 @@ module Asciidoctor
         end.join
       end
 
+      BCP_KEYWORDS = [
+        'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT',
+        'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'MAY', 'OPTIONAL'
+      ]
       def inline_quoted(node)
         noko do |xml|
           case node.type
           when :emphasis then xml.em node.text
           when :strong
-            if $bcp_bold && node.text =~ /^(MUST|MUST NOT|REQUIRED|SHALL|SHALL NOT|SHOULD|SHOULD NOT|RECOMMENDED|MAY|OPTIONAL)$/
+            if $bcp_bold && BCP_KEYWORDS.exist?(node.text)
               xml.bcp14 node.text
             else
               xml.strong node.text
@@ -227,20 +205,20 @@ module Asciidoctor
       #   * [[[ref2]]] Ref
       def section(node)
         result = []
-        if node.attr("style") == "bibliography"
-          $xreftext = {}
+        if node.attr("style") == "bibliography" ||
+            node.parent.context == :section && node.parent.attr("style") == "bibliography"
           $processing_reflist = true
 
-          # references_attributes = {
-          #   anchor: node.id,
-          # }.reject { |_, value| value.nil? }
-
-          # result << noko do |xml|
-          #   xml.references **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
+          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}>"
@@ -250,6 +228,8 @@ module Asciidoctor
           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
@@ -257,9 +237,27 @@ module Asciidoctor
             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?
-            result.unshift($xreftext.keys.map { |k| %(<displayreference target="#{k}" to="#{$xreftext[k]}"/>) })
+          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

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

@@ -1,3 +1,5 @@
+require "htmlentities"
+
 module Asciidoctor
   module RFC::V3
     module Blocks
@@ -40,6 +42,31 @@ module Asciidoctor
         end
       end
 
+      # stem is treated as literal, but with center alignment
+      def stem(node)
+        artwork_attributes = {
+          anchor: node.id,
+          align: node.attr("align") || "center",
+          type: "ascii-art",
+          name: node.title,
+          alt: node.attr("alt"),
+        }
+
+        # NOTE: html escaping is performed by Nokogiri
+        artwork_content = node.lines.join("\n")
+
+        noko do |xml|
+          if node.parent.context != :example
+            xml.figure do |xml_figure|
+              xml_figure.artwork artwork_content, **attr_code(artwork_attributes)
+            end
+          else
+            xml.artwork artwork_content, **attr_code(artwork_attributes)
+          end
+        end
+      end
+
+
       # Syntax:
       #   [[id]]
       #   [quote, attribution, citation info] # citation info limited to URL
@@ -104,7 +131,7 @@ module Asciidoctor
           result << noko do |xml|
             xml.note **attr_code(note_attributes) do |xml_note|
               xml_note.name node.title unless node.title.nil?
-              xml_note << [paragraph1(node)].flatten.join("\n")
+              xml_note << HTMLEntities.new.decode([paragraph1(node)].flatten.join("\n"))
             end
           end
         else
@@ -149,7 +176,7 @@ module Asciidoctor
       #   ====
       def example(node)
         node.blocks.each do |b|
-          unless %i{listing image literal}.include? b.context
+          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}"
           end
         end

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

@@ -56,8 +56,6 @@ module Asciidoctor
       alias_method :inline_menu, :skip
       alias_method :inline_image, :skip
 
-      alias_method :stem, :literal
-
       alias_method :inline_callout, :content
     end
   end

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

@@ -74,16 +74,12 @@ module Asciidoctor
           end
         end
         # NOTE technically node.text should be node.reftext, but subs have already been applied to text
-        %(<bibanchor="#{node.id}">) # will convert to anchor attribute upstream
+        # %(<bibanchor="#{node.id}">) # will convert to anchor attribute upstream
+        nil
       end
 
       def inline_anchor_ref(node)
-        # If this is within referencegroup, output as bibanchor anyway
-        if $processing_reflist
-          %(<bibanchor="#{node.id}">) # will convert to anchor attribute upstream
-        else
           warn %(asciidoctor: WARNING: anchor "#{node.id}" is not in a place where XML RFC will recognise it as an anchor attribute)
-        end
       end
     end
   end

data/lib/asciidoctor/rfc/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module RFC
-    VERSION = "0.2.0".freeze
+    VERSION = "0.8.0".freeze
   end
 end

data/spec/asciidoctor/rfc/v2/comments_spec.rb

@@ -156,7 +156,7 @@ describe Asciidoctor::RFC::V2::Converter do
 
 
       </front><middle>
-      <section anchor="sect1" title="Section1"><t>Text<cref>Text _Text_ *Text* `Text` ~Text~ ^Text^ http://example.com/[linktext] &lt;&lt;ref&gt;&gt;</cref></t>
+      <section anchor="sect1" title="Section1"><t>Text<cref>Text _Text_ *Text* `Text` ~Text~ ^Text^ http://example.com/[linktext] </cref></t>
 
       </section>
       </middle><back>
@@ -208,6 +208,10 @@ describe Asciidoctor::RFC::V2::Converter do
       . They are allergic to *cinnamon*.
       . More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens.
       . Celery makes them sad.
+      
+      ....
+      <tagging>
+      ....
       ====
     INPUT
       <?xml version="1.0" encoding="US-ASCII"?>
@@ -236,8 +240,8 @@ describe Asciidoctor::RFC::V2::Converter do
 
 
 
-      Celery makes them sad.</cref></t>
-
+      Celery makes them sad.
+      &lt;tagging&gt;</cref></t>
       </section>
       </middle>
       </rfc>

data/spec/asciidoctor/rfc/v2/date_spec.rb

@@ -163,4 +163,27 @@ describe Asciidoctor::RFC::V2::Converter do
        </rfc>
     OUTPUT
   end
+
+  it "supplies today's date if invalid date given" do
+    # today's date is frozen at 2000-01-01 by spec_helper
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+       = Document title
+       :docName:
+       :date: fred
+       Author
+    INPUT
+         <?xml version="1.0" encoding="US-ASCII"?>
+         <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+         <rfc
+                  submissionType="IETF">
+         <front>
+         <title>Document title</title>
+         <author fullname="Author"/>
+       <date day="1" month="January" year="2000"/>
+       </front><middle>
+       </middle>
+       </rfc>
+    OUTPUT
+  end
 end

data/spec/asciidoctor/rfc/v2/dlist_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 describe Asciidoctor::RFC::V2::Converter do
-  it "renders a description list" do
+  it "renders a definition list" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       = Document title
       Author
@@ -14,15 +14,74 @@ describe Asciidoctor::RFC::V2::Converter do
       <section anchor="_section_1" title="Section 1">
          <t>
          <list hangIndent="5" style="hanging">
-           <t hangText="A">B</t>
-           <t hangText="C">D</t>
+           <t hangText="A"><vspace blankLines="1"/>B</t>
+           <t hangText="C"><vspace blankLines="1"/>D</t>
          </list>
        </t>
       </section>
     OUTPUT
   end
 
-  it "renders a description list with empty style" do
+  it "renders an inline definition list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :inline-definition-list: true
+
+      == Section 1
+      [[id]]
+      [hang-indent=5]
+      A:: B
+      C:: D
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+      <?rfc strict="yes"?>
+      <?rfc toc="yes"?>
+      <?rfc tocdepth="4"?>
+      <?rfc symrefs="yes"?>
+      <?rfc sortrefs="yes"?>
+      <?rfc compact="yes"?>
+      <?rfc subcompact="no"?>
+      <rfc submissionType="IETF">
+      <front>
+         <title>Document title</title>
+         <author fullname="Author"/>
+         <date day="1" month="January" year="2000"/>
+     
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list hangIndent="5" style="hanging">
+           <t hangText="A"><vspace blankLines="1"/>B</t>
+           <t hangText="C"><vspace blankLines="1"/>D</t>
+         </list>
+       </t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "ignores formatting on definition list terms" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      `A` _2_:: B
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list style="hanging">
+           <t hangText="A 2"><vspace blankLines="1"/>B</t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+
+  it "renders a definition list with empty style" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       = Document title
       Author
@@ -36,15 +95,15 @@ describe Asciidoctor::RFC::V2::Converter do
       <section anchor="_section_1" title="Section 1">
          <t>
          <list hangIndent="5" style="empty">
-           <t hangText="A">B</t>
-           <t hangText="C">D</t>
+           <t hangText="A"><vspace blankLines="1"/>B</t>
+           <t hangText="C"><vspace blankLines="1"/>D</t>
          </list>
        </t>
       </section>
     OUTPUT
   end
 
-  it "renders hybrid description list" do
+  it "renders hybrid definition list" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       = Document title
       Author
@@ -83,6 +142,26 @@ describe Asciidoctor::RFC::V2::Converter do
     OUTPUT
   end
 
+  it "renders a definition list with definitions on the next line" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      A:: 
+      +
+      B
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list style="hanging">
+           <t hangText="A"><vspace blankLines="1"/>B</t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+
   it "uses vspace to break up multi paragraph list items" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       = Document title
@@ -98,8 +177,27 @@ describe Asciidoctor::RFC::V2::Converter do
       <section anchor="_section_1" title="Section 1">
          <t>
          <list style="hanging">
-           <t hangText="Notes">Note 1.<vspace/>Note 2.
-       <vspace/>Note 3.</t>
+           <t hangText="Notes"><vspace blankLines="1"/>Note 1.<vspace blankLines="1"/>Note 2.
+       <vspace blankLines="1"/>Note 3.</t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+  it "renders definition lists with more definition terms than definitions" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      Notes1::
+      Notes2:: Definition 
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list style="hanging">
+           <t hangText="Notes1"/>
+           <t hangText="Notes2"><vspace blankLines="1"/>Definition</t>
          </list>
        </t>
       </section>