isodoc 1.4.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf37a37eb402d844a36b33e3911c67d3ebcbef7bf7f864dfc0e9f3a8aca7603c
-  data.tar.gz: cc3645b92e85d43e2c6e49cfce67cc13d0f656cf1c16d67247cb7053eceba394
+  metadata.gz: a6b9025bfaedc51dd8e707cd191e5cca2790abe37859c2d7612058f67e4e4f3f
+  data.tar.gz: f176dde82d63fbc4664db489c8ca6411db6a573c6d8dbc5a1e70320b4db61fed
 SHA512:
-  metadata.gz: 83bfcc73e86c73c9373bf9b42170ebc58c4ae50e4a0789cacddefa05c5b80fe1c59559e3abde2071e79aa3fd839d7844b3c0145ca89ed09b9d6d7e09b1e03de9
-  data.tar.gz: 11fbb6a5a6a19eadae64d22dd032185eaed46a1dd007f188e26cc73153e75ceb16ec3c64c8613c8dc05e0263fafab98655287e23993c34ebcf815096dca50bda
+  metadata.gz: 3d35f5d9a2ec0ff9cb2990ef937d2bc16a35b3b221c7c59003f37e5b446d34aac101517f1325831c2d40d9a2a0c5cca93eea525e3fd0c31b4ec0e5c6cb9ac552
+  data.tar.gz: f1b47eb92f282d86e41eab040c8fcaf566e0b4eb3052eca61edd630a28746331c2dce84349cd055cd1edb9260a903fc9c3adf87019dfd75dbff85322f22714e5

data/.github/workflows/rake.yml

@@ -16,17 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
         include:
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'ubuntu-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'windows-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'macos-latest'
             experimental: true
     steps:
@@ -35,35 +35,19 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
-      - uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
-          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
-
-      - run: bundle config set path 'vendor/bundle'
-
-      - run: bundle install --jobs 4 --retry 3
-
-      - name: Install Inkscape macOS
-        if: matrix.os == 'macos-latest'
-        run: |
-          brew cask install inkscape
-          inkscape --version
-
-      - name: Install Inkscape Ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        run: |
-          sudo add-apt-repository ppa:inkscape.dev/stable
-          sudo apt update
-          sudo apt install inkscape
-          inkscape --version
-
-      - name: Install Inkscape Windows
-        if: matrix.os == 'windows-latest'
-        run: |
-          choco install --no-progress -y inkscape
-          inkscape --version
+      - uses: metanorma/metanorma-build-scripts/inkscape-setup-action@master
 
       - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/isodoc.gemspec

@@ -30,11 +30,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "asciimath"
   spec.add_dependency "htmlentities", "~> 4.3.4"
-  spec.add_dependency "nokogiri", ">= 1.10.4"
+  spec.add_dependency "nokogiri", "~> 1.10.4"
   spec.add_dependency "thread_safe"
   spec.add_dependency "uuidtools"
   spec.add_dependency "html2doc", "~> 1.0.0"
-  spec.add_dependency "liquid"
+  spec.add_dependency "liquid", "~> 4"
   spec.add_dependency "twitter_cldr"
   spec.add_dependency "roman-numerals"
   spec.add_dependency "metanorma", "~> 1.2.0"
@@ -50,4 +50,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "= 0.54.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "rexml"
 end

data/lib/isodoc/convert.rb

@@ -9,6 +9,7 @@ module IsoDoc
   class Convert < ::IsoDoc::Common
     attr_accessor :options
     attr_accessor :i18n
+    attr_accessor :meta
 
     # htmlstylesheet: Generic stylesheet for HTML
     # wordstylesheet: Generic stylesheet for Word

data/lib/isodoc/function/inline.rb

@@ -39,7 +39,7 @@ module IsoDoc::Function
                        "uri[@type = 'citation']"))
       return href unless url
       href = suffix_url(url.text)
-      anchor = node&.at(ns(".//locality[@type = 'anchor']"))&.text
+      anchor = node&.at(ns(".//locality[@type = 'anchor']"))&.text&.strip
       anchor and href += "##{anchor}"
       href
     end

