html2doc 1.0.6 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed67d44964092ea651bf40f1e7d4843d9ed84b9e2e3c9a8fe51c77e6ed1b4e8c
-  data.tar.gz: 2bc1662270ac499f54710568ae9ed31f78113556278a0f34510d30683a08b48a
+  metadata.gz: 64215843fa5fb0918c0c24d6023f466b3602d36fe155ff49687f2a9e447e6681
+  data.tar.gz: 2fd0022ce58dd6106f27825b593b7d6c632913414699067cc70ba09936d47810
 SHA512:
-  metadata.gz: 5503cb2408a86644d3481b82002fba01f333a841ff0de0113cdd15de99984fd6aa458ba8af82e521d3fdce79d6f27aae69b9a760be66e85b8de874681710c36b
-  data.tar.gz: b48073035e3000fa1cfc9b3eabf1a5d3e5e2f79dd61aa20881b73cb186d75a69c01e8c7951016bf7a997ab6b7e5911ad2e69b845ecc0783b15aeaa54c6f4f55a
+  metadata.gz: fc525ead15dbbdbfede252026ae44451cd5b45fe8225c70cdefcccafd3e5a903a32d8e6dfdb396f67c58d11e8b2c48a36562bf8e4f439181f99a8f49b3799202
+  data.tar.gz: 243b6c5efa00090e1248ad420d9641882fcc956fb8734333267459db9dbaffbf0742488164f4c72975ce4bb9b4e62458eb0c0d5dc03bb3cd7990863d77ba40a3

data/.github/workflows/rake.yml

@@ -0,0 +1,42 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '3.0'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '3.0'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.rubocop-https--*

data/.rubocop.yml

@@ -1,10 +1,12 @@
 # This project follows the Ribose OSS style guide.
 # https://github.com/riboseinc/oss-guides
 # All project-specific additions and overrides should be specified in this file.
-
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
 AllCops:
-  TargetRubyVersion: 2.3
-Rails:
-  Enabled: true
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4

data/Gemfile

@@ -10,6 +10,6 @@ end
 
 gemspec
 
-if File.exist? 'Gemfile.devel'
-  eval File.read('Gemfile.devel'), nil, 'Gemfile.devel' # rubocop:disable Security/Eval
+if File.exist? "Gemfile.devel"
+  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
 end

data/README.adoc

@@ -3,9 +3,7 @@
 https://github.com/metanorma/html2doc/workflows/main/badge.svg
 
 image:https://img.shields.io/gem/v/html2doc.svg["Gem Version", link="https://rubygems.org/gems/html2doc"]
-image:https://github.com/metanorma/html2doc/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/html2doc/actions?query=workflow%3Aubuntu"]
-image:https://github.com/metanorma/html2doc/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/html2doc/actions?query=workflow%3Amacos"]
-image:https://github.com/metanorma/html2doc/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/html2doc/actions?query=workflow%3Awindows"]
+image:https://github.com/metanorma/html2doc/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/html2doc/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/html2doc/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/html2doc"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/html2doc.svg["Pull Requests", link="https://github.com/metanorma/html2doc/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/html2doc/latest.svg["Commits since latest",link="https://github.com/metanorma/html2doc/releases"]

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/html2doc

@@ -21,9 +21,8 @@ if ARGV.length < 1
 end
 
 Html2Doc.process(
-  File.read(ARGV[0], encoding: "utf-8"), 
+  File.read(ARGV[0], encoding: "utf-8"),
   filename: ARGV[0].gsub(/\.html?$/, ""),
   stylesheet: options[:stylesheet],
   header: options[:header],
 )
-                 

data/bin/rspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-  
+
 # This file was generated by Bundler.
 #
 # The application 'rspec' is installed as part of a gem, and

data/html2doc.gemspec

@@ -1,5 +1,4 @@
-
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "html2doc/version"
 
@@ -16,8 +15,8 @@ Gem::Specification.new do |spec|
     This gem is in active development.
   DESCRIPTION
 
-  spec.homepage      = "https://github.com/metanorma/html2doc"
-  spec.licenses       = ["CC-BY-SA-3.0", "BSD-2-Clause"]
+  spec.homepage = "https://github.com/metanorma/html2doc"
+  spec.licenses = ["CC-BY-SA-3.0", "BSD-2-Clause"]
 
   spec.bindir        = "bin"
   spec.require_paths = ["lib"]
