imaginator 0.1.5

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) 2009 Daniel Mendler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/Manifest.txt

@@ -0,0 +1,5 @@
+Manifest.txt
+lib/imaginator.rb
+README.markdown
+LICENSE
+Rakefile

data/README.markdown

@@ -0,0 +1,40 @@
+README
+======
+
+Imaginator is a ruby library to generate images from LaTeX/Graphviz code in a background job. This library is derived from my latex-renderer library.
+
+Usage
+-----
+
+    Imaginator.uri = 'drbunix://tmp/imaginator.sock'
+    Imaginator.dir = '/tmp/imaginator'
+
+    Imaginator.run do |server|
+      server.add_renderer(:math,  Imaginator::LaTeX.new)
+      server.add_renderer(:dot,   Imaginator::Graphviz.new(:cmd => 'dot'))
+      server.add_renderer(:neato, Imaginator::Graphviz.new(:cmd => 'neato'))
+      server.add_renderer(:twopi, Imaginator::Graphviz.new(:cmd => 'twopi'))
+      server.add_renderer(:circo, Imaginator::Graphviz.new(:cmd => 'circo'))
+      server.add_renderer(:fdp,   Imaginator::Graphviz.new(:cmd => 'fdp'))
+    end
+
+    ...
+
+    name = Imaginator.get.enqueue(:math, '1+1')
+    ...
+    filename = Imaginator.get.result(name)
+
+TODO
+----
+
+* Write unit tests or specs
+
+Authors
+-------
+
+Daniel Mendler
+
+License
+-------
+
+This library is released under the MIT license.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'hoe'
+
+$:.unshift 'lib'
+require 'imaginator'
+
+Hoe.new 'imaginator', Imaginator::VERSION do |imaginator|
+  imaginator.developer 'Daniel Mendler', 'mail@daniel-mendler.de'
+  imaginator.summary = 'Image generator for LaTeX/Graphviz source'
+end
+

data/lib/imaginator.rb

