metanorma-bipm 1.0.4 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be68aaa802943c019afdfd6279a33269e9de8e9c2a9ece29a311e08e6c465355
-  data.tar.gz: 96b2dc9464927ae543c7a4ce10a705b14647ca79db313ff503e6856c1ce788b4
+  metadata.gz: 623fbeeac6901c02be4e9d2b6f63fffd801ca05d3265b50044bfadd6cee89305
+  data.tar.gz: 2541d290c848922b72be621bc9ebb4422bd77606ae40094006d0af38e378c7c0
 SHA512:
-  metadata.gz: de26de8eb2254291733038b0598e7dade4f27378ff1285a42d5957c95d14d02202df44ebfcb7a0072eb2760985a6d1c4c0d3feb860aa218f6eb34a0737a4dbf7
-  data.tar.gz: 447a238c927f5a14a655acbc0c52a4f33c3db5513eddf208ac6c564a6429786e62c53308e4adf0de5e15a0c26dfda28d29c9f855355dbe9bc1f6f7b98403787e
+  metadata.gz: 398c0d71ce26040dcc71453421b7a2af92470bb1e0f76b409bed57c4668e13681eeed2615069bf9de259520d22d1bb9a5ad7c251994d6e975dd4a0ea1051aaf9
+  data.tar.gz: 62c7116d632363c56808f868dc001f4ea313f85f9b0b5116821394d2ed46fdc1bce56f3dc1b7e331454c01d1120762e5c4cd4d3722bbbe32db9a3bf314b62097

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,50 +16,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
         include:
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'ubuntu-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'windows-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'macos-latest'
             experimental: true
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - if: matrix.os == 'macos-latest'
-        run: brew install autoconf automake libtool
-
-      - 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
+          bundler-cache: true
 
       - 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/.gitignore

@@ -0,0 +1 @@
+.rubocop-https--*

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
+AllCops:
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
+Rails:
+  Enabled: true

data/lib/asciidoctor/bipm/biblio.rng

@@ -124,7 +124,7 @@
           <value>application/tei+xml</value>
           <value>text/x-asciidoc</value>
           <value>text/markdown</value>
-          <value>application/x-isodoc+xml</value>
+          <value>application/x-metanorma+xml</value>
           <text/>
         </choice>
       </attribute>
@@ -452,6 +452,7 @@
       <attribute name="type">
         <choice>
           <value>isni</value>
+          <value>orcid</value>
           <value>uri</value>
         </choice>
       </attribute>
@@ -461,10 +462,7 @@
   <define name="org-identifier">
     <element name="identifier">
       <attribute name="type">
-        <choice>
-          <value>orcid</value>
-          <value>uri</value>
-        </choice>
+        <data type="string" datatypeLibrary=""/>
       </attribute>
       <text/>
     </element>
@@ -1106,7 +1104,7 @@
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>
-      <value>cited</value>
+      <value>cites</value>
       <value>isCitedIn</value>
     </choice>
   </define>

data/lib/asciidoctor/bipm/bipm.rng

@@ -340,6 +340,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -355,6 +358,9 @@
       <optional>
         <ref name="bibliography"/>
       </optional>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
     </element>
   </define>
 </grammar>

data/lib/asciidoctor/bipm/converter.rb

@@ -1,5 +1,5 @@
 require "asciidoctor/standoc/converter"
-require 'asciidoctor/generic/converter'
+require "asciidoctor/generic/converter"
 
 module Asciidoctor
   module BIPM
@@ -19,20 +19,26 @@ module Asciidoctor
       end
 
       def org_abbrev
