asciimath 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9854257261efca821e14c559add910c54fe4902cac3b5670f9af6c2fde09f168
-  data.tar.gz: a92201a108b0ebafb364e5b619a9edfcdde7c9bbea1facc58d5302d9d4d44c36
+  metadata.gz: d4492ccf2978a02b79bf6d5a70a23871fd33db6893e4a90b1b159db3b4d7b8b3
+  data.tar.gz: 43fbc1d2bba388ca359e0e908e0118b22189479cc05bf4a9882cb6459b4c6488
 SHA512:
-  metadata.gz: d20e388ca4ecdf4823361833276033b7b8c003a3b8324515e0d5c36457c790996f3b344380cee5b7d61f259ccf893eb176bc944481a3f4d254055edf35ef0d4f
-  data.tar.gz: f38c5f8c4fa8af496e6aabdf147afe29b4de39eedab4266ba33392284b4ec6dc588ece0ca3fa6cd9c743174fdd66c10cdf376e8949b2498146046877a10957d7
+  metadata.gz: 60c01de3ce18dd8eec2ff1a1fa559da2e0de840e08b59686ab3d1ff913a02f2656f2d8ceee1106657ae99bf9de2fdb2f80eeef1f71cc604845541d9d503f7bed
+  data.tar.gz: 62e0c29f76f709c53b040260dee1e36dce9af4c8737822297ea9d1908b2c72ade763d236c36266c411ce8f7330fbf397d4f0877ac2d5fc80d9064c40920bcbee

data/.gitignore

@@ -0,0 +1,16 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.iml
+mkmf.log

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache:
+  apt: true
+  directories:
+    - vendor/bundle
+    - $HOME/.cache/pip
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - jruby
+  - truffleruby
+before_install:
+  - type bundle || gem install bundler --version '~> 1.0'
+install:
+  - bundle install --path vendor/bundle --jobs=3 --retry=3

data/CHANGELOG.adoc

@@ -1,5 +1,16 @@
 = Asciimath Changelog
 
+== 2.0.1
+
+Enhancements::
+
+  * Issue #40: add `ker` as standard symbol (@GarkGarcia)
+  * Issue #46: allow customisation of the parsing and rendering symbol tables (@GarkGarcia)
+
+Bug fixes::
+
+  * Issue #48: fix parsing of single column matrices (@ronaldtse)
+
 == 2.0.0
 
 Enhancements::
@@ -72,4 +83,4 @@ Enhancements::
 
 Initial release::
 
-  * An AsciiMath parser and MathML converter written in Ruby
+  * An AsciiMath parser and MathML converter written in Ruby

data/README.adoc

@@ -87,6 +87,45 @@ asciimath latex "an asciimath string"
 
 This command will print out the generated code on stdout.
 
+## Extentions and Customization
+
+The parser can be extended by passing a custum tokenization table:
+
+[source, ruby]
+----
+my_tokens_table = AsciiMath::SymbolTableBuilder.new
+AsciiMath::Parser.add_default_parser_symbols(my_tokens_table)
+my_tokens_table.add('mysymbol', :mysymbol, :symbol)
+
+AsciiMath::parse("a + mysymbol + b", my_tokens_table.build)
+----
+
+Furthermore, the behaviour of the tokenizer be customized by altering the value 
+associated with a token in `AsciiMath::Tokenizer::DEFAULT_PARSE_SYMBOL_TABLE`:
+
+[source, ruby]
+----
+my_tokens_table = AsciiMath::SymbolTableBuilder.new
+AsciiMath::Parser.add_default_parser_symbols(my_tokens_table)
+my_tokens_table.add('alpha', :beta, :symbol)
+
+# Now "alpha + beta" is equivalent to "beta + beta"
+AsciiMath::parse("alpha + beta", my_tokens_table.build)
+----
+
+The same behaviour applies to each individual render (`MathMLBuilder`, 
+`HTMLBuilder` and `LatexBuilder`). By adding entries to a rendere's rendering 
+table (or modifying exisisting entries), users can customize it's output:
+
+[source, ruby]
+----
+my_rendering_table = AsciiMath::SymbolTableBuilder.new
+AsciiMath::MarkupBuilder.add_default_display_symbols(my_rendering_table)
+my_rendering_table.add('alpha', '\u03b2', :identifier)
+
+# Now "alpha + beta" is equivalent to "beta + beta"
+AsciiMath::parse("alpha + beta").to_mathml(my_rendering_table.build)
+----
 
 ## Notes on the HTML Output
 

