metanorma-iso 1.4.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e88ecac9a1d970682830fc23fc1b808c7b83dedc00a3e6a3adcad7822225622
-  data.tar.gz: 413f8bb0aac5a124b33992bdaf7977d3e89da0e701512a4d877af68255fd8ba1
+  metadata.gz: 9b80a62eb663a85ad1428d97e32114a9b6341303689f0d43a5bac63e071e4740
+  data.tar.gz: 11412874aa684c02fde2eb00899f1f4290b3cede75b6981f6df11c2b0e99be29
 SHA512:
-  metadata.gz: 7b9b163582c5602c131691c8aa484fe20cf4fe02f2fca00b66ef6d50b5515673b8794e0cd4e4a4e404ff169697221551e7a521dac9c7ebb2998b406de7d9b649
-  data.tar.gz: 26f82fb95d062ddc527a2ac2cefa798edee6771d332307713759ab494fa27a8f16a1e8b27b4f817c088da7ee9e6beac7ea41221618cfd12cfe01dc3f561d309d
+  metadata.gz: 8a513b51527259420edc479f2cb6a2438e47383c66a1aceb2386cfba0ce7b2c7f16d3c55661cf83c6b5d8db35550c1a7354d81474df66d32df3a4dce6c79f104
+  data.tar.gz: 7676550f3771804a384e1b1d7f7948e46e950be96844031108f5d0ef019bbc605d18c8367b428858ea36d97b398134e34a529cb8ab4b09a82ac20594140c420a

data/.github/workflows/ubuntu.yml

@@ -39,7 +39,7 @@ jobs:
           polling_interval_seconds: 5
           timeout_minutes: 5
           max_attempts: 3
-          command: sudo bash -c "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
+          command: sudo apt-get update -y && sudo bash -c "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
       - name: Run specs
         run: |
           bundle exec rake

data/lib/asciidoctor/iso/base.rb

@@ -3,7 +3,6 @@ require "nokogiri"
 require "json"
 require "pathname"
 require "open-uri"
-require "pp"
 require "isodoc"
 require "fileutils"
 require 'asciidoctor/iso/macros'
@@ -47,32 +46,22 @@ module Asciidoctor
 
       def init(node)
         super
-        @amd = %w(amendment technical-corrigendum).include? node.attr("doctype")
+        @amd = %w(amendment technical-corrigendum).include? doctype(node)
       end
 
       def outputs(node, ret)
           File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
           presentation_xml_converter(node).convert(@filename + ".xml")
-          html_converter_alt(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}_alt.html")
-          html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-          doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
-          pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
+          html_converter_alt(node).convert(@filename + ".presentation.xml", 
+                                           nil, false, "#{@filename}_alt.html")
+          html_converter(node).convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.html")
+          doc_converter(node).convert(@filename + ".presentation.xml", 
+                                      nil, false, "#{@filename}.doc")
+          pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.pdf")
           #sts_converter(node)&.convert(@filename + ".xml")
       end
-
-      def load_yaml(lang, script)
-        y = if @i18nyaml then YAML.load_file(@i18nyaml)
-            elsif lang == "en"
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            elsif lang == "fr"
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-fr.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
-        super.merge(y)
-      end
     end
   end
 end

data/lib/asciidoctor/iso/cleanup.rb

@@ -4,20 +4,19 @@ require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
-require "pp"
 require "asciidoctor/iso/term_lookup_cleanup"
 
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
       PRE_NORMREF_FOOTNOTES = "//preface//fn | "\
-        "//clause[title = 'Scope']//fn".freeze
+        "//clause[@type = 'scope']//fn".freeze
 
       NORMREF_FOOTNOTES =
         "//references[@normative = 'true']//fn".freeze
 
       POST_NORMREF_FOOTNOTES =
-        "//sections//clause[not(title = 'Scope')]//fn | "\
+        "//sections//clause[not(@type = 'scope')]//fn | "\
         "//annex//fn | "\
         "//references[@normative = 'false']//fn".freeze
 

data/lib/asciidoctor/iso/front.rb

@@ -4,7 +4,6 @@ require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
-require "pp"
 require_relative "front_id"
 
 module Asciidoctor
@@ -14,7 +13,7 @@ module Asciidoctor
         super
         structured_id(node, xml)
         xml.stagename stage_name(get_stage(node), get_substage(node),
-                                 node.attr("doctype"), node.attr("iteration"))
+                                 doctype(node), node.attr("iteration"))
         @amd && a = node.attr("updates-document-type") and
           xml.updates_document_type a
       end
@@ -35,7 +34,7 @@ module Asciidoctor
 
       def metadata_author(node, xml)
         publishers = node.attr("publisher") || "ISO"
