metanorma-iso 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e2e7e19a42e3aeb8a036946cd7a312df8887f9a68a9f0b159399c4a2285f636
-  data.tar.gz: 229cbacc6397cdf692b6294d4f46b88a22ad39a18b80e29be3d85f37c1eeb203
+  metadata.gz: 9d170797212efc1050755714c1c875246a5b1b07ca8c4c1b6562b51ab2ee44a9
+  data.tar.gz: a6deb053bf737183c275a1f93a110d89f8fa42a093bafd514c7d672b5e16f427
 SHA512:
-  metadata.gz: bcfbfd49e84b5127ccb0f4cca2777803ea5a560e60267ccd8e077c7a8b68052f38499a2662f3dfea06641f2a8f278525ebc0118ccef63715bf6e4e1f90badbde
-  data.tar.gz: 003f5ae00770eeb488ca7adf2c13a611bb8a79425f223f07ed765fc5b2333e2700c7e27fa720ce8cfbcfd55750dd633f1f035f46026e792cab5d0fa0c83e7c72
+  metadata.gz: 63752e6b4a75cba612fca7cacf5c0ccd7a4553f51b9743e667d7a2891737dff68deace61efcab395be2f22e8b4d6559ee8eee6c50ad84e3f13e627af1ca98a68
+  data.tar.gz: 401f42f155a7424266d3bf62cb6fca9a67ad1adeddf01145c55de95397a91de22847b56fa92563d64045eb6dc2682511eab3925d60f74b1ca737f8ecefacee63

data/lib/asciidoctor/iso/base.rb

@@ -17,8 +17,8 @@ module Asciidoctor
       end
 
       def html_converter_alt(node)
-        IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node).
-                                     merge(alt: true))
+        IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node)
+                                     .merge(alt: true))
       end
 
       def doc_converter(node)
@@ -27,11 +27,13 @@ module Asciidoctor
 
       def pdf_converter(node)
         return nil if node.attr("no-pdf")
+
         IsoDoc::Iso::PdfConvert.new(doc_extract_attributes(node))
       end
 
       def sts_converter(node)
         return nil if node.attr("no-pdf")
+
         IsoDoc::Iso::StsConvert.new(html_extract_attributes(node))
       end
 
@@ -45,22 +47,22 @@ module Asciidoctor
       end
 
       def ol_attrs(node)
