kramdown-math-mathjaxnode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad99951db7cc187e81f6085d0ce0896b1cb73f42a285b8b98b8c4c3526f6236c
+  data.tar.gz: 2c0d0aac53a3c91c4120701dc0cdf105b62267e1aa8675780acce8f60016ed3e
+SHA512:
+  metadata.gz: 5fc4264e014c2608cd9b255c3012e48cd13e04fa2359fc1dddf180764fd9e46d6b3dfde255eaf6a0db29001c881ebb8f6d929dfe9a0cfb68a79584a16ad29c9a
+  data.tar.gz: 03a56fe3b29882318a5b7ec14e6d36e130c238d432dedc38417ef94e2081d1e0259beadbda17337f675d6d9fe4b2d5c11ea4980e61db9ae9b3d4470cbac4c0ba

data/CONTRIBUTERS

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

data/COPYING

@@ -0,0 +1,21 @@
+kramdown-math-mathjaxnode
+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-mathjaxnode.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-mathjaxnode which is licensed under the MIT.
+#++
+#
+
+require 'kramdown/converter/math_engine/mathjaxnode'

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

@@ -0,0 +1,69 @@
+# -*- coding: utf-8; frozen_string_literal: true -*-
+#
+#--
+# Copyright (C) 2019 Thomas Leitner <t_leitner@gmx.at>
+#
+# This file is part of kramdown-math-mathjaxnode which is licensed under the MIT.
+#++
+#
+
+require 'kramdown/converter'
+
+module Kramdown::Converter #:nodoc:
+  module MathEngine #:nodoc
+
+    # Uses the mathjax-node-cli library for converting math formulas to MathML.
+    module MathjaxNode
+
+      VERSION = '1.0.0'
+
+      # MathjaxNode is available if this constant is +true+.
+      AVAILABLE = begin
+        %x{node --version}[1..-2] >= '4.5'
+      rescue
+        begin
+          %x{nodejs --version}[1..-2] >= '4.5'
+        rescue
+          false
+        end
+      end && begin
+        npm = %x{npm --global --depth=1 list mathjax-node-cli 2>&1}
+
+        unless /mathjax-node-cli@/ === npm.lines.drop(1).join("\n")
+          npm = %x{npm --depth=1 list mathjax-node-cli 2>&1}
+        end
+
+        T2MPATH = File.join(npm.lines.first.strip, "node_modules/mathjax-node-cli/bin/tex2mml")
+        /mathjax-node-cli@/ === npm.lines.drop(1).join("\n") && File.exist?(T2MPATH)
+      rescue
+        false
+      end
+
+      unless AVAILABLE
+        raise "Needed dependencies (node, mathjax-node-cli) not found"
+      end
+
+      def self.call(converter, el, opts)
+        type = el.options[:category]
+
+        cmd = [T2MPATH]
+        cmd << "--inline" unless type == :block
+        cmd << "--semantics" if converter.options[:math_engine_opts][:semantics] == true
+        cmd << "--notexhints" if converter.options[:math_engine_opts][:texhints] == false
+        result = IO.popen(cmd << el.value).read.strip
+
+        attr = el.attr.dup
+        attr.delete('xmlns')
+        attr.delete('display')
+        result.insert("<math".length, converter.html_attributes(attr))
+
+        (type == :block ? "#{' '*opts[:indent]}#{result}\n" : result)
+      end
+
+    end
+
+  end
+
+  add_math_engine(:mathjaxnode, MathEngine::MathjaxNode)
+
+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-mathjaxnode which is licensed under the MIT.
+#++
+#
+
+require 'minitest/autorun'
+require 'kramdown'
+require 'kramdown-math-mathjaxnode'
+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/mathjaxnode-span.html

@@ -0,0 +1,27 @@
+<p>This is <math xmlns="http://www.w3.org/1998/Math/MathML" alttext="f left-parenthesis x right-parenthesis equals a x cubed plus b x squared plus c x plus d">
+  <mi>f</mi>
+  <mo stretchy="false">(</mo>
+  <mi>x</mi>
+  <mo stretchy="false">)</mo>
+  <mo>=</mo>
+  <mi>a</mi>
+  <mrow class="MJX-TeXAtom-ORD">
+    <msup>
+      <mi>x</mi>
+      <mn>3</mn>
+    </msup>
+  </mrow>
+  <mo>+</mo>
+  <mi>b</mi>
+  <mrow class="MJX-TeXAtom-ORD">
+    <msup>
+      <mi>x</mi>
+      <mn>2</mn>
+    </msup>
+  </mrow>
+  <mo>+</mo>
+  <mi>c</mi>
+  <mi>x</mi>
+  <mo>+</mo>
+  <mi>d</mi>
+</math> something!</p>

data/test/testcases/mathjaxnode-span.options

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

data/test/testcases/mathjaxnode-span.text

@@ -0,0 +1 @@
+This is $$f(x) = a{x^3} + b{x^2} + cx + d$$ something!

data/test/testcases/mathjaxnode.html

