isodoc 0.7.0 → 0.7.1

data/lib/isodoc/table.rb

@@ -1,5 +1,5 @@
 module IsoDoc
-  class Convert
+  class Common
     def table_title_parse(node, out)
       name = node.at(ns("./name"))
       out.p **{ class: "TableTitle", align: "center" } do |p|

data/lib/isodoc/terms.rb

@@ -1,5 +1,5 @@
 module IsoDoc
-  class Convert
+  class Common
     def definition_parse(node, out)
       node.children.each { |n| parse(n, out) }
     end

data/lib/isodoc/utils.rb

@@ -1,33 +1,32 @@
 module IsoDoc
-  class Convert
-    def ns(xpath)
+  class Common
+    def self.ns(xpath)
       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")
     end
 
-    def insert_tab(out, n)
-      [1..n].each { out << "&nbsp; " }
+    def ns(xpath)
+      Common::ns(xpath)
     end
 
-    STAGE_ABBRS = {
-      "00": "PWI",
-      "10": "NWIP",
-      "20": "WD",
-      "30": "CD",
-      "40": "DIS",
-      "50": "FDIS",
-      "60": "IS",
-      "90": "(Review)",
-      "95": "(Withdrawal)",
-    }.freeze
+    def self.date_range(date)
+      from = date.at(ns("./from"))
+      to = date.at(ns("./to"))
+      on = date.at(ns("./on"))
+      return on.text if on
+      ret = "#{from.text}&ndash;"
+      ret += to.text if to
+      ret
+    end
 
-    def stage_abbrev(stage, iter, draft)
-      stage = STAGE_ABBRS[stage.to_sym] || "??"
-      stage += iter.text if iter
-      stage = "Pre" + stage if draft&.text =~ /^0\./
-      stage
+    def date_range(date)
+      Common::date_range(date)
+    end
+
+    def insert_tab(out, n)
+      [1..n].each { out << "&nbsp; " }
     end
 
     NOKOHEAD = <<~HERE.freeze
@@ -133,7 +132,7 @@ module IsoDoc
     end
 
     def populate_template(docxml, _format)
-      meta = get_metadata.merge(@labels)
+      meta = @meta.get.merge(@labels)
       docxml = docxml.
         gsub(/\[TERMREF\]\s*/, l10n("[#{@source_lbl}: ")).
         gsub(/\s*\[\/TERMREF\]\s*/, l10n("]")).

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "0.7.0".freeze
+  VERSION = "0.7.1".freeze
 end

data/lib/isodoc/wordconvert/comments.rb

@@ -1,140 +1,145 @@
-def in_comment
-  @in_comment
-end
+module IsoDoc
+  class WordConvert < Common
 
-def comments(div)
-  return if @comments.empty?
-  div.div **{ style: "mso-element:comment-list" } do |div1|
-    @comments.each { |fn| div1.parent << fn }
-  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 in_comment
+      @in_comment
+    end
 
-def comment_link_attrs(fn, node)
-  { style: "MsoCommentReference", target: fn,
-    class: "commentLink", from: node["from"],
-    to: node["to"] }
-end
+    def comments(div)
+      return if @comments.empty?
+      div.div **{ style: "mso-element:comment-list" } do |div1|
+        @comments.each { |fn| div1.parent << fn }
+      end
+    end
 
-# add in from and to links to move the comment into place
-def make_comment_link(out, fn, node)
-  out.span(**comment_link_attrs(fn, node)) do |s1|
-    s1.span **{ lang: "EN-GB", style: "font-size:9.0pt" } do |s2|
-      s2.a **{ style: "mso-comment-reference:SMC_#{fn};"\
-               "mso-comment-date:#{node['date'].gsub(/[:-]+/, '')}" }
-      s2.span **{ style: "mso-special-character:comment",
-                  target: fn } # do |s|
+    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
-  end
-end
 
-def make_comment_target(out)
-  out.span **{ style: "MsoCommentReference" } do |s1|
-    s1.span **{ lang: "EN-GB", style: "font-size:9.0pt" } do |s2|
-      s2.span **{ style: "mso-special-character:comment" }
+    def comment_link_attrs(fn, node)
+      { style: "MsoCommentReference", target: fn,
+        class: "commentLink", from: node["from"],
+        to: node["to"] }
     end
-  end
-end
 
