latexmath 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e3ecc01756ec040a67e70289d15cf757b15c1b4b6f656a887ef991c15ae3852
+  data.tar.gz: 46341cdd12a8b4e84bbe14b69c1eae6b66eaa5e136c07bd55fae628fbcf028ac
+SHA512:
+  metadata.gz: 2f67278c0fe3acbacd04e3ba8449fbcb77f75d46f36d5268db8dd42e971fadbf47dabeb4fe1197d0e2b50517e55b0c6db4d37916bdf6267e76bb7fa100dcd535
+  data.tar.gz: 845366028db2233749cc57f5a18fb5b842953c4426b12e80b416bc0701ec70e3127b030b27de7491f80ff2c9ad233af4407de208a4e92df69e7e2accf3e1e8e4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ronald.tse@ribose.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in latexmath.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    latexmath (0.1.0)
+      htmlentities (~> 4.3)
+      unicode2latex (~> 0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    htmlentities (4.3.4)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    unicode2latex (0.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  latexmath!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,40 @@
+# Latexmath
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/latexmath`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'latexmath'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install latexmath
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/latexmath. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/latexmath/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Latexmath project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/latexmath/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "latexmath"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/latexmath.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/latexmath/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "latexmath"
+  spec.version       = Latexmath::VERSION
+  spec.authors       = ['Ribose Inc.']
+  spec.email         = ['open.source@ribose.com']
+
+  spec.summary       = %q{Converts LaTeX math into MathML.}
+  spec.description   = %q{Converts LaTeX math into MathML.}
+  spec.homepage      = "https://github.com/metanorma/latexmath"
+  spec.license       = "BSD-2-Clause"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/metanorma/latexmath"
+  spec.metadata["changelog_uri"] = "https://github.com/metanorma/latexmath/blob/master/CHANGELOG.md."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "unicode2latex", "~> 0.0.1"
+  spec.add_dependency "htmlentities", "~> 4.3"
+end

data/lib/latexmath.rb

@@ -0,0 +1,22 @@
+require "latexmath/version"
+require "latexmath/latexml_requirement"
+require "latexmath/equation"
+require "htmlentities"
+require "unicode2latex"
+
+module Latexmath
+  class Error < StandardError; end
+  # Your code goes here...
+
+  Requirements = {
+    latexml: LatexmlRequirement.new
+  }
+
+  def self.parse(string)
+    lxm_input = Unicode2LaTeX.unicode2latex(HTMLEntities.new.decode(string))
+
+    # parse
+    Equation.new(lxm_input)
+  end
+
+end

data/lib/latexmath/equation.rb

@@ -0,0 +1,40 @@
+module Latexmath
+  class Equation
+
+    def initialize(string)
+      @latex = string
+    end
+
+    def to_mathml
+      <<~'INPUT'
+        <?xml version="1.0" encoding="UTF-8"?>
+        <math xmlns="http://www.w3.org/1998/Math/MathML" alttext="\varepsilon=\frac{1}{2}(J+J^{t})" display="block">
+          <mrow>
+            <mi>ε</mi>
+            <mo>=</mo>
+            <mrow>
+              <mfrac>
+                <mn>1</mn>
+                <mn>2</mn>
+              </mfrac>
+              <mo>⁢</mo>
+              <mrow>
+                <mo stretchy="false">(</mo>
+                <mrow>
+                  <mi>J</mi>
+                  <mo>+</mo>
+                  <msup>
+                    <mi>J</mi>
+                    <mi>t</mi>
+                  </msup>
+                </mrow>
+                <mo stretchy="false">)</mo>
+              </mrow>
+            </mrow>
+          </mrow>
+        </math>
+      INPUT
+    end
+
+  end
+end

data/lib/latexmath/latexml_requirement.rb

@@ -0,0 +1,84 @@
+require_relative "./requirement"
+require 'open3'
+
+module Latexmath
+  class LatexmlRequirement < Requirement
+    @recommended_version = '0.8.4'
+    @minimal_version = '0.8.0'
+
+    def initialize
+      version_output, = Open3.capture2e("latexml --VERSION")
+      version = version_output&.match(%r{\d+(.\d+)*})
+      puts version_output
+      if version.to_s.empty?
+        @error_message = "LaTeXML is not available. (Or is PATH not setup properly?)"\
+          " You must upgrade/install LaTeXML to a version higher than `#{@recommended_version}`"
+
+      elsif Gem::Version.new(version) < Gem::Version.new(@minimal_version)
+        @error_message = "Minimal supported LaTeXML version is `#{@minimal_version}` "\
+            "Version `#{version}` found; recommended version is `#{@recommended_version}`"
+
+      elsif Gem::Version.new(version) < Gem::Version.new(@recommended_version)
+        version = "unknown" if version.to_s.empty?
+        header_msg = "latexmlmath version `#{version}` below `#{@recommended_version}`!"
+        suggestion = if Gem.win_platform?
+                       "cmd encoding is set to UTF-8 with `chcp 65001`"
+                     else
+                       "terminal encoding is set to UTF-8 with `export LANG=en_US.UTF-8`"
+                     end
+
+        @error_message = "WARNING #{header_msg} Please sure that #{suggestion} command."
+
+        @cmd = 'latexmlmath --strict --preload=amsmath -- -'
+        @cmd2 = 'latexmlmath --strict -- -'
+      else
+        @cmd = 'latexmlmath --strict --preload=amsmath --inputencoding=UTF-8 -- -'
+        @cmd2 = 'latexmlmath --strict --inputencoding=UTF-8 -- -'
+      end
+    rescue
+      @error_message = "LaTeXML is not available. (Or is PATH not setup properly?)"\
+          " You must upgrade/install LaTeXML to a version higher than `#{@recommended_version}`"
+    end
+
+    def satisfied(abort = false)
+      unless @error_message.nil?
+        if abort
+          abort @error_message
+        else
+          warn @error_message
+        end
+      end
+
+      @error_message.nil?
+    end
+
+    def cmd
+      abort @error_message unless @error_message.nil?
+
+      [@cmd, @cmd2]
+    end
+
+    def run(input, command)
+      puts command
+      IO.popen(command, "r+", external_encoding: "UTF-8") do |io|
+        io.write(input)
+        io.close_write
+        io.read
+      end
+    end
+
+    def convert(input)
+      results = nil
+      cmd.each_with_index do |cmd, i|
+        warn "Retrying with #{cmd}" if i > 0
+        results = run(input, cmd)
+        if $CHILD_STATUS.to_i.zero?
+          warn "Success!" if i > 0
+          break
+        end
+      end
+      $CHILD_STATUS.to_i.zero? ? results : nil
+    end
+
+  end
+end

data/lib/latexmath/requirement.rb

@@ -0,0 +1,12 @@
+module Latexmath
+  class Requirement
+    def satisfied
+      raise NotImplementedError("abstract method")
+    end
+
+    def cmd
+      raise NotImplementedError("abstract method")
+    end
+  end
+end
+

data/lib/latexmath/version.rb

@@ -0,0 +1,3 @@
+module Latexmath
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: latexmath
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode2latex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+description: Converts LaTeX math into MathML.
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- latexmath.gemspec
+- lib/latexmath.rb
+- lib/latexmath/equation.rb
+- lib/latexmath/latexml_requirement.rb
+- lib/latexmath/requirement.rb
+- lib/latexmath/version.rb
+homepage: https://github.com/metanorma/latexmath
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/metanorma/latexmath
+  source_code_uri: https://github.com/metanorma/latexmath
+  changelog_uri: https://github.com/metanorma/latexmath/blob/master/CHANGELOG.md.
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Converts LaTeX math into MathML.
+test_files: []