isodoc 1.7.1 → 1.7.4

data/lib/isodoc/function/blocks_example_note.rb

@@ -1,107 +1,113 @@
-module IsoDoc::Function
-  module Blocks
-    def example_label(node, div, name)
-      return if name.nil?
-      div.p **{ class: "example-title" } do |p|
-        name.children.each { |n| parse(n, div) }
+module IsoDoc
+  module Function
+    module Blocks
+      def example_label(_node, div, name)
+        return if name.nil?
+
+        div.p **{ class: "example-title" } do |_p|
+          name.children.each { |n| parse(n, div) }
+        end
       end
-    end
 
-    EXAMPLE_TBL_ATTR =
-      { class: "example_label", style: "width:82.8pt;padding:0 0 0 0;\
+      EXAMPLE_TBL_ATTR =
+        { class: "example_label", style: "width:82.8pt;padding:0 0 0 0;\
         margin-left:0pt;vertical-align:top;" }.freeze
 
-    def example_div_attr(node)
-      attr_code(id: node["id"], class: "example", style: keep_style(node))
-    end
+      def example_div_attr(node)
+        attr_code(id: node["id"], class: "example", style: keep_style(node))
+      end
 
-    # used if we are boxing examples
-    def example_div_parse(node, out)
-      out.div **example_div_attr(node) do |div|
-        example_label(node, div, node.at(ns("./name")))
-        node.children.each do |n|
-          parse(n, div) unless n.name == "name"
+      # used if we are boxing examples
+      def example_div_parse(node, out)
+        out.div **example_div_attr(node) do |div|
+          example_label(node, div, node.at(ns("./name")))
+          node.children.each do |n|
+            parse(n, div) unless n.name == "name"
+          end
         end
       end
-    end
 
-    def example_table_attr(node)
-      attr_code(id: node["id"], class: "example",
-                style: "border-collapse:collapse;border-spacing:0;"\
-                "#{keep_style(node)}" )
-    end
+      def example_table_attr(node)
+        attr_code(id: node["id"], class: "example",
+                  style: "border-collapse:collapse;border-spacing:0;"\
+                         "#{keep_style(node)}")
+      end
 
-    EXAMPLE_TD_ATTR =
-      { style: "vertical-align:top;padding:0;", class: "example" }.freeze
+      EXAMPLE_TD_ATTR =
+        { style: "vertical-align:top;padding:0;", class: "example" }.freeze
 
-    def example_table_parse(node, out)
-      out.table **example_table_attr(node) do |t|
-        t.tr do |tr|
-          tr.td **EXAMPLE_TBL_ATTR do |td|
-            example_label(node, td, node.at(ns("./name")))
-          end
-          tr.td **EXAMPLE_TD_ATTR do |td|
-            node.children.each { |n| parse(n, td) unless n.name == "name" }
+      def example_table_parse(node, out)
+        out.table **example_table_attr(node) do |t|
+          t.tr do |tr|
+            tr.td **EXAMPLE_TBL_ATTR do |td|
+              example_label(node, td, node.at(ns("./name")))
+            end
+            tr.td **EXAMPLE_TD_ATTR do |td|
+              node.children.each { |n| parse(n, td) unless n.name == "name" }
+            end
           end
         end
       end
-    end
 
-    def example_parse(node, out)
-      example_div_parse(node, out)
-    end
+      def example_parse(node, out)
+        example_div_parse(node, out)
+      end
 
-    def note_delim
-      ""
-    end
+      def note_delim
+        ""
+      end
 
-    def note_p_parse(node, div)
-      name = node&.at(ns("./name"))&.remove
-      div.p do |p|
-        name and p.span **{ class: "note_label" } do |s|
-          name.children.each { |n| parse(n, s) }
-          s << note_delim
+      def note_p_parse(node, div)
+        name = node&.at(ns("./name"))&.remove
+        div.p do |p|
+          name and p.span **{ class: "note_label" } do |s|
+            name.children.each { |n| parse(n, s) }
+            s << note_delim
+          end
+          insert_tab(p, 1)
+          node.first_element_child.children.each { |n| parse(n, p) }
         end
-        insert_tab(p, 1)
-        node.first_element_child.children.each { |n| parse(n, p) }
+        node.element_children[1..-1].each { |n| parse(n, div) }
       end
-      node.element_children[1..-1].each { |n| parse(n, div) }
-    end
 
-    def note_parse1(node, div)
-      name = node&.at(ns("./name"))&.remove
-      name and div.p do |p|
-        p.span **{ class: "note_label" } do |s|
-          name.children.each { |n| parse(n, s) }
-          s << note_delim
+      def note_parse1(node, div)
+        name = node&.at(ns("./name"))&.remove
+        name and div.p do |p|
+          p.span **{ class: "note_label" } do |s|
+            name.children.each { |n| parse(n, s) }
+            s << note_delim
+          end
+          insert_tab(p, 1)
         end
-        insert_tab(p, 1)
+        node.children.each { |n| parse(n, div) }
       end
-      node.children.each { |n| parse(n, div) }
-    end
 
-    def keep_style(node)
-      ret = ""
-      node["keep-with-next"] == "true" and
-        ret += "page-break-after: avoid;"
-      node["keep-lines-together"] == "true" and
-        ret += "page-break-inside: avoid;"
-      return nil if ret.empty?
-      ret
-    end
+      def keep_style(node)
+        ret = ""
+        node["keep-with-next"] == "true" and
+          ret += "page-break-after: avoid;"
+        node["keep-lines-together"] == "true" and
+          ret += "page-break-inside: avoid;"
+        return nil if ret.empty?
 
-    def note_attrs(node)
-      attr_code(id: node["id"], class: "Note", style: keep_style(node))
-    end
+        ret
+      end
+
+      def note_attrs(node)
+        attr_code(id: node["id"], class: "Note", style: keep_style(node))
+      end
 
-    def note_parse(node, out)
-      @note = true
-      out.div **note_attrs(node) do |div|
-        node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p" ?
-        # node.first_element_child.name == "p" ?
-          note_p_parse(node, div) : note_parse1(node, div)
+      def note_parse(node, out)
+        @note = true
+        out.div **note_attrs(node) do |div|
+          if node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p"
+            note_p_parse(node, div)
+          else
+            note_parse1(node, div)
+          end
+        end
+        @note = false
       end
-      @note = false
     end
   end
 end

data/lib/isodoc/function/cleanup.rb

@@ -1,226 +1,232 @@
-module IsoDoc::Function
-  module Cleanup
-    def textcleanup(docxml)
-      termref_cleanup(passthrough_cleanup(docxml))
-    end
+module IsoDoc
+  module Function
+    module Cleanup
+      def textcleanup(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; "))
-    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; "))
+      end
 
-    def passthrough_cleanup(docxml)
-      docxml.split(%r{(<passthrough>|</passthrough>)}).each_slice(4).map do |a|
-        a.size > 2 and a[2] = HTMLEntities.new.decode(a[2])
-        [a[0], a[2]]
-      end.join
-    end
+      def passthrough_cleanup(docxml)
+        docxml.split(%r{(<passthrough>|</passthrough>)}).each_slice(4)
+          .map do |a|
+          a.size > 2 and a[2] = HTMLEntities.new.decode(a[2])
+          [a[0], a[2]]
+        end.join
+      end
 
-    def cleanup(docxml)
-      @i18n ||= i18n_init(@lang, @script)
-      comment_cleanup(docxml)
-      footnote_cleanup(docxml)
-      inline_header_cleanup(docxml)
-      figure_cleanup(docxml)
-      table_cleanup(docxml)
-      symbols_cleanup(docxml)
-      example_cleanup(docxml)
-      admonition_cleanup(docxml)
-    end
+      def cleanup(docxml)
+        @i18n ||= i18n_init(@lang, @script)
+        comment_cleanup(docxml)
+        footnote_cleanup(docxml)
+        inline_header_cleanup(docxml)
+        figure_cleanup(docxml)
+        table_cleanup(docxml)
+        symbols_cleanup(docxml)
+        example_cleanup(docxml)
+        admonition_cleanup(docxml)
+      end
 
-    def table_long_strings_cleanup(docxml)
-      return unless @break_up_urls_in_tables == true
+      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?
+        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),
-                    ))
+            n.replace(HTMLEntities.new.encode(
+                        break_up_long_strings(n.text),
+                      ))
+          end
         end
       end
