isodoc 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe7dc7a4c361573ce166000c4b747853185889ed1385f6219da5ecd9bf33b73
-  data.tar.gz: 2da4bf7a5c8a282bdfee95b96b99322c246712405b429404d5accf3385f9b360
+  metadata.gz: 5bd9d095a9d498797d6c48b1465b878f5587107e47f09a76a4148ba3a9618db0
+  data.tar.gz: a0825c515977f0ae8fe7047848480d2e2131be9b3baed8c803ae17aedf6270cd
 SHA512:
-  metadata.gz: 62e7510c6f20ac7d8773d112bc25957c543097164e3b794dcc05d9b241be70317ea37295e9da8d3fcf61aec5597471091af2912277977db1fa266dd3f5351cae
-  data.tar.gz: 6c09ae0a60b767cd4d3dd4ce22a6df2609ea8d1a21f29863a5c5ca27283ebe5897f0d530bf89212dc7b8cd4788641f66d04d646a04189f9c3c379e058d3c50c7
+  metadata.gz: 23b189ba917e52f1822ad80f096b8abb3fb3eca22e06f860fc300c8f3155492da9a7ef1817a43f6674657456885086ba73c5909d0106cdbbd9efe2392269e408
+  data.tar.gz: 2f72ce5902ef2a944f5b49d657e71e0afde82b1d94a2c6e9661d004b54810f7109faa98f2272b651a917da1fbf19e39bd027186e57597b2ae447e8551886e390

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require 'isodoc/gem_tasks'
 
+IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :spec

data/isodoc.gemspec

@@ -36,11 +36,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "html2doc", "~> 1.0.0"
   spec.add_dependency "liquid"
   spec.add_dependency "roman-numerals"
-  spec.add_dependency "sassc", "~> 2.4.0"
   spec.add_dependency "metanorma", "~> 1.1.0"
   spec.add_dependency "rake", "~> 12.0"
 
   spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "sassc", "~> 2.4.0"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

data/lib/isodoc/base_style/metanorma_word.scss

@@ -28,4 +28,3 @@ br.section
 br.pagebreak
     {page-break-before:always;
     mso-special-character:line-break;}
-

data/lib/isodoc/base_style/reset.scss

@@ -49,9 +49,9 @@ time, mark, audio, video {
 }
 
 html, body, div, span, applet, object, iframe,
-p, blockquote, 
-a, abbr, acronym, address, big, cite, 
-del, dfn, em, img, ins, q, s, 
+p, blockquote,
+a, abbr, acronym, address, big, cite,
+del, dfn, em, img, ins, q, s,
 small, strike, strong, sub, sup, var,
 b, u, i, center,
 dl, dt, dd, ol, ul, li,

data/lib/isodoc/convert.rb

@@ -1,7 +1,8 @@
-require "isodoc/common"
-require "sassc"
-require "fileutils"
-require "tempfile"
+# frozen_string_literal: true
+
+require 'isodoc/common'
+require 'fileutils'
+require 'tempfile'
 
 module IsoDoc
   class Convert < ::IsoDoc::Common
@@ -27,15 +28,25 @@ module IsoDoc
     # scripts_pdf: Scripts file for PDF
     # datauriimage: Encode images in HTML output as data URIs
     def initialize(options)
-      @libdir = File.dirname(__FILE__) unless @libdir
-      options.merge!(default_fonts(options)) { |_, old, new| old || new }.
-        merge!(default_file_locations(options)) { |_, old, new| old || new }
+      @libdir ||= File.dirname(__FILE__)
+      options.merge!(default_fonts(options)) do |_, old, new|
+        old || new
+      end
+             .merge!(default_file_locations(options)) do |_, old, new|
+        old || new
+      end
       @options = options
       @files_to_delete = []
       @tempfile_cache = []
