mathjax-renderer 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8167da313922059eab8f95cc78bcafbf7a4a9c49
-  data.tar.gz: 89316e24aed1c3371872de66857f63d68fa2d9ad
+  metadata.gz: 108c1668656658f3c89100c86dcbaee043b19343
+  data.tar.gz: 9635fb1117c4084b4b6480c7ef4b851d3fdca2f8
 SHA512:
-  metadata.gz: 90128c641d73aaabac0aa6060290101ee2b09e1f4e27efd16baa1b30f1b0d71a30404b62d9ec5975f3a5cdbdd16fa0885c44797009ed094808773defb4109601
-  data.tar.gz: cad9e561bcf59d94c82b9f3feec86c3ed985d0c3e8e389e6c9416af4628d17d3609a7cb8207e2ef5a86b06faeac146ab03b9e1cb6261e3ee41294015627f340b
+  metadata.gz: e02966b4f64ab784df3176473320abfb0e2ffb43dc899665383450bc30e91bf271a4f748efd0cf4a7d8391c4298529159e895e6f0c23019761111579d6c0e97e
+  data.tar.gz: d0f48a885c73debde6bb8b86c65544e3f8b51c5de7dc293dba87356e6703056bdca1d7b9c59360561e6e2fd8021426cffa4ae05954f7be52296f223833cca591

data/README.md

@@ -1,6 +1,11 @@
 # Mathjax::Renderer
 
-TODO: Write a gem description
+This gem is to pre-render MathJax expressions or export them as images. Since MathJax uses client-side
+Javascript and styles to convert MathML (along with other formats) to HTML, this is not compatible
+with article readers like Pocket as they do not run scripts. mathjax-renderer solves this by
+generating images from MathJax expressions which can be inserted to the site instead of the MathML
+expression, thus making them visible to readers. Also, there is an option to generate the HTML,
+so you can remove the client-side scripts.
 
 ## Installation
 
@@ -20,11 +25,66 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+mathjax-renderer can generate the HTML from running the MathJax scripts, and it can be used to directly
+generate an image from the result. It uses a global cache, so it is fast for the second time for the
+same input.
+
+### Requirements
+
+mathjax-renderer uses Chrome with Xvfb, so they need to be installed (sorry, not gonna work on Windows).
+
+### Generating the HTML
+
+To generated the HTML, just call:
+
+```ruby
+Mathjax_Renderer::Renderer.new(mathml_string).html
+```
+
+Then, the resulting HTML can be directly inserted to the page. This also needs the MathJax fonts, so
+don't forget to include them as well:
+
+```
+@font-face {font-family: MathJax_Main; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Main-Regular.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Main-Regular.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Main-bold; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Main-Bold.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Main-Bold.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Main-italic; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Main-Italic.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Main-Italic.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Math-italic; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Math-Italic.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Math-Italic.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Caligraphic; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Caligraphic-Regular.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Caligraphic-Regular.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Size1; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Size1-Regular.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Size1-Regular.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Size2; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Size2-Regular.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Size2-Regular.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Size3; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Size3-Regular.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Size3-Regular.otf?rev=2.5.0') format('opentype')}
+@font-face {font-family: MathJax_Size4; src: url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/woff/MathJax_Size4-Regular.woff?rev=2.5.0') format('woff'), url('http://cdn.mathjax.org/mathjax/latest/fonts/HTML-CSS/TeX/otf/MathJax_Size4-Regular.otf?rev=2.5.0') format('opentype')}
+```
+
+_Note:_ don't forget that you already have these as a transitive dependency to rails-assets-MathJax.
+Be nice and use those instead.
+
+### Generating image
+
+To generate the image as well, just supply a base folder to store the images:
+
+```ruby
+Mathjax_Renderer::Renderer.new(mathml_string, image_directory).image_name
+```
+
+This generates the image and gets back the name in the target directory.
+
+There are a few configurations possible:
+
+* *min_width:* The resulting image will be at least wide in pixels. Pocket enlarges images that are too small,
+making them a bit bigger disables this behaviour
+* *extra_style:* These will be appended to a style element. Use it to set text color, background color,
+or any other styles that would have been applied to the HTML in your site.
+* *padding:* A padding in pixels will be added to both dimensions.
+
+## Caveats
+
+mathjax-renderer internally uses a WEBrick server to generate the results in a random free port. It is
+started when the renderer is first called, and remains running.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/mathjax-renderer/fork )
+1. Fork it ( https://github.com/sashee/mathjax-renderer/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/mathjax_renderer/renderer.rb

@@ -28,7 +28,7 @@ module Mathjax_Renderer
       Headless.ly do
 
         Capybara.register_driver :chrome do |app|
-          Capybara::Selenium::Driver.new(app, :browser => :chrome)
+          Capybara::Selenium::Driver.new(app, :browser => :chrome, :args => ['no-sandbox','no-default-browser-check','no-first-run','disable-default-apps'])
         end
 
         Capybara.default_driver = :chrome
@@ -38,7 +38,9 @@ module Mathjax_Renderer
 
         def mathjax_ready?(page)
           html = Nokogiri::HTML(page.html)
-          !html.css('.MathJax').empty? && html.css('.MathJax_Processing').empty? && html.css('.MathJax_Processed').empty?
+          !html.css('.MathJax').empty? &&
+            html.css('.MathJax_Processing').empty? &&
+            html.css('.MathJax_Processed').empty?
         end
 
         Timeout.timeout(5) do
@@ -159,9 +161,16 @@ module Mathjax_Renderer
           require 'webrick'
           mathjax_dir = Gem::Specification.find_by_name("rails-assets-MathJax").gem_dir
 
-          self.server = WEBrick::HTTPServer.new(:Port => 0, :DocumentRoot => "#{mathjax_dir}/app/assets",:AccessLog => [], :Logger => WEBrick::Log::new('/dev/null', 7))
+          self.server = WEBrick::HTTPServer.new(
+            :Port => 0,
+            :DocumentRoot => "#{mathjax_dir}/app/assets",
+            :AccessLog => [],
+            :Logger => WEBrick::Log::new('/dev/null', 7)
+          )
 
-          server.mount '/javascripts/MathJax/fonts', WEBrick::HTTPServlet::FileHandler, "#{mathjax_dir}/app/assets/fonts/MathJax/fonts"
+          server.mount '/javascripts/MathJax/fonts',
+                       WEBrick::HTTPServlet::FileHandler,
+                       "#{mathjax_dir}/app/assets/fonts/MathJax/fonts"
 
           begin
             server.start

data/lib/mathjax_renderer/version.rb

@@ -1,3 +1,3 @@
 module Mathjax_Renderer
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mathjax-renderer
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - sashee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-07 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler