erbtex 0.2.0 → 0.3.0

data/lib/erbtex/runner.rb

@@ -14,12 +14,10 @@ module ErbTeX
   # Write the .etx file to the current directory unless it is not
   # writable, in which case write it to /tmp.
   #
-  # Perhaps change the Erubis pattern to something like .{ }. so that
-  # AucTeX does not get confused with the comment character used in
-  # Erubis by default (<%= %>).  Erubis -p commandline would use the
-  # switch -p '\.{ }\.' But adapt if old pattern style is found in the
-  # input.
-  #
+  # Perhaps change the Erubis pattern to something other than the erbtex
+  # default '{: :}'.  Erubis normally by uses '<%= %>' by default.  Erubis -p
+  # commandline -p '\.{ }\.'
+
   # If there are no Erubis patterns in the file, skip the Erubis phase
   # and just pass the original command on to the system.
   #
@@ -37,72 +35,181 @@ module ErbTeX
   # on our processed .etx file and otherwise leave the commandline
   # intact.
   #
-  def ErbTeX.run(command)
-    cl = CommandLine.new(command)
-    Dir.chdir(cl.run_dir) do
-      if cl.input_file
-        new_infile = process(cl.input_file, cl.input_path)
-      else
-        new_infile = nil
-      end
-      if new_infile
-        new_infile = Pathname.new(new_infile).
-          relative_path_from(Pathname.new(cl.run_dir))
-        new_progname = ErbTeX.find_executable(command.lstrip.split(' ')[0])
-        cmd = cl.new_command_line(new_progname, new_infile)
-        cmd.sub!('\\', '\\\\\\')
-        puts "Executing: #{cmd}"
-        system(cmd)
+  def self.run(cl)
+    tex_dir = input_dir(cl.input_file)
+    tex_file = erb_to_tex(cl.input_file, tex_dir) if cl.input_file
+    run_tex(cl.tex_command(tex_file), tex_dir)
+  end
+
+  # Run the TeX program, adding add_dir to the front of TEXINPUTS, unless it is
+  # already in TEXINPUTS.
+  def self.run_tex(cmd, add_dir = nil)
+    new_env = {}
+    if add_dir
+      add_dir = File.absolute_path(File.expand_path(add_dir))
+      unless ENV['TEXINPUTS'].split(File::PATH_SEPARATOR)
+               .reject { |p| p.strip.empty? }
+               .any? { |p| add_dir == File.absolute_path(File.expand_path(p)) }
+        new_env['TEXINPUTS'] = "#{add_dir}:#{ENV['TEXINPUTS']}"
       end
     end
+    unless system(cmd)
+      $stderr.puts "Call to '#{cmd}' failed."
+      exit $?.exitstatus
+    end
+    $?
   end
 
-  # Run erbtex on the content of file_name, a String, and return the
-  # name of the file where the processed content can be found.  This
-  # could be the orignal file name if no processing was needed, or a
-  # temporary file if the erubis pattern is found anywhere in the file.
-  def ErbTeX.process(file_name, dir)
-    puts "Input path: #{dir}"
-    contents = nil
-    File.open(file_name) do |f|
-      contents = f.read
+  def self.input_dir(in_file)
+    return nil unless in_file
+    in_file_absolute = File.absolute_path(File.expand_path(in_file))
+    in_file_absolute[/\A(.*\/)([^\/.]+)(\.[\w.]+)\z/, 1]
+  end
+
+  # Pre-process the input file with erubis, adding the add_dir to the front of
+  # the ruby load path if its not already in the load path.  Return the name of
+  # the processed file.
+  def self.erb_to_tex(in_file, add_dir = nil)
+    add_dir = File.absolute_path(File.expand_path(add_dir))
+    unless $LOAD_PATH
+             .any? { |p| add_dir == File.absolute_path(File.expand_path(p)) }
+      $LOAD_PATH.unshift(add_dir)
+    end
+
+    in_contents = nil
+    File.open(in_file) do |f|
+      in_contents = f.read
     end
     # TODO: recurse through any \input or \include commands
 
-    # Add current directory to LOAD_PATH
-    $: << '.' unless $:.include?('.')
+    pat =
+      if ENV['ERBTEX_PATTERN']
+        ENV['ERBTEX_PATTERN']
+      else
+        '{: :}'
+      end
 
