isodoc 2.1.0.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc4bad696f0cd3e8c530eaf2c0b7722379d8412a055a2431d6367a9a0d6a939b
-  data.tar.gz: 2529ca812cfe2e7c229c03fd9e9e2d0d367ccb92d9413837fa22446955519417
+  metadata.gz: 28ac8ba37e46dab584c5c8b31b651a3c35554c48a286edbe27380837d8cf2bcb
+  data.tar.gz: b8aa34af74f5ea34f01a8e80e5c9d3d9d1c8f04623e490efcd4ef405fa3d9d89
 SHA512:
-  metadata.gz: 42adec43794af927dcba7cb365d0044d2b1544a13a63f11fee15e66096e42329c6dea9949b2b4d70a2689a81daffe8d7b87772d4131199688fe4abfc88104d24
-  data.tar.gz: b352d2087309de8f6b478835419ebddbdf31f5dee372de95276072381332a6836d971446fe61efe4ede949c6f7798e1e34c8d6462cf41543278667242596f2ca
+  metadata.gz: 48b4097c940f272ce85bb6ccce887df0640525d90176246b00772f2b858daf1a8a3710ccd06766048a2c57030abbed6a72f122dddd084717604e30d08290b01d
+  data.tar.gz: 21cc6a5137d95431098706c1f0a71f2ce759da10fdd892bb8cf7fcbc7a74dbc671a5d8bb90d7e1ec072d7eb3a3aa618112dade4dda0a3944a4a9e95455bd1748

data/isodoc.gemspec

@@ -24,12 +24,15 @@ Gem::Specification.new do |spec|
 
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]
-  spec.files         = `git ls-files`.split("\n")
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|.github)/}) \
+    || f.match(%r{\.[a-zA-Z0-9_-]+\.yml|Rakefile|bin/rspec})
+  end
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "asciimath"
-  spec.add_dependency "html2doc", "~> 1.4.0"
+  spec.add_dependency "html2doc", "~> 1.4.1"
   spec.add_dependency "htmlentities", "~> 4.3.4"
   spec.add_dependency "isodoc-i18n", "~> 1.0.0"
   spec.add_dependency "liquid", "~> 4"
@@ -37,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "emf2svg"
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-utils"
-  spec.add_dependency "nokogiri", "~> 1.12.0"
+
   spec.add_dependency "relaton-cli"
   spec.add_dependency "relaton-render", ">= 0.3.1"
   spec.add_dependency "roman-numerals"

data/lib/isodoc/base_style/blocks.scss

@@ -23,6 +23,13 @@
   }
 }
 
