be9-rubbr 1.1.4.1

data/History.txt

@@ -0,0 +1,62 @@
+== 1.1.4.1 / 2009-01-20 (by be9)
+
+* Loop mode (--loop). Build, wait a bit, check for changes, rebuild if changed, repeat.
+* Build even if files were not changed since last build with --force option.
+* Bugfix: color was not reset in color messages.
+
+== 1.1.4 / 2008-06-20
+
+* Bugfix: Very verbose messages needs to come in addition to normal verbose
+  messages.
+
+== 1.1.3 / 2008-06-20
+
+* Overfull and underfull hbox output can now be shown specifically with -V
+  switch.
+
+== 1.1.2 / 2008-04-08
+
+* BiBTeX style files (*.bst) now are copied from the vendor dir to
+  the build dir if needed.
+
+== 1.1.1 / 2008-04-07
+
+* Bugfix: lib/rubbr/change.rb not included because of faulty manifest.
+
+== 1.1.1 / 2008-04-07
+
+* Support for colorized cli output.
+
+== 1.1.0 / 2008-04-06
+
+* Source files are now compiled only if they've changed since last build.
+
+== 1.0.6 / 2008-04-01
+
+* New option: more verbose output.
+* Somehow a graphic files were not copied to the builddir. This
+  was unnoticed since I've used the \graphicspath{} macro.
+
+== 1.0.5 / 2008-03-30
+
+* Small bugfixes and no default output on successful builds.
+
+== 1.0.4 / 2008-03-07
+
+* Added support for the pdflatex engine.
+
+== 1.0.3 / 2008-02-28
+
+* Rerun latex when labels are updated.
+
+== 1.0.2 / 2008-02-28
+
+* Exit program on errors and sort warnings
+
+== 1.0.1 / 2008-02-10
+
+* Many small bugfixes and code refactorings
+
+== 1.0.0 / 2008-02-01
+
+* First public release

data/Manifest.txt

@@ -0,0 +1,27 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/rubbr
+lib/rubbr.rb
+lib/rubbr/builder.rb
+lib/rubbr/change.rb
+lib/rubbr/cli.rb
+lib/rubbr/options.rb
+lib/rubbr/runner.rb
+lib/rubbr/scm.rb
+lib/rubbr/spell.rb
+lib/rubbr/viewer.rb
+lib/rubbr/builder/tex.rb
+lib/rubbr/builder/ps.rb
+lib/rubbr/builder/dvi.rb
+lib/rubbr/runner/ps2pdf.rb
+lib/rubbr/runner/pdflatex.rb
+lib/rubbr/runner/latex.rb
+lib/rubbr/runner/dvips.rb
+lib/rubbr/runner/bibtex.rb
+lib/rubbr/scm/subversion.rb
+lib/rubbr/scm/mercurial.rb
+lib/rubbr/viewer/ps.rb
+lib/rubbr/viewer/pdf.rb
+lib/rubbr/viewer/dvi.rb

data/README.txt

