Bump the version to 0.9

* The viewer now sends `SIGHUP` to the main process when it exists
* The main process signal handler kills the viewer and terminates the
  notifier/main event loop when receiving `SIGINT`/`SIGTERM`/`SIGQUIT`
* The main process signal handler just terminates the notifier/main
  event loop when receiving `SIGHUP`
* Clean just after the notifier/main loop finishes

TODO.md

@@ -0,0 +1,8 @@
+ToDo items for rubberin
+=======================
+
+* Add options to track additional files.
+* Add some (pre/post-)compile hooks.
+* Don't destroy ARGV, just track if it contains --ps/--pdf/--help.
+* Add a verbose (-v) and debug (-d) mode.
+* Add configurability of default compile modes and used viewers.

rubberin

@@ -13,29 +13,31 @@
 # the result of the LaTeX compilation and forces it to reload every time
 # rubberin has recompiled the LaTeX file.
 #
-# This program is free software; you can redistribute it and/or modify it 
-# under the terms of the GNU General Public License as published by the 
-# Free Software Foundation; either version 2 of the License, or (at your 
-# option) any later version.  
-#  
-# This program is distributed in the hope that it will be useful, but 
-# WITHOUT ANY WAR RANTY; without even the implied warranty of 
+# This program is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WAR RANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
 
-# Public License for more details.  
-#  
-# You should have received a copy of the GNU General Public License along 
-# with this p rogram; if not, write to the Free Software Foundation, Inc., 
+# Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
 # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 
-require 'getoptlong'
-require 'inotify'
-require 'pathname'
+require "English"
+require "getoptlong"
+require "rb-inotify"
+require "pathname"
 
 # Small necessary Pathname class extension.
 class Pathname
   def extname=(ext)
