metanorma-m3aawg 1.5.6 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24f72496b09470f4ba51be8bab7dd660afe55d6992c0e796a62ab9cf55e827eb
-  data.tar.gz: 1ced435294ef6563be291a9f3819d6d7c0d56c7c052b158e92ca3fbefcc5302e
+  metadata.gz: 609a9a25743facaca6a46d3b95562d3c88f495b0861b716c8ab27c8e76395462
+  data.tar.gz: b6527b4b1c98c8db6bfbc78f7671f03f66386e737d72d652ab25976860411705
 SHA512:
-  metadata.gz: 88c4d252e305ed09ec1306ee4fc7a93450d61c548046e4cfcd2a71e5a17117f49a649c2e94e808582d9c9ea9cde10938e5cad417e97c9bfa81d5898724e2c534
-  data.tar.gz: 31ba0a8661ab3c840ab132710a0e440cb4a3ae9fb0a94b76a40eb48d8a73a431b89d589bc7d611cb6aab569888ab8bf3924c1dd4a09f4b67c366298dc79df4ee
+  metadata.gz: 0740a2fd599ffaa85273cb1f2fe653f7392321012fc878c350a784555763535a7c30f1b5ff07231446b3929751db5a1c165d481e7bf88277cac0e5b97c329c2e
+  data.tar.gz: b85fd00c45fcb6651acf9e59e34e9dd0bb843275957d8c2d4941fb9877f41b554a57634d0444e413dbcbf5accb2bbac9f254bc060c9625a0544801b59151fc15

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,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,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +777,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>
@@ -801,6 +839,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -856,9 +897,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1028,6 +1071,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1081,6 +1127,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1183,6 +1232,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1511,6 +1563,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1541,6 +1594,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>

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

@@ -228,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;
@@ -666,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;
@@ -789,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;
 }