asciidoctor-rfc 0.8.0 → 0.8.2

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

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe Asciidoctor::RFC::V2::Converter do
+  # it "processes v2 sample biblio file" do
+  #  system("rm -f spec/examples/refs-v2.new.xml")
+  #  system("bin/asciidoctor-rfc2 -r asciidoctor-bibliography spec/examples/refs-v2.adoc -o spec/examples/refs-v2.new.xml")
+  #  expect(File.read("spec/examples/refs-v2.new.xml")).to be_equivalent_to File.read("spec/examples/refs-v2.xml")
+  # end
+end

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

@@ -208,7 +208,7 @@ describe Asciidoctor::RFC::V2::Converter do
       . They are allergic to *cinnamon*.
       . More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens.
       . Celery makes them sad.
-      
+
       ....
       <tagging>
       ....
@@ -317,4 +317,70 @@ describe Asciidoctor::RFC::V2::Converter do
       </rfc>
     OUTPUT
   end
+
+  it "renders inline XML comments" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      A:: B [comment]#This is a comment# C D
+      C [comment]#This is another comment#:: D
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+         <t>
+         <list style="hanging">
+           <t hangText="A"><vspace blankLines="1"/>B <!--This is a comment--> C D</t>
+           <t hangText="C "><vspace blankLines="1"/>D</t>
+         </list>
+       </t>
+      </section>
+    OUTPUT
+  end
+
+  it "renders XML comment paragraphs" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [.comment]
+      This is a 
+      _paragraph comment_.
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <!--This is a _paragraph comment_.-->
+      </section>
+    OUTPUT
+  end
+
+  it "renders XML comment blocks" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+
+      == Section 1
+      [.comment]
+      --
+      This is a 
+      _paragraph comment_.
+
+      And the comment runs over
+
+      several paragraphs.
+      --
+    INPUT
+      <section anchor="_section_1" title="Section 1">
+      <!--This is a
+       _paragraph comment_.
+
+       And the comment runs over
+
+       several paragraphs.
+       -->
+      </section>
+    OUTPUT
+  end
+
+
 end

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

@@ -48,6 +48,9 @@ describe Asciidoctor::RFC::V2::Converter do
 
       == Section 4
       See <<crossreference,format=counter: text>>
+
+      == Section 5
+      See <<crossreference,format=title>>
     INPUT
       <?xml version="1.0" encoding="US-ASCII"?>
       <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
@@ -70,18 +73,22 @@ describe Asciidoctor::RFC::V2::Converter do
       <section anchor="_section_4" title="Section 4">
       <t>See <xref format="counter" target="crossreference">text</xref></t>
       </section>
+      <section anchor="_section_5" title="Section 5">
+      <t>See <xref format="title" target="crossreference"/></t>
+      </section>
       </middle>
       </rfc>
     OUTPUT
   end
 
-  it "renders cross-references to bibliography" do
+  it "renders cross-references" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
       = Document title
       :abbrev: abbrev_value
       :docName:
       Author
 
+      [[crossreference]]
       == Section 1
 
       == Section 2
@@ -90,6 +97,56 @@ describe Asciidoctor::RFC::V2::Converter do
       == Section 3
       See <<crossreference,text>>
 
+      == Section 4
+      See <<crossreference,format=counter: text>>
+
+      == Section 5
+      See <<crossreference,format=title>>
+    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="crossreference" title="Section 1">
+      </section>
+      <section anchor="_section_2" title="Section 2">
+      <t>See <xref target="crossreference"></xref>.</t>
+      </section>
+      <section anchor="_section_3" title="Section 3">
+      <t>See <xref target="crossreference">text</xref></t>
+      </section>
+      <section anchor="_section_4" title="Section 4">
+      <t>See <xref format="counter" target="crossreference">text</xref></t>
+      </section>
+      <section anchor="_section_5" title="Section 5">
+      <t>See <xref format="title" target="crossreference"/></t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "does not support fragments in cross-references to bibliography" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+
+      == Section 2
+      See <<crossreference#fragment1>>.
+
+      == Section 3
+      See <<crossreference#fragment1,text>>
+
       [bibliography]
       == References
       ++++
@@ -138,6 +195,71 @@ describe Asciidoctor::RFC::V2::Converter do
       </rfc>
     OUTPUT
   end
+
+  it "renders cross-references with dots to bibliography" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+
+      == Section 2
+      See <<cross.reference>>.
+
+      == Section 3
+      See <<cross.reference,text>>
+
+      [bibliography]
+      == References
+      ++++
+      <reference anchor='cross.reference' target='https://tools.ietf.org/html/rfc7253'>
+      <front>
+         <title>Guidelines for Writing an IANA Considerations Section in RFCs</title>
+         <author initials="T." surname="Krovetz">
+           <organization>Sacramento State</organization>
+         </author>
+         <date month='May' year='2014'/>
+      </front>
+      </reference>
+      ++++
+    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">
+      </section>
+      <section anchor="_section_2" title="Section 2">
+      <t>See <xref target="cross.reference"></xref>.</t>
+      </section>
+      <section anchor="_section_3" title="Section 3">
+      <t>See <xref target="cross.reference">text</xref></t>
+      </section>
+      </middle><back>
+      <references title="References">
+      <reference anchor='cross.reference' target='https://tools.ietf.org/html/rfc7253'>
+       <front>
+         <title>Guidelines for Writing an IANA Considerations Section in RFCs</title>
+         <author initials="T." surname="Krovetz">
+           <organization>Sacramento State</organization>
+         </author>
+         <date month='May' year='2014'/>
+       </front>
+      </reference>
+      </references>
+      </back>
+      </rfc>
+    OUTPUT
+  end
+
   it "renders relref references" do
     expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
       = Document title
