isodoc 1.6.0 → 1.6.5

data/lib/isodoc/function/blocks_example_note.rb

@@ -59,7 +59,7 @@ module IsoDoc::Function
       name = node&.at(ns("./name"))&.remove
       div.p do |p|
         name and p.span **{ class: "note_label" } do |s|
-          name and name.children.each { |n| parse(n, s) }
+          name.children.each { |n| parse(n, s) }
           s << note_delim
         end
         insert_tab(p, 1)
@@ -98,7 +98,7 @@ module IsoDoc::Function
       @note = true
       out.div **note_attrs(node) do |div|
         node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p" ?
-        #node.first_element_child.name == "p" ?
+        # node.first_element_child.name == "p" ?
           note_p_parse(node, div) : note_parse1(node, div)
       end
       @note = false

data/lib/isodoc/function/cleanup.rb

@@ -1,16 +1,17 @@
 module IsoDoc::Function
   module Cleanup
     def textcleanup(docxml)
-      docxml = termref_cleanup(passthrough_cleanup(docxml))
+      termref_cleanup(passthrough_cleanup(docxml))
     end
 
     def termref_cleanup(docxml)
-      docxml.
-        gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/, l10n(", #{@i18n.modified} [/TERMREF]")).
-        gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ").
-        gsub(/\[TERMREF\]\s*/, l10n("[#{@i18n.source}: ")).
-        gsub(%r{\s*\[\/TERMREF\]\s*}, l10n("]")).
-        gsub(/\s*\[MODIFICATION\]/, l10n(", #{@i18n.modified} &mdash; "))
+      docxml
+        .gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/,
+              l10n(", #{@i18n.modified} [/TERMREF]"))
+        .gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ")
+        .gsub(/\[TERMREF\]\s*/, l10n("[#{@i18n.source}: "))
+        .gsub(%r{\s*\[/TERMREF\]\s*}, l10n("]"))
+        .gsub(/\s*\[MODIFICATION\]/, l10n(", #{@i18n.modified} &mdash; "))
     end
 
     def passthrough_cleanup(docxml)
@@ -21,7 +22,7 @@ module IsoDoc::Function
     end
 
     def cleanup(docxml)
-      @i18n ||= i18n_init(@lang, @script) 
+      @i18n ||= i18n_init(@lang, @script)
       comment_cleanup(docxml)
       footnote_cleanup(docxml)
       inline_header_cleanup(docxml)
@@ -34,30 +35,36 @@ module IsoDoc::Function
 
     def table_long_strings_cleanup(docxml)
       return unless @break_up_urls_in_tables == true
+
       docxml.xpath("//td | //th").each do |d|
         d.traverse do |n|
           next unless n.text?
+
           n.replace(HTMLEntities.new.encode(
-            break_up_long_strings(n.text)))
+                      break_up_long_strings(n.text),
+                    ))
         end
       end
     end
 
-    def break_up_long_strings(t)
-      return t if t.match(/^\s*$/)
-      t.split(/(?=\s)/).map do |w|
-        (/^\s*$/.match(t) or w.size < 30) ? w :
+    def break_up_long_strings(text)
+      return text if /^\s*$/.match?(text)
+
+      text.split(/(?=\s)/).map do |w|
+        if /^\s*$/.match(text) || (w.size < 30) then w
+        else
           w.scan(/.{,30}/).map do |w1|
-          (w1.size < 30) ? w1 : break_up_long_strings1(w1)
-        end.join
+            w1.size < 30 ? w1 : break_up_long_strings1(w1)
+          end.join
+        end
       end.join
     end
 
-    def break_up_long_strings1(w1)
-      s = w1.split(%r{(?<=[,.?+;/=])})
-      if s.size == 1 then w1 + " "
+    def break_up_long_strings1(text)
+      s = text.split(%r{(?<=[,.?+;/=])})
+      if s.size == 1 then "#{text} "
       else
-        s[-1] = " " + s[-1]
+        s[-1] = " #{s[-1]}"
         s.join
       end
     end
@@ -78,11 +85,11 @@ module IsoDoc::Function
       docxml
     end
 
-    def figure_get_or_make_dl(t)
-      dl = t.at(".//dl")
+    def figure_get_or_make_dl(elem)
+      dl = elem.at(".//dl")
       if dl.nil?
-        t.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
-        dl = t.at(".//dl")
+        elem.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
+        dl = elem.at(".//dl")
       end
       dl
     end
@@ -91,10 +98,10 @@ module IsoDoc::Function
       "//div[@class = 'figure'][descendant::aside]"\
       "[not(descendant::div[@class = 'figure'])]".freeze
 
-    def figure_aside_process(f, aside, key)
+    def figure_aside_process(elem, aside, key)
       # get rid of footnote link, it is in diagram
-      f&.at("./a[@class='TableFootnoteRef']")&.remove
-      fnref = f.at(".//span[@class='TableFootnoteRef']/..")
+      elem&.at("./a[@class='TableFootnoteRef']")&.remove
+      fnref = elem.at(".//span[@class='TableFootnoteRef']/..")
       dt = key.add_child("<dt></dt>").first
       dd = key.add_child("<dd></dd>").first
       fnref.parent = dt
@@ -109,6 +116,7 @@ module IsoDoc::Function
     def figure_cleanup(docxml)
       docxml.xpath(FIGURE_WITH_FOOTNOTES).each do |f|
         next unless f.at(".//aside[not(ancestor::p[@class = 'FigureTitle'])]")
+
         key = figure_get_or_make_dl(f)
         f.xpath(".//aside").each do |aside|
           figure_aside_process(f, aside, key)
@@ -137,12 +145,13 @@ module IsoDoc::Function
       docxml
     end
 
-    def merge_fnref_into_fn_text(a)
-      fn = a.at('.//span[@class="TableFootnoteRef"]/..')
+    def merge_fnref_into_fn_text(elem)
+      fn = elem.at('.//span[@class="TableFootnoteRef"]/..')
       n = fn.next_element
       n&.children&.first&.add_previous_sibling(fn.remove)
     end
 
+    # preempt html2doc putting MsoNormal under TableFootnote class
     def table_footnote_cleanup(docxml)
       docxml.xpath("//table[descendant::aside]").each do |t|
         t.xpath(".//aside").each do |a|
@@ -152,36 +161,36 @@ module IsoDoc::Function
           t << a.remove
         end
       end
-      # preempt html2doc putting MsoNormal there
       docxml.xpath("//p[not(self::*[@class])]"\
                    "[ancestor::*[@class = 'TableFootnote']]").each do |p|
         p["class"] = "TableFootnote"
       end
     end
 
