mathjax-renderer 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 165ff0794cd3f86f3bc5ced82d3a664c3158a001
-  data.tar.gz: 5dbba1a656af3cca9a23ed24ca2ad71080badfa1
+  metadata.gz: a82f09525f6f7743b239d3a7ff05682b4e28fdda
+  data.tar.gz: 80664ffb9aecc94634e6e6a12127a68f73e0efd8
 SHA512:
-  metadata.gz: 8ad8df450bf98d2634868769ed0731f5f0d925b7ce4538769f840f924dd1d17a49d0e722d6bc0e7f49de959b46f64d1f87738d2da9d846e0213c81aee54f0141
-  data.tar.gz: a12f8a668b433844cdc54490a06021176fa0393e14e49fbda7a43d15f76ee13e8166668fe2ed6a3222db061b802672eec82a17f3fa0984cc82724b88805aefb4
+  metadata.gz: a9c9e9dc0fccac290d8e784d238e89377295611d40f6af689381d67f656ac64f225de97b00de6eb47e106a3d48a1cc8ea371b8af8e4febc2af3fa9c85fab1816
+  data.tar.gz: b2c9514dc87c99ee7d1e9d5fe129788e37f8ee5e85d9bcfde088237605b43776ae7a9d97c3bc941a32173bf13b2845f4123554fac614e5d392fd76ac6595a3fa

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 source 'https://rails-assets.org'
 
-# Specify your gem's dependencies in mathjax-renderer.gemspec
+# Specify your gem's dependencies in mathjax_renderer-renderer.gemspec
 gemspec

data/features/generate_html.feature

@@ -0,0 +1,21 @@
+Feature: The renderer can generate the HTML content that displays the mathml
+
+  Scenario: The renderer generates the HTML from MathML
+    When the renderer is invoked with
+      """
+      <math xmlns="http://www.w3.org/1998/Math/MathML">
+        <mi>a</mi><msup><mi>x</mi><mn>2</mn></msup>
+        <mo>+</mo> <mi>b</mi><mi>x</mi>
+        <mo>+</mo> <mi>c</mi> <mo>=</mo> <mn>0</mn>
+      </math>
+      """
+    Then the result text is "ax2+bx+c=0"
+      And the contains more than 10 HTML tags
+
+  Scenario: The renderer generates HTML from TeX
+    When the renderer is invoked with
+    """
+      \(ax^2 + bx + c = 0\)
+    """
+    Then the result text is "ax2+bx+c=0"
+      And the contains more than 10 HTML tags

data/features/generate_image.feature

@@ -0,0 +1,19 @@
+Feature: The renderer can render PNG images from math
+
+  Scenario: When an image path is supplied, the generated image is put there
+    Given the image path is set
+    When the renderer is invoked with a valid expression
+    Then the image is generated in the directory
+
+  Scenario: When there is no image path supplied, then an image is not generated
+    Given the image path is not set
+    When getting the image path
+    Then an Exception occurs
+
+  Scenario: The generated image contains the expression
+    Given an image is generated for the formulae
+    """
+    \(ax^2 + bx + c = 0\)
+    """
+    Then it's width is at least 120px
+      And it's height is at least 10px

data/features/options.feature

@@ -0,0 +1,23 @@
+Feature: Padding, min width and additional styles can be set for image generation
+
+  Scenario: If a padding is set, then the generated image is bigger
+    When an image is generated with 10px padding
+    Then it's size increases by 20px in every dimension
+
+  Scenario: If min width is set, then no image will be smaller than that
+    When an image is generated with 300px min width for
+    """
+    \(ax^2 + bx + c = 0\)
+    """
+    Then it's width is 300px
+
+  Scenario: If additional styles are supplied, they will be applied to the image
+    Given an image is generated for the formulae
+    """
+    \(ax^2 + bx + c = 0\)
+    """
+      And the additional styles are
+    """
+      body{background-color:blue;}
+    """
+    Then the generated image is mostly blue

data/features/step_definitions/html_steps.rb