-        attr_code(keep_attrs(node).
-                  merge(id: ::Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(keep_attrs(node)
+                  .merge(id: ::Metanorma::Utils::anchor_or_uuid(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", 
+        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", 
+        html_converter(node).convert("#{@filename}.presentation.xml",
                                      nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", 
+        doc_converter(node).convert("#{@filename}.presentation.xml",
                                     nil, false, "#{@filename}.doc")
-        pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+        pdf_converter(node)&.convert("#{@filename}.presentation.xml",
                                      nil, false, "#{@filename}.pdf")
-        #sts_converter(node)&.convert(@filename + ".xml")
+        # sts_converter(node)&.convert(@filename + ".xml")
       end
     end
   end

data/lib/asciidoctor/iso/cleanup.rb

@@ -22,20 +22,19 @@ module Asciidoctor
       def other_footnote_renumber(xmldoc)
         seen = {}
         i = 0
-        xmldoc.xpath(PRE_NORMREF_FOOTNOTES).each do |fn|
-          i, seen = other_footnote_renumber1(fn, i, seen)
-        end
-        xmldoc.xpath(NORMREF_FOOTNOTES).each do |fn|
-          i, seen = other_footnote_renumber1(fn, i, seen)
-        end
-        xmldoc.xpath(POST_NORMREF_FOOTNOTES).each do |fn|
-          i, seen = other_footnote_renumber1(fn, i, seen)
+        [PRE_NORMREF_FOOTNOTES, NORMREF_FOOTNOTES,
+         POST_NORMREF_FOOTNOTES].each do |xpath|
+          xmldoc.xpath(xpath).each do |fn|
+            i, seen = other_footnote_renumber1(fn, i, seen)
+          end
         end
       end
 
       def id_prefix(prefix, id)
-        return id.text if @amd # we're just inheriting the prefixes from parent doc
-        prefix.join("/") + ( id.text.match(%{^/}) ? "" :  " " ) + id.text
+        # we're just inheriting the prefixes from parent doc
+        return id.text if @amd
+
+        prefix.join("/") + (id.text.match?(%{^/}) ? "" : " ") + id.text
       end
 
       def get_id_prefix(xmldoc)
@@ -79,6 +78,7 @@ module Asciidoctor
         return 2 if bib.at("#{PUBLISHER}[name = 'International "\
                            "Electrotechnical Commission']")
         return 3 if bib.at("./docidentifier[@type][not(#{OTHERIDS})]")
+
         4
       end
 
@@ -101,25 +101,26 @@ module Asciidoctor
         num = bib&.at("./docnumber")&.text
         id = bib&.at("./docidentifier[not(#{OTHERIDS})]")
         metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
-        abbrid = metaid unless /^\[\d+\]$/.match(metaid)
+        abbrid = metaid unless /^\[\d+\]$/.match?(metaid)
         /\d-(?<partid>\d+)/ =~ id&.text
-        type = id['type'] if id
+        type = id["type"] if id
         title = bib&.at("./title[@type = 'main']")&.text ||
           bib&.at("./title")&.text || bib&.at("./formattedref")&.text
         "#{pubclass} :: #{type} :: "\
-          "#{num.nil? ? abbrid : sprintf("%09d", num.to_i)} :: "\
+          "#{num.nil? ? abbrid : sprintf('%09d', num.to_i)} :: "\
           "#{partid} :: #{id&.text} :: #{title}"
       end
 
-      def sections_cleanup(x)
+      def sections_cleanup(xml)
         super
         return unless @amd
-        x.xpath("//*[@inline-header]").each do |h|
-          h.delete('inline-header')
+
+        xml.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
         end
       end
 
-      def boilerplate_file(xmldoc)
+      def boilerplate_file(_xmldoc)
         file = @lang == "fr" ? "boilerplate-fr.xml" : "boilerplate.xml"
         File.join(@libdir, file)
       end
@@ -146,14 +147,17 @@ module Asciidoctor
       end
 
       def unpublished_note(xmldoc)
-        xmldoc.xpath("//bibitem[not(note[@type = 'Unpublished-Status'])]").each do |b|
+        xmldoc.xpath("//bibitem[not(note[@type = 'Unpublished-Status'])]")
+          .each do |b|
           next if pub_class(b) > 2
-          next unless s = b.at("./status/stage") and s.text.to_i < 60
+          next unless (s = b.at("./status/stage")) && (s.text.to_i < 60)
+
           id = b.at("docidentifier").text
-          b.at("./language | ./script | ./abstract | ./status").previous = <<~NOTE
-          <note type="Unpublished-Status">
-            <p>#{@i18n.under_preparation.sub(/%/, id)}</p></note>
-          NOTE
+          b.at("./language | ./script | ./abstract | ./status")
+            .previous = <<~NOTE
+              <note type="Unpublished-Status">
+              <p>#{@i18n.under_preparation.sub(/%/, id)}</p></note>
+            NOTE
         end
       end
     end

data/lib/asciidoctor/iso/front.rb

@@ -33,7 +33,9 @@ module Asciidoctor
         csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
-            c.organization { |a| organization(a, p, node, !node.attr("publisher")) }
+            c.organization do |a|
+              organization(a, p, false, node, !node.attr("publisher"))
+            end
           end
         end
       end
@@ -43,20 +45,25 @@ module Asciidoctor
         csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "publisher" }
-            c.organization { |a| organization(a, p, node, !node.attr("publisher")) }
+            c.organization do |a|
+              organization(a, p, true, node, !node.attr("publisher"))
+            end
           end
         end
       end
 
       def metadata_copyright(node, xml)
-        publishers = node.attr("copyright-holder") || node.attr("publisher") || "ISO"
+        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|
               owner.organization do |o|
-                organization(o, p, node,
-                             !(node.attr("copyright-holder") || node.attr("publisher")))
+                organization(
+                  o, p, true, node,
+                  !(node.attr("copyright-holder") || node.attr("publisher"))
+                )
               end
             end
           end
@@ -82,34 +89,37 @@ module Asciidoctor
         end
       end
 
-      def title_intro(node, t, lang, at)
+      def title_intro(node, xml, lang, at)
         return unless node.attr("title-intro-#{lang}")
-        t.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
+
+        xml.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-intro-#{lang}"))
         end
       end
 
-      def title_main(node, t, lang, at)
-        t.title **attr_code(at.merge(type: "title-main")) do |t1|
+      def title_main(node, xml, lang, at)
+        xml.title **attr_code(at.merge(type: "title-main")) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-main-#{lang}"))
         end
       end
 
-      def title_part(node, t, lang, at)
+      def title_part(node, xml, lang, at)
         return unless node.attr("title-part-#{lang}")
-        t.title(**attr_code(at.merge(type: "title-part"))) do |t1|
+
+        xml.title(**attr_code(at.merge(type: "title-part"))) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
         end
       end
 
-      def title_amd(node, t, lang, at)
+      def title_amd(node, xml, lang, at)
         return unless node.attr("title-amendment-#{lang}")
-        t.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
+
+        xml.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
         end
       end
 
-      def title_full(node, t, lang, at)
+      def title_full(node, xml, lang, at)
         title = node.attr("title-main-#{lang}")
         intro = node.attr("title-intro-#{lang}")
         part = node.attr("title-part-#{lang}")
@@ -117,7 +127,7 @@ module Asciidoctor
         title = "#{intro} -- #{title}" if intro
         title = "#{title} -- #{part}" if part
         title = "#{title} -- #{amd}" if amd && @amd
-        t.title **attr_code(at.merge(type: "main")) do |t1|
+        xml.title **attr_code(at.merge(type: "main")) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(title)
         end
       end

data/lib/asciidoctor/iso/validate.rb

@@ -1,8 +1,9 @@
 require "metanorma-standoc"
-require_relative "./validate_style.rb"
-require_relative "./validate_requirements.rb"
-require_relative "./validate_section.rb"
-require_relative "./validate_title.rb"
+require_relative "./validate_style"
+require_relative "./validate_requirements"
+require_relative "./validate_section"
+require_relative "./validate_title"
+require_relative "./validate_image"
 require "nokogiri"
 require "jing"
 require "iev"
@@ -10,17 +11,6 @@ require "iev"
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
-      # ISO/IEC DIR 2, 22.3.2
-      def onlychild_clause_validate(root)
-        root.xpath(Standoc::Utils::SUBCLAUSE_XPATH).each do |c|
-          next unless c.xpath("../clause").size == 1
-          title = c.at("./title")
-          location = c["id"] || c.text[0..60] + "..."
-          location += ":#{title.text}" if c["id"] && !title.nil?
-          @log.add("Style", nil, "#{location}: subclause is only child")
-        end
-      end
-
       def isosubgroup_validate(root)
         root.xpath("//technical-committee/@type").each do |t|
           unless %w{TC PC JTC JPC}.include? t.text
@@ -37,12 +27,13 @@ module Asciidoctor
       end
 
       # ISO/IEC DIR 2, 15.5.3
+      # does not deal with preceding text marked up
       def see_xrefs_validate(root)
         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)
+
           (target = root.at("//*[@id = '#{t['target']}']")) || next
           if target&.at("./ancestor-or-self::*[@obligation = 'normative']")
             @log.add("Style", t,
@@ -54,36 +45,34 @@ module Asciidoctor
       # ISO/IEC DIR 2, 15.5.3
       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)
+          prec = t.at("./preceding-sibling::text()[last()]")
+          next unless !prec.nil? && /\b(see|refer to)\s*$/mi.match(prec)
+
           unless target = root.at("//*[@id = '#{t['bibitemid']}']")
             @log.add("Bibliography", t,
                      "'#{t} is not pointing to a real reference")
             next
           end
-          if target.at("./ancestor::references[@normative = 'true']")
+          target.at("./ancestor::references[@normative = 'true']") and
             @log.add("Style", t,
                      "'see #{t}' is pointing to a normative reference")
-          end
         end
       end
 
       # ISO/IEC DIR 2, 10.4
       def locality_erefs_validate(root)
         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")
-            end
+          if /^(ISO|IEC)/.match?(t["citeas"]) &&
+              !(/: ?(\d+{4}|–)$/.match?(t["citeas"]))
+            @log.add("Style", t,
+                     "undated reference #{t['citeas']} should not contain "\
+                     "specific elements")
           end
         end
       end
 
-      def termdef_warn(text, re, t, term, msg)
-        re.match(text) && @log.add("Style", t, "#{term}: #{msg}")
+      def termdef_warn(text, regex, elem, term, msg)
+        regex.match(text) && @log.add("Style", elem, "#{term}: #{msg}")
       end
 
       # ISO/IEC DIR 2, 16.5.6
@@ -103,6 +92,7 @@ module Asciidoctor
       def cited_term_style(xmldoc)
         xmldoc.xpath("//term//xref").each do |x|
           next unless xmldoc.at("//term[@id = '#{x['target']}']")
+
           x&.previous&.text == " (" and x&.previous&.previous&.name == "em" or
             style_warning(x, "term citation not preceded with italicised term",
                           x.parent.text)
@@ -111,8 +101,8 @@ module Asciidoctor
 
       def doctype_validate(xmldoc)
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
-        %w(international-standard technical-specification technical-report 
-        publicly-available-specification international-workshop-agreement 
+        %w(international-standard technical-specification technical-report
+        publicly-available-specification international-workshop-agreement
         guide amendment technical-corrigendum).include? doctype or
         @log.add("Document Attributes", nil,
                  "#{doctype} is not a recognised document type")
@@ -146,84 +136,6 @@ module Asciidoctor
                    "#{iteration} is not a recognised iteration")
       end
 
-      # DRG directives 3.7; but anticipated by standoc
-      def subfigure_validate(xmldoc)
-        xmldoc.xpath("//figure//figure").each do |f|
-          { footnote: "fn", note: "note", key: "dl" }.each do |k, v|
-            f.xpath(".//#{v}").each do |n|
-              @log.add("Style", n, "#{k} is not permitted in a subfigure")
-            end
-          end
-        end
-      end
-
-      def image_name_prefix(xmldoc)
-        std = xmldoc&.at("//bibdata/ext/structuredidentifier/project-number") or return
-        num = xmldoc&.at("//bibdata/docnumber")&.text or return
-        ed = xmldoc&.at("//bibdata/edition")&.text || "1"
-        prefix = num
-        part = std["part"] and prefix += "-#{std['part']}"
-        prefix += "_ed#{ed}"
-        amd = std["amendment"] and prefix += "amd#{amd}"
-        prefix
-      end
-
-      def image_name_suffix(xmldoc)
-        case xmldoc&.at("//bibdata/language")&.text
-        when "fr" then "_f"
-        when "de" then "_d"
-        when "ru" then "_r"
-        when "es" then "_s"
-        when "ar" then "_a"
-        when "en" then "_e"
-        else
-          "_e"
-        end
-      end
-
-      def disjunct_error(i, cond1, cond2, msg1, msg2)
-        cond1 && !cond2 and @log.add("Style", i, "image name #{i['src']} #{msg1}")
-        !cond1 && cond2 and @log.add("Style", i, "image name #{i['src']} #{msg2}")
-      end
-
-      def image_name_validate1(i, prefix)
-        m = %r[(SL)?#{prefix}fig(?<tab>Tab)?(?<annex>[A-Z])?(Text)?(?<num>\d+)
-            (?<subfig>[a-z])?(?<key>_key\d+)?(?<lang>_[a-z])?$]x.match(File.basename(i["src"], ".*"))
-        if m.nil?
-          @log.add("Style", i, "image name #{i['src']} does not match DRG requirements")
-          return
-        end
-        warn i['src']
-        disjunct_error(i, i.at("./ancestor::table"), !m[:tab].nil?,
-                       "is under a table but is not so labelled", "is labelled as under a table but is not")
-        disjunct_error(i, i.at("./ancestor::annex"), !m[:annex].nil?,
-                       "is under an annex but is not so labelled", "is labelled as under an annex but is not")
-        disjunct_error(i, i.xpath("./ancestor::figure").size > 1, !m[:subfig].nil?,
-                       "does not have a subfigure letter but is a subfigure",
-                       "has a subfigure letter but is not a subfigure")
-        lang = image_name_suffix(i.document.root)
-        (m[:lang] || "_e") == lang or @log.add("Style", i, "image name #{i['src']} expected to have suffix #{lang}")
-      end
-
-      # DRG directives 3.2
-      def image_name_validate(xmldoc)
-        prefix = image_name_prefix(xmldoc) or return
-        xmldoc.xpath("//image").each do |i|
-          next if i["src"].start_with?("data:")
-          if /^ISO_\d+_/.match(File.basename(i["src"]))
-          elsif /^(SL)?#{prefix}fig/.match(File.basename(i["src"]))
-            image_name_validate1(i, prefix)
-          else
-            @log.add("Style", i, "image name #{i['src']} does not match DRG requirements: expect #{prefix}fig")
-          end
-        end
-      end
-
-      def figure_validate(xmldoc)
-        image_name_validate(xmldoc)
-        subfigure_validate(xmldoc)
-      end
-
       def bibdata_validate(doc)
         doctype_validate(doc)
         script_validate(doc)
@@ -251,7 +163,7 @@ module Asciidoctor
         xmldoc.xpath("//bibitem[date/on = '–']").each do |b|
           b.at("./note[@type = 'Unpublished-Status']") or
             @log.add("Style", b,
-                     "Reference #{b&.at("./@id")&.text} does not have an "\
+                     "Reference #{b&.at('./@id')&.text} does not have an "\
                      "associated footnote indicating unpublished status")
         end
       end