texas 0.1.0

data/lib/texas/option_parser.rb

@@ -0,0 +1,175 @@
+require 'optparse'
+require 'optparse/time'
+require 'ostruct'
+require 'pathname'
+
+module Texas
+  class OptionParser
+    attr_reader :args, :options
+
+    def initialize(args)
+      @args = args
+      @options = OpenStruct.new
+    end
+
+    #
+    # Return 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.colors = true
+      options.merge_config = nil
+      options.verbose = false
+      options.warnings = true
+      options.open_pdf = true
+
+      lookup_and_execute_require_option(args)
+      
+      opts = ::OptionParser.new do |opts|
+        opts.banner = "Usage: texas [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
+          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:"
+
+        # Boolean switch.
+        opts.on("-c", "--[no-]color", "Switch colors") do |v|
+          options.colors = v
+        end
+
+        # Boolean switch.
+        opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+          options.verbose = v
+        end
+
+        # Boolean switch.
+        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
+      options
+    end
+
+    private
+
+    # This method can be overwritten by other libraries
+    # to parse additional options
+    def parse_additional_options(opts)
+    end
+    
+    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)
+      if options.work_dir.nil?
+        warn "texas: missing file operand\nTry `texas --help' for more information."
+        exit 1
+      end
+      if options.contents_template.nil?
+        warn "texas: could not find contents template\nTry `texas --help' for more information."
+        exit 1
+      end
+    end
+
+    def find_work_dir(start_dir = Dir.pwd)
+      results = Dir[File.join(start_dir, Texas.contents_subdir_name)]
+      if !results.empty?
+        start_dir
+      else
+        path = Pathname.new(start_dir)
+        if path.realpath.to_s == "/"
+          nil
+        else
+          find_work_dir File.join(start_dir, '..')
+        end
+      end
+    end
+
+    def find_contents_dir(file)
+      if Dir["#{file}*"].empty?
+        nil
+      else
+        File.dirname(file)
+      end
+    end
+
+    def find_contents_file(file)
+      file = file.gsub("#{Texas.contents_subdir_name}/", "")
+      glob = File.join(Texas.contents_subdir_name, "#{file}*")
+      if Dir[glob].empty?
+        nil
+      else
+        file
+      end
+    end
+  end
+
+end

data/lib/texas/runner.rb

@@ -0,0 +1,71 @@
+def verbose(&block)
+  if Texas.verbose
+    value = block.()
+    if value.is_a?(String)
+      puts value
+    else
+      pp value
+    end
+  end
+end
+
+def warning(&block)
+  if Texas.warnings
+    value = block.()
+    if value.is_a?(String)
+      puts "[WARNING]".yellow + " #{value}"
+    else
+      pp value
+    end
+  end
+end
+
+module Texas
+  class Runner
+    attr_reader :task_instance
+
+    def initialize(force_options = nil)
+      @options = if force_options.nil?
+        Texas::OptionParser.new(ARGV).parse
+      else
+        opts = Texas::OptionParser.new([]).parse
+        force_options.each { |k, v| opts.send("#{k}=", v) }
+        opts
+      end
+      extend_string_class
+      Texas.verbose = @options.verbose
+      Texas.warnings = @options.warnings
+      load_local_libs if @options.load_local_libs
+      @task_instance = task_class.new(@options)
+      @task_instance.run
+    end
+    
+    def extend_string_class
+      mod = @options.colors ? Term::ANSIColor : Term::NoColor
+      String.send :include, mod
+    end
+
+    def load_local_libs
+      init_file = File.join(@options.work_dir, "lib", "init.rb")
+      require init_file if File.exist?(init_file)
+    end
+
+    def task_class
+      map = {
+        :build      => Build::Final,
+        :dry        => Build::Dry,
+      }
+      map[@options.task] || fallback_task_class
+    end
+
+    def fallback_task_class 
+      class_name = @options.task.to_s.capitalize
+      begin
+        eval("::Texas::Task::#{class_name}")
+      rescue
+        puts "Failed to fallback for ::Task::#{class_name}"
+        exit
+      end
+    end
+  end
+end

data/lib/texas/task/base.rb

@@ -0,0 +1,23 @@
+module Texas
+  module Task
+    class Base
+      attr_accessor :options
+
+      def initialize(_options, _build = nil)
+        self.options = _options
+        @build = _build if _build
+      end
+
+      def build(klass = Build::Dry)
+        @build ||= klass.run(options)
+      end
+
+      def track
+        build.track
+      end
+
+      def run
+      end
+    end
+  end
+end

data/lib/texas/task/new.rb

@@ -0,0 +1,18 @@
+module Texas
+  module Task
+    class New < Base
+
+      def source_dir
+        File.join(Texas.texas_dir, "spec", "fixtures", "new")
+      end
+
+      def dest_dir
+        File.join(Dir.pwd, options.new_project_name)
+      end
+
+      def run
+        FileUtils.cp_r source_dir, dest_dir
+      end
+    end
+  end
+end

data/lib/texas/task/watch.rb

