metanorma-csa 1.6.5 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b39b8dc480981f588fa326b12c646f7ed4e40967f18a5614e23032dde195fccb
-  data.tar.gz: 41e2d38150cb17f451786e0f753b51094097c43694c847ddcd9f193e7881b8a2
+  metadata.gz: e6fe06c1107b70d768044a3ebc469e00b060b466c0a4582b84344d25460daff8
+  data.tar.gz: 3bdd15ce9f800edd24868b63ffe09f46d110b71906a67446a7000e8291ffa33d
 SHA512:
-  metadata.gz: f08298b4edade5b2ec79b7ba3a711ebf47707671f0b31cfda119cb3689c6b092264196535694b04946d59464b32edef2be13405009292c1d4b193ed45f4ff3dd
-  data.tar.gz: 9007cbedf8e94f4cbd5e65163e8dfefe4659539b5aafd76306fe66a01c8401c5f88fffcae2a1e158f13b9e0e169ab6bfdd3b7f1aaa3744cff46f62e38398c0a6
+  metadata.gz: 2ccc69f6f1dd8e66f96787f93ded9d5e867a73c0c38358908b7616fd9f25ddf5e3a3009089c0144ef50523e25fb6de4c50305e874d2fba315d42049d28e326eb
+  data.tar.gz: e2127ad0bf2f0dec437c30a677b0bae3f3283946bb83d5eda4597daebfb97aa5304fb0e6e333f895f274677d86d3f369163dc8ef5a4625dbe169c02d435cf475

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,19 +1,15 @@
-= AsciiCSAND: Asciidoctor processor for CSA Normal Documents (CSAND)
+= Metanorma processor for CSA documents
 
 image:https://img.shields.io/gem/v/metanorma-csa.svg["Gem Version", link="https://rubygems.org/gems/metanorma-csa"]
-image:https://github.com/metanorma/metanorma-csa/workflows/ubuntu/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-csa/actions?query=workflow%3Aubuntu"]
-image:https://github.com/metanorma/metanorma-csa/workflows/macos/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-csa/actions?query=workflow%3Amacos"]
-image:https://github.com/metanorma/metanorma-csa/workflows/windows/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-csa/actions?query=workflow%3Awindows"]
+image:https://github.com/metanorma/metanorma-csa/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-csa/actions?query=workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-csand/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-csand"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-csa.svg["Pull Requests", link="https://github.com/metanorma/metanorma-csa/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-csa/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-csa/releases"]
 
-_Formerly known as_ `asciidoctor-csand`.
-
 == Functionality
 
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
-a template for generating CSAND documents.
+This gem processes https://www.metanorma.com/[Metanorma documents] following
+a template for generating CSA documents.
 
 The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
 gem, and aligns closely to it. Refer to the ISO gem documentation
@@ -21,24 +17,15 @@ for guidance, including https://github.com/metanorma/metanorma-iso/wiki/Guidance
 
 The following outputs are generated.
 
-* (Optional) An HTML preview generated directly from the Asciidoctor document,
-using native Asciidoctor formatting.
-** http://asciimath.org[AsciiMathML] is to be used for mathematical formatting.
-The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser],
-which is syntactically stricter than the common MathJax processor;
-if you do not get expected results, try bracketing terms your in AsciiMathML
-expressions.
-* an XML representation of the document, intended as a document model for CSAND
-International Standards.
-* The XML representation is processed in turn to generate the following outputs
-as end deliverable CSAND standard drafts.
-** HTML output.
-
-This AsciiDoc syntax for writing CSAND standards is hereby named "AsciiCSAND".
+* Metanorma XML
+* HTML output (from Metanorma XML)
+* PDF output (from Metanorma XML)
+
+// This AsciiDoc syntax for writing CSAND standards is hereby named "AsciiCSAND".
 
 == Usage
 
-The preferred way to invoke this gem is via the `metanorma` script:
+The preferred way to invoke this gem is via the `metanorma` command:
 
 [source,console]
 ----
@@ -56,13 +43,6 @@ document.
 The gem then converts the XML to HTML, and
 outputs that files with the appropriate `.html` suffix.
 
