isodoc 2.3.6 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa570f1c978671ee699be488fae2f0fe3835db689bfa7c5c0c1183e0a87f1854
-  data.tar.gz: 2ae14cde9d26714858c4240012d29e4483b22044d8112256627a709bc2704aee
+  metadata.gz: 4a7c100c4751a8d8bfe69eeaf31614c74bfeec4c56d188fd0d4a6a16c09d3257
+  data.tar.gz: '0858086207425a9c38bb6f12fba1a219599c4c7e469aea40e4f29255f152333b'
 SHA512:
-  metadata.gz: 39d02fd071cd42d4e3771e1d6c6ed938024a2fd0842820d775b35cd5494371c31c09232b39c5526a921b81d660f9e2d9d3222e35c347b899d09c2fab8e35fed1
-  data.tar.gz: 3da1407baf7cd7a36e414925755436fbf4547f8f64da8c739c2e53edcda4e7a3d72a40efd5bb9be93bc9f9f28c626f59903b802e58b764f68e571e5172455398
+  metadata.gz: bc74e409e73b0b63f5a609e44b0a90a88cf4e83253604cbf6634f62b9c6ff12cccdc40fa2399acd4c373c44d3748ff311828890f319fc508c35e4993c88ff800
+  data.tar.gz: b6f7d0abe389ee3c0342fbdd862f0671bc94959eb9f7b3755e51c7aac1aad74e65127b8819f5b3f310a8e2c2ede29dd663642f9a16e12b5fdf563dd9e2e9bb4f

data/isodoc.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-utils", "~> 1.4.5"
   spec.add_dependency "mn2pdf"
-  spec.add_dependency "mn-requirements", "~> 0.2.0"
+  spec.add_dependency "mn-requirements", "~> 0.3.1"
   spec.add_dependency "relaton-cli"
   spec.add_dependency "relaton-render", "~> 0.5.2"
   spec.add_dependency "roman-numerals"

data/lib/isodoc/class_utils.rb

@@ -47,6 +47,11 @@ module IsoDoc
       end
     end
 
+    def to_xml(node)
+      node&.to_xml(encoding: "UTF-8", indent: 0,
+                   save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
+    end
+
     def case_with_markup(linkend, casing, script, firstonly: true)
       seen = false
       xml = Nokogiri::XML("<root>#{linkend}</root>")
@@ -57,7 +62,7 @@ module IsoDoc
                                       firstonly: firstonly))
         seen = true if firstonly
       end
-      xml.root.children.to_xml
+      to_xml(xml.root.children)
     end
 
     def nearest_block_parent(node)

data/lib/isodoc/function/inline_simple.rb

@@ -72,7 +72,8 @@ module IsoDoc
       end
 
       def underline_parse(node, out)
-        out.u do |e|
+        node["style"] and style = "text-decoration: #{node['style']}"
+        out.u **attr_code(style: style) do |e|
           node.children.each { |n| parse(n, e) }
         end
       end

data/lib/isodoc/function/utils.rb

@@ -3,6 +3,10 @@ require "metanorma-utils"
 module IsoDoc
   module Function
     module Utils
+      def to_xml(node)
+        self.class.to_xml(node)
+      end
+
       def date_range(date)
         self.class.date_range(date)
       end

data/lib/isodoc/html_function/html.rb

@@ -78,7 +78,7 @@ module IsoDoc
       def html_button
         return "" if @bare
 
-        '<button onclick="topFunction()" id="myBtn" '\
+        '<button onclick="topFunction()" id="myBtn" ' \
         'title="Go to top">Top</button>'.freeze
       end
 
@@ -121,7 +121,9 @@ module IsoDoc
       end
 
       def underline_parse(node, out)
-        out.span **{ style: "text-decoration: underline;" } do |e|
+        style = node["style"] ? " #{node['style']}" : ""
+        attr = { style: "text-decoration: underline#{style}" }
+        out.span **attr do |e|
           node.children.each { |n| parse(n, e) }
         end
       end

data/lib/isodoc/presentation_function/bibdata.rb

@@ -10,7 +10,7 @@ module IsoDoc
       address_precompose(a)
       bibdata_i18n(a)
       a.next =
-        "<localized-strings>#{i8n_name(trim_hash(@i18n.get), '').join}"\
+        "<localized-strings>#{i8n_name(trim_hash(@i18n.get), '').join}" \
         "</localized-strings>"
     end
 
