isodoc 1.7.6.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 411fdbd359b728afea9bcab7225c1e79a2a2698dd37c6219c70a1434cfa09286
-  data.tar.gz: 05a4997c47971d8cc74985ea8a0cf7b4e2c0d0e15a144e68eae007ce24176c9a
+  metadata.gz: 38ce5f3d119cf53361811f16b0ff8ed4108116c02e0816ab5ba31846934c3c29
+  data.tar.gz: 5ffb61e6729edb93e5e3ba1916e531bf7e1511bfdbd5fe0e0cd1405590971c4d
 SHA512:
-  metadata.gz: 7db1599bdd9d90aada565fbb02d4744a1ac85de0798c2dfd33d2b76905e5f40894042df0e0131a282fa669509f590cf471285188f6dd8e3c091d3bf6c0809bb3
-  data.tar.gz: cd90f9f57aa3ccd37d59d7ebc14438dd37c8812e3d131d7d82618499bfd69c25f660716a508621f536e72a68b942571347fb7218a746c42e61296e4e7fef3da8
+  metadata.gz: e023cfd0d05068daf11e4ccf5c6aab29ff037ec562b65e65f769f7d64c9d4a6c681895dfba5539a2b8a8ee310facba56dad371a21a5f0ced621ebacbf64a8ddf
+  data.tar.gz: 6412c5b7f2b11c4eedf1ab840461a703d1342e148ae89607ea30bb7faff05591aa33132dd2a1b660a92a0e3466060ef404cab4564c5a10bd909843293b4c9ad1

data/isodoc.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "asciimath"
-  spec.add_dependency "html2doc", "~> 1.1.1"
+  spec.add_dependency "html2doc", "~> 1.2.0"
   spec.add_dependency "htmlentities", "~> 4.3.4"
   spec.add_dependency "liquid", "~> 4"
   # spec.add_dependency "metanorma", ">= 1.2.0"
@@ -43,7 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "twitter_cldr", ">= 6.6.0"
   spec.add_dependency "uuidtools"
 
-  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

data/lib/isodoc/class_utils.rb

@@ -16,7 +16,7 @@ module IsoDoc
       xpath.gsub(%r{/([a-zA-z])}, "/xmlns:\\1")
         .gsub(%r{::([a-zA-z])}, "::xmlns:\\1")
         .gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]* ?=)}, "[xmlns:\\1")
-        .gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]*\])}, "[xmlns:\\1")
+        .gsub(%r{\[([a-zA-z][a-z0-9A-Z@/]*[/\]])}, "[xmlns:\\1")
     end
 
     def liquid(doc)
@@ -27,5 +27,28 @@ module IsoDoc
       end.join
       Liquid::Template.parse(doc)
     end
+
+    def case_strict(text, casing, script)
+      return text unless %w(Latn Cyrl Grek Armn).include?(script)
+
+      letters = text.chars
+      case casing
+      when "capital" then letters.first.upcase!
+      when "lowercase" then letters.first.downcase!
+      end
+      letters.join
+    end
+
+    def case_with_markup(linkend, casing, script)
+      seen = false
+      xml = Nokogiri::XML("<root>#{linkend}</root>")
+      xml.traverse do |b|
+        next unless b.text? && !seen
+
+        b.replace(Common::case_strict(b.text, casing, script))
+        seen = true
+      end
+      xml.root.children.to_xml
+    end
   end
 end

data/lib/isodoc/convert.rb

@@ -102,6 +102,7 @@ module IsoDoc
       @bookmarks_allocated = { "X" => true }
       @fn_bookmarks = {}
       @baseassetpath = options[:baseassetpath]
+      @aligncrosselements = options[:aligncrosselements]
     end
 
     def tmpimagedir_suffix
@@ -118,6 +119,7 @@ module IsoDoc
 
     def convert1(docxml, filename, dir)
       @xrefs.parse docxml
+      bibitem_lookup(docxml)
       noko do |xml|
         xml.html **{ lang: @lang.to_s } do |html|
           html.parent.add_namespace("epub", "http://www.idpf.org/2007/ops")
@@ -129,6 +131,13 @@ module IsoDoc
       end.join("\n")
     end
 
+    def bibitem_lookup(docxml)
+      @bibitems = docxml.xpath(ns("//references/bibitem"))
+        .each_with_object({}) do |b, m|
+        m[b["id"]] = b
+      end
+    end
+
     def metadata_init(lang, script, i18n)
       @meta = Metadata.new(lang, script, i18n)
     end

data/lib/isodoc/function/cleanup.rb

@@ -165,6 +165,10 @@ module IsoDoc
             t << a.remove
           end
         end
+        table_footnote_cleanup_propagate(docxml)
+      end
+
+      def table_footnote_cleanup_propagate(docxml)
         docxml.xpath("//p[not(self::*[@class])]"\
                      "[ancestor::*[@class = 'TableFootnote']]").each do |p|
           p["class"] = "TableFootnote"

data/lib/isodoc/function/inline.rb

@@ -5,7 +5,7 @@ module IsoDoc
     module Inline
       def link_parse(node, out)
         url = node["target"]
-        node["updatetype"] == "true" and url = suffix_url(url)
+        node["update-type"] == "true" and url = suffix_url(url)
         out.a **attr_code(href: url, title: node["alt"]) do |l|
           if node.text.empty?
             l << node["target"].sub(/^mailto:/, "")
@@ -41,10 +41,8 @@ module IsoDoc
       end
 
       def eref_target(node)
-        href = "##{node['bibitemid']}"
-        url = node.at(ns("//bibitem[@id = '#{node['bibitemid']}']/"\
-                         "uri[@type = 'citation']"))
-        return href unless url
+        return "##{node['bibitemid']}" unless url = @bibitems[node["bibitemid"]]
+          &.at(ns("./uri[@type = 'citation']"))
 
         href = suffix_url(url.text)
         anchor = node&.at(ns(".//locality[@type = 'anchor']"))&.text&.strip

data/lib/isodoc/html_function/html.rb

@@ -5,6 +5,7 @@ module IsoDoc
   module HtmlFunction
     module Html
       def convert1(docxml, filename, dir)
+        bibitem_lookup(docxml)
         noko do |xml|
           xml.html **{ lang: @lang.to_s } do |html|
             info docxml, nil

data/lib/isodoc/html_function/postprocess.rb

@@ -1,5 +1,6 @@
 require "isodoc/html_function/mathvariant_to_plain"
 require_relative "postprocess_footnotes"
+require "metanorma-utils"
 
 module IsoDoc
   module HtmlFunction
@@ -74,7 +75,8 @@ module IsoDoc
         head = docxml.at("//*[local-name() = 'head']")
         head << htmlstylesheet(@htmlstylesheet)
         s = htmlstylesheet(@htmlstylesheet_override) and head << s
-        @bare and head << "<style>body {margin-left: 2em; margin-right: 2em;}</style>"
+        @bare and
+          head << "<style>body {margin-left: 2em; margin-right: 2em;}</style>"
         docxml
       end
 
@@ -167,11 +169,7 @@ module IsoDoc
       end
 
       def datauri(img)
-        type = img["src"].split(".")[-1]
-        supertype = type == "xml" ? "application" : "image"
-        bin = IO.binread(image_localfile(img))
-        data = Base64.strict_encode64(bin)
-        img["src"] = "data:#{supertype}/#{type};base64,#{data}"
+        img["src"] = Metanorma::Utils::datauri(img["src"], @localdir)
       end
 
       def image_suffix(img)

data/lib/isodoc/metadata_date.rb

@@ -6,7 +6,7 @@ module IsoDoc
                    vote-ended}.freeze
 
     def months
-    {
+      {
         "01": @labels["month_january"],
         "02": @labels["month_february"],
         "03": @labels["month_march"],
@@ -19,30 +19,32 @@ module IsoDoc
         "10": @labels["month_october"],
         "11": @labels["month_november"],
         "12": @labels["month_december"],
-    }
+      }
     end
 
     def monthyr(isodate)
       m = /(?<yr>\d\d\d\d)-(?<mo>\d\d)/.match isodate
       return isodate unless m && m[:yr] && m[:mo]
