artex 2.1.1

data/lib/artex/tempdir.rb

@@ -0,0 +1,52 @@
+require 'fileutils'
+
+module ArTeX
+  
+  class Tempdir #:nodoc:
+        
+    def self.open(parent_path=ArTeX::Document.options[:tempdir])
+      tempdir = new(parent_path)
+      FileUtils.mkdir_p tempdir.path
+      result = Dir.chdir(tempdir.path) do
+        yield tempdir
+      end
+      # We don't remove the temporary directory when exceptions occur,
+      # so that the source of the exception can be dubbed (logfile kept)
+      tempdir.remove!
+      result
+    end
+    
+    def initialize(parent_path, basename='artex')
+      @parent_path = parent_path
+      @basename = basename
+      @removed = false
+    end
+    
+    def path
+      @path ||= File.expand_path(File.join(@parent_path, 'artex', "#{@basename}-#{uuid}"))
+    end
+    
+    def remove!
+      return false if @removed
+      FileUtils.rm_rf path
+      @removed = true
+    end
+    
+    #######
+    private
+    #######
+    
+    # Try using uuidgen, but if that doesn't work drop down to
+    # a poor-man's UUID; timestamp, thread & object hashes
+    # Note: I don't want to add any dependencies (so no UUID library)
+    def uuid
+      if (result = `uuidgen`.strip rescue nil).empty?
+        "#{Time.now.to_i}-#{Thread.current.hash}-#{hash}"
+      else
+        result
+      end
+    end
+    
+  end
+  
+end

data/lib/artex/version.rb

@@ -0,0 +1,77 @@
+# (The MIT License)
+# 
+# Copyright (c) 2008 Jamis Buck <jamis@37signals.com>,
+#               with modifications by Bruce Williams <bruce@codefluency.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+module ArTeX
+  
+    
+  # A class for describing the current version of a library. The version
+  # consists of three parts: the +major+ number, the +minor+ number, and the
+  # +tiny+ (or +patch+) number.
+  class Version
+  
+    # A convenience method for instantiating a new Version instance with the
+    # given +major+, +minor+, and +tiny+ components.
+    def self.[](major, minor, tiny)
+      new(major, minor, tiny)
+    end
+    
+    attr_reader :major, :minor, :tiny
+
+    # Create a new Version object with the given components.
+    def initialize(major, minor, tiny)
+      @major, @minor, @tiny = major, minor, tiny
+    end
+
+    # Compare this version to the given +version+ object.
+    def <=>(version)
+      to_i <=> version.to_i
+    end
+
+    # Converts this version object to a string, where each of the three
+    # version components are joined by the '.' character. E.g., 2.0.0.
+    def to_s
+      @to_s ||= [@major, @minor, @tiny].join(".")
+    end
+
+    # Converts this version to a canonical integer that may be compared
+    # against other version objects.
+    def to_i
+      @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
+    end
+    
+    def to_a
+      [@major, @minor, @tiny]
+    end
+
+    MAJOR = 2
+    MINOR = 1
+    TINY  = 1
+    
+    # The current version as a Version instance
+    CURRENT = new(MAJOR, MINOR, TINY)
+    # The current version as a String
+    STRING = CURRENT.to_s
+        
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'artex'

