isodoc 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36b5db70dc3eb379ad1f903a8707b7c9403474e55f0fe99b9218536d0651c9a
-  data.tar.gz: 33e3a3e805b97042ac336754d43c47162e0d3e8851649514c20e4d5ede0301c0
+  metadata.gz: e07a78782a0c09a2c70525f1d7d4b8f5d34ea8d731c3dbc5860b7386250c1e56
+  data.tar.gz: bb3ddf0e119c8cf4b4d25c70ba381dba043020c132edd13fc4934bb08871594e
 SHA512:
-  metadata.gz: 7ec36b6afb9cdb96291f75a78740d5cd555d898fa9bce309904a7ac54408c8ad90f2f4dcb5fe5e97aeb08526f6659d317a42537466801f9abbc4735b8fa23a39
-  data.tar.gz: ffb1143efd27cf641cc9b336b9ff538bb6c6c5153cdc351f0e9edb8f4c7f029793267b47caa5682e9ce886ac9e30ea7c0601d1b91eca88a62f92ccb675294fc5
+  metadata.gz: ba808db07e817492e8ceb891771ec1df67f8d4dfab34896eb2eca9accd45ccf110745a5844276e52f1f20c6542cf1d33fdaad816ea3ce0ff264465bd4f4c8d4c
+  data.tar.gz: 0124e13883ab5d0c5f0561c62b924920ae0d73bc4980024f77336a4aed919d175c0f51a464e3574f910ea77ba15bccbf0d86c7e14707a6f4b7bf038ff7f1d80a

data/.github/workflows/rake.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
     steps:

data/.rubocop.yml

@@ -7,4 +7,4 @@ inherit_from:
 # ...
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5

data/isodoc.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "asciimath"
   spec.add_dependency "html2doc", "~> 1.1.1"
@@ -50,5 +50,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop", "~> 1.5.2"
   spec.add_development_dependency "sassc", "~> 2.4.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_development_dependency "metanorma-iso"
   spec.add_development_dependency "timecop", "~> 0.9"
 end

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

@@ -18,29 +18,23 @@ clause: فقرة
 annex: ملحق
 appendix: تذييل
 no_terms_boilerplate: |
-  <p>No terms and definitions are listed in this document.</p>
+  <p>لم يتم سرد أي مصطلحات وتعريفات في هذا المستند.</p>
 internal_terms_boilerplate: |
-  <p>For the purposes of this document,
-            the following terms and definitions apply.</p>
+  <p>لأغراض هذا المستند، تنطبق المصطلحات والتعريفات التالية.</p>
 norm_with_refs_pref:
-  The following documents are referred to in the text in such a way
-      that some or all of their content constitutes requirements of this
-      document. For dated references, only the edition cited applies.
-      For undated references, the latest edition of the referenced
-      document (including any amendments) applies.
+  تتم الإشارة إلى المستندات التالية في النص بحيث يشكل بعض أو كل محتوياتها متطلبات هذا المستند. للحصول على مراجع مؤرخة، تطبق النسخة المشار إليها فقط. بالنسبة للمراجع غير المؤرخة ، تنطبق أحدث طبعة من الوثيقة المشار إليها (بما في ذلك أي تعديلات).
 norm_empty_pref:
-  There are no normative references in this document.
+  لا توجد مراجع معيارية في هذه الوثيقة.
 external_terms_boilerplate: |
-  <p>For the purposes of this document,
-    the terms and definitions given in % apply.</p>
+  <p> لأغراض هذا المستند ، تنطبق المصطلحات والتعريفات الواردة في%. </ p>
 internal_external_terms_boilerplate: |
-  <p>For the purposes of this document, the terms and definitions
-    given in % and the following apply.</p>
-term_defined_in: "[term defined in %]"
+  <p>لأغراض هذه الوثيقة ،تنطبق المصطلحات والتعاريف الواردة في % وما يلي.</p>
+term_defined_in: "[المصطلح المحدد في %]"
 note: ملاحظة
 note_xref: ملاحظة
-termnote: Note % to entry
+termnote: ملاحظة % للقيد
 list: قائمة
+deflist: قائمة تعريف
 figure: شكل
 formula: معادلة
 inequality: عدم مساواة
