texas 0.1.6 → 0.1.7

data/lib/texas/build/task/add_default_templates_to_build_path.rb

@@ -1,6 +1,10 @@
 module Texas
   module Build
     module Task
+      # This build task copies those templates from Texas' own template 
+      # directory that are still missing in the current project's build 
+      # directory (e.g. the preambel partial)
+      #
       class AddDefaultTemplatesToBuildPath < Base
         def build_path
           build.__path__

data/lib/texas/build/task/base.rb

@@ -2,11 +2,13 @@ module Texas
   module Build
     module Task
       class Base
+        include Texas::OutputHelper
         attr_reader :build
         
         def initialize(_build = nil)
           @build = _build
         end
+
         def run
         end
       end

data/lib/texas/build/task/copy_contents_to_build_path.rb

@@ -1,6 +1,9 @@
 module Texas
   module Build
     module Task
+      # This build task copies all the templates in the current project's
+      # contents directory to the build directory.
+      #
       class CopyContentsToBuildPath < Base
         def run
           ensure_build_path_exists

data/lib/texas/build/task/execute_after_scripts.rb

@@ -0,0 +1,18 @@
+module Texas
+  module Build
+    module Task
+      # This build task checks the 'after' script in
+      # the config's script section and executes it, if present.
+      #
+      class ExecuteAfterScripts < Script
+        def cmd
+          cmd_from_config :after
+        end
+
+        def run
+          execute cmd if cmd
+        end
+      end
+    end
+  end
+end

data/lib/texas/build/task/execute_before_scripts.rb

@@ -0,0 +1,18 @@
+module Texas
+  module Build
+    module Task
+      # This build task checks the 'before' script in
+      # the config's script section and executes it, if present.
+      #
+      class ExecuteBeforeScripts < Script
+        def cmd
+          cmd_from_config :before
+        end
+
+        def run
+          execute cmd if cmd
+        end
+      end
+    end
+  end
+end

data/lib/texas/build/task/open_pdf.rb

@@ -1,32 +1,18 @@
 module Texas
   module Build
     module Task
-      class OpenPDF < Base
-        DEFAULT_OPEN_CMD = "evince"
+      # This build task opens the generated PDF file.
+      #
+      class OpenPDF < Script
+        DEFAULT_OPEN_CMD = 'evince "<%= build.dest_file %>"'
 
         def cmd
-          @cmd ||= scripts && scripts['open']
-        end
-
-        def scripts
-          build.config['script']
+          cmd_from_config :open, DEFAULT_OPEN_CMD
         end
 
         def run
-          return unless build.options.open_pdf
-          if open_pdf_cmd
-            system "#{open_pdf_cmd} #{build.dest_file}"
-          else
-            puts "Can't open PDF: no default command recognized. Specify in #{Build::Base::CONFIG_FILE}"
-          end
-        end
-
-        def open_pdf_cmd
-          if cmd
-            cmd
-          else
-            default = `which #{DEFAULT_OPEN_CMD}`.strip
-            default.empty? ? nil : default
+          if cmd && build.options.open_pdf
+            execute cmd
           end
         end
 

data/lib/texas/build/task/publish_pdf.rb

@@ -1,11 +1,10 @@
 module Texas
   module Build
     module Task
-      class PublishPDF < Base
-
-        def master_file
-          build.master_file
-        end
+      # This build task compiles the generated *.tex files into a PDF.
+      #
+      class PublishPDF < Script
+        DEFAULT_COMPILE_CMD = 'pdflatex -halt-on-error "<%= File.basename(build.master_file) %>"'
 
         def build_path
           build.__path__
@@ -16,36 +15,45 @@ module Texas
         end
 
         def run
-          run_pdflatex
-          copy_pdf_file_to_dest_dir
+          latex_cmd_output = compile_pdf
+          if compile_pdf_successfull?
+            compile_pdf # again
+            copy_pdf_file_to_dest_dir
+          else
+            trace latex_cmd_output
+            raise "Error while running: `#{compile_cmd.cyan}`"
+          end
         end
-
+        
+        def compile_pdf_successfull?
+          $?.to_i == 0
+        end
+        
         def copy_pdf_file_to_dest_dir