-    end
 
-    def break_up_long_strings(text)
-      return text if /^\s*$/.match?(text)
+      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
+          end
+        end.join
+      end
 
-      text.split(/(?=\s)/).map do |w|
-        if /^\s*$/.match(text) || (w.size < 30) then w
+      def break_up_long_strings1(text)
+        s = text.split(%r{(?<=[,.?+;/=])})
+        if s.size == 1 then "#{text} "
         else
-          w.scan(/.{,30}/).map do |w1|
-            w1.size < 30 ? w1 : break_up_long_strings1(w1)
-          end.join
+          s[-1] = " #{s[-1]}"
+          s.join
         end
-      end.join
-    end
-
-    def break_up_long_strings1(text)
-      s = text.split(%r{(?<=[,.?+;/=])})
-      if s.size == 1 then "#{text} "
-      else
-        s[-1] = " #{s[-1]}"
-        s.join
       end
-    end
 
-    def admonition_cleanup(docxml)
-      docxml.xpath("//div[@class = 'Admonition'][title]").each do |d|
-        title = d.at("./title")
-        n = title.next_element
-        n&.children&.first&.add_previous_sibling(title.remove.text + "&mdash;")
+      def admonition_cleanup(docxml)
+        docxml.xpath("//div[@class = 'Admonition'][title]").each do |d|
+          title = d.at("./title")
+          n = title.next_element
+          n&.children&.first
+            &.add_previous_sibling("#{title.remove.text}&mdash;")
+        end
+        docxml
       end
