jarrett-quarto 1.4.1 → 1.5.0

data/VERSION

@@ -1 +1 @@
-1.4.1
+1.5.0

data/lib/quarto/generator.rb

@@ -27,6 +27,9 @@ module Quarto
 		Dir.glob(project_path + '/models/*.rb').each do |model_file|
 			require model_file
 		end
+		Dir.glob(project_path + '/transformers/*.rb').each do |transformer_file|
+			require transformer_file
+		end
 		generator = Quarto::Generator.new(project_path)
 		generator.generate(&block)
 		generator

data/lib/quarto/init_project.rb

@@ -4,7 +4,8 @@ module Quarto
 		'models',
 		'output',
 		'pages',
-		'xml'
+		'xml',
+		'transformers'
 	]
 
 	STARTER_GENERATE_FILE = %q(

data/lib/quarto/transformer.rb

@@ -9,7 +9,7 @@ module Quarto
 	#
 	#   class MyTranformer < Quarto::Transformer
 	#     # This method will handle all <book> elements
-	#     def transform_book(book_element)
+	#     def transform_book(book_element, raise_on_unrecognized_element)
 	#        # Return whatever string you like
 	#        # raise_on_unrecognized_element is provided
 	#        # so that you can pass it to recursive_transform
@@ -147,6 +147,21 @@ module Quarto
 				element.to_s
 			end
 		end
+		
+		# Replaces +element+ with +replace_with+, adding any
+		# +attributes+. This is a convenience method for use
+		# inside a custom transform method. It's not infinitely
+		# flexible, but it simplifies a common task. Calls
+		# recursive_transform on +element+'s children.
+		def replace_element(element, replace_with, raise_on_unrecognized_element, attributes = {})
+			raise ArgumentError, "Expected REXML::Element but got #{element.inspect}" unless element.is_a?(REXML::Element)
+			raise ArgumentError, "Expected String but got #{replace_with.inspect}" unless replace_with.is_a?(String)
+			raise ArgumentError, "Expected Hash but got #{attributes.inspect}" unless attributes.is_a?(Hash)
+			contents = element.children.inject('') do |result, child|
+				result + recursive_transform(child, raise_on_unrecognized_element)
+			end
+			content_tag(replace_with, contents, attributes)
+		end
 	end
 	
 	class UnrecognizedElementError < RuntimeError; end

data/quarto.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{quarto}
-  s.version = "1.4.1"
+  s.version = "1.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jarrett Colby"]
@@ -57,6 +57,7 @@ Gem::Specification.new do |s|
      "spec/sample_project/models/location.rb",
      "spec/sample_project/models/mascot.rb",
      "spec/sample_project/models/product.rb",
+     "spec/sample_project/transformers/descriptions_transformer.rb",
      "spec/sample_project/urls.rb",
      "spec/spec_helper.rb",
      "spec/transformation_helper_spec.rb",

data/spec/matchers/rexml_matchers.rb

@@ -8,21 +8,30 @@ module Quarto
 			
 			def matches?(target)
 				@target = target
+				return false unless @target.is_a?(REXML::Element)
 				!@target.find_first_recursive { |node| node_matches?(node) }.nil?
 			end
 			
 			def failure_message
-				"Expected element '#{element_desc}' to be in:\n\n#{@target.to_s}"
+				if @target.is_a?(REXML::Element)
+					"Expected element #{element_desc} to be in:\n\n#{@target.to_s}"
+				else
+					"Expected #{@target.inspect} to be a REXML::Element"
+				end
 			end
 			
 			def negative_failure_message
-				"Expected element '#{element_desc}' not to be in:\n\n#{@target.to_s}"
+				if @target.is_a?(REXML::Element)
+					"Expected element #{element_desc} not to be in:\n\n#{@target.to_s}"
+				else
+					"Expected #{@target.inspect} to be a REXML::Element"
+				end
 			end
 			
 			protected
 			
 			def element_desc
-				desc = @element_name
+				desc = '<' + @element_name + '>'
 				if @options.has_key?(:attributes)
 					desc << " with attributes: #{@options[:attributes].inspect}"
 					if @options.has_key?(:text)

data/spec/sample_project/transformers/descriptions_transformer.rb

@@ -0,0 +1,5 @@
+class DescriptionsTransformer < Quarto::HtmlTransformer
+	def transform_tv(element, raise_on_unrecognized_elements)
+		replace_element(element, 'cite', raise_on_unrecognized_elements, 'class' => 'tv_show')
+	end
+end

data/spec/transformer_spec.rb

@@ -145,4 +145,22 @@ describe Quarto::Transformer do
 			end
 		end
 	end
+	
+	context '#replace_element' do
+		before :each do
+			@html = REXML::Document.new('<p><tv>The Office</tv> is a popular show.</p>')
+			@tv_element = REXML::XPath.first(@html, '//tv')
+			@t = Quarto::HtmlTransformer.new
+		end
+		
+		it 'should substitute the given elements and attributes' do
+			output = @t.send(:replace_element, @tv_element, 'cite', false, {'class' => 'tv_show'})
+			REXML::Document.new(output).should have_element('cite', :attributes => {'class' => 'tv_show'}, :text => 'The Office')
+		end
+		
+		it 'should pass the contents of the replaced tag to recursive_transform' do
+			@t.should_receive(:recursive_transform).with(@tv_element.children[0], false).and_return('The Office')
+			@t.send(:replace_element, @tv_element, 'cite', false, {'class' => 'tv_show'})
+		end
+	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jarrett-quarto
 version: !ruby/object:Gem::Version 
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors: 
 - Jarrett Colby
@@ -92,6 +92,7 @@ test_files:
 - spec/sample_project/models/location.rb
 - spec/sample_project/models/mascot.rb
 - spec/sample_project/models/product.rb
+- spec/sample_project/transformers/descriptions_transformer.rb
 - spec/sample_project/urls.rb
 - spec/spec_helper.rb
 - spec/transformation_helper_spec.rb