mathematical 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90116f92892598eb7e352b94a5063289b1a4d597
-  data.tar.gz: e0d87480fadd5ce03a9f6d112d035c686cf9871d
+  metadata.gz: 9e4cb929866748f87d1b15561f28e2cb5be55038
+  data.tar.gz: 71cfa345fd9663b10209bd536619a69638d2d0ff
 SHA512:
-  metadata.gz: 128b9d3bcd5b4633203f0c76628e5190f80219b4f0d4f8f5b59d55a9a3182fd2e271886aa3245683ea0fbfd7770e48498f15e11fffc3abff3e9f1a4ed10a1270
-  data.tar.gz: ff3df8ae35fa24a359ca304531bec3ce0f610eae97819084fe617e752450396ef923b32baf12a36bde7f39eb2f9abd3ffeb0723e08e9cb7661ee6c5a8afc5f2d
+  metadata.gz: 1540affcb37235374e27834f805d90abd09d763815fc21854b8eebc5fdd9ca2f0f11c80428e1e937a3790ba02bae9730901e007fad79de2c9dcc07e65109271d
+  data.tar.gz: fe10a215421e6e25e021545bbea5fa17c419c8e63ac5c8962f7721197a393b68d76609e8b6ea2bae0845512bf106db9ec19fd9ecfa77d4e1c001f1d2e810e304

data/README.md

@@ -1,6 +1,6 @@
 # Mathematical
 