data/lib/isodoc/function/inline_simple.rb

@@ -71,5 +71,11 @@ module IsoDoc::Function
         node.children.each { |n| parse(n, e) }
       end
     end
+
+    def underline_parse(node, out)
+      out.u do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
   end
 end

data/lib/isodoc/function/references.rb

@@ -87,7 +87,7 @@ module IsoDoc::Function
 
     def omit_docid_prefix(prefix)
       return true if prefix.nil? || prefix.empty?
-      return %w(ISO IEC ITU W3C metanorma).include? prefix
+      return %w(ISO IEC IEV ITU W3C metanorma).include? prefix
     end
 
     def date_note_process(b, ref)

data/lib/isodoc/function/to_word_html.rb

@@ -109,7 +109,7 @@ module IsoDoc::Function
       @meta.get
     end
 
-    def middle_title(out)
+    def middle_title(_isoxml, out)
       out.p(**{ class: "zzSTDTitle1" }) { |p| p << @meta.get[:doctitle] }
     end
 
@@ -120,7 +120,7 @@ module IsoDoc::Function
     end
 
     def middle(isoxml, out)
-      middle_title(out)
+      middle_title(isoxml, out)
       middle_admonitions(isoxml, out)
       i = scope isoxml, out, 0
       i = norm_ref isoxml, out, i
@@ -157,6 +157,7 @@ module IsoDoc::Function
         when "sub" then sub_parse(node, out)
         when "tt" then tt_parse(node, out)
         when "strike" then strike_parse(node, out)
+        when "underline" then underline_parse(node, out)
         when "keyword" then keyword_parse(node, out)
         when "smallcap" then smallcap_parse(node, out)
         when "br" then br_parse(node, out)

data/lib/isodoc/function/utils.rb

@@ -152,8 +152,8 @@ module IsoDoc::Function
     def populate_template(docxml, _format = nil)
       meta = @meta
              .get
-             .merge(@labels || {})
-             .merge(@meta.labels || {})
+             .merge(@labels ? {labels: @labels} : {})
+             .merge(@meta.labels ? {labels: @meta.labels} : {})
              .merge(fonts_options || {})
       template = liquid(docxml)
       template.render(meta.map { |k, v| [k.to_s, empty2nil(v)] }.to_h)
@@ -161,7 +161,7 @@ module IsoDoc::Function
     end
 
     def save_dataimage(uri, _relative_dir = true)
