metanorma-mpfa 0.4.0

data/lib/asciidoctor/mpfa/mpfd.rng

@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar ns="https://www.metanorma.org/ns/mpfd" xmlns="http://relaxng.org/ns/structure/1.0">
+  <!--
+    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="isodoc.rng">
+    <start>
+      <ref name="mpfd-standard"/>
+    </start>
+    <define name="DocumentType">
+      <choice>
+        <value>policy-and-procedures</value>
+        <value>best-practices</value>
+        <value>supporting-document</value>
+        <value>report</value>
+        <value>legal</value>
+        <value>directives</value>
+        <value>proposal</value>
+        <value>standard</value>
+      </choice>
+    </define>
+    <define name="editorialgroup">
+      <element name="editorialgroup">
+        <oneOrMore>
+          <ref name="committee"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="BibDataExtensionType">
+      <optional>
+        <ref name="doctype"/>
+      </optional>
+      <ref name="editorialgroup"/>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+      <optional>
+        <ref name="security"/>
+      </optional>
+    </define>
+  </include>
+  <define name="committee">
+    <element name="committee">
+      <attribute name="type">
+        <choice>
+          <value>technical</value>
+          <value>provisional</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
+  <define name="security">
+    <element name="security">
+      <text/>
+    </element>
+  </define>
+  <define name="mpfd-standard">
+    <element name="mpfd-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/mpfa/reqt.rng

@@ -0,0 +1,194 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    Presupposes isodoc.rnc, is included in it
+    include "isodoc.rnc" { }
+  -->
+  <define name="requirement">
+    <element name="requirement">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="recommendation">
+    <element name="recommendation">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="permission">
+    <element name="permission">
+      <ref name="RequirementType"/>
+    </element>
+  </define>
+  <define name="RequirementType">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="unnumbered">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
+    <optional>
+      <attribute name="subsequence"/>
+    </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <attribute name="id">
+      <data type="ID"/>
+    </attribute>
+    <optional>
+      <attribute name="filename"/>
+    </optional>
+    <optional>
+      <attribute name="model"/>
+    </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <ref name="reqtitle"/>
+    </optional>
+    <optional>
+      <ref name="label"/>
+    </optional>
+    <optional>
+      <ref name="subject"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="reqinherit"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <choice>
+        <ref name="measurementtarget"/>
+        <ref name="specification"/>
+        <ref name="verification"/>
+        <ref name="import"/>
+        <ref name="description"/>
+      </choice>
+    </zeroOrMore>
+    <optional>
+      <ref name="reqt_references"/>
+    </optional>
+    <zeroOrMore>
+      <choice>
+        <ref name="requirement"/>
+        <ref name="recommendation"/>
+        <ref name="permission"/>
+      </choice>
+    </zeroOrMore>
+  </define>
+  <define name="reqtitle">
+    <element name="title">
+      <ref name="FormattedString"/>
+    </element>
+  </define>
+  <define name="label">
+    <element name="label">
+      <text/>
+    </element>
+  </define>
+  <define name="subject">
+    <element name="subject">
+      <text/>
+    </element>
+  </define>
+  <define name="reqinherit">
+    <element name="inherit">
+      <text/>
+    </element>
+  </define>
+  <define name="measurementtarget">
+    <element name="measurement-target">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="specification">
+    <element name="specification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="verification">
+    <element name="verification">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="import">
+    <element name="import">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="description">
+    <element name="description">
+      <ref name="RequirementSubpart"/>
+    </element>
+  </define>
+  <define name="reqt_references">
+    <element name="references">
+      <oneOrMore>
+        <ref name="bibitem"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="RequirementSubpart">
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="exclude">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-with-next">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="keep-lines-together">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="ObligationType">
+    <choice>
+      <value>requirement</value>
+      <value>recommendation</value>
+      <value>permission</value>
+    </choice>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/mpfa/section.rb

@@ -0,0 +1,61 @@
+module Asciidoctor
+  module MPFA
+
+    # A {Converter} implementation that generates MPFD output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class Converter < Standoc::Converter
+
+      def sections_cleanup(x)
+        super
+        x.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
+        end
+        x.xpath("//*[@guidance]").each do |h|
+          c = h.previous_element || next
+          c.add_child h.remove
+        end
+      end
+
+      def sectiontype_streamline(ret)
+        case ret
+        when "glossary" then "terms and definitions"
+        else
+          super
+        end
+      end
+
+      def term_def_title(_toplevel, node)
+        return node.title
+      end
+
+      def move_sections_into_preface(x, preface)
+        foreword = x.at("//foreword")
+        preface.add_child foreword.remove if foreword
+        introduction = x.at("//introduction")
+        preface.add_child introduction.remove if introduction
+        terms = x.at("//sections/clause[descendant::terms]") || x.at("//terms")
+        preface.add_child terms.remove if terms
+        move_clauses_into_preface(x, preface)
+        acknowledgements = x.at("//acknowledgements")
+        preface.add_child acknowledgements.remove if acknowledgements
+      end
+
+      def make_preface(x, s)
+        if x.at("//foreword | //introduction | //terms | //acknowledgements |"\
+            "//abstract[not(ancestor::bibitem)] | //clause[@preface]")
+          preface = s.add_previous_sibling("<preface/>").first
+          move_sections_into_preface(x, preface)
+          make_abstract(x, s)
+        end
+      end
+
+      def clause_parse(attrs, xml, node)
+        attrs[:guidance] = true if node.role == "guidance"
+        attrs[:container] = true if node.role == "container"
+        super
+      end
+
+    end
+  end
+end

