eadcodec 0.0.1

data/test/TestEADLevel.rb

@@ -0,0 +1,76 @@
+require "TestEAD"
+require "EADSubordinates"
+require "EADLevel"
+
+class TestEADLevel < TestEAD
+	def initialize(*args)
+		super(*args)
+		
+		@test_file = "test_ead_level.xml"
+	end
+
+	def test_attrs
+		dsc = EAD::EADSubordinates.new
+		@ead.add_descelem(dsc)
+		
+		c01 = EAD::EADLevel.new
+		c01.did = EAD::EADDescription.new
+		c01.phystech = EAD::EADPhysTech.new
+		dsc.add_level(c01)
+	
+		c02 = EAD::EADLevel.new
+		c01.add_level(c02)
+
+		c03 = EAD::EADLevel.new
+		c02.add_level(c03)
+
+		export
+		element_exists("/ead/archdesc/dsc/c01", "Check that the level was added")
+		element_exists("/ead/archdesc/dsc/c01/did", "Check that the description was added")
+		element_exists("/ead/archdesc/dsc/c01/phystech", "Check that the phystech was added")
+		element_exists("/ead/archdesc/dsc/c01/c02", "Check that the second level was added")
+		element_exists("/ead/archdesc/dsc/c01/c02/c03", "Check that the third level was added")
+	end
+
+	def test_import
+		import
+		dsc = @ead.descelems[0]
+		assert(dsc.levels[0], "Check that the level was imported")
+		assert(dsc.levels[0].did, "Check that the description was imported")
+		assert(dsc.levels[0].levels[0], "Check that the second level was imported")
+		assert(dsc.levels[0].levels[0].levels[0], "Check that the third level was imported")
+	end
+	
+	def test_attrs_unnumbered
+		dsc = EAD::EADSubordinates.new
+		@ead.add_descelem(dsc)
+		
+		c01 = EAD::EADLevel.new
+		c01.set_unnumbered
+		c01.did = EAD::EADDescription.new
+		c01.phystech = EAD::EADPhysTech.new
+		dsc.add_level(c01)
+	
+		c02 = EAD::EADLevel.new
+		c01.add_level(c02)
+
+		c03 = EAD::EADLevel.new
+		c02.add_level(c03)
+
+		export
+		element_exists("/ead/archdesc/dsc/c", "Check that the level was added")
+		element_exists("/ead/archdesc/dsc/c/did", "Check that the description was added")
+		element_exists("/ead/archdesc/dsc/c/phystech", "Check that the phystech was added")
+		element_exists("/ead/archdesc/dsc/c/c", "Check that the second level was added")
+		element_exists("/ead/archdesc/dsc/c/c/c", "Check that the third level was added")
+	end
+	
+	def test_import_unnumbered
+		import
+		dsc = @ead.descelems[0]
+		assert(dsc.levels[0], "Check that the level was imported")
+		assert(dsc.levels[0].did, "Check that the description was imported")
+		assert(dsc.levels[0].levels[0], "Check that the second level was imported")
+		assert(dsc.levels[0].levels[0].levels[0], "Check that the third level was imported")
+	end
+end

data/test/TestEADNote.rb

@@ -0,0 +1,36 @@
+require "TestEAD"
+require "EADNote"
+
+class TestEADNote < TestEAD
+	def initialize(*args)
+		super(*args)
+		
+		@test_file = "test_ead_note.xml"
+		@p = "Test p"
+	end
+
+	def test_attrs
+		dsc = EAD::EADSubordinates.new
+		@ead.add_descelem(dsc)
+		
+		c01 = EAD::EADLevel.new
+		dsc.add_level(c01)
+		
+		sc = EAD::EADNote.new
+		sc.p << EAD::EADP.new(@p)
+		sc.p << EAD::EADP.new(@p)
+		c01.note = sc
+		
+		export
+		element_exists("/ead/archdesc/dsc/c01/note", "Check that the scopecontent was added")
+		compare_xpath(@p, "/ead/archdesc/dsc/c01/note/p")
+	end
+
+
+	def test_import
+		import
+		note = @ead.descelems[0].levels[0].note
+		assert_equal(@p, note.p[0].value)
+		assert_equal(@p, note.p[1].value)
+	end
+end

data/test/TestEADPhysTech.rb

