mathml2asciimath 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8737530a0a13306fbbae39a18d7eb464905fa9d
+  data.tar.gz: fcdcd915ff8319b98cb1dedbb7b3d5b57e8668ad
+SHA512:
+  metadata.gz: '08e516b489e48eb8fb9387d42980db48a838cb33c7efb66c3763550bf8b4c62948a3c8135c20b591bad50adb9f79e64bd3fb578849800809f147406f00a90d38'
+  data.tar.gz: 0b5b8f8d1cfb0a44d1e98aff1b44368d67a79947311d40cf97387bb3ca2a88ea15ae06e7d465d6e2f6ccc5e14ab3a65ebeaeec071272b9ad30f52235ffcf22b6

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2018, Ribose
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.adoc

@@ -0,0 +1,12 @@
+= mathml2asciimath
+
+Ruby gem to convert MathML into AsciiMath
+
+Ignores style and MathML attributes (other than `mfenced/@open`, `mfenced/@close`, `mo/@fence`).
+
+Processes the following MathML tags: `mrow, mfenced, msqrt, mfrac, msup, msub, munderover, msubsup, munder, mover, mi, mn, ntext, mo, mtable, mtr, mtd`.
+
+Converts all the Unicode characters MathJax knows about into AsciiMath operators (e.g. `\\beta, xx, oint`)
+
+As with the other two MathML to AsciiMath converters available online (Python: https://github.com/rochecompaan/upfront.mathml2asciimath, Node.js: https://github.com/learningobjectsinc/mathml-to-asciimath), this converter is not foolproof, production-ready, or complete, and you will need to post-edit output. It's still a lot better than nothing. (And because it converts Unicode to Ascii, it's a lot better than the other two.)
+

data/bin/m2a.rb

@@ -0,0 +1,17 @@
+require "mathml2asciimath"
+
+STDIN.set_encoding("UTF-8")
+while a = gets
+  matches = a.split(%r{(<math.*?</math>)})
+  out = ""
+  matches.each do |x|
+    if /<math/.match? x
+      out += MathML2AsciiMath.m2a(x)
+    else
+      out += x
+    end
+  end
+  print out
+end
+
+

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+  
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
+  "../../Gemfile", Pathname.new(__FILE__).realpath
+)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")
+

data/lib/mathml2asciimath.rb

@@ -0,0 +1,5 @@
+require_relative "mathml2asciimath/version"
+require_relative "mathml2asciimath/m2a"
+
+require "nokogiri"
+require "htmlentities"

data/lib/mathml2asciimath/m2a.rb

