isodoc 3.1.0 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a3a3be88ed08f8f5025c255a596b63685e4361411265eb024d0e9473f94fcca
-  data.tar.gz: 0e821ce48e0d212e638ee5fe70298ea7ea47780d057255d67e708cecd02f3319
+  metadata.gz: aa02186be0f73d998dca870f3559df00184697cc3582ef302eb934e4901d1ab1
+  data.tar.gz: 54cf027ca0fcab8ec1c97b35d7ada8ec7137a32a2adeecfa2c0cb9b653b3b0f2
 SHA512:
-  metadata.gz: ab31e514116f9dc989eae235a933062dfdd05418076b2d353e21d51d4a1767a4038e66946aa09d4a8e6616b8b0750bca340f92570b02d3320a63f14b8cc3c701
-  data.tar.gz: 7373511670a6a8314374ab368bce30e23fcc5c0088adb53ae43fe85b70b87198347a141fd91127a200dcad2baa01492af476507e561c25785cb232a680876068
+  metadata.gz: 251471002a6b16dd050364344f6a63e99b0e3b266a0dcc65cb4f83382b5ebfece49cc75ea65229282ef61a7206fb1ac4d7aba441b86b19704c6d9d00398ce3f2
+  data.tar.gz: 5fde838af0af79d78ccc4fecd730bc64cc60e6afaf68691f5e046d18ada04df54a922b61d98b22632a9395e21caa4c0cbbafceea70c729da839f9b732beb54c9

data/isodoc.gemspec

@@ -44,6 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "thread_safe"
   spec.add_dependency "twitter_cldr", ">= 6.6.0"
   spec.add_dependency "uuidtools"
+  spec.add_dependency "lutaml-model", "~> 0.6.0"
 
   spec.add_development_dependency "bigdecimal"
   spec.add_development_dependency "debug"
@@ -52,18 +53,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 1.5.2"
-=begin
-  if RUBY_VERSION.start_with?("3.1")
-    spec.add_development_dependency "sassc-embedded", "1.54.0"
-    spec.add_development_dependency "sass-embedded", "1.54.2"
-  else
-    spec.add_development_dependency "sassc-embedded", "~> 1"
-    spec.add_development_dependency "sass-embedded", "~> 1"
-  end
-  #spec.add_development_dependency "sassc-embedded", "~> 1"
-=end
-  #spec.add_development_dependency "sassc"
+  spec.add_development_dependency "rubocop", "~> 1"
+  spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "sassc-embedded", "~> 1"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"

data/lib/isodoc/common.rb

@@ -2,6 +2,7 @@ require_relative "function/blocks"
 require_relative "function/cleanup"
 require_relative "function/form"
 require_relative "function/inline"
+require_relative "function/footnotes"
 require_relative "function/lists"
 require_relative "function/references"
 require_relative "function/section"
@@ -18,6 +19,7 @@ module IsoDoc
     include Function::Cleanup
     include Function::Form
     include Function::Inline
+    include Function::Footnotes
     include Function::Lists
     include Function::References
     include Function::Section

data/lib/isodoc/css.rb

@@ -75,6 +75,25 @@ module IsoDoc
     end
 
     def convert_scss(filename, stylesheet, stripwordcss)
