texmath-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58d0d834d41e8dedcde7b731f4aaadb325c2c3b5
+  data.tar.gz: 4f56df014bc172c78ed1c2ce8de6e400f67903fa
+SHA512:
+  metadata.gz: 68bc2a4a95ced0348f1ddf8be62ec1caaac43a0de3cebf2e59e573e490592c32f898abb9c137395149b9fbb407273026c829f9ae24c38d0e1335fa857e490669
+  data.tar.gz: 1b79da5a96331ead2c38f5738ddfd74880443b8cadb1ddc510491d4b4824f49d0d8a4eb34511e4f9af81a4e1b655b43cab1fdcafa991f7ab6747c62228f27ef7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.2
+  - ruby-head
+  - jruby-20mode # JRuby in 1.9 mode
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+cache: bundler
+before_install:
+  - sudo apt-get install haskell-platform
+  - cabal update
+  - cabal install texmath

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry'
+end
+
+group :development, :test do
+  gem 'bundler', '~> 1.6'
+  gem 'minitest', '~> 5.5'
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Casper Hollingberry
+
+MIT License
+
+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,89 @@
+# texmath-ruby
+
+A wrapper for [TeXMath](https://github.com/jgm/texmath), a Haskell library for
+converting between formats used to represent mathematics.
+
+TeXMath can convert between LaTeX, presentation MathML, and OMML (Office Math
+Markup Language). This wrapper uses the command line program for
+texmath for all operations (rather than interface directly with the
+Haskell library) and is heavily based on
+[William Melody's wrapper](https://github.com/alphabetum/pandoc-ruby)
+for [Pandoc](https://github.com/jgm/pandoc).
+
+## Installation
+
+First, make sure [texmath](https://github.com/jgm/texmath) is installed. If you
+already have [The Haskell Platform](https://www.haskell.org/platform/), you can
+install texmath with Cabal:
+
+```shell
+$ cabal install texmath
+```
+
+If you use [Bundler](http://bundler.io), then add this line to your
+application's Gemfile:
+
+```ruby
+gem 'texmath-ruby', require: 'texmath'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install texmath-ruby
+```
+
+## Usage
+
+Once everything is installed correctly, using TeXMath is incredibly easy.
+
+For example, converting from LaTeX to MathML looks like this:
+
+```ruby
+TeXMath.convert('\sqrt{x^3}', from: :tex, to: :mathml)
+  # => '<math display="block" xmlns=...'
+```
+
+TeXMath can convert between LaTeX, MathML, and OMML, in any
+direction. By default (if either the source or destination format
+isn't explicitly specified), TeXMath will try to convert from LaTeX to
+MathML. So to convert from LaTeX (the default source format) to OMML:
+
+```ruby
+TeXMath.convert('\sqrt{x^3}', to: :omml)
+  # => '<m:oMathPara>...'
+```
+
+Or from OMML to MathML (the default destination format):
+
+```ruby
+TeXMath.convert('<m:oMathPara>...', from: :omml)
+  # => '<math display="block" xmlns=...'
+```
+
+TeXMath also comes with writers for XHTML and Pandoc's native format.
+
+## Supported formats
+
+|             Format            |    Symbol    |  Reader  |  Writer  |
+|-------------------------------|--------------|----------|----------|
+| LaTeX                         | `:tex`       | &#10004; | &#10004; |
+| MathML                        | `:mathml`    | &#10004; | &#10004; |
+| Office Math Markup Language   | `:omml`      | &#10004; | &#10004; |
+| TeXMath native                | `:native`    | &#10004; | &#10004; |
+| XHTML                         | `:xhtml`     |          | &#10004; |
+| Pandoc native                 | `:pandoc`    |          | &#10004; |
+
+## Contributing
+
+1. Fork it ( https://github.com/hollingberry/texmath-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+task :default => :test
+
+desc 'Run the tests'
+task :test do
+  $LOAD_PATH.unshift 'lib', 'test'
+  Dir['test/**/*_test.rb'].each do |file|
+    require File.expand_path(file)
+  end
+end

data/lib/texmath.rb

@@ -0,0 +1,9 @@
+require 'texmath/converter'
+require 'texmath/errors'
+require 'texmath/version'
+
+module TeXMath
+  def self.convert(data, options = {})
+    Converter.new(options).convert(data)
+  end
+end

data/lib/texmath/converter.rb

@@ -0,0 +1,78 @@
+require 'texmath/errors'
+require 'open3'
+
+module TeXMath
+  ##
+  # A `Converter` represents a single `texmath` command to which data
+  # can be piped. For example, a `Converter` that converts LaTeX to
+  # MathML can be reused for different input expressions, although all
+  # would have to be valid LaTeX.
+  class Converter
+    ##
+    # The available readers and their corresponding names.
+    READERS = {
+      'tex' => 'LaTeX',
+      'mathml' => 'MathML',
+      'omml' => 'Office Math Markup Language',
+      'native' => 'texmath native'
+    }
+
+    ##
+    # The available writers and their corresponding names.
+    WRITERS = {
+      'tex' => 'LaTeX',
+      'mathml' => 'MathML',
+      'omml' => 'Office Math Markup Language',
+      'xhtml' => 'XHTML',
+      'pandoc' => 'pandoc native',
+      'native' => 'texmath native'
+    }
+
+    ##
+    # Create a new Converter.
+    # @param executable [String] the executable path
+    # @param from [Symbol] the source format
+    # @param to [Symbol] the destination format
+    def initialize(executable = 'texmath', from: :tex, to: :mathml)
+      @executable = executable
+      self.reader = from
+      self.writer = to
+    end
+
+    attr_reader :executable
+
+    ##
+    # Convert `data` between formats.
+    # @return [String] the converted data
+    def convert(data)
+      Open3.popen3(command) do |stdin, stdout, stderr| 
+        stdin.puts(data)
+        stdin.close
+        output = stdout.read
+        error = stderr.read
+        raise ConversionError.new(error) unless error.empty?
+        return output.strip
+      end
+    rescue Errno::ENOENT
+      raise NoExecutableError.new("Can't find the '#{executable}' executable.")
+    end
+
+    attr_reader :reader, :writer
+
+    def reader=(format)
+      return @reader = format if READERS.has_key?(format.to_s)
+      raise InvalidReaderError.new("Can't find '#{format}' reader.")
+    end
+
+    def writer=(format)
+      return @writer = format if WRITERS.has_key?(format.to_s)
+      raise InvalidWriterError.new("Can't find '#{format}' writer.")
+    end
+
+    private
+
+    def command
+      "#{executable} -f #{reader} -t #{writer}"
+    end
+  end
+end

data/lib/texmath/errors.rb

@@ -0,0 +1,22 @@
+module TeXMath
+  ##
+  # Error raised when the underlying Haskell library writes to
+  # /dev/stderr. This usually occurs when the input was malformed.
+  class ConversionError < StandardError; end
+
+  ##
+  # Error raised when the `texmath` executable can't be found.
+  class NoExecutableError < StandardError; end
+
+  ##
+  # Error raised when an invalid reader or writer format is specified.
+  class InvalidFormatError < StandardError; end
+
+  ##
+  # Error raised when an invalid reader format is specified.
+  class InvalidReaderError < InvalidFormatError; end
+
+  ##
+  # Error raised when an invalid writer format is specified.
+  class InvalidWriterError < InvalidFormatError; end
+end

data/lib/texmath/version.rb

@@ -0,0 +1,3 @@
+module TeXMath
+  VERSION = '0.0.1'
+end

data/test/support/formats.rb

@@ -0,0 +1,84 @@
+module Formats
+  def tex
+    '\sqrt{x^{3}}'
+  end
+
+  def mathml
+    <<-XML.gsub(/^      /, '').strip
+      <math display="block" xmlns="http://www.w3.org/1998/Math/MathML">
+        <msqrt>
+          <msup>
+            <mi>x</mi>
+            <mn>3</mn>
+          </msup>
+        </msqrt>
+      </math>
+    XML
+  end
+
+  def omml
+    <<-XML.gsub(/^      /, '').strip
+      <m:oMathPara>
+        <m:oMathParaPr>
+          <m:jc m:val="center" />
+        </m:oMathParaPr>
+        <m:oMath>
+          <m:rad>
+            <m:radPr>
+              <m:degHide m:val="on" />
+            </m:radPr>
+            <m:deg />
+            <m:e>
+              <m:sSup>
+                <m:e>
+                  <m:r>
+                    <m:rPr>
+                      <m:sty m:val="p" />
+                    </m:rPr>
+                    <m:t>x</m:t>
+                  </m:r>
+                </m:e>
+                <m:sup>
+                  <m:r>
+                    <m:rPr>
+                      <m:sty m:val="p" />
+                    </m:rPr>
+                    <m:t>3</m:t>
+                  </m:r>
+                </m:sup>
+              </m:sSup>
+            </m:e>
+          </m:rad>
+        </m:oMath>
+      </m:oMathPara>
+    XML
+  end
+
+  def xhtml
+    <<-XML.gsub(/^      /, '').strip
+      <html xmlns="http://www.w3.org/1999/xhtml">
+        <head>
+          <meta content="application/xhtml+xml; charset=UTF-8" http-equiv="Content-Type" />
+        </head>
+        <body>
+          <math display="block" xmlns="http://www.w3.org/1998/Math/MathML">
+            <msqrt>
+              <msup>
+                <mi>x</mi>
+                <mn>3</mn>
+              </msup>
+            </msqrt>
+          </math>
+        </body>
+      </html>
+    XML
+  end
+
+  def pandoc
+    '[Math DisplayMath "\\\\sqrt{x^{3}}"]'
+  end
+
+  def native
+    '[ESqrt (ESuper (EIdentifier "x") (ENumber "3"))]'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+# Configure $LOAD_PATH
+require 'bundler/setup'
+
+# Load texmath
+require 'texmath'
+
+# Load testing libraries
+require 'minitest/autorun'
+
+# Load debugging libraries
+require 'pp'

data/test/texmath/converter_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+require 'support/formats'
+
+class ConverterTest < Minitest::Test
+  include Formats
+  include TeXMath
+
+  Converter::READERS.each_key do |reader|
+    Converter::WRITERS.each_key do |writer|
+      define_method "test_#{reader}_to_#{writer}" do
+        assert_converts reader, writer
+      end
+    end
+  end
+
+  def test_symbol_reader_and_writer
+    assert_converts :tex, :mathml
+  end
+
+  def test_string_reader_and_writer
+    assert_converts 'tex', 'mathml'
+  end
+
+  def test_default_reader
+    assert_equal :tex, Converter.new(to: :mathml).reader
+  end
+
+  def test_default_writer
+    assert_equal :mathml, Converter.new(from: :tex).writer
+  end
+
+  def test_invalid_input
+    assert_raises ConversionError do
+      Converter.new.convert('\sqrt{3')
+    end
+  end
+
+  def test_executable_not_found
+    assert_raises NoExecutableError, "Can't find the 'ogremath' executable." do
+      Converter.new('ogremath').convert('\sqrt{3}')
+    end
+  end
+
+  def test_string_reader_not_found
+    assert_raises InvalidReaderError, "Can't find 'pears' reader." do
+      Converter.new(from: 'pears', to: :mathml)
+    end
+  end
+
+  def test_string_writer_not_found
+    assert_raises InvalidWriterError, "Can't find 'pears' writer." do
+      Converter.new(from: :tex, to: 'pears')
+    end
+  end
+
+  def test_symbol_reader_not_found
+    assert_raises InvalidReaderError, "Can't find 'pears' reader." do
+      Converter.new(from: :pears, to: :mathml)
+    end
+  end
+
+  def test_symbol_writer_not_found
+    assert_raises InvalidWriterError, "Can't find 'pears' writer." do
+      Converter.new(from: :tex, to: :pears)
+    end
+  end
+
+  private
+
+  def assert_converts(from, to)
+    input, expected_output = send(from), send(to)
+    actual_output = TeXMath.convert(input, from: from, to: to)
+    assert_equal expected_output, actual_output
+  end
+end

data/texmath-ruby.gemspec

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+
+require 'texmath/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'texmath-ruby'
+  spec.version       = TeXMath::VERSION
+  spec.authors       = ['Casper Hollingberry']
+  spec.email         = ['hollingberry7@gmail.com']
+  spec.summary       = 'Convert math markup between LaTeX, MathML, and OMML.'
+  spec.description   = 'Convert math markup between LaTeX, MathML, and OMML using Ruby. A wrapper for TeXMath, a Haskell library written by the creator of Pandoc.'
+  spec.homepage      = 'http://github.com/hollingberry/texmath-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(/^test/)
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: texmath-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Casper Hollingberry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-10 00:00:00.000000000 Z
+dependencies: []
+description: Convert math markup between LaTeX, MathML, and OMML using Ruby. A wrapper
+  for TeXMath, a Haskell library written by the creator of Pandoc.
+email:
+- hollingberry7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/texmath.rb
+- lib/texmath/converter.rb
+- lib/texmath/errors.rb
+- lib/texmath/version.rb
+- test/support/formats.rb
+- test/test_helper.rb
+- test/texmath/converter_test.rb
+- texmath-ruby.gemspec
+homepage: http://github.com/hollingberry/texmath-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Convert math markup between LaTeX, MathML, and OMML.
+test_files:
+- test/support/formats.rb
+- test/test_helper.rb
+- test/texmath/converter_test.rb