-      docxml
-    end
 
-    def example_cleanup(docxml)
-      docxml.xpath("//table[@class = 'example']//p[not(@class)]").each do |p|
-        p["class"] = "example"
+      def example_cleanup(docxml)
+        docxml.xpath("//table[@class = 'example']//p[not(@class)]").each do |p|
+          p["class"] = "example"
+        end
+        docxml
       end
-      docxml
-    end
 
-    def figure_get_or_make_dl(elem)
-      dl = elem.at(".//dl")
-      if dl.nil?
-        elem.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
+      def figure_get_or_make_dl(elem)
         dl = elem.at(".//dl")
+        if dl.nil?
+          elem.add_child("<p><b>#{@i18n.key}</b></p><dl></dl>")
+          dl = elem.at(".//dl")
+        end
+        dl
       end
-      dl
-    end
 
-    FIGURE_WITH_FOOTNOTES =
-      "//div[@class = 'figure'][descendant::aside]"\
-      "[not(descendant::div[@class = 'figure'])]".freeze
-
-    def figure_aside_process(elem, aside, key)
-      # get rid of footnote link, it is in diagram
-      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
-      aside.xpath(".//p").each do |a|
-        a.delete("class")
-        a.parent = dd
+      FIGURE_WITH_FOOTNOTES =
+        "//div[@class = 'figure'][descendant::aside]"\
+        "[not(descendant::div[@class = 'figure'])]".freeze
+
+      def figure_aside_process(elem, aside, key)
+        # get rid of footnote link, it is in diagram
+        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
+        aside.xpath(".//p").each do |a|
+          a.delete("class")
+          a.parent = dd
+        end
       end
-    end
 
-    # move footnotes into key, and get rid of footnote reference
-    # since it is in diagram
-    def figure_cleanup(docxml)
-      docxml.xpath(FIGURE_WITH_FOOTNOTES).each do |f|
-        next unless f.at(".//aside[not(ancestor::p[@class = 'FigureTitle'])]")
+      # move footnotes into key, and get rid of footnote reference
+      # since it is in diagram
+      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)
+          key = figure_get_or_make_dl(f)
+          f.xpath(".//aside").each do |aside|
+            figure_aside_process(f, aside, key)
+          end
         end
+        docxml
       end
-      docxml
-    end
 
-    def inline_header_cleanup(docxml)
-      docxml.xpath('//span[@class="zzMoveToFollowing"]').each do |x|
-        x.delete("class")
-        n = x.next_element
-        if n.nil?
-          x.name = "p"
-        else
-          n.children.first.previous = x.remove
+      def inline_header_cleanup(docxml)
+        docxml.xpath('//span[@class="zzMoveToFollowing"]').each do |x|
+          x.delete("class")
+          n = x.next_element
+          if n.nil?
+            x.name = "p"
+          else
+            n.children.first.previous = x.remove
+          end
         end
+        docxml
       end
