artex 2.1.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+v2.1.0
+
+ Forked from RTeX 2.1.0.

data/Manifest

@@ -0,0 +1,25 @@
+CHANGELOG
+Manifest
+README.rdoc
+Rakefile
+artex.gemspec
+init.rb
+lib/artex.rb
+lib/artex/document.rb
+lib/artex/escaping.rb
+lib/artex/framework/merb.rb
+lib/artex/framework/rails.rb
+lib/artex/pdf.rb
+lib/artex/tempdir.rb
+lib/artex/version.rb
+rails/init.rb
+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
+vendor/instiki/LICENSE
+vendor/instiki/redcloth_for_tex.rb

data/README.rdoc

@@ -0,0 +1,46 @@
+= ArTeX: TeX/PDF Generation for Ruby
+
+Project homepage (FAQ, manual, documentation, contact info): http://github.com/avarteq/artex
+
+Source repository at: http://github.com/avarteq/artex
+
+== Dependencies
+
+* pdflatex executable, available in modern teTeX distributions
+* Requires Ruby
+
+== Motivation
+This gem has been forked from the rtex gem (http://github.com/bruce/rtex).
+RTeX can be used either as stand alone executable or as a rails plugin.
+Using it as rails plugin means to create PDF files using the rails rendering engine.
+This will bring you in trouble if you don't want to generate your PDF files within controllers.
+In contrast to that ArTeX has no dependencies on ActionPack and thus can also be used in models.
+
+We'll keep on updating the gem and we'll try to provide some examples in the future.
+Besides of that the code will be iteratively cut down, rewritten and enhanced.
+
+ 
+== License
+
+  (The MIT License)
+
+  Copyright (c) 2006-2010 Bruce Williams, Wiebe Cazemier, Julian Fischer
+
+  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/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'echoe'
+
+require File.dirname(__FILE__) << "/lib/artex/version"
+
+Echoe.new 'artex' do |p|
+  p.version = ArTeX::Version::STRING
+  p.author = ['Bruce Williams', 'Wiebe Cazemier', 'Julian Fischer']
+  p.email  = 'artex@avarteq.de'
+  p.project = 'artex'
+  p.summary = "LaTeX preprocessor for PDF generation; Rails plugin"
+  p.url = "http://github.com/avarteq/artex"
+  p.include_rakefile = true
+  p.development_dependencies = %w(Shoulda echoe)
+  p.rcov_options = '--exclude gems --exclude version.rb --sort coverage --text-summary --html -o coverage'
+  p.ignore_pattern = /^(pkg|doc|site)|\.svn|CVS|\.bzr|\.DS|\.git/
+  p.rubygems_version = nil
+end
+
+task :coverage do
+  system "open coverage/index.html" if PLATFORM['darwin']
+end

data/artex.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{artex}
+  s.version = "2.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bruce Williams, Wiebe Cazemier, Julian Fischer"]
+  s.date = %q{2010-04-19}
+  s.description = %q{LaTeX preprocessor for PDF generation; Rails plugin}
+  s.email = %q{artex@avarteq.de}
+  s.extra_rdoc_files = ["CHANGELOG", "README.rdoc", "lib/artex.rb", "lib/artex/document.rb", "lib/artex/escaping.rb", "lib/artex/framework/merb.rb", "lib/artex/framework/rails.rb", "lib/artex/pdf.rb", "lib/artex/tempdir.rb", "lib/artex/version.rb"]
+  s.files = ["CHANGELOG", "Manifest", "README.rdoc", "Rakefile", "artex.gemspec", "init.rb", "lib/artex.rb", "lib/artex/document.rb", "lib/artex/escaping.rb", "lib/artex/framework/merb.rb", "lib/artex/framework/rails.rb", "lib/artex/pdf.rb", "lib/artex/tempdir.rb", "lib/artex/version.rb", "rails/init.rb", "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", "vendor/instiki/LICENSE", "vendor/instiki/redcloth_for_tex.rb"]
+  s.homepage = %q{http://github.com/avarteq/artex}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Artex", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{artex}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{LaTeX preprocessor for PDF generation; Rails plugin}
+  s.test_files = ["test/document_test.rb", "test/filter_test.rb", "test/tempdir_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<Shoulda>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<Shoulda>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<Shoulda>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) << "/rails/init"

data/lib/artex.rb

@@ -0,0 +1,31 @@
+$:.unshift(File.dirname(__FILE__) << '/artex')
+
+require 'document'
+require 'version'
+require 'pdf'
+
+module ArTeX
+  
+  def self.filters #:nodoc:
+    @filters ||= {}
+  end
+  
+  def self.basic_layout #:nodoc:
+    "\\documentclass[12pt]{article}\n\\begin{document}\n<%= yield %>\n\\end{document}"
+  end
+  
+  # Define a processing filter
+  # call-seq:
+  #   filter(:name) { |text_to_transform| ... } # => result
+  def self.filter(name, &block)
+    filters[name.to_s] = block
+  end
+  
+  filter :textile do |source|
+    require File.dirname(__FILE__) << '/../vendor/instiki/redcloth_for_tex'
+    RedClothForTex.new(source).to_tex
+  end
+  
+end
+
+

data/lib/artex/document.rb

@@ -0,0 +1,175 @@
+require 'erb'
+require 'ostruct'
+require 'tmpdir'
+
+require 'escaping'
+require 'tempdir'
+
+module ArTeX
+  
+  class Document
+    
+    extend Escaping
+        
+    class FilterError < ::StandardError; end
+    class GenerationError < ::StandardError; end
+    class ExecutableNotFoundError < ::StandardError; end
+    
+    # Default options
+    # [+:preprocess+] Are we preprocessing? Default is +false+
+    # [+:preprocessor+] Executable to use during preprocessing (generating TOCs, etc). Default is +latex+
+    # [+:shell_redirect+] Option redirection for shell output (eg, +"> /dev/null 2>&1"+ ). Default is +nil+.
+    # [+:tmpdir+] Location of temporary directory (default: +Dir.tmpdir+)
+    def self.options
+      @options ||= {
+        :preprocessor => 'latex',
+        :preprocess => false,
+        :processor => 'pdflatex',
+        # 
+        :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
+    
+    # Get the source for the entire 
+    def source(binding=nil) #:nodoc:
+      @source ||= wrap_in_layout do
+        filter @erb.result(binding)
+      end
+    end
+    
+    # Process through defined filter
+    def filter(text) #:nodoc:
+      return text unless @options[:filter]
+      if (process = ArTeX.filters[@options[:filter]])
+        process[text]
+      else
+        raise FilterError, "No `#{@options[:filter]}' filter"
+      end
+    end
+    
+    # Wrap content in optional layout
+    def wrap_in_layout #:nodoc:
+      if @options[:layout]
+        ERB.new(@options[:layout]).result(binding)
+      else
+        yield
+      end
+    end
+    
+    # Generate PDF from 
+    # call-seq:
+    #   to_pdf # => PDF in a String
+    #   to_pdf { |filename| ... }
+    def to_pdf(binding=nil, &file_handler)
+      process_pdf_from(source(binding), &file_handler)
+    end
+    
+    def processor #:nodoc:
+      @processor ||= check_path_for @options[:processor]
+    end
+    
+    def preprocessor #:nodoc:
+      @preprocessor ||= check_path_for @options[:preprocessor]
+    end
+    
+    def system_path #:nodoc:
+      ENV['PATH']
+    end
+        
+    #######
+    private
+    #######
+    
+    # Verify existence of executable in search path
+    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
+    
+    # Basic processing
+    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!
+      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

data/lib/artex/escaping.rb

@@ -0,0 +1,28 @@
+module ArTeX
+  
+  module Escaping
+    
+    # Escape text using +replacements+
+    def escape(text)
+      replacements.inject(text.to_s) do |corpus, (pattern, replacement)|
+        corpus.gsub(pattern, replacement)
+      end
+    end
+    
+    # List of replacements
+    def replacements
+      @replacements ||= [
+        [/([{}])/,    '\\\\\1'],
+        [/\\/,        '\textbackslash{}'],
+        [/\^/,        '\textasciicircum{}'],
+        [/~/,         '\textasciitilde{}'],
+        [/\|/,        '\textbar{}'],
+        [/\</,        '\textless{}'],
+        [/\>/,        '\textgreater{}'],
+        [/([_$&%#])/, '\\\\\1']
+      ]
+    end
+    
+  end
+  
+end

data/lib/artex/framework/merb.rb

@@ -0,0 +1,13 @@
+module ArTeX
+  
+  module Framework #:nodoc:
+    
+    module Merb #:nodoc:
+      
+      # TODO
+      
+    end
+    
+  end
+  
+end

data/lib/artex/framework/rails.rb

@@ -0,0 +1,28 @@
+require 'tempfile'
+
+module ArTeX
+  module Framework #:nodoc:   
+    module Rails #:nodoc:
+      
+      def self.setup
+        ArTeX::Document.options[:tempdir] = File.expand_path(File.join(RAILS_ROOT, 'tmp'))
+      end
+            
+      module HelperMethods
+        # Similar to h()
+        def latex_escape(*args)
+          # Since Rails' I18n implementation aliases l() to localize(), LaTeX
+          # escaping should only be done if ArTeX is doing the rendering.
+          # Otherwise, control should be be passed to localize().
+          if Thread.current[:_rendering_rtex]
+            ArTeX::Document.escape(*args)
+          else
+            localize(*args)
+          end
+        end
+        alias :l :latex_escape
+      end
+      
+    end
+  end
+end

data/lib/artex/pdf.rb

@@ -0,0 +1,81 @@
+#TODO Translate comments.
+module ArTeX
+  class PDF  
+    
+    # Wir bilden das Verhalten von render :partial nach.
+    # So wird die Abhängigkeit zu ActionView aufgelöst.
+    # Dabei gehen sicherlich Möglichkeiten verloren, die hier aber auch nicht benötigt werden.
+    # Ziel ist die Verlagerung der PDF-Generierung aus dem Controller in Klassen bzw. Models,
+    # so dass dies auch im Hintergrund erfolgen kann.
+    #
+    # === Beispiele
+    #   render :partial => "layouts/brandings/#{@bill.branding.template_name}"
+    #   render :partial => 'bills/form/billing_position/_billing_position.pdf.rtex', :collection => @bill.billing_positions
+    def render(options = {})
+      content = ""
+
+      # Relativer Pfad zum Template
+      # z.B. 'bills/form/billing_position/_billing_position.pdf.rtex'
+      template_name = get_template_name_from_partial_name(options[:partial])
+
+      if is_collection?(options) then
+        content = render_collection(options[:collection], binding, template_name)
+      else
+        content = render_to_latex(binding, template_name)
+      end
+      return content
+    end
+
+    def is_collection?(options)
+      options[:collection] && options[:collection].is_a?(Array)    
+    end
+
+    def render_collection(collection, binding, template_name)
+      content = ""
+      
+      #TODO refactor
+      collection.each do |billing_position|      
+          @billing_position = billing_position
+          latex = render_to_latex(binding, template_name)        
+          content += latex
+      end
+      return content
+    end
+
+    # 'bills/form/billing_position/_billing_position.pdf.rtex' -> 'bills/form/billing_position/_billing_position.pdf.rtex'
+    def get_template_name_from_partial_name(partial_name)
+      parts = partial_name.split(/\//)
+
+      # "_" vor das letzte Element setzen.
+      parts[-1] = "_" + parts.last
+      template_name = parts.join("/")
+      template_name
+    end
+
+    def render_to_latex(binding, path)
+      template_path = get_template_path(path)
+      template = File.read(template_path)
+
+      latex_code = ERB.new(template).result(binding)
+      return latex_code
+    end
+
+    # Nimmt Latex und schreibt ein PDF. Gibt den Pfad zum PDF zurück.
+      def latex_to_pdf(latex_content)
+        pdf_file = ""
+        ::ArTeX::Document.new(latex_content, {:process => true} ).to_pdf do |filename|
+          pdf_file = Tempfile.new('artex-pdf')
+          FileUtils.mv filename, pdf_file.path
+        end
+        return pdf_file.path
+      end
+    
+    def get_template_path(path)
+      raise "unimplemented"
+    end
+    
+    def l(*args)
+      return ArTeX::Document.escape(*args)
+    end
+  end  
+end