-    if ENV['ERBTEX_PATTERN']
-      pat = ENV['ERBTEX_PATTERN']
+    out_file = set_out_file(in_file)
+    File.open(out_file, 'w') do |f|
+      er = ::Erubis::Eruby.new(in_contents, pattern: pat)
+      f.write(er.result)
+    end
+    out_file
+  rescue SystemCallError => ex
+    $stderr.puts "Error: #{ex}"
+    exit 1
+  rescue ScriptError => ex
+    $stderr.puts "Erubis pre-processing failed: #{ex}"
+    exit 1
+  end
+
+  def self.set_out_file(in_file)
+    in_file_absolute = File.absolute_path(File.expand_path(in_file))
+    in_dir = in_file_absolute[/\A(.*\/)([^\/.]+)(\.[\w.]+)\z/, 1]
+    in_base = in_file_absolute[/\A(.*\/)([^\/.]+)(\.[\w.]+)\z/, 2]
+    in_ext = in_file_absolute[/\A(.*\/)([^\/.]+)(\.[\w.]+)\z/, 3]
+
+    if in_ext.empty?
+      if File.exists?("#{in_file}.tex.erb")
+        out_ext = '.tex'
+      elsif File.exists?("#{in_file}.tex")
+        out_ext = '.etx'
+      elsif File.exists?("#{in_file}.erb")
+        out_ext = '.tex'
+      else
+        out_ext = '.tex'
+      end
     else
-      pat = '{: :}'
+      case in_ext
+      when '.tex.erb'
+        out_ext = '.tex'
+      when '.tex'
+        out_ext = '.etx'
+      when '.erb'
+        out_ext = '.tex'
+      else
+        out_ext = '.tex'
+      end
     end
 
-    # Otherwise process the contents
     # Find a writable directory, prefering the one the input file came
     # from, or the current directory, and a temp file as a last resort.
-    file_absolute = File.absolute_path(File.expand_path(file_name))
-    file_dir = File.dirname(file_absolute)
-    if file_absolute =~ /\.tex\.erb$/
-      file_base = File.basename(file_absolute, '.tex.erb')
-    else
-      file_base = File.basename(file_absolute, '.tex')
-    end
-    of = nil
-    if File.writable?(file_dir)
-      out_file = file_dir + '/' + file_base + '.etx'
+    if File.writable?(in_dir)
+      out_file = File.join(in_dir, "#{in_base}#{out_ext}")
     elsif File.writable?('.')
-      out_file = './' + file_base + '.etx'
+      out_file = File.join('.', "#{in_base}#{out_ext}")
     else
-      of = Tempfile.new([File.basename(file_name), '.etx'])
-      out_file = of.path
+      out_file = Tempfile.new([in_base, out_ext]).path
     end
-    unless of
-      of = File.open(out_file, 'w+')
-    end
-    er = Erubis::Eruby.new(contents, :pattern => pat)
-    of.write(er.result)
-    of.close
     out_file
   end
 end
