runtex 0.2.1

data/unittest/unittest_catch_output.rb

@@ -0,0 +1,66 @@
+require 'test/unit'
+#~ require 'tempfile'  #needed to get logger.data
+
+require 'catch_output'
+
+class Test_RedirectStdout < Test::Unit::TestCase
+  
+  def test_block()
+    assert_raise( RuntimeError ){ Frame_catch_output.catch_stdout() }
+    assert_raise( RuntimeError ){ Frame_catch_output.catch_screen_output() }
+  end #test_block()
+  
+  def test_stdout()
+    #test with puts
+    assert_equal( "", Frame_catch_output.catch_stdout{})
+    assert_equal( "11\n", Frame_catch_output.catch_stdout{ puts 11 })
+    assert_equal( "11\n12\n", Frame_catch_output.catch_stdout{ puts 11; puts 12 })
+    assert_equal( "\n", Frame_catch_output.catch_stdout{ puts })
+    
+    #test with print
+    assert_equal( "11", Frame_catch_output.catch_stdout{ print 11 })
+    assert_equal( "1112", Frame_catch_output.catch_stdout{ print 11; print 12 })
+    
+    #Test with STDOUT
+    assert_equal( "11", Frame_catch_output.catch_stdout{ STDOUT << 11 })
+  end #test_stdout()
+
+  def test_stderr()
+    assert_equal( "", Frame_catch_output.catch_stderr{ })
+    assert_equal( "11", Frame_catch_output.catch_stderr{ STDERR << 11 })
+  end #test_stdout()
+  
+  def test_catch_screen_output()
+    
+    assert_equal( ["11\n",''], Frame_catch_output.catch_screen_output{ puts 11 })
+    assert_equal( ['', "11"], Frame_catch_output.catch_screen_output{ STDERR << 11 })
+    assert_equal( ["hello world\n", "earthquake"], Frame_catch_output.catch_screen_output{ 
+        puts 'hello world'
+        STDERR << 'earthquake'
+    })
+
+    assert_equal( ["hello world\n", nil], 
+        Frame_catch_output.catch_screen_output( true, false) { 
+          puts 'hello world'
+        })
+    assert_equal( [nil, "earthquake"], 
+        Frame_catch_output.catch_screen_output( false, true) { 
+          STDERR << 'earthquake'
+        })
+
+  end #test_catch_screen_output()
+  
+  def test_nested_call()
+    out_o, err_o, out_i, err_i = nil
+    out_o, err_o  = Frame_catch_output.catch_screen_output{
+      out_i, err_i = Frame_catch_output.catch_screen_output{
+        puts 'inner call'
+      }
+      puts 'outer call'
+    }
+    assert_equal( "outer call\n", out_o )
+    assert_equal( "inner call\n", out_i )
+    assert_equal( "", err_o )
+    assert_equal( "", err_i )
+  end #test_nested_call()
+end #Test_RedirectStdout

data/unittest/unittest_runtex.rb