@@ -24,7 +24,7 @@ module IsoDoc
       @toctables and
         ins << "<toc type='table'><title>#{@i18n.toc_tables}</title></toc>"
       @tocfigures and
-        ins << "<toc type='recommendation'><title>#{@i18n.toc_recommendations}"\
+        ins << "<toc type='recommendation'><title>#{@i18n.toc_recommendations}" \
                "</title></toc>"
     end
 
@@ -50,17 +50,17 @@ module IsoDoc
     end
 
     def presmeta(name, value)
-      "<presentation-metadata><name>#{name}</name><value>#{value}</value>"\
+      "<presentation-metadata><name>#{name}</name><value>#{value}</value>" \
         "</presentation-metadata>"
     end
 
     def address_precompose1(addr)
       ret = []
-      addr.xpath(ns("./street")).each { |s| ret << s.children.to_xml }
-      a = addr.at(ns("./city")) and ret << a.children.to_xml
-      addr.xpath(ns("./state")).each { |s| ret << s.children.to_xml }
-      a = addr.at(ns("./country")) and ret << a.children.to_xml
-      a = addr.at(ns("./postcode")) and ret[-1] += " #{a.children.to_xml}"
+      addr.xpath(ns("./street")).each { |s| ret << to_xml(s.children) }
+      a = addr.at(ns("./city")) and ret << to_xml(a.children)
+      addr.xpath(ns("./state")).each { |s| ret << to_xml(s.children) }
+      a = addr.at(ns("./country")) and ret << to_xml(a.children)
+      a = addr.at(ns("./postcode")) and ret[-1] += " #{to_xml a.children}"
       ret.join("<br/>")
     end
 
@@ -118,7 +118,7 @@ module IsoDoc
     end
 
     def i18n_tag(key, value)
-      "<localized-string key='#{key}' language='#{@lang}'>#{value}"\
+      "<localized-string key='#{key}' language='#{@lang}'>#{value}" \
         "</localized-string>"
     end
 

data/lib/isodoc/presentation_function/erefs.rb

@@ -9,7 +9,7 @@ module IsoDoc
 
     def erefstack1(elem)
       locs = elem.xpath(ns("./eref")).map do |e|
-        [e["connective"], e.to_xml]
+        [e["connective"], to_xml(e)]
       end.flatten
       ret = resolve_eref_connectives(locs)
       elem.replace(ret[1])
@@ -30,9 +30,9 @@ module IsoDoc
       ret = resolve_eref_connectives(eref_locality_stacks(refs, target,
                                                           node))
       node.delete("droploc") unless droploc
-      eref_localities1(target,
-                       refs.first.at(ns("./locality/@type")).text,
-                       l10n(ret[1..-1].join), nil, node, @lang)
+      eref_localities1({ target: target, number: "pl",
+                         type: refs.first.at(ns("./locality/@type")).text,
+                         from: l10n(ret[1..-1].join), node: node, lang: @lang })
     end
 
     def can_conflate_eref_rendering?(refs)
@@ -61,19 +61,24 @@ module IsoDoc
       locs1 = []
       add = ""
       until locs.empty?
-        if [", ", " "].include?(locs[1])
-          add += locs[0..2].join
-          locs.shift(3)
-        else
-          locs1 << add unless add.empty?
-          add = ""
-          locs1 << locs.shift
-        end
+        locs, locs1, add = resolve_comma_connectives1(locs, locs1, add)
       end
       locs1 << add unless add.empty?
       locs1
     end
 
+    def resolve_comma_connectives1(locs, locs1, add)
+      if [", ", " "].include?(locs[1])
+        add += locs[0..2].join
+        locs.shift(3)
+      else
+        locs1 << add unless add.empty?
+        add = ""
+        locs1 << locs.shift
+      end
+      [locs, locs1, add]
+    end
+
     def resolve_to_connectives(locs)
       locs1 = []
       until locs.empty?
@@ -108,12 +113,7 @@ module IsoDoc
     def eref_locality_stack(ref, idx, target, node)
       ret = []
       if ref.name == "localityStack"
-        ref.elements.each_with_index do |rr, j|
-          l = eref_localities0(rr, j, target, node) or next
-
-          ret << l
-          ret << locality_delimiter(rr) unless j == ref.elements.size - 1
-        end
+        ret = eref_locality_stack1(ref, target, node, ret)
       else
         l = eref_localities0(ref, idx, target, node) and ret << l
       end
