eadcodec 0.0.3 → 0.0.4

data/Rakefile

@@ -1,5 +1,5 @@
 PKG_NAME = 'eadcodec'
-PKG_VERSION = '0.0.3'
+PKG_VERSION = '0.0.4'
 
 require 'rake'
 require 'rake/testtask'
@@ -30,7 +30,7 @@ spec = Gem::Specification.new do |s|
   s.author = 'Pedro Côrte-Real'
   s.email = 'pedrocr@gmail.com'
   s.requirements << 'xmlcodec'
-  s.add_dependency('xmlcodec', '>= 0.0.3')
+  s.add_dependency('xmlcodec', '>= 0.0.4')
   s.require_path = 'lib'
   s.autorequire = 'rake'
   s.files = PKG_FILES

data/lib/EAD.rb

@@ -1,6 +1,5 @@
 require "rexml/document"
 require "xmlcodec"
-include REXML
 
 # This module includes all the support for EAD import/export. The main class to
 # use is EADDocument that is a subclass of XMLUtils::XMLElement. All elements
@@ -46,9 +45,6 @@ module EAD
   # Create a bunch of classes for simple elements with just values
   # Most of these actually can have children so they should be promoted to
   # actual classes.
-  sclass "EADOrigination", "origination"
-  sclass "EADUnitTitle", "unittitle"
-  sclass "EADUnitId", "unitid"
   sclass "EADAbstract", "abstract"
   sclass "EADPhysDesc", "physdesc"
   sclass "EADPhysLoc", "physloc"
@@ -68,6 +64,77 @@ module EAD
   sclass "EADRef", "ref"
   sclass "EADLinkGrp", "linkgrp"
   sclass "EADTitle", "title"
+
+  class EADOrigination < EADElement
+    elname "origination"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    
+    xmlsubelements
+    
+    def initialize(string=nil)
+      if string
+        self.subelements << string
+      end
+    end
+    
+    def value
+      self.subelements[0].to_s
+    end
+  end
+
+  class EADUnitTitle < EADElement
+    elname "unittitle"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    xmlattr :type
+    
+    xmlsubelements
+    
+    def initialize(string=nil)
+      if string
+        self.subelements << string
+      end
+    end
+    
+    def value
+      self.subelements[0].to_s
+    end
+  end
+  
+  class EADUnitId < EADElement
+    elname "unitid"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :countrycode
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :identifier
+    xmlattr :label
+    xmlattr :repositorycode
+    xmlattr :type
+    
+    xmlsubelements
+    
+    def initialize(string=nil)
+      if string
+        self.subelements << string
+      end
+    end
+    
+    def value
+      self.subelements[0].to_s
+    end
+  end
   
   # The class for the 'head' element. For convenience it can be initialized
   # with a string value that is used as the first subelement.
@@ -130,6 +197,28 @@ require "EADHeader"
 require "EADBiogHist"
 require "EADDocument"
 require "EADLang"
+require 'EADExtent'
+require 'EADGeogName'
+require 'EADRepository'
+require 'EADAcqInfo'
+require 'EADChronList'
+require 'EADEvent'
+require 'EADControlAccess'
+require 'EADList'
+require 'EADLabel'
+require 'EADCustodHist'
+require 'EADFilePlan'
+require 'EADProcessInfo'
+require 'EADName'
+require 'EADDimensions'
+require 'EADArrangement'
+require 'EADContainer'
+require 'EADAltFormAvail'
+require 'EADPhysFacet'
+require 'EADMaterialSpec'
+require 'EADAppraisal'
+require 'EADOtherFindAid'
+
 
 module EAD
   def self.c_levels

data/lib/EADAcqInfo.rb

@@ -0,0 +1,13 @@
+module EAD
+  class EADAcqInfo < EADElement
+    elname "acqinfo"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    
+    xmlsubelements
+  end
+end

data/lib/EADAltFormAvail.rb

@@ -0,0 +1,13 @@
+module EAD
+  class EADAltFormAvail < EADElement
+    elname "altformavail"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :type
+    
+    xmlsubelements
+  end
+end

data/lib/EADAppraisal.rb

@@ -0,0 +1,12 @@
+module EAD
+  class EADAppraisal < EADElement
+    elname "appraisal"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADArrangement.rb

@@ -0,0 +1,12 @@
+module EAD
+  class EADArrangement < EADElement
+    elname "arrangement"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+
+    xmlsubelements
+  end
+end

data/lib/EADChronList.rb

@@ -0,0 +1,27 @@
+module EAD
+  class EADChronList < EADElement
+    elname "chronlist"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    
+    xmlsubelements
+  end
+  
+  class EADChronItem < EADElement
+    elname "chronitem"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    
+    xmlsubel :date
+    xmlsubel :event
+    xmlsubel :eventgrp
+  end
+end
+
+