data/test/document_test.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) << '/test_helper'
+
+class DocumentTest < Test::Unit::TestCase
+
+  context "Document Generation" do
+  
+    setup do
+      change_tmpdir_for_testing
+    end
+  
+    should "have a to_pdf method" do
+      assert document(:first).respond_to?(:to_pdf)
+    end
+    
+    context "when escaping" do
+      setup do
+        @obj = Object.new
+        def @obj.to_s
+          '\~'
+        end
+        @escaped = '\textbackslash{}\textasciitilde{}'
+      end
+      should "escape character" do
+        assert_equal @escaped, ArTeX::Document.escape(@obj.to_s)
+      end
+      should "convert argument to string before attempting escape" do        
+        assert_equal @escaped, ArTeX::Document.escape(@obj)
+      end
+    end
+    
+    should "use a to_pdf block to move a file to a relative path" do
+      begin
+        path = File.expand_path(File.dirname(__FILE__) << '/tmp/this_is_relative_to_pwd.pdf')
+        document(:first).to_pdf do |filename|
+          assert_nothing_raised do
+            FileUtils.move filename, path
+          end
+          assert File.exists?(path)
+        end
+      ensure
+        FileUtils.rm path rescue nil
+      end
+    end
+  
+    should "generate PDF and return as a string" do
+      @author = 'Foo'
+      assert_equal '%PDF', document(:first).to_pdf(binding)[0, 4]
+    end
+  
+    should "generate TeX source and return as a string with debug option" do
+      @author = 'Foo'
+      assert_not_equal '%PDF', document(:first, :tex => true).to_pdf(binding)[0, 4]    
+    end
+  
+    should "generate PDF and give access to file directly" do
+      @author = 'Foo'
+      data_read = nil
+      invocation_result = document(:first).to_pdf(binding) do |filename|
+        data_read = File.open(filename, 'rb') { |f| f.read }
+        :not_the_file_contents
+      end
+      assert_equal '%PDF', data_read[0, 4]
+      assert_equal :not_the_file_contents, invocation_result
+    end
+  
+    should "generate TeX source and give access to file directly" do
+      @author = 'Foo'
+      data_read = nil
+      invocation_result = document(:first, :tex => true).to_pdf(binding) do |filename|
+        data_read = File.open(filename, 'rb') { |f| f.read }
+        :not_the_file_contents
+      end
+      assert_not_equal '%PDF', data_read[0, 4]
+      assert_equal :not_the_file_contents, invocation_result
+    end
+  
+    should "wrap in a layout using `yield'" do
+      doc = document(:fragment, :layout => 'testing_layout[<%= yield %>]')
+      @name = 'ERB'
+      source = doc.source(binding)
+      assert source =~ /^testing_layout.*?ERB, Fragmented/
+    end
+  
+  end
+  
+end

data/test/filter_test.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) << '/test_helper'
+
+class FilterTest < Test::Unit::TestCase
+
+  context "Filtering Documents" do
+  
+    should "filter through textile" do
+      doc = document('text.textile', :filter => 'textile')
+      source = doc.source(binding)
+      assert source.include?('\item')
+    end
+  
+    should "not affect layouts" do
+      doc = document('text.textile',
+              :filter => 'textile',
+              :layout => "* layout\n* is\n<%= yield %>")
+      source = doc.source(binding)
+      assert source.include?("* layout"), "filtered layout"
+      assert source.include?('\item'), "didn't filter content"
+    end
+
+  end
+  
+end

data/test/fixtures/first.tex

@@ -0,0 +1,50 @@
+% This percent indicates a comment.
+% This is a very simple latex article that introduces the way 
+% equations are typeset.  Do this in linux:
+%
+% latex first.tex
+% latex first.tex
+% xdvi first.dvi
+% dvips -o first.ps first.dvi
+% gv first.ps
+% lpr first.ps
+% pdflatex first.tex
+% acroread first.pdf
+\documentclass[12pt]{article}
+\title{First \LaTeX} 
+\author{Joe Student}
+\date{\today}
+
+\begin{document}
+
+\maketitle
+
+\abstract{This is a very simple example of using \LaTeX\ for typesetting.
+The procedure for typesetting equations is introduced.}
+\begin{sdsd}
+\end{bar}
+
+\section{A few equations}
+Equations can be typeset inline like so: $\vec{F}=m\vec{a}$ .
+Equations can also be separated form the text: $$ \vec{F}=m\vec{a} \ . $$
+Notice the punctuation, the ``.'', had to be included with the equation. 
+Equations can also have a number assigned and a label attached,
+as in the following:
+\begin{equation}
+\frac{D\vec{\omega}}{Dt} =
+( \vec{\omega} + \vec{\Omega}) \cdot \nabla  \vec{U}
++ \frac{1}{\rho^2} \nabla \rho \times \nabla p 
++ \nu \nabla^2  \vec{\omega} 
+\label{vorteq}
+\end{equation}
+The vorticity equation (\ref{vorteq}) is referenced by label,
+not by number.  The numbers may change as the document grows and
+more equations are added.
+
+New paragraphs are indicated with a blank line in the source code.
+
+\section{The End}
+
+Further examples of \LaTeX\ can be found at {\tt it.metr.ou.edu}
+
+\end{document}

data/test/fixtures/first.tex.erb

