metanorma-iso 1.5.10 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcacb0045dc41c1bd31e2623205d83815c60dc4e020bbe6c0485ee0abd2f24d6
-  data.tar.gz: 795cf80c9d0c18c0aebfeff25f7e919c790b47fbf3352746e5f28cf90701a728
+  metadata.gz: c9ff94c61e35de46dc7952d37bfff144de3138445e1deac3634627a2fa6f7a6a
+  data.tar.gz: 053100705b2af0c4d3d26359948fa8ba23f811010b2096475664ee5b44c0d3dc
 SHA512:
-  metadata.gz: 72ebb4928526e51d726f697c99798f2375f3e26c34b7e641e463a074a9d467a3e94e4d60c68a129ac71552e7826a757af0f20c871aefe5f7b27a2f21e0e17b74
-  data.tar.gz: 8507e683e4534458a8a3af9908862608e6e07675b2c6cdd9f29788b84ef36b3456fb4a859c33efd8a89f1f91206b2bc6e3dd00ef281ffbcebe8cad5599d08fe7
+  metadata.gz: a093a518a812e1fea3f5053f287b589010fc896954ff6da4a9674c72c4d0db566095ba0702ac85b6ba519f23e2d0a09d8697d984c998dbda6759698c6075726c
+  data.tar.gz: 45b6dcdb5783272457a495e8c4f2ea2a3c4fab3114d48a8c7d6917782db82f3ee573af34c903fd07cda28447373721dd7cdb83c519bca9ae74208f4f9a77bd8c

data/.github/workflows/rake.yml

@@ -0,0 +1,66 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main  ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - name: install plantuml ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        uses: nick-invision/retry@v1
+        with:
+          polling_interval_seconds: 5
+          timeout_minutes: 5
+          max_attempts: 3
+          command: >
+            sudo apt-get update -y && sudo bash -c 
+            "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
+
+      - if: matrix.os == 'macos-latest'
+        run: brew install plantuml
+
+      - if: matrix.os == 'windows-latest'
+        run: cinst -y plantuml
+
+      - run: bundle exec rake

data/README.adoc

@@ -1,22 +1,18 @@
 = Metanorma-ISO: Metanorma processor for ISO standards
 
 image:https://img.shields.io/gem/v/metanorma-iso.svg["Gem Version", link="https://rubygems.org/gems/metanorma-iso"]
-image:https://github.com/metanorma/metanorma-iso/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-iso/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-iso/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-iso/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-iso/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-iso/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-iso/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-iso/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-iso/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-iso"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-iso.svg["Pull Requests", link="https://github.com/metanorma/metanorma-iso/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-iso/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-iso/releases"]
 
-_Formerly known as_ `asciidoctor-iso`.
-
 == Functionality and Approach
 
 For the conceptual underpinnings of this gem, and the other gems in the Metanorma suite, see the https://github.com/metanorma/metanorma-model-standoc/blob/master/README.adoc[metanorma-standoc README].
 
 == Outputs
 
-This gem processes Metanorma documents following a template for generating ISO
+This gem processes https://www.metanorma.com[Metanorma documents] following a template for generating ISO
 International Standards. The following outputs are generated.
 
 * The XML representation of the document, intended as a document model for ISO
@@ -79,3 +75,6 @@ See https://www.metanorma.com/author/iso/[The ISO flavor of Metanorma].
 * Example documents are avalable at the https://github.com/metanorma/mn-samples-iso[mn-samples-iso] repository.
 * Document templates are available at the https://github.com/metanorma/mn-templates-iso[mn-templates-iso] repository.
 
+== Notes
+
+Metanorma-ISO was formerly published as `asciidoctor-iso`.

data/lib/asciidoctor/iso/base.rb

@@ -5,7 +5,6 @@ require "pathname"
 require "open-uri"
 require "isodoc"
 require "fileutils"
-require 'asciidoctor/iso/macros'
 
 module Asciidoctor
   module ISO
@@ -13,10 +12,6 @@ module Asciidoctor
       XML_ROOT_TAG = "iso-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/iso".freeze
 
-      Asciidoctor::Extensions.register do
-        inline_macro Asciidoctor::Iso::TermRefInlineMacro
-      end
-
       def html_converter(node)
         IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node))
       end
@@ -49,6 +44,11 @@ module Asciidoctor
         @amd = %w(amendment technical-corrigendum).include? doctype(node)
       end
 
+       def ol_attrs(node)
+        attr_code(keep_attrs(node).
+                  merge(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node)))
+      end
+
       def outputs(node, ret)
           File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
           presentation_xml_converter(node).convert(@filename + ".xml")

data/lib/asciidoctor/iso/basicdoc.rng

@@ -596,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -728,15 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
     </element>
   </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </element>
+  </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->
   <define name="bookmark">
     <element name="bookmark">

data/lib/asciidoctor/iso/boilerplate-fr.xml

@@ -0,0 +1,40 @@
+<boilerplate>
+  <copyright-statement>
+    <clause>
+      <title>DOCUMENT PROTÉGÉ PAR COPYRIGHT</title>
+    <p id="boilerplate-year">&copy; {{ agency }} {{ docyear }}</p>
+
+  <p id="boilerplate-message">
+Droits de reproduction réservés. Sauf indication contraire, aucune partie de cette publication ne
+peut être reproduite ni utilisée sous quelque forme que ce soit et par aucun procédé, électronique
+ou mécanique, y compris la photocopie, l’affichage sur l’internet ou sur un Intranet, sans
+autorisation écrite préalable. Les demandes d’autorisation peuvent être adressées à l’ISO à
+l’adresse ci-après ou au comité membre de l’ISO dans le pays du demandeur.
+  </p>
+
+  <p id="boilerplate-address" align="left">
+    ISO copyright office<br/>
+    Ch. de Blandonnet 8 &#x2022; CP 401<br/>
+    CH-1214 Vernier, Geneva, Switzerland<br/>
+    Tel.&nbsp;&nbsp;+ 41 22 749 01 11<br/>
+    Fax&nbsp;&nbsp;+ 41 22 749 09 47<br/>
+    Email: copyright@iso.org<br/>
+    Website: www.iso.org
+  </p>
+    <p id="boilerplate-place">
+    Publié en Suisse
+  </p>
+</clause>
+  </copyright-statement>
+
+  {% if unpublished %}
+  <license-statement>
+    <clause>
+<title>Avertissement</title>
+
+<p>Ce document n'est pas une Norme internationale de l'ISO. Il est distribué pour examen et observations. Il est susceptible de modification sans préavis et ne peut être cité comme Norme internationale.</p>
+<p>Les destinataires du présent projet sont invités à présenter, avec leurs observations, notification des droits de propriété dont ils auraient éventuellement connaissance et à fournir une documentation explicative.</p>
+</clause>
+  </license-statement>
+{% endif %}
+</boilerplate>

data/lib/asciidoctor/iso/boilerplate.xml

@@ -1,6 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
+      <title>COPYRIGHT PROTECTED DOCUMENT</title>
     <p id="boilerplate-year">
     &copy; {{ agency }} {{ docyear }}
   </p>

data/lib/asciidoctor/iso/cleanup.rb

@@ -4,7 +4,6 @@ require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
-require "asciidoctor/iso/term_lookup_cleanup"
 
 module Asciidoctor
   module ISO
@@ -89,11 +88,6 @@ module Asciidoctor
         end
       end
 
-      def termdef_cleanup(xmldoc)
-        Asciidoctor::ISO::TermLookupCleanup.new(xmldoc, @log).call
-        super
-      end
-
       # TODO sort by authors
       # sort by: doc class (ISO, IEC, other standard (not DOI &c), other
       # then standard class (docid class other than DOI &c)
@@ -124,6 +118,44 @@ module Asciidoctor
           h.delete('inline-header')
         end
       end
+
+      def boilerplate_file(xmldoc)
+        file = @lang == "fr" ? "boilerplate-fr.xml" : "boilerplate.xml"
+        File.join(@libdir, file)
+      end
+
+      def footnote_cleanup(xmldoc)
+        unpub_footnotes(xmldoc)
+        super
+      end
+
+      def unpub_footnotes(xmldoc)
+        xmldoc.xpath("//bibitem/note[@type = 'Unpublished-Status']").each do |n|
+          id = n.parent["id"]
+          e = xmldoc.at("//eref[@bibitemid = '#{id}']") or next
+          e.next = n.dup
+          e.next.name = "fn"
+          e.next.delete("format")
+          e.next.delete("type")
+        end
+      end
+
+      def bibitem_cleanup(xmldoc)
+        super
+        unpublished_note(xmldoc)
+      end
+
+      def unpublished_note(xmldoc)
+        xmldoc.xpath("//bibitem[not(note[@type = 'Unpublished-Status'])]").each do |b|
+          next if pub_class(b) > 2
+          next unless s = b.at("./status/stage") and s.text.to_i < 60
+          id = b.at("docidentifier").text
+          b.at("./language | ./script | ./abstract | ./status").previous = <<~NOTE
+          <note type="Unpublished-Status">
+            <p>#{@i18n.under_preparation.sub(/%/, id)}</p></note>
+          NOTE
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/iso/front.rb

@@ -18,6 +18,11 @@ module Asciidoctor
           xml.updates_document_type a
       end
 
+      def metadata_doctype(node, xml)
+        xml.doctype doctype(node)
+        a = node.attr("horizontal") and xml.horizontal a
+      end
+
       def org_abbrev
         { "International Organization for Standardization" => "ISO",
           "International Electrotechnical Commission" => "IEC" }

data/lib/asciidoctor/iso/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -47,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -141,6 +156,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -233,6 +253,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +774,18 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -1164,49 +1199,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">