texas 0.1.0

data/lib/texas/template.rb

@@ -0,0 +1,62 @@
+module Texas
+  module Template
+    class << self
+      attr_accessor :handlers, :known_extensions
+
+      # Returns a template handler for the given filename
+      #
+      # Example:
+      #   Template.handler("some_file.tex.erb")
+      #   # => Template::Runner::TeX
+      #
+      def handler(filename)
+        Template.handlers.each do |pattern, klass|
+          return klass if filename =~ pattern
+        end
+        warning { "No template handler found for: #{filename}" }
+        Template::Runner::Base
+      end
+
+      # Registers a handler for the given template extensions
+      #
+      # Example:
+      #   Template.register_handler %w(tex tex.erb), Template::Runner::TeX
+      #
+      def register_handler(extensions, handler_class)
+        extensions.each do |ext|
+          handlers[/\.#{ext}$/i] = handler_class
+        end
+        known_extensions.concat extensions
+      end
+
+      def register_helper(klass)
+        Template::Runner::Base.__send__ :include, klass
+      end
+
+      def create(filename, build)
+        handler(filename).new(filename, build)
+      end
+
+      # Returns the filename without the template extension
+      #
+      # Example:
+      #   input_path("/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)
+        value = filename
+        known_extensions.each do |str|
+          value = value.gsub(/\.#{str}$/, '')
+        end
+        value
+      end
+
+    end
+  end
+end
+
+Texas::Template.handlers = {}
+Texas::Template.known_extensions = []
+
+require_relative 'template/helper'
+require_relative 'template/runner'

data/lib/texas/version.rb

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

data/lib/texas.rb

@@ -0,0 +1,18 @@
+module Texas
+  class << self
+    attr_accessor :contents_subdir_name, :texas_dir
+    attr_accessor :verbose, :warnings
+  end
+end
+Texas.texas_dir = File.join(File.dirname(__FILE__), '..')
+Texas.contents_subdir_name = "contents"
+
+require 'pp'
+
+require_relative 'texas/option_parser'
+require_relative 'texas/build'
+require_relative 'texas/core_ext'
+require_relative 'texas/task'
+require_relative 'texas/template'
+require_relative 'texas/version'
+require_relative 'texas/runner'

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

@@ -0,0 +1,8 @@
+<%
+  info.abstract = %Q(This is a one-liner to describe the contents of this template)
+  info.summary = <<-TXT
+    This is a more elaborate summary of the contents of this template!
+  TXT
+%>
+
+Hello World!

data/spec/fixtures/basic-md/contents/contents.md.erb

@@ -0,0 +1 @@
+<%= render "input_template" %>

data/spec/fixtures/basic-md/contents/contents.tex.should

@@ -0,0 +1,3 @@
+Lorem ipsum
+
+ERb is evaluated!

data/spec/fixtures/basic-md/contents/input_template.md.erb

@@ -0,0 +1,3 @@
+Lorem ipsum
+
+<%= "ERb is evaluated!" %>

data/spec/fixtures/basic-tex/contents/contents.tex.erb

@@ -0,0 +1 @@
+<%= input "input_template" %>

data/spec/fixtures/basic-tex/contents/contents.tex.should

@@ -0,0 +1 @@
+\input{input_template}

data/spec/fixtures/basic-tex/contents/input_template.tex.erb

@@ -0,0 +1,3 @@
+Lorem ipsum
+
+<%= "ERb is evaluated!" %>

data/spec/fixtures/basic-tex/contents/input_template.tex.should

@@ -0,0 +1,3 @@
+Lorem ipsum
+
+ERb is evaluated!

data/spec/fixtures/basic-tex/contents/unused_template.tex.erb

@@ -0,0 +1 @@
+This template is never used!

data/spec/fixtures/different-master-tex/contents/contents.tex.erb

@@ -0,0 +1 @@
+Hello World!

data/spec/fixtures/different-master-tex/contents/contents.tex.should

@@ -0,0 +1 @@
+Hello World!

data/spec/fixtures/different-master-tex/contents/master.tex.erb

@@ -0,0 +1,9 @@
+<%= partial :preambel %>
+
+\begin{document}
+
+THIS IS A DIFFERENT MASTER.TEX!
+
+<%= input build.contents_template %>
+
+\end{document}

data/spec/fixtures/different-master-tex/contents/master.tex.should

@@ -0,0 +1,59 @@
+\documentclass[a4paper,parskip=half*,12pt]{scrartcl} 
+
+\usepackage{relsize}
+
+\usepackage{amsmath,amstext,amssymb}
+
+\usepackage[ngerman]{babel}
+\usepackage[utf8]{inputenc} 
+
+
+
+\usepackage{courier}
+
+
+\usepackage[T1]{fontenc}
+
+\usepackage[table]{xcolor}
+\usepackage{color}
+
+
+\usepackage{url,hyperref}
+\urlstyle{same}
+
+\usepackage{setspace}
+
+\clubpenalty = 10000
+\widowpenalty = 10000
+\displaywidowpenalty = 10000
+
+\setlength{\parindent}{1em}
+
+\setcounter{secnumdepth}{0}
+\setcounter{tocdepth}{0}
+
+\usepackage{fancyhdr}
+\pagestyle{fancy}
+
+\fancyhead{}
+\fancyfoot{}
+
+\fancyhead[L]{ -- }
+\fancyhead[C]{}
+\fancyhead[R]{}
+
+\fancyfoot[L]{}
+\fancyfoot[C]{}
+\fancyfoot[R]{\thepage}
+
+
+\onehalfspacing
+
+
+\begin{document}
+
+THIS IS A DIFFERENT MASTER.TEX!
+
+\input{contents}
+
+\end{document}

data/spec/fixtures/helper-methods-tex/contents/contents.tex.erb

@@ -0,0 +1,7 @@
+<%= input "input_template" %>
+
+<%= input "some_chapter" %>
+
+<%= input "template/helper/base" %>
+
+<%= input "template/helper/info" %>

data/spec/fixtures/helper-methods-tex/contents/contents.tex.should

@@ -0,0 +1,7 @@
+\input{input_template}
+
+\input{some_chapter}
+
+\input{template/helper/base}
+
+\input{template/helper/info}

data/spec/fixtures/helper-methods-tex/contents/input_template.tex.erb

@@ -0,0 +1,5 @@
+Lorem ipsum
+
+<%= b "This should be bold" %>
+
+<%= i "This should be italic" %>

data/spec/fixtures/helper-methods-tex/contents/input_template.tex.should

@@ -0,0 +1,5 @@
+Lorem ipsum
+
+\textbf{This should be bold}
+
+\emph{This should be italic}

data/spec/fixtures/helper-methods-tex/contents/some_chapter/another_include.tex

@@ -0,0 +1 @@
+This file is a static .tex file.

data/spec/fixtures/helper-methods-tex/contents/some_chapter/test_include.tex.erb

@@ -0,0 +1,7 @@
+Should find this template relatively and render the template another\_include below:
+
+<%= render "another_include" %>
+
+When using the LaTeX input command, the path should be relative to master.tex e.g. some\_chapter/another\_include
+
+<%= input "another_include" %>

data/spec/fixtures/helper-methods-tex/contents/some_chapter/test_include.tex.should

@@ -0,0 +1,7 @@
+Should find this template relatively and render the template another\_include below:
+
+This file is a static .tex file.
+
+When using the LaTeX input command, the path should be relative to master.tex e.g. some\_chapter/another\_include
+
+\input{some_chapter/another_include}

data/spec/fixtures/helper-methods-tex/contents/some_chapter.tex.erb

@@ -0,0 +1,5 @@
+Texas should find the following template in a subdir with the same name as the this template
+
+(e.g. some\_chapter)
+
+<%= input "test_include" %>

data/spec/fixtures/helper-methods-tex/contents/some_chapter.tex.should

@@ -0,0 +1,5 @@
+Texas should find the following template in a subdir with the same name as the this template
+
+(e.g. some\_chapter)
+
+\input{some_chapter/test_include}

data/spec/fixtures/helper-methods-tex/contents/template/helper/_some_partial.md.erb

@@ -0,0 +1 @@
+This is foo <%= o.foo %>.

data/spec/fixtures/helper-methods-tex/contents/template/helper/base.tex.erb

@@ -0,0 +1,3 @@
+<%= partial "some_partial", :foo => "bar" %>
+
+<%= render "_some_partial" %>

data/spec/fixtures/helper-methods-tex/contents/template/helper/base.tex.should

@@ -0,0 +1,4 @@
+This is foo bar.
+
+
+This is foo .

data/spec/fixtures/helper-methods-tex/contents/template/helper/info.md.erb

@@ -0,0 +1,6 @@
+<!--<%
+  info.abstract = "This does not appear in output"
+  info.summary = "This does not appear in output"
+%>-->
+
+Some content ...

data/spec/fixtures/helper-methods-tex/contents/template/helper/info.tex.should

@@ -0,0 +1 @@
+Some content \ldots{}

data/spec/fixtures/helper-methods-tex/contents/test_figure.tex.erb

@@ -0,0 +1 @@
+<%= figure :test_figure, :caption => "This should be a caption to a figure." %>

data/spec/fixtures/lib-helpers/contents/contents.tex.erb

@@ -0,0 +1,3 @@
+Hello World!
+
+<%= some_value %>

data/spec/fixtures/lib-helpers/contents/contents.tex.should

@@ -0,0 +1,3 @@
+Hello World!
+
+42

data/spec/fixtures/lib-helpers/lib/helpers/document_helper.rb

@@ -0,0 +1,7 @@
+module DocumentHelper
+  def some_value
+    document.some_value
+  end
+end
+
+Texas::Template.register_helper DocumentHelper

data/spec/fixtures/lib-helpers/lib/init.rb

@@ -0,0 +1,4 @@
+glob = File.join( File.dirname(__FILE__), "helpers", "**.rb" )
+Dir[glob].each do |filename|
+  require filename
+end

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

@@ -0,0 +1,9 @@
+This is a sample <%= b "TeX" %> document.
+
+TeX is a typesetting system designed and mostly written by Donald Knuth and released in 1978. Within the typesetting system, its name is formatted as TEX.
+
+Together with the Metafont language for font description and the Computer Modern family of typefaces, TeX was designed with two main goals in mind: to allow anybody to produce high-quality books using a reasonably minimal amount of effort, and to provide a system that would give exactly the same results on all computers, now and in the future.
+
+TeX is a popular means by which to typeset complex mathematical formulae; it has been noted as one of the most sophisticated digital typographical systems in the world.[3] TeX is popular in academia, especially in mathematics, computer science, economics, engineering, physics, statistics, and quantitative psychology. It has largely displaced Unix troff, the other favored formatter, in many Unix installations, which use both for different purposes. It is also used for many other typesetting tasks, especially in the form of LaTeX and other template packages.
+
+The widely used MIME type for TeX is application/x-tex. TeX is free software.

data/spec/fixtures/new/lib/helpers/document_helper.rb

@@ -0,0 +1,11 @@
+module DocumentHelper
+  # All methods defined in this helper are avaiable in all templates.
+  #
+  # <%= foo %> # => "bar"
+  #
+  def foo
+    "bar"
+  end
+end
+
+Texas::Template.register_helper DocumentHelper

data/spec/fixtures/new/lib/init.rb

@@ -0,0 +1,4 @@
+glob = File.join( File.dirname(__FILE__), "helpers", "**.rb" )
+Dir[glob].each do |filename|
+  require filename
+end

data/spec/fixtures/prose/contents/chapter-1/01-some-scene.md

@@ -0,0 +1 @@
+Lorem ipsum 1

data/spec/fixtures/prose/contents/chapter-1/02-another-scene.md

@@ -0,0 +1 @@
+Lorem ipsum 2

data/spec/fixtures/prose/contents/chapter-1/03-and-another-scene.md

@@ -0,0 +1 @@
+Lorem ipsum 3

data/spec/fixtures/prose/contents/contents.md.erb

@@ -0,0 +1 @@
+<%= chapter :title => "Lorem", :glob => "chapter-1/*" %>

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

@@ -0,0 +1,6 @@
+<% 
+  info.write_at_end_of_build = true
+%>
+
+<%= document.message %>
+<% document.message = "Hello World!" %>

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

@@ -0,0 +1,4 @@
+
+
+Hello World!
+

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

@@ -0,0 +1,3 @@
+Hello World!
+
+<%= document.some_value %>

data/spec/fixtures/texasrc/contents/contents.tex.should

@@ -0,0 +1,3 @@
+Hello World!
+
+42

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby -wKU
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require 'rspec'
+require 'fileutils'
+
+require 'texas'
+
+def default_options
+  {:open_pdf => false, :warnings => false}
+end
+
+def rebuild_test_data_dir!(scenario)
+  FileUtils.rm_rf test_data_dir(scenario)
+  FileUtils.mkdir_p test_data_dir(scenario)
+
+  source_dir = original_test_data_dir(scenario)
+  FileUtils.cp_r(source_dir, tmp_dir)
+end
+
+def original_test_data_dir(scenario)
+  File.join(File.dirname(__FILE__), 'fixtures', scenario.to_s)
+end
+
+def test_data_dir(scenario)
+  File.join(tmp_dir, scenario.to_s)
+end
+
+def tmp_dir
+  File.join(File.dirname(__FILE__), '..', 'tmp')
+end
+
+def use_scenario(scenario)
+  rebuild_test_data_dir! scenario
+  Dir.chdir test_data_dir(scenario)
+  Dir.pwd
+end
+
+def run_scenario(scenario, options = {}, &block)
+  options = default_options.merge(options)
+  work_dir = use_scenario(scenario)
+  runner = Texas::Runner.new(options)
+  if block_given?
+    yield runner
+  else
+    match_should_templates work_dir
+  end
+end
+
+def match_should_templates(work_dir)
+  should_templates = Dir[File.join(work_dir, "tmp", "build", "**/*.tex.should")]
+  should_templates.each do |should_file|
+    generated_file = should_file.gsub(/\.should$/, '')
+    File.read(generated_file).should == File.read(should_file)
+  end
+end
+
+RSpec.configure do |config|
+  config.before(:each) {
+#    rebuild_test_data_dir!
+#    Dir.chdir(test_data_dir)
+  }
+end

data/spec/texas/build_spec.rb

@@ -0,0 +1,17 @@
+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

data/spec/texas/template/helper/info_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper')
+
+describe Texas::Template::Runner::Base do
+
+  def test_template(_runner)
+    build = _runner.task_instance
+    template_filename = File.join(build.__path__, "contents.tex.erb")
+    Texas::Template.create( template_filename, build )
+  end
+
+  describe "#info" do
+    it "should return an info object for the given template" do
+      run_scenario "basic" do |runner|
+        template = test_template(runner)
+        template.__run__
+        template.info.should_not be_nil
+      end
+    end
+  end
+  
+  describe "#abstract" do
+    it "should return an info object for the given template" do
+      run_scenario "basic" do |runner|
+        template = test_template(runner)
+        template.__run__
+        template.abstract.should == "This is a one-liner to describe the contents of this template"
+      end
+    end
+  end
+  
+  describe "#summary" do
+    it "should return an info object for the given template" do
+      run_scenario "basic" do |runner|
+        template = test_template(runner)
+        template.__run__
+        template.summary.should == "This is a more elaborate summary of the contents of this template!"
+      end
+    end
+  end
+  
+end

data/spec/texas/template/runner_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Texas::Template::Runner::Base do
+
+  def test_template(_runner)
+    build = _runner.task_instance
+    template_filename = File.join(build.__path__, "contents.tex.erb")
+    Texas::Template.create( template_filename, build )
+  end
+
+  describe "#__path__" do
+    it "should return the absolute path of the given template" do
+      run_scenario "basic" do |runner|
+        build = runner.task_instance
+        template = test_template(runner)
+        template.__path__.should == build.__path__
+      end
+    end
+  end
+  
+  describe "#find_template_file" do
+    it "should return the absolute path of found image" do
+      run_scenario "basic" do |runner|
+        build = runner.task_instance
+        work_dir = build.root
+        template = test_template(runner)
+
+        found_location = template.find_template_file(["figures", "test_figure"], [:pdf, :png])
+        image_file_location = File.join(work_dir, "figures", "test_figure.png")
+        found_location.should == image_file_location
+      end
+    end
+  end
+
+end

data/spec/texas/template_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Texas::Template::Runner do
+  describe ".basename" do
+
+    it "returns the path without the known extensions" do
+      Texas::Template.basename("some_path/some_file.tex.erb").should == "some_path/some_file"
+    end
+
+  end
+end

data/spec/texas_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Texas::Runner do
+  describe "#initialize" do
+
+    it "run basic tex scenario" do
+      run_scenario "basic-tex"
+    end
+
+    it "run basic markdown scenario" do
+      run_scenario "basic-md"
+    end
+
+    it "run scenario with different master file" do
+      run_scenario "different-master-tex"
+    end
+
+    it "run scenario for TeX helper methods" do
+      run_scenario "helper-methods-tex"
+    end
+
+    it "run scenario for .texasrc" do
+      run_scenario "texasrc"
+    end
+
+    it "run scenario for lib/ helpers" do
+      run_scenario "lib-helpers"
+    end
+
+    it "run scenario for rerun" do
+      run_scenario "rerun"
+    end
+
+    it "run scenario for --new" do
+      run_scenario "new"
+    end
+
+    it "run scenario for prose" do
+      run_scenario "prose"
+    end
+
+  end
+end