eadcodec 0.0.4 → 0.1.0

data/test/scopecontent_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestEADScopeContent < Test::Unit::TestCase
+	def initialize(*args)
+		super(*args)
+		
+		@test_file = "test_ead_scopecontent.xml"
+		@head = "Test Head"
+		@p = "Test p"
+	end
+
+	def test_attrs
+		dsc = EADCodec::Subordinates.new
+		@ead.archdesc << dsc
+		
+		c01 = EADCodec::Level.new
+		dsc << c01
+		
+		sc = EADCodec::ScopeContent.new
+		sc << EADCodec::Head.new(@head)
+		sc << EADCodec::P.new(@p)
+		sc << EADCodec::P.new(@p)
+		c01 << sc
+		
+		export
+		element_exists("/ead/archdesc/dsc/c/scopecontent", "Check that the scopecontent was added")
+		compare_xpath(@head, "/ead/archdesc/dsc/c/scopecontent/head")
+		compare_xpath(@p, "/ead/archdesc/dsc/c/scopecontent/p")
+	end
+
+
+	def test_import
+		import
+		assert_equal(1, @ead.archdesc[:dsc].find_all_named(:c).size)
+		sc = @ead.archdesc[:dsc][:c][:scopecontent]
+		assert_equal(@head, sc[:head].value)
+		ps = sc.find_all_named(:p)
+		assert_equal(@p, ps[0].value)
+		assert_equal(@p, ps[1].value)
+	end
+end

data/test/{TestEADSubordinates.rb → subordinates_test.rb}

@@ -1,7 +1,6 @@
-require "TestEAD"
-require "EADSubordinates"
+require File.dirname(__FILE__) + '/test_helper'
 
-class TestEADSubordinates < TestEAD
+class TestEADSubordinates < Test::Unit::TestCase
 
 	def initialize(*args)
 		super(*args)
@@ -13,11 +12,11 @@ class TestEADSubordinates < TestEAD
 	end
 
 	def test_attrs
-		dsc = EAD::EADSubordinates.new
+		dsc = EADCodec::Subordinates.new
 		dsc.type = @type
-		dsc.head = @head
+		dsc << EADCodec::Head.new(@head)
 		
-		@ead.add_descelem(dsc)
+		@ead.archdesc << dsc
 		export
 		compare_xpath(@type, "/ead/archdesc/dsc/@type")
 		compare_xpath(@head, "/ead/archdesc/dsc/head")
@@ -25,9 +24,9 @@ class TestEADSubordinates < TestEAD
 
 	def test_import
 		import
-		dsc = @ead.descelems[0]
+		dsc = @ead.archdesc[:dsc]
 
 		assert_equal(@type, dsc.type)
-		assert_equal(@head, dsc.head.value)
+		assert_equal(@head, dsc[:head].value)
 	end
 end

data/test/{TestEADSubtitle.rb → subtitle_test.rb}

@@ -1,7 +1,6 @@
-require "TestEAD"
-require "EADSubtitle"
+require File.dirname(__FILE__) + '/test_helper'
 
-class TestEADSubtitle < TestEAD
+class TestEADSubtitle < Test::Unit::TestCase
 	def setup
 		super
 		@test_file = "test_ead_subtitle.xml"
@@ -12,11 +11,11 @@ class TestEADSubtitle < TestEAD
 	def test_base_export
 		titlestmt = @ead.eadheader.filedesc.titlestmt
 	
-		st = titlestmt.subtitle = EAD::EADSubtitle.new
+		st = titlestmt.subtitle = EADCodec::Subtitle.new
 		st.subelements << @text
-		st.subelements << EAD::EADAbbr.new(@abbr)
+		st.subelements << EADCodec::Abbr.new(@abbr)
 		st.subelements << @text
-		st.subelements << EAD::EADAbbr.new(@abbr)
+		st.subelements << EADCodec::Abbr.new(@abbr)
 		
 		export
 		# The base document has an empty archdesc and is thus not valid EAD

data/test/test_helper.rb

@@ -0,0 +1,45 @@
+$-w = true
+require File.dirname(__FILE__) + '/../lib/eadcodec'
+require 'test/unit'
+require 'tmpdir'
+
+class Test::Unit::TestCase
+  alias_method :old_setup, :setup
+  def setup
+    @ead = EADCodec::Document.new("1", "Teste")
+  end
+
+  def filepath(name=nil)
+    name = @test_file if not name
+    File.join(Dir::tmpdir, name)
+  end
+
+  def export(name=nil)
+    @ead.export filepath(name) 
+  end
+  
+  def import
+    @ead = EADCodec::Document.from_file filepath
+  end
+
+  def validate_well_formed
+    assert(system("rxp", "-xs", filepath))
+  end
+
+  def validate_dtd
+    assert(system("rxp", "-VVs", filepath))
+    #assert(system("xmlstarlet", "val", "-d", "ead.dtd", @test_file))
+  end
+
+  def compare_xpath(value, path)
+    assert_equal(value, select(path))
+  end
+
+  def element_exists(xpath, *args)
+    assert(XMLUtils::element_exists(xpath, filepath), *args)
+  end
+
+  def select(xpath)
+    XMLUtils::select_path(xpath, filepath)
+  end
+end