data/asciimath.gemspec

@@ -3,7 +3,6 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'asciimath/version'
-require 'rake/file_list'
 
 Gem::Specification.new do |spec|
   spec.name          = "asciimath"
@@ -15,8 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = ""
   spec.license       = "MIT"
 
-  spec.files         = Rake::FileList['**/*'].exclude(*File.read('.gitignore').split)
-                                             .exclude('dump_symbol_table.rb')
+  spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

data/dump_symbol_table.rb

@@ -0,0 +1,46 @@
+require_relative 'lib/asciimath'
+
+def escape_adoc(adoc)
+  case adoc
+    when nil
+      ''
+    when '+'
+      adoc
+    else
+      "++#{adoc.gsub('|', '\\|')}++"
+  end
+end
+
+puts "|==="
+puts '|AsciiMath |Symbol |MathML Value |LaTeX Value'
+puts
+
+AsciiMath::Parser::DEFAULT_PARSER_SYMBOL_TABLE.each_pair do |asciimath, value|
+  sym = value[:value]
+  unless sym.is_a?(Symbol)
+    next
+  end
+
+  mathml = AsciiMath::MathMLBuilder::DEFAULT_DISPLAY_SYMBOL_TABLE[sym]
+
+  if mathml
+    val = mathml[:value]
+  else
+    val = "Missing!!!!!"
+  end
+
+  latex = AsciiMath::LatexBuilder::SYMBOLS[sym] || "\\#{sym.to_s}"
+
+  codepoint = ""
+  if val.is_a?(String)
+    codepoint = val.codepoints.map do |cp|
+      cpstr = sprintf('U+%04X', cp)
+      "https://codepoints.net/#{cpstr}[#{cpstr}]"
+    end.join(' ')
+  end
+
+  puts "|#{escape_adoc(asciimath)} |:#{sym.to_s} |#{escape_adoc(val.to_s)} (#{codepoint}) |#{escape_adoc(latex)}"
+end
+
+puts "|==="
+puts

data/lib/asciimath/latex.rb

@@ -2,8 +2,11 @@ require_relative 'ast'
 
 module AsciiMath
   class LatexBuilder
-    def initialize
+    attr_reader :symbol_table
+
+    def initialize(symbol_table = nil)
       @latex = ''
+      @symbol_table = symbol_table.nil? ? DEFAULT_DISPLAY_SYMBOL_TABLE : symbol_table
     end
 
     def to_s
@@ -14,12 +17,8 @@ module AsciiMath
       append(expression)
       self
     end
