rake4latex 0.1.1 → 0.1.2

data/bin/call_rake4latex.rb

@@ -69,12 +69,16 @@ opts.on("-i", "--ignore", "--ignore-error", "Allow LaTeX errors") { |v|
   puts "Allow LaTeX errors"  if PARSE_MESSAGES
   Rake4LaTeX.set_latexrunner_default(:texerrors_allowed, true)
 }
-
 opts.on("-s", "--statistic", "Show the statistic after TeX-run") { |v|
   puts "Show the statistic after TeX-run"  if PARSE_MESSAGES
   TASK_BEFORE_TeX  << :statistic  #Set filename
   TASK_AFTER_TeX  << :statistic
 }
+opts.on("-o", "--overview", "Create a log-overview file") { |v|
+  puts "Create a log-overview file after TeX-run"  if PARSE_MESSAGES
+  TASK_BEFORE_TeX  << :statistic  #Set filename
+  TASK_AFTER_TeX  << :log_overview_file
+}
 opts.on("-c", "--clean", "Clean after TeX-run (delete auxiliary files)") { |v|
   puts "Clean after TeX-run"  if PARSE_MESSAGES
   TASK_AFTER_TeX  << :clean
@@ -143,6 +147,8 @@ begin
         }
       when :statistic
         task (:statistic => target.ext('tex'))
+      when :log_overview_file
+        task (:log_overview_file => target.ext('tex'))
       else
         raise ArgumentError, "Undefined option #{task.inspect}"
       end

data/bin/readme_call_rake4latex.txt

@@ -16,6 +16,7 @@ Specific options:
         --dep, --dependecies         Build dependecies (rakefile recommended)
     -i, --ignore, --ignore-error     Allow LaTeX errors
     -s, --statistic                  Show the statistic after TeX-run
+    -o, --overview                   Create a log-overview file
     -c, --clean                      Clean after TeX-run (delete auxiliary files)
         --touch FILE                 Touch FILE
         --task TASK                  Define a rake-task

data/lib/rake4latex.rb

@@ -5,7 +5,7 @@ This file contains definitions to build a rakefile for LaTeX-documents.
 A not-so minimal rakefile looks like this:
   require 'rake4latex'
   #Needed for some actions without a previous TeX-call
-  task :basefile => 'testdocument.tex'
+  Rake4LaTeX::Basefile.set('testdocument.tex')
   #We want to build a PDF
   file 'testdocument.pdf' => 'testdocument.tex'
   
@@ -52,7 +52,7 @@ Example:
   task :touch   => 'testdocument.tex'
   task :runtex => [:touch, 'testdocument.pdf', :clean]
   Rake.application[:runtex].invoke
-  #~ task :basefile => 'testdocument.pdf'
+  #~ Rake4LaTeX::Basefile.set('testdocument.pdf')
   #~ Rake.application[:clean].invoke
 
 ==Document creation
@@ -157,6 +157,7 @@ Tasks using basefile are:
 * touch
 * statistic
 * log_overview
+* log_overview_file
 * log_archive
 * clean
 * clobber
@@ -166,7 +167,8 @@ If you build a pdf (or dvi), basefile-actions are done in background.
 It is recommended to define your main-file as basefile.
 Without this, clean... may not work correct.
 
-
+Please use instead:
+  Rake4LaTeX::Basefile.set('testdocument.tex')
 
 ===touch
 The touch task changes the modification data for the touched file.
@@ -176,36 +178,36 @@ Usage:
   task :touch => 'myfile.tex'
   task :default => touch
 
-With 
-  task :basefile => 'myfile'
-touch is also connected with your sourcefile.
 
 ===statistic
 Get a very short overview on the log-content.
 Errors and warnings are counted for each log (TeX, bibTeX, makeindex...)
 
 Usage:
-  task :basefile => 'myfile'
+  Rake4LaTeX::Basefile.set('myfile')
   task :statistic
   task :default => [ 'myfile.pdf', :statistic ]
 
 See also Rake4LaTeX#TeX_Statistic#stat_summary
 
 ===log_overview