data/lib/EADContainer.rb

@@ -0,0 +1,15 @@
+module EAD
+  class EADContainer < EADElement
+    elname "container"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    xmlattr :parent
+    xmlattr :type
+    
+    xmlsubelements
+  end
+end

data/lib/EADControlAccess.rb

@@ -0,0 +1,12 @@
+module EAD
+  class EADControlAccess < EADElement
+    elname :controlaccess
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADCustodHist.rb

@@ -0,0 +1,12 @@
+module EAD
+  class EADCustodHist < EADElement
+    elname "custodhist"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADDimensions.rb

@@ -0,0 +1,15 @@
+module EAD
+  class EADDimensions < EADElement
+    elname "dimensions"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    xmlattr :type
+    xmlattr :unit
+    
+    xmlsubelements
+  end
+end

data/lib/EADDocument.rb

@@ -5,7 +5,15 @@ module EAD
   class EADArchDesc < EADElement
     elname "archdesc"
   
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
     xmlattr :level
+    xmlattr :otherlevel
+    xmlattr :relatedencoding
+    xmlattr :type
+    
     xmlsubel :did
     xmlsubel :bioghist
     xmlsubel :scopecontent
@@ -76,9 +84,9 @@ module EAD
     end
 
     def export(filename)
-      doc = Document.new
-      doc << XMLDecl.new("1.0", "UTF-8")
-      doc << DocType.new("ead SYSTEM", '"file:///home/pedrocr/ead.dtd"')
+      doc = REXML::Document.new
+      doc << REXML::XMLDecl.new("1.0", "UTF-8")
+      doc << REXML::DocType.new("ead SYSTEM", '"file:///home/pedrocr/ead.dtd"')
       create_xml(doc)
       output = File.open(filename, "w")
 

data/lib/EADEvent.rb

@@ -0,0 +1,11 @@
+module EAD
+  class EADEvent < EADElement
+    elname "event"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADExtent.rb

@@ -0,0 +1,15 @@
+module EAD
+  class EADExtent < EADElement
+    elname "extent"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    xmlattr :type
+    xmlattr :unit
+    
+    xmlsubelements
+  end
+end

data/lib/EADFilePlan.rb

@@ -0,0 +1,12 @@
+module EAD
+  class EADFilePlan< EADElement
+    elname "fileplan"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADGeogName.rb

@@ -0,0 +1,15 @@
+module EAD
+  class EADGeogName < EADElement
+    elname 'geogname'
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :authfilenumber
+    xmlattr :encondinganalog
+    xmlattr :id
+    xmlattr :normal
+    xmlattr :role
+    xmlattr :rules
+    xmlattr :source
+  end
+end

data/lib/EADLabel.rb

@@ -0,0 +1,11 @@
+module EAD
+  class EADLabel < EADElement
+    elname "label"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADLevel.rb

@@ -16,6 +16,7 @@ module EAD
 		xmlsubel :note
 		xmlsubel :relatedmaterial
 		xmlsubel_mult :c
+		xmlsubel_mult :dsc
 		
 		attr_reader :parent
 		

data/lib/EADList.rb

@@ -0,0 +1,36 @@
+module EAD
+  class EADList < EADElement
+    elname "list"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :continuation
+    xmlattr :id
+    xmlattr :mark
+    xmlattr :numeration
+    xmlattr :type
+    
+    xmlsubelements
+  end
+  
+  class EADDefItem < EADElement 
+    elname "defitem"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :id
+    
+    xmlsubel :label
+    xmlsubel :item
+  end
+  
+  class EADItem < EADElement 
+    elname "item"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADMaterialSpec.rb

@@ -0,0 +1,14 @@
+module EAD
+  class EADMaterialSpec < EADElement
+    elname "materialspec"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    xmlattr :type
+    
+    xmlsubelements
+  end
+end

data/lib/EADName.rb

@@ -0,0 +1,17 @@
+module EAD
+  class EADName < EADElement
+    elname "name"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :authfilenumber
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :normal
+    xmlattr :role
+    xmlattr :rules
+    xmlattr :source
+    
+    xmlsubelements
+  end
+end

data/lib/EADOtherFindAid.rb

@@ -0,0 +1,12 @@
+module EAD
+  class EADOtherFindAid < EADElement
+    elname "otherfindaid"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    
+    xmlsubelements
+  end
+end

data/lib/EADPhysFacet.rb

@@ -0,0 +1,17 @@
+module EAD
+  class EADPhysFacet < EADElement
+    elname "physfacet"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    xmlattr :rules
+    xmlattr :source
+    xmlattr :type
+    xmlattr :unit
+    
+    xmlsubelements
+  end
+end

data/lib/EADProcessInfo.rb

@@ -0,0 +1,13 @@
+module EAD
+  class EADProcessInfo < EADElement
+    elname "processinfo"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :type
+    
+    xmlsubelements
+  end
+end

data/lib/EADRepository.rb

@@ -0,0 +1,13 @@
+module EAD
+  class EADRepository < EADElement
+    elname "repository"
+    
+    xmlattr :altrender
+    xmlattr :audience
+    xmlattr :encodinganalog
+    xmlattr :id
+    xmlattr :label
+    
+    xmlsubelements
+  end
+end

data/lib/EADSubordinates.rb

@@ -1,29 +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
+  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 description_level
+      0
+    end
 
-		def unnumbered?
-			false
-		end
-	end
+    def unnumbered?
+      false
+    end
+  end
 end

data/test/TestPartialExport.rb

@@ -24,21 +24,27 @@ class TestPartialExport < TestEAD
     c01.did = EAD::EADDescription.new
     c01.did.head = "abc"
     c01.did.unitid = "teste"
+    c01.did.unittitle = "teste"
     
     dsc.c << c01
-    c01.partial_export(file)
+    c01.start_partial_export(file)
     
-    c01 = EAD::EADLevel.new
-    c01.did = EAD::EADDescription.new
-    c01.did.head = "abc"
-    c01.did.unitid = "teste"
+    dsc = EAD::EADSubordinates.new
+    dsc.type = @type
+    c01.dsc << dsc
+    
+    c02 = EAD::EADLevel.new
+    c02.did = EAD::EADDescription.new
+    c02.did.head = "abc"
+    c02.did.unitid = "teste"
+    c02.did.unittitle = "teste"
     sc = EAD::EADScopeContent.new
     sc.p << EAD::EADP.new('value1')
     sc.p << EAD::EADP.new('value2')
-    c01.scopecontent = sc
+    c02.scopecontent = sc
     
-    dsc.c << c01
-    c01.partial_export(file)
+    dsc.c << c02
+    c02.start_partial_export(file)
     
     @ead.end_partial_export(file)
     
@@ -47,7 +53,9 @@ class TestPartialExport < TestEAD
     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")
+    element_exists("/ead/archdesc/dsc/c01", "the first level was not added")
+    element_exists("/ead/archdesc/dsc/c01/did", "the first level description was not added")
+    element_exists("/ead/archdesc/dsc/c01/dsc/c01", "the second level was not added")
+    element_exists("/ead/archdesc/dsc/c01/dsc/c01/did", "the second level description was not added")
   end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: eadcodec
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2006-05-29 00:00:00 +01:00
+  version: 0.0.4
+date: 2006-07-06 00:00:00 +01:00
 summary: Importer/Exporter for the EAD XML format
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - "Pedro C\xC3\xB4rte-Real"
 files: 
@@ -36,7 +37,6 @@ files:
 - lib/EADPhysTech.rb
 - lib/EADBiogHist.rb
 - lib/EADHeader.rb
-- lib/EADStreamParser.rb
 - lib/EADSubtitle.rb
 - lib/EADDate.rb
 - lib/EADDocument.rb
@@ -45,6 +45,27 @@ files:
 - lib/eadcodec.rb
 - lib/EADSubordinates.rb
 - lib/EADLang.rb
+- lib/EADExtent.rb
+- lib/EADGeogName.rb
+- lib/EADRepository.rb
+- lib/EADAcqInfo.rb
+- lib/EADChronList.rb
+- lib/EADEvent.rb
+- lib/EADControlAccess.rb
+- lib/EADList.rb
+- lib/EADLabel.rb
+- lib/EADCustodHist.rb
+- lib/EADFilePlan.rb
+- lib/EADProcessInfo.rb
+- lib/EADName.rb
+- lib/EADDimensions.rb
+- lib/EADArrangement.rb
+- lib/EADContainer.rb
+- lib/EADAltFormAvail.rb
+- lib/EADPhysFacet.rb
+- lib/EADMaterialSpec.rb
+- lib/EADAppraisal.rb
+- lib/EADOtherFindAid.rb
 - test/TestXMLStreamObjectParser.rb
 - test/TestEADDescription.rb
 - test/TestEADScopeContent.rb
@@ -52,7 +73,6 @@ files:
 - test/TestEADNote.rb
 - test/TestEADPhysTech.rb
 - test/TestEADLevel.rb
-- test/TestEADStreamParser.rb
 - test/TestEADSubtitle.rb
 - test/TestEADDocument.rb
 - test/TestEAD.rb
@@ -87,5 +107,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.3
+        version: 0.0.4
     version: 

data/lib/EADStreamParser.rb

@@ -1,40 +0,0 @@
-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/test/TestEADStreamParser.rb

@@ -1,109 +0,0 @@
-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