+  # def ErbTeX.run(command)
+  #   cl = CommandLine.new(command)
+  #   Dir.chdir(cl.run_dir) do
+  #     if cl.input_file
+  #       new_infile = process(cl.input_file, cl.input_path)
+  #     else
+  #       new_infile = nil
+  #     end
+  #     if new_infile
+  #       new_infile = Pathname.new(new_infile).
+  #                    relative_path_from(Pathname.new(cl.run_dir))
+  #     end
+  #     new_progname = ErbTeX.find_executable(command.lstrip.split(' ')[0])
+  #     cmd = cl.new_command_line(new_progname, new_infile)
+  #     cmd.sub!('\\', '\\\\\\')
+  #     cmd.sub!('&', '\\\\&')
+  #     puts "Executing: #{cmd}"
+  #     system(cmd)
+  #   end
+  # end
+
+  # Run erbtex on the content of file_name, a String, and return the
+  # name of the file where the processed content can be found.  This
+  # could be the orignal file name if no processing was needed, or a
+  # temporary file if the erubis pattern is found anywhere in the file.
+  # def ErbTeX.process(file_name, dir)
+  #   puts "Input path: #{dir}"
+  #   contents = nil
+  #   File.open(file_name) do |f|
+  #     contents = f.read
+  #   end
+  #   # TODO: recurse through any \input or \include commands
+
+  #   # Add current directory to LOAD_PATH
+  #   $: << '.' unless $:.include?('.')
+
+  #   if ENV['ERBTEX_PATTERN']
+  #     pat = ENV['ERBTEX_PATTERN']
+  #   else
+  #     pat = '{: :}'
+  #   end
+
+  #   # Otherwise process the contents
+  #   # Find a writable directory, prefering the one the input file came
+  #   # from, or the current directory, and a temp file as a last resort.
+  #   file_absolute = File.absolute_path(File.expand_path(file_name))
+  #   file_dir = File.dirname(file_absolute)
+  #   if file_absolute =~ /\.tex\.erb$/
+  #     file_base = File.basename(file_absolute, '.tex.erb')
+  #   else
+  #     file_base = File.basename(file_absolute, '.tex')
+  #   end
+  #   of = nil
+  #   if File.writable?(file_dir)
+  #     out_file = file_dir + '/' + file_base + '.etx'
+  #   elsif File.writable?('.')
+  #     out_file = './' + file_base + '.etx'
+  #   else
+  #     of = Tempfile.new([File.basename(file_name), '.etx'])
+  #     out_file = of.path
+  #   end
+  #   unless of
+  #     of = File.open(out_file, 'w+')
+  #   end
+  #   er = Erubis::Eruby.new(contents, :pattern => pat)
+  #   of.write(er.result)
+  #   of.close
+  #   out_file
+  # end

data/lib/erbtex/version.rb

@@ -1,3 +1,3 @@
 module ErbTeX
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/erbtex.rb

@@ -1,10 +1,15 @@
-#! /usr/bin/env ruby
+# Conditional added to prevent running bundler/setup twice when it already has
+# erbtex in the LOAD_PATH.  Failure to do this was causing bundler to setup for
+# the wrong Gemfile if it was run in the development directory of another gem,
+# for example, ydl.  This only happened on saturn for some reason that I don't
+# understand, but this kludge made it work.
 
+require 'bundler/setup' if $LOAD_PATH.none? { |p| p =~ /erbtex/ }
+
+require 'shellwords'
 require 'erubis'
 
 require 'erbtex/version'
 require 'erbtex/command_line'
 require 'erbtex/find_binary'
 require 'erbtex/runner'
-
-require 'byebug'

data/spec/lib/command_line_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+
+module ErbTeX
+  describe CommandLine do
+    describe 'parsing' do
+      before :all do
+        # Without this fakery, $0 would be rspec when these specs are run.
+        $0 = 'erbtex'
+        # Note: ARGV does not include the name of the program as the first
+        # element, as in C.
+        @argv_with_file =
+          %w(
+            -draftmode -enc -etex -file-line-error -fmt junk
+            -halt-on-error -ini -interaction batchmode -ipc -ipc-start
+            -jobname junk -kpathsea-debug 8 -mktex tex --invoke=pdflatex
+            -mltex -nomktex tfm -ouptput-comment This\ is\ a\ long\ comment
+            -output-directory ~/texmf/tex -parse-first-line -progname pdflatex
+            -recorder -shell-escape -src-specials cr,display,hbox,math,par
+            -translate-file willy -version &myformat file_name.tex.erb
+          )
+        @argv_with_cmds =
+          %w(
+            -draftmode -enc -etex -file-line-error -fmt junk
+            -halt-on-error -ini -interaction batchmode -ipc -ipc-start
+            -jobname junk -kpathsea-debug 8 -mktex tex --invoke=pdflatex
+            -mltex -nomktex tfm -ouptput-comment This\ is\ a\ long\ comment
+            -output-directory ~/texmf/tex -parse-first-line -progname pdflatex
+            -recorder -shell-escape -src-specials cr,display,hbox,math,par
+            -translate-file willy -version &myformat
+            \\input{junk.tex} \\print these \\items \\end not_a_file
+          )
+        @argv_with_file_cmds =
+          %w(
+            -draftmode -enc -etex -file-line-error -fmt junk
+            -halt-on-error -ini -interaction batchmode -ipc -ipc-start
+            -jobname junk -kpathsea-debug 8 -mktex tex --invoke=pdflatex
+            -mltex -nomktex tfm -ouptput-comment This\ is\ a\ long\ comment
+            -output-directory ~/texmf/tex -parse-first-line -progname pdflatex
+            -recorder -shell-escape -src-specials cr,display,hbox,math,par
+            -translate-file willy -version &myformat file_name
+            \\input{junk.tex} \\print these \\items \\end not_a_file
+          )
+      end
+
+      it 'parse command line with file name' do
+        cl = CommandLine.new(@argv_with_file)
+        expect(cl.erbtex_name).to eq('erbtex')
+        expect(cl.tex_program).to eq('pdflatex')
+        expect(cl.input_file).to eq('file_name.tex.erb')
+        expect(cl.tex_command).to eq(<<~'EOS'.tr("\n", ' ').strip)
+          pdflatex -draftmode -enc -etex -file-line-error -fmt junk -halt-on-error
+          -ini -interaction batchmode -ipc -ipc-start -jobname junk -kpathsea-debug 8
+          -mktex tex -mltex -nomktex tfm
+          -ouptput-comment This\ is\ a\ long\ comment
+          -output-directory \~/texmf/tex -parse-first-line -progname pdflatex
+          -recorder -shell-escape -src-specials cr,display,hbox,math,par
+          -translate-file willy -version \&myformat file_name.tex.erb
+        EOS
+      end
+
+      it 'parse command line with TeX commands' do
+        cl = CommandLine.new(@argv_with_cmds)
+        expect(cl.erbtex_name).to eq('erbtex')
+        expect(cl.tex_program).to eq('pdflatex')
+        expect(cl.input_file).to be_nil
+        expect(cl.tex_command).to eq(<<~'EOS'.tr("\n", ' ').strip)
+          pdflatex -draftmode -enc -etex -file-line-error -fmt junk -halt-on-error
+          -ini -interaction batchmode -ipc -ipc-start -jobname junk -kpathsea-debug 8
+          -mktex tex -mltex -nomktex tfm
+          -ouptput-comment This\ is\ a\ long\ comment
+          -output-directory \~/texmf/tex -parse-first-line -progname pdflatex
+          -recorder -shell-escape -src-specials cr,display,hbox,math,par
+          -translate-file willy -version \&myformat
+          \\input\{junk.tex\} \\print these \\items \\end not_a_file
+        EOS
+      end
+
+      it 'parse command line with a file name and TeX commands' do
+        cl = CommandLine.new(@argv_with_file_cmds)
+        expect(cl.erbtex_name).to eq('erbtex')
+        expect(cl.tex_program).to eq('pdflatex')
+        expect(cl.input_file).to eq('file_name')
+        expect(cl.tex_command).to eq(<<~'EOS'.tr("\n", ' ').strip)
+          pdflatex -draftmode -enc -etex -file-line-error -fmt junk -halt-on-error
+          -ini -interaction batchmode -ipc -ipc-start -jobname junk -kpathsea-debug 8
+          -mktex tex -mltex -nomktex tfm
+          -ouptput-comment This\ is\ a\ long\ comment
+          -output-directory \~/texmf/tex -parse-first-line -progname pdflatex
+          -recorder -shell-escape -src-specials cr,display,hbox,math,par
+          -translate-file willy -version \&myformat
+          \\input\{junk.tex\} \\print these \\items \\end not_a_file
+          file_name
+        EOS
+      end
+    end
+
+    describe 'expand input file' do
+      before :all do
+        unless Dir.exist?('tmp')
+          FileUtils.mkdir_p('tmp')
+        end
+      end
+
+      before :each do
+        FileUtils.rm_f Dir.glob('tmp/*')
+      end
+
+      after :all do
+        FileUtils.rm_rf('tmp')
+      end
+
+      it 'expand file name with no extension and .tex existing' do
+        FileUtils.touch('tmp/junk.tex')
+        expect(CommandLine.expand_input_file('tmp/junk')).to eq('tmp/junk.tex')
+      end
+
+      it 'expand file name with no extension and .tex.erb existing' do
+        FileUtils.touch('tmp/junk.tex.erb')
+        expect(CommandLine.expand_input_file('tmp/junk'))
+          .to eq('tmp/junk.tex.erb')
+      end
+
+      it 'expand file name with no extension and .erb existing' do
+        FileUtils.touch('tmp/junk.erb')
+        expect(CommandLine.expand_input_file('tmp/junk'))
+          .to eq('tmp/junk.erb')
+      end
+
+      it 'expand file name with .tex extension and existing' do
+        FileUtils.touch('tmp/junk.tex')
+        expect(CommandLine.expand_input_file('tmp/junk'))
+          .to eq('tmp/junk.tex')
+      end
+
+      it 'expand file name with .tex extension and not existing' do
+        expect(CommandLine.expand_input_file('tmp/junk.tex'))
+          .to eq('tmp/junk.tex')
+      end
+
+      it 'expand file name with funny extension and not existing' do
+        expect(CommandLine.expand_input_file('tmp/junk.arb'))
+          .to eq('tmp/junk.arb')
+      end
+    end
+  end
+end