-A log-file is created with a log-summary (TeX_Statistic#stat_summary),
+A more detailed log is created with a log-summary (TeX_Statistic#stat_summary),
 all errors and warnings from TeX and the tools and
 a detailed analyse for the TeX-log.
 
 You should do this task always _before_ a clean-task.
 
 Usage:
-  task :basefile => 'myfile'
+  Rake4LaTeX::Basefile.set('myfile')
   task :log_overview
   task :default => [ 'myfile.pdf', :log_overview ]
 
-
 See also Rake4LaTeX#TeX_Statistic#overview
 
+With task log_overview_file the detailed log will be saved in a file
+for detailed analyses.
+
+
 ===clean
 TeX and the related tools build a lot of auxiliary files.
 When you have them, you can delete the auxiliary files.
@@ -216,7 +218,7 @@ If you also want to delete the results (pdf...) you can use the task
 _clobber_.
 
 Usage:
-  task :basefile => 'myfile'
+  Rake4LaTeX::Basefile.set('myfile')
   task :default => [ 'myfile.pdf', :clean ]
 
 
@@ -232,7 +234,7 @@ in case of errors you can make analyses in the archived logs.
 You should do this task always _before_ a clean-task.
 
 Usage:
-  task :basefile => 'myfile'
+  Rake4LaTeX::Basefile.set('myfile')
   task :default => [ 'myfile.pdf', :log_archive, :clean ]
 
 
@@ -304,7 +306,6 @@ There are additional packages requiring additonal runs.
 
 =end
 
-
 #
 #Load the base functions and load subfiles.
 #
@@ -313,7 +314,7 @@ require 'rake4latex/base'
 #
 #Define the pdf-creation via pdflatex
 #
-#This definition maust be first.
+#This definition must be first.
 #If not, the way via ps2pdf would be the default.
 desc "Build a pdf-file with pdfLaTeX"
 rule '.pdf' => '.tex' do |t|

data/lib/rake4latex/analyse_texfile.rb

@@ -1,4 +1,3 @@
-
 if $0 == __FILE__
 require 'rake4latex'
 end
@@ -89,7 +88,7 @@ Search dependecies by sanning for
 =end
   def analyse(content )
 
-    content.each{ |line|
+    content.each_line{ |line|
       #Skip comments
       #Remarks/Bug: 
       #* \% is not detected.
@@ -218,6 +217,7 @@ def self.build_rakefile( filename, *options )
 Rakefile for LaTeX-project #{basename}
 
 Generated by Rake4LaTeX.build_rakefile, #{Date.today}
+Options: #{options.inspect}
 
 =end
 require 'rake4latex'
@@ -239,9 +239,9 @@ Template
     includes = texfile.includes(:uniq, :recursive)
     if ! includes.empty?
       template << <<Template
-#{texfile.tree.to_yaml.map{|line| "# #{line}"}}
+#{texfile.tree.to_yaml.gsub(/^/, "# ")}
 dependecies = [ 
-#{includes.map{|f| "  \"#{f}\",\n"}}]
+#{includes.map{|f| "  \"#{f}\",\n"}.join}]
 Template
       template << "file '#{pdf_name}' => dependecies\n" if options.include?(:pdf)
       template << "file '#{dvi_name}' => dependecies\n" if options.include?(:dvi)
@@ -316,6 +316,8 @@ Template
 Closing Tasks
 =end
 task :default => :statistic #Get an overview on errors and warnings
+#~ task :default => :log_overview #Show log overview-file
+#~ task :default => :log_overview_file #Build a log overview-file
 task :default => :clean #delete helpfiles
 
 Template

data/lib/rake4latex/base.rb

@@ -3,10 +3,16 @@ Base definitions of rake4latex.
 This file must be loaded by all specific rake4file-variants.
 =end
 
-
 #~ gem 'rake', '=0.8.7'
 require 'rake'
-require 'md5'
+case RUBY_VERSION
+  when /1.8/;   
+    require 'md5'             #   defines MD5 and  Digest::MD5    
+  when /1.9/;   
+    require 'digest/md5'  #defines Digest::MD5
+    require 'yaml'
+  else; raise "Undefined ruby version #{RUBY_VERSION}"
+end
 require 'log4r' #1.0.5
 
 module Rake
@@ -22,41 +28,33 @@ end
 
 
 module Rake4LaTeX
-  VERSION = '0.1.1'
-  
+  VERSION = '0.1.2'
+
   #With this creation we define the constants Log4r::DEBUG...
   Logger = Log4r::Logger.new("LaTeXRunner")
   Logger.outputters = Log4r::StdoutOutputter.new('log_stdout')
 
-=begin rdoc
-Sets a default option for the LaTeXRunner.
-
-The options are stored and used for new LaTeXRunners.
-
-Examples:
-  Rake4LaTeX.set_latexrunner_default(:maxruns, 1)
-  Rake4LaTeX.set_latexrunner_default(:loglevel, Log4r::DEBUG)
-  Rake4LaTeX.set_latexrunner_default(:program, xelatex)
-  Rake4LaTeX.set_latexrunner_default(:texerrors_allowed, true)
+  #
+  #Define the main settings for the runner.
+  #
+  #This values can be overwritten for each base file:
+  #   basefile = Rake4LaTeX::Basefile.set('filename')
+  #   basefile[:maxruns] =  1
+  #   basefile[:loglevel] =  Log4r::DEBUG
+  #   basefile[:program] =  :xelatex
+  #   basefile[:texerrors_allowed] =  true
+  #
+  DEFAULT_SETTINGS = {
+    :main_file => nil,  #only needed for key-check. Must be defined later.
+    :maxruns => 5,
+    :program => :pdflatex,  #Valid entries see PROGRAMS
+    :loglevel => Log4r::INFO,
+    :texerrors_allowed => false,
+  }
 
-You could also access LaTeXRunner::DEFAULT_SETTINGS directly.
-But with this method you get also a check if the option exists.
-=end
-  def self.set_latexrunner_default( key, option )
-    if ! LaTeXRunner::DEFAULT_SETTINGS.keys.include?(key)
-      raise ArgumentError, "Undefined key #{key.inspect} for LaTeXRunner" unless @latexrunner
-      Rake4LaTeX::Logger.warn("Undefined key #{key.inspect} for LaTeXRunner") if Rake4LaTeX::Logger.warn?
-    end
-    LaTeXRunner::DEFAULT_SETTINGS[key] = option
-    case key
-      when :program
-      if LaTeXRunner::PROGRAMS.keys.include?( option.to_sym )
-        LaTeXRunner::DEFAULT_SETTINGS[key] = option.to_sym
-      else
-        Rake4LaTeX::Logger.warn("Undefined programm #{option.inspect} for LaTeXRunner") if Rake4LaTeX::Logger.warn?
-      end
-    end
-  end
+  #Adaption per file:
+  # Rake4LaTeX::Basefile.set(basename)[:loglevel] =  Log4r::DEBUG
+  Logger.level = DEFAULT_SETTINGS[:loglevel]
   
 =begin rdoc
 Definition of the programms and there call parameters.
@@ -86,6 +84,7 @@ Load the Programs with parameters for Rake4LaTeX.build_cmd.
     #a src\lib\rake4latex\rake4latex.yaml    
     #a lib\ruby\gems\1.8\gems\rake4latex-0.1.0\lib\rake4latex\base.rb    
     "#{File.dirname(__FILE__)}/../../../../../../../../src/lib/rake4latex/rake4latex.yaml",  #for ocra-version (exe)
+    #fixme: user/local system specific settings
     "./rake4latex.yaml", #local re-definition
   ].each{| setting_file |
     if File.exist?(setting_file)
@@ -97,7 +96,6 @@ Load the Programs with parameters for Rake4LaTeX.build_cmd.
     raise "No program settings found"
   end
 
-
 =begin rdoc
 Build the command line to call a tool.
 
@@ -137,47 +135,177 @@ The keys must fit to the settings in Rake4LaTeX::Programms .
   
     cmd
   end
+=begin rdoc
+Define a basename.
+
+Set the file for clean/clobber, offers the possibility to set defaults,
+define a logger.
+=end
+  class Basefile
+    
+    @@all = {}
+    
+=begin rdoc    
+Get the basefile object or create a a new instance.
+=end
+    def self.set( basename, options = {} )
+      basename = basename.ext()
+      @@all[basename] = new(basename) unless @@all[basename]
+      options.each{|key, value| @@all[basename][key] = value }
+      @@all[basename]
+    end #set
+    
+=begin rdoc    
+Get the basefile object.
+=end
+    def self.[](key)
+      @@all[key.ext()]
+    end
+=begin rdoc
+Loop on all defined base files
+=end
+    def self.each()
+      @@all.each{|key, basefile| yield basefile }
+    end
+
+=begin rdoc
+Create a new basefile object.
+
+This is a private method.
+To create new objects, use Rake4LaTeX::Basefile.set
+=end
+    def initialize( basename, options = {} )
+      @basename = basename.ext('')
+      
+      @settings4LaTeXRunner = DEFAULT_SETTINGS.dup
+      
+      @logger = Log4r::Logger.new(@basename)
+      @logger.level = @settings4LaTeXRunner[:loglevel]
+
+      options.each{|key, value| self[key] = value }
+
+      @logger.outputters = Log4r::StdoutOutputter.new('log_stdout')
+      #~ @logger.info("Define base file #{@basename}")
+      
+      
+      set4clean()
+      define_tasks()    
+    end #basename#initialze
+    private_class_method :new #make it private
+
+    #Basename of the Basefile.
+    attr_reader :basename
+    #Get the logger
+    attr_reader :logger
+    #Settings for the LaTeXRunner. May be changed with Rake4LaTeX::Basefile#[]=
+    attr_reader :settings4LaTeXRunner
+=begin rdoc
+Defines document specific tasks (statistic, set clean and clobber)
+=end
+    def define_tasks()    
+      
+      namespace @basename do
+        desc "Create the statistic for #{@basename}"
+        task :statistic do
+          stat = Rake4LaTeX::TeX_Statistic.new(@basename)
+          puts "Statistic for #{@basename}:"
+          puts stat.stat_summary.map{|e| "  #{e}"}
+        end
+
+        desc "Build a log-overview for #{@basename}"
+        task :log_overview do
+            stat = Rake4LaTeX::TeX_Statistic.new(@basename)
+            puts stat.overview()
+        end
+
+        desc "Build a log-overview file for #{@basename}"
+        task :log_overview_file do
+            stat = Rake4LaTeX::TeX_Statistic.new(@basename)
+            #Filename also used in set4clean
+            File.open("#{@basename}.overview.txt", 'w'){|f| 
+              puts "Create #{f.path}"
+              f << stat.overview()
+            }
+        end
+
+      end  #namespace
+      
+      #Define the 'global' tasks.
+      task :statistic       => "#{@basename}:statistic"
+      task :log_overview => "#{@basename}:log_overview"
+      task :log_overview_file => "#{@basename}:log_overview_file"
+    end #define_tasks()
+
+
 =begin rdoc
 Define the files to be deleted with clean and clobber.
 
 There is no global definition to delete all files, 
 only the help file for the selected basename is taken.
 
-Helpfiles for splitindex are not added. You can do it manual:
-  CLEAN.add("testdocument-*") #splitidx-helpfiles
+This method is called by task 'basename' (Basefile#initialize)
+=end
+    def set4clean()
+      cleanlist = FileList.new("#{@basename}.{aux,log,out,toc,lot,lof,nav,snm}")
+      cleanlist.add("#{@basename}.{ilg,idx,ind}") #Index
+      cleanlist.add("#{@basename}-*.{ilg,idx,ind}") #splitindex.sty
+      cleanlist.add("#{@basename}.{blg,bbl}") #BibTeX
+      cleanlist.add("#{@basename}-blx.{bib}") #auxiliary file used by the 'biblatex' package
+      cleanlist.add("#{@basename}.*.{blg,bbl,aux}") #gloss.sty
+      cleanlist.add("#{@basename}.{maf,ptc*,mtc*,stc*}") #minitoc.sty (stc1, stc2...)
+      cleanlist.add("#{@basename}.{glo,gls}") #glossary.sty
+      #~ cleanlist.add("#{@basename}.{rai,rao,RAO}") #rail/rail.sty
+      cleanlist.add("#{@basename}.{rai,rao}") #rail/rail.sty
+      cleanlist.add("#{@basename}.{tdo}") #tdo: todonotes.sty
+      cleanlist.add("#{@basename}.{vrb}") #vrb: beamer.sty (verbatim)
+
+      clobberlist = FileList.new("#{@basename}.{dvi,pdf,ps}")
+      #The * is needed.else the filename is added always. With '*' it is checked for existence
+      clobberlist.add("#{@basename}.overview*.txt")  #rake4latex, task :log_overview
+      
+      CLEAN.include(cleanlist)
+      CLOBBER.include(clobberlist)
+
+      CLEAN.uniq!
+      CLOBBER.uniq!
+
+    end #set4clean
+
+=begin rdoc
+Sets a default option for the LaTeXRunner.
+
+The options are stored and used for new LaTeXRunners.
+
+Examples:
+  
+  basefile = Rake4LaTeX::Basefile.set('filename')
+  basefile[:maxruns] =  1
+  basefile[:loglevel] =  Log4r::DEBUG
+  basefile[:program] =  :xelatex
+  basefile[:texerrors_allowed] =  true
 
-This method is called by task 'basename'.
 =end
-  def self.set4clean( basename )
-    #fixme splitindex-dateien
-    FileList["#{basename.ext('*')}"].each do |file|
-      #Set the cleaning actions      
-      case file
-        when /\.(tex)\Z/
-        when /\.(aux|log|out|toc|lot|lof|nav|snm)\Z/
-          CLEAN.include(file)
-        when /\.(maf|ptc\d*|mtc\d*|stc\d*)\Z/ #minitoc
-          CLEAN.include(file)
-        when /\.(ilg|idx|ind)\Z/  #Index-Files
-          CLEAN.include(file)
-        when /\.(glo|gls)\Z/  #Glossary-Files
-          CLEAN.include(file)
-        when /\.(blg|bbl)\Z/  #BibTeX-Files
-          CLEAN.include(file)
-        when /\.(rai|rao|RAO)\Z/  #Rail-Files
-          CLEAN.include(file)
-        when /\.(dvi|pdf|ps)\Z/
-          CLOBBER.include(file)              
-        when /\.overview.txt\Z/ #rake4latex, task :log_overview
-          CLOBBER.include(file)              
-        else
-          #~ @logger.warn("Unknown help file #{file}")
+  def []=( key, option )
+    if ! settings4LaTeXRunner.keys.include?(key)
+      raise ArgumentError, "Undefined key #{key.inspect} for LaTeXRunner" unless @latexrunner
+      @ogger.warn("Undefined key #{key.inspect} for LaTeXRunner") if @ogger.warn?
+    end
+    settings4LaTeXRunner[key] = option
+    case key
+      when :program
+      if LaTeXRunner::PROGRAMS.keys.include?( option.to_sym )
+        settings4LaTeXRunner[key] = option.to_sym
+      else
+        @ogger.warn("Undefined programm #{option.inspect} for LaTeXRunner") if @logger.warn?
       end
     end
-    CLEAN.uniq!
-    CLOBBER.uniq!
-  end #set4clean
+  end
 
+
+    def inspect()
+      "#<Rake4LaTeX::Basefile #{@basename}>"
+    end
+  end #Basefile
 end #Rake4LaTeX