-        publishers.split(/,[ ]?/).each do |p|
+        csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
             c.organization { |a| organization(a, p) }
@@ -45,7 +44,7 @@ module Asciidoctor
 
       def metadata_publisher(node, xml)
         publishers = node.attr("publisher") || "ISO"
-        publishers.split(/,[ ]?/).each do |p|
+        csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "publisher" }
             c.organization { |a| organization(a, p) }
@@ -54,8 +53,8 @@ module Asciidoctor
       end
 
       def metadata_copyright(node, xml)
-        publishers = node.attr("publisher") || "ISO"
-        publishers.split(/,[ ]?/).each do |p|
+        publishers = node.attr("copyright-holder") || node.attr("publisher") || "ISO"
+        csv_split(publishers).each do |p|
           xml.copyright do |c|
             c.from (node.attr("copyright-year") || Date.today.year)
             c.owner do |owner|
@@ -69,7 +68,7 @@ module Asciidoctor
         stage = get_stage(node)
         substage = get_substage(node)
         xml.status do |s|
-          s.stage stage, **attr_code(abbreviation: stage_abbr(stage, substage, node.attr("doctype")))
+          s.stage stage, **attr_code(abbreviation: stage_abbr(stage, substage, doctype(node)))
           s.substage substage
           node.attr("iteration") && (s.iteration node.attr("iteration"))
         end

data/lib/asciidoctor/iso/front_id.rb

@@ -95,7 +95,7 @@ module Asciidoctor
       def add_amd_parts(dn, node)
         a = node.attr("amendment-number")
         c = node.attr("corrigendum-number")
-        case node.attr("doctype")
+        case doctype(node)
         when "amendment"
           "#{dn}/Amd #{node.attr('amendment-number')}"
         when "technical-corrigendum"
@@ -133,12 +133,12 @@ module Asciidoctor
       end
 
       def id_stage_abbr(stage, substage, node)
-        ret = IsoDoc::Iso::Metadata.new("en", "Latn", {}).
-          status_abbrev(stage_abbr(stage, substage, node.attr("doctype")),
+        ret = IsoDoc::Iso::Metadata.new("en", "Latn", @i18n).
+          status_abbrev(stage_abbr(stage, substage, doctype(node)),
                         substage, node.attr("iteration"),
-                        node.attr("draft"), node.attr("doctype"))
+                        node.attr("draft"), doctype(node))
         if %w(amendment technical-corrigendum amendment
-          technical-corrigendum).include?(node.attr("doctype"))
+          technical-corrigendum).include?(doctype(node))
           ret = ret + " " unless %w(40 50).include?(stage)
         end
         ret
@@ -184,7 +184,7 @@ module Asciidoctor
       end
 
       def get_typeabbr(node)
-        case node.attr("doctype")
+        case doctype(node)
         when "technical-report" then "TR "
         when "technical-specification" then "TS "
         else

data/lib/asciidoctor/iso/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -922,6 +925,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +967,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +995,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1017,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1045,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1186,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/iso/section.rb

@@ -5,13 +5,15 @@ module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
       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 scope_parse(attrs, xml, node)
+        attrs = attrs.merge(type: "scope") unless @amd 
+        clause_parse(attrs, xml, node)
+      end
+
       def appendix_parse(attrs, xml, node)
         attrs["inline-header".to_sym] = node.option? "inline-header"
         set_obligation(attrs, node)
@@ -28,14 +30,6 @@ module Asciidoctor
         xml << node.content
       end
 
-      def scope_parse(attrs, xml, node)
-        xml.clause **attr_code(attrs) do |xml_section|
-          xml_section.title { |t| t << "Scope" }
-          content = node.content
-          xml_section << content
-        end
-      end
-
       def section_attributes(node)
         super.merge(
           change: @amd ? node.attr("change") : nil,

data/lib/asciidoctor/iso/term_lookup_cleanup.rb

@@ -75,7 +75,6 @@ module Asciidoctor
 
       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}")

data/lib/asciidoctor/iso/validate_section.rb

@@ -7,6 +7,7 @@ module Asciidoctor
         foreword_validate(doc.root)
         normref_validate(doc.root)
         symbols_validate(doc.root)
+        sections_presence_validate(doc.root)
         sections_sequence_validate(doc.root)
         section_style(doc.root)
         subclause_validate(doc.root)
@@ -46,46 +47,44 @@ module Asciidoctor
       end
 
       def seqcheck(names, msg, accepted)
