erbtex 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6aa6baa55cd84b872ced3ccdd4a2935e5805ae29
+  data.tar.gz: d5c069096815028c9eb786d1cd3920ad5fbe6116
+SHA512:
+  metadata.gz: eab55ecc60a34f11a6bdcd93d70ae8daf6a1c75443534e1913a7ac7495f45a80bed2291dacc8f4129ceef40349c9c7b6291f35d33ed9c8dd77d6ef942f81ca00
+  data.tar.gz: 65c04c3b86a0a694e2e064716844908271b7ad569a0a067d4bfc9c853da367d1d81a20edc58ee273b7ee0fd438eec5563401c8288c249df244074a646edc1311

data/.gitignore

@@ -0,0 +1,9 @@
+*.aux
+*.log
+*.etx
+*.out
+*.pdf
+*.gem
+etc
+auto
+/.bundle/config

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,25 @@
+PATH
+  remote: .
+  specs:
+    erbtex (0.2.0)
+      erubis
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (3.1.2)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    erubis (2.7.0)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  erbtex!
+  rake

data/LICENCE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel E. Doherty
+
+MIT License
+
+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.md

@@ -0,0 +1,127 @@
+ErbTeX: Ruby pre-processing for TeX and LaTeX Documents
+==========
+
+# Description
+
+erbtex is a ruby gem that provides a command line program the
+pre-processes TeX and LaTeX source files with ruby's erubis and then
+passes the resulting file along to a real TeX program.
+
+# Installation
+
+Install it with:
+
+    gem install erbtex
+
+# Usage
+
+After the gem is installed, erbtex is placed in your PATH in front of
+the real TeX and LaTeX programs, along with links to erbtex having the
+names pdftex, pdflatex, luatex, and several other TeX processing
+programs.  Thus, invoking, for example, `pdflatex` runs `erbtex`
+instead of the real `pdflatex` program.
+
+It will then read the input file and execute any ruby code between the special
+markers markers `{:` and `:}` and then find the real program further along
+your path and run it on the pre-processed output.  The result is that you can
+use the ruby programming language to greatly increase the computational
+capabilities of a normal TeX or LaTeX file.
+
+erbtex simply uses the `erubis` program to pre-process the input, except that
+it uses the `{: :}` delimiters instead of the erubis default of `<% %>`.  The
+brace-colon form of delimiters is less disruptive of syntax highlighting than
+the default delimiters, which get confused with TeX and LaTeX comments.
+
+If the opening delimiter has an `=` appended to it, the contained expression
+is converted into a string and inserted in-place into the TeX manuscript at
+that point.  Without the `=` the code is simply executed.  Loops started in
+one ruby fragment can be continued or terminated in a later fragment, and
+variables defined in one fragment in one fragment are visible in later
+fragments according to Ruby's usual scoping rules.
+
+# Example
+
+For example, the following LaTeX file will produce a table of square
+roots when run through erbtex.  It uses a ruby iterator to supply the
+rows of the table, a feat that would tedious at best with bare TeX or
+LaTeX.
+
+    \documentclass{article}
+    \usepackage[mathbf]{euler}
+    \usepackage{longtable}
+
+    \begin{document}
+        \begin{longtable}[c]{r|r}
+    \hline\hline
+    \multicolumn{1}{c|}{\mathversion{bold}$x$}&
+    \multicolumn{1}{c}{\mathversion{bold}\rule{0pt}{12pt}$\sqrt{x}$}\\
+    \hline\hline
+    \endhead
+    \hline\hline
+    \endfoot
+    % The following line starts a ruby enumerator loop but does not
+    % produce any output, since the delimiters are {: :}.
+    {: 0.upto(100).each do |x| :}
+      % But the following two lines produce output since the opening
+      % delimiter is '{:='.  Both call the sprintf method in ruby via the
+      % percent operator, and the second line calls ruby's Math module to
+      % compute the square root.
+      {:= "\\mathversion{bold}$%0.4f$" % x :}&
+      {:= "$%0.8f$" % Math.sqrt(x) :}\\
+    {: end :}
+    \end{longtable}
+    \end{document}
+
+With the above in file `roots.tex`, running `$ pdflatex roots.tex` at
+the command line will generate a `PDF` file with a nicely typeset
+table of square roots.
+
+As a by-product, the pre-processed file `roots.etx` is left in the
+same directory, so you can see what the effect of the erbtex fragments
+were.  This is often very handy when you are trying to debug the
+document; otherwise, it can be deleted.  Here, for example is a
+portion of the `roots.etx` file generated by the foregoing:
+
+    \begin{document}
+      \begin{longtable}[c]{r|r}
+      \hline\hline
+      \multicolumn{1}{c|}{\mathversion{bold}$x$}&
+      \multicolumn{1}{c}{\mathversion{bold}\rule{0pt}{12pt}$\sqrt{x}$}\\
+      \hline\hline
+      \endhead
+      \hline\hline
+      \endfoot
+      \mathversion{bold}$0.0000$&
+      $0.00000000$\\
+      \mathversion{bold}$1.0000$&
+      $1.00000000$\\
+      \mathversion{bold}$2.0000$&
+      $1.41421356$\\
+      \mathversion{bold}$3.0000$&
+      $1.73205081$\\
+      \mathversion{bold}$4.0000$&
+      $2.00000000$\\
+      \mathversion{bold}$5.0000$&
+      $2.23606798$\\
+      \mathversion{bold}$6.0000$&
+      $2.44948974$\\
+      \mathversion{bold}$7.0000$&
+      $2.64575131$\\
+      \mathversion{bold}$8.0000$&
+      $2.82842712$\\
+      \mathversion{bold}$9.0000$&
+      $3.00000000$\\
+      \mathversion{bold}$10.0000$&
+      $3.16227766$\\
+      \mathversion{bold}$11.0000$&
+      $3.31662479$\\
+      \mathversion{bold}$12.0000$&
+      $3.46410162$\\
+      \mathversion{bold}$13.0000$&
+      $3.60555128$\\
+      \mathversion{bold}$14.0000$&
+
+And many more lines like it.
+
+The examples directory installed with the erbtex gem has a few more
+examples.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake/testtask'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+desc "Run all the unit tests"
+task :test do
+  Dir.foreach('test') do |t|
+    next if t == 'test_helper.rb'
+    next if t =~ /^\.\.?/
+    cmd = "ruby -I 'test' -C 'test' #{t}"
+    system cmd
+  end
+end

