isodoc 1.0.29 → 1.1.3.pre.alpha2

data/lib/isodoc/{function → xref}/xref_anchor.rb

@@ -1,7 +1,7 @@
 require "singleton"
 
-module IsoDoc::Function
-  module XrefGen
+module IsoDoc::XrefGen
+  module Anchor
     class Seen_Anchor
       include Singleton
 
@@ -12,34 +12,23 @@ module IsoDoc::Function
       def seen(x)
         @seen.has_key?(x)
       end
-      
+
       def add(x)
         @seen[x] = true
       end
     end
 
-    @anchors = {}
+    def initialize()
+      @anchors = {}
+    end
 
     def get_anchors
       @anchors
     end
 
-    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
-      end
-      @anchors.dig(id, lbl)
-    end
-
     def anchor_struct_label(lbl, elem)
       case elem
-      when @appendix_lbl then l10n("#{elem} #{lbl}")
+      when @labels["appendix"] then l10n("#{elem} #{lbl}")
       else
         lbl.to_s
       end
@@ -47,8 +36,8 @@ module IsoDoc::Function
 
     def anchor_struct_xref(lbl, elem)
       case elem
-      when @formula_lbl then l10n("#{elem} (#{lbl})")
-      when @inequality_lbl then l10n("#{elem} (#{lbl})")
+      when @labels["formula"] then l10n("#{elem} (#{lbl})")
+      when @labels["inequality"] then l10n("#{elem} (#{lbl})")
       else
         l10n("#{elem} #{lbl}")
       end
@@ -59,7 +48,7 @@ module IsoDoc::Function
       ret[:label] = unnumbered == "true" ? nil : anchor_struct_label(lbl, elem)
       ret[:xref] = anchor_struct_xref(unnumbered == "true" ? "(??)" : lbl, elem)
       ret[:xref].gsub!(/ $/, "")
-      ret[:container] = get_clause_id(container) unless container.nil?
+      ret[:container] = @klass.get_clause_id(container) unless container.nil?
       ret[:type] = type
       ret
     end

data/lib/isodoc/xref/xref_counter.rb

@@ -0,0 +1,74 @@
+require "roman-numerals"
+
+module IsoDoc::XrefGen
+  class Counter
+    def initialize
+      @num = 0
+      @letter = ""
+      @subseq = ""
+      @letter_override = nil
+      @number_override = nil
+    end
+
+    def new_subseq_increment(node)
+      @subseq = node["subsequence"]
+      @num += 1
+      @letter = node["subsequence"] ? "a" : ""
+      if node["number"]
+        /^(?<n>\d*)(?<a>[a-z]*)$/ =~ node["number"]
+        if n || a
+          @letter_override = @letter = a if a
+          @number_override = @num = n.to_i if n
+        else
+          @letter_override = node["number"]
+          @letter = @letter_override if /^[a-z]$/.match(@letter_override)
+        end
+      end
+    end
+
+    def sequence_increment(node)
+      if node["number"]
+        @number_override = node["number"]
+        @num = @number_override.to_i if /^\d+$/.match(@number_override)
+      else
+        @num += 1
+      end
+    end
+
+    def subsequence_increment(node)
+      if node["number"]
+        @letter_override = node["number"]
+        @letter = @letter_override if /^[a-z]$/.match(@letter_override)
+      else
+        @letter = (@letter.ord + 1).chr.to_s
+      end
+    end
+
+    def increment(node)
+      return self if node["unnumbered"]
+      @letter_override = nil
+      @number_override = nil
+      if node["subsequence"] != @subseq
+        new_subseq_increment(node)
+      elsif @letter.empty?
+        sequence_increment(node)
+      else
+        subsequence_increment(node)
+      end
+      self
+    end
+
+    def print
+      "#{@number_override || @num}#{@letter_override || @letter}"
+    end
+
+    def listlabel(depth)
+      return @num.to_s if [2, 7].include? depth
+      return (96 + @num).chr.to_s if [1, 6].include? depth
+      return (64 + @num).chr.to_s if [4, 9].include? depth
+      return RomanNumerals.to_roman(@num).downcase if [3, 8].include? depth
+      return RomanNumerals.to_roman(@num).upcase if [5, 10].include? depth
+      return @num.to_s
+    end
+  end
+end

