metanorma-csa 1.4.0

data/lib/asciidoctor/csa/converter.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+require 'asciidoctor'
+require 'metanorma/csa/version'
+require 'isodoc/csa/html_convert'
+require 'isodoc/csa/pdf_convert'
+require 'isodoc/csa/word_convert'
+require 'asciidoctor/standoc/converter'
+require 'fileutils'
+require_relative 'validate'
+
+module Asciidoctor
+  module Csa
+    CSA_NAMESPACE = 'https://open.ribose.com/standards/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
+
+      register_for CSA_TYPE
+
+      def metadata_author(node, xml)
+        xml.contributor do |c|
+          c.role **{ type: "author" }
+          c.organization do |a|
+            a.name "Cloud Security Alliance"
+          end
+        end
+      end
+
+      def metadata_publisher(node, xml)
+        xml.contributor do |c|
+          c.role **{ type: "publisher" }
+          c.organization do |a|
+            a.name "Cloud Security Alliance"
+          end
+        end
+      end
+
+      def metadata_committee(node, xml)
+        return unless node.attr("technical-committee")
+        xml.editorialgroup do |a|
+          a.committee node.attr("technical-committee"),
+            **attr_code(type: node.attr("technical-committee-type"))
+          i = 2
+          while node.attr("technical-committee_#{i}") do
+            a.committee node.attr("technical-committee_#{i}"),
+              **attr_code(type: node.attr("technical-committee-type_#{i}"))
+            i += 1
+          end
+        end
+      end
+
+      def metadata_id(node, xml)
+        docstatus = node.attr('status')
+        dn = node.attr('docnumber')
+        if docstatus
+          abbr = IsoDoc::Csa::Metadata.new('en', 'Latn', {})
+                                      .status_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 metadata_copyright(node, xml)
+        from = node.attr('copyright-year') || Date.today.year
+        xml.copyright do |c|
+          c.from from
+          c.owner do |owner|
+            owner.organization do |o|
+              o.name 'Cloud Security Alliance'
+            end
+          end
+        end
+      end
+
+      def title_validate(root)
+        nil
+      end
+
+      def makexml(node)
+        result = ["<?xml version='1.0' encoding='UTF-8'?>\n<csa-standard>"]
+        @draft = node.attributes.has_key?("draft")
+        result << noko { |ixml| front node, ixml }
+        result << noko { |ixml| middle node, ixml }
+        result << '</csa-standard>'
+        result = textcleanup(result)
+        ret1 = cleanup(Nokogiri::XML(result))
+        validate(ret1) unless @novalid
+        ret1.root.add_namespace(nil, CSA_NAMESPACE)
+        ret1
+      end
+
+      def doctype(node)
+        d = node.attr('doctype')
+        unless %w{guidance proposal standard report whitepaper charter policy glossary case-study}.include? d
+          warn "#{d} is not a legal document type: reverting to 'standard'"
+          d = 'standard'
+        end
+        d
+      end
+
+      def document(node)
+        init(node)
+        ret1 = makexml(node)
+        ret = ret1.to_xml(indent: 2)
+        unless node.attr('nodoc') || !node.attr('docfile')
+          filename = node.attr('docfile').gsub(/\.adoc/, '.xml')
+                         .gsub(%r{^.*/}, '')
+          File.open(filename, 'w') { |f| f.write(ret) }
+          html_converter(node).convert filename unless node.attr('nodoc')
+          pdf_converter(node).convert filename unless node.attr('nodoc')
+          word_converter(node).convert filename unless node.attr('nodoc')
+        end
+        @files_to_delete.each { |f| FileUtils.rm f }
+        ret
+      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|
+          h.delete('inline-header')
+        end
+      end
+
+      def style(n, t)
+        return
+      end
+
+      def html_converter(node)
+        IsoDoc::Csa::HtmlConvert.new(html_extract_attributes(node))
+      end
+      def pdf_converter(node)
+        IsoDoc::Csa::PdfConvert.new(html_extract_attributes(node))
+      end
+      def word_converter(node)
+        IsoDoc::Csa::WordConvert.new(doc_extract_attributes(node))
+      end
+    end
+  end
+end

data/lib/asciidoctor/csa/csa.rng

