metanorma-iso 1.5.7 → 1.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4e243a2452352cf57ead226a133917dfd0cd0d7f618109e07355777ac10354b
-  data.tar.gz: d7a8f18735dce09f5fdb1f8be436b7314f265a508ca5c4e878e1ae6c28f4df39
+  metadata.gz: 8fa41b9ff5a061ea7bf8428ec4cd1a692867c877462f4fd1b7bf1ae1b0dd2a9f
+  data.tar.gz: 7e99d7041d2a295b48057be5ea7505ce05be4b40739ce4ffa3ffc4b94149aabc
 SHA512:
-  metadata.gz: fa1a2af192f51f4cda4a52b85b8a83aec9656fe36f890fd4e322d13e9d8db4587be47bbbb0b56b1680af139a1c3582d3a0304160517f5c582fb2f937791fa621
-  data.tar.gz: ba1a5714584f972567677d83ca2ffc7326b3f86319e9cc4bdfd458ed1d5fa6e09bf4fa0b175c9c0c035537a9d9d1090e3c5f6cbaeb70bd963b055f9da18ff872
+  metadata.gz: e7ee3745f439ae3aae5664e6440aed30d94f5e02b4691754fc39cc8ed58fa9bd8e8b80063d9d7889c4e36e8edc9e056f1bef761f471af4742bab8d8465d6a8d7
+  data.tar.gz: a8f78935bf25b08a0cf56872384d0dcabd71d7ea8e996bf87d54db1f7045811b6e064953773b93d0d4f560a38f4fff16b4efd96814f01ac1eefbd4ae4e214d04

data/.github/workflows/macos.yml

@@ -29,9 +29,17 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+      - name: Cache gems
+        uses: actions/cache@preview
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
       - name: Update gems
         run: |
-          sudo gem install bundler --force
+          gem install bundler
+          bundle config --local path vendor/bundle
           bundle install --jobs 4 --retry 3
       - name: Install PlantUML
         run: |

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@v1
+        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/.github/workflows/ubuntu.yml

@@ -29,9 +29,17 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+      - name: Cache gems
+        uses: actions/cache@preview
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
       - name: Update gems
         run: |
           gem install bundler
+          bundle config --local path vendor/bundle
           bundle install --jobs 4 --retry 3
       - name: Install PlantUML
         uses: nick-invision/retry@v1

data/.github/workflows/windows.yml

@@ -29,6 +29,13 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+      - name: Cache gems
+        uses: actions/cache@preview
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-${{ matrix.ruby }}-gem-${{ hashFiles('Gemfile') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.ruby }}-gem-
       - name: Update gems
         shell: pwsh
         run: |

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/basicdoc.rng

@@ -158,17 +158,7 @@
         <data type="ID"/>
       </attribute>
       <oneOrMore>
-        <choice>
-          <ref name="formula"/>
-          <ref name="ul"/>
-          <ref name="ol"/>
-          <ref name="dl"/>
-          <ref name="quote"/>
-          <ref name="sourcecode"/>
-          <ref name="paragraph"/>
-          <ref name="table"/>
-          <ref name="figure"/>
-        </choice>
+        <ref name="paragraph"/>
       </oneOrMore>
     </element>
   </define>
@@ -1028,6 +1018,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

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

@@ -124,6 +124,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,18 +18,9 @@ module Asciidoctor
           xml.updates_document_type a
       end
 
-      def organization(org, orgname)
-        if ["ISO",
-            "International Organization for Standardization"].include? orgname
-          org.name "International Organization for Standardization"
-          org.abbreviation "ISO"
-        elsif ["IEC",
-               "International Electrotechnical Commission"].include? orgname
-          org.name "International Electrotechnical Commission"
-          org.abbreviation "IEC"
-        else
-          org.name orgname
-        end
+      def org_abbrev
+        { "International Organization for Standardization" => "ISO",
+          "International Electrotechnical Commission" => "IEC" }
       end
 
       def metadata_author(node, xml)
@@ -37,7 +28,7 @@ module Asciidoctor
         csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
-            c.organization { |a| organization(a, p) }
+            c.organization { |a| organization(a, p, node, !node.attr("publisher")) }
           end
         end
       end
@@ -47,7 +38,7 @@ module Asciidoctor
         csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "publisher" }
-            c.organization { |a| organization(a, p) }
+            c.organization { |a| organization(a, p, node, !node.attr("publisher")) }
           end
         end
       end
@@ -58,7 +49,10 @@ module Asciidoctor
           xml.copyright do |c|
             c.from (node.attr("copyright-year") || Date.today.year)
             c.owner do |owner|
-              owner.organization { |o| organization(o, p) }
+              owner.organization do |o|
+                organization(o, p, node,
+                             !(node.attr("copyright-holder") || node.attr("publisher")))
+              end
             end
           end
         end

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">
@@ -42,7 +50,6 @@
     </define>
     <define name="xref">
       <element name="xref">
-        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
           <data type="string">
             <param name="pattern">\i\c*|\c+#\c+</param>
@@ -64,6 +71,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -137,6 +149,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -859,6 +876,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -880,7 +904,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -1153,49 +1177,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">
@@ -1481,11 +1463,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>