-          tmp_file = File.join(build_path, "#{File.basename(master_file, '.tex')}.pdf")
+          basename = File.basename(build.master_file, '.tex')
+          tmp_file = File.join(build_path, "#{basename}.pdf")
           FileUtils.mkdir_p File.dirname(dest_file)
           FileUtils.copy tmp_file, dest_file
-          verbose {
-            file = File.join(build_path, "master.log")
-            output = `grep "Output written on" #{file}`
-            numbers = output.scan(/\((\d+?) pages?\, (\d+?) bytes\)\./).flatten
-            @page_count = numbers.first.to_i
-            "Written PDF in #{dest_file.gsub(build.root, '')} (#{@page_count} pages)".green
-          }
+          verbose { verbose_info }
+        end
+        
+        def compile_cmd
+          cmd_from_config :compile, DEFAULT_COMPILE_CMD
         end
 
-        def run_pdflatex
-          verbose { "Running pdflatex in #{build_path} ..." }
-          run_in build_path do
-            `pdflatex #{File.basename(master_file)}`
-            `pdflatex #{File.basename(master_file)}`
-          end
+        def compile_pdf
+          execute compile_cmd
+        end
+        
+        def tex_log_file
+          File.join(build_path, "master.log")
         end
 
-        def run_in(path)
-          old_path = Dir.pwd
-          Dir.chdir path
-          yield
-          Dir.chdir old_path
+        def verbose_info
+          output = `grep "Output written on" #{tex_log_file}`
+          numbers = output.scan(/\((\d+?) pages?\, (\d+?) bytes\)\./).flatten
+          @page_count = numbers.first.to_i
+          verbose { TraceInfo.new(:written, "#{dest_file.gsub(build.root, '')} (#{@page_count} pages)", :magenta) }
         end
 
       end

data/lib/texas/build/task/run_master_template.rb

@@ -1,6 +1,8 @@
 module Texas
   module Build
     module Task
+      # This build task finds and runs the master template.
+      #
       class RunMasterTemplate < Base
 
         def find_master_template(possible_templates)

data/lib/texas/build/task/script.rb

@@ -0,0 +1,28 @@
+module Texas
+  module Build
+    module Task
+      class Script < Base
+        
+        def cmd_from_config(key, default_value = nil)
+          if cmd = build.config.script(key) || default_value
+            ERB.new(cmd).result(binding)
+          end
+        end
+
+        def execute(cmd)
+          verbose { TraceInfo.new(:run, "`#{cmd}`", :cyan) }
+          execute_in(build.__path__) { `#{cmd}` }
+        end
+
+        def execute_in(path)
+          old_path = Dir.pwd
+          Dir.chdir path
+          return_value = yield
+          Dir.chdir old_path
+          return_value
+        end
+
+      end
+    end
+  end
+end

data/lib/texas/core_ext.rb

@@ -1 +1,2 @@
-require_relative 'core_ext/string'
+require_relative 'core_ext/hash'
+require_relative 'core_ext/string'

data/lib/texas/core_ext/hash.rb

@@ -0,0 +1,34 @@
+class Hash
+  # Returns a new hash with self and other_hash merged recursively.
+  #
+  def deep_merge(other_hash)
+    dup.deep_merge!(other_hash)
+  end
+
+  # Returns a new hash with self and other_hash merged recursively.
+  # Modifies the receiver in place.
+  #
+  def deep_merge!(other_hash)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.deep_merge(v) : v
+    end
+    self
+  end
+
+  # Destructively convert all keys to strings.
+  #
+  def stringify_keys
+    dup.stringify_keys!
+  end
+
+  # Destructively convert all keys to strings. 
+  # Modifies the receiver in place.
+  #
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+end

data/lib/texas/core_ext/string.rb

@@ -2,131 +2,4 @@ require 'term/ansicolor'
 
 class String
   