-      @htmlstylesheet_name = options[:htmlstylesheet]
-      @wordstylesheet_name = options[:wordstylesheet]
-      @standardstylesheet_name = options[:standardstylesheet]
+      @htmlstylesheet_name = precompiled_style_or_original(
+        options[:htmlstylesheet]
+      )
+      @wordstylesheet_name = precompiled_style_or_original(
+        options[:wordstylesheet]
+      )
+      @standardstylesheet_name = precompiled_style_or_original(
+        options[:standardstylesheet]
+      )
       @header = options[:header]
       @htmlcoverpage = options[:htmlcoverpage]
       @wordcoverpage = options[:wordcoverpage]
@@ -48,8 +59,8 @@ module IsoDoc
       @olstyle = options[:olstyle]
       @datauriimage = options[:datauriimage]
       @suppressheadingnumbers = options[:suppressheadingnumbers]
-      @break_up_urls_in_tables = options[:break_up_urls_in_tables] == "true"
-      @termdomain = ""
+      @break_up_urls_in_tables = options[:break_up_urls_in_tables] == 'true'
+      @termdomain = ''
       @termexample = false
       @note = false
       @sourcecode = false
@@ -61,40 +72,57 @@ module IsoDoc
       @in_figure = false
       @seen_footnote = Set.new
       @c = HTMLEntities.new
-      @openmathdelim = "`"
-      @closemathdelim = "`"
-      @lang = "en"
-      @script = "Latn"
+      @openmathdelim = '`'
+      @closemathdelim = '`'
+      @lang = 'en'
+      @script = 'Latn'
       @maxwidth = 1200
       @maxheight = 800
       @wordToClevels = options[:doctoclevels].to_i
-      @wordToClevels = 2 if @wordToClevels == 0
+      @wordToClevels = 2 if @wordToClevels.zero?
       @htmlToClevels = options[:htmltoclevels].to_i
-      @htmlToClevels = 2 if @htmlToClevels == 0
-      @bookmarks_allocated = {"X" => true}
+      @htmlToClevels = 2 if @htmlToClevels.zero?
+      @bookmarks_allocated = { 'X' => true }
       @fn_bookmarks = {}
     end
 
+    # Check if already compiled version(.css) exists,
+    #   if not, return original scss file. During release
+    #   we compile scss into css files in order to not depend on scss
+    def precompiled_style_or_original(stylesheet_path)
+      # Already have compiled stylesheet, use it
+      return stylesheet_path if stylesheet_path.nil? ||
+                                File.extname(stylesheet_path) == '.css'
+
+      basename = File.basename(stylesheet_path, '.*')
+      compiled_path = File.join(File.dirname(stylesheet_path),
+                                "#{basename}.css")
+      return stylesheet_path unless File.file?(compiled_path)
+
+      compiled_path
+    end
+
     # run this after @meta is populated
     def populate_css
-      @htmlstylesheet = generate_css(@htmlstylesheet_name, true, extract_fonts(options))
-      @wordstylesheet = generate_css(@wordstylesheet_name, false, extract_fonts(options))
-      @standardstylesheet = generate_css(@standardstylesheet_name, false, extract_fonts(options))
+      @htmlstylesheet = generate_css(@htmlstylesheet_name, true)
+      @wordstylesheet = generate_css(@wordstylesheet_name, false)
+      @standardstylesheet = generate_css(@standardstylesheet_name, false)
     end
 
     def tmpimagedir_suffix
-      "_images"
+      '_images'
     end
 
     def default_fonts(_options)
       {
-        bodyfont: "Arial",
-        headerfont: "Arial",
-        monospacefont: "Courier",
+        bodyfont: 'Arial',
+        headerfont: 'Arial',
+        monospacefont: 'Courier'
       }
     end
 
-    # none for this parent gem, but will be populated in child gems which have access to stylesheets &c; e.g.
+    # none for this parent gem, but will be populated in child
+    #   gems which have access to stylesheets &c; e.g.
     # {
     #      htmlstylesheet: html_doc_path("htmlstyle.scss"),
     #      htmlcoverpage: html_doc_path("html_rsd_titlepage.html"),
@@ -112,30 +140,51 @@ module IsoDoc
       {}
     end
 