@@ -0,0 +1,48 @@
+% This percent indicates a comment.
+% This is a very simple latex article that introduces the way 
+% equations are typeset.  Do this in linux:
+%
+% latex first.tex
+% latex first.tex
+% xdvi first.dvi
+% dvips -o first.ps first.dvi
+% gv first.ps
+% lpr first.ps
+% pdflatex first.tex
+% acroread first.pdf
+\documentclass[12pt]{article}
+\title{First \LaTeX} 
+\author{<%= @author %>}
+\date{\today}
+
+\begin{document}
+
+\maketitle
+
+\abstract{This is a very simple example of using \LaTeX\ for typesetting.
+The procedure for typesetting equations is introduced.}
+
+\section{A few equations}
+Equations can be typeset inline like so: $\vec{F}=m\vec{a}$ .
+Equations can also be separated form the text: $$ \vec{F}=m\vec{a} \ . $$
+Notice the punctuation, the ``.'', had to be included with the equation. 
+Equations can also have a number assigned and a label attached,
+as in the following:
+\begin{equation}
+\frac{D\vec{\omega}}{Dt} =
+( \vec{\omega} + \vec{\Omega}) \cdot \nabla  \vec{U}
++ \frac{1}{\rho^2} \nabla \rho \times \nabla p 
++ \nu \nabla^2  \vec{\omega} 
+\label{vorteq}
+\end{equation}
+The vorticity equation (\ref{vorteq}) is referenced by label,
+not by number.  The numbers may change as the document grows and
+more equations are added.
+
+New paragraphs are indicated with a blank line in the source code.
+
+\section{The End}
+
+Further examples of \LaTeX\ can be found at {\tt it.metr.ou.edu}
+
+\end{document}

data/test/fixtures/fragment.tex.erb

@@ -0,0 +1 @@
+\par <%= @name %>, Fragmented

data/test/fixtures/text.textile

@@ -0,0 +1,4 @@
+This is a list:
+* One
+* Two
+* _three_

data/test/tempdir_test.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) << '/test_helper'
+
+class TempdirTest < Test::Unit::TestCase
+
+  context "Creating a temporary directory" do
+  
+    setup do
+      change_tmpdir_for_testing
+    end
+  
+    should "change directory" do
+      old_location = Dir.pwd
+      block_location = nil
+      ArTeX::Tempdir.open do
+        assert_not_equal old_location, Dir.pwd
+        block_location = Dir.pwd
+      end
+      assert_equal old_location, Dir.pwd
+      assert !File.exists?(block_location)
+    end
+  
+    should "use a 'artex' name prefix" do
+      ArTeX::Tempdir.open do
+        assert_equal 'artex', File.basename(Dir.pwd)[0,5]
+      end
+    end
+  
+    should "remove the directory after use if no exception occurs by default" do
+      path = nil
+      ArTeX::Tempdir.open do
+        path = Dir.pwd
+        assert File.exists?(path)
+      end
+      assert !File.exists?(path)
+    end
+  
+    should "return the result of the last statement if automatically removing the directory" do
+      result = ArTeX::Tempdir.open do
+        :last
+      end
+      assert_equal :last, :last
+    end
+  
+    should "return the result of the last statment if not automatically removing the directory" do
+      tempdir = nil # to capture value
+      result = ArTeX::Tempdir.open do |tempdir|
+        :last
+      end
+      tempdir.remove!
+      assert_equal :last, :last
+    end
+  
+    should "not remove the directory after use if an exception occurs" do
+      path = nil
+      assert_raises RuntimeError do
+        ArTeX::Tempdir.open do
+          path = Dir.pwd
+          assert File.directory?(path)
+          raise "Test exception!"
+        end
+      end
+      assert File.directory?(path)
+    end
+  
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+
+require 'rubygems'
+begin
+  require 'shoulda'
+  require 'flexmock/test_unit'
+rescue LoadError
+  abort "the `Shoulda' and `flexmock' gems are required for testing"
+end
+
+require File.dirname(__FILE__) << '/../lib/artex'
+
+class Test::Unit::TestCase
+  
+  def change_tmpdir_for_testing
+    flexmock(Dir).should_receive(:tmpdir).and_return(File.dirname(__FILE__) << '/tmp')
+  end
+
+  def document(name, options={})
+    name = name.kind_of?(Symbol) ? "#{name}.tex.erb" : name
+    template = File.read(File.dirname(__FILE__) << "/fixtures/#{name}")
+    ArTeX::Document.new(template, options)
+  end
+end
+