asciidoctor-rfc 0.2.0 → 0.8.0

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

@@ -12,6 +12,23 @@ describe Asciidoctor::RFC::V2::Converter do
       </figure>
     OUTPUT
   end
+  it "renders an image within an example" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      [[id1]]
+      .Example Title
+      [align=right,alt=Example]
+      ====
+      [[id]]
+      .Image Title
+      [align=center,alt=alt_text]
+      image::http:://www.example/org/filename.jpg[]
+      ====
+    INPUT
+      <figure anchor="id1" align="right" alt="Example" title="Example Title">
+         <artwork align="center" alt="alt_text" name="Image Title" src="http:://www.example/org/filename.jpg"/>
+      </figure>
+    OUTPUT
+  end
   it "renders an image with macro attributes" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       [[id]]

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

@@ -174,4 +174,16 @@ describe Asciidoctor::RFC::V2::Converter do
       </rfc>
     OUTPUT
   end
+  it "renders line break" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      == Section 1
+      Hello +
+      This is a line break
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>Hello<vspace/>
+       This is a line break</t>
+      </section>
+    OUTPUT
+  end
 end

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

@@ -19,6 +19,28 @@ describe Asciidoctor::RFC::V2::Converter do
     OUTPUT
   end
 
+  it "renders a listing block within an example" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      [#id]
+      ====
+      [[literal-id]]
+      .filename.rb
+      [source,ruby,src=http://example.com/ruby.rb,alt=Alt Text]
+      ----
+      def listing(node)
+        result = []
+        result << "<figure>" if node.parent.context != :example
+      end
+      ----
+      ====
+    INPUT
+      <figure anchor="id">
+        <artwork name="filename.rb" type="ruby" src="http://example.com/ruby.rb" alt="Alt Text">
+        </artwork>
+      </figure>
+    OUTPUT
+  end
+
   it "renders a listing block without source attribute" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       [[literal-id]]

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

@@ -1,6 +1,6 @@
 require "spec_helper"
 describe Asciidoctor::RFC::V2::Converter do
-  it "renders a listing" do
+  it "renders a literal" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
       [[literal-id]]
       .filename
@@ -44,7 +44,27 @@ describe Asciidoctor::RFC::V2::Converter do
       ++++
     INPUT
       <figure>
-      <artwork>
+      <artwork align="center">
+      sqrt(4) = 2
+      </artwork>
+      </figure>
+    OUTPUT
+  end
+  
+  it "renders stem as a literal within an example" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      :stem:
+      
+      [#id]
+      ====
+      [stem]
+      ++++
+      sqrt(4) = 2
+      ++++
+      ====
+    INPUT
+      <figure anchor="id">
+      <artwork align="center">
       sqrt(4) = 2
       </artwork>
       </figure>

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

@@ -62,6 +62,39 @@ describe Asciidoctor::RFC::V2::Converter do
     OUTPUT
   end
 
+  it "renders verse in preamble as abstract" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :docName:
+
+      [verse]
+      More Preamble content.
+
+      == Lorem
+      Ipsum.
+    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"/>
+      <abstract>
+      <t>More Preamble content.</t>
+      </abstract>
+      </front><middle>
+      <section anchor="_lorem" title="Lorem">
+      <t>Ipsum.</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
   it "renders admonitions in preamble as notes" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
       = Document title
@@ -98,6 +131,45 @@ describe Asciidoctor::RFC::V2::Converter do
     OUTPUT
   end
 
+  it "renders admonitions in preamble as notes, following an abstract" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :docName:
+      
+      Abstract
+
+      [NOTE]
+      .Title of Note
+      ====
+      This is another note.
+      ====
+
+      == Lorem
+      Ipsum.
+    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"/>
+      <abstract><t>Abstract</t></abstract>
+      <note title="Title of Note">
+      <t>This is another note.</t>
+      </note>
+      </front><middle>
+      <section anchor="_lorem" title="Lorem">
+      <t>Ipsum.</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
   it "supplies default titles for notes" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
       = Document title

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

@@ -37,6 +37,8 @@ describe Asciidoctor::RFC::V2::Converter do
 
       [bibliography]
       == References
+      
+      === Normative References
       ++++
       <reference anchor='ISO.IEC.10118-3' target='https://www.iso.org/standard/67116.html'>
         <front>
@@ -66,7 +68,7 @@ describe Asciidoctor::RFC::V2::Converter do
       <section anchor="_text" title="Text">
       <t>Text</t>
       </section>
-      <references title="References">
+      <references title="Normative 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>

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

@@ -152,7 +152,7 @@ describe Asciidoctor::RFC::V2::Converter do
       |===
     INPUT
       <section anchor="_section_1" title="Section 1">
-      <texttable title="Table Title" suppress-title="false" style="all">
+      <texttable title="Table Title" suppress-title="false" style="full">
          <ttcol align="left">head</ttcol>
          <ttcol align="left">head</ttcol>
          <c>header cell</c>
@@ -195,7 +195,7 @@ describe Asciidoctor::RFC::V2::Converter do
       |===
     INPUT
       <section anchor="_section_1" title="Section 1">
-      <texttable title="Table Title" suppress-title="false" style="all">
+      <texttable title="Table Title" suppress-title="false" style="full">
          <ttcol align="left">head</ttcol>
          <ttcol align="left">head</ttcol>
          <c>header cell</c>
@@ -229,7 +229,7 @@ describe Asciidoctor::RFC::V2::Converter do
       |===
     INPUT
       <section anchor="_section_1" title="Section 1">
-      <texttable suppress-title="false" style="all">
+      <texttable suppress-title="false" style="full">
          <ttcol align="left" width="12.5%">a</ttcol>
          <ttcol align="left" width="25%">b</ttcol>
          <ttcol align="left" width="62.5%">c</ttcol>
@@ -254,7 +254,7 @@ describe Asciidoctor::RFC::V2::Converter do
       |===
     INPUT
       <section anchor="_section_1" title="Section 1">
-      <texttable suppress-title="false" style="all">
+      <texttable suppress-title="false" style="full">
          <ttcol align="left" width="10%">a</ttcol>
          <ttcol align="left" width="20%">b</ttcol>
          <ttcol align="left" width="70%">c</ttcol>
@@ -275,6 +275,31 @@ describe Asciidoctor::RFC::V2::Converter do
       |===
       |a |b |c
 
+      |a |b |c
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable suppress-title="false" style="full">
+         <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
+  it "renders table with grid=all" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [grid=all]
+      |===
+      |a |b |c
+
       |a |b |c
       |===
     INPUT
@@ -290,4 +315,79 @@ describe Asciidoctor::RFC::V2::Converter do
       </section>
     OUTPUT
   end
+  it "renders table with grid=rows" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [grid=rows]
+      |===
+      |a |b |c
+
+      |a |b |c
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable suppress-title="false" style="none">
+         <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
+  it "renders table with grid=cols" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [grid=cols]
+      |===
+      |a |b |c
+
+      |a |b |c
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable suppress-title="false" style="full">
+         <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
+  it "renders table with grid=none" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [grid=none]
+      |===
+      |a |b |c
+
+      |a |b |c
+      |===
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <texttable suppress-title="false" style="none">
+         <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

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

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+def text_compare(old_xml, new_xml)
+  File.write("#{old_xml}.1", norm(File.read(old_xml, encoding: "utf-8")))
+  File.write("#{new_xml}.1", norm(File.read(new_xml, encoding: "utf-8")))
+  system("xml2rfc #{old_xml}.1 -o #{old_xml}.txt")
+  system("xml2rfc #{new_xml}.1 -o #{new_xml}.txt")
+end
+
+def text_compare1(old_xml, new_xml)
+  system("xml2rfc #{old_xml} -o #{old_xml}.txt")
+  system("xml2rfc #{new_xml} -o #{new_xml}.txt")
+end
+
+def norm(text)
+  text.gsub(%r{<spanx style="strong">(MUST|MUST NOT|REQUIRED|SHALL|SHALL NOT|SHOULD|SHOULD NOT|RECOMMENDED|MAY|OPTIONAL)</spanx>}, "\\1")
+end
+
+describe Asciidoctor::RFC::V2::Converter do
+  it "processes Davies template with equivalent text" do
+    system("bin/asciidoctor-rfc2 spec/examples/davies-template-bare-06.adoc")
+    text_compare("spec/examples/davies-template-bare-06.xml.orig", "spec/examples/davies-template-bare-06.xml")
+    expect(norm(File.read("spec/examples/davies-template-bare-06.xml.orig.txt"))).to be_equivalent_to norm(File.read("spec/examples/davies-template-bare-06.xml.txt"))
+  end
+  it "processes MIB template with equivalent text" do
+    system("bin/asciidoctor-rfc2 spec/examples/mib-doc-template-xml-06.adoc")
+    text_compare("spec/examples/mib-doc-template-xml-06.xml.orig", "spec/examples/mib-doc-template-xml-06.xml")
+    expect(norm(File.read("spec/examples/mib-doc-template-xml-06.xml.orig.txt"))).to be_equivalent_to norm(File.read("spec/examples/mib-doc-template-xml-06.xml.txt"))
+  end
+  it "processes rfc1149 from Markdown with equivalent text" do
+    # leaving out step of running ./mmark
+    system("bin/asciidoctor-rfc2 spec/examples/rfc1149.md.adoc")
+    text_compare("spec/examples/rfc1149.md.2.xml", "spec/examples/rfc1149.md.xml")
+    expect(norm(File.read("spec/examples/rfc1149.md.2.xml.txt"))).to be_equivalent_to norm(File.read("spec/examples/rfc1149.md.xml.txt"))
+  end
+  it "processes rfc2100 from Markdown with equivalent text" do
+    # leaving out step of running ./mmark
+    system("bin/asciidoctor-rfc2 spec/examples/rfc2100.md.adoc")
+    text_compare("spec/examples/rfc2100.md.2.xml", "spec/examples/rfc2100.md.xml")
+    expect(norm(File.read("spec/examples/rfc2100.md.2.xml.txt"))).to be_equivalent_to norm(File.read("spec/examples/rfc2100.md.xml.txt"))
+  end
+  it "processes rfc3514 from Markdown with equivalent text" do
+    # leaving out step of running ./mmark
+    system("bin/asciidoctor-rfc2 spec/examples/rfc3514.md.adoc")
+    text_compare("spec/examples/rfc3514.md.2.xml", "spec/examples/rfc3514.md.xml")
+    expect(norm(File.read("spec/examples/rfc3514.md.2.xml.txt"))).to be_equivalent_to norm(File.read("spec/examples/rfc3514.md.xml.txt"))
+  end
+  it "processes rfc5841 from Markdown with equivalent text" do
+    # leaving out step of running ./mmark
+    system("bin/asciidoctor-rfc2 spec/examples/rfc5841.md.adoc")
+    text_compare("spec/examples/rfc5841.md.2.xml", "spec/examples/rfc5841.md.xml")
+    expect(norm(File.read("spec/examples/rfc5841.md.2.xml.txt"))).to be_equivalent_to norm(File.read("spec/examples/rfc5841.md.xml.txt"))
+  end
+  it "processes rfc748 from Markdown with equivalent text" do
+    # leaving out step of running ./mmark
+    system("bin/asciidoctor-rfc2 spec/examples/rfc748.md.adoc")
+    text_compare("spec/examples/rfc748.md.2.xml", "spec/examples/rfc748.md.xml")
+    expect(norm(File.read("spec/examples/rfc748.md.2.xml.txt"))).to be_equivalent_to norm(File.read("spec/examples/rfc748.md.xml.txt"))
+  end
+  it "processes rfc7511 from Markdown with equivalent text" do
+    # leaving out step of running ./mmark
+    system("bin/asciidoctor-rfc2 spec/examples/rfc7511.md.adoc")
+    text_compare("spec/examples/rfc7511.md.2.xml", "spec/examples/rfc7511.md.xml")
+    expect(norm(File.read("spec/examples/rfc7511.md.2.xml.txt"))).to be_equivalent_to norm(File.read("spec/examples/rfc7511.md.xml.txt"))
+  end
+  it "processes draft-ietf-core-block-xx from Kramdown with equivalent text" do
+    # leaving out step of running ./kramdown
+    system("bin/asciidoctor-rfc2 spec/examples/draft-ietf-core-block-xx.mkd.adoc")
+    text_compare("spec/examples/draft-ietf-core-block-xx.xml.orig", "spec/examples/draft-ietf-core-block-xx.mkd.xml")
+    expect(norm(File.read("spec/examples/draft-ietf-core-block-xx.xml.orig.txt"))).to be_equivalent_to norm(File.read("spec/examples/draft-ietf-core-block-xx.mkd.xml.txt"))
+  end
+  it "processes skel from Kramdown with equivalent text" do
+    # leaving out step of running ./kramdown
+    system("bin/asciidoctor-rfc2 spec/examples/skel.mkd.adoc")
+    text_compare1("spec/examples/skel.xml.orig", "spec/examples/skel.mkd.xml")
+    expect(File.read("spec/examples/skel.xml.orig.txt")).to be_equivalent_to File.read("spec/examples/skel.mkd.xml.txt")
+  end
+  it "processes stupid-s from Kramdown with equivalent text" do
+    # leaving out step of running ./kramdown
+    system("bin/asciidoctor-rfc2 spec/examples/stupid-s.mkd.adoc")
+    text_compare("spec/examples/stupid-s.xml.orig", "spec/examples/stupid-s.mkd.xml")
+    expect(File.read("spec/examples/stupid-s.xml.orig.txt")).to be_equivalent_to File.read("spec/examples/stupid-s.mkd.xml.txt")
+  end
+  it "processes Hoffman RFC XML v2 example with equivalent text" do
+    system("bin/asciidoctor-rfc2 spec/examples/hoffmanv2.xml.adoc")
+    text_compare("spec/examples/hoffmanv2.xml.orig", "spec/examples/hoffmanv2.xml.xml")
+    expect(norm(File.read("spec/examples/hoffmanv2.xml.orig.txt"))).to be_equivalent_to norm(File.read("spec/examples/hoffmanv2.xml.xml.txt"))
+  end
+end