-    def remove_bottom_border(td)
-      td["style"] =
-        td["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
+    def remove_bottom_border(cell)
+      cell["style"] =
+        cell["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
     end
 
-    def table_get_or_make_tfoot(t)
-      tfoot = t.at(".//tfoot")
+    def table_get_or_make_tfoot(table)
+      tfoot = table.at(".//tfoot")
       if tfoot.nil?
-        t.add_child("<tfoot></tfoot>")
-        tfoot = t.at(".//tfoot")
+        table.add_child("<tfoot></tfoot>")
+        tfoot = table.at(".//tfoot")
       else
         tfoot.xpath(".//td | .//th").each { |td| remove_bottom_border(td) }
       end
       tfoot
     end
 
-    def new_fullcolspan_row(t, tfoot)
+    def new_fullcolspan_row(table, tfoot)
       # how many columns in the table?
       cols = 0
-      t.at(".//tr").xpath("./td | ./th").each do |td|
+      table.at(".//tr").xpath("./td | ./th").each do |td|
         cols += (td["colspan"] ? td["colspan"].to_i : 1)
       end
-      style = %{border-top:0pt;border-bottom:#{IsoDoc::Function::Table::SW} 1.5pt;}
+      style =
+        %{border-top:0pt;border-bottom:#{IsoDoc::Function::Table::SW} 1.5pt;}
       tfoot.add_child("<tr><td colspan='#{cols}' style='#{style}'/></tr>")
       tfoot.xpath(".//td").last
     end
@@ -204,15 +213,14 @@ module IsoDoc::Function
       docxml
     end
 
-    def symbols_cleanup(docxml)
-    end
+    def symbols_cleanup(docxml); end
 
-    def table_footnote_reference_format(a)
-      a
+    def table_footnote_reference_format(link)
+      link
     end
 
-    def footnote_reference_format(a)
-      a
+    def footnote_reference_format(link)
+      link
     end
   end
 end

data/lib/isodoc/function/form.rb

@@ -0,0 +1,51 @@
+module IsoDoc::Function
+  module Form
+    def form_parse(node, out)
+      node.children.each do |n|
+        parse(n, out)
+      end
+    end
+
+    def input_parse(node, out)
+      case node["type"]
+      when "button" then out << "[#{node['value'] || 'BUTTON'}]"
+      when "checkbox" then out << "&#x2610; "
+      when "date" then text_input(out)
+      when "file" then text_input(out)
+      when "password" then text_input(out)
+      when "radio" then out << "&#x25CE; "
+      when "submit" # nop
+      when "text" then text_input(out, node["maxlength"])
+      end
+    end
+
+    def text_input(out, length = 10)
+      length ||= 10
+      length = length.to_i
+      length.zero? and length = 10
+      out << "_" * length
+      out << " "
+    end
+
+    def select_parse(node, out)
+      text_input(out, node["size"] || 10)
+    end
+
+    def label_parse(node, out)
+      node.children.each do |n|
+        parse(n, out)
+      end
+    end
+
+    def option_parse(node, out); end
+
+    def textarea_parse(_node, out)
+      out.table **{ border: 1, width: "50%" } do |t|
+        t.tr do |tr|
+          tr.td do |td|
+          end
+        end
+      end
+    end
+  end
+end

data/lib/isodoc/function/inline.rb

@@ -3,11 +3,12 @@ require_relative "inline_simple"
 module IsoDoc::Function
   module Inline
     def link_parse(node, out)
-      out.a **attr_code(href: node["target"], title: node["alt"]) do |l|
+      url = node["target"]
+      node["updatetype"] == "true" and url = suffix_url(url)
+      out.a **attr_code(href: url, title: node["alt"]) do |l|
         if node.text.empty?
           l << node["target"].sub(/^mailto:/, "")
-        else
-          node.children.each { |n| parse(n, l) }
+        else node.children.each { |n| parse(n, l) }
         end
       end
     end
@@ -33,6 +34,7 @@ module IsoDoc::Function
 
     def suffix_url(url)
       return url if %r{^https?://}.match?(url)
+      return url unless File.extname(url).empty?
 
       url.sub(/#{File.extname(url)}$/, ".html")
     end
@@ -78,8 +80,7 @@ module IsoDoc::Function
                "#{@openmathdelim}#{HTMLEntities.new.encode(node.text)}"\
                  "#{@closemathdelim}"
              when "MathML" then node.first_element_child.to_s
-             else
-               HTMLEntities.new.encode(node.text)
+             else HTMLEntities.new.encode(node.text)
              end
       out.span **{ class: "stem" } do |span|
         span.parent.add_child ooml
@@ -122,13 +123,13 @@ module IsoDoc::Function
     end
 
     def add_parse(node, out)
-      out.span **{class: "addition"} do |e|
+      out.span **{ class: "addition" } do |e|
         node.children.each { |n| parse(n, e) }
       end
     end
 
     def del_parse(node, out)
-      out.span **{class: "deletion"} do |e|
+      out.span **{ class: "deletion" } do |e|
         node.children.each { |n| parse(n, e) }
       end
     end

data/lib/isodoc/function/references.rb

@@ -1,82 +1,81 @@
 module IsoDoc::Function
   module References
-
     # This is highly specific to ISO, but it's not a bad precedent for
     # references anyway; keeping here instead of in IsoDoc::Iso for now
-    def docid_l10n(x)
-      return x if x.nil?
-      x.gsub(/All Parts/i, @i18n.all_parts.downcase) if @i18n.all_parts
-      x
+    def docid_l10n(text)
+      return text if text.nil?
+
+      text.gsub(/All Parts/i, @i18n.all_parts.downcase) if @i18n.all_parts
+      text
     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
-          ref << "#{identifiers[0] || identifiers[1]}"
+          ref << (identifiers[0] || identifiers[1]).to_s
           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]}"
+          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
 
     # if t is just a number, only use that ([1] Non-Standard)
     # else, use both ordinal, as prefix, and t
-    def ref_entry_code(r, ordinal, t, id)
+    def ref_entry_code(r, ordinal, t, _id)
       prefix_bracketed_ref(r, t[0] || "[#{ordinal}]")
-      t[1] and r << "#{t[1]}"
+      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 "\
-                    "@type = 'ISBN']")) 
+    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 << "(NO ID)"
       [nil, id, nil]
     end
 
-    def bracket_if_num(x)
-      return nil if x.nil?
-      x = x.text.sub(/^\[/, "").sub(/\]$/, "")
-      return "[#{x}]" if /^\d+$/.match(x)
-      x
+    def bracket_if_num(num)
+      return nil if num.nil?
+
+      num = num.text.sub(/^\[/, "").sub(/\]$/, "")
+      return "[#{num}]" if /^\d+$/.match?(num)
+
+      num
     end
 
-    def render_identifier(id)
-      [
-        bracket_if_num(id[0]),
-        id[1].nil? ? nil :
-        docid_prefix(id[1]["type"], id[1].text.sub(/^\[/, "").sub(/\]$/, "")),
-        id[2].nil? ? nil :
-        docid_prefix(id[2]["type"], id[2].text.sub(/^\[/, "").sub(/\]$/, "")),
-      ]
+    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)
@@ -87,32 +86,34 @@ module IsoDoc::Function
 
     def omit_docid_prefix(prefix)
       return true if prefix.nil? || prefix.empty?
-      return %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(b)
-      title = b.at(ns("./title[@language = '#{@lang}' and @type = 'main']")) ||
-        b.at(ns("./title[@language = '#{@lang}']")) ||
-        b.at(ns("./title[@type = 'main']")) ||
-        b.at(ns("./title"))
-      title
+    def iso_title(bib)
+      bib.at(ns("./title[@language = '#{@lang}' and @type = 'main']")) ||
+        bib.at(ns("./title[@language = '#{@lang}']")) ||
+        bib.at(ns("./title[@type = 'main']")) ||
+        bib.at(ns("./title"))
     end
 
     # reference not to be rendered because it is deemed implicit
     # in the standards environment
-    def implicit_reference(b)
-      b["hidden"] == "true"
+    def implicit_reference(bib)
+      bib["hidden"] == "true"
     end
 
     def prefix_bracketed_ref(ref, text)
@@ -120,35 +121,37 @@ module IsoDoc::Function
       insert_tab(ref, 1)
     end
 
-    def reference_format(b, r)
-      if ftitle = b.at(ns("./formattedref"))
-        ftitle&.children&.each { |n| parse(n, r) }
+    def reference_format(bib, out)
+      if ftitle = bib.at(ns("./formattedref"))
+        ftitle&.children&.each { |n| parse(n, out) }
       else
-        title = iso_title(b)
-        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(b)
+    def is_standard(bib)
       ret = false
-      b.xpath(ns("./docidentifier")).each do |id|
-        next if id["type"].nil? ||
-          %w(metanorma DOI ISSN ISBN).include?(id["type"])
+      drop = %w(metanorma DOI ISSN ISBN)
+      bib.xpath(ns("./docidentifier")).each do |id|
+        next if id["type"].nil? || drop.include?(id["type"])
+
         ret = true
       end
       ret
     end
 
-    def biblio_list(f, div, biblio)
+    def biblio_list(refs, div, biblio)
       i = 0
-      f.children.each do |b|
+      refs.children.each do |b|
         if b.name == "bibitem"
           next if implicit_reference(b)
+
           i += 1
-          (is_standard(b)) ? std_bibitem_entry(div, b, i, biblio) :
-            nonstd_bibitem(div, b, i, biblio)
+          if is_standard(b) then std_bibitem_entry(div, b, i, biblio)
+          else nonstd_bibitem(div, b, i, biblio)
+          end
         else
           parse(b, div) unless %w(title).include? b.name
         end
@@ -167,14 +170,13 @@ 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
     end
 
-    def bibliography_xpath 
+    def bibliography_xpath
       "//bibliography/clause[.//references]"\
         "[not(.//references[@normative = 'true'])] | "\
         "//bibliography/references[@normative = 'false']"
@@ -184,7 +186,7 @@ module IsoDoc::Function
       f = isoxml.at(ns(bibliography_xpath)) and f["hidden"] != "true" or return
       page_break(out)
       out.div do |div|
-        div.h1 **{class: "Section3"} do |h1|
+        div.h1 **{ class: "Section3" } do |h1|
           f&.at(ns("./title"))&.children&.each { |c2| parse(c2, h1) }
         end
         biblio_list(f, div, true)
@@ -193,19 +195,11 @@ module IsoDoc::Function
 
     def bibliography_parse(node, out)
       node["hidden"] != true or return
-      title = node&.at(ns("./title"))&.text || ""
       out.div do |div|
         clause_parse_title(node, div, node.at(ns("./title")), out,
                            { class: "Section3" })
         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