@@ -0,0 +1,265 @@
+require "nokogiri"
+require "htmlentities"
+require "pp"
+
+module MathML2AsciiMath
+
+  def self.m2a(x)
+    docxml = Nokogiri::XML(x)
+    parse(docxml.root).gsub(/  /, " ").
+      sub(/^\s+/, "").
+      sub(/\s+$/, "")
+  end
+
+  def self.encodechars(x)
+    x.gsub(/\u03b1/, "\\alpha").
+      gsub(/\u03b2/, "\\beta").
+      gsub(/\u03b3/, "\\gamma").
+      gsub(/\u0393/, "\\Gamma").
+      gsub(/\u03b4/, "\\delta").
+      gsub(/\u0394/, "\\Delta").
+      gsub(/\u2206/, "\\Delta").
+      gsub(/\u03b5/, "\\epsilon").
+      gsub(/\u025b/, "\\varepsilon").
+      gsub(/\u03b6/, "\\zeta").
+      gsub(/\u03b7/, "\\eta").
+      gsub(/\u03b8/, "\\theta").
+      gsub(/\u0398/, "\\Theta").
+      gsub(/\u03d1/, "\\vartheta").
+      gsub(/\u03b9/, "\\iota").
+      gsub(/\u03ba/, "\\kappa").
+      gsub(/\u03bb/, "\\lambda").
+      gsub(/\u039b/, "\\Lambda").
+      gsub(/\u03bc/, "\\mu").
+      gsub(/\u03bd/, "\\nu").
+      gsub(/\u03be/, "\\xi").
+      gsub(/\u039e/, "\\Xi").
+      gsub(/\u03c0/, "\\pi").
+      gsub(/\u03a0/, "\\Pi").
+      gsub(/\u03c1/, "\\rho").
+      gsub(/\u03c2/, "\\beta").
+      gsub(/\u03c3/, "\\sigma").
+      gsub(/\u03a3/, "\\Sigma").
+      gsub(/\u03c4/, "\\tau").
+      gsub(/\u03c5/, "\\upsilon").
+      gsub(/\u03c6/, "\\phi").
+      gsub(/\u03a6/, "\\Phi").
+      gsub(/\u03d5/, "\\varphi").
+      gsub(/\u03c7/, "\\chi").
+      gsub(/\u03c8/, "\\psi").
+      gsub(/\u03a8/, "\\Psi").
+      gsub(/\u03c9/, "\\omega").
+      gsub(/\u22c5/, "*").
+      gsub(/\u2219/, "*").
+      gsub(/\u00b7/, "*").
+      gsub(/\u2217/, "**").
+      gsub(/\u22c6/, "***").
+      gsub(/\//, "//").
+      gsub(/\\/, "\\\\").
+      gsub(/\u00d7/, "xx").
+      gsub(/\u22c9/, "|><").
+      gsub(/\u22ca/, "><|").
+      gsub(/\u22c8/, "|><|").
+      gsub(/\u00f7/, "-:").
+      gsub(/\u2218/, "@").
+      gsub(/\u2295/, "o+").
+      gsub(/\u2297/, "ox").
+      gsub(/\u2299/, "o.").
+      gsub(/\u2211/, "sum").
+      gsub(/\u220f/, "prod").
+      gsub(/\u2227/, "^^").
+      gsub(/\u22c0/, "^^^").
+      gsub(/\u2228/, "vv").
+      gsub(/\u22c1/, "vvv").
+      gsub(/\u2229/, "nn").
+      gsub(/\u22c2/, "nnn").
+      gsub(/\u222a/, "uu").
+      gsub(/\u22c3/, "uuu").
+      gsub(/\u2260/, "!=").
+      gsub(/\u2264/, "<=").
+      gsub(/\u2265/, ">=").
+      gsub(/\u227a/, "-<").
+      gsub(/\u227b/, ">-").
+      gsub(/\u2aaf/, "-<=").
+      gsub(/\u2ab0/, ">-=").
+      gsub(/\u2208/, "in").
+      gsub(/\u2209/, "!in").
+      gsub(/\u2282/, "sub").
+      gsub(/\u2283/, "sup").
+      gsub(/\u2286/, "sube").
+      gsub(/\u2287/, "supe").
+      gsub(/\u2261/, "-=").
+      gsub(/\u2245/, "~=").
+      gsub(/\u2248/, "~~").
+      gsub(/\u221d/, "prop").
+      gsub(/\u00ac/, "not").
+      gsub(/\u21d2/, "=>").
+      gsub(/\u21d4/, "<=>").
+      gsub(/\u2200/, "AA").
+      gsub(/\u2203/, "EE").
+      gsub(/\u22a5/, "_|_").
+      gsub(/\u22a4/, "TT").
+      gsub(/\u22a2/, "|--").
+      gsub(/\u22a8/, "|==").
+      gsub(/\u22a8/, "|==").
+      gsub(/\u2329/, "(:").
+      gsub(/\u232a/, ":)").
+      gsub(/\u2329/, "<<").
+      gsub(/\u232a/, ">>").
+      gsub(/\u222e/, "oint").
+      gsub(/\u2202/, "del").
+      gsub(/\u2207/, "grad").
+      gsub(/\u00b1/, "+-").
+      gsub(/\u2205/, "O/").
+      gsub(/\u221e/, "oo").
+      gsub(/\u2135/, "aleph").
+      gsub(/\u2234/, ":.").
+      gsub(/\u2235/, ":'").
+      gsub(/\u2220/, "/_").
+      gsub(/\u25b3/, "/_\\").
+      gsub(/\u2032/, "'").
+      gsub(/~/, "tilde").
+      gsub(/\u00a0\u00a0\u00a0\u00a0/, "qquad").
+      gsub(/\u00a0\u00a0/, "quad").
+      gsub(/\u00a0/, "\\ ").
+      gsub(/\u2322/, "frown").
+      gsub(/\u00a0/, "quad").
+      gsub(/\u22ef/, "cdots").
+      gsub(/\u22ee/, "vdots").
+      gsub(/\u22f1/, "ddots").
+      gsub(/\u22c4/, "diamond").
+      gsub(/\u25a1/, "square").
+      gsub(/\u230a/, "|__").
+      gsub(/\u230b/, "__|").
+      gsub(/\u2308/, "|~").
+      gsub(/\u2309/, "~|").
+      gsub(/\u2102/, "CC").
+      gsub(/\u2115/, "NN").
+      gsub(/\u211a/, "QQ").
+      gsub(/\u211d/, "RR").
+      gsub(/\u2124/, "ZZ").
+      gsub(/\u2191/, "uarr").
+      gsub(/\u2193/, "darr").
+      gsub(/\u2190/, "larr").
+      gsub(/\u2194/, "harr").
+      gsub(/\u21d2/, "rArr").
+      gsub(/\u21d0/, "lArr").
+      gsub(/\u21d4/, "hArr").
+      gsub(/\u2192/, "->").
+      gsub(/\u21a3/, ">->").
+      gsub(/\u21a0/, "->>").
+      gsub(/\u2916/, ">->>").
+      gsub(/\u21a6/, "|->").
+      gsub(/\u2026/, "...").
+      gsub(/\u2212/, "-").
+      gsub(/\u2061/, ""). # function application
+      gsub(/\u2751/, "square")
+  end
+
+  def self.parse(node)
+    out = ""
+    if node.text?
+      return encodechars(HTMLEntities.new.decode(node.text))
+    else
+      case node.name
+      when "math"
+        node.elements.each { |n| out << parse(n) }
+        return out
+      when "mrow"
+        outarr = []
+        node.children.each { |n| outarr << parse(n) }
+        out = outarr.join("")
+        if %w{mfrac msub munder munderover}.include? node.parent.name
+          out = "(#{out})"
+        end
+        return out
+      when "mfenced"
+        outarr = []
+        open = node["open"] || "("
+        close = node["close"] || ")"
+        separator = "," # TODO currently ignore the supplied separators
+        node.children.each { |n| outarr << parse(n) }
+        out = outarr.join(separator)
+        return "#{open}#{out}#{close}"
+      when "msqrt"
+        node.children.each { |n| out << parse(n) }
+        return "sqrt(#{out})"
+      when "mfrac"
+        return "(#{parse(node.elements[0])})/(#{parse(node.elements[1])})"
+      when "msup"
+        sup = parse(node.elements[1])
+        sup = "(#{sup})" unless sup.length == 1
+        op = parse(node.elements[0]).gsub(/ $/, "")
+        return "#{op}^#{sup}"
+      when "msub"
+        sub = parse(node.elements[1])
+        sub = "(#{sub})" unless sub.length == 1
+        op = parse(node.elements[0]).gsub(/ $/, "")
+        return "#{op}_#{sub}"
+      when "munderover", "msubsup"
+        sub = parse(node.elements[1])
+        sub = "(#{sub})" unless sub.length == 1
+        sup = parse(node.elements[2])
+        sup = "(#{sup})" unless sup.length == 1
+        op = parse(node.elements[0]).gsub(/ $/, "")
+        return "#{op}_#{sub}^#{sup}"
+      when "munder"
+        elem1 = parse(node.elements[1]).sub(/^\s+/, "").sub(/\s+$/, "")
+        accent = case elem1
+                 when "\u0332" then "ul"
+                 when "\u23df" then "ubrace"
+                 else
+                   "underset"
+                 end
+        if accent == "underset"
+          return "underset(#{elem1})(#{parse(node.elements[0])})"
+        else
+          return "#{accent} #{parse(node.elements[0])}"
+        end
+      when "mover"
+        elem1 = parse(node.elements[1]).sub(/^\s+/, "").sub(/\s+$/, "")
+        accent = case elem1
+                 when "\u005e" then "hat"
+                 when "\u00af" then "bar"
+                 when "\u2192" then "vec"
+                 when "." then "dot"
+                 when ".." then "ddot"
+                 when "\u23de" then "obrace"
+                 else
+                   "overset"
+                 end
+        if accent == "overset"
+          return "overset(#{elem1})(#{parse(node.elements[0])})"
+        else
+          return "#{accent} #{parse(node.elements[0])}"
+        end
+      when "mtable"
+        rows = []
+        node.children.each { |n| rows << parse(n) }
+        return "[#{rows.join(",")}]"
+      when "mtr"
+        cols = []
+        node.children.each { |n| cols << parse(n) }
+        return "[#{cols.join(",")}]"
+      when "mtd"
+        node.children.each { |n| out << parse(n) }
+        return "#{out}"
+      when "mn", "mtext"
+        node.children.each { |n| out << parse(n) }
+        return "#{out}"
+      when "mi"
+        # mi is not meant to have space around it, but Word is conflating operators and operands
+        node.children.each { |n| out << parse(n) }
+        out = " #{out} " if /[^a-zA-Z0-9',]|[a-z][a-z]/.match? out
+        return out
+      when "mo"
+        node.children.each { |n| out << parse(n) }
+        out = " #{out} " unless node["fence"]
+        return out
+      else
+        node.to_xml
+      end
+    end
+  end
+
+end

data/lib/mathml2asciimath/version.rb

@@ -0,0 +1,4 @@
+module MathML2AsciiMath
+  VERSION = "0.0.1".freeze
+end
+

data/mathml2asciimath.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mathml2asciimath/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mathml2asciimath"
+  spec.version       = MathML2AsciiMath::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Convert MathML to AsciiMath "
+  spec.description   = <<~DESCRIPTION
+    Convert MathML to AsciiMath
+
+    This gem is in active development.
+  DESCRIPTION
+
+  spec.homepage      = "https://github.com/riboseinc/mathml2asciimath"
+  spec.license       = "MIT"
+
+  spec.bindir        = "bin"
+  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.add_dependency "htmlentities", "~> 4.3.4"
+  spec.add_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "equivalent-xml", "~> 0.6"
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "rubocop", "~> 0.50"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_development_dependency "timecop", "~> 0.9"
+end

metadata

@@ -0,0 +1,223 @@
+--- !ruby/object:Gem::Specification
+name: mathml2asciimath
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |
+  Convert MathML to AsciiMath
+
+  This gem is in active development.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- bin/m2a.rb
+- bin/rspec
+- lib/mathml2asciimath.rb
+- lib/mathml2asciimath/m2a.rb
+- lib/mathml2asciimath/version.rb
+- mathml2asciimath.gemspec
+homepage: https://github.com/riboseinc/mathml2asciimath
+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.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Convert MathML to AsciiMath
+test_files: []