-        n = names.shift
-        unless accepted.include? n
+        n = names.shift 
+        return [] if n.nil?
+        test = accepted.map { |a| n.at(a) }
+        if test.all? { |a| a.nil? }
           @log.add("Style", nil, msg)
-          names = []
         end
         names
       end
 
+      def sections_presence_validate(root)
+        root.at("//sections/clause[@type = 'scope']") or
+          @log.add("Style", nil, "Scope clause missing")
+        root.at("//references[@normative = 'true']") or
+          @log.add("Style", nil, "Normative references missing")
+        root.at("//terms") or
+          @log.add("Style", nil, "Terms & definitions missing")
+      end
+
       # spec of permissible section sequence
       # we skip normative references, it goes to end of list
       SEQ =
         [
           {
             msg: "Initial section must be (content) Foreword",
-            val:  [{ tag: "foreword", title: "Foreword" }],
+            val:  ["./self::foreword"]
           },
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val:  [{ tag: "introduction", title: "Introduction" },
-                   { tag: "clause", title: "Scope" }],
+            val: ["./self::introduction", "./self::clause[@type = 'scope']" ]
           },
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val: [{ tag: "clause", title: "Scope" }],
+            val: ["./self::clause[@type = 'scope']" ]
           },
           {
             msg: "Normative References must be followed by "\
             "Terms and Definitions",
-            val: [
-              { tag: "terms", title: "Terms and definitions" },
-              { tag: "clause", title: "Terms and definitions" },
-              {
-                tag: "terms",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-              {
-                tag: "clause",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-            ],
+            val: ["./self::terms | .//terms"]
           },
       ].freeze
 
@@ -95,50 +94,47 @@ module Asciidoctor
         "//clause[descendant::references][not(parent::clause)]".freeze
 
       def sections_sequence_validate(root)
-        f = root.xpath(SECTIONS_XPATH)
-        names = f.map { |s| { tag: s.name, title: s&.at("./title")&.text } }
-        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) || return
+        names = root.xpath(SECTIONS_XPATH)
+        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) 
         n = names[0]
-        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) || return
-        if n == { tag: "introduction", title: "Introduction" }
-          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) || return
+        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) 
+        if n&.at("./self::introduction")
+          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) 
         end
-        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) || return
+        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) 
         n = names.shift
-        if n == { tag: "definitions", title: nil }
-          n = names.shift || return
+        if n&.at("./self::definitions")
+          n = names.shift
         end
-        unless n
+        if n.nil? || n.name != "clause"
           @log.add("Style", nil, "Document must contain at least one clause")
-          return
         end
-        n[:tag] == "clause" ||
+        n&.at("./self::clause") ||
           @log.add("Style", nil, "Document must contain clause after "\
                "Terms and Definitions")
-        n == { tag: "clause", title: "Scope" } &&
+        n&.at("./self::clause[@type = 'scope']") &&
           @log.add("Style", nil, "Scope must occur before Terms and Definitions")
-        n = names.shift || return
-        while n[:tag] == "clause"
-          n[:title] == "Scope" &&
+        n = names.shift 
+        while n&.name == "clause"
+          n&.at("./self::clause[@type = 'scope']")
             @log.add("Style", nil, "Scope must occur before Terms and Definitions")
-          n = names.shift || return
+          n = names.shift 
         end
-        unless n[:tag] == "annex" || n[:tag] == "references"
+        unless %w(annex references).include? n&.name
           @log.add("Style", nil, "Only annexes and references can follow clauses")
         end
-        while n[:tag] == "annex"
+        while n&.name == "annex"
           n = names.shift
           if n.nil?
             @log.add("Style", nil, "Document must include (references) "\
                  "Normative References")
-            return
           end
         end
-        n == { tag: "references", title: "Normative References" } ||
+        n&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) "\
                "Normative References")
-        n = names.shift
-        n == { tag: "references", title: "Bibliography" } ||
+        n = names&.shift
+        n&.at("./self::references[@normative = 'false']") ||
           @log.add("Style", nil, "Final section must be (references) Bibliography")
         names.empty? ||
           @log.add("Style", nil, "There are sections after the final Bibliography")
@@ -157,8 +153,8 @@ module Asciidoctor
       def section_style(root)
         foreword_style(root.at("//foreword"))
         introduction_style(root.at("//introduction"))
-        scope_style(root.at("//clause[title = 'Scope']"))
-        scope = root.at("//clause[title = 'Scope']/clause")
+        scope_style(root.at("//clause[@type = 'scope']"))
+        scope = root.at("//clause[@type = 'scope']/clause")
         # ISO/IEC DIR 2, 14.4
         scope.nil? || style_warning(scope, SCOPE_WARN, nil)
       end