isodoc 1.6.4 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c36b5db70dc3eb379ad1f903a8707b7c9403474e55f0fe99b9218536d0651c9a
-  data.tar.gz: 33e3a3e805b97042ac336754d43c47162e0d3e8851649514c20e4d5ede0301c0
+  metadata.gz: c645dd63676e96fc3568d9a06b4570a7a33f5df4c330f2bdcdf318220aa1459c
+  data.tar.gz: b63c3a8db1307b3987c5bc1f214d27b2bff20b2a5bd182834b2afd267d9b3598
 SHA512:
-  metadata.gz: 7ec36b6afb9cdb96291f75a78740d5cd555d898fa9bce309904a7ac54408c8ad90f2f4dcb5fe5e97aeb08526f6659d317a42537466801f9abbc4735b8fa23a39
-  data.tar.gz: ffb1143efd27cf641cc9b336b9ff538bb6c6c5153cdc351f0e9edb8f4c7f029793267b47caa5682e9ce886ac9e30ea7c0601d1b91eca88a62f92ccb675294fc5
+  metadata.gz: bb2781a07832e45ddb5d85ef75d56f50c114f67b05cc9c1643b677bea19a1a977e020c45b96eff2ec3c729527e43934f88a0a5722defede0ddba92e5c3a0e435
+  data.tar.gz: 806fd47fa7b99aa392e85e2b477ce4211aff48eead6ef3c0e1622f81082a336d05673c4a35286a556b8c912ca8601f784b9e517fc21965c83332988ac28d742f

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-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

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

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

@@ -14,6 +14,7 @@ termsdefsymbols: 术语、定义、符号和代号
 termsdefabbrev: 术语、定义、符号和缩略语
 normref: 规范性引用文件
 bibliography: 参考文献
+preface: 序言
 clause: 条
 annex: 附件
 appendix: 附录

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
@@ -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) }

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,16 +45,16 @@ 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
 
@@ -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

data/lib/isodoc/function/table.rb

@@ -1,17 +1,16 @@
 module IsoDoc::Function
   module Table
-
     def table_title_parse(node, out)
       name = node.at(ns("./name")) or return
       out.p **{ class: "TableTitle", style: "text-align:center;" } do |p|
-        name and name.children.each { |n| parse(n, p) }
+        name&.children&.each { |n| parse(n, p) }
       end
     end
 
-    def thead_parse(node, t)
+    def thead_parse(node, table)
       thead = node.at(ns("./thead"))
       if thead
-        t.thead do |h|
+        table.thead do |h|
           thead.element_children.each_with_index do |n, i|
             tr_parse(n, h, i, thead.element_children.size, true)
           end
@@ -19,19 +18,19 @@ module IsoDoc::Function
       end
     end
 
-    def tbody_parse(node, t)
+    def tbody_parse(node, table)
       tbody = node.at(ns("./tbody")) || return
-      t.tbody do |h|
+      table.tbody do |h|
         tbody.element_children.each_with_index do |n, i|
           tr_parse(n, h, i, tbody.element_children.size, false)
         end
       end
     end
 
-    def tfoot_parse(node, t)
+    def tfoot_parse(node, table)
       tfoot = node.at(ns("./tfoot"))
       if tfoot
-        t.tfoot do |h|
+        table.tfoot do |h|
           tfoot.element_children.each_with_index do |n, i|
             tr_parse(n, h, i, tfoot.element_children.size, false)
           end
@@ -45,23 +44,23 @@ module IsoDoc::Function
         id: node["id"],
         class: "MsoISOTable",
         style: "border-width:1px;border-spacing:0;#{width}#{keep_style(node)}",
-        title: node["alt"]
+        title: node["alt"],
       )
     end
 
-    def tcaption(node, t)
+    def tcaption(node, table)
       return unless node["summary"]
 
-      t.caption do |c|
+      table.caption do |c|
         c.span **{ style: "display:none" } do |s|
           s << node["summary"]
         end
       end
     end
 
-    def colgroup(node, t)
+    def colgroup(node, table)
       colgroup = node.at(ns("./colgroup")) or return
-      t.colgroup do |cg|
+      table.colgroup do |cg|
         colgroup.xpath(ns("./col")).each do |c|
           cg.col **{ style: "width: #{c['width']};" }
         end
@@ -90,19 +89,19 @@ module IsoDoc::Function
     # border-left:#{col.zero? ? "#{SW} 1.5pt;" : "none;"}
     # border-right:#{SW} #{col == totalcols && !header ? "1.5" : "1.0"}pt;
 
-    def make_tr_attr(td, row, totalrows, header)
-      style = td.name == "th" ? "font-weight:bold;" : ""
-      td["align"] and style += "text-align:#{td['align']};"
-      td["valign"] and style += "vertical-align:#{td['valign']};"
-      rowmax = td["rowspan"] ? row + td["rowspan"].to_i - 1 : row
+    def make_tr_attr(cell, row, totalrows, header)
+      style = cell.name == "th" ? "font-weight:bold;" : ""
+      cell["align"] and style += "text-align:#{cell['align']};"
+      cell["valign"] and style += "vertical-align:#{cell['valign']};"
+      rowmax = cell["rowspan"] ? row + cell["rowspan"].to_i - 1 : row
       style += <<~STYLE
         border-top:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}
         border-bottom:#{SW} #{rowmax == totalrows ? '1.5' : '1.0'}pt;
       STYLE
-      header and scope = (td["colspan"] ? "colgroup" : "col")
-      !header and td.name == "th" and scope =
-        (td["rowspan"] ? "rowgroup" : "row")
-      { rowspan: td["rowspan"], colspan: td["colspan"],
+      header and scope = (cell["colspan"] ? "colgroup" : "col")
+      !header and cell.name == "th" and scope =
+                                          (cell["rowspan"] ? "rowgroup" : "row")
+      { rowspan: cell["rowspan"], colspan: cell["colspan"],
         style: style.gsub(/\n/, ""), scope: scope }
     end
 

data/lib/isodoc/function/terms.rb

@@ -11,27 +11,27 @@ module IsoDoc::Function
     end
 
     def deprecated_term_parse(node, out)
-      out.p **{ class: "DeprecatedTerms", style:"text-align:left;" } do |p|
+      out.p **{ class: "DeprecatedTerms", style: "text-align:left;" } do |p|
         p << l10n("#{@i18n.deprecated}: ")
         node.children.each { |c| parse(c, p) }
       end
     end
 
     def admitted_term_parse(node, out)
-      out.p **{ class: "AltTerms", style:"text-align:left;" } do |p|
+      out.p **{ class: "AltTerms", style: "text-align:left;" } do |p|
         node.children.each { |c| parse(c, p) }
       end
     end
 
     def term_parse(node, out)
-      out.p **{ class: "Terms", style:"text-align:left;" } do |p|
+      out.p **{ class: "Terms", style: "text-align:left;" } do |p|
         node.children.each { |c| parse(c, p) }
       end
     end
 
-    def para_then_remainder(first, node, p, div)
+    def para_then_remainder(first, node, para, div)
       if first.name == "p"
-        first.children.each { |n| parse(n, p) }
+        first.children.each { |n| parse(n, para) }
         node.elements.drop(1).each { |n| parse(n, div) }
       else
         node.elements.each { |n| parse(n, div) }
@@ -72,7 +72,6 @@ module IsoDoc::Function
       node.children.each { |n| parse(n, out) }
     end
 
-    def termdocsource_parse(_node, _out)
-    end
+    def termdocsource_parse(_node, _out); end
   end
 end

data/lib/isodoc/gem_tasks.rb

@@ -12,12 +12,10 @@ module IsoDoc
 
     def install
       rule ".css" => [proc { |tn| tn.sub(/\.css$/, ".scss") }] do |current_task|
-        begin
-          puts(current_task)
-          compile_scss_task(current_task)
-        rescue StandardError => e
-          notify_borken_compilation(e, current_task)
-        end
+        puts(current_task)
+        compile_scss_task(current_task)
+      rescue StandardError => e
+        notify_borken_compilation(e, current_task)
       end
 
       scss_files = Rake::FileList["lib/**/*.scss"]
@@ -88,7 +86,7 @@ module IsoDoc
       text
         .gsub("/* LIQUID_COMMENT", "")
         .gsub("LIQUID_COMMENT */", "")
-        .gsub('"{{', '{{').gsub('}}"', "}}")
+        .gsub('"{{', "{{").gsub('}}"', "}}")
     end
 
     def fonts_placeholder
@@ -107,7 +105,8 @@ module IsoDoc
       require "sassc"
 
       isodoc_path = if Gem.loaded_specs["isodoc"]
-                      File.join(Gem.loaded_specs["isodoc"].full_gem_path, "lib", "isodoc")
+                      File.join(Gem.loaded_specs["isodoc"].full_gem_path,
+                                "lib", "isodoc")
                     else
                       File.join("lib", "isodoc")
                     end
@@ -119,7 +118,7 @@ module IsoDoc
       SassC::Engine.new(fonts_placeholder + sheet_content,
                         syntax: :scss,
                         importer: SasscImporter)
-                   .render
+        .render
     end
 
     def compile_scss_task(current_task)