jarrett-quarto 1.5.1 → 1.6.0

data/VERSION

@@ -1 +1 @@
-1.5.1
+1.6.0

data/lib/quarto/rendering.rb

@@ -1,6 +1,6 @@
 module Quarto
 	class Rendering # :nodoc: all
-		def initialize(__erb_template, __locals, __mixins)
+		def initialize(__erb_template, __locals, __mixins, __output_file_path)
 			unless __erb_template.is_a?(ERB)
 				raise ArgumentError, "Expected ERB but got #{__erb_template.inspect}"
 			end
@@ -29,12 +29,19 @@ module Quarto
 			end
 			
 			@result = __erb_template.result(__b)
+			@output_file_path = __output_file_path
 		end
 		
-		def self.render(erb_template, locals, mixins = [], &block)
-			new(erb_template, locals, mixins, &block).result
+		def self.render(erb_template, locals, mixins = [], output_file_path = '', &block)
+			new(erb_template, locals, mixins, output_file_path, &block).result
 		end
 		
 		attr_reader :result
+		
+		protected
+		
+		def output_file_path
+			@output_file_path
+		end
 	end
 end

data/lib/quarto/transformer.rb

@@ -17,30 +17,6 @@ module Quarto
 	#     end
 	#   end
 	class Transformer