@@ -25,14 +24,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
+  spec.add_dependency "asciimath", "~> 2.0.2"
   spec.add_dependency "htmlentities", "~> 4.3.4"
   spec.add_dependency "image_size"
   spec.add_dependency "mime-types"
-  spec.add_dependency "nokogiri", ">= 1.10.4"
+  spec.add_dependency "nokogiri", "~> 1.10"
+  spec.add_dependency "plane1converter", "~> 0.0.1"
   spec.add_dependency "thread_safe"
   spec.add_dependency "uuidtools"
-  spec.add_dependency "asciimath", "~> 2.0.0"
-  spec.add_dependency "plane1converter", "~> 0.0.1"
 
   spec.add_development_dependency "byebug", "~> 9.1"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
@@ -40,8 +39,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "= 0.54.0"
+  spec.add_development_dependency "rspec-match_fuzzy", "~> 0.1.3"
+  spec.add_development_dependency "rubocop", "~> 1.5.2"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "rspec-match_fuzzy", "~> 0.1.3"
 end

data/lib/html2doc.rb

@@ -4,6 +4,3 @@ require_relative "html2doc/mime"
 require_relative "html2doc/notes"
 require_relative "html2doc/math"
 require_relative "html2doc/lists"
-#require_relative "asciimath/parser"
-#require_relative "asciimath/mathml"
-#require_relative "asciimath/html"

data/lib/html2doc/base.rb

@@ -2,8 +2,6 @@ require "uuidtools"
 require "asciimath"
 require "htmlentities"
 require "nokogiri"
-#require "xml/xslt"
-require "pp"
 require "fileutils"
 
 module Html2Doc
@@ -19,16 +17,26 @@ module Html2Doc
 
   def self.process_header(headerfile, hash)
     return if headerfile.nil?
+
     doc = File.read(headerfile, encoding: "utf-8")
-    doc = header_image_cleanup(doc, hash[:dir1], hash[:filename], File.dirname(hash[:filename]))
+    doc = header_image_cleanup(doc, hash[:dir1], hash[:filename],
+                               File.dirname(hash[:filename]))
     File.open("#{hash[:dir1]}/header.html", "w:UTF-8") { |f| f.write(doc) }
   end
 
+  def self.clear_dir(dir)
+    Dir.foreach(dir) do |f|
+      fn = File.join(dir, f)
+      File.delete(fn) if f != "." && f != ".."
+    end
+    dir
+  end
+
   def self.create_dir(filename, dir)
-    return dir if dir
+    dir and return clear_dir(dir)
     dir = "#{filename}_files"
     Dir.mkdir(dir) unless File.exists?(dir)
-    dir
+    clear_dir(dir)
   end
 
   def self.process_html(result, hash)
@@ -64,7 +72,7 @@ module Html2Doc
 
   def self.to_xhtml(xml)
     xml.gsub!(/<\?xml[^>]*>/, "")
-    unless /<!DOCTYPE /.match xml
+    unless /<!DOCTYPE /.match? xml
       xml = '<!DOCTYPE html SYSTEM
           "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' + xml
     end
@@ -76,34 +84,35 @@ module Html2Doc
   DOCTYPE
 
   def self.from_xhtml(xml)
-    xml.to_xml.sub(%{ xmlns="http://www.w3.org/1999/xhtml"}, "").
-      sub(DOCTYPE, "").
-      gsub(%{ />}, "/>")
+    xml.to_xml.sub(%{ xmlns="http://www.w3.org/1999/xhtml"}, "")
+      .sub(DOCTYPE, "")
+      .gsub(%{ />}, "/>")
   end
 
-  def self.msword_fix(r)
+  def self.msword_fix(doc)
     # brain damage in MSWord parser