@@ -121,6 +121,15 @@ module IsoDoc
       ret
     end
 
+    def eref_locality_stack1(ref, target, node, ret)
+      ref.elements.each_with_index do |rr, j|
+        l = eref_localities0(rr, j, target, node) or next
+        ret << l
+        ret << locality_delimiter(rr) unless j == ref.elements.size - 1
+      end
+      ret
+    end
+
     def locality_delimiter(_loc)
       ", "
     end
@@ -128,38 +137,43 @@ module IsoDoc
     def eref_localities0(ref, _idx, target, node)
       if ref["type"] == "whole" then @i18n.wholeoftext
       else
-        eref_localities1(target, ref["type"],
-                         ref&.at(ns("./referenceFrom"))&.text,
-                         ref&.at(ns("./referenceTo"))&.text, node, @lang)
+        eref_localities1({ target: target, type: ref["type"], number: "sg",
+                           from: ref.at(ns("./referenceFrom"))&.text,
+                           upto: ref.at(ns("./referenceTo"))&.text, node: node,
+                           lang: @lang })
       end
     end
 
-    def eref_localities1_zh(_target, type, from, upto, node)
-      ret = "第#{from}" if from
-      ret += "&#x2013;#{upto}" if upto
-      loc = eref_locality_populate(type, node)
-      ret += " #{loc}" unless node["droploc"] == "true"
+    # def eref_localities1_zh(_target, type, from, upto, node)
+    def eref_localities1_zh(opt)
+      ret = "第#{opt[:from]}" if opt[:from]
+      ret += "&#x2013;#{opt[:upto]}" if opt[:upto]
+      loc = eref_locality_populate(opt[:type], opt[:node], "sg")
+      ret += " #{loc}" unless opt[:node]["droploc"] == "true"
       ret
     end
 
-    def eref_localities1(target, type, from, upto, node, lang = "en")
-      return nil if type == "anchor"
+    # def eref_localities1(target, type, from, upto, node, lang = "en")
+    def eref_localities1(opt)
+      return nil if opt[:type] == "anchor"
 
-      lang == "zh" and
-        return l10n(eref_localities1_zh(target, type, from, upto, node))
-      ret = eref_locality_populate(type, node)
-      ret += " #{from}" if from
-      ret += "&#x2013;#{upto}" if upto
+      opt[:lang] == "zh" and
+        # return l10n(eref_localities1_zh(target, type, from, upto, node))
+        return l10n(eref_localities1_zh(opt))
+      ret = eref_locality_populate(opt[:type], opt[:node], opt[:number])
+      ret += " #{opt[:from]}" if opt[:from]
+      ret += "&#x2013;#{opt[:upto]}" if opt[:upto]
       l10n(ret)
     end
 
-    def eref_locality_populate(type, node)
+    def eref_locality_populate(type, node, number)
       return "" if node["droploc"] == "true"
 
       loc = type.sub(/^locality:/, "")
       ret = @i18n.locality[loc] || loc
+      number == "pl" and ret = @i18n.inflect(ret, number: "pl")
       ret = case node["case"]
-            when "lowercase" then loc.downcase
+            when "lowercase" then ret.downcase
             else Metanorma::Utils.strict_capitalize_first(ret)
             end
       " #{ret}"

data/lib/isodoc/presentation_function/refs.rb

@@ -20,7 +20,7 @@ module IsoDoc
       d.remove_namespaces!
       refs = d.xpath("//references/bibitem").each_with_object([]) do |b, m|
         prep_for_rendering(b)
-        m << b.to_xml
+        m << to_xml(b)
       end.join
       bibrenderer.render_all("<references>#{refs}</references>",
                              type: citestyle)

data/lib/isodoc/presentation_function/section.rb

@@ -55,7 +55,7 @@ module IsoDoc
     def annex1(elem)
       lbl = @xrefs.anchor(elem["id"], :label)
       if t = elem.at(ns("./title"))
-        t.children = "<strong>#{t.children.to_xml}</strong>"
+        t.children = "<strong>#{to_xml(t.children)}</strong>"
       end
       prefix_name(elem, "<br/><br/>", lbl, "title")
     end

data/lib/isodoc/presentation_function/terms.rb

@@ -24,7 +24,7 @@ module IsoDoc
       concept1_linkmention(ref, render, opts)
       concept1_ref(node, ref, opts)
       concept1_nonital(node, opts)