@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
+    we cannot have a new default namespace: we will end up with a grammar with two different
+    namespaces, one for isostandard and one for csand additions. And we do not want that.
+  -->
+  <include href="isostandard.rng">
+    <start>
+      <ref name="csa-standard"/>
+    </start>
+    <define name="figure">
+      <element name="figure">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <ref name="source"/>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <choice>
+          <oneOrMore>
+            <ref name="figure"/>
+          </oneOrMore>
+          <group>
+            <choice>
+              <zeroOrMore>
+                <ref name="TextElement"/>
+              </zeroOrMore>
+              <ref name="pre"/>
+            </choice>
+            <zeroOrMore>
+              <ref name="note"/>
+            </zeroOrMore>
+            <optional>
+              <ref name="dl"/>
+            </optional>
+          </group>
+        </choice>
+      </element>
+    </define>
+    <define name="DocumentType">
+      <choice>
+        <value>guidance</value>
+        <value>proposal</value>
+        <value>standard</value>
+        <value>report</value>
+        <value>whitepaper</value>
+        <value>charter</value>
+        <value>policy</value>
+        <value>glossary</value>
+        <value>case-study</value>
+      </choice>
+    </define>
+    <define name="BibDataExtensionType">
+      <optional>
+        <ref name="doctype"/>
+      </optional>
+      <ref name="editorialgroup"/>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+    </define>
+    <define name="editorialgroup">
+      <element name="editorialgroup">
+        <oneOrMore>
+          <ref name="technical-committee"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="technical-committee">
+      <element name="committee">
+        <optional>
+          <attribute name="type"/>
+        </optional>
+        <text/>
+      </element>
+    </define>
+  </include>
+  <define name="csa-standard">
+    <element name="csa-standard">
+      <ref name="bibdata"/>
+      <zeroOrMore>
+        <ref name="termdocsource"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="boilerplate"/>
+      </optional>
+      <ref name="preface"/>
+      <oneOrMore>
+        <ref name="sections"/>
+      </oneOrMore>
+      <zeroOrMore>
+        <ref name="annex"/>
+      </zeroOrMore>
+      <ref name="bibliography"/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/csa/isodoc.rng

