asciidoctor-rfc 0.1.0 → 0.2.0

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

@@ -0,0 +1,33 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders keywords" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, 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 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"/>
+      <keyword>first_keyword</keyword>
+      <keyword>second_keyword</keyword>
+      </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/link_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders links" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+      :link: http://www.example.com,urn:issn:99999999 item
+
+      == 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">
+      <link href="http://www.example.com"/>
+      <link href="urn:issn:99999999" rel="item"/>
+      <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
+end

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

@@ -0,0 +1,59 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders a listing block with source attribute, ignoring listing content" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[literal-id]]
+      .filename.rb
+      [source,ruby,src=http://example.com/ruby.rb]
+      ----
+      def listing(node)
+        result = []
+        result << "<figure>" if node.parent.context != :example
+      end
+      ----
+    INPUT
+      <figure>
+      <sourcecode anchor="literal-id" name="filename.rb" type="ruby" src="http://example.com/ruby.rb">
+      </sourcecode>
+      </figure>
+    OUTPUT
+  end
+
+  it "renders a listing block without source attribute" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[literal-id]]
+      .filename.rb
+      [source,ruby]
+      ----
+      def listing(node)
+        result = []
+        result << "<figure>" if node.parent.context != :example
+      end
+      ----
+    INPUT
+      <figure>
+      <sourcecode anchor="literal-id" name="filename.rb" type="ruby">
+      def listing(node)
+        result = []
+        result &lt;&lt; "&lt;figure&gt;" if node.parent.context != :example
+      end
+      </sourcecode>
+      </figure>
+    OUTPUT
+  end
+
+  it "renders a listing paragraph" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [listing]
+      This is an example of a paragraph styled with `listing`.
+      Notice that the monospace markup is preserved in the output.
+    INPUT
+      <figure>
+      <sourcecode>
+      This is an example of a paragraph styled with `listing`.
+      Notice that the monospace markup is preserved in the output.
+      </sourcecode>
+      </figure>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,51 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders a listing" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[literal-id]]
+      .filename
+      [align=left,alt=alt_text]
+      ....
+        Literal contents.
+      ....
+    INPUT
+      <figure>
+      <artwork anchor="literal-id" align="left" name="filename" type="ascii-art" alt="alt_text">
+        Literal contents.
+      </artwork>
+      </figure>
+    OUTPUT
+  end
+  it "ignores callouts" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      [[literal-id]]
+      .filename
+      [align=left,alt=alt_text]
+      ....
+        Literal contents.
+      ....
+      <1> This is a callout
+    INPUT
+      <figure>
+      <artwork anchor="literal-id" align="left" name="filename" type="ascii-art" alt="alt_text">
+        Literal contents.
+      </artwork>
+      </figure>
+    OUTPUT
+  end
+  it "renders stem as a literal" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      :stem:
+      [stem]
+      ++++
+      sqrt(4) = 2
+      ++++
+    INPUT
+      <figure>
+      <artwork type="ascii-art">
+      sqrt(4) = 2
+      </artwork>
+      </figure>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,168 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders an ordered list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      [[id]]
+      [start=3,group=5,arabic,spacing=compact]
+      . First
+      . Second
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <ol anchor="id" spacing="compact" start="3" group="5" type="1">
+      <li>First</li>
+      <li>Second</li>
+      </ol>
+      </section>
+    OUTPUT
+  end
+  it "ignores anchors on list items" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      [[id]]
+      [start=3,group=5,arabic,spacing=compact]
+      . First
+      . [[id1]] Second
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <ol anchor="id" spacing="compact" start="3" group="5" type="1">
+      <li>First</li>
+      <li>Second</li>
+      </ol>
+      </section>
+    OUTPUT
+  end
+  it "renders an ordered list with custom style" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      [format="#%d"]
+      . First
+      . Second
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <ol type="#%d">
+      <li>First</li>
+      <li>Second</li>
+      </ol>
+      </section>
+    OUTPUT
+  end
+  it "renders a nested ordered list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      [[id]]
+      [loweralpha]
+      . First
+      . Second
+      [upperalpha]
+      .. Third
+      .. Fourth
+      . Fifth
+      . Sixth
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <ol anchor="id" type="a">
+      <li>First</li>
+      <li><t>Second</t>
+      <ol type="A">
+      <li>Third</li>
+      <li>Fourth</li>
+      </ol>
+      </li>
+      <li>Fifth</li>
+      <li>Sixth</li>
+      </ol>
+      </section>
+    OUTPUT
+  end
+  it "renders a nested ordered/unordered list" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      [[id]]
+      [lowerroman]
+      . First
+      . Second
+      ** Third
+      ** Fourth
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <ol anchor="id" type="i">
+      <li>First</li>
+      <li><t>Second</t>
+      <ul>
+      <li>Third</li>
+      <li>Fourth</li>
+      </ul>
+      </li>
+      </ol>
+      </section>
+    OUTPUT
+  end
+  it "renders decimal lists as arabic" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      [[id]]
+      [decimal]
+      . First
+      . Second
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <ol anchor="id" type="1">
+      <li>First</li>
+      <li>Second</li>
+      </ol>
+      </section>
+    OUTPUT
+  end
+  it "renders lowergreek lists as arabic" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :docName:
+      Author
+
+      == Section 1
+      [[id]]
+      [lowergreek]
+      . First
+      . Second
+    INPUT
+      <section anchor="_section_1" numbered="false">
+      <name>Section 1</name>
+      <ol anchor="id" type="1">
+      <li>First</li>
+      <li>Second</li>
+      </ol>
+      </section>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,73 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders a paragraph" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Section 1
+      [[id]]
+      [keep-with-next=true, keep-with-previous=true, foo=bar]
+      Lorem ipsum.
+    INPUT
+      <section anchor="_section_1" numbered="false">
+        <name>Section 1</name>
+        <t anchor="id" keepWithNext="true" keepWithPrevious="true">Lorem ipsum.</t>
+      </section>
+    OUTPUT
+  end
+
+  it "suppresses smart apostrophes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      :smart-quotes: false
+      Author
+
+      == Dante's Revenge
+      Don't panic!
+    INPUT
+      <?xml version="1.0" encoding="US-ASCII"?>
+       <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+       <?rfc strict="yes"?>
+       <?rfc toc="yes"?>
+       <?rfc tocdepth="4"?>
+       <?rfc symrefs=""?>
+       <?rfc sortrefs=""?>
+       <?rfc compact="yes"?>
+       <?rfc subcompact="no"?>
+       <rfc submissionType="IETF" prepTime="2000-01-01T05:00:00Z" version="3">
+       <front>
+         <title abbrev="abbrev_value">Document title</title>
+         <author fullname="Author"/>
+         <date day="1" month="January" year="2000"/>
+
+       </front><middle>
+      <section anchor="_dante_s_revenge" numbered="false">
+        <name>Dante's Revenge</name>
+      <t>Don't panic!</t>
+      </section>
+      </rfc>
+    OUTPUT
+  end
+
+  it "allows smart apostrophes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      == Dante's Revenge
+      Don't panic!
+    INPUT
+      <section anchor="_dante_s_revenge" numbered="false">
+        <name>Dante&#8217;s Revenge</name>
+        <t>Don&#8217;t panic!</t>
+      </section>
+    OUTPUT
+  end
+end

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