-      %r{^data:image/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ uri
+      %r{^data:(image|application)/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ uri
       imgtype.sub!(/\+[a-z0-9]+$/, '') # svg+xml
       imgtype = 'png' unless /^[a-z0-9]+$/.match imgtype
       Tempfile.open(['image', ".#{imgtype}"]) do |f|
@@ -173,7 +173,7 @@ module IsoDoc::Function
     end
 
     def image_localfile(i)
-      if /^data:image/.match? i['src']
+      if /^data:/.match? i['src']
         save_dataimage(i['src'], false)
       elsif %r{^([A-Z]:)?/}.match? i['src']
         i['src']

data/lib/isodoc/html_function/html.rb

@@ -111,6 +111,12 @@ module IsoDoc::HtmlFunction
       sourcecode_name_parse(node, out, name)
     end
 
+    def underline_parse(node, out)
+      out.span **{ style: "text-decoration: underline;" } do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+
     def table_long_strings_cleanup(docxml)
     end
   end

data/lib/isodoc/html_function/postprocess.rb

@@ -137,7 +137,7 @@ module IsoDoc::HtmlFunction
       docxml.xpath("//*[local-name() = 'img']").each do |i|
         i["width"], i["height"] = Html2Doc.image_resize(i, image_localfile(i),
                                                         @maxheight, @maxwidth)
-        next if /^data:image/.match i["src"]
+        next if /^data:/.match i["src"]
         @datauriimage ? datauri(i) : move_image1(i)
       end
       docxml
@@ -145,9 +145,10 @@ module IsoDoc::HtmlFunction
 
     def datauri(i)
       type = i["src"].split(".")[-1]
+      supertype = type == "xml" ? "application" : "image"
       bin = IO.binread(image_localfile(i))
       data = Base64.strict_encode64(bin)
-      i["src"] = "data:image/#{type};base64,#{data}"
+      i["src"] = "data:#{supertype}/#{type};base64,#{data}"
     end
 
     def image_suffix(i)

data/lib/isodoc/presentation_function/block.rb

@@ -9,6 +9,12 @@ module IsoDoc
       docxml.xpath(ns("//figure")).each do |f|
         figure1(f)
       end
+      docxml.xpath(ns("//svgmap")).each do |s|
+        if f = s.at(ns("./figure")) then s.replace(f)
+        else
+          s.remove
+        end
+      end
     end
 
     def figure1(f)

data/lib/isodoc/presentation_function/inline.rb

@@ -211,7 +211,11 @@ module IsoDoc
     def mathml1(f, locale)
       localize_maths(f, locale)
       return unless f.elements.size == 1 && f.elements.first.name == "mn"
-      f.replace(f.at("./m:mn", MATHML).children)
+      if f.parent.name == "stem"
+        f.parent.replace(f.at("./m:mn", MATHML).children)
+      else
+        f.replace(f.at("./m:mn", MATHML).children)
+      end
     end
 
     def variant(docxml)

data/lib/isodoc/presentation_function/section.rb

@@ -47,7 +47,7 @@ module IsoDoc
     end
 
     def index(docxml)
-      docxml.xpath(ns("//index | //index-xref")).each do |f|
+      docxml.xpath(ns("//index | //index-xref | //indexsect")).each do |f|
         f.remove
       end
     end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "1.4.0".freeze
+  VERSION = "1.5.2".freeze
 end

data/lib/isodoc/word_function/inline.rb

@@ -24,7 +24,7 @@ module IsoDoc::WordFunction
 
     def imgsrc(node)
       ret = svg_to_emf(node) and return ret
-      return node["src"] unless %r{^data:image/}.match node["src"]
+      return node["src"] unless %r{^data:}.match node["src"]
       save_dataimage(node["src"])
     end
 
@@ -45,7 +45,7 @@ module IsoDoc::WordFunction
     def svg_to_emf(node)
       return unless node["mimetype"] == "image/svg+xml"
       uri = node["src"]
-      %r{^data:image/}.match(uri) and uri = save_dataimage(uri)
+      %r{^data:}.match(uri) and uri = save_dataimage(uri)
       ret = svg_to_emf_filename(uri)
       File.exists?(ret) and return ret
       exe = inkscape_installed? or return nil

data/lib/isodoc/word_function/postprocess_cover.rb

@@ -96,7 +96,7 @@ module IsoDoc::WordFunction
     def generate_header(filename, _dir)
       return nil unless @header
       template = IsoDoc::Common.liquid(File.read(@header, encoding: "UTF-8"))
-      meta = @meta.get.merge(@labels || {}).merge(@meta.labels || {})
+      meta = @meta.get.merge(@labels ? { labels: @labels } : {}).merge(@meta.labels ? { labels: @meta.labels } : {})
       meta[:filename] = filename
       params = meta.map { |k, v| [k.to_s, v] }.to_h
       Tempfile.open(%w(header html), :encoding => "utf-8") do |f|

data/lib/isodoc/xref/xref_counter.rb

@@ -2,41 +2,56 @@ require "roman-numerals"
 
 module IsoDoc::XrefGen
   class Counter
-    def initialize(num = 0)
+    def initialize(num = 0, opts = {numerals: :arabic})
       @num = num
       @letter = ""
       @subseq = ""
       @letter_override = nil
       @number_override = nil
+      @style = opts[:numerals]
       @base = ""
+      if num.is_a? String
+        if /^\d+$/.match(num)
+          @num = num.to_i
+        else
+          @num = nil
+          @base = num[0..-2]
+          @letter = num[-1]
+        end
+      end
     end
 
     def new_subseq_increment(node)
       @subseq = node["subsequence"]
-      @num += 1
+      @num += 1 unless @num.nil?
       @letter = node["subsequence"] ? "a" : ""
       @base = ""
       if node["number"]
-        /^(?<b>.*?)(?<n>\d*)(?<a>[a-z]*)$/ =~ node["number"]
+        /^(?<b>.*?)(?<n>\d*)(?<a>[a-zA-Z]*)$/ =~ node["number"]
         if !n.empty? || !a.empty?
           @letter_override = @letter = a unless a.empty?
           @number_override = @num = n.to_i unless n.empty?
           @base = b
         else
           @letter_override = node["number"]
-          @letter = @letter_override if /^[a-z]$/.match(@letter_override)
+          @letter = @letter_override if /^[a-zA-Z]$/.match(@letter_override)
         end
       end
     end
 
     def sequence_increment(node)
       if node["number"]
-        @base = ""
-        @number_override = node["number"]
+        @base = @letter_override = @number_override = ""
         /^(?<b>.*?)(?<n>\d+)$/ =~ node["number"]
-        unless n.nil? || n.empty?
+        if blank?(n)
+          @num = nil
+          @base = node["number"][0..-2]
+          @letter = @letter_override = node["number"][-1]
+        else
+          @number_override = node["number"]
           @num = n.to_i
           @base = b
+          @letter = ""
         end
       else
         @num += 1
@@ -47,9 +62,20 @@ module IsoDoc::XrefGen
       if node["number"]
         @base = ""
         @letter_override = node["number"]
-        /^(?<b>.*?)(?<n>\d*)(?<a>[a-z]+)$/ =~ node["number"]
-        unless a.empty?
-          @letter = a
+        /^(?<b>.*?)(?<n>\d*)(?<a>[a-zA-Z])$/ =~ node["number"]
+        if blank?(a)
+          if /^\d+$/.match(node["number"])
+            @letter_override = @letter = ""
+            @number_override = @num = node["number"].to_i
+          else
+            /^(?<b>.*)(?<a>[a-zA-Z])$/ =~ node["number"]
+            unless blank?(a)
+              @letter = @letter_override = a
+              @base = b
+            end
+          end
+        else
+          @letter_override = @letter = a
           @base = b
           @number_override = @num = n.to_i unless n.empty?
         end
@@ -58,11 +84,15 @@ module IsoDoc::XrefGen
       end
     end
 
+    def blank?(x)
+      x.nil? || x.empty?
+    end
+
     def increment(node)
       return self if node["unnumbered"]
       @letter_override = nil
       @number_override = nil
-      if node["subsequence"] != @subseq
+      if node["subsequence"] != @subseq && !(blank?(node["subsequence"]) && blank?(@subseq))
         new_subseq_increment(node)
       elsif @letter.empty?
         sequence_increment(node)
@@ -73,7 +103,9 @@ module IsoDoc::XrefGen
     end
 
     def print
-      "#{@base}#{@number_override || @num}#{@letter_override || @letter}"
+      num = @number_override || @num
+      num_out = @style == :roman && !num.nil? ? RomanNumerals.to_roman(num) : num
+      "#{@base}#{num_out}#{@letter_override || @letter}"
     end
 
     def ol_type(list, depth)

data/lib/isodoc/xref/xref_sect_gen.rb

@@ -1,23 +1,25 @@
 module IsoDoc::XrefGen
   module Sections
     def back_anchor_names(docxml)
-      docxml.xpath(ns("//annex")).each_with_index do |c, i|
-        annex_names(c, (65 + i).chr.to_s)
+      i = Counter.new("@")
+      docxml.xpath(ns("//annex")).each do |c|
+        i.increment(c)
+        annex_names(c, i.print)
+      end
+      docxml.xpath(ns(@klass.bibliography_xpath)).each do |b|
+        preface_names(b)
+      end
+      docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
+        reference_names(ref)
       end
-      docxml.xpath(
-           ns(@klass.bibliography_xpath)).each do |b|
-            preface_names(b)
-          end
-          docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
-            reference_names(ref)
-          end
     end
 
     def initial_anchor_names(d)
       d.xpath(ns("//preface/*")).each { |c| c.element? and preface_names(c) }
       # potentially overridden in middle_section_asset_names()
       sequential_asset_names(d.xpath(ns("//preface/*")))
-      n = section_names(d.at(ns("//clause[@type = 'scope']")), 0, 1)
+      n = Counter.new
+      n = section_names(d.at(ns("//clause[@type = 'scope']")), n, 1)
       n = section_names(d.at(ns(@klass.norm_ref_xpath)), n, 1)
       n = section_names(d.at(ns("//sections/terms | "\
                                 "//sections/clause[descendant::terms]")), n, 1)
@@ -52,8 +54,7 @@ module IsoDoc::XrefGen
       label = title || parent_title
       @anchors[clause["id"]] =
         { label: nil, level: level, xref: label, type: "clause" }
-      clause.xpath(ns(SUBCLAUSES)).
-        each_with_index do |c, i|
+      clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
         preface_names1(c, c.at(ns("./title"))&.text, "#{label} #{i+1}",
                        level + 1)
       end
@@ -67,21 +68,22 @@ module IsoDoc::XrefGen
       sequential_asset_names(d.xpath(ns(middle_sections)))
     end
 
-    def clause_names(docxml, sect_num)
+    def clause_names(docxml, n)
       docxml.xpath(ns(@klass.middle_clause(docxml))).each_with_index do |c, i|
-        section_names(c, (i + sect_num), 1)
+        section_names(c, n, 1)
       end
     end
 
     def section_names(clause, num, lvl)
       return num if clause.nil?
-      num = num + 1
+      num.increment(clause)
       @anchors[clause["id"]] =
-        { label: num.to_s, xref: l10n("#{@labels["clause"]} #{num}"), level: lvl,
+        { label: num.print, xref: l10n("#{@labels["clause"]} #{num.print}"), level: lvl,
           type: "clause" }
-      clause.xpath(ns(SUBCLAUSES)).
-        each_with_index do |c, i|
-        section_names1(c, "#{num}.#{i + 1}", lvl + 1)
+      i = Counter.new
+      clause.xpath(ns(SUBCLAUSES)).each do |c|
+        i.increment(c)
+        section_names1(c, "#{num.print}.#{i.print}", lvl + 1)
       end
       num
     end
@@ -90,9 +92,10 @@ module IsoDoc::XrefGen
       @anchors[clause["id"]] =
         { label: num, level: level, xref: l10n("#{@labels["clause"]} #{num}"),
           type: "clause" }
-      clause.xpath(ns(SUBCLAUSES)).
-        each_with_index do |c, i|
-        section_names1(c, "#{num}.#{i + 1}", level + 1)
+      i = Counter.new
+      clause.xpath(ns(SUBCLAUSES)).each do |c|
+        i.increment(c)
+        section_names1(c, "#{num}.#{i.print}", level + 1)
       end
     end
 
@@ -118,8 +121,10 @@ module IsoDoc::XrefGen
       if a = single_annex_special_section(clause)
         annex_names1(a, "#{num}", 1)
       else
-        clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
-          annex_names1(c, "#{num}.#{i + 1}", 2)
+        i = Counter.new
+        clause.xpath(ns(SUBCLAUSES)).each do |c|
+          i.increment(c)
+          annex_names1(c, "#{num}.#{i.print}", 2)
         end
       end
       hierarchical_asset_names(clause, num)
@@ -128,8 +133,10 @@ module IsoDoc::XrefGen
     def annex_names1(clause, num, level)
       @anchors[clause["id"]] = { label: num, xref: "#{@labels["annex"]} #{num}",
                                  level: level, type: "clause" }
-      clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
-        annex_names1(c, "#{num}.#{i + 1}", level + 1)
+      i = Counter.new
+      clause.xpath(ns(SUBCLAUSES)).each_with_index do |c|
+        i.increment(c)
+        annex_names1(c, "#{num}.#{i.print}", level + 1)
       end
     end