asciidoctor-rfc 0.1.0 → 0.2.0

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

@@ -0,0 +1,91 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders a quote" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[verse-id]]
+      [quote, attribution="quote attribution", citetitle="http://www.foo.bar"]
+      Text
+    INPUT
+      <blockquote anchor="verse-id" quotedFrom="quote attribution" cite="http://www.foo.bar">
+      Text
+      </blockquote>
+    OUTPUT
+  end
+
+  it "renders a multi-paragraph quote" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[verse-id]]
+      [quote, attribution="quote attribution", citetitle="http://www.foo.bar"]
+      ____
+      Dennis: Come and see the violence inherent in the system. Help! Help! I'm being repressed!
+
+      King Arthur: Bloody peasant!
+
+      Dennis: Oh, what a giveaway! Did you hear that? Did you hear that, eh? That's what I'm on about! Did you see him repressing me? You saw him, Didn't you?
+      ____
+    INPUT
+      <blockquote anchor="verse-id" quotedFrom="quote attribution" cite="http://www.foo.bar">
+      <t>Dennis: Come and see the violence inherent in the system. Help! Help! I&#8217;m being repressed!</t>
+      <t>King Arthur: Bloody peasant!</t>
+      <t>Dennis: Oh, what a giveaway! Did you hear that? Did you hear that, eh? That&#8217;s what I&#8217;m on about! Did you see him repressing me? You saw him, Didn&#8217;t you?</t>
+      </blockquote>
+    OUTPUT
+  end
+
+  it "renders a quoted paragraph" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[verse-id]]
+      "I hold it that a little rebellion now and then is a good thing,
+      and as necessary in the political world as storms in the physical."
+      -- Thomas Jefferson, Papers of Thomas Jefferson: Volume 11
+    INPUT
+      <blockquote anchor="verse-id" quotedFrom="Thomas Jefferson" cite="Papers of Thomas Jefferson: Volume 11">
+      I hold it that a little rebellion now and then is a good thing,
+      and as necessary in the political world as storms in the physical.
+      </blockquote>
+    OUTPUT
+  end
+
+  it "renders a blockquote with internal markup" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      > I've got Markdown in my AsciiDoc!
+      >
+      > * Blockquotes
+      > * Headings
+      > * Fenced code blocks
+      >
+      > ....
+      > Wha?
+      > ....
+      >
+      > Yep. AsciiDoc and Markdown share a lot of common syntax already.
+    INPUT
+      <blockquote>
+      <t>I&#8217;ve got Markdown in my AsciiDoc!</t>
+      <ul>
+      <li>Blockquotes</li>
+      <li>Headings</li>
+      <li>Fenced code blocks</li>
+      </ul>
+      <figure>
+      <artwork type="ascii-art">
+      Wha?
+      </artwork>
+      </figure>
+      <t>Yep. AsciiDoc and Markdown share a lot of common syntax already.</t>
+      </blockquote>
+    OUTPUT
+  end
+
+  it "renders a verse" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[verse-id]]
+      [verse, Carl Sandburg, two lines from the poem Fog]
+      The *fog* comes
+      on little cat feet.
+    INPUT
+      <blockquote anchor="verse-id" quotedFrom="Carl Sandburg">The <strong>fog</strong> comes
+      on little cat feet.</blockquote>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,147 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders raw RFC XML as references" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :doctype: internet-draft
+
+      == Text
+      Text
+
+      [bibliography]
+      == References
+      ++++
+      <reference anchor='ISO.IEC.10118-3' 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
+      <section anchor="_text" numbered="false">
+      <name>Text</name>
+      <t>Text</t>
+      </section>
+      </middle><back>
+      <references anchor="_references">
+      <name>References</name>
+      <reference anchor='ISO.IEC.10118-3' 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>
+    OUTPUT
+  end
+
+  it "renders raw RFC XML as references, with displayreferences" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :doctype: internet-draft
+
+      == Text
+      Text
+
+      [bibliography]
+      == References
+      * [[[xxx,1]]]
+      * [[[gof,2]]]
+      ++++
+      <reference anchor='ISO.IEC.10118-3' 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
+      <section anchor="_text" numbered="false">
+      <name>Text</name>
+      <t>Text</t>
+      </section>
+      <displayreference target="xxx" to="1"/>
+      <displayreference target="gof" to="2"/>
+      <references anchor="_references">
+      <name>References</name>
+      <reference anchor='ISO.IEC.10118-3' 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>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,198 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders section with attributes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      [remove-in-rfc=true,toc=include]
+      == Section 1
+      Para 1
+
+      Para 2
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" removeInRFC="true" toc="include" numbered="false">
+      <name>Section 1</name>
+      <t>Para 1</t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders subsections" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      :sectnums:
+      [toc=exclude]
+      == Section 1
+      Para 1
+
+      === Subsection 1.1
+      Para 1a
+
+      :sectnums!:
+      [toc=default]
+
+      === Subsection 1.2
+      Para 2
+
+      ==== Subsection 1.2.1
+      Para 3
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" toc="exclude" numbered="true">
+      <name>Section 1</name>
+      <t>Para 1</t>
+      <section anchor="_subsection_1_1" numbered="true">
+      <name>Subsection 1.1</name>
+      <t>Para 1a</t>
+      </section>
+      <section anchor="_subsection_1_2" toc="default" numbered="false">
+      <name>Subsection 1.2</name>
+      <t>Para 2</t>
+      <section anchor="_subsection_1_2_1" numbered="false">
+      <name>Subsection 1.2.1</name>
+      <t>Para 3</t>
+      </section>
+      </section>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "ignores page breaks" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      Para 1
+
+      <<<
+
+      Para 2
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <t>Para 1</t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "ignores horizontal rules" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      Para 1
+
+      '''
+
+      Para 2
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <t>Para 1</t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders floating titles" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      Para 1
+
+      [discrete]
+      == Section 2
+      Para 2
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <t>Para 1</t>
+      <t><strong>Section 2</strong></t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,151 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "sets seriesInfo attributes for Internet Draft" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :doctype: internet-draft
+      :name: internet-draft-this-is-an-internet-draft-00
+      :status: informational
+      :intended-series: bcp
+      :submission-type: IRTF
+
+      == Section 1
+      Text
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IRTF">
+      <front>
+      <title>Document title</title>
+      <seriesInfo name="Internet-Draft" status="informational" stream="IRTF" value="internet-draft-this-is-an-internet-draft-00"/>
+      <seriesInfo name="" status="bcp" value="internet-draft-this-is-an-internet-draft-00"/>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+       <section anchor="_section_1" numbered="false">
+
+         <name>Section 1</name>
+
+         <t>Text</t>
+
+       </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "sets seriesInfo attributes for RFC, with FYI status" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :doctype: rfc
+      :name: 1111
+      :status: full-standard
+      :intended-series: fyi 1111
+      :submission-type: IRTF
+
+      == Section 1
+      Text
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IRTF">
+      <front>
+      <title>Document title</title>
+      <seriesInfo name="RFC" status="full-standard" stream="IRTF" value="1111"/>
+      <seriesInfo name="" status="fyi" value="1111"/>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+       <section anchor="_section_1" numbered="false">
+
+         <name>Section 1</name>
+
+         <t>Text</t>
+
+       </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "treats the rfc- prefix on :name: as optional" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :doctype: rfc
+      :name: rfc-1111
+      :status: full-standard
+      :intended-series: fyi 1111
+      :submission-type: IRTF
+
+      == Section 1
+      Text
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IRTF">
+      <front>
+      <title>Document title</title>
+      <seriesInfo name="RFC" status="full-standard" stream="IRTF" value="1111"/>
+      <seriesInfo name="" status="fyi" value="1111"/>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+       <section anchor="_section_1" numbered="false">
+
+         <name>Section 1</name>
+
+         <t>Text</t>
+
+       </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "sets seriesInfo attributes for RFC with historic status" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :doctype: rfc
+      :name: rfc-1111
+      :status: full-standard
+      :intended-series: historic
+      :submission-type: IRTF
+
+      == Section 1
+      Text
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IRTF">
+      <front>
+      <title>Document title</title>
+      <seriesInfo name="RFC" status="full-standard" stream="IRTF" value="1111"/>
+      <seriesInfo name="" status="historic" value="1111"/>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+       <section anchor="_section_1" numbered="false">
+
+         <name>Section 1</name>
+
+         <t>Text</t>
+
+       </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end