isodoc 1.6.0 → 1.6.5

data/lib/isodoc/xref.rb

@@ -11,7 +11,9 @@ module IsoDoc
     include XrefGen::Blocks
     include XrefGen::Sections
 
-     def initialize(lang, script, klass, i18n, options = {})
+    attr_reader :klass
+
+    def initialize(lang, script, klass, i18n, options = {})
       @anchors = {}
       @lang = lang
       @script = script
@@ -28,13 +30,12 @@ module IsoDoc
 
     def anchor(id, lbl, warning = true)
       return nil if id.nil? || id.empty?
-      unless @anchors[id]
-        if warning
-          @seen ||= Seen_Anchor.instance
-          @seen.seen(id) or warn "No label has been processed for ID #{id}"
-          @seen.add(id)
-          return "[#{id}]"
-        end
+
+      if warning && !@anchors[id]
+        @seen ||= Seen_Anchor.instance
+        @seen.seen(id) or warn "No label has been processed for ID #{id}"
+        @seen.add(id)
+        return "[#{id}]"
       end
       @anchors.dig(id, lbl)
     end
@@ -56,8 +57,8 @@ module IsoDoc
       Common::ns(xpath)
     end
 
-    def l10n(a, lang = @lang, script = @script)
-      @i18n.l10n(a, lang, script)
+    def l10n(text, lang = @lang, script = @script)
+      @i18n.l10n(text, lang, script)
     end
   end
 end

data/lib/isodoc/xref/xref_counter.rb

@@ -2,16 +2,17 @@ require "roman-numerals"
 
 module IsoDoc::XrefGen
   class Counter
-    def initialize(num = 0, opts = {numerals: :arabic})
+    def initialize(num = 0, opts = { numerals: :arabic })
       @num = num
       @letter = ""
       @subseq = ""
       @letter_override = nil
       @number_override = nil
       @style = opts[:numerals]
+      @skip_i = opts[:skip_i]
       @base = ""
       if num.is_a? String
-        if /^\d+$/.match(num)
+        if /^\d+$/.match?(num)
           @num = num.to_i
         else
           @num = nil
@@ -34,7 +35,7 @@ module IsoDoc::XrefGen
           @base = b
         else
           @letter_override = node["number"]
-          @letter = @letter_override if /^[a-zA-Z]$/.match(@letter_override)
+          @letter = @letter_override if /^[a-zA-Z]$/.match?(@letter_override)
         end
       end
     end
@@ -48,8 +49,7 @@ module IsoDoc::XrefGen
           @base = node["number"][0..-2]
           @letter = @letter_override = node["number"][-1]
         else
-          @number_override = node["number"]
-          @num = n.to_i
+          @number_override = @num = n.to_i
           @base = b
           @letter = ""
         end
@@ -64,7 +64,7 @@ module IsoDoc::XrefGen
         @letter_override = node["number"]
         /^(?<b>.*?)(?<n>\d*)(?<a>[a-zA-Z])$/ =~ node["number"]
         if blank?(a)
-          if /^\d+$/.match(node["number"])
+          if /^\d+$/.match?(node["number"])
             @letter_override = @letter = ""
             @number_override = @num = node["number"].to_i
           else
@@ -80,32 +80,46 @@ module IsoDoc::XrefGen
           @number_override = @num = n.to_i unless n.empty?
         end
       else
-        @letter = (@letter.ord + 1).chr.to_s
+        increment_letter
+      end
+    end
+
+    def increment_letter
+      case @letter
+      when "Z"
+        @letter = "@"
+        @base = @base.empty? ? "A" : @base[0..-2] + (@base[-1].ord + 1).chr.to_s
+      when "z"
+        @letter = "`"
+        @base = @base.empty? ? "a" : @base[0..-2] + (@base[-1].ord + 1).chr.to_s
       end
+      @letter = (@letter.ord + 1).chr.to_s
+      @skip_i && %w(i I).include?(@letter) and
+        @letter = (@letter.ord + 1).chr.to_s
     end
 
-    def blank?(x)
-      x.nil? || x.empty?
+    def blank?(str)
+      str.nil? || str.empty?
     end
 
     def increment(node)
       return self if node["unnumbered"]
+
       @letter_override = nil
       @number_override = nil
-      if node["subsequence"] != @subseq && !(blank?(node["subsequence"]) && blank?(@subseq))
+      if node["subsequence"] != @subseq &&
+          !(blank?(node["subsequence"]) && blank?(@subseq))
         new_subseq_increment(node)
-      elsif @letter.empty?
-        sequence_increment(node)
-      else
-        subsequence_increment(node)
+      elsif @letter.empty? then sequence_increment(node)
+      else subsequence_increment(node)
       end
       self
     end
 
     def print
       num = @number_override || @num