-def make_comment_text(node, fn)
-  noko do |xml|
-    xml.div **{ style: "mso-element:comment", id: fn } do |div|
-      div.span **{ style: %{mso-comment-author:"#{node['reviewer']}"} }
-      make_comment_target(div)
-      node.children.each { |n| parse(n, div) }
+    # add in from and to links to move the comment into place
+    def make_comment_link(out, fn, node)
+      out.span(**comment_link_attrs(fn, node)) do |s1|
+        s1.span **{ lang: "EN-GB", style: "font-size:9.0pt" } do |s2|
+          s2.a **{ style: "mso-comment-reference:SMC_#{fn};"\
+                   "mso-comment-date:#{node['date'].gsub(/[:-]+/, '')}" }
+          s2.span **{ style: "mso-special-character:comment",
+                      target: fn } # do |s|
+        end
+      end
     end
-  end.join("\n")
-end
 
-def comment_cleanup(docxml)
-  move_comment_link_to_from(docxml)
-  reorder_comments_by_comment_link(docxml)
-  embed_comment_in_comment_list(docxml)
-end
+    def make_comment_target(out)
+      out.span **{ style: "MsoCommentReference" } do |s1|
+        s1.span **{ lang: "EN-GB", style: "font-size:9.0pt" } do |s2|
+          s2.span **{ style: "mso-special-character:comment" }
+        end
+      end
+    end
 
-COMMENT_IN_COMMENT_LIST1 =
-  '//div[@style="mso-element:comment-list"]//'\
-  'span[@style="MsoCommentReference"]'.freeze
+    def make_comment_text(node, fn)
+      noko do |xml|
+        xml.div **{ style: "mso-element:comment", id: fn } 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")
+    end
 
-def embed_comment_in_comment_list(docxml)
-  #docxml.xpath(COMMENT_IN_COMMENT_LIST).each do |x|
-  docxml.xpath(COMMENT_IN_COMMENT_LIST1).each do |x|
-    n = x.next_element
-    n&.children&.first&.add_previous_sibling(x.remove)
-  end
-  docxml
-end
+    def comment_cleanup(docxml)
+      move_comment_link_to_from(docxml)
+      reorder_comments_by_comment_link(docxml)
+      embed_comment_in_comment_list(docxml)
+    end
 
-def move_comment_link_to_from1(x, fromlink)
-  x.remove
-  link = x.at(".//a")
-  fromlink.replace(x)
-  link.children = fromlink
-end
+    COMMENT_IN_COMMENT_LIST1 =
+      '//div[@style="mso-element:comment-list"]//'\
+      'span[@style="MsoCommentReference"]'.freeze
+
+    def embed_comment_in_comment_list(docxml)
+      #docxml.xpath(COMMENT_IN_COMMENT_LIST).each do |x|
+      docxml.xpath(COMMENT_IN_COMMENT_LIST1).each do |x|
+        n = x.next_element
+        n&.children&.first&.add_previous_sibling(x.remove)
+      end
+      docxml
+    end
 
-def comment_attributes(docxml, x)
-  fromlink = docxml.at("//*[@id='#{x['from']}']")
-  return(nil) if fromlink.nil?
-  tolink = docxml.at("//*[@id='#{x['to']}']") || fromlink
-  target = docxml.at("//*[@id='#{x['target']}']")
-  { from: fromlink, to: tolink, target: target }
-end
+    def move_comment_link_to_from1(x, fromlink)
+      x.remove
+      link = x.at(".//a")
+      fromlink.replace(x)
+      link.children = fromlink
+    end
 
-def wrap_comment_cont(from, target)
-  s = from.replace("<span style='mso-comment-continuation:#{target}'>")
-  s.first.children = from
-end
+    def comment_attributes(docxml, x)
+      fromlink = docxml.at("//*[@id='#{x['from']}']")
+      return(nil) if fromlink.nil?
+      tolink = docxml.at("//*[@id='#{x['to']}']") || fromlink
+      target = docxml.at("//*[@id='#{x['target']}']")
+      { from: fromlink, to: tolink, target: target }
+    end
 
-def skip_comment_wrap(from)
-  from["style"] != "mso-special-character:comment"
-end
+    def wrap_comment_cont(from, target)
+      s = from.replace("<span style='mso-comment-continuation:#{target}'>")
+      s.first.children = from
+    end
 
-def insert_comment_cont(from, to, target)
-  # includes_to = from.at(".//*[@id='#{to}']")
-  while !from.nil? && from["id"] != to
-    following = from.xpath("./following::*")
-    (from = following.shift) && incl_to = from.at(".//*[@id='#{to}']")
-    while !incl_to.nil? && !from.nil? && skip_comment_wrap(from)
-      (from = following.shift) && incl_to = from.at(".//*[@id='#{to}']")
+    def skip_comment_wrap(from)
+      from["style"] != "mso-special-character:comment"
     end
-    wrap_comment_cont(from, target) if !from.nil?
-  end
-end
 
-def move_comment_link_to_from(docxml)
-  docxml.xpath('//span[@style="MsoCommentReference"][@from]').each do |x|
-    attrs = comment_attributes(docxml, x) || next
-    move_comment_link_to_from1(x, attrs[:from])
-    insert_comment_cont(attrs[:from], x["to"], x["target"])
-  end
-end
+    def insert_comment_cont(from, to, target)
+      # includes_to = from.at(".//*[@id='#{to}']")
+      while !from.nil? && from["id"] != to
+        following = from.xpath("./following::*")
+        (from = following.shift) && incl_to = from.at(".//*[@id='#{to}']")
+        while !incl_to.nil? && !from.nil? && skip_comment_wrap(from)
+          (from = following.shift) && incl_to = from.at(".//*[@id='#{to}']")
+        end
+        wrap_comment_cont(from, target) if !from.nil?
+      end
+    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"] }
-  end
-  comments.sort! { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }
-  # comments
-end
+    def move_comment_link_to_from(docxml)
+      docxml.xpath('//span[@style="MsoCommentReference"][@from]').each do |x|
+        attrs = comment_attributes(docxml, x) || next
+        move_comment_link_to_from1(x, attrs[:from])
+        insert_comment_cont(attrs[:from], x["to"], x["target"])
+      end
+    end
 
-COMMENT_TARGET_XREFS1 =
-  "//span[@style='mso-special-character:comment']/@target".freeze
+    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"] }
+      end
+      comments.sort! { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }
+      # comments
+    end
 
-def reorder_comments_by_comment_link(docxml)
-  link_order = {}
-  docxml.xpath(COMMENT_TARGET_XREFS1).each_with_index do |target, i|
-    link_order[target.value] = i
+    COMMENT_TARGET_XREFS1 =
+      "//span[@style='mso-special-character:comment']/@target".freeze
+
+    def reorder_comments_by_comment_link(docxml)
+      link_order = {}
+      docxml.xpath(COMMENT_TARGET_XREFS1).each_with_index do |target, i|
+        link_order[target.value] = i
+      end
+      comments = get_comments_from_text(docxml, link_order)
+      list = docxml.at("//*[@style='mso-element:comment-list']") || return
+      list.children = comments.map { |c| c[:text] }.join("\n")
+    end
   end
-  comments = get_comments_from_text(docxml, link_order)
-  list = docxml.at("//*[@style='mso-element:comment-list']") || return
-  list.children = comments.map { |c| c[:text] }.join("\n")
 end

data/lib/isodoc/wordconvert/convert.rb

@@ -5,9 +5,11 @@ require "liquid"
 require_relative "wordconvertmodule"
 require_relative "comments"
 require_relative "footnotes"
+require_relative "postprocess"
 
 module IsoDoc
 
+=begin
   module WordConvertModule
     # http://tech.tulentsev.com/2012/02/ruby-how-to-override-class-method-with-a-module/
     # https://www.ruby-forum.com/topic/148303
@@ -24,9 +26,10 @@ module IsoDoc
       end
     end
   end
+=end
 
-  class WordConvert < Convert
-    include WordConvertModule
+  class WordConvert < Common
+    #include WordConvertModule
   end
 end
 

data/lib/isodoc/wordconvert/footnotes.rb

@@ -1,4 +1,7 @@
-def footnotes(div)
+module IsoDoc
+  class WordConvert < Common
+
+    def footnotes(div)
   return if @footnotes.empty?
   @footnotes.each { |fn| div.parent << fn }
 end
@@ -66,3 +69,13 @@ def footnote_parse(node, out)
   @in_footnote = false
   @seen_footnote << fn
 end
+
+    def make_footnote(node, fn)
+      return if @seen_footnote.include?(fn)
+      @in_footnote = true
+      @footnotes << make_generic_footnote_text(node, fn)
+      @in_footnote = false
+      @seen_footnote << fn
+    end
+  end
+end

data/lib/isodoc/wordconvert/postprocess.rb

@@ -1,4 +1,7 @@
-def postprocess(result, filename, dir)
+module IsoDoc
+  class WordConvert < Common
+
+    def postprocess(result, filename, dir)
   generate_header(filename, dir)
   result = from_xhtml(cleanup(to_xhtml(result)))
   toWord(result, filename, dir)
@@ -53,7 +56,7 @@ end
 def generate_header(filename, _dir)
   return unless @header
   template = Liquid::Template.parse(File.read(@header, encoding: "UTF-8"))
-  meta = get_metadata
+  meta = @meta.get
   meta[:filename] = filename
   params = meta.map { |k, v| [k.to_s, v] }.to_h
   File.open("header.html", "w") do |f|
