isodoc 1.1.1 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fe7dc7a4c361573ce166000c4b747853185889ed1385f6219da5ecd9bf33b73
-  data.tar.gz: 2da4bf7a5c8a282bdfee95b96b99322c246712405b429404d5accf3385f9b360
+  metadata.gz: 51829acf741b07dd3c2ab2be2d56ca10aa26f32cd45830c53fe53a0ac26c8ad5
+  data.tar.gz: f7e70d7ca7b40958a35799f564c05b0a3d5342efdf3c6e3dd5e41536a7bb9825
 SHA512:
-  metadata.gz: 62e7510c6f20ac7d8773d112bc25957c543097164e3b794dcc05d9b241be70317ea37295e9da8d3fcf61aec5597471091af2912277977db1fa266dd3f5351cae
-  data.tar.gz: 6c09ae0a60b767cd4d3dd4ce22a6df2609ea8d1a21f29863a5c5ca27283ebe5897f0d530bf89212dc7b8cd4788641f66d04d646a04189f9c3c379e058d3c50c7
+  metadata.gz: e2ff423a107d6b06cc723c943ac2311513c78a46d8b63f4ded2e8b7ebf94794d00796ef2b52ad2921dc1efd97cbba8bc43b29b0e8091b2c9430627db67a75f4f
+  data.tar.gz: ec09dbbcf25e13bb08352f49d77c1565473f768af554a3d2b1b7311b0862f63e730fee0f69b7af82f99ce8f3a020b3088b429ed253a9852708138867dd848519

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 "rake", "~> 13.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/all.css

@@ -0,0 +1,207 @@
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0; }
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  border: 0;
+  font-size: 100%; }
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, tt, var,
+b, u, i, center,
+dl, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  vertical-align: baseline; }
+
+html, body, div, span, applet, object, iframe,
+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,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  font-family: {{bodyfont}}; }
+
+code, pre, tt, kbd, samp {
+  font-family: {{monospacefont}};
+  font-variant-ligatures: none; }
+
+code *, pre *, tt *, kbd *, samp * {
+  font-family: {{monospacefont}} !important;
+  font-variant-ligatures: none; }
+
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+  display: block; }
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0; }
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: {{headerfont}}; }
+
+blockquote, q {
+  quotes: none; }
+  blockquote:before, blockquote:after, q:before, q:after {
+    content: '';
+    content: none; }
+
+.h2Annex {
+  font-family: {{headerfont}}; }
+
+dl {
+  display: grid;
+  grid-template-columns: max-content auto; }
+  dl dt p, dl dd p {
+    margin-top: 0; }
+  dl dt {
+    grid-column-start: 1; }
+  dl dd {
+    grid-column-start: 2; }
+
+b, strong {
+  font-weight: bold; }
+
+div.document-stage-band, div.document-type-band {
+  background-color: #333333; }
+
+#standard-band {
+  background-color: #0AC442; }
+
+#standard {
+  border-bottom: solid 3px #0AC442; }
+
+#directive-band {
+  background-color: #540D6E; }
+
+#directive {
+  border-bottom: solid 3px #540D6E; }
+
+#guide-band {
+  background-color: #D183C9; }
+
+#guide {
+  border-bottom: solid 3px #D183C9; }
+
+#specification-band {
+  background-color: #65AFFF; }
+
+#specification {
+  border-bottom: solid 3px #65AFFF; }
+
+#report-band {
+  background-color: #3A405A; }
+
+#report {
+  border-bottom: solid 3px #3A405A; }
+
+#amendment-band {
+  background-color: #F26430; }
+
+#amendment {
+  border-bottom: solid 3px #F26430; }
+
+#corrigendum-band {
+  background-color: #C84630; }
+
+#corrigendum {
+  border-bottom: solid 3px #C84630; }
+
+#administrative-band {
+  background-color: #BFAE48; }
+
+#administrative {
+  border-bottom: solid 3px #BFAE48; }
+
+#advisory-band {
+  background-color: #BD9391; }
+
+#advisory {
+  border-bottom: solid 3px #BD9391; }
+
+#proposal-band {
+  background-color: #39A0ED; }
+
+#proposal {
+  border-bottom: solid 3px #39A0ED; }
+
+#working-draft-band {
+  background-color: #2D7393; }
+
+#working-draft {
+  border-bottom: solid 3px #2D7393; }
+
+#committee-draft-band {
+  background-color: #2A6B7C; }
+
+#committee-draft {
+  border-bottom: solid 3px #2A6B7C; }
+
+#draft-standard-band {
+  background-color: #1C7F7A; }
+
+#draft-standard {
+  border-bottom: solid 3px #1C7F7A; }
+
+#final-draft-band {
+  background-color: #53C170; }
+
+#final-draft {
+  border-bottom: solid 3px #53C170; }
+
+#published-band {
+  background-color: #069E2D; }
+
+#published {
+  border-bottom: solid 3px #069E2D; }
+
+#withdrawn-band {
+  background-color: #004E64; }
+
+#withdrawn {
+  border-bottom: solid 3px #004E64; }
+
+#cancelled-band {
+  background-color: #2E382E; }
+
+#cancelled {
+  border-bottom: solid 3px #2E382E; }

data/lib/isodoc/base_style/metanorma_word.css

@@ -0,0 +1,34 @@
+div.table_container {
+  margin-bottom: 14pt; }
+
+ol {
+  margin-bottom: 0cm; }
+
+ul {
+  margin-bottom: 0cm; }
+
+table.MsoISOTable tr {
+  page-break-inside: avoid; }
+
+td {
+  page-break-inside: avoid; }
+
+tr {
+  page-break-after: avoid; }
+
+span.stem {
+  font-family: "Cambria Math",serif;
+  mso-ascii-font-family: "Cambria Math";
+  font-style: italic; }
+
+dt {
+  page-break-inside: avoid;
+  page-break-after: avoid; }
+
+br.section {
+  page-break-before: always;
+  mso-break-type: section-break; }
+
+br.pagebreak {
+  page-break-before: always;
+  mso-special-character: line-break; }

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.css

@@ -0,0 +1,105 @@
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0; }
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  border: 0;
+  font-size: 100%; }
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, tt, var,
+b, u, i, center,
+dl, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  vertical-align: baseline; }
+
+html, body, div, span, applet, object, iframe,
+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,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  font-family: {{bodyfont}}; }
+
+code, pre, tt, kbd, samp {
+  font-family: {{monospacefont}};
+  font-variant-ligatures: none; }
+
+code *, pre *, tt *, kbd *, samp * {
+  font-family: {{monospacefont}} !important;
+  font-variant-ligatures: none; }
+
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+  display: block; }
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0; }
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: {{headerfont}}; }
+
+blockquote, q {
+  quotes: none; }
+  blockquote:before, blockquote:after, q:before, q:after {
+    content: '';
+    content: none; }
+
+.h2Annex {
+  font-family: {{headerfont}}; }
+
+dl {
+  display: grid;
+  grid-template-columns: max-content auto; }
+  dl dt p, dl dd p {
+    margin-top: 0; }
+  dl dt {
+    grid-column-start: 1; }
+  dl dd {
+    grid-column-start: 2; }
+
+b, strong {
+  font-weight: bold; }
+
+div.document-stage-band, div.document-type-band {
+  background-color: #333333; }

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,55 @@ 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))
+    def html_doc_path(*file)
+      file.each do |f|
+        ret = File.join(@libdir, File.join('html', f))
+        File.exist?(ret) and return ret
+      end
+      nil
+    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 +196,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 +217,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 +243,7 @@ module IsoDoc
 
     def middle_clause
       "//clause[parent::sections][not(xmlns:title = 'Scope')]"\
-      "[not(descendant::terms)]".freeze
+        '[not(descendant::terms)]'
     end
   end
 end