texas 0.1.6 → 0.1.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTExNmYwNjAzZGVhYmE0ZTMwMzkzNTc3NDY5ODQzMWM1ZjUyNWU4NQ==
+  data.tar.gz: !binary |-
+    YWVlNmFkNDhkNTI0YWQ5Yzg0ZTk2YTc3YTU4NWQ2ZmQ3NDFmYjkzYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjQxNGM0N2ExZTQxOTU2MTI2OWFlZjQxZmZiYmQ0NmJlYzA1NWUwMGY3ODc1
+    ZmU3YTg5ODk5NzA1NWI2MWZiNTM3NTIxMTQ1NjYxMjM5NzdhNmJhMDJiMGYz
+    MmJiODQ3ZTczN2UyZjcyMDYyZDk0YTAwZGMwOWQ1NTZmNjIzNjU=
+  data.tar.gz: !binary |-
+    NGJmYzJiY2ZlYzE3ZWYxYWY3ZTEyNDAxNzY3NWIwMzc5Y2MzNTdmNzMyNjc3
+    NjZhM2ViZjdiODJmOWFmOGIzM2VkNDc4M2FjOWYwNDU2YmQ1YjhiODYyOTJh
+    ODE1MTM5MWE2OTAxNTU0Yjc4YmM0ZTcxNzgwODQ0Yzc4YWQ1NjI=

data/bin/texas

@@ -7,4 +7,4 @@ rescue Bundler::GemfileNotFound => e
   require 'texas'
 end
 
-Texas::Runner.new
+Texas::Runner.new(ARGV)

data/lib/texas.rb

@@ -1,7 +1,17 @@
 module Texas
   class << self
-    attr_accessor :contents_subdir_name, :texas_dir
-    attr_accessor :verbose, :warnings
+    # Returns the name of the template sub directory
+    # defaults to "contents"
+    attr_accessor :contents_subdir_name
+
+    # Points to the directory where Texas is located
+    attr_accessor :texas_dir
+
+    # Returns true if Texas is run in verbose mode
+    attr_accessor :verbose
+
+    # Returns true if warnings are enabled
+    attr_accessor :warnings
   end
 end
 Texas.texas_dir = File.join(File.dirname(__FILE__), '..')
@@ -9,6 +19,7 @@ Texas.contents_subdir_name = "contents"
 
 require 'pp'
 
+require_relative 'texas/output_helper'
 require_relative 'texas/option_parser'
 require_relative 'texas/build'
 require_relative 'texas/core_ext'

data/lib/texas/build.rb

@@ -1,13 +1,45 @@
 module Texas
   module Build
+    class << self
+      include Texas::OutputHelper
+
+      # Display the error message that caused the exception.
+      #
+      def display_error_message(build, ex)
+        trace TraceInfo.new(:error, "#{build.options.task} aborted!", :red)
+        trace "\n" + ex.message
+        if build.options.backtrace
+          trace ex.backtrace
+        else
+          trace "(See full trace with --backtrace)"
+        end
+      end
+
+      # Run the given build object. If any errors occur, display them in a
+      # formatted way and call the optional block, if present.
+      #
+      def run_with_nice_errors(build, &block)
+        build.run
+      rescue Interrupt => ex
+        trace "\n"
+        trace TraceInfo.new("interrupt", "#{build.options.task} interrupted!", :yellow)
+        exit 0
+      rescue StandardError => ex
+        display_error_message(build, ex)
+        block.() if block
+      end
+    end
   end
 end
 
+require_relative 'build/config'
+require_relative 'build/config_loader'
 require_relative 'build/base'
 require_relative 'build/dry'
 require_relative 'build/final'
 
 require_relative 'build/task/base'
+require_relative 'build/task/script'
 
 all_rbs = Dir[ File.join( File.dirname(__FILE__), "build", "task", "*.rb" ) ]
 all_rbs.each do |t|

data/lib/texas/build/base.rb

@@ -3,12 +3,29 @@ require 'yaml'
 module Texas
   module Build
     class Base
+      include Texas::OutputHelper
       CONFIG_FILE = ".texasrc"
       MASTER_TEMPLATE = "master.tex"
 
-      attr_reader :root, :options
-      attr_reader :master_file, :contents_dir, :contents_template
-      attr_reader :current_template, :ran_templates
+      # Returns the path of the current Texas project
+      attr_reader :root
+
+      # Returns the options of this build.
+      attr_reader :options
+
+      # Returns the location of the template that is run.
+      attr_reader :master_file
+
+      attr_reader :contents_dir
+
+      # Returns the name of the template whose contents should be rendered.
+      attr_reader :contents_template
+
+      # Returns the name of the template currently rendered.
+      attr_reader :current_template
+
+      # Returns an array of all templates that have been rendered.
+      attr_reader :ran_templates
 
       def initialize(_options)
         @options = _options
@@ -16,63 +33,69 @@ module Texas
         @contents_dir = options.contents_dir
         @contents_template = options.contents_template
         @master_file = File.join(__path__, MASTER_TEMPLATE)
-
-        verbose { "Starting #{self.class}" }
-        verbose { "[i] work_dir: #{options.work_dir}".dark }
-        verbose { "[i] contents_dir: #{@contents_dir}".dark }
-        verbose { "[i] contents_template: #{@contents_template}".dark }
-        verbose { "[i] build_path: #{__path__}".dark }
+        verbose { verbose_info }
       end
 
+      # Returns the full path of the directory where the build is happening.
+      #
       def __path__
         File.join(root, 'tmp', 'build')
       end
 
+      # Returns an object that can store persistent information throughout
+      # the build process.
+      #
       def store
         @store ||= OpenStruct.new
       end
 
+      # Sets the currently rendered template.
+      #
       def current_template=(t)
         @ran_templates ||= []
         @ran_templates << t unless t.nil?
         @current_template = t
       end
 
-      def document_struct
-        @document_struct ||= begin
-          hash = config["document"] || {}
-          if options.merge_config
-            hash.merge! config[options.merge_config]
-          end
-          OpenStruct.new(hash)
-        end
-      end
-      
+      # Returns the Config object.
+      #
       def config
-        @config ||= begin
-          filename = File.join(root, CONFIG_FILE)
-          File.exist?(filename) ? YAML.load_file(filename) : {}
-        end
+        @config ||= Config.create ConfigLoader.new(root, CONFIG_FILE).to_hash, options.merge_config
       end
 
+      # Returns the location where the generated PDF file should be after the build.
+      #
       def dest_file
         @dest_file ||= File.join(root, "bin", "#{Template.basename contents_template}.pdf")
       end
 
+      # Runs the given build tasks.
+      #
       def run_build_tasks(*tasks)
         tasks.flatten.each { |t| run_build_task t }
       end
 
+      # Runs the given build task.
+      #
       def run_build_task(klass)
+        verbose { TraceInfo.new(:build_task, klass, :green) }
         klass = eval("::Texas::Build::Task::#{klass}") if [Symbol, String].include?(klass.class)
-        verbose { "[b] #{klass}".dark }
         klass.new(self).run
       end
 
+      # Executes the build process.
+      #
       def run
         run_build_tasks before_tasks, basic_tasks, after_tasks
       end
 
+      def verbose_info
+        [
+          TraceInfo.new("work_dir", options.work_dir, :dark),
+          TraceInfo.new("build_path", __path__, :dark),
+        ].join("\n")
+      end
+
       %w(before basic after).each do |method|
         class_eval <<-INSTANCE_EVAL
           def #{method}_tasks

data/lib/texas/build/config.rb

@@ -0,0 +1,118 @@
+module Texas
+  module Build
+    # This class holds the config information for a build.
+    #
+    class Config
+      def initialize(hash)
+        @hash = hash.stringify_keys
+      end
+
+      def [](key)
+        @hash[key.to_s]
+      end
+
+      # Returns an object for the +document+ config key.
+      #
+      # Example:
+      #   # .texasrc
+      #
+      #   document:
+      #     title: "My Document"
+      #
+      #   config = Config.new YAML.load_file(".texasrc") 
+      #   # => #<Texas::Build::Config ...>
+      #
+      #   config.document.title
+      #   # => "My Document"
+      #
+      def document
+        @document ||= OpenStruct.new self[:document]
+      end
+
+      # Returns an object for the +document+ config key.
+      #
+      # Example:
+      #   # .texasrc
+      #
+      #   document:
+      #     title: "My Document (DRAFT!)"
+      #   final:
+      #     document:
+      #       title: "My Document"
+      #
+      #   config = Config.new YAML.load_file(".texasrc") 
+      #   # => #<Texas::Build::Config ...>
+      #
+      #   config.document.title
+      #   # => "My Document (DRAFT!)"
+      #
+      #   config.merge! :final
+      #   # => #<Texas::Build::Config ...>
+      #
+      #   config.document.title
+      #   # => "My Document"      
+      #
+      def merge!(key)
+        @document = nil
+        merge_hash = @hash[key.to_s]
+        if merge_hash
+          @hash.deep_merge! merge_hash.stringify_keys
+          self
+        else
+          raise "Trying to merge config with none existing key #{key.inspect}"
+        end
+      end
+
+      def method_missing(m, *args, &block)
+        self[m] || super
+      end
+
+      # Returns an element from the +script+ config key
+      #
+      # Example:
+      #   # .texasrc
+      #
+      #   script:
+      #     before: "touch some_file"
+      #   document:
+      #     title: "My Document"
+      #
+      #   config = Config.new YAML.load_file(".texasrc") 
+      #   # => #<Texas::Build::Config ...>
+      #
+      #   config.script(:before)
+      #   # => "touch some_file"
+      #
+      #   config.script(:after)
+      #   # => nil
+      #
+      def script(key)
+        hash = self[:script] || {}
+        hash[key.to_s]
+      end
+
+      # Returns a Config object.
+      #
+      # Example:
+      #   # .texasrc
+      #
+      #   document:
+      #     title: "My Document (DRAFT!)"
+      #   final:
+      #     document:
+      #       title: "My Document"
+      #
+      #   config = Config.create YAML.load_file(".texasrc"), :final
+      #   # => #<Texas::Build::Config ...>
+      #
+      #   config.document.title
+      #   # => "My Document"   
+      #
+      def self.create(hash, merge_key = nil)
+        config = self.new hash
+        config.merge! merge_key if merge_key
+        config
+      end
+    end
+  end
+end

data/lib/texas/build/config_loader.rb

@@ -0,0 +1,93 @@
+module Texas
+  module Build
+    # This class looks for a given filename in the current and all parent directories.
+    #
+    #   # Given the following directory structure:
+    #
+    #   ~/
+    #     projects/
+    #       some_texas_project/
+    #         .texasrc
+    #     .texasrc
+    #
+    # In the above case, it would find and load 
+    # ~/.texasrc and ~/projects/some_texas_project/.texasrc
+    # with the latter one overriding settings in the former one.
+    #
+    class ConfigLoader
+      def initialize(start_dir, filename)
+        @start_dir = start_dir
+        @filename = filename
+      end
+
+      # Returns all found files with the given filename in the current and all parent directories.
+      #
+      # Example:
+      #   # Given the following directory structure:
+      #
+      #   ~/
+      #     projects/
+      #       some_texas_project/
+      #         .texasrc
+      #     .texasrc
+      #
+      #   all_config_files
+      #   # => ["~/.texasrc", "~/projects/some_texas_project/.texasrc"]
+      #
+      def all_config_files
+        found_files = []
+        each_parent_dir(@start_dir) do |dir|
+          filename = File.join(dir, @filename)
+          found_files.unshift filename if File.exist?(filename)
+        end
+        found_files
+      end
+
+      def each_parent_dir(dir)
+        old_length = nil
+        while dir != '.' && dir.length != old_length
+          yield dir
+          old_length = dir.length
+          dir = File.dirname(dir)
+        end
+      end
+
+      # Returns a hash of all the found config files.
+      #
+      # Example:
+      #   # Given the following directory structure:
+      #
+      #   ~/
+      #     projects/
+      #       some_texas_project/
+      #         .texasrc
+      #     .texasrc
+      #
+      #   # ~/.texasrc
+      #   
+      #   document:
+      #     author: "John Doe"
+      #     some_value: 42
+      #
+      #   # ~/projects/some_texas_project/.texasrc
+      #   
+      #   document:
+      #     title: "My Document"
+      #     some_value: 123
+      #
+      #   to_hash
+      #   # => {:document => {
+      #          :author => "John Doe", 
+      #          :title => "My Document", 
+      #          :some_value => 123}}
+      #          
+      def to_hash
+        hash = {}
+        all_config_files.each do |filename|
+          hash.deep_merge! YAML.load_file(filename) 
+        end
+        hash
+      end
+    end
+  end
+end

data/lib/texas/build/dry.rb

@@ -1,7 +1,7 @@
 module Texas
   module Build
     class Dry < Base
-      before_task :RunBeforeScripts, :CopyContentsToBuildPath
+      before_task :ExecuteBeforeScripts, :CopyContentsToBuildPath
 
       basic_task :AddDefaultTemplatesToBuildPath, :RunMasterTemplate
 

data/lib/texas/build/final.rb

@@ -1,7 +1,7 @@
 module Texas
   module Build
     class Final < Dry
-      append_after_task :PublishPDF, :OpenPDF
+      append_after_task :PublishPDF, :ExecuteAfterScripts, :OpenPDF
     end
   end
-end
+end