-    r.gsub!(%r{<span style="mso-special-character:footnote"/>},
-            '<span style="mso-special-character:footnote"></span>')
-    r.gsub!(%r{<div style="mso-element:footnote-list"></div>},
-            '<div style="mso-element:footnote-list"/>')
-    r.gsub!(%r{(<a style="mso-comment-reference:[^>/]+)/>}, "\\1></a>")
-    r.gsub!(%r{<link rel="File-List"}, "<link rel=File-List")
-    r.gsub!(%r{<meta http-equiv="Content-Type"},
-            "<meta http-equiv=Content-Type")
-    r.gsub!(%r{></m:jc>}, "/>")
-    r.gsub!(%r{></v:stroke>}, "/>")
-    r.gsub!(%r{></v:f>}, "/>")
-    r.gsub!(%r{></v:path>}, "/>")
-    r.gsub!(%r{></o:lock>}, "/>")
-    r.gsub!(%r{></v:imagedata>}, "/>")
-    r.gsub!(%r{></w:wrap>}, "/>")
-    r.gsub!(%r{&tab;|&amp;tab;}, '<span style="mso-tab-count:1">&#xA0; </span>')
-    r = r.split(%r{(<m:oMath>|</m:oMath>)}).each_slice(4).map do |a|
+    doc.gsub!(%r{<span style="mso-special-character:footnote"/>},
+              '<span style="mso-special-character:footnote"></span>')
+    doc.gsub!(%r{<div style="mso-element:footnote-list"></div>},
+              '<div style="mso-element:footnote-list"/>')
+    doc.gsub!(%r{(<a style="mso-comment-reference:[^>/]+)/>}, "\\1></a>")
+    doc.gsub!(%r{<link rel="File-List"}, "<link rel=File-List")
+    doc.gsub!(%r{<meta http-equiv="Content-Type"},
+              "<meta http-equiv=Content-Type")
+    doc.gsub!(%r{></m:jc>}, "/>")
+    doc.gsub!(%r{></v:stroke>}, "/>")
+    doc.gsub!(%r{></v:f>}, "/>")
+    doc.gsub!(%r{></v:path>}, "/>")
+    doc.gsub!(%r{></o:lock>}, "/>")
+    doc.gsub!(%r{></v:imagedata>}, "/>")
+    doc.gsub!(%r{></w:wrap>}, "/>")
+    doc.gsub!(%r{<(/)?m:(span|em)\b}, "<\\1\\2")
+    doc.gsub!(%r{&tab;|&amp;tab;},
+              '<span style="mso-tab-count:1">&#xA0; </span>')
+    doc.split(%r{(<m:oMath>|</m:oMath>)}).each_slice(4).map do |a|
       a.size > 2 and a[2] = a[2].gsub(/>\s+</, "><")
       a
     end.join
-    r
   end
 
   PRINT_VIEW = <<~XML.freeze
@@ -119,29 +128,30 @@ module Html2Doc
     <meta http-equiv=Content-Type content="text/html; charset=utf-8"/>
   XML
 
-  def self.define_head1(docxml, dir)
+  def self.define_head1(docxml, _dir)
     docxml.xpath("//*[local-name() = 'head']").each do |h|
       h.children.first.add_previous_sibling <<~XML
-      #{PRINT_VIEW}
-        <link rel="File-List" href="#{File.basename(dir)}/filelist.xml"/>
+        #{PRINT_VIEW}
+          <link rel="File-List" href="cid:filelist.xml"/>
       XML
     end
   end
 
-  def self.filename_substitute(stylesheet, header_filename, filename)
-    if header_filename.nil?
-      stylesheet.gsub!(/\n[^\n]*FILENAME[^\n]*i\n/, "\n")
-    else
-      stylesheet.gsub!(/FILENAME/, File.basename(filename))
+  def self.filename_substitute(head, header_filename)
+    return if header_filename.nil?
+
+    head.xpath(".//*[local-name() = 'style']").each do |s|
+      s1 = s.to_xml.gsub(/url\("[^"]+"\)/) do |m|
+        /FILENAME/.match?(m) ? "url(cid:header.html)" : m
+      end
+      s.replace(s1)
     end
-    stylesheet
   end
 
-  def self.stylesheet(filename, header_filename, fn)
-    (fn.nil? || fn.empty?) &&
+  def self.stylesheet(_filename, _header_filename, fn)
+    (fn.nil? || fn.empty?) and
       fn = File.join(File.dirname(__FILE__), "wordstyle.css")
     stylesheet = File.read(fn, encoding: "UTF-8")
-    stylesheet = filename_substitute(stylesheet, header_filename, filename)
     xml = Nokogiri::XML("<style/>")
     xml.children.first << Nokogiri::XML::Comment.new(xml, "\n#{stylesheet}\n")
     xml.root.to_s
@@ -152,6 +162,7 @@ module Html2Doc
     head = docxml.at("//*[local-name() = 'head']")
     css = stylesheet(hash[:filename], hash[:header_file], hash[:stylesheet])
     add_stylesheet(head, title, css)
+    filename_substitute(head, hash[:header_file])
     define_head1(docxml, hash[:dir1])
     rootnamespace(docxml.root)
   end
@@ -180,13 +191,13 @@ module Html2Doc
   end
 
   def self.bookmarks(docxml)
-    docxml.xpath("//*[@id][not(@name)][not(@style = 'mso-element:footnote')]").each do |x|
-      next if x["id"].empty?
-      next if %w(shapetype v:shapetype shape v:shape).include? x.name
-      if x.children.empty?
-        x.add_child("<a name='#{x["id"]}'></a>")
-      else
-        x.children.first.previous = "<a name='#{x["id"]}'></a>"
+    docxml.xpath("//*[@id][not(@name)][not(@style = 'mso-element:footnote')]")
+      .each do |x|
+      next if x["id"].empty? ||
+        %w(shapetype v:shapetype shape v:shape).include?(x.name)
+
+      if x.children.empty? then x.add_child("<a name='#{x['id']}'></a>")
+      else x.children.first.previous = "<a name='#{x['id']}'></a>"
       end
       x.delete("id")
     end

data/lib/html2doc/lists.rb

@@ -2,83 +2,87 @@ require "uuidtools"
 require "asciimath"
 require "htmlentities"
 require "nokogiri"
-require "uuidtools"
 
 module Html2Doc
-  def self.style_list(li, level, liststyle, listnumber)
+  def self.style_list(elem, level, liststyle, listnumber)
     return unless liststyle
-    if li["style"]
-      li["style"] += ";"
+
+    if elem["style"]
+      elem["style"] += ";"
     else
-      li["style"] = ""
+      elem["style"] = ""
     end
-    li["style"] += "mso-list:#{liststyle} level#{level} lfo#{listnumber};"
+    elem["style"] += "mso-list:#{liststyle} level#{level} lfo#{listnumber};"
   end
 
-  def self.list_add1(li, liststyles, listtype, level)
-    if [:ul, :ol].include? listtype
-          list_add(li.xpath(".//ul") - li.xpath(".//ul//ul | .//ol//ul"),
-                   liststyles, :ul, level + 1)
-          list_add(li.xpath(".//ol") - li.xpath(".//ul//ol | .//ol//ol"),
-                   liststyles, :ol, level + 1)
-        else
-          list_add(li.xpath(".//ul") - li.xpath(".//ul//ul | .//ol//ul"),
-                   liststyles, listtype, level + 1)
-          list_add(li.xpath(".//ol") - li.xpath(".//ul//ol | .//ol//ol"),
-                   liststyles, listtype, level + 1)
-        end
+  def self.list_add1(elem, liststyles, listtype, level)
+    if %i[ul ol].include? listtype
+      list_add(elem.xpath(".//ul") - elem.xpath(".//ul//ul | .//ol//ul"),
+               liststyles, :ul, level + 1)
+      list_add(elem.xpath(".//ol") - elem.xpath(".//ul//ol | .//ol//ol"),
+               liststyles, :ol, level + 1)
+    else
+      list_add(elem.xpath(".//ul") - elem.xpath(".//ul//ul | .//ol//ul"),
+               liststyles, listtype, level + 1)
+      list_add(elem.xpath(".//ol") - elem.xpath(".//ul//ol | .//ol//ol"),
+               liststyles, listtype, level + 1)
+    end
   end
 
   def self.list_add(xpath, liststyles, listtype, level)
-    xpath.each_with_index do |list, i|
+    xpath.each_with_index do |l, _i|
       @listnumber += 1 if level == 1
-      list["seen"] = true if level == 1
-      list["id"] ||= UUIDTools::UUID.random_create
-      (list.xpath(".//li") - list.xpath(".//ol//li | .//ul//li")).each do |li|
+      l["seen"] = true if level == 1
+      l["id"] ||= UUIDTools::UUID.random_create
+      (l.xpath(".//li") - l.xpath(".//ol//li | .//ul//li")).each do |li|
         style_list(li, level, liststyles[listtype], @listnumber)
         list_add1(li, liststyles, listtype, level)
       end
-      list.xpath(".//ul[not(ancestor::li/ancestor::*/@id = '#{list['id']}')] | "\
-                 ".//ol[not(ancestor::li/ancestor::*/@id = '#{list['id']}')]").each do |li|
-        list_add1(li.parent, liststyles, listtype, level-1)
+      l.xpath(".//ul[not(ancestor::li/ancestor::*/@id = '#{l['id']}')] | "\
+              ".//ol[not(ancestor::li/ancestor::*/@id = '#{l['id']}')]")
+        .each do |li|
+        list_add1(li.parent, liststyles, listtype, level - 1)
       end
     end
   end
 
-  def self.list2para(u)
-    return if u.xpath("./li").empty?
-    u.xpath("./li").first["class"] ||= "MsoListParagraphCxSpFirst"
-    u.xpath("./li").last["class"] ||= "MsoListParagraphCxSpLast"
-    u.xpath("./li/p").each { |p| p["class"] ||= "MsoListParagraphCxSpMiddle" }
-    u.xpath("./li").each do |l|
+  def self.list2para(list)
+    return if list.xpath("./li").empty?
+
+    list.xpath("./li").first["class"] ||= "MsoListParagraphCxSpFirst"
+    list.xpath("./li").last["class"] ||= "MsoListParagraphCxSpLast"
+    list.xpath("./li/p").each { |p| p["class"] ||= "MsoListParagraphCxSpMiddle" }
+    list.xpath("./li").each do |l|
       l.name = "p"
       l["class"] ||= "MsoListParagraphCxSpMiddle"
       l&.first_element_child&.name == "p" and
         l.first_element_child.replace(l.first_element_child.children)
     end
-    u.replace(u.children)
+    list.replace(list.children)
   end
 
   TOPLIST = "[not(ancestor::ul) and not(ancestor::ol)]".freeze
 
-  def self.lists1(docxml, liststyles, k)
-    case k
+  def self.lists1(docxml, liststyles, style)
+    case style
     when :ul then list_add(docxml.xpath("//ul[not(@class)]#{TOPLIST}"),
-                            liststyles, :ul, 1)
+                           liststyles, :ul, 1)
     when :ol then list_add(docxml.xpath("//ol[not(@class)]#{TOPLIST}"),
                            liststyles, :ol, 1)
     else
-      list_add(docxml.xpath("//ol[@class = '#{k.to_s}']#{TOPLIST} | "\
-                            "//ul[@class = '#{k.to_s}']#{TOPLIST}"),
-      liststyles, k, 1)
+      list_add(docxml.xpath("//ol[@class = '#{style}']#{TOPLIST} | "\
+                            "//ul[@class = '#{style}']#{TOPLIST}"),
+      liststyles, style, 1)
     end
   end
 
   def self.lists_unstyled(docxml, liststyles)
-    list_add(docxml.xpath("//ul#{TOPLIST}[not(@seen)]"),
-             liststyles, :ul, 1) if liststyles.has_key?(:ul)
-    list_add(docxml.xpath("//ol#{TOPLIST}[not(@seen)]"),
-             liststyles, :ul, 1) if liststyles.has_key?(:ol)
+    liststyles.has_key?(:ul) and
+      list_add(docxml.xpath("//ul#{TOPLIST}[not(@seen)]"),
+               liststyles, :ul, 1)
+    liststyles.has_key?(:ol) and
+      list_add(docxml.xpath("//ol#{TOPLIST}[not(@seen)]"),
+               liststyles, :ul, 1)
     docxml.xpath("//ul[@seen] | //ol[@seen]").each do |l|
       l.delete("seen")
     end
@@ -86,6 +90,7 @@ module Html2Doc
 
   def self.lists(docxml, liststyles)
     return if liststyles.nil?
+
     @listnumber = 0
     liststyles.each_key { |k| lists1(docxml, liststyles, k) }
     lists_unstyled(docxml, liststyles)