@@ -0,0 +1,78 @@
+= rubbr
+
+* http://rubyforge.org/projects/rubbr/
+* by Eivind Uggedal <eu@redflavor.com>
+
+== DESCRIPTION:
+  
+Build LaTeX documents.
+
+== SYNOPSIS:
+
+Usage: rubbr [options]
+  -f, --format [FORMAT]            Select output format (dvi, ps, pdf)
+  -F, --force                      Force rebuild (even if files not changed)
+  -e, --engine [ENGINE]            Select processing engine (latex, pdflatex)
+  -d, --display                    Display the document
+  -s, --spell                      Spell check source files
+  -l, --loop                       Go into a build loop
+  -D, --loop-delay [DELAY]         Set loop delay in seconds (default: 0.5)
+  -v, --verbose                    Enable verbose feedback
+  -V, --verboser                   Enable very verbose feedback
+  -h, --help                       Show this help message
+
+Standard project layout:
+
+  root_dir         = Dir.pwd
+  source_dir       = 'src'
+  
+  @defaults ||= {
+    :root_dir          => File.pwd,
+    :source_dir        => source_dir,
+    :build_dir         => 'tmp',
+    :distribution_dir  => 'dist',
+    :template_file     => 'template.erb',
+    :base_file         => 'base',
+    :vendor_dir        => source_dir + '/vendor',
+    :graphics_dir      => source_dir + '/graphics',
+    :spell_dir         => source_dir,
+    :spell_file        => 'dictionary.ispell',
+    :distribution_name => distribution_name(root_dir),
+    :loop_delay        => 0.5
+  }
+
+All these can be changed with a config.yml in the root_dir:
+
+  ---
+  build_dir: build
+  graphics_dir: src/figures
+
+
+== INSTALL:
+
+gem install rubbr
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Eivind Uggedal <eu@redflavor.com>
+
+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/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'hoe'
+require 'spec/rake/spectask'
+require './lib/rubbr.rb'
+
+Hoe.new('rubbr', Rubbr::VERSION) do |p|
+  p.rubyforge_name = 'rubbr'
+  p.author = 'Eivind Uggedal'
+  p.email = 'eu@redflavor.com'
+  p.summary = 'LaTeX builder'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ''
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('specs') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['specs/*_spec.rb'].sort
+end
+
+task :cultivate do
+  system "touch Manifest.txt; rake check_manifest | grep -v \"(in \" | patch"
+  system "rake debug_gem | grep -v \"(in \" > `basename \\`pwd\\``.gemspec"
+end

data/bin/rubbr

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rubbr'
+
+Rubbr.run

data/lib/rubbr/builder/dvi.rb

@@ -0,0 +1,18 @@
+module Rubbr
+  module Builder
+    class Dvi < Base
+      def self.build
+        @output_format = 'ps'
+        base_dvi_file = Rubbr.options[:base_dvi_file]
+
+        build_dir do
+          dvips = Rubbr::Runner::DviPs.new(base_dvi_file)
+        end
+
+        distribute_file(base_dvi_file)
+        notice "Build of #{@output_format} completed for: #{base_dvi_file} " +
+               "in #{Rubbr.options[:build_dir]}"
+      end
+    end
+  end
+end

data/lib/rubbr/builder/ps.rb

@@ -0,0 +1,18 @@
+module Rubbr
+  module Builder
+    class Ps < Base
+      def self.build
+        @output_format = 'pdf'
+        base_ps_file = Rubbr.options[:base_ps_file]
+
+        build_dir do
+          dvips = Rubbr::Runner::Ps2Pdf.new(base_ps_file)
+        end
+
+        distribute_file(base_ps_file)
+        notice "Build of #{@output_format} completed for: #{base_ps_file} " +
+               "in #{Rubbr.options[:build_dir]}"
+      end
+    end
+  end
+end

data/lib/rubbr/builder/tex.rb

@@ -0,0 +1,88 @@
+module Rubbr
+  module Builder
+    class Tex < Base
+      class << self
+        def build
+
+          clean_build_dir
+
+          base_latex_file = Rubbr.options[:base_latex_file]
+          base_bibtex_file = Rubbr.options[:base_bibtex_file]
+
+          case Rubbr.options[:engine]
+          when :pdflatex
+            @output_format = :pdf
+            preprocessor = Rubbr::Runner::PdfLaTeX
+          else
+            @output_format = :dvi
+            preprocessor = Rubbr::Runner::LaTeX
+          end
+
+          build_dir do
+            copy_source_files
+            copy_vendor_files
+            copy_graphic_files
+
+            # first run
+            latex = preprocessor.new(base_latex_file)
+
+            if base_bibtex_file && latex.warnings.join =~ /No file .+\.bbl/
+              bibtex = Rubbr::Runner::BibTeX.new(base_bibtex_file)
+            end
+
+            if latex.warnings.join =~ /No file .+\.(aux|toc)/
+              latex = preprocessor.new(base_latex_file)
+            end
+
+            if latex.warnings.join =~ /There were undefined citations/
+              latex = preprocessor.new(base_latex_file)
+            end
+
+            if latex.warnings.join =~ /Label\(s\) may have changed\. Rerun/
+              latex = preprocessor.new(base_latex_file)
+            end
+
+            # last run needed to get lof to be proper
+            latex = preprocessor.new(base_latex_file)
+
+            latex.feedback
+            if bibtex
+              bibtex.feedback
+            end
+          end
+          distribute_file(base_latex_file)
+          notice "Build of #@output_format completed for: #{base_latex_file} " +
+                 "in #{Rubbr.options[:build_dir]}"
+        end
+
+        private
+
+          def clean_build_dir
+            if File.exists? Rubbr.options[:build_dir]
+              FileUtils.rm_r Rubbr.options[:build_dir]
+            end
+          end
+
+          def copy_source_files
+            copy_files(Rubbr.options[:source_dir], %w(tex bib cls))
+          end
+
+          def copy_vendor_files
+            copy_files(Rubbr.options[:vendor_dir], %w(sty clo cls cfg bst))
+          end
+
+          def copy_graphic_files
+            copy_files(Rubbr.options[:graphics_dir], %w(eps mps png))
+          end
+
+          def copy_files(source_dir, file_extensions)
+            file_extensions.each do |file_extension|
+              Dir["#{source_dir}/*.#{file_extension}"].each do |file|
+                FileUtils.cp(file,  Rubbr.options[:build_dir])
+              end
+            end
+          end
+      end
+    end
+  end
+end

