metanorma-m3aawg 1.5.5 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e4609234c251bfd60f7f8db10d5b2bf164086060667e333f3157d98bd09126b
-  data.tar.gz: 5cff4ab9b4f71cd267bcbd6246791418a8d0f0c96ff58b385c08bbec9cfffccd
+  metadata.gz: 05e03f4d8aa09a9f187402ebdc4458ed44a74ce997f2e73eb4d8aa7f6fc74166
+  data.tar.gz: 03b1472ddeb5befa4ca2b1c4c7f9792b2445fc3e76e6f2ab74d21abe844f3e6a
 SHA512:
-  metadata.gz: e2f4d8ee7faf5754835acc43f0027ce303a60eb942e91d42109a2edce07ae58141364160be689813685f8a696a86028446040a6023faa50b808efc355f520959
-  data.tar.gz: 2a6bb8be8bd69a43010f69919736b43d2283bd7a2a0550325fca49f058f6835437c6d629f081c1186556a60e7201e47bd0e58acb03a72b16a5f1f108ef4db785
+  metadata.gz: aa0e526bc5c4121ca63de30e5442d3c6ae25d0e98295d6e043de06a9d18c1b41e23b65301be77ef594a6e0a80d579fac6f5836d03c4ce1786e8172185f511df8
+  data.tar.gz: 70174fb0222d2d757fd8985ddf49cb6872cb74453de568369c8785b6fd0f94d31d9e0b21b2333ef872f519b0ab213dadac247c28a786352a3d8564c75bfa89fb

data/.github/workflows/rake.yml

@@ -0,0 +1,62 @@
+# 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
+
+      - 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,9 +1,7 @@
 = Metanorma processor for M3AAWG documents 
 
 https://github.com/metanorma/metanorma-m3aawg[metanorma-m3aawg] image:https://img.shields.io/gem/v/metanorma-m3aawg.svg["Gem Version", link="https://rubygems.org/gems/metanorma-m3aawg"]::
-image:https://github.com/metanorma/metanorma-m3aawg/workflows/macos/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-m3aawg/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-m3aawg/workflows/windows/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-m3aawg/actions?workflow=windows"]
-image:https://github.com/metanorma/metanorma-m3aawg/workflows/ubuntu/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-m3aawg/actions?workflow=ubuntu"]
+image:https://github.com/metanorma/metanorma-m3aawg/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-m3aawg/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-m3aawg/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-m3aawg"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-m3aawg.svg["Pull Requests", link="https://github.com/metanorma/metanorma-m3aawg/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-m3aawg/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-m3aawg/releases"]
@@ -12,7 +10,7 @@ _Formerly known as_ `asciidoctor-m3d`.
 
 == Functionality
 
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
+This gem processes https://www.metanorma.com[Metanorma documents] following
 a template for generating M3AAWG documents.
 
 The gem currently inherits from the https://github.com/metanorma/metanorma-standoc

data/lib/asciidoctor/m3aawg/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/m3aawg/converter.rb

@@ -1,27 +1,14 @@
-require "asciidoctor"
-require "metanorma/m3aawg/version"
-require "isodoc/m3aawg/html_convert"
-require "isodoc/m3aawg/word_convert"
-require "isodoc/m3aawg/pdf_convert"
 require "asciidoctor/standoc/converter"
-require "fileutils"
-require_relative "./validate.rb"
+require 'asciidoctor/generic/converter'
 
 module Asciidoctor
   module M3AAWG
-
-    # A {Converter} implementation that generates M3D output, and a document
-    # schema encapsulation of the document for validation
-    class Converter < Standoc::Converter
+    class Converter < Asciidoctor::Generic::Converter
       XML_ROOT_TAG = "m3d-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/m3d".freeze
 
       register_for "m3aawg"
 
-      def default_publisher
-        "Messaging Malware and Mobile Anti-Abuse Working Group"
-      end
-
       def metadata_committee(node, xml)
         return unless node.attr("technical-committee")
         xml.editorialgroup do |a|
@@ -36,21 +23,8 @@ module Asciidoctor
         end
       end
 
-      def metadata_id(node, xml)
-        docstatus = node.attr("status")
-        dn = node.attr("docnumber")
-        if docstatus
-          abbr = IsoDoc::M3AAWG::Metadata.new("en", "Latn", @i18n).
-            stage_abbr(docstatus)
-          dn = "#{dn}(#{abbr})" unless abbr.empty?
-        end
-        node.attr("copyright-year") and dn += ":#{node.attr("copyright-year")}"
-        xml.docidentifier dn, **{type: "M3AAWG"}
-        xml.docnumber { |i| i << node.attr("docnumber") }
-      end
-
-      def title_validate(root)
-        nil
+       def configuration
+        Metanorma::M3AAWG.configuration
       end
 
       def makexml(node)
@@ -58,15 +32,6 @@ module Asciidoctor
         super
       end
 
-      def doctype(node)
-        d = super
-        unless %w{policy best-practices supporting-document report}.include? d
-          @log.add("Document Attributes", nil, "#{d} is not a legal document type: reverting to 'report'")
-          d = "report"
-        end
-        d
-      end
-
       def outputs(node, ret)
         File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
         presentation_xml_converter(node).convert(@filename + ".xml")
@@ -75,12 +40,6 @@ module Asciidoctor
         pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
       end
 
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "m3d.rng"))
-      end
-
       def sections_cleanup(x)
         super
         x.xpath("//*[@inline-header]").each do |h|
@@ -88,10 +47,6 @@ module Asciidoctor
         end
       end
 
-      def style(n, t)
-        return
-      end
-
       def presentation_xml_converter(node)
         IsoDoc::M3AAWG::PresentationXMLConvert.new(html_extract_attributes(node))
       end

data/lib/asciidoctor/m3aawg/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">

data/lib/isodoc/m3aawg/base_convert.rb

@@ -3,18 +3,8 @@ require "fileutils"
 module IsoDoc
   module M3AAWG
     module BaseRender
-      def cleanup(docxml)
-        super
-        term_cleanup(docxml)
-      end
-
-      def term_cleanup(docxml)
-        docxml.xpath("//p[@class = 'Terms']").each do |d|
-          h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
-          h2.add_child(" ")
-          h2.add_child(d.remove)
-        end
-        docxml
+      def configuration
+        Metanorma::M3AAWG.configuration
       end
     end
   end

data/lib/isodoc/m3aawg/html/htmlstyle.css

@@ -118,6 +118,10 @@ b, strong {
 div.document-stage-band, div.document-type-band {
   background-color: #333333; }
 
+a.FootnoteRef + a.FootnoteRef:before {
+  content: ", ";
+  vertical-align: super; }
+
 #standard-band {
   background-color: #0AC442; }
 
@@ -224,7 +228,7 @@ body {
   margin-left: auto;
   margin-right: auto;
   max-width: 100%;
-  font-size: 15px;
+  font-size: {{normalfontsize}};
   font-weight: 300;
   line-height: 1.4em;
   color: #1d1d1d;
@@ -662,7 +666,7 @@ p.Biblio, p.NormRef {
 pre,
 .pseudocode {
   background-color: #F5F6F6;
-  font-size: 0.8em;
+  font-size: {{monospacefontsize}};
   line-height: 1.6em;
   padding: 1.5em;
   margin: 2em 0 1em 0;
@@ -785,7 +789,7 @@ a.footnote-number {
   font-size: 0.8em; }
 
 .footnote {
-  font-size: 0.9em; }
+  font-size: {{footnotefontsize}}; }
 
 /*
     3.11 Blockquotes

data/lib/isodoc/m3aawg/html/htmlstyle.scss

@@ -18,7 +18,7 @@ Light Gray: #F5F6F6
 @import 'base_style/all';
 
 body {
-    @include bodyStyle1(15px, 1.4em, #1d1d1d, #ffffff, 300);
+    @include bodyStyle1($normalfontsize, 1.4em, #1d1d1d, #ffffff, 300);
 }
 
 #report {
@@ -431,7 +431,7 @@ a.footnote-number {
 }
 
 .footnote {
-    font-size: 0.9em;
+    font-size: $footnotefontsize;
 }