@@ -0,0 +1,27 @@
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block" alttext="f left-parenthesis x right-parenthesis equals a x cubed plus b x squared plus c x plus d">
+  <mi>f</mi>
+  <mo stretchy="false">(</mo>
+  <mi>x</mi>
+  <mo stretchy="false">)</mo>
+  <mo>=</mo>
+  <mi>a</mi>
+  <mrow class="MJX-TeXAtom-ORD">
+    <msup>
+      <mi>x</mi>
+      <mn>3</mn>
+    </msup>
+  </mrow>
+  <mo>+</mo>
+  <mi>b</mi>
+  <mrow class="MJX-TeXAtom-ORD">
+    <msup>
+      <mi>x</mi>
+      <mn>2</mn>
+    </msup>
+  </mrow>
+  <mo>+</mo>
+  <mi>c</mi>
+  <mi>x</mi>
+  <mo>+</mo>
+  <mi>d</mi>
+</math>

data/test/testcases/mathjaxnode.options

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

data/test/testcases/mathjaxnode.text

@@ -0,0 +1 @@
+$$f(x) = a{x^3} + b{x^2} + cx + d$$

data/test/testcases/mathjaxnode_notexhints.html

@@ -0,0 +1,23 @@
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block" alttext="f left-parenthesis x right-parenthesis equals a x cubed plus b x squared plus c x plus d">
+  <mi>f</mi>
+  <mo stretchy="false">(</mo>
+  <mi>x</mi>
+  <mo stretchy="false">)</mo>
+  <mo>=</mo>
+  <mi>a</mi>
+  <msup>
+    <mi>x</mi>
+    <mn>3</mn>
+  </msup>
+  <mo>+</mo>
+  <mi>b</mi>
+  <msup>
+    <mi>x</mi>
+    <mn>2</mn>
+  </msup>
+  <mo>+</mo>
+  <mi>c</mi>
+  <mi>x</mi>
+  <mo>+</mo>
+  <mi>d</mi>
+</math>

data/test/testcases/mathjaxnode_notexhints.options

@@ -0,0 +1,3 @@
+:math_engine: mathjaxnode
+:math_engine_opts:
+  :texhints: false

data/test/testcases/mathjaxnode_notexhints.text

@@ -0,0 +1 @@
+$$f(x) = a{x^3} + b{x^2} + cx + d$$

data/test/testcases/mathjaxnode_semantics.html

@@ -0,0 +1,32 @@
+<math xmlns="http://www.w3.org/1998/Math/MathML" display="block" alttext="f left-parenthesis x right-parenthesis equals a x cubed plus b x squared plus c x plus d">
+  <semantics>
+    <mrow>
+      <mi>f</mi>
+      <mo stretchy="false">(</mo>
+      <mi>x</mi>
+      <mo stretchy="false">)</mo>
+      <mo>=</mo>
+      <mi>a</mi>
+      <mrow class="MJX-TeXAtom-ORD">
+        <msup>
+          <mi>x</mi>
+          <mn>3</mn>
+        </msup>
+      </mrow>
+      <mo>+</mo>
+      <mi>b</mi>
+      <mrow class="MJX-TeXAtom-ORD">
+        <msup>
+          <mi>x</mi>
+          <mn>2</mn>
+        </msup>
+      </mrow>
+      <mo>+</mo>
+      <mi>c</mi>
+      <mi>x</mi>
+      <mo>+</mo>
+      <mi>d</mi>
+    </mrow>
+    <annotation encoding="application/x-tex">f(x) = a{x^3} + b{x^2} + cx + d</annotation>
+  </semantics>
+</math>

data/test/testcases/mathjaxnode_semantics.options

@@ -0,0 +1,3 @@
+:math_engine: mathjaxnode
+:math_engine_opts:
+  :semantics: true

data/test/testcases/mathjaxnode_semantics.text

@@ -0,0 +1 @@
+$$f(x) = a{x^3} + b{x^2} + cx + d$$

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: kramdown-math-mathjaxnode
+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'
+description: 
+email: t_leitner@gmx.at
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTERS
+- COPYING
+- VERSION
+- lib/kramdown-math-mathjaxnode.rb
+- lib/kramdown/converter/math_engine/mathjaxnode.rb
+- test/test_files.rb
+- test/testcases/mathjaxnode-span.html
+- test/testcases/mathjaxnode-span.options
+- test/testcases/mathjaxnode-span.text
+- test/testcases/mathjaxnode.html
+- test/testcases/mathjaxnode.options
+- test/testcases/mathjaxnode.text
+- test/testcases/mathjaxnode_notexhints.html
+- test/testcases/mathjaxnode_notexhints.options
+- test/testcases/mathjaxnode_notexhints.text
+- test/testcases/mathjaxnode_semantics.html
+- test/testcases/mathjaxnode_semantics.options
+- test/testcases/mathjaxnode_semantics.text
+homepage: https://github.com/kramdown/math-mathjaxnode
+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-mathjaxnode uses mathjax-node to convert math elements to MathML
+test_files: []