@@ -48,16 +42,16 @@ table: جدول
 requirement: مطلب
 recommendation: توصية
 permission: إذن
-key: Key
+key: مفتاح
 example: مثال
 example_xref: مثال
 where: حيث
 wholeoftext: كامل النص
-draft_label: draft
-inform_annex: informative
-norm_annex: normative
+draft_label: مسودة
+inform_annex: إخباري
+norm_annex: مقياسي
 modified: معدلة
-deprecated: DEPRECATED
+deprecated: مهمل
 source: مصدر
 and: و
 all_parts: كل الأجزاء
@@ -78,8 +72,8 @@ subject: موضوع
 inherits: يرث
 admonition:
   danger: خطر
-  warning: Warning
-  caution: Caution
+  warning: تحذير
+  caution: حذر
   important: مهم
   safety precautions: احتياطات السلامة
 locality:
@@ -108,9 +102,9 @@ inflection:
   ملاحظة:
     sg: ملاحظة
     pl: ملاحظات
-  "Note % to entry":
-    sg: Note % to entry
-    pl: Notes % to entry
+  "ملاحظة % للقيد":
+    sg: ملاحظة % للقيد
+    pl: ملاحظات % للقيد
   قائمة:
     sg: قائمة
     pl: قوائم

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

@@ -36,6 +36,7 @@ note: HINWEIS
 note_xref: Hinweis
 termnote: Hinweis % zum Eintrag
 list: Liste
+deflist: Definitionsliste
 figure: Abbildung
 formula: Formel
 inequality: Formel

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

@@ -14,6 +14,7 @@ termsdefsymbols: Terms, definitions and symbols
 termsdefabbrev: Terms, definitions and abbreviated terms
 normref: Normative references
 bibliography: Bibliography
+preface: Preface
 clause: Clause
 annex: Annex
 appendix: Appendix
@@ -41,6 +42,7 @@ note: NOTE
 note_xref: Note
 termnote: Note % to entry
 list: List
+deflist: Definition List
 figure: Figure
 formula: Formula
 inequality: Formula

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

@@ -38,6 +38,7 @@ note: NOTA
 note_xref: Nota
 termnote: Nota % a la entrada
 list: Lista
+deflist: Lista de definiciones
 figure: Figura
 formula: Fórmula
 inequality: Fórmula

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

@@ -14,6 +14,7 @@ termsdefsymbols: Terms, définitions et symboles
 termsdefabbrev: Terms, définitions et termes abrégés
 normref: Références normatives
 bibliography: Bibliographie
+preface: Préface
 clause: Article
 annex: Annexe
 appendix: Appendice
@@ -37,6 +38,7 @@ figure: Figure
 formula: Formule
 inequality: Formule
 list: Liste
+deflist: Liste de définitions
 table: Tableau
 requirement: Exigence
 recommendation: Recommandation

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

@@ -41,6 +41,7 @@ note: ПРИМЕЧАНИЕ
 note_xref: Примечание
 termnote: Примечание % к определению
 list: Список
+deflist: Список определений
 figure: Рисунок
 formula: Формула
 inequality: Формула

data/lib/isodoc-yaml/i18n-zh-Hans.yaml

@@ -14,6 +14,7 @@ termsdefsymbols: 术语、定义、符号和代号
 termsdefabbrev: 术语、定义、符号和缩略语
 normref: 规范性引用文件
 bibliography: 参考文献
+preface: 序言
 clause: 条
 annex: 附件
 appendix: 附录
@@ -39,6 +40,7 @@ figure: 图
 formula: 公式
 inequality: 公式
 list: 列项
+deflist: 定义列表
 table: 表
 requirement: 要求
 recommendation: 建议

data/lib/isodoc/convert.rb

@@ -37,6 +37,7 @@ module IsoDoc
     # datauriimage: Encode images in HTML output as data URIs
     # break_up_urls_in_tables: whether to insert spaces in URLs in tables
     #   every 40-odd chars
+    # sectionsplit: split up HTML output on sections
     # bare: do not insert any prefatory material (coverpage, boilerplate)
     def initialize(options)
       @libdir ||= File.dirname(__FILE__) # rubocop:disable Lint/DisjunctiveAssignmentInConstructor
