isodoc 0.5.5 → 0.5.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32b644d32aaf9d2170de736e389cec4a7b0b1a4d
-  data.tar.gz: afc5f22b859a533e4244758b80a3f4acc9658924
+  metadata.gz: de4c3e74196d5812243cf431a1d013c2f13ec687
+  data.tar.gz: 731a94da93e07e7494a7b565823f7c1904861996
 SHA512:
-  metadata.gz: 22698380e197c7f94fa0e690dfa181bc2312aa130aeab631fa6cd8ca515c1cd6c312b3f37b56823eef43d079c24ee1c2b539173c4dcd5f13c156dec975fdfce8
-  data.tar.gz: 6b95287839fe12f19e777cfdf62bc06b317247e79b1f6cf084b4ab6b938b561d763aebf9f6ec7bcd0ce280a3cea19ded061cd2fbb8e086c5591221ea9c768a4e
+  metadata.gz: d0464408db2c12b91837bb66a523e7f149b376ece67044d47a6d92b1a5dc7756bdc8bc13d49e084287ed5c8f6dc5569491ec3b856021e2d22c6831bfee9e2cfe
+  data.tar.gz: c3a5075be9cdb977ddc58787d857d1477c636fc037fe5cde78e2795c03e3450b515681a4751a7b2bb9db22b32c20a604272f6d9e2ed9537cd2bd24aead1ded09

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ronald.tse@ribose.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -15,7 +15,7 @@ standardsheet:: Stylesheet specific to Standard
 header:: Header file for Word
 htmlcoverpage:: Cover page for HTML
 wordcoverpage:: Cover page for Word
-tmlintropage:: Introductory page for HTML
+htmlintropage:: Introductory page for HTML
 wordintropage:: Introductory page for Word
 
 e.g.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/isodoc.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "uuidtools"
   spec.add_dependency "html2doc"
   spec.add_dependency "liquid"
+  spec.add_dependency "roman-numerals"
 
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "byebug", "~> 9.1"

data/lib/isodoc.rb

@@ -1,3 +1,5 @@
+module Isodoc
+
 require_relative "isodoc/version"
 
 require "nokogiri"
@@ -8,100 +10,7 @@ require "base64"
 require "mime/types"
 require "image_size"
 require "set"
-require_relative "isodoc/iso2wordhtml"
-require_relative "isodoc/cleanup"
-require_relative "isodoc/postprocessing"
-require_relative "isodoc/utils"
-require_relative "isodoc/metadata"
-require_relative "isodoc/section"
-require_relative "isodoc/references"
-require_relative "isodoc/terms"
-require_relative "isodoc/blocks"
-require_relative "isodoc/lists"
-require_relative "isodoc/table"
-require_relative "isodoc/inline"
-require_relative "isodoc/notes"
-require_relative "isodoc/xref_gen"
-require_relative "isodoc/html"
-require_relative "isodoc/i18n"
 require "pp"
-
-module IsoDoc
-  class Convert
-
-    # htmlstylesheet: Generic stylesheet for HTML
-    # wordstylesheet: Generic stylesheet for Word
-    # standardsheet: Stylesheet specific to Standard
-    # header: Header file for Word
-    # htmlcoverpage: Cover page for HTML
-    # wordcoverpage: Cover page for Word
-    # htmlintropage: Introductory page for HTML
-    # wordintropage: Introductory page for Word
-    # i18nyaml: YAML file for internationalisation of text
-    # ulstyle: list style in Word CSS for unordered lists
-    # olstyle: list style in Word CSS for ordered lists
-    def initialize(options)
-      @htmlstylesheet = options[:htmlstylesheet]
-      @wordstylesheet = options[:wordstylesheet]
-      @standardstylesheet = options[:standardstylesheet]
-      @header = options[:header]
-      @htmlcoverpage = options[:htmlcoverpage]
-      @wordcoverpage = options[:wordcoverpage]
-      @htmlintropage = options[:htmlintropage]
-      @wordintropage = options[:wordintropage]
-      @i18nyaml = options[:i18nyaml]
-      @ulstyle = options[:ulstyle]
-      @olstyle = options[:olstyle]
-      @termdomain = ""
-      @termexample = false
-      @note = false
-      @sourcecode = false
-      @anchors = {}
-      @meta = {}
-      init_metadata
-      @footnotes = []
-      @comments = []
-      @in_footnote = false
-      @in_comment = false
-      @in_table = false
-      @in_figure = false
-      @seen_footnote = Set.new
-      @c = HTMLEntities.new
-      @openmathdelim = "`"
-      @closemathdelim = "`"
-      @lang = "en"
-      @script = "Latn"
-    end
-
-    def convert1(docxml, filename, dir)
-      noko do |xml|
-        xml.html do |html|
-          html.parent.add_namespace("epub", "http://www.idpf.org/2007/ops")
-          html_header(html, docxml, filename, dir)
-          make_body(html, docxml)
-        end
-      end.join("\n")
-    end
-
-    def convert_init(file, filename, debug)
-      docxml = Nokogiri::XML(file)
-      filename, dir = init_file(filename, debug)
-      docxml.root.default_namespace = ""
-      i18n_init(docxml&.at(ns("//bibdata/language"))&.text || "en",
-                docxml&.at(ns("//bibdata/script"))&.text || "Latn")
-      [docxml, filename, dir]
-    end
-
-    def convert(filename, debug = false)
-      convert_file(File.read(filename), filename, debug)
-    end
-
-    def convert_file(file, filename, debug)
-      @openmathdelim, @closemathdelim = extract_delims(file)
-      docxml, filename, dir = convert_init(file, filename, debug)
-      result = convert1(docxml, filename, dir)
-      return result if debug
-      postprocess(result, filename, dir)
-    end
-  end
+require "isodoc/convert"
+require "isodoc/wordconvert/convert"
 end

data/lib/isodoc/cleanup.rb

@@ -19,7 +19,7 @@ module IsoDoc
       docxml.xpath("//div[@class = 'Admonition'][title]").each do |d|
         title = d.at("./title")
         n = title.next_element
-        n&.children&.first&.add_previous_sibling(title.text + "—")
+        n&.children&.first&.add_previous_sibling(title.remove.text + "—")
       end
       docxml
     end
@@ -39,7 +39,7 @@ module IsoDoc
 
     def figure_aside_process(f, aside, key)
       # get rid of footnote link, it is in diagram
-      f.at("./a[@class='TableFootnoteRef']").remove
+      f&.at("./a[@class='TableFootnoteRef']")&.remove
       fnref = f.at(".//a[@class='TableFootnoteRef']")
       dt = key.add_child("<dt></dt>").first
       dd = key.add_child("<dd></dd>").first
@@ -50,15 +50,16 @@ module IsoDoc
       end
     end
 
+    # move footnotes into key, and get rid of footnote reference
+    # since it is in diagram
     def figure_cleanup(docxml)
-      # move footnotes into key, and get rid of footnote reference
-      # since it is in diagram
       docxml.xpath(FIGURE_WITH_FOOTNOTES).each do |f|
         key = figure_get_or_make_dl(f)
         f.xpath(".//aside").each do |aside|
           figure_aside_process(f, aside, key)
         end
       end
+      docxml
     end
 
     def inline_header_cleanup(docxml)
@@ -71,6 +72,7 @@ module IsoDoc
           n.children.first.previous = x.remove
         end
       end
+      docxml
     end
 
     def footnote_cleanup(docxml)
@@ -99,8 +101,7 @@ module IsoDoc
 
     def remove_bottom_border(td)
       td["style"] =
-        td["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;").
-        gsub(/mso-border-bottom-alt:[^;]+;/, "mso-border-bottom-alt:0pt;")
+        td["style"].gsub(/border-bottom:[^;]+;/, "border-bottom:0pt;")
     end
 
     def table_get_or_make_tfoot(t)
