metanorma-iso 1.3.23 → 1.4.0

data/lib/asciidoctor/iso/isostandard-amd.rng

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar ns="https://www.metanorma.org/ns/iso" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!-- default namespace isostandard = "https://www.metanorma.com/ns/iso" -->
+  <include href="isostandard.rng">
+    <start>
+      <ref name="iso-standard"/>
+    </start>
+    <define name="sections">
+      <element name="sections">
+        <oneOrMore>
+          <ref name="clause"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="clause">
+      <element name="clause">
+        <optional>
+          <attribute name="type"/>
+        </optional>
+        <optional>
+          <attribute name="change">
+            <choice>
+              <value>add</value>
+              <value>delete</value>
+              <value>modify</value>
+            </choice>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="locality"/>
+        </optional>
+        <ref name="Clause-Section"/>
+      </element>
+    </define>
+    <define name="iso-standard">
+      <element name="iso-standard">
+        <ref name="bibdata"/>
+        <optional>
+          <ref name="boilerplate"/>
+        </optional>
+        <ref name="preface"/>
+        <oneOrMore>
+          <ref name="sections"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="documentnumber">
+      <element name="project-number">
+        <optional>
+          <attribute name="part">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="subpart">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="amendment">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="corrigendum">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="origyr">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <text/>
+      </element>
+    </define>
+    <define name="BibDataExtensionType">
+      <ref name="doctype"/>
+      <ref name="editorialgroup"/>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+      <ref name="structuredidentifier"/>
+      <optional>
+        <ref name="stagename"/>
+      </optional>
+      <optional>
+        <ref name="updates_document_type"/>
+      </optional>
+    </define>
+  </include>
+  <!-- end overrides -->
+  <define name="updates_document_type">
+    <element name="updates-document-type">
+      <ref name="DocumentType"/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/iso/isostandard.rng

@@ -91,6 +91,12 @@
     </define>
     <define name="sections">
       <element name="sections">
+        <zeroOrMore>
+          <choice>
+            <ref name="note"/>
+            <ref name="admonition"/>
+          </choice>
+        </zeroOrMore>
         <ref name="clause"/>
         <optional>
           <choice>
@@ -263,6 +269,8 @@
         <value>publicly-available-specification</value>
         <value>international-workshop-agreement</value>
         <value>guide</value>
+        <value>amendment</value>
+        <value>technical-corrigendum</value>
       </choice>
     </define>
     <define name="structuredidentifier">
@@ -354,6 +362,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
         <optional>
           <attribute name="subsequence"/>
         </optional>
@@ -510,7 +521,7 @@
         </attribute>
       </optional>
       <oneOrMore>
-        <ref name="paragraph-with-footnote"/>
+        <ref name="BasicBlock"/>
       </oneOrMore>
     </element>
   </define>

data/lib/asciidoctor/iso/macros.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'asciidoctor/extensions'
+
+module Asciidoctor
+  module Iso
+    # Macro to transform `term[X,Y]` into em, termxref xml
+    class TermRefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+
+      named :term
+      name_positional_attributes 'name', 'termxref'
+      using_format :short
+
+      def process(_parent, _target, attrs)
+        termref = attrs['termxref'] || attrs['name']
+        "<em>#{attrs['name']}</em> (<termxref>#{termref}</termxref>)"
+      end
+    end
+  end
+end

data/lib/asciidoctor/iso/reqt.rng

@@ -30,9 +30,22 @@
         <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>
@@ -141,6 +154,16 @@
         <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>

data/lib/asciidoctor/iso/section.rb

@@ -4,38 +4,12 @@ require "uri"
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
-      def section(node)
-        a = section_attributes(node)
-        noko do |xml|
-          case sectiontype(node)
-          when "foreword" then foreword_parse(a, xml, node)
-          when "introduction" then introduction_parse(a, xml, node)
-          when "patent notice" then patent_notice_parse(xml, node)
-          when "scope" then scope_parse(a, xml, node)
-          when "normative references" then norm_ref_parse(a, xml, node)
-          when "terms and definitions"
-            @term_def = true
-            term_def_parse(a, xml, node, true)
-            @term_def = false
-          when "symbols and abbreviated terms"
-            symbols_parse(a, xml, node)
-          when "acknowledgements"
-            acknowledgements_parse(a, xml, node)
-          when "bibliography" then bibliography_parse(a, xml, node)
-          else
-            if @term_def then term_def_subclause_parse(a, xml, node)
-            elsif @biblio then bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "bibliography"
-              bibliography_parse(a, xml, node)
-            elsif node.attr("style") == "appendix" && node.level == 1
-              annex_parse(a, xml, node)
-            elsif node.option? "appendix"
-              appendix_parse(a, xml, node)
-            else
-              clause_parse(a, xml, node)
-            end
-          end
-        end.join("\n")
+      def clause_parse(attrs, xml, node)
+        title = node&.attr("heading")&.downcase ||
+          node.title.gsub(/<[^>]+>/, "").downcase
+        title == "scope" and return scope_parse(attrs, xml, node)
+        node.option? "appendix" and return appendix_parse(attrs, xml, node)
+        super
       end
 
       def appendix_parse(attrs, xml, node)