-end
-
-module Term
-  # The ANSIColor module can be used for namespacing and mixed into your own
-  # classes.
-  module NoColor
-    # :stopdoc:
-    ATTRIBUTES = [
-      [ :clear              ,   0 ],     # String#clear is already used to empty string in Ruby 1.9
-      [ :reset              ,   0 ],     # synonym for :clear
-      [ :bold               ,   1 ], 
-      [ :dark               ,   2 ], 
-      [ :italic             ,   3 ],     # not widely implemented
-      [ :underline          ,   4 ], 
-      [ :underscore         ,   4 ],     # synonym for :underline
-      [ :blink              ,   5 ], 
-      [ :rapid_blink        ,   6 ],     # not widely implemented
-      [ :negative           ,   7 ],     # no reverse because of String#reverse
-      [ :concealed          ,   8 ], 
-      [ :strikethrough      ,   9 ],     # not widely implemented
-      [ :black              ,  30 ], 
-      [ :red                ,  31 ], 
-      [ :green              ,  32 ], 
-      [ :yellow             ,  33 ], 
-      [ :blue               ,  34 ], 
-      [ :magenta            ,  35 ], 
-      [ :cyan               ,  36 ], 
-      [ :white              ,  37 ], 
-      [ :on_black           ,  40 ], 
-      [ :on_red             ,  41 ], 
-      [ :on_green           ,  42 ], 
-      [ :on_yellow          ,  43 ], 
-      [ :on_blue            ,  44 ], 
-      [ :on_magenta         ,  45 ], 
-      [ :on_cyan            ,  46 ], 
-      [ :on_white           ,  47 ],
-      [ :intense_black      ,  90 ],    # High intensity, aixterm (works in OS X)
-      [ :intense_red        ,  91 ], 
-      [ :intense_green      ,  92 ], 
-      [ :intense_yellow     ,  93 ], 
-      [ :intense_blue       ,  94 ], 
-      [ :intense_magenta    ,  95 ], 
-      [ :intense_cyan       ,  96 ], 
-      [ :intense_white      ,  97 ], 
-      [ :on_intense_black   , 100 ],    # High intensity background, aixterm (works in OS X)
-      [ :on_intense_red     , 101 ], 
-      [ :on_intense_green   , 102 ], 
-      [ :on_intense_yellow  , 103 ], 
-      [ :on_intense_blue    , 104 ], 
-      [ :on_intense_magenta , 105 ], 
-      [ :on_intense_cyan    , 106 ], 
-      [ :on_intense_white   , 107 ]
-    ]
-
-    ATTRIBUTE_NAMES = ATTRIBUTES.transpose.first
-    # :startdoc:
-
-    # Returns true if Term::ANSIColor supports the +feature+.
-    #
-    # The feature :clear, that is mixing the clear color attribute into String,
-    # is only supported on ruby implementations, that do *not* already
-    # implement the String#clear method. It's better to use the reset color
-    # attribute instead.
-    def support?(feature)
-      case feature
-      when :clear
-        !String.instance_methods(false).map(&:to_sym).include?(:clear)
-      end
-    end
-    # Returns true, if the coloring function of this module
-    # is switched on, false otherwise.
-    def self.coloring?
-      @coloring
-    end
-
-    # Turns the coloring on or off globally, so you can easily do
-    # this for example:
-    #  Term::ANSIColor::coloring = STDOUT.isatty
-    def self.coloring=(val)
-      @coloring = val
-    end
-    self.coloring = true
-
-    ATTRIBUTES.each do |c, v|
-      eval <<-EOT
-        def #{c}(string = nil)
-          result = ''
-          if block_given?
-            result << yield
-          elsif string.respond_to?(:to_str)
-            result << string.to_str
-          elsif respond_to?(:to_str)
-            result << to_str
-          else
-            return result #only switch on
-          end
-          result
-        end
-      EOT
-    end
-
-    # Regular expression that is used to scan for ANSI-sequences while
-    # uncoloring strings.
-    COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/
-
-    # Returns an uncolored version of the string, that is all
-    # ANSI-sequences are stripped from the string.
-    def uncolored(string = nil) # :yields:
-      if block_given?
-        yield.to_str.gsub(COLORED_REGEXP, '')
-      elsif string.respond_to?(:to_str)
-        string.to_str.gsub(COLORED_REGEXP, '')
-      elsif respond_to?(:to_str)
-        to_str.gsub(COLORED_REGEXP, '')
-      else
-        ''
-      end
-    end
-
-    module_function
-
-    # Returns an array of all Term::ANSIColor attributes as symbols.
-    def attributes
-      ATTRIBUTE_NAMES
-    end
-    extend self
-  end
-end
+end

data/lib/texas/option_parser.rb

@@ -5,6 +5,7 @@ require 'pathname'
 
 module Texas
   class OptionParser
+    include Texas::OutputHelper
     attr_reader :args, :options
 
     def initialize(args)