data/lib/isodoc/{function → xref}/xref_gen.rb

@@ -1,11 +1,9 @@
-require_relative "xref_counter"
-require_relative "xref_anchor"
-require_relative "xref_gen_seq"
+require_relative "xref_gen_seq.rb"
 
-module IsoDoc::Function
-  module XrefGen
+module IsoDoc::XrefGen
+  module Blocks
     def termnote_label(n)
-      @termnote_lbl.gsub(/%/, n.to_s)
+      @labels["termnote"].gsub(/%/, n.to_s)
     end
 
     def termnote_anchor_names(docxml)
@@ -17,7 +15,7 @@ module IsoDoc::Function
           @anchors[n["id"]] =
             { label: termnote_label(c.print), type: "termnote",
               xref: l10n("#{anchor(t['id'], :xref)}, "\
-                         "#{@note_xref_lbl} #{c.print}") }
+                         "#{@labels["note_xref"]} #{c.print}") }
         end
       end
     end
@@ -33,7 +31,7 @@ module IsoDoc::Function
           @anchors[n["id"]] = {
             type: "termexample", label: idx, 
             xref: l10n("#{anchor(t['id'], :xref)}, "\
-                       "#{@example_xref_lbl} #{c.print}") }
+                       "#{@labels["example_xref"]} #{c.print}") }
         end
       end
     end
@@ -57,7 +55,7 @@ module IsoDoc::Function
         notes.each do |n|
           next if @anchors[n["id"]] || n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @note_xref_lbl, 
+          @anchors[n["id"]] = anchor_struct(idx, n, @labels["note_xref"], 
                                             "note", false)
         end
         note_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -79,7 +77,7 @@ module IsoDoc::Function
           next if @anchors[n["id"]]
           next if n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @example_xref_lbl,
+          @anchors[n["id"]] = anchor_struct(idx, n, @labels["example_xref"],
                                             "example", n["unnumbered"])
         end
         example_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
@@ -94,7 +92,7 @@ module IsoDoc::Function
         notes.each do |n|
           next if n["id"].nil? || n["id"].empty?
           idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] = anchor_struct(idx, n, @list_lbl, "list", false)
+          @anchors[n["id"]] = anchor_struct(idx, 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)))
@@ -115,16 +113,5 @@ module IsoDoc::Function
         end
       end
     end
-
-    # extract names for all anchors, xref and label
-    def anchor_names(docxml)
-      initial_anchor_names(docxml)
-      back_anchor_names(docxml)
-      # preempt clause notes with all other types of note (ISO default)
-      note_anchor_names(docxml.xpath(ns("//table | //figure")))
-      note_anchor_names(docxml.xpath(ns(SECTIONS_XPATH)))
-      example_anchor_names(docxml.xpath(ns(SECTIONS_XPATH)))
-      list_anchor_names(docxml.xpath(ns(SECTIONS_XPATH)))
-    end
   end
 end

data/lib/isodoc/{function → xref}/xref_gen_seq.rb

@@ -1,11 +1,19 @@
-module IsoDoc::Function
-  module XrefGen
+module IsoDoc::XrefGen
+  module Blocks
+    def hiersep
+      "."
+    end
+
+    def hierfigsep
+      "-"
+    end
+
     def subfigure_increment(j, c, t)
       if t.parent.name == "figure" then j += 1
-        else
-          j = 0
-          c.increment(t)
-        end
+      else
+        j = 0
+        c.increment(t)
+      end
       j
     end
 
@@ -18,7 +26,7 @@ module IsoDoc::Function
         label = c.print + (j.zero? ? "" : "-#{j}")
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
-          anchor_struct(label, nil, @figure_lbl, "figure", t["unnumbered"])
+          anchor_struct(label, nil, @labels["figure"], "figure", t["unnumbered"])
       end
     end
 
@@ -27,7 +35,7 @@ module IsoDoc::Function
       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, 
-                                          @table_lbl, "table", t["unnumbered"])
+                                          @labels["table"], "table", t["unnumbered"])
       end
     end
 
@@ -37,7 +45,7 @@ module IsoDoc::Function
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
           anchor_struct(c.increment(t).print, t, 
-                        t["inequality"] ? @inequality_lbl : @formula_lbl,
+                        t["inequality"] ? @labels["inequality"] : @labels["formula"],
                         "formula", t["unnumbered"])
       end
     end
