asciidoctor-pdf-mathjax 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fc66d0f0c7026c39d6363d44464ad9c5f430aed3202b344de302604679d3166
-  data.tar.gz: 62009314bb1e5e72e759e2251ce7eaa7ffc14bb123a365a9c0f88dcc58d04bac
+  metadata.gz: 7a4ff18612f669474f7731d46e59103e23488c5dcdde291a5aa6635249e28d88
+  data.tar.gz: 6fea7b703e6de28edfe0b9615e3132cabf704bdfdc1ca14b2750a1cb5b610b49
 SHA512:
-  metadata.gz: 5234f95491bf7ec6320942e21c009f77575567a4312b1651e13736f19b1cb85d8eeee8cd9b3e443e483628c0b1e7d18847384cb98e9b4cab5efafb539973bcc8
-  data.tar.gz: 7e89244f2911bc889e4f2a3cdd2d34fc31fde201bacac64a0d995ddcbfbd14afe367e98c20922c828ce80bed93e0e05877cd2dbfb81fd655adda92e5c396a6e0
+  metadata.gz: ddf278d42765f9cd09394a73b62c6dd34d88059dae04265d5d15106a2834918d51464cab444ea1731e8747ca2fc9254815f41aac9bbfcc0ee84f829279ceefd8
+  data.tar.gz: 1c6066f9e7df67a6c1c9f9df9a584dd8b99161ed3f7fc8b37966db09a206ff0542275deb7b794e729b5a6390b64eb48f2aea3485e4c2e1bc3976ef44a6f39f33

data/bin/render.js

@@ -1,7 +1,5 @@
 #!/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.
@@ -11,48 +9,132 @@ const mj = require('mathjax-node');
 //     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 server = process.argv[2] === '--server';
-const font = server ? process.argv[3] : process.argv[5];
+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 data.svg;
+  return { font: font, fontExtensions: [] };
 }
 
-if (server) {
-  let queue = Promise.resolve();
-  require('readline').createInterface({ input: process.stdin }).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) };
-      }
-      process.stdout.write(JSON.stringify(answer) + '\n');
-    });
+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;
   });
-} else {
-  const latex = process.argv[2];
-  const format = process.argv[3];
-  const pixels_per_ex = parseInt(process.argv[4]);
-
-  convertToSvg(latex, format, pixels_per_ex).then(svg => {
-    console.log(svg);
-  }).catch(err => console.error(err));
 }
+
+MathJax.init({
+  loader: {
+    require: require,
+    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

@@ -199,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
@@ -280,12 +281,19 @@ class AsciidoctorPDFExtensions < (Asciidoctor::Converter.for 'pdf')
       raise "No font context found for node #{node}"
     end
 
-    # noinspection RubyResolve
-    font_catalog = theme.font_catalog
-    font_file = font_catalog[font_family][font_style.to_s]
+    # asciidoctor-pdf has already resolved the font catalog - against pdf-fontsdir, the theme
+    # directory and its bundled fonts - and registered the files with Prawn. Use that file, so a
+    # path relative to the theme directory is not looked up in the working directory.
+    font_file = node.document.converter.font_families.dig(font_family, font_style.to_sym) if node.document.converter.respond_to?(:font_families)
 
-    if font_file && !font_file.include?(File::SEPARATOR)
-      font_file = File.join(node.document.attributes['pdf-fontsdir'], font_file)
+    unless font_file && File.file?(font_file)
+      # noinspection RubyResolve
+      font_catalog = theme.font_catalog
+      font_file = font_catalog[font_family][font_style.to_s]
+
+      if font_file && !font_file.include?(File::SEPARATOR)
+        font_file = File.join(node.document.attributes['pdf-fontsdir'], font_file)
+      end
     end
 
     font = TTFunk::File.open(font_file)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-pdf-mathjax
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Crown0815
@@ -98,63 +98,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: logger
+  name: pdf-reader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-description: Converts STEM blocks and inline macros to SVG images using MathJax-node
-  for AsciiDoctor PDF.
+        version: '2.0'
+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