data/lib/asciidoctor/mpfa/validate.rb

@@ -0,0 +1,30 @@
+module Asciidoctor
+  module MPFA
+    class Converter < Standoc::Converter
+      def content_validate(doc)
+        super
+        bibdata_validate(doc.root)
+      end
+
+      def bibdata_validate(doc)
+        doctype_validate(doc)
+        stage_validate(doc)
+      end
+
+      def doctype_validate(xmldoc)
+        doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
+        %w(policy-and-procedures best-practices supporting-document
+        report legal directives proposal standard).include? doctype or
+        @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
+      end
+
+      def stage_validate(xmldoc)
+        stage = xmldoc&.at("//bibdata/status/stage")&.text
+        %w(proposal working-draft committee-draft draft-standard final-draft
+        published withdrawn).include? stage or
+        @log.add("Document Attributes", nil, "#{stage} is not a recognised status")
+      end
+    end
+  end
+end
+

data/lib/isodoc/mpfa/base_convert.rb

@@ -0,0 +1,128 @@
+require "isodoc"
+require_relative "metadata"
+require_relative "xref"
+require  "fileutils"
+
+module IsoDoc
+  module MPFA
+    module BaseConvert
+      def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+      end
+
+      def xref_init(lang, script, klass, labels, options)
+        @xrefs = Xref.new(lang, script, klass, labels, options)
+      end
+
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{@xrefs.anchor(annex['id'], :label)} "
+          t.b do |b|
+            name&.children&.each { |c2| parse(c2, b) }
+          end
+        end
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+
+      def i18n_init(lang, script)
+        super
+        y = if lang == "en"
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            elsif lang == "zh" && script == "Hans"
+              YAML.load_file(File.join(File.dirname(__FILE__),
+                                       "i18n-zh-Hans.yaml"))
+            else
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            end
+        @labels = @labels.merge(y)
+        @annex_lbl = y["annex"]
+        @clause_lbl = y["clause"]
+      end
+
+      def terms_defs_title(f)
+        return f&.at(ns("./title"))&.content
+      end
+
+      TERM_CLAUSE = "//preface/terms | "\
+        "//preface/clause[descendant::terms]".freeze
+
+      SECTIONS_XPATH = 
+        "//foreword | //introduction | //preface/terms | //preface/clause | //annex | "\
+        "//sections/clause | //bibliography/references | //acknowledgements | "\
+        "//bibliography/clause".freeze
+
+      def terms_defs(isoxml, out, num)
+        f = isoxml.at(ns(self.class::TERM_CLAUSE)) or return num
+        out.div **attr_code(id: f["id"]) do |div|
+          clause_name(nil, terms_defs_title(f), div, nil)
+          f.elements.each do |e|
+            parse(e, div) unless %w{title source}.include? e.name
+          end
+        end
+        num
+      end
+
+      FRONT_CLAUSE = "//*[parent::preface]".freeze
+
+      def preface(isoxml, out)
+        isoxml.xpath(ns(self.class::FRONT_CLAUSE)).each do |c|
+          if c.name == "terms" || c.at(ns(".//terms")) then terms_defs isoxml, out, 0
+          else
+            out.div **attr_code(id: c["id"]) do |s|
+              clause_name(@xrefs.anchor(c['id'], :label),
+                          c&.at(ns("./title"))&.content, s, nil)
+              c.elements.reject { |c1| c1.name == "title" }.each do |c1|
+                parse(c1, s)
+              end
+            end
+          end
+        end
+      end
+
+      def middle(isoxml, out)
+        middle_title(out)
+        middle_admonitions(isoxml, out)
+        clause isoxml, out
+        annex isoxml, out
+        bibliography isoxml, out
+      end
+
+      def termdef_parse(node, out)
+        set_termdomain("")
+        node.children.each { |n| parse(n, out) }
+      end
+
+      def clause(isoxml, out)
+        isoxml.xpath(ns(middle_clause)).each do |c|
+          out.div **attr_code(id: c["id"]) do |s|
+            clause_name(@xrefs.anchor(c['id'], :label),
+                        c&.at(ns("./title"))&.content, s, class: c["container"] ? "containerhdr" : nil )
+            c.elements.reject { |c1| c1.name == "title" }.each do |c1|
+              parse(c1, s)
+            end
+          end
+        end
+      end
+
+      def clause_parse_title(node, div, c1, out)
+        if node["inline-header"] == "true"
+          inline_header_title(out, node, c1)
+        else
+          attrs = { class: node["container"] ? "containerhdr" : nil }
+          div.send "h#{@xrefs.anchor(node['id'], :level, :false) || '1'}", **attr_code(attrs) do |h|
+            lbl = @xrefs.anchor(node['id'], :label, false)
+            h << "#{lbl}. " if lbl && !@suppressheadingnumbers
+            c1&.children&.each { |c2| parse(c2, h) }
+          end
+        end
+      end
+
+      def ol_depth(node)
+        ol_style(node["type"])
+      end
+    end
+  end
+end