asciidoctor-rfc 0.8.3 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5863fe02ba89d28e9da58e35cebe4502982de33
-  data.tar.gz: 2f2b188dbd17dfbe10ec94cf9fdf3133d5e07af5
+  metadata.gz: '0870e860045d4a8c9d597097567e671c1fa5a6c9'
+  data.tar.gz: 7583fa0df0d6ba3c320d4eae8aadcd5e7abdd5bf
 SHA512:
-  metadata.gz: 4a02f95152d0448df4363d6c77562db8044b70bb9e33612a78903ade801f371f3b1013efc630ef05b3b88f4287d3ddd1a42d634562a95ac33e756edf250576a7
-  data.tar.gz: eec672a895df5026b803681f745273ff2e533d59a9e2caa9e4085b180d52f51ad1c7966a2456ca174a05f833d6a918fe0372716f1b0c6852fb9c5b65bb4aa454
+  metadata.gz: 6ed53a096a521ef2424673d95c71e96b4c8256b9863e4517d72201d4f5b669547e5b9b10a066dbf91f5f57dae76d7a7c173eea03f514ad6a74b223aa132ba744
+  data.tar.gz: fe916106d9dba4a87c2bc88bcdbe0c2af403cc34873dce7e2c877d85cd228764f7fac4651bf9ebf77085853197b1bc05f24fea82b399e719ae435700be79028c

data/.rubocop.tb.yml

@@ -352,8 +352,18 @@ Style/TrailingCommaInArguments:
     - no_comma
   Enabled: true
 
-Style/TrailingCommaInLiteral:
-  Description: 'Checks for trailing comma in array and hash literals.'
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  EnforcedStyleForMultiline: comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
   EnforcedStyleForMultiline: comma
   SupportedStylesForMultiline:
@@ -398,6 +408,13 @@ Layout/AlignParameters:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-double-indent'
   Enabled: false
 
+Layout/ConditionPosition:
+  Description: >-
+                 Checks for condition placed in a confusing position relative to
+                 the keyword.
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
+  Enabled: false
+
 Layout/DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains'
@@ -450,13 +467,6 @@ Lint/CircularArgumentReference:
   Description: "Don't refer to the keyword argument in the default value."
   Enabled: false
 
-Lint/ConditionPosition:
-  Description: >-
-                 Checks for condition placed in a confusing position relative to
-                 the keyword.
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#same-line-condition'
-  Enabled: false
-
 Lint/DeprecatedClassMethods:
   Description: 'Check for deprecated class method calls.'
   Enabled: false
@@ -523,7 +533,7 @@ Lint/UnderscorePrefixedVariableName:
   Description: 'Do not use prefix `_` for a variable that is used.'
   Enabled: false
 
-Lint/UnneededDisable:
+Lint/UnneededCopDisableDirective:
   Description: >-
                  Checks for rubocop:disable comments that can be removed.
                  Note: this cop is not disabled when disabling all cops.

data/Gemfile

@@ -7,5 +7,5 @@ group :development, :test do
   gem "rspec-rails", "~> 3.0"
 end
 
-# Specify your gem"s dependencies in ribose.gemspec
+# Specify your gem's dependencies in asciidoctor-rfc.gemspec
 gemspec

data/README.adoc

@@ -884,6 +884,34 @@ Note that fragments (e.g. `crossreference#fragment`) are not supported on the `x
 in either v2 or v3: the RFC XML specification requires that the `xref@target` attribute equals
 the value of an anchor attribute elsewhere in the document.
 
+Internal crossreferences and bibliographic references are marked up in the same way; but
+bibliographic references are marked up separately from the main flow of Asciidoctor, and are
+processed later.
+
+NOTE: Normally, Asciidoctor attempts to match a crossreference to a section title, if it does not find
+a matching anchor ID. This behaviour has become optional as of Asciidoctor 1.5.7, and is suppressed in
+this gem. If you have a citation of a bibliographic item which is identical to a section title (e.g. you have a 
+bibliographic citation with the anchor "WHIRLPOOL", and a section with the title "WHIRLPOOL"),
+this gem will correctly pick the former as the target of the reference, so long as that section
+has a different anchor ID:
+
+[source,asciidoc]
+----
+[[hash_whirlpool]]
+=== WHIRLPOOL
+
+The WHIRLPOOL hash function is defined in <<WHIRLPOOL>>.
+
+This section should actually be referenced as <<hash_whirlpool>>.
+...
+
+[bibliography]
+== Informative References
+++++
+<reference anchor='WHIRLPOOL' target='http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html'>
+...
+++++
+----
 
 === Indexing
 

data/asciidoctor-rfc.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.add_dependency "asciidoctor", "~> 1.5.6"
+  spec.add_dependency "asciidoctor", "~> 1.5.7"
   spec.add_dependency "htmlentities", "~> 4.3.4"
   spec.add_dependency "nokogiri"
   spec.add_dependency "ruby-jing"

data/lib/asciidoctor/rfc/v2/converter.rb

@@ -39,6 +39,7 @@ module Asciidoctor
 
       def initialize(backend, opts)
         super
+        Asciidoctor::Compliance.natural_xrefs = false
         basebackend "html"
         outfilesuffix ".xml"
       end

data/lib/asciidoctor/rfc/v3/converter.rb

@@ -39,6 +39,8 @@ module Asciidoctor
 
       def initialize(backend, opts)
         super
+        # enable when Asciidoctor 1.5.7 is released
+        Asciidoctor::Compliance.natural_xrefs = false
         # basebackend 'html'
         outfilesuffix ".xml"
       end

data/lib/asciidoctor/rfc/version.rb

@@ -1,5 +1,5 @@
 module Asciidoctor
   module RFC
-    VERSION = "0.8.3".freeze
+    VERSION = "0.8.5".freeze
   end
 end

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

@@ -43,7 +43,7 @@ describe Asciidoctor::RFC::V2::Converter do
         <author fullname="Author"/>
         <date day="1" month="January" year="2000"/>
       </front><middle>
-      <section anchor="_dante_s_revenge" title="Dante's Revenge">
+      <section anchor="_dantes_revenge" title="Dante's Revenge">
       <t>Don't panic!</t>
       </section>
       </rfc>
@@ -60,7 +60,7 @@ describe Asciidoctor::RFC::V2::Converter do
       == Dante's Revenge
       Don't panic!
     INPUT
-      <section anchor="_dante_s_revenge" title="Dante&#8217;s Revenge">
+      <section anchor="_dantes_revenge" title="Dante&#8217;s Revenge">
       <t>Don&#8217;t panic!</t>
       </section>
     OUTPUT

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

@@ -290,4 +290,56 @@ describe Asciidoctor::RFC::V2::Converter do
       </rfc>
     OUTPUT
   end
+
+  it "supresses natural cross-references" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc2, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      [[hash_whirlpool]]
+      === WHIRLPOOL
+
+      The WHIRLPOOL hash function is defined in <<WHIRLPOOL>>.
+
+      This section should actually be referenced as <<hash_whirlpool>>.
+      ...
+
+      [bibliography]
+      == Informative References
+      ++++
+      <reference anchor='WHIRLPOOL' target='http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html'>
+      ...
+      ++++
+    INPUT
+    <?xml version="1.0" encoding="US-ASCII"?>
+<?xml-stylesheet type="text/xsl" href="rfc2629.xslt"?>
+<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+<?rfc strict="yes"?>
+<?rfc compact="yes"?>
+<?rfc subcompact="no"?>
+<?rfc toc="yes"?>
+<?rfc tocdepth="4"?>
+<?rfc symrefs="yes"?>
+<?rfc sortrefs="yes"?>
+<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="hash_whirlpool" title="WHIRLPOOL"><t>The WHIRLPOOL hash function is defined in <xref target="WHIRLPOOL"/>.</t>
+       <t>This section should actually be referenced as <xref target="hash_whirlpool"/>.
+       &#8230;&#8203;</t></section>
+       </middle><back>
+       <references title="Informative References">
+         <reference anchor="WHIRLPOOL" target="http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html">
+       ...</reference>
+       </references>
+       </back>
+       </rfc>
+    OUTPUT
+  end
 end

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

@@ -46,7 +46,7 @@ describe Asciidoctor::RFC::V3::Converter do
          <date day="1" month="January" year="2000"/>
 
        </front><middle>
-      <section anchor="_dante_s_revenge" numbered="false">
+      <section anchor="_dantes_revenge" numbered="false">
         <name>Dante's Revenge</name>
       <t>Don't panic!</t>
       </section>
@@ -64,7 +64,7 @@ describe Asciidoctor::RFC::V3::Converter do
       == Dante's Revenge
       Don't panic!
     INPUT
-      <section anchor="_dante_s_revenge" numbered="false">
+      <section anchor="_dantes_revenge" numbered="false">
         <name>Dante&#8217;s Revenge</name>
         <t>Don&#8217;t panic!</t>
       </section>

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

@@ -195,4 +195,57 @@ describe Asciidoctor::RFC::V3::Converter do
       </rfc>
     OUTPUT
   end
+
+  it "supresses natural cross-references" do
+    expect(Asciidoctor.convert(<<~'INPUT', backend: :rfc3, header_footer: true)).to be_equivalent_to <<~'OUTPUT'
+      = Document title
+      :abbrev: abbrev_value
+      :docName:
+      Author
+
+      [[hash_whirlpool]]
+      === WHIRLPOOL
+
+      The WHIRLPOOL hash function is defined in <<WHIRLPOOL>>.
+
+      This section should actually be referenced as <<hash_whirlpool>>.
+      ...
+
+      [bibliography]
+      == Informative References
+      ++++
+      <reference anchor='WHIRLPOOL' target='http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html'>
+      ...
+      ++++
+    INPUT
+    <?xml version="1.0" encoding="US-ASCII"?>
+<?xml-stylesheet type="text/xsl" href="rfc2629.xslt"?>
+<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+<?rfc strict="yes"?>
+<?rfc compact="yes"?>
+<?rfc subcompact="no"?>
+<?rfc toc="yes"?>
+<?rfc tocdepth="4"?>
+<?rfc symrefs="yes"?>
+<?rfc sortrefs="yes"?>
+       <rfc xmlns:xi="http://www.w3.org/2001/XInclude" 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="hash_whirlpool" numbered="false"><name>WHIRLPOOL</name><t>The WHIRLPOOL hash function is defined in <xref target="WHIRLPOOL"/>.</t>
+       <t>This section should actually be referenced as <xref target="hash_whirlpool"/>.
+       &#8230;&#8203;</t></section>
+       </middle><back>
+       <references anchor="_informative_references">
+         <name>Informative References</name>
+         <reference anchor="WHIRLPOOL" target="http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html">
+       ...</reference>
+       </references>
+       </back>
+       </rfc>
+    OUTPUT
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-rfc
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2018-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.5.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 1.5.7
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -254,7 +254,6 @@ files:
 - Guardfile
 - LICENSE
 - README.adoc
-- REQUIREMENTS.adoc
 - Rakefile
 - asciidoctor-rfc.gemspec
 - bin/asciidoctor-rfc2

data/REQUIREMENTS.adoc

@@ -1,36 +0,0 @@
-= Requirements
-
-The aim is to create a new Ruby gem called asciidoctor-rfc that outputs an RFC XML document, as an asciidoctor backend.
-
-RFC XML is defined in these two documents:
-
-* https://tools.ietf.org/html/rfc7749[RFC 7749]
-* https://tools.ietf.org/html/rfc7991[RFC 7991]
-
-This new gem should allow the following work flow:
-
-1. RFC-XML-enabled AsciiDoc (we can call this "`AsciiDoc-RFC`")
-2. Converts to RFC XML via asciidoctor-rfc
-3. RFC XML can convert to TXT or HTML via the tool https://xml2rfc.tools.ietf.org/[`xml2rfc` (v2)]
-4. Round-tripping:
-** from AsciiDoc-RFC to RFC XML, then back to AsciiDoc using https://github.com/riboseinc/rfc2md[`rfc2adoc`]
-
-There are other tools that create XML RFCs, such as https://github.com/miekg/mmark[MMark] which uses Markdown
-(conversely https://github.com/riboseinc/rfc2md[`rfc2md`]).
-
-You will need to define and implement some new asciidoctor commands specifically pertaining to the RFC XML format, such as to support the header fields (author, license, etc.), RFC / Internet Draft citations, etc.
-
-Work needed:
-
-1. Creation of the asciidoctor-rfc gem:
-
-** contains necessary commands to create the RFC XML in v2 and v3 formats
-** output must be acceptable to the `xml2rfc` tool to create TXT and HTML from there
-
-2 Recreate RFC 6350 and RFC 5545 in the new AsciiDoc format
-
-** that can be generated into the same RFC through AsciiDoc-RFC -> RFC XML -> RFC HTML
-
-3. Any bugfixes or minor enhancements on asciidoctor and asciidoctor-pdf:
-
-** Should be done through our GitHub account, submit PR to main repo, follow-up and ensure acceptance to the mainline. Code and PR must be attributed to Ribose Inc.