isodoc 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 708e958deabed499e51692381679f293bebad4e75e664200910e49b77c518184
-  data.tar.gz: d0a7243ab00a620c92acb69e1844494e68f6a055ff18cf56d6681f73ef53b660
+  metadata.gz: 75ecf3fa764d00da20d4334b09534a204da5937eaef686dc341789b90d12a5a7
+  data.tar.gz: 8e4ed1c6fa123a51507ea403be8ea462d272ca19c0107d0c30cf87a6c842f68a
 SHA512:
-  metadata.gz: c8127ecb1d1102c8eec50c8bb79c7d807525cdab884a80b889846cbe740bde1625b41260b8d2c67bd679afbe46e766577a37e9567d7bc880cc81ec902053e07d
-  data.tar.gz: 59ff53f328714281dea1c8d83130771669f087054cd789276e1370536b627a397b635026407837e998b0272c2c8a3bc954e5863f39f9a5860b8f589bcd576248
+  metadata.gz: dbca0780e09eca6364b99cb71b66799d9440a25df70c13c4e54bed3c884e19437f4d84e916816bb34234323ccf98c0589586bffb024b428ff0fef37334c8068c
+  data.tar.gz: 8bc973b97d542a380822f66900ef1208fec7308ebb396e7a6588022578ee7e6af59cf91bb6ff7634ca675d4e8a2fcbd2379c061eb2498f29398d1166bf71d1a5

data/bin/rspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-  
+
 # This file was generated by Bundler.
 #
 # The application 'rspec' is installed as part of a gem, and
@@ -15,4 +15,3 @@ require "rubygems"
 require "bundler/setup"
 
 load Gem.bin_path("rspec-core", "rspec")
-

data/lib/isodoc/convert.rb

@@ -163,9 +163,9 @@ module IsoDoc
       FileUtils.rm_rf dir
     end
 
-    def middle_clause(docxml = nil)
+    def middle_clause(_docxml = nil)
       "//clause[parent::sections][not(@type = 'scope')]"\
-        '[not(descendant::terms)]'
+        "[not(descendant::terms)]"
     end
 
     def target_pdf(node)

data/lib/isodoc/css.rb

@@ -6,17 +6,20 @@ module IsoDoc
     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, '.*')
+        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
 
     def localpath(path)
-      return path if %r{^[A-Z]:|^/|^file:/}.match(path)
+      return path if %r{^[A-Z]:|^/|^file:/}.match?(path)
       return path unless (@sourcedir || @localdir) && path
+
       File.expand_path(File.join((@sourcedir || @localdir), path))
     end
 
@@ -34,9 +37,9 @@ module IsoDoc
 
     def default_fonts(_options)
       {
-        bodyfont: 'Arial',
-        headerfont: 'Arial',
-        monospacefont: 'Courier',
+        bodyfont: "Arial",
+        headerfont: "Arial",
+        monospacefont: "Courier",
       }
     end
 
@@ -48,35 +51,35 @@ module IsoDoc
 
     def fonts_options
       {
-        'bodyfont' => options[:bodyfont] || 'Arial',
-        'headerfont' => options[:headerfont] || 'Arial',
-        'monospacefont' => options[:monospacefont] || 'Courier',
+        "bodyfont" => options[:bodyfont] || "Arial",
+        "headerfont" => options[:headerfont] || "Arial",
+        "monospacefont" => options[:monospacefont] || "Courier",
         "normalfontsize" => options[:normalfontsize],
         "monospacefontsize" => options[:monospacefontsize],
         "smallerfontsize" => options[:smallerfontsize],
-        "footnotefontsize" => options[:footnotefontsize] 
+        "footnotefontsize" => options[:footnotefontsize],
       }
     end
 
     def scss_fontheader(is_html_css)
