mathematical 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 020b6daf960edb5a9e5436aef6fa8c406188896c
-  data.tar.gz: ac15939f237b1086ed76ab8cd36fd55b7cb261e5
+  metadata.gz: f7920616d037c8cdab3ade36bceda055362a6de9
+  data.tar.gz: a6d2688b1275203704cf01146a952ee7391c4d76
 SHA512:
-  metadata.gz: 9f73b02d173514430ff94664fa28e2b2d7cdfd863556796b399c3ee590a97a1904ab9f119b13ea617a677a47bde1351d7c5a4bbcd069d8732ffa097b46a418f9
-  data.tar.gz: 773a25ece459f013a69554c33018f2be6530ffc0e31d6b821a89690d5a652d84286e51697037b69887c09a682c50669927ff0ee4252cbf29fda3dad301a939df
+  metadata.gz: 54a36429dd2a1bd98712ee5a194ef07396a8b76404894d9d3260ca0597b46896a86c97ab6f6664887c15c101dac1c49417880745c55c97ded3672e61390dbb2c
+  data.tar.gz: 51fdd320022dd0555be2a3141b7a2de65d5c7c076bd441565da36a61e3ba2a77f172e479e104367b268c3983cd362e170f7dda48a1624971d95bc0ff30b94890

data/README.md

@@ -2,7 +2,7 @@
 
 Quickly convert math equations into beautiful SVGs (or PNGs/MathML).
 
