isodoc 3.1.3 → 3.1.5

data/lib/isodoc/presentation_function/math.rb

@@ -149,11 +149,7 @@ module IsoDoc
     def maths_just_numeral(node)
       mn = node.at(".//m:mn", MATHML).children.text
         .sub(/\^([0-9+-]+)$/, "<sup>\\1</sup>")
-      #if node.parent.parent.name == "stem"
-        #node.replace(mn)
-      #else
-        node.replace(mn)
-      #end
+      node.replace(mn)
     end
 
     def mathml1(node, locale)
@@ -209,11 +205,7 @@ module IsoDoc
     def mathml_number_to_number(node)
       (node.elements.size == 1 && node.elements.first.name == "mn") or return
       repl = node.at("./m:mn", MATHML).children
-      #if node.parent.name == "stem"
-        #node.parent.replace(repl)
-      #else
-        node.replace(repl)
-      #end
+      node.replace(repl)
     end
   end
 end

data/lib/isodoc/presentation_function/xrefs.rb

@@ -5,7 +5,7 @@ module IsoDoc
         sem_xml_descendant?(x) and next
         tag = x.name
         y = Nokogiri::XML::Node.new("fmt-#{tag}", x.document)
-        x.attributes.each_key { |a| y[a] = x[a] }
+        x.attributes.keys.reject { |a| a == "id" }.each { |a| y[a] = x[a] }
         n = semx_fmt_dup(x) # semx/fmt-xref for ease of processing
         n.children.each { |c| y << c }
         n << y

data/lib/isodoc/presentation_xml_convert.rb

@@ -1,4 +1,5 @@
 require_relative "presentation_function/block"
+require_relative "presentation_function/list"
 require_relative "presentation_function/reqt"
 require_relative "presentation_function/concepts"
 require_relative "presentation_function/terms"
@@ -21,34 +22,71 @@ module IsoDoc
     end
 
     def convert1(docxml, filename, dir)
+      presxml_convert_init(docxml, filename, dir)
+      conversions(docxml)
+      docxml.root["type"] = "presentation"
+      repeat_id_validate(docxml.root)
+      idref_validate(docxml.root)
+      docxml.to_xml.gsub("<", "<").gsub(">", ">")
+    end
+
+    def counter_init
+      @counter = IsoDoc::XrefGen::Counter.new(0, {})
+    end
+
+    def presxml_convert_init(docxml, filename, dir)
       @outputdir = dir
       @outputfile = Pathname.new(filename).basename.to_s
       docid_prefixes(docxml) # feeds @xrefs.parse citation processing
       @xrefs.parse docxml
       @xrefs.klass.meta = @meta
       @xrefs.klass.info docxml, nil
-      conversions(docxml)
-      docxml.root["type"] = "presentation"
-      repeat_id_validate(docxml.root)
-      docxml.to_xml.gsub("<", "<").gsub(">", ">")
+      counter_init
     end
 
     def repeat_id_validate1(elem)
-        if @doc_ids[elem["id"]]
-          @log.add("Anchors", elem,
-                   "Anchor #{elem['id']} has already been " \
-                   "used at line #{@doc_ids[elem['id']]}", severity: 0)
-        end
-        @doc_ids[elem["id"]] = elem.line
+      if @doc_ids[elem["id"]]
+        @log.add("Anchors", elem,
+                 "Anchor #{elem['id']} has already been " \
+                 "used at line #{@doc_ids[elem['id']]}", severity: 0)
+      end
+      @doc_ids[elem["id"]] = elem.line
+    end
+
+    def repeat_id_validate(doc)
+      @log or return
+      @doc_ids = {}
+      doc.xpath("//*[@id]").each do |x|
+        repeat_id_validate1(x)
       end
+    end
 
-      def repeat_id_validate(doc)
-        @log or return
-        @doc_ids = {}
-        doc.xpath("//*[@id]").each do |x|
-          repeat_id_validate1(x)
+    IDREF =
+      [%w(review from), %w(review to), %w(index to), %w(xref target),
+       %w(callout target), %w(eref bibitemid), %w(citation bibitemid),
+       %w(admonition target), %w(label for), %w(semx source),
+       %w(fmt-title source), %w(fmt-xref-label container), %w(fn target),
+       %w(fmt-fn-body target), %w(fmt-review-start source),
+       %w(fmt-review-start end), %w(fmt-review-start target),
+       %w(fmt-review-end source), %w(fmt-review-end start),
+       %w(fmt-review-end target)].freeze
+
+    def idref_validate(doc)
+      @log or return
+      IDREF.each do |e|
+        doc.xpath("//xmlns:#{e[0]}[@#{e[1]}]").each do |x|
+          idref_validate1(x, e[1])
         end
       end