@@ -0,0 +1,514 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  instantiations of this grammar may replace leaf strings
+  with more elaborated types; e.g. title (text) replaced with
+  title-main, title-intro, title-part; type replaced with
+  enum.
+  
+  some renaming at leaf nodes is permissible
+  
+  obligations can change both from optional to mandatory,
+  and from mandatory to optional; optional elements may
+  be omitted; freely positioned alternatives may be replaced
+  with strict ordering
+  
+  DO NOT introduce a namespace here. We do not want a distinct namespace
+  for these elements, and a distinct namespace for any grammar inheriting
+  these elements; we just want one namespace for any child grammars
+  of this.
+-->
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <include href="reqt.rng"/>
+  <!-- include "biblio.rnc" { } -->
+  <include href="basicdoc.rng">
+    <start>
+      <ref name="standard-document"/>
+    </start>
+    <define name="BibDataExtensionType">
+      <ref name="doctype"/>
+      <zeroOrMore>
+        <ref name="structuredidentifier"/>
+      </zeroOrMore>
+    </define>
+    <define name="TitleType">
+      <text/>
+    </define>
+    <define name="sections">
+      <element name="sections">
+        <oneOrMore>
+          <choice>
+            <ref name="clause"/>
+            <ref name="terms"/>
+            <ref name="definitions"/>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="references">
+      <element name="references">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="section-title"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="bibitem"/>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </zeroOrMore>
+      </element>
+    </define>
+  </include>
+  <define name="standard-document">
+    <element name="standard-document">
+      <ref name="bibdata"/>
+      <optional>
+        <ref name="boilerplate"/>
+      </optional>
+      <optional>
+        <ref name="preface"/>
+      </optional>
+      <ref name="sections"/>
+      <zeroOrMore>
+        <ref name="annex"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="references"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="preface">
+    <element name="preface">
+      <oneOrMore>
+        <choice>
+          <ref name="content"/>
+          <ref name="abstract"/>
+          <ref name="foreword"/>
+          <ref name="introduction"/>
+          <ref name="acknowledgements"/>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="foreword">
+    <element name="foreword">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="introduction">
+    <element name="introduction">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="boilerplate">
+    <element name="boilerplate">
+      <optional>
+        <ref name="copyright-statement"/>
+      </optional>
+      <optional>
+        <ref name="license-statement"/>
+      </optional>
+      <optional>
+        <ref name="legal-statement"/>
+      </optional>
+      <optional>
+        <ref name="feedback-statement"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright-statement">
+    <element name="copyright-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="license-statement">
+    <element name="license-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="legal-statement">
+    <element name="legal-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="feedback-statement">
+    <element name="feedback-statement">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="definitions">
+    <element name="definitions">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <ref name="section-title"/>
+      </optional>
+      <oneOrMore>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+        <ref name="dl"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="content">
+    <element name="clause">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="abstract">
+    <element name="abstract">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="acknowledgements">
+    <element name="acknowledgements">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="content-subsection">
+    <element name="clause">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <ref name="Content-Section"/>
+    </element>
+  </define>
+  <define name="Content-Section">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="language"/>
+    </optional>
+    <optional>
+      <attribute name="script"/>
+    </optional>
+    <optional>
+      <ref name="section-title"/>
+    </optional>
+    <choice>
+      <group>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </group>
+      <oneOrMore>
+        <ref name="content-subsection"/>
+      </oneOrMore>
+    </choice>
+  </define>
+  <define name="clause">
+    <element name="clause">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <ref name="Clause-Section"/>
+    </element>
+  </define>
+  <define name="Clause-Section">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="language"/>
+    </optional>
+    <optional>
+      <attribute name="script"/>
+    </optional>
+    <optional>
+      <ref name="section-title"/>
+    </optional>
+    <choice>
+      <group>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </group>
+      <oneOrMore>
+        <choice>
+          <ref name="clause-subsection"/>
+          <ref name="terms"/>
+          <ref name="definitions"/>
+        </choice>
+      </oneOrMore>
+    </choice>
+  </define>
+  <define name="clause-subsection">
+    <element name="clause">
+      <ref name="Clause-Section"/>
+    </element>
+  </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>
+      <attribute name="obligation">
+        <choice>
+          <value>normative</value>
+          <value>informative</value>
+        </choice>
+      </attribute>
+      <optional>
+        <ref name="section-title"/>
+      </optional>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <oneOrMore>
+          <ref name="clause-subsection"/>
+        </oneOrMore>
+      </choice>
+    </element>
+  </define>
+  <define name="terms">
+    <element name="terms">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="BasicBlock"/>
+      </zeroOrMore>
+      <oneOrMore>
+        <ref name="term"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="term">
+    <element name="term">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="preferred"/>
+      </oneOrMore>
+      <zeroOrMore>
+        <ref name="admitted"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="related"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="deprecates"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="termdomain"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="termgrammar"/>
+      </zeroOrMore>
+      <ref name="definition"/>
+      <zeroOrMore>
+        <ref name="termnote"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="termexample"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="preferred">
+    <element name="preferred">
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="admitted">
+    <element name="admitted">
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="related">
+    <element name="related">
+      <optional>
+        <attribute name="type">
+          <choice>
+            <value>compare</value>
+            <value>contrast</value>
+            <value>see</value>
+          </choice>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="deprecates">
+    <element name="deprecates">
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="termdomain">
+    <element name="domain">
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="termgrammar">
+    <element name="grammar">
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="definition">
+    <element name="definition">
+      <ref name="paragraph"/>
+    </element>
+  </define>
+  <define name="termnote">
+    <element name="termnote">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <ref name="paragraph"/>
+    </element>
+  </define>
+  <define name="termexample">
+    <element name="termexample">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <ref name="paragraph"/>
+    </element>
+  </define>
+  <define name="termsource">
+    <element name="termsource">
+      <attribute name="status">
+        <choice>
+          <value>identical</value>
+          <value>modified</value>
+        </choice>
+      </attribute>
+      <ref name="origin"/>
+      <optional>
+        <ref name="modification"/>
+      </optional>
+    </element>
+  </define>
+  <define name="origin">
+    <element name="origin">
+      <ref name="erefType"/>
+    </element>
+  </define>
+  <define name="modification">
+    <element name="modification">
+      <ref name="paragraph"/>
+    </element>
+  </define>
+  <define name="structuredidentifier">
+    <element name="structuredidentifier">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <oneOrMore>
+        <element name="agency">
+          <text/>
+        </element>
+      </oneOrMore>
+      <optional>
+        <element name="class">
+          <text/>
+        </element>
+      </optional>
+      <element name="docnumber">
+        <text/>
+      </element>
+      <optional>
+        <element name="partnumber">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="edition">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="version">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="supplementtype">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="supplementnumber">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="language">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="year">
+          <text/>
+        </element>
+      </optional>
+    </element>
+  </define>
+</grammar>