asciidoctor-rfc 0.8.0 → 0.8.2

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

@@ -114,7 +114,7 @@ describe Asciidoctor::RFC::V2::Converter do
       </t>
     OUTPUT
   end
-  
+
   it "renders a nested list containing a comment" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       [[id]]

data/spec/asciidoctor/rfc/v3/biblio_spec.rb

@@ -0,0 +1,13 @@
+require "spec_helper"
+
+def remove_preptime(xml)
+  xml.gsub(/ prepTime="[^"]+"/, "").gsub(/ prepTime='[^']+'/, "")
+end
+
+describe Asciidoctor::RFC::V3::Converter do
+  # it "processes v3 sample biblio file" do
+  #  system("rm -f spec/examples/refs-v3.new.xml")
+  #  system("bin/asciidoctor-rfc3 -r asciidoctor-bibliography spec/examples/refs-v3.adoc -o spec/examples/refs-v3.new.xml")
+  #  expect(remove_preptime(File.read("spec/examples/refs-v3.new.xml"))).to be_equivalent_to remove_prepTime(File.read("spec/examples/refs-v3.xml"))
+  # end
+end

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

@@ -305,4 +305,75 @@ describe Asciidoctor::RFC::V3::Converter do
       </rfc>
     OUTPUT
   end
+  
+  it "renders inline XML comments" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      A:: B [comment]#This is a comment# C D
+      C [comment]#This is another comment#:: D
+    INPUT
+      <section anchor="_section_1" numbered="false">
+         <name>Section 1</name>
+         <dl>
+         <dt>A</dt>
+         <dd>B <!--This is a comment--> C D</dd>
+         <dt>C <!--This is another comment--></dt>
+         <dd>D</dd>
+       </dl>
+      </section>
+    OUTPUT
+  end
+
+
+  it "renders XML comment paragraphs" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [.comment]
+      This is a 
+      _paragraph comment_.
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <!--This is a 
+      _paragraph comment_.-->
+      </section>
+    OUTPUT
+  end
+
+  it "renders XML comment blocks" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [.comment]
+      --
+      This is a 
+      _paragraph comment_.
+
+      And the comment runs over
+
+      several paragraphs.
+      --
+    INPUT
+      <section anchor="_section_1" numbered="false">
+        <name>Section 1</name>
+         <!--This is a
+         _paragraph comment_.
+
+         And the comment runs over
+
+         several paragraphs.
+         -->
+      </section>
+    OUTPUT
+  end
+
+
 end

data/spec/asciidoctor/rfc/v3/crossref_spec.rb

@@ -49,6 +49,9 @@ describe Asciidoctor::RFC::V3::Converter do
 
       == Section 4
       See <<crossreference,format=counter: text>>
+
+      == Section 5
+      See <<crossreference,format=title>>
     INPUT
       <?xml version="1.0" encoding="US-ASCII"?>
       <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
@@ -76,6 +79,10 @@ describe Asciidoctor::RFC::V3::Converter do
       <name>Section 4</name>
       <t>See <xref format="counter" target="crossreference">text</xref></t>
       </section>
+      <section anchor="_section_5" numbered="false">
+      <name>Section 5</name>
+      <t>See <xref format="title" target="crossreference"/></t>
+      </section>
       </middle>
       </rfc>
     OUTPUT

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

@@ -102,7 +102,7 @@ describe Asciidoctor::RFC::V3::Converter do
       Author
 
       == Section 1
-      A:: 
+      A::
       +
       B
     INPUT
@@ -147,7 +147,7 @@ describe Asciidoctor::RFC::V3::Converter do
       +
       --
       Note 2.
-      
+
       Note 3.
       --
     INPUT
@@ -189,7 +189,7 @@ describe Asciidoctor::RFC::V3::Converter do
       Author
 
       == Section 1
-      Notes::  
+      Notes::
     INPUT
       <section anchor="_section_1" numbered="false">
          <name>Section 1</name>