@@ -0,0 +1,39 @@
+require 'listen'
+
+module Texas
+  module Task
+    class Watch < Base
+      class << self
+        attr_accessor :run_options
+      end
+
+      def run
+        self.class.run_options = options
+        dirs = Task::Watch.directories_to_watch
+        Listen.to(*dirs) do |modified, added, removed|
+          Task::Watch.rebuild
+        end
+      end
+
+      def self.directories_to_watch
+        arr = []
+        arr << "tex"
+        arr << "figures"
+        arr << Texas.texas_dir
+        arr
+      end
+
+      def self.rebuild
+        started_at = Time.now.to_i
+        @build = Build::Final.new(run_options)
+        @build.run
+        finished_at = Time.now.to_i
+        puts (finished_at - started_at).to_s + " seconds to rebuild"
+      rescue Exception => e
+        puts @build.current_template.filename
+        puts "[ERROR] while building \n#{e}"
+      end
+
+    end
+  end
+end

data/lib/texas/task.rb

@@ -0,0 +1,11 @@
+module Texas
+  module Task
+  end
+end
+
+require_relative 'task/base'
+
+all_rbs = Dir[ File.join( File.dirname(__FILE__), "task", "*.rb" ) ]
+all_rbs.each do |t|
+  require t
+end

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

@@ -0,0 +1,82 @@
+# encoding: UTF-8
+module Texas
+  module Template
+    module Helper
+      #
+      # Basic helper methods for finding files and template handling
+      #
+      module Base
+
+        def default_search_paths
+          [
+            __path__, 
+            path_with_templates_basename, 
+            build_path, 
+            build.root
+          ].compact
+        end
+
+        def path_with_templates_basename
+          subdir = Template.basename @output_filename
+          File.directory?(subdir) ? subdir : nil
+        end
+
+        # Searches for the given file in +possible_paths+, also checking for +possible_exts+ as extensions
+        #
+        # Example:
+        #   find_template_file(["figures", "titel"], [:pdf, :png])
+        #   # => will check
+        #          figures/titel.pdf
+        #          figures/titel.png
+        #          tmp/figures/titel.pdf
+        #          tmp/figures/titel.png
+        #
+        def find_template_file(parts, possible_exts = [], possible_paths = default_search_paths)
+          possible_paths.each do |base|
+            ([""] + possible_exts).each do |ext|
+              path = parts.clone.map(&:to_s).map(&:dup)
+              path.unshift base.to_s
+              path.last << ".#{ext}" unless ext.empty?
+              filename = File.join(*path)
+              return filename if File.exist?(filename) && !File.directory?(filename)
+            end
+          end
+          nil
+        end
+
+        # Searches for the given file and raises an error if it is not found anywhere
+        #
+        def find_template_file!(parts, possible_exts = [], possible_paths = default_search_paths)
+          if filename = find_template_file(parts, possible_exts, possible_paths)
+            filename
+          else
+            raise "File doesnot exists anywhere: #{parts.inspect}#{possible_exts.inspect} in #{possible_paths.inspect} #{}"
+          end
+        end
+
+        def partial(name, locals = {})
+          render("_#{name}", locals)
+        end
+
+        def render(name, locals = {})
+          template_file = find_template_file!([name], template_extensions)
+          Template.create(template_file, build).__run__(locals)
+        end
+
+        # Returns all extensions the Template::Runner can handle.
+        def template_extensions
+          Template.known_extensions
+        end
+
+        def templates_by_glob(glob = "*") 
+          files = Dir[File.join(__path__, glob)]
+          templates = files.map do |f| 
+            Template.basename(f).gsub(__path__, '') 
+          end
+          templates.uniq.sort
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+module Texas
+  module Template
+    module Helper
+      #
+      # Helper methods for describing templates via an info object
+      #
+      module Info
+
+        def info
+          @info ||= OpenStruct.new(:abstract => "", :summary => "")
+        end
+
+        def abstract
+          info.abstract.strip
+        end
+        
+        def summary
+          info.summary.strip
+        end
+
+        def marked_for_rewrite?
+          !!info.write_at_end_of_build
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+module Texas
+  module Template
+    module Helper
+      module Markdown
+
+        def chapter(opts = {})
+          if glob = opts[:glob]
+            opts[:templates] = templates_by_glob(glob)
+          end
+          store.__chapters__ ||= []
+          store.__chapters__ << opts
+          partial(:chapter, opts)
+        end
+
+        def center(str)
+          "\\begin{center}#{str}\\end{center}"
+        end
+
+        def gray(text)
+          "\\textcolor{gray}{#{text}}"
+        end
+
+        def page_break
+          "\\clearpage"
+        end
+
+        def scene_delimiter
+          center gray("* * *")
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+module Texas
+  module Template
+    module Helper
+      module TeX
+
+        # Converts all URLs in a text in \url TeX commands
+        #
+        def auto_link(text)
+          text.to_s.gsub(/(https*\:\/\/\S+)/, '\url{\1}')
+        end
+
+        def bold(text)
+          tex :textbf, text
+        end
+        alias b bold
+
+        def h1(*args); tex(:section, *args); end
+        def h2(*args); tex(:subsection, *args); end
+        def h3(*args); tex(:subsubsection, *args); end
+        def h4(text); '\paragraph{'+text+'} ~\\'; end
+
+        def italic(text)
+          tex :emph, text
+        end
+        alias i italic
+
+        def input(*path)
+          write_template_for_input(path)
+          tex :input, relative_template_basename(path)
+        end
+
+        def input!(*path)
+          write_template_for_input(path)
+          tex :include, relative_template_basename(path)
+        end
+
+        def linebreak
+          "\\\\"
+        end
+        alias br linebreak
+        
+        def quote(string)
+          "\"`#{string}\"'"
+        end
+
+        def write_template_for_input(path)
+          filename = find_template_file!(path, template_extensions)
+          template = Template.create(filename, build)
+          template.write
+        end
+
+        private
+
+        # Returns a path relative to the build_path
+        #
+        # Example:
+        #   input_path("/home/rene/github/sample_project/tmp/build/contents.tex.erb")
+        #   # => "contents.tex.erb"
+        #
+        def relative_template_filename(path, possible_exts = Template.known_extensions)
+          filename = find_template_file!(path, possible_exts)
+          filename.gsub(build_path+'/', '')
+        end
+
+        # Returns a path relative to the build_path and strips the template extension
+        #
+        # Example:
+        #   input_path("/home/rene/github/sample_project/tmp/build/contents.tex.erb")
+        #   # => "contents"
+        #
+        def relative_template_basename(path)
+          Template.basename relative_template_filename(path)
+        end
+
+        def tex(command, text)
+          "\\#{command}{#{text}}"
+        end
+
+      end
+    end
+  end
+end