-The gem can also be invoked directly within asciidoctor, though this is deprecated:
-
-[source,console]
-----
-$ asciidoctor -b csa -r 'metanorma-csa' a.adoc  
-----
-
 === Installation
 
 If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup
@@ -83,3 +63,7 @@ See https://www.metanorma.com/author/csa/[Author Cloud Security Alliance documen
 == Examples
 
 See https://github.com/metanorma/mn-samples-csa for sample documents.
+
+== Notes
+
+Metanorma-CSA was formerly published as `asciidoctor-csand`.

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

@@ -1,29 +1,24 @@
 # frozen_string_literal: true
 
 require 'asciidoctor'
-require 'metanorma/csa/version'
+require 'metanorma-generic'
 require 'isodoc/csa/html_convert'
 require 'isodoc/csa/pdf_convert'
 require 'isodoc/csa/word_convert'
 require 'isodoc/csa/presentation_xml_convert'
-require 'asciidoctor/standoc/converter'
+require 'metanorma/csa'
 require 'fileutils'
-require_relative 'validate'
 
 module Asciidoctor
   module Csa
-    CSA_TYPE = 'csa'
-
-    # A {Converter} implementation that generates CSD output, and a document
-    # schema encapsulation of the document for validation
-    class Converter < Standoc::Converter
+    class Converter < ::Asciidoctor::Generic::Converter
       XML_ROOT_TAG = "csa-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/csa".freeze
 
-      register_for CSA_TYPE
+      register_for "csa"
 
-      def default_publisher
-        "Cloud Security Alliance"
+      def configuration
+        Metanorma::Csa.configuration
       end
 
       def personal_role(node, c, suffix)
@@ -47,34 +42,10 @@ module Asciidoctor
         end
       end
 
-      def metadata_id(node, xml)
-        dn = node.attr('docnumber') or return
-        docstatus = node.attr('status')
-        if docstatus
-          abbr = IsoDoc::Csa::Metadata.new('en', 'Latn', @i18n)
-            .stage_abbr(docstatus)
-          dn = "#{dn}(#{abbr})" unless abbr.empty?
-        end
-        node.attr('copyright-year') && dn += ":#{node.attr('copyright-year')}"
-        xml.docidentifier dn, **{ type: CSA_TYPE }
-        xml.docnumber { |i| i << node.attr('docnumber') }
-      end
-
       def title_validate(root)
         nil
       end
 
-      def doctype(node)
-        d = super
-        unless %w{guidance proposal standard report whitepaper charter policy
-          glossary case-study}.include? d
-          @log.add("Document Attributes", nil,
-                   "#{d} is not a legal document type: reverting to 'standard'")
-          d = 'standard'
-        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")
@@ -86,12 +57,6 @@ module Asciidoctor
                                        nil, false, "#{@filename}.pdf")
       end
 
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), 'csa.rng'))
-      end
-
       def sections_cleanup(x)
         super
         x.xpath("//*[@inline-header]").each do |h|
@@ -99,6 +64,21 @@ module Asciidoctor
         end
       end
 
+      def bibdata_validate(doc)
+        super
+        role_validate(doc)
+      end
+
+      def role_validate(doc)
+        doc&.xpath("//bibdata/contributor/role[description]")&.each do |r|
+          r["type"] == "author" or next
+          role = r.at("./description").text
+          %w{full-author contributor staff reviewer}.include?(role) or
+        @log.add("Document Attributes", nil,
+                 "#{role} is not a recognised role")
+        end
+      end
+
       def style(n, t)
         return
       end
@@ -106,12 +86,16 @@ module Asciidoctor
       def html_converter(node)
         IsoDoc::Csa::HtmlConvert.new(html_extract_attributes(node))
       end
+
       def pdf_converter(node)
+        return if node.attr("no-pdf")
         IsoDoc::Csa::PdfConvert.new(html_extract_attributes(node))
       end
+
       def doc_converter(node)
         IsoDoc::Csa::WordConvert.new(doc_extract_attributes(node))
       end
+
       def presentation_xml_converter(node)
         IsoDoc::Csa::PresentationXMLConvert.new(doc_extract_attributes(node))
       end

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