-    # extract fonts for use in generate_css
-    def extract_fonts(options)
-      b = options[:bodyfont] || "Arial"
-      h = options[:headerfont] || "Arial"
-      m = options[:monospacefont] || "Courier"
+    def fonts_options
+      {
+        'bodyfont' => options[:bodyfont] || 'Arial',
+        'headerfont' => options[:headerfont] || 'Arial',
+        'monospacefont' => options[:monospacefont] || 'Courier'
+      }
+    end
+
+    def scss_fontheader
+      b = options[:bodyfont] || 'Arial'
+      h = options[:headerfont] || 'Arial'
+      m = options[:monospacefont] || 'Courier'
       "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
     end
 
     def html_doc_path(file)
-      File.join(@libdir, File.join("html", file))
+      File.join(@libdir, File.join('html', file))
+    end
+
+    def convert_scss(filename, stylesheet)
+      require 'sassc'
+      require 'isodoc/sassc_importer'
+
+      [File.join(Gem.loaded_specs['isodoc'].full_gem_path,
+                 'lib', 'isodoc'),
+       File.dirname(filename)].each do |name|
+        SassC.load_paths << name
+      end
+      SassC::Engine.new(scss_fontheader + stylesheet, syntax: :scss,
+                                                      importer: SasscImporter)
+                   .render
     end
 
-    def generate_css(filename, stripwordcss, fontheader)
-      return nil unless filename
-      stylesheet = File.read(filename, encoding: "UTF-8")
+    def generate_css(filename, stripwordcss)
+      return nil if filename.nil?
+
+      stylesheet = File.read(filename, encoding: 'UTF-8')
       stylesheet = populate_template(stylesheet, :word)
-      stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, "\\1") if stripwordcss
-      SassC.load_paths << File.join(Gem.loaded_specs['isodoc'].full_gem_path,
-                                    "lib", "isodoc")
-      SassC.load_paths << File.dirname(filename)
-      engine = SassC::Engine.new(fontheader + stylesheet, syntax: :scss)
-      Tempfile.open([File.basename(filename, ".*"), "css"],
-                    :encoding => "utf-8") do |f|
-        f.write(engine.render)
+      stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, '\\1') if stripwordcss
+      if File.extname(filename) == '.scss'
+        stylesheet = convert_scss(filename, stylesheet)
+      end
+      Tempfile.open([File.basename(filename, '.*'), 'css'],
+                    encoding: 'utf-8') do |f|
+        f.write(stylesheet)
         f
       end
     end
@@ -143,10 +192,10 @@ module IsoDoc
     def convert1(docxml, filename, dir)
       @xrefs.parse docxml
       noko do |xml|
-        xml.html **{ lang: "#{@lang}" } do |html|
-          html.parent.add_namespace("epub", "http://www.idpf.org/2007/ops")
+        xml.html **{ lang: @lang.to_s } do |html|
+          html.parent.add_namespace('epub', 'http://www.idpf.org/2007/ops')
           info docxml, nil
-          populate_css()
+          populate_css
           html.head { |head| define_head head, filename, dir }
           make_body(html, docxml)
         end
@@ -164,17 +213,21 @@ module IsoDoc
     def convert_init(file, input_filename, debug)
       docxml = Nokogiri::XML(file)
       filename, dir = init_file(input_filename, debug)
-      docxml.root.default_namespace = ""
-      lang = docxml&.at(ns("//bibdata/language"))&.text || @lang
-      script = docxml&.at(ns("//bibdata/script"))&.text || @script
+      docxml.root.default_namespace = ''
+      lang = docxml&.at(ns('//bibdata/language'))&.text || @lang
+      script = docxml&.at(ns('//bibdata/script'))&.text || @script
       i18n_init(lang, script)
       metadata_init(lang, script, @labels)
+      @meta.fonts_options = fonts_options
       xref_init(lang, script, self, @labels, {})
       [docxml, filename, dir]
     end
 
