latexmath 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e3ecc01756ec040a67e70289d15cf757b15c1b4b6f656a887ef991c15ae3852
-  data.tar.gz: 46341cdd12a8b4e84bbe14b69c1eae6b66eaa5e136c07bd55fae628fbcf028ac
+  metadata.gz: 3dd210bb97aa808bf1bee45d595148730fd1e324917a7fe402c05dcda243357e
+  data.tar.gz: 2bf325bde0a31dee92da668bd985d11cbc43424aeb1a3e94397ffbe7b6803a95
 SHA512:
-  metadata.gz: 2f67278c0fe3acbacd04e3ba8449fbcb77f75d46f36d5268db8dd42e971fadbf47dabeb4fe1197d0e2b50517e55b0c6db4d37916bdf6267e76bb7fa100dcd535
-  data.tar.gz: 845366028db2233749cc57f5a18fb5b842953c4426b12e80b416bc0701ec70e3127b030b27de7491f80ff2c9ad233af4407de208a4e92df69e7e2accf3e1e8e4
+  metadata.gz: d0ee9acb802192c32b47f22a8563964efd6640d8d606cd622e9f152dd46fd4f1fbe7d2c017aa8f1cc0e769e3b69d20b3e111946be67faed4420f45a519078053
+  data.tar.gz: e3cf465915d734f68290aecb7d9b1c9747b9b8202b5c673536899f97356e0fef341428950c31782b228209e4ea4eeb06cb5e87a2b925478a3e05fbee4261f6b9

data/.editorconfig

@@ -0,0 +1,14 @@
+# editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.github/workflows/test.yml

@@ -0,0 +1,80 @@
+name: test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  build:
+    name: Run specs on ${{ matrix.os }} ruby ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        ruby: ['2.6', '2.5', '2.4']
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            os: ubuntu-latest
+            experimental: true
+          - ruby: '2.7'
+            os: macos-latest
+            experimental: true
+          - ruby: '2.7'
+            os: windows-latest
+            experimental: true
+
+    steps:
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/checkout@master
+
+      - name: Install gems
+        run: |
+          gem install bundler -v "~> 2"
+          bundle install --jobs 4 --retry 5
+
+      - name: Install LaTeXML on Ubuntu
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          sudo snap install latexml --edge
+          echo "::add-path::/snap/bin"
+
+      - name: Install LaTeXML on macOS
+        if: matrix.os == 'macos-latest'
+        run: |
+          brew install libxml2 cpanminus
+          env PATH=$(brew --prefix libxml2)/bin:$PATH \
+            cpanm --notest XML::LibXSLT@1.96 git://github.com/brucemiller/LaTeXML.git@9a0e7dc5
+
+      - name: Install LaTeXML on Windows
+        if: matrix.os == 'windows-latest'
+        shell: cmd
+        run: |
+          cinst -y latexml
+          refreshenv
+          set PATH=C:\Strawberry\c\bin;C:\Strawberry\perl\site\bin;C:\Strawberry\perl\bin;%PATH%
+          where latexmlmath
+
+      - name: Run RSpecs
+        if: matrix.os == 'ubuntu-latest'
+        run: |
+          bundle exec rake
+
+      - name: Run RSpecs
+        if: matrix.os == 'macos-latest'
+        run: |
+          env PATH=$(brew --prefix perl)/bin:$PATH bundle exec rake
+
+      - name: Run specs
+        if: matrix.os == 'windows-latest'
+        shell: pwsh
+        run: |
+          $env:Path = "C:\Strawberry\c\bin;C:\Strawberry\perl\site\bin;C:\Strawberry\perl\bin;$env:Path"
+          bundle exec rake

data/.gitignore

@@ -7,5 +7,16 @@
 /spec/reports/
 /tmp/
 
+# ignore generated file via Rakefile
+#/lib/latexmath/constants/symbols.rb
+
 # rspec failure tracking
 .rspec_status
+
+# ignore byebug history
+.byebug_history
+
+# ignore MacOS system file
+.DS_Store
+
+/dist/

data/.rubocop.yml

@@ -0,0 +1,129 @@
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/latexmath/converter.rb'
+    - 'lib/latexmath/tokenizer.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowSafeAssignment.
+Lint/AssignmentInCondition:
+  Exclude:
+    - 'lib/latexmath/tokenizer.rb'
+
+# Offense count: 2
+Lint/ImplicitStringConcatenation:
+  Exclude:
+    - 'spec/tokenizer_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowKeywordBlockArguments.
+Lint/UnderscorePrefixedVariableName:
+  Exclude:
+    - 'lib/latexmath/converter.rb'
+
+# Offense count: 2
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/latexmath/converter.rb'
+
+# Offense count: 7
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 32
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 35
+
+# Offense count: 1
+# Configuration parameters: CountBlocks.
+Metrics/BlockNesting:
+  Max: 4
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 157
+
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 13
+
+# Offense count: 9
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 39
+
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 14
+
+# Offense count: 1
+Naming/ConstantName:
+  Exclude:
+    - 'lib/latexmath.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/latexmath/xml/builder.rb'
+    - 'lib/latexmath/xml/element.rb'
+
+# Offense count: 7
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/latexmath.rb'
+    - 'lib/latexmath/aggregator.rb'
+    - 'lib/latexmath/converter.rb'
+    - 'lib/latexmath/equation.rb'
+    - 'lib/latexmath/tokenizer.rb'
+
+# Offense count: 18
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/latexmath/aggregator.rb'
+
+# Offense count: 5
+Style/IdenticalConditionalBranches:
+  Exclude:
+    - 'lib/latexmath/converter.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/LineEndConcatenation:
+  Exclude:
+    - 'spec/tokenizer_spec.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/latexmath/aggregator.rb'
+    - 'lib/latexmath/converter.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ZeroLengthPredicate:
+  Exclude:
+    - 'lib/latexmath/converter.rb'
+
+