@@ -0,0 +1,11 @@
+When(/^the renderer is invoked with$/) do |string|
+  @renderer = Mathjax_Renderer::Renderer.new(string)
+end
+
+Then(/^the result text is "(.*?)"$/) do |arg1|
+  expect(@renderer.html.inner_text).to eq arg1
+end
+
+Then(/^the contains more than (\d+) HTML tags$/) do |arg1|
+  expect(@renderer.html.xpath('.//*').size).to be >= arg1.to_i
+end

data/features/step_definitions/image_steps.rb

@@ -0,0 +1,80 @@
+Given(/^the image path is set$/) do
+  @img_path = $tmpdir
+end
+
+When(/^the renderer is invoked with a valid expression$/) do
+  @renderer = Mathjax_Renderer::Renderer.new('\(ax^2 + bx + c = 0\)', @img_path)
+end
+
+Then(/^the image is generated in the directory$/) do
+  img_name = @renderer.image_name
+  expect(File.exists? @img_path + '/' +img_name).to be
+end
+
+Given(/^the image path is not set$/) do
+  @img_path = nil
+end
+
+Then(/^an Exception occurs$/) do
+  expect(@exception).to be
+end
+
+When(/^getting the image path$/) do
+  begin
+    @renderer.image_name
+    rescue => @exception
+  end
+end
+
+Given(/^an image is generated for the formulae$/) do |string|
+  @expression = string
+  renderer = Mathjax_Renderer::Renderer.new(@expression, $tmpdir)
+  @image = ChunkyPNG::Image.from_file("#{$tmpdir}/#{renderer.image_name}")
+end
+
+Then(/^it's width is at least (\d+)px$/) do |arg1|
+  expect(@image.width).to be >= arg1.to_i
+end
+
+Then(/^it's height is at least (\d+)px$/) do |arg1|
+  expect(@image.height).to be >= arg1.to_i
+end
+
+When(/^an image is generated with (\d+)px padding$/) do |arg1|
+  original_renderer = Mathjax_Renderer::Renderer.new('\(ax^2 + bx + c = 0\)', $tmpdir)
+  padded_renderer = Mathjax_Renderer::Renderer.new('\(ax^2 + bx + c = 0\)', $tmpdir, padding: arg1.to_i)
+  @original_image = ChunkyPNG::Image.from_file("#{$tmpdir}/#{original_renderer.image_name}")
+  @padded_image = ChunkyPNG::Image.from_file("#{$tmpdir}/#{padded_renderer.image_name}")
+end
+
+Then(/^it's size increases by (\d+)px in every dimension$/) do |arg1|
+  expect(@padded_image.width).to eq @original_image.width + arg1.to_i
+  expect(@padded_image.height).to eq @original_image.height + arg1.to_i
+end
+
+When(/^an image is generated with (\d+)px min width for$/) do |arg1, string|
+  renderer = Mathjax_Renderer::Renderer.new(string, $tmpdir, min_width:arg1.to_i)
+  @image = ChunkyPNG::Image.from_file("#{$tmpdir}/#{renderer.image_name}")
+end
+
+Then(/^it's width is (\d+)px$/) do |arg1|
+  expect(@image.width).to eq arg1.to_i
+end
+
+Given(/^the additional styles are$/) do |string|
+  renderer = Mathjax_Renderer::Renderer.new(@expression, $tmpdir, additional_styles:string)
+  @image = ChunkyPNG::Image.from_file("#{$tmpdir}/#{renderer.image_name}")
+end
+
+Then(/^the generated image is mostly blue$/) do
+  blue = 0
+  @image.width.times do |x|
+    @image.height.times do |y|
+       blue+=1 if ChunkyPNG::Color.b(@image[1,1])==255
+    end
+  end
+
+  all_pixels = @image.width * @image.height
+
+  expect(blue).to be >= all_pixels / 2
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+require 'mathjax_renderer/renderer'
+require 'chunky_png'
+
+Around do |scenario, block|
+  Dir.mktmpdir{|tmpdir|
+    $tmpdir = tmpdir
+    block.call
+  }
+end

data/lib/mathjax_renderer/renderer.rb

@@ -0,0 +1,207 @@
+module Mathjax_Renderer
+  class Renderer
+    require 'capybara'
+    require 'capybara/dsl'
+    require 'headless'
+
+    include Capybara::DSL
+
+    def initialize(mathml, image_base_url = nil, options = {})
+      @mathml = mathml
+      @image_base_url = image_base_url
+      @options = {min_width: 0, extra_style:'', padding:0}.merge options
+    end
+
+    def image_name
+      raise ArgumentError if @image_base_url.nil?
+      render! unless File.exist?(image_path)
+      _image_name
+    end
+
+    def render!
+      server = RendererServer.new
+      server.ensure_started!
+
+      added_margin = [@options[:padding],@options[:min_width]].max
+
+      url = server.add_content(@mathml, added_margin, @options[:extra_style])
+
+      Headless.ly do
+
+        Capybara.register_driver :chrome do |app|
+          Capybara::Selenium::Driver.new(app, :browser => :chrome)
+        end
+
+        Capybara.default_driver = :chrome
+        Capybara.app_host = "http://localhost:#{server.port}"
+
+        visit url
+
+        def mathjax_ready?(page)
+          html = Nokogiri::HTML(page.html)
+          !html.css('.MathJax').empty? && html.css('.MathJax_Processing').empty? && html.css('.MathJax_Processed').empty?
+        end
+
+        sleep 0.1 until mathjax_ready?(page)
+
+        unless @image_base_url.nil?
+          require 'chunky_png'
+          driver = page.driver
+
+          require 'fileutils'
+          FileUtils.mkpath @image_base_url
+
+          driver.save_screenshot(image_path)
+
+          el= page.find('.MathJax .math').native
+
+          image = ChunkyPNG::Image.from_file(image_path)
+
+          correction = [(@options[:min_width] -(el.size.width + 2 * @options[:padding])) / 2,0].max
+
+          x = el.location.x + 1 - @options[:padding]-correction
+          y = el.location.y + 1 - @options[:padding]
+          width = [el.size.width + 2 * @options[:padding],@options[:min_width]].max
+          height = el.size.height+ 2 * @options[:padding]
+
+          image.crop!(x, y, width, height)
+          image.save(image_path)
+        end
+        result = Nokogiri::HTML(page.html).css('.MathJax')[0]
+
+        put_cache!(params_hash,result)
+
+        page.driver.quit
+
+        @html = result
+      end
+    end
+
+    def html
+      return cached(params_hash) if cached? params_hash
+
+      render! if @html.nil?
+
+      @html
+    end
+
+    private
+
+    def params_hash
+      Digest::SHA1.hexdigest(@mathml+@options.to_s)
+    end
+
+    def image_path
+      "#{@image_base_url}/#{_image_name}"
+    end
+
+    def _image_name
+      "#{params_hash}.png"
+    end
+
+    @@cache={}
+
+    def cache
+      @@cache
+    end
+
+    def cached?(mathml)
+      cache.has_key?(mathml)
+    end
+
+    def cached(mathml)
+      cache[mathml]
+    end
+
+    def put_cache!(mathml,result)
+      cache[mathml]=result
+    end
+  end
+
+  class RendererServer
+    require 'concurrent/atomic/atomic_boolean'
+    require 'digest'
+
+    def add_content(content, added_margin, extra_style = '')
+      digest = Digest::SHA1.hexdigest(content)
+      path = "/#{digest}.html"
+      server.mount_proc path do |_, res|
+        res.body = response(content, added_margin, extra_style)
+      end
+
+      path
+    end
+
+    def port
+      server.config[:Port]
+    end
+
+    def response(content, added_margin, extra_style)
+      "
+        <html><head>
+      <script type='text/x-mathjax_renderer-config'>
+          MathJax.Hub.Config({
+            messageStyle: 'none',
+            showMathMenu:false
+          });
+      </script>
+      <script type='text/javascript'
+            src='javascripts/MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
+<style>.MathJax{position:absolute!important;margin:#{added_margin}px!important;}
+#{extra_style}</style>
+</head><body>#{content}</body></html>"
+    end
+
+    def ensure_started!
+      if start!
+        Thread.start do
+          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))
+
+          server.mount '/javascripts/MathJax/fonts', WEBrick::HTTPServlet::FileHandler, "#{mathjax_dir}/app/assets/fonts/MathJax/fonts"
+
+          begin
+            server.start
+          ensure
+            server.shutdown
+          end
+        end
+      end
+      def server_started?
+        require 'net/http'
+        uri = URI("http://localhost:#{port}/javascripts/MathJax/MathJax.js")
+
+        req = Net::HTTP::Get.new(uri)
+        res = Net::HTTP.start(uri.hostname, uri.port) {|http|
+          http.read_timeout = 1
+          http.request(req)
+        }
+
+        res.is_a?(Net::HTTPSuccess)
+      rescue
+        false
+      end
+
+      sleep 0.1 until server_started?
+    end
+
+    private
+
+    def server
+      @@server
+    end
+
+    def server=(server)
+      @@server = server
+    end
+
+    @@started=Concurrent::AtomicBoolean.new
+
+    def start!
+      @@started.make_true
+    end
+
+  end
+end

data/lib/mathjax_renderer/version.rb

@@ -0,0 +1,3 @@
+module Mathjax_Renderer
+  VERSION = "0.0.3"
+end

data/lib/renderer.rb

@@ -0,0 +1,5 @@
+require 'mathjax_renderer/version'
+require 'mathjax_renderer/renderer'
+
+module Mathjax_Renderer
+end

data/mathjax-renderer.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mathjax/renderer/version'
+require 'mathjax_renderer/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "mathjax-renderer"
-  spec.version       = Mathjax::Renderer::VERSION
+  spec.version       = Mathjax_Renderer::VERSION
   spec.authors       = ["sashee"]
   spec.email         = ["gsashee@gmail.com"]
   spec.summary       = %q{Summary}
@@ -21,6 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "rspec-expectations"
+
   spec.add_dependency "rails-assets-MathJax"
   spec.add_dependency "nokogiri"
   spec.add_dependency "concurrent-ruby"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mathjax-renderer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - sashee
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  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'
 - !ruby/object:Gem::Dependency
   name: rails-assets-MathJax
   requirement: !ruby/object:Gem::Requirement
@@ -162,8 +190,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/mathjax/renderer.rb
-- lib/mathjax/renderer/version.rb
+- features/generate_html.feature
+- features/generate_image.feature
+- features/options.feature
+- features/step_definitions/html_steps.rb
+- features/step_definitions/image_steps.rb
+- features/support/env.rb
+- lib/mathjax_renderer/renderer.rb
+- lib/mathjax_renderer/version.rb
+- lib/renderer.rb
 - mathjax-renderer.gemspec
 homepage: ''
 licenses:
@@ -189,4 +224,10 @@ rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Summary
-test_files: []
+test_files:
+- features/generate_html.feature
+- features/generate_image.feature
+- features/options.feature
+- features/step_definitions/html_steps.rb
+- features/step_definitions/image_steps.rb
+- features/support/env.rb

data/lib/mathjax/renderer/version.rb

@@ -1,5 +0,0 @@
-module Mathjax
-  module Renderer
-    VERSION = "0.0.2"
-  end
-end

data/lib/mathjax/renderer.rb

@@ -1,201 +0,0 @@
-require "mathjax/renderer/version"
-
-module Mathjax
-  module Renderer
-    class MathJaxRenderer
-      require 'capybara'
-      require 'capybara/dsl'
-      require 'headless'
-
-      include Capybara::DSL
-
-      def initialize(image_base_url, mathml, options = {})
-        @mathml = mathml
-        @image_base_url = image_base_url
-        @options = {min_width: 0, extra_style:'', padding:0}.merge options
-      end
-
-      def image_name
-        render! unless File.exist?(image_path)
-        _image_name
-      end
-
-      def render!
-        server = MathJaxServer.new
-        server.ensure_started!
-
-        url = server.add_content(@mathml, @options[:extra_style])
-
-        Headless.ly do
-
-          Capybara.register_driver :chrome do |app|
-            Capybara::Selenium::Driver.new(app, :browser => :chrome)
-          end
-
-          Capybara.default_driver = :chrome
-          Capybara.app_host = "http://localhost:#{server.port}"
-
-          visit url
-
-          def mathjax_ready?(page)
-            html = Nokogiri::HTML(page.html)
-            !html.css('.MathJax_Display').empty? && html.css('.MathJax_Processing').empty? && html.css('.MathJax_Processed').empty?
-          end
-
-          sleep 0.1 until mathjax_ready?(page)
-
-          require 'chunky_png'
-          driver = page.driver
-
-          require 'fileutils'
-          FileUtils.mkpath @image_base_url
-
-          driver.save_screenshot(image_path)
-
-          el= page.find('.MathJax_Display .math').native
-
-          image = ChunkyPNG::Image.from_file(image_path)
-
-          correction = [(@options[:min_width] -(el.size.width + 2 * @options[:padding])) /2,0].max
-
-          image.crop!(el.location.x + 1 - @options[:padding]-correction, el.location.y + 1 - @options[:padding], el.size.width + 2 * @options[:padding] + (2 * correction), el.size.height+ 2 * @options[:padding])
-          image.save(image_path)
-
-          result = Nokogiri::HTML(page.html).css('.MathJax_Display')[0]
-
-          put_cache!(params_hash,result)
-
-          page.driver.quit
-
-          @html = result
-        end
-      end
-
-      def html
-        return cached(params_hash) if cached? params_hash
-
-        render! if @html.nil?
-
-        @html
-      end
-
-      private
-
-      def params_hash
-        Digest::SHA1.hexdigest(@mathml+@options.to_s)
-      end
-
-      def image_path
-        "#{@image_base_url}/#{_image_name}"
-      end
-
-      def _image_name
-        "#{params_hash}.png"
-      end
-
-      @@cache={}
-
-      def cache
-        @@cache
-      end
-
-      def cached?(mathml)
-        cache.has_key?(mathml)
-      end
-
-      def cached(mathml)
-        cache[mathml]
-      end
-
-      def put_cache!(mathml,result)
-        cache[mathml]=result
-      end
-    end
-
-    class MathJaxServer
-      require 'concurrent/atomic/atomic_boolean'
-      require 'digest'
-
-      def add_content(content, extra_style = '')
-        digest = Digest::SHA1.hexdigest(content)
-        path = "/#{digest}.html"
-        server.mount_proc path do |_, res|
-          res.body = response(content, extra_style)
-        end
-
-        path
-      end
-
-      def port
-        server.config[:Port]
-      end
-
-      def response(content, extra_style)
-        "
-          <html><head>
-        <script type='text/x-mathjax-config'>
-            MathJax.Hub.Config({
-              messageStyle: 'none',
-              showMathMenu:false
-            });
-        </script>
-        <script type='text/javascript'
-              src='javascripts/MathJax/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
-<style>#{extra_style}</style>
-</head><body>#{content}</body></html>"
-      end
-
-      def ensure_started!
-        if start!
-          Thread.start do
-            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))
-
-            server.mount '/javascripts/MathJax/fonts', WEBrick::HTTPServlet::FileHandler, "#{mathjax_dir}/app/assets/fonts/MathJax/fonts"
-
-            begin
-              server.start
-            ensure
-              server.shutdown
-            end
-          end
-        end
-        def server_started?
-          require 'net/http'
-          uri = URI("http://localhost:#{port}/javascripts/MathJax/MathJax.js")
-
-          req = Net::HTTP::Get.new(uri)
-          res = Net::HTTP.start(uri.hostname, uri.port) {|http|
-            http.read_timeout = 1
-            http.request(req)
-          }
-
-          res.is_a?(Net::HTTPSuccess)
-        rescue
-          false
-        end
-
-        sleep 0.1 until server_started?
-      end
-
-      private
-
-      def server
-        @@server
-      end
-
-      def server=(server)
-        @@server = server
-      end
-
-      @@started=Concurrent::AtomicBoolean.new
-
-      def start!
-        @@started.make_true
-      end
-
-    end
-  end
-end