+    end
+
+    def idref_validate1(node, attr)
+      node[attr].strip.empty? and return
+      @doc_ids[node[attr]] and return
+      @log.add("Anchors", node,
+               "Anchor #{node[attr]} pointed to by #{node.name} " \
+               "is not defined in the document", severity: 1)
+    end
 
     def bibitem_lookup(docxml)
       @bibitem_lookup ||= docxml.xpath(ns("//references/bibitem"))
@@ -58,7 +96,6 @@ module IsoDoc
     end
 
     def conversions(docxml)
-      #semantic_xml_insert(docxml)
       metadata docxml
       bibdata docxml
       @xrefs.parse docxml
@@ -88,6 +125,7 @@ module IsoDoc
       toc docxml
       display_order docxml # feeds document_footnotes
       document_footnotes docxml
+      comments docxml
     end
 
     def block(docxml)
@@ -117,7 +155,6 @@ module IsoDoc
       xref docxml
       eref docxml # feeds eref2link
       origin docxml # feeds eref2link
-      #quotesource docxml # feeds eref2link
       concept docxml
       eref2link docxml
       mathml docxml
@@ -136,21 +173,10 @@ module IsoDoc
       termdefinition docxml
       designation docxml
       termsource docxml
-      #concept docxml
       related docxml
       termcleanup docxml
     end
 
-    # KILL
-    def semantic_xml_insert(xml)
-      @semantic_xml_insert or return
-      embed = embedable_semantic_xml(xml)
-      ins = metanorma_extension_insert_pt(xml)
-      ins = ins.at(ns("./metanorma")) || ins.add_child("<metanorma/>").first
-      ins = ins.add_child("<source/>").first
-      ins << embed
-    end
-
     def metanorma_extension_insert_pt(xml)
       xml.at(ns("//metanorma-extension")) ||
         xml.at(ns("//bibdata"))&.after("<metanorma-extension/>")

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "3.1.3".freeze
+  VERSION = "3.1.5".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -52,7 +52,7 @@ module IsoDoc
         body.div class: "WordSection3" do |div3|
           content(div3, docxml, ns(self.class::MAIN_ELEMENTS))
           footnotes docxml, div3
-          comments div3
+          comments docxml, div3
         end
       end
 
@@ -79,31 +79,6 @@ module IsoDoc
         node.xpath(ns("./note")).each { |n| parse(n, out) }
       end
 
-      # KILL
-      def figure_get_or_make_dlx(node)
-        dl = node.at(".//table[@class = 'dl']")
-        if dl.nil?
-          node.add_child("<p><b>#{@i18n.key}</b></p><table class='dl'></table>")
-          dl = node.at(".//table[@class = 'dl']")
-        end
-        dl
-      end
-
-      # get rid of footnote link, it is in diagram
-      # KILL
-      def figure_aside_processx(fig, aside, key)
-        fig.at("./a[@class='TableFootnoteRef']")&.remove
-        fnref = fig.at(".//span[@class='TableFootnoteRef']/..")
-        tr = key.add_child("<tr></tr>").first
-        dt = tr.add_child("<td valign='top' align='left'></td>").first
-        dd = tr.add_child("<td valign='top'></td>").first
-        fnref.parent = dt
-        aside.xpath(".//p").each do |a|
-          a.delete("class")
-          a.parent = dd
-        end
-      end
-
       def note_p_class
         "Note"
       end

data/lib/isodoc/word_function/comments.rb

@@ -1,28 +1,27 @@
 module IsoDoc
   module WordFunction
     module Comments
-      def comments(div)
-        return if @comments.empty?
-
-        div.div style: "mso-element:comment-list" do |div1|
-          @comments.each { |fn| div1.parent << fn }
+      def comments(docxml, out)
+        c = docxml.xpath(ns("//fmt-review-body"))
+        c.empty? and return
+        out.div style: "mso-element:comment-list" do |div|
+          @in_comment = true
+          c.each { |fn| parse(fn, div) }
+          @in_comment = false
         end
       end
 
-      def review_note_parse(node, out)
-        fn = @comments.length + 1
-        make_comment_link(out, fn, node)
-        @in_comment = true
-        @comments << make_comment_text(node, fn)
-        @in_comment = false
-      end
-
       def comment_link_attrs(fnote, node)
         { style: "MsoCommentReference", target: fnote,
-          class: "commentLink", from: node["from"],
-          to: node["to"] }
+          class: "commentLink", from: node["source"],
+          to: node["end"] }
+      end
+
+      def fmt_review_start_parse(node, out)
+        make_comment_link(out, node["target"], node)
       end
 
+      # TODO: CONSOLIDATE
       # add in from and to links to move the comment into place
       def make_comment_link(out, fnote, node)
         out.span(**comment_link_attrs(fnote, node)) do |s1|
@@ -43,22 +42,46 @@ module IsoDoc
         end
       end
 
-      def make_comment_text(node, fnote)
-        noko do |xml|
-          xml.div style: "mso-element:comment", id: fnote do |div|
-            div.span style: %{mso-comment-author:"#{node['reviewer']}"}
-            make_comment_target(div)
-            node.children.each { |n| parse(n, div) }
-          end
-        end.join("\n")
+      def fmt_review_body_parse(node, out)
+        out.div style: "mso-element:comment", id: node["id"] do |div|
+          div.span style: %{mso-comment-author:"#{node['reviewer']}"}
+          make_comment_target(div)
+          node.children.each { |n| parse(n, div) }
+        end
       end
 
       def comment_cleanup(docxml)
+        number_comments(docxml)
         move_comment_link_to_from(docxml)
         reorder_comments_by_comment_link(docxml)
         embed_comment_in_comment_list(docxml)
       end
 
+      def number_comments(docxml)
+        map = comment_id_to_number(docxml)
+        docxml.xpath("//span[@style='MsoCommentReference' or " \
+        "'mso-special-character:comment']").each do |x|
+          x["target"] &&= map[x["target"]]
+        end
+        docxml.xpath("//div[@style='mso-element:comment']").each do |x|
+          x["id"] = map[x["id"]]
+        end
+        docxml.xpath("//a[@style]").each do |x|
+          m = /mso-comment-reference:SMC_([^;]+);/.match(x["style"]) or next
+          x["style"] = x["style"].sub(/mso-comment-reference:SMC_#{m[1]}/,
+                                      "mso-comment-reference:SMC_#{map[m[1]]}")
+        end
+      end
+
+      def comment_id_to_number(docxml)
+        ids = docxml.xpath("//span[@style='MsoCommentReference']").map do |x|
+          x["target"]
+        end
+        ids.uniq.each_with_index.with_object({}) do |(id, i), m|
+          m[id] = i + 1
+        end
+      end
+
       COMMENT_IN_COMMENT_LIST1 =
         '//div[@style="mso-element:comment-list"]//' \
         'span[@style="MsoCommentReference"]'.freeze
@@ -123,14 +146,12 @@ module IsoDoc
       end
 
       def get_comments_from_text(docxml, link_order)
-        comments = []
-        docxml.xpath("//div[@style='mso-element:comment']").each do |c|
-          next unless c["id"] && !link_order[c["id"]].nil?
-
-          comments << { text: c.remove.to_s, id: c["id"] }
+        comments = docxml.xpath("//div[@style='mso-element:comment']")
+          .each_with_object([]) do |c, m|
+          c["id"] && !link_order[c["id"]].nil? or next
+          m << { text: c.remove.to_s, id: c["id"] }
         end
-        comments.sort! { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }
-        # comments
+        comments.sort { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }
       end
 
       COMMENT_TARGET_XREFS1 =

data/lib/isodoc/word_function/footnotes.rb

@@ -22,16 +22,18 @@ module IsoDoc
         node.at(ns(".//fmt-fn-label"))&.remove
         aside = node.parent.name == "fmt-footnote-container"
         tag = aside ? "aside" : "div"
-        out.send tag, id: "ftn#{node['reference']}" do |div|
+        id = node["is_table"] ? node["reference"] : node["id"]
+        out.send tag, id: "ftn#{id}" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
 
       # dupe to HTML
- def get_table_ancestor_id(node)
-    table = node.ancestors("table")
+      def get_table_ancestor_id(node)
+        table = node.ancestors("table")
         table.empty? and table = node.ancestors("figure")
-        table.empty? and return [nil, UUIDTools::UUID.random_create.to_s]
+        table.empty? and return [nil,
+                                 UUIDTools::UUID.random_create.to_s]
         [table.last, table.last["id"]]
       end
 
@@ -42,30 +44,17 @@ module IsoDoc
         make_table_footnote_link(out, tid + fn, node.at(ns("./fmt-fn-label")))
         # do not output footnote text if we have already seen it for this table
         return if @seen_footnote.include?(tid + fn)