data/Gemfile

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

data/Gemfile.lock

@@ -1,16 +1,39 @@
 PATH
   remote: .
   specs:
-    latexmath (0.1.0)
+    latexmath (0.1.5)
       htmlentities (~> 4.3)
-      unicode2latex (~> 0.0.1)
+      ox (~> 2.13)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
     diff-lcs (1.4.4)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    execjs (2.7.0)
     htmlentities (4.3.4)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    opal (1.0.3)
+      ast (>= 2.3.0)
+      parser (~> 2.6)
+    ox (2.13.3)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -24,15 +47,33 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    unicode2latex (0.0.4)
+    rubocop (0.90.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.3.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  byebug
+  equivalent-xml
+  execjs
   latexmath!
+  opal
+  pry
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
 
 BUNDLED WITH
    2.1.4

data/README.adoc

@@ -0,0 +1,28 @@
+= latexmath
+
+image:https://img.shields.io/gem/v/latexmath.svg["Gem Version", link="https://rubygems.org/gems/latexmath"]
+image:https://github.com/metanorma/latexmath/workflows/test/badge.svg["Build Status", link="https://github.com/metanorma/latexmath/actions?workflow=test"]
+image:https://codeclimate.com/github/metanorma/latexmath/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/latexmath"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/latexmath.svg["Pull Requests", link="https://github.com/metanorma/latexmath/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/latexmath/latest.svg["Commits since latest",link="https://github.com/metanorma/latexmath/releases"]
+
+== Purpose
+
+Ruby gem to translate LaTeX math into MathML.
+The MathML is supposed to be compliant with output of LaTeXML.
+
+It also works in reverse by translating MathML into LaTeX code.
+
+The LaTeX math syntax supports `amsmath`, `array`, `split` and `pmatrix` packages.
+
+NOTE: Bolding, symbols like `\backepsilon`, equation alignment, are all supported.
+
+== Usage
+
+[source,ruby]
+-------------
+require "latexmath"
+
+latex = "$$f_i =  \sum_{j=1}^2 s_{ij} n_j \quad {\rm for} \quad i = 1,2$$"
+mathml = Latexmath.parse(latex).to_mathml
+-------------

data/Rakefile

@@ -1,6 +1,95 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task 'build-opal' do
+  require 'opal'
+  require 'erb'
+  require 'json'
+
+  b = Opal::Builder.new
+
+  b.append_paths __dir__ + '/lib'
+  b.append_paths __dir__ + '/opal'
+  b.use_gem 'htmlentities'
+
+  build = b.build('latexmath-opal').to_s
+  # This is a hack intended for ExecJS to work properly.
+  build = build.gsub('Object freezing is not supported by Opal', '')
+
+  FileUtils.mkdir_p 'dist'
+  File.write('dist/latexmath.js', build)
+end
+
+task 'spec-opal' => 'build-opal' do
+  ENV['TEST_OPAL'] = '1'
+  Rake::Task['spec'].execute
+  ENV.delete 'TEST_OPAL'
+end
+
+def read_symbols(input)
+  @symbols = {}
+  File.readlines(input).each do |line|
+    next if line.start_with?('#')
+
+    columns = line.chop.split('^')
+    _unicode = columns[0]
+    latex = columns[2]
+    unicode_math = columns[3]
+
+    @symbols[latex] = _unicode if latex && !@symbols.include?(latex)
+    @symbols[unicode_math] = _unicode if unicode_math && !@symbols.include?(unicode_math)
+
+    matches = columns[-1].match(/=\s+(\\[^,^ ]+),?/)
+    if matches
+      @symbols[matches[1]] = _unicode unless @symbols[matches[1]]
+    end
+  end
+  @symbols
+end
+
+directory 'lib/latexmath/constants'
+file 'lib/latexmath/constants/symbols.rb' => [
+  'lib/latexmath/constants',
+  'lib/unimathsymbols.txt'
+  ] do |file|
+  symbols = read_symbols(file.prerequisites.last)
+
+  File.open(file.name, "w+") do |f|
+    f.puts <<~HERE
+    module Latexmath
+      module Constants
+        SYMBOLS = {
+    HERE
+
+    @symbols.each_pair do |k,v|
+      f.puts("     '#{k.to_s}' => '#{v}',")
+    end
+
+    f.puts <<~HERE
+        }.freeze
+      end
+    end
+    HERE
+  end
+end
+
+Rake::Task['build'].enhance ['lib/latexmath/constants/symbols.rb']
+Rake::Task[:spec].enhance ['lib/latexmath/constants/symbols.rb']
+
+desc 'Generate and write MathML fixtures'
+task 'create-mathml-fixtures' do
+  require_relative 'lib/latexmath'
+  records = Dir.glob('spec/fixtures/*/*.tex')
+
+  records.each do |file|
+    tex = File.read("./#{file}")
+    tokens = Latexmath::Tokenizer.new(tex).tokenize
+    aggr = Latexmath::Aggregator.new(tokens).aggregate
+
+    File.write("./#{file.chomp('.tex')}.html", Latexmath::Converter.new(aggr).convert)
+  end
+end
+
+task default: [:spec, 'spec-opal']