data/test/xmlsoparser_test.rb

@@ -0,0 +1,119 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+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_c(el)
+    el.consume
+  end
+end
+
+class TestXMLStreamObjectParser < Test::Unit::TestCase
+  def initialize(*args)
+    super(*args)
+    
+    @test_file = "test_ead_stream_object_parser.xml"
+  end
+
+  def test_import
+    @ead.eadheader.id = "1"
+  
+    dsc = EADCodec::Subordinates.new
+    @ead.archdesc << dsc
+    
+    c01 = EADCodec::Level.new
+    c01 << EADCodec::Description.new
+    c01 << EADCodec::PhysTech.new
+    dsc << c01
+  
+    c02 = EADCodec::Level.new
+    c01 << c02
+
+    c03 = EADCodec::Level.new
+    c02 << c03
+
+    export
+    listener = MyStreamListener.new
+    parser = XMLCodec::XMLStreamObjectParser.new(EADCodec::EADElement, listener)
+    parser.parse(File.new(filepath))
+    @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.archdesc[:dsc]
+    assert(dsc[:c], "Check that the level was imported")
+    assert(dsc[:c][:did], "Check that the description was imported")
+    assert(dsc[:c][:c], "Check that the second level was imported")
+    assert(dsc[:c][:c][:c], "Check that the third level was imported")
+  end
+  
+  def test_consume
+    @ead.eadheader.id = "1"
+  
+    dsc = EADCodec::Subordinates.new
+    @ead.archdesc << dsc
+    
+    c01 = EADCodec::Level.new
+    c01 << EADCodec::Description.new
+    c01 << EADCodec::PhysTech.new
+    dsc << c01
+  
+    c02 = EADCodec::Level.new
+    c01 << c02
+
+    c03 = EADCodec::Level.new
+    c02 << c03
+
+    export
+    
+    listener = MyConsumingStreamListener.new
+    parser = XMLCodec::XMLStreamObjectParser.new(EADCodec::EADElement, listener)
+    parser.parse(File.new(filepath))
+    @ead = listener.ead    
+    
+    dsc = @ead.archdesc[:dsc]
+    assert_nil(dsc[:c], "Check that the levels were consumed")
+  end
+  
+  def test_numbering
+    @ead.eadheader.id = "1"
+  
+    dsc = EADCodec::Subordinates.new
+    @ead.archdesc << dsc
+    
+    c01 = EADCodec::Level.new
+    c01 << EADCodec::Description.new
+    c01 << EADCodec::PhysTech.new
+    dsc << c01
+    
+    export
+    
+    listener = MyStreamListener.new
+    parser = XMLCodec::XMLStreamObjectParser.new(EADCodec::EADElement, listener)
+    parser.parse(File.new(filepath))
+    @ead = listener.ead
+    
+    dsc = @ead.archdesc[:dsc]
+    c01 = dsc[:c]
+    
+    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

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: eadcodec
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
-date: 2006-07-06 00:00:00 +01:00
+  version: 0.1.0
+date: 2006-07-27 00:00:00 +01:00
 summary: Importer/Exporter for the EAD XML format
 require_paths: 
 - lib
@@ -29,54 +29,76 @@ post_install_message:
 authors: 
 - "Pedro C\xC3\xB4rte-Real"
 files: 
-- lib/EADRelatedMaterial.rb
-- lib/EADDescription.rb
-- lib/EADScopeContent.rb
-- lib/EADNote.rb
-- lib/EADLevel.rb
-- lib/EADPhysTech.rb
-- lib/EADBiogHist.rb
-- lib/EADHeader.rb
-- lib/EADSubtitle.rb
-- lib/EADDate.rb
-- lib/EADDocument.rb
-- lib/EAD.rb
-- lib/EADProfileDesc.rb
 - 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