@@ -0,0 +1,112 @@
+require "spec_helper"
+describe Asciidoctor::RFC::V3::Converter do
+  it "renders no abstract if preamble has no content" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :docName:
+
+      == Lorem
+      Ipsum.
+    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="_lorem" numbered="false">
+      <name>Lorem</name>
+      <t>Ipsum.</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "renders preamble contents as abstract" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :docName:
+
+      Preamble content.
+
+      More Preamble content.
+
+      == Lorem
+      Ipsum.
+    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"/>
+      <abstract>
+      <t>Preamble content.</t>
+      <t>More Preamble content.</t>
+      </abstract>
+      </front><middle>
+      <section anchor="_lorem" numbered="false">
+      <name>Lorem</name>
+      <t>Ipsum.</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+  it "renders admonitions in preamble as notes" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      Author
+      :docName:
+
+      NOTE: This is a note.
+
+      [NOTE,remove-in-rfc=true]
+      .Title of Note
+      ====
+      This is another note.
+      ====
+
+      == Lorem
+      Ipsum.
+    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"/>
+      <note>
+      <t>
+      This is a note.
+      </t>
+      </note>
+      <note removeInRFC="true">
+      <name>Title of Note</name>
+      <t>This is another note.</t>
+      </note>
+      </front><middle>
+      <section anchor="_lorem" numbered="false">
+      <name>Lorem</name>
+      <t>Ipsum.</t>
+      </section>
+      </middle>
+      </rfc>
+    OUTPUT
+  end
+end