data/spec/lib/find_executable_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module ErbTeX
+  describe 'FindExecutable' do
+    # Here we set up the situation as we expect it to be after
+    # installation.  There is a "real" pdflatex executable binary and
+    # there is one that is just a link to our script, the "fake" binary.
+    # The fake binary is earlier in PATH than the real binary, and we want
+    # this function, when fed the name of the fake binary to deduce the
+    # name of the real binary.
+    before :all do
+      # Create a "fake" ruby script named pdflatex
+      @fake_dir = File.dirname(File.absolute_path(__FILE__)) + '/fake_bin'
+      FileUtils.mkdir(@fake_dir) unless File.exist?(@fake_dir)
+      @fake_binary = @fake_dir + '/pdflatex'
+      @erbtex = @fake_dir + '/erbtex'
+      FileUtils.touch(@erbtex)
+      FileUtils.chmod(0700, @erbtex)
+      FileUtils.rm_rf(@fake_binary) if File.exist?(@fake_binary)
+      FileUtils.ln_s(@erbtex, @fake_binary)
+
+      # Point to "real" pdflatex to find
+      @real_binary = '/usr/bin/pdflatex'
+      @real_dir = '/usr/bin'
+
+      # Put the fake dir on the PATH before the real dir
+      ENV['PATH'] = @fake_dir + ':' + @real_dir + ':' + ENV['PATH']
+    end
+
+    after :all do
+      FileUtils.rm_rf(@fake_dir)
+    end
+
+    it 'should find the real executable from fake' do
+      expect(ErbTeX.find_executable(@fake_binary)).to eq @real_binary
+    end
+
+    it 'should find the real executable from erbtex' do
+      expect(ErbTeX.find_executable(@erbtex)).to eq @real_binary
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'erbtex'
+
+require 'pry'
+require 'byebug'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.raise_errors_for_deprecations!
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erbtex
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel E. Doherty
@@ -53,7 +53,63 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,54 +130,33 @@ description: |-
 email: ded-erbtex@ddoherty.net
 executables:
 - erbtex
-- etex
-- latex
-- lualatex
-- luatex
-- pdfetex
-- pdflatex
-- pdftex
-- pslatex
-- tex
-- xelatex
-- xetex
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bundle/config"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENCE
-- README.md
+- README.org
 - Rakefile
 - bin/erbtex
-- bin/etex
-- bin/latex
-- bin/lualatex
-- bin/luatex
-- bin/pdfetex
-- bin/pdflatex
-- bin/pdftex
-- bin/pslatex
-- bin/tex
-- bin/xelatex
-- bin/xetex
 - docs/NOTES.org
 - erbtex.gemspec
 - examples/TrigTable.tex
 - examples/TrigTable2.tex
 - examples/dms.rb
-- examples/roots.tex
+- examples/roots.tex.erb
 - examples/testbind.rb
-- examples/testbind.tex
+- examples/testbind.tex.erb
 - lib/erbtex.rb
 - lib/erbtex/command_line.rb
 - lib/erbtex/find_binary.rb
 - lib/erbtex/runner.rb
 - lib/erbtex/version.rb
-- test/test_command_line.rb
-- test/test_find_executable.rb
-- test/test_helper.rb
+- spec/lib/command_line_spec.rb
+- spec/lib/find_executable_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -141,7 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Preprocesses TeX and LaTeX files with erubis for ruby.