sskatex 0.9.20

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b5feb74566bcc5031cb615e5bacf5e795c6e465
+  data.tar.gz: a5163ab70c56af3d2aba6f7670883e5114348922
+SHA512:
+  metadata.gz: 7d3e59e7a9d7005779e656528c09714b50d27c5def895baa2dd97560003e22a2342059698359043c548e222dc2d8d23fde368ba97e206de0878798f3a70476fb
+  data.tar.gz: baa2384e98b60595061776f234fcc7be036c9ef51f2a586e294e9b3487f39d0d515cc0e7c48679e994558d78f00491ec09c8533956e4c7b386efc07522c9b5e7

data/COPYING

@@ -0,0 +1,23 @@
+SsKaTeX - Server-side KaTeX for Ruby
+(not including KaTeX itself)
+MIT License
+Copyright (C) 2017 Christian Cornelssen <ccorn@1tein.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# SsKaTeX
+## Server-side KaTeX for Ruby
+
+This is a TeX-to-HTML+MathML+CSS converter class using the Javascript-based
+[KaTeX], interpreted by one of the Javascript engines supported by [ExecJS].
+The intended purpose is to eliminate the need for math-rendering Javascript
+in the client's HTML browser. Therefore the name: SsKaTeX means *server-side*
+KaTeX.
+
+Javascript execution context initialization can be done once and then reused
+for formula renderings with the same general configuration. As a result, the
+performance is reasonable. Consider this a fast and lightweight alternative to
+[mathjax-node-cli].
+
+Requirements for using SsKaTeX:
+
+* Ruby gem [ExecJS],
+* A Javascript engine supported by ExecJS, e.g. via one of
+    - Ruby gem [therubyracer],
+    - Ruby gem [therubyrhino],
+    - Ruby gem [duktape.rb],
+    - [Node.js],
+* `katex.min.js` from [KaTeX].
+
+Although the converter only needs `katex.min.js`, you may need to serve the
+rest of the KaTeX package, that is, CSS and fonts, as resources to the
+targeted web browsers. The upside is that your HTML templates need no longer
+include Javascripts for Math (neither `katex.js` nor any search-and-replace
+script). Your HTML templates should continue referencing the KaTeX CSS.
+If you host your own copy of the CSS, also keep hosting the fonts.
+
+Minimal usage example:
+
+    tex_to_html = SsKaTeX.new(katex_js: 'path-to-katex/katex.min.js')
+    # Here you could verify contents of tex_to_html.js_source for security...
+
+    body_html = '<p>By Pythagoras, %s. Furthermore:</p>' %
+      tex_to_html.call('a^2 + b^2 = c^2', false)  # inline math
+    body_html <<                                  # block display
+      tex_to_html.call('\frac{1}{2} + \frac{1}{3} + \frac{1}{6} = 1', true)
+    # etc, etc.
+
+More configuration options are described in the Rdoc. Most options, with the
+notable exception of `katex_opts`, do not affect usage nor output, but may be
+needed to make SsKaTeX work with all the external parts (JS engine and KaTeX).
+Since KaTeX is distributed separately from the SsKaTeX gem, configuration of
+the latter must support the specification of Javascript file locations. This
+implies that execution of arbitrary Javascript code is possible. Specifically,
+options with `js` in their names should be accepted from trusted sources only.
+Applications using SsKaTeX need to check this.
+
+[duktape.rb]: https://github.com/judofyr/duktape.rb#duktaperb
+[ExecJS]: https://github.com/rails/execjs#execjs
+[KaTeX]: https://khan.github.io/KaTeX/
+[mathjax-node-cli]: https://github.com/mathjax/mathjax-node-cli
+[Node.js]: https://nodejs.org/
+[therubyracer]: https://github.com/cowboyd/therubyracer#therubyracer
+[therubyrhino]: https://github.com/cowboyd/therubyrhino#therubyrhino

data/data/sskatex/js/escape_nonascii_html.js

@@ -0,0 +1,12 @@
+// -*- coding: utf-8 -*-
+//
+// Copyright (C) 2017 Christian Cornelssen <ccorn@1tein.de>
+//
+// This file is part of SsKaTeX which is licensed under the MIT.
+
+// Transform non-ASCII characters and '\0' in given string to HTML numeric character references
+function escape_nonascii_html(str) {
+  return str.replace(/[^\x01-\x7F]/g, function (u) {
+    return "&#x" + u.charCodeAt(0).toString(16) + ";";
+  });
+};

data/data/sskatex/js/tex_to_html.js

@@ -0,0 +1,15 @@
+// -*- coding: utf-8 -*-
+//
+// Copyright (C) 2017 Christian Cornelssen <ccorn@1tein.de>
+//
+// This file is part of SsKaTeX which is licensed under the MIT.
+
+// Given a LaTeX math string, a boolean display_mode
+// (true for block display, false for inline),
+// and a dict katex_opts with general KaTeX options,
+// return a string with corresponding HTML+MathML output.
+// The implementation is allowed to set katex_opts.displayMode .
+function tex_to_html(tex, display_mode, katex_opts) {
+  katex_opts.displayMode = display_mode;
+  return escape_nonascii_html(katex.renderToString(tex, katex_opts));
+};

data/lib/sskatex.rb

@@ -0,0 +1,354 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2017 Christian Cornelssen <ccorn@1tein.de>
+#
+# This file is part of SsKaTeX which is licensed under the MIT.
+#++
+
+require 'json'
+
+# This is a TeX-to-HTML+MathML+CSS converter class using the Javascript-based
+# KaTeX[https://khan.github.io/KaTeX/], interpreted by one of the Javascript
+# engines supported by ExecJS[https://github.com/rails/execjs#execjs].
+# The intended purpose is to eliminate the need for math-rendering Javascript
+# in the client's HTML browser. Therefore the name: SsKaTeX means _server-side_
+# KaTeX.
+#
+# Javascript execution context initialization can be done once and then reused
+# for formula renderings with the same general configuration. As a result, the
+# performance is reasonable. Consider this a fast and lightweight alternative to
+# mathjax-node-cli[https://github.com/mathjax/mathjax-node-cli].
+#
+# Requirements for using SsKaTeX:
+#
+# - Ruby gem ExecJS[https://github.com/rails/execjs#execjs],
+# - A Javascript engine supported by ExecJS, e.g. via one of
+#   - Ruby gem therubyracer[https://github.com/cowboyd/therubyracer#therubyracer],
+#   - Ruby gem therubyrhino[https://github.com/cowboyd/therubyrhino#therubyrhino],
+#   - Ruby gem duktape.rb[https://github.com/judofyr/duktape.rb#duktaperb],
+#   - Node.js[https://nodejs.org/],
+# - +katex.min.js+ from KaTeX[https://khan.github.io/KaTeX/].
+#
+# Although the converter only needs +katex.min.js+, you may need to serve the
+# rest of the KaTeX package, that is, CSS and fonts, as resources to the
+# targeted web browsers. The upside is that your HTML templates need no longer
+# include Javascripts for Math (neither +katex.js+ nor any search-and-replace
+# script). Your HTML templates should continue referencing the KaTeX CSS.
+# If you host your own copy of the CSS, also keep hosting the fonts.
+#
+# Minimal usage example:
+#
+#     tex_to_html = SsKaTeX.new(katex_js: 'path-to-katex/katex.min.js')
+#     # Here you could verify contents of tex_to_html.js_source for security...
+#
+#     body_html = '<p>By Pythagoras, %s. Furthermore:</p>' %
+#       tex_to_html.call('a^2 + b^2 = c^2', false)  # inline math
+#     body_html <<                                  # block display
+#       tex_to_html.call('\frac{1}{2} + \frac{1}{3} + \frac{1}{6} = 1', true)
+#     # etc, etc.
+#
+# More configuration options are described in the Rdoc. Most options, with the
+# notable exception of #katex_opts, do not affect usage nor output, but may be
+# needed to make SsKaTeX work with all the external parts (JS engine and KaTeX).
+# Since KaTeX is distributed separately from the SsKaTeX gem, configuration of
+# the latter must support the specification of Javascript file locations. This
+# implies that execution of arbitrary Javascript code is possible. Specifically,
+# options with +js+ in their names should be accepted from trusted sources only.
+# Applications using SsKaTeX need to check this.
+class SsKaTeX
+
+  # Original value of the +EXECJS_RUNTIME+ environment variable, if any.
+  # Used when deferring ExecJS's engine auto-selection.
+  ENV_EXECJS_RUNTIME = ENV['EXECJS_RUNTIME']
+  begin
+    ::ENV['EXECJS_RUNTIME'] = 'Disabled'  # Defer automatic JS engine selection
+    require 'execjs'
+  ensure
+    ::ENV['EXECJS_RUNTIME'] = ENV_EXECJS_RUNTIME
+  end
+
+  # Root directory for auxiliary files of this gem
+  DATADIR = File.expand_path(File.join(File.dirname(__FILE__),
+                                       '..', 'data', 'sskatex'))
+
+  # The default for the #js_dir configuration option.
+  # Path of a directory with Javascript helper files.
+  DEFAULT_JS_DIR = File.join(DATADIR, 'js')
+
+  # The default path to +katex.js+, cf. the #katex_js configuration option.
+  # For a relative path, the starting point is the current working directory.
+  DEFAULT_KATEX_JS = File.join('katex', 'katex.min.js')
+
+  # The default for the #js_libs configuration option.
+  # A list of UTF-8-encoded Javascript helper files to load.
+  # Relative paths are interpreted relative to #js_dir.
+  DEFAULT_JS_LIBS = ['escape_nonascii_html.js', 'tex_to_html.js']
+
+  # This is a module with miscellaneous utility functions needed by SsKaTeX.
+  module Utils
+    # Dictionary for escape sequences used in Javascript string literals
+    JS_ESCAPE = {
+      "\\" => "\\\\",
+      "\"" => "\\\"",
+      # Escaping single quotes not necessary in double-quoted string literals
+      #"'" => "\\'",
+      # JS does not recognize \a nor GNU's \e
+      # \b is ambiguous in regexps, as in Perl and Ruby
+      #"\b" => "\\b",
+      "\f" => "\\f",
+      "\n" => "\\n",
+      "\r" => "\\r",
+      "\t" => "\\t",
+      "\v" => "\\v",
+    }
+    private_constant :JS_ESCAPE
+
+    # ExecJS uses <tt>runtime = Runtimes.const_get(name)</tt> without checks.
+    # That is fragile and potentially insecure with arbitrary user input.
+    # Instead we use a fixed dictionary restricted to valid contents.
+    # Note that there are aliases like <tt>SpiderMonkey = Spidermonkey</tt>.
+    JSRUN_FROMSYM = {}.tap do |dict|
+      ExecJS::Runtimes.constants.each do |name|
+        runtime = ExecJS::Runtimes.const_get(name)
+        dict[name] = runtime if runtime.is_a?(ExecJS::Runtime)
+      end
+    end
+
+    # Subclasses of +ExecJS::Runtime+ provide +.name+ (which is too verbose),
+    # but not, say, +.symbol+. This dictionary associates each JS runtime
+    # class with a representative symbol. For aliases like <tt>SpiderMonkey =
+    # Spidermonkey</tt>, an unspecified choice is made.
+    JSRUN_TOSYM = JSRUN_FROMSYM.invert
+
+    class << self   # class-level methods
+      # Turn a string into an equivalent Javascript literal, double-quoted.
+      # Similar to +.to_json+, but escape all non-ASCII codes as well.
+      def js_quote(str)
+        # No portable way of escaping Unicode points above 0xFFFF
+        '"%s"' % str.encode(Encoding::UTF_8).
+        gsub(/[\0-\u{001F}\"\\\u{0080}-\u{FFFF}]/u) do |c|
+          JS_ESCAPE[c] || "\\u%04x" % c.ord
+        end
+      end
+
+      # This should really be provided by +ExecJS::Runtimes+:
+      # A list of available JS engines, as symbols, in the order of preference.
+      def js_runtimes
+        ExecJS::Runtimes.runtimes.select(&:available?).map(&JSRUN_TOSYM)
+      end
+
+      # Configuration dicts may contain keys in both string and symbol form.
+      # This bloats the output of +.to_json+ with duplicate key-value pairs.
+      # While this does not affect the result, it looks strange in logfiles.
+      # Therefore here is a function that recursively dedups dict keys,
+      # removing symbolic keys if there are corresponding string keys.
+      # Nondestructive.
+      def dedup_keys(conf)
+        # Lazy solution would be: JSON.parse(conf.to_json)
+        case conf
+        when Hash
+          conf.reject {|key, _| key.is_a?(Symbol) && conf.has_key?(key.to_s)}.
+            tap {|dict| dict.each {|key, value| dict[key] = dedup_keys(value)}}
+        when Array
+          conf.map {|value| dedup_keys(value)}
+        else
+          conf
+        end
+      end
+    end
+  end
+
+  # This can be used for monitoring or debugging. When set to a
+  #     proc {|level, &block| ...}
+  # the #logger will be used internally as
+  #     logger.call(level) {msg}
+  # with the log message constructed in the given block. _level_ is one of:
+  #
+  # +:verbose+::
+  #   For information about the effective engine configuration.
+  #   Issued on first use of a changed configuration option.
+  # +:debug+::
+  #   For the Javascript expressions used when converting TeX.
+  #   Issued once per TeX snippet.
+  #
+  # For example, to ignore +:debug+ yet trace +:verbose+ messages, set
+  #     .logger = lambda {|level, &block| warn(block.call) if level == :verbose}
+  # The default after construction is to log nothing.
+  attr_accessor :logger
+
+  # A dictionary with the used configuration options.
+  # The resulting effective option values can be read from the same-named
+  # attributes #katex_js, #katex_opts, #js_dir, #js_libs, #js_run.
+  # See also #config=.
+  def config
+    @config
+  end
+
+  # Reconfigure the conversion engine by passing in a dictionary, without
+  # affecting the #logger setting. Changes become effective on first use.
+  #
+  # Note: The dict will be shared by reference. Its deep object tree should
+  # remain unchanged at least until #js_context or #call has been invoked.
+  # Thereafter changes do not matter until #config= is assigned again.
+  def config=(cfg)
+    @js_context = nil
+    @js_source = nil
+    @katex_opts = nil
+    @katex_js = nil
+    @js_libs = nil
+    @js_dir = nil
+    @js_runtime = nil
+    @js_run = nil
+    @config = cfg
+  end
+
+  # Create a new instance configured with keyword arguments. Disable logging.
+  # The keyword arguments can be retrieved as dictionary #config, and the
+  # resulting effective option values can be read from the same-named attributes
+  # #katex_js, #katex_opts, #js_dir, #js_libs, #js_run.
+  def initialize(cfg = {})
+    @logger = lambda {|level, &block|}
+    self.config = cfg
+  end
+
+  # A symbol for the Javascript engine to be used. Recognized identifiers
+  # include: +:RubyRacer+, +:RubyRhino+, +:Duktape+, +:MiniRacer+, +:Node+,
+  # +:JavaScriptCore+, +:Spidermonkey+, +:JScript+, +:V8+, and +:Disabled+;
+  # that last one would raise an error on first run (by #js_context).
+  # Which engines are actually available depends on your installation.
+  #
+  # #js_run is determined on demand as follows and then cached for reuse.
+  # If #config[ +:js_run+ ] is not defined, the contents of the environment
+  # variable +EXECJS_RUNTIME+ will be considered instead; and if that is not
+  # defined, an automatic choice will be made. For more information, set the
+  # #logger to show +:verbose+ messages and consult the documentation of
+  # ExecJS[https://github.com/rails/execjs#execjs].
+  def js_run
+    @js_run ||= begin
+      log = lambda {|&block| @logger.call(:verbose, &block)}
+
+      log.call {"Available JS runtimes: #{Utils.js_runtimes.join(', ')}"}
+      jsrun = (@config[:js_run] ||
+               ENV_EXECJS_RUNTIME ||
+               Utils::JSRUN_TOSYM[ExecJS::Runtimes.best_available] ||
+               'Disabled').to_s.to_sym
+      log.call {"Selected JS runtime: #{jsrun}"}
+      jsrun
+    end
+  end
+
+  # The +ExecJS::Runtime+ subclass to be used, corresponding to #js_run.
+  def js_runtime
+    @js_runtime ||= Utils::JSRUN_FROMSYM[js_run]
+  end
+
+  # The path to a directory with Javascript helper files as specified by
+  # #config[ +:js_dir+ ], or its default which is the subdirectory +js+ in the
+  # data directory of SsKaTeX. There is no need to change that setting unless
+  # you want to experiment with Javascript details.
+  def js_dir
+    @js_dir ||= @config[:js_dir] || DEFAULT_JS_DIR
+  end
+
+  # A list of UTF-8-encoded Javascript helper files to load.
+  # Can be overridden with #config[ +:js_libs+ ].
+  # Relative paths are interpreted relative to #js_dir.
+  # The default setting (in YAML notation) is
+  #
+  #     js_libs:
+  #       - escape_nonascii_html.js
+  #       - tex_to_html.js
+  #
+  # And there is no need to change that unless you want to experiment with
+  # Javascript details.
+  #
+  # Files available in the default #js_dir are:
+  #
+  # +escape_nonascii_html.js+::
+  #   defines a function +escape_nonascii_html+ that converts non-ASCII
+  #   characters to HTML numeric character references.
+  #   Intended as postprocessing filter.
+  # +tex_to_html.js+::
+  #   defines a function +tex_to_html+(_tex_, _display_mode_, _katex_opts_)
+  #   that takes a LaTeX math string, a boolean display mode (+true+ for block
+  #   display, +false+ for inline), and a dict with general KaTeX options, and
+  #   returns a string with corresponding HTML+MathML output. The implementation
+  #   is allowed to set +katex_opts.displayMode+. SsKaTeX applies +tex_to_html+
+  #   to each math fragment encountered.
+  #   The implementation given here uses +katex.renderToString+ and
+  #   postprocesses the output with +escape_nonascii_html+.
+  def js_libs
+    @js_libs ||= @config[:js_libs] || DEFAULT_JS_LIBS
+  end
+
+  # The path to your copy of +katex.min.js+ as specified by
+  # #config[ +:katex_js+ ] or its default <tt>'katex/katex.min.js'</tt>.
+  # For a relative path, the starting point is the current working directory.
+  def katex_js
+    @katex_js ||= @config[:katex_js] || DEFAULT_KATEX_JS
+  end
+
+  # A dictionary filled with the contents of #config[ +:katex_opts+ ] if given.
+  # These are general KaTeX options such as +throwOnError+, +errorColor+,
+  # +colorIsTextColor+, and +macros+. See the KaTeX
+  # documentation[https://github.com/Khan/KaTeX#rendering-options] for details.
+  # Use <tt>throwOnError: false</tt> if you want parse errors highlighted in the
+  # HTML output rather than raised as exceptions when compiling.
+  # Note that +displayMode+ is computed dynamically and should not be specified
+  # here. Keys can be symbols or strings; if a key is given in both forms, the
+  # symbol will be ignored.
+  def katex_opts
+    @katex_opts ||= Utils.dedup_keys(@config[:katex_opts] || {})
+  end
+
+  # The concatenation of the contents of the files in #js_libs, in #katex_js,
+  # and a JS variable definition for #katex_opts, each item followed by a
+  # newline. Created at first use. Can be used to validate JS contents if used
+  # before #js_context.
+  def js_source
+    @js_source ||= begin
+      log = lambda {|&block| @logger.call(:verbose, &block)}
+
+      # Concatenate sources
+      js = ''
+      js_libs.each do |libfile|
+        absfile = File.expand_path(libfile, js_dir)
+        log.call {"Loading JS file: #{absfile}"}
+        js << IO.read(absfile, external_encoding: Encoding::UTF_8) << "\n"
+      end
+      log.call {"Loading KaTeX JS file: #{katex_js}"}
+      js << IO.read(katex_js, external_encoding: Encoding::UTF_8) << "\n"
+
+      # Initialize JS variable katex_opts
+      js_katex_opts = "var katex_opts = #{katex_opts.to_json}"
+      log.call {"JS eval: #{js_katex_opts}"}
+      js << js_katex_opts << "\n"
+    end
+  end
+
+  # The JS engine context resulting from compilation of #js_source by the
+  # #js_runtime selected with #js_run. Created at first use e.g. by #call.
+  def js_context
+    @js_context ||= js_runtime.compile(js_source)
+  end
+
+  # Given a TeX math fragment _tex_ as well as a boolean _display_mode_ (true
+  # for block, false for inline), run the JS engine (using #js_context) and let
+  # KaTeX compile the math fragment. Return the resulting HTML string.
+  # Can raise errors if something in the process fails.
+  def call(tex, display_mode)
+    ctx = js_context
+    js = "tex_to_html(#{Utils.js_quote(tex)}, #{display_mode.to_json}, katex_opts)"
+    @logger.call(:debug) {"JS eval: #{js}"}
+    ans = ctx.eval(js)
+    raise (<<MSG) unless ans && ans.start_with?('<') && ans.end_with?('>')
+KaTeX conversion failed!
+Input:
+#{tex}
+Output:
+#{ans}
+MSG
+    ans
+  end
+end

data/test/block/det.html

@@ -0,0 +1,2 @@
+<span class="katex-display"><span class="katex"><span class="katex-mathml"><math><semantics><mrow><mi mathvariant="normal">&#x394;</mi><mo>=</mo><mfrac><mrow><mn>1</mn></mrow><mrow><mn>2</mn></mrow></mfrac><mrow><mo fence="true">&#x2223;</mo><mtable><mtr><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>a</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>b</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>c</mi></mrow></mstyle></mtd></mtr><mtr><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>d</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>e</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>f</mi></mrow></mstyle></mtd></mtr><mtr><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>g</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>h</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>i</mi></mrow></mstyle></mtd></mtr></mtable><mo fence="true">&#x2223;</mo></mrow></mrow><annotation encoding="application/x-tex">\Delta = \frac{1}{2}
+\begin{vmatrix}a &amp; b &amp; c \\ d &amp; e &amp; f \\ g &amp; h &amp; i\end{vmatrix}</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="strut" style="height:2.08597em;"></span><span class="strut bottom" style="height:3.636em;vertical-align:-1.5500299999999998em;"></span><span class="base"><span class="mord mathrm">&#x394;</span><span class="mrel">=</span><span class="mord"><span class="mopen nulldelimiter"></span><span class="mfrac"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:1.32144em;"><span style="top:-2.314em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathrm">2</span></span></span><span style="top:-3.23em;"><span class="pstrut" style="height:3em;"></span><span class="frac-line" style="border-bottom-width:0.04em;"></span></span><span style="top:-3.677em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathrm">1</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:0.686em;"></span></span></span></span><span class="mclose nulldelimiter"></span></span><span class="minner"><span class="mopen"><span class="delimsizing mult"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.08597em;"><span style="top:-1.05597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-1.6619700000000002em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.26797em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.87397em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-3.47997em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-4.08597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500299999999998em;"></span></span></span></span></span><span class="mord"><span class="mtable"><span class="col-align-c"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.05em;"><span style="top:-4.21em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">a</span></span></span><span style="top:-3.0099999999999993em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">d</span></span></span><span style="top:-1.8099999999999994em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit" style="margin-right:0.03588em;">g</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500000000000007em;"></span></span></span></span><span class="arraycolsep" style="width:0.5em;"></span><span class="arraycolsep" style="width:0.5em;"></span><span class="col-align-c"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.05em;"><span style="top:-4.21em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">b</span></span></span><span style="top:-3.0099999999999993em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">e</span></span></span><span style="top:-1.8099999999999994em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">h</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500000000000007em;"></span></span></span></span><span class="arraycolsep" style="width:0.5em;"></span><span class="arraycolsep" style="width:0.5em;"></span><span class="col-align-c"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.05em;"><span style="top:-4.21em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">c</span></span></span><span style="top:-3.0099999999999993em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit" style="margin-right:0.10764em;">f</span></span></span><span style="top:-1.8099999999999994em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">i</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500000000000007em;"></span></span></span></span></span></span><span class="mclose"><span class="delimsizing mult"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.08597em;"><span style="top:-1.05597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-1.6619700000000002em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.26797em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.87397em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-3.47997em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-4.08597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500299999999998em;"></span></span></span></span></span></span></span></span></span></span>

data/test/block/sup.html

@@ -0,0 +1 @@
+<span class="katex-display"><span class="katex"><span class="katex-mathml"><math><semantics><mrow><msup><mi>a</mi><mn>2</mn></msup><mo>+</mo><msup><mi>b</mi><mn>2</mn></msup><mo>=</mo><msup><mi>c</mi><mn>2</mn></msup></mrow><annotation encoding="application/x-tex">a^2+b^2=c^2</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="strut" style="height:0.8641079999999999em;"></span><span class="strut bottom" style="height:0.9474379999999999em;vertical-align:-0.08333em;"></span><span class="base"><span class="mord"><span class="mord mathit">a</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8641079999999999em;"><span style="top:-3.113em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathrm mtight">2</span></span></span></span></span></span></span></span><span class="mbin">+</span><span class="mord"><span class="mord mathit">b</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8641079999999999em;"><span style="top:-3.113em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathrm mtight">2</span></span></span></span></span></span></span></span><span class="mrel">=</span><span class="mord"><span class="mord mathit">c</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8641079999999999em;"><span style="top:-3.113em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathrm mtight">2</span></span></span></span></span></span></span></span></span></span></span></span>

data/test/span/det.html

@@ -0,0 +1,2 @@
+<span class="katex"><span class="katex-mathml"><math><semantics><mrow><mi mathvariant="normal">&#x394;</mi><mo>=</mo><mfrac><mrow><mn>1</mn></mrow><mrow><mn>2</mn></mrow></mfrac><mrow><mo fence="true">&#x2223;</mo><mtable><mtr><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>a</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>b</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>c</mi></mrow></mstyle></mtd></mtr><mtr><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>d</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>e</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>f</mi></mrow></mstyle></mtd></mtr><mtr><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>g</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>h</mi></mrow></mstyle></mtd><mtd><mstyle scriptlevel="0" displaystyle="false"><mrow><mi>i</mi></mrow></mstyle></mtd></mtr></mtable><mo fence="true">&#x2223;</mo></mrow></mrow><annotation encoding="application/x-tex">\Delta = \frac{1}{2}
+\begin{vmatrix}a &amp; b &amp; c \\ d &amp; e &amp; f \\ g &amp; h &amp; i\end{vmatrix}</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="strut" style="height:2.08597em;"></span><span class="strut bottom" style="height:3.636em;vertical-align:-1.5500299999999998em;"></span><span class="base"><span class="mord mathrm">&#x394;</span><span class="mrel">=</span><span class="mord"><span class="mopen nulldelimiter"></span><span class="mfrac"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:0.845108em;"><span style="top:-2.6550000000000002em;"><span class="pstrut" style="height:3em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mathrm mtight">2</span></span></span></span><span style="top:-3.23em;"><span class="pstrut" style="height:3em;"></span><span class="frac-line" style="border-bottom-width:0.04em;"></span></span><span style="top:-3.394em;"><span class="pstrut" style="height:3em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight"><span class="mord mathrm mtight">1</span></span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:0.345em;"></span></span></span></span><span class="mclose nulldelimiter"></span></span><span class="minner"><span class="mopen"><span class="delimsizing mult"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.08597em;"><span style="top:-1.05597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-1.6619700000000002em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.26797em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.87397em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-3.47997em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-4.08597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500299999999998em;"></span></span></span></span></span><span class="mord"><span class="mtable"><span class="col-align-c"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.05em;"><span style="top:-4.21em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">a</span></span></span><span style="top:-3.0099999999999993em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">d</span></span></span><span style="top:-1.8099999999999994em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit" style="margin-right:0.03588em;">g</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500000000000007em;"></span></span></span></span><span class="arraycolsep" style="width:0.5em;"></span><span class="arraycolsep" style="width:0.5em;"></span><span class="col-align-c"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.05em;"><span style="top:-4.21em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">b</span></span></span><span style="top:-3.0099999999999993em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">e</span></span></span><span style="top:-1.8099999999999994em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">h</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500000000000007em;"></span></span></span></span><span class="arraycolsep" style="width:0.5em;"></span><span class="arraycolsep" style="width:0.5em;"></span><span class="col-align-c"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.05em;"><span style="top:-4.21em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">c</span></span></span><span style="top:-3.0099999999999993em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit" style="margin-right:0.10764em;">f</span></span></span><span style="top:-1.8099999999999994em;"><span class="pstrut" style="height:3em;"></span><span class="mord"><span class="mord mathit">i</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500000000000007em;"></span></span></span></span></span></span><span class="mclose"><span class="delimsizing mult"><span class="vlist-t vlist-t2"><span class="vlist-r"><span class="vlist" style="height:2.08597em;"><span style="top:-1.05597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-1.6619700000000002em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.26797em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-2.87397em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-3.47997em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span><span style="top:-4.08597em;"><span class="pstrut" style="height:2.606em;"></span><span class="delimsizinginner delim-size1"><span>&#x2223;</span></span></span></span><span class="vlist-s">&#x200b;</span></span><span class="vlist-r"><span class="vlist" style="height:1.5500299999999998em;"></span></span></span></span></span></span></span></span></span>

data/test/span/sup.html

@@ -0,0 +1 @@
+<span class="katex"><span class="katex-mathml"><math><semantics><mrow><msup><mi>a</mi><mn>2</mn></msup><mo>+</mo><msup><mi>b</mi><mn>2</mn></msup><mo>=</mo><msup><mi>c</mi><mn>2</mn></msup></mrow><annotation encoding="application/x-tex">a^2+b^2=c^2</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="strut" style="height:0.8141079999999999em;"></span><span class="strut bottom" style="height:0.897438em;vertical-align:-0.08333em;"></span><span class="base"><span class="mord"><span class="mord mathit">a</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8141079999999999em;"><span style="top:-3.063em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathrm mtight">2</span></span></span></span></span></span></span></span><span class="mbin">+</span><span class="mord"><span class="mord mathit">b</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8141079999999999em;"><span style="top:-3.063em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathrm mtight">2</span></span></span></span></span></span></span></span><span class="mrel">=</span><span class="mord"><span class="mord mathit">c</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8141079999999999em;"><span style="top:-3.063em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mathrm mtight">2</span></span></span></span></span></span></span></span></span></span></span>

data/test/test_all.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2017 Christian Cornelssen <ccorn@1tein.de>
+#
+# This file is part of SsKaTeX which is licensed under the MIT.
+#++
+
+require 'minitest/autorun'
+require 'sskatex'
+
+class SsKaTeXTest < Minitest::Test
+  def setup
+    @tex2html = SsKaTeX.new
+    @tex2html.logger = lambda do |level, &block|
+#      warn(block.call) if level == :verbose
+    end
+  end
+
+  TESTDIR = File.dirname(__FILE__)
+
+  # Generate test methods
+  Dir[File.join(TESTDIR, 'tex', '*.tex')].each do |f|
+    testcase = File.basename(f, '.tex').tr('^a-zA-Z0-9_', '_')
+    ['block', 'span'].each do |mode|
+      define_method("test_#{testcase}_#{mode}") do
+        tex = IO.read(f, external_encoding: Encoding::UTF_8).chomp
+        html = IO.read(File.join(TESTDIR, mode, testcase) + '.html',
+                       external_encoding: Encoding::UTF_8).chomp
+        assert_equal @tex2html.call(tex, mode == 'block'), html
+      end
+    end
+  end
+end

data/test/tex/det.tex

@@ -0,0 +1,2 @@
+\Delta = \frac{1}{2}
+\begin{vmatrix}a & b & c \\ d & e & f \\ g & h & i\end{vmatrix}

data/test/tex/sup.tex

@@ -0,0 +1 @@
+a^2+b^2=c^2

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: sskatex
+version: !ruby/object:Gem::Version
+  version: 0.9.20
+platform: ruby
+authors:
+- Christian Cornelssen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: duktape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: |
+  This is a TeX-to-HTML+MathML+CSS converter class using the Javascript-based
+  KaTeX, interpreted by one of the Javascript engines supported by ExecJS.
+  The intended purpose is to eliminate the need for math-rendering Javascript
+  in the client's HTML browser. Therefore the name: SsKaTeX means Server-side
+  KaTeX.
+
+  Javascript execution context initialization can be done once and then reused
+  for formula renderings with the same general configuration. As a result, the
+  performance is reasonable.
+
+  The configuration supports arbitrary locations of the external file katex.min.js
+  as well as custom Javascript for pre- and postprocessing.
+  For that reason, the configuration must not be left to untrusted users.
+email: ccorn@1tein.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- README.md
+- data/sskatex/js/escape_nonascii_html.js
+- data/sskatex/js/tex_to_html.js
+- lib/sskatex.rb
+- test/block/det.html
+- test/block/sup.html
+- test/span/det.html
+- test/span/sup.html
+- test/test_all.rb
+- test/tex/det.tex
+- test/tex/sup.tex
+homepage: https://github.com/ccorn/sskatex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "-a"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Javascript engine supported by the ExecJS gem
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Server-side KaTeX for Ruby
+test_files: []