@@ -0,0 +1,239 @@
+require 'digest'
+require 'fileutils'
+require 'thread'
+require 'monitor'
+require 'drb'
+require 'timeout'
+
+class Imaginator
+  VERSION = '0.1.5'
+
+  class LaTeX
+    def initialize(opts = {})
+      @opts = {
+        :convert_opts => '-trim -density 120',
+        :format          => 'png',
+        :debug           => false
+      }
+      @opts[:blacklist] = %w{
+        include def command loop repeat open toks output input
+        catcode name \\every \\errhelp \\errorstopmode \\scrollmode
+        \\nonstopmode \\batchmode \\read \\write csname \\newhelp
+        \\uppercase \\lowercase \\relax \\aftergroup \\afterassignment
+        \\expandafter \\noexpand \\special $$
+      }
+      @opts.update(opts)
+    end
+
+    def format
+      @opts[:format]
+    end
+
+    def render(code, file)
+      begin
+        temp_dir = create_temp_dir(file)
+        latex2dvi(temp_dir, code)
+        dvi2ps(temp_dir)
+        ps2image(temp_dir, file)
+      rescue
+        FileUtils.rm_rf(temp_dir) if !@opts[:debug]
+      else
+        FileUtils.rm_rf(temp_dir)
+      end
+    end
+
+    def process(code)
+      errors = @opts[:blacklist].select { |cmd| code.include?(cmd) }
+      errors.empty? || raise(ArgumentError.new("Invalid LaTeX commands #{errors.join(', ')}"))
+      code.strip
+    end
+
+    private
+
+    def template(code)
+      <<END # {{{
+\\documentclass{minimal}
+\\newcommand\\use[2][]{\\IfFileExists{#2.sty}{\\usepackage[#1]{#2}}{}}
+\\use[utf8]{inputenc}
+\\use{amsmath}
+\\use{amsfonts}
+\\use{amssymb}
+\\use{mathrsfs}
+\\use{esdiff}
+\\use{cancel}
+\\use[dvips,usenames]{color}
+\\use{nicefrac}
+\\use[fraction=nice]{siunitx}
+\\use{mathpazo}
+\\begin{document}
+$$
+#{code}
+$$
+\\end{document}
+END
+      # }}}
+    end
+
+    def create_temp_dir(file)
+      temp_dir = file + '-tmp'
+      FileUtils.mkdir_p(temp_dir)
+      temp_dir
+    end
+
+    def sh(cmd, args)
+      `#{cmd} #{args} 2>&1 > /dev/null`
+      raise RuntimeError.new("Execution of #{cmd} failed with status #{$?}") if $? != 0
+    end
+
+    def latex2dvi(dir, code)
+      tex_file = File.join(dir, 'code.tex')
+      File.open(tex_file, 'w') {|f| f.write(template(code)) }
+      sh('latex', "--interaction=nonstopmode --output-directory=#{dir} #{tex_file}")
+    end
+
+    def dvi2ps(dir)
+      file = File.join(dir, 'code')
+      sh('dvips', "-E #{file}.dvi -o #{file}.ps")
+    end
+
+    def ps2image(dir, file)
+      ps_file = File.join(dir, 'code.ps')
+      sh('convert', "#{@opts[:convert_opts]} #{ps_file} #{file}")
+    end
+  end
+
+  class Graphviz
+    def initialize(opts = {})
+      @opts = {
+        :format => 'png',
+        :cmd    => 'dot'
+      }
+      @opts.update(opts)
+    end
+
+    def format
+      @opts[:format]
+    end
+
+    def render(code, file)
+      IO.popen(@opts[:cmd] + " -T #{@opts[:format]} -o #{file}", 'w') {|io|
+        io.write(code)
+        io.close
+      }
+    end
+
+    def process(code)
+      code.strip
+    end
+  end
+
+  class Server
+    def initialize(renderer)
+      @renderer = renderer
+      @queue = []
+      @queue.extend(MonitorMixin)
+      @empty = @queue.new_cond
+    end
+
+    def enqueue(name, type, code)
+      @queue.synchronize do
+	@queue << [name, type, code]
+        @empty.signal
+      end
+    end
+
+    def enqueued?(name)
+      @queue.synchronize do
+        @queue.any? do |x|
+          x[0] == name
+        end
+      end
+    end
+
+    def run
+      loop do
+	name, type, code = @queue.synchronize do
+          return if !wait_while_empty
+          @queue.first
+        end
+	@renderer[type].render(code, name) rescue nil
+        @queue.synchronize do
+          @queue.shift
+        end
+      end
+    end
+
+    private
+
+    def wait_while_empty
+      Timeout.timeout(5) do
+        while @queue.empty?
+          @empty.wait
+        end
+        return true
+      end
+    rescue Timeout::Error => ex
+      false
+    end
+  end
+
+  def initialize(uri, dir)
+    @uri = uri
+    @dir = dir
+    @renderer = {}
+    FileUtils.mkdir_p(@dir, :mode => 0755)
+    yield(self) if block_given?
+  end
+
+  def add_renderer(type, renderer)
+    @renderer[type.to_sym] = renderer
+  end
+
+  def enqueue(type, code)
+    type = type.to_sym
+    renderer = @renderer[type]
+    raise(ArgumentError, "Renderer not found") if !renderer
+    format = renderer.format
+    code = renderer.process(code)
+    name = Digest::MD5.hexdigest(code) + '.' + format
+    file = File.join(@dir, name)
+    if !File.exists?(file)
+      server.enqueue(file, type, code)
+    end
+    name
+  end
+
+  def result(name)
+    file = File.join(@dir, name)
+    if !File.exists?(file)
+      20.times do
+        break if !server.enqueued?(file)
+        sleep 0.5
+      end
+    end
+    raise(RuntimeError, 'Image could not be generated') if !File.exists?(file)
+    file
+  end
+
+  def server
+    begin
+      @server ||= DRb::DRbObject.new(nil, @uri)
+      @server.respond_to? :enqueue
+      @server
+    rescue
+      if @uri =~ %r{^drbunix://(.+)$}
+        File.unlink($1) rescue nil
+      end
+      server = Server.new(@renderer)
+      drb_server = DRb.start_service(@uri, server)
+      Thread.new do
+	server.run
+	drb_server.stop_service
+        DRb.primary_server = nil if DRb.primary_server == drb_server
+	@server = nil
+      end
+      @server = server
+    end
+  end
+end
+

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: imaginator
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Daniel Mendler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-17 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.3
+    version: 
+description: 
+email: 
+- mail@daniel-mendler.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+files: 
+- Manifest.txt
+- lib/imaginator.rb
+- README.markdown
+- LICENSE
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/minad/imaginator
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: imaginator
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Image generator for LaTeX/Graphviz source
+test_files: []
+