metanorma-generic 1.6.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4051c5aaaa0b9eb7a8830a501f63f0d31ac188bcf2da6eff4a2569370c191798
-  data.tar.gz: cff9b18009cd0b594bde8789c05318e5ec357f1c5e31fe2d7e20ef58c2cede1d
+  metadata.gz: c325e9aa02cddaf26372e0199b21c55338e5abff1b8a1e8a25007567fb03b799
+  data.tar.gz: b6fc284631a359dc78e4f83744d1fbda26211b1692d74417b5a45af254b0266b
 SHA512:
-  metadata.gz: 9602b51e4a9b97efeddbe0f844bb189cc9f1f251266a88ef9ba3fa5efb534aa35991f079248f4669c59800cc7b2e3910b20c3c8ee14b3df49a57cf4478ff0b9c
-  data.tar.gz: 6bc8966b060289541a0702cdee8ad9be5d8707b03d6812673bbea05fedb3748d8b381c7115ecdb5c341bd4aa847b7c3122740a03d6ef6200b87d83e7145867a8
+  metadata.gz: a0496b1c8cb2ef30e8265d08eaf4c0206f110a6687f6e2acc7d9e172e2e1975e266f9740ac628fa492d5b151ecad4a171653f9cc8704625e76359676231b6364
+  data.tar.gz: 3a4fd80dfd4fd4540950837182bf860676d4ea15f6a09cc207f64ab2025c2a54b0fa9aa84ba324585f6dcee41632ff38117b00a1dc8594c6d215e8b6779cc0e8

data/.github/workflows/rake.yml

@@ -0,0 +1,63 @@
+# 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
+
+      - run: bundle exec rake
+
+  notify:
+    name: Trigger notify workflow
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger notify workflow
+        uses: Sibz/github-status-action@v1
+        with:
+          authToken: ${{ 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

@@ -3,9 +3,7 @@
 Formerly known as metanorma-acme
 
 image:https://img.shields.io/gem/v/metanorma-generic.svg["Gem Version", link="https://rubygems.org/gems/metanorma-generic"]
-image:https://github.com/metanorma/metanorma-generic/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-generic/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-generic/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-generic/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-generic/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-generic/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-generic/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-generic/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-acme/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-acme"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-generic.svg["Pull Requests", link="https://github.com/metanorma/metanorma-generic/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-generic/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-generic/releases"]

data/lib/asciidoctor/generic/basicdoc.rng

@@ -402,6 +402,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -429,6 +439,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -998,6 +1018,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

data/lib/asciidoctor/generic/converter.rb

@@ -1,13 +1,10 @@
 require "asciidoctor"
 require "asciidoctor/standoc/converter"
 require "fileutils"
+require_relative "front"
 
 module Asciidoctor
   module Generic
-
-    # A {Converter} implementation that generates RSD output, and a document
-    # schema encapsulation of the document for validation
-    #
     class Converter < Standoc::Converter
       XML_ROOT_TAG = "generic-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/generic".freeze
@@ -28,33 +25,6 @@ module Asciidoctor
           self.class::_file || __FILE__), "..", "..", "..", loc))
       end
 
-      def default_publisher
-        configuration.organization_name_long
-      end
-
-      def metadata_committee(node, xml)
-        return unless node.attr("committee")
-        xml.editorialgroup do |a|
-          a.committee node.attr("committee"),
-            **attr_code(type: node.attr("committee-type"))
-          i = 2
-          while node.attr("committee_#{i}") do
-            a.committee node.attr("committee_#{i}"),
-              **attr_code(type: node.attr("committee-type_#{i}"))
-            i += 1
-          end
-        end
-      end
-
-      def metadata_status(node, xml)
-        xml.status do |s|
-          s.stage ( node.attr("status") || node.attr("docstage") ||
-                   configuration.default_stage || "published" )
-          x = node.attr("substage") and s.substage x
-          x = node.attr("iteration") and s.iteration x
-        end
-      end
-
       def docidentifier_cleanup(xmldoc)
         template = configuration.docid_template ||
           "{{ organization_name_short }} {{ docnumeric }}"