@@ -0,0 +1,44 @@
+require "TestEAD"
+
+class TestEADPhysTech < TestEAD
+	def initialize(*args)
+		super(*args)
+		@test_file = "test_ead_phystech.xml"
+		@head = "HEADTest"
+		@ptext = "Some Text "
+	end
+
+	def test_export
+		phystech = EAD::EADPhysTech.new
+		phystech.head = @head
+		(1..4).each {|i| phystech.p << EAD::EADP.new(@ptext+i.to_s)}
+		
+		did = EAD::EADDescription.new
+		did.head = "head"
+		did.unitid = "id"
+
+		@ead.archdesc.phystech = phystech
+		@ead.archdesc.did = did
+		export
+
+		# Since we've added content it is now valid EAD
+		validate_dtd
+
+		element_exists("/ead/archdesc/phystech", "Test did exists")
+		compare_xpath(@head, "/ead/archdesc/phystech/head")
+		(1..4).each do |i| 
+			compare_xpath(@ptext+i.to_s, "/ead/archdesc/phystech/p["+i.to_s+"]")
+		end
+	end
+
+
+	def test_import
+		import
+		phystech = @ead.archdesc.phystech
+
+		assert_equal(@head, phystech.head.value)
+		(1..4).each do |i| 
+			assert_equal(@ptext+i.to_s, phystech.p[i-1].value)
+		end
+	end
+end

data/test/TestEADScopeContent.rb

@@ -0,0 +1,43 @@
+require "TestEAD"
+require "EADSubordinates"
+require "EADLevel"
+require "EADScopeContent"
+
+class TestEADScopeContent < TestEAD
+	def initialize(*args)
+		super(*args)
+		
+		@test_file = "test_ead_scopecontent.xml"
+		@head = "Test Head"
+		@p = "Test p"
+	end
+
+	def test_attrs
+		dsc = EAD::EADSubordinates.new
+		@ead.add_descelem(dsc)
+		
+		c01 = EAD::EADLevel.new
+		dsc.add_level(c01)
+		
+		sc = EAD::EADScopeContent.new
+		sc.head = @head
+		sc.p << EAD::EADP.new(@p)
+		sc.p << EAD::EADP.new(@p)
+		c01.scopecontent = sc
+		
+		export
+		element_exists("/ead/archdesc/dsc/c01/scopecontent", "Check that the scopecontent was added")
+		compare_xpath(@head, "/ead/archdesc/dsc/c01/scopecontent/head")
+		compare_xpath(@p, "/ead/archdesc/dsc/c01/scopecontent/p")
+	end
+
+
+	def test_import
+		import
+		assert_equal(1, @ead.archdesc.dsc[0].c.size)
+		sc = @ead.archdesc.dsc[0].c[0].scopecontent
+		assert_equal(@head, sc.head.value)
+		assert_equal(@p, sc.p[0].value)
+		assert_equal(@p, sc.p[1].value)
+	end
+end

data/test/TestEADStreamParser.rb

@@ -0,0 +1,109 @@
+require "TestEAD"
+require "EADStreamParser"
+require "rexml/document"
+
+class MyEADStreamListener
+	attr_reader :eadheader, :did
+
+	def el_eadheader(el)
+		@eadheader = el
+	end
+	
+	def el_did(el)
+		@did = el
+	end
+end
+
+class MyEADStreamListener2
+	attr_reader :dsc, :c01
+
+	def el_dsc(el)
+		@dsc = el
+	end
+	
+	def el_c01(el)
+		@c01 = el
+	end
+end
+
+class TestEADStreamParser < TestEAD
+	def initialize(*args)
+		super(*args)
+
+		@test_file = "test_ead_stream_parser.xml"
+
+		@head = "HEADTest"
+		@origination = "somwhere"
+		@unittitle = "Some Title"
+		@unitid = "15235"
+		@abstract = "Some Abstract"
+		@physdesc = "Some Description"
+		@physloc = "Some Location"
+
+		@unitdate = "1/1/2001"
+		@unitdatelabel = "TestLabel"
+		@unitdatetype = "inclusive"
+	end
+
+	def test_base_import
+		did = EAD::EADDescription.new
+		did.head = @head
+		did.origination = @origination
+		did.unittitle = @unittitle
+		did.unitid = @unitid
+		did.abstract = @abstract
+		did.physdesc = @physdesc
+		did.physloc = @physloc
+
+		did.unitdate = EAD::EADUnitDate.new(@unitdate)
+		did.unitdate.label = @unitdatelabel
+		did.unitdate.type = @unitdatetype
+
+		@ead.add_description(did)
+		
+		export
+		
+		listener = MyEADStreamListener.new
+		parser = EAD::EADStreamParser.new(listener)
+		parser.parse(File.new(@test_file))
+		
+		assert(listener.eadheader, "Header was not imported")
+		assert_equal("1", listener.eadheader.eadid.value)
+		assert_equal("Teste", listener.eadheader.eadtitle.value)
+		
+		assert(listener.did, "DID was not imported")
+		did = listener.did
+		
+		xmlstr = did.create_xml(REXML::Document.new).to_s
+		assert_equal(did.__xml_text.tr(" \n\t",""), xmlstr.tr(" \n\t",""))
+		
+		assert_equal(@head, did.head.value)
+		assert_equal(@origination, did.origination.value) 
+		assert_equal(@unittitle, did.unittitle.value) 
+		assert_equal(@unitid, did.unitid.value)
+		assert_equal(@abstract, did.abstract.value)
+		assert_equal(@physdesc, did.physdesc.value)
+		assert_equal(@physloc, did.physloc.value)
+
+		assert_equal(@unitdate, did.unitdate.value)
+		assert_equal(@unitdatelabel, did.unitdate.label) 
+		assert_equal(@unitdatetype, did.unitdate.type)
+	end
+	
+	def test_level_numbering
+		dsc = EAD::EADSubordinates.new
+		@ead.add_descelem(dsc)
+		
+		c01 = EAD::EADLevel.new
+		dsc.add_level(c01)
+		
+		export
+		
+		listener = MyEADStreamListener2.new
+		parser = EAD::EADStreamParser.new(listener)
+		parser.parse(File.new(@test_file))
+		
+		assert(listener.dsc, "DSC was not imported")
+		assert_equal(listener.dsc.element_id, listener.c01.parent_id)
+	end
+end

