texas 0.1.5 → 0.1.6

data/lib/texas/build/base.rb

@@ -21,7 +21,7 @@ module Texas
         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: #{@build_path}".dark }
+        verbose { "[i] build_path: #{__path__}".dark }
       end
 
       def __path__
@@ -65,6 +65,7 @@ module Texas
 
       def run_build_task(klass)
         klass = eval("::Texas::Build::Task::#{klass}") if [Symbol, String].include?(klass.class)
+        verbose { "[b] #{klass}".dark }
         klass.new(self).run
       end
 
@@ -81,12 +82,6 @@ module Texas
       end
 
       class << self
-        def run(options)
-          instance = self.new(options)
-          instance.run
-          instance
-        end
-
         def tasks(key)
           @@tasks ||= {}
           initialize_tasks if @@tasks[self.to_s].nil?

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

@@ -17,7 +17,7 @@ module Texas
           if open_pdf_cmd
             system "#{open_pdf_cmd} #{build.dest_file}"
           else
-            puts "Can't open PDF: no default command recognized. Specify in #{CONFIG_FILE}"
+            puts "Can't open PDF: no default command recognized. Specify in #{Build::Base::CONFIG_FILE}"
           end
         end
 

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

@@ -27,17 +27,25 @@ module Texas
           verbose {
             file = File.join(build_path, "master.log")
             output = `grep "Output written on" #{file}`
-            numbers = output.scan(/\((\d+?) pages\, (\d+?) bytes\)\./).flatten
+            numbers = output.scan(/\((\d+?) pages?\, (\d+?) bytes\)\./).flatten
             @page_count = numbers.first.to_i
-            "Written PDF in #{dest_file.gsub(root, '')} (#{@page_count} pages)".green
+            "Written PDF in #{dest_file.gsub(build.root, '')} (#{@page_count} pages)".green
           }
         end
 
         def run_pdflatex
           verbose { "Running pdflatex in #{build_path} ..." }
-          Dir.chdir build_path
-          `pdflatex #{File.basename(master_file)}`
-          `pdflatex #{File.basename(master_file)}`
+          run_in build_path do
+            `pdflatex #{File.basename(master_file)}`
+            `pdflatex #{File.basename(master_file)}`
+          end
+        end
+
+        def run_in(path)
+          old_path = Dir.pwd
+          Dir.chdir path
+          yield
+          Dir.chdir old_path
         end
 
       end

data/lib/texas/option_parser.rb

@@ -12,7 +12,6 @@ module Texas
       @options = OpenStruct.new
     end
 
-    #
     # Return a structure describing the options.
     #
     def parse
@@ -34,7 +33,7 @@ module Texas
       lookup_and_execute_require_option(args)
       
       opts = ::OptionParser.new do |opts|
-        opts.banner = "Usage: texas [options]"
+        opts.banner = "Usage: texas [CONTENTS_TEMPLATE] [options]"
 
         opts.separator ""
         opts.separator "Specific options:"
@@ -117,11 +116,17 @@ module Texas
 
     private
 
-    # This method can be overwritten by other libraries
-    # to parse additional options
+    # 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.
+    #
     def lookup_and_execute_require_option(args)
       args.each_with_index do |v, i|
         if %w(-r --require).include?(v)

data/lib/texas/runner.rb

@@ -41,6 +41,7 @@ module Texas
     end
     
     # Display the error message that caused the exception.
+    #
     def display_error_message(ex)
       puts "#{@options.task} aborted!"
       puts ex.message
@@ -51,11 +52,15 @@ module Texas
       end
     end
 
+    # Extends String with Term::ANSIColor if options demand it.
+    #
     def extend_string_class
       mod = @options.colors ? Term::ANSIColor : Term::NoColor
       String.send :include, mod
     end
 
+    # Load lib/init.rb if present in current project.
+    #
     def load_local_libs
       init_file = File.join(@options.work_dir, "lib", "init.rb")
       require init_file if File.exist?(init_file)
@@ -68,6 +73,8 @@ module Texas
       exit 1
     end
 
+    # Returns the class for the given task.
+    #
     def task_class
       map = {
         :build      => Build::Final,

data/lib/texas/task/base.rb

@@ -9,7 +9,7 @@ module Texas
       end
 
       def build(klass = Build::Dry)
-        @build ||= klass.run(options)
+        @build ||= klass.new(options).run
       end
 
       def run

data/lib/texas/task/watch.rb

@@ -17,16 +17,16 @@ module Texas
 
       def self.directories_to_watch
         arr = []
-        arr << "tex"
-        arr << "figures"
+        arr << "tex"      if Dir.exists?("tex")
+        arr << "contents" if Dir.exists?("contents")
+        arr << "figures"  if Dir.exists?("figures")
         arr << Texas.texas_dir
         arr
       end
 
       def self.rebuild
         started_at = Time.now.to_i
-        @build = Build::Final.new(run_options)
-        @build.run
+        Build::Final.new(run_options).run
         finished_at = Time.now.to_i
         puts (finished_at - started_at).to_s + " seconds to rebuild"
       rescue Exception => e

data/lib/texas/template.rb

@@ -29,10 +29,28 @@ module Texas
         known_extensions.concat extensions
       end
 
+      # Registers the methods defined in a module to use
+      # them in templates.
+      #
+      # Example:
+      #   module Foo
+      #     def bar; "foobar"; end
+      #   end
+      #   Template.register_helper Foo
+      #
+      #   # afterwards, this prints "foobar" in any template:
+      #   <%= bar %>
+      #
       def register_helper(klass)
         Template::Runner::Base.__send__ :include, klass
       end
 
+      # Returns a Template runner for the given filename
+      #
+      # Example:
+      #   Template.create("some_file.tex.erb", build)
+      #   # => #<Template::Runner::TeX ...>
+      #
       def create(filename, build)
         handler(filename).new(filename, build)
       end
@@ -40,7 +58,7 @@ module Texas
       # Returns the filename without the template extension
       #
       # Example:
-      #   input_path("/home/rene/github/sample_project/tmp/build/chapter-01/contents.md.erb")
+      #   Template.basename("/home/rene/github/sample_project/tmp/build/chapter-01/contents.md.erb")
       #   # => "/home/rene/github/sample_project/tmp/build/chapter-01/contents"
       #
       def basename(filename)

data/lib/texas/template/helper/base.rb

@@ -13,7 +13,7 @@ module Texas
             path_with_templates_basename, 
             build_path, 
             build.root
-          ].compact
+          ].compact.uniq
         end
 
         # Returns a subdir with the current template's basename