@@ -207,7 +207,7 @@ describe Asciidoctor::RFC::V3::Converter do
 
       == Section 1
       Notes1::
-      Notes2:: Definition 
+      Notes2:: Definition
     INPUT
       <section anchor="_section_1" numbered="false">
          <name>Section 1</name>

data/spec/asciidoctor/rfc/v3/literal_spec.rb

@@ -51,7 +51,7 @@ describe Asciidoctor::RFC::V3::Converter do
   it "renders stem as a literal within an example" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
       :stem:
-      
+
       [#id]
       ====
       [stem]

data/spec/asciidoctor/rfc/v3/preamble_spec.rb

@@ -69,7 +69,7 @@ describe Asciidoctor::RFC::V3::Converter do
       = Document title
       Author
       :docName:
-      
+
       Abstract
 
       [NOTE]

data/spec/asciidoctor/rfc/v3/references_spec.rb

@@ -11,7 +11,7 @@ describe Asciidoctor::RFC::V3::Converter do
 
       [bibliography]
       == References
-      
+
       === Normative References
       ++++
       <reference anchor='ISO.IEC.10118-3' target='https://www.iso.org/standard/67116.html'>
@@ -86,7 +86,7 @@ describe Asciidoctor::RFC::V3::Converter do
       == References
       * [[[xxx,1]]]
       * [[[gof,2]]]
-      
+
       === Normative References
       ++++
       <reference anchor='ISO.IEC.10118-3' target='https://www.iso.org/standard/67116.html'>
@@ -128,7 +128,7 @@ describe Asciidoctor::RFC::V3::Converter do
          <title>Document title</title>
          <author fullname="Author"/>
          <date day="1" month="January" year="2000"/>
-     
+
        </front><middle>
        <section anchor="_text" numbered="false">
          <name>Text</name>
@@ -145,4 +145,209 @@ describe Asciidoctor::RFC::V3::Converter do
       </rfc>
     OUTPUT
   end
+
+  it "renders external RFC XML references as includes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true).to_s).to be_equivalent_to <<~'OUTPUT'
+      = The Holy Hand Grenade of Antioch
+      Arthur Pendragon
+      :doctype: internet-draft
+
+      == Hello
+      Hello
+
+      [bibliography]
+      == Normative References
+      ++++
+      <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119">
+      <front>
+      <title>
+      Key words for use in RFCs to Indicate Requirement Levels
+      </title>
+      <author initials="S." surname="Bradner" fullname="S. Bradner">
+      <organization/>
+      </author>
+      <date year="1997" month="March"/>
+      <abstract>
+      <t>
+      In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.
+      </t>
+      </abstract>
+      </front>
+      <seriesInfo name="BCP" value="14"/>
+      <seriesInfo name="RFC" value="2119"/>
+      <seriesInfo name="DOI" value="10.17487/RFC2119"/>
+      </reference>
+      ++++
+
+      [bibliography]
+      == Informative References
+      ++++
+      <reference anchor="I-D.abarth-cake">
+      <front>
+      <title>Simple HTTP State Management Mechanism</title>
+      <author initials="A" surname="Barth" fullname="Adam Barth">
+      <organization/>
+      </author>
+      <date month="August" day="22" year="2010"/>
+      <abstract>
+      <t>
+      This document describes a simple HTTP state management mechanism, called cake, that lets HTTP servers maintain stateful sessions with HTTP user agents. This mechanism is harmonized with the same-origin security model and provides both confidentiality and integrity protection against active network attackers. In addition, the mechanism is robust to cross-site request forgery attacks.Editorial Note (To be removed by RFC Editor) If you have suggestions for improving this document, please send email to mailto:http-state@ietf.org. Further Working Group information is available from https://tools.ietf.org/wg/httpstate/.
+      </t>
+      </abstract>
+      </front>
+      <seriesInfo name="Internet-Draft" value="draft-abarth-cake-00"/>
+      <format type="TXT" target="http://www.ietf.org/internet-drafts/draft-abarth-cake-00.txt"/>
+      </reference>
+      ++++
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+      <?rfc strict="yes"?>
+      <?rfc compact="yes"?>
+      <?rfc subcompact="no"?>
+      <?rfc toc="yes"?>
+      <?rfc tocdepth="4"?>
+      <?rfc symrefs="yes"?>
+      <?rfc sortrefs="yes"?>
+      <rfc xmlns:xi="http://www.w3.org/2001/XInclude" submissionType="IETF" prepTime="2000-01-01T05:00:00Z" version="3">
+       <front>
+         <title>The Holy Hand Grenade of Antioch</title>
+         <author fullname="Arthur Pendragon" surname="Pendragon"/>
+         <date day="1" month="January" year="2000"/>
+       </front><middle>
+       <section anchor="_hello" numbered="false">
+         <name>Hello</name>
+         <t>Hello</t>
+       </section>
+       </middle><back>
+       <references anchor="_normative_references">
+         <name>Normative References</name>
+         <xi:include href="https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml" parse="text"/>
+       </references>
+       <references anchor="_informative_references">
+         <name>Informative References</name>
+         <xi:include href="https://xml2rfc.tools.ietf.org/public/rfc/bibxml3//reference.I-D.draft-abarth-cake-00.xml" parse="text"/>
+       </references>
+       </back>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders skeletal external RFC XML references as includes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true).to_s).to be_equivalent_to <<~'OUTPUT'
+      = The Holy Hand Grenade of Antioch
+      Arthur Pendragon
+      :doctype: internet-draft
+
+      == Hello
+      Hello
+
+      [bibliography]
+      == Normative References
+      ++++
+      <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119">
+      <front>
+      <title/>
+      <author/>
+      <date/>
+      </front>
+      </reference>
+      ++++
+
+      [bibliography]
+      == Informative References
+      ++++
+      <reference anchor="I-D.abarth-cake">
+      <front>
+      <title/>
+      <author/>
+      <date/>
+      </front>
+      </reference>
+      ++++
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+      <?rfc strict="yes"?>
+      <?rfc compact="yes"?>
+      <?rfc subcompact="no"?>
+      <?rfc toc="yes"?>
+      <?rfc tocdepth="4"?>
+      <?rfc symrefs="yes"?>
+      <?rfc sortrefs="yes"?>
+      <rfc xmlns:xi="http://www.w3.org/2001/XInclude" submissionType="IETF" prepTime="2000-01-01T05:00:00Z" version="3">
+       <front>
+         <title>The Holy Hand Grenade of Antioch</title>
+         <author fullname="Arthur Pendragon" surname="Pendragon"/>
+         <date day="1" month="January" year="2000"/>
+
+       </front><middle>
+       <section anchor="_hello" numbered="false">
+         <name>Hello</name>
+         <t>Hello</t>
+       </section>
+       </middle><back>
+       <references anchor="_normative_references">
+         <name>Normative References</name>
+         <xi:include href="https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml" parse="text"/>
+       </references>
+       <references anchor="_informative_references">
+         <name>Informative References</name>
+          <xi:include href="https://xml2rfc.tools.ietf.org/public/rfc/bibxml3//reference.I-D.abarth-cake.xml" parse="text"/>
+       </references>
+       </back>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders skeletal external RFC XML references with drafts as includes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true).to_s).to be_equivalent_to <<~'OUTPUT'
+      = The Holy Hand Grenade of Antioch
+      Arthur Pendragon
+      :doctype: internet-draft
+
+      == Hello
+      Hello
+
+      [bibliography]
+      == Informative References
+      ++++
+      <reference anchor="I-D.abarth-cake">
+      <front>
+      <title/>
+      <author/>
+      <date/>
+      </front>
+      <seriesInfo name="Internet-Draft" value="draft-abarth-cake-00"/>
+      </reference>
+      ++++
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+      <?rfc strict="yes"?>
+      <?rfc compact="yes"?>
+      <?rfc subcompact="no"?>
+      <?rfc toc="yes"?>
+      <?rfc tocdepth="4"?>
+      <?rfc symrefs="yes"?>
+      <?rfc sortrefs="yes"?>
+      <rfc xmlns:xi="http://www.w3.org/2001/XInclude" submissionType="IETF" prepTime="2000-01-01T05:00:00Z" version="3">
+      <front>
+         <title>The Holy Hand Grenade of Antioch</title>
+         <author fullname="Arthur Pendragon" surname="Pendragon"/>
+         <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_hello" numbered="false">
+         <name>Hello</name>
+         <t>Hello</t>
+       </section>
+       </middle><back>
+       <references anchor="_informative_references">
+          <name>Informative References</name>
+          <xi:include href="https://xml2rfc.tools.ietf.org/public/rfc/bibxml3//reference.I-D.draft-abarth-cake-00.xml" parse="text"/>
+       </references>
+       </back>
+       </rfc>
+    OUTPUT
+  end
 end