-    def convert(input_filename, file = nil, debug = false, output_filename = nil)
-      file = File.read(input_filename, encoding: "utf-8") if file.nil?
+    def convert(input_filename,
+                file = nil,
+                debug = false,
+                output_filename = nil)
+      file = File.read(input_filename, encoding: 'utf-8') if file.nil?
       @openmathdelim, @closemathdelim = extract_delims(file)
       docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
@@ -186,7 +239,7 @@ module IsoDoc
 
     def middle_clause
       "//clause[parent::sections][not(xmlns:title = 'Scope')]"\
-      "[not(descendant::terms)]".freeze
+      '[not(descendant::terms)]'
     end
   end
 end

data/lib/isodoc/function/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IsoDoc::Function
   module Utils
     def date_range(date)
@@ -9,50 +11,50 @@ module IsoDoc::Function
     end
 
     def insert_tab(out, n)
-      [1..n].each { out << "&nbsp; " }
+      [1..n].each { out << '&nbsp; ' }
     end
 
     # add namespaces for Word fragments
-    NOKOHEAD = <<~HERE.freeze
-    <!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>
+    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("")
+      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
 
     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]
+        [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">'.freeze
+      '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
 
     def to_xhtml(xml)
-      xml.gsub!(/<\?xml[^>]*>/, "")
-      /<!DOCTYPE /.match xml or xml = DOCTYPE_HDR + 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) ? 
+        /^(\&[^ \t\r\n#;]+;)/.match?(t) ?
           HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal) : t
-      end.join("")
+      end.join('')
       begin
-        Nokogiri::XML.parse(xml) { |config| config.strict }
+        Nokogiri::XML.parse(xml, &:strict)
       rescue Nokogiri::XML::SyntaxError => e
-        File.open("#{@filename}.#{@format}.err", "w:UTF-8") { |f| f.write xml }
+        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
@@ -64,7 +66,7 @@ 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 =
@@ -72,7 +74,7 @@ module IsoDoc::Function
       "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".freeze
+      "local-name() = 'clause' or local-name() = 'references']/@id"
 
     def get_clause_id(node)
       clause = node.xpath(CLAUSE_ANCESTOR)
@@ -86,7 +88,7 @@ module IsoDoc::Function
       "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".freeze
+      "local-name() = 'table' or local-name() = 'example']/@id"
 
     def get_note_container_id(node)
       container = node.xpath(NOTE_CONTAINER_ANCESTOR)
@@ -94,7 +96,7 @@ module IsoDoc::Function
     end
 
     def sentence_join(array)
-      return "" if array.nil? || array.empty?
+      return '' if array.nil? || array.empty?
       if array.length == 1 then array[0]
       else
         IsoDoc::Function::I18n::l10n("#{array[0..-2].join(', ')} "\
@@ -105,25 +107,25 @@ module IsoDoc::Function
 
     # 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 == '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
@@ -135,9 +137,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
 
@@ -147,37 +149,41 @@ module IsoDoc::Function
     end
 
     def populate_template(docxml, _format = nil)
-      meta = @meta.get.merge(@labels || {}).merge(@meta.labels || {})
+      meta = @meta
+             .get
+             .merge(@labels || {})
+             .merge(@meta.labels || {})
+             .merge(@meta.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;')
+      template.render(meta.map { |k, v| [k.to_s, empty2nil(v)] }.to_h)
+              .gsub('&lt;', '&#x3c;').gsub('&gt;', '&#x3e;').gsub('&amp;', '&#x26;')
     end
 
-    def save_dataimage(uri, relative_dir = true)
+    def save_dataimage(uri, _relative_dir = true)
       %r{^data:image/(?<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
+        @tempfile_cache << f # persist to the end
         f.path
       end
     end
 
     def image_localfile(i)
-      if /^data:image/.match i["src"]
-        save_dataimage(i["src"], false)
-      elsif %r{^([A-Z]:)?/}.match i["src"]
-        i["src"]
+      if /^data:image/.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)
-      return !node.ancestors("example, requirement, recommendation, permission, "\
-                             "table, figure, sourcecode").empty?
+      !node.ancestors('example, requirement, recommendation, permission, '\
+                             'table, figure, sourcecode').empty?
     end
   end
 end