+
         update_table_fn_body_ref(node, table, tid + fn)
         @seen_footnote << (tid + fn)
       end
 
-      # TODO merge with HTML
-      def update_table_fn_body_ref(fnote, table, reference)
-        fnbody = table.at(ns(".//fmt-fn-body[@id = '#{fnote['target']}']")) or return
-        fnbody["reference"] = reference
-        sup = fnbody.at(ns(".//fmt-fn-label/sup")) and sup.replace(sup.children)
-        fnbody.xpath(ns(".//fmt-fn-label")).each do |s|
-          s["class"] = "TableFootnoteRef"
-          s.name = "span"
-          d = s.at(ns("./span[@class = 'fmt-caption-delim']")) and
-            s.next = d
-        end
-      end
-
       def seen_footnote_parse(node, out, footnote)
         f = node.at(ns("./fmt-fn-label"))
         sup = f.at(ns(".//sup")) and sup.replace(sup.children)
         s = f.at(ns(".//semx[@source = '#{node['id']}']"))
-
         semx = <<~SPAN.strip
-<span style="mso-element:field-begin"/> NOTEREF _Ref#{@fn_bookmarks[footnote]} \\f \\h<span style="mso-element:field-separator"/>#{footnote}<span style="mso-element:field-end"/>
+          <span style="mso-element:field-begin"/> NOTEREF _Ref#{@fn_bookmarks[footnote]} \\f \\h<span style="mso-element:field-separator"/>#{footnote}<span style="mso-element:field-end"/>
         SPAN
         s.replace(semx)
         out.span class: "MsoFootnoteReference" do |fn|
@@ -74,29 +63,36 @@ module IsoDoc
       end
 
       def footnote_parse(node, out)
-        return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
-          !node.ancestors.map(&:name).include?("fmt-name")
-
-        fn = node["reference"] || UUIDTools::UUID.random_create.to_s
-        return seen_footnote_parse(node, out, fn) if @seen_footnote.include?(fn)
-
+        table_footnote?(node) and return table_footnote_parse(node, out)
+        fn = node["reference"] # || UUIDTools::UUID.random_create.to_s
+        @seen_footnote.include?(fn) and return seen_footnote_parse(node, out, fn)
         @fn_bookmarks[fn] = bookmarkid
+        f = footnote_label_process(node)
+        out.span style: "mso-bookmark:_Ref#{@fn_bookmarks[fn]}",
+                 class: "MsoFootnoteReference" do |s|
+          children_parse(f, s)
+        end
+        footnote_hyperlink(node, out)
+        @seen_footnote << fn
+      end
+
+      def footnote_label_process(node)
         f = node.at(ns("./fmt-fn-label"))
         sup = f.at(ns(".//sup")) and sup.replace(sup.children)
         if semx = f.at(ns(".//semx[@element = 'autonum']"))
           semx.name = "span"
           semx["class"] = "FMT-PLACEHOLDER"
         end
-        out.span style: "mso-bookmark:_Ref#{@fn_bookmarks[fn]}", class: "MsoFootnoteReference" do |s|
-              children_parse(f, out)
-        end
+        f
+      end
+
+      def footnote_hyperlink(node, out)
         if semx = out.parent.at(".//span[@class = 'FMT-PLACEHOLDER']")
           semx.name = "a"
           semx["class"] = "FootnoteRef"
           semx["epub:type"] = "footnote"
-          semx["href"] = "#ftn#{fn}"
+          semx["href"] = "#ftn#{node['target']}"
         end
-        @seen_footnote << fn
       end
     end
   end

data/lib/isodoc/word_function/lists.rb

@@ -96,14 +96,12 @@ module IsoDoc
         end
       end
 