-          { org_name_long => configuration.organization_name_short }
+        { 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|
           metadata_committee1(node, a)
-          metadata_committee2(node, a)
+          i = 2
+          while node.attr("committee-en_#{i}") || node.attr("committee-fr_#{i}")
+            metadata_committee2(node, a, i)
+            i += 1
+          end
           metadata_workgroup(node, a)
         end
       end
 
-      def metadata_committee1(node, a)
-        a.committee **attr_code(acronym: node.attr("committee-acronym")) do |c|
+      def metadata_committee1(node, xml)
+        xml.committee **attr_code(acronym:
+                                  node.attr("committee-acronym")) do |c|
           e = node.attr("committee-en") and
             c.variant e, language: "en", script: "Latn"
           e = node.attr("committee-fr") and
@@ -40,24 +46,25 @@ module Asciidoctor
         end
       end
 
-      def metadata_committee2(node, a)
-        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"
+      def metadata_committee2(node, xml, num)
+        xml.committee **attr_code(acronym:
+                                  node.attr("committee-acronym_#{num}")) do |c|
+          %w(en fr).each do |lg|
+            e = node.attr("committee-#{lg}_#{num}") and
+              c.variant e, language: lg, script: "Latn"
           end
-          i += 1
         end
       end
 
-      def metadata_workgroup(node, a)
-        a.workgroup node.attr("workgroup"),
-          **attr_code(acronym: node.attr("workgroup-acronym"))
+      def metadata_workgroup(node, xml)
+        xml.workgroup(node.attr("workgroup"),
+                      **attr_code(acronym: node.attr("workgroup-acronym")))
         i = 2
-        while node.attr("workgroup_#{i}") do
-          a.workgroup node.attr("workgroup_#{i}"),
+        while node.attr("workgroup_#{i}")
+          xml.workgroup(
+            node.attr("workgroup_#{i}"),
             **attr_code(acronym: node.attr("workgroup-acronym_#{i}"))
+          )
           i += 1
         end
       end
@@ -76,13 +83,15 @@ module Asciidoctor
         draft = node.attr("supersedes-draft#{suffix}")
         edition = node.attr("supersedes-edition#{suffix}")
         return false unless d || draft || edition
+
         relation_supersedes_self1(xml, d, edition, draft)
       end
 
-      def relation_supersedes_self1(xml, d, edition, draft)
+      def relation_supersedes_self1(xml, date, edition, draft)
         xml.relation **{ type: "supersedes" } do |r|
           r.bibitem do |b|
-            d and b.date d, **{ type: edition ? "published" : "circulated" }
+            date and b.date(date,
+                            **{ type: edition ? "published" : "circulated" })
             edition and b.edition edition
             draft and b.version do |v|
               v.draft draft
@@ -91,13 +100,13 @@ module Asciidoctor
         end
       end
 
-      def personal_role(node, c, suffix)
+      def personal_role(node, xml, suffix)
         role = node.attr("role#{suffix}") || "author"
         unless %w(author editor).include?(role.downcase)
           desc = role
           role = "editor"
         end
-        c.role desc, **{ type: role.downcase }
+        xml.role desc, **{ type: role.downcase }
       end
 
       def title(node, xml)
@@ -106,7 +115,7 @@ module Asciidoctor
           xml.title **attr_code(at.merge(type: "main")) do |t1|
             t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-#{lang}"))
           end
-          %w(cover appendix annex part subpart).each do |w|
+          %w(cover appendix annex part subpart provenance).each do |w|
             typed_title(node, xml, lang, w)
           end
         end
@@ -115,6 +124,7 @@ module Asciidoctor
       def typed_title(node, xml, lang, type)
         at = { language: lang, format: "text/plain" }
         return unless title = node.attr("title-#{type}-#{lang}")
+
         xml.title **attr_code(at.merge(type: type)) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(title)
         end
@@ -122,7 +132,7 @@ module Asciidoctor
 
       def sectiontype_streamline(ret)
         case ret
-        when "introduction" then "clause"
+        when "introduction" then @jcgm ? "introduction" : "clause"
         else
           super
         end
@@ -130,13 +140,13 @@ module Asciidoctor
 
       def inline_anchor_xref_attrs(node)
         flags = %w(pagenumber nosee nopage).each_with_object({}) do |w, m|
-          if /#{w}%/.match(node.text)
+          if /#{w}%/.match?(node.text)
             node.text = node.text.sub(/#{w}%/, "")
             m[w] = true
           end
         end
         ret = super
-        flags.keys.each { |k| ret[k.to_sym] = true }
+        flags.each_key { |k| ret[k.to_sym] = true }
         ret
       end
 
@@ -154,9 +164,6 @@ module Asciidoctor
         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
@@ -173,21 +180,44 @@ module Asciidoctor
       end
 
       def boilerplate_file(xmldoc)
-        return super unless xmldoc&.at("//bibdata/ext/editorialgroup/committee/@acronym")&.value == "JCGM"
-        baselocation("lib/asciidoctor/bipm/boilerplate-jcgm-en.xml")
+        return super unless @jcgm
+
+        File.join(File.dirname(__FILE__), "boilerplate-jcgm-en.xml")
+      end
+
+      def sections_cleanup(xml)
+        super
+        jcgm_untitled_sections_cleanup(xml) if @jcgm
+      end
+
+      def jcgm_untitled_sections_cleanup(xml)
+        xml.xpath("//clause//clause | //annex//clause").each do |c|
+          next if !c&.at("./title")&.text&.empty?
+
+          c["inline-header"] = true
+        end
       end
 
+      def section_names_terms_cleanup(xml); end
+
+      def section_names_refs_cleanup(xml); end
+
       def mathml_mi_italics
         { uppergreek: false, upperroman: false,
           lowergreek: false, lowerroman: true }
       end
 
+      def document(node)
+        @jcgm = node.attr("committee-acronym") == "JCGM"
+        super
+      end
+
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml",
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert("#{@filename}.xml")
+        html_converter(node).convert("#{@filename}.presentation.xml",
                                      nil, false, "#{@filename}.html")
-        pdf_converter(node)&.convert(@filename + ".presentation.xml",
+        pdf_converter(node)&.convert("#{@filename}.presentation.xml",
                                      nil, false, "#{@filename}.pdf")
       end
 
@@ -201,6 +231,7 @@ module Asciidoctor
 
       def pdf_converter(node)
         return nil if node.attr("no-pdf")
+
         IsoDoc::BIPM::PdfConvert.new(doc_extract_attributes(node))
       end
     end

data/lib/asciidoctor/bipm/isodoc.rng

@@ -86,6 +86,35 @@
         <text/>
       </element>
     </define>
+    <define name="erefType">
+      <optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="citeas"/>
+      <attribute name="type">
+        <ref name="ReferenceFormat"/>
+      </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
+      <optional>
+        <attribute name="case">
+          <choice>
+            <value>capital</value>
+            <value>lowercase</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="droploc">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <ref name="CitationType"/>
+      <text/>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -102,7 +131,7 @@
           </attribute>
         </optional>
         <oneOrMore>
-          <ref name="li"/>
+          <ref name="ul_li"/>
         </oneOrMore>
         <zeroOrMore>
           <ref name="note"/>
@@ -775,6 +804,78 @@
         <ref name="paragraph"/>
       </element>
     </define>
+    <define name="em">
+      <element name="em">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strong">
+      <element name="strong">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="tt">
+      <element name="tt">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="keyword">
+      <element name="keyword">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strike">
+      <element name="strike">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="underline">
+      <element name="underline">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="smallcap">
+      <element name="smallcap">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
   <define name="colgroup">
@@ -793,7 +894,35 @@
     <value>internal</value>
   </define>
   <define name="TextElement" combine="choice">
-    <ref name="concept"/>
+    <choice>
+      <ref name="concept"/>
+      <ref name="add"/>
+      <ref name="del"/>
+    </choice>
+  </define>
+  <define name="add">
+    <element name="add">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
+  <define name="del">
+    <element name="del">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
   </define>
   <define name="concept">
     <element name="concept">
@@ -919,6 +1048,9 @@
         </choice>
       </attribute>
       <ref name="bibdata"/>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -929,11 +1061,21 @@
       <zeroOrMore>
         <ref name="annex"/>
       </zeroOrMore>
+      <optional>
+        <ref name="bibliography"/>
+      </optional>
       <zeroOrMore>
-        <ref name="references"/>
+        <ref name="indexsect"/>
       </zeroOrMore>
     </element>
   </define>
+  <define name="misccontainer">
+    <element name="misc-container">
+      <oneOrMore>
+        <ref name="AnyElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>
@@ -957,6 +1099,11 @@
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="indexsect">
+    <element name="indexsect">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="boilerplate">
     <element name="boilerplate">
       <optional>
@@ -1698,4 +1845,26 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="ul_li">
+    <element name="li">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="uncheckedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="checkedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="BasicBlock"/>
+      </oneOrMore>
+    </element>
+  </define>
 </grammar>