RubyGems - isodoc - Versions diffs - 1.6.3 → 1.6.4 - Mend

isodoc 1.6.3 → 1.6.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

checksums.yaml +4 -4
data/.github/workflows/rake.yml +2 -12
data/.hound.yml +3 -1
data/.rubocop.yml +3 -5
data/isodoc.gemspec +1 -1
data/lib/isodoc.rb +0 -2
data/lib/isodoc/convert.rb +4 -0
data/lib/isodoc/function/cleanup.rb +52 -43
data/lib/isodoc/function/inline.rb +7 -7
data/lib/isodoc/function/section.rb +29 -16
data/lib/isodoc/function/to_word_html.rb +6 -3
data/lib/isodoc/function/utils.rb +181 -163
data/lib/isodoc/headlesshtml_convert.rb +8 -7
data/lib/isodoc/html_function/comments.rb +2 -0
data/lib/isodoc/html_function/footnotes.rb +14 -7
data/lib/isodoc/html_function/html.rb +30 -26
data/lib/isodoc/html_function/postprocess.rb +16 -13
data/lib/isodoc/pdf_convert.rb +11 -13
data/lib/isodoc/presentation_function/bibdata.rb +43 -22
data/lib/isodoc/presentation_function/inline.rb +20 -15
data/lib/isodoc/version.rb +1 -1
data/lib/isodoc/word_function/postprocess.rb +50 -36
data/lib/isodoc/xref/xref_gen_seq.rb +60 -35
data/lib/isodoc/xref/xref_sect_gen.rb +4 -4
data/spec/assets/scripts_override.html +3 -0
data/spec/isodoc/blocks_spec.rb +196 -245
data/spec/isodoc/inline_spec.rb +442 -289
data/spec/isodoc/postproc_spec.rb +111 -50
data/spec/isodoc/presentation_xml_spec.rb +354 -277
data/spec/isodoc/terms_spec.rb +83 -83
metadata +5 -4

data/lib/isodoc/function/to_word_html.rb CHANGED Viewed

@@ -21,9 +21,10 @@ module IsoDoc::Function
       filename = filepath.sub_ext("").sub(/\.presentation$/, "").to_s
       dir = init_dir(filename, debug)
       @filename = filename
-      @localdir = filepath.parent.to_s + "/"
+      @localdir = "#{filepath.parent}/"
       @sourcedir = @localdir
-      @sourcefilename and @sourcedir = Pathname.new(@sourcefilename).parent.to_s + "/"
+      @sourcefilename and
+        @sourcedir = "#{Pathname.new(@sourcefilename).parent}/"
       [filename, dir]
     end
@@ -47,7 +48,7 @@ module IsoDoc::Function
     # isodoc.css overrides any CSS injected by Html2Doc, which
     # is inserted before this CSS.
-    def define_head(head, filename, _dir)
+    def define_head(head, _filename, _dir)
       if @standardstylesheet
         head.style do |style|
           @standardstylesheet.open
@@ -128,6 +129,8 @@ module IsoDoc::Function
     end
     def boilerplate(node, out)
+      return if @bare
       boilerplate = node.at(ns("//boilerplate")) or return
       out.div **{ class: "authority" } do |s|
         boilerplate.children.each do |n|

data/lib/isodoc/function/utils.rb CHANGED Viewed

@@ -1,193 +1,211 @@
 # frozen_string_literal: true