data/lib/texas/template/helper.rb

@@ -0,0 +1,6 @@
+module Texas
+  module Template
+    module Helper
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+require 'texas/template/helper/base'
+require 'texas/template/helper/info'
+require 'erb'
+
+module Texas
+  class Template::Runner::Base
+    include Texas::Template::Helper::Base
+    include Texas::Template::Helper::Info
+
+    attr_accessor :build, :content, :filename
+
+    def initialize(_filename, _build)
+      self.filename = _filename
+      self.build = _build
+      self.content = File.read(filename)
+      @output_filename = filename.gsub(/(\.erb)$/, '')
+    end
+
+    # TODO: Use Forwardable
+    def root; build.root; end
+
+    def build_path
+      build.__path__
+    end
+
+    def __path__
+      File.dirname filename
+    end
+    
+    def document
+      build.document_struct
+    end
+
+    def store
+      build.store
+    end
+
+    def o
+      @locals
+    end
+
+    def append_to_output(str)
+      @erbout << str
+    end
+
+    def __render__(locals = {})
+      @locals = OpenStruct.new(locals)
+      ERB.new(@content, nil, nil, "@erbout").result(binding)
+    end
+
+    def __run__(locals = {})
+      verbose { "[T] #{filename.gsub(build_path, '')}".dark }
+
+      old_current_template = build.current_template
+      build.current_template = self
+      @output = after_render __render__(locals)
+      build.current_template = old_current_template
+      @output
+    end
+
+    def after_write; end
+    def after_render(str); str; end
+
+    def write
+      __run__
+      File.open(@output_filename, 'w') {|f| f.write(@output) }
+      after_write
+    end
+  end
+end

data/lib/texas/template/runner/md.rb

@@ -0,0 +1,16 @@
+require 'texas/template/helper/md'
+
+class Texas::Template::Runner::Markdown < Texas::Template::Runner::Base
+  include Texas::Template::Helper::Markdown
+
+  def after_write
+    if `which pandoc`.empty?
+      puts "\nAborting build: pandoc not found in PATH (required for Markdown rendering)"
+      exit
+    end
+    tex_filename = Texas::Template.basename(@output_filename) + ".tex"
+    `pandoc -S "#{@output_filename}" -o "#{tex_filename}"`
+  end
+end
+
+Texas::Template.register_handler %w(md md.erb), Texas::Template::Runner::Markdown

data/lib/texas/template/runner/tex.rb

@@ -0,0 +1,11 @@
+require 'texas/template/helper/tex'
+
+class Texas::Template::Runner::TeX < Texas::Template::Runner::Base
+  include Texas::Template::Helper::TeX
+
+  def after_render(output)
+    output.gsub(/^%(.+)$/, '')
+  end
+end
+
+Texas::Template.register_handler %w(tex tex.erb), Texas::Template::Runner::TeX

data/lib/texas/template/runner.rb

@@ -0,0 +1,13 @@
+module Texas
+  module Template
+    module Runner
+    end
+  end
+end
+
+require_relative 'runner/base'
+
+all_rbs = Dir[ File.join( File.dirname(__FILE__), "runner", "*.rb" ) ]
+all_rbs.each do |t|
+  require t
+end