-    raise "Invalid extension" unless ext.is_a? String and ext.match(/^\./)
+    raise "Invalid extension" unless ext.is_a?(String) && ext.match(/^\./)
+
     @path.sub!(/#{extname}$/, ext)
   end
 end
@@ -44,7 +46,7 @@ end
 
 # Print the usage.
 def usage
-  puts "Usage: #{Program} [options]... [tex-file] [rubber-options]..."
+  puts "Usage: #{PROGRAM} [options]... [tex-file] [rubber-options]..."
 end
 
 # Print the command line help.
@@ -62,11 +64,11 @@ end
 
 # Compile the input file using the right options based on the mode.
 def compile(infile, mode)
-  mode_opt = {:pdf   => "--pdf",
-              :ps    => "--ps", 
-              :pspdf => "--ps --pdf"}[mode]
-  params = ARGV.join(' ')
-  err_file = infile.with_extname('err')
+  mode_opt = { pdf: "--pdf",
+               ps: "--ps",
+               pspdf: "--ps --pdf" }[mode]
+  params = ARGV.join(" ")
+  err_file = infile.with_extname("err")
 
   system "rubber --inplace #{mode_opt} #{params} #{infile} 2> #{err_file}"
   File.open(err_file) { |file| puts file.read }
@@ -75,64 +77,75 @@ end
 # Start the right viewer based on the mode.
 def view(infile, mode)
   case mode
-    when :dvi
-      exec "xdvi.bin", "-watchfile", "1", 
-                       "-name", "xdvi",  infile.with_extname('dvi')
-    when :ps
-      exec "evince", infile.with_extname('ps')
-    when :pdf, :pspdf
-      exec "evince", infile.with_extname('pdf')
+  when :dvi
+    system "xdvi.bin",
+           "-watchfile", "1",
+           "-name", "xdvi", infile.with_extname("dvi").to_s
+  when :ps
+    system "evince", infile.with_extname("ps").to_s
+  when :pdf, :pspdf
+    system "evince", infile.with_extname("pdf").to_s
   end
 end
 
+# Clean up cruft related to compilation of the input file.
+def clean(infile)
+  err_file = infile.with_extname("err")
+  File.unlink(err_file) if err_file.exist?
+  system "rubber --clean --inplace #{infile}"
+end
+
 # Reload the right viewer based on the mode.
 def reload(infile, mode)
   case mode
-    when :ps
-      system "evince", infile.with_extname('ps')
-    when :pdf, :pspdf
-      system "evince", infile.with_extname('pdf')
+  when :ps
+    system "evince", infile.with_extname("ps").to_s
+  when :pdf, :pspdf
+    system "evince", infile.with_extname("pdf").to_s
   end
 end
 
 ## Initialisation
-Program = File.basename $0
-Version = '0.4a'
+PROGRAM = File.basename($PROGRAM_NAME).freeze
+VERSION = "0.9".freeze
 
 # Parse the command line options.
 # Determine the compile mode from the options.
 mode = :dvi
-opts = GetoptLong.new(
-                      [ "--help", "-h", GetoptLong::NO_ARGUMENT ],
-                      [ "--ps",   "-p", GetoptLong::NO_ARGUMENT ],
-                      [ "--pdf",  "-d", GetoptLong::NO_ARGUMENT ])
+opts = GetoptLong.new(["--help",    "-h", GetoptLong::NO_ARGUMENT],
+                      ["--ps",      "-p", GetoptLong::NO_ARGUMENT],
+                      ["--pdf",     "-d", GetoptLong::NO_ARGUMENT],
+                      ["--version", "-v", GetoptLong::NO_ARGUMENT])
 opts.ordering = GetoptLong::REQUIRE_ORDER
 opts.quiet = true
-opts.each do |opt, arg|
+opts.each do |opt, _arg|
   case opt
-    when "--help"
-      help
-      exit 0
-    when "--ps"
-      mode = :ps
-    when "--pdf"
-      mode = if mode == :ps then :pspdf
-             else :pdf
-             end
+  when "--help"
+    help
+    exit 0
+  when "--ps"
+    mode = :ps
+  when "--pdf"
+    mode = if mode == :ps
+             :pspdf
+           else
+             :pdf
+           end
+  when "--version"
+    puts "#{PROGRAM} #{VERSION}"
+    exit 0
   end
 end
 
 # Get the input file from the arguments.
-if ARGV.length < 1
+if ARGV.empty?
   usage
   exit 1
 else
   infile = Pathname.new(ARGV.shift)
-  def infile.base
-    self.basename(self.extname)
-  end
+
   def infile.with_extname(ext)
-    file = self.base
+    file = dirname + basename(extname)
     file.extname = ".#{ext}"
     file
   end
@@ -141,37 +154,58 @@ end
 # Check the input file.
 begin
   File.open(infile) {}
-rescue => err
-  puts "#{Program}: #{err}"
+rescue SystemCallError => e
+  puts "#{PROGRAM}: #{e}"
   exit 2
 end
 
-# Find the dependancies of the input file using rubber-info and
+# Find the dependencies of the input file using rubber-info and
 # do an initial run.
 files = `rubber-info --deps #{infile}`.chomp.split
 compile(infile, mode)
+puts
 
 # Spawn a viewer based on the mode.
-viewer_pid = fork
-view(infile, mode) if not viewer_pid
-
-# Handle signals.
-["INT", "TERM", "QUIT"].each do |sig|
-  Signal.trap(sig) { Process.kill(sig, viewer_pid); exit }
-end
-# If xdvi exits, this program should exit too.
-Signal.trap("CLD") { puts "#{Program}: viewer exited, so will I!"; exit }
+pid = $PROCESS_ID
+viewer_pid =
+  fork do
+    view(infile, mode)
+    # If xdvi/evince exits, this program should exit too.
+    puts "#{PROGRAM}: viewer exited, so will I!"
+    Process.kill("HUP", pid)
+  end
 
 ## Main event loop
 
 # Add input file with dependancies to the watch list and start event loop.
-i = Inotify.new
-files.each do |file|
-  i.add_watch(file, Inotify::MODIFY)
+notifier = INotify::Notifier.new
+dirs = files.map { |file| Pathname.new(file).dirname }.uniq
+dirs.each do |dir|
+  # Set up a watch per directory
+  notifier.watch(dir.to_s, :close_write) do |ev|
+    # Only compile if a dependency of the input file has been modified
+    file_path = (dir + ev.name).to_s
+    next unless files.include? file_path
+
+    puts "#{PROGRAM}: file #{ev.name} modified, compiling #{infile}..."
+    compile(infile, mode)
+    reload(infile, mode)
+    puts
+  end
 end
-# Process the events, recompile and reload when necessary.
-i.each_event do |ev|
-  puts "I: file #{ev.name} modified, compiling #{infile}..."
-  compile(infile, mode)
-  reload(infile, mode)
+
+# Handle signals during the main event loop.
+["INT", "TERM", "QUIT"].each do |sig|
+  Signal.trap(sig) do
+    puts "#{PROGRAM}: caught signal #{sig}, stopping the viewer..."
+    Process.kill(sig, viewer_pid)
+    notifier.stop
+  end
 end
+Signal.trap("HUP") { notifier.stop }
+
+# Run the main event loop.
+notifier.run
+
+# Clean before finishing!
+clean(infile)