@@ -0,0 +1,282 @@
+#
+#If this unit test reports errors:
+#
+#     No Panic
+#
+#I found no easy way to create unit tests.
+#
+#What I do:
+#-Creates test files (Based on testcases.yaml)
+#-Call rtex
+#-Compare the log.
+#
+#The test results depend on your local TeX-installation!
+#
+#The test works on _my_ installation.
+#
+#What you can do with this test:
+#-Use the testfiles to make your own tests.
+#
+#If there are differences, it can be another TeX-installation.
+#-Versions of tools (bibtex, makeindex, rail...)
+#-Missing tool in your system (Rail.exe?)
+#
+#
+
+Dir.chdir('../lib'){  require 'runtex' }
+#~ Dir.chdir('../lib'){  require 'runtex_old' }
+
+include RunTeX
+
+#~ bibliography_plain
+#~ bibliography_babelbib
+#~ bibliography.bib
+#~ packagedoc_dtx
+#~ $testonly = %w{
+#~ rail_error
+#~ }
+
+puts <<xx
+Missing tests:
+  - Test Documente with errors (see testcases_log.yaml, -> more)
+  - Test overfull/underfull
+Missing Code:
+  - Gui (runtex_gui.rb)  
+xx
+
+
+require 'yaml'
+require 'assert_equal_filecontent'
+require 'test/unit'
+
+#
+#Mocking-Element for time (summary writes a time stamp)
+#Side-effect: assert_equal_filecontent uses the same date.
+class Time
+  def self.now()
+    return Time.local( 2000, 1, 1, 12, 0 )
+    #~ return Time.local( 2000, 1, 1, 12, 0 ) if caller().last =~ /#{__FILE__}/
+    #~ return Time.new
+  end
+end
+
+
+class Test_Configuration < Test::Unit::TestCase
+  include Catch_output
+  def test_yaml_data()
+    assert_instance_of( Hash, Job_chain::Configuration )
+    Job_chain::Configuration.each{|key, configuration|
+      assert_instance_of( Hash, configuration )
+      configuration.each{|key2, val2|
+        case key2
+          when 'call'
+            assert_instance_of( String, val2 )
+          when 'post'
+            assert_instance_of( Array, val2 )
+          when 'parameters'
+            assert_instance_of( Array, val2 )
+            val2.each{|val3|
+              assert_instance_of( Array, val3 )
+            }
+          else
+            puts "Undefined key #{key2}"
+            assert_equal( 1,2) #Just any error
+            assert_instance_of( Job_chain, key2 => val2 ) #Just any error
+          end
+      }
+    }
+  end
+  #All TeX-formats have the same start parameters
+  def test_latex_variants()
+    template = Job_chain::Configuration['latex']['parameters']
+    assert_equal( template, Job_chain::Configuration['pdflatex']['parameters'] )
+    assert_equal( template, Job_chain::Configuration['pdflualatex']['parameters'] )
+    assert_equal( template, Job_chain::Configuration['xelatex']['parameters'] )
+  end
+  def test_latex()
+    job = Job_chain.new('test')
+    assert_equal( 'latex -interaction=batchmode  texfile', 
+                        LaTeX.new(job).build_cmd('latex', :filename => 'texfile') )
+                        
+    stdout, stderr = catch_screen_output{ LaTeX.new(job).build_cmd('latex') }
+    assert_equal( "ERROR test: Parameter :filename (nil) missing to execute latex\n", stdout )
+  end
+  def test_bibtex()
+    job = Job_chain.new('test')
+    assert_equal( 'bibtex  filename', BibTeX.new(job).build_cmd('bibtex', :source => 'filename') )
+    
+    #~ stdout, stderr = catch_screen_output{ 
+        #~ BibTeX.new(job).build_cmd('bibtex')
+    #~ }  
+    #~ assert_equal( "ERROR test: Parameter :file_in (nil) missing to execute makeindex\n", stdout )
+  end  
+  def test_makeindex()
+    job = Job_chain.new('test')
+    #makeindex take the default settings from the job
+    assert_equal( 'makeindex -o test.ind -t test.ilg  test.idx', 
+                              Makeindex.new(job).build_cmd('makeindex') )
+    #Taking his own parameters
+    assert_equal( 'makeindex -s format -o file.ind -t file.ilg  file.idx', 
+                              Makeindex.new(job).build_cmd('makeindex', 
+                                          :file_in => 'file.idx', 
+                                          :file_out => 'file.ind', 
+                                          :file_log => 'file.ilg', 
+                                          :format => 'format'
+                                            ) )
+    assert_equal( 'makeindex -o file.ind -t file.ilg  file.idx', 
+                              Makeindex.new(job).build_cmd('makeindex', 
+                                          :file_in => 'file.idx', 
+                                          :file_out => 'file.ind', 
+                                          :file_log => 'file.ilg'
+                                            ) )
+    stdout, stderr = catch_screen_output{ 
+                              Makeindex.new(job).build_cmd('makeindex', 
+                                          :file_out => 'file.ind', 
+                                          :file_log => 'file.ilg'
+                                            ) 
+    }
+    assert_equal( "ERROR test: Parameter :file_in (nil) missing to execute makeindex\n", stdout )
+    
+    stdout, stderr = catch_screen_output{ 
+                              Makeindex.new(job).build_cmd('makeindex', 
+                                          :file_in => 'file.idx', 
+                                          :file_log => 'file.ilg'
+                                            ) 
+    }
+    assert_equal( "ERROR test: Parameter :file_out (-o) missing to execute makeindex\n", stdout )
+  end
+  def test_rail()
+    job = Job_chain.new('test')
+    assert_equal( 'C:/usr/texmf/tex/Latex/rail/rail.exe -t filename', 
+        Rail.new(job).build_cmd('rail', :railfile => 'filename') )
+    
+    #~ stdout, stderr = catch_screen_output{ 
+        #~ rail.new(job).build_cmd('rail')
+    #~ }  
+    #~ assert_equal( "ERROR test: Parameter :file_in (nil) missing to execute makeindex\n", stdout )
+  end  
+end #Test_Configuration 
+
+#
+# Test analyses of auxfile
+#
+class Test_log < Test::Unit::TestCase
+  #Dummy-job/File
+  job = Job_chain.new(__FILE__)
+  @@tex = LaTeX.new( job )
+
+  File.open('Testcases_log.yaml'){|yamlfile|
+    YAML.load(yamlfile).each_with_index{|testcase, num|
+      keys = %w{description source log_source result}
+      next if testcase['ignore']
+      (keys - testcase.keys).each{|key| puts "missing key #{key} for #{testcase.inspect}" }
+      (testcase.keys - keys).each{|key| puts "new key #{key} for #{testcase.inspect}"}
+      
+      testcode = <<code
+  #{testcase['description'].gsub(/^/,'#') if testcase['description']}
+  def test_#{num}() 
+    expected_result = #{testcase['result'].inspect}
+    assert_equal(expected_result, 
+                    @@tex.analyse_logfile("#{testcase['log_source']}"),
+                    "#{testcase['description']}"
+    )
+  end #test_#{num}()
+  
+code
+        #Add testcode for this test case to the test class
+        self.module_eval( testcode )  #<===Here's the test
+    }
+  } #File
+end #Test_aux < Test::Unit::TestCase
+
+#
+#Fo each test docuemnt in 
+#
+class Test_Document < Test::Unit::TestCase
+
+  include Catch_output
+
+  #
+  #First create test examples in Testcases.yaml and create the test.
+  #
+  #1st job: Virgin data, everything must be done
+  #2nd job: Normally only 1 run necessary
+  #
+  #Each job is compared with the expected result for:
+  #-Compare log on screen (stdout, contains log start with INFO)
+  #-Compare debug log test_#{testcase}.debug[12].txt
+  #The debug log contains ionformation from Hash#inspect
+  #There may be (harmless) differences in the order of the values.
+  #
+  #This must be re-created for each test run.
+  #If there are already intermediate files, 
+  ['test'].each{|dir|
+    Dir.mkdir(dir) unless File.exist?(dir)
+    Dir["#{dir}/*"].each{|file| File.delete(file)}
+  }
+  #File the directories.
+  File.open('Testcases.yaml'){|yamlfile|
+    if defined?($testonly)
+      puts "! >> Restricted document test: #{$testonly.inspect}"
+    end
+    
+    YAML.load(yamlfile).each{|testcase, testcode|
+      next if defined?($testonly) and ! $testonly.include?(testcase)
+      case testcase #Check for non-tex files
+        when /\.(bib)$/
+          File.open( "test/test_#{testcase}", 'w'){|texfile|
+            texfile << testcode
+          }      
+        else  
+          filename = "test/test_#{testcase}.tex"
+          filename = "test/test_#{testcase}.dtx" if testcase =~ /_dtx/
+          File.open( filename, 'w'){|texfile|
+            texfile << testcode
+          }
+          #Name for logs.
+          debuglog1 = "test_#{testcase}.debug1.txt"
+          debuglog2 = "test_#{testcase}.debug2.txt"
+          summary   = File.basename("#{filename}.runtex_summary.txt")
+          testcode = <<code
+  def test_#{testcase}()
+    job = Job_chain.new('#{filename}')
+
+    #1st run - a lot of work
+    job.log.add(Log4r::FileOutputter.new('log_file_debug', :filename => 'test/#{debuglog1}', :level => Log4r::DEBUG ) )
+    stdout, stderr = catch_screen_output{ job.start(:pdflatex) }
+    job.log.outputters.last.close
+    
+    assert_equal_filecontent( 'expected/test_#{testcase}_1.txt', stdout )
+    assert_equal_filecontent( 'expected/#{debuglog1}', File.readlines('test/#{debuglog1}').to_s )
+
+    puts stderr if stderr != '' #only for test reasons, stderr should be empty, but can be used for test output
+    
+    #2nd run -should be shorter
+    job.log.add(Log4r::FileOutputter.new('log_file_debug2', :filename => 'test/#{debuglog2}', :level => Log4r::DEBUG ) )
+    stdout, stderr = catch_screen_output{ job.start(:pdflatex) }
+    job.log.outputters.last.close
+    assert_equal_filecontent( 'expected/test_#{testcase}_2.txt', stdout )
+    assert_equal_filecontent( 'expected/#{debuglog2}', File.readlines('test/#{debuglog2}').to_s )
+    
+    #Check summary
+    assert_equal_filecontent( 'expected/#{summary}', File.readlines('test/#{summary}').to_s )
+    
+    File.delete('test/#{debuglog1}')
+    File.delete('test/#{debuglog2}')
+  end
+code
+        #Add testcode for this test case to the test class
+        self.module_eval( testcode )  #<===Here's the test
+      end #case testcase
+      #~ puts testcode
+    }
+  }
+
+  #~ def test_test()
+    #~ job = Job_chain.new('test/test_test.tex')
+    #~ job.log.level = Log4r::DEBUG
+    #~ stdout, stderr = catch_screen_output{ job.start(:pdflatex) }
+    #~ assert_equal_filecontent( 'expected/test_test.txt', stdout )
+  #~ end
+
+end #Test_Configuration 

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: runtex
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+date: 2009-05-20 00:00:00 +02:00
+summary: runTeX - Translate (La)TeX-files as often as needed
+require_paths: 
+- lib
+email: knut@lickert.net
+homepage: http://ruby.lickert.net/runtex
+rubyforge_project: runtex
+description: "runtex is a ruby script which allows you to translate a (La)TeX file. The program runs LaTeX as often as necessary, it checks for the need to start BibTeX, Makeindex, Rail...  After finishing the script you get an overview on all errors (from each program the script used).  It is possible to define by switches to define the way of processing: - LaTeX - pdfLaTeX - XeLaTeX - LuaLaTeX  There are different reasons for additional tex runs. Beside the 'normal' LaTeX reasons for multiple TeX-calls, the following packages from CTAN are supported by runtex: - longtable: Allow tables to flow over page boundaries. http://www.ctan.org/tex-archive/help/Catalogue/entries/longtable.html http://www.ctan.org/cgi-bin/ctanPackageInformation.py?id=longtable - glossaries: Create glossaries and lists of acronyms. (uses makeindex) http://www.ctan.org/tex-archive/macros/latex/contrib/glossaries/ - gloss: Create glossaries using BibTeX. http://www.ctan.org/tex-archive/macros/latex/contrib/gloss/ - splitindex: Unlimited number of indexes http://www.ctan.org/tex-archive/macros/latex/contrib/splitindex/ (runtex replaces the other splitindex-programms like splitindex.pl, splitindex.jar, splitindex.exe, splitindex.tex). - index:  Extended index for LaTeX including multiple indexes. http://www.ctan.org/tex-archive/macros/latex/contrib/index/ (works proper only in addition with index2.sty) - rail: Syntax specification in EBNF. http://www.ctan.org/tex-archive/support/rail/   Bugs, Wishes and new Features  This program is tested on a WIN2K System with TeXLive 2008 and ruby 1.8.6. The results of the unit test depends on your TeX-installation. No panic if there are errors!  If it does not work on your system: 1) Please check the configuration runtex_pathes.yaml. (where are the programs like makeindex, bibtex, rail...) Perhaps you must adapt it.  There is no configuration for different systems. If you need another configuration, send me please your adaption, I will think about different configurations.  2) It does not work with Style X. Please inform me about it, send a minimal example, where the script does not enough runs.  3) The Error/Warning X is not reported/detected Please send a minimal example an the log-file    The Files of this contribution: runtex-0.2.1.gem: Gem on Rubyforge  runtex-0.2.1_CTAN.zip: - runtex.exe: The 'compiled' programm start runtex.exe -h for the switches - runtex-0.2.1.gem - Also available at Rubyforge - index2.sty: Minor modification of index.sty  More details: http://ruby.lickert.net/runtex http://rubyforge.org/projects/runtex/  knut@lickert.net"
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Knut Lickert
+files: 
+- lib/catch_output.rb
+- lib/Code_zum_Pluendern_rtex4newrtex.rb
+- lib/runtex.rb
+- lib/runtex_bibtex.rb
+- lib/runtex_job_chain.rb
+- lib/runtex_latex.rb
+- lib/runtex_makeindex.rb
+- lib/runtex_rail.rb
+- lib/runtex_splitindex.rb
+- lib/runtex_tool.rb
+- lib/runtex_pathes.yaml
+- lppl.txt
+- readme
+test_files: 
+- unittest/unittest_catch_output.rb
+- unittest/unittest_runtex.rb
+- unittest/testcases.yaml
+- unittest/expected/test_bibliography_babelbib.debug1.txt
+- unittest/expected/test_bibliography_babelbib.debug2.txt
+- unittest/expected/test_bibliography_babelbib.tex.runtex_summary.txt
+- unittest/expected/test_bibliography_babelbib_1.txt
+- unittest/expected/test_bibliography_babelbib_2.txt
+- unittest/expected/test_bibliography_plain.debug1.txt
+- unittest/expected/test_bibliography_plain.debug2.txt
+- unittest/expected/test_bibliography_plain.tex.runtex_summary.txt
+- unittest/expected/test_bibliography_plain_1.txt
+- unittest/expected/test_bibliography_plain_2.txt
+- unittest/expected/test_error.debug1.txt
+- unittest/expected/test_error.debug2.txt
+- unittest/expected/test_error.tex.runtex_summary.txt
+- unittest/expected/test_error_1.txt
+- unittest/expected/test_error_2.txt
+- unittest/expected/test_gloss.debug1.txt
+- unittest/expected/test_gloss.debug2.txt
+- unittest/expected/test_gloss.tex.runtex_summary.txt
+- unittest/expected/test_glossaries.debug1.txt
+- unittest/expected/test_glossaries.debug2.txt
+- unittest/expected/test_glossaries.tex.runtex_summary.txt
+- unittest/expected/test_glossaries_1.txt
+- unittest/expected/test_glossaries_2.txt
+- unittest/expected/test_gloss_1.txt
+- unittest/expected/test_gloss_2.txt
+- unittest/expected/test_gloss_newgloss.debug1.txt
+- unittest/expected/test_gloss_newgloss.debug2.txt
+- unittest/expected/test_gloss_newgloss.tex.runtex_summary.txt
+- unittest/expected/test_gloss_newgloss_1.txt
+- unittest/expected/test_gloss_newgloss_2.txt
+- unittest/expected/test_index.debug1.txt
+- unittest/expected/test_index.debug2.txt
+- unittest/expected/test_index.tex.runtex_summary.txt
+- unittest/expected/test_index2.debug1.txt
+- unittest/expected/test_index2.debug2.txt
+- unittest/expected/test_index2.tex.runtex_summary.txt
+- unittest/expected/test_index2_1.txt
+- unittest/expected/test_index2_2.txt
+- unittest/expected/test_index_1.txt
+- unittest/expected/test_index_2.txt
+- unittest/expected/test_makeindex.debug1.txt
+- unittest/expected/test_makeindex.debug2.txt
+- unittest/expected/test_makeindex.tex.runtex_summary.txt
+- unittest/expected/test_makeindex_1.txt
+- unittest/expected/test_makeindex_2.txt
+- unittest/expected/test_packagedoc_dtx.debug1.txt
+- unittest/expected/test_packagedoc_dtx.debug2.txt
+- unittest/expected/test_packagedoc_dtx.dtx.runtex_summary.txt
+- unittest/expected/test_packagedoc_dtx_1.txt
+- unittest/expected/test_packagedoc_dtx_2.txt
+- unittest/expected/test_rail.debug1.txt
+- unittest/expected/test_rail.debug2.txt
+- unittest/expected/test_rail.tex.runtex_summary.txt
+- unittest/expected/test_rail_1.txt
+- unittest/expected/test_rail_2.txt
+- unittest/expected/test_rail_error.debug1.txt
+- unittest/expected/test_rail_error.debug2.txt
+- unittest/expected/test_rail_error.tex.runtex_summary.txt
+- unittest/expected/test_rail_error_1.txt
+- unittest/expected/test_rail_error_2.txt
+- unittest/expected/test_splitindex.debug1.txt
+- unittest/expected/test_splitindex.debug2.txt
+- unittest/expected/test_splitindex.tex.runtex_summary.txt
+- unittest/expected/test_splitindex_1.txt
+- unittest/expected/test_splitindex_2.txt
+- unittest/expected/test_test.debug1.txt
+- unittest/expected/test_test.debug2.txt
+- unittest/expected/test_test.tex.runtex_summary.txt
+- unittest/expected/test_test_1.txt
+- unittest/expected/test_test_2.txt
+- unittest/expected/test_test_bibliography.debug1.txt
+- unittest/expected/test_test_gloss.debug1.txt
+- unittest/expected/test_test_glossaries.debug1.txt
+- unittest/expected/test_test_gloss_newgloss.debug1.txt
+- unittest/expected/test_test_index.debug1.txt
+- unittest/expected/test_test_index2.debug1.txt
+- unittest/expected/test_test_makeindex.debug1.txt
+- unittest/expected/test_test_rail.debug1.txt
+- unittest/expected/test_test_splitindex.debug1.txt
+- unittest/expected/test_test_test.debug1.txt
+rdoc_options: []
+
+extra_rdoc_files: 
+- readme
+executables: []
+
+extensions: []
+
+requirements: 
+- TeX, LaTeX, ...
+- BibTeX, Makeindex, ...
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: log4r
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: