isodoc 1.5.4 → 1.6.3

data/lib/isodoc/function/references.rb

@@ -1,12 +1,12 @@
 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
@@ -16,7 +16,7 @@ module IsoDoc::Function
         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]
@@ -29,7 +29,7 @@ module IsoDoc::Function
         identifiers = render_identifier(bibitem_ref_code(b))
         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)
@@ -40,9 +40,9 @@ module IsoDoc::Function
 
     # 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)
@@ -55,27 +55,36 @@ module IsoDoc::Function
       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']")) 
+                    "@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(/\]$/, "")),
+        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,
       ]
     end
 
@@ -87,12 +96,14 @@ module IsoDoc::Function
 
     def omit_docid_prefix(prefix)
       return true if prefix.nil? || prefix.empty?
-      return %w(ISO IEC IEV ITU W3C metanorma rfc-anchor).include? prefix
+
+      %w(ISO IEC IEV ITU W3C csd metanorma rfc-anchor).include? prefix
     end
 
     def date_note_process(b, ref)
       date_note = b.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
@@ -101,18 +112,17 @@ module IsoDoc::Function
       { id: b["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 +130,38 @@ module IsoDoc::Function
       insert_tab(ref, 1)
     end
 
-    def reference_format(b, r)
-      if ftitle = b.at(ns("./formattedref"))
+    def reference_format(bib, r)
+      if ftitle = bib.at(ns("./formattedref"))
         ftitle&.children&.each { |n| parse(n, r) }
       else
-        title = iso_title(b)
+        title = iso_title(bib)
         r.i do |i|
           title&.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|
+      bib.xpath(ns("./docidentifier")).each do |id|
         next if id["type"].nil? ||
           %w(metanorma DOI ISSN ISBN).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
@@ -174,7 +187,7 @@ module IsoDoc::Function
       num
     end
 
-    def bibliography_xpath 
+    def bibliography_xpath
       "//bibliography/clause[.//references]"\
         "[not(.//references[@normative = 'true'])] | "\
         "//bibliography/references[@normative = 'false']"
@@ -184,7 +197,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,7 +206,6 @@ 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" })
@@ -201,11 +213,12 @@ module IsoDoc::Function
       end
     end
 
-    def format_ref(ref, prefix, isopub, date, allparts)
+    def format_ref(ref, prefix, _isopub, _date, _allparts)
       ref = docid_prefix(prefix, ref)
       return "[#{ref}]" if ref && /^\d+$/.match(ref) && !prefix &&
         !/^\[.*\]$/.match(ref)
-        ref
+
+      ref
     end
   end
 end

data/lib/isodoc/function/table.rb

@@ -51,6 +51,7 @@ module IsoDoc::Function
 
     def tcaption(node, t)
       return unless node["summary"]
+
       t.caption do |c|
         c.span **{ style: "display:none" } do |s|
           s << node["summary"]

data/lib/isodoc/function/to_word_html.rb

@@ -18,15 +18,22 @@ module IsoDoc::Function
 
     def init_file(filename, debug)
       filepath = Pathname.new(filename)
-      filename = filepath.sub_ext('').sub(/\.presentation$/, "").to_s
+      filename = filepath.sub_ext("").sub(/\.presentation$/, "").to_s
+      dir = init_dir(filename, debug)
+      @filename = filename
+      @localdir = filepath.parent.to_s + "/"
+      @sourcedir = @localdir
+      @sourcefilename and @sourcedir = Pathname.new(@sourcefilename).parent.to_s + "/"
+      [filename, dir]
+    end
+
+    def init_dir(filename, debug)
       dir = "#{filename}_files"
       unless debug
-        Dir.mkdir(dir, 0777) unless File.exists?(dir)
+        Dir.mkdir(dir, 0o777) unless File.exists?(dir)
         FileUtils.rm_rf "#{dir}/*"
       end
-      @filename = filename
-      @localdir = filepath.parent.to_s + '/'
-      [filename, dir]
+      dir
     end
 
     # tmp image dir is same directory as @filename
@@ -44,15 +51,14 @@ module IsoDoc::Function
       if @standardstylesheet
         head.style do |style|
           @standardstylesheet.open
-          stylesheet = @standardstylesheet.read.
-            gsub("FILENAME", File.basename(filename).sub(/\.presentation$/, ""))
+          stylesheet = @standardstylesheet.read
           style.comment "\n#{stylesheet}\n"
         end
       end
     end
 
     def body_attr
-      { lang: "#{@lang}" }
+      { lang: @lang.to_s }
     end
 
     def make_body(xml, docxml)
@@ -70,7 +76,7 @@ module IsoDoc::Function
       section_break(body)
     end
 
-    def make_body2(body, docxml)
+    def make_body2(body, _docxml)
       body.div **{ class: "prefatory-section" } do |div2|
         div2.p { |p| p << "&nbsp;" } # placeholder
       end
@@ -109,23 +115,13 @@ module IsoDoc::Function
       @meta.get
     end
 
-    def middle_title(_isoxml, out)
-      out.p(**{ class: "zzSTDTitle1" }) { |p| p << @meta.get[:doctitle] }
-    end
-
-    def middle_admonitions(isoxml, out)
-      isoxml.xpath(ns("//sections/note | //sections/admonition")).each do |x|
-        parse(x, out)
-      end
-    end
-
     def middle(isoxml, out)
       middle_title(isoxml, out)
       middle_admonitions(isoxml, out)
       i = scope isoxml, out, 0
       i = norm_ref isoxml, out, i
       i = terms_defs isoxml, out, i
-      i = symbols_abbrevs isoxml, out, i
+      symbols_abbrevs isoxml, out, i
       clause isoxml, out
       annex isoxml, out
       bibliography isoxml, out
@@ -133,22 +129,20 @@ module IsoDoc::Function
 
     def boilerplate(node, out)
       boilerplate = node.at(ns("//boilerplate")) or return
-      out.div **{class: "authority"} do |s|
+      out.div **{ class: "authority" } do |s|
         boilerplate.children.each do |n|
           if n.name == "title"
             s.h1 do |h|
               n.children.each { |nn| parse(nn, h) }
             end
-          else
-            parse(n, s)
+          else parse(n, s)
           end
         end
       end
     end
 
     def parse(node, out)
-      if node.text?
-        text_parse(node, out)
+      if node.text? then text_parse(node, out)
       else
         case node.name
         when "em" then em_parse(node, out)
@@ -225,9 +219,16 @@ module IsoDoc::Function
         when "passthrough" then passthrough_parse(node, out)
         when "amend" then amend_parse(node, out)
         when "tab" then clausedelimspace(out) # in Presentation XML only
-        when "svg" then svg_parse(node, out) # introduced in Presentation XML only
-        else
-          error_parse(node, out)
+        when "svg" then svg_parse(node, out) # in Presentation XML only
+        when "add" then add_parse(node, out)
+        when "del" then del_parse(node, out)
+        when "form" then form_parse(node, out)
+        when "input" then input_parse(node, out)
+        when "select" then select_parse(node, out)
+        when "label" then label_parse(node, out)
+        when "option" then option_parse(node, out)
+        when "textarea" then textarea_parse(node, out)
+        else error_parse(node, out)
         end
       end
     end

data/lib/isodoc/function/utils.rb

@@ -28,10 +28,10 @@ module IsoDoc::Function
     # to allow for HTMLentities
     def noko(&block)
       doc = ::Nokogiri::XML.parse(NOKOHEAD)
-      fragment = doc.fragment('')
+      fragment = doc.fragment("")
       ::Nokogiri::XML::Builder.with fragment, &block
-      fragment.to_xml(encoding: 'US-ASCII').lines.map do |l|
-        l.gsub(/\s*\n/, '')
+      fragment.to_xml(encoding: "US-ASCII").lines.map do |l|
+        l.gsub(/\s*\n/, "")
       end
     end
 
@@ -46,17 +46,18 @@ module IsoDoc::Function
       '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
 
     def to_xhtml(xml)
-      xml.gsub!(/<\?xml[^>]*>/, '')
+      xml.gsub!(/<\?xml[^>]*>/, "")
       /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml)
       xml = xml.split(/(\&[^ \r\n\t#;]+;)/).map do |t|
         /^(\&[^ \t\r\n#;]+;)/.match?(t) ?
           HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal) : t
-      end.join('')
+      end.join("")
       begin
         Nokogiri::XML.parse(xml, &:strict)
       rescue Nokogiri::XML::SyntaxError => e
-        File.open("#{@filename}.#{@format}.err", 'w:UTF-8') { |f| f.write xml }
-        abort "Malformed Output XML for #{@format}: #{e} (see #{@filename}.#{@format}.err)"
+        File.open("#{@filename}.#{@format}.err", "w:UTF-8") { |f| f.write xml }
+        abort "Malformed Output XML for #{@format}: #{e} "\
+          "(see #{@filename}.#{@format}.err)"
       end
     end
 
@@ -67,11 +68,12 @@ module IsoDoc::Function
     end
 
     def from_xhtml(xml)
-      xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, '')
+      xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")
     end
 
     CLAUSE_ANCESTOR =
       ".//ancestor::*[local-name() = 'annex' or "\
+      "local-name() = 'definitions' or "\
       "local-name() = 'acknowledgements' or local-name() = 'term' or "\
       "local-name() = 'appendix' or local-name() = 'foreword' or "\
       "local-name() = 'introduction' or local-name() = 'terms' or "\
@@ -102,31 +104,32 @@ module IsoDoc::Function
       else
         @i18n.l10n("#{array[0..-2].join(', ')} "\
                    "#{@i18n.and} #{array.last}",
-                                     @lang, @script)
+                   @lang, @script)
       end
     end
 
     # avoid `; avoid {{ (Liquid Templates); avoid [[ (Javascript)
     def extract_delims(text)
-      @openmathdelim = '(#('
-      @closemathdelim = ')#)'
+      @openmathdelim = "(#("
+      @closemathdelim = ")#)"
       while text.include?(@openmathdelim) || text.include?(@closemathdelim)
-        @openmathdelim += '('
-        @closemathdelim += ')'
+        @openmathdelim += "("
+        @closemathdelim += ")"
       end
       [@openmathdelim, @closemathdelim]
     end
 
     def header_strip(h)
-      h = h.to_s.gsub(%r{<br\s*/>}, ' ').gsub(/<\/?h[123456][^>]*>/, '')
-           .gsub(/<\/?b[^>]*>/, '')
+      h = h.to_s.gsub(%r{<br\s*/>}, " ").gsub(/<\/?h[123456][^>]*>/, "")
+        .gsub(/<\/?b[^>]*>/, "")
       h1 = to_xhtml_fragment(h.dup)
       h1.traverse do |x|
-        x.replace(' ') if x.name == 'span' && /mso-tab-count/.match(x['style'])
-        x.remove if x.name == 'span' && x['class'] == 'MsoCommentReference'
-        x.remove if x.name == 'a' && x['class'] == 'FootnoteRef'
-        x.remove if x.name == 'span' && /mso-bookmark/.match(x['style'])
-        x.replace(x.children) if x.name == 'a'
+        x.replace(" ") if x.name == "span" && /mso-tab-count/.match(x["style"])
+        x.remove if x.name == "img"
+        x.remove if x.name == "span" && x["class"] == "MsoCommentReference"
+        x.remove if x.name == "a" && x["class"] == "FootnoteRef"
+        x.remove if x.name == "span" && /mso-bookmark/.match(x["style"])
+        x.replace(x.children) if x.name == "a"
       end
       from_xhtml(h1)
     end
@@ -138,9 +141,9 @@ module IsoDoc::Function
     def liquid(doc)
       # unescape HTML escapes in doc
       doc = doc.split(%r<(\{%|%\})>).each_slice(4).map do |a|
-        a[2] = a[2].gsub(/\&lt;/, '<').gsub(/\&gt;/, '>') if a.size > 2
-        a.join('')
-      end.join('')
+        a[2] = a[2].gsub(/\&lt;/, "<").gsub(/\&gt;/, ">") if a.size > 2
+        a.join("")
+      end.join("")
       Liquid::Template.parse(doc)
     end
 
@@ -151,20 +154,20 @@ module IsoDoc::Function
 
     def populate_template(docxml, _format = nil)
       meta = @meta
-             .get
-             .merge(@labels ? {labels: @labels} : {})
-             .merge(@meta.labels ? {labels: @meta.labels} : {})
-             .merge(fonts_options || {})
+        .get
+        .merge(@labels ? {labels: @labels} : {})
+        .merge(@meta.labels ? {labels: @meta.labels} : {})
+        .merge(fonts_options || {})
       template = liquid(docxml)
       template.render(meta.map { |k, v| [k.to_s, empty2nil(v)] }.to_h)
-              .gsub('&lt;', '&#x3c;').gsub('&gt;', '&#x3e;').gsub('&amp;', '&#x26;')
+        .gsub("&lt;", "&#x3c;").gsub("&gt;", "&#x3e;").gsub("&amp;", "&#x26;")
     end
 
     def save_dataimage(uri, _relative_dir = true)
       %r{^data:(image|application)/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ uri
-      imgtype.sub!(/\+[a-z0-9]+$/, '') # svg+xml
-      imgtype = 'png' unless /^[a-z0-9]+$/.match imgtype
-      Tempfile.open(['image', ".#{imgtype}"]) do |f|
+      imgtype.sub!(/\+[a-z0-9]+$/, "") # svg+xml
+      imgtype = "png" unless /^[a-z0-9]+$/.match imgtype
+      Tempfile.open(["image", ".#{imgtype}"]) do |f|
         f.binmode
         f.write(Base64.strict_decode64(imgdata))
         @tempfile_cache << f # persist to the end
@@ -173,18 +176,18 @@ module IsoDoc::Function
     end
 
     def image_localfile(i)
-      if /^data:/.match? i['src']
-        save_dataimage(i['src'], false)
-      elsif %r{^([A-Z]:)?/}.match? i['src']
-        i['src']
+      if /^data:/.match? i["src"]
+        save_dataimage(i["src"], false)
+      elsif %r{^([A-Z]:)?/}.match? i["src"]
+        i["src"]
       else
-        File.join(@localdir, i['src'])
+        File.join(@localdir, i["src"])
       end
     end
 
     def labelled_ancestor(node)
-      !node.ancestors('example, requirement, recommendation, permission, '\
-                             'note, table, figure, sourcecode').empty?
+      !node.ancestors("example, requirement, recommendation, permission, "\
+                      "note, table, figure, sourcecode").empty?
     end
   end
 end