asciidoctor-rfc 0.1.0 → 0.2.0

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

@@ -0,0 +1,316 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "ignores actual Asciidoctor comments" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section1
+      Text
+
+      //Ignorable comment
+
+      ////
+        Multiblock ignorable comment
+      ////
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc
+                submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section1" title="Section1">
+      <t>Text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "uses Asciidoc inline NOTE admonition" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section1
+      Text
+
+      NOTE: This is a note
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc submissionType="IETF">
+      <front>
+
+         <title abbrev="abbrev_value">Document title</title>
+
+         <author fullname="Author"/>
+
+         <date day="1" month="January" year="2000"/>
+
+
+      </front><middle>
+      <section anchor="_section1" title="Section1"><t>Text<cref>This is a note</cref></t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "uses any Asciidoc inline admonition" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section1
+      Text
+
+      WARNING: This is a note
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc submissionType="IETF">
+      <front>
+
+         <title abbrev="abbrev_value">Document title</title>
+
+         <author fullname="Author"/>
+
+         <date day="1" month="January" year="2000"/>
+
+
+      </front><middle>
+      <section anchor="_section1" title="Section1"><t>Text<cref>This is a note</cref></t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "strips any inline formatting within Asciidoc inline admonition" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      [[sect1]]
+      == Section1
+      Text
+
+      WARNING: Text _Text_ *Text* `Text` ~Text~ ^Text^ http://example.com/[linktext] <<ref>>
+      [bibliography]
+      == References
+      ++++
+      <reference anchor='ref' target='https://www.iso.org/standard/67116.html'>
+        <front>
+          <title>ISO/IEC FDIS 10118-3 -- Information technology -- Security techniques -- Hash-functions -- Part 3: Dedicated hash-functions</title>
+          <author>
+            <organization>International Organization for Standardization</organization>
+            <address>
+              <postal>
+                <street>BIBC II</street>
+                <street>Chemin de Blandonnet 8</street>
+                <street>CP 401</street>
+                <city>Vernier</city>
+                <region>Geneva</region>
+                <code>1214</code>
+                <country>Switzerland</country>
+              </postal>
+              <phone>+41 22 749 01 11</phone>
+              <email>central@iso.org</email>
+              <uri>https://www.iso.org/</uri>
+            </address>
+          </author>
+          <date day='15' month='September' year='2017'/>
+        </front>
+      </reference>
+      ++++
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc submissionType="IETF">
+      <front>
+
+         <title abbrev="abbrev_value">Document title</title>
+
+         <author fullname="Author"/>
+
+         <date day="1" month="January" year="2000"/>
+
+
+      </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>
+      </middle><back>
+      <references title="References">
+      <reference anchor="ref" target="https://www.iso.org/standard/67116.html">
+         <front>
+           <title>ISO/IEC FDIS 10118-3 -- Information technology -- Security techniques -- Hash-functions -- Part 3: Dedicated hash-functions</title>
+           <author>
+             <organization>International Organization for Standardization</organization>
+             <address>
+               <postal>
+                 <street>BIBC II</street>
+                 <street>Chemin de Blandonnet 8</street>
+                 <street>CP 401</street>
+                 <city>Vernier</city>
+                 <region>Geneva</region>
+                 <code>1214</code>
+                 <country>Switzerland</country>
+               </postal>
+               <phone>+41 22 749 01 11</phone>
+               <email>central@iso.org</email>
+               <uri>https://www.iso.org/</uri>
+             </address>
+           </author>
+           <date day="15" month="September" year="2017"/>
+         </front>
+      </reference>
+      </references>
+      </back>
+      </rfc>
+    OUTPUT
+  end
+
+  it "uses Asciidoc block admonition" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section1
+      Text
+
+      [IMPORTANT]
+      .Feeding the Werewolves
+      ====
+      While werewolves are hardy community members, keep in mind the following dietary concerns:
+
+      . 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.
+      ====
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc submissionType="IETF">
+      <front>
+
+         <title abbrev="abbrev_value">Document title</title>
+
+         <author fullname="Author"/>
+
+         <date day="1" month="January" year="2000"/>
+
+
+      </front><middle>
+      <section anchor="_section1" title="Section1"><t>Text<cref>While werewolves are hardy community members, keep in mind the following dietary concerns:
+
+
+
+      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.</cref></t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "uses all options of the Asciidoc block admonition" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section1
+      Text
+
+      [[id]]
+      [NOTE,source=GBS]
+      .Note Title
+      ====
+      Any admonition inside the body of the text is a comment.
+      ====
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc submissionType="IETF">
+      <front>
+
+         <title abbrev="abbrev_value">Document title</title>
+
+         <author fullname="Author"/>
+
+         <date day="1" month="January" year="2000"/>
+
+
+      </front><middle>
+      <section anchor="_section1" title="Section1"><t>Text<cref anchor="id" source="GBS">Any admonition inside the body of the text is a comment.</cref></t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "has a comment at the start of a section" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      NOTE: This is an initial note
+
+      Text
+    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>
+      <section anchor="_section_1" title="Section 1"><t><cref>This is an initial note</cref></t>
+
+      <t>Text</t></section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,205 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders links" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      http://example.com/
+      http://example.com/[linktext]
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc
+               submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+      <t><eref target="http://example.com/"></eref>
+      <eref target="http://example.com/">linktext</eref></t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders cross-references" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      [[crossreference]]
+      == Section 1
+
+      == Section 2
+      See <<crossreference>>.
+
+      == Section 3
+      See <<crossreference,text>>
+
+      == Section 4
+      See <<crossreference,format=counter: text>>
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc
+               submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="crossreference" title="Section 1">
+      </section>
+      <section anchor="_section_2" title="Section 2">
+      <t>See <xref target="crossreference"></xref>.</t>
+      </section>
+      <section anchor="_section_3" title="Section 3">
+      <t>See <xref target="crossreference">text</xref></t>
+      </section>
+      <section anchor="_section_4" title="Section 4">
+      <t>See <xref format="counter" target="crossreference">text</xref></t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders cross-references to bibliography" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+
+      == Section 2
+      See <<crossreference>>.
+
+      == Section 3
+      See <<crossreference,text>>
+
+      [bibliography]
+      == References
+      ++++
+      <reference anchor='crossreference' target='https://tools.ietf.org/html/rfc7253'>
+      <front>
+         <title>Guidelines for Writing an IANA Considerations Section in RFCs</title>
+         <author initials="T." surname="Krovetz">
+           <organization>Sacramento State</organization>
+         </author>
+         <date month='May' year='2014'/>
+      </front>
+      </reference>
+      ++++
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc
+               submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+      </section>
+      <section anchor="_section_2" title="Section 2">
+      <t>See <xref target="crossreference"></xref>.</t>
+      </section>
+      <section anchor="_section_3" title="Section 3">
+      <t>See <xref target="crossreference">text</xref></t>
+      </section>
+      </middle><back>
+      <references title="References">
+      <reference anchor='crossreference' target='https://tools.ietf.org/html/rfc7253'>
+       <front>
+         <title>Guidelines for Writing an IANA Considerations Section in RFCs</title>
+         <author initials="T." surname="Krovetz">
+           <organization>Sacramento State</organization>
+         </author>
+         <date month='May' year='2014'/>
+       </front>
+      </reference>
+      </references>
+      </back>
+      </rfc>
+    OUTPUT
+  end
+  it "renders relref references" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      See <<crossreference,1.3 of>>
+      <<crossreference,1.4 comma: text>>
+      <<crossreference#fragment1,2.5.3 parens>>
+      <<crossreference#fragment2,6.2a bare: text>>
+
+      [bibliography]
+      == References
+      ++++
+      <reference anchor='crossreference' target='https://www.iso.org/standard/67116.html'>
+        <front>
+          <title>ISO/IEC FDIS 10118-3 -- Information technology -- Security techniques -- Hash-functions -- Part 3: Dedicated hash-functions</title>
+          <author>
+            <organization>International Organization for Standardization</organization>
+            <address>
+              <postal>
+                <street>BIBC II</street>
+                <street>Chemin de Blandonnet 8</street>
+                <street>CP 401</street>
+                <city>Vernier</city>
+                <region>Geneva</region>
+                <code>1214</code>
+                <country>Switzerland</country>
+              </postal>
+              <phone>+41 22 749 01 11</phone>
+              <email>central@iso.org</email>
+              <uri>https://www.iso.org/</uri>
+            </address>
+          </author>
+          <date day='15' month='September' year='2017'/>
+        </front>
+      </reference>
+      ++++
+    INPUT
+       <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+       <rfc submissionType="IETF">
+       <front>
+         <title abbrev="abbrev_value">Document title</title>
+         <author fullname="Author"/>
+         <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+         <t>See <xref target="crossreference">Section 1.3 of [crossreference]</xref>
+       <xref target="crossreference">[crossreference], Section 1.4: text</xref>
+       <xref target="crossreference#fragment1">[crossreference] (Section 2.5.3)</xref>
+       <xref target="crossreference#fragment2">6.2a: text</xref></t>
+       </section>
+       </middle><back>
+       <references title="References">
+         <reference anchor="crossreference" target="https://www.iso.org/standard/67116.html">  <front>    <title>ISO/IEC FDIS 10118-3 -- Information technology -- Security techniques -- Hash-functions -- Part 3: Dedicated hash-functions</title>    <author>      <organization>International Organization for Standardization</organization>      <address>        <postal>          <street>BIBC II</street>          <street>Chemin de Blandonnet 8</street>          <street>CP 401</street>          <city>Vernier</city>          <region>Geneva</region>          <code>1214</code>          <country>Switzerland</country>        </postal>        <phone>+41 22 749 01 11</phone>        <email>central@iso.org</email>        <uri>https://www.iso.org/</uri>      </address>    </author>    <date day="15" month="September" year="2017"/>  </front></reference>
+       </references>
+      </back>
+      </rfc>
+    OUTPUT
+  end
+end