isodoc 2.3.3 → 2.3.4

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+# ...
+
+AllCops:
+  TargetRubyVersion: 2.5

data/isodoc.gemspec

@@ -25,11 +25,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]
   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})
+    f.match(%r{^(test|spec|features|bin|.github)/}) \
+    || f.match(%r{Rakefile|bin/rspec})
   end
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "asciimath"
   spec.add_dependency "html2doc", "~> 1.4.3"

data/lib/isodoc/convert.rb

@@ -47,6 +47,7 @@ module IsoDoc
     # tocrecommendations: add ToC for rcommendations
     # fonts: fontist fonts to install
     # fontlicenseagreement: fontist font license agreement
+    # modspecidentifierbase: base prefix for any Modspec identifiers
     def initialize(options) # rubocop:disable Lint/MissingSuper
       @options = options_preprocess(options)
       init_stylesheets(@options)
@@ -78,6 +79,7 @@ module IsoDoc
       @suppressasciimathdup = options[:suppressasciimathdup] == "true"
       @bare = options[:bare]
       @aligncrosselements = options[:aligncrosselements]
+      @modspecidentifierbase = options[:modspecidentifierbase]
     end
 
     def init_i18n(options)
@@ -216,7 +218,7 @@ module IsoDoc
       i18n_init(@lang, @script, @locale)
       @reqt_models = requirements_processor
         .new({ default: "default", lang: @lang, script: @script, locale: @locale,
-               labels: @i18n.get })
+               labels: @i18n.get, modspecidentifierbase: @modspecidentifierbase })
     end
 
     def convert(input_filename, file = nil, debug = false,

data/lib/isodoc/function/references.rb

@@ -71,7 +71,7 @@ module IsoDoc
       def bibitem_ref_code(bib)
         id = bib.at(ns("./docidentifier[@type = 'metanorma']"))
         id1 = pref_ref_code(bib)
-        id2 = bib.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or "\
+        id2 = bib.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or " \
                         "@type = 'ISBN']"))
         id3 = bib.at(ns("./docidentifier[@type = 'metanorma-ordinal']"))
         return [id, id1, id2, id3] if id || id1 || id2 || id3
@@ -179,7 +179,7 @@ module IsoDoc
       end
 
       def norm_ref_xpath
-        "//bibliography/references[@normative = 'true'] | "\
+        "//bibliography/references[@normative = 'true'] | " \
           "//bibliography/clause[.//references[@normative = 'true']]"
       end
 
@@ -198,8 +198,8 @@ module IsoDoc
       end
 
       def bibliography_xpath
-        "//bibliography/clause[.//references]"\
-          "[not(.//references[@normative = 'true'])] | "\
+        "//bibliography/clause[.//references]" \
+          "[not(.//references[@normative = 'true'])] | " \
           "//bibliography/references[@normative = 'false']"
       end
 

data/lib/isodoc/function/section.rb

@@ -82,7 +82,7 @@ module IsoDoc
         f = isoxml.at(ns("//sections/definitions")) or return num
         out.div **attr_code(id: f["id"], class: "Symbols") do |div|
           num = num + 1
-          clause_name(num, f&.at(ns("./title")) || @i18n.symbols, div, nil)
+          clause_name(num, f.at(ns("./title")), div, nil)
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end

data/lib/isodoc/function/to_word_html.rb

@@ -32,7 +32,8 @@ module IsoDoc
       def init_dir(filename, debug)
         dir = "#{filename}#{@tmpfilesdir_suffix}"
         unless debug
-          Dir.mkdir(dir, 0o777) unless File.exist?(dir)
+          FileUtils.mkdir_p(dir)
+          FileUtils.chmod 0o777, dir
           FileUtils.rm_rf "#{dir}/*"
         end
         dir
@@ -205,10 +206,10 @@ module IsoDoc
           when "recommendation" then recommendation_parse(node, out)
           when "permission" then permission_parse(node, out)
           when "div" then div_parse(node, out)
-          #when "subject", "classification"
+          # when "subject", "classification"
           #  requirement_skip_parse(node, out)