-      b = options[:bodyfont] || 'Arial'
-      h = options[:headerfont] || 'Arial'
-      m = options[:monospacefont] || 'Courier'
-      ns = options[:normalfontsize] || (is_html_css ? "1.0em" : '12.0pt')
-      ms = options[:monospacefontsize] || (is_html_css ? "0.8em" : '11.0pt')
-      ss = options[:smallerfontsize] || (is_html_css ? "0.9em" : '10.0pt')
-      fs = options[:footnotefontsize] || (is_html_css ? "0.9em" : '9.0pt')
+      b = options[:bodyfont] || "Arial"
+      h = options[:headerfont] || "Arial"
+      m = options[:monospacefont] || "Courier"
+      ns = options[:normalfontsize] || (is_html_css ? "1.0em" : "12.0pt")
+      ms = options[:monospacefontsize] || (is_html_css ? "0.8em" : "11.0pt")
+      ss = options[:smallerfontsize] || (is_html_css ? "0.9em" : "10.0pt")
+      fs = options[:footnotefontsize] || (is_html_css ? "0.9em" : "9.0pt")
       "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"\
         "$normalfontsize: #{ns};\n$monospacefontsize: #{ms};\n"\
         "$smallerfontsize: #{ss};\n$footnotefontsize: #{fs};\n"
     end
 
     def convert_scss(filename, stylesheet, stripwordcss)
-      require 'sassc'
-      require 'isodoc/sassc_importer'
+      require "sassc"
+      require "isodoc/sassc_importer"
 