@@ -31,12 +31,14 @@ module Texas
         # Searches for the given file in +possible_paths+, also checking for +possible_exts+ as extensions
         #
         # Example:
-        #   find_template_file(["figures", "titel"], [:pdf, :png])
+        #   find_template_file(["figures", "some-chart"], [:pdf, :png], ["", "tmp", "tmp/build"])
         #   # => will check
-        #          figures/titel.pdf
-        #          figures/titel.png
-        #          tmp/figures/titel.pdf
-        #          tmp/figures/titel.png
+        #          figures/some-chart.pdf
+        #          figures/some-chart.png
+        #          tmp/figures/some-chart.pdf
+        #          tmp/figures/some-chart.png
+        #          tmp/build/figures/some-chart.pdf
+        #          tmp/build/figures/some-chart.png
         #
         def find_template_file(parts, possible_exts = [], possible_paths = default_search_paths)
           possible_paths.each do |base|
@@ -57,7 +59,7 @@ module Texas
           if filename = find_template_file(parts, possible_exts, possible_paths)
             filename
           else
-            raise TemplateError.new(self, "File doesnot exists anywhere: #{parts.size > 1 ? parts : parts.first}")
+            raise TemplateError.new(self, "File doesn't exists anywhere: #{parts.size > 1 ? parts : parts.first}")
           end
         end
 
@@ -67,7 +69,7 @@ module Texas
           render("_#{name}", locals)
         end
 
-        # Renders a template with the given locals.
+        # Renders one or more templates with the given locals.
         #
         def render(options, locals = {})
           if [String, Symbol].include?(options.class)

data/lib/texas/version.rb

@@ -2,7 +2,7 @@ module Texas
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    BUILD = 5
+    BUILD = 6
 
     STRING = [MAJOR, MINOR, BUILD].join('.').freeze
   end

data/spec/fixtures/rerun/contents/contents.tex.erb

@@ -2,5 +2,5 @@
   info.write_at_end_of_build = true
 %>
 
-<%= document.message %>
-<% document.message = "Hello World!" %>
+<%= store.message %>
+<% store.message = "Hello World!" %>

data/spec/texas/build/base_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Texas::Build::Base do
+
+  def test_build
+    @test_build ||= get_runner_instance
+  end
+
+  def get_runner_instance
+    run_scenario "basic" do |runner|
+      return runner.task_instance
+    end
+  end
+
+  describe "#ran_templates" do
+    it "returns the templates" do
+      filenames = test_build.ran_templates.map(&:filename)
+      basenames = filenames.map { |f| f.gsub(test_build.__path__+'/', '') }
+      basenames.size.should > 0
+      basenames.include?("unused_template.tex.erb").should == false
+    end
+  end
+
+  class FoobarTask
+    class << self
+      attr_accessor :foo
+    end
+
+    def initialize(*args)
+    end
+
+    def run
+      self.class.foo = :bar
+    end
+  end
+
+  describe "#run_build_task" do
+    it "should instantiate the given class and call the run method" do
+      FoobarTask.foo.nil?.should == true
+      test_build.run_build_task FoobarTask
+      FoobarTask.foo.should == :bar
+    end
+  end
+  
+end

data/spec/texas/build/task/publish_pdf_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe Texas::Build::Task::PublishPDF do
+
+  def test_build
+    run_scenario "basic" do |runner|
+      return runner.task_instance
+    end
+  end
+
+  describe "#run" do
+    it "should return an info object for the given template" do
+      test_build.run_build_task Texas::Build::Task::PublishPDF
+    end
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: texas
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
   prerelease: 
 platform: ruby
 authors:
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: '0.9'
 description: A tool for creating LaTex files from ERb templates and processing them
   into PDF format.
 email: rf@bamaru.de
@@ -102,8 +102,9 @@ files:
 - lib/texas.rb
 - spec/texas/template/runner_spec.rb
 - spec/texas/template/helper/info_spec.rb
-- spec/texas/build_spec.rb
 - spec/texas/template_spec.rb
+- spec/texas/build/task/publish_pdf_spec.rb
+- spec/texas/build/base_spec.rb
 - spec/texas_spec.rb
 - spec/fixtures/different-master-tex/contents/contents.tex.erb
 - spec/fixtures/different-master-tex/contents/contents.tex.should

data/spec/texas/build_spec.rb

@@ -1,17 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe Texas::Build::Base do
-  describe "#ran_templates" do
-
-    it "returns the templates" do
-      run_scenario "basic-md" do |runner|
-        build = runner.task_instance
-        filenames = build.ran_templates.map(&:filename)
-        basenames = filenames.map { |f| f.gsub(build.__path__+'/', '') }
-        basenames.size.should > 0
-        basenames.include?("unused_template.tex.erb").should == false
-      end
-    end
-
-  end
-end