-      node.replace(node.children.to_xml.strip)
+      node.replace(node.children)
     end
 
     def concept1_nonital(node, opts)
@@ -68,8 +68,8 @@ module IsoDoc
            !c.text? || /\S/.match(c)
          end.empty?
         ref.replace(@i18n.term_defined_in.sub(/%/,
-                                              ref.to_xml))
-      else ref.replace("[#{ref.to_xml}]")
+                                              to_xml(ref)))
+      else ref.replace("[#{to_xml(ref)}]")
       end
     end
 
@@ -83,7 +83,7 @@ module IsoDoc
       label = @i18n.relatedterms[node["type"]].upcase
       if p && ref
         node.replace(l10n("<p><strong>#{label}:</strong> " \
-                          "<em>#{p.to_xml}</em> (#{ref.to_xml})</p>"))
+                          "<em>#{to_xml(p)}</em> (#{Common::to_xml(ref)})</p>"))
       else
         node.replace(l10n("<p><strong>#{label}:</strong> " \
                           "<strong>**RELATED TERM NOT FOUND**</strong></p>"))
@@ -110,7 +110,7 @@ module IsoDoc
       if merge_preferred_eligible?(pref, second)
         n1 = pref.at(ns("./expression/name"))
         n2 = second.remove.at(ns("./expression/name"))
-        n1.children = l10n("#{n1.children.to_xml}; #{n2.children.to_xml}")
+        n1.children = l10n("#{to_xml(n1.children)}; #{Common::to_xml(n2.children)}")
       end
     end
 
@@ -150,7 +150,7 @@ module IsoDoc
 
     def designation_field(desgn, name)
       f = desgn.xpath(ns("./field-of-application | ./usage-info"))
-        &.map { |u| u.children.to_xml }&.join(", ")
+        &.map { |u| to_xml(u.children) }&.join(", ")
       return nil if f&.empty?
 
       name << ", &#x3c;#{f}&#x3e;"
@@ -181,7 +181,7 @@ module IsoDoc
     def designation_pronunciation(desgn, name)
       f = desgn.at(ns("./expression/pronunciation")) or return
 
-      name << ", /#{f.children.to_xml}/"
+      name << ", /#{to_xml(f.children)}/"
     end
 
     def termexample(docxml)
@@ -214,9 +214,9 @@ module IsoDoc
 
     def multidef(elem)
       d = elem.at(ns("./definition"))
-      d = d.replace("<ol><li>#{d.children.to_xml}</li></ol>").first
+      d = d.replace("<ol><li>#{to_xml(d.children)}</li></ol>").first
       elem.xpath(ns("./definition")).each do |f|
-        f = f.replace("<li>#{f.children.to_xml}</li>").first
+        f = f.replace("<li>#{to_xml(f.children)}</li>").first
         d << f
       end
       d.wrap("<definition></definition>")
@@ -242,9 +242,9 @@ module IsoDoc
 
     def termsource1(elem)
       while elem&.next_element&.name == "termsource"
-        elem << "; #{elem.next_element.remove.children.to_xml}"
+        elem << "; #{to_xml(elem.next_element.remove.children)}"
       end
-      elem.children = l10n("[#{@i18n.source}: #{elem.children.to_xml.strip}]")
+      elem.children = l10n("[#{@i18n.source}: #{to_xml(elem.children).strip}]")
     end
 
     def termsource_modification(mod)

data/lib/isodoc/presentation_function/xrefs.rb

@@ -38,14 +38,20 @@ module IsoDoc
     def anchor_xref(node, target)
       x = @xrefs.anchor(target, :xref)
       t = @xrefs.anchor(target, :title)
-      if node["style"] == "basic" && t then t
-      elsif node["style"] == "full" && t
-        l10n("#{x}, #{t}")
-      else x
+      case node["style"]
+      when "basic" then t || x
+      when "full" then t ? anchor_xref_full(x, t) : x
+      when "short", nil then x
+      else @xrefs.anchor(target, node[:style].to_sym)
       end
     end
 
+    def anchor_xref_full(num, title)
+      l10n("#{num}, #{title}")
+    end
+
     def prefix_container?(container, node)
+      node["style"] == "modspec" and return false # TODO: move to mn-requirements?
       type = @xrefs.anchor(node["target"], :type)
       container &&
         get_note_container_id(node, type) != container &&
