isodoc 1.0.29 → 1.1.3.pre.alpha2

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/common.rb

@@ -9,8 +9,6 @@ require_relative "./function/table"
 require_relative "./function/terms"
 require_relative "./function/to_word_html"
 require_relative "./function/utils"
-require_relative "./function/xref_gen"
-require_relative "./function/xref_sect_gen"
 require_relative "./function/reqt"
 require_relative "./class_utils"
 
@@ -27,8 +25,6 @@ module IsoDoc
     include Function::Terms
     include Function::ToWordHtml
     include Function::Utils
-    include Function::XrefGen
-    include Function::XrefSectGen
 
     extend ::IsoDoc::ClassUtils
   end

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,12 +59,11 @@ 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
-      @anchors = {}
       @footnotes = []
       @comments = []
       @in_footnote = false
@@ -62,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"),
@@ -113,41 +140,62 @@ 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 generate_css(filename, stripwordcss, fontheader)
-      return nil unless filename
-      stylesheet = File.read(filename, encoding: "UTF-8")
+    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)
+      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
 
     def convert1(docxml, filename, dir)
-      anchor_names docxml
+      @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
@@ -158,25 +206,40 @@ module IsoDoc
       @meta = Metadata.new(lang, script, labels)
     end
 
-    def convert_init(file, filename, debug)
+    def xref_init(lang, script, klass, labels, options)
+      @xrefs = Xref.new(lang, script, klass, labels, options)
+    end
+
+    def convert_init(file, input_filename, debug)
       docxml = Nokogiri::XML(file)
-      filename, dir = init_file(filename, debug)
-      docxml.root.default_namespace = ""
-      lang = docxml&.at(ns("//bibdata/language"))&.text || @lang
-      script = docxml&.at(ns("//bibdata/script"))&.text || @script
+      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
       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(filename, file = nil, debug = false)
-      file = File.read(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, filename, debug)
+      docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
       return result if debug
-      postprocess(result, filename, dir)
+      output_filename ||= "#{filename}.#{@suffix}"
+      postprocess(result, output_filename, dir)
       FileUtils.rm_rf dir
     end
+
+    def middle_clause
+      "//clause[parent::sections][not(xmlns:title = 'Scope')]"\
+      '[not(descendant::terms)]'
+    end
   end
 end

data/lib/isodoc/function/blocks.rb

@@ -6,7 +6,7 @@ module IsoDoc::Function
 
     def figure_name_parse(node, div, name)
       return if name.nil? && node.at(ns("./figure"))
-      lbl = anchor(node['id'], :label, false)
+      lbl = @xrefs.anchor(node['id'], :label, false)
       lbl = nil if labelled_ancestor(node) && node.ancestors("figure").empty?
       return if lbl.nil? && name.nil?
       div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
@@ -55,7 +55,7 @@ module IsoDoc::Function
     end
 
     def sourcecode_name_parse(node, div, name)
-      lbl = anchor(node['id'], :label, false)
+      lbl = @xrefs.anchor(node['id'], :label, false)
       lbl = nil if labelled_ancestor(node)
       return if lbl.nil? && name.nil?
       div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
@@ -141,7 +141,7 @@ module IsoDoc::Function
       out.div **attr_code(class: "formula") do |div|
         div.p do |p|
           parse(node.at(ns("./stem")), div)
-          lbl = anchor(node['id'], :label, false)
+          lbl = @xrefs.anchor(node['id'], :label, false)
           unless lbl.nil?
             insert_tab(div, 1)
             div << "(#{lbl})"

data/lib/isodoc/function/blocks_example_note.rb

@@ -1,7 +1,7 @@
 module IsoDoc::Function
   module Blocks
     def example_label(node, div, name)
-      n = get_anchors[node["id"]]
+      n = @xrefs.get[node["id"]]
       div.p **{ class: "example-title" } do |p|
         lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @example_lbl :
           l10n("#{@example_lbl} #{n[:label]}")
@@ -56,7 +56,7 @@ module IsoDoc::Function
     end
 
     def note_label(node)
-      n = get_anchors[node["id"]]
+      n = @xrefs.get[node["id"]]
       return @note_lbl if n.nil? || n[:label].nil? || n[:label].empty?
       l10n("#{@note_lbl} #{n[:label]}")
     end

data/lib/isodoc/function/inline.rb

@@ -17,17 +17,17 @@ module IsoDoc::Function
     end
 
     def prefix_container(container, linkend, _target)
-      l10n(anchor(container, :xref) + ", " + linkend)
+      l10n(@xrefs.anchor(container, :xref) + ", " + linkend)
     end
 
     def anchor_linkend(node, linkend)
       if node["citeas"].nil? && node["bibitemid"] 
-        return anchor(node["bibitemid"] ,:xref) || "???"
+        return @xrefs.anchor(node["bibitemid"] ,:xref) || "???"
       elsif node["target"] && !/.#./.match(node["target"])
