isodoc 1.0.27 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68d6f17f0d5291c6c067bfc6a3a476885b80f128bdc9c4e3e3d8356c6af30482
-  data.tar.gz: 2710c48aa2fb9eeee44b586107b07884d52802a53fec81d69c0f3fb68fa988ed
+  metadata.gz: 5bd9d095a9d498797d6c48b1465b878f5587107e47f09a76a4148ba3a9618db0
+  data.tar.gz: a0825c515977f0ae8fe7047848480d2e2131be9b3baed8c803ae17aedf6270cd
 SHA512:
-  metadata.gz: 1c38cb43027aa1a056d465660449a4a58e1a5b78474a5f0184fca4164f2af2480720329e5a7181fcc1731151ef15db71019aa9fc34175b779de517006bf85fa6
-  data.tar.gz: '09503b88edfb1db0b3def003bca81c356b40790014953a9bc08de680af8db75222ded714f43a1f6820ec30dbaa2e3f83ac2a5e386f3c757f0d639f086e0b4b2c'
+  metadata.gz: 23b189ba917e52f1822ad80f096b8abb3fb3eca22e06f860fc300c8f3155492da9a7ef1817a43f6674657456885086ba73c5909d0106cdbbd9efe2392269e408
+  data.tar.gz: 2f72ce5902ef2a944f5b49d657e71e0afde82b1d94a2c6e9661d004b54810f7109faa98f2272b651a917da1fbf19e39bd027186e57597b2ae447e8551886e390

data/.github/workflows/macos.yml

@@ -29,18 +29,14 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
+      - name: Install Inkscape
+        run: |
+          brew cask install inkscape
+          inkscape --version
       - name: Update gems
         run: |
           sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer@3.0.1
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -5,6 +5,8 @@ name: ubuntu
 on:
   push:
     branches: [ master ]
+    tags:
+      - '*'
   pull_request:
     paths-ignore:
       - .github/workflows/macos.yml
@@ -29,32 +31,32 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
+      - name: Install Inkscape
+        run: |
+          sudo add-apt-repository ppa:inkscape.dev/stable
+          sudo apt update
+          sudo apt install inkscape
+          inkscape --version
       - name: Update gems
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-      - name: Install Puppeteer
-        run: |
-          sudo apt-get update
-          sudo apt-get install libgbm1
-          npm install -g puppeteer@3.0.1
       - name: Run specs
         run: |
           bundle exec rake
-      - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
+      - name: Trigger repositories
+        if: matrix.ruby == '2.6'
         env:
-          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
-          GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
+          GH_USERNAME: metanorma-ci
+          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
         run: |
           curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
-          for repo in $DEPENDENT_REPOS
+          CLIENT_PAYLOAD=$(cat <<EOF
+          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          EOF
+          )
+          for repo in $REPOS
           do
-            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
           done

data/.github/workflows/windows.yml

@@ -29,20 +29,16 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
+      - name: Install Inkscape
+        run: |
+          choco install --no-progress -y inkscape
+          inkscape --version
       - name: Update gems
         shell: pwsh
         run: |
           gem install bundler
           bundle config --local path vendor/bundle
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '12'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer@3.0.1
       - name: Run specs
         run: |
           bundle exec rake

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.2.1"
-  spec.add_dependency "metanorma", "~> 1.0.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.rb

@@ -21,6 +21,8 @@ require "isodoc/word_convert"
 require "isodoc/pdf_convert"
 require "isodoc/xslfo_convert"
 require "isodoc/headlesshtml_convert"
+require "isodoc/presentation_xml_convert"
+require "isodoc/xref"
 
 module IsoDoc
 

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/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