@@ -12,140 +13,37 @@ module Texas
       @options = OpenStruct.new
     end
 
-    # Return a structure describing the options.
+    # Returns a structure describing the options.
     #
     def parse
-      # The options specified on the command line will be collected in *options*.
-      # We set default values here.
-      options.task = :build
-      options.work_dir = find_work_dir
-      options.check_mandatory_arguments = true
-      options.load_local_libs = true
-      options.contents_dir = Texas.contents_subdir_name
-      options.contents_template = find_contents_file("contents")
-      options.backtrace = false
-      options.colors = true
-      options.merge_config = nil
-      options.verbose = false
-      options.warnings = true
-      options.open_pdf = true
-
+      set_default_options
       lookup_and_execute_require_option(args)
-      
-      opts = ::OptionParser.new do |opts|
-        opts.banner = "Usage: texas [CONTENTS_TEMPLATE] [options]"
-
-        opts.separator ""
-        opts.separator "Specific options:"
-
-        opts.on("-d", "--dry-run", "Run without pdf generation") do |contents_template|
-          options.task = :dry
-        end
-
-        opts.on("-m", "--merge-config [CONFIG]",
-                "Merge config with key from .texasrc") do |key|
-          options.merge_config = key
-        end
-
-        opts.on("-n", "--new [NAME]",
-                "Create new texas project directory") do |name|
-          options.task = :new_project
-          options.check_mandatory_arguments = false
-          options.load_local_libs = false
-          options.new_project_name = name
-        end
-
-        opts.on("-r", "--require [LIBRARY]", "Require library before running texas") do |lib|
-          # this block does nothing
-          # require was already performed by lookup_and_execute_require_option
-          # this option is here to ensure the -r switch is listed in the help option
-        end
-
-        opts.on("--watch", "Watch the given template") do |contents_template|
-          options.task = :watch
-          options.open_pdf = false
-        end
-
-        parse_additional_options(opts)
-
-        opts.separator ""
-        opts.separator "Common options:"
-
-        opts.on("--[no-]backtrace", "Switch backtrace") do |v|
-          options.backtrace = v
-        end
-
-        opts.on("-c", "--[no-]color", "Switch colors") do |v|
-          options.colors = v
-        end
-
-        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-          options.verbose = v
-        end
-
-        opts.on("-w", "--[no-]warnings", "Switch warnings") do |v|
-          options.warnings = v
-        end
-
-        # No argument, shows at tail.  This will print an options summary.
-        # Try it and see!
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit
-        end
-
-        # Another typical switch to print the version.
-        opts.on_tail("--version", "Show version") do
-          puts Texas::VERSION::STRING
-          exit
-        end
-      end
-
-      opts.parse!(args)
-
-      unless args.empty?
-        f = args.shift
-        options.contents_template = find_contents_file(f)
-        options.contents_dir = find_contents_dir(f)
-      end
-      if options.check_mandatory_arguments
-        check_mandatory! options
-      end
+      parse_options
+      set_contents_template_from_args unless args.empty?
+      check_mandatory! if options.check_mandatory_arguments
       options
     end
 
     private
 
-    # Is empty. It can be overwritten by other libraries to 
-    # parse and display additional options.
-    #
-    def parse_additional_options(opts)
-    end
-    
-    # Parses the given arguments for the --require option and requires
-    # it if present. This is done separately from the regular option parsing 
-    # to enable the required library to modify Texas, 
-    # e.g. overwrite OptionParser#parse_additional_options.
+    # Kills the program if any mandatory options are missing.
     #
-    def lookup_and_execute_require_option(args)
-      args.each_with_index do |v, i|
-        if %w(-r --require).include?(v)
-          require args[i+1]
-        end
-      end
-    end
-
-    def check_mandatory!(options)
+    def check_mandatory!
       if options.work_dir.nil?
-        warn "texas: missing file operand\nTry `texas --help' for more information."
-        exit 1
+        kill "missing file operand"
       end
       if options.contents_template.nil?
-        warn "texas: could not find contents template\nTry `texas --help' for more information."
-        exit 1
+        kill "could not find contents template"
       end
     end
 
+    # Displays an error message and exits the program afterwards.
+    #
+    def kill(msg)
+      trace "texas: #{msg}\nTry `texas --help' for more information."
+      exit 1
+    end
+
     def find_work_dir(start_dir = Dir.pwd)
       results = Dir[File.join(start_dir, Texas.contents_subdir_name)]
       if !results.empty?