-        linkend = anchor(node["target"], :xref)
-        container = anchor(node["target"], :container, false)
+        linkend = @xrefs.anchor(node["target"], :xref)
+        container = @xrefs.anchor(node["target"], :container, false)
         (container && get_note_container_id(node) != container &&
-         @anchors[node["target"]]) &&
+         @xrefs.get[node["target"]]) &&
         linkend = prefix_container(container, linkend, node["target"])
         linkend = capitalise_xref(node, linkend)
       end

data/lib/isodoc/function/references.rb

@@ -16,22 +16,24 @@ module IsoDoc::Function
         identifiers = render_identifier(ids)
         if biblio then ref_entry_code(ref, ordinal, identifiers, ids)
         else
-          ref << "#{identifiers[0] || identifiers[1]}, "
-          ref << "#{identifiers[1]}, " if identifiers[0] && identifiers[1]
+          ref << "#{identifiers[0] || identifiers[1]}"
+          ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
         end
+        ref << ", " unless biblio && !identifiers[1]
         reference_format(b, ref)
       end
     end
 
     def std_bibitem_entry(list, b, ordinal, biblio)
       list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
-        ids = bibitem_ref_code(b)
-        identifiers = render_identifier(ids)
-        prefix_bracketed_ref(ref, "[#{ordinal}]") if biblio
-        ref << "#{identifiers[0] || identifiers[1]}"
-        ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
+        identifiers = render_identifier(bibitem_ref_code(b))
+        if biblio then ref_entry_code(ref, ordinal, identifiers, nil)
+        else
+          ref << "#{identifiers[0] || identifiers[1]}"
+          ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
+        end
         date_note_process(b, ref)
-        ref << ", "
+        ref << ", " unless biblio && !identifiers[1]
         reference_format(b, ref)
       end
     end
@@ -40,9 +42,7 @@ module IsoDoc::Function
     # else, use both ordinal, as prefix, and t
     def ref_entry_code(r, ordinal, t, id)
       prefix_bracketed_ref(r, t[0] || "[#{ordinal}]")
-      if t[1]
-        r << "#{t[1]}, "
-      end
+      t[1] and r << "#{t[1]}"
     end
 
     def pref_ref_code(b)
@@ -129,12 +129,6 @@ module IsoDoc::Function
       end
     end
 
-    ISO_PUBLISHER_XPATH =
-      "./contributor[xmlns:role/@type = 'publisher']/"\
-      "organization[abbreviation = 'ISO' or xmlns:abbreviation = 'IEC' or "\
-      "xmlns:name = 'International Organization for Standardization' or "\
-      "xmlns:name = 'International Electrotechnical Commission']".freeze
-
     def is_standard(b)
       ret = false
       b.xpath(ns("./docidentifier")).each do |id|
@@ -159,22 +153,33 @@ module IsoDoc::Function
       end
     end
 
+    def norm_ref_xpath
+      "//bibliography/references[@normative = 'true'] | "\
+      "//bibliography/clause[.//references[@normative = 'true']]"
+    end
+
     def norm_ref(isoxml, out, num)
-      q = "//bibliography/references[@normative = 'true']"
-      f = isoxml.at(ns(q)) or return num
+      f = isoxml.at(ns(norm_ref_xpath)) or return num
       out.div do |div|
         num = num + 1
         clause_name(num, @normref_lbl, div, nil)
-        biblio_list(f, div, false)
+        if f.name == "clause"
+          f.elements.each { |e| parse(e, div) unless e.name == "title" }
+        else
+          biblio_list(f, div, false)
+        end
       end
       num
     end
 
-    BIBLIOGRAPHY_XPATH = "//bibliography/clause[.//references[@normative = 'false']] | "\
-      "//bibliography/references[@normative = 'false']".freeze
+    def bibliography_xpath 
+      "//bibliography/clause[.//references]"\
+      "[not(.//references[@normative = 'true'])] | "\
+      "//bibliography/references[@normative = 'false']"
+    end
 
     def bibliography(isoxml, out)
-      f = isoxml.at(ns(BIBLIOGRAPHY_XPATH)) || return
+      f = isoxml.at(ns(bibliography_xpath)) || return
       page_break(out)
       out.div do |div|
         div.h1 @bibliography_lbl, **{ class: "Section3" }
@@ -185,7 +190,7 @@ module IsoDoc::Function
     def bibliography_parse(node, out)
       title = node&.at(ns("./title"))&.text || ""
       out.div do |div|
-        anchor(node['id'], :label, false) and
+        @xrefs.anchor(node['id'], :label, false) and
           clause_parse_title(node, div, node.at(ns("./title")), out) or
           div.h2 title, **{ class: "Section3" }
         biblio_list(node, div, true)
@@ -199,16 +204,6 @@ module IsoDoc::Function
         ref
     end
 
-    def reference_names(ref)
-      isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
-      ids = bibitem_ref_code(ref)
-      identifiers = render_identifier(ids)
-      date = ref.at(ns("./date[@type = 'published']"))
-      allparts = ref.at(ns("./extent[@type='part'][referenceFrom='all']"))
-      reference = docid_l10n(identifiers[0] || identifiers[1])
-      @anchors[ref["id"]] = { xref: reference }
-    end
-
     # def ref_names(ref)
     #  linkend = ref.text
     # linkend.gsub!(/[\[\]]/, "") unless /^\[\d+\]$/.match linkend