+@mixin listBlock() {
+  .ListTitle {
+    @include blockTitle();
+    text-align: left;
+  }
+}
+
 @mixin figureBlock() {
   .FigureTitle, .figure-title {
     @include blockTitle();

data/lib/isodoc/class_utils.rb

@@ -7,7 +7,7 @@ module IsoDoc
       return date.text unless from || on || to
       return on.text if on
 
-      ret = "#{from.text}–"
+      ret = "#{from.text}–"
       ret += to.text if to
       ret
     end

data/lib/isodoc/function/blocks.rb

@@ -169,7 +169,7 @@ module IsoDoc
         return if author.nil? && source.nil?
 
         out.p **{ class: "QuoteAttribution" } do |p|
-          p << "&mdash; #{author.text}" if author
+          p << "&#x2014; #{author.text}" if author
           p << ", " if author && source
           eref_parse(source, p) if source
         end

data/lib/isodoc/function/cleanup.rb

@@ -66,7 +66,7 @@ module IsoDoc
           title = d.at("./title")
           n = title.next_element
           n&.children&.first
-            &.add_previous_sibling("#{title.remove.text}—")
+            &.add_previous_sibling("#{title.remove.text}—")
         end
         docxml
       end

data/lib/isodoc/function/inline.rb

@@ -14,6 +14,8 @@ module IsoDoc
         end
       end
 
+      def location_parse(node, out); end
+
       def span_parse(node, out)
         node.children.each { |n| parse(n, out) }
       end
@@ -134,8 +136,8 @@ module IsoDoc
 
         text = node.to_s
         if in_sourcecode
-          text = text.gsub("\n", "<br/>").gsub("<br/> ", "<br/>&nbsp;")
-            .gsub(/ (?= )/, "&nbsp;")
+          text = text.gsub("\n", "<br/>").gsub("<br/> ", "<br/>&#xa0;")
+            .gsub(/ (?= )/, "&#xa0;")
         end
         out << text
       end

data/lib/isodoc/function/lists.rb

@@ -1,13 +1,21 @@
 module IsoDoc
   module Function
     module Lists
+      def list_title_parse(node, out)
+        name = node.at(ns("./name")) or return
+        out.p **{ class: "ListTitle" } do |p|
+          name&.children&.each { |n| parse(n, p) }
+        end
+      end
+
       def ul_attrs(node)
         { id: node["id"], style: keep_style(node) }
       end
 
       def ul_parse(node, out)
+        list_title_parse(node, out)
         out.ul **attr_code(ul_attrs(node)) do |ul|
-          node.children.each { |n| parse(n, ul) }
+          node.children.each { |n| n.name == "name" or parse(n, ul) }
         end
       end
 
@@ -44,8 +52,9 @@ module IsoDoc
       end
 
       def ol_parse(node, out)
+        list_title_parse(node, out)
         out.ol **attr_code(ol_attrs(node)) do |ol|
-          node.children.each { |n| parse(n, ol) }
+          node.children.each { |n| n.name == "name" or parse(n, ol) }
         end
       end
 
@@ -82,17 +91,23 @@ module IsoDoc
       end
 
       def dl_parse(node, out)
+        list_title_parse(node, out)
         out.dl **dl_attrs(node) do |v|
           node.elements.select { |n| dt_dd? n }.each_slice(2) do |dt, dd|
-            v.dt **attr_code(id: dt["id"]) do |term|
-              dt_parse(dt, term)
-            end
-            v.dd **attr_code(id: dd["id"]) do |listitem|
-              dd.children.each { |n| parse(n, listitem) }
-            end
+            dl_parse1(v, dt, dd)
           end
         end
-        node.elements.reject { |n| dt_dd? n }.each { |n| parse(n, out) }
+        node.elements.reject { |n| dt_dd?(n) || n.name == "name" }
+          .each { |n| parse(n, out) }
+      end
+
+      def dl_parse1(dlist, dterm, ddef)
+        dlist.dt **attr_code(id: dterm["id"]) do |term|
+          dt_parse(dterm, term)
+        end
+        dlist.dd **attr_code(id: ddef["id"]) do |listitem|
+          ddef.children.each { |n| parse(n, listitem) }
+        end
       end
     end
   end

data/lib/isodoc/function/table.rb

@@ -82,7 +82,7 @@ module IsoDoc
           node.xpath(ns("./note")).each { |n| parse(n, out) }
         end
         @in_table = false
-        # out.p { |p| p << "&nbsp;" }
+        # out.p { |p| p << "&#xa0;" }
       end
 
       SW = "solid windowtext".freeze

data/lib/isodoc/function/to_word_html.rb

@@ -73,14 +73,14 @@ module IsoDoc
 
       def make_body1(body, _docxml)
         body.div **{ class: "title-section" } do |div1|
-          div1.p { |p| p << "&nbsp;" } # placeholder
+          div1.p { |p| p << "&#xa0;" } # placeholder
         end
         section_break(body)
       end
 
       def make_body2(body, _docxml)
         body.div **{ class: "prefatory-section" } do |div2|
-          div2.p { |p| p << "&nbsp;" } # placeholder
+          div2.p { |p| p << "&#xa0;" } # placeholder
         end
         section_break(body)
       end
@@ -231,6 +231,7 @@ module IsoDoc
           when "toc" then toc_parse(node, out)
           when "variant-title" then variant_title(node, out)
           when "span" then span_parse(node, out)
+          when "location" then location_parse(node, out)
           else error_parse(node, out)
           end
         end

data/lib/isodoc/function/utils.rb

@@ -12,7 +12,7 @@ module IsoDoc
       end
 
       def insert_tab(out, count)
-        tab = %w(Hans Hant).include?(@script) ? "　" : "  "
+        tab = %w(Hans Hant).include?(@script) ? "　" : "  "
         [1..count].each { out << tab }
       end
 
@@ -58,24 +58,30 @@ module IsoDoc
         end
       end
 
-      def to_xhtml_prep(xml)
-        xml.gsub!(/<\?xml[^>]*>/, "")
-        /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml)
+      def numeric_escapes(xml)
+        c = HTMLEntities.new
         xml.split(/(&[^ \r\n\t#;]+;)/).map do |t|
           if /^(&[^ \t\r\n#;]+;)/.match?(t)
-            HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal)
+            c.encode(c.decode(t), :hexadecimal)
           else t
           end
         end.join
       end
 
+      def to_xhtml_prep(xml)
+        xml.gsub!(/<\?xml[^>]*>/, "")
+        /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml)
+        numeric_escapes(xml)
+      end
+
       def to_xhtml_fragment(xml)
         doc = ::Nokogiri::XML.parse(NOKOHEAD)
         doc.fragment(xml)
       end
 
       def from_xhtml(xml)
-        xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")
+        numeric_escapes(xml.to_xml
+          .sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, ""))
       end
 
       CLAUSE_ANCESTOR =
@@ -100,8 +106,12 @@ module IsoDoc
         "local-name() = 'figure' or local-name() = 'formula' or "\
         "local-name() = 'table' or local-name() = 'example']/@id"
 
-      def get_note_container_id(node)
-        container = node.xpath(NOTE_CONTAINER_ANCESTOR)
+      # no recursion on references
+      def get_note_container_id(node, type)
+        xpath = NOTE_CONTAINER_ANCESTOR.dup
+        %w(figure table example).include?(type) and
+          xpath.sub!(%r[ or local-name\(\) = '#{type}'], "")
+        container = node.xpath(xpath)
         container&.last&.text || nil
       end
 

data/lib/isodoc/gem_tasks.rb

@@ -8,14 +8,20 @@ module IsoDoc
   module GemTasks
     extend Rake::DSL if defined? Rake::DSL
 
+    @@css_list = []
+
     module_function
 
+    def self.css_list
+      @@css_list
+    end
+
     def install
       rule ".css" => [proc { |tn| tn.sub(/\.css$/, ".scss") }] do |current_task|
         puts(current_task)
         compile_scss_task(current_task)
       rescue StandardError => e
-        notify_borken_compilation(e, current_task)
+        notify_broken_compilation(e, current_task)
       end
 
       scss_files = Rake::FileList["lib/**/*.scss"]
@@ -40,25 +46,27 @@ module IsoDoc
       end
     end
 
-    def notify_borken_compilation(error, current_task)
+    def interactive?
+      ENV["CI"] == nil
+    end
+
+    def notify_broken_compilation(error, current_task)
       puts("Cannot compile #{current_task} because of #{error.message}")
+      return unless interactive?
+
       puts("continue anyway[y|n]?")
-      answer = STDIN.gets.strip
-      if %w[y yes].include?(answer.strip.downcase)
-        puts("Cannot compile #{current_task} because of #{error.message}")
-      else
-        exit(0)
-      end
+      answer = $stdin.gets.strip
+      exit(0) unless %w[y yes].include?(answer.strip.downcase)
     end
 
     def git_cache_compiled_files
-      CLEAN.each do |css_file|
+      @@css_list.each do |css_file|
         sh "git add #{css_file}"
       end
     end
 
     def git_rm_compiled_files
-      CLEAN.each do |css_file|
+      @@css_list.each do |css_file|
         sh "git rm --cached #{css_file}"
       end
     end
@@ -129,6 +137,7 @@ module IsoDoc
       File.open(compiled_path, "w:UTF-8") do |f|
         f.write(content)
       end
+      @@css_list << compiled_path
       CLEAN << compiled_path
     end
   end

data/lib/isodoc/html_function/html.rb

@@ -20,7 +20,7 @@ module IsoDoc
         return if @bare
 
         body.div **{ class: "title-section" } do |div1|
-          div1.p { |p| p << "&nbsp;" } # placeholder
+          div1.p { |p| p << "&#xa0;" } # placeholder
         end
         section_break(body)
       end
@@ -29,7 +29,7 @@ module IsoDoc
         return if @bare
 
         body.div **{ class: "prefatory-section" } do |div2|
-          div2.p { |p| p << "&nbsp;" } # placeholder
+          div2.p { |p| p << "&#xa0;" } # placeholder
         end
         section_break(body)
       end

data/lib/isodoc/i18n.rb

@@ -23,3 +23,22 @@ module IsoDoc
     end
   end
 end
+
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |_, v1, v2|
+      if Hash === v1 && Hash === v2
+        v1.merge(v2, &merger)
+      elsif Array === v1 && Array === v2
+        v1 | v2
+      elsif [:undefined, nil,
+             :nil].include?(v2)
+        v1
+      else
+        v2
+      end
+    }
+    merge(second.to_h, &merger)
+  end
+end
+

data/lib/isodoc/metadata.rb

@@ -11,8 +11,8 @@ module IsoDoc
       Common::ns(xpath)
     end
 
-    def l10n(a, b, c)
-      @i18n.l10n(a, b, c)
+    def l10n(expr, lang, script)
+      @i18n.l10n(expr, lang, script)
     end
 
     def initialize(lang, script, i18n, fonts_options = {})

data/lib/isodoc/presentation_function/block.rb

@@ -31,7 +31,7 @@ module IsoDoc
       return if labelled_ancestor(elem)
 
       lbl = @xrefs.anchor(elem["id"], :label, false) or return
-      prefix_name(elem, " — ",
+      prefix_name(elem, " — ",
                   l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 
@@ -60,7 +60,7 @@ module IsoDoc
             else
               l10n("#{@i18n.example} #{n[:label]}")
             end
-      prefix_name(elem, " — ", lbl, "name")
+      prefix_name(elem, " — ", lbl, "name")
     end
 
     def note(docxml)
@@ -130,7 +130,7 @@ module IsoDoc
       return if elem["unnumbered"] && !elem.at(ns("./name"))
 
       n = @xrefs.anchor(elem["id"], :label, false)
-      prefix_name(elem, " — ", l10n("#{lower2cap @i18n.table} #{n}"),
+      prefix_name(elem, " — ", l10n("#{lower2cap @i18n.table} #{n}"),
                   "name")
     end
 

data/lib/isodoc/presentation_function/image.rb

@@ -32,7 +32,7 @@ module IsoDoc
       return if elem.at(ns("./figure")) && !elem.at(ns("./name"))
 
       lbl = @xrefs.anchor(elem["id"], :label, false) or return
-      prefix_name(elem, " — ",
+      prefix_name(elem, " — ",
                   l10n("#{lower2cap @i18n.figure} #{lbl}"), "name")
     end
 

data/lib/isodoc/presentation_function/inline.rb

@@ -158,7 +158,7 @@ module IsoDoc
     # TODO: move to localization file
     def eref_localities1_zh(_target, type, from, upto, node)
       ret = "第#{from}" if from
-      ret += "–#{upto}" if upto
+      ret += "–#{upto}" if upto
       loc = eref_locality_populate(type, node)
       ret += " #{loc}" unless node["droploc"] == "true"
       ret
@@ -172,19 +172,20 @@ module IsoDoc
         return l10n(eref_localities1_zh(target, type, from, upto, node))
       ret = eref_locality_populate(type, node)
       ret += " #{from}" if from
-      ret += "–#{upto}" if upto
+      ret += "–#{upto}" if upto
       l10n(ret)
     end
 
     def eref_locality_populate(type, node)
       return "" if node["droploc"] == "true"
 
-      loc = @i18n.locality[type] || type.sub(/^locality:/, "")
-      loc = case node["case"]
+      loc = type.sub(/^locality:/, "")
+      ret = @i18n.locality[loc] || loc
+      ret = case node["case"]
             when "lowercase" then loc.downcase
-            else Metanorma::Utils.strict_capitalize_first(loc)
+            else Metanorma::Utils.strict_capitalize_first(ret)
             end
-      " #{loc}"
+      " #{ret}"
     end
 
     def xref(docxml)
@@ -226,6 +227,12 @@ module IsoDoc
       end
     end
 
+    def identifier(docxml)
+      docxml.xpath(ns("//identifier")).each do |n|
+        n.name = "tt"
+      end
+    end
+
     private
 
     def found_matching_variant_sibling(node)

data/lib/isodoc/presentation_function/section.rb

@@ -56,7 +56,7 @@ module IsoDoc
 
     def single_term_clause(elem)
       t = elem.at(ns("./terms | ./definitions | ./references"))
-      t.at(ns("./title")).remove
+      t.at(ns("./title"))&.remove
       t.xpath(ns(".//clause | .//terms | .//definitions | .//references"))
         .each do |c|
           tit = c.at(ns("./title")) or return
@@ -84,6 +84,8 @@ module IsoDoc
     end
 
     def bibitem(xml)
+      @xrefs.klass.implicit_reference(xml) and
+        xml["hidden"] = "true"
       bibrender(xml)
     end
 

data/lib/isodoc/presentation_function/xrefs.rb

@@ -26,24 +26,39 @@ module IsoDoc
     def anchor_linkend1(node)
       linkend = @xrefs.anchor(node["target"], :xref)
       container = @xrefs.anchor(node["target"], :container, false)
-      (container && get_note_container_id(node) != container &&
-       @xrefs.get[node["target"]]) and
+      prefix_container?(container, node) and
         linkend = prefix_container(container, linkend, node["target"])
       capitalise_xref(node, linkend, anchor_value(node["target"]))
     end
 
+    def prefix_container?(container, node)
+      type = @xrefs.anchor(node["target"], :type)
+      container &&
+        get_note_container_id(node, type) != container &&
+        @xrefs.get[node["target"]]
+    end
+
     def combine_xref_locations(node)
       locs = gather_xref_locations(node)
       linkend = if can_conflate_xref_rendering?(locs)
-                  out = locs.each { |l| l[:target] = anchor_value(l[:target]) }
-                  l10n("#{locs.first[:elem]} #{combine_conn(out)}")
+                  combine_conflated_xref_locations(locs)
                 else
-                  out = locs.each { |l| l[:target] = anchor_linked1(l[:node]) }
+                  out = locs.each { |l| l[:target] = anchor_linkend1(l[:node]) }
                   l10n(combine_conn(out))
                 end
       capitalise_xref(node, linkend, anchor_value(node["target"]))
     end
 
+    def combine_conflated_xref_locations(locs)
+      out = locs.each { |l| l[:target] = anchor_value(l[:target]) }
+      ret = l10n("#{locs.first[:elem]} #{combine_conn(out)}")
+      container = @xrefs.anchor(locs.first[:node]["target"], :container,
+                                false)
+      prefix_container?(container, locs.first[:node]) and
+        ret = prefix_container(container, ret, locs.first[:node]["target"])
+      ret
+    end
+
     def gather_xref_locations(node)
       node.xpath(ns("./location")).each_with_object([]) do |l, m|
         type = @xrefs.anchor(l["target"], :type)
@@ -74,7 +89,8 @@ module IsoDoc
     end
 
     def can_conflate_xref_rendering?(locs)
-      !locs.all? { |l| l[:container].nil? } &&
+      (locs.all? { |l| l[:container].nil? } ||
+       locs.all? { |l| l[:container] == locs.first[:container] }) &&
         locs.all? { |l| l[:type] == locs[0][:type] }
     end
 

data/lib/isodoc/presentation_xml_convert.rb

@@ -68,6 +68,7 @@ module IsoDoc
       quotesource docxml
       mathml docxml
       variant docxml
+      identifier docxml
     end
 
     def terms(docxml)

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.1.0.1".freeze
+  VERSION = "2.1.2".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -20,7 +20,7 @@ module IsoDoc
 
       def make_body1(body, _docxml)
         body.div **{ class: "WordSection1" } do |div1|
-          div1.p { |p| p << "&nbsp;" } # placeholder
+          div1.p { |p| p << "&#xa0;" } # placeholder
         end
         section_break(body)
       end
@@ -34,7 +34,7 @@ module IsoDoc
           introduction docxml, div2
           preface docxml, div2
           acknowledgements docxml, div2
-          div2.p { |p| p << "&nbsp;" } # placeholder
+          div2.p { |p| p << "&#xa0;" } # placeholder
         end
         section_break(body)
       end
@@ -64,7 +64,7 @@ module IsoDoc
       def para_parse(node, out)
         out.p **attr_code(para_attrs(node)) do |p|
           unless @termdomain.empty?
-            p << "&lt;#{@termdomain}&gt; "
+            p << "&#x3c;#{@termdomain}&#x3e; "
             @termdomain = ""
           end
           node.children.each { |n| parse(n, p) unless n.name == "note" }
@@ -92,8 +92,10 @@ module IsoDoc
       end
 
       def dl_parse_table(node, out)
+        list_title_parse(node, out)
         out.table **{ class: "dl" } do |v|
-          node.elements.select { |n| dt_dd? n }.each_slice(2) do |dt, dd|
+          node.elements.select { |n| dt_dd?(n) }
+            .each_slice(2) do |dt, dd|
             dl_parse_table1(v, dt, dd)
           end
           dl_parse_notes(node, v)
@@ -112,11 +114,12 @@ module IsoDoc
       end
 
       def dl_parse_notes(node, out)
-        return if node.elements.reject { |n| dt_dd? n }.empty?
+        remainder = node.elements.reject { |n| dt_dd?(n) || n.name == "name" }
+        return if remainder.empty?
 
         out.tr do |tr|
           tr.td **{ colspan: 2 } do |td|
-            node.elements.reject { |n| dt_dd? n }.each { |n| parse(n, td) }
+            remainder.each { |n| parse(n, td) }
           end
         end
       end

data/lib/isodoc/word_function/postprocess.rb

@@ -187,7 +187,7 @@ module IsoDoc
           next unless t.children.empty?
 
           t["style"] = t["style"].sub(/;?$/, ";font-size:0pt;")
-          t.children = " "
+          t.children = " "
         end
       end