asciidoctor-pdf-mathjax 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953f3afce27ff482bfcae64ac333e262c1282f6c50d0bdb8317064f3d60b888d
-  data.tar.gz: ea179ece644755ef9834f2ed4da39b21008917004b2d6ff7f2cbbca82495e6c8
+  metadata.gz: 3ef66936477b46fb7aceae1c15a22cb42ebcea5d227ab19be302493e55efc9d2
+  data.tar.gz: df675d9c39be83650834c20b818c437c75bf842a117be0ba5fa4c4ce0e23eddb
 SHA512:
-  metadata.gz: c671beb46e4bd786b0deceb6af5108430b9417ff1ea4a585b83efb3c77910bffe6b3b1384a47fa7e876708be13485ae7521b43b50dcf64155c748b4cf814a28b
-  data.tar.gz: 2d76424a66dc155b0078f1b91ba327e2b19f89a41de049c834dc90bf0af5f5609420a193492433d043b1f92e0fd57cc2d0b3c155e18e13808150e4cfba27d9e3
+  metadata.gz: 204c9d8cb2f5fc184ca1e968d4666bcb971fe1e44dba2306d6230a0a2800a22178bfd417fc032a64e9e989d43ac4f89a027de8c99ba3e244c49c683986ad725f
+  data.tar.gz: e908b87d74694eddce9063863755e4119bbe9ad6adc7959c8373da173b3ca75bcb6aaf1cecf8a3559448762af696928091df1a53f3e727fae3055888a7b55a8a

data/bin/render.js

@@ -1,31 +1,139 @@
 #!/usr/bin/env node
 
-const mj = require('mathjax-node');
+// Two modes:
+//   render.js <latex> <format> <pixels_per_ex> <font>
+//     renders one formula, prints the SVG and exits.
+//   render.js --server <font>
+//     starts MathJax once and renders one formula per line of stdin,
+//     {"math": "...", "format": "TeX", "ex": 6}, answering with one line
+//     per formula, {"svg": "..."} or {"error": "..."}.
+// Starting MathJax takes seconds; the server mode pays that once per font
+// instead of once per formula.
+//
+// Font names are MathJax 4 names (mathjax-tex, mathjax-stix2, ...).
+// The MathJax 2 names previously passed to mathjax-node are still accepted.
 
-const latex = process.argv[2];
-const format = process.argv[3];
-const pixels_per_ex = parseInt(process.argv[4]);
-const font = process.argv[5];
+const server = process.argv[2] === '--server';
+const fontArg = server ? process.argv[3] : process.argv[5];
 