@@ -63,30 +33,16 @@ module Asciidoctor
         id.empty? and docid.remove or docid.children = id
       end
 
-      def metadata_id(node, xml)
-        xml.docidentifier **{ type:
-                              configuration.organization_name_short } do |i|
-          i << "DUMMY"
-        end
-        xml.docnumber { |i| i << node.attr("docnumber") }
-      end
-
-      def metadata_ext(node, ext)
-        super
-        Array(configuration.metadata_extensions).each do |e|
-          a = node.attr(e) and ext.send e, a
-        end
-      end
-
       def doctype(node)
         d = super
-        configuration.doctypes or return d == "article" ? "standard" : d
-        default = configuration.default_doctype || Array(configuration.doctypes).dig(0) ||
-          "standard"
-        unless Array(configuration.doctypes).include? d
+        configuration.doctypes or return d == "article" ? 
+          (configuration.default_doctype || "standard") : d
+        type = configuration.default_doctype ||
+          configuration.doctypes.keys.dig(0) || "standard"
+        unless configuration.doctypes.keys.include? d
           @log.add("Document Attributes", nil,
-                   "#{d} is not a legal document type: reverting to '#{default}'")
-          d = default
+                   "#{d} is not a legal document type: reverting to '#{type}'")
+          d = type
         end
         d
       end
@@ -97,13 +53,13 @@ module Asciidoctor
       end
 
       def sectiontype_streamline(ret)
-        if configuration.termsdefs_titles.map(&:downcase).include? (ret)
+        if configuration&.termsdefs_titles&.map(&:downcase)&.include? (ret)
           "terms and definitions"
-        elsif configuration.symbols_titles.map(&:downcase).include? (ret)
+        elsif configuration&.symbols_titles&.map(&:downcase)&.include? (ret)
           "symbols and abbreviated terms"
-        elsif configuration.normref_titles.map(&:downcase).include? (ret)
+        elsif configuration&.normref_titles&.map(&:downcase)&.include? (ret)
           "normative references"
-        elsif configuration.bibliography_titles.map(&:downcase).include? (ret)
+        elsif configuration&.bibliography_titles&.map(&:downcase)&.include? (ret)
           "bibliography"
         else
           ret
@@ -117,11 +73,11 @@ module Asciidoctor
 
       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", 
-                                     nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", 
-                                    nil, false, "#{@filename}.doc")
+        presentation_xml_converter(node)&.convert(@filename + ".xml")
+        html_converter(node)&.convert(@filename + ".presentation.xml", 
+                                      nil, false, "#{@filename}.html")
+        doc_converter(node)&.convert(@filename + ".presentation.xml", 
+                                     nil, false, "#{@filename}.doc")
         pdf_converter(node)&.convert(@filename + ".presentation.xml", 
                                      nil, false, "#{@filename}.pdf")
 
@@ -141,6 +97,7 @@ module Asciidoctor
 
       def bibdata_validate(doc)
         stage_validate(doc)
+        committee_validate(doc)
       end
 
       def stage_validate(xmldoc)
@@ -151,6 +108,15 @@ module Asciidoctor
           @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
       end
 
+      def committee_validate(xmldoc)
+        committees = Array(configuration&.committees) || return
+        committees.empty? and return
+        xmldoc.xpath("//bibdata/ext/editorialgroup/committee").each do |c|
+          committees.include? c.text or
+            @log.add("Document Attributes", nil, "#{c.text} is not a recognised committee")
+        end
+      end
+
       def sections_cleanup(x)
         super
         x.xpath("//*[@inline-header]").each do |h|
@@ -187,6 +153,26 @@ module Asciidoctor
         end
         conv
       end
+
+      def boilerplate_file(xmldoc)
+        f = configuration.boilerplate
+        f.nil? and return super
+        f.is_a? String and return baselocation(f)
+        f.is_a? Hash and f[@lang] and return baselocation(f[@lang])
+        super
+      end
+
+      def cleanup(xmldoc)
+        super
+        empty_metadata_cleanup(xmldoc)
+        xmldoc
+      end
+
+      def empty_metadata_cleanup(xmldoc)
+        xmldoc.xpath("//bibdata/ext//*").each do |x|
+          x.remove if x.children.empty?
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/generic/front.rb

