isodoc 2.0.5.2 → 2.0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '099aeb3456fabbcbd95076b6ccb9826997871b9d85ff079fc04aadf82a491a80'
-  data.tar.gz: 4002cee22c77b7a64f69864f3a67990cdfedddd458f95e86921ff132a804fe10
+  metadata.gz: c32b98e8156bdafb3ad6549d179b6607cc7811bf67191cf0ee736b6c72d5360f
+  data.tar.gz: 63236257e5e7f511e6cfe2ea9ff5c7a12dd2059be3bc588c50f15c8946e4a01d
 SHA512:
-  metadata.gz: 5342970e267f7a1b8c259d7c06c8cd27e5600cc0ff4d33033f5d8e5206d335050dd4d6f989f68220d8adc0966483f26c30e472b51cacbe93268ddbd24c42e1c7
-  data.tar.gz: 0f03dd6d85ada4c98a13b0a1bfe6c86b19d0dc5d02fc759a334d560eeed1ad7642a2c25c1442610187206d41a24aa058db3e16fb6f7a96d0e19ed6752a244290
+  metadata.gz: 58a629b21dee494368d7ad6c9f25fc3ac01ccb5f70b82674843cefdcb0959c484f770174ccb9ce75e52f4d4f906918fe1f390405dafd91119c945bade6ff716b
+  data.tar.gz: 11332100db734b1fd700ecfe164fb80ae0fd4be9843c6e48ffac4ea2c0d2d1ef4c417cb9e78c1a5d9cbae68294acac7f98fcb8365c10808a38153fae1f1dd2dd

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: metanorma/metanorma-build-scripts/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+      event_name: ${{ github.event_name }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+

data/lib/isodoc/function/to_word_html.rb

@@ -32,7 +32,7 @@ module IsoDoc
       def init_dir(filename, debug)
         dir = "#{filename}#{@tmpfilesdir_suffix}"
         unless debug
-          Dir.mkdir(dir, 0o777) unless File.exists?(dir)
+          Dir.mkdir(dir, 0o777) unless File.exist?(dir)
           FileUtils.rm_rf "#{dir}/*"
         end
         dir

data/lib/isodoc/html_convert.rb

@@ -24,7 +24,7 @@ module IsoDoc
 
     def convert(filename, file = nil, debug = false, output_filename = nil)
       ret = super
-      Dir.exists?(tmpimagedir) and Dir["#{tmpimagedir}/*"].empty? and
+      Dir.exist?(tmpimagedir) and Dir["#{tmpimagedir}/*"].empty? and
         FileUtils.rm_r tmpimagedir
       ret
     end

data/lib/isodoc/html_function/postprocess_footnotes.rb

@@ -36,7 +36,7 @@ module IsoDoc::HtmlFunction
     def footnote_backlinks(docxml)
       seen = {}
       docxml.xpath('//a[@class = "FootnoteRef"]').each_with_index do |x, i|
-        seen[x["href"]] and next or seen[x["href"]] = true
+        (seen[x["href"]] and next) or seen[x["href"]] = true
         fn = docxml.at(%<//*[@id = '#{x['href'].sub(/^#/, '')}']>) || next
         footnote_backlinks1(x, fn)
         x["id"] ||= "fnref:#{i + 1}"

data/lib/isodoc/metadata_contributor.rb

@@ -5,10 +5,9 @@ module IsoDoc
         if a.at(ns("./name/completename"))
           ret << a.at(ns("./name/completename")).text
         else
-          forenames = a.xpath(ns("./name/forename"))
-          fn = forenames.each_with_object([]) { |f, m| m << f.text }
-          surname = a&.at(ns("./name/surname"))&.text
-          ret << "#{fn.join(' ')} #{surname}"
+          fn = a.xpath(ns("./name/forename"))
+            .each_with_object([]) { |f, m| m << f.text }
+          ret << "#{fn.join(' ')} #{a&.at(ns('./name/surname'))&.text}"
         end
       end
     end

data/lib/isodoc/presentation_function/image.rb

@@ -64,7 +64,7 @@ module IsoDoc
     def svg_to_emf(node)
       uri = svg_to_emf_uri(node)
       ret = svg_to_emf_filename(uri)
-      File.exists?(ret) and return ret
+      File.exist?(ret) and return ret
       exe = inkscape_installed? or raise "Inkscape missing in PATH, unable" \
                                          "to convert EMF to SVG. Aborting."
       uri = Metanorma::Utils::external_path uri

data/lib/isodoc/presentation_xml_convert.rb

@@ -13,7 +13,7 @@ module IsoDoc
       super
     end
 
-    def convert1(docxml, filename, dir)
+    def convert1(docxml, _filename, _dir)
       @xrefs.parse docxml
       info docxml, nil
       conversions(docxml)
@@ -76,11 +76,11 @@ module IsoDoc
     end
 
     def postprocess(result, filename, _dir)
-      toXML(result, filename)
+      to_xml(result, filename)
       @files_to_delete.each { |f| FileUtils.rm_rf f }
     end
 
-    def toXML(result, filename)
+    def to_xml(result, filename)
       File.open(filename, "w:UTF-8") { |f| f.write(result) }
     end
   end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.0.5.2".freeze
+  VERSION = "2.0.6.1".freeze
 end

data/lib/isodoc/word_function/body.rb

@@ -206,7 +206,7 @@ module IsoDoc
 
         out.p { |p| p << @i18n.where }
         parse(deflist, out)
-        out.parent.at("./table")["class"] = "formula_dl"
+        t = out.parent.at("./table") and t["class"] = "formula_dl"
       end
 
       def formula_parse1(node, out)

data/lib/isodoc/word_function/postprocess.rb

@@ -107,9 +107,8 @@ module IsoDoc
                 x += 1
               end
               (r..(r + rs - 1)).each do |y2|
-                (x..(x + cs - 1)).each do |x2|
-                  cells2d[y2][x2] = 1
-                end
+                cells2d[y2].nil? and next
+                (x..(x + cs - 1)).each { |x2| cells2d[y2][x2] = 1 }
               end
               width = (x..(x + cs - 1)).each_with_object({ width: 0 }) do |z, m|
                 m[:width] += w[z]

data/lib/isodoc/xref/xref_gen.rb

@@ -35,7 +35,7 @@ module IsoDoc
         @labels["termnote"].gsub(/%/, note.to_s)
       end
 
-      def increment_label(elems, node, counter, increment = true)
+      def increment_label(elems, node, counter, increment: true)
         return "" if elems.size == 1 && !node["number"]
 
         counter.increment(node) if increment
@@ -62,10 +62,9 @@ module IsoDoc
           c = Counter.new
           examples.reject { |n| blank?(n["id"]) }.each do |n|
             c.increment(n)
-            idx = increment_label(examples, n, c, false)
-            @anchors[n["id"]] =
-              anchor_struct(idx, n, @labels["example_xref"], "termexample",
-                            n["unnumbered"])
+            idx = increment_label(examples, n, c, increment: false)
+            @anchors[n["id"]] = anchor_struct(idx, n, @labels["example_xref"],
+                                              "termexample", n["unnumbered"])
           end
         end
       end
@@ -88,18 +87,23 @@ module IsoDoc
 
       def note_anchor_names(sections)
         sections.each do |s|
-          c = Counter.new
-          (notes = s.xpath(CHILD_NOTES_XPATH)).each do |n|
-            next if @anchors[n["id"]] || n["id"].nil? || n["id"].empty?
-
-            @anchors[n["id"]] =
-              anchor_struct(increment_label(notes, n, c), n,
-                            @labels["note_xref"], "note", false)
-          end
+          notes = s.xpath(CHILD_NOTES_XPATH) -
+            s.xpath(ns(".//figure//note | .//table//note"))
+          note_anchor_names1(notes, Counter.new)
           note_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
         end
       end
 
+      def note_anchor_names1(notes, counter)
+        notes.each do |n|
+          next if @anchors[n["id"]] || blank?(n["id"])
+
+          @anchors[n["id"]] =
+            anchor_struct(increment_label(notes, n, counter), n,
+                          @labels["note_xref"], "note", false)
+        end
+      end
+
       CHILD_EXAMPLES_XPATH =
         "./*[not(self::xmlns:clause) and not(self::xmlns:appendix) and "\
         "not(self::xmlns:terms) and not(self::xmlns:definitions)]//"\
@@ -110,18 +114,22 @@ module IsoDoc
 
       def example_anchor_names(sections)
         sections.each do |s|
-          c = Counter.new
-          (notes = s.xpath(CHILD_EXAMPLES_XPATH)).each do |n|
-            next if @anchors[n["id"]] || n["id"].nil? || n["id"].empty?
-
-            @anchors[n["id"]] =
-              anchor_struct(increment_label(notes, n, c), n,
-                            @labels["example_xref"], "example", n["unnumbered"])
-          end
+          notes = s.xpath(CHILD_EXAMPLES_XPATH)
+          example_anchor_names1(notes, Counter.new)
           example_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
         end
       end
 
+      def example_anchor_names1(notes, counter)
+        notes.each do |n|
+          next if @anchors[n["id"]] || blank?(n["id"])
+
+          @anchors[n["id"]] =
+            anchor_struct(increment_label(notes, n, counter), n,
+                          @labels["example_xref"], "example", n["unnumbered"])
+        end
+      end
+
       def list_anchor_names(sections)
         sections.each do |s|
           notes = s.xpath(ns(".//ol")) - s.xpath(ns(".//clause//ol")) -
@@ -155,17 +163,20 @@ module IsoDoc
         sections.each do |s|
           notes = s.xpath(ns(".//dl")) - s.xpath(ns(".//clause//dl")) -
             s.xpath(ns(".//appendix//dl")) - s.xpath(ns(".//dl//dl"))
-          c = Counter.new
-          notes.reject { |n| blank?(n["id"]) }.each do |n|
-            @anchors[n["id"]] =
-              anchor_struct(increment_label(notes, n, c), n,
-                            @labels["deflist"], "deflist", false)
-            deflist_term_anchor_names(n, @anchors[n["id"]])
-          end
+          deflist_anchor_names1(notes, Counter.new)
           deflist_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
         end
       end
 
+      def deflist_anchor_names1(notes, counter)
+        notes.reject { |n| blank?(n["id"]) }.each do |n|
+          @anchors[n["id"]] =
+            anchor_struct(increment_label(notes, n, counter), n,
+                          @labels["deflist"], "deflist", false)
+          deflist_term_anchor_names(n, @anchors[n["id"]])
+        end
+      end
+
       def deflist_term_anchor_names(list, list_anchor)
         list.xpath(ns("./dt")).each do |li|
           label = l10n("#{list_anchor[:xref]}: #{dt2xreflabel(li)}")

data/lib/isodoc/xslfo_convert.rb

@@ -2,7 +2,7 @@ require "metanorma"
 
 module IsoDoc
   class XslfoPdfConvert < ::IsoDoc::Convert
-    # MN2PDF_OPTIONS = :mn2pdf
+    MN_OPTIONS_KEY = :mn2pdf
     MN2PDF_FONT_MANIFEST = :font_manifest
     MN2PDF_OPTIONS = { pdfencryptionlength: "--encryption-length",
                        pdfownerpassword: "--owner-password",
@@ -43,7 +43,7 @@ module IsoDoc
 
     def pdf_options(_docxml)
       ret = {}
-      font_manifest = @options[MN2PDF_FONT_MANIFEST] and
+      font_manifest = @options.dig(MN_OPTIONS_KEY, MN2PDF_FONT_MANIFEST) and
         ret[MN2PDF_FONT_MANIFEST] = font_manifest
       @aligncrosselements && !@aligncrosselements.empty? and
         ret["--param align-cross-elements="] =

data/lib/metanorma/output/base.rb

@@ -1,10 +1,9 @@
-
 module Metanorma
   module Output
 
     class Base
 
-      def convert(in_path, out_path)
+      def convert(_in_path, _out_path)
         raise "This is an abstract class"
       end
 

data/spec/isodoc/blocks_spec.rb

@@ -558,6 +558,49 @@ RSpec.describe IsoDoc do
       .convert("test", input, true)))).to be_equivalent_to xmlpp(doc)
   end
 
