rails-latex 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Geoff Jacobsen
+
+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/README.rdoc

@@ -0,0 +1,57 @@
+= Rails-LaTeX
+
+* Git: http://github.com/jacott/rails-latex
+* Author: Geoff Jacobsen   
+* Copyright: 2009-2010    
+* License: MIT-LICENSE
+
+== Description
+
+rails-latex is a renderer for rails 3 which allows tex files with erb to be turned into an inline pdf.
+
+== Synopsis
+
+app/helpers/application_helper.rb:
+   def lesc(text)
+     LatexToPdf.escape_latex(text)
+   end
+
+app/views/stories/show.html.erb:
+   ...
+   <%= link_to "print", story_path(@story,:format => :pdf) %>
+
+
+app/views/stories/show.pdf.erb:
+   ...   
+   <%= lesc @story.name % >
+
+app/views/layouts/application.pdf.erbtex:
+   \documentclass[12pt,a4paper,sloppy,< %= @landscape % >]{article}
+   ...
+   < %= yield % >
+   \end{document}
+
+
+config/initializers/mime_types.rb:
+   ...     
+   Mime::Type.register "application/pdf", :pdf, ['text/pdf'], ['pdf']
+
+
+Only the file containing the \\documentclass should be of type: .pdf.erbtex . Partials and views (when there is a layout)
+should be of type .pdf.erb .
+
+== Requirements
+
+* ruby 1.8 or 1.9
+* rails 3
+
+== Install
+
+* gem install rails-latex
+
+== Development
+
+Developing rails-latex requires jeweler
+
+* rake test
+* rake build

data/lib/erb_latex.rb

@@ -0,0 +1,18 @@
+require 'fileutils'
+require 'latex_to_pdf'
+require 'action_view'
+
+module ActionView               # :nodoc: all
+  module Template::Handlers
+    class ERBLatex < ERB
+      def compile(template)
+        erb = "<% __in_erb_template=true %>#{template.source}"
+        out=self.class.erb_implementation.new(erb, :trim=>(self.class.erb_trim_mode == "-")).src
+        out + ";LatexToPdf.generate_pdf(@output_buffer.to_s)"
+      end
+    end
+  end
+  Template.register_template_handler :erbtex, Template::Handlers::ERBLatex
+end
+
+

data/lib/latex_to_pdf.rb

@@ -0,0 +1,57 @@
+class LatexToPdf
+  # Converts a string of LaTeX +code+ into a binary string of PDF.
+  #
+  # pdflatex is used to convert the file and creates the directory +#{Rails.root}/tmp/rails-latex+ to store intermediate
+  # files.
+  def self.generate_pdf(code)
+    dir=File.join(Rails.root,'tmp','rails-latex',"#{Process.pid}-#{Thread.current.hash}")
+    input=File.join(dir,'input.tex')
+    FileUtils.mkdir_p(dir)
+    File.open(input,'wb') {|io| io.write(code) }
+    system('pdflatex','-output-directory',dir,'-interaction','batchmode',input,
+           :umask => 7,:out => :close, :err => :close, :in => :close)
+    result=File.read(input.sub(/\.tex$/,'.pdf'))
+    FileUtils.rm_rf(dir)
+    result
+  end
+
+  # Escapes LaTex special characters in text so that they wont be interpreted as LaTex commands.
+  #
+  # This method will use RedCloth to do the escaping if available.
+  def self.escape_latex(text)
+    # :stopdoc:
+    unless @latex_escaper
+      if defined?(RedCloth::Formatters::LATEX)
+        class << (@latex_escaper=RedCloth.new(''))
+          include RedCloth::Formatters::LATEX
+        end
+      else
+        class << (@latex_escaper=Object.new)
+          ESCAPE_RE=/([{}_$&%#])|([\\^~|<>])/
+          ESC_MAP={
+            '\\' => 'backlash',
+            '^' => 'asciicircum',
+            '~' => 'asciitilde',
+            '|' => 'bar',
+            '<' => 'less',
+            '>' => 'greater',
+          }
+
+          def latex_esc(text)   # :nodoc:
+            text.gsub(ESCAPE_RE) {|m|
+              if $1
+                "\\#{m}"
+              else
+                "\\text#{ESC_MAP[m]}{}"
+              end
+            }
+          end
+        end
+      end
+      # :startdoc:
+    end
+
+    @latex_escaper.latex_esc(text.to_s).html_safe
+  end
+
+end

data/lib/rails-latex.rb

@@ -0,0 +1 @@
+require 'erb_latex'

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+class Test::Unit::TestCase
+end

data/test/test_doc.tex

@@ -0,0 +1,5 @@
+\documentclass{article}
+
+\begin{document}
+hello world
+\end{document}

data/test/test_latex_to_pdf.rb

@@ -0,0 +1,23 @@
+require 'helper'
+require 'erb_latex'
+require 'ostruct'
+
+Rails=OpenStruct.new(:root => File.dirname(TMP_DIR=File.expand_path(File.dirname(__FILE__),'tmp')))
+
+class TestLatexToPdf < Test::Unit::TestCase
+  def test_escape
+    assert_equal "dsf \\textless{} \\textgreater{} \\& ! @ \\# \\$ \\% \\textasciicircum{} \\textasciitilde{} \\textbacklash{} fds", LatexToPdf.escape_latex('dsf < > & ! @ # $ % ^ ~ \\ fds')
+    LatexToPdf.instance_eval{@latex_escaper=nil}
+    require 'redcloth'
+    assert_equal "dsf \\textless{} \\textgreater{} \\& ! @ \\# \\$ \\% \\^{} \\~{} \\textbackslash{} fds", LatexToPdf.escape_latex('dsf < > & ! @ # $ % ^ ~ \\ fds')
+  end
+
+  def test_generate_pdf
+    FileUtils.mkdir_p(TMP_DIR)
+    File.open(pdf_file=File.join(TMP_DIR,'out.pdf'),'wb') do |wio|
+      wio.write(LatexToPdf.generate_pdf(IO.read(File.expand_path(File.dirname(__FILE__),'test_doc.tex'))))
+    end
+    assert_equal "hello world\n\n1\n\n\f", `pdftotext #{pdf_file} -`
+    assert_equal [], Dir["#{TMP_DIR}/rails-latex/*"]
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: rails-latex
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Geoff Jacobsen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-07 00:00:00 +12:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta3
+        version: 3.0.0.beta3
+  type: :runtime
+  version_requirements: *id001
+description: rails-latex is a renderer for rails 3 which allows tex files with erb to be turned into an inline pdf.
+email: geoffjacobsen@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- MIT-LICENSE
+- lib/erb_latex.rb
+- lib/latex_to_pdf.rb
+- lib/rails-latex.rb
+- test/helper.rb
+- test/test_doc.tex
+- test/test_latex_to_pdf.rb
+- README.rdoc
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- --main=README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A LaTeX to pdf rails 3 renderer.
+test_files: 
+- test/test_latex_to_pdf.rb
+- test/helper.rb