-module IsoDoc::Function
-  module Utils
-    def date_range(date)
-      self.class.date_range(date)
-    end
+module IsoDoc
+  module Function
+    module Utils
+      def date_range(date)
+        self.class.date_range(date)
+      end
-    def ns(xpath)
-      self.class.ns(xpath)
-    end
+      def ns(xpath)
+        self.class.ns(xpath)
+      end
-    def insert_tab(out, n)
-      tab = %w(Hans Hant).include?(@script) ? "&#x3000;" : "&nbsp; "
-      [1..n].each { out << tab }
-    end
+      def insert_tab(out, count)
+        tab = %w(Hans Hant).include?(@script) ? "&#x3000;" : "&nbsp; "
+        [1..count].each { out << tab }
+      end
-    # add namespaces for Word fragments
-    NOKOHEAD = <<~HERE
-      <!DOCTYPE html SYSTEM
-      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-      <html xmlns="http://www.w3.org/1999/xhtml">
-      <head> <title></title> <meta charset="UTF-8" /> </head>
-      <body> </body> </html>
-    HERE
-    # block for processing XML document fragments as XHTML,
-    # to allow for HTMLentities
-    def noko(&block)
-      doc = ::Nokogiri::XML.parse(NOKOHEAD)
-      fragment = doc.fragment("")
-      ::Nokogiri::XML::Builder.with fragment, &block
-      fragment.to_xml(encoding: "US-ASCII").lines.map do |l|
-        l.gsub(/\s*\n/, "")
+      # add namespaces for Word fragments
+      NOKOHEAD = <<~HERE
+        <!DOCTYPE html SYSTEM
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+        <html xmlns="http://www.w3.org/1999/xhtml">
+        <head> <title></title> <meta charset="UTF-8" /> </head>
+        <body> </body> </html>
+      HERE
+      # block for processing XML document fragments as XHTML,
+      # to allow for HTMLentities
+      def noko(&block)
+        doc = ::Nokogiri::XML.parse(NOKOHEAD)
+        fragment = doc.fragment("")
+        ::Nokogiri::XML::Builder.with fragment, &block
+        fragment.to_xml(encoding: "US-ASCII").lines.map do |l|
+          l.gsub(/\s*\n/, "")
+        end
       end
-    end
-    def attr_code(attributes)
-      attributes = attributes.reject { |_, val| val.nil? }.map
-      attributes.map do |k, v|
-        [k, v.is_a?(String) ? HTMLEntities.new.decode(v) : v]
-      end.to_h
-    end
+      def attr_code(attributes)
+        attributes = attributes.reject { |_, val| val.nil? }.map
+        attributes.map do |k, v|
+          [k, v.is_a?(String) ? HTMLEntities.new.decode(v) : v]
+        end.to_h
+      end
-    DOCTYPE_HDR = '<!DOCTYPE html SYSTEM '\
-      '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
-    def to_xhtml(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("")
-      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)"
+      DOCTYPE_HDR = "<!DOCTYPE html SYSTEM "\
+        '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
+      def to_xhtml(xml)
+        xml = to_xhtml_prep(xml)
+        begin
+          Nokogiri::XML.parse(xml, &:strict)
+        rescue Nokogiri::XML::SyntaxError => e
+          File.open("#{@filename}.#{@format}.err", "w:UTF-8") do |f|
+            f.write xml
+          end
+          abort "Malformed Output XML for #{@format}: #{e} "\
+            "(see #{@filename}.#{@format}.err)"
+        end
       end
