metanorma-bipm 0.0.3 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d8436644152700b4a7927bd706cefb128e019ea7592721852bb227df1f3e304
-  data.tar.gz: 72bb82f202b91f9f31ea74718b972b315c1f69d02f66b03f7d52424d6955e274
+  metadata.gz: a0e8acf33a7fceea3050a35b6d104de2a50936c05f29a5e30025cad7fe45c835
+  data.tar.gz: 5a7b43fd90b235369e3aa8456821d121ff994dec4a34e9133bdd1e64c5aea236
 SHA512:
-  metadata.gz: 2e3c3175ef01047372bbcd0f22807d5ac04cb61a87d51c4fc05faf12af40a066c3e8d1ee5a34d31b77f7c66cc2f82f556b214bc365c3e45f49f187726d269332
-  data.tar.gz: 032ceebe7c4688f8c617998b8b3aa2a047be8fb0c8b20914a3d4927d6cfafaa6a26bc1c9cb6ec191233b978721cc3152b2312d8a17daaf29ebc3c2ddb2d75060
+  metadata.gz: 38fed8bc9d7b0b7624d3924d9503d8073fef2fdea8fbb56975642160713d48a053e46073d4ec5a23ca22916cccd6c31d22d0e8a5dc5b9fe62624ecc1fd964adc
+  data.tar.gz: 95b610c7b041e243c14a2c98dfa36aa8647798327b7fff5b8acb5ae6915dc6a0e82a5cdcced4f0b423ae08e351159393e7676f58ebf835a1913a0da4d55846ad

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main  ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,14 +32,34 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
 
-      - name: Update gems
-        run: bundle install --jobs 4 --retry 3
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
 
-      - name: Run specs
-        run: bundle exec rake
+      - 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
+
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          context: 'tests-passed-successfully'
+          description: 'Tests passed successfully'
+          state: 'success'
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/README.adoc

@@ -1,17 +1,14 @@
 = Metanorma for BIPM: Metanorma processor for Bureau International de Poids et Mesures
 
-image:https://img.shields.io/gem/v/metanorma-bimp.sbimp["Gem Version", link="https://rubygems.org/gems/metanorma-bimp"]
-image:https://github.com/metanorma/metanorma-bimp/workflows/macos/badge.sbimp["Build Status (macOS)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-bimp/workflows/ubuntu/badge.sbimp["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-bimp/workflows/windows/badge.sbimp["Build Status (Windows)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=windows"]
-image:https://codeclimate.com/github/metanorma/metanorma-bimp/badges/gpa.sbimp["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-bimp"]
-image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-bimp.sbimp["Pull Requests", link="https://github.com/metanorma/metanorma-bimp/pulls"]
-image:https://img.shields.io/github/commits-since/metanorma/metanorma-bimp/latest.sbimp["Commits since latest",link="https://github.com/metanorma/metanorma-bimp/releases"]
+image:https://img.shields.io/gem/v/metanorma-bipm.svg["Gem Version", link="https://rubygems.org/gems/metanorma-bipm"]
+image:https://github.com/metanorma/metanorma-bipm/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-bipm/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/metanorma-bipm/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-bipm"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-bipm.svg["Pull Requests", link="https://github.com/metanorma/metanorma-bipm/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-bipm/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-bipm/releases"]
 
 == Functionality
 
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
-a template for generating BIPM standards.
+This gem processes https://www.metanorma.com[Metanorma documents] following a template for generating BIPM standards.
 
 == Usage
 
@@ -42,138 +39,10 @@ scripts such as this one. You need only run the following in a Terminal console:
 [source,console]
 ----
 $ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
-$ gem install metanorma-vg
+$ gem install metanorma-bipm
 ----
 
 