@@ -161,10 +59,10 @@ module Texas
     end
 
     def find_contents_dir(file)
-      if Dir["#{file}*"].empty?
-        nil
+      if file =~ /#{Texas.contents_subdir_name}/
+        Texas.contents_subdir_name
       else
-        File.dirname(file)
+        nil
       end
     end
 
@@ -177,6 +75,137 @@ module Texas
         file
       end
     end
-  end
 
-end
+    # Parses the given arguments for the --require option and requires
+    # it if present. This is done separately from the regular option parsing 
+    # to enable the required library to modify Texas, 
+    # e.g. overwrite OptionParser#parse_additional_options.
+    #
+    def lookup_and_execute_require_option(args)
+      args.each_with_index do |v, i|
+        if %w(-r --require).include?(v)
+          require args[i+1]
+        end
+      end
+    end
+
+    def parse_options
+      parser = ::OptionParser.new do |parser|
+        parser.banner = "Usage: texas [CONTENTS_TEMPLATE] [options]"
+        parse_specific_options(parser)
+        parse_additional_options(parser)
+        parse_common_options(parser)
+      end
+      parser.parse!(args)
+    end
+
+    def parse_additional_options(parser)
+      if arr = self.class.parse_options_procs
+        parser.separator ""
+        parser.separator "Custom options:"
+        arr.each do |proc|
+          proc.(parser, options)
+        end
+      end
+    end
+
+    def self.parse_options_procs
+      @@parse_options_procs ||= []
+    end
+
+    def self.parse_additional_options(&block)
+      parse_options_procs << block
+    end
+
+    def parse_common_options(parser)
+      parser.separator ""
+      parser.separator "Common options:"
+
+      parser.on("--[no-]backtrace", "Switch backtrace") do |v|
+        options.backtrace = v
+      end
+
+      parser.on("-c", "--[no-]color", "Switch colors") do |v|
+        options.colors = v
+      end
+
+      parser.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        options.verbose = v
+      end
+
+      parser.on("-w", "--[no-]warnings", "Switch warnings") do |v|
+        options.warnings = v
+      end
+
+      # No argument, shows at tail.  This will print an options summary.
+      # Try it and see!
+      parser.on_tail("-h", "--help", "Show this message") do
+        trace parser
+        exit
+      end
+
+      # Another typical switch to print the version.
+      parser.on_tail("--version", "Show version") do
+        trace Texas::VERSION::STRING
+        exit
+      end
+    end
+
+    # Parses the specific options.
+    #
+    def parse_specific_options(parser)
+      parser.separator ""
+      parser.separator "Specific options:"
+
+      parser.on("-d", "--dry-run", "Run without pdf generation") do |contents_template|
+        options.task = :dry
+      end
+
+      parser.on("-m", "--merge-config [CONFIG]",
+              "Merge config with key from .texasrc") do |key|
+        options.merge_config = key
+      end
+
+      parser.on("-n", "--new [NAME]",
+              "Create new texas project directory") do |name|
+        options.task = :new_project
+        options.check_mandatory_arguments = false
+        options.load_local_libs = false
+        options.new_project_name = name
+      end
+
+      parser.on("-r", "--require [LIBRARY]", "Require library before running texas") do |lib|
+        # this block does nothing
+        # require was already performed by lookup_and_execute_require_option
+        # this option is here to ensure the -r switch is listed in the help option
+      end
+
+      parser.on("--watch", "Watch the given template") do |contents_template|
+        options.task = :watch
+        options.open_pdf = false
+      end
+    end
+    
+    def set_default_options
+      options.task = :build
+      options.work_dir = find_work_dir
+      options.check_mandatory_arguments = true
+      options.load_local_libs = true
+      options.contents_dir = Texas.contents_subdir_name
+      options.contents_template = find_contents_file("contents")
+      options.backtrace = false
+      options.colors = true
+      options.merge_config = nil
+      options.verbose = false
+      options.warnings = true
+      options.open_pdf = true
+    end
+
+    def set_contents_template_from_args
+      f = args.shift
+      options.contents_template = find_contents_file(f)
+      options.contents_dir = find_contents_dir(f)
+    end
+
+  end
+end