rtex 1.99.0

data/HISTORY.rdoc

@@ -0,0 +1,29 @@
+2008-04-20
+
+Released RTeX v1.99.0 as a Rubygem, with a standalone executable for PDF generation
+and support for plugin installation from the executable.
+
+This release requires Rails >= 2.0.1
+
+Thanks to:
+* Jonas Bähr for a patch with additional LaTeX escaping
+* Fouad Mardini for a TemplateHandler patch
+
+2007
+
+No active development, maintenance primarily by Wiebe Cazemier
+
+2006-07-27
+
+Added quite a few *long* overdue fixes & enhancements sent in by various people.
+
+* Added latex escaping 'l' method (Thanks, Benjamin Quorning)
+* Added support for @options_for_rtex hash for configuration:
+  * Added :tempdir option, and changed default temporary directory
+    (Thanks, Francesco Levorato)
+  * Added :preprocess option to support running through latex before pdflatex
+    (Thanks Charles Lesburg, Benjamin Quorning)
+  * Moved old @filename setting to :filename option in this hash
+
+If you're using the same settings for @options_for_rtex often, you might want to 
+put your assignment in a before_filter (perhaps overriding :filename, etc in your actions).

data/Manifest.txt

@@ -0,0 +1,33 @@
+HISTORY.rdoc
+Manifest.txt
+README.rdoc
+README_RAILS.rdoc
+Rakefile
+bin/rtex
+init.rb
+lib/rtex.rb
+lib/rtex/document.rb
+lib/rtex/escaping.rb
+lib/rtex/framework/merb.rb
+lib/rtex/framework/rails.rb
+lib/rtex/tempdir.rb
+lib/rtex/version.rb
+tasks/doc.rake
+tasks/gem.rake
+tasks/manifest.rake
+tasks/post_load.rake
+tasks/setup.rb
+tasks/test.rake
+test/document_test.rb
+test/filter_test.rb
+test/fixtures/first.tex
+test/fixtures/first.tex.erb
+test/fixtures/fragment.tex.erb
+test/fixtures/text.textile
+test/tempdir_test.rb
+test/test_helper.rb
+test/tmp/rtex-071EE944-B2FA-4A3B-9764-1B5143833EB7/document.tex
+test/tmp/rtex-592F93A7-6198-4B00-B638-33855344A29B/document.tex
+test/tmp/rtex-96736595-5175-4602-9DC1-ABA096CC0E3D/document.tex
+vendor/instiki/LICENSE
+vendor/instiki/redcloth_for_tex.rb

data/README.rdoc

