isodoc 1.6.2 → 1.6.7

data/lib/isodoc/pdf_convert.rb

@@ -1,11 +1,10 @@
-require_relative "html_function/comments.rb"
-require_relative "html_function/footnotes.rb"
-require_relative "html_function/html.rb"
+require_relative "html_function/comments"
+require_relative "html_function/footnotes"
+require_relative "html_function/html"
 require "metanorma"
 
 module IsoDoc
   class PdfConvert < ::IsoDoc::Convert
-
     include HtmlFunction::Comments
     include HtmlFunction::Footnotes
     include HtmlFunction::Html
@@ -13,6 +12,8 @@ module IsoDoc
     def initialize(options)
       @standardstylesheet = nil
       super
+      @format = :pdf
+      @suffix = "pdf"
       @scripts = @scripts_pdf if @scripts_pdf
       @maxwidth = 500
       @maxheight = 800
@@ -22,22 +23,19 @@ module IsoDoc
       "_pdfimages"
     end
 
-    def initialize(options)
-      @format = :pdf
-      @suffix = "pdf"
-      super
-    end
-
     def convert(input_filename, file = nil, debug = false, output_filename = nil)
       file = File.read(input_filename, encoding: "utf-8") if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)
       docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
       return result if debug
-      postprocess(result, filename + ".tmp.html", dir)
+
+      postprocess(result, "#{filename}.tmp.html", dir)
       FileUtils.rm_rf dir
-      ::Metanorma::Output::Pdf.new.convert("#{filename}.tmp.html",
-                                           output_filename || "#{filename}.#{@suffix}")
+      ::Metanorma::Output::Pdf.new.convert(
+        "#{filename}.tmp.html",
+        output_filename || "#{filename}.#{@suffix}",
+      )
       FileUtils.rm_rf ["#{filename}.tmp.html", tmpimagedir]
     end
 

data/lib/isodoc/presentation_function/bibdata.rb

@@ -1,13 +1,40 @@
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def bibdata(docxml)
+      docid_prefixes(docxml)
       a = bibdata_current(docxml) or return
+      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
 
+     def docid_prefixes(docxml)
+      docxml.xpath(ns("//references/bibitem/docidentifier")).each do |i|
+        i.children = @xrefs.klass.docid_prefix(i["type"], i.text)
+      end
+    end
+
+    def address_precompose(bib)
+      bib.xpath(ns("//bibdata//address")).each do |b|
+        next if b.at(ns("./formattedAddress"))
+
+        x = address_precompose1(b)
+        b.children = "<formattedAddress>#{x}</formattedAddress>"
+      end
+    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}"
+      ret.join("<br/>")
+    end
+
     def bibdata_current(docxml)
       a = docxml.at(ns("//bibdata")) or return
       a.xpath(ns("./language")).each do |l|
@@ -19,10 +46,10 @@ module IsoDoc
       a
     end
 
-    def bibdata_i18n(b)
-      hash_translate(b, @i18n.get["doctype_dict"], "./ext/doctype")
-      hash_translate(b, @i18n.get["stage_dict"], "./status/stage")
-      hash_translate(b, @i18n.get["substage_dict"], "./status/substage")
+    def bibdata_i18n(bib)
+      hash_translate(bib, @i18n.get["doctype_dict"], "./ext/doctype")
+      hash_translate(bib, @i18n.get["stage_dict"], "./status/stage")
+      hash_translate(bib, @i18n.get["substage_dict"], "./status/substage")
     end
 
     def hash_translate(bibdata, hash, xpath, lang = @lang)
@@ -35,58 +62,62 @@ module IsoDoc
       x.next.children = hash[x.text]
     end
 
-    def i18n_tag(k, v)
-      "<localized-string key='#{k}' language='#{@lang}'>#{v}</localized-string>"
+    def i18n_tag(key, value)
+      "<localized-string key='#{key}' language='#{@lang}'>#{value}"\
+        "</localized-string>"
     end
 
-    def i18n_safe(k)
-      k.to_s.gsub(/\s|\./, "_")
+    def i18n_safe(key)
+      key.to_s.gsub(/\s|\./, "_")
     end
 
-    def i8n_name(h, pref)
-      if h.is_a? Hash then i8n_name1(h, pref)
-      elsif h.is_a? Array
-        h.reject { |a| blank?(a) }.each_with_object([]).
-          with_index do |(v1, g), i|
+    def i8n_name(hash, pref)
+      if hash.is_a? Hash then i8n_name1(hash, pref)
+      elsif hash.is_a? Array
+        hash.reject { |a| blank?(a) }.each_with_object([])
+          .with_index do |(v1, g), i|
           i8n_name(v1, "#{i18n_safe(k)}.#{i}").each { |x| g << x }
         end
-      else [i18n_tag(pref, h)]
+      else [i18n_tag(pref, hash)]
       end
     end
 
-    def i8n_name1(h, pref)
-      h.reject { |k, v| blank?(v) }.each_with_object([]) do |(k, v), g|
+    def i8n_name1(hash, pref)
+      hash.reject { |_k, v| blank?(v) }.each_with_object([]) do |(k, v), g|
         if v.is_a? Hash then i8n_name(v, i18n_safe(k)).each { |x| g << x }
         elsif v.is_a? Array
           v.reject { |a| blank?(a) }.each_with_index do |v1, i|
             i8n_name(v1, "#{i18n_safe(k)}.#{i}").each { |x| g << x }
           end
         else
-          g << i18n_tag("#{pref}#{pref.empty? ? "" : "."}#{i18n_safe(k)}", v)
+          g << i18n_tag("#{pref}#{pref.empty? ? '' : '.'}#{i18n_safe(k)}", v)
         end
       end
     end
 
-    #https://stackoverflow.com/a/31822406
-    def blank?(v)
-      v.nil? || v.respond_to?(:empty?) && v.empty?
+    # https://stackoverflow.com/a/31822406
+    def blank?(elem)
+      elem.nil? || elem.respond_to?(:empty?) && elem.empty?
     end
 
-    def trim_hash(h)
+    def trim_hash(hash)
       loop do
-        h_new = trim_hash1(h)
-        break h if h==h_new
-        h = h_new
+        h_new = trim_hash1(hash)
+        break hash if hash == h_new
+
+        hash = h_new
       end
     end
 
-    def trim_hash1(h)
-      return h unless h.is_a? Hash
-      h.each_with_object({}) do |(k,v), g|
+    def trim_hash1(hash)
+      return hash unless hash.is_a? Hash
+
+      hash.each_with_object({}) do |(k, v), g|
         next if blank?(v)
-        g[k] = if v.is_a? Hash then trim_hash1(h[k])
+
+        g[k] = if v.is_a? Hash then trim_hash1(hash[k])
                elsif v.is_a? Array
-                 h[k].map { |a| trim_hash1(a) }.reject { |a| blank?(a) }
+                 hash[k].map { |a| trim_hash1(a) }.reject { |a| blank?(a) }
                else
                  v
                end

data/lib/isodoc/presentation_function/inline.rb

@@ -9,8 +9,8 @@ module IsoDoc
         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) || "???"
+            @xrefs.anchor(node["target"], :label) ||
+            @xrefs.anchor(node["target"], :xref) || "???"
       elsif node["target"] && !/.#./.match(node["target"])
         linkend = anchor_linkend1(node)
       end
@@ -33,6 +33,10 @@ module IsoDoc
       return linkend&.downcase if node["case"] == "lowercase"
       return linkend if linkend[0, 1].match?(/\p{Upper}/)
 
+      capitalise_xref1(node, linkend)
+    end
+
+    def capitalise_xref1(node, linkend)
       prec = nearest_block_parent(node).xpath("./descendant-or-self::text()") &
         node.xpath("./preceding::text()")
       if prec.empty? || /(?!<[^.].)\.\s+$/.match(prec.map(&:text).join)
@@ -43,8 +47,8 @@ module IsoDoc
 
     def nearest_block_parent(node)
       until %w(p title td th name formula li dt dd sourcecode pre)
-        .include?(node.name)
-      node = node.parent
+          .include?(node.name)
+        node = node.parent
       end
       node
     end
@@ -68,55 +72,55 @@ module IsoDoc
     # so not <origin bibitemid="ISO7301" citeas="ISO 7301">
     # <locality type="section"><reference>3.1</reference></locality></origin>
 
-    def eref_localities(refs, target, n)
+    def eref_localities(refs, target, node)
       ret = ""
       refs.each_with_index do |r, i|
         delim = ","
         delim = ";" if r.name == "localityStack" && i.positive?
-        ret = eref_locality_stack(r, i, target, delim, ret, n)
+        ret = eref_locality_stack(r, i, target, delim, ret, node)
       end
       ret
     end
 
-    def eref_locality_stack(r, idx, target, delim, ret, n)
-      if r.name == "localityStack"
-        r.elements.each_with_index do |rr, j|
-          ret += eref_localities0(rr, j, target, delim, n)
+    def eref_locality_stack(ref, idx, target, delim, ret, node)
+      if ref.name == "localityStack"
+        ref.elements.each_with_index do |rr, j|
+          ret += eref_localities0(rr, j, target, delim, node)
           delim = ","
         end
       else
-        ret += eref_localities0(r, idx, target, delim, n)
+        ret += eref_localities0(ref, idx, target, delim, node)
       end
       ret
     end
 
-    def eref_localities0(r, _i, target, delim, n)
-      if r["type"] == "whole" then l10n("#{delim} #{@i18n.wholeoftext}")
+    def eref_localities0(ref, _idx, target, delim, node)
+      if ref["type"] == "whole" then l10n("#{delim} #{@i18n.wholeoftext}")
       else
-        eref_localities1(target, r["type"], r.at(ns("./referenceFrom")),
-                         r.at(ns("./referenceTo")), delim, n, @lang)
+        eref_localities1(target, ref["type"], ref.at(ns("./referenceFrom")),
+                         ref.at(ns("./referenceTo")), delim, node, @lang)
       end
     end
 
     # TODO: move to localization file
-    def eref_localities1_zh(_target, type, from, to, n, delim)
+    def eref_localities1_zh(_target, type, from, upto, node, delim)
       ret = "#{delim} 第#{from.text}" if from
-      ret += "&ndash;#{to.text}" if to
+      ret += "&ndash;#{upto.text}" if upto
       loc = (@i18n.locality[type] || type.sub(/^locality:/, "").capitalize)
-      ret += " #{loc}" unless n["droploc"] == "true"
+      ret += " #{loc}" unless node["droploc"] == "true"
       ret
     end
 
     # TODO: move to localization file
-    def eref_localities1(target, type, from, to, delim, n, lang = "en")
+    def eref_localities1(target, type, from, upto, delim, node, lang = "en")
       return "" if type == "anchor"
 
       lang == "zh" and
-        return l10n(eref_localities1_zh(target, type, from, to, n, delim))
+        return l10n(eref_localities1_zh(target, type, from, upto, node, delim))
       ret = delim
-      ret += eref_locality_populate(type, n)
+      ret += eref_locality_populate(type, node)
       ret += " #{from.text}" if from
-      ret += "&ndash;#{to.text}" if to
+      ret += "&ndash;#{upto.text}" if upto
       l10n(ret)
     end
 
@@ -158,12 +162,15 @@ module IsoDoc
     end
 
     def concept1(node)
-      content = node.first_element_child.children.select do |c|
-        !%w{locality localityStack}.include? c.name
+      content = node.first_element_child.children.reject do |c|
+        %w{locality localityStack}.include? c.name
       end.select { |c| !c.text? || /\S/.match(c) }
-      node.replace content.empty? ?
-        @i18n.term_defined_in.sub(/%/, node.first_element_child.to_xml) :
-        "<em>#{node.children.to_xml}</em>"
+      n = if content.empty?
+            @i18n.term_defined_in.sub(/%/, node.first_element_child.to_xml)
+          else
+            "<em>#{node.children.to_xml}</em>"
+          end
+      node.replace(n)
     end
 
     def variant(docxml)

data/lib/isodoc/presentation_function/section.rb

@@ -2,20 +2,21 @@ module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def clause(docxml)
       docxml.xpath(ns("//clause | "\
-                      "//terms | //definitions | //references")).
-                     each do |f|
+                      "//terms | //definitions | //references"))
+        .each do |f|
         clause1(f)
       end
     end
 
