asciidoctor-rfc 0.1.0 → 0.2.0

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

@@ -0,0 +1,24 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders a quote as a paragraph" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      [[verse-id]]
+      [quote, attribution="quote attribution", citetitle="http://www.foo.bar"]
+      Text
+    INPUT
+      <t anchor="verse-id">Text</t>
+    OUTPUT
+  end
+
+  it "renders a verse" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      [[verse-id]]
+      [verse, Carl Sandburg, two lines from the poem Fog]
+      The fog comes
+      on little cat feet.
+    INPUT
+      <t anchor="verse-id">The fog comes<vspace/>
+      on little cat feet.</t>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,96 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "rejects an unordered list of references" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :doctype: internet-draft
+
+      == Text
+      Text
+
+      [[id]]
+      [bibliography]
+      == References
+      * [[[xxx]]] Andy Hunt & Dave Thomas. The Pragmatic Programmer:
+         From Journeyman to Master. Addison-Wesley. 1999.
+      * [[[gof]]] Erich Gamma, Richard Helm, Ralph Johnson & John Vlissides. Design Patterns:
+         Elements of Reusable Object-Oriented Software. Addison-Wesley. 1994.
+    INPUT
+      <section anchor="_text" title="Text">
+      <t>Text</t>
+      </section>
+      </middle><back>
+      <references title="References">
+      </references>
+    OUTPUT
+  end
+
+  it "renders raw RFC XML as references" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).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" title="Text">
+      <t>Text</t>
+      </section>
+      <references title="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>
+      </references>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,260 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders section with attributes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      [[id]]
+      == Section 1
+      Para 1
+
+      Para 2
+    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="id" title="Section 1">
+      <t>Para 1</t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders HTML entities and Non-ASCII characters and in section title attributes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      [[id]]
+      == Section&nbsp;(Секция) 1
+      Para 1
+
+      Para 2
+    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="id" title="Section&#160;(&#1057;&#1077;&#1082;&#1094;&#1080;&#1103;) 1">
+      <t>Para 1</t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders subsections" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      Para 1
+
+      === Subsection 1.1
+      Para 1a
+
+      === 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
+               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>Para 1</t>
+      <section anchor="_subsection_1_1" title="Subsection 1.1">
+      <t>Para 1a</t>
+      </section>
+      <section anchor="_subsection_1_2" title="Subsection 1.2">
+      <t>Para 2</t>
+      <section anchor="_subsection_1_2_1" title="Subsection 1.2.1">
+      <t>Para 3</t>
+      </section>
+      </section>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "ignores sectnums" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      :sectnums:
+      == Section 1
+      Para 1
+
+      === Subsection 1.1
+      Para 1a
+
+      :sectnums!:
+      === 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
+               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>Para 1</t>
+      <section anchor="_subsection_1_1" title="Subsection 1.1">
+      <t>Para 1a</t>
+      </section>
+      <section anchor="_subsection_1_2" title="Subsection 1.2">
+      <t>Para 2</t>
+      <section anchor="_subsection_1_2_1" title="Subsection 1.2.1">
+      <t>Para 3</t>
+      </section>
+      </section>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "ignores page breaks" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               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>Para 1</t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "ignores horizontal rules" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               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>Para 1</t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders floating titles" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               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>Para 1</t>
+      <t><spanx style="strong">Section 2</spanx></t>
+      <t>Para 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,32 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders a sidebar as normal paragraphs" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      [[id]]
+      ****
+      Sidebar
+
+      Another sidebar
+
+      * This is a list
+
+      ....
+      And this is ascii-art
+      ....
+      ****
+    INPUT
+      <t>Sidebar</t>
+      <t>Another sidebar</t>
+      <t>
+      <list style="symbols">
+      <t>This is a list</t>
+      </list>
+      </t>
+      <figure>
+      <artwork>
+      And this is ascii-art
+      </artwork>
+      </figure>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,293 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders a table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [[id]]
+      [suppress-title=false,align=left,grid=cols]
+      .Table Title
+      |===
+      |[[id]] head | head
+
+      h|header cell | body cell
+      | | body cell
+      ^|centre aligned cell | cell
+      <|left aligned cell | cell
+      >|right aligned cell | cell
+
+      |foot | foot
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable anchor="id" title="Table Title" suppress-title="false" align="left" style="full">
+      <ttcol align="left"> head</ttcol>
+      <ttcol align="left">head</ttcol>
+      <c>header cell</c>
+      <c>body cell</c>
+      <c></c>
+      <c>body cell</c>
+      <c>centre aligned cell</c>
+      <c>cell</c>
+      <c>left aligned cell</c>
+      <c>cell</c>
+      <c>right aligned cell</c>
+      <c>cell</c>
+      <c>foot</c>
+      <c>foot</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+
+  it "ignores cell anchors in a table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [[id]]
+      [suppress-title=false,align=left,grid=cols]
+      .Table Title
+      |===
+      |[[id]] head | head
+
+      h|header cell | body cell
+      | | [[id]] body cell
+      ^|centre aligned cell | cell
+      <|left aligned cell | cell
+      >|right aligned cell | cell
+
+      |foot | foot
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable anchor="id" title="Table Title" suppress-title="false" align="left" style="full">
+      <ttcol align="left"> head</ttcol>
+      <ttcol align="left">head</ttcol>
+      <c>header cell</c>
+      <c>body cell</c>
+      <c></c>
+      <c> body cell</c>
+      <c>centre aligned cell</c>
+      <c>cell</c>
+      <c>left aligned cell</c>
+      <c>cell</c>
+      <c>right aligned cell</c>
+      <c>cell</c>
+      <c>foot</c>
+      <c>foot</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+
+  it "ignores colspan and rowspan in table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [[id]]
+      [suppress-title=false,align=left,grid=cols]
+      .Table Title
+      |===
+      |[[id]] head | head
+
+      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" title="Section 1">
+      <texttable anchor="id" title="Table Title" suppress-title="false" align="left" style="full">
+      <ttcol align="left"> head</ttcol>
+      <ttcol align="left">head</ttcol>
+      <c>header cell</c>
+      <c>body cell</c>
+      <c></c>
+      <c>body cell</c>
+      <c>colspan of 2</c>
+      <c>rowspan of 2</c>
+      <c>cell</c>
+      <c>cell</c>
+      <c>centre aligned cell</c>
+      <c>cell</c>
+      <c>left aligned cell</c>
+      <c>cell</c>
+      <c>right aligned cell</c>
+      <c>cell</c>
+      <c>foot</c>
+      <c>foot</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+  it "renders inline formatting within a table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      .Table Title
+      |===
+      |head | head
+
+      h|header cell | *body* _cell_
+      | | body cell<<x>>
+      ^|centre aligned cell | cell
+      <|left aligned cell | cell
+      >|right aligned cell | cell
+
+      |foot | foot
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable title="Table Title" suppress-title="false" style="all">
+         <ttcol align="left">head</ttcol>
+         <ttcol align="left">head</ttcol>
+         <c>header cell</c>
+         <c><spanx style="strong">body</spanx> <spanx style="emph">cell</spanx></c>
+         <c/>
+         <c>body cell<xref target="x"/></c>
+         <c>centre aligned cell</c>
+         <c>cell</c>
+         <c>left aligned cell</c>
+         <c>cell</c>
+         <c>right aligned cell</c>
+         <c>cell</c>
+         <c>foot</c>
+         <c>foot</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+  it "ignores block formatting within a table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [cols="2"]
+      .Table Title
+      |===
+      |head | head
+
+      h|header cell
+      a|
+      * List 1
+      * List 2
+      | | body cell<<x>>
+      ^|centre aligned cell | cell
+      <|left aligned cell | cell
+      >|right aligned cell | cell
+
+      |foot | foot
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable title="Table Title" suppress-title="false" style="all">
+         <ttcol align="left">head</ttcol>
+         <ttcol align="left">head</ttcol>
+         <c>header cell</c>
+         <c>* List 1
+       * List 2</c>
+         <c/>
+         <c>body cell<xref target="x"/></c>
+         <c>centre aligned cell</c>
+         <c>cell</c>
+         <c>left aligned cell</c>
+         <c>cell</c>
+         <c>right aligned cell</c>
+         <c>cell</c>
+         <c>foot</c>
+         <c>foot</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+  it "renders relative column widths in a table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [cols="1,2,5"]
+      |===
+      |a |b |c
+
+      |a |b |c
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable suppress-title="false" style="all">
+         <ttcol align="left" width="12.5%">a</ttcol>
+         <ttcol align="left" width="25%">b</ttcol>
+         <ttcol align="left" width="62.5%">c</ttcol>
+         <c>a</c>
+         <c>b</c>
+         <c>c</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+  it "renders percentage column widths in a table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [cols="10%,20%,70%"]
+      |===
+      |a |b |c
+
+      |a |b |c
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable suppress-title="false" style="all">
+         <ttcol align="left" width="10%">a</ttcol>
+         <ttcol align="left" width="20%">b</ttcol>
+         <ttcol align="left" width="70%">c</ttcol>
+         <c>a</c>
+         <c>b</c>
+         <c>c</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+  it "ignores '1,1,1,1,...' column widths in a table" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [cols="1,1,1"]
+      |===
+      |a |b |c
+
+      |a |b |c
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable suppress-title="false" style="all">
+         <ttcol align="left">a</ttcol>
+         <ttcol align="left">b</ttcol>
+         <ttcol align="left">c</ttcol>
+         <c>a</c>
+         <c>b</c>
+         <c>c</c>
+      </texttable>
+      </section>
+    OUTPUT
+  end
+end