asciidoctor-rfc 0.1.0 → 0.2.0

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

@@ -0,0 +1,166 @@
+require "spec_helper"
+require "date"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders the date" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               submissionType="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="2070"/>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+         <t>text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders the revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               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>text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "gives precedence to revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               submissionType="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="2070"/>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+         <t>text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "permits year-only revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               submissionType="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author"/>
+      <date year="1972"/>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+         <t>text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "permits year-month revdate" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               submissionType="IETF">
+      <front>
+      <title>Document title</title>
+      <author fullname="Author"/>
+      <date year="1972" month="June"/>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+         <t>text</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "supplies today's date if no date given" do
+    # today's date is frozen at 2000-01-01 by spec_helper
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+       = Document title
+       :docName:
+       Author
+    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>
+       </middle>
+       </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,108 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders a description list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [[id]]
+      [hang-indent=5]
+      A:: B
+      C:: D
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list hangIndent="5" style="hanging">
+           <t hangText="A">B</t>
+           <t hangText="C">D</t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+
+  it "renders a description list with empty style" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [[id]]
+      [empty,hang-indent=5]
+      A:: B
+      C:: D
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list hangIndent="5" style="empty">
+           <t hangText="A">B</t>
+           <t hangText="C">D</t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+
+  it "renders hybrid description list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      Dairy::
+      * Milk
+      * Eggs
+      Bakery::
+      * Bread
+      Produce::
+      * Bananas
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list style="hanging">
+           <t hangText="Dairy">
+             <list style="symbols">
+         <t>Milk</t>
+         <t>Eggs</t>
+       </list>
+           </t>
+           <t hangText="Bakery">
+             <list style="symbols">
+         <t>Bread</t>
+       </list>
+           </t>
+           <t hangText="Produce">
+             <list style="symbols">
+         <t>Bananas</t>
+       </list>
+           </t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+
+  it "uses vspace to break up multi paragraph list items" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      Notes::  Note 1.
+      +
+      Note 2.
+      +
+      Note 3.
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list style="hanging">
+           <t hangText="Notes">Note 1.<vspace/>Note 2.
+       <vspace/>Note 3.</t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,161 @@
+require "spec_helper"
+require "byebug"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders the minimal document w/ default values" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               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>text</t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders all document attributes for RFC" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :name: 1111
+      :abbrev: abbrev
+      :doctype: rfc
+      :ipr: full3978
+      :consensus: false
+      :obsoletes: 1, 2
+      :updates: 10, 11
+      :index-include: index_include_value
+      :ipr-extract: ipr_extract_value
+      :submission-type: IRTF
+      :status: info
+      :series-no: 12
+      :xml-lang: en
+
+      [[ipr_extract_value]]
+      == Section 1
+      Text
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc ipr="full3978" obsoletes="1, 2" updates="10, 11" category="info" consensus="no" submissionType="IRTF" iprExtract="ipr_extract_value" number="1111" seriesNo="12" xml:lang="en">
+      <front>
+
+         <title abbrev="abbrev">Document title</title>
+
+         <author fullname="Author"/>
+
+         <date day="1" month="January" year="2000"/>
+
+
+      </front><middle>
+      <section anchor="ipr_extract_value" title="Section 1">
+
+         <t>Text</t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders all document attributes for Internet Draft" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :name: draft-03-draft
+      :abbrev: abbrev
+      :doctype: internet-draft
+      :ipr: full3978
+      :consensus: false
+      :obsoletes: 1, 2
+      :updates: 10, 11
+      :ipr-extract: ipr_extract_value
+      :submission-type: IRTF
+      :status: info
+      :series-no: 12
+      :xml-lang: en
+
+      [[ipr_extract_value]]
+      == Section 1
+      Text
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+      <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+
+      <rfc ipr="full3978" obsoletes="1, 2" updates="10, 11" category="info" consensus="no" submissionType="IRTF" iprExtract="ipr_extract_value" docName="draft-03-draft" seriesNo="12" xml:lang="en">
+      <front>
+
+         <title abbrev="abbrev">Document title</title>
+
+         <author fullname="Author"/>
+
+         <date day="1" month="January" year="2000"/>
+
+
+      </front><middle>
+      <section anchor="ipr_extract_value" title="Section 1">
+
+         <t>Text</t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders back matter" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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 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>Text</t>
+
+      </section>
+      </middle><back>
+      <section anchor="_appendix" title="Appendix">
+
+         <t>Lipsum.</t>
+
+      </section>
+      </back>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,50 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders a maximal example" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      [[id]]
+      .Figure 1
+      [align=left,alt=Alt Text,suppress-title=true]
+      ====
+      [[id2]]
+      .figure1.txt
+      ....
+      Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork)
+      ....
+      ====
+    INPUT
+      <figure anchor="id" align="left" alt="Alt Text" title="Figure 1" suppress-title="true">
+      <artwork name="figure1.txt">
+      Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork)
+      </artwork>
+      </figure>
+    OUTPUT
+  end
+
+  it "renders preambles and postambles in example" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      ====
+      Preamble text
+
+      .figure1.txt
+      ....
+      Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork)
+      ....
+
+      Postamble text
+      ====
+    INPUT
+      <figure>
+      <preamble>
+      Preamble text
+      </preamble>
+      <artwork name="figure1.txt">
+      Figures are only permitted to contain listings (sourcecode), images (artwork), or literal (artwork)
+      </artwork>
+      <postamble>
+      Postamble text
+      </postamble>
+      </figure>
+    OUTPUT
+  end
+end