@@ -0,0 +1,47 @@
+= RTeX: TeX/PDF Generation for Ruby
+
+Project homepage: http://rtex.rubyforge.org
+
+Please file comments and bug reports at http://rubyforge.org/projects/rtex
+(in the Forum and the Tracker, respectively).
+
+== Dependencies
+
+* pdflatex executable, available in modern teTeX distributions
+* Requires Rails >= 2.0.1 if used as a plugin.
+
+== Usage
+
+For use as a standalone executable, see `rtex --help'
+
+For use as a Rails plugin, see README_RAILS.rdoc
+
+== More Information
+
+Additional help may be available at the project homepage,
+http://rtex.rubyforge.org
+
+== License
+
+  (The MIT License)
+
+  Copyright (c) 2006-2008 Bruce Williams, Wiebe Cazemier
+
+  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_RAILS.rdoc

@@ -0,0 +1,45 @@
+= RTeX Rails plugin
+
+== Installation
+
+  sudo gem install rtex
+  rtex --install /path/to/rails/app
+  
+== Dependencies
+
+* Rails >= 2.0.1
+  
+== Usage
+
+Create files +pdf.rtex+ extensions (eg, +index.pdf.rtex+) using standard LaTeX markup.
+
+* Layouts are supported, eg: +application.pdf.rtex+
+* Partials are supported, eg: +_item.pdf.rtex+
+
+=== Example
+
+With the following:
+
+  # app/controllers/items_controller.rb
+  def index
+    @items = Item.find(:all)
+  end
+  
+  # app/views/items/index.pdf.rtex
+  \section*{Items}
+  \begin{itemize}
+  <%= render :partial => @items %>
+  \end{itemize}
+  
+  # app/views/items/_item.pdf.rtex
+  \item <%=l item.name %> \\
+  
+  # app/layouts/application.pdf.rtex
+  \documentclass[12pt]{article}
+  \begin{document}
+  <%= yield %>
+  \end{document}
+
+If you hit +http://the.server.url/items.pdf+, you end up with a nice PDF listing of items.
+
+Obviously a simplistic example.

data/Rakefile

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) << "/lib/rtex/version"
+
+load 'tasks/setup.rb'
+
+PROJ.name = 'rtex'
+PROJ.authors = ['Bruce Williams', 'Wiebe Cazemier']
+PROJ.email = ['bruce@codefluency.com']
+PROJ.url = 'http://rtex.rubyforge.org'
+PROJ.rubyforge_name = 'rtex'
+
+PROJ.libs = %w[]
+PROJ.ruby_opts = []
+PROJ.test_opts = []
+
+PROJ.description = "LaTeX preprocessor for PDF generation; Rails plugin"
+PROJ.summary = PROJ.description
+
+PROJ.version = RTeX::Version::STRING
+
+task 'gem:package' => 'manifest:assert'

data/bin/rtex

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+
+require File.dirname(__FILE__) << '/../lib/rtex'
+
+options = {}
+
+opts = OptionParser.new do |opts|
+  
+  opts.banner = [
+    "RTeX v#{RTeX::Version::STRING} (c) 2006-2007 Bruce Williams, Wiebe Cazemier",
+    "USAGE: rtex [OPTIONS]"
+  ].join("\n")
+  
+  opts.on_tail('-h', '--help', "Show this message") do
+    STDERR.puts opts
+    exit
+  end
+  
+  opts.on('-l LAYOUT', '--layout LAYOUT', 'Path to layout file (use <%= yield %>)') do |layout|
+    if File.exists?(layout)
+      options[:layout] = File.read(layout)
+    else
+      STDERR.puts "Layout file not found: #{layout}"
+      exit 1
+    end
+  end
+  
+  opts.on('-o OUTFILE', '--output OUTFILE', "Output to file (defaults to STDOUT)") do |path|
+    options[:outfile] = path
+  end
+  
+  filters = RTeX.filters.keys.map { |k| k.to_s }.sort.join(', ')
+  opts.on('-f FILTER', '--filter FILTER', "Filter input (supported: #{filters})", "(Wraps in a basic `article' document; use --layout to customize)") do |filter|
+    options[:filter] = filter
+  end
+  
+  opts.on('--no-pdf', "Don't generate PDF (just output TeX)") do
+    options[:tex] = true
+  end
+  
+  opts.on('-i PATH', '--install PATH', "Install as plugin into Rails app at PATH") do |path|
+    unless Dir[plugins = File.join(path, 'vendor/plugins')].any?
+      STDERR.puts "Could not find application at #{path}"
+      exit 1
+    end
+    plugin_path = File.join(plugins, 'rtex')
+    FileUtils.cp_r(File.dirname(__FILE__) << '/..', plugin_path)
+    %w(Rakefile Manifest.txt bin tasks).each do |prune|
+      FileUtils.rm_rf(File.join(plugin_path, prune)) rescue nil
+    end
+    STDERR.puts "Installed at #{plugin_path}"
+    exit
+  end
+  
+end
+opts.parse!(ARGV)
+
+if options[:filter] && !options[:layout]
+  STDERR.puts "Warning: Using default `article' layout (see --help on '--layout')"
+  options[:layout] = RTeX.basic_layout
+end
+
+document = RTeX::Document.new(ARGF.read, options)
+location = File.expand_path(options[:outfile]) rescue nil
+document.to_pdf(nil) do |filename|
+  if location
+    FileUtils.move filename, location
+  else
+    STDOUT.print File.read(filename)
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'rtex'
+RTeX.framework :rails

data/lib/rtex.rb

@@ -0,0 +1,33 @@
+$:.unshift(File.dirname(__FILE__) << '/rtex')
+
+require 'document'
+require 'version'
+
+module RTeX
+    
+  def self.framework(name)
+    require File.dirname(__FILE__) << "/rtex/framework/#{name}"
+    framework = ::RTeX::Framework.const_get(name.to_s.capitalize)
+    framework.setup
+  end
+  
+  def self.basic_layout #:nodoc:
+    "\\documentclass[12pt]{article}\n\\begin{document}\n<%= yield %>\n\\end{document}"
+  end
+  
+  def self.filter(name, &block)
+    filters[name.to_s] = block
+  end
+  
+  def self.filters #:nodoc:
+    @filters ||= {}
+  end
+  
+  filter :textile do |source|
+    require File.dirname(__FILE__) << '/../vendor/instiki/redcloth_for_tex'
+    RedClothForTex.new(source).to_tex
+  end
+  
+end
+
+