-== Document Attributes
-
-The gem relies on Asciidoctor document attributes to provide necessary
-metadata about the document. These include:
-
-`:edition:`:: The document edition
-
-`:revdate:`:: The date the document was last updated
-
-`:title-en:`:: The title of the document in English (mandatory)
-`:title-fr:`:: The title of the document in French (mandatory)
-`:title-cover-en:`:: The title of the front cover of the document in English (where different from the title proper)
-`:title-cover-fr:`:: The title of the front cover of the document in French (where different from the title proper)
-`:title-appendix-en:`:: The title of the appendix in English, if this document is an appendix published separately; `title-en` becomes the title of the main document, as presented within the standalone appendix.
-`:title-appendix-fr:`:: The title of the appendix in English, if this document is an appendix published separately; `title-en` becomes the title of the main document, as presented within the standalone appendix.
-
-`:appendix-id:`:: The number of the appendix, if this document is an appendix published separately
-
-`:si-aspect:`:: The domain of SI covered by the document; used to select logo in PDF cover page. The logo nominates one primary SI base units, and defining consonants for that unit and possibly others as well. The permitted values are:
-+
---
-* A_e_deltanu (ampere; time)
-* A_e (ampere)
-* cd_Kcd_h_deltanu (candela; mass, time)
-* cd_Kcd (candela)
-* full (all units)
-* K_k_deltanu (kelvin; mass, time)
-* K_k (kelvin)
-* kg_h_c_deltanu (kilogram; length, time)
-* kg_h (kilogram)
-* m_c_deltanu (metre; time)
-* m_c (metre)
-* mol_NA (mole)
-* s_deltanu (second)
---
-
-`:copyright-year:`:: The year which will be claimed as when the copyright for
-the document was issued
-
-`:supersedes:`:: One or more BIPM document that this BIPM document standard supersedes; the superseded
-document may still remain in effect. Identified with document identifier. Comma delimited.
-
-`:superseded-by:`:: One or more BIPM document that this BIPM document standard is superseded by; this
-document may still remain in effect. Identified with document identifier. Comma delimited.
-
-`:supersedes-date_{i}:`:: Date of the document draft or version which this document supersedes. 
-Assumes superseded document does not have distinct identifier.
-`:supersedes-draft_{i}:`:: Draft of the document which this document supersedes.
-Assumes superseded document does not have distinct identifier.
-`:supersedes-edition{i}:``:: Version of the document which this document supersedes.
-Assumes superseded document does not have distinct identifier.
-
-`:doctype:`:: The document type (mandatory). The permitted types are:
-+
---
-* brochure (default)
-* mise-en-pratique
-* rapport
-* monographie
-* guide
-* meeting-report
-* technical-report
-* working-party-note
-* strategy
-* cipm-mra
-* resolution
---
-
-`:status:``:: The document status. The permitted types are: `draft-proposal`,
-`draft-development`, `in-force`, `retired`.
-
-`:committee-en:`:: The name of the relevant committee in English (mandatory)
-`:committee-fr:`:: The name of the relevant committee in French (mandatory)
-`:committee-acronym:`:: The acronym of the relevant committee (mandatory)
-+
---
-* CGPM: General Conference on Weights and Measures / Conférence générale des poids et mesures
-* CIPM: International Committee for Weights and Measures / Comité international des poids et mesures
-* BIPM: International Bureau of Weights and Measures / Bureau International des Poids et Mesures
-* CCAUV: Consultative Committee for Acoustics, Ultrasound and Vibration / Comité consultatif de l'acoustique, des ultrasons et des vibrations
-* CCEM: Consultative Committee for Electricity and Magnetism / Comité consultatif d'électricité et magnétisme
-* CCL: Consultative Committee for Length / Comité consultatif des longueurs
-* CCM: Consultative Committee for Mass and Related Quantities / Comité consultatif pour la masse et les grandeurs apparentées
-* CCPR: Consultative Committee for Photometry and Radiometry / Comité consultatif de photométrie et radiométrie
-* CCQM: Consultative Committee for Amount of Substance: Metrology in Chemistry and Biology / Comité consultatif pour la quantité de matière : métrologie en chimie et biologie
-* CCRI: Consultative Committee for Ionizing Radiation / Comité consultatif des rayonnements ionisants
-* CCT: Consultative Committee for Thermometry / Comité consultatif de thermométrie
-* CCTF: Consultative Committee for Time and Frequency / Comité consultatif du temps et des fréquences
-* CCU: Consultative Committee for Units / Comité consultatif des unités
-* CCL-CCTF: Frequency Standards Working Group
-* JCGM: Joint Committee for Guides in Metrology / Comité commun pour les guides en métrologie
-* JCRB: Joint Committee of the Regional Metrology Organizations and the BIPM / Comité mixte des organisations régionales de métrologie et du BIPM
-* JCTLM: Joint Committee for Traceability in Laboratory Medicine / Comité commun pour la traçabilité en médecine de laboratoire
-* INetQI: International Network on Quality Infrastructure 
---
-`:workgroup:`:: The name of the relevant workgroup (mandatory)
-`:workgroup-acronym:`:: The acronym of the relevant workgroup (mandatory)
-
-`:language:` :: The language of the document (`en` or `fr`)  (mandatory)
-
-`:comment-period-from:`:: Start of the period during which comments are allowed on the document draft
-`:comment-period-to:`:: End of the period during which comments are allowed on the document draft (optional)
-
-`:obsoleted-date:`:: The date a document was superseded
-`:implemented-date:`:: The date a document became effective
-
-`:meeting-note:`:: Note on when and where a guide was adopted.
-
-`:role_{i}:`:: If provided and is other than "author" or "editor" (e.g. "WG-N co-chair"),
-is treated as a subclass of "editor".
-
-`:supersedes-date_{i}:`:: Date of the document draft or version which this document supersedes.
-`:supersedes-draft_{i}:`:: Draft of the document which this document supersedes.
-`:supersedes-version_{i}:``:: Version of the document which this document supersedes.
-
-
-The attribute `:draft:`, if present, includes review notes in the XML output;
-these are otherwise suppressed.
-
-== Markup
-
-Cross-references formatted as `<<{{anchor}},pagenumber%>>` are rendered in PDF as just the page number;
-they are used for tables of content. In HTML output, they are treated as normal cross-references.
-
-Clauses and annexes may be marked as `[%unnumbered]`, in which case they do not receive section numbering, and are cross-referenced by their title.
-
-Unlike the Metanorma default, ordered lists do not have a fixed sequence of numbering styles: the type set for each ordered list (including nested lists) is respected. The default numbering style for ordered lists is always arabic.
-
 == Data Models
 
 The document model for BIPM is given in https://github.com/metanorma/metanorma-model-bipm[metanorma-model-bipm].

data/lib/asciidoctor/bipm/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/bipm/bipm.rng

@@ -42,6 +42,16 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="nosee">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="nopage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -209,9 +219,9 @@
         <oneOrMore>
           <ref name="committee"/>
         </oneOrMore>
-        <oneOrMore>
+        <zeroOrMore>
           <ref name="workgroup"/>
-        </oneOrMore>
+        </zeroOrMore>
       </element>
     </define>
     <define name="structuredidentifier">
@@ -333,7 +343,9 @@
       <optional>
         <ref name="boilerplate"/>
       </optional>
-      <ref name="preface"/>
+      <optional>
+        <ref name="preface"/>
+      </optional>
       <oneOrMore>
         <ref name="sections"/>
       </oneOrMore>

data/lib/asciidoctor/bipm/boilerplate-en.xml

@@ -1,7 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-      <p align="center"> © Bureau International des poids et mesures {{ docyear }} all rights reserved</p>
+      <p align="center"> © Bureau International des Poids et Mesures {{ docyear }} all rights reserved</p>
     </clause>
   </copyright-statement>
   <license-statement>
@@ -13,8 +13,7 @@
   <feedback-statement>
     <p>BIPM<br/>
       Pavillon de Breteuil<br/>
-      F-92312 Sèvres<br/>
-      Cedex<br/>
+      F-92312 Sèvres Cedex<br/>
       FRANCE</p>
   </feedback-statement>
 </boilerplate>

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

@@ -1,20 +1,19 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-      <p align="center"> © Bureau International des poids et mesures {{ docyear }} tous droits réservés</p>
+      <p align="center"> © Bureau international des poids et mesures {{ docyear }} tous droits réservés</p>
     </clause>
   </copyright-statement>
   <license-statement>
     <clause>
     <title>Note concernant les droits d’auteur</title>
-    <p>Ce document est distribué selon les termes et conditions de la licence Creative Commons Attribution 4.0 International (<link target="http://creativecommons.org/licenses/by/4.0/"/>), qui permet l’utilisation sans restriction, la distribution et la reproduction sur quelque support que soit, sous réserve de mentionner dûment l’auteur ou les auteurs originaux ainsi que la source de l’œuvre, d’intégrer un lien vers la licence Creative Commons et d’indiquer si des modifications ont été effectuées.</p>
+    <p>Ce document est distribué selon les termes et conditions de la licence Creative Commons Attribution 4.0 International (<link target="http://creativecommons.org/licenses/by/4.0/"/>), qui permet l’utilisation sans restriction, la distribution et la reproduction sur quelque support que soit, sous réserve de mentionner dûment l’auteur ou les auteurs originaux ainsi que la source de l’œuvre, d’intégrer un lien vers la licence Creative Commons et d’indiquer si des modifications ont été effectuées.</p>
   </clause>
   </license-statement>
   <feedback-statement>
     <p>BIPM<br/>
       Pavillon de Breteuil<br/>
-      F-92312 Sèvres<br/>
-      Cedex<br/>
+      F-92312 Sèvres Cedex<br/>
       FRANCE</p>
   </feedback-statement>
 </boilerplate>

data/lib/asciidoctor/bipm/converter.rb

@@ -10,6 +10,18 @@ module Asciidoctor
         Metanorma::BIPM.configuration
       end
 
+      def org_name_long
+        configuration.organization_name_long[@lang]
+      end
+
+      def default_publisher
+        org_name_long
+      end
+
+      def org_abbrev
+          { org_name_long => configuration.organization_name_short }
+      end
+
       def metadata_committee(node, xml)
         return unless node.attr("committee-en") || node.attr("committee-fr")
         xml.editorialgroup do |a|
@@ -32,10 +44,8 @@ module Asciidoctor
         i = 2
         while node.attr("committee-en_#{i}") || node.attr("committee-fr_#{i}")  do
           a.committee **attr_code(acronym: node.attr("committee-acronym_#{i}")) do |c|
-            e = node.attr("committee-en_#{i}") and
-              c.variant e, language: "en", script: "Latn"
-            e = node.attr("committee-fr_#{i}") and
-              c.variant e, language: "fr", script: "Latn"
+            e = node.attr("committee-en_#{i}") and c.variant e, language: "en", script: "Latn"
+            e = node.attr("committee-fr_#{i}") and c.variant e, language: "fr", script: "Latn"
           end
           i += 1
         end
@@ -97,8 +107,9 @@ module Asciidoctor
             t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(
               node.attr("title-#{lang}"))
           end
-          typed_title(node, xml, lang, "cover")
-          typed_title(node, xml, lang, "appendix")
+          %w(cover appendix annex part subpart).each do |w|
+            typed_title(node, xml, lang, w)
+          end
         end
       end
 
@@ -119,11 +130,15 @@ module Asciidoctor
       end
 
       def inline_anchor_xref_attrs(node)
-        if /pagenumber%/.match(node.text)
-          node.text = node.text.sub(/pagenumber%/, "")
-          page = true
+        flags = %w(pagenumber nosee nopage).each_with_object({}) do |w, m|
+          if /#{w}%/.match(node.text)
+            node.text = node.text.sub(/#{w}%/, "")
+            m[w] = true
+          end
         end
-        page ? super.merge(pagenumber: true) : super
+        ret = super
+        flags.keys.each { |k| ret[k.to_sym] = true }
+        ret
       end
 
       def clause_parse(attrs, xml, node)
@@ -137,7 +152,30 @@ module Asciidoctor
       end
 
       def ol_attrs(node)
-        super.merge(start: node.attr("start"))
+        super.merge(attr_code(start: node.attr("start")))
+      end
+
+      def section_names_terms_cleanup(x)
+      end
+
+      def committee_validate(xml)
+        committees = Array(configuration&.committees) || return
+        committees.empty? and return
+        xml.xpath("//bibdata/ext/editorialgroup/committee/variant").each do |c|
+          committees.include? c.text or
+            @log.add("Document Attributes", nil,
+                     "#{c.text} is not a recognised committee")
+        end
+        xml.xpath("//bibdata/ext/editorialgroup/committee/@acronym").each do |c|
+          committees.include? c.text or
+            @log.add("Document Attributes", nil,
+                     "#{c.text} is not a recognised committee")
+        end
+      end
+
+      def mathml_mi_italics
+        { uppergreek: false, upperroman: false,
+          lowergreek: false, lowerroman: true }
       end
 
       def outputs(node, ret)