-mj.config({
-  MathJax: {
-    SVG: {
-      font: font
-    }
+const LEGACY_FONTS = {
+  'TeX': 'mathjax-tex',
+  'STIX-Web': 'mathjax-stix2',
+  'Asana-Math': 'mathjax-asana',
+  'Neo-Euler': 'mathjax-euler',
+  'Gyre-Pagella': 'mathjax-pagella',
+  'Gyre-Termes': 'mathjax-termes',
+  'Latin-Modern': 'mathjax-modern',
+};
+
+function resolveFont(name) {
+  const requested = (name && String(name).trim()) || 'TeX';
+  const font = LEGACY_FONTS[requested] || requested;
+  // Neo Euler ships as a font extension in MathJax 4, not a standalone font.
+  if (font === 'mathjax-euler') {
+    return { font: 'mathjax-tex', fontExtensions: ['mathjax-euler'] };
   }
-});
-mj.start();
-
-async function convertToSvg(latex, format, pixels_per_ex) {
-  const data = await mj.typeset({
-    ex: pixels_per_ex,
-    math: latex,
-    format: format,
-    svg: true,
+  return { font: font, fontExtensions: [] };
+}
+
+function assertInstalled(packageName) {
+  try {
+    // Font packages export no main entry, so resolve a file they do export.
+    require.resolve(packageName + '/package.json');
+  } catch (err) {
+    throw new Error(
+      `Cannot load ${packageName}. Install MathJax 4 with npm, for example: npm install ${packageName}@4`
+    );
+  }
+}
+
+const { font, fontExtensions } = resolveFont(fontArg);
+
+let MathJax;
+try {
+  assertInstalled('@mathjax/src');
+  assertInstalled(`@mathjax/${font}-font`);
+  fontExtensions.forEach((extension) => assertInstalled(`@mathjax/${extension}-font-extension`));
+  MathJax = require('@mathjax/src');
+} catch (err) {
+  console.error(err.message);
+  process.exit(1);
+}
+
+function convertToSvg(latex, format, pixelsPerEx) {
+  const display = format !== 'inline-TeX';
+  const ex = Number(pixelsPerEx) || 6;
+  return MathJax.tex2svgPromise(latex, {
+    display: display,
+    em: ex * 2,
+    ex: ex,
+    // Formulas are embedded at their natural width. A wide container keeps
+    // MathJax from inserting line breaks when a width is still consulted.
+    containerWidth: 100000,
+  }).then((node) => {
+    const adaptor = MathJax.startup.adaptor;
+    const svg = adaptor.tags(node, 'svg')[0];
+    if (!svg) {
+      throw new Error('MathJax produced no SVG');
+    }
+    const xml = adaptor.serializeXML(svg);
+    const mathError = xml.match(/data-mjx-error="([^"]*)"/);
+    if (mathError) {
+      throw new Error(mathError[1]);
+    }
+    return xml;
   });
-  return data.svg;
 }
 
-convertToSvg(latex, format, pixels_per_ex).then(svg => {
-  console.log(svg);
-}).catch(err => console.error(err));
+MathJax.init({
+  loader: {
+    load: ['input/tex', 'output/svg'],
+    // Font packages can report an older component version than MathJax itself.
+    versionWarnings: false,
+  },
+  output: {
+    font: font,
+    fontExtensions: fontExtensions,
+    displayOverflow: 'overflow',
+    linebreaks: { inline: false },
+  },
+  svg: {
+    fontCache: 'local',
+  },
+  startup: {
+    typeset: false,
+  },
+}).then(() => {
+  if (server) {
+    let queue = Promise.resolve();
+    const input = require('readline').createInterface({ input: process.stdin });
+    input.on('line', (line) => {
+      queue = queue.then(async () => {
+        let answer;
+        try {
+          const request = JSON.parse(line);
+          answer = { svg: await convertToSvg(request.math, request.format, request.ex) };
+        } catch (err) {
+          answer = { error: String(err && err.message ? err.message : err) };
+        }
+        process.stdout.write(JSON.stringify(answer) + '\n');
+      });
+    });
+    input.on('close', () => {
+      queue.then(() => {
+        if (MathJax.done) MathJax.done();
+      });
+    });
+  } else {
+    const latex = process.argv[2];
+    const format = process.argv[3];
+    const pixelsPerEx = parseInt(process.argv[4], 10);
+    return convertToSvg(latex, format, pixelsPerEx).then((svg) => {
+      process.stdout.write(svg + '\n');
+      if (MathJax.done) MathJax.done();
+    });
+  }
+}).catch((err) => {
+  console.error(err && err.message ? err.message : err);
+  process.exit(1);
+});

data/lib/asciidoctor-pdf-mathjax.rb

@@ -1,5 +1,6 @@
 require 'asciidoctor-pdf' unless Asciidoctor::Converter.for 'pdf'
 require 'open3'
+require 'json'
 require 'tempfile'
 require 'rexml/document'
 require 'ttfunk'
@@ -97,7 +98,7 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
       tmp_svg.close
 
       logger.debug "Successfully embedded stem inline #{node.text} with font #{math_font} as SVG image"
-      quoted_text = "<img src=\"#{tmp_svg.path}\" format=\"svg\" width=\"#{svg_width}\" alt=\"#{node.text}\">"
+      quoted_text = "<img src=\"#{tmp_svg.path}\" format=\"svg\" width=\"#{svg_width}\" alt=\"#{node.text.gsub('"', '&quot;')}\">"
       node.id ? %(<a id="#{node.id}">#{DummyText}</a>#{quoted_text}) : quoted_text
     rescue => e
       logger.warn "Failed to process SVG: #{e.message}"
@@ -124,19 +125,62 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
   end
 
   def stem_to_svg(latex_content, is_inline, math_font)
-    js_script = File.join(File.dirname(__FILE__), '../bin/render.js')
-    svg_output, error = nil, nil
     format = is_inline ? 'inline-TeX' : 'TeX'
-    begin
-      Open3.popen3('node', js_script, latex_content, format, POINTS_PER_EX.to_s, math_font) do |_, stdout, stderr, wait_thr|
-        svg_output = stdout.read
-        error = stderr.read unless wait_thr.value.success?
-      end
+    MathJaxServer.for(math_font).render(latex_content, format)
+  end
+
+  # One long-running render.js process per math font. Starting node and MathJax takes
+  # seconds, rendering a formula takes milliseconds, so a document pays the start once.
+  class MathJaxServer
+    JS_SCRIPT = File.join(File.dirname(__FILE__), '../bin/render.js')
+
+    @servers = {}
+
+    def self.for(math_font)
+      @servers[math_font] ||= new(math_font)
+    end
+
+    def initialize(math_font)
+      @math_font = math_font
+    end
+
+    def render(latex_content, format)
+      start unless @stdin
+      @stdin.puts JSON.generate('math' => latex_content, 'format' => format, 'ex' => POINTS_PER_EX)
+      @stdin.flush
+      answer = read_answer
+      [answer['svg'], answer['error']]
     rescue Errno::ENOENT => e
-      error = "Node.js executable 'node' was not found. Please install Node.js and ensure 'node' is available on your PATH. Original error: #{e.message}"
-      svg_output = nil
+      [nil, "Node.js executable 'node' was not found. Please install Node.js and ensure 'node' is available on your PATH. Original error: #{e.message}"]
+    rescue IOError, SystemCallError => e
+      stop
+      [nil, "MathJax process for font #{@math_font} failed: #{e.message}"]
+    end
+
+    private
+
+    def start
+      @stdin, @stdout, @wait_thr = Open3.popen2('node', JS_SCRIPT, '--server', @math_font)
+      at_exit { stop }
+    end
+
+    # Skips anything else a dependency may print to stdout.
+    def read_answer
+      while (line = @stdout.gets)
+        answer = JSON.parse(line) rescue nil
+        return answer if answer.is_a?(Hash) && (answer.key?('svg') || answer.key?('error'))
+      end
+      raise IOError, 'render.js ended without an answer'
+    end
+
+    def stop
+      return unless @stdin
+      @stdin.close unless @stdin.closed?
+      Process.kill('KILL', @wait_thr.pid) unless @wait_thr.join(5)
+      @stdin = @stdout = @wait_thr = nil
+    rescue SystemCallError
+      @stdin = @stdout = @wait_thr = nil
     end
-    [svg_output, error]
   end
 
   def adjust_svg_to_match_text(svg_content, font)
@@ -155,32 +199,33 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
     svg_width = svg_width * scaling_factor
     svg_height = svg_height * scaling_factor
 
-    svg_height_difference = font.font_full_height - svg_height
-    svg_relative_height_difference = font.font_full_height / svg_height
-    embedding_text_relative_baseline_height = font.font_baseline / font.font_full_height
+    # Points per viewBox unit. Held constant so the glyphs keep the size MathJax produced.
+    pt_per_unit = svg_height / svg_inner_height
+    orig_top = svg_inner_offset
+    orig_bottom = svg_inner_offset + svg_inner_height
+
+    # Line-sized window with the math baseline (y = 0) on the text baseline.
+    # Asciidoctor centers an inline image in the line when it is at most 1.5 line
+    # heights tall, and bottom-aligns it otherwise. A window exactly the line height
+    # crops any ink past the font ascender or descender (subscripts, denominators).
+    line_units = font.font_full_height / pt_per_unit
+    line_bottom = font.font_baseline / pt_per_unit
+    line_top = line_bottom - line_units
+    overflow_above = [line_top - orig_top, 0].max
+    overflow_below = [orig_bottom - line_bottom, 0].max
+    # Pad both sides equally so centering still leaves the baseline on the text baseline.
+    extra = [overflow_above, overflow_below].max
 
     logger.debug "Original SVG height: #{svg_height.round(2)}, width: #{svg_width.round(2)}, inner height: #{svg_inner_height.round(2)}, inner offset: #{svg_inner_offset.round(2)}"
-    if svg_height_difference < 0
-      svg_relative_portion_extending_embedding_text_below = (1 - svg_relative_height_difference) / 2
-      svg_relative_baseline_height = embedding_text_relative_baseline_height * svg_relative_height_difference
-      svg_inner_relative_offset = svg_relative_baseline_height + svg_relative_portion_extending_embedding_text_below - 1
-
-      svg_inner_offset_new = svg_inner_relative_offset * svg_inner_height
-      svg_inner_height_padding = (svg_inner_offset - svg_inner_offset_new) * 0.25 # 25% padding to handle fractions
-      svg_inner_height_difference = 2 * svg_inner_height_padding
-      svg_inner_height_new = svg_inner_height + svg_inner_height_difference
-      svg_inner_height_relative_difference = svg_inner_height_new / svg_inner_height
-
-      logger.debug("svg_inner_offset = #{svg_inner_offset}, svg_inner_height = #{svg_inner_height}, svg_inner_offset_new = #{svg_inner_offset_new}, svg_inner_height_new = #{svg_inner_height_new}")
-      logger.debug("svg_inner_offset_diff = #{svg_inner_offset - svg_inner_offset_new}, svg_inner_offset_diff_relative = #{(svg_inner_offset - svg_inner_offset_new) / svg_inner_height}")
-
-      svg_height = svg_height * svg_inner_height_relative_difference
-      svg_inner_height = svg_inner_height_new
-      svg_inner_offset = svg_inner_offset_new - svg_inner_height_padding
+    fitted_height = (line_units + 2 * extra) * pt_per_unit
+    if fitted_height <= font.font_full_height * 1.5
+      svg_inner_offset = line_top - extra
+      svg_inner_height = line_units + 2 * extra
+      svg_height = fitted_height
     else
-      svg_height = font.font_full_height
-      svg_inner_height = svg_relative_height_difference * svg_inner_height
-      svg_inner_offset = (embedding_text_relative_baseline_height - 1) * svg_inner_height
+      svg_inner_offset = orig_top
+      svg_inner_height = orig_bottom - orig_top
+      svg_height = svg_inner_height * pt_per_unit
     end
 
     view_box[1] = svg_inner_offset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf-mathjax
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Crown0815
@@ -153,8 +153,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-description: Converts STEM blocks and inline macros to SVG images using MathJax-node
-  for AsciiDoctor PDF.
+description: Converts STEM blocks and inline macros to SVG images using MathJax for
+  AsciiDoctor PDF.
 executables:
 - render.js
 extensions: []
@@ -168,10 +168,10 @@ licenses:
 metadata: {}
 post_install_message: |
   Thank you for installing asciidoctor-pdf-mathjax!
-  Note: This gem requires MathJax-Node for full functionality (e.g., LaTeX rendering).
+  Note: This gem requires MathJax 4 for full functionality (e.g., LaTeX rendering).
   If you haven't installed it, run:
-    npm install -g mathjax-node
-  See the README for details.
+    npm install -g @mathjax/src@4 @mathjax/mathjax-tex-font@4
+  See the README for details and for the other math fonts.
 rdoc_options: []
 require_paths:
 - lib