data/test/TestEADSubordinates.rb

@@ -0,0 +1,33 @@
+require "TestEAD"
+require "EADSubordinates"
+
+class TestEADSubordinates < TestEAD
+
+	def initialize(*args)
+		super(*args)
+
+		@test_file = "test_ead_subordinates.xml"
+
+		@type = "combined"
+		@head = "Some head"
+	end
+
+	def test_attrs
+		dsc = EAD::EADSubordinates.new
+		dsc.type = @type
+		dsc.head = @head
+		
+		@ead.add_descelem(dsc)
+		export
+		compare_xpath(@type, "/ead/archdesc/dsc/@type")
+		compare_xpath(@head, "/ead/archdesc/dsc/head")
+	end
+
+	def test_import
+		import
+		dsc = @ead.descelems[0]
+
+		assert_equal(@type, dsc.type)
+		assert_equal(@head, dsc.head.value)
+	end
+end

data/test/TestEADSubtitle.rb

@@ -0,0 +1,40 @@
+require "TestEAD"
+require "EADSubtitle"
+
+class TestEADSubtitle < TestEAD
+	def setup
+		super
+		@test_file = "test_ead_subtitle.xml"
+		@abbr = "testeabbr"
+		@text = "ABCD"
+	end
+
+	def test_base_export
+		titlestmt = @ead.eadheader.filedesc.titlestmt
+	
+		st = titlestmt.subtitle = EAD::EADSubtitle.new
+		st.subelements << @text
+		st.subelements << EAD::EADAbbr.new(@abbr)
+		st.subelements << @text
+		st.subelements << EAD::EADAbbr.new(@abbr)
+		
+		export
+		# The base document has an empty archdesc and is thus not valid EAD
+		# Just check for well-formed XML, although REXML will probably never
+		# output anything else.
+		validate_well_formed 
+
+		compare_xpath("1", "/ead/eadheader/eadid")
+		compare_xpath("Teste", "/ead/eadheader/filedesc/titlestmt/titleproper")
+		compare_xpath(@abbr, "/ead/eadheader/filedesc/titlestmt/subtitle/abbr")
+	end
+
+	def test_base_import
+		import
+		st = @ead.eadheader.filedesc.titlestmt.subtitle
+		assert_equal(@text, st.subelements[0].to_s)
+		assert_equal(@abbr, st.subelements[1].to_s)
+		assert_equal(@text, st.subelements[2].to_s)
+		assert_equal(@abbr, st.subelements[3].to_s)
+	end
+end

data/test/TestPartialExport.rb

@@ -0,0 +1,53 @@
+require "TestEAD"
+
+class TestPartialExport < TestEAD
+  def setup
+    super
+    @test_file = "test_ead_partial_export.xml"
+    @head = "Test head"
+    @type = "combined"
+  end
+
+  def test_partial_export
+    file = File.open(@test_file, "w")
+    
+    did = EAD::EADDescription.new
+    did.head = "abc"
+    did.unitid = "teste"
+    @ead.archdesc.did = did
+    
+    dsc = EAD::EADSubordinates.new
+    dsc.type = @type
+    @ead.archdesc.dsc << dsc
+    
+    c01 = EAD::EADLevel.new
+    c01.did = EAD::EADDescription.new
+    c01.did.head = "abc"
+    c01.did.unitid = "teste"
+    
+    dsc.c << c01
+    c01.partial_export(file)
+    
+    c01 = EAD::EADLevel.new
+    c01.did = EAD::EADDescription.new
+    c01.did.head = "abc"
+    c01.did.unitid = "teste"
+    sc = EAD::EADScopeContent.new
+    sc.p << EAD::EADP.new('value1')
+    sc.p << EAD::EADP.new('value2')
+    c01.scopecontent = sc
+    
+    dsc.c << c01
+    c01.partial_export(file)
+    
+    @ead.end_partial_export(file)
+    
+    file.close
+    
+    validate_dtd
+    compare_xpath("fonds", "/ead/archdesc/@level")
+    compare_xpath(@type, "/ead/archdesc/dsc/@type")
+    element_exists("/ead/archdesc/dsc/c01", "Check that the level was added")
+    element_exists("/ead/archdesc/dsc/c01/did", "Check that the description was added")
+  end
+end

