scxml 0.1.0

data/test/scxml/element_test.rb

@@ -0,0 +1,552 @@
+require File.join(File.dirname(__FILE__), '../scxml_test_helper')
+require 'stringio'
+
+class ElementTest < Test::Unit::TestCase
+	include SCXML
+	include Benchmark
+	
+	def doc_str
+%Q{
+<root>
+  <tags>
+    <tag>a</tag>
+    <tag >b</tag>
+  </tags>
+  <tags key='value'>
+    <tag id='0' another='value'>c</tag>
+  </tags>
+  <another>
+    <tag id='1'>d</tag>
+  </another>
+  <tag id='2'>e</tag>
+</root>}
+	end
+	
+	def doc
+		Document.new(doc_str, :remove_whitespace => true)
+	end
+		
+	#
+	# initialization tests
+	#
+	
+	def test_initialize_without_range_returns_doc_root
+		s = Element.new("")
+		doc = s.doc
+		assert_equal doc.root, s
+		
+		s1 = Element.new(s.doc)
+		assert_equal doc.root, s1
+		
+		s2 = Element.new(s)
+		assert_equal doc.root, s2
+	end
+	
+	def test_initialize_sets_root_attributes_and_content
+		cases = {
+			# basic 
+			"<tag>a</tag>" => ['tag', {}, 'a'],
+			"<tag >a</tag>" => ['tag', {}, 'a'],
+			# with attributes
+			"<tag id='0'>a</tag>" => ['tag', {'id' => '0'}, 'a'],
+			"<tag id='0' key='value'>a</tag>" => ['tag', {'id' => '0', 'key' => 'value'}, 'a'],
+			# with variable content
+			"<tag>some longer content</tag>" => ['tag', {}, 'some longer content'],
+			"<tag><inner>a</inner></tag>" => ['tag', {}, '<inner>a</inner>'],
+			# with newline whitespace
+			"\n<tag>\n  <inner>\n    a\n  </inner>\n</tag>\n" => ['tag', {}, "\n  <inner>\n    a\n  </inner>\n"]}
+		
+		cases.each_pair do |str, expected|
+			s = Element.new(str)
+			assert_equal expected, [s.name, s.attributes, s.content]
+			assert_equal str, s.doc.string
+		end
+	end
+	
+	#
+	# content tests
+	#
+	
+	def test_content
+		cases = {
+			%Q{<?xml version="1.0"?>\n<doc>\n</doc>\n} => "\n",
+			%Q{<?xml version="1.0"?>\n<doc/>\n} => "",
+			%Q{<doc><a></a></doc>} => "<a></a>",
+			%Q{<doc><a/></doc>} => "<a/>",
+			%Q{} => ""}
+		
+		cases.each_pair do |string, expected|
+			e = Element.new(string)
+			assert_equal expected, e.content, string
+		end
+	end
+	
+	def test_content_with_objectify_true
+			cases = {
+			# no content 
+			"<tag></tag>" => "",
+			"<tag/>" => "",
+			# int 
+			"<tag>1</tag>" => 1,
+			"<tag> 10 </tag>" => 10,
+			# float
+			"<tag>1.0</tag>" => 1.0,
+			"<tag>0.1</tag>" => 0.1,
+			"<tag> .1 </tag>" => 0.1,
+			# bool
+			"<tag>true</tag>" => true,
+			"<tag>false</tag>" => false,
+			"<tag> TrUe </tag>" => true,
+			# string
+			"<tag> some string </tag>" => ' some string ',
+			"<tag><inner>a</inner></tag>" => '<inner>a</inner>'}
+		
+		cases.each_pair do |str, expected|
+			s = Element.new(str)
+			assert_equal expected, s.content(true)
+		end
+	end
+	
+	#
+	# children tests
+	#
+	
+	def test_children
+		cases = {
+			%Q{<?xml version="1.0"?>\n<doc><a>\n</a></doc>\n} => ['a'],
+			%Q{<doc><a></a></doc>} => ['a'],
+			%Q{<doc><a/></doc>} => ['a'],
+			%Q{} => [],
+			# test results unique when in sequence
+			%Q{<doc><a></a><a></a></doc>} => ['a', 'a'],
+			%Q{<doc><a/><a/></doc>} => ['a', 'a'],
+			# test results unique when nested
+			%Q{<doc><a><a></a></a></doc>} => ['a'],
+			%Q{<doc><a><a/></a></doc>} => ['a']}
+		
+		cases.each_pair do |string, expected|
+			e = Element.new(string)
+			children_names = e.children.collect { |c| c.name}
+			assert_equal expected, children_names, string
+		end
+	end
+	
+	#
+	# select tests
+	#
+	
+	def assert_selected(element, xpath, expected)
+		assert_equal expected,  element.select(xpath), "selecting on => '#{xpath}'"
+	end
+	
+	def test_select_with_self
+		e = doc.root
+		assert_selected(e, '.', [e])
+	end
+	
+	def test_select_document
+		e = doc.root
+		assert_selected(e, '/', [e.doc])
+	end
+	
+	def test_select_root_element
+		e = doc.root
+		assert_selected(e, '/root', [e])
+	end
+	
+	def test_select_parent
+		e = doc.root
+		assert_selected(e, '..', [])
+	end
+	
+	def assert_selected_content(element, xpath, expected)
+		result = element.select(xpath).collect {|selected| selected.string}
+		assert_equal expected, result, "selecting on => '#{xpath}'"
+	end
+	
+	def test_select_with_astrix_picks_all_children_nodes
+		s = Element.new(doc)
+		
+		expected = [
+			"<tags><tag>a</tag><tag >b</tag></tags>",
+			"<tags key='value'><tag id='0' another='value'>c</tag></tags>",
+			"<another><tag id='1'>d</tag></another>",
+			"<tag id='2'>e</tag>"]
+		
+		assert_selected_content(s, '*', expected)
+	end
+		
+	def btest_selected_elements_have_parent_set
+		s = Element.new(doc)
+		
+		s.select("//tags").each do |e|
+			assert_equal s, e.parent
+		end
+	end
+	
+	def test_select_picks_all_tags_matching_path
+		s = Element.new(doc)
+		
+		tags = [
+			"<tag>a</tag>",
+			"<tag >b</tag>",
+			"<tag id='0' another='value'>c</tag>",
+			"<tag id='1'>d</tag>",
+			"<tag id='2'>e</tag>"]
+		
+		case_test(
+			"//tag" => tags,
+			"root//tag" => [],
+			"/root//tag" => tags,
+			
+			"root/tags/tag" => [],
+			"/root/tags/tag" => tags[0..2],
+			"/root/tags/*" => tags[0..2],
+			"tags/tag" => tags[0..2],
+			"another/tag" => [tags[3]],
+			"/root/another/tag" => [tags[3]],
+			
+			"//tag[@id]" => tags[2..4],
+			"//tag[@id='0']" => [tags[2]]
+			#"//@id" => tags[2..4]
+		) do |path, expected|
+			assert_selected_content(s, path, expected)
+		end	
+	end
+	
+	def test_select_speed
+		benchmark_test do
+			bm(25) do |x| 
+				doc = nil
+				xml_string = ""
+				n_rows = 1000
+				n_cols = 10
+				
+				x.report('Builder make') do 
+					builder = Builder::XmlMarkup.new :target => xml_string
+					builder.root {
+					  builder.rows {
+						1.upto(n_rows) do |i|
+						  builder.row('id' => i.to_s) {
+							1.upto(n_cols) do |j|
+								builder.col("[#{i}, #{j}]", 'id' => j.to_s)
+							end
+						  }
+						end
+					  }
+					}
+				end
+	
+				puts "   XML length: #{xml_string.length}"
+				puts "   n rows: #{n_rows}"
+				puts "   n cols: #{n_rows*n_cols}"
+				
+				x.report('SCXML parse') { doc = Document.new(xml_string) } 
+				x.report('SCXML nodes') { assert_equal(['root', 'rows', 'row', 'col'], doc.node_names) }
+				x.report('SCXML select //row') { assert_equal n_rows, doc.select('//row').length } 
+				x.report('SCXML select rows/row') { assert_equal n_rows, doc.root.select('rows/row').length } 
+				x.report("SCXML select rows/row[@id='10']") {assert_equal 1, doc.root.select("rows/row[@id='10']").length }	
+				x.report('SCXML select //col') {assert_equal n_rows*n_cols, doc.select('//col').length }
+				x.report("SCXML select //col[@id='10']") {assert_equal n_rows, doc.select("//col[@id='10']").length }
+			end
+		end
+	end
+	
+	#
+	# rewrite tests
+	#
+	
+	def test_rewrite_indentation
+		case_test(
+			# basic cases
+			"<a></a>" => "  <a></a>",
+			"<a>content</a>" => "  <a>content</a>",
+			"<a><b></b></a>" => "  <a>\n    <b></b>\n  </a>",
+			"<a><b><c></c></b></a>" => "  <a>\n    <b>\n      <c></c>\n    </b>\n  </a>",
+			"<a>\n  <b></b>\n</a>" => "  <a>\n    <b></b>\n  </a>",
+			"<a><b>content</b></a>" => "  <a>\n    <b>content</b>\n  </a>",
+			"<a>\n  <b>\n  <c></c>\n  </b>\n</a>" => "  <a>\n    <b>\n      <c></c>\n    </b>\n  </a>",
+		
+			# cases with closed tags
+			"<a/>" => "  <a/>",
+			"<a key='value'/>" => "  <a key='value'/>",
+			"<a><b/></a>" => "  <a>\n    <b/>\n  </a>",
+			
+			# funky whitespace, note whitespace in content is preserved
+			"   <a> </a> \n\t " => "  <a> </a>",
+			" <a>\n  <b> content </b>\n\n  \t</a>  " => "  <a>\n    <b> content </b>\n  </a>"
+			
+			# not supported
+			#"<a>content<b></b></a>" => "  <a>content\n    <b></b>\n  </a>"
+		) do |doc, expected|
+			s = Element.new(doc)
+			assert_equal expected, s.rewrite(:indent => 2), doc
+		end	
+	end
+	
+	def test_rewrite_with_new_attributes
+		s = Element.new("<a key='value'></a>")
+		assert_equal({'key' => 'value'}, s.attributes)
+		
+		case_test(
+			# basic cases
+			{:one => '1'} => "<a one='1'></a>"
+			
+			# can't test this due to hashing... workaround?
+			#{:one => '1', :two => '2'} => "<a two='2' one='1'></a>"
+		) do |attr, expected|
+			assert_equal expected, s.rewrite(:attributes => attr), attr
+		end	
+	end
+	
+	def test_merge_attributes_merges_input_with_attributes
+		s = Element.new("<a key='value'></a>")
+		assert_equal({'key' => 'value'}, s.attributes)
+				
+		case_test(
+			{'one' => '1'} => {'one' => '1', 'key' => 'value'},
+			{'key' => 'another'} => {'key' => 'another'}
+		) do |attr, expected|
+			e = Element.new(s.rewrite(:merge_attributes => attr))
+			assert_equal expected, e.attributes, attr
+		end	
+	end
+	
+	def test_rewrite_with_new_content
+		s = Element.new("<a></a>")
+		assert_equal "<a>content</a>", s.rewrite(:add_content => "content")
+	
+		s = Element.new("<a>content</a>")
+		assert_equal "<a>content added</a>", s.rewrite(:add_content => " added")
+	
+		s = Element.new("<a><b/></a>")
+		assert_equal "<a>\n  <b/>\n  <c/>\n</a>", s.rewrite(:add_content => "<c/>")
+	
+		s = Element.new("<a><b/></a>")
+		assert_equal "<a>\n  <b/>\n  <c>\n    <d></d>\n  </c>\n</a>", s.rewrite(:add_content => "<c><d></d></c>")
+	end
+	
+	#
+	# test hashify
+	#
+	
+	def test_hashify_returns_hash_with_name_content_pairs
+		input = ""
+		x = Builder::XmlMarkup.new :target => input
+		x.root {
+			x.key('value')
+			x.another('another value')
+		}
+		
+		e = Element.new(input)
+		assert_equal({'key' => 'value', 'another' => 'another value'}, e.hashify)
+	end
+	
+	def test_hashify_xpath_selects_elements_to_hashify
+		input = ""
+		x = Builder::XmlMarkup.new :target => input
+		x.root {
+			x.one('1', 'id' => 'a')
+			x.two('2', 'id' => 'b')
+			x.three('3', 'id' => 'a')
+		}
+		
+		e = Element.new(input)
+		assert_equal({'one' => '1', 'three' => '3'}, e.hashify("/root/*[@id='a']"))
+	end
+		
+	def test_hashify_block_determines_key
+		input = ""
+		x = Builder::XmlMarkup.new :target => input
+		x.root {
+			x.element('1', 'id' => 'a')
+			x.element('2', 'id' => 'b')
+			x.element('3', 'id' => 'c')
+		}
+		
+		e = Element.new(input)
+		hash = e.hashify do |element|
+			element.attributes['id']
+		end
+		
+		assert_equal({'a' => '1', 'b' => '2', 'c' => '3'}, hash)
+	end
+	
+	def test_attribute_returns_attribute_if_present
+		s = Element.new("<a key='value'></a>")
+		assert_equal('value', s.attribute('key'))
+	end
+	
+	def test_attribute_returns_nil_if_absent
+		s = Element.new("<a></a>")
+		assert_equal(nil, s.attribute('key'))
+		
+		s = Element.new("<a another='value'></a>")
+		assert_equal(nil, s.attribute('key'))
+	end
+end
+
+class Hold
+	#
+	# insert tests
+	#
+	
+	def assert_element(element, string, string_range, content, content_range)	
+		assert_equal string, element.string, "#{element.name} => string"
+		assert_equal string_range, element.string_range, "#{element.name} => string_range"
+		assert_equal content, element.content, "#{element.name} => content"
+		assert_equal content_range, element.content_range, "#{element.name} => content_range"
+	end
+	
+	def test_insert
+		[6, -7].each do |index|
+			s = Element.new("<root></root>")
+			assert_element(s, "<root></root>",  0...s.doc.string.length, "", 6...-7)
+
+			s.insert(index, "text")
+			assert_element(s, "<root>text</root>",  0...s.doc.string.length, "text", 6...-7)
+		end
+	end
+	
+	def nested_insert_setup
+		a = Element.new("<a><b><c></c></b></a>")
+		b = a.select('b').first
+		c = a.select('b/c').first
+		[a,b,c]
+	end
+	
+	def test_nested_insert_setup
+		a,b,c = nested_insert_setup
+		
+		assert_equal 21, a.doc.string.length
+		
+		# string | string_range | content | content_range
+		{a => ["<a><b><c></c></b></a>", 0...21, "<b><c></c></b>", 3...-4],
+		b => ["<b><c></c></b>", 3...-4, "<c></c>", 3...-4],
+		c  => ["<c></c>", 6...-8, "", 3...-4]}.each_pair do |e, expected|
+			assert_element(e, *expected)
+		end
+	end
+	
+	def test_insert_into_nested
+		[3, -4].each do |index|
+			a,b,c = nested_insert_setup
+
+			c.insert(index, "text")
+			
+			# string | string_range | content | content_range
+			{a => ["<a><b><c>text</c></b></a>", 0...25, "<b><c>text</c></b>", 3...-4],
+			b => ["<b><c>text</c></b>", 3...-4, "<c>text</c>", 3...-4],
+			c  => ["<c>text</c>", 6...-8, "text", 3...-4]}.each_pair do |e, expected|
+				assert_element(e, *expected)
+			end
+		end
+	end
+	
+	def test_insert_before_nested
+		# -11 = -4 - content_length
+		[3,-11].each do |index|
+			a,b,c = nested_insert_setup
+
+			b.insert(index, "text")
+			
+			# string | string_range | content | content_range
+			{a => ["<a><b>text<c></c></b></a>", 0...25, "<b>text<c></c></b>", 3...-4],
+			b => ["<b>text<c></c></b>", 3...-4, "text<c></c>", 3...-4],
+			c  => ["<c></c>", 10...-8, "", 3...-4]}.each_pair do |e, expected|
+				assert_element(e, *expected)
+			end
+		end
+	end
+	
+	def test_insert_after_nested
+		# 10 = 3 +  content_length
+		[10, -4].each do |index|
+			a,b,c = nested_insert_setup
+
+			b.insert(index, "text")
+			
+			# string | string_range | content | content_range
+			{a => ["<a><b><c></c>text</b></a>", 0...25, "<b><c></c>text</b>", 3...-4],
+			b => ["<b><c></c>text</b>", 3...-4, "<c></c>text", 3...-4],
+			c  => ["<c></c>", 6...-12, "", 3...-4]}.each_pair do |e, expected|
+				assert_element(e, *expected)
+			end
+		end
+	end
+	
+	#
+	# remove tests
+	#
+	
+	def test_remove
+		[6, -11].each do |index|
+			s = Element.new("<root>text</root>")
+			assert_element(s, "<root>text</root>",  0...s.doc.string.length, "text", 6...-7)
+
+			s.remove(index, 4)
+			assert_element(s, "<root></root>",  0...s.doc.string.length, "", 6...-7)
+		end
+	end
+		
+	def nested_remove_setup
+		a = Element.new("<a><b>text<c>text</c>text</b></a>")
+		b = a.select('b').first
+		c = a.select('b/c').first
+		[a,b,c]
+	end
+	
+	def test_nested_remove_setup
+		a,b,c = nested_remove_setup
+		
+		assert_equal 33, a.doc.string.length
+		
+		{a => ["<a><b>text<c>text</c>text</b></a>", 0...33, "<b>text<c>text</c>text</b>", 3...-4],
+		b => ["<b>text<c>text</c>text</b>", 3...-4, "text<c>text</c>text",  3...-4],
+		c => ["<c>text</c>", 10...-12, "text", 3...-4]}.each_pair do |e, expected|
+			assert_element(e, *expected)
+		end
+	end
+	
+	def test_remove_from_nested
+		[3, -8].each do |index|
+			
+			a,b,c = nested_remove_setup
+
+			c.remove(index, 4)
+			{a => ["<a><b>text<c></c>text</b></a>", 0...29, "<b>text<c></c>text</b>", 3...-4],
+			b => ["<b>text<c></c>text</b>", 3...-4, "text<c></c>text",  3...-4],
+			c => ["<c></c>", 10...-12, "", 3...-4]}.each_pair do |e, expected|
+				assert_element(e, *expected)
+			end
+		end
+	end
+	
+	def test_remove_before_nested
+		[3, -23].each do |index|
+			a,b,c = nested_remove_setup
+
+			b.remove(index, 4)
+			
+			{a => ["<a><b><c>text</c>text</b></a>", 0...29, "<b><c>text</c>text</b>", 3...-4],
+			b => ["<b><c>text</c>text</b>", 3...-4, "<c>text</c>text",  3...-4],
+			c => ["<c>text</c>", 6...-12, "text", 3...-4]}.each_pair do |e, expected|
+				assert_element(e, *expected)
+			end
+		end
+	end
+	
+	def test_remove_after_nested
+		[18, -8].each do |index|
+			a,b,c = nested_remove_setup
+
+			b.remove(index, 4)
+			
+			{a => ["<a><b>text<c>text</c></b></a>", 0...29, "<b>text<c>text</c></b>", 3...-4],
+			b => ["<b>text<c>text</c></b>", 3...-4, "text<c>text</c>",  3...-4],
+			c => ["<c>text</c>", 10...-8, "text", 3...-4]}.each_pair do |e, expected|
+				assert_element(e, *expected)
+			end
+		end
+	end
+end