-Convert mathematical equations to base64 encoded images.
+Quickly convert math equations into beautiful SVGs.
 
 [![Build Status](https://travis-ci.org/gjtorikian/mathematical.svg?branch=master)](https://travis-ci.org/gjtorikian/mathematical)
 
@@ -28,45 +28,29 @@ The simplest way to do this is
 Mathematical::Render.new.render(string_with_math)
 ```
 
-`string_with_math` should just be a string, containing inline or display style math.
-The output will be all the math equations, as SVGs, converted into base64 encoded images.
-They look something like this:
-
-``` html
-<img class="type-inline" data-math-type="type-inline" src="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0..."/>
-```
-
-Inline math will have `class="type-inline" data-math-type="type-inline"` set, and display math will have
-`class="type-display" data-math-type="type-display"`.
-
-### Matched math notations
-
-Currently, the following formats are supported:
-
-| inline formulas | displayed equations |
-| ------------- |-------------|
-| `$...$`      | `[...]`
-| `(...)`      | `\begin{equation}...\end{equation}`
-
-### Supported commands and symbols
-
-Literally everything on the [itex2MML homepage for version 1.5.1](http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html)
-is supported, because it acts as the interpretation engine for mathematical.
+`string_with_math` should just be a string of itex inline (`$..$`) or display (`$$..$$`) style math.
+The output will be the math equation, as an SVG blob.
 
 ### Options
 
 `Mathematical::Render.new` can take a few options:
 
-* `:ppi`, the pixels per inch of the resulting SVG (default: `72.0`)
-* `:zoom`, the zoome level of the resulting SVG (default: `1.0`)
+* `:ppi` - A double determining the pixels per inch of the resulting SVG (default: `72.0`).
+* `:zoom` - A double determining the zoom level of the resulting SVG (default: `1.0`).
+* `:base64` - A boolean determining whether Mathematical's output should be a base64-encoded SVG string (default: `false`).
 
-Pass these in as an options hash; these *must* be Float values! For example:
+Pass these in as an options hash:
 
 ``` ruby
-opts = { :ppi => 200.0, :zoom => 5.0 }
+opts = { :ppi => 200.0, :zoom => 5.0, :base64 => true }
 renderer = Mathematical::Render.new(opts)
+renderer.render('$a \ne b$')
 ```
 
+### Supported commands and symbols
+
+Literally everything on the [itex2MML homepage for version 1.5.1](http://golem.ph.utexas.edu/~distler/blog/itex2MMLcommands.html) is supported, because it acts as the interpretation engine for Mathematical.
+
 ## Dependencies
 
 Before using this gem, you must install the following libraries:
@@ -105,6 +89,16 @@ sudo apt-get -qq -y install libxml2-dev libcairo2-dev libpango1.0-dev ttf-lyx
 
 On a Windows machine, I have no idea. Pull requests welcome!
 
+## Benchmarks
+
+```
+Benchmarking....
+Size: 1175 kilobytes
+Iterations: 10
+                                               user     system      total        real
+Rendering...                               9.470000   0.750000  10.220000 ( 13.909420)
+```
+
 ## Hacking
 
 After cloning the repo:
@@ -184,3 +178,19 @@ can convert directly to SVG, and it's fast. The same arbitrary 880 equations wer
 rendered in less than three seconds.
 
 And thus a wrapper was born.
+
+## More math stuff
+
+Check out [math-to-itex](https://github.com/gjtorikian/math-to-itex/), which quickly
+parses out itex notation from strings.
+
+With it, you could do something fun like:
+
+``` ruby
+MathToItex(string).convert do |eq, type|
+  svg_content = Mathematical::Render.new(:base64 => true).render(eq)
+
+  # create image tags of math with base64-encoded SVGs
+  %|<img class="#{type.to_s}-math" data-math-type="#{type.to_s}-math" src="#{svg_content}"/>|
+end
+```

data/lib/mathematical.rb

@@ -1,13 +1,7 @@
 require "mathematical/mathematical"
 
-require "mathematical/parser"
 require "mathematical/render"
 require "mathematical/version"
 
 module Mathematical
-  # Raised when missing binaries for images rendering.
-  class CommandNotFoundError < Exception; end
-
-  # Raised when the contents could not be parsed
-  class ParseError < Exception; end
 end

data/lib/mathematical/render.rb

@@ -6,7 +6,8 @@ module Mathematical
   class Render
     DEFAULT_OPTS = {
       :ppi => 72.0,
-      :zoom => 1.0
+      :zoom => 1.0,
+      :base64 => false
     }
 
     def initialize(opts = {})
@@ -18,59 +19,33 @@ module Mathematical
       rescue TypeError => e # some error in the C code
         raise
       end
-
     end
 
-    def render(text)
-      raise(TypeError, "text must be a string!") unless text.is_a? String
+    def render(maths)
+      raise(TypeError, "text must be a string!") unless maths.is_a? String
+      raise(ArgumentError, "text must be in itex format (`$...$` or `$$...$$`)!") unless maths =~ /\A\${1,2}/
 
-      # TODO: figure out how to write svgs without the tempfile
+      # TODO: figure out how to write SVGs without the tempfile
       tempfile = Tempfile.new('mathematical-temp.svg')
-      text = text.gsub(Mathematical::Parser::REGEX) do |maths|
-        if maths =~ /^\$(?!\$)/
-          just_maths = maths[1..-2]
-          type = :inline
-        elsif maths =~ /^\\\((?!\\\[)/
-          just_maths = maths[2..-4]
-          type = :inline
-        elsif maths =~ /^\\\[(?!\\\[)/
-          just_maths = maths[2..-4]
-          type = :display
-        elsif maths =~ /^\\begin(?!\\begin)/
-          just_maths = maths[16..-15]
-          type = :display
-        end
-
-        # this is the format itex2MML expects
-        if type == :inline
-          just_maths = "$#{just_maths}$"
-        else
-          just_maths = "$$#{just_maths}$$"
-        end
-
-        begin
-          status = @processer.process(just_maths, tempfile.path)
-          raise RuntimeError unless status
-          svg_content = File.open(tempfile.path, 'r') { |image_file| image_file.read }
-          svg_content = svg_content.lines.to_a[1..-1].join
-        rescue RuntimeError => e # an error in the C code, probably a bad TeX parse
-          $stderr.puts "#{e.message}: #{maths}"
-          next(maths)
-        end
-
-        "<img class=\"#{named_type(type)}\" data-math-type=\"#{named_type(type)}\" src=\"data:image/svg+xml;base64,#{svg_to_base64(svg_content)}\"/>"
+      begin
+        raise RuntimeError unless @processer.process(maths, tempfile.path)
+        svg_content = File.open(tempfile.path, 'r') { |image_file| image_file.read }
+        svg_content = svg_content[xml_header.length..-1] # remove starting <?xml...> tag
+        @config[:base64] ? svg_to_base64(svg_content) : svg_content
+      rescue RuntimeError => e # an error in the C code, probably a bad TeX parse
+        $stderr.puts "#{e.message}: #{maths}"
+        maths
       end
-      tempfile.close
-      tempfile.unlink
-      text
     end
 
-    def svg_to_base64(contents)
-      Base64.strict_encode64(contents)
+private
+
+    def xml_header
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
     end
 
-    def named_type(type)
-      "#{type.to_s}-math"
+    def svg_to_base64(contents)
+      "data:image/svg+xml;base64,#{Base64.strict_encode64(contents)}"
     end
   end
 end

data/lib/mathematical/version.rb

@@ -1,3 +1,3 @@
 module Mathematical
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/mathematical.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Mathematical::VERSION
   spec.authors       = ["Garen Torikian"]
   spec.email         = ["gjtorikian@gmail.com"]
-  spec.summary       = %q{Quickly turn itex math equations into base64 SVGs.}
-  spec.description   = %q{A very fast way to turn itex math equations into beautifully rendered base64 SVGs, to embed on the web. This library is a general purpose wrapper to GNOME's Lasem. }
+  spec.summary       = %q{Quickly convert math equations into beautiful SVGs.}
+  spec.description   = %q{A very fast way to turn itex math equations into beautifully rendered SVGs, to embed on the web. This library is a general purpose wrapper to GNOME's Lasem. }
   spec.homepage      = "https://github.com/gjtorikian/mathematical"
   spec.license       = "MIT"
 
@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake-compiler"
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "mocha", "~> 1.0"
+  spec.add_development_dependency "math-to-itex"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mathematical
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Garen Torikian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -52,8 +52,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: math-to-itex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'A very fast way to turn itex math equations into beautifully rendered
-  base64 SVGs, to embed on the web. This library is a general purpose wrapper to GNOME''s
+  SVGs, to embed on the web. This library is a general purpose wrapper to GNOME''s
   Lasem. '
 email:
 - gjtorikian@gmail.com
@@ -67,7 +81,6 @@ files:
 - lib/mathematical.bundle
 - lib/mathematical.rb
 - lib/mathematical/mathematical.bundle
-- lib/mathematical/parser.rb
 - lib/mathematical/render.rb
 - lib/mathematical/version.rb
 - mathematical.gemspec
@@ -94,5 +107,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Quickly turn itex math equations into base64 SVGs.
+summary: Quickly convert math equations into beautiful SVGs.
 test_files: []

data/lib/mathematical/parser.rb

@@ -1,30 +0,0 @@
-module Mathematical
-  class Parser
-    # https://stackoverflow.com/questions/14182879/regex-to-match-latex-equations
-    REGEX = /
-    (?<!\\)    # negative look-behind to make sure start is not escaped
-    (?:       # start non-capture group for all possible match starts
-        # group 1, match dollar signs only
-        # single or double dollar sign enforced by look-arounds
-        ((?<!\$)\${1,2}(?!\$))|
-        # group 2, match escaped parenthesis
-        (\\\()|
-        # group 3, match escaped bracket
-        (\\\[)|
-        # group 4, match begin equation
-        (\\begin\{equation\})
-    )
-    (.*?(\g<1>)?.*?)  # match everything in between including nested LaTeX equations
-    (?<!\\)  # negative look-behind to make sure end is not escaped
-        # if group 1 was start, match \1
-        (?(1)(?<!\$)\1(?!\$)|
-        # if group 2 was start, escaped parenthesis is end
-        (?(2)\\\)|
-        # if group 3 was start, escaped bracket is end
-        (?(3)\\\]|
-        # otherwise group 4 was start, match end equation
-        \\end\{equation\}
-    )))
-    /x
-  end
-end