-
-    private
-
-    SPECIAL_CHARACTERS = [?&, ?%, ?$, ?#, ?_, ?{, ?}, ?~, ?^, ?[, ?]].map(&:ord)
-
-    SYMBOLS = {
+    
+    DEFAULT_DISPLAY_SYMBOL_TABLE = {
       :plus => ?+,
       :minus => ?-,
       :ast => ?*,
@@ -97,7 +96,11 @@ module AsciiMath
       :bold_sans_serif => "\\mathsf",
       :sans_serif_italic => "\\mathsf",
       :sans_serif_bold_italic => "\\mathsf",
-    }
+    }.freeze
+
+    private
+
+    SPECIAL_CHARACTERS = [?&, ?%, ?$, ?#, ?_, ?{, ?}, ?~, ?^, ?[, ?]].map(&:ord)
 
     COLOURS = {
       [0xFF, 0xFF, 0xFF] => "white",
@@ -138,7 +141,7 @@ module AsciiMath
           end
 
         when AsciiMath::AST::Symbol
-          @latex << symbol(expression.value)
+          @latex << resolve_symbol(expression.value)
 
         when AsciiMath::AST::Identifier
           append_escaped(expression.value)
@@ -229,7 +232,7 @@ module AsciiMath
             end
 
           else
-            @latex << symbol(op)
+            @latex << resolve_symbol(op)
 
             curly do
               append(expression.operand1)
@@ -259,7 +262,7 @@ module AsciiMath
     end
 
     def macro(macro, *args)
-      @latex << symbol(macro)
+      @latex << resolve_symbol(macro)
 
       if args.length != 0
         @latex << "["
@@ -284,9 +287,9 @@ module AsciiMath
 
       if block_given?
         if l || r
-          @latex << "\\left " << symbol(l) << " "
+          @latex << "\\left " << resolve_symbol(l) << " "
           yield self
-          @latex << " \\right " << symbol(r)
+          @latex << " \\right " << resolve_symbol(r)
         else
           yield self
         end
@@ -294,12 +297,12 @@ module AsciiMath
         needs_left_right = !is_small(content)
 
         @latex << "\\left " if needs_left_right
-        @latex << symbol(l) << " " if l or needs_left_right
+        @latex << resolve_symbol(l) << " " if l or needs_left_right
 
         append(content)
 
         @latex << " \\right" if needs_left_right
-        @latex << " " << symbol(r) if r or needs_left_right
+        @latex << " " << resolve_symbol(r) if r or needs_left_right
       end
     end
 
@@ -333,8 +336,19 @@ module AsciiMath
       end
     end
 
-    def symbol(s)
-      SYMBOLS[s] || "\\#{s.to_s}"
+    def resolve_symbol(s)
+      symbol = @symbol_table[s]
+
+      case symbol
+      when String
+        return symbol
+      when Hash
+        return symbol[:value]
+      when nil
+        return "\\#{s.to_s}"
+      else
+        raise "Invalid entry in symbol table"
+      end
     end
 
     def is_small(e)
@@ -379,8 +393,8 @@ module AsciiMath
   end
 
   class Expression
-    def to_latex
-      LatexBuilder.new().append_expression(ast).to_s
+    def to_latex(symbol_table = nil)
+      LatexBuilder.new(symbol_table).append_expression(ast).to_s
     end
   end
 end

data/lib/asciimath/markup.rb

@@ -163,6 +163,7 @@ module AsciiMath
       b.add(:Ln, 'Ln', :identifier)
       b.add(:det, 'det', :identifier)
       b.add(:dim, 'dim', :identifier)
+      b.add(:ker, 'ker', :identifier)
       b.add(:mod, 'mod', :identifier)
       b.add(:gcd, 'gcd', :identifier)
       b.add(:lcm, 'lcm', :identifier)
@@ -475,4 +476,4 @@ module AsciiMath
       end
     end
   end
-end
+end

data/lib/asciimath/parser.rb

@@ -385,6 +385,7 @@ module AsciiMath
       b.add('Ln', :Ln, :symbol)
       b.add('det', :det, :symbol)
       b.add('dim', :dim, :symbol)
+      b.add('ker', :ker, :symbol)
       b.add('mod', :mod, :symbol)
       b.add('gcd', :gcd, :symbol)
       b.add('lcm', :lcm, :symbol)
@@ -663,21 +664,21 @@ module AsciiMath
 
         row_content = row.expression
         unless row_content.is_a?(::AsciiMath::AST::Sequence)
-          row_content = expression(row_content)
-        end
-
-        row_content.each do |item|
-          if is_matrix_separator(item)
-            chunks << current_chunk
-            current_chunk = []
-          else
-            current_chunk << item
+          [expression(row_content)]
+        else
+          row_content.each do |item|
+            if is_matrix_separator(item)
+              chunks << current_chunk
+              current_chunk = []
+            else
+              current_chunk << item
+            end
           end
-        end
 
-        chunks << current_chunk
+          chunks << current_chunk
 
-        chunks.map { |c| c.length == 1 ? c[0] : expression(*c) }.to_a
+          chunks.map { |c| c.length == 1 ? c[0] : expression(*c) }.to_a
+        end
       end
 
       return node unless rows.all? { |row| row.length == rows[0].length }

data/lib/asciimath/version.rb

@@ -1,3 +1,3 @@
 module AsciiMath
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/ast.rb

@@ -141,4 +141,4 @@ module AsciiMath
       end
     end
   end
-end
+end

data/spec/customisation_spec.rb

@@ -0,0 +1,28 @@
+#encoding: utf-8
+require 'rspec'
+require 'asciimath'
+require_relative 'ast'
+
+RSpec.configure do |c|
+  c.include ::AsciiMath::ASTHelper
+end
+
+describe 'AsciiMath::Parser', :variant => :ast do
+  it "should support custom symbols" do
+    my_tokens_table = AsciiMath::SymbolTableBuilder.new
+    AsciiMath::Parser.add_default_parser_symbols(my_tokens_table)
+    my_tokens_table.add('mysymbol', :mysymbol, :symbol)
+
+    parsed = AsciiMath::parse("a + mysymbol + b", my_tokens_table.build)
+    expect(parsed.ast).to eq(seq(identifier('a'), symbol('+'), ::AsciiMath::AST::Symbol.new(:mysymbol, 'mysymbol'), symbol('+'), identifier('b')))
+  end
+
+  it "should support replacing standard symbols" do
+    my_tokens_table = AsciiMath::SymbolTableBuilder.new
+    AsciiMath::Parser.add_default_parser_symbols(my_tokens_table)
+    my_tokens_table.add('+', :foo, :symbol)
+
+    parsed = AsciiMath::parse("a + b", my_tokens_table.build)
+    expect(parsed.ast).to eq(seq(identifier('a'), ::AsciiMath::AST::Symbol.new(:foo, '+'), identifier('b')))
+  end
+end

data/spec/parser_spec.rb

@@ -1,7 +1,7 @@
 #encoding: utf-8
 require 'rspec'
 require 'asciimath'
-require 'ast'
+require_relative 'ast'
 require 'nokogiri'
 
 
@@ -319,6 +319,13 @@ RSpec.shared_examples 'AsciiMath Examples' do
       :latex => '\\sum_{n = 0}^\\infty a_n',
   ))
 
+  example('((1),(42))', &should_generate(
+      :ast => matrix([%w[1], %w[42]]),
+      :mathml => '<math><mrow><mo>(</mo><mtable><mtr><mtd><mn>1</mn></mtd></mtr><mtr><mtd><mn>42</mn></mtd></mtr></mtable><mo>)</mo></mrow></math>',
+      :html => '<span class="math-inline"><span class="math-row"><span class="math-brace" style="font-size: 200%;">(</span><span class="math-matrix" style="grid-template-columns:repeat(1,1fr);grid-template-rows:repeat(2,1fr);"><span class="math-row"><span class="math-number">1</span></span><span class="math-row"><span class="math-number">42</span></span></span><span class="math-brace" style="font-size: 200%;">)</span></span></span>',
+      :latex => '\\left ( \\begin{matrix} 1 \\\\ 42 \\end{matrix} \\right )',
+  ))
+
   example('((1,2,3),(4,5,6),(7,8,9))', &should_generate(
       :ast => matrix([%w[1 2 3], %w[4 5 6], %w[7 8 9]]),
       :mathml => '<math><mrow><mo>(</mo><mtable><mtr><mtd><mn>1</mn></mtd><mtd><mn>2</mn></mtd><mtd><mn>3</mn></mtd></mtr><mtr><mtd><mn>4</mn></mtd><mtd><mn>5</mn></mtd><mtd><mn>6</mn></mtd></mtr><mtr><mtd><mn>7</mn></mtd><mtd><mn>8</mn></mtd><mtd><mn>9</mn></mtd></mtr></mtable><mo>)</mo></mrow></math>',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciimath
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Pepijn Van Eeckhoudt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
+date: 2020-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,15 +76,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
 - AST.adoc
 - CHANGELOG.adoc
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.adoc
 - Rakefile
 - asciimath.gemspec
 - bin/asciimath
+- dump_symbol_table.rb
 - lib/asciimath.rb
 - lib/asciimath/ast.rb
 - lib/asciimath/cli.rb
@@ -97,6 +99,7 @@ files:
 - lib/asciimath/symbol_table.rb
 - lib/asciimath/version.rb
 - spec/ast.rb
+- spec/customisation_spec.rb
 - spec/parser_spec.rb
 - spec/schema/mathml2/common/common-attribs.xsd
 - spec/schema/mathml2/common/math.xsd
@@ -153,12 +156,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: AsciiMath parser and converter
 test_files:
 - spec/ast.rb
+- spec/customisation_spec.rb
 - spec/parser_spec.rb
 - spec/schema/mathml2/common/common-attribs.xsd
 - spec/schema/mathml2/common/math.xsd

data/Gemfile.lock

@@ -1,39 +0,0 @@
-PATH
-  remote: .
-  specs:
-    asciimath (2.0.0.next1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    mini_portile2 (2.4.0)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    rake (13.0.1)
-    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.1)
-      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)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  asciimath!
-  bundler (> 0)
-  nokogiri (~> 1.10.9)
-  rake (~> 13.0.0)
-  rspec (~> 3.9.0)
-
-BUNDLED WITH
-   1.17.2