mathematical 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7920616d037c8cdab3ade36bceda055362a6de9
-  data.tar.gz: a6d2688b1275203704cf01146a952ee7391c4d76
+  metadata.gz: 4c820da257090af3286f7e4756f79ce1aece737d
+  data.tar.gz: d2f998fbdd90b00510d0a5ac678af9397fa00dd8
 SHA512:
-  metadata.gz: 54a36429dd2a1bd98712ee5a194ef07396a8b76404894d9d3260ca0597b46896a86c97ab6f6664887c15c101dac1c49417880745c55c97ded3672e61390dbb2c
-  data.tar.gz: 51fdd320022dd0555be2a3141b7a2de65d5c7c076bd441565da36a61e3ba2a77f172e479e104367b268c3983cd362e170f7dda48a1624971d95bc0ff30b94890
+  metadata.gz: 643d66def8e1670019d4a9bdad47d3914fb0e09136790e6349e5088a2dcda5db606e81da6480f92c23dc0887b3b10fa2596c28eb31b53420d38300fec0b729be
+  data.tar.gz: fedb115fd8b874671d9dfaa43004e89d06640ea3f0288ac3c939d8bff4418c0b58c0e7dc07e89c04058f8367a6c2a807e2ed20a32b3225827ba7493201e57b23

data/README.md

