rtex 1.99.0

data/tasks/setup.rb

@@ -0,0 +1,205 @@
+# $Id$
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+require 'ostruct'
+
+PROJ = OpenStruct.new
+
+PROJ.name = nil
+PROJ.summary = nil
+PROJ.description = nil
+PROJ.changes = nil
+PROJ.authors = nil
+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.release_name = ENV['RELEASE']
+PROJ.history_file = 'HISTORY.rdoc'
+PROJ.manifest_file = 'Manifest.txt'
+PROJ.readme_file = 'README.rdoc'
+
+# Test::Unit
+PROJ.tests = FileList['test/**/*_test.rb']
+PROJ.test_file = 'test/all.rb'
+PROJ.test_opts = []
+
+# Rcov
+PROJ.rcov_dir = 'coverage'
+PROJ.rcov_opts = ['--sort', 'coverage', '-T']
+PROJ.rcov_threshold = 90.0
+PROJ.rcov_threshold_exact = false
+
+# Rdoc
+PROJ.rdoc_opts = []
+PROJ.rdoc_include = %w(^lib/ ^bin/ ^ext/ .txt$)
+PROJ.rdoc_exclude = %w(extconf.rb$)
+PROJ.rdoc_main = nil
+PROJ.rdoc_dir = 'doc'
+PROJ.rdoc_remote_dir = nil
+
+# Gem Packaging
+PROJ.files = nil
+PROJ.executables = nil
+PROJ.dependencies = []
+PROJ.need_tar = true
+PROJ.need_zip = false
+PROJ.post_install_message = nil
+
+# Announce
+PROJ.ann_file = 'announcement.txt'
+PROJ.ann_text = nil
+PROJ.ann_paragraphs = []
+PROJ.ann_email = {
+  :from     => nil,
+  :to       => %w(ruby-talk@ruby-lang.org),
+  :server   => 'localhost',
+  :port     => 25,
+  :domain   => ENV['HOSTNAME'],
+  :acct     => nil,
+  :passwd   => nil,
+  :authtype => :plain
+}
+
+# Load the other rake files in the tasks folder
+rakefiles = Dir.glob('tasks/*.rake').sort
+rakefiles.unshift(rakefiles.delete('tasks/post_load.rake')).compact!
+import(*rakefiles)
+
+# Setup some constants
+WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
+
+DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+
+def quiet( &block )
+  io = [STDOUT.dup, STDERR.dup]
+  STDOUT.reopen DEV_NULL
+  STDERR.reopen DEV_NULL
+  block.call
+ensure
+  STDOUT.reopen io.first
+  STDERR.reopen io.last
+end
+
+DIFF = if WIN32 then 'diff.exe'
+       else
+         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
+         else 'diff' end
+       end unless defined? DIFF
+
+SUDO = if WIN32 then ''
+       else
+         if quiet {system 'which sudo'} then 'sudo'
+         else '' end
+       end
+
+RCOV = WIN32 ? 'rcov.bat' : 'rcov'
+GEM  = WIN32 ? 'gem.bat'  : 'gem'
+
+%w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
+  begin
+    require lib
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
+  rescue LoadError
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
+  end
+end
+
+# Reads a file at +path+ and spits out an array of the +paragraphs+
+# specified.
+#
+#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+#
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
+end
+
+# Adds the given gem _name_ to the current project's dependency list. An
+# optional gem _version_ can be given. If omitted, the newest gem version
+# will be used.
+#
+def depend_on( name, version = nil )
+  spec = Gem.source_index.find_name(name).last
+  version = spec.version.to_s if version.nil? and !spec.nil?
+
+  PROJ.dependencies << case version
+    when nil; [name]
+    when %r/^\d/; [name, ">= #{version}"]
+    else [name, version] end
+end
+
+# Adds the given arguments to the include path if they are not already there
+#
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
+end
+
+# Find a rake task using the task name and remove any description text. This
+# will prevent the task from being displayed in the list of available tasks.
+#
+def remove_desc_for_task( names )
+  Array(names).each do |task_name|
+    task = Rake.application.tasks.find {|t| t.name == task_name}
+    next if task.nil?
+    task.instance_variable_set :@comment, nil
+  end
+end
+
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
+# Scans the current working directory and creates a list of files that are
+# candidates to be in the manifest.
+#
+def manifest_files
+  files = []
+  exclude = Regexp.new(PROJ.exclude.join('|'))
+  Find.find '.' do |path|
+    path.sub! %r/^(\.\/|\/)/o, ''
+    next unless test ?f, path
+    next if path =~ exclude
+    files << path
+  end
+  files.sort!
+end
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,38 @@
+# $Id$
+
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test(?f, PROJ.test_file) then [PROJ.test_file]
+                   else PROJ.tests end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test_opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov_opts.dup << '-o' << PROJ.rcov_dir
+      opts = opts.join(' ')
+      files = if test(?f, PROJ.test_file) then [PROJ.test_file]
+              else PROJ.tests end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+# EOF