@@ -107,4 +110,6 @@ def make_WordToC(docxml)
   end
   toc.sub(/(<p class="MsoToc1">)/,
           %{\\1#{WORD_TOC_PREFACE1}}) +  WORD_TOC_SUFFIX1
+end
+  end
 end

data/lib/isodoc/wordconvert/wordconvertmodule.rb

@@ -1,4 +1,13 @@
-def make_body2(body, docxml)
+module IsoDoc
+  class WordConvert < Common
+    def make_body1(body, _docxml)
+      body.div **{ class: "WordSection1" } do |div1|
+        div1.p { |p| p << "&nbsp;" } # placeholder
+      end
+      section_break(body)
+    end
+
+    def make_body2(body, docxml)
   body.div **{ class: "WordSection2" } do |div2|
     info docxml, div2
     foreword docxml, div2
@@ -136,4 +145,6 @@ def figure_aside_process(f, aside, key)
     a.delete("class")
     a.parent = dd
   end
+end
+  end
 end

data/lib/isodoc/xref_gen.rb

@@ -1,7 +1,7 @@
 require "roman-numerals"
 
 module IsoDoc
-  class Convert
+  class Common
     @anchors = {}
 
     def get_anchors
@@ -15,6 +15,7 @@ module IsoDoc
     def termnote_anchor_names(docxml)
       docxml.xpath(ns("//term[termnote]")).each do |t|
         t.xpath(ns("./termnote")).each_with_index do |n, i|
+          return if n["id"].nil? || n["id"].empty?
           @anchors[n["id"]] =
             { label: termnote_label(i + 1),
               xref: l10n("#{@anchors[t['id']][:xref]}, "\
@@ -26,6 +27,7 @@ module IsoDoc
     def termexample_anchor_names(docxml)
       docxml.xpath(ns("//term[termexample]")).each do |t|
         t.xpath(ns("./termexample")).each_with_index do |n, i|
+          return if n["id"].nil? || n["id"].empty?
           @anchors[n["id"]] =
             { label: (i + 1).to_s,
               xref: l10n("#{@anchors[t['id']][:xref]}, "\
@@ -48,7 +50,7 @@ module IsoDoc
         notes = s.xpath(CHILD_NOTES_XPATH)
         notes.each_with_index do |n, i|
           next if @anchors[n["id"]]
-          next if n["id"].nil?
+          next if n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{i + 1}"
           @anchors[n["id"]] = anchor_struct(idx, s, @note_xref_lbl)
         end
@@ -65,6 +67,7 @@ module IsoDoc
         notes = s.xpath(CHILD_EXAMPLES_XPATH)
         notes.each_with_index do |n, i|
           next if @anchors[n["id"]]
+          next if n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{i + 1}"
           @anchors[n["id"]] = anchor_struct(idx, s, @example_xref_lbl)
         end
@@ -77,6 +80,7 @@ module IsoDoc
         notes = s.xpath(ns(".//ol")) - s.xpath(ns(".//clause//ol")) -
           s.xpath(ns(".//appendix//ol")) - s.xpath(ns(".//ol//ol"))
         notes.each_with_index do |n, i|
+          next if n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{i + 1}"
           @anchors[n["id"]] = anchor_struct(idx, s, @list_lbl)
           list_item_anchor_names(n, @anchors[n["id"]], 1, "", notes.size != 1)
@@ -128,6 +132,7 @@ module IsoDoc
           i += 1
         end
         label = i.to_s + (j.zero? ? "" : "-#{j}")
+          next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] = anchor_struct(label, nil, @figure_lbl)
       end
     end
@@ -159,10 +164,12 @@ module IsoDoc
 
     def sequential_asset_names(clause)
       clause.xpath(ns(".//table")).each_with_index do |t, i|
+          next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] = anchor_struct(i + 1, nil, @table_lbl)
       end
       sequential_figure_names(clause)
       clause.xpath(ns(".//formula")).each_with_index do |t, i|
+          next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] = anchor_struct(i + 1, t, @formula_lbl)
       end
     end
@@ -176,16 +183,19 @@ module IsoDoc
           i += 1
         end
         label = "#{num}.#{i}" + (j.zero? ? "" : "-#{j}")
+          next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] = anchor_struct(label, nil, @figure_lbl)
       end
     end
 
     def hierarchical_asset_names(clause, num)
       clause.xpath(ns(".//table")).each_with_index do |t, i|
+          next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] = anchor_struct("#{num}.#{i + 1}", nil, @table_lbl)
       end
       hierarchical_figure_names(clause, num)
       clause.xpath(ns(".//formula")).each_with_index do |t, i|
+          next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] = anchor_struct("#{num}.#{i + 1}", t, @formula_lbl)
       end
     end