rtex 1.99.0 → 2.0.0

data/Manifest.txt

@@ -16,6 +16,7 @@ tasks/doc.rake
 tasks/gem.rake
 tasks/manifest.rake
 tasks/post_load.rake
+tasks/rubyforge.rake
 tasks/setup.rb
 tasks/test.rake
 test/document_test.rb
@@ -26,8 +27,5 @@ 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

@@ -1,9 +1,8 @@
 = RTeX: TeX/PDF Generation for Ruby
 
-Project homepage: http://rtex.rubyforge.org
+Project homepage (FAQ, manual, documentation, contact info): http://rtex.rubyforge.org
 
-Please file comments and bug reports at http://rubyforge.org/projects/rtex
-(in the Forum and the Tracker, respectively).
+Source repository at: http://github.com/bruce/rtex
 
 == Dependencies
 

data/Rakefile

@@ -12,6 +12,9 @@ PROJ.libs = %w[]
 PROJ.ruby_opts = []
 PROJ.test_opts = []
 
+PROJ.rdoc_main = 'README.rdoc'
+PROJ.rdoc_include.push 'README.rdoc', 'README_RAILS.rdoc'
+
 PROJ.description = "LaTeX preprocessor for PDF generation; Rails plugin"
 PROJ.summary = PROJ.description
 

data/lib/rtex.rb

@@ -4,25 +4,29 @@ require 'document'
 require 'version'
 
 module RTeX
-    
+  
+  # Load code to initialize RTeX for framework 
   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.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
   
-  def self.filters #:nodoc:
-    @filters ||= {}
-  end
-  
   filter :textile do |source|
     require File.dirname(__FILE__) << '/../vendor/instiki/redcloth_for_tex'
     RedClothForTex.new(source).to_tex

data/lib/rtex/document.rb

@@ -16,12 +16,17 @@ module RTeX
     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',
-        # Option redirection for shell output (eg, set to  '> /dev/null 2>&1' )
+        # 
         :shell_redirect => nil,
         # Temporary Directory
         :tempdir => Dir.tmpdir
@@ -37,13 +42,15 @@ module RTeX
       end
     end
     
-    def source(binding=nil)
+    # Get the source for the entire 
+    def source(binding=nil) #:nodoc:
       @source ||= wrap_in_layout do
         filter @erb.result(binding)
       end
     end
     
-    def filter(text)
+    # Process through defined filter
+    def filter(text) #:nodoc:
       return text unless @options[:filter]
       if (process = RTeX.filters[@options[:filter]])
         process[text]
@@ -52,7 +59,8 @@ module RTeX
       end
     end
     
-    def wrap_in_layout
+    # Wrap content in optional layout
+    def wrap_in_layout #:nodoc:
       if @options[:layout]
         ERB.new(@options[:layout]).result(binding)
       else
@@ -60,19 +68,23 @@ module RTeX
       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
+    def processor #:nodoc:
       @processor ||= check_path_for @options[:processor]
     end
     
-    def preprocessor
+    def preprocessor #:nodoc:
       @preprocessor ||= check_path_for @options[:preprocessor]
     end
     
-    def system_path
+    def system_path #:nodoc:
       ENV['PATH']
     end
         
@@ -80,6 +92,7 @@ module RTeX
     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
@@ -87,6 +100,7 @@ module RTeX
       command
     end
     
+    # Basic processing
     def process_pdf_from(input, &file_handler)
       Tempdir.open(@options[:tempdir]) do |tempdir|
         prepare input
@@ -103,7 +117,7 @@ module RTeX
       end
     end
     
-    def process! #:nodoc:
+    def process!
       unless `#{processor} --interaction=nonstopmode '#{source_file}' #{@options[:shell_redirect]}`
         raise GenerationError, "Could not generate PDF using #{processor}"      
       end

data/lib/rtex/escaping.rb

@@ -2,12 +2,14 @@ module RTeX
   
   module Escaping
     
+    # Escape text using +replacements+
     def escape(text)
       replacements.inject(text) do |corpus, (pattern, replacement)|
         corpus.gsub(pattern, replacement)
       end
     end
     
