asciidoctor-iso 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 58f094fee040fe809c10907c121a5f57a49eb298
-  data.tar.gz: ab697dc58b43802eaa4a8b7ed684a7230c7dac75
+  metadata.gz: f7daddca4e53f6799078868555fe51888f8ad0dd
+  data.tar.gz: 6d069238f149cc8fdb5e6caa49fc2ca92b35c2ac
 SHA512:
-  metadata.gz: 62485082baccb11b5a2c494f2326972c526ae62a75487e8392a8f79fd1df08392ec61aae09fe37c5830dfc65f1e82d9b382ca572489d2136cea10595be36b17b
-  data.tar.gz: 7d6f0b924bdc4cd14b97e21c73ebb917e3d33485809afee917a09c9d21b331e3848b40e3257f7815140ce360e9ac854050f20609b01ac6fe219e6d59d32e5827
+  metadata.gz: 06dc788c44fbf112301e8fbb91159efaf44e6c87ac7dd7d108c25e5db7e472911d15099a09f30ed37cd02812c10f054fc1ae23b6fdd619500806c706ec29dff0
+  data.tar.gz: 98b8dac9dff88dcb2da02fde81481144729d525f2bc0745a07d0b2cbafe48c7400049af385c8f9584c777e6db3d9c4b9e52e14f612b4728981e08ae07a5e7b67

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/.travis.yml

@@ -2,4 +2,6 @@ sudo: false
 language: ruby
 rvm:
   - 2.4.3
-before_install: gem install bundler -v 1.16.1
+before_install:
+  - gem install bundler -v 1.16.1
+  - unset _JAVA_OPTIONS

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/riboseinc/html2doc.git
-  revision: 3b42789ece0ac0bb3de2c208062aca0feca4f797
+  revision: 06a521ffd8fad90149699ae768040d25bba50cee
   specs:
-    html2doc (0.6.9)
+    html2doc (0.7.0)
       asciimath
       htmlentities (~> 4.3.4)
       image_size
@@ -14,9 +14,9 @@ GIT
 
 GIT
   remote: https://github.com/riboseinc/isodoc.git
-  revision: e84b3385acf7d6eb025d80756080a1610efc43da
+  revision: 951d28f6904f506208af360b2b0e42f7dc0d5d18
   specs:
-    isodoc (0.5.7)
+    isodoc (0.5.8)
       asciimath
       html2doc
       htmlentities (~> 4.3.4)
@@ -46,7 +46,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    asciidoctor (1.5.6.2)
+    asciidoctor (1.5.7)
     asciimath (1.0.4)
     ast (2.4.0)
     byebug (9.1.0)