@@ -61,6 +35,18 @@ module Asciidoctor
           xml_section << content
         end
       end
+
+      def section_attributes(node)
+        super.merge(
+          change: @amd ? node.attr("change") : nil,
+          locality: @amd ? node.attr("locality") : nil,
+        )
+      end
+
+      def sectiontype(node, level = true)
+        return nil if @amd
+        super
+      end
     end
   end
 end

data/lib/asciidoctor/iso/term_lookup_cleanup.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true.
+
+module Asciidoctor
+  module ISO
+    # Intelligent term lookup xml modifier
+    # Lookup all `term` and `calause` tags and replace `termxref` tags with
+    # `xref`:target tag
+    class TermLookupCleanup
+      AUTOMATIC_GENERATED_ID_REGEXP = /\A_/
+      EXISTING_TERM_REGEXP = /\Aterm-/
+
+      attr_reader :xmldoc, :termlookup, :log
+
+      def initialize(xmldoc, log)
+        @xmldoc = xmldoc
+        @log = log
+        @termlookup = {}
+      end
+
+      def call
+        @termlookup = replace_automatic_generated_ids_terms
+        set_termxref_tags_target
+      end
+
+      private
+
+      def set_termxref_tags_target
+        xmldoc.xpath('//termxref').each do |node|
+          target = normalize_ref_id(node.text)
+          if termlookup[target].nil?
+            remove_missing_ref(node, target)
+            next
+          end
+          modify_ref_node(node, target)
+        end
+      end
+
+      def remove_missing_ref(node, target)
+        log.add('AsciiDoc Input', node,
+                %(Error: Term reference in `term[#{target}]` missing: \
+                "#{target}" is not defined in document))
+        term_name_node = node.previous.previous
+        term_name_node.remove
+        term_name_node.name = "strong"
+        term_name_node.children.first.content =
+          %(term "#{term_name_node.text}" not resolved)
+        node.add_previous_sibling(term_name_node)
+        node.remove
+      end
+
+      def modify_ref_node(node, target)
+        node.name = 'xref'
+        node['target'] = termlookup[target]
+        node.children.remove
+        node.remove_attribute('defaultref')
+      end
+
+      def replace_automatic_generated_ids_terms
+        xmldoc.xpath('//term').each.with_object({}) do |term_node, res|
+          normalize_id_and_memorize(term_node, res, './preferred')
+        end
+      end
+
+      def normalize_id_and_memorize(term_node, res_table, text_selector)
+        term_text = normalize_ref_id(term_node.at(text_selector).text)
+                  unless AUTOMATIC_GENERATED_ID_REGEXP.match(term_node['id']).nil?
+        term_node['id'] = unique_text_id(term_text)
+                  end
+        res_table[term_text] = term_node['id']
+      end
+
+      def normalize_ref_id(text)
+        text.downcase.gsub(/[[:space:]]/, '-')
+      end
+
+      def unique_text_id(text)
+        return "term-#{text}" if xmldoc.at("//*[@id = 'term-#{text}']").nil?
+
+        (1..Float::INFINITY).lazy.each do |index|
+          if xmldoc.at("//*[@id = 'term-#{text}-#{index}']").nil?
+            break("term-#{text}-#{index}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/iso/validate.rb

@@ -24,12 +24,14 @@ module Asciidoctor
       def isosubgroup_validate(root)
         root.xpath("//technical-committee/@type").each do |t|
           unless %w{TC PC JTC JPC}.include? t.text
-            @log.add("Document Attributes", nil, "invalid technical committee type #{t}")
+            @log.add("Document Attributes", nil,
+                     "invalid technical committee type #{t}")
           end
         end
         root.xpath("//subcommittee/@type").each do |t|
           unless %w{SC JSC}.include? t.text
-            @log.add("Document Attributes", nil, "invalid subcommittee type #{t}")
+            @log.add("Document Attributes", nil,
+                     "invalid subcommittee type #{t}")
           end
         end
       end
@@ -39,10 +41,12 @@ module Asciidoctor
         root.xpath("//xref").each do |t|
           # does not deal with preceding text marked up
           preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\b(see| refer to)\s*$/mi.match(preceding)
+          next unless !preceding.nil? &&
+            /\b(see| refer to)\s*$/mi.match(preceding)
           (target = root.at("//*[@id = '#{t['target']}']")) || next
           if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
-            @log.add("Style", t, "'see #{t['target']}' is pointing to a normative section")
+            @log.add("Style", t,
+                     "'see #{t['target']}' is pointing to a normative section")
           end
         end
       end
@@ -51,14 +55,16 @@ module Asciidoctor
       def see_erefs_validate(root)
         root.xpath("//eref").each do |t|
           preceding = t.at("./preceding-sibling::text()[last()]")
-          next unless !preceding.nil? && /\b(see|refer to)\s*$/mi.match(preceding)
+          next unless !preceding.nil? &&
+            /\b(see|refer to)\s*$/mi.match(preceding)
           unless target = root.at("//*[@id = '#{t['bibitemid']}']")
-            @log.add("Bibliography", t, "'#{t} is not pointing to a real reference")
+            @log.add("Bibliography", t,
+                     "'#{t} is not pointing to a real reference")
             next
           end
-          if target.at("./ancestor::references"\
-              "[title = 'Normative References']")
-            @log.add("Style", t, "'see #{t}' is pointing to a normative reference")
+          if target.at("./ancestor::references[@normative = 'true']")
+            @log.add("Style", t,
+                     "'see #{t}' is pointing to a normative reference")
           end
         end
       end
@@ -68,8 +74,9 @@ module Asciidoctor
         root.xpath("//eref[descendant::locality]").each do |t|
           if /^(ISO|IEC)/.match t["citeas"]
             unless /:[ ]?(\d+{4}|–)$/.match t["citeas"]
-              @log.add("Style", t, "undated reference #{t['citeas']} should not contain "\
-                "specific elements")
+              @log.add("Style", t,
+                       "undated reference #{t['citeas']} should not contain "\
+                       "specific elements")
             end
           end
         end
@@ -106,32 +113,37 @@ module Asciidoctor
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
         %w(international-standard technical-specification technical-report 
         publicly-available-specification international-workshop-agreement 
-        guide).include? doctype or
-        @log.add("Document Attributes", nil, "#{doctype} is not a recognised document type")
+        guide amendment technical-corrigendum).include? doctype or
+        @log.add("Document Attributes", nil,
+                 "#{doctype} is not a recognised document type")
       end
 
       def script_validate(xmldoc)
         script = xmldoc&.at("//bibdata/script")&.text
         script == "Latn" or