@@ -66,8 +72,8 @@ module IsoDoc
     def combine_conflated_xref_locations(locs)
       out = locs.each { |l| l[:label] = anchor_value(l[:target]) }
       label = @i18n.inflect(locs.first[:elem], number: "pl")
-      ret = l10n("#{label} #{combine_conn(out)}")
-      combine_conflated_xref_locations_container(locs, ret)
+      out[0][:label] = l10n("#{label} #{out[0][:label]}")
+      combine_conflated_xref_locations_container(locs, l10n(combine_conn(out)))
     end
 
     def combine_conflated_xref_locations_container(locs, ret)

data/lib/isodoc/presentation_xml_convert.rb

@@ -85,11 +85,11 @@ module IsoDoc
     end
 
     def postprocess(result, filename, _dir)
-      to_xml(result, filename)
+      to_xml_file(result, filename)
       @files_to_delete.each { |f| FileUtils.rm_rf f }
     end
 
-    def to_xml(result, filename)
+    def to_xml_file(result, filename)
       File.open(filename, "w:UTF-8") { |f| f.write(result) }
     end
   end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.3.6".freeze
+  VERSION = "2.4.0".freeze
 end

data/lib/isodoc/xref/xref_gen.rb

@@ -62,7 +62,7 @@ module IsoDoc
             @anchors[n["id"]] =
               { label: termnote_label(c.print), type: "termnote",
                 value: c.print, elem: @labels["termnote"],
-                xref: l10n("#{anchor(t['id'], :xref)}, "\
+                xref: l10n("#{anchor(t['id'], :xref)}, " \
                            "#{@labels['note_xref']} #{c.print}") }
           end
         end
@@ -82,10 +82,10 @@ module IsoDoc
       end
 
       SECTIONS_XPATH =
-        "//foreword | //introduction | //acknowledgements | "\
-        "//preface/terms | preface/definitions | preface/references | "\
-        "//preface/clause | //sections/terms | //annex | "\
-        "//sections/clause | //sections/definitions | "\
+        "//foreword | //introduction | //acknowledgements | " \
+        "//preface/terms | preface/definitions | preface/references | " \
+        "//preface/clause | //sections/terms | //annex | " \
+        "//sections/clause | //sections/definitions | " \
         "//bibliography/references | //bibliography/clause".freeze
 
       def sections_xpath
@@ -93,8 +93,8 @@ module IsoDoc
       end
 
       CHILD_NOTES_XPATH =
-        "./*[not(self::xmlns:clause) and not(self::xmlns:appendix) and "\
-        "not(self::xmlns:terms) and not(self::xmlns:definitions)]//xmlns:note | "\
+        "./*[not(self::xmlns:clause) and not(self::xmlns:appendix) and " \
+        "not(self::xmlns:terms) and not(self::xmlns:definitions)]//xmlns:note | " \
         "./xmlns:note".freeze
 
       def note_anchor_names(sections)
@@ -117,11 +117,11 @@ module IsoDoc
       end
 
       CHILD_EXAMPLES_XPATH =
-        "./*[not(self::xmlns:clause) and not(self::xmlns:appendix) and "\
-        "not(self::xmlns:terms) and not(self::xmlns:definitions)]//"\
+        "./*[not(self::xmlns:clause) and not(self::xmlns:appendix) and " \
+        "not(self::xmlns:terms) and not(self::xmlns:definitions)]//" \
         "xmlns:example | ./xmlns:example".freeze
 
-      CHILD_SECTIONS = "./clause | ./appendix | ./terms | ./definitions | "\
+      CHILD_SECTIONS = "./clause | ./appendix | ./terms | ./definitions | " \
                        "./references".freeze
 
       def example_anchor_names(sections)
@@ -205,7 +205,7 @@ module IsoDoc
         label = dterm.dup
         label.xpath(ns(".//p")).each { |x| x.replace(x.children) }
         label.xpath(ns(".//index")).each(&:remove)
-        label.children.to_xml
+        Common::to_xml(label.children)
       end
 
       def bookmark_anchor_names(xml)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.3.6
+  version: 2.4.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2022-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.1
 - !ruby/object:Gem::Dependency
   name: relaton-cli
   requirement: !ruby/object:Gem::Requirement
@@ -497,7 +497,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Convert documents in IsoDoc into Word and HTML in AsciiDoc.