kramdown-math-sskatex 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eea0ebeb94d328134576b141281e3a6171453e178a89914883741dd791af3500
+  data.tar.gz: f146f00e8f64211f8d110b396435360eda48899e73699aea93d7f84670676fac
+SHA512:
+  metadata.gz: 06c146ff1190a226bb860d1351dacc328ee20d0e8b261ae908b62f3fe62e375ab3a145e5a4ebd6c6c48e892b1345269c969a926599cd6406ad27bd9024a467d9
+  data.tar.gz: e1f11778786850f53c758e3cc8d236faedeb9d384c045ec02ed1bcf12e1c34eda9708aa359953f2ef35ccdf802504c0c9e1ee49ed06b9cecdbac654590ddc73e

data/CONTRIBUTERS

@@ -0,0 +1,3 @@
+  Count Name
+======= ====
+      1 Thomas Leitner <t_leitner@gmx.at>

data/COPYING

@@ -0,0 +1,21 @@
+kramdown-math-sskatex
+Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+
+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/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/kramdown-math-sskatex.rb

@@ -0,0 +1,10 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown-math-sskatex which is licensed under the MIT.
+#++
+#
+
+require 'kramdown/converter/math_engine/sskatex'

data/lib/kramdown/converter/math_engine/sskatex.rb

@@ -0,0 +1,94 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2017 Christian Cornelssen <ccorn@1tein.de>
+#
+# This file is part of kramdown-math-sskatex which is licensed under the MIT.
+#++
+
+require 'kramdown/converter'
+require 'sskatex'
+
+module Kramdown::Converter #:nodoc:
+  module MathEngine #:nodoc
+
+    # Consider this a lightweight alternative to MathjaxNode. Uses KaTeX and ExecJS (via ::SsKaTeX)
+    # instead of MathJax and Node.js. Javascript execution context initialization is done only once.
+    # As a result, the performance is reasonable.
+    module SsKaTeX
+
+      VERSION = '1.0.0'
+
+      # Class-level cache for ::SsKaTeX converter state, queried by configuration. Note: KTXC
+      # contents may become stale if the contents of used JS files change while the configuration
+      # remains unchanged.
+      KTXC = ::Kramdown::Utils::LRUCache.new(10)
+
+      # A logger that routes messages to the debug channel only. No need to create this dynamically.
+      DEBUG_LOGGER = lambda {|_level, &expr| warn(expr.call) }
+
+      class << self
+
+        private
+
+        # Given a Kramdown::Converter::Base object _converter_, retrieves the logging options and
+        # builds an object usable for ::SsKaTeX#logger. The result is either +nil+ (no logging) or a
+        # +Proc+ object which, when given a _level_ (either +:verbose+ or +:debug+) and a block,
+        # decides whether logging is enabled, and if so, evaluates the given block for the message
+        # and routes that message to the appropriate channels. With <tt>level == :verbose+</tt>,
+        # messages are passed to _converter_.warning if the _converter_'s +:verbose+ option is set.
+        # All messages are passed to +warn+ if the _converter_'s +:debug+ option is set.
+        #
+        # Note that the returned logger may contain references to the given _converter_ and is not
+        # affected by subsequent changes in the _converter_'s logging options.
+        def logger(converter)
+          config = converter.options[:math_engine_opts]
+          debug = config[:debug]
+          if config[:verbose]
+            # Need a closure
+            lambda do |level, &expr|
+              verbose = (level == :verbose)
+              msg = expr.call if debug || verbose
+              warn(msg) if debug
+              converter.warning(msg) if verbose
+            end
+          elsif debug
+            DEBUG_LOGGER
+          end
+        end
+
+        # Given a Kramdown::Converter::Base object _converter_, return a ::SsKaTeX converter _sktx_
+        # that has been configured with _converter_'s +math_engine_opts+, but not for logging. Cache
+        # _sktx_ for reuse, without references to _converter_.
+        def katex_conv(converter)
+          config = converter.options[:math_engine_opts]
+          # Could .reject { |key, _| [:verbose, :debug].include?(key.to_sym) }
+          # because the JS engine setup can be reused for different logging settings.
+          # But then the +math_engine_opts+ dict would be essentially dup'ed every time,
+          # and late activation of logging would miss the initialization if the engine is reused.
+          KTXC[config] ||= ::SsKaTeX.new(config)
+        end
+
+        public
+
+        # The function used by kramdown for rendering TeX math to HTML
+        def call(converter, el, opts)
+          display_mode = el.options[:category]
+          ans = katex_conv(converter).call(el.value, display_mode == :block, &logger(converter))
+          attr = el.attr.dup
+          attr.delete('xmlns')
+          attr.delete('display')
+          ans.insert(ans =~ /[[:space:]>]/, converter.html_attributes(attr))
+          ans = ' ' * opts[:indent] << ans << "\n" if display_mode == :block
+          ans
+        end
+
+      end
+
+    end
+
+  end
+
+  add_math_engine(:sskatex, MathEngine::SsKaTeX)
+
+end

data/test/test_files.rb

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+#
+#--
+# Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown-math-sskatex which is licensed under the MIT.
+#++
+#
+
+require 'minitest/autorun'
+require 'kramdown'
+require 'kramdown-math-sskatex'
+require 'yaml'
+require 'tmpdir'
+
+Encoding.default_external = 'utf-8'
+
+class TestFiles < Minitest::Test
+
+  Dir[File.dirname(__FILE__) + '/testcases/**/*.text'].each do |text_file|
+    basename = text_file.sub(/\.text$/, '')
+
+    html_file = basename + '.html'
+    define_method('test_' + text_file.tr('.', '_') + "_to_html") do
+      opts_file = basename + '.options'
+      opts_file = File.join(File.dirname(html_file), 'options') if !File.exist?(opts_file)
+      options = File.exist?(opts_file) ? YAML::load(File.read(opts_file)) : {auto_ids: false, footnote_nr: 1}
+      doc = Kramdown::Document.new(File.read(text_file), options)
+      assert_equal(File.read(html_file), doc.to_html)
+    end
+  end
+
+end

data/test/testcases/sskatex-span.html

@@ -0,0 +1 @@
+<p>Erst einmal eine Formel wie <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> innerhalb eines Satzes.</p>

data/test/testcases/sskatex-span.options

@@ -0,0 +1 @@
+:math_engine: sskatex

data/test/testcases/sskatex-span.text

@@ -0,0 +1 @@
+Erst einmal eine Formel wie $$a^2+b^2=c^2$$ innerhalb eines Satzes.

data/test/testcases/sskatex.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/testcases/sskatex.options

@@ -0,0 +1 @@
+:math_engine: sskatex

data/test/testcases/sskatex.text

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-math-sskatex
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Thomas Leitner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sskatex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.37
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.37
+description: 
+email: t_leitner@gmx.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTERS
+- COPYING
+- VERSION
+- lib/kramdown-math-sskatex.rb
+- lib/kramdown/converter/math_engine/sskatex.rb
+- test/test_files.rb
+- test/testcases/sskatex-span.html
+- test/testcases/sskatex-span.options
+- test/testcases/sskatex-span.text
+- test/testcases/sskatex.html
+- test/testcases/sskatex.options
+- test/testcases/sskatex.text
+homepage: https://github.com/kramdown/math-sskatex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: kramdown-math-sskatex uses katex to convert math elements to HTML+MathML
+  on the server side
+test_files: []