-          #when "inherit", "description", "specification", "measurement-target",
-          #"verification", "import", "component"
+          # when "inherit", "description", "specification", "measurement-target",
+          # "verification", "import", "component"
           # requirement_component_parse(node, out)
           when "index" then index_parse(node, out)
           when "index-xref" then index_xref_parse(node, out)

data/lib/isodoc/presentation_function/inline.rb

@@ -10,8 +10,8 @@ module IsoDoc
     end
 
     def get_linkend(node)
-      c1 = non_locality_elems(node).select { |c| !c.text? || /\S/.match(c) }
-      return unless c1.empty?
+      node["style"] == "id" and anchor_id_postprocess(node)
+      return unless xref_empty?(node)
 
       link = anchor_linkend(node, docid_l10n(node["target"] ||
                                              expand_citeas(node["citeas"])))
@@ -23,11 +23,26 @@ module IsoDoc
     # so not <origin bibitemid="ISO7301" citeas="ISO 7301">
     # <locality type="section"><reference>3.1</reference></locality></origin>
 
+    def xref_empty?(node)
+      c1 = non_locality_elems(node).select { |c| !c.text? || /\S/.match(c) }
+      c1.empty?
+    end
+
+    def anchor_id_postprocess(node); end
+
     def expand_citeas(text)
       text.nil? and return text
       HTMLEntities.new.decode(text.gsub(/&amp;#x/, "&#"))
     end
 
+    def erefstack1(elem)
+      locs = elem.xpath(ns("./eref")).map do |e|
+        [e["connective"], e.to_xml]
+      end.flatten
+      ret = resolve_eref_connectives(locs)
+      elem.replace(ret[1])
+    end
+
     def eref_localities(refs, target, node)
       if can_conflate_eref_rendering?(refs)
         l10n(", #{eref_localities_conflated(refs, target, node)}")
@@ -147,7 +162,6 @@ module IsoDoc
       end
     end
 
-    # TODO: move to localization file
     def eref_localities1_zh(_target, type, from, upto, node)
       ret = "第#{from}" if from
       ret += "&#x2013;#{upto}" if upto
@@ -156,7 +170,6 @@ module IsoDoc
       ret
     end
 
-    # TODO: move to localization file
     def eref_localities1(target, type, from, upto, node, lang = "en")
       return nil if type == "anchor"
 
@@ -182,10 +195,12 @@ module IsoDoc
 
     def xref(docxml)
       docxml.xpath(ns("//xref")).each { |f| xref1(f) }
+      docxml.xpath(ns("//xref//xref")).each { |f| f.replace(f.children) }
     end
 
     def eref(docxml)
       docxml.xpath(ns("//eref")).each { |f| xref1(f) }
+      docxml.xpath(ns("//erefstack")).each { |f| erefstack1(f) }
     end
 
     def origin(docxml)

data/lib/isodoc/presentation_function/refs.rb

@@ -38,17 +38,13 @@ module IsoDoc
     end
 
     def bibrender(xml, renderings)
-      if f = xml.at(ns("./formattedref"))
+      if f = xml.at(ns("./formattedref")) && xml.at(ns("./title")).nil?
         bibrender_formattedref(f, xml)
       else bibrender_relaton(xml, renderings)
       end
     end
 
-    def bibrender_formattedref(formattedref, xml)
-      code = render_identifier(bibitem_ref_code(xml))
-      (code[:sdo] && xml["suppress_identifier"] != "true") and
-        formattedref << " [#{code[:sdo]}] "
-    end
+    def bibrender_formattedref(formattedref, xml); end
 
     def bibrender_relaton(xml, renderings)
       f = renderings[xml["id"]][:formattedref]

data/lib/isodoc/presentation_function/section.rb

@@ -3,9 +3,12 @@ require_relative "refs"
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def clause(docxml)
-      docxml.xpath(ns("//clause | "\
+      docxml.xpath(ns("//clause | " \
                       "//terms | //definitions | //references"))
         .each do |f|
+        f.parent.name == "annex" &&
+          @xrefs.klass.single_term_clause?(f.parent) and next
+
         clause1(f)
       end
     end
@@ -23,8 +26,8 @@ module IsoDoc
     end
 
     def floattitle(docxml)
-      docxml.xpath(ns("//clause | //annex | //appendix | //introduction | "\
-                      "//foreword | //preface/abstract | //acknowledgements | "\
+      docxml.xpath(ns("//clause | //annex | //appendix | //introduction | " \
+                      "//foreword | //preface/abstract | //acknowledgements | " \
                       "//terms | //definitions | //references"))
         .each do |f|
         floattitle1(f)
@@ -42,9 +45,11 @@ module IsoDoc
 
     def annex(docxml)
       docxml.xpath(ns("//annex")).each do |f|
+        @xrefs.klass.single_term_clause?(f) and single_term_clause_retitle(f)
         annex1(f)
-        @xrefs.klass.single_term_clause?(f) and single_term_clause(f)
+        @xrefs.klass.single_term_clause?(f) and single_term_clause_unnest(f)
       end
+      @xrefs.parse_inclusions(clauses: true).parse(docxml)
     end
 
     def annex1(elem)
@@ -55,9 +60,16 @@ module IsoDoc
       prefix_name(elem, "<br/><br/>", lbl, "title")
     end
 
-    def single_term_clause(elem)
+    def single_term_clause_retitle(elem)
+      t = elem.at(ns("./terms | ./definitions | ./references"))
+      title1 = elem.at(ns("./title"))
+      title2 = t.at(ns("./title"))&.remove
+      !title1 && title2 and
+        elem.first_element_child.previous = title2
+    end
+
+    def single_term_clause_unnest(elem)
       t = elem.at(ns("./terms | ./definitions | ./references"))
-      t.at(ns("./title"))&.remove
       t.xpath(ns(".//clause | .//terms | .//definitions | .//references"))
         .each do |c|
           tit = c.at(ns("./title")) or return
@@ -72,7 +84,7 @@ module IsoDoc
     end
 
     def term1(elem)
-      lbl = @xrefs.get[elem["id"]][:label] or return
+      lbl = @xrefs.anchor(elem["id"], :label) or return
       prefix_name(elem, "", "#{lbl}#{clausedelim}", "name")
     end
 
@@ -101,7 +113,7 @@ module IsoDoc
       i = display_order_xpath(docxml, "//preface/*", i)
       i = display_order_at(docxml, "//clause[@type = 'scope']", i)
       i = display_order_at(docxml, @xrefs.klass.norm_ref_xpath, i)
-      i = display_order_at(docxml, "//sections/terms | "\
+      i = display_order_at(docxml, "//sections/terms | " \
                                    "//sections/clause[descendant::terms]", i)
       i = display_order_at(docxml, "//sections/definitions", i)
       i = display_order_xpath(docxml, @xrefs.klass.middle_clause(docxml), i)

data/lib/isodoc/presentation_function/xrefs.rb

@@ -1,7 +1,6 @@
 module IsoDoc
   class PresentationXMLConvert < ::IsoDoc::Convert
     def prefix_container(container, linkend, node, _target)
-      # l10n("#{@xrefs.anchor(container, :xref)}, #{linkend}")
       l10n("#{anchor_xref(node, container)}, #{linkend}")
     end
 
@@ -11,19 +10,23 @@ module IsoDoc
     end
 
     def anchor_linkend(node, linkend)
-      if node["citeas"].nil? && node["bibitemid"]
+      node["style"] == "id" and
+        return anchor_id_postproc(node)
+      node["citeas"].nil? && node["bibitemid"] and
         return @xrefs.anchor(node["bibitemid"], :xref) || "???"
-      elsif node.at(ns("./location"))
-        linkend = combine_xref_locations(node)
-      elsif node["target"] && node["droploc"]
+      node.at(ns("./location")) and
+        return combine_xref_locations(node) || "???"
+      node["target"] && node["droploc"] and
         return anchor_value(node["target"]) || "???"
-      elsif node["target"] && !/.#./.match(node["target"])
-        linkend = anchor_linkend1(node)
-      end
-
+      node["target"] && !/.#./.match(node["target"]) and
+        return anchor_linkend1(node) || "???"
       linkend || "???"
     end
 
+    def anchor_id_postproc(node)
+      node["target"]
+    end
+
     def anchor_linkend1(node)
       linkend = anchor_xref(node, node["target"])
       container = @xrefs.anchor(node["target"], :container, false)

data/lib/isodoc/presentation_xml_convert.rb

@@ -36,9 +36,9 @@ module IsoDoc
       references docxml
       # triggers xrefs reparse, so put references before all other sections,
       # which alter titles and thus can alter xrefs
+      annex docxml
       clause docxml
       term docxml
-      annex docxml
       index docxml
       clausetitle docxml
       floattitle docxml

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "2.3.3".freeze
+  VERSION = "2.3.4".freeze
 end

data/lib/isodoc/xref/xref_sect_gen.rb

@@ -30,7 +30,7 @@ module IsoDoc
           n = Counter.new
           n = section_names(doc.at(ns("//clause[@type = 'scope']")), n, 1)
           n = section_names(doc.at(ns(@klass.norm_ref_xpath)), n, 1)
-          n = section_names(doc.at(ns("//sections/terms | "\
+          n = section_names(doc.at(ns("//sections/terms | " \
                                       "//sections/clause[descendant::terms]")), n, 1)
           n = section_names(doc.at(ns("//sections/definitions")), n, 1)
           clause_names(doc, n)
@@ -92,9 +92,9 @@ module IsoDoc
       end
 
       def middle_section_asset_names(doc)
-        middle_sections = "//clause[@type = 'scope'] | "\
-                          "#{@klass.norm_ref_xpath} | "\
-                          "//sections/terms | //preface/* | "\
+        middle_sections = "//clause[@type = 'scope'] | " \
+                          "#{@klass.norm_ref_xpath} | " \
+                          "//sections/terms | //preface/* | " \
                           "//sections/definitions | //clause[parent::sections]"
         sequential_asset_names(doc.xpath(ns(middle_sections)))
       end
@@ -141,7 +141,9 @@ module IsoDoc
       end
 
       def annex_name_anchors(clause, num, level)
-        label = level == 1 ? annex_name_lbl(clause, num) : num
+        label = num
+        level == 1 && clause.name == "annex" and
+          label = annex_name_lbl(clause, num)
         @anchors[clause["id"]] =
           { label: label,
             elem: @labels["annex"], type: "clause",
@@ -172,9 +174,9 @@ module IsoDoc
       end
 
       ISO_PUBLISHER_XPATH =
-        "./contributor[xmlns:role/@type = 'publisher']/"\
-        "organization[abbreviation = 'ISO' or xmlns:abbreviation = 'IEC' or "\
-        "xmlns:name = 'International Organization for Standardization' or "\
+        "./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)

data/lib/isodoc-yaml/i18n-fr.yaml

@@ -8,10 +8,10 @@ introduction: Introduction
 foreword: Avant-propos
 abstract: Résumé
 acknowledgements: Remerciements
-termsdef: Terms et définitions
-termsdefsymbolsabbrev: Terms, définitions, symboles et termes abrégés
-termsdefsymbols: Terms, définitions et symboles
-termsdefabbrev: Terms, définitions et termes abrégés
+termsdef: Termes et définitions
+termsdefsymbolsabbrev: Termes, définitions, symboles et termes abrégés
+termsdefsymbols: Termes, définitions et symboles
+termsdefabbrev: Termes, définitions et termes abrégés
 normref: Références normatives
 bibliography: Bibliographie
 preface: Préface
@@ -19,7 +19,7 @@ clause: Article
 annex: Annexe
 appendix: Appendice
 no_terms_boilerplate: |
-          <p>Aucun terme n’est defini dans le présent document.</p>
+          <p>Aucun terme n’est défini dans le présent document.</p>
 internal_terms_boilerplate: |
          <p>Pour les besoins du présent document, les termes et définitions suivants s’appliquent.</p>
 norm_with_refs_pref: 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: isodoc
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.3.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath
@@ -385,6 +385,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".hound.yml"
+- ".oss-guides.rubocop.yml"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE
@@ -500,14 +503,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Convert documents in IsoDoc into Word and HTML in AsciiDoc.