+      load_scss_paths(filename)
+      Dir.mktmpdir do |dir|
+        variables_file_path = File.join(dir, "variables.scss")
+        File.write(variables_file_path, scss_fontheader(stripwordcss))
+        SassC.load_paths << dir
+        modified_stylesheet = %( @use "variables" as *;\n#{stylesheet})
+        compile_scss(modified_stylesheet)
+      end
+    end
+
+    def compile_scss(modified_stylesheet)
+      SassC::Engine
+        .new(modified_stylesheet, quiet_deps: true, syntax: :scss,
+                                  silence_deprecations: %w(mixed-decls),
+                                  importer: SasscImporter)
+        .render.gsub(/__WORD__/, "")
+    end
+
+    def load_scss_paths(filename)
       require "sassc-embedded"
       require "isodoc/sassc_importer"
       [File.join(Gem.loaded_specs["isodoc"].full_gem_path,
@@ -82,23 +101,6 @@ module IsoDoc
        File.dirname(filename)].each do |name|
         SassC.load_paths << name
       end
-
-      Dir.mktmpdir do |dir|
-        variables_file_path = File.join(dir, "variables.scss")
-        File.write(variables_file_path,
-                   scss_fontheader(stripwordcss))
-
-        SassC.load_paths << dir
-
-        # Modify the stylesheet to use the tempfile with @use
-        modified_stylesheet = <<~SCSS
-          @use "variables" as *;
-          #{stylesheet}
-        SCSS
-        SassC::Engine.new(modified_stylesheet,
-                          syntax: :scss, importer: SasscImporter)
-          .render
-      end
     end
 
     # stripwordcss if HTML stylesheet, !stripwordcss if DOC stylesheet
@@ -106,17 +108,28 @@ module IsoDoc
       filename.nil? and return nil
       filename = precompiled_style_or_original(filename)
       stylesheet = File.read(filename, encoding: "UTF-8")
-      stylesheet = populate_template(stylesheet, :word)
-      stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, "\\1") if stripwordcss
-      stylesheet.gsub!(/--/, "-DOUBLE_HYPHEN_ESCAPE-") unless stripwordcss
+      stylesheet = preprocess_css(stylesheet, stripwordcss)
       File.extname(filename) == ".scss" and
         stylesheet = convert_scss(filename, stylesheet, stripwordcss)
+      write_css(filename, stylesheet)
+    end
+
+    def write_css(filename, stylesheet)
       Tempfile.open([File.basename(filename, ".*"), "css"],
                     mode: File::BINARY | File::SHARE_DELETE,
                     encoding: "utf-8") do |f|
-        f.write(stylesheet)
-        f
-      end
+                      f.write(stylesheet)
+                      f
+                    end
+    end
+
+    def preprocess_css(stylesheet, html)
+      stylesheet = populate_template(stylesheet, :word)
+      html and stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, "\\1")
+      !html and stylesheet.gsub!(/--/, "-DOUBLE_HYPHEN_ESCAPE-")
+      !html and stylesheet.gsub!(%r<([a-z])\.([0-9])(?=[^{}]*{)>m,
+                                 "\\1.__WORD__\\2")
+      stylesheet
     end
   end
 end

data/lib/isodoc/function/blocks.rb

@@ -192,6 +192,18 @@ module IsoDoc
       end
 
       def columnbreak_parse(node, out); end
+
+      # we dont't want figure dl/dd/fmt-fn-body to be processed
+      # as actual footnotes
+      def fmt_fn_body_parse(node, out)
+        node.ancestors("table, figure").empty? and
+          node.at(ns(".//fmt-fn-label"))&.remove
+        aside = node.parent.name == "fmt-footnote-container"
+        tag = aside ? "aside" : "div"
+        out.send tag, id: "fn:#{node['reference']}", class: "footnote" do |div|
+          node.children.each { |n| parse(n, div) }
+        end
+      end
     end
   end
 end

data/lib/isodoc/function/cleanup.rb

@@ -16,7 +16,7 @@ module IsoDoc
       def cleanup(docxml)
         @i18n ||= i18n_init(@lang, @script, @locale)
         comment_cleanup(docxml)
-        footnote_cleanup(docxml)
+        #footnote_cleanup(docxml)
         inline_header_cleanup(docxml)
         figure_cleanup(docxml)
         table_cleanup(docxml)
@@ -58,7 +58,7 @@ module IsoDoc
         docxml
       end
 
-      # todo PRESENTATION XML
+      # KILL
       def footnote_cleanup(docxml)
         docxml.xpath('//a[@class = "FootnoteRef"]/sup')
           .each_with_index do |x, i|
@@ -68,7 +68,7 @@ module IsoDoc
       end
 
       def merge_fnref_into_fn_text(elem)
-        fn = elem.at('.//span[@class="TableFootnoteRef"]/..')
+        fn = elem.at('.//span[@class="TableFootnoteRef"]/..') or return
         n = fn.next_element
         n&.children&.first&.add_previous_sibling(fn.remove)
       end
@@ -80,7 +80,7 @@ module IsoDoc
             merge_fnref_into_fn_text(a)
             a.name = "div"
             a["class"] = "TableFootnote"
-            t << a.remove
+            t << a.remove # this is redundant
           end
         end
         table_footnote_cleanup_propagate(docxml)
@@ -142,14 +142,6 @@ module IsoDoc
       end
 
       def symbols_cleanup(docxml); end
-
-      def table_footnote_reference_format(link)
-        link
-      end
-
-      def footnote_reference_format(link)
-        link
-      end
     end
   end
 end

data/lib/isodoc/function/footnotes.rb

@@ -0,0 +1,57 @@
+module IsoDoc
+  module Function
+    module Footnotes
+      def make_table_footnote_link(out, fnid, node)
+        attrs = { href: "##{fnid}", class: "TableFootnoteRef" }
+        sup = node.at(ns("./sup")) and sup.replace(sup.children)
+        out.a **attrs do |a|
+          children_parse(node, a)
+        end
+      end
+
+      def get_table_ancestor_id(node)
+        table = node.ancestors("table")
+        table.empty? and table = node.ancestors("figure")
+        table.empty? and return [nil, UUIDTools::UUID.random_create.to_s]
+        [table.last, table.last["id"]]
+      end
+
+      # @seen_footnote:
+      # do not output footnote text if we have already seen it for this table
+
+      def table_footnote_parse(node, out)
+        fn = node["reference"] || UUIDTools::UUID.random_create.to_s
+        table, tid = get_table_ancestor_id(node)
+        make_table_footnote_link(out, tid + fn, node.at(ns("./fmt-fn-label")))
+        # do not output footnote text if we have already seen it for this table
+        @seen_footnote.include?(tid + fn) and return
+        update_table_fn_body_ref(node, table, tid + fn)
+        @seen_footnote << (tid + fn)
+      end
+
+      def update_table_fn_body_ref(fnote, table, reference)
+        fnbody = table.at(ns(".//fmt-fn-body[@id = '#{fnote['target']}']")) or return
+        fnbody["reference"] = reference
+        sup = fnbody.at(ns(".//fmt-fn-label/sup")) and sup.replace(sup.children)
+        fnbody.xpath(ns(".//fmt-fn-label")).each do |s|
+          s["class"] = "TableFootnoteRef"
+          s.name = "span"
+          d = s.at(ns("./span[@class = 'fmt-caption-delim']")) and
+            s.next = d
+        end
+      end
+
+      def footnote_parse(node, out)
+        return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
+          !node.ancestors.map(&:name).include?("fmt-name")
+
+        fn = node["reference"] || UUIDTools::UUID.random_create.to_s
+        attrs = { class: "FootnoteRef", href: "#fn:#{fn}" }
+        f = node.at(ns("./fmt-fn-label"))
+        out.a **attrs do |a|
+          children_parse(f, a)
+        end
+      end
+    end
+  end
+end

data/lib/isodoc/function/inline.rb

@@ -15,8 +15,6 @@ module IsoDoc
         end
       end
 
-      def location_parse(node, out); end
-
       # Presentation XML classes which we need not pass on to HTML or DOC
       SPAN_UNWRAP_CLASSES =
         %w[fmt-caption-label fmt-label-delim fmt-caption-delim fmt-autonum-delim
@@ -189,8 +187,6 @@ module IsoDoc
         end
       end
 
-      def author_parse(node, out); end
-
       def semx_parse(node, out)
         children_parse(node, out)
       end
@@ -199,8 +195,9 @@ module IsoDoc
         node.children.each { |n| parse(n, out) }
       end
 
+      def location_parse(node, out); end
+      def author_parse(node, out); end
       def xref_label_parse(node, out); end
-
       def name_parse(node, out); end
       def semx_definition_parse(node, out); end
       def semx_xref_parse(node, out); end
@@ -209,7 +206,6 @@ module IsoDoc
       def semx_origin_parse(node, out); end
       def date_parse(node, out); end
       def semx_stem_parse(node, out); end
-
       def floating_title_parse(node, out); end
       def identifier_parse(node, out); end
       def concept_parse(node, out); end
@@ -233,6 +229,14 @@ module IsoDoc
       def fmt_date_parse(node, out)
         children_parse(node, out)
       end
+
+      def fmt_fn_label_parse(node, out)
+        children_parse(node, out)
+      end
+
+      def fmt_footnote_container_parse(node, out)
+        children_parse(node, out)
+      end
     end
   end
 end

data/lib/isodoc/function/section.rb

@@ -219,6 +219,13 @@ module IsoDoc
           node.children.each { |n| parse(n, div) }
         end
       end
+
+      def footnotes(docxml, div)
+        docxml.xpath(ns("/*/fmt-footnote-container"))
+          .each do |fn|
+            fn.children.each { |n| parse(n, div) }
+          end
+      end
     end
   end
 end

data/lib/isodoc/function/setup.rb

@@ -0,0 +1,64 @@
+require "fileutils"
+require "pathname"
+
+module IsoDoc
+  module Function
+    module ToWordHtml
+      def note?
+        @note
+      end
+
+      def init_file(filename, debug)
+        filepath = Pathname.new(filename)
+        filename = filepath.sub_ext("").sub(/\.presentation$/, "").to_s
+        dir = init_dir(filename, debug)
+        @filename = filename
+        @localdir = @baseassetpath || filepath.parent.to_s
+        @localdir += "/"
+        @sourcedir = @localdir
+        @sourcefilename and
+          @sourcedir = "#{Pathname.new(@sourcefilename).parent}/"
+        [filename, dir]
+      end
+
+      def init_dir(filename, debug)
+        dir = "#{filename}#{@tmpfilesdir_suffix}"
+        unless debug
+          FileUtils.mkdir_p(dir)
+          FileUtils.chmod 0o777, dir
+          FileUtils.rm_rf "#{dir}/*"
+        end
+        dir
+      end
+
+      # tmp image dir is same directory as @filename
+      def tmpimagedir
+        @filename + @tmpimagedir_suffix
+      end
+
+      def rel_tmpimagedir
+        Pathname.new(@filename).basename.to_s + @tmpimagedir_suffix
+      end
+
+      def info(isoxml, out)
+        @meta.code_css isoxml, out
+        @meta.title isoxml, out
+        @meta.subtitle isoxml, out
+        @meta.docstatus isoxml, out
+        @meta.docid isoxml, out
+        @meta.otherid isoxml, out
+        @meta.docnumeric isoxml, out
+        @meta.doctype isoxml, out
+        @meta.author isoxml, out
+        @meta.bibdate isoxml, out
+        @meta.relations isoxml, out
+        @meta.version isoxml, out
+        @meta.url isoxml, out
+        @meta.keywords isoxml, out
+        @meta.note isoxml, out
+        @meta.presentation isoxml, out
+        @meta.get
+      end
+    end
+  end
+end

data/lib/isodoc/function/table.rb

@@ -86,6 +86,8 @@ module IsoDoc
         (dl = node.at(ns("./dl"))) && parse(dl, out)
         node.xpath(ns("./source")).each { |n| parse(n, out) }
         node.xpath(ns("./note")).each { |n| parse(n, out) }
+        node.xpath(ns("./fmt-footnote-container/fmt-fn-body"))
+          .each { |n| parse(n, out) }
       end
 
       def table_parse_core(node, out)

data/lib/isodoc/function/to_word_html.rb

@@ -1,45 +1,10 @@
 require "fileutils"
 require "pathname"
+require_relative "setup"
 
 module IsoDoc
   module Function
     module ToWordHtml
-      def note?
-        @note
-      end
-
-      def init_file(filename, debug)
-        filepath = Pathname.new(filename)
-        filename = filepath.sub_ext("").sub(/\.presentation$/, "").to_s
-        dir = init_dir(filename, debug)
-        @filename = filename
-        @localdir = @baseassetpath || filepath.parent.to_s
-        @localdir += "/"
-        @sourcedir = @localdir
-        @sourcefilename and
-          @sourcedir = "#{Pathname.new(@sourcefilename).parent}/"
-        [filename, dir]
-      end
-
-      def init_dir(filename, debug)
-        dir = "#{filename}#{@tmpfilesdir_suffix}"
-        unless debug
-          FileUtils.mkdir_p(dir)
-          FileUtils.chmod 0o777, dir
-          FileUtils.rm_rf "#{dir}/*"
-        end
-        dir
-      end
-
-      # tmp image dir is same directory as @filename
-      def tmpimagedir
-        @filename + @tmpimagedir_suffix
-      end
-
-      def rel_tmpimagedir
-        Pathname.new(@filename).basename.to_s + @tmpimagedir_suffix
-      end
-
       # isodoc.css overrides any CSS injected by Html2Doc, which
       # is inserted before this CSS.
       def define_head(head, _filename, _dir)
@@ -88,7 +53,7 @@ module IsoDoc
         body.div class: "main-section" do |div3|
           boilerplate docxml, div3
           content(div3, docxml, ns(self.class::TOP_ELEMENTS))
-          footnotes div3
+          footnotes docxml, div3
           comments div3
         end
       end
@@ -129,26 +94,6 @@ module IsoDoc
         end
       end
 
-      def info(isoxml, out)
-        @meta.code_css isoxml, out
-        @meta.title isoxml, out
-        @meta.subtitle isoxml, out
-        @meta.docstatus isoxml, out
-        @meta.docid isoxml, out
-        @meta.otherid isoxml, out
-        @meta.docnumeric isoxml, out
-        @meta.doctype isoxml, out
-        @meta.author isoxml, out
-        @meta.bibdate isoxml, out
-        @meta.relations isoxml, out
-        @meta.version isoxml, out
-        @meta.url isoxml, out
-        @meta.keywords isoxml, out
-        @meta.note isoxml, out
-        @meta.presentation isoxml, out
-        @meta.get
-      end
-
       def cross_align(isoxml, out)
         isoxml.xpath(ns("//cross-align")).each do |c|
           parse(c, out)
@@ -286,6 +231,9 @@ module IsoDoc
           when "amend" then amend_parse(node, out)
           when "date" then date_parse(node, out)
           when "fmt-date" then fmt_date_parse(node, out)
+          when "fmt-fn-body" then fmt_fn_body_parse(node, out)
+          when "fmt-fn-label" then fmt_fn_label_parse(node, out)
+          when "fmt-footnote-container" then fmt_footnote_container_parse(node, out)
           else error_parse(node, out)
           end
         end

data/lib/isodoc/function/utils.rb

@@ -107,8 +107,7 @@ module IsoDoc
       end
 
       def sentence_join(array)
-        return "" if array.nil? || array.empty?
-
+        array.nil? || array.empty? and return ""
         if array.length == 1 then array[0]
         else
           @i18n.l10n("#{array[0..-2].join(', ')} " \
@@ -242,11 +241,9 @@ module IsoDoc
       def external_path(path)
         win = !!((RUBY_PLATFORM =~ /(win|w)(32|64)$/) ||
                  (RUBY_PLATFORM =~ /mswin|mingw/))
-        if win
-          path.tr!(%{/}, "\\")
-          path[/\s/] ? "\"#{path}\"" : path
-        else path
-        end
+        win or return path
+        path.tr!(%{/}, "\\")
+        path[/\s/] ? "\"#{path}\"" : path
       end
     end
   end

data/lib/isodoc/gem_tasks.rb

@@ -111,30 +111,30 @@ module IsoDoc
     end
 
     def compile_scss(filename)
+      load_scss_paths(filename)
+      Dir.mktmpdir do |dir|
+        File.write(File.join(dir, "variables.scss"), fonts_placeholder)
+        SassC.load_paths << dir
+        sheet_content = File.read(filename, encoding: "UTF-8")
+          .gsub(%r<([a-z])\.([0-9])(?=[^{}]*{)>m, "\\1.__WORD__\\2")
+        SassC::Engine.new(%<@use "variables" as *;\n#{sheet_content}>,
+                          syntax: :scss, importer: SasscImporter)
+          .render.gsub(/__WORD__/, "")
+      end
+    end
+
+    def load_scss_paths(filename)
       require "sassc-embedded"
       require "isodoc/sassc_importer"
-
       isodoc_path = if Gem.loaded_specs["isodoc"]
                       File.join(Gem.loaded_specs["isodoc"].full_gem_path,
                                 "lib", "isodoc")
-                    else
-                      File.join("lib", "isodoc")
+                    else File.join("lib", "isodoc")
                     end
       [isodoc_path,
        File.dirname(filename)].each do |name|
-        SassC.load_paths << name
-      end
-      Dir.mktmpdir do |dir|
-        variables_file_path = File.join(dir, "variables.scss")
-        File.write(variables_file_path, fonts_placeholder)
-        SassC.load_paths << dir
-
-      sheet_content = File.read(filename, encoding: "UTF-8")
-      SassC::Engine.new(%<@use "variables" as *;\n#{sheet_content}>,
-                        syntax: :scss,
-                        importer: SasscImporter)
-        .render
-    end
+         SassC.load_paths << name
+       end
     end
 
     def compile_scss_task(current_task)

data/lib/isodoc/headlesshtml_convert.rb

@@ -1,12 +1,10 @@
 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
 
     def tmpimagedir_suffix

data/lib/isodoc/html_convert.rb

@@ -1,5 +1,4 @@
 require_relative "html_function/comments"
-require_relative "html_function/footnotes"
 require_relative "html_function/html"
 require_relative "html_function/postprocess"
 require_relative "html_function/form"
@@ -8,7 +7,6 @@ module IsoDoc
   class HtmlConvert < ::IsoDoc::Convert
 
     include HtmlFunction::Comments
-    include HtmlFunction::Footnotes
     include HtmlFunction::Form
     include HtmlFunction::Html
 

data/lib/isodoc/html_function/postprocess.rb

@@ -26,7 +26,8 @@ module IsoDoc
 
       def html_cleanup(html)
         html = term_header(html_footnote_filter(html_preface(htmlstyle(html))))
-        html = footnote_format(footnote_backlinks(html))
+        #html = footnote_format(footnote_backlinks(html))
+        html = (footnote_backlinks(html))
         html = mathml(html_list_clean(remove_placeholder_paras(html)))
         html_toc(heading_anchors(sourcecode_cleanup(html)))
       end

data/lib/isodoc/html_function/postprocess_footnotes.rb

@@ -49,7 +49,8 @@ module IsoDoc
         docxml
       end
 
-      def footnote_format(docxml)
+      # KILL
+      def footnote_formatx(docxml)
         docxml.xpath("//a[@class = 'FootnoteRef']/sup").each do |x|
           footnote_reference_format(x)
         end

data/lib/isodoc/pdf_convert.rb

@@ -1,11 +1,9 @@
 require_relative "html_function/comments"
-require_relative "html_function/footnotes"
 require_relative "html_function/html"
 
 module IsoDoc
   class PdfConvert < ::IsoDoc::Convert
     include HtmlFunction::Comments
-    include HtmlFunction::Footnotes
     include HtmlFunction::Html
 
     def initialize(options)