eadcodec 0.0.1

data/lib/EADBiogHist.rb

@@ -0,0 +1,10 @@
+require "EAD"
+
+module EAD
+	class EADBiogHist < EADElement
+		elname "bioghist"
+	
+		xmlsubel :head
+		xmlsubel_mult :p
+	end
+end

data/lib/EADDate.rb

@@ -0,0 +1,24 @@
+module EAD
+	class EADDate < EADElement
+		elname "date"
+		elwithvalue
+
+		xmlattr :altrender
+		xmlattr :audience
+		xmlattr :calendar
+		xmlattr :certainty
+		xmlattr :encodinganalog
+		xmlattr :era
+		xmlattr :id
+		xmlattr :normal
+		xmlattr :type
+	end
+
+	class EADUnitDate < EADDate	
+		elname "unitdate"
+		elwithvalue
+		
+		xmlattr :datechar
+		xmlattr :label
+	end
+end

data/lib/EADDescription.rb

@@ -0,0 +1,21 @@
+require "EADDate"
+
+module EAD
+	class EADDescription < EADElement	
+		elname "did"
+	
+		xmlattr :altrender
+		xmlattr :audience
+		xmlattr :encodinganalog
+		xmlattr :id
+	
+		xmlsubel :head
+		xmlsubel :origination
+		xmlsubel :unittitle
+		xmlsubel :unitid
+		xmlsubel :abstract
+		xmlsubel :physdesc
+		xmlsubel :physloc
+		xmlsubel :unitdate
+	end
+end

data/lib/EADDocument.rb

@@ -0,0 +1,98 @@
+require "EAD"
+require "XMLUtils"
+
+module EAD
+  class EADArchDesc < EADElement
+    elname "archdesc"
+  
+    xmlattr :level
+    xmlsubel :did
+    xmlsubel :bioghist
+    xmlsubel :scopecontent
+    xmlsubel :phystech
+    xmlsubel_mult :dsc
+
+    def initialize
+      @level = "fonds"
+    end
+    
+    def add_descelem(elem)
+      dsc << elem
+    end
+
+    def descelems
+      dsc.dup
+    end
+    
+    def current_content
+      text = create_open_tag+"\n"
+      each_subel do |name|
+        if not subel_mult?(name)
+          value = send(name)
+          if value
+            doc = REXML::Document.new
+            xml = value.create_xml(doc)
+            doc.write(text,2)
+          end
+        end
+      end
+      text
+    end
+  end
+
+  class EADDocument < EADElement
+    elname "ead"
+  
+    COUNTRY_CODE = "pt"
+    AGENCY_CODE = "iantt"
+
+    xmlsubel :eadheader
+    xmlsubel :archdesc
+
+    def self.from_file(file)
+      doc = REXML::Document.new(File.new(file))
+      self.import_xml(doc.elements[1])
+    end
+
+    def initialize(id, title)
+      self.eadheader = EADHeader.new(id, title)
+      self.archdesc = EADArchDesc.new
+    end
+
+    def add_description(description)
+      @archdesc.did = description
+    end
+
+    def ead_did
+      @archdesc.did
+    end
+
+    def add_descelem(elem)
+      @archdesc.add_descelem(elem)
+    end
+
+    def descelems
+      @archdesc.descelems
+    end
+
+    def export(filename)
+      doc = Document.new
+      doc << XMLDecl.new("1.0", "UTF-8")
+      doc << DocType.new("ead SYSTEM", '"file:///home/pedrocr/ead.dtd"')
+      create_xml(doc)
+      output = File.open(filename, "w")
+
+      doc.write(output, 0)
+      output.write "\n"
+      output.close
+    end
+    
+    def start_partial_export(file)
+      if not already_partial_exported?
+        file << "<?xml version='1.0' encoding='UTF-8'?>\n"
+        file << "<!DOCTYPE ead SYSTEM \"file:///home/pedrocr/ead.dtd\">\n"
+        super
+      end
+    end
+  end
+end

data/lib/EADHeader.rb

@@ -0,0 +1,70 @@
+module EAD
+	class EADId < EADElement
+		elname 'eadid'
+		elwithvalue
+	
+		xmlattr :countrycode
+		xmlattr :encodinganalog
+		xmlattr :identifier
+		xmlattr :mainagencycode
+		xmlattr :publicid
+		xmlattr :url
+		xmlattr :urn
+	end
+
+	class EADTitleStatement < EADElement
+		elname 'titlestmt'
+	
+		xmlsubel :author
+		xmlsubel :sponsor
+		xmlsubel :subtitle
+		xmlsubel :titleproper
+
+		def initialize(title)
+			self.titleproper = title
+		end
+	end
+
+	class EADFileDesc < EADElement
+		elname 'filedesc'
+	
+		xmlattr :altrender
+		xmlattr :audience
+		xmlattr :encodinganalog
+		xmlattr :id
+		xmlsubel :titlestmt
+
+		def initialize(title)
+			self.titlestmt = EADTitleStatement.new(title)
+		end
+	end
+
+	class EADHeader < EADElement
+		elname 'eadheader'
+
+		xmlattr :altrender
+		xmlattr :audience
+		xmlattr :countryenconding
+		xmlattr :dateencoding
+		xmlattr :encodinganalog
+		xmlattr :findaidstatus
+		xmlattr :id
+		xmlattr :langenconding
+		xmlattr :relatedencoding
+		xmlattr :repositoryencoding
+		xmlattr :scriptencoding
+
+		xmlsubel :eadid
+		xmlsubel :filedesc
+		xmlsubel :profiledesc
+		
+		def initialize(id, title)
+			self.eadid = EADId.new(id)
+			self.filedesc = EADFileDesc.new(title)
+		end
+
+		def eadtitle
+			self.filedesc.titlestmt.titleproper
+		end
+	end
+end

data/lib/EADLevel.rb

@@ -0,0 +1,72 @@
+module EAD
+	class EADLevel < EADElement
+		include EADLevels
+		
+		xmlattr :altrender
+		xmlattr :audience
+		xmlattr :encodinganalog
+		xmlattr :id
+		xmlattr :level
+		xmlattr :otherlevel
+		xmlattr :tpattern
+
+		xmlsubel :did
+		xmlsubel :phystech
+		xmlsubel :scopecontent
+		xmlsubel :note
+		xmlsubel :relatedmaterial
+		xmlsubel_mult :c
+		
+		attr_reader :parent
+		
+		elnames(*["c","c01","c02","c03","c04","c05","c06",
+		          "c07","c08","c09","c10","c11","c12"])
+
+		def initialize
+			@unnumbered = false
+		end
+
+		def set_unnumbered
+			@unnumbered = true
+		end
+		
+		def set_numbered
+			@unnumbered = false
+		end
+		
+		def unnumbered?
+		  if not instance_variables.index('@unnumbered')
+		    @unnumbered = false
+		  end
+		  @unnumbered
+		end
+
+		def __parent=(parent)
+			super
+			if parent.unnumbered?
+				self.set_unnumbered
+			end
+		end
+
+    def description_level
+      if __parent
+        return __parent.description_level + 1
+      else
+        return 0
+      end  
+    end
+  
+    alias_method :oldelname, :elname # Just to shut up the warning
+		def elname
+			if unnumbered?
+				return "c"
+			end
+			
+			if description_level < 10
+				return "c0" + description_level.to_s
+			else
+				return "c" + description_level.to_s
+			end
+		end
+	end
+end

data/lib/EADNote.rb

@@ -0,0 +1,24 @@
+module EAD
+  class EADNote < EADElement
+    elname "note"
+  
+    xmlattr :actuate
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    xmlattr :show
+    xmlattr :type
+  
+    xmlsubel_mult :p
+    
+    def value
+      str = ""
+      p.each do |par|
+        str += "<p>"+par.value+"</p>\n"
+      end
+      str
+    end
+  end
+end

data/lib/EADPhysTech.rb

@@ -0,0 +1,16 @@
+module EAD
+	class EADPhysTech < EADElement
+		elname "phystech"
+	
+		xmlsubel :head
+		xmlsubel_mult :p
+		
+		def value
+			str = ""
+			p.each do |par|
+				str += "<p>"+par.value+"</p>\n"
+			end
+			str
+		end
+	end
+end

data/lib/EADProfileDesc.rb

@@ -0,0 +1,17 @@
+module EAD
+	class EADCreation < EADElement
+		elname "creation"
+		xmlsubelements
+	end
+
+	class EADProfileDesc < EADElement
+		elname "profiledesc"
+		
+		xmlattr :altrender
+		xmlattr :audience
+		xmlattr :encodinganalog
+		xmlattr :id
+		
+		xmlsubel :creation
+	end
+end

data/lib/EADRelatedMaterial.rb

@@ -0,0 +1,21 @@
+module EAD
+  class EADRelatedMaterial < EADElement
+    elname "relatedmaterial"
+  
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+  
+    xmlsubel :head
+    xmlsubel_mult :p
+    
+    def value
+      str = ""
+      p.each do |par|
+        str += "<p>"+par.value+"</p>\n"
+      end
+      str
+    end
+  end
+end

data/lib/EADScopeContent.rb

@@ -0,0 +1,21 @@
+module EAD
+  class EADScopeContent < EADElement
+    elname "scopecontent"
+  
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+  
+    xmlsubel :head
+    xmlsubel_mult :p
+    
+    def value
+      str = ""
+      p.each do |par|
+        str += "<p>"+par.value+"</p>\n"
+      end
+      str
+    end
+  end
+end

data/lib/EADStreamParser.rb

@@ -0,0 +1,40 @@
+require "XMLStreamParser"
+require "rexml/document"
+require "EAD"
+
+module EAD
+  # This is a stream parser that will output EAD element objects. To use it
+  # all you have to do is create a listener that responds to methods called 
+  # el_<eadelementname> with one argument. The argument passed will be the
+  # object with the content of the EAD element.
+  #
+  # The actual stream parsing is done with XMLUtils::XMLStreamParser.
+  class EADStreamParser
+  	def initialize(listener=nil)
+  		@listener = listener
+  	end
+
+    # Parse the text of the EAD file. This can be any IO capable object, like a
+    # string or an open file.
+  	def parse(text)
+  		parser = XMLUtils::XMLStreamParser.new(self)
+  		parser.parse(text)
+  	end
+  	
+  	# This is the element method that is called by XMLStreamParser everytime
+  	# a XML element is finished.
+  	def element(el) #:nodoc:
+  		method_sym = ("el_"+el.name).to_sym
+  		if @listener.respond_to?(method_sym)
+  			cl = XMLCodec::XMLElement.get_element_class(el.name.to_sym)
+  			eadelement = cl.import_xml_text(el.content)
+  			eadelement.element_id = el.element_id
+  			eadelement.parent_id = el.parent_id
+  			eadelement.__xml_text = el.content
+  			
+  			@listener.send(method_sym, eadelement)
+  			el.consume
+  		end
+  	end
+  end
+end

data/lib/EADSubordinates.rb

@@ -0,0 +1,29 @@
+require "EAD.rb"
+
+module EAD
+	class EADSubordinates < EADElement
+		elname "dsc"
+	
+		include EADLevels
+		
+		xmlattr :altrender
+		xmlattr :audience
+		xmlattr :encondinganalog
+		xmlattr :id
+		xmlattr :othertype
+		xmlattr :tpattern
+		xmlattr :type
+		
+		xmlsubel :head
+		xmlsubel_mult :p
+		xmlsubel_mult :c
+
+		def description_level
+			0
+		end
+
+		def unnumbered?
+			false
+		end
+	end
+end

data/lib/EADSubtitle.rb

@@ -0,0 +1,8 @@
+require "EAD"
+
+module EAD 
+	class EADSubtitle < EADElement
+		elname "subtitle"
+		xmlsubelements
+	end
+end

data/lib/eadcodec.rb

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

data/test/TestEAD.rb

@@ -0,0 +1,50 @@
+$:.unshift File.join(File.dirname(__FILE__), "..")
+$-w = true
+
+require 'EAD'
+require 'test/unit'
+require 'XMLUtils'
+
+class TestEAD < Test::Unit::TestCase
+	def initialize(*args)
+		super(*args)
+		@test_file = nil
+	end
+
+	def setup
+		@ead = EAD::EADDocument.new("1", "Teste")
+	end
+
+	def export 
+		@ead.export(@test_file) 
+	end
+	
+	def import
+		@ead = EAD::EADDocument.from_file(@test_file)
+	end
+
+	def validate_well_formed
+		assert(system("rxp", "-xs", @test_file))
+	end
+
+	def validate_dtd
+		assert(system("rxp", "-VVs", @test_file))
+		#assert(system("xmlstarlet", "val", "-d", "ead.dtd", @test_file))
+	end
+
+	def test_fake
+		#Just a fake test to fool Unit::TestCase
+	end
+
+	def compare_xpath(value, path)
+		assert_equal(value, select(path))
+	end
+
+	def element_exists(xpath, *args)
+		assert(XMLUtils::element_exists(xpath, @test_file), *args)
+	end
+
+	def select(xpath)
+		XMLUtils::select_path(xpath, @test_file)
+	end
+end

data/test/TestEADDescription.rb

@@ -0,0 +1,73 @@
+require "TestEAD"
+
+class TestEADDescription < TestEAD
+	def initialize(*args)
+		super(*args)
+
+		@test_file = "test_ead_description.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_description
+		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
+
+		# Since we've added content it is now valid EAD
+		validate_dtd
+
+		element_exists("/ead/archdesc/did", "Test did exists")
+		compare_xpath(@head, "/ead/archdesc/did/head")
+		compare_xpath(@origination, "/ead/archdesc/did/origination")
+		compare_xpath(@unittitle, "/ead/archdesc/did/unittitle")	
+		compare_xpath(@abstract, "/ead/archdesc/did/abstract")
+		compare_xpath(@physdesc, "/ead/archdesc/did/physdesc")
+		compare_xpath(@physloc, "/ead/archdesc/did/physloc")
+		compare_xpath(@unitid, "/ead/archdesc/did/unitid")
+
+		compare_xpath(@unitdate, "/ead/archdesc/did/unitdate")
+		compare_xpath(@unitdatelabel, "/ead/archdesc/did/unitdate/@label")
+		compare_xpath(@unitdatetype, "/ead/archdesc/did/unitdate/@type")
+	end
+
+
+	def test_import_description
+		import
+		did = @ead.ead_did
+
+		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
+end

data/test/TestEADDocument.rb

@@ -0,0 +1,32 @@
+require "TestEAD"
+
+class TestEADDocument < TestEAD
+	def setup
+		super
+		@test_file = "test_ead_document.xml"
+	end
+
+	def test_base_export
+		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")
+	end
+
+	def test_base_import
+		import
+		assert_equal("1", @ead.eadheader.eadid.value)
+		assert_equal("Teste", @ead.eadheader.eadtitle.value)
+	end
+
+	#def test_import_export_2
+	#	@test_file = "examples/example2.xml"
+	#	import
+	#	@test_file = "examples/example2_exported.xml"
+	#	export
+	#end
+end