+  it "numbers notes in tables and figures separately from notes outside them" do
+    input = <<~INPUT
+      <iso-standard xmlns="http://riboseinc.com/isoxml">
+          <preface><foreword>
+          <figure id="F"><note id="FB"><p>XYZ</p></note></figure>
+          <table id="T"><note id="TB"><p>XYZ</p></note></table>
+          <p id="A">ABC <note id="B"><p id="C">XYZ</p></note>
+      </foreword></preface>
+          </iso-standard>
+    INPUT
+    output = <<~OUTPUT
+           <iso-standard xmlns='http://riboseinc.com/isoxml' type='presentation'>
+         <preface>
+           <foreword displayorder='1'>
+             <figure id='F'>
+               <name>Figure 1</name>
+               <note id='FB'>
+                 <name>NOTE</name>
+                 <p>XYZ</p>
+               </note>
+             </figure>
+             <table id='T'>
+               <name>Table 1</name>
+               <note id='TB'>
+                 <name>NOTE</name>
+                 <p>XYZ</p>
+               </note>
+             </table>
+             <p id='A'>
+               ABC
+               <note id='B'>
+                 <name>NOTE</name>
+                 <p id='C'>XYZ</p>
+               </note>
+             </p>
+           </foreword>
+         </preface>
+       </iso-standard>
+    OUTPUT
+    expect(xmlpp(IsoDoc::PresentationXMLConvert.new({})
+      .convert("test", input, true))).to be_equivalent_to xmlpp(output)
+  end
+
   it "processes figures" do
     input = <<~INPUT
           <iso-standard xmlns="http://riboseinc.com/isoxml">

data/spec/isodoc/xslfo_convert_spec.rb

@@ -15,7 +15,7 @@ RSpec.describe IsoDoc do
     convert = IsoDoc::XslfoPdfConvert.new(
       {
         datauriimage: false,
-        IsoDoc::XslfoPdfConvert::MN2PDF_OPTIONS => {
+        IsoDoc::XslfoPdfConvert::MN_OPTIONS_KEY => {
           IsoDoc::XslfoPdfConvert::MN2PDF_FONT_MANIFEST => nil,
         },
       },
@@ -32,8 +32,7 @@ RSpec.describe IsoDoc do
     convert = IsoDoc::XslfoPdfConvert.new(
       {
         datauriimage: false,
-        IsoDoc::XslfoPdfConvert::MN2PDF_OPTIONS => mn2pdf_opts,
-        font_manifest: "/tmp/manifest.yml",
+        IsoDoc::XslfoPdfConvert::MN_OPTIONS_KEY => mn2pdf_opts,
       },
     )
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.0.5.2
+  version: 2.0.6.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath
@@ -372,6 +372,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
 - ".hound.yml"
 - ".oss-guides.rubocop.yml"
 - ".rubocop.yml"
@@ -534,7 +535,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.9
 signing_key:
 specification_version: 4
 summary: Convert documents in IsoDoc into Word and HTML in AsciiDoc.