@@ -48,7 +48,7 @@ The output will be a hash, with keys that depend on the format you want:
   * `: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).
+**Note**: If you pass in invalid LaTeX, an error is not raised, but a message *is* printed to STDERR. It is the caller's responsibility to check for `:error` and act on it.
 
 ### Array of equations
 
@@ -75,7 +75,7 @@ Mathematical.new.render(array)
 [ {: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 single strings, 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, the error message is printed to STDERR, but not raised.
 
 ### Options
 

data/ext/mathematical/mathematical.c

@@ -192,6 +192,9 @@ VALUE process(VALUE self, unsigned long maxsize, const char *latex_code, unsigne
   return result_hash;
 }
 
+// `process` can potentially raise a bunch of exceptions, so we need to wrap
+// the call in a rescue. And `rb_rescue` only takes one argument, so we need
+// to pack everything in an array, and then unpack it in `process_helper`.
 static VALUE process_helper(VALUE data)
 {
   VALUE *args = (VALUE *) data;
@@ -221,7 +224,14 @@ static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input)
   case T_STRING: {
     latex_code = StringValueCStr(rb_Input);
     latex_size = (unsigned long) strlen(latex_code);
-    output = process(self, maxsize, latex_code, latex_size);
+
+    VALUE args[4];
+    args[0] = self;
+    args[1] = ULONG2NUM(maxsize);
+    args[2] = rb_Input;
+    args[3] = ULONG2NUM(latex_size);
+
+    output = rb_rescue(process_helper, args, process_rescue, rb_Input);
     break;
   }
   case T_ARRAY: {
@@ -238,14 +248,12 @@ static VALUE MATHEMATICAL_process(VALUE self, VALUE rb_Input)
       latex_code = StringValueCStr(math);
       latex_size = (unsigned long) strlen(latex_code);
 
-      // `process` can potentially raise a bunch of exceptions, so we need to wrap
-      // the call in a rescue. And `rb_rescue` only takes one argument, so we need
-      // to pack everything in an array, and then unpack it in `process_helper`.
-      VALUE args[5];
+      VALUE args[4];
       args[0] = self;
       args[1] = ULONG2NUM(maxsize);
       args[2] = math;
       args[3] = ULONG2NUM(latex_size);
+
       hash = rb_rescue(process_helper, args, process_rescue, math);
 
       rb_ary_store(output, i, hash);

data/lib/mathematical.rb

@@ -33,19 +33,13 @@ class Mathematical
   def render(maths)
     maths = validate_content(maths)
 
-    begin
-      result_data = @processer.process(maths)
-      fail RuntimeError if result_data.nil? || (!result_data.is_a?(Hash) && !result_data.is_a?(Array))
-
-      if result_data.is_a? Array
-        result_data.map { |d| format_data(d) }
-      else
-        format_data(result_data)
-      end
-    rescue ParseError, DocumentCreationError, DocumentReadError => e
-      # an error in the C code, probably a bad TeX parse
-      $stderr.puts "#{e.message}: #{maths}"
-      maths
+    result_data = @processer.process(maths)
+    fail RuntimeError if !result_data.is_a?(Hash) && !result_data.is_a?(Array)
+
+    if result_data.is_a? Array
+      result_data.map { |d| format_data(d) }
+    else
+      format_data(result_data)
     end
   end
 

data/lib/mathematical/version.rb

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

data/test/mathematical/maliciousness_test.rb

@@ -7,7 +7,8 @@ class Mathematical::MaliciousnessTest < Test::Unit::TestCase
     output = nil
     # In mtex2MML, we raise a ParseError, but Mathematical suppresses it and returns the string.
     assert_nothing_raised { output = render.render('$not__thisisnotreal$') }
-    assert output == '$not__thisisnotreal$'
+    assert_equal output[:data], '$not__thisisnotreal$'
+    assert_equal output[:exception].class, Mathematical::ParseError
   end
 
   def test_it_does_not_blow_up_on_bad_arguments
@@ -25,42 +26,37 @@ class Mathematical::MaliciousnessTest < Test::Unit::TestCase
 
   def test_it_does_not_blow_up_on_bad_options
     assert_raise TypeError do
-      render = Mathematical.new({:ppi => "not a number"})
+      Mathematical.new({:ppi => 'not a number'})
     end
 
     assert_raise TypeError do
-      render = Mathematical.new({:zoom => "not a number"})
+      render = Mathematical.new({:zoom => 'not a number'})
     end
 
     assert_raise TypeError do
-      render = Mathematical.new({:maxsize => "not a number"})
+      Mathematical.new({:maxsize => 'not a number'})
     end
 
     assert_raise TypeError do
-      render = Mathematical.new({:maxsize => -23})
+      Mathematical.new({:maxsize => -23})
     end
 
     assert_raise TypeError do
-      render = Mathematical.new({:maxsize => 5.3})
+      Mathematical.new({:maxsize => 5.3})
     end
 
     assert_raise TypeError do
-      render = Mathematical.new({:format => 123})
+      Mathematical.new({:format => 123})
     end
 
     assert_raise TypeError do
-      render = Mathematical.new({:format => "something amazing"})
+      Mathematical.new({:format => 'something amazing'})
     end
 
-    assert_raise Mathematical::MaxsizeError do
-      render = Mathematical.new({:maxsize => 2})
-      render.render('$a \ne b$')
-    end
-
-    assert_nothing_raised RangeError do
-      render = Mathematical.new({:maxsize => 2147483647}) # signed long max
-      render.render('$a \ne b$')
-    end
+    render = Mathematical.new({:maxsize => 2})
+    output = render.render '$a \ne b$'
+    assert_equal output[:data], '$a \ne b$'
+    assert_equal output[:exception].class, Mathematical::MaxsizeError
 
     assert_raise RangeError do
       render = Mathematical.new({ :maxsize => 4_294_967_295 }) # unsigned long max
@@ -94,7 +90,8 @@ class Mathematical::MaliciousnessTest < Test::Unit::TestCase
     # Much like above, this fails in mtx2MML, but should do nothing here
     text = '$\Huge \sqrt\sqrt\sqrt\sqrt\sqrt\sqrt\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{\sqrt{}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}'
     assert_nothing_raised { output = render.render(text) }
-    assert output == text
+    assert_equal output[:data], text
+    assert_equal output[:exception].class, Mathematical::ParseError
   end
 
   def test_it_parses_all_possible_array_elements

metadata

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