@@ -120,8 +121,7 @@ module IsoDoc
       t.at(".//tr").xpath("./td | ./th").each do |td|
         cols += (td["colspan"] ? td["colspan"].to_i : 1)
       end
-      style = %{border-top:0pt;mso-border-top-alt:0pt;
-      border-bottom:#{SW} 1.5pt;mso-border-bottom-alt:#{SW} 1.5pt;}
+      style = %{border-top:0pt;border-bottom:#{SW} 1.5pt;}
       tfoot.add_child("<tr><td colspan='#{cols}' style='#{style}'/></tr>")
       tfoot.xpath(".//td").last
     end
@@ -142,9 +142,11 @@ module IsoDoc
     def table_cleanup(docxml)
       table_footnote_cleanup(docxml)
       table_note_cleanup(docxml)
+      docxml
     end
 
-    # We assume AsciiMath. Indices sort after letter but before any following
+    # We assume AsciiMath is being used in the terms & definitions. 
+    # Indices sort after letter but before any following
     # letter (x, x_m, x_1, xa); we use colon to force that sort order.
     # Numbers sort *after* letters; we use thorn to force that sort order.
     def symbol_key(x)
@@ -165,10 +167,12 @@ module IsoDoc
     end
 
     def symbols_cleanup(docxml)
-      dl = docxml.at("//div[@class = 'Symbols']/dl") || return
+      dl = docxml.at("//div[@class = 'Symbols']/dl")
+      return docxml unless dl
       dl_out = extract_symbols_list(dl)
       dl_out.sort! { |a, b| a[:key] <=> b[:key] }
       dl.replace(dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n"))
+      docxml
     end
   end
 end

data/lib/isodoc/{notes.rb → comments.rb}

@@ -2,83 +2,10 @@ require "uuidtools"
 
 module IsoDoc
   class Convert
-    def in_footnote
-      @in_footnote
-    end
-
     def in_comment
       @in_comment
     end
 
-    def footnotes(div)
-      return if @footnotes.empty?
-      @footnotes.each { |fn| div.parent << fn }
-    end
-
-    def make_table_footnote_link(out, fnid, fnref)
-      attrs = { href: "##{fnid}", class: "TableFootnoteRef" }
-      out.a **attrs do |a|
-        a << fnref
-      end
-    end
-
-    def make_table_footnote_target(out, fnid, fnref)
-      attrs = { id: fnid, class: "TableFootnoteRef" }
-      out.a **attrs do |a|
-        a << fnref
-        insert_tab(a, 1)
-      end
-    end
-
-    def make_table_footnote_text(node, fnid, fnref)
-      attrs = { id: "ftn#{fnid}" }
-      noko do |xml|
-        xml.div **attr_code(attrs) do |div|
-          make_table_footnote_target(div, fnid, fnref)
-          node.children.each { |n| parse(n, div) }
-        end
-      end.join("\n")
-    end
-
-    def make_generic_footnote_text(node, fnid)
-      noko do |xml|
-        xml.aside **{ id: "ftn#{fnid}" } do |div|
-          node.children.each { |n| parse(n, div) }
-        end
-      end.join("\n")
-    end
-
-    def get_table_ancestor_id(node)
-      table = node.ancestors("table") || node.ancestors("figure")
-      return UUIDTools::UUID.random_create.to_s if table.empty?
-      table.last["id"]
-    end
-
-    def table_footnote_parse(node, out)
-      fn = node["reference"]
-      tid = get_table_ancestor_id(node)
-      make_table_footnote_link(out, tid + fn, fn)
-      # do not output footnote text if we have already seen it for this table
-      return if @seen_footnote.include?(tid + fn)
-      @in_footnote = true
-      out.aside { |a| a << make_table_footnote_text(node, tid + fn, fn) }
-      @in_footnote = false
-      @seen_footnote << (tid + fn)
-    end
-
-    def footnote_parse(node, out)
-      return table_footnote_parse(node, out) if @in_table || @in_figure
-      fn = node["reference"]
-      out.a **{ "epub:type": "footnote", href: "#ftn#{fn}" } do |a|
-        a.sup { |sup| sup << fn }
-      end
-      return if @seen_footnote.include?(fn)
-      @in_footnote = true
-      @footnotes << make_generic_footnote_text(node, fn)
-      @in_footnote = false
-      @seen_footnote << fn
-    end
-
     def comments(div)
       return if @comments.empty?
       div.div **{ style: "mso-element:comment-list" } do |div1|

data/lib/isodoc/convert.rb

@@ -0,0 +1,97 @@
+require "isodoc/iso2wordhtml"
+require "isodoc/cleanup"
+require "isodoc/utils"
+require "isodoc/metadata"
+require "isodoc/section"
+require "isodoc/references"
+require "isodoc/terms"
+require "isodoc/blocks"
+require "isodoc/lists"
+require "isodoc/table"
+require "isodoc/inline"
+require "isodoc/footnotes"
+require "isodoc/comments"
+require "isodoc/xref_gen"
+require "isodoc/xref_sect_gen"
+require "isodoc/html"
+require "isodoc/i18n"
+
+module IsoDoc
+  class Convert
+
+    # htmlstylesheet: Generic stylesheet for HTML
+    # wordstylesheet: Generic stylesheet for Word
+    # standardsheet: Stylesheet specific to Standard
+    # header: Header file for Word
+    # htmlcoverpage: Cover page for HTML
+    # wordcoverpage: Cover page for Word
+    # htmlintropage: Introductory page for HTML
+    # wordintropage: Introductory page for Word
+    # i18nyaml: YAML file for internationalisation of text
+    # ulstyle: list style in Word CSS for unordered lists
+    # olstyle: list style in Word CSS for ordered lists
+    def initialize(options)
+      @htmlstylesheet = options[:htmlstylesheet]
+      @wordstylesheet = options[:wordstylesheet]
+      @standardstylesheet = options[:standardstylesheet]
+      @header = options[:header]
+      @htmlcoverpage = options[:htmlcoverpage]
+      @wordcoverpage = options[:wordcoverpage]
+      @htmlintropage = options[:htmlintropage]
+      @wordintropage = options[:wordintropage]
+      @i18nyaml = options[:i18nyaml]
+      @ulstyle = options[:ulstyle]
+      @olstyle = options[:olstyle]
+      @termdomain = ""
+      @termexample = false
+      @note = false
+      @sourcecode = false
+      @anchors = {}
+      @meta = {}
+      init_metadata
+      @footnotes = []
+      @comments = []
+      @in_footnote = false
+      @in_comment = false
+      @in_table = false
+      @in_figure = false
+      @seen_footnote = Set.new
+      @c = HTMLEntities.new
+      @openmathdelim = "`"
+      @closemathdelim = "`"
+      @lang = "en"
+      @script = "Latn"
+    end
+
+    def convert1(docxml, filename, dir)
+      noko do |xml|
+        xml.html do |html|
+          html.parent.add_namespace("epub", "http://www.idpf.org/2007/ops")
+          html_header(html, docxml, filename, dir)
+          make_body(html, docxml)
+        end
+      end.join("\n")
+    end
+
+    def convert_init(file, filename, debug)
+      docxml = Nokogiri::XML(file)
+      filename, dir = init_file(filename, debug)
+      docxml.root.default_namespace = ""
+      i18n_init(docxml&.at(ns("//bibdata/language"))&.text || "en",
+                docxml&.at(ns("//bibdata/script"))&.text || "Latn")
+      [docxml, filename, dir]
+    end
+
+    def convert(filename, debug = false)
+      convert_file(File.read(filename), filename, debug)
+    end
+
+    def convert_file(file, filename, debug)
+      @openmathdelim, @closemathdelim = extract_delims(file)
+      docxml, filename, dir = convert_init(file, filename, debug)
+      result = convert1(docxml, filename, dir)
+      return result if debug
+      postprocess(result, filename, dir)
+    end
+  end
+end