data/test/document_test.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) << '/test_helper'
+
+context "Document Generation" do
+  
+  def setup
+    change_tmpdir_for_testing
+  end
+  
+  specify "documents have a to_pdf method" do
+    assert document(:first).respond_to?(:to_pdf)
+  end
+  
+  specify "can escape characters" do
+    assert_equal '\textbackslash{}\textasciitilde{}', RTeX::Document.escape('\~')
+  end
+  
+  specify "documents can use a to_pdf block to move a file to a relative path" do
+    begin
+      path = File.expand_path(File.dirname(__FILE__) << '/tmp/this_is_relative_to_pwd.pdf')
+      document(:first).to_pdf do |filename|
+        assert_nothing_raised do
+          FileUtils.move filename, path
+        end
+        assert File.exists?(path)
+      end
+    ensure
+      FileUtils.rm path rescue nil
+    end
+  end
+  
+  specify "can generate PDF and return as a string" do
+    @author = 'Foo'
+    assert_equal '%PDF', document(:first).to_pdf(binding)[0, 4]
+  end
+  
+  specify "can generate TeX source and return as a string with debug option" do
+    @author = 'Foo'
+    assert_not_equal '%PDF', document(:first, :tex => true).to_pdf(binding)[0, 4]    
+  end
+  
+  specify "can generate PDF and give access to file directly" do
+    @author = 'Foo'
+    data_read = nil
+    invocation_result = document(:first).to_pdf(binding) do |filename|
+      data_read = File.open(filename, 'rb') { |f| f.read }
+      :not_the_file_contents
+    end
+    assert_equal '%PDF', data_read[0, 4]
+    assert_equal :not_the_file_contents, invocation_result
+  end
+  
+  specify "can generate TeX source and give access to file directly" do
+    @author = 'Foo'
+    data_read = nil
+    invocation_result = document(:first, :tex => true).to_pdf(binding) do |filename|
+      data_read = File.open(filename, 'rb') { |f| f.read }
+      :not_the_file_contents
+    end
+    assert_not_equal '%PDF', data_read[0, 4]
+    assert_equal :not_the_file_contents, invocation_result
+  end
+  
+  specify "can wrap in a layout using `yield'" do
+    doc = document(:fragment, :layout => 'testing_layout[<%= yield %>]')
+    @name = 'ERB'
+    source = doc.source(binding)
+    assert source =~ /^testing_layout.*?ERB, Fragmented/
+  end
+  
+end

data/test/filter_test.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) << '/test_helper'
+
+context "Filtering Documents" do
+  
+  specify "can filter through textile" do
+    doc = document('text.textile', :filter => 'textile')
+    source = doc.source(binding)
+    assert source.include?('\item')
+  end
+  
+  specify "does not affect layouts" do
+    doc = document('text.textile',
+            :filter => 'textile',
+            :layout => "* layout\n* is\n<%= yield %>")
+    source = doc.source(binding)
+    assert source.include?("* layout"), "filtered layout"
+    assert source.include?('\item'), "didn't filter content"
+  end
+
+end

data/test/fixtures/first.tex

@@ -0,0 +1,50 @@
+% 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{Joe Student}
+\date{\today}
+
+\begin{document}
+
+\maketitle
+
+\abstract{This is a very simple example of using \LaTeX\ for typesetting.
+The procedure for typesetting equations is introduced.}
+\begin{sdsd}
+\end{bar}
+
+\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/fixtures/first.tex.erb

@@ -0,0 +1,48 @@
+% 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{<%= @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/fixtures/fragment.tex.erb

@@ -0,0 +1 @@
+\par <%= @name %>, Fragmented

data/test/fixtures/text.textile

@@ -0,0 +1,4 @@
+This is a list:
+* One
+* Two
+* _three_