data/lib/rubbr/builder.rb

@@ -0,0 +1,101 @@
+require 'fileutils'
+
+module Rubbr
+
+  # Handles the business of building latex (and bibtex if needed) source
+  # files into binary formats as dvi, ps, and pdf. The latex and bibtex
+  # utilites need to be run a certain number of times so that things like
+  # table of contents, references, citations, etc become proper. This module
+  # tries to solve this issue by running the needed utilities only as many
+  # times as needed.
+  module Builder
+    extend Rubbr::Cli
+
+    # Build to the spesified format.
+    def self.build
+      if Rubbr::Change.d?
+        do_build
+      elsif Rubbr.options[:force]
+        notice "No changes in #{Rubbr.options[:build_dir]} since last build, building anyway (--force)"
+        do_build
+      else 
+        notice "No changes in #{Rubbr.options[:build_dir]} since last build"
+      end
+    end
+
+    def self.build_in_a_loop
+      delay = Rubbr.options[:loop_delay]
+      delay = 0.5 if delay == 0.0
+
+      notice "Entering build loop. Press Ctrl-C to break out."
+
+      while true
+        if Rubbr::Change.d?
+          notice "Change detected, building"
+
+          do_build
+        end
+
+        sleep delay
+      end
+    end
+
+    def self.do_build
+      if Rubbr.options[:engine] == :pdflatex
+        Rubbr::Builder::Tex.build
+      else
+        case Rubbr.options[:format]
+        when :dvi
+          Rubbr::Builder::Tex.build
+        when :ps
+          Rubbr::Builder::Tex.build
+          Rubbr::Builder::Dvi.build
+        else
+          Rubbr::Builder::Tex.build
+          Rubbr::Builder::Dvi.build
+          Rubbr::Builder::Ps.build
+        end
+      end
+    end
+
+    class Base
+      class << self
+        include Rubbr::Cli
+
+        protected
+
+          def build_dir
+            prepare_dir(Rubbr.options[:build_dir]) do
+              yield
+            end
+          end
+
+          def distribute_file(base_file)
+            prepare_dir(Rubbr.options[:distribution_dir]) do
+              FileUtils.cp(File.join(Rubbr.options[:build_dir],
+                           "#{base_file.gsub(/.\w+$/, '')}.#@output_format"),
+                 File.join(Rubbr.options[:distribution_dir],
+                           Rubbr.options[:distribution_name] +
+                           ".#@output_format"))
+            end
+          end
+
+          def prepare_dir(dir)
+            if dir
+              FileUtils.mkdir_p dir unless File.exists? dir
+              FileUtils.cd dir do
+                yield
+              end
+            else
+              yield
+            end
+          end
+      end
+    end
+
+    %w(tex dvi ps).each do
+      |f| require File.dirname(__FILE__) + "/builder/#{f}"
+    end
+  end
+end
+