data/spec/asciidoctor/rfc/v3/series_info_spec.rb

@@ -177,7 +177,7 @@ describe Asciidoctor::RFC::V3::Converter do
          <seriesInfo name="" status="illegal" value="draft-xxx"/>
          <author fullname="Author"/>
          <date day="1" month="January" year="2000"/>
-     
+
        </front><middle>
        <section anchor="_section_1" numbered="false">
          <name>Section 1</name>

data/spec/asciidoctor/rfc/v3/table_spec.rb

@@ -7,6 +7,7 @@ describe Asciidoctor::RFC::V3::Converter do
 
       == Section 1
       [[id]]
+      [options="footer"]
       .Table Title
       |===
       |[[id]] head | head
@@ -19,6 +20,7 @@ describe Asciidoctor::RFC::V3::Converter do
       ^|centre aligned cell | cell
       <|left aligned cell | cell
       >|right aligned cell | cell
+
       |foot | foot
       |===
     INPUT
@@ -63,11 +65,13 @@ describe Asciidoctor::RFC::V3::Converter do
       <td align="right">right aligned cell</td>
       <td align="left">cell</td>
       </tr>
+      </tbody>
+      <tfoot>
       <tr>
       <td align="left">foot</td>
       <td align="left">foot</td>
       </tr>
-      </tbody>
+      </tfoot>
       </table>
       </section>
     OUTPUT
@@ -272,4 +276,69 @@ describe Asciidoctor::RFC::V3::Converter do
       </section>
     OUTPUT
   end
+  it "renders a table with no header row" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [[id]]
+      .Table Title
+      |===
+
+      h|header cell | body cell
+      | | body cell
+      2+| colspan of 2
+      .2+|rowspan of 2 | cell
+      |cell
+      ^|centre aligned cell | cell
+      <|left aligned cell | cell
+      >|right aligned cell | cell
+      |foot | foot
+      |===
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <table anchor="id">
+      <name>Table Title</name>
+      <tbody>
+      <tr>
+      <th align="left">header cell</th>
+      <td align="left">body cell</td>
+      </tr>
+      <tr>
+      <td align="left"></td>
+      <td align="left">body cell</td>
+      </tr>
+      <tr>
+      <td colspan="2" align="left">colspan of 2</td>
+      </tr>
+      <tr>
+      <td rowspan="2" align="left">rowspan of 2</td>
+      <td align="left">cell</td>
+      </tr>
+      <tr>
+      <td align="left">cell</td>
+      </tr>
+      <tr>
+      <td align="center">centre aligned cell</td>
+      <td align="left">cell</td>
+      </tr>
+      <tr>
+      <td align="left">left aligned cell</td>
+      <td align="left">cell</td>
+      </tr>
+      <tr>
+      <td align="right">right aligned cell</td>
+      <td align="left">cell</td>
+      </tr>
+      <tr>
+      <td align="left">foot</td>
+      <td align="left">foot</td>
+      </tr>
+      </tbody>
+      </table>
+      </section>
+    OUTPUT
+  end
 end