-- test/TestPartialExport.rb
-- test/TestEADNote.rb
-- test/TestEADPhysTech.rb
-- test/TestEADLevel.rb
-- test/TestEADSubtitle.rb
-- test/TestEADDocument.rb
-- test/TestEAD.rb
-- test/TestEADSubordinates.rb
+- lib/elements/p.rb
+- lib/elements/head.rb
+- lib/elements/accessrestrict.rb
+- lib/elements/accruals.rb
+- lib/elements/acqinfo.rb
+- lib/elements/altformavail.rb
+- lib/elements/appraisal.rb
+- lib/elements/arrangement.rb
+- lib/elements/bibliography.rb
+- lib/elements/bioghist.rb
+- lib/elements/chronlist.rb
+- lib/elements/container.rb
+- lib/elements/controlaccess.rb
+- lib/elements/custodhist.rb
+- lib/elements/date.rb
+- lib/elements/description.rb
+- lib/elements/dimensions.rb
+- lib/elements/defitem.rb
+- lib/elements/event.rb
+- lib/elements/extent.rb
+- lib/elements/fileplan.rb
+- lib/elements/geogname.rb
+- lib/elements/language.rb
+- lib/elements/label.rb
+- lib/elements/langmaterial.rb
+- lib/elements/list.rb
+- lib/elements/dsc.rb
+- lib/elements/item.rb
+- lib/elements/materialspec.rb
+- lib/elements/name.rb
+- lib/elements/note.rb
+- lib/elements/odd.rb
+- lib/elements/originalsloc.rb
+- lib/elements/otherfindaid.rb
+- lib/elements/physdesc.rb
+- lib/elements/physfacet.rb
+- lib/elements/physloc.rb
+- lib/elements/phystech.rb
+- lib/elements/processinfo.rb
+- lib/elements/profiledesc.rb
+- lib/elements/relatedmaterial.rb
+- lib/elements/repository.rb
+- lib/elements/scopecontent.rb
+- lib/elements/subtitle.rb
+- lib/elements/userestrict.rb
+- lib/elements/origination.rb
+- lib/elements/unitid.rb
+- lib/elements/unittitle.rb
+- lib/elements/chronitem.rb
+- lib/elements/unitdate.rb
+- lib/elements/archdesc.rb
+- lib/elements/ead.rb
+- lib/elements/id.rb
+- lib/elements/titlestmt.rb
+- lib/elements/filedesc.rb
+- lib/elements/eadheader.rb
+- lib/elements/creation.rb
+- lib/elements/c.rb
+- test/xmlsoparser_test.rb
+- test/subtitle_test.rb
+- test/subordinates_test.rb
+- test/test_helper.rb
+- test/phystech_test.rb
+- test/document_test.rb
+- test/note_test.rb
+- test/level_test.rb
+- test/description_test.rb
+- test/partial_export_test.rb
+- test/scopecontent_test.rb
 - test/examples/example1.xml
 - test/examples/example2.xml
 - README
@@ -107,5 +129,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.4
+        version: 0.1.0
     version: 

data/lib/EAD.rb

@@ -1,229 +0,0 @@
-require "rexml/document"
-require "xmlcodec"
-
-# 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
-# supported are based on the EAD DTD and have the same names. Currently not all
-# attributes and elements have been added. Adding an element is pretty easy 
-# though.
-module EAD
-  class EADElement < XMLCodec::XMLElement #:nodoc:
-  end
-  
-  class EADSimpleElement < EADElement
-    elwithvalue
-    
-    def to_s
-      value
-    end
-  end
-
-  include XMLUtils
-  # Module used in EADSubordinates and EADLevels to add new levels to a file
-  module EADLevels
-  public
-    # Returns the list of all the child levels of the current element.
-    def levels
-      (self.c ||= []).dup
-    end
-  
-    # Adds a child level to the current element.
-    def add_level(level)
-      self.c << level
-    end
-    
-    # Removes a child level from the current element.
-    def remove_level(level)
-      self.c.delete(level)
-    end
-  end
-  
-  def self.sclass(name, string)
-    const_set(name, Class.new(EADSimpleElement)).send(:elname, string) 
-  end
-  
-  # 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 "EADAbstract", "abstract"
-  sclass "EADPhysDesc", "physdesc"
-  sclass "EADPhysLoc", "physloc"
-  sclass "EADAuthor", "author"
-  sclass "EADSponsor", "sponsor"
-  sclass "EADTitleProper", "titleproper"
-  sclass "EADAbbr", "abbr"
-  sclass "EADEmph", "emph"
-  sclass "EADExpan", "expan"
-  sclass "EADExtPtr", "extptr"
-  sclass "EADLb", "lb"
-  sclass "EADNum", "num"
-  sclass "EADPtr", "ptr"
-  sclass "EADArchRef", "archref"
-  sclass "EADBibRef", "bibref"
-  sclass "EADExtRef", "extref"
-  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.
-  class EADHead < EADElement
-    elname "head"
-    
-    xmlattr :althead
-    xmlattr :altrender
-    xmlattr :audience
-    xmlattr :id
-      
-    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 'p' element. For convenience it can be initialized
-  # with a string value that is used as the first subelement.
-  class EADP < EADElement
-    elname "p"
-    
-    xmlattr :altrender
-    xmlattr :audience
-    xmlattr :id
-      
-    xmlsubelements
-    
-    def initialize(string=nil)
-      if string
-        self.subelements << string
-      end
-    end
-    
-    def value
-      self.subelements[0].to_s
-    end
-  end
-  
-end
-
-require "EADDate"
-require "EADSubtitle"
-require "EADPhysTech"
-require "EADScopeContent"
-require "EADRelatedMaterial"
-require "EADNote"
-require "EADDescription"
-require "EADLevel"
-require "EADSubordinates"
-require "EADProfileDesc"
-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
-     ["c","c01","c02","c03","c04","c05","c06","c07","c08","c09","c10","c11","c12"]
-  end
-               
-  #c_levels.each{|level| ElClasses[level.to_sym] = EADLevel}
-end

data/lib/EADAcqInfo.rb

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

data/lib/EADAltFormAvail.rb

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

data/lib/EADAppraisal.rb

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

data/lib/EADArrangement.rb

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