asciidoctor-rfc 0.1.0 → 0.2.0

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

@@ -0,0 +1,75 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders author, date, area, workgroup, keyword in sequence" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, 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
+               submissionType="IETF" docName="rfc-1111">
+      <front>
+      <title abbrev="abbrev_value">Document title</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="1999"/>
+      <area>horticulture</area>
+      <workgroup>IETF</workgroup>
+      <keyword>widgets</keyword>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+
+         <t>text</t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "deals with entities in titles" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document on the derivation of x & y < z
+      Author
+      :abbrev: deriv x & y < z
+      :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
+               submissionType="IETF" docName="rfc-1111">
+      <front>
+      <title abbrev="deriv x &amp; y &lt; z">Document on the derivation of x &amp; y &lt; z</title>
+      <author fullname="Author"/>
+      <date day="1" month="January" year="1999"/>
+      <area>horticulture</area>
+      <workgroup>IETF</workgroup>
+      <keyword>widgets</keyword>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+
+         <t>text</t>
+
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,81 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders an image with block attributes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      [[id]]
+      .Title
+      [align=center,alt=alt_text,type=img/jpeg]
+      image::http:://www.example/org/filename.jpg[]
+    INPUT
+      <figure>
+      <artwork name="Title" align="center" alt="alt_text" type="img/jpeg" 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]]
+      .Title
+      image::http:://www.example/org/filename.jpg[alt_text,300,200]
+    INPUT
+      <figure>
+      <artwork name="Title" alt="alt_text" src="http:://www.example/org/filename.jpg" width="300" height="200"/>
+      </figure>
+    OUTPUT
+  end
+  it "skips inline images" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      You should click image:play.jpg[Sunset] to continue.
+    INPUT
+      <t>You should click  to continue.</t>
+    OUTPUT
+  end
+  it "skips keyboard shortcuts" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      :experimental:
+      You should click kbd:[F11] to continue.
+    INPUT
+      <t>You should click  to continue.</t>
+    OUTPUT
+  end
+  it "skips menu selections" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      :experimental:
+      You should click menu:View[Zoom > Reset] to continue.
+    INPUT
+      <t>You should click  to continue.</t>
+    OUTPUT
+  end
+  it "skips UI buttons" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      :experimental:
+      You should click btn:[OK] to continue.
+    INPUT
+      <t>You should click  to continue.</t>
+    OUTPUT
+  end
+  it "skips audio" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      Text
+
+      audio::ocean_waves.mp3[options="autoplay,loop"]
+
+      Text
+    INPUT
+      <t>Text</t>
+      <t>Text</t>
+    OUTPUT
+  end
+  it "skips video" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2)).to be_equivalent_to <<~'OUTPUT'
+      Text
+
+      video::video_file.mp4[width=640, start=60, end=140, options=autoplay]
+
+      Text
+    INPUT
+      <t>Text</t>
+      <t>Text</t>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,66 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders index" 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 ((indexterm))
+      is visible in the text,
+      this one is not (((indexterm, index-subterm))).
+    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>This indexterm<iref item="indexterm"/>
+      is visible in the text,
+      this one is not <iref item="indexterm" subitem="index-subterm"/>.</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "does not render tertiary index terms" 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 ((indexterm))
+      is visible in the text,
+      this one with a tertiary term is not (((indexterm, index-subterm, index-subsubterm))).
+    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>This indexterm<iref item="indexterm"/>
+      is visible in the text,
+      this one with a tertiary term is not <iref item="indexterm" subitem="index-subterm"/>.</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,177 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "treats bcp14 macro in v2 as <strong>" 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 [bcp14]#must not# stand
+    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>This <spanx style="strong">MUST NOT</spanx> stand</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "respects Asciidoctor inline formatting" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      _Text_ *Text* `Text` "`Text`" '`Text`' ^Superscript^ ~Subscript~
+    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="emph">Text</spanx> <spanx style="strong">Text</spanx> <spanx style="verb">Text</spanx> &#8220;Text&#8221; &#8216;Text&#8217; ^Superscript^ _Subscript_</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "allows suppression of smart quotes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      :smart-quotes: false
+      Author
+
+      == Section 1
+      "`Text`" '`Text`'
+    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>"Text" 'Text'</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+
+  it "renders stem as literal" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+      :stem:
+
+      == Section 1
+      stem:[sqrt(4) = 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>sqrt(4) = 2</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "deals with non-Ascii characters" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      Hello René! Hello Владимир!
+
+    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>Hello Ren&#233;! Hello &#1042;&#1083;&#1072;&#1076;&#1080;&#1084;&#1080;&#1088;!</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "deals with HTML entities" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      Hello &lt;&nbsp;(&amp;lt;)
+
+      == Section 2
+      Hello &lt;&nbsp;(&amp;lt;)
+    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>Hello &lt;&#160;(&amp;lt;)</t>
+      </section>
+      <section anchor="_section_2" title="Section 2">
+         <t>Hello &lt;&#160;(&amp;lt;)</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,63 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V2::Converter do
+  it "renders keywords" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :keyword: first_keyword, second_keyword
+
+      == 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"/>
+      <keyword>first_keyword</keyword><keyword>second_keyword</keyword>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+
+         <t>text</t>
+
+      </section>
+      </middle>
+      </rfc>
+     OUTPUT
+  end
+  it "deals with entities in keywords" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :keyword: first_keyword & second_keyword
+
+      == 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"/>
+      <keyword>first_keyword &amp; second_keyword</keyword>
+      </front><middle>
+      <section anchor="_section_1" title="Section 1">
+
+         <t>text</t>
+
+      </section>
+      </middle>
+      </rfc>
+     OUTPUT
+  end
+end