@@ -56,9 +64,9 @@ module IsoDoc::Function
     end
 
     def sequential_permission_names2(t, id)
-      sequential_permission_names1(t, id, "permission", @permission_lbl)
-      sequential_permission_names1(t, id, "requirement", @requirement_lbl)
-      sequential_permission_names1(t, id, "recommendation", @recommendation_lbl)
+      sequential_permission_names1(t, id, "permission", @labels["permission"])
+      sequential_permission_names1(t, id, "requirement", @labels["requirement"])
+      sequential_permission_names1(t, id, "recommendation", @labels["recommendation"])
     end
 
     def sequential_permission_names1(block, lbl, klass, label)
@@ -75,9 +83,9 @@ module IsoDoc::Function
       sequential_table_names(clause)
       sequential_figure_names(clause)
       sequential_formula_names(clause)
-      sequential_permission_names(clause, "permission", @permission_lbl)
-      sequential_permission_names(clause, "requirement", @requirement_lbl)
-      sequential_permission_names(clause, "recommendation", @recommendation_lbl)
+      sequential_permission_names(clause, "permission", @labels["permission"])
+      sequential_permission_names(clause, "requirement", @labels["requirement"])
+      sequential_permission_names(clause, "recommendation", @labels["recommendation"])
     end
 
     def hierarchical_figure_names(clause, num)
@@ -89,7 +97,7 @@ module IsoDoc::Function
         label = "#{num}#{hiersep}#{c.print}" +
           (j.zero? ? "" : "#{hierfigsep}#{j}")
         next if t["id"].nil? || t["id"].empty?
-        @anchors[t["id"]] = anchor_struct(label, nil, @figure_lbl, "figure",
+        @anchors[t["id"]] = anchor_struct(label, nil, @labels["figure"], "figure",
                                           t["unnumbered"])
       end
     end
@@ -100,7 +108,7 @@ module IsoDoc::Function
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
           anchor_struct("#{num}#{hiersep}#{c.increment(t).print}",
-                        nil, @table_lbl, "table", t["unnumbered"])
+                        nil, @labels["table"], "table", t["unnumbered"])
       end
     end
 
@@ -108,11 +116,11 @@ module IsoDoc::Function
       hierarchical_table_names(clause, num)
       hierarchical_figure_names(clause, num)
       hierarchical_formula_names(clause, num)
-      hierarchical_permission_names(clause, num, "permission", @permission_lbl)
+      hierarchical_permission_names(clause, num, "permission", @labels["permission"])
       hierarchical_permission_names(clause, num, "requirement",
-                                    @requirement_lbl)
+                                    @labels["requirement"])
       hierarchical_permission_names(clause, num, "recommendation",
-                                    @recommendation_lbl)
+                                    @labels["recommendation"])
     end
 
     def hierarchical_formula_names(clause, num)
@@ -121,7 +129,7 @@ module IsoDoc::Function
         next if t["id"].nil? || t["id"].empty?
         @anchors[t["id"]] =
           anchor_struct("#{num}#{hiersep}#{c.increment(t).print}", nil,
-                        t["inequality"] ? @inequality_lbl : @formula_lbl,
+                        t["inequality"] ? @labels["inequality"] : @labels["formula"],
                         "formula", t["unnumbered"])
       end
     end
@@ -136,13 +144,13 @@ module IsoDoc::Function
       end
     end
 
-     def hierarchical_permission_names2(t, id)
-      hierarchical_permission_names1(t, id, "permission", @permission_lbl)
-      hierarchical_permission_names1(t, id, "requirement", @requirement_lbl)
-      hierarchical_permission_names1(t, id, "recommendation", @recommendation_lbl)
+    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"])
     end
 
-     def hierarchical_permission_names1(block, lbl, klass, label)
+    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?

data/lib/isodoc/{function → xref}/xref_sect_gen.rb

@@ -1,18 +1,16 @@
-module IsoDoc::Function
-  module XrefSectGen
+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)
       end
       docxml.xpath(
-           ns("//bibliography/clause[.//references[@normative = 'false']] | "\
-           "//bibliography/references[@normative = 'false']"
-           )).each do |b|
-        preface_names(b)
-      end
-      docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
-        reference_names(ref)
-      end
+           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)
@@ -20,9 +18,7 @@ module IsoDoc::Function
       # potentially overridden in middle_section_asset_names()
       sequential_asset_names(d.xpath(ns("//preface/*")))
       n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
-      n = section_names(d.at(ns(
-        "//bibliography/clause[.//references[@normative = 'true']] | "\
-        "//bibliography/references[@normative = 'true']")), 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)
       n = section_names(d.at(ns("//sections/definitions")), n, 1)
@@ -65,15 +61,14 @@ module IsoDoc::Function
 
     def middle_section_asset_names(d)
       middle_sections = "//clause[title = 'Scope'] | "\
-        "//references[@normative = 'true'] | "\
+        "#{@klass.norm_ref_xpath} | "\
         "//sections/terms | //preface/* | "\
         "//sections/definitions | //clause[parent::sections]"
       sequential_asset_names(d.xpath(ns(middle_sections)))
     end
 
     def clause_names(docxml, sect_num)
-      q = self.class::MIDDLE_CLAUSE
-      docxml.xpath(ns(q)).each_with_index do |c, i|
+      docxml.xpath(ns(@klass.middle_clause)).each_with_index do |c, i|
         section_names(c, (i + sect_num), 1)
       end
     end
@@ -82,7 +77,7 @@ module IsoDoc::Function
       return num if clause.nil?
       num = num + 1
       @anchors[clause["id"]] =
-        { label: num.to_s, xref: l10n("#{@clause_lbl} #{num}"), level: lvl,
+        { label: num.to_s, xref: l10n("#{@labels["clause"]} #{num}"), level: lvl,
           type: "clause" }
       clause.xpath(ns(SUBCLAUSES)).
         each_with_index do |c, i|
@@ -93,7 +88,7 @@ module IsoDoc::Function
 
     def section_names1(clause, num, level)
       @anchors[clause["id"]] =
-        { label: num, level: level, xref: l10n("#{@clause_lbl} #{num}"),
+        { label: num, level: level, xref: l10n("#{@labels["clause"]} #{num}"),
           type: "clause" }
       clause.xpath(ns(SUBCLAUSES)).
         each_with_index do |c, i|
@@ -102,9 +97,9 @@ module IsoDoc::Function
     end
 
     def annex_name_lbl(clause, num)
-      obl = l10n("(#{@inform_annex_lbl})")
-      obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
-      l10n("<b>#{@annex_lbl} #{num}</b><br/>#{obl}")
+      obl = l10n("(#{@labels["inform_annex"]})")
+      obl = l10n("(#{@labels["norm_annex"]})") if clause["obligation"] == "normative"
+      l10n("<b>#{@labels["annex"]} #{num}</b><br/>#{obl}")
     end
 
     def single_annex_special_section(clause)
@@ -119,7 +114,7 @@ module IsoDoc::Function
     def annex_names(clause, num)
       @anchors[clause["id"]] = { label: annex_name_lbl(clause, num),
                                  type: "clause",
-                                 xref: "#{@annex_lbl} #{num}", level: 1 }
+                                 xref: "#{@labels["annex"]} #{num}", level: 1 }
       if a = single_annex_special_section(clause)
         annex_names1(a, "#{num}", 1)
       else
@@ -131,11 +126,26 @@ module IsoDoc::Function
     end
 
     def annex_names1(clause, num, level)
-      @anchors[clause["id"]] = { label: num, xref: "#{@annex_lbl} #{num}",
+      @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)
       end
     end
+
+    ISO_PUBLISHER_XPATH =
+      "./contributor[xmlns:role/@type = 'publisher']/"\
+      "organization[abbreviation = 'ISO' or xmlns:abbreviation = 'IEC' or "\
+      "xmlns:name = 'International Organization for Standardization' or "\
+      "xmlns:name = 'International Electrotechnical Commission']".freeze
+
+    def reference_names(ref)
+      isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
+      ids = @klass.bibitem_ref_code(ref)
+      identifiers = @klass.render_identifier(ids)
+      date = ref.at(ns("./date[@type = 'published']"))
+      reference = @klass.docid_l10n(identifiers[0] || identifiers[1])
+      @anchors[ref["id"]] = { xref: reference }
+    end
   end
 end