data/lib/rubbr/change.rb

@@ -0,0 +1,47 @@
+module Rubbr
+
+  # Checks if source files have changed since last time they was accessed by
+  # computing and storing a hash of their contents.
+  class Change
+    require 'digest/md5'
+    require 'yaml'
+
+    def self.d?
+      sums = inventory
+      if changes?(sums)
+        write_inventory sums
+        true
+      else
+        false
+      end
+    end
+
+    private
+
+      def self.inventory
+        source_files = Dir["#{Rubbr.options[:source_dir]}/*.tex"]
+        source_files.collect do |f|
+          [f, digest(File.read(f))]
+        end
+      end
+
+      def self.write_inventory(sums)
+        File.open(Rubbr.options[:inventory_file], 'w') do |f|
+          f.write(sums.to_yaml)
+        end
+      end
+
+      def self.read_inventory
+        YAML.load_file(Rubbr.options[:inventory_file])
+      end
+
+      def self.changes?(sums)
+        return true unless File.exists?(Rubbr.options[:inventory_file])
+        sums != read_inventory
+      end
+
+      def self.digest(contents)
+        Digest::MD5.hexdigest contents
+      end
+  end
+end

data/lib/rubbr/cli.rb

@@ -0,0 +1,58 @@
+module Rubbr
+
+  # Handles command line output and input.
+  module Cli
+    def notice(message)
+      puts color?(message, "\e[32m") if Rubbr.options[:verbose]
+    end
+
+    def warning(message)
+      puts color?("  - #{message}", "\e[33m") if Rubbr.options[:verbose]
+    end
+
+    def error(message)
+      puts color?("  * #{message}", "\e[31m")
+    end
+
+    def color?(msg, code)
+      Rubbr.options[:color] ? "#{code}#{msg}\e[0m" : msg
+    end
+
+    def disable_stdout
+      old_stdout = STDOUT.dup
+      STDOUT.reopen('/dev/null')
+      yield
+      STDOUT.reopen(old_stdout)
+    end
+
+    def disable_stderr
+      old_stderr = STDERR.dup
+      STDERR.reopen('/dev/null')
+      yield
+      STDERR.reopen(old_stderr)
+    end
+
+    def disable_stdinn
+      old_stdinn = STDIN.dup
+      STDIN.reopen('/dev/null')
+      yield
+      STDIN.reopen(old_stdinn)
+    end
+
+    def executable?(executable)
+      disable_stdout do
+        @existing = system("which #{executable}")
+      end
+      @existing
+    end
+
+    def valid_executable(executable)
+      if executable?(executable)
+        executable
+      else
+        error "Missing executable #{executable}"
+        exit
+      end
+    end
+  end
+end

data/lib/rubbr/options.rb

@@ -0,0 +1,77 @@
+module Rubbr
+  class Options
+    class << self
+      include Rubbr::Cli
+      def defaults
+        root_dir         = Dir.pwd
+        source_dir       = 'src'
+
+        @defaults ||= {
+          :root_dir          => root_dir,
+          :source_dir        => source_dir,
+          :build_dir         => 'tmp',
+          :distribution_dir  => 'dist',
+          :base_file         => 'base',
+          :vendor_dir        => source_dir + '/vendor',
+          :graphics_dir      => source_dir + '/graphics',
+          :spell_dir         => source_dir,
+          :spell_file        => 'dictionary.ispell',
+          :inventory_file    => '.inventory',
+          :distribution_name => distribution_name(root_dir),
+          :verbose           => false,
+          :verboser          => false,
+          :color             => false,
+          :format            => :dvi,
+          :engine            => :latex,
+          :loop_delay        => 0.5
+        }
+      end
+
+      # Fetching options from a config file if present and merges it
+      # with the defaults.
+      def setup
+        preference_file = "#{defaults[:root_dir]}/config.yml"
+        preferences = {}
+        if File.exists? preference_file
+          require 'yaml'
+          File.open(preference_file) { |file| preferences = YAML.load(file) }
+        end
+        base_file_variations(absolute_paths(defaults.merge(preferences)))
+      end
+
+      private
+
+        def distribution_name(root)
+          name = File.basename(root)
+          name << ".#{user_name}"
+          if stats = Rubbr::Scm.stats(root)
+            name << ".r#{stats[:revision].gsub(':', '_')}"
+          end
+          name
+        end
+
+        def user_name
+          `whoami`.strip
+        end
+
+        def absolute_paths(options)
+          options.each_key do |key|
+            if key.to_s =~ /\w+_dir/ && key != :root_dir
+              options[key.to_sym] = File.join(options[:root_dir],
+                                              options[key.to_sym])
+            end
+          end
+          options
+        end
+
+        def base_file_variations(options)
+          options[:base_latex_file]  = options[:base_file] + '.tex'
+          options[:base_bibtex_file] = options[:base_file] + '.aux'
+          options[:base_dvi_file]    = options[:base_file] + '.dvi'
+          options[:base_ps_file]     = options[:base_file] + '.ps'
+          options[:base_pdf_file]    = options[:base_file] + '.pdf'
+          options
+        end
+    end
+  end
+end