-      num_out = @style == :roman && !num.nil? ? RomanNumerals.to_roman(num) : num
-      "#{@base}#{num_out}#{@letter_override || @letter}"
+      out = @style == :roman && !num.nil? ? RomanNumerals.to_roman(num) : num
+      "#{@base}#{out}#{@letter_override || @letter}"
     end
 
     def ol_type(list, depth)
@@ -115,7 +129,8 @@ module IsoDoc::XrefGen
       return :alphabet_upper if [4, 9].include? depth
       return :roman if [3, 8].include? depth
       return :roman_upper if [5, 10].include? depth
-      return :arabic
+
+      :arabic
     end
 
     def listlabel(list, depth)

data/lib/isodoc/xref/xref_gen.rb

@@ -1,4 +1,4 @@
-require_relative "xref_gen_seq.rb"
+require_relative "xref_gen_seq"
 
 module IsoDoc::XrefGen
   module Blocks
@@ -10,35 +10,43 @@ module IsoDoc::XrefGen
         autonum = amend_autonums(a)
         NUMBERED_BLOCKS.each do |b|
           a.xpath(ns("./newcontent//#{b}")).each_with_index do |e, i|
-            autonum[b] and i == 0 and e["number"] = autonum[b]
+            autonum[b] && i.zero? and e["number"] = autonum[b]
             !autonum[b] and e["unnumbered"] = "true"
           end
         end
       end
     end
 
-    def amend_autonums(a)
+    def amend_autonums(amend)
       autonum = {}
-      a.xpath(ns("./autonumber")).each do |n|
+      amend.xpath(ns("./autonumber")).each do |n|
         autonum[n["type"]] = n.text
       end
       autonum
     end
 
-    def termnote_label(n)
-      @labels["termnote"].gsub(/%/, n.to_s)
+    def termnote_label(note)
+      @labels["termnote"].gsub(/%/, note.to_s)
+    end
+
+    def increment_label(elems, node, counter, increment = true)
+      return "" if elems.size == 1 && !node["number"]
+
+      counter.increment(node) if increment
+      " #{counter.print}"
     end
 
     def termnote_anchor_names(docxml)
       docxml.xpath(ns("//term[descendant::termnote]")).each do |t|
         c = Counter.new
         t.xpath(ns(".//termnote")).each do |n|
-          return if n["id"].nil? || n["id"].empty?
+          next if n["id"].nil? || n["id"].empty?
+
           c.increment(n)
           @anchors[n["id"]] =
             { label: termnote_label(c.print), type: "termnote", value: c.print,
               xref: l10n("#{anchor(t['id'], :xref)}, "\
-                         "#{@labels["note_xref"]} #{c.print}") }
+                         "#{@labels['note_xref']} #{c.print}") }
         end
       end
     end
@@ -48,13 +56,14 @@ module IsoDoc::XrefGen
         examples = t.xpath(ns(".//termexample"))
         c = Counter.new
         examples.each do |n|
-          return if n["id"].nil? || n["id"].empty?
+          next if n["id"].nil? || n["id"].empty?
+
           c.increment(n)
-          idx = examples.size == 1 && !n["number"] ? "" : c.print
+          idx = increment_label(examples, n, c, false)
           @anchors[n["id"]] = {
             type: "termexample", label: idx, value: c.print,
             xref: l10n("#{anchor(t['id'], :xref)}, "\
-                       "#{@labels["example_xref"]} #{c.print}") }
+                       "#{@labels['example_xref']} #{c.print}") }
         end
       end
     end
@@ -81,9 +90,10 @@ module IsoDoc::XrefGen
         c = Counter.new
         notes.each do |n|
           next if @anchors[n["id"]] || n["id"].nil? || n["id"].empty?
-          idx = notes.size == 1 && !n["number"] ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @labels["note_xref"], 
-                                            "note", false)
+
+          @anchors[n["id"]] =
+            anchor_struct(increment_label(notes, n, c), n,
+                          @labels["note_xref"], "note", false)
         end
         note_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
       end
@@ -103,10 +113,10 @@ module IsoDoc::XrefGen
         c = Counter.new
         notes.each do |n|
           next if @anchors[n["id"]] || n["id"].nil? || n["id"].empty?
-          idx = notes.size == 1 && !n["number"]  ? "" :
-            " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @labels["example_xref"],
-                                            "example", n["unnumbered"])
+
+          @anchors[n["id"]] =
+            anchor_struct(increment_label(notes, n, c), n,
+                          @labels["example_xref"], "example", n["unnumbered"])
         end
         example_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
       end
@@ -119,9 +129,9 @@ module IsoDoc::XrefGen
         c = Counter.new
         notes.each do |n|
           next if n["id"].nil? || n["id"].empty?
-          idx = notes.size == 1 && !n["number"] ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @labels["list"], "list",
-                                            false)
+
+          @anchors[n["id"]] = anchor_struct(increment_label(notes, n, c), n,
+                                            @labels["list"], "list", false)
           list_item_anchor_names(n, @anchors[n["id"]], 1, "", notes.size != 1)
         end
         list_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -146,9 +156,11 @@ module IsoDoc::XrefGen
     def bookmark_anchor_names(docxml)
       docxml.xpath(ns(".//bookmark")).each do |n|
         next if n["id"].nil? || n["id"].empty?
+
         parent = nil
         n.ancestors.each do |a|
           next unless a["id"] && parent = @anchors.dig(a["id"], :xref)
+
           break
         end
         @anchors[n["id"]] = { type: "bookmark", label: nil, value: nil,

data/lib/isodoc/xref/xref_gen_seq.rb

@@ -8,25 +8,27 @@ module IsoDoc::XrefGen
       "-"
     end
 
-    def subfigure_increment(j, c, t)
-      if t.parent.name == "figure" then j += 1
+    def subfigure_increment(idx, counter, elem)
+      if elem.parent.name == "figure" then idx += 1
       else
-        j = 0
-        c.increment(t)
+        idx = 0
+        counter.increment(elem)
       end
-      j
+      idx
     end
 
     def sequential_figure_names(clause)
       c = Counter.new
       j = 0
-      clause.xpath(ns(".//figure | .//sourcecode[not(ancestor::example)]")).
-        each do |t|
+      clause.xpath(ns(".//figure | .//sourcecode[not(ancestor::example)]"))
+        .each do |t|
         j = subfigure_increment(j, c, t)
         label = c.print + (j.zero? ? "" : "-#{j}")
         next if t["id"].nil? || t["id"].empty?
-        @anchors[t["id"]] =
-          anchor_struct(label, nil, @labels["figure"], "figure", t["unnumbered"])
+
+        @anchors[t["id"]] = anchor_struct(
+          label, nil, @labels["figure"], "figure", t["unnumbered"]
+        )
       end
     end
 
@@ -34,8 +36,11 @@ module IsoDoc::XrefGen
       c = Counter.new
       clause.xpath(ns(".//table")).each do |t|
         next if t["id"].nil? || t["id"].empty?
-        @anchors[t["id"]] = anchor_struct(c.increment(t).print, nil, 
-                                          @labels["table"], "table", t["unnumbered"])
+
+        @anchors[t["id"]] = anchor_struct(
+          c.increment(t).print, nil,
+          @labels["table"], "table", t["unnumbered"]
+        )
       end
     end
 
@@ -43,10 +48,12 @@ module IsoDoc::XrefGen
       c = Counter.new
       clause.xpath(ns(".//formula")).each do |t|
         next if t["id"].nil? || t["id"].empty?
-        @anchors[t["id"]] =
-          anchor_struct(c.increment(t).print, t, 
-                        t["inequality"] ? @labels["inequality"] : @labels["formula"],
-                        "formula", t["unnumbered"])
+
+        @anchors[t["id"]] = anchor_struct(
+          c.increment(t).print, t,
+          t["inequality"] ? @labels["inequality"] : @labels["formula"],
+          "formula", t["unnumbered"]
+        )
       end
     end
 
@@ -57,22 +64,27 @@ module IsoDoc::XrefGen
       c = Counter.new
       clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
         next if t["id"].nil? || t["id"].empty?
+
         id = c.increment(t).print
         @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
         sequential_permission_names2(t, id)
       end
     end
 
-    def sequential_permission_names2(t, id)
-      sequential_permission_names1(t, id, "permission", @labels["permission"])
-      sequential_permission_names1(t, id, "requirement", @labels["requirement"])
-      sequential_permission_names1(t, id, "recommendation", @labels["recommendation"])
+    def sequential_permission_names2(elem, ident)
+      sequential_permission_names1(elem, ident, "permission",
+                                   @labels["permission"])
+      sequential_permission_names1(elem, ident, "requirement",
+                                   @labels["requirement"])
+      sequential_permission_names1(elem, ident, "recommendation",
+                                   @labels["recommendation"])
     end
 
     def sequential_permission_names1(block, lbl, klass, label)
       c = Counter.new
       block.xpath(ns("./#{klass}")).each do |t|
         next if t["id"].nil? || t["id"].empty?
+
         id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
         @anchors[t["id"]] = anchor_struct(id, t, label, klass, t["unnumbered"])
         sequential_permission_names2(t, id)
@@ -85,20 +97,22 @@ module IsoDoc::XrefGen
       sequential_formula_names(clause)
       sequential_permission_names(clause, "permission", @labels["permission"])
       sequential_permission_names(clause, "requirement", @labels["requirement"])
-      sequential_permission_names(clause, "recommendation", @labels["recommendation"])
+      sequential_permission_names(clause, "recommendation",
+                                  @labels["recommendation"])
     end
 
     def hierarchical_figure_names(clause, num)
       c = Counter.new
       j = 0
-      clause.xpath(ns(".//figure |  .//sourcecode[not(ancestor::example)]")).
-        each do |t|
+      clause.xpath(ns(".//figure |  .//sourcecode[not(ancestor::example)]"))
+        .each do |t|
         j = subfigure_increment(j, c, t)
         label = "#{num}#{hiersep}#{c.print}" +
           (j.zero? ? "" : "#{hierfigsep}#{j}")
         next if t["id"].nil? || t["id"].empty?
-        @anchors[t["id"]] = anchor_struct(label, nil, @labels["figure"], "figure",
-                                          t["unnumbered"])
+
+        @anchors[t["id"]] = anchor_struct(label, nil, @labels["figure"],
+                                          "figure", t["unnumbered"])
       end
     end
 
@@ -106,6 +120,7 @@ module IsoDoc::XrefGen
       c = Counter.new
       clause.xpath(ns(".//table")).each do |t|
         next if t["id"].nil? || t["id"].empty?
+
         @anchors[t["id"]] =
           anchor_struct("#{num}#{hiersep}#{c.increment(t).print}",
                         nil, @labels["table"], "table", t["unnumbered"])
@@ -116,7 +131,8 @@ module IsoDoc::XrefGen
       hierarchical_table_names(clause, num)
       hierarchical_figure_names(clause, num)
       hierarchical_formula_names(clause, num)
-      hierarchical_permission_names(clause, num, "permission", @labels["permission"])
+      hierarchical_permission_names(clause, num, "permission",
+                                    @labels["permission"])
       hierarchical_permission_names(clause, num, "requirement",
                                     @labels["requirement"])
       hierarchical_permission_names(clause, num, "recommendation",
@@ -127,10 +143,12 @@ module IsoDoc::XrefGen
       c = Counter.new
       clause.xpath(ns(".//formula")).each do |t|
         next if t["id"].nil? || t["id"].empty?
-        @anchors[t["id"]] =
-          anchor_struct("#{num}#{hiersep}#{c.increment(t).print}", nil,
-                        t["inequality"] ? @labels["inequality"] : @labels["formula"],
-                        "formula", t["unnumbered"])
+
+        @anchors[t["id"]] = anchor_struct(
+          "#{num}#{hiersep}#{c.increment(t).print}", nil,
+          t["inequality"] ? @labels["inequality"] : @labels["formula"],
+          "formula", t["unnumbered"]
+        )
       end
     end
 
@@ -138,24 +156,31 @@ module IsoDoc::XrefGen
       c = Counter.new
       clause.xpath(ns(".//#{klass}#{FIRST_LVL_REQ}")).each do |t|
         next if t["id"].nil? || t["id"].empty?
+
         id = "#{num}#{hiersep}#{c.increment(t).print}"
-        @anchors[t["id"]] = anchor_struct(id, nil, label, klass, t["unnumbered"])
+        @anchors[t["id"]] =
+          anchor_struct(id, nil, label, klass, t["unnumbered"])
         hierarchical_permission_names2(t, id)
       end
     end
 
-    def hierarchical_permission_names2(t, id)
-      hierarchical_permission_names1(t, id, "permission", @labels["permission"])
-      hierarchical_permission_names1(t, id, "requirement", @labels["requirement"])
-      hierarchical_permission_names1(t, id, "recommendation", @labels["recommendation"])
+    def hierarchical_permission_names2(elem, ident)
+      hierarchical_permission_names1(elem, ident, "permission",
+                                     @labels["permission"])
+      hierarchical_permission_names1(elem, ident, "requirement",
+                                     @labels["requirement"])
+      hierarchical_permission_names1(elem, ident, "recommendation",
+                                     @labels["recommendation"])
     end
 
     def hierarchical_permission_names1(block, lbl, klass, label)
       c = Counter.new
       block.xpath(ns("./#{klass}")).each do |t|
         next if t["id"].nil? || t["id"].empty?
+
         id = "#{lbl}#{hierfigsep}#{c.increment(t).print}"
-        @anchors[t["id"]] = anchor_struct(id, nil, label, klass, t["unnumbered"])
+        @anchors[t["id"]] =
+          anchor_struct(id, nil, label, klass, t["unnumbered"])
         hierarchical_permission_names2(t, id)
       end
     end