data/bin/erbtex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/etex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/latex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/lualatex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/luatex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/pdfetex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/pdflatex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/pdftex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)

data/bin/pslatex

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+
+verbose = true
+
+# This adds our lib subdirectory to the ruby load path
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+# This adds our RUBYLIB env to ruby load path
+if ENV['RUBYLIB']
+  STDERR.puts "ENV['RUBYLIB']:" if verbose
+  ENV['RUBYLIB'].split(':').each do |p|
+    $LOAD_PATH.unshift p
+    STDERR.puts "\t#{p}" if verbose
+  end
+else
+  STDERR.puts "ENV['RUBYLIB'] is EMPTY" if verbose
+end
+
+require 'erbtex'
+
+progname = File.basename($0)
+commandline = progname
+ARGV.each do |a|
+  if a =~ /\s/
+    a = "'" + a + "'"
+  end
+  commandline += " #{a}"
+end
+
+if verbose
+  STDERR.puts "Program name: #{progname}"
+  STDERR.puts "Command line: #{commandline}"
+  STDERR.puts "Ruby Load path:"
+  $:.each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts 'ARGV:'
+  ARGV.each do |a|
+    STDERR.puts "\t#{a}"
+  end
+  STDERR.puts 'PATH:'
+  ENV['PATH'].split(':').each do |p|
+    STDERR.puts "\t#{p}"
+  end
+  STDERR.puts "Executable: "
+  STDERR.puts ErbTeX.find_executable($0)
+end
+
+ErbTeX.run(commandline)