-[![Build Status](https://travis-ci.org/gjtorikian/mathematical.svg?branch=master)](https://travis-ci.org/gjtorikian/mathematical)
+[![Build Status](https://travis-ci.org/gjtorikian/mathematical.svg?branch=master)](https://travis-ci.org/gjtorikian/mathematical) [![Gem Version](https://badge.fury.io/rb/mathematical.svg)](http://badge.fury.io/rb/mathematical)
 
 ![Mathematical](https://i.imgur.com/JC7HT32.gif)
 
@@ -35,15 +35,18 @@ Mathematical.new.render(string_with_math)
 The output will be a hash, with keys that depend on the format you want:
 
 * If you asked for an SVG, you'll get:
-  * `width`: the width of the resulting image
-  * `height`: the height of the resulting image
-  * `svg`: the actual string of SVG
+  * `:width`: the width of the resulting image
+  * `:height`: the height of the resulting image
+  * `:data`: the actual string of SVG
 * If you asked for a PNG, you'll get:
-  * `width`: the width of the resulting image
-  * `height`: the height of the resulting image
-  * `png`: the PNG data
+  * `:width`: the width of the resulting image
+  * `:height`: the height of the resulting image
+  * `:data`: the PNG data
 * If you asked for MathML, you'll get:
-  * `mathml`: the MathML data
+  * `:data`: the MathML data
+* If you pass in invalid LaTeX, you'll get:
+  * `:data`: the original invalid LaTeX
+  * `:error`: the error class (with message)
 
 **Note**: If you pass in invalid LaTeX, an error is not raised, but a message *is* printed to STDERR, and the original string is returned (not a hash).
 
@@ -60,10 +63,7 @@ inputs << '$c$'
 Mathematical.new.render(inputs)
 ```
 
-This returns an array of hashes, possessing the same keys as above.
-
-**Note**: With an array, it is possible to receive elements that are not hashes. For example, given the following input:
-
+This returns an array of hashes, possessing the same keys as above. For example:
 ```
 array = ['$foof$', '$not__thisisnotreal$', '$poof$']
 ```
@@ -72,10 +72,10 @@ You will receive the following output:
 
 ```
 Mathematical.new.render(array)
-[ {:svg => "...", :width => ... }, '$not__thisisnotreal$', {:svg => "...", :width => ... }]
+[ {:data => "...", :width => ... }, { :data => '$not__thisisnotreal$', :error => "...", {:data => "...", :width => ... }]
 ```
 
-That is, while the first and last elements are valid LaTeX math, the middle one is not, so the same string is returned. As with a single string, a message is also printed to STDERR.
+That is, while the first and last elements are valid LaTeX math, the middle one is not, so the same string is returned. As with single strings, a message is also printed to STDERR.
 
 ### Options
 

data/ext/mathematical/mathematical.c

@@ -76,10 +76,20 @@ void print_and_raise(VALUE error_type, const char* format, ...)
   va_end(args);
 }
 
+static VALUE process_rescue(VALUE args, VALUE exception_object)
+{
+  VALUE rescue_hash = rb_hash_new();
+
+  rb_hash_aset (rescue_hash, CSTR2SYM ("data"), args);
+  rb_hash_aset (rescue_hash, CSTR2SYM ("exception"), exception_object);
+
+  return rescue_hash;
+}
+
 VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigned long latex_size)
 {
   if (latex_size > maxsize) {
-    print_and_raise(rb_eMaxsizeError, "Size of latex string (%lu) is greater than the maxsize (%lu)!", latex_size, maxsize);
+    print_and_raise(rb_eMaxsizeError, "Size of latex string is greater than the maxsize");
   }
 
   VALUE result_hash = rb_hash_new();
@@ -87,7 +97,7 @@ VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigne
 
   // convert the LaTeX math to MathML
   char * mathml = lsm_mtex_to_mathml(latex_code, latex_size, global_start);
-  if (mathml == NULL) { print_and_raise(rb_eParseError, "Failed to parse mtex: %s", latex_code); }
+  if (mathml == NULL) { print_and_raise(rb_eParseError, "Failed to parse mtex"); }
 
   // basically, only update the next equation counter if the last math had a numbered equation
   if (strstr(mathml, "<mlabeledtr>") != NULL) {
@@ -95,7 +105,7 @@ VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigne
   }
 
   if (format == FORMAT_MATHML) {
-    rb_hash_aset (result_hash, rb_tainted_str_new2 ("mathml"), rb_str_new2(mathml));
+    rb_hash_aset (result_hash, CSTR2SYM ("data"), rb_str_new2(mathml));
     mtex2MML_free_string(mathml);
     return result_hash;
   }
@@ -157,12 +167,12 @@ VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigne
   switch (format) {
   case FORMAT_SVG: {
     if (rb_iv_get(self, "@svg") == Qnil) { print_and_raise(rb_eDocumentReadError, "Failed to read SVG contents"); }
-    rb_hash_aset (result_hash, rb_tainted_str_new2 ("svg"),    rb_iv_get(self, "@svg"));
+    rb_hash_aset (result_hash, CSTR2SYM ("data"), rb_iv_get(self, "@svg"));
     break;
   }
   case FORMAT_PNG: {
     if (rb_iv_get(self, "@png") == Qnil) { print_and_raise(rb_eDocumentReadError, "Failed to read PNG contents"); }
-    rb_hash_aset (result_hash, rb_tainted_str_new2 ("png"),    rb_iv_get(self, "@png"));
+    rb_hash_aset (result_hash, CSTR2SYM ("data"), rb_iv_get(self, "@png"));
     break;
   }
   default: {
@@ -172,8 +182,8 @@ VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigne
   }
   }
 
-  rb_hash_aset (result_hash, rb_tainted_str_new2 ("width"),  INT2FIX(width_pt));
-  rb_hash_aset (result_hash, rb_tainted_str_new2 ("height"), INT2FIX(height_pt));
+  rb_hash_aset (result_hash, CSTR2SYM ("width"),  INT2FIX(width_pt));
+  rb_hash_aset (result_hash, CSTR2SYM ("height"), INT2FIX(height_pt));
 
   // we need to clear out this key when attempting multiple calls. See http://git.io/i1hblQ
   rb_iv_set(self, "@svg", Qnil);
@@ -189,11 +199,6 @@ static VALUE process_helper(VALUE data)
   return process(args[0], NUM2ULONG(args[1]), StringValueCStr(args[2]), NUM2ULONG(args[3]));
 }
 
-static VALUE process_failed(void)
-{
-  return Qnil;
-}
-
 static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input)
 {
   unsigned long maxsize = (unsigned long) FIX2INT(rb_iv_get(self, "@maxsize"));
@@ -241,14 +246,9 @@ static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input)
       args[1] = ULONG2NUM(maxsize);
       args[2] = math;
       args[3] = ULONG2NUM(latex_size);
-      hash = rb_rescue(process_helper, args, process_failed, 0);
-
-      // the call errored; just store the same string
-      if (hash == Qnil) {
-        rb_ary_store(output, i, math);
-      } else {
-        rb_ary_store(output, i, hash);
-      }
+      hash = rb_rescue(process_helper, args, process_rescue, math);
+
+      rb_ary_store(output, i, hash);
     }
     break;
   }

data/lib/mathematical.rb

@@ -34,13 +34,13 @@ class Mathematical
     maths = validate_content(maths)
 
     begin
-      data = @processer.process(maths)
-      fail RuntimeError if data.nil? || (!data.is_a?(Hash) && !data.is_a?(Array))
+      result_data = @processer.process(maths)
+      fail RuntimeError if result_data.nil? || (!result_data.is_a?(Hash) && !result_data.is_a?(Array))
 
-      if data.is_a? Array
-        data.map { |d| format_data(d) }
+      if result_data.is_a? Array
+        result_data.map { |d| format_data(d) }
       else
-        format_data(data)
+        format_data(result_data)
       end
     rescue ParseError, DocumentCreationError, DocumentReadError => e
       # an error in the C code, probably a bad TeX parse
@@ -96,19 +96,19 @@ class Mathematical
     maths =~ /\A\${1,2}/
   end
 
-  def format_data(data)
+  def format_data(result_hash)
     # we passed in an array of math, and found an unprocessable element
-    return data unless data.is_a? Hash
+    return result_hash if result_hash[:exception]
 
     case @config[:format]
     when :svg
       # remove starting <?xml...> tag
-      data['svg'] = data['svg'][XML_HEADER.length..-1]
-      data['svg'] = svg_to_base64(data['svg']) if @config[:base64]
+      result_hash[:data] = result_hash[:data][XML_HEADER.length..-1]
+      result_hash[:data] = svg_to_base64(result_hash[:data]) if @config[:base64]
 
-      data
+      result_hash
     when :png, :mathml # do nothing with these...for now?
-      data
+      result_hash
     end
   end
 

data/lib/mathematical/version.rb

@@ -1,3 +1,3 @@
 class Mathematical
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/test/mathematical/basic_test.rb

@@ -9,7 +9,7 @@ class Mathematical::BasicTest < Test::Unit::TestCase
   def test_multiple_calls
     render = Mathematical.new
     render.render('$\pi$')
-    output = render.render('$\pi$')['svg']
+    output = render.render('$\pi$')[:data]
     assert_equal 1, output.scan(/<svg/).size, 'should only contain one svg'
   end
 

data/test/mathematical/fixtures_test.rb

@@ -18,14 +18,14 @@ class Mathematical::FixturesTest < Test::Unit::TestCase
           svg_content = Mathematical.new(:base64 => false).render(eq)
           # remove \ and $, remove whitespace, keep alphanums, remove extraneous - and trailing -
           filename = eq.gsub(/[\$\\]*/, '').gsub(/\s+/, '-').gsub(/[^a-zA-Z\d]/, '-').gsub(/-{2,}/, '-').gsub(/-$/, '')
-          File.open("samples/fixtures/#{filename}.svg", 'w') { |file| file.write svg_content['svg'] }
+          File.open("samples/fixtures/#{filename}.svg", 'w') { |file| file.write svg_content[:data] }
         end
       end
 
       actual = MathToItex(source).convert do |eq, type|
         svg_content = Mathematical.new(:base64 => true).render(eq)
 
-        %|<img class="#{type.to_s}-math" data-math-type="#{type.to_s}-math" src="#{svg_content['svg']}"/>|
+        %(<img class="#{type}-math" data-math-type="#{type}-math" src="#{svg_content[:data]}"/>)
       end.rstrip
 
       expected_file = before.sub(/before/, 'after').sub(/text/, 'html')
@@ -34,7 +34,7 @@ class Mathematical::FixturesTest < Test::Unit::TestCase
 
       expected = File.read(expected_file)
 
-      expected = (MathToItex(expected).convert {|string| Mathematical.new.render(string)}).rstrip
+      expected = (MathToItex(expected).convert { |string| Mathematical.new.render(string) }).rstrip
 
       # Travis and OS X each render SVGs differently. For now, let's just be happy
       # that something renders at all.

data/test/mathematical/maliciousness_test.rb

@@ -109,8 +109,30 @@ class Mathematical::MaliciousnessTest < Test::Unit::TestCase
     assert_equal 3, output.length
     assert_equal Hash, output.first.class
     assert_equal Hash, output.last.class
-    assert_equal '$/this___istotallyfake$', output[1]
-    # array errors output to STDERR
-    assert_match /Failed to parse mtex: \$\/this___istotallyfake\$/, err
+
+    assert_equal '$/this___istotallyfake$', output[1][:data]
+    assert_equal Mathematical::ParseError, output[1][:exception].class
+    assert_match 'Failed to parse mtex', output[1][:exception].message
+
+    # array errors also output to STDERR
+    assert_match /Failed to parse mtex/, err
+  end
+
+  def test_it_passes_a_legible_error_for_maxsize
+    output = nil
+    render = Mathematical.new({:maxsize => 2})
+
+    _, err = capture_subprocess_io do
+      output = render.render(['$a \ne b$'])
+    end
+
+    assert_equal 1, output.length
+
+    assert_equal '$a \ne b$', output[0][:data]
+    assert_equal Mathematical::MaxsizeError, output[0][:exception].class
+    assert_match 'Size of latex string is greater than the maxsize', output[0][:exception].message
+
+    # array errors also output to STDERR
+    assert_match /Size of latex string is greater than the maxsize/, err
   end
 end

data/test/mathematical/mathjax_test.rb

@@ -16,7 +16,7 @@ class Mathematical::MathJaxTest < Test::Unit::TestCase
       assert_nothing_raised { data = render_svg.render(tex_contents) }
 
       # assert the SVG actually rendered
-      doc = Nokogiri::HTML(data['svg'])
+      doc = Nokogiri::HTML(data[:data])
       assert_empty doc.search(%(//svg[@width='0pt']))
       assert_empty doc.search(%(//svg[@height='0pt']))
     end

data/test/mathematical/mathml_test.rb

@@ -14,7 +14,7 @@ class Mathematical::MathMLTest < Test::Unit::TestCase
 $$
 '''
     render = Mathematical.new({:format => :mathml})
-    mathml = render.render(string)['mathml']
+    mathml = render.render(string)[:data]
 
     assert_match %r{<math xmlns='http://www.w3.org/1998/Math/MathML' display='block'><semantics><mrow><mrow><mo>\(}, mathml
   end

data/test/mathematical/multiples_test.rb

@@ -16,7 +16,7 @@ $$
 '''
 
     output = @render.render([string])
-    svg = output.first['svg']
+    svg = output.first[:data]
 
     assert_equal 1, svg.scan(/svg\+xml;/).size, 'should only contain one svg'
     assert_match 'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My', svg
@@ -38,13 +38,13 @@ $$
     output = @render.render(inputs)
     assert_equal 1000, output.length
     output.each do |data|
-      assert_match 'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My', data['svg']
+      assert_match 'PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My', data[:data]
     end
   end
 
   def test_it_properly_accounts_for_equations
     inputs = []
-    [1, 2].each do |i|
+    (1..2).each do |i|
       string = """
   $$
   \\begin{equation}
@@ -60,8 +60,8 @@ $$
     output = render.render(inputs)
     assert_equal 3, output.length
     output.each_with_index do |data_hash, i|
-      header = data_hash['png'].unpack('H*').first.slice(0, 18)
-      File.open("#{fixtures_dir}/png/numeric_test_#{i + 1}.png", 'w') { |f| f.write(data_hash['png'])}
+      header = data_hash[:data].unpack('H*').first.slice(0, 18)
+      File.open("#{fixtures_dir}/png/numeric_test_#{i + 1}.png", 'w') { |f| f.write(data_hash[:data])}
       assert_equal header, '89504e470d0a1a0a00'
     end
   end

data/test/mathematical/png_test.rb

@@ -18,8 +18,8 @@ $$
 '''
     render = Mathematical.new({:format => :png})
     data_hash = render.render(string)
-    header = data_hash['png'].unpack('H*').first.slice(0, 18)
-    File.open("#{fixtures_dir}/png/pmatrix.png", 'w') { |f| f.write(data_hash['png'])}
+    header = data_hash[:data].unpack('H*').first.slice(0, 18)
+    File.open("#{fixtures_dir}/png/pmatrix.png", 'w') { |f| f.write(data_hash[:data])}
     assert_equal header, '89504e470d0a1a0a00'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mathematical
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Garen Torikian