-      [File.join(Gem.loaded_specs['isodoc'].full_gem_path,
-                 'lib', 'isodoc'),
+      [File.join(Gem.loaded_specs["isodoc"].full_gem_path,
+                 "lib", "isodoc"),
                  File.dirname(filename)].each do |name|
                    SassC.load_paths << name
                  end
@@ -88,15 +91,16 @@ module IsoDoc
     # stripwordcss if HTML stylesheet, !stripwordcss if DOC stylesheet
     def generate_css(filename, stripwordcss)
       return nil if filename.nil?
+
       filename = precompiled_style_or_original(filename)
-      stylesheet = File.read(filename, encoding: 'UTF-8')
+      stylesheet = File.read(filename, encoding: "UTF-8")
       stylesheet = populate_template(stylesheet, :word)
-      stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, '\\1') if stripwordcss
-      if File.extname(filename) == '.scss'
+      stylesheet.gsub!(/(\s|\{)mso-[^:]+:[^;]+;/m, "\\1") if stripwordcss
+      if File.extname(filename) == ".scss"
         stylesheet = convert_scss(filename, stylesheet, stripwordcss)
       end
-      Tempfile.open([File.basename(filename, '.*'), 'css'],
-                    encoding: 'utf-8') do |f|
+      Tempfile.open([File.basename(filename, ".*"), "css"],
+                    encoding: "utf-8") do |f|
         f.write(stylesheet)
         f
       end

data/lib/isodoc/function/blocks.rb

@@ -24,6 +24,7 @@ module IsoDoc::Function
     def figure_parse(node, out)
       return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
         node["type"] == "pseudocode"
+
       @in_figure = true
       out.div **figure_attrs(node) do |div|
         node.children.each do |n|
@@ -51,6 +52,7 @@ module IsoDoc::Function
 
     def sourcecode_name_parse(node, div, name)
       return if name.nil? 
+
       div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
         name.children.each { |n| parse(n, p) }
       end
@@ -91,14 +93,15 @@ module IsoDoc::Function
       @annotation = false
     end
 
-    def admonition_class(node)
+    def admonition_class(_node)
       "Admonition"
     end
 
     def admonition_name(node, type)
       name = node&.at(ns("./name")) and return name
-      name = Nokogiri::XML::Node.new('name', node.document)
+      name = Nokogiri::XML::Node.new("name", node.document)
       return unless type && @i18n.admonition[type]
+
       name << @i18n.admonition[type]&.upcase
       name
     end
@@ -119,7 +122,8 @@ module IsoDoc::Function
 
     def formula_where(dl, out)
       return unless dl
-      out.p **{ style: "page-break-after:avoid;"} do |p|
+
+      out.p **{ style: "page-break-after:avoid;" } do |p|
         p << @i18n.where
       end
       parse(dl, out)
@@ -148,6 +152,7 @@ module IsoDoc::Function
         formula_where(node.at(ns("./dl")), div)
         node.children.each do |n|
           next if %w(stem dl name).include? n.name
+
           parse(n, div)
         end
       end
@@ -182,6 +187,7 @@ module IsoDoc::Function
       author = node.at(ns("./author"))
       source = node.at(ns("./source"))
       return if author.nil? && source.nil?
+
       out.p **{ class: "QuoteAttribution" } do |p|
         p << "&mdash; #{author.text}" if author
         p << ", " if author && source
@@ -201,8 +207,9 @@ module IsoDoc::Function
     end
 
     def passthrough_parse(node, out)
-      return if node["format"] and
+      return if node["format"] &&
         !(node["format"].split(/,/).include? @format.to_s)
+
       out.passthrough node.text
     end
 

data/lib/isodoc/function/blocks_example_note.rb

@@ -59,7 +59,7 @@ module IsoDoc::Function
       name = node&.at(ns("./name"))&.remove
       div.p do |p|
         name and p.span **{ class: "note_label" } do |s|
-          name and name.children.each { |n| parse(n, s) }
+          name.children.each { |n| parse(n, s) }
           s << note_delim
         end
         insert_tab(p, 1)
@@ -98,7 +98,7 @@ module IsoDoc::Function
       @note = true
       out.div **note_attrs(node) do |div|
         node&.at(ns("./*[local-name() != 'name'][1]"))&.name == "p" ?
-        #node.first_element_child.name == "p" ?
+        # node.first_element_child.name == "p" ?
           note_p_parse(node, div) : note_parse1(node, div)
       end
       @note = false

data/lib/isodoc/function/cleanup.rb

@@ -204,8 +204,7 @@ module IsoDoc::Function
       docxml
     end
 
-    def symbols_cleanup(docxml)
-    end
+    def symbols_cleanup(docxml); end
 
     def table_footnote_reference_format(a)
       a

data/lib/isodoc/function/utils.rb

@@ -28,10 +28,10 @@ module IsoDoc::Function
     # to allow for HTMLentities
     def noko(&block)
       doc = ::Nokogiri::XML.parse(NOKOHEAD)
-      fragment = doc.fragment('')
+      fragment = doc.fragment("")
       ::Nokogiri::XML::Builder.with fragment, &block
-      fragment.to_xml(encoding: 'US-ASCII').lines.map do |l|
-        l.gsub(/\s*\n/, '')
+      fragment.to_xml(encoding: "US-ASCII").lines.map do |l|
+        l.gsub(/\s*\n/, "")
       end
     end
 
@@ -46,17 +46,18 @@ module IsoDoc::Function
       '"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
 
     def to_xhtml(xml)
-      xml.gsub!(/<\?xml[^>]*>/, '')
+      xml.gsub!(/<\?xml[^>]*>/, "")
       /<!DOCTYPE /.match(xml) || (xml = DOCTYPE_HDR + xml)
       xml = xml.split(/(\&[^ \r\n\t#;]+;)/).map do |t|
         /^(\&[^ \t\r\n#;]+;)/.match?(t) ?
           HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal) : t
-      end.join('')
+      end.join("")
       begin
         Nokogiri::XML.parse(xml, &:strict)
       rescue Nokogiri::XML::SyntaxError => e
-        File.open("#{@filename}.#{@format}.err", 'w:UTF-8') { |f| f.write xml }
-        abort "Malformed Output XML for #{@format}: #{e} (see #{@filename}.#{@format}.err)"
+        File.open("#{@filename}.#{@format}.err", "w:UTF-8") { |f| f.write xml }
+        abort "Malformed Output XML for #{@format}: #{e} "\
+          "(see #{@filename}.#{@format}.err)"
       end
     end
 
@@ -67,11 +68,12 @@ module IsoDoc::Function
     end
 
     def from_xhtml(xml)
-      xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, '')
+      xml.to_xml.sub(%r{ xmlns="http://www.w3.org/1999/xhtml"}, "")
     end
 
     CLAUSE_ANCESTOR =
       ".//ancestor::*[local-name() = 'annex' or "\
+      "local-name() = 'definitions' or "\
       "local-name() = 'acknowledgements' or local-name() = 'term' or "\
       "local-name() = 'appendix' or local-name() = 'foreword' or "\
       "local-name() = 'introduction' or local-name() = 'terms' or "\
@@ -102,32 +104,32 @@ module IsoDoc::Function
       else
         @i18n.l10n("#{array[0..-2].join(', ')} "\
                    "#{@i18n.and} #{array.last}",
-                                     @lang, @script)
+                   @lang, @script)
       end
     end
 
     # avoid `; avoid {{ (Liquid Templates); avoid [[ (Javascript)
     def extract_delims(text)
-      @openmathdelim = '(#('
-      @closemathdelim = ')#)'
+      @openmathdelim = "(#("
+      @closemathdelim = ")#)"
       while text.include?(@openmathdelim) || text.include?(@closemathdelim)
-        @openmathdelim += '('
-        @closemathdelim += ')'
+        @openmathdelim += "("
+        @closemathdelim += ")"
       end
       [@openmathdelim, @closemathdelim]
     end
 
     def header_strip(h)
-      h = h.to_s.gsub(%r{<br\s*/>}, ' ').gsub(/<\/?h[123456][^>]*>/, '')
-           .gsub(/<\/?b[^>]*>/, '')
+      h = h.to_s.gsub(%r{<br\s*/>}, " ").gsub(/<\/?h[123456][^>]*>/, "")
+        .gsub(/<\/?b[^>]*>/, "")
       h1 = to_xhtml_fragment(h.dup)
       h1.traverse do |x|
-        x.replace(' ') if x.name == 'span' && /mso-tab-count/.match(x['style'])
-        x.remove if x.name == 'img'
-        x.remove if x.name == 'span' && x['class'] == 'MsoCommentReference'
-        x.remove if x.name == 'a' && x['class'] == 'FootnoteRef'
-        x.remove if x.name == 'span' && /mso-bookmark/.match(x['style'])
-        x.replace(x.children) if x.name == 'a'
+        x.replace(" ") if x.name == "span" && /mso-tab-count/.match(x["style"])
+        x.remove if x.name == "img"
+        x.remove if x.name == "span" && x["class"] == "MsoCommentReference"
+        x.remove if x.name == "a" && x["class"] == "FootnoteRef"
+        x.remove if x.name == "span" && /mso-bookmark/.match(x["style"])
+        x.replace(x.children) if x.name == "a"
       end
       from_xhtml(h1)
     end
@@ -139,9 +141,9 @@ module IsoDoc::Function
     def liquid(doc)
       # unescape HTML escapes in doc
       doc = doc.split(%r<(\{%|%\})>).each_slice(4).map do |a|
-        a[2] = a[2].gsub(/\&lt;/, '<').gsub(/\&gt;/, '>') if a.size > 2
-        a.join('')
-      end.join('')
+        a[2] = a[2].gsub(/\&lt;/, "<").gsub(/\&gt;/, ">") if a.size > 2
+        a.join("")
+      end.join("")
       Liquid::Template.parse(doc)
     end
 
@@ -152,20 +154,20 @@ module IsoDoc::Function
 
     def populate_template(docxml, _format = nil)
       meta = @meta
-             .get
-             .merge(@labels ? {labels: @labels} : {})
-             .merge(@meta.labels ? {labels: @meta.labels} : {})
-             .merge(fonts_options || {})
+        .get
+        .merge(@labels ? {labels: @labels} : {})
+        .merge(@meta.labels ? {labels: @meta.labels} : {})
+        .merge(fonts_options || {})
       template = liquid(docxml)
       template.render(meta.map { |k, v| [k.to_s, empty2nil(v)] }.to_h)
-              .gsub('&lt;', '&#x3c;').gsub('&gt;', '&#x3e;').gsub('&amp;', '&#x26;')
+        .gsub("&lt;", "&#x3c;").gsub("&gt;", "&#x3e;").gsub("&amp;", "&#x26;")
     end
 
     def save_dataimage(uri, _relative_dir = true)
       %r{^data:(image|application)/(?<imgtype>[^;]+);base64,(?<imgdata>.+)$} =~ uri
-      imgtype.sub!(/\+[a-z0-9]+$/, '') # svg+xml
-      imgtype = 'png' unless /^[a-z0-9]+$/.match imgtype
-      Tempfile.open(['image', ".#{imgtype}"]) do |f|
+      imgtype.sub!(/\+[a-z0-9]+$/, "") # svg+xml
+      imgtype = "png" unless /^[a-z0-9]+$/.match imgtype
+      Tempfile.open(["image", ".#{imgtype}"]) do |f|
         f.binmode
         f.write(Base64.strict_decode64(imgdata))
         @tempfile_cache << f # persist to the end
@@ -174,18 +176,18 @@ module IsoDoc::Function
     end
 
     def image_localfile(i)
-      if /^data:/.match? i['src']
-        save_dataimage(i['src'], false)
-      elsif %r{^([A-Z]:)?/}.match? i['src']
-        i['src']
+      if /^data:/.match? i["src"]
+        save_dataimage(i["src"], false)
+      elsif %r{^([A-Z]:)?/}.match? i["src"]
+        i["src"]
       else
-        File.join(@localdir, i['src'])
+        File.join(@localdir, i["src"])
       end
     end
 
     def labelled_ancestor(node)
-      !node.ancestors('example, requirement, recommendation, permission, '\
-                             'note, table, figure, sourcecode').empty?
+      !node.ancestors("example, requirement, recommendation, permission, "\
+                      "note, table, figure, sourcecode").empty?
     end
   end
 end

data/lib/isodoc/gem_tasks.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'sassc'
-require 'isodoc/sassc_importer'
-require 'rake/clean'
+require "sassc"
+require "isodoc/sassc_importer"
+require "rake/clean"
 
 module IsoDoc
   module GemTasks
@@ -11,7 +11,7 @@ module IsoDoc
     module_function
 
     def install
-      rule '.css' => [proc { |tn| tn.sub(/\.css$/, '.scss') }] do |current_task|
+      rule ".css" => [proc { |tn| tn.sub(/\.css$/, ".scss") }] do |current_task|
         begin
           puts(current_task)
           compile_scss_task(current_task)
@@ -20,23 +20,23 @@ module IsoDoc
         end
       end
 
-      scss_files = Rake::FileList['lib/**/*.scss']
-      source_files = scss_files.ext('.css')
+      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'))
+          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'))
+          uncomment_out_liquid(File.read(file_name, encoding: "UTF-8"))
         end
-        git_cache_compiled_files && puts('Built scss!')
+        git_cache_compiled_files && puts("Built scss!")
       end
 
-      Rake::Task['build'].enhance [:build_scss] do
+      Rake::Task["build"].enhance [:build_scss] do
         git_rm_compiled_files
         Rake::Task[:clean].invoke
       end
@@ -44,7 +44,7 @@ module IsoDoc
 
     def notify_borken_compilation(error, current_task)
       puts("Cannot compile #{current_task} because of #{error.message}")
-      puts('continue anyway[y|n]?')
+      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}")
@@ -68,7 +68,7 @@ module IsoDoc
     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.open(file_name, "w", encoding: "UTF-8") do |file|
           file.puts(result)
         end
       end
@@ -81,42 +81,41 @@ module IsoDoc
         else
           line
         end
-      end
-          .join("\n")
+      end.join("\n")
     end
 
     def uncomment_out_liquid(text)
       text
-        .gsub('/* LIQUID_COMMENT', '')
-        .gsub('LIQUID_COMMENT */', '')
-        .gsub('"{{', '{{').gsub('}}"', '}}')
+        .gsub("/* LIQUID_COMMENT", "")
+        .gsub("LIQUID_COMMENT */", "")
+        .gsub('"{{', '{{').gsub('}}"', "}}")
     end
 
     def fonts_placeholder
       <<~TEXT
-        $bodyfont: '{{bodyfont}}';
-        $headerfont: '{{headerfont}}';
-        $monospacefont: '{{monospacefont}}';
-        $normalfontsize: '{{normalfontsize}}';
-        $smallerfontsize: '{{smallerfontsize}}';
-        $footnotefontsize: '{{footnotefontsize}}';
-        $monospacefontsize: '{{monospacefontsize}}';
+        $bodyfont: "{{bodyfont}}";
+        $headerfont: "{{headerfont}}";
+        $monospacefont: "{{monospacefont}}";
+        $normalfontsize: "{{normalfontsize}}";
+        $smallerfontsize: "{{smallerfontsize}}";
+        $footnotefontsize: "{{footnotefontsize}}";
+        $monospacefontsize: "{{monospacefontsize}}";
       TEXT
     end
 
     def compile_scss(filename)
-      require 'sassc'
+      require "sassc"
 
-      isodoc_path = if Gem.loaded_specs['isodoc']
-                      File.join(Gem.loaded_specs['isodoc'].full_gem_path, 'lib', 'isodoc')
+      isodoc_path = if Gem.loaded_specs["isodoc"]
+                      File.join(Gem.loaded_specs["isodoc"].full_gem_path, "lib", "isodoc")
                     else
-                      File.join('lib', 'isodoc')
+                      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')
+      sheet_content = File.read(filename, encoding: "UTF-8")
       SassC::Engine.new(fonts_placeholder + sheet_content,
                         syntax: :scss,
                         importer: SasscImporter)
@@ -125,10 +124,10 @@ module IsoDoc
 
     def compile_scss_task(current_task)
       filename = current_task.source
-      basename = File.basename(filename, '.*')
+      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|
+      File.open(compiled_path, "w:UTF-8") do |f|
         f.write(content)
       end
       CLEAN << compiled_path