asciidoctor-rfc 0.1.0 → 0.2.0

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

@@ -0,0 +1,149 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders the date" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :revdate: 2070-01-01T00:00:00Z
+
+      == 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="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2070"/>
+      </front><middle>
+        <section anchor="_section_1" numbered="false">
+        <name>Section 1</name>
+        <t>Text</t>
+        </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "renders the revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :date: 2000-01-01T05:00:00Z
+
+      == 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="IETF">
+      <front>
+      <title>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>Text</t>
+        </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "gives precedence to revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :revdate: 2070-01-01T00:00:00Z
+      :date: 2000-01-01T05:00:00Z
+
+      == 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="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2070"/>
+      </front><middle>
+        <section anchor="_section_1" numbered="false">
+        <name>Section 1</name>
+        <t>Text</t>
+        </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "permits year-only revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :revdate: 1972
+
+      == 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="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author">
+      </author>
+      <date year="1972"/>
+      </front><middle>
+        <section anchor="_section_1" numbered="false">
+        <name>Section 1</name>
+        <t>Text</t>
+        </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "permits year-month revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :revdate: 1972-06
+
+      == 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="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author">
+      </author>
+      <date year="1972" month="June"/>
+      </front><middle>
+        <section anchor="_section_1" numbered="false">
+        <name>Section 1</name>
+        <t>Text</t>
+        </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,121 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders a horizontal description list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[id]]
+      [horizontal]
+      A:: B
+      C:: D
+    INPUT
+      <dl anchor="id" hanging="true">
+      <dt>A</dt>
+      <dd>B</dd>
+      <dt>C</dt>
+      <dd>D</dd>
+      </dl>
+    OUTPUT
+  end
+  it "renders a compact description list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[id]]
+      [compact]
+      A:: B
+      C:: D
+    INPUT
+      <dl anchor="id" spacing="compact">
+      <dt>A</dt>
+      <dd>B</dd>
+      <dt>C</dt>
+      <dd>D</dd>
+      </dl>
+    OUTPUT
+  end
+  it "renders nested description list/ulist" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      Dairy::
+      * Milk
+      * Eggs
+      Bakery::
+      * Bread
+      Produce::
+      * Bananas
+    INPUT
+      <dl>
+      <dt>Dairy</dt>
+      <dd>
+      <ul>
+      <li>Milk</li>
+      <li>Eggs</li>
+      </ul>
+      </dd>
+      <dt>Bakery</dt>
+      <dd>
+      <ul>
+      <li>Bread</li>
+      </ul>
+      </dd>
+      <dt>Produce</dt>
+      <dd>
+      <ul>
+      <li>Bananas</li>
+      </ul>
+      </dd>
+      </dl>
+    OUTPUT
+  end
+  it "renders hybrid nested description list/ulist" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      Dairy:: That is,
+      * Milk
+      * Eggs
+      Bakery:: Namely,
+      * Bread
+      Produce:: Viz.,
+      * Bananas
+    INPUT
+      <dl>
+      <dt>Dairy</dt>
+      <dd><t>That is,</t>
+      <ul>
+      <li>Milk</li>
+      <li>Eggs</li>
+      </ul>
+      </dd>
+      <dt>Bakery</dt>
+      <dd><t>Namely,</t>
+      <ul>
+      <li>Bread</li>
+      </ul>
+      </dd>
+      <dt>Produce</dt>
+      <dd><t>Viz.,</t>
+      <ul>
+      <li>Bananas</li>
+      </ul>
+      </dd>
+      </dl>
+    OUTPUT
+  end
+  it "permits multi paragraph list items" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      Notes::  Note 1.
+      +
+      Note 2.
+      +
+      Note 3.
+    INPUT
+      <section anchor="_section_1" numbered="false">
+         <name>Section 1</name>
+         <dl>
+         <dt>Notes</dt>
+         <dd><t>Note 1.</t><t>Note 2.</t>
+       <t>Note 3.</t></dd>
+       </dl>
+      </section>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,109 @@
+require "spec_helper"
+require "byebug"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders the minimal document w/ default values" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == 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="IETF">
+      <front>
+      <title>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>text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "renders all document attributes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :abbrev: abbrev
+      :ipr: ipr_value
+      :consensus: false
+      :obsoletes: 1, 2
+      :updates: 10, 11
+      :index-include: true
+      :ipr-extract: ipr_extract_value
+      :sort-refs: true
+      :sym-refs: false
+      :toc-include: false
+      :toc-depth: 2
+      :submission-type: IRTF
+
+      [[ipr_extract_value]]
+      == Section 1
+      text
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc ipr="ipr_value" obsoletes="1, 2" updates="10, 11" prepTime="2000-01-01T05:00:00Z"
+                version="3" submissionType="IRTF" indexInclude="true" iprExtract="ipr_extract_value" sortRefs="true" symRefs="false" tocInclude="false" tocDepth="2">
+      <front>
+      <title abbrev="abbrev">Document title</title>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="2000"/>
+      </front><middle>
+      <section anchor="ipr_extract_value" numbered="false">
+      <name>Section 1</name>
+      <t>text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "renders back matter" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      text
+
+      [appendix]
+      == Appendix
+      Lipsum.
+    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>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>text</t>
+      </section>
+      </middle><back>
+      <section anchor="_appendix" numbered="false">
+      <name>Appendix</name>
+      <t>Lipsum.</t>
+      </section>
+      </back>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,34 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders a minimal example" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      ====
+      Example
+      ====
+    INPUT
+      <figure>
+      <t>Example</t>
+      </figure>
+    OUTPUT
+  end
+  it "renders a maximal example" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[id]]
+      .Figure 1
+      ====
+      [[id2]]
+      .figure1.txt
+      ....
+      Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork)
+      ....
+      ====
+    INPUT
+      <figure anchor="id">
+      <name>Figure 1</name>
+      <artwork anchor="id2" name="figure1.txt" type="ascii-art">
+      Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork)
+      </artwork>
+      </figure>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,43 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders series, author, date, area, workgroup, keyword in sequence" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :abbrev: abbrev_value
+      :name: rfc-1111
+      :revdate: 1999-01-01
+      :area: horticulture
+      :workgroup: IETF
+      :keyword: widgets
+
+      == 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="IETF">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <seriesInfo name="RFC" stream="IETF" value="1111"/>
+      <author fullname="Author">
+      </author>
+      <date day="1" month="January" year="1999"/>
+      <area>horticulture</area>
+      <workgroup>IETF</workgroup>
+      <keyword>widgets</keyword>
+      </front><middle>
+             <section anchor="_section_1" numbered="false">
+
+                      <name>Section 1</name>
+
+                               <t>Text</t>
+
+                                      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end