+
       l10n("#{months[m[:mo].to_sym]} #{m[:yr]}",
-                                   @lang, @script)
+           @lang, @script)
     end
 
     def MMMddyyyy(isodate)
       return nil if isodate.nil?
+
       arr = isodate.split("-")
-      date = if arr.size == 1 and (/^\d+$/.match isodate)
-               Date.new(*arr.map(&:to_i)).strftime("%Y")
-             elsif arr.size == 2
-               Date.new(*arr.map(&:to_i)).strftime("%B %Y")
-             else
-               Date.parse(isodate).strftime("%B %d, %Y")
-             end
+      if arr.size == 1 && (/^\d+$/.match isodate)
+        Date.new(*arr.map(&:to_i)).strftime("%Y")
+      elsif arr.size == 2
+        Date.new(*arr.map(&:to_i)).strftime("%B %Y")
+      else
+        Date.parse(isodate).strftime("%B %d, %Y")
+      end
     end
 
     def bibdate(isoxml, _out)
-      isoxml.xpath(ns('//bibdata/date')).each do |d|
+      isoxml.xpath(ns("//bibdata/date")).each do |d|
         set("#{d['type'].gsub(/-/, '_')}date".to_sym, Common::date_range(d))
       end
     end

data/lib/isodoc/presentation_function/bibdata.rb

@@ -10,7 +10,7 @@ module IsoDoc
         "</localized-strings>"
     end
 
-     def docid_prefixes(docxml)
+    def docid_prefixes(docxml)
       docxml.xpath(ns("//references/bibitem/docidentifier")).each do |i|
         i.children = @xrefs.klass.docid_prefix(i["type"], i.text)
       end
@@ -97,7 +97,7 @@ module IsoDoc
 
     # https://stackoverflow.com/a/31822406
     def blank?(elem)
-      elem.nil? || elem.respond_to?(:empty?) && elem.empty?
+      elem.nil? || (elem.respond_to?(:empty?) && elem.empty?)
     end
 
     def trim_hash(hash)

data/lib/isodoc/presentation_function/block.rb

@@ -54,12 +54,6 @@ module IsoDoc
       end
     end
 
-    def termexample(docxml)
-      docxml.xpath(ns("//termexample")).each do |f|
-        example1(f)
-      end
-    end
-
     def example1(elem)
       n = @xrefs.get[elem["id"]]
       lbl = if n.nil? || n[:label].nil? || n[:label].empty?
@@ -89,36 +83,6 @@ module IsoDoc
       prefix_name(elem, "", lbl, "name")
     end
 
-    def termnote(docxml)
-      docxml.xpath(ns("//termnote")).each do |f|
-        termnote1(f)
-      end
-    end
-
-    # introduce name element
-    def termnote1(elem)
-      lbl = l10n(@xrefs.anchor(elem["id"], :label) || "???")
-      prefix_name(elem, "", lower2cap(lbl), "name")
-    end
-
-    def termdefinition(docxml)
-      docxml.xpath(ns("//term[definition]")).each do |f|
-        termdefinition1(f)
-      end
-    end
-
-    def termdefinition1(elem)
-      return unless elem.xpath(ns("./definition")).size > 1
-
-      d = elem.at(ns("./definition"))
-      d = d.replace("<ol><li>#{d.children.to_xml}</li></ol>").first
-      elem.xpath(ns("./definition")).each do |f|
-        f = f.replace("<li>#{f.children.to_xml}</li>").first
-        d << f
-      end
-      d.wrap("<definition></definition>")
-    end
-
     def recommendation(docxml)
       docxml.xpath(ns("//recommendation")).each do |f|
         recommendation1(f, lower2cap(@i18n.recommendation))

data/lib/isodoc/presentation_function/inline.rb

@@ -1,5 +1,4 @@
 require "metanorma-utils"