+    # List of replacements
     def replacements
       @replacements ||= [
         [/([{}])/,    '\\\1'],

data/lib/rtex/framework/merb.rb

@@ -1,8 +1,8 @@
 module RTeX
   
-  module Framework
+  module Framework #:nodoc:
     
-    module Merb
+    module Merb #:nodoc:
       
       # TODO
       

data/lib/rtex/framework/rails.rb

@@ -1,8 +1,8 @@
 require 'tempfile'
 
 module RTeX
-  module Framework    
-    module Rails
+  module Framework #:nodoc:   
+    module Rails #:nodoc:
       
       def self.setup
         RTeX::Document.options[:tempdir] = File.expand_path(File.join(RAILS_ROOT, 'tmp'))

data/lib/rtex/tempdir.rb

@@ -2,7 +2,7 @@ require 'fileutils'
 
 module RTeX
   
-  class Tempdir
+  class Tempdir #:nodoc:
         
     def self.open(parent_path=RTeX::Document.options[:tempdir])
       tempdir = new(parent_path)

data/lib/rtex/version.rb

@@ -63,12 +63,10 @@ module RTeX
       [@major, @minor, @tiny]
     end
 
-    MAJOR = 1
-    MINOR = 99
+    MAJOR = 2
+    MINOR = 0
     TINY  = 0
     
-    DESCRIPTION = '2.0 Preview 1' 
-
     # The current version as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)
     # The current version as a String

data/tasks/rubyforge.rake

@@ -0,0 +1,57 @@
+# $Id$
+
+if PROJ.rubyforge_name && HAVE_RUBYFORGE
+
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => [:clobber, :package] do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+    pkg = "pkg/#{PROJ.spec.full_name}"
+
+    if $DEBUG then
+      puts "release_id = rf.add_release #{PROJ.rubyforge_name.inspect}, #{PROJ.name.inspect}, #{PROJ.version.inspect}, \"#{pkg}.tgz\""
+      puts "rf.add_file #{PROJ.rubyforge_name.inspect}, #{PROJ.name.inspect}, release_id, \"#{pkg}.gem\""
+    end
+
+    rf = RubyForge.new
+    puts 'Logging in'
+    rf.login
+
+    c = rf.userconfig
+    c['release_notes'] = PROJ.description if PROJ.description
+    c['release_changes'] = PROJ.changes if PROJ.changes
+    c['preformatted'] = true
+
+    files = [(PROJ.need_tar ? "#{pkg}.tgz" : nil),
+             (PROJ.need_zip ? "#{pkg}.zip" : nil),
+             "#{pkg}.gem"].compact
+
+    puts "Releasing #{PROJ.name} v. #{PROJ.version}"
+    rf.add_release PROJ.rubyforge_name, PROJ.name, PROJ.version, *files
+  end
+end  # namespace :gem
+
+
+namespace :doc do
+  desc "Publish RDoc to RubyForge"
+  task :release => %w(doc:clobber_rdoc doc:rdoc) do
+    config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge_name}/"
+    remote_dir << PROJ.rdoc_remote_dir if PROJ.rdoc_remote_dir
+    local_dir = PROJ.rdoc_dir
+
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end  # namespace :doc
+
+end  # if HAVE_RUBYFORGE
+
+# EOF

data/tasks/setup.rb

@@ -17,7 +17,7 @@ PROJ.email = nil
 PROJ.url = nil
 PROJ.version = ENV['VERSION'] || '0.0.0'
 PROJ.rubyforge_name = nil
-PROJ.exclude = %w(tmp$ bak$ ~$ CVS site .svn/ ^pkg/ ^doc/ ^\. ^rails-example/)
+PROJ.exclude = %w(tmp$ bak$ ~$ CVS site .svn/ ^pkg/ ^doc/ ^\. ^rails-example/ ^test/tmp)
 PROJ.release_name = ENV['RELEASE']
 PROJ.history_file = 'HISTORY.rdoc'
 PROJ.manifest_file = 'Manifest.txt'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rtex
 version: !ruby/object:Gem::Version 
-  version: 1.99.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Bruce Williams
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-24 00:00:00 -05:00
+date: 2008-05-06 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -22,6 +22,8 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- README.rdoc
+- README_RAILS.rdoc
 - bin/rtex
 files: 
 - HISTORY.rdoc
@@ -42,6 +44,7 @@ files:
 - tasks/gem.rake
 - tasks/manifest.rake
 - tasks/post_load.rake
+- tasks/rubyforge.rake
 - tasks/setup.rb
 - tasks/test.rake
 - test/document_test.rb
@@ -52,9 +55,6 @@ files:
 - 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
 has_rdoc: true

data/test/tmp/rtex-071EE944-B2FA-4A3B-9764-1B5143833EB7/document.tex