-      docxml
-    end
 
-    def footnote_cleanup(docxml)
-      docxml.xpath('//a[@class = "FootnoteRef"]/sup').each_with_index do |x, i|
-        x.content = (i + 1).to_s
+      def footnote_cleanup(docxml)
+        docxml.xpath('//a[@class = "FootnoteRef"]/sup')
+          .each_with_index do |x, i|
+          x.content = (i + 1).to_s
+        end
+        docxml
       end
-      docxml
-    end
 
-    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
+      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|
-          merge_fnref_into_fn_text(a)
-          a.name = "div"
-          a["class"] = "TableFootnote"
-          t << a.remove
+      # 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|
+            merge_fnref_into_fn_text(a)
+            a.name = "div"
+            a["class"] = "TableFootnote"
+            t << a.remove
+          end
+        end
+        docxml.xpath("//p[not(self::*[@class])]"\
+                     "[ancestor::*[@class = 'TableFootnote']]").each do |p|
+          p["class"] = "TableFootnote"
         end
       end
-      docxml.xpath("//p[not(self::*[@class])]"\
-                   "[ancestor::*[@class = 'TableFootnote']]").each do |p|
-        p["class"] = "TableFootnote"
-      end
-    end
 
-    def remove_bottom_border(cell)
-      cell["style"] =
-        cell["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
-    end
+      def remove_bottom_border(cell)
+        cell["style"] =
+          cell["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
+      end
 
-    def table_get_or_make_tfoot(table)
-      tfoot = table.at(".//tfoot")
-      if tfoot.nil?
-        table.add_child("<tfoot></tfoot>")
+      def table_get_or_make_tfoot(table)
         tfoot = table.at(".//tfoot")
-      else
-        tfoot.xpath(".//td | .//th").each { |td| remove_bottom_border(td) }
+        if tfoot.nil?
+          table.add_child("<tfoot></tfoot>")
+          tfoot = table.at(".//tfoot")
+        else
+          tfoot.xpath(".//td | .//th").each { |td| remove_bottom_border(td) }
+        end
+        tfoot
       end
-      tfoot
-    end
 
-    def new_fullcolspan_row(table, tfoot)
-      # how many columns in the table?
-      cols = 0
-      table.at(".//tr").xpath("./td | ./th").each do |td|
-        cols += (td["colspan"] ? td["colspan"].to_i : 1)
+      def new_fullcolspan_row(table, tfoot)
+        # how many columns in the table?
+        cols = 0
+        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;}
+        tfoot.add_child("<tr><td colspan='#{cols}' style='#{style}'/></tr>")
+        tfoot.xpath(".//td").last
       end
-      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
 
-    def table_note_cleanup(docxml)
-      docxml.xpath("//table[div[@class = 'Note' or "\
-                   "@class = 'TableFootnote']]").each do |t|
-        tfoot = table_get_or_make_tfoot(t)
-        insert_here = new_fullcolspan_row(t, tfoot)
-        t.xpath("div[@class = 'Note' or @class = 'TableFootnote']").each do |d|
-          d.parent = insert_here
+      def table_note_cleanup(docxml)
+        docxml.xpath("//table[div[@class = 'Note' or "\
+                     "@class = 'TableFootnote']]").each do |t|
+          tfoot = table_get_or_make_tfoot(t)
+          insert_here = new_fullcolspan_row(t, tfoot)
+          t.xpath("div[@class = 'Note' or @class = 'TableFootnote']")
+            .each do |d|
+            d.parent = insert_here
+          end
         end
       end
-    end
 
-    def table_cleanup(docxml)
-      table_footnote_cleanup(docxml)
-      table_note_cleanup(docxml)
-      table_long_strings_cleanup(docxml)
-      docxml
-    end
+      def table_cleanup(docxml)
+        table_footnote_cleanup(docxml)
+        table_note_cleanup(docxml)
+        table_long_strings_cleanup(docxml)
+        docxml
+      end
 
-    def symbols_cleanup(docxml); end
+      def symbols_cleanup(docxml); end
 
-    def table_footnote_reference_format(link)
-      link
-    end
+      def table_footnote_reference_format(link)
+        link
+      end
 
-    def footnote_reference_format(link)
-      link
+      def footnote_reference_format(link)
+        link
+      end
     end
   end
 end