-    end
-    def to_xhtml_fragment(xml)
-      doc = ::Nokogiri::XML.parse(NOKOHEAD)
-      fragment = doc.fragment(xml)
-      fragment
-    end
+      def to_xhtml_prep(xml)
+        xml.gsub!(/<\?xml[^>]*>/, "")
+        /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml)
+        xml.split(/(&[^ \r\n\t#;]+;)/).map do |t|
+          if /^(&[^ \t\r\n#;]+;)/.match?(t)
+            HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal)
+          else t
+          end
+        end.join("")
+      end
-    def from_xhtml(xml)
-      xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")
-    end
+      def to_xhtml_fragment(xml)
+        doc = ::Nokogiri::XML.parse(NOKOHEAD)
+        doc.fragment(xml)
+      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 "\
-      "local-name() = 'clause' or local-name() = 'references']/@id"
-    def get_clause_id(node)
-      clause = node.xpath(CLAUSE_ANCESTOR)
-      clause&.last&.text || nil
-    end
+      def from_xhtml(xml)
+        xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")
+      end
-    NOTE_CONTAINER_ANCESTOR =
-      ".//ancestor::*[local-name() = 'annex' or "\
-      "local-name() = 'foreword' or local-name() = 'appendix' or "\
-      "local-name() = 'introduction' or local-name() = 'terms' or "\
-      "local-name() = 'acknowledgements' or local-name() = 'term' or "\
-      "local-name() = 'clause' or local-name() = 'references' or "\
-      "local-name() = 'figure' or local-name() = 'formula' or "\
-      "local-name() = 'table' or local-name() = 'example']/@id"
-    def get_note_container_id(node)
-      container = node.xpath(NOTE_CONTAINER_ANCESTOR)
-      container&.last&.text || nil
-    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 "\
+        "local-name() = 'clause' or local-name() = 'references']/@id"
+      def get_clause_id(node)
+        clause = node.xpath(CLAUSE_ANCESTOR)
+        clause&.last&.text || nil
+      end
-    def sentence_join(array)
-      return '' if array.nil? || array.empty?
-      if array.length == 1 then array[0]
-      else
-        @i18n.l10n("#{array[0..-2].join(', ')} "\
-                   "#{@i18n.and} #{array.last}",
-                   @lang, @script)
+      NOTE_CONTAINER_ANCESTOR =
+        ".//ancestor::*[local-name() = 'annex' or "\
+        "local-name() = 'foreword' or local-name() = 'appendix' or "\
+        "local-name() = 'introduction' or local-name() = 'terms' or "\
+        "local-name() = 'acknowledgements' or local-name() = 'term' or "\
+        "local-name() = 'clause' or local-name() = 'references' or "\
+        "local-name() = 'figure' or local-name() = 'formula' or "\
+        "local-name() = 'table' or local-name() = 'example']/@id"
+      def get_note_container_id(node)
+        container = node.xpath(NOTE_CONTAINER_ANCESTOR)
+        container&.last&.text || nil
       end
-    end
-    # avoid `; avoid {{ (Liquid Templates); avoid [[ (Javascript)
-    def extract_delims(text)
-      @openmathdelim = "(#("
-      @closemathdelim = ")#)"
-      while text.include?(@openmathdelim) || text.include?(@closemathdelim)
-        @openmathdelim += "("
-        @closemathdelim += ")"
+      def sentence_join(array)
+        return "" if array.nil? || array.empty?
+        if array.length == 1 then array[0]
+        else
+          @i18n.l10n("#{array[0..-2].join(', ')} "\
+                     "#{@i18n.and} #{array.last}",
+                     @lang, @script)
+        end
       end
-      [@openmathdelim, @closemathdelim]
-    end
-    def header_strip(h)
-      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 == "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
+      # avoid `; avoid {{ (Liquid Templates); avoid [[ (Javascript)
+      def extract_delims(text)
+        @openmathdelim = "(#("
+        @closemathdelim = ")#)"
+        while text.include?(@openmathdelim) || text.include?(@closemathdelim)
+          @openmathdelim += "("
+          @closemathdelim += ")"
+        end
+        [@openmathdelim, @closemathdelim]
+      end
-    def liquid(doc)
-      self.class.liquid(doc)
-    end
+      def header_strip(hdr)
+        h1 = to_xhtml_fragment(hdr.to_s.gsub(%r{<br\s*/>}, " ")
+          .gsub(/<\/?h[123456][^>]*>/, "").gsub(/<\/?b[^>]*>/, "").dup)
+        h1.traverse do |x|
+          if x.name == "span" && /mso-tab-count/.match(x["style"])
+            x.replace(" ")
+          elsif header_strip_elem?(x) then x.remove
+          elsif x.name == "a" then x.replace(x.children)
+          end
+        end
+        from_xhtml(h1)
+      end
-    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("")
-      Liquid::Template.parse(doc)
-    end
+      def header_strip_elem?(elem)
+        elem.name == "img" ||
+          elem.name == "span" && elem["class"] == "MsoCommentReference" ||
+          elem.name == "a" && elem["class"] == "FootnoteRef" ||
+          elem.name == "span" && /mso-bookmark/.match(elem["style"])
+      end
-    def empty2nil(v)
-      return nil if !v.nil? && v.is_a?(String) && v.empty?
-      v
-    end
+=begin
+      def liquid(doc)
+        self.class.liquid(doc)
+      end
+=end
+      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("")
+        Liquid::Template.parse(doc)
+      end
-    def populate_template(docxml, _format = nil)
-      meta = @meta
-        .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;")
-    end
+      def empty2nil(str)
+        return nil if !str.nil? && str.is_a?(String) && str.empty?
-    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|
-        f.binmode
-        f.write(Base64.strict_decode64(imgdata))
-        @tempfile_cache << f # persist to the end
-        f.path
+        str
       end
-    end
-    def image_localfile(i)
-      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"])
+      def populate_template(docxml, _format = nil)
+        meta = @meta
+          .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;")
       end
-    end
-    def labelled_ancestor(node)
-      !node.ancestors("example, requirement, recommendation, permission, "\
-                      "note, table, figure, sourcecode").empty?
+      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|
+          f.binmode
+          f.write(Base64.strict_decode64(imgdata))
+          @tempfile_cache << f # persist to the end
+          f.path
+        end
+      end
+      def image_localfile(img)
+        if /^data:/.match? img["src"]
+          save_dataimage(img["src"], false)
+        elsif %r{^([A-Z]:)?/}.match? img["src"]
+          img["src"]
+        else
+          File.join(@localdir, img["src"])
+        end
+      end
+      def labelled_ancestor(node)
+        !node.ancestors("example, requirement, recommendation, permission, "\
+                        "note, table, figure, sourcecode").empty?
+      end
     end
   end
 end

data/lib/isodoc/headlesshtml_convert.rb CHANGED Viewed

@@ -1,11 +1,10 @@
-require_relative "html_function/comments.rb"
-require_relative "html_function/footnotes.rb"
-require_relative "html_function/html.rb"
+require_relative "html_function/comments"
+require_relative "html_function/footnotes"
+require_relative "html_function/html"
 require "fileutils"
 module IsoDoc
   class HeadlessHtmlConvert < ::IsoDoc::Convert
     include HtmlFunction::Comments
     include HtmlFunction::Footnotes
     include HtmlFunction::Html
@@ -26,16 +25,18 @@ module IsoDoc
       docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
       return result if debug
-      postprocess(result, filename + ".tmp.html", dir)
+      postprocess(result, "#{filename}.tmp.html", dir)
       FileUtils.rm_rf dir
-      strip_head(filename + ".tmp.html", output_filename || "#{filename}.#{@suffix}")
+      strip_head("#{filename}.tmp.html",
+                 output_filename || "#{filename}.#{@suffix}")
       FileUtils.rm_rf ["#{filename}.tmp.html", tmpimagedir]
     end
     def strip_head(input, output)
       file = File.read(input, encoding: "utf-8")
       doc = Nokogiri::XML(file)
-      doc.xpath("//head").each { |x| x.remove }
+      doc.xpath("//head").each(&:remove)
       doc.xpath("//html").each { |x| x.name = "div" }
       body = doc.at("//body")
       body.replace(body.children)

data/lib/isodoc/html_function/comments.rb CHANGED Viewed

@@ -84,6 +84,7 @@ module IsoDoc::HtmlFunction
     def comment_attributes(docxml, x)
       fromlink = docxml.at("//*[@id='#{x['from']}']")
       return(nil) if fromlink.nil?
       tolink = docxml.at("//*[@id='#{x['to']}']") || fromlink
       target = docxml.at("//*[@id='#{x['target']}']")
       { from: fromlink, to: tolink, target: target }
@@ -122,6 +123,7 @@ module IsoDoc::HtmlFunction
       comments = []
       docxml.xpath("//div[@style='mso-element:comment']").each do |c|
         next unless c["id"] && !link_order[c["id"]].nil?
         comments << { text: c.remove.to_s, id: c["id"] }
       end
       comments.sort! { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }