isodoc 1.1.0 → 1.1.3.pre.alpha3

data/lib/isodoc/gem_tasks.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'sassc'
+require 'isodoc/sassc_importer'
+require 'rake/clean'
+
+module IsoDoc
+  module GemTasks
+    extend Rake::DSL if defined? Rake::DSL
+
+    module_function
+
+    def install
+      rule '.css' => [proc { |tn| tn.sub(/\.css$/, '.scss') }] do |current_task|
+        begin
+          puts(current_task)
+          compile_scss_task(current_task)
+        rescue StandardError => e
+          notify_borken_compilation(e, current_task)
+        end
+      end
+
+      scss_files = Rake::FileList['lib/**/*.scss']
+      source_files = scss_files.ext('.css')
+
+      task :comment_out_liquid do
+        process_css_files(scss_files) do |file_name|
+          comment_out_liquid(File.read(file_name, encoding: 'UTF-8'))
+        end
+      end
+
+      task build_scss: [:comment_out_liquid].push(*source_files) do
+        process_css_files(scss_files) do |file_name|
+          uncomment_out_liquid(File.read(file_name, encoding: 'UTF-8'))
+        end
+        git_cache_compiled_files && puts('Built scss!')
+      end
+
+      Rake::Task['build'].enhance [:build_scss] do
+        git_rm_compiled_files
+        Rake::Task[:clean].invoke
+      end
+    end
+
+    def notify_borken_compilation(error, current_task)
+      puts("Cannot compile #{current_task} because of #{error.message}")
+      puts('continue anyway[y|n]?')
+      answer = STDIN.gets.strip
+      if %w[y yes].include?(answer.strip.downcase)
+        puts("Cannot compile #{current_task} because of #{error.message}")
+      else
+        exit(0)
+      end
+    end
+
+    def git_cache_compiled_files
+      CLEAN.each do |css_file|
+        sh "git add #{css_file}"
+      end
+    end
+
+    def git_rm_compiled_files
+      CLEAN.each do |css_file|
+        sh "git rm --cached #{css_file}"
+      end
+    end
+
+    def process_css_files(scss_files)
+      scss_files.each do |file_name|
+        result = yield(file_name)
+        File.open(file_name, 'w', encoding: 'UTF-8') do |file|
+          file.puts(result)
+        end
+      end
+    end
+
+    def comment_out_liquid(text)
+      text.split("\n").map do |line|
+        if line.match?(/{({|%).+(}|%)}/)
+          "/* LIQUID_COMMENT#{line}LIQUID_COMMENT */"
+        else
+          line
+        end
+      end
+          .join("\n")
+    end
+
+    def uncomment_out_liquid(text)
+      text
+        .gsub('/* LIQUID_COMMENT', '')
+        .gsub('LIQUID_COMMENT */', '')
+        .gsub('"{{', '{{').gsub('}}"', '}}')
+    end
+
+    def fonts_placeholder
+      <<~TEXT
+        $bodyfont: '{{bodyfont}}';
+        $headerfont: '{{headerfont}}';
+        $monospacefont: '{{monospacefont}}';
+      TEXT
+    end
+
+    def compile_scss(filename)
+      require 'sassc'
+
+      isodoc_path = if Gem.loaded_specs['isodoc']
+                      File.join(Gem.loaded_specs['isodoc'].full_gem_path, 'lib', 'isodoc')
+                    else
+                      File.join('lib', 'isodoc')
+                    end
+      [isodoc_path,
+       File.dirname(filename)].each do |name|
+        SassC.load_paths << name
+      end
+      sheet_content = File.read(filename, encoding: 'UTF-8')
+      SassC::Engine.new(fonts_placeholder + sheet_content,
+                        syntax: :scss,
+                        importer: SasscImporter)
+                   .render
+    end
+
+    def compile_scss_task(current_task)
+      filename = current_task.source
+      basename = File.basename(filename, '.*')
+      compiled_path = File.join(File.dirname(filename), "#{basename}.css")
+      content = uncomment_out_liquid(compile_scss(filename))
+      File.open(compiled_path, 'w:UTF-8') do |f|
+        f.write(content)
+      end
+      CLEAN << compiled_path
+    end
+  end
+end

data/lib/isodoc/metadata.rb

@@ -1,10 +1,15 @@
-require_relative "./metadata_date"
+# frozen_string_literal: true
+
+require_relative './metadata_date'
 
 module IsoDoc
   class Metadata
     DATETYPES = %w{published accessed created implemented obsoleted confirmed
-    updated issued received transmitted copied unchanged circulated vote-started
-    vote-ended}.freeze
+                   updated issued received transmitted copied unchanged
+                   circulated vote-started
+                   vote-ended}.freeze
+
+    attr_accessor :fonts_options
 
     def ns(xpath)
       Common::ns(xpath)
@@ -14,13 +19,14 @@ module IsoDoc
       IsoDoc::Function::I18n::l10n(a, b, c)
     end
 
-    def initialize(lang, script, labels)
+    def initialize(lang, script, labels, fonts_options = {})
       @metadata = {}
-      DATETYPES.each { |w| @metadata["#{w.gsub(/-/, "_")}date".to_sym] = "XXX" }
+      DATETYPES.each { |w| @metadata["#{w.gsub(/-/, '_')}date".to_sym] = 'XXX' }
       @lang = lang
       @script = script
       @c = HTMLEntities.new
       @labels = labels
+      @fonts_options = fonts_options
     end
 
     def get
@@ -36,26 +42,26 @@ module IsoDoc
     end
 
     def extract_person_names(authors)
-      authors.inject([]) do |ret, a|
-        if a.at(ns("./name/completename"))
-          ret << a.at(ns("./name/completename")).text
+      authors.reduce([]) do |ret, a|
+        if a.at(ns('./name/completename'))
+          ret << a.at(ns('./name/completename')).text
         else
           fn = []
-          forenames = a.xpath(ns("./name/forename"))
+          forenames = a.xpath(ns('./name/forename'))
           forenames.each { |f| fn << f.text }
-          surname = a&.at(ns("./name/surname"))&.text
-          ret << fn.join(" ") + " " + surname
+          surname = a&.at(ns('./name/surname'))&.text
+          ret << fn.join(' ') + ' ' + surname
         end
       end
     end
 
     def extract_person_affiliations(authors)
-      authors.inject([]) do |m, a|
-        name = a&.at(ns("./affiliation/organization/name"))&.text
-        location = a&.at(ns("./affiliation/organization/address/"\
-                            "formattedAddress"))&.text
-        m << ((!name.nil? && !location.nil?) ? "#{name}, #{location}" :
-          (name || location || ""))
+      authors.reduce([]) do |m, a|
+        name = a&.at(ns('./affiliation/organization/name'))&.text
+        location = a&.at(ns('./affiliation/organization/address/'\
+                            'formattedAddress'))&.text
+        m << (!name.nil? && !location.nil? ? "#{name}, #{location}" :
+          (name || location || ''))
         m
       end
     end
@@ -84,99 +90,99 @@ module IsoDoc
     end
 
     def bibdate(isoxml, _out)
-      isoxml.xpath(ns("//bibdata/date")).each do |d|
-        set("#{d['type'].gsub(/-/, "_")}date".to_sym, Common::date_range(d))
+      isoxml.xpath(ns('//bibdata/date')).each do |d|
+        set("#{d['type'].gsub(/-/, '_')}date".to_sym, Common::date_range(d))
       end
     end
 
     def doctype(isoxml, _out)
-      b = isoxml&.at(ns("//bibdata/ext/doctype"))&.text || return
-      t = b.split(/[- ]/).map{ |w| w.capitalize }.join(" ")
+      b = isoxml&.at(ns('//bibdata/ext/doctype'))&.text || return
+      t = b.split(/[- ]/).map(&:capitalize).join(' ')
       set(:doctype, t)
     end
 
     def iso?(org)
-      name = org&.at(ns("./name"))&.text
-      abbrev = org&.at(ns("./abbreviation"))&.text
-      (abbrev == "ISO" ||
-       name == "International Organization for Standardization" )
+      name = org&.at(ns('./name'))&.text
+      abbrev = org&.at(ns('./abbreviation'))&.text
+      (abbrev == 'ISO' ||
+       name == 'International Organization for Standardization')
     end
 
     def agency(xml)
-      agency = ""
+      agency = ''
       publisher = []
       xml.xpath(ns("//bibdata/contributor[xmlns:role/@type = 'publisher']/"\
-                   "organization")).each do |org|
-        name = org&.at(ns("./name"))&.text
-        agency1 = org&.at(ns("./abbreviation"))&.text || name
+                   'organization')).each do |org|
+        name = org&.at(ns('./name'))&.text
+        agency1 = org&.at(ns('./abbreviation'))&.text || name
         publisher << name if name
-        agency = iso?(org) ?  "ISO/#{agency}" : "#{agency}#{agency1}/"
+        agency = iso?(org) ? "ISO/#{agency}" : "#{agency}#{agency1}/"
       end
-      set(:agency, agency.sub(%r{/$}, ""))
-      set(:publisher, multiple_and(publisher, @labels["and"]))
+      set(:agency, agency.sub(%r{/$}, ''))
+      set(:publisher, multiple_and(publisher, @labels['and']))
     end
 
     def multiple_and(names, andword)
-      return "" if names.length == 0
+      return '' if names.empty?
       return names[0] if names.length == 1
-      names.length == 2 and
-        return l10n("#{names[0]} #{andword} #{names[1]}", @lang, @script)
-      l10n(names[0..-2].join(", ") + " #{andword} #{names[-1]}", @lang, @script)
+      (names.length == 2) &&
+        (return l10n("#{names[0]} #{andword} #{names[1]}", @lang, @script))
+      l10n(names[0..-2].join(', ') + " #{andword} #{names[-1]}", @lang, @script)
     end
 
     def docstatus(isoxml, _out)
-      docstatus = isoxml.at(ns("//bibdata/status/stage"))
+      docstatus = isoxml.at(ns('//bibdata/status/stage'))
       set(:unpublished, true)
       if docstatus
         set(:stage, status_print(docstatus.text))
-        i = isoxml&.at(ns("//bibdata/status/substage"))&.text and
+        (i = isoxml&.at(ns('//bibdata/status/substage'))&.text) &&
           set(:substage, i)
-        i = isoxml&.at(ns("//bibdata/status/iteration"))&.text and
+        (i = isoxml&.at(ns('//bibdata/status/iteration'))&.text) &&
           set(:iteration, i)
         set(:unpublished, unpublished(docstatus.text))
-        unpublished(docstatus.text) and
+        unpublished(docstatus.text) &&
           set(:stageabbr, stage_abbr(docstatus.text))
       end
     end
 
     def stage_abbr(docstatus)
-      status_print(docstatus).split(/ /).
-        map { |s| s[0].upcase }.join("")
+      status_print(docstatus).split(/ /)
+                             .map { |s| s[0].upcase }.join('')
     end
 
     def unpublished(status)
-      !(status.downcase == "published")
+      !status.casecmp('published').zero?
     end
 
     def status_print(status)
-      status.split(/-/).map{ |w| w.capitalize }.join(" ")
+      status.split(/-/).map(&:capitalize).join(' ')
     end
 
     def docid(isoxml, _out)
-      dn = isoxml.at(ns("//bibdata/docidentifier"))
+      dn = isoxml.at(ns('//bibdata/docidentifier'))
       set(:docnumber, dn&.text)
     end
 
     def docnumeric(isoxml, _out)
-      dn = isoxml.at(ns("//bibdata/docnumber"))
+      dn = isoxml.at(ns('//bibdata/docnumber'))
       set(:docnumeric, dn&.text)
     end
 
     def draftinfo(draft, revdate)
-      draftinfo = ""
+      draftinfo = ''
       if draft
-        draftinfo = " (#{@labels["draft_label"]} #{draft}"
+        draftinfo = " (#{@labels['draft_label']} #{draft}"
         draftinfo += ", #{revdate}" if revdate
-        draftinfo += ")"
+        draftinfo += ')'
       end
       l10n(draftinfo, @lang, @script)
     end
 
     def version(isoxml, _out)
-      set(:edition, isoxml&.at(ns("//bibdata/edition"))&.text)
-      set(:docyear, isoxml&.at(ns("//bibdata/copyright/from"))&.text)
-      set(:draft, isoxml&.at(ns("//version/draft"))&.text)
-      revdate = isoxml&.at(ns("//version/revision-date"))&.text
+      set(:edition, isoxml&.at(ns('//bibdata/edition'))&.text)
+      set(:docyear, isoxml&.at(ns('//bibdata/copyright/from'))&.text)
+      set(:draft, isoxml&.at(ns('//version/draft'))&.text)
+      revdate = isoxml&.at(ns('//version/revision-date'))&.text
       set(:revdate, revdate)
       set(:revdate_monthyear, monthyr(revdate))
       set(:draftinfo,
@@ -188,7 +194,7 @@ module IsoDoc
       set(:doctitle, main)
     end
 
-    def subtitle(isoxml, _out)
+    def subtitle(_isoxml, _out)
       nil
     end
 
@@ -199,29 +205,29 @@ module IsoDoc
 
     def relations_partof(isoxml)
       std = isoxml.at(ns("//bibdata/relation[@type = 'partOf']")) || return
-      id = std.at(ns(".//docidentifier"))
+      id = std.at(ns('.//docidentifier'))
       set(:partof, id.text) if id
     end
 
     def relations_obsoletes(isoxml)
       std = isoxml.at(ns("//bibdata/relation[@type = 'obsoletes']")) || return
-      locality = std.at(ns(".//locality"))
-      id = std.at(ns(".//docidentifier"))
+      locality = std.at(ns('.//locality'))
+      id = std.at(ns('.//docidentifier'))
       set(:obsoletes, id.text) if id
       set(:obsoletes_part, locality.text) if locality
     end
 
     def url(xml, _out)
-      a = xml.at(ns("//bibdata/uri[not(@type)]")) and set(:url, a.text)
-      a = xml.at(ns("//bibdata/uri[@type = 'html']")) and set(:html, a.text)
-      a = xml.at(ns("//bibdata/uri[@type = 'xml']")) and set(:xml, a.text)
-      a = xml.at(ns("//bibdata/uri[@type = 'pdf']")) and set(:pdf, a.text)
-      a = xml.at(ns("//bibdata/uri[@type = 'doc']")) and set(:doc, a.text)
+      (a = xml.at(ns('//bibdata/uri[not(@type)]'))) && set(:url, a.text)
+      (a = xml.at(ns("//bibdata/uri[@type = 'html']"))) && set(:html, a.text)
+      (a = xml.at(ns("//bibdata/uri[@type = 'xml']"))) && set(:xml, a.text)
+      (a = xml.at(ns("//bibdata/uri[@type = 'pdf']"))) && set(:pdf, a.text)
+      (a = xml.at(ns("//bibdata/uri[@type = 'doc']"))) && set(:doc, a.text)
     end
 
     def keywords(isoxml, _out)
       ret = []
-      isoxml.xpath(ns("//bibdata/keyword")).each { |kw| ret << kw.text }
+      isoxml.xpath(ns('//bibdata/keyword')).each { |kw| ret << kw.text }
       set(:keywords, ret)
     end
   end

data/lib/isodoc/sassc_importer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'sassc'
+
+class SasscImporter < SassC::Importer
+  def imports(path, _parent_path)
+    unless path.match?(/(css|scss)$/)
+      Import.new("#{path}.scss")
+    end
+  end
+end

data/lib/isodoc/version.rb

@@ -1,3 +1,3 @@
 module IsoDoc
-  VERSION = "1.1.0".freeze
+  VERSION = "1.1.3-alpha3".freeze
 end

data/lib/isodoc/xref/xref_sect_gen.rb

@@ -5,9 +5,7 @@ module IsoDoc::XrefGen
         annex_names(c, (65 + i).chr.to_s)
       end
       docxml.xpath(
-        ns("//bibliography/clause[.//references[@normative = 'false']] | "\
-           "//bibliography/references[@normative = 'false']"
-          )).each do |b|
+           ns(@klass.bibliography_xpath)).each do |b|
             preface_names(b)
           end
           docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
@@ -20,9 +18,7 @@ module IsoDoc::XrefGen
       # potentially overridden in middle_section_asset_names()
       sequential_asset_names(d.xpath(ns("//preface/*")))
       n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
-      n = section_names(d.at(ns(
-        "//bibliography/clause[.//references[@normative = 'true']] | "\
-        "//bibliography/references[@normative = 'true']")), n, 1)
+      n = section_names(d.at(ns(@klass.norm_ref_xpath)), n, 1)
       n = section_names(d.at(ns("//sections/terms | "\
                                 "//sections/clause[descendant::terms]")), n, 1)
       n = section_names(d.at(ns("//sections/definitions")), n, 1)
@@ -65,7 +61,7 @@ module IsoDoc::XrefGen
 
     def middle_section_asset_names(d)
       middle_sections = "//clause[title = 'Scope'] | "\
-        "//references[@normative = 'true'] | "\
+        "#{@klass.norm_ref_xpath} | "\
         "//sections/terms | //preface/* | "\
         "//sections/definitions | //clause[parent::sections]"
       sequential_asset_names(d.xpath(ns(middle_sections)))

data/spec/isodoc/footnotes_spec.rb

@@ -138,7 +138,7 @@ RSpec.describe IsoDoc do
 
   it "processes IsoXML reviewer notes (HTML)" do
     FileUtils.rm_f "test.html"
-    IsoDoc::HtmlConvert.new({wordstylesheet: "spec/assets/word.css", htmlstylesheet: "spec/assets/html.css"}).convert("test", <<~"INPUT", false)
+    IsoDoc::HtmlConvert.new({wordstylesheet: "spec/assets/word.css", htmlstylesheet: "spec/assets/html.scss"}).convert("test", <<~"INPUT", false)
     <iso-standard xmlns="http://riboseinc.com/isoxml">
     <preface>
     <foreword>
@@ -192,7 +192,7 @@ RSpec.describe IsoDoc do
 
   it "processes IsoXML reviewer notes (Word)" do
     FileUtils.rm_f "test.doc"
-    IsoDoc::WordConvert.new({wordstylesheet: "spec/assets/word.css", htmlstylesheet: "spec/assets/html.css"}).convert("test", <<~"INPUT", false)
+    IsoDoc::WordConvert.new({wordstylesheet: "spec/assets/word.css", htmlstylesheet: "spec/assets/html.scss"}).convert("test", <<~"INPUT", false)
     <iso-standard xmlns="http://riboseinc.com/isoxml">
     <preface>
     <foreword>