-    def clause1(f)
-      level = @xrefs.anchor(f['id'], :level, false) || "1"
-      t = f.at(ns("./title")) and t["depth"] = level
-      return if !f.ancestors("boilerplate").empty?
-      return if @suppressheadingnumbers || f["unnumbered"]
-      lbl = @xrefs.anchor(f['id'], :label,
-                          f.parent.name != "sections") or return
-      prefix_name(f, "<tab/>", "#{lbl}#{clausedelim}", "title")
+    def clause1(elem)
+      level = @xrefs.anchor(elem["id"], :level, false) || "1"
+      t = elem.at(ns("./title")) and t["depth"] = level
+      return if !elem.ancestors("boilerplate").empty? ||
+        @suppressheadingnumbers || elem["unnumbered"]
+
+      lbl = @xrefs.anchor(elem["id"], :label,
+                          elem.parent.name != "sections") or return
+      prefix_name(elem, "<tab/>", "#{lbl}#{clausedelim}", "title")
     end
 
     def annex(docxml)
@@ -24,12 +25,12 @@ module IsoDoc
       end
     end
 
-    def annex1(f)
-      lbl = @xrefs.anchor(f['id'], :label)
-      if t = f.at(ns("./title"))
+    def annex1(elem)
+      lbl = @xrefs.anchor(elem["id"], :label)
+      if t = elem.at(ns("./title"))
         t.children = "<strong>#{t.children.to_xml}</strong>"
       end
-      prefix_name(f, "<br/><br/>", lbl, "title")
+      prefix_name(elem, "<br/><br/>", lbl, "title")
     end
 
     def term(docxml)
@@ -38,18 +39,52 @@ module IsoDoc
       end
     end
 
-    def term1(f)
-      lbl = @xrefs.get[f["id"]][:label] or return
-      prefix_name(f, "", "#{lbl}#{clausedelim}", "name")
+    def term1(elem)
+      lbl = @xrefs.get[elem["id"]][:label] or return
+      prefix_name(elem, "", "#{lbl}#{clausedelim}", "name")
     end
 
     def references(docxml)
     end
 
+    def docid_prefixes(docxml)
+      docxml.xpath(ns("//references/bibitem/docidentifier")).each do |i|
+        i.children = @xrefs.klass.docid_prefix(i["type"], i.text)
+      end
+    end
+
     def index(docxml)
-      docxml.xpath(ns("//index | //index-xref | //indexsect")).each do |f|
-        f.remove
+      docxml.xpath(ns("//index | //index-xref | //indexsect")).each(&:remove)
+    end
+
+    def display_order_at(docxml, xpath, idx)
+      return idx unless c = docxml.at(ns(xpath))
+
+      idx += 1
+      c["displayorder"] = idx
+      idx
+    end
+
+    def display_order_xpath(docxml, xpath, idx)
+      docxml.xpath(ns(xpath)).each do |c|
+        idx += 1
+        c["displayorder"] = idx
       end
+      idx
+    end
+
+    def display_order(docxml)
+      i = 0
+      i = display_order_xpath(docxml, "//preface/*", i)
+      i = display_order_at(docxml, "//clause[@type = 'scope']", i)
+      i = display_order_at(docxml, @xrefs.klass.norm_ref_xpath, i)
+      i = display_order_at(docxml, "//sections/terms | "\
+                           "//sections/clause[descendant::terms]", i)
+      i = display_order_at(docxml, "//sections/definitions", i)
+      i = display_order_xpath(docxml, @xrefs.klass.middle_clause(docxml), i)
+      i = display_order_xpath(docxml, "//annex", i)
+      i = display_order_xpath(docxml, @xrefs.klass.bibliography_xpath, i)
+      display_order_xpath(docxml, "//indexsect", i)
     end
   end
 end

data/lib/isodoc/presentation_xml_convert.rb

@@ -22,12 +22,14 @@ module IsoDoc
 
     def conversions(docxml)
       bibdata docxml
+      @xrefs.parse docxml
       section docxml
       block docxml
       inline docxml
     end
 
     def section(docxml)
+      display_order docxml
       clause docxml
       annex docxml
       term docxml

data/lib/isodoc/sassc_importer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sassc'
+require "sassc"
 
 class SasscImporter < SassC::Importer
   def imports(path, _parent_path)