data/lib/rubbr/runner/bibtex.rb

@@ -0,0 +1,15 @@
+module Rubbr
+  module Runner
+    class BibTeX < Base
+      def initialize(input_file, executable='bibtex')
+        super
+      end
+
+      def run
+        messages = /^I (found no|couldn't open)/
+        @warnings = `#@executable #@input_file`.grep(messages)
+        feedback
+      end
+    end
+  end
+end

data/lib/rubbr/runner/dvips.rb

@@ -0,0 +1,16 @@
+module Rubbr
+  module Runner
+    class DviPs < Base
+      def initialize(input_file, executable='dvips')
+        super
+      end
+
+      def run
+        disable_stderr do
+          @warnings = `#@executable -Ppdf #@input_file`.split("\n")
+        end
+        feedback
+      end
+    end
+  end
+end

data/lib/rubbr/runner/latex.rb

@@ -0,0 +1,9 @@
+module Rubbr
+  module Runner
+    class LaTeX < Base
+      def initialize(input_file, executable='latex')
+        super
+      end
+    end
+  end
+end

data/lib/rubbr/runner/pdflatex.rb

@@ -0,0 +1,9 @@
+module Rubbr
+  module Runner
+    class PdfLaTeX < Base
+      def initialize(input_file, executable='pdflatex')
+        super
+      end
+    end
+  end
+end

data/lib/rubbr/runner/ps2pdf.rb

@@ -0,0 +1,15 @@
+module Rubbr
+  module Runner
+    class Ps2Pdf < Base
+      def initialize(input_file, executable='ps2pdf')
+        super
+      end
+
+      def run
+        disable_stderr do
+          @warnings = `#@executable #@input_file`.split("\n")
+        end
+      end
+    end
+  end
+end

data/lib/rubbr/runner.rb

@@ -0,0 +1,93 @@
+module Rubbr
+
+  # Takes care of running latex and related utilities. Gives helpful
+  # information if input files are missing and also cleans up the output of
+  # these utilities.
+  module Runner
+    class Base
+      include Rubbr::Cli
+
+      # The file to be run trough the latex process.
+      attr_accessor :input_file
+
+      # The executable to be run.
+      attr_accessor :executable
+
+      # Contains a list of possible warnings after a run.
+      attr_accessor :warnings
+
+      # Contains a list of possible verboser warnings after a run.
+      attr_accessor :verboser_warnings
+
+      # Contains a list of possible errors after a run.
+      attr_accessor :errors
+
+      def initialize(input_file, executable)
+        @input_file = input_file
+        @executable = valid_executable executable
+        @verboser_warnings = []
+        @errors = []
+
+        if File.exists? @input_file
+          run
+        else
+          error "Running of #@executable aborted. " +
+                "Input file: #@input_file not found"
+        end
+      end
+
+      def run
+        disable_stdinn do # No input in case of error correction dialogue
+          messages = /^(Overfull|Underfull|No file|Package \w+ Warning:|LaTeX Warning:)/
+          verbose_messages = /^(Overfull \\hbox|Underfull \\hbox)/
+
+          run = `#@executable #@input_file`
+          lines = run.split("\n")
+          @warnings = run.grep(messages).sort
+
+          if Rubbr.options[:verboser]
+
+            lines.each_with_index do |line, i|
+              if line =~ verbose_messages
+                @verboser_warnings << line
+                @verboser_warnings << lines[i+1]
+              end
+            end
+          end
+
+          while lines.shift
+            if lines.first =~ /^!/ # LaTeX Error, processing halted
+              3.times { @errors << lines.shift }
+            end
+          end
+        end
+      end
+
+      def feedback
+        unless @warnings.empty?
+          notice "Warnings from #@executable:"
+          @warnings.each do |message|
+            warning message
+          end
+        end
+        unless @verboser_warnings.empty?
+          notice "Verboser warnings from #@executable:"
+          @verboser_warnings.each do |message|
+            warning message
+          end
+        end
+        unless @errors.empty?
+          notice "Errors from #@executable:"
+          @errors.each do |message|
+            error message
+          end
+          exit
+        end
+      end
+    end
+
+    %w(latex bibtex dvips ps2pdf pdflatex).each do
+      |f| require File.dirname(__FILE__) + "/runner/#{f}"
+    end
+  end
+end

data/lib/rubbr/scm/mercurial.rb

@@ -0,0 +1,31 @@
+module Rubbr
+
+  # Extracts changeset stats from various SCM systems. This info can be
+  # included in the title page of the latex document and is especially helpful
+  # when working with draft versions.
+  module Scm
+    class Mercurial < Base
+
+      def initialize
+        super
+
+        @name = 'Mercurial'
+        @executable = valid_executable :hg
+
+        @revision, @date = parse_scm_stats
+
+        yield self if block_given?
+      end
+
+      def parse_scm_stats
+        return [nil, nil] unless @executable
+
+        raw_stats = `#@executable tip`
+        revision = raw_stats.scan(/^changeset: +(.+)/).first.first
+        date = raw_stats.scan(/^date: +(.+)/).first.first
+
+        [revision, date]
+      end
+    end
+  end
+end

data/lib/rubbr/scm/subversion.rb

@@ -0,0 +1,31 @@
+module Rubbr
+
+  # Extracts changeset stats from various SCM systems. This info can be
+  # included in the title page of the latex document and is especially helpful
+  # when working with draft versions.
+  module Scm
+    class Subversion < Base
+
+      def initialize
+        super
+
+        @name = 'Subversion'
+        @executable = valid_executable :svn
+
+        @revision, @date = parse_scm_stats
+
+        yield self if block_given?
+      end
+
+      def parse_scm_stats
+        return [nil, nil] unless @executable
+
+        raw_stats = `#@executable info`
+        revision = raw_stats.scan(/^Revision: (\d+)/).first.first
+        date = raw_stats.scan(/^Last Changed Date: (.+)/).first.first
+
+        [revision, date]
+      end
+    end
+  end
+end

data/lib/rubbr/scm.rb

@@ -0,0 +1,38 @@
+module Rubbr
+
+  # Extracts changeset stats from various SCM systems. This info can be
+  # included in the title page of the latex document and is especially helpful
+  # when working with draft versions.
+  module Scm
+    class Base
+      include Rubbr::Cli
+
+      # The name of the SCM system. 
+      attr_accessor :name
+
+      # The Mercurial executable.
+      attr_accessor :executable
+
+      # The revision and date of the tip/head/latest changeset.
+      attr_accessor :revision, :date
+
+      def collect_scm_stats
+        { :name => @name,
+          :revision => @revision,
+          :date => @date }
+      end
+    end
+
+    def self.stats(dir)
+      if File.exists? File.join(dir, '.svn')
+        Rubbr::Scm::Subversion.new.collect_scm_stats
+      elsif File.exists? File.join(dir, '.hg')
+        Rubbr::Scm::Mercurial.new.collect_scm_stats
+      end
+    end
+
+    %w(mercurial subversion).each do
+      |f| require File.dirname(__FILE__) + "/scm/#{f}"
+    end
+  end
+end

data/lib/rubbr/spell.rb

@@ -0,0 +1,20 @@
+module Rubbr
+  class Spell
+    include Rubbr::Cli
+
+    def check
+      base_file_path = File.join(Rubbr.options[:source_dir],
+                                 Rubbr.options[:base_latex_file])
+      source_files = Dir["#{Rubbr.options[:source_dir]}/*.tex"]
+      source_files.delete base_file_path
+
+      dictionary_path = File.join(Rubbr.options[:spell_dir],
+                                  Rubbr.options[:spell_file])
+      executable = valid_executable(:ispell)
+
+      source_files.each do |file|
+        system "#{executable} -t -x -p #{dictionary_path} #{file}"
+      end
+    end
+  end
+end

data/lib/rubbr/viewer/dvi.rb

@@ -0,0 +1,11 @@
+module Rubbr
+  module Viewer
+    class Dvi < Base
+      def initialize(*args)
+        super
+        @view_name = 'dvi'
+        @executables = %w(evince xdvi kdvi)
+      end
+    end
+  end
+end

data/lib/rubbr/viewer/pdf.rb

@@ -0,0 +1,11 @@
+module Rubbr
+  module Viewer
+    class Pdf < Base
+      def initialize(*args)
+        super
+        @view_name = 'pdf'
+        @executables = %w(evince acroread xpdf gv)
+      end
+    end
+  end
+end

data/lib/rubbr/viewer/ps.rb

@@ -0,0 +1,11 @@
+module Rubbr
+  module Viewer
+    class Ps < Base
+      def initialize(*args)
+        super
+        @view_name = 'ps'
+        @executables = %w(evince gv)
+      end
+    end
+  end
+end

data/lib/rubbr/viewer.rb

@@ -0,0 +1,56 @@
+module Rubbr
+  module Viewer
+
+    # View the spesified format.
+    def self.view
+      if Rubbr.options[:engine] == :pdflatex
+        Rubbr::Viewer::Pdf.new.launch
+      else
+        case Rubbr.options[:format]
+        when :dvi
+          Rubbr::Viewer::Dvi.new.launch
+        when :ps
+          Rubbr::Viewer::Ps.new.launch
+        else
+          Rubbr::Viewer::Pdf.new.launch
+        end
+      end
+    end
+
+    class Base
+      include Rubbr::Cli
+
+      # The name prefix of the distribution file. 
+      attr_accessor :distribution_name
+
+      def distribution_file
+        File.join(Rubbr.options[:distribution_dir],
+                  "#@distribution_name.#@view_name")
+      end
+
+      def initialize
+        @distribution_name = Rubbr.options[:distribution_name]
+
+        @view_name = 'base'
+        @executables = []
+      end
+
+      def find_viewer
+        @executables.each do |executable|
+          return executable if executable? executable
+        end
+      end
+
+      def launch
+        return unless viewer = find_viewer
+        fork { exec "#{viewer} #{distribution_file}" }
+        notice "Display of #@view_name completed for: #{@distribution_name}" +
+               ".#@view_name in #{Rubbr.options[:distribution_dir]}"
+      end
+    end
+
+    %w(dvi ps pdf).each do
+      |f| require File.dirname(__FILE__) + "/viewer/#{f}"
+    end
+  end
+end

data/lib/rubbr.rb

@@ -0,0 +1,101 @@
+require 'optparse'
+$:.unshift File.dirname(__FILE__)
+
+module Rubbr
+  VERSION = '1.1.4.1'
+
+  autoload :Options,       'rubbr/options'
+  autoload :Cli,           'rubbr/cli'
+  autoload :Config,        'rubbr/config'
+  autoload :Scm,           'rubbr/scm'
+  autoload :Change,        'rubbr/change'
+  autoload :Runner,        'rubbr/runner'
+  autoload :Builder,       'rubbr/builder'
+  autoload :Viewer,        'rubbr/viewer'
+  autoload :Spell,         'rubbr/spell'
+
+  class << self
+    @@cmd_opts = {}
+
+    def options
+      @@global_opts ||= Rubbr::Options.setup.merge(@@cmd_opts)
+    end
+
+    def run(args = ARGV)
+      opts = OptionParser.new do |opts|
+        opts.version = Rubbr::VERSION
+        opts.banner = 'Usage: rubbr [options]'
+
+        opts.on('-f', '--format [FORMAT]', [:dvi, :ps, :pdf],
+          'Select output format (dvi, ps, pdf)') do |format|
+          @@cmd_opts[:format] = format
+        end
+        
+        opts.on('-F', '--force', 'Force rebuild (even if files not changed)') do
+          @@cmd_opts[:force] = true
+        end
+
+        opts.on('-e', '--engine [ENGINE]', [:pdflatex, :ps, :pdf],
+          'Select processing engine (latex, pdflatex)') do |engine|
+          @@cmd_opts[:engine] = engine
+        end
+
+        opts.on('-d', '--display', 'Display the document') do
+          @@cmd_opts[:view] = true
+        end
+
+        opts.on('-s', '--spell', 'Spell check source files') do
+          @@cmd_opts[:spell] = true
+        end
+        
+        opts.on('-l', '--loop', 'Go into a build loop') do
+          @@cmd_opts[:loop] = true
+        end
+        
+        opts.on('-D', '--loop-delay [DELAY]', Float, 'Set loop delay in seconds (default: 0.5)') do |delay|
+          @@cmd_opts[:loop_delay] = delay
+        end
+
+        opts.on('-v', '--verbose', 'Enable verbose feedback') do
+          @@cmd_opts[:verbose] = true
+        end
+
+        opts.on('-V', '--verboser', 'Enable verbose feedback for hboxes') do
+          @@cmd_opts[:verbose] = true
+          @@cmd_opts[:verboser] = true
+        end
+
+        opts.on('-c', '--color', 'Enable colorized feedback') do
+          @@cmd_opts[:color] = true
+        end
+
+        opts.on('-h', '--help', 'Show this help message') do
+          puts opts
+          exit 1
+        end
+      end
+
+      begin
+        opts.parse!(args)
+      rescue OptionParser::ParseError
+        puts opts
+        exit 1
+      end
+
+      case
+      when @@cmd_opts[:spell]
+        Rubbr::Spell.new.check
+
+      when @@cmd_opts[:view]
+        Rubbr::Builder.build
+        Rubbr::Viewer.view
+
+      when @@cmd_opts[:loop]
+        Rubbr::Builder.build_in_a_loop
+
+      else
+        Rubbr::Builder.build
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: be9-rubbr
+version: !ruby/object:Gem::Version 
+  version: 1.1.4.1
+platform: ruby
+authors: 
+- Eivind Uggedal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-20 00:00:00 -08:00
+default_executable: rubbr
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: Build LaTeX documents.
+email: eu@redflavor.com
+executables: 
+- rubbr
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/rubbr
+- lib/rubbr.rb
+- lib/rubbr/builder.rb
+- lib/rubbr/change.rb
+- lib/rubbr/cli.rb
+- lib/rubbr/options.rb
+- lib/rubbr/runner.rb
+- lib/rubbr/scm.rb
+- lib/rubbr/spell.rb
+- lib/rubbr/viewer.rb
+- lib/rubbr/builder/tex.rb
+- lib/rubbr/builder/ps.rb
+- lib/rubbr/builder/dvi.rb
+- lib/rubbr/runner/ps2pdf.rb
+- lib/rubbr/runner/pdflatex.rb
+- lib/rubbr/runner/latex.rb
+- lib/rubbr/runner/dvips.rb
+- lib/rubbr/runner/bibtex.rb
+- lib/rubbr/scm/subversion.rb
+- lib/rubbr/scm/mercurial.rb
+- lib/rubbr/viewer/ps.rb
+- lib/rubbr/viewer/pdf.rb
+- lib/rubbr/viewer/dvi.rb
+has_rdoc: true
+homepage: http://rubyforge.org/projects/rubbr/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rubbr
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: LaTeX builder
+test_files: []
+