-		# Macro to define the <tt>literal?</tt> method. Accepts
-		# one or more element names.
-		#
-		# Example:
-		#
-		#   class MyTransformer < Quarto::Transformer
-		#     literals 'div', 'p', 'a'
-		#   end
-		#
-		# The above is equivalent to:
-		#
-		#   class MyTransformer < Quarto::Transformer
-		#     def literal?(element)
-		#       ['div', 'p', 'a'].include?(element.name)
-		#     end
-		#   end 
-		def self.literals(*args)
-			class_eval(%Q(
-				def literal?(element)
-					[#{args.collect { |e| "'#{e}'" }.join(',')}].include?(element.name)
-				end
-			))
-		end
-		
 		# Recursively applies the transformation rules
 		# you've defined to +element+ and its children,
 		# returning the results as a string. Depending
@@ -76,7 +52,18 @@ module Quarto
 		
 		protected
 		
-		def content_tag(tag_name, *args) # :nodoc:
+		# Creates an XML tag with the specified name, returning a string.
+		# This method is meant to be called by subclasses of
+		# <tt>Transformer</tt>.
+		#
+		# Example:
+		#
+		#   content_tag('img', 'src' => 'http://example.com/image.jpg')
+		#
+		# If you need to use an absolute path for something, e.g. an image,
+		# you should include <tt>Quarto::UrlHelper</tt> in your
+		# <tt>Transformer</tt> subclass and call <tt>abs_path</tt>.
+		def content_tag(tag_name, *args)
 			if args.last.is_a?(Hash)
 				attributes = args.pop
 			else
@@ -126,6 +113,30 @@ module Quarto
 			false
 		end
 		
+		# Macro to define the <tt>literal?</tt> method. Accepts
+		# one or more element names.
+		#
+		# Example:
+		#
+		#   class MyTransformer < Quarto::Transformer
+		#     literals 'div', 'p', 'a'
+		#   end
+		#
+		# The above is equivalent to:
+		#
+		#   class MyTransformer < Quarto::Transformer
+		#     def literal?(element)
+		#       ['div', 'p', 'a'].include?(element.name)
+		#     end
+		#   end 
+		def self.literals(*args)
+			class_eval(%Q(
+				def literal?(element)
+					[#{args.collect { |e| "'#{e}'" }.join(',')}].include?(element.name)
+				end
+			))
+		end
+		
 		# Recursively transform the +element+ and all its children,
 		# returning a string. Custom transform methods often call
 		# this method.

data/lib/quarto/url_helper.rb

@@ -14,13 +14,36 @@ module Quarto
 			end
 		end
 		
-		# Generates an absolute URL, using the <tt>:site_root</tt> config value. (To change <tt>:site_root</tt>,
+		# Generates an absolute path, using the <tt>:site_root</tt> config value. (To change <tt>:site_root</tt>,
 		# put something like this in <tt>generate.rb</tt>:
 		#   config(:site_root, 'http://your_domain.com/whatever')
-		def abs_url(str)
+		def abs_path(str)
 			"#{Quarto.config[:site_root]}#{str}"
 		end
 		
+		def abs_url(str)
+			warn 'Quarto::UrlHelper#abs_url is deprecated. Use abs_path instead.'
+			abs_path(str)
+		end
+		
+		# Generates a relative path based on the location of the current output file and +path+.
+		# +path+ must be relative to the project's output directory. For example, if
+		# the current output file is in <tt>output/employees</tt>, and you call
+		# <tt>relative_path('images/foo.jpg')</tt>, the result will be <tt>../images/foo.jpg</tt>.
+		def relative_path(path)
+			current_hierarchy = output_file_path.split('/')
+			target_hierarchy = path.split('/')
+			while current_hierarchy[0] == target_hierarchy[0]
+				current_hierarchy.shift
+				target_hierarchy.shift
+			end
+			rel_path = current_hierarchy.inject('') do |result, dir|
+				result + '../'
+			end
+			#puts target_hierarchy.inspect
+			rel_path << target_hierarchy.join('/')
+		end
+		
 		def url_for_with_element_wrapper(options = {})
 			if options.is_a?(Quarto::ElementWrapper::Base)
 				if options.respond_to?(:to_path)

data/quarto.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{quarto}
-  s.version = "1.5.1"
+  s.version = "1.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jarrett Colby"]
-  s.date = %q{2009-06-18}
+  s.date = %q{2009-06-19}
   s.default_executable = %q{quarto}
   s.description = %q{Quarto is a Ruby framework for generating collections of documents from XML. It steps in where XSLT just won't cut it. Potential applications include web sites and e-books. It's built on top of ERB and REXML.}
   s.email = %q{jarrett@uchicago.edu}

data/spec/rendering_spec.rb

@@ -42,4 +42,11 @@ describe Quarto::Rendering do
 			end
 		end
 	end
+	
+	context '#output_file_path' do
+		it 'should return the path' do
+			rendering = Quarto::Rendering.new(ERB.new('foo'), {}, [], 'bar/baz')
+			rendering.send(:output_file_path).should == 'bar/baz'
+		end
+	end
 end

data/spec/sample_project/generate.rb

@@ -1,5 +1,5 @@
 Quarto.generate do
-	config(:site_root, '') # This determines how abs_url works. If you need your absolute URLs to be prepended with something, you can put it here.
+	config(:site_root, '') # This determines how abs_path works. If you need your absolute URLs to be prepended with something, you can put it here.
 
 	use_xml('companies.xml')
 

data/spec/sample_project/urls.rb

@@ -3,7 +3,7 @@ module Quarto
 		include Quarto::UrlHelper
 		
 		def companies_url
-			abs_url('companies.html')
+			abs_path('companies.html')
 		end
 	end
 end

data/spec/url_helper_spec.rb

@@ -145,10 +145,11 @@ describe Quarto::UrlHelper do
 				end
 			end
 			
-			it 'should not call abs_url' do
+			it 'should not call abs_url or abs_path' do
 				['foo', '../foo', '/foo'].each do |rel_url|
 					template = TemplateOutsideRails.new
 					template.should_not_receive(:abs_url)
+					template.should_not_receive(:abs_path)
 					template.url_for(rel_url)
 				end
 			end
@@ -204,4 +205,46 @@ describe Quarto::UrlHelper do
 			end
 		end
 	end
+	
+	context '#relative_path' do
+		before :all do
+			class MockRendering
+				include Quarto::UrlHelper
+				
+				def initialize(output_file_path)
+					@output_file_path = output_file_path
+				end
+				
+				attr_accessor :output_file_path
+			end
+		end
+		
+		after :all do
+			Object.class_eval do
+				remove_const :MockRendering
+			end
+		end
+		
+		it 'should call output_file_path' do
+			rendering = MockRendering.new('employees')
+			rendering.should_receive('output_file_path').and_return('employees')
+			rendering.relative_path('images/foo.jpg')
+		end
+		
+		it 'should derive the correct relative path from output_file_path to the given file' do
+			rendering = MockRendering.new('employees')
+			rendering.relative_path('images/foo.jpg').should == '../images/foo.jpg'
+		end
+		
+		it 'should work for complex directory structures' do
+			[
+				['countries/companies/employees', 'assets/images/foo.jpg', '../../../assets/images/foo.jpg'],
+				['a/b/c/d/e/f', 'a/b/z', '../../../../z'],
+				['a/b/z', 'a/b/c/d/e/f', '../c/d/e/f']
+			].each do |output_file_path, target, expected|
+				rendering = MockRendering.new(output_file_path)
+				rendering.relative_path(target).should == expected
+			end
+		end
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jarrett-quarto
 version: !ruby/object:Gem::Version 
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors: 
 - Jarrett Colby
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-18 00:00:00 -07:00
+date: 2009-06-19 00:00:00 -07:00
 default_executable: quarto
 dependencies: 
 - !ruby/object:Gem::Dependency