data/test/TestXMLStreamObjectParser.rb

@@ -0,0 +1,126 @@
+$-w = true
+
+require "test/unit"
+require "xmlcodec"
+require "EAD"
+require "TestEAD"
+
+class MyStreamListener
+  attr_reader :ead
+  def el_ead(el)
+    @ead = el.get_object
+  end
+end
+
+class MyConsumingStreamListener
+  attr_reader :ead
+  def el_ead(el)
+    @ead = el.get_object
+  end
+    
+  def el_c02(el)
+    el.consume
+  end
+end
+
+class TestXMLStreamObjectParser < TestEAD
+  def initialize(*args)
+    super(*args)
+    
+    @test_file = "test_ead_stream_object_parser.xml"
+  end
+
+  def test_import
+    @ead.eadheader.id = "1"
+  
+    dsc = EAD::EADSubordinates.new
+    @ead.add_descelem(dsc)
+    
+    c01 = EAD::EADLevel.new
+    c01.did = EAD::EADDescription.new
+    c01.phystech = EAD::EADPhysTech.new
+    dsc.add_level(c01)
+  
+    c02 = EAD::EADLevel.new
+    c01.add_level(c02)
+
+    c03 = EAD::EADLevel.new
+    c02.add_level(c03)
+
+    export
+    listener = MyStreamListener.new
+    parser = XMLCodec::XMLStreamObjectParser.new(listener)
+    parser.parse(File.new(@test_file))
+    @ead = listener.ead
+    
+    assert_equal(@ead, parser.top_element)
+    
+    assert_equal("1", @ead.eadheader.eadid.value)
+    assert_equal("1", @ead.eadheader.id)
+    assert_equal("Teste", @ead.eadheader.eadtitle.value)
+    
+    dsc = @ead.descelems[0]
+    assert(dsc.levels[0], "Check that the level was imported")
+    assert(dsc.levels[0].did, "Check that the description was imported")
+    assert(dsc.levels[0].levels[0], "Check that the second level was imported")
+    assert(dsc.levels[0].levels[0].levels[0], "Check that the third level was imported")
+  end
+  
+  def test_consume
+    @ead.eadheader.id = "1"
+  
+    dsc = EAD::EADSubordinates.new
+    @ead.add_descelem(dsc)
+    
+    c01 = EAD::EADLevel.new
+    c01.did = EAD::EADDescription.new
+    c01.phystech = EAD::EADPhysTech.new
+    dsc.add_level(c01)
+  
+    c02 = EAD::EADLevel.new
+    c01.add_level(c02)
+
+    c03 = EAD::EADLevel.new
+    c02.add_level(c03)
+
+    export
+    
+    listener = MyConsumingStreamListener.new
+    parser = XMLCodec::XMLStreamObjectParser.new(listener)
+    parser.parse(File.new(@test_file))
+    @ead = listener.ead    
+    
+    dsc = @ead.descelems[0]
+    assert(dsc.levels[0], "Check that the level was imported")
+    assert(dsc.levels[0].did, "Check that the description was imported")
+    assert_equal(0, dsc.levels[0].levels.size, "Check that c03 was consumed")
+  end
+  
+  def test_numbering
+    @ead.eadheader.id = "1"
+  
+    dsc = EAD::EADSubordinates.new
+    @ead.add_descelem(dsc)
+    
+    c01 = EAD::EADLevel.new
+    c01.did = EAD::EADDescription.new
+    c01.phystech = EAD::EADPhysTech.new
+    dsc.add_level(c01)
+    
+    export
+    
+    listener = MyStreamListener.new
+    parser = XMLCodec::XMLStreamObjectParser.new(listener)
+    parser.parse(File.new(@test_file))
+    @ead = listener.ead
+    
+    dsc = @ead.descelems[0]
+    c01 = dsc.levels[0]
+    
+    assert(dsc.element_id)
+    assert(dsc.parent_id)
+    assert(c01.element_id)
+    assert(c01.parent_id)
+    assert_equal(c01.parent_id, dsc.element_id)
+  end
+end