@@ -189,10 +311,10 @@ describe Asciidoctor::RFC::V2::Converter do
          <date day="1" month="January" year="2000"/>
       </front><middle>
       <section anchor="_section_1" title="Section 1">
-         <t>See <xref target="crossreference">Section 1.3 of [crossreference]</xref>
-       <xref target="crossreference">[crossreference], Section 1.4: text</xref>
-       <xref target="crossreference#fragment1">[crossreference] (Section 2.5.3)</xref>
-       <xref target="crossreference#fragment2">6.2a: text</xref></t>
+      <t>See Section 1.3 of <xref target="crossreference"/>
+       <xref target="crossreference">text</xref>, Section 1.4
+       <xref target="crossreference"/> (Section 2.5.3)
+       <xref target="crossreference">6.2a: text</xref></t>
        </section>
        </middle><back>
        <references title="References">

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

@@ -145,45 +145,41 @@ describe Asciidoctor::RFC::V2::Converter do
   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
+      = Document title
+      :docName:
+      Author
     INPUT
-         <?xml version="1.0" encoding="US-ASCII"?>
-         <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
-
-         <rfc
-                  submissionType="IETF">
+      <?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>
+         <date day="1" month="January" year="2000"/>
+         </front><middle>
+         </middle>
+      </rfc>
     OUTPUT
   end
 
   it "supplies today's date if invalid 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:
-       :date: fred
-       Author
+      = Document title
+      :docName:
+      :date: fred
+      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>
+      <?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

@@ -48,13 +48,13 @@ describe Asciidoctor::RFC::V2::Converter do
          <title>Document title</title>
          <author fullname="Author"/>
          <date day="1" month="January" year="2000"/>
-     
+
       </front><middle>
       <section anchor="_section_1" title="Section 1">
          <t>
          <list hangIndent="5" style="hanging">
-           <t hangText="A"><vspace blankLines="1"/>B</t>
-           <t hangText="C"><vspace blankLines="1"/>D</t>
+           <t hangText="A"><vspace blankLines="0"/>B</t>
+           <t hangText="C"><vspace blankLines="0"/>D</t>
          </list>
        </t>
       </section>
@@ -148,7 +148,7 @@ describe Asciidoctor::RFC::V2::Converter do
       Author
 
       == Section 1
-      A:: 
+      A::
       +
       B
     INPUT
@@ -191,7 +191,7 @@ describe Asciidoctor::RFC::V2::Converter do
 
       == Section 1
       Notes1::
-      Notes2:: Definition 
+      Notes2:: Definition
     INPUT
       <section anchor="_section_1" title="Section 1">
          <t>

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

@@ -7,7 +7,7 @@ describe Asciidoctor::RFC::V2::Converter do
       [align=center,alt=alt_text,type=img/jpeg]
       image::http:://www.example/org/filename.jpg[]
     INPUT
-      <figure>
+      <figure anchor="id">
       <artwork name="Title" align="center" alt="alt_text" type="img/jpeg" src="http:://www.example/org/filename.jpg"/>
       </figure>
     OUTPUT
@@ -35,7 +35,7 @@ describe Asciidoctor::RFC::V2::Converter do
       .Title
       image::http:://www.example/org/filename.jpg[alt_text,300,200]
     INPUT
-      <figure>
+      <figure anchor="id">
       <artwork name="Title" alt="alt_text" src="http:://www.example/org/filename.jpg" width="300" height="200"/>
       </figure>
     OUTPUT

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

@@ -186,4 +186,32 @@ describe Asciidoctor::RFC::V2::Converter do
       </section>
     OUTPUT
   end
+  it "removes markup within spanx" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      `This is http://www.example.com _a_ *citation*`
+    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><spanx style="verb">This is  a citation</spanx></t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
 end

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

@@ -12,7 +12,7 @@ describe Asciidoctor::RFC::V2::Converter do
       end
       ----
     INPUT
-      <figure>
+      <figure anchor="literal-id">
         <artwork name="filename.rb" type="ruby" src="http://example.com/ruby.rb" alt="Alt Text">
         </artwork>
       </figure>
@@ -53,7 +53,7 @@ describe Asciidoctor::RFC::V2::Converter do
       end
       ----
     INPUT
-      <figure>
+      <figure anchor="literal-id">
       <artwork name="filename.rb" type="ruby">
       def listing(node)
         result = []

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

@@ -9,7 +9,7 @@ describe Asciidoctor::RFC::V2::Converter do
         Literal contents.
       ....
     INPUT
-      <figure>
+      <figure anchor="literal-id">
       <artwork align="left" name="filename" type="abnf" alt="alt_text">
         Literal contents.
       </artwork>
@@ -27,7 +27,7 @@ describe Asciidoctor::RFC::V2::Converter do
       ....
       <1> This is a callout
     INPUT
-      <figure>
+      <figure anchor="literal-id">
       <artwork align="left" name="filename" alt="alt_text">
         Literal contents.
       </artwork>
@@ -50,11 +50,11 @@ describe Asciidoctor::RFC::V2::Converter do
       </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]