-          @log.add("Document Attributes", nil, "#{script} is not a recognised script")
+          @log.add("Document Attributes", nil,
+                   "#{script} is not a recognised script")
       end
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
         %w(00 10 20 30 40 50 60 90 95).include? stage or
-          @log.add("Document Attributes", nil, "#{stage} is not a recognised stage")
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not a recognised stage")
       end
 
       def substage_validate(xmldoc)
         substage = xmldoc&.at("//bibdata/status/substage")&.text or return
         %w(00 20 60 90 92 93 98 99).include? substage or
-          @log.add("Document Attributes", nil, "#{substage} is not a recognised substage")
+          @log.add("Document Attributes", nil,
+                   "#{substage} is not a recognised substage")
       end
 
       def iteration_validate(xmldoc)
         iteration = xmldoc&.at("//bibdata/status/iteration")&.text or return
         /^\d+/.match(iteration) or
-          @log.add("Document Attributes", nil, "#{iteration} is not a recognised iteration")
+          @log.add("Document Attributes", nil,
+                   "#{iteration} is not a recognised iteration")
       end
 
       def bibdata_validate(doc)
@@ -158,20 +170,24 @@ module Asciidoctor
 
       def bibitem_validate(xmldoc)
         xmldoc.xpath("//bibitem[date/on = '–']").each do |b|
-          found = false
-          b.xpath("./note").each do |n|
-            found = true if /^ISO DATE:/.match n.text
-          end
-          found or
-            @log.add("Style", b, "Reference #{b&.at("./@id")&.text} does not have an "\
-          "associated footnote indicating unpublished status")
+          b.at("./note[@type = 'ISO DATE']") or
+            @log.add("Style", b,
+                     "Reference #{b&.at("./@id")&.text} does not have an "\
+                     "associated footnote indicating unpublished status")
         end
       end
 
       def validate(doc)
         content_validate(doc)
+        doctype = doc&.at("//bibdata/ext/doctype")&.text
+        schema = case doctype
+                 when "amendment", "technical-corrigendum" # @amd
+                   "isostandard-amd.rng"
+                 else
+                   "isostandard.rng"
+                 end
         schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "isostandard.rng"))
+                        File.join(File.dirname(__FILE__), schema))
       end
     end
   end