-      def li_parse(node, out)
-        out.li **attr_code(id: node["id"]) do |li|
-          if node["uncheckedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">&#x2610; </span>'
-          elsif node["checkedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">&#x2611; </span>'
-          end
-          node.children.each { |n| parse(n, li) }
+      def li_checkbox(node)
+        if node["uncheckedcheckbox"] == "true"
+          '<span class="zzMoveToFollowing">&#x2610; </span>'
+        elsif node["checkedcheckbox"] == "true"
+          '<span class="zzMoveToFollowing">&#x2611; </span>'
+        else ""
         end
       end
     end

data/lib/isodoc/word_function/postprocess.rb

@@ -172,23 +172,6 @@ module IsoDoc
         end
       end
 
-      # KILL
-      def word_footnote_formatx(docxml)
-        # the content is in a[@epub:type = 'footnote']//sup, but in Word,
-        # we need to inject content around the autonumbered footnote reference
-        docxml.xpath("//a[@epub:type = 'footnote']").each do |x|
-          footnote_reference_format(x)
-        end
-        docxml.xpath("//span[@class = 'MsoFootnoteReference']").each do |x|
-          footnote_reference_format(x)
-        end
-        docxml.xpath("//a[@class = 'TableFootnoteRef'] | " \
-                     "//span[@class = 'TableFootnoteRef']").each do |x|
-          table_footnote_reference_format(x)
-        end
-        docxml
-      end
-
       # move p.h1 (floating title) after any page, section breaks
       def word_floating_titles(docxml)
         docxml.xpath("//p[@class = 'section-break' or @class = 'page-break']")

data/lib/isodoc/word_function/table.rb

@@ -23,6 +23,7 @@ module IsoDoc
 
       def make_tr_attr(cell, row, totalrows, header, bordered)
         style = cell.name == "th" ? "font-weight:bold;" : ""
+        cell["style"] and style += "#{cell['style']};"
         rowmax = cell["rowspan"] ? row + cell["rowspan"].to_i - 1 : row
         style += make_tr_attr_style(cell, row, rowmax, totalrows,
                                     { header: header, bordered: bordered })

data/lib/isodoc/xref/ol_type_provider.rb

@@ -0,0 +1,16 @@
+module IsoDoc
+  module XrefGen
+    module OlTypeProvider
+      def ol_type(list, depth)
+        return list["type"].to_sym if list["type"]
+        return :arabic if [2, 7].include? depth
+        return :alphabet if [1, 6].include? depth
+        return :alphabet_upper if [4, 9].include? depth
+        return :roman if [3, 8].include? depth
+        return :roman_upper if [5, 10].include? depth
+
+        :arabic
+      end
+    end
+  end
+end

data/lib/isodoc/xref/xref_counter.rb

@@ -1,5 +1,6 @@
 require "roman-numerals"
 require "twitter_cldr"
+require_relative "ol_type_provider"
 
 module IsoDoc
   module XrefGen
@@ -16,6 +17,7 @@ module IsoDoc
     end
 
     class Counter
+      include OlTypeProvider
       attr_accessor :prefix_override
 
       def initialize(num = 0, opts = { numerals: :arabic })
@@ -172,17 +174,6 @@ module IsoDoc
         "#{prefix}#{@base}#{out}#{@letter_override || @letter}"
       end
 
-      def ol_type(list, depth)
-        return list["type"].to_sym if list["type"]
-        return :arabic if [2, 7].include? depth
-        return :alphabet if [1, 6].include? depth
-        return :alphabet_upper if [4, 9].include? depth
-        return :roman if [3, 8].include? depth
-        return :roman_upper if [5, 10].include? depth
-
-        :arabic
-      end
-
       def listlabel(list, depth)
         case ol_type(list, depth)
         when :arabic then @num.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-17 00:00:00.000000000 Z
+date: 2025-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: mn2pdf
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.16.8
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 1.16.8
 - !ruby/object:Gem::Dependency
   name: relaton-render
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +164,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: lutaml-model
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
@@ -449,7 +421,6 @@ files:
 - lib/isodoc/headlesshtml_convert.rb
 - lib/isodoc/html_convert.rb
 - lib/isodoc/html_function.rb
-- lib/isodoc/html_function/comments.rb
 - lib/isodoc/html_function/form.rb
 - lib/isodoc/html_function/html.rb
 - lib/isodoc/html_function/mathvariant_to_plain.rb
@@ -472,6 +443,7 @@ files:
 - lib/isodoc/presentation_function/image.rb
 - lib/isodoc/presentation_function/index.rb
 - lib/isodoc/presentation_function/inline.rb
+- lib/isodoc/presentation_function/list.rb
 - lib/isodoc/presentation_function/math.rb
 - lib/isodoc/presentation_function/metadata.rb
 - lib/isodoc/presentation_function/refs.rb
@@ -498,6 +470,7 @@ files:
 - lib/isodoc/word_function/table.rb
 - lib/isodoc/xref.rb
 - lib/isodoc/xref/clause_order.rb
+- lib/isodoc/xref/ol_type_provider.rb
 - lib/isodoc/xref/xref_anchor.rb
 - lib/isodoc/xref/xref_counter.rb
 - lib/isodoc/xref/xref_counter_types.rb