@@ -0,0 +1,108 @@
+module Asciidoctor
+  module Generic
+    class Converter < Standoc::Converter
+      def default_publisher
+        configuration.organization_name_long
+      end
+
+      def org_abbrev
+        if !configuration.organization_name_long.empty? &&
+            !configuration.organization_name_short.empty? &&
+            configuration.organization_name_long !=
+            configuration.organization_name_short
+          { configuration.organization_name_long =>
+            configuration.organization_name_short }
+        else
+          super
+        end
+      end
+
+      def relaton_relations
+        Array(configuration.relations) || []
+      end
+
+      def metadata_committee(node, xml)
+        return unless node.attr("committee")
+        xml.editorialgroup do |a|
+          a.committee node.attr("committee"),
+            **attr_code(type: node.attr("committee-type"))
+          i = 2
+          while node.attr("committee_#{i}") do
+            a.committee node.attr("committee_#{i}"),
+              **attr_code(type: node.attr("committee-type_#{i}"))
+            i += 1
+          end
+        end
+      end
+
+      def metadata_status(node, xml)
+        xml.status do |s|
+          s.stage ( node.attr("status") || node.attr("docstage") ||
+                   configuration.default_stage || "published" )
+          x = node.attr("substage") and s.substage x
+          x = node.attr("iteration") and s.iteration x
+        end
+      end
+
+      def metadata_id(node, xml)
+        xml.docidentifier **{ type:
+                              configuration.organization_name_short } do |i|
+          i << "DUMMY"
+        end
+        xml.docnumber { |i| i << node.attr("docnumber") }
+      end
+
+      def metadata_ext(node, ext)
+        super
+        if configuration.metadata_extensions.is_a? Hash
+          metadata_ext_hash(node, ext, configuration.metadata_extensions)
+        else
+          Array(configuration.metadata_extensions).each do |e|
+            a = node.attr(e) and ext.send e, a
+          end
+        end
+      end
+
+      def metadata_doctype(node, xml)
+        d = doctype(node)
+        xml.doctype d, attr_code(abbreviation: configuration&.doctypes&.dig(d))
+      end
+
+      EXT_STRUCT = %w(_output _attribute _list).freeze
+
+      def metadata_ext_hash(node, ext, hash)
+        hash.each do |k, v|
+          next if EXT_STRUCT.include?(k) || !v&.is_a?(Hash) && !node.attr(k)
+          if v&.is_a?(Hash) && v["_list"]
+            csv_split(node.attr(k)).each do |val|
+              metadata_ext_hash1(k, val, ext, v, node)
+            end
+          else
+            metadata_ext_hash1(k, node.attr(k), ext, v, node)
+          end
+        end
+      end
+
+      def metadata_ext_hash1(key, value, ext, hash, node)
+        return if hash&.is_a?(Hash) && hash["_attribute"]
+        is_hash = hash&.is_a?(Hash) &&
+            !hash.keys.reject { |n| EXT_STRUCT.include?(n) }.empty?
+        return if !is_hash && (value.nil? || value.empty?)
+        name = hash&.is_a?(Hash) ? (hash["_output"] || key) : key
+        ext.send name, **attr_code(metadata_ext_attrs(hash, node)) do |e|
+            is_hash ? metadata_ext_hash(node, e, hash) : (e << value)
+        end
+      end
+
+      def metadata_ext_attrs(hash, node)
+        return {} unless hash.is_a?(Hash)
+        ret = {}
+        hash.each do |k, v|
+          next unless v.is_a?(Hash) && v["_attribute"]
+          ret[(v["_output"] || k).to_sym] = node.attr(k)
+        end
+        ret
+      end
+    end
+  end
+end

data/lib/asciidoctor/generic/generic.rng

@@ -59,6 +59,13 @@
   </define>
   <define name="generic-standard">
     <element name="generic-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/lib/asciidoctor/generic/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"/>
@@ -581,6 +598,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -664,6 +683,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -700,6 +729,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -837,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"/>
@@ -858,7 +904,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -1052,14 +1098,17 @@
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1128,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">
@@ -1456,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>
@@ -1510,4 +1512,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>