data/lib/rtex/document.rb

@@ -0,0 +1,162 @@
+require 'erb'
+require 'ostruct'
+require 'tmpdir'
+
+require 'escaping'
+require 'tempdir'
+
+
+module RTeX
+  
+  class Document
+    
+    extend Escaping
+        
+    class FilterError < ::StandardError; end
+    class GenerationError < ::StandardError; end
+    class ExecutableNotFoundError < ::StandardError; end
+    
+    def self.options
+      @options ||= {
+        :preprocessor => 'latex',
+        :preprocess => false,
+        :processor => 'pdflatex',
+        # Option redirection for shell output (eg, set to  '> /dev/null 2>&1' )
+        :shell_redirect => nil,
+        # Temporary Directory
+        :tempdir => Dir.tmpdir
+      }
+    end
+        
+    def initialize(content, options={})
+      @options = self.class.options.merge(options)
+      if @options[:processed]
+        @source = content
+      else
+        @erb = ERB.new(content)
+      end
+    end
+    
+    def source(binding=nil)
+      @source ||= wrap_in_layout do
+        filter @erb.result(binding)
+      end
+    end
+    
+    def filter(text)
+      return text unless @options[:filter]
+      if (process = RTeX.filters[@options[:filter]])
+        process[text]
+      else
+        raise FilterError, "No `#{@options[:filter]}' filter"
+      end
+    end
+    
+    def wrap_in_layout
+      if @options[:layout]
+        ERB.new(@options[:layout]).result(binding)
+      else
+        yield
+      end
+    end
+    
+    def to_pdf(binding=nil, &file_handler)
+      process_pdf_from(source(binding), &file_handler)
+    end
+    
+    def processor
+      @processor ||= check_path_for @options[:processor]
+    end
+    
+    def preprocessor
+      @preprocessor ||= check_path_for @options[:preprocessor]
+    end
+    
+    def system_path
+      ENV['PATH']
+    end
+        
+    #######
+    private
+    #######
+    
+    def check_path_for(command)
+      unless FileTest.executable?(command) || system_path.split(":").any?{ |path| FileTest.executable?(File.join(path, command))}
+        raise ExecutableNotFoundError, command
+      end
+      command
+    end
+    
+    def process_pdf_from(input, &file_handler)
+      Tempdir.open(@options[:tempdir]) do |tempdir|
+        prepare input
+        if generating?
+          preprocess! if preprocessing?
+          process!
+          verify!
+        end
+        if file_handler
+          yield full_path_in(tempdir.path)
+        else
+          result_as_string
+        end
+      end
+    end
+    
+    def process! #:nodoc:
+      unless `#{processor} --interaction=nonstopmode '#{source_file}' #{@options[:shell_redirect]}`
+        raise GenerationError, "Could not generate PDF using #{processor}"      
+      end
+    end
+    
+    def preprocess!
+      unless `#{preprocessor} --interaction=nonstopmode '#{source_file}' #{@options[:shell_redirect]}`
+        raise GenerationError, "Could not preprocess using #{preprocessor}"      
+      end
+    end
+    
+    def preprocessing?
+      @options[:preprocess]
+    end
+        
+    def source_file
+      @source_file ||= file(:tex)
+    end
+    
+    def log_file
+      @log_file ||= file(:log)
+    end
+    
+    def result_file
+      @result_file ||= file(@options[:tex] ? :tex : :pdf)
+    end
+    
+    def file(extension)
+      "document.#{extension}"
+    end
+    
+    def generating?
+      !@options[:tex]
+    end
+    
+    def verify!
+      unless File.exists?(result_file)
+        raise GenerationError, "Could not find result PDF #{result_file} after generation.\nCheck #{File.expand_path(log_file)}"
+      end
+    end
+    
+    def prepare(input)
+      File.open(source_file, 'wb') { |f| f.puts input }
+    end
+    
+    def result_as_string
+      File.open(result_file, 'rb') { |f| f.read }
+    end
+    
+    def full_path_in(directory)
+      File.expand_path(File.join(directory, result_file))
+    end
+    
+  end
+
+end