@@ -72,14 +72,14 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     htmlentities (4.3.4)
-    image_size (1.5.0)
+    image_size (2.0.0)
     json (2.1.0)
     liquid (4.0.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
-    lumberjack (1.0.12)
+    lumberjack (1.0.13)
     method_source (0.9.0)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
@@ -93,14 +93,14 @@ GEM
       shellany (~> 0.0)
     optout (0.0.2)
     parallel (1.12.1)
-    parser (2.5.0.4)
+    parser (2.5.1.0)
       ast (~> 2.4.0)
     powerpack (0.1.1)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rainbow (3.0.0)
-    rake (12.3.0)
+    rake (12.3.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
@@ -118,7 +118,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
-    rubocop (0.53.0)
+    rubocop (0.55.0)
       parallel (~> 1.10)
       parser (>= 2.5)
       powerpack (~> 0.1)
@@ -144,7 +144,7 @@ GEM
     thor (0.20.0)
     thread_safe (0.3.6)
     timecop (0.9.1)
-    unicode-display_width (1.3.0)
+    unicode-display_width (1.3.2)
     uuidtools (2.1.5)
 
 PLATFORMS

data/README.adoc

@@ -345,6 +345,16 @@ example:
 The references cannot contain spaces. Any text following the sequence of localities
 will be displayed instead of the localities.
 
+A custom locality can be entered by prefixing it with `locality:`:
+
+[source,asciidoctor]
+--
+<<ISO712,locality:frontispiece 5, page 8-10>>         # renders as: ISO 712, Frontispiece 5, Page 8-10
+--
+
+Custom localities may not contain commas, colons, or space. Localities with the `locality:`
+prefix are recognised in internationalisation configuration files.
+
 === Additional warning types
 
 Asciidoctor natively supports the ISO admonitions "Caution", "Warning", and "Important"
@@ -644,13 +654,8 @@ used for validation from the generic IsoDoc grammar
 
 The gem has been tested to date against the
 https://www.iso.org/publication/PUB100407.html["Rice document"], the ISO's
-model document of an international standard. This repository includes:
-
-* the link:spec/examples/rice.adoc[AsciiISO version of the Rice document].
-* the link:spec/examples/rice.preview.html[AsciiISO rendering of the Rice document as an HTML preview] 
-(native Asciidoc rendering)
-* the link:spec/examples/rice.xml[ISO XML rendering of the Rice document].
-* the link:spec/examples/rice.doc[Word .doc rendering of the Rice document].
-* the link:spec/examples/rice.html[HTML rendering of the Rice document].
+model document of an international standard. Sample representation of the Rice document
+in Asciidoctor, and output formats, are included in the https://github.com/riboseinc/isodoc-rice
+repository.
 
 See also `link:spec/asciidoctor-iso[]` for individual features.

data/lib/asciidoctor/iso/base.rb

@@ -38,6 +38,7 @@ module Asciidoctor
         engine = Sass::Engine.new(@fontheader + stylesheet, syntax: :scss)
         outname = File.basename(filename, ".*") + ".css"
         File.open(outname, "w") { |f| f.write(engine.render) }
+        @files_to_delete << outname
         outname
       end
 
@@ -72,6 +73,7 @@ module Asciidoctor
         @draft = node.attributes.has_key?("draft")
         @novalid = node.attr("novalid")
         @fontheader = default_fonts(node)
+        @files_to_delete = []
       end
 
       def default_fonts(node)
@@ -94,6 +96,7 @@ module Asciidoctor
         File.open(filename, "w") { |f| f.write(ret) }
         html_converter(node).convert filename unless node.attr("nodoc")
         doc_converter(node).convert filename unless node.attr("nodoc")
+        @files_to_delete.each { |f| system "rm #{f}" }
         ret
       end
 

data/lib/asciidoctor/iso/biblio.rng

@@ -20,7 +20,7 @@
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <define name="status">
     <element name="status">
-      <ref name="FormattedString"/>
+      <ref name="LocalizedString"/>
     </element>
   </define>
   <define name="language">
@@ -346,21 +346,9 @@
   </define>
   <define name="locality">
     <element name="locality">
+      <!-- attribute type { ( "section" | "clause" | "part" | "paragraph" | "chapter" | "page" | "whole" | "table" | "annex" | "figure" | "note" | "example" | ("locality:", text) ) }, -->
       <attribute name="type">
-        <choice>
-          <value>section</value>
-          <value>clause</value>
-          <value>part</value>
-          <value>paragraph</value>
-          <value>chapter</value>
-          <value>page</value>
-          <value>whole</value>
-          <value>table</value>
-          <value>annex</value>
-          <value>figure</value>
-          <value>note</value>
-          <value>example</value>
-        </choice>
+        <ref name="LocalityType"/>
       </attribute>
       <ref name="referenceFrom"/>
       <optional>
@@ -368,6 +356,11 @@
       </optional>
     </element>
   </define>
+  <define name="LocalityType">
+    <data type="string">
+      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|example|locality:[a-zA-Z0-9_]+</param>
+    </data>
+  </define>
   <define name="referenceFrom">
     <element name="referenceFrom">
       <text/>
@@ -420,7 +413,7 @@
       <ref name="formattedref"/>
     </choice>
     <zeroOrMore>
-      <ref name="source"/>
+      <ref name="bsource"/>
     </zeroOrMore>
     <zeroOrMore>
       <ref name="docidentifier"/>
@@ -437,9 +430,6 @@
     <zeroOrMore>
       <ref name="biblionote"/>
     </zeroOrMore>
-    <zeroOrMore>
-      <ref name="partof"/>
-    </zeroOrMore>
     <zeroOrMore>
       <ref name="language"/>
     </zeroOrMore>
@@ -464,6 +454,11 @@
       <ref name="FormattedString"/>
     </element>
   </define>
+  <define name="bsource">
+    <element name="source">
+      <ref name="TypedUri"/>
+    </element>
+  </define>
   <define name="formattedref">
     <element name="formattedref">
       <ref name="FormattedString"/>
@@ -487,8 +482,11 @@
           <value>published</value>
           <value>accessed</value>
           <value>created</value>
-          <value>activated</value>
+          <value>implemented</value>
           <value>obsoleted</value>
+          <value>confirmed</value>
+          <value>updated</value>
+          <value>issued</value>
         </choice>
       </attribute>
       <ref name="bfrom"/>
@@ -531,11 +529,6 @@
       <ref name="FormattedString"/>
     </element>
   </define>
-  <define name="partof">
-    <element name="partof">
-      <ref name="BibliographicItem"/>
-    </element>
-  </define>
   <define name="copyright">
     <element name="copyright">
       <ref name="from"/>
@@ -560,6 +553,31 @@
       <ref name="ContributorInfo"/>
     </element>
   </define>
+  <define name="docrelation">
+    <element name="relation">
+      <attribute name="type">
+        <choice>
+          <value>parent</value>
+          <value>child</value>
+          <value>obsoletes</value>
+          <value>updates</value>
+          <value>updatedBy</value>
+          <value>complements</value>
+          <value>derivedFrom</value>
+          <value>adoptedFrom</value>
+          <value>equivalent</value>
+          <value>identical</value>
+          <value>nonequivalent</value>
+        </choice>
+      </attribute>
+      <element name="bibitem">
+        <ref name="BibliographicItem"/>
+      </element>
+      <zeroOrMore>
+        <ref name="locality"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <!--
     Anycontents = mixed {
     https://github.com/relaxng/jing-trang/issues/211

data/lib/asciidoctor/iso/blocks.rb

@@ -35,11 +35,11 @@ module Asciidoctor
 
       def sidebar_attrs(node)
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
-        date += "T0000" unless /T/.match? date
+        date += "T00:00:00Z" unless /T/.match? date
         {
           reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
           id: Utils::anchor_or_uuid(node),
-          date: date.gsub(/[:-]/, ""),
+          date: date,
           from: node.attr("from"),
           to: node.attr("to") || node.attr("from"),
         }

data/lib/asciidoctor/iso/cleanup.rb

@@ -15,9 +15,9 @@ module Asciidoctor
       end
 
       def cleanup(xmldoc)
+        termdef_cleanup(xmldoc)
         sections_cleanup(xmldoc)
         obligations_cleanup(xmldoc)
-        termdef_cleanup(xmldoc)
         table_cleanup(xmldoc)
         formula_cleanup(xmldoc)
         figure_cleanup(xmldoc)
@@ -128,14 +128,14 @@ module Asciidoctor
         xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
       end
 
-      def termdef_subsection_cleanup(xmldoc)
+      def termdef_subclause_cleanup(xmldoc)
         xmldoc.xpath("//terms[terms]").each do |t|
           t.name = "clause"
         end
       end
 
       def termdocsource_cleanup(xmldoc)
-        f = xmldoc.at("//foreword")
+        f = xmldoc.at("//preface | //sections")
         xmldoc.xpath("//terms/termdocsource").each do |s|
           f.previous = s.remove
         end
@@ -147,7 +147,7 @@ module Asciidoctor
         termdomain_cleanup(xmldoc)
         termdefinition_cleanup(xmldoc)
         termdef_boilerplate_cleanup(xmldoc)
-        termdef_subsection_cleanup(xmldoc)
+        termdef_subclause_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc)
       end
 

data/lib/asciidoctor/iso/cleanup_block.rb

@@ -110,13 +110,27 @@ module Asciidoctor
         subfigure_cleanup(xmldoc)
       end
 
+      def make_preface(x, s)
+        if x.at("//foreword | //introduction")
+          preface = s.add_previous_sibling("<preface/>").first
+          foreword = x.at("//foreword")
+          preface.add_child foreword.remove if foreword
+          introduction = x.at("//introduction")
+          preface.add_child introduction.remove if introduction
+        end
+      end
+
+      def make_bibliography(x, s)
+        if x.at("//sections/references")
+          biblio = s.add_next_sibling("<bibliography/>").first
+          x.xpath("//sections/references").each { |r| biblio.add_child r.remove }
+        end
+      end
+
       def sections_cleanup(x)
         s = x.at("//sections")
-        foreword = x.at("//foreword")
-        s.previous = foreword.remove if foreword
-        introduction = x.at("//introduction")
-        s.previous = introduction.remove if introduction
-        x.xpath("//sections/references").reverse_each { |r| s.next = r.remove }
+        make_preface(x, s)
+        make_bibliography(x, s)
         x.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
       end
 
@@ -144,7 +158,7 @@ module Asciidoctor
         x.xpath("//annex | //clause").each do |r|
           r["obligation"] = "normative" unless r["obligation"]
         end
-        x.xpath("//subsection").each do |r|
+        x.xpath(Utils::SUBCLAUSE_XPATH).each do |r|
           r["obligation"] = r.at("./ancestor::*/@obligation").text
         end
       end

data/lib/asciidoctor/iso/cleanup_ref.rb

@@ -5,9 +5,10 @@ module Asciidoctor
       # extending localities to cover ISO referencing
       LOCALITY_REGEX_STR = <<~REGEXP.freeze
         ^((?<locality>section|clause|part|paragraph|chapter|page|
-                      table|annex|figure|example|note|formula)\\s+
+                      table|annex|figure|example|note|formula|
+                      locality:[^ \\t\\n\\r:,]+)\\s+
                (?<ref>[^ \\t\\n,:-]+)(-(?<to>[^ \\t\\n,:-]+))?|
-          (?<locality>whole))[,:]?\\s*
+          (?<locality2>whole|locality:[^ \\t\\n\\r:,]+))[,:]?\\s*
          (?<text>.*)$
       REGEXP
       LOCALITY_RE = Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
@@ -18,8 +19,8 @@ module Asciidoctor
         while (m = LOCALITY_RE.match text)
           ref = m[:ref] ? "<referenceFrom>#{m[:ref]}</referenceFrom>" : ""
           refto = m[:to] ? "<referenceTo>#{m[:to]}</referenceTo>" : ""
-          x.add_child("<locality type='#{m[:locality].downcase}'>"\
-                      "#{ref}#{refto}</locality>")
+          loc = m[:locality]&.downcase || m[:locality2]&.downcase
+          x.add_child("<locality type='#{loc}'>#{ref}#{refto}</locality>")
           text = m[:text]
         end
         x.add_child(text)