@@ -1,48 +0,0 @@
-% This percent indicates a comment.
-% This is a very simple latex article that introduces the way 
-% equations are typeset.  Do this in linux:
-%
-% latex first.tex
-% latex first.tex
-% xdvi first.dvi
-% dvips -o first.ps first.dvi
-% gv first.ps
-% lpr first.ps
-% pdflatex first.tex
-% acroread first.pdf
-\documentclass[12pt]{article}
-\title{First \LaTeX} 
-\author{Foo}
-\date{\today}
-
-\begin{document}
-
-\maketitle
-
-\abstract{This is a very simple example of using \LaTeX\ for typesetting.
-The procedure for typesetting equations is introduced.}
-
-\section{A few equations}
-Equations can be typeset inline like so: $\vec{F}=m\vec{a}$ .
-Equations can also be separated form the text: $$ \vec{F}=m\vec{a} \ . $$
-Notice the punctuation, the ``.'', had to be included with the equation. 
-Equations can also have a number assigned and a label attached,
-as in the following:
-\begin{equation}
-\frac{D\vec{\omega}}{Dt} =
-( \vec{\omega} + \vec{\Omega}) \cdot \nabla  \vec{U}
-+ \frac{1}{\rho^2} \nabla \rho \times \nabla p 
-+ \nu \nabla^2  \vec{\omega} 
-\label{vorteq}
-\end{equation}
-The vorticity equation (\ref{vorteq}) is referenced by label,
-not by number.  The numbers may change as the document grows and
-more equations are added.
-
-New paragraphs are indicated with a blank line in the source code.
-
-\section{The End}
-
-Further examples of \LaTeX\ can be found at {\tt it.metr.ou.edu}
-
-\end{document}

data/test/tmp/rtex-592F93A7-6198-4B00-B638-33855344A29B/document.tex

@@ -1,48 +0,0 @@
-% This percent indicates a comment.
-% This is a very simple latex article that introduces the way 
-% equations are typeset.  Do this in linux:
-%
-% latex first.tex
-% latex first.tex
-% xdvi first.dvi
-% dvips -o first.ps first.dvi
-% gv first.ps
-% lpr first.ps
-% pdflatex first.tex
-% acroread first.pdf
-\documentclass[12pt]{article}
-\title{First \LaTeX} 
-\author{}
-\date{\today}
-
-\begin{document}
-
-\maketitle
-
-\abstract{This is a very simple example of using \LaTeX\ for typesetting.
-The procedure for typesetting equations is introduced.}
-
-\section{A few equations}
-Equations can be typeset inline like so: $\vec{F}=m\vec{a}$ .
-Equations can also be separated form the text: $$ \vec{F}=m\vec{a} \ . $$
-Notice the punctuation, the ``.'', had to be included with the equation. 
-Equations can also have a number assigned and a label attached,
-as in the following:
-\begin{equation}
-\frac{D\vec{\omega}}{Dt} =
-( \vec{\omega} + \vec{\Omega}) \cdot \nabla  \vec{U}
-+ \frac{1}{\rho^2} \nabla \rho \times \nabla p 
-+ \nu \nabla^2  \vec{\omega} 
-\label{vorteq}
-\end{equation}
-The vorticity equation (\ref{vorteq}) is referenced by label,
-not by number.  The numbers may change as the document grows and
-more equations are added.
-
-New paragraphs are indicated with a blank line in the source code.
-
-\section{The End}
-
-Further examples of \LaTeX\ can be found at {\tt it.metr.ou.edu}
-
-\end{document}

data/test/tmp/rtex-96736595-5175-4602-9DC1-ABA096CC0E3D/document.tex

@@ -1,48 +0,0 @@
-% This percent indicates a comment.
-% This is a very simple latex article that introduces the way 
-% equations are typeset.  Do this in linux:
-%
-% latex first.tex
-% latex first.tex
-% xdvi first.dvi
-% dvips -o first.ps first.dvi
-% gv first.ps
-% lpr first.ps
-% pdflatex first.tex
-% acroread first.pdf
-\documentclass[12pt]{article}
-\title{First \LaTeX} 
-\author{Foo}
-\date{\today}
-
-\begin{document}
-
-\maketitle
-
-\abstract{This is a very simple example of using \LaTeX\ for typesetting.
-The procedure for typesetting equations is introduced.}
-
-\section{A few equations}
-Equations can be typeset inline like so: $\vec{F}=m\vec{a}$ .
-Equations can also be separated form the text: $$ \vec{F}=m\vec{a} \ . $$
-Notice the punctuation, the ``.'', had to be included with the equation. 
-Equations can also have a number assigned and a label attached,
-as in the following:
-\begin{equation}
-\frac{D\vec{\omega}}{Dt} =
-( \vec{\omega} + \vec{\Omega}) \cdot \nabla  \vec{U}
-+ \frac{1}{\rho^2} \nabla \rho \times \nabla p 
-+ \nu \nabla^2  \vec{\omega} 
-\label{vorteq}
-\end{equation}
-The vorticity equation (\ref{vorteq}) is referenced by label,
-not by number.  The numbers may change as the document grows and
-more equations are added.
-
-New paragraphs are indicated with a blank line in the source code.
-
-\section{The End}
-
-Further examples of \LaTeX\ can be found at {\tt it.metr.ou.edu}
-
-\end{document}