@@ -73,6 +74,7 @@ module IsoDoc
       @datauriimage = options[:datauriimage]
       @suppressheadingnumbers = options[:suppressheadingnumbers]
       @break_up_urls_in_tables = options[:break_up_urls_in_tables] == "true"
+      @sectionsplit = options[:sectionsplit] == "true"
       @bare = options[:bare]
       @termdomain = ""
       @termexample = false
@@ -143,7 +145,7 @@ module IsoDoc
     end
 
     def convert_init(file, input_filename, debug)
-      docxml = Nokogiri::XML(file)
+      docxml = Nokogiri::XML(file) { |config| config.huge }
       filename, dir = init_file(input_filename, debug)
       docxml.root.default_namespace = ""
       lang = docxml&.at(ns("//bibdata/language"))&.text and @lang = lang
@@ -154,7 +156,7 @@ module IsoDoc
       [docxml, filename, dir]
     end
 
-    def convert(input_filename, file = nil, debug = false, 
+    def convert(input_filename, file = nil, debug = false,
                 output_filename = nil)
       file = File.read(input_filename, encoding: "utf-8") if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)

data/lib/isodoc/function/blocks.rb

@@ -14,10 +14,11 @@ module IsoDoc::Function
       end
     end
 
-    def figure_name_parse(node, div, name)
-      return if name.nil? 
+    def figure_name_parse(_node, div, name)
+      return if name.nil?
+
       div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
-        name.children.each { |n| parse(n, div) }
+        name.children.each { |n| parse(n, p) }
       end
     end
 
@@ -61,7 +62,7 @@ module IsoDoc::Function
     end
 
     def sourcecode_name_parse(node, div, name)
-      return if name.nil? 
+      return if name.nil?
 
       div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
         name.children.each { |n| parse(n, p) }
@@ -224,7 +225,7 @@ module IsoDoc::Function
     end
 
     def svg_parse(node, out)
-      out << node.to_xml
+      out.parent.add_child(node)
     end
   end
 end

data/lib/isodoc/function/references.rb

@@ -10,9 +10,9 @@ module IsoDoc::Function
     end
 
     # TODO generate formatted ref if not present
-    def nonstd_bibitem(list, b, ordinal, biblio)
-      list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
-        ids = bibitem_ref_code(b)
+    def nonstd_bibitem(list, bib, ordinal, biblio)
+      list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
+        ids = bibitem_ref_code(bib)
         identifiers = render_identifier(ids)
         if biblio then ref_entry_code(ref, ordinal, identifiers, ids)
         else
@@ -20,21 +20,21 @@ module IsoDoc::Function
           ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
         end
         ref << ", " unless biblio && !identifiers[1]
-        reference_format(b, ref)
+        reference_format(bib, ref)
       end
     end
 
-    def std_bibitem_entry(list, b, ordinal, biblio)
-      list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
-        identifiers = render_identifier(bibitem_ref_code(b))
+    def std_bibitem_entry(list, bib, ordinal, biblio)
+      list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
+        identifiers = render_identifier(bibitem_ref_code(bib))
         if biblio then ref_entry_code(ref, ordinal, identifiers, nil)
         else
           ref << (identifiers[0] || identifiers[1]).to_s
           ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
         end
-        date_note_process(b, ref)
+        date_note_process(bib, ref)
         ref << ", " unless biblio && !identifiers[1]
-        reference_format(b, ref)
+        reference_format(bib, ref)
       end
     end
 
@@ -45,20 +45,20 @@ module IsoDoc::Function
       t[1] and r << (t[1]).to_s
     end
 
-    def pref_ref_code(b)
-      b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
+    def pref_ref_code(bib)
+      bib.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
               "or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor')]"))
     end
 
     # returns [metanorma, non-metanorma, DOI/ISSN/ISBN] identifiers
-    def bibitem_ref_code(b)
-      id = b.at(ns("./docidentifier[@type = 'metanorma']"))
-      id1 = pref_ref_code(b)
-      id2 = b.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or "\
+    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 "\
                     "@type = 'ISBN']"))
       return [id, id1, id2] if id || id1 || id2
 
-      id = Nokogiri::XML::Node.new("docidentifier", b.document)
+      id = Nokogiri::XML::Node.new("docidentifier", bib.document)
       id << "(NO ID)"
       [nil, id, nil]
     end