-require_relative "./concept"
 
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
@@ -7,13 +6,16 @@ module IsoDoc
       l10n("#{@xrefs.anchor(container, :xref)}, #{linkend}")
     end
 
+    def anchor_value(id)
+      @xrefs.anchor(id, :value) || @xrefs.anchor(id, :label) ||
+        @xrefs.anchor(id, :xref)
+    end
+
     def anchor_linkend(node, linkend)
       if node["citeas"].nil? && node["bibitemid"]
         return @xrefs.anchor(node["bibitemid"], :xref) || "???"
       elsif node["target"] && node["droploc"]
-        return @xrefs.anchor(node["target"], :value) ||
-            @xrefs.anchor(node["target"], :label) ||
-            @xrefs.anchor(node["target"], :xref) || "???"
+        return anchor_value(node["target"]) || "???"
       elsif node["target"] && !/.#./.match(node["target"])
         linkend = anchor_linkend1(node)
       end
@@ -27,14 +29,15 @@ module IsoDoc
       (container && get_note_container_id(node) != container &&
        @xrefs.get[node["target"]]) and
         linkend = prefix_container(container, linkend, node["target"])
-      capitalise_xref(node, linkend)
+      capitalise_xref(node, linkend, anchor_value(node["target"]))
     end
 
-    def capitalise_xref(node, linkend)
-      return linkend unless %w(Latn Cyrl Grek).include? @script
-      return linkend&.capitalize if node["case"] == "capital"
-      return linkend&.downcase if node["case"] == "lowercase"
-      return linkend if linkend[0, 1].match?(/\p{Upper}/)
+    def capitalise_xref(node, linkend, label)
+      linktext = linkend.gsub(/<[^>]+>/, "")
+      (label && !label.empty? && /^#{Regexp.escape(label)}/.match?(linktext)) ||
+        linktext[0, 1].match?(/\p{Upper}/) and return linkend
+      node["case"] and
+        return Common::case_with_markup(linkend, node["case"], @script)
 
       capitalise_xref1(node, linkend)
     end
@@ -43,7 +46,7 @@ module IsoDoc
       prec = nearest_block_parent(node).xpath("./descendant-or-self::text()") &
         node.xpath("./preceding::text()")
       if prec.empty? || /(?!<[^.].)\.\s+$/.match(prec.map(&:text).join)
-        linkend&.capitalize
+        Common::case_with_markup(linkend, "capital", @script)
       else linkend
       end
     end

data/lib/isodoc/presentation_function/terms.rb

@@ -0,0 +1,223 @@
+module IsoDoc
+  class PresentationXMLConvert < ::IsoDoc::Convert
+    def concept(docxml)
+      docxml.xpath(ns("//concept")).each { |f| concept1(f) }
+    end
+
+    def concept1(node)
+      xref = node&.at(ns("./xref/@target"))&.text or
+        return concept_render(node, ital: node["ital"] || "true",
+                                    ref: node["ref"] || "true",
+                                    linkref: node["linkref"] || "true",
+                                    linkmention: node["linkmention"] || "false")
+      if node.at(ns("//definitions//dt[@id = '#{xref}']"))
+        concept_render(node, ital: node["ital"] || "false",
+                             ref: node["ref"] || "false",
+                             linkref: node["linkref"] || "true",
+                             linkmention: node["linkmention"] || "false")
+      else concept_render(node, ital: node["ital"] || "true",
+                                ref: node["ref"] || "true",
+                                linkref: node["linkref"] || "true",
+                                linkmention: node["linkmention"] || "false")
+      end
+    end
+
+    def concept_render(node, opts)
+      node&.at(ns("./refterm"))&.remove
+      r = node.at(ns("./renderterm"))
+      ref = node.at(ns("./xref | ./eref | ./termref"))
+      ref && opts[:ref] != "false" and r&.next = " "
+      opts[:ital] == "true" and r&.name = "em"
+      concept1_linkmention(ref, r, opts)
+      concept1_ref(node, ref, opts)
+      if opts[:ital] == "false"
+        r = node.at(ns(".//renderterm"))
+        r&.replace(r&.children)
+      end
+      node.replace(node.children)
+    end
+
+    def concept1_linkmention(ref, renderterm, opts)
+      if opts[:linkmention] == "true" && !renderterm.nil? && !ref.nil?
+        ref2 = ref.clone
+        r2 = renderterm.clone
+        renderterm.replace(ref2).children = r2
+      end
+    end
+
+    def concept1_ref(_node, ref, opts)
+      ref.nil? and return
+      return ref.remove if opts[:ref] == "false"
+
+      r = concept1_ref_content(ref)
+      ref = r.at("./descendant-or-self::xmlns:xref | "\
+                 "./descendant-or-self::xmlns:eref | "\
+                 "./descendant-or-self::xmlns:termref")
+      %w(xref eref).include? ref&.name and get_linkend(ref)
+      if opts[:linkref] == "false" && %w(xref eref).include?(ref&.name)
+        ref.replace(ref.children)
+      end
+    end
+
+    def concept1_ref_content(ref)
+      if non_locality_elems(ref).select do |c|
+           !c.text? || /\S/.match(c)
+         end.empty?
+        ref.replace(@i18n.term_defined_in.sub(/%/,
+                                              ref.to_xml))
+      else ref.replace("[#{ref.to_xml}]")
+      end
+    end
+
+    def related(docxml)
+      docxml.xpath(ns("//related")).each { |f| related1(f) }
+    end
+
+    def related1(node)
+      p = node.at(ns("./preferred"))
+      ref = node.at(ns("./xref | ./eref | ./termref"))
+      label = @i18n.relatedterms[node["type"]].upcase
+      node.replace(l10n("<p><strong>#{label}:</strong> "\
+                        "<em>#{p.to_xml}</em> (#{ref.to_xml})</p>"))
+    end
+
+    def designation(docxml)
+      docxml.xpath(ns("//term")).each do |t|
+        merge_second_preferred(t)
+      end
+      docxml.xpath(ns("//preferred | //admitted | //deprecates")).each do |p|
+        designation1(p)
+      end
+    end
+
+    def merge_second_preferred(term)
+      pref = nil
+      term.xpath(ns("./preferred[expression/name]")).each_with_index do |p, i|
+        if i.zero? then pref = p
+        elsif merge_preferred_eligible?(pref, p)
+          pref.at(ns("./expression/name")) <<
+            l10n("; #{p.at(ns('./expression/name')).children.to_xml}")
+          p.remove
+        end
+      end
+    end
+
+    def merge_preferred_eligible?(first, second)
+      firstex = first.at(ns("./expression")) || {}
+      secondex = second.at(ns("./expression")) || {}
+      first["geographic-area"] == second["geographic-area"] &&
+        firstex["language"] == secondex["language"] &&
+        !first.at(ns("./pronunciation | ./grammar")) &&
+        !second.at(ns("./pronunciation | ./grammar"))
+    end
+
+    def designation1(desgn)
+      s = desgn.at(ns("./termsource"))
+      name = desgn.at(ns("./expression/name | ./letter-symbol/name | "\
+                         "./graphical-symbol")) or return
+
+      designation_annotate(desgn, name)
+      s and desgn.next = s
+    end
+
+    def designation_annotate(desgn, name)
+      designation_boldface(desgn)
+      designation_field(desgn, name)
+      g = desgn.at(ns("./expression/grammar")) and
+        name << ", #{designation_grammar(g).join(', ')}"
+      designation_localization(desgn, name)
+      designation_pronunciation(desgn, name)
+      desgn.children = name.children
+    end
+
+    def designation_boldface(desgn)
+      desgn.name == "preferred" or return
+      name = desgn.at(ns("./expression/name | ./letter-symbol/name")) or return
+      name.children = "<strong>#{name.children}</strong>"
+    end
+
+    def designation_field(desgn, name)
+      f = desgn.xpath(ns("./field-of-application | ./usage-info"))
+        &.map { |u| u.children.to_xml }&.join(", ")
+      return nil if f&.empty?
+
+      name << ", &lt;#{f}&gt;"
+    end
+
+    def designation_grammar(grammar)
+      ret = []
+      grammar.xpath(ns("./gender | ./number")).each do |x|
+        ret << @i18n.grammar_abbrevs[x.text]
+      end
+      %w(isPreposition isParticiple isAdjective isVerb isAdverb isNoun)
+        .each do |x|
+        grammar.at(ns("./#{x}[text() = 'true']")) and
+          ret << @i18n.grammar_abbrevs[x]
+      end
+      ret
+    end
+
+    def designation_localization(desgn, name)
+      loc = [desgn&.at(ns("./expression/@language"))&.text,
+             desgn&.at(ns("./expression/@script"))&.text,
+             desgn&.at(ns("./@geographic-area"))&.text].compact
+      return if loc.empty?
+
+      name << ", #{loc.join(' ')}"
+    end
+
+    def designation_pronunciation(desgn, name)
+      f = desgn.at(ns("./expression/pronunciation")) or return
+
+      name << ", /#{f.children.to_xml}/"
+    end
+
+    def termexample(docxml)
+      docxml.xpath(ns("//termexample")).each do |f|
+        example1(f)
+      end
+    end
+
+    def termnote(docxml)
+      docxml.xpath(ns("//termnote")).each do |f|
+        termnote1(f)
+      end
+    end
+
+    # introduce name element
+    def termnote1(elem)
+      lbl = l10n(@xrefs.anchor(elem["id"], :label) || "???")
+      prefix_name(elem, "", lower2cap(lbl), "name")
+    end
+
+    def termdefinition(docxml)
+      docxml.xpath(ns("//term[definition]")).each do |f|
+        termdefinition1(f)
+      end
+    end
+
+    def termdefinition1(elem)
+      unwrap_definition(elem)
+      multidef(elem) if elem.xpath(ns("./definition")).size > 1
+    end
+
+    def multidef(elem)
+      d = elem.at(ns("./definition"))
+      d = d.replace("<ol><li>#{d.children.to_xml}</li></ol>").first
+      elem.xpath(ns("./definition")).each do |f|
+        f = f.replace("<li>#{f.children.to_xml}</li>").first
+        d << f
+      end
+      d.wrap("<definition></definition>")
+    end
+
+    def unwrap_definition(elem)
+      elem.xpath(ns("./definition")).each do |d|
+        %w(verbal-definition non-verbal-representation).each do |e|
+          v = d&.at(ns("./#{e}"))
+          v&.replace(v.children)
+        end
+      end
+    end
+  end
+end

data/lib/isodoc/presentation_xml_convert.rb

@@ -1,4 +1,5 @@
 require_relative "presentation_function/block"
+require_relative "presentation_function/terms"
 require_relative "presentation_function/inline"
 require_relative "presentation_function/math"
 require_relative "presentation_function/section"
@@ -25,6 +26,7 @@ module IsoDoc
       @xrefs.parse docxml
       section docxml
       block docxml
+      terms docxml
       inline docxml
     end
 
@@ -46,17 +48,13 @@ module IsoDoc
       sourcecode docxml
       formula docxml
       example docxml
-      termexample docxml
       note docxml
-      termnote docxml
-      termdefinition docxml
       permission docxml
       requirement docxml
       recommendation docxml
     end
 
     def inline(docxml)
-      concept docxml
       xref docxml
       eref docxml
       origin docxml
@@ -65,6 +63,15 @@ module IsoDoc
       variant docxml
     end
 
+    def terms(docxml)
+      termexample docxml
+      termnote docxml
+      termdefinition docxml
+      designation docxml
+      concept docxml
+      related docxml
+    end
+
     def postprocess(result, filename, _dir)
       toXML(result, filename)
       @files_to_delete.each { |f| FileUtils.rm_rf f }

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "1.7.6.1".freeze
+  VERSION = "1.8.2".freeze
 end