isodoc 1.6.0 → 1.6.5

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,32 +11,30 @@ module IsoDoc
     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
+      rule ".css" => [proc { |tn| tn.sub(/\.css$/, ".scss") }] do |current_task|
+        puts(current_task)
+        compile_scss_task(current_task)
+      rescue StandardError => e
+        notify_borken_compilation(e, current_task)
       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 +42,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 +66,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,54 +79,54 @@ 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)
-                   .render
+        .render
     end
 
     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

data/lib/isodoc/headlesshtml_convert.rb

@@ -1,11 +1,10 @@
-require_relative "html_function/comments.rb"
-require_relative "html_function/footnotes.rb"
-require_relative "html_function/html.rb"
+require_relative "html_function/comments"
+require_relative "html_function/footnotes"
+require_relative "html_function/html"
 require "fileutils"
 
 module IsoDoc
   class HeadlessHtmlConvert < ::IsoDoc::Convert
-
     include HtmlFunction::Comments
     include HtmlFunction::Footnotes
     include HtmlFunction::Html
@@ -26,16 +25,18 @@ module IsoDoc
       docxml, filename, dir = convert_init(file, input_filename, debug)
       result = convert1(docxml, filename, dir)
       return result if debug
-      postprocess(result, filename + ".tmp.html", dir)
+
+      postprocess(result, "#{filename}.tmp.html", dir)
       FileUtils.rm_rf dir
-      strip_head(filename + ".tmp.html", output_filename || "#{filename}.#{@suffix}")
+      strip_head("#{filename}.tmp.html",
+                 output_filename || "#{filename}.#{@suffix}")
       FileUtils.rm_rf ["#{filename}.tmp.html", tmpimagedir]
     end
 
     def strip_head(input, output)
       file = File.read(input, encoding: "utf-8")
       doc = Nokogiri::XML(file)
-      doc.xpath("//head").each { |x| x.remove }
+      doc.xpath("//head").each(&:remove)
       doc.xpath("//html").each { |x| x.name = "div" }
       body = doc.at("//body")
       body.replace(body.children)

data/lib/isodoc/html_convert.rb

@@ -1,13 +1,16 @@
-require_relative "html_function/comments.rb"
-require_relative "html_function/footnotes.rb"
-require_relative "html_function/html.rb"
-require_relative "html_function/postprocess.rb"
+require_relative "html_function/comments"
+require_relative "html_function/footnotes"
+require_relative "html_function/html"
+require_relative "html_function/postprocess"
+require_relative "html_function/sectionsplit"
+require_relative "html_function/form"
 
 module IsoDoc
   class HtmlConvert < ::IsoDoc::Convert
 
     include HtmlFunction::Comments
     include HtmlFunction::Footnotes
+    include HtmlFunction::Form
     include HtmlFunction::Html
 
     def tmpimagedir_suffix
@@ -21,6 +24,9 @@ module IsoDoc
     end
 
     def convert(filename, file = nil, debug = false, output_filename = nil)
+      @sectionsplit and
+        return sectionsplit_convert(filename, file, debug, output_filename)
+
       ret = super
       Dir.exists?(tmpimagedir) and Dir["#{tmpimagedir}/*"].empty? and
         FileUtils.rm_r tmpimagedir

data/lib/isodoc/html_function/comments.rb

@@ -24,16 +24,16 @@ module IsoDoc::HtmlFunction
 =end
     end
 
-    def comment_link_attrs(fn, node)
-      { style: "MsoCommentReference", target: fn,
+    def comment_link_attrs(fnote, node)
+      { style: "MsoCommentReference", target: fnote,
         class: "commentLink", from: node["from"],
         to: node["to"] }
     end
 
     # add in from and to links to move the comment into place
-    def make_comment_link(out, fn, node)
-      out.span(**comment_link_attrs(fn, node)) do |s1|
-          s1.a **{ style: "mso-comment-reference:SMC_#{fn};"\
+    def make_comment_link(out, fnote, node)
+      out.span(**comment_link_attrs(fnote, node)) do |s1|
+          s1.a **{ style: "mso-comment-reference:SMC_#{fnote};"\
                    "mso-comment-date:#{node['date'].gsub(/[-:Z]/, '')}" }
         end
     end
@@ -44,9 +44,9 @@ module IsoDoc::HtmlFunction
         end
     end
 
-    def make_comment_text(node, fn)
+    def make_comment_text(node, fnote)
       noko do |xml|
-        xml.div **{ style: "mso-element:comment", id: fn } do |div|
+        xml.div **{ style: "mso-element:comment", id: fnote } do |div|
           div.span **{ style: %{mso-comment-author:"#{node['reviewer']}"} }
           make_comment_target(div)
           node.children.each { |n| parse(n, div) }
@@ -84,6 +84,7 @@ module IsoDoc::HtmlFunction
     def comment_attributes(docxml, x)
       fromlink = docxml.at("//*[@id='#{x['from']}']")
       return(nil) if fromlink.nil?
+
       tolink = docxml.at("//*[@id='#{x['to']}']") || fromlink
       target = docxml.at("//*[@id='#{x['target']}']")
       { from: fromlink, to: tolink, target: target }
@@ -98,13 +99,13 @@ module IsoDoc::HtmlFunction
       from["style"] != "mso-special-character:comment"
     end
 
-    def insert_comment_cont(from, to, target)
-      # includes_to = from.at(".//*[@id='#{to}']")
-      while !from.nil? && from["id"] != to
+    def insert_comment_cont(from, upto, target)
+      # includes_to = from.at(".//*[@id='#{upto}']")
+      while !from.nil? && from["id"] != upto
         following = from.xpath("./following::*")
-        (from = following.shift) && incl_to = from.at(".//*[@id='#{to}']")
+        (from = following.shift) && incl_to = from.at(".//*[@id='#{upto}']")
         while !incl_to.nil? && !from.nil? && skip_comment_wrap(from)
-          (from = following.shift) && incl_to = from.at(".//*[@id='#{to}']")
+          (from = following.shift) && incl_to = from.at(".//*[@id='#{upto}']")
         end
         wrap_comment_cont(from, target) if !from.nil?
       end
@@ -122,6 +123,7 @@ module IsoDoc::HtmlFunction
       comments = []
       docxml.xpath("//div[@style='mso-element:comment']").each do |c|
         next unless c["id"] && !link_order[c["id"]].nil?
+
         comments << { text: c.remove.to_s, id: c["id"] }
       end
       comments.sort! { |a, b| link_order[a[:id]] <=> link_order[b[:id]] }

data/lib/isodoc/html_function/footnotes.rb

@@ -3,6 +3,7 @@ module IsoDoc::HtmlFunction
 
     def footnotes(div)
       return if @footnotes.empty?
+
       @footnotes.each { |fn| div.parent << fn }
     end
 
@@ -44,15 +45,19 @@ module IsoDoc::HtmlFunction
     def get_table_ancestor_id(node)
       table = node.ancestors("table") || node.ancestors("figure")
       return UUIDTools::UUID.random_create.to_s if table.empty?
+
       table.last["id"]
     end
 
+    # @seen_footnote:
+    # do not output footnote text if we have already seen it for this table
+
     def table_footnote_parse(node, out)
       fn = node["reference"] || UUIDTools::UUID.random_create.to_s
       tid = get_table_ancestor_id(node)
       make_table_footnote_link(out, tid + fn, fn)
-      # do not output footnote text if we have already seen it for this table
       return if @seen_footnote.include?(tid + fn)
+
       @in_footnote = true
       out.aside **{ class: "footnote" } do |a|
         a << make_table_footnote_text(node, tid + fn, fn)
@@ -62,8 +67,9 @@ module IsoDoc::HtmlFunction
     end
 
     def footnote_parse(node, out)
-       return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
-        !node.ancestors.map {|m| m.name }.include?("name")
+      return table_footnote_parse(node, out) if (@in_table || @in_figure) &&
+        !node.ancestors.map(&:name).include?("name")
+
       fn = node["reference"] || UUIDTools::UUID.random_create.to_s
       attrs = { class: "FootnoteRef", href: "#fn:#{fn}" }
       out.a **attrs do |a|
@@ -72,12 +78,13 @@ module IsoDoc::HtmlFunction
       make_footnote(node, fn)
     end
 
-    def make_footnote(node, fn)
-      return if @seen_footnote.include?(fn)
+    def make_footnote(node, fnote)
+      return if @seen_footnote.include?(fnote)
+
       @in_footnote = true
-      @footnotes << make_generic_footnote_text(node, fn)
+      @footnotes << make_generic_footnote_text(node, fnote)
       @in_footnote = false
-      @seen_footnote << fn
+      @seen_footnote << fnote
     end
   end
 end

data/lib/isodoc/html_function/form.rb

@@ -0,0 +1,62 @@
+module IsoDoc::HtmlFunction
+  module Form
+    def form_parse(node, out)
+      out.form **attr_code(id: node["id"], name: node["name"],
+                           action: node["action"]) do |div|
+        node.children.each do |n|
+          parse(n, div)
+        end
+      end
+    end
+
+    def input_parse(node, out)
+      out.input nil, **attr_code(
+        id: node["id"], name: node["name"], type: node["type"],
+        value: node["value"], disabled: node["disabled"],
+        readonly: node["readonly"], checked: node["checked"],
+        maxlength: node["maxlength"], minlength: node["minlength"]
+      )
+    end
+
+    def select_parse(node, out)
+      selected = node.at(ns("./option[@value = '#{node['value']}']"))
+      selected and selected["selected"] = true
+      out.select **attr_code(
+        id: node["id"], name: node["name"], size: node["size"],
+        disabled: node["disabled"], multiple: node["multiple"]
+      ) do |div|
+        node.children.each do |n|
+          parse(n, div)
+        end
+      end
+    end
+
+    def label_parse(node, out)
+      out.label **attr_code(for: node["for"]) do |div|
+        node.children.each do |n|
+          parse(n, div)
+        end
+      end
+    end
+
+    def option_parse(node, out)
+      out.option **attr_code(
+        disabled: node["disabled"], selected: node["selected"],
+        value: node["value"]
+      ) do |o|
+        node.children.each do |n|
+          parse(n, o)
+        end
+      end
+    end
+
+    def textarea_parse(node, out)
+      out.textarea **attr_code(
+        id: node["id"], name: node["name"], rows: node["rows"],
+        cols: node["cols"]
+      ) do |div|
+        node["value"] and div << node["value"]
+      end
+    end
+  end
+end

data/lib/isodoc/html_function/html.rb

@@ -5,9 +5,9 @@ module IsoDoc::HtmlFunction
   module Html
     def convert1(docxml, filename, dir)
       noko do |xml|
-        xml.html **{ lang: "#{@lang}" } do |html|
+        xml.html **{ lang: @lang.to_s } do |html|
           info docxml, nil
-          populate_css()
+          populate_css
           html.head { |head| define_head head, filename, dir }
           make_body(html, docxml)
         end
@@ -15,13 +15,17 @@ module IsoDoc::HtmlFunction
     end
 
     def make_body1(body, _docxml)
+      return if @bare
+
       body.div **{ class: "title-section" } do |div1|
         div1.p { |p| p << "&nbsp;" } # placeholder
       end
       section_break(body)
     end
 
-    def make_body2(body, docxml)
+    def make_body2(body, _docxml)
+      return if @bare
+
       body.div **{ class: "prefatory-section" } do |div2|
         div2.p { |p| p << "&nbsp;" } # placeholder
       end
@@ -43,46 +47,47 @@ module IsoDoc::HtmlFunction
       end
     end
 
-    def googlefonts()
+    def googlefonts
       <<~HEAD.freeze
-      <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
-    <link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,900" rel="stylesheet">
+        <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
+        <link href="https://fonts.googleapis.com/css?family=Lato:400,400i,700,900" rel="stylesheet">
       HEAD
     end
 
-    def html_head()
+    def html_head
       <<~HEAD.freeze
-    <title>#{@meta&.get&.dig(:doctitle)}</title>
-    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
-
-    <!--TOC script import-->
-    <script type="text/javascript"  src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js"></script>
-    <script type="text/javascript">#{toclevel}</script>
-
-    <!--Google fonts-->
-      <link rel="preconnect" href="https://fonts.gstatic.com"> 
-      #{googlefonts}
-    <!--Font awesome import for the link icon-->
-    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous">
-    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous">
-    <style class="anchorjs"></style>
+        <title>#{@meta&.get&.dig(:doctitle)}</title>
+        <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+
+        <!--TOC script import-->
+        <script type="text/javascript"  src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js"></script>
+        <script type="text/javascript">#{toclevel}</script>
+
+        <!--Google fonts-->
+        <link rel="preconnect" href="https://fonts.gstatic.com">#{' '}
+        #{googlefonts}
+        <!--Font awesome import for the link icon-->
+        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous">
+        <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous">
+        <style class="anchorjs"></style>
       HEAD
     end
 
-    def html_button()
+    def html_button
       '<button onclick="topFunction()" id="myBtn" '\
         'title="Go to top">Top</button>'.freeze
     end
 
     def html_main(docxml)
-      docxml.at("//head").add_child(html_head())
+      docxml.at("//head").add_child(html_head)
       d = docxml.at('//div[@class="main-section"]')
       d.name = "main"
-      d.children.empty? or d.children.first.previous = html_button()
+      d.children.empty? or d.children.first.previous = html_button
     end
 
     def sourcecodelang(lang)
       return unless lang
+
       case lang.downcase
       when "javascript" then "lang-js"
       when "c" then "lang-c"
@@ -117,7 +122,6 @@ module IsoDoc::HtmlFunction
       end
     end
 
-    def table_long_strings_cleanup(docxml)
-    end
+    def table_long_strings_cleanup(docxml); end
   end
 end