@@ -72,20 +72,10 @@ module IsoDoc::Function
       num
     end
 
-    def render_identifier(id)
-      [
-        bracket_if_num(id[0]),
-        if id[1].nil?
-          nil
-        else
-          docid_prefix(id[1]["type"], id[1].text.sub(/^\[/, "").sub(/\]$/, ""))
-        end,
-        if id[2].nil?
-          nil
-        else
-          docid_prefix(id[2]["type"], id[2].text.sub(/^\[/, "").sub(/\]$/, ""))
-        end,
-      ]
+    def render_identifier(ident)
+      [bracket_if_num(ident[0]),
+       ident[1].nil? ? nil : ident[1].text.sub(/^\[/, "").sub(/\]$/, ""),
+       ident[2].nil? ? nil : ident[2].text.sub(/^\[/, "").sub(/\]$/, "")]
     end
 
     def docid_prefix(prefix, docid)
@@ -97,19 +87,20 @@ module IsoDoc::Function
     def omit_docid_prefix(prefix)
       return true if prefix.nil? || prefix.empty?
 
-      %w(ISO IEC IEV ITU W3C csd metanorma rfc-anchor).include? prefix
+      %w(ISO IEC IEV ITU W3C csd metanorma repository rfc-anchor)
+        .include? prefix
     end
 
-    def date_note_process(b, ref)
-      date_note = b.at(ns("./note[@type = 'Unpublished-Status']"))
+    def date_note_process(bib, ref)
+      date_note = bib.at(ns("./note[@type = 'Unpublished-Status']"))
       return if date_note.nil?
 
       date_note.children.first.replace("<p>#{date_note.content}</p>")
       footnote_parse(date_note, ref)
     end
 
-    def iso_bibitem_entry_attrs(b, biblio)
-      { id: b["id"], class: biblio ? "Biblio" : "NormRef" }
+    def iso_bibitem_entry_attrs(bib, biblio)
+      { id: bib["id"], class: biblio ? "Biblio" : "NormRef" }
     end
 
     def iso_title(bib)
@@ -130,22 +121,21 @@ module IsoDoc::Function
       insert_tab(ref, 1)
     end
 
-    def reference_format(bib, r)
+    def reference_format(bib, out)
       if ftitle = bib.at(ns("./formattedref"))
-        ftitle&.children&.each { |n| parse(n, r) }
+        ftitle&.children&.each { |n| parse(n, out) }
       else
-        title = iso_title(bib)
-        r.i do |i|
-          title&.children&.each { |n| parse(n, i) }
+        out.i do |i|
+          iso_title(bib)&.children&.each { |n| parse(n, i) }
         end
       end
     end
 
     def is_standard(bib)
       ret = false
+      drop = %w(metanorma DOI ISSN ISBN)
       bib.xpath(ns("./docidentifier")).each do |id|
-        next if id["type"].nil? ||
-          %w(metanorma DOI ISSN ISBN).include?(id["type"])
+        next if id["type"].nil? || drop.include?(id["type"])
 
         ret = true
       end
@@ -180,8 +170,7 @@ module IsoDoc::Function
         clause_name(num, f.at(ns("./title")), div, nil)
         if f.name == "clause"
           f.elements.each { |e| parse(e, div) unless e.name == "title" }
-        else
-          biblio_list(f, div, false)
+        else biblio_list(f, div, false)
         end
       end
       num
@@ -212,13 +201,5 @@ module IsoDoc::Function
         biblio_list(node, div, true)
       end
     end
-
-    def format_ref(ref, prefix, _isopub, _date, _allparts)
-      ref = docid_prefix(prefix, ref)
-      return "[#{ref}]" if ref && /^\d+$/.match(ref) && !prefix &&
-        !/^\[.*\]$/.match(ref)
-
-      ref
-    end
   end
 end

data/lib/isodoc/function/section.rb

@@ -165,7 +165,6 @@ module IsoDoc::Function
       out.div **attr_code(id: f["id"]) do |s|
         clause_name(nil, f.at(ns("./title")) || @i18n.foreword, s,
                     { class: "ForewordTitle" })
-        # s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @i18n.foreword }
         f.elements.each { |e| parse(e, s) unless e.name == "title" }
       end
     end