eadcodec 0.0.4 → 0.1.0

data/Rakefile

@@ -1,11 +1,12 @@
 PKG_NAME = 'eadcodec'
-PKG_VERSION = '0.0.4'
+PKG_VERSION = '0.1.0'
 
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
 require 'rubygems'
+require 'rcov/rcovtask'
 
 task :default => ['test']
 
@@ -30,7 +31,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.4')
+  s.add_dependency('xmlcodec', '>= 0.1.0')
   s.require_path = 'lib'
   s.autorequire = 'rake'
   s.files = PKG_FILES
@@ -50,9 +51,8 @@ end
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/Test*.rb'].exclude('test/TestEAD.rb')
-  t.libs = ['../lib','..']
-  t.ruby_opts = ['-xtest']
+  t.test_files = FileList['test/*_test.rb']
+  t.libs = ['lib']
   t.verbose = true
 end
 
@@ -77,6 +77,13 @@ task :stats do
   puts "Code to test ratio: 1:%.2f" % ratio
 end
 
+Rcov::RcovTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.output_dir = 'test/coverage'
+  t.verbose = true
+end
+
 def count_lines(files)
   code = 0
   comments = 0

data/lib/eadcodec.rb

@@ -1 +1,76 @@
-require 'EAD'
+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 EADCodec
+  class EADElement < XMLCodec::XMLElement #:nodoc:
+    xmlformat 'EAD'
+  end
+  
+  class EADSimpleElement < EADElement
+    elwithvalue
+    
+    def to_s
+      value
+    end
+  end
+
+  include XMLUtils
+  
+  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 "Abstract", "abstract"
+  sclass "Author", "author"
+  sclass "Sponsor", "sponsor"
+  sclass "TitleProper", "titleproper"
+  sclass "Abbr", "abbr"
+  sclass "Emph", "emph"
+  sclass "Expan", "expan"
+  sclass "ExtPtr", "extptr"
+  sclass "Lb", "lb"
+  sclass "Num", "num"
+  sclass "Ptr", "ptr"
+  sclass "ArchRef", "archref"
+  sclass "BibRef", "bibref"
+  sclass "ExtRef", "extref"
+  sclass "Ref", "ref"
+  sclass "LinkGrp", "linkgrp"
+  sclass "Title", "title"
+
+  
+  
+  # Module included in classes that have paragraphs as subelements
+  module WithParagraphs
+    def initialize(value=nil)
+      value = [] if not value
+      value = [value] if not value.is_a? Array
+      value.each{|v| self << P.new(v)}
+    end
+  end
+  
+  # Module included in classes that have text and other elements as subelements
+  module WithText
+    def initialize(value=nil)
+      value = [] if not value
+      value = [value] if not value.is_a? Array
+      value.each{|v| self << v}
+    end
+    
+    def value
+      self.subelements[0].to_s
+    end
+  end
+end
+
+Dir.glob(File.dirname(__FILE__)+'/elements/*.rb').each do |el|
+  EADCodec.module_eval File.open(el).read
+end

data/lib/elements/accessrestrict.rb

@@ -0,0 +1,12 @@
+class AccessRestrict < EADElement
+  include WithParagraphs
+  elname "accessrestrict"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :type
+  
+  xmlsubelements
+end

data/lib/elements/accruals.rb

@@ -0,0 +1,11 @@
+class Accruals < EADElement
+  include WithParagraphs
+  elname "accruals"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/acqinfo.rb

@@ -0,0 +1,12 @@
+class AcqInfo < EADElement
+  include WithParagraphs
+  elname "acqinfo"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :label
+  
+  xmlsubelements
+end

data/lib/elements/altformavail.rb

@@ -0,0 +1,12 @@
+class AltFormAvail < EADElement
+  include WithParagraphs
+  elname "altformavail"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :type
+  
+  xmlsubelements
+end

data/lib/elements/appraisal.rb

@@ -0,0 +1,11 @@
+class Appraisal < EADElement
+  include WithParagraphs
+  elname "appraisal"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/archdesc.rb

@@ -0,0 +1,32 @@
+class ArchDesc < EADElement
+  elname "archdesc"
+
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :level
+  xmlattr :otherlevel
+  xmlattr :relatedencoding
+  xmlattr :type
+  
+  xmlsubelements
+  def initialize
+    @level = "fonds"
+  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

data/lib/elements/arrangement.rb

@@ -0,0 +1,11 @@
+class Arrangement < EADElement
+  include WithParagraphs
+  elname "arrangement"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+
+  xmlsubelements
+end

data/lib/elements/bibliography.rb

@@ -0,0 +1,12 @@
+class Bibliography < EADElement
+  include WithParagraphs
+  elname "bibliography"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :type
+  
+  xmlsubelements
+end

data/lib/elements/bioghist.rb

@@ -0,0 +1,11 @@
+class BiogHist < EADElement
+  include WithParagraphs
+  elname "bioghist"
+
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+
+  xmlsubelements
+end

data/lib/elements/c.rb

@@ -0,0 +1,65 @@
+class Level < EADElement		
+	xmlattr :altrender
+	xmlattr :audience
+	xmlattr :encodinganalog
+	xmlattr :id
+	xmlattr :level
+	xmlattr :otherlevel
+	xmlattr :tpattern
+
+	xmlsubelements
+	
+	attr_reader :parent
+	
+	#elnames(*["c","c01","c02","c03","c04","c05","c06",
+	#          "c07","c08","c09","c10","c11","c12"])
+
+  elname 'c'
+
+	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

data/lib/elements/chronitem.rb

@@ -0,0 +1,12 @@
+class ChronItem < EADElement
+  elname "chronitem"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  
+  xmlsubel :date
+  xmlsubel :event
+  xmlsubel :eventgrp
+end

data/lib/elements/chronlist.rb

@@ -0,0 +1,12 @@
+class ChronList < EADElement
+  elname "chronlist"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  
+  xmlsubelements
+end
+
+

data/lib/elements/container.rb

@@ -0,0 +1,13 @@
+class Container < EADElement
+  elname "container"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :label
+  xmlattr :parent
+  xmlattr :type
+  
+  xmlsubelements
+end

data/lib/elements/controlaccess.rb

@@ -0,0 +1,10 @@
+class ControlAccess < EADElement
+  elname :controlaccess
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/creation.rb

@@ -0,0 +1,4 @@
+class Creation < EADElement
+	elname "creation"
+	xmlsubelements
+end

data/lib/elements/custodhist.rb

@@ -0,0 +1,11 @@
+class CustodHist < EADElement
+  include WithParagraphs
+  elname "custodhist"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/date.rb

@@ -0,0 +1,14 @@
+class Date < EADElement
+	elname "date"
+	elwithvalue
+
+	xmlattr :altrender
+	xmlattr :audience
+	xmlattr :calendar
+	xmlattr :certainty
+	xmlattr :encodinganalog
+	xmlattr :era
+	xmlattr :id
+	xmlattr :normal
+	xmlattr :type
+end

data/lib/elements/defitem.rb

@@ -0,0 +1,10 @@
+class DefItem < EADElement 
+  elname "defitem"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :id
+  
+  xmlsubel :label
+  xmlsubel :item
+end

data/lib/elements/description.rb

@@ -0,0 +1,10 @@
+class Description < EADElement	
+	elname "did"
+
+	xmlattr :altrender
+	xmlattr :audience
+	xmlattr :encodinganalog
+	xmlattr :id
+
+	xmlsubelements
+end

data/lib/elements/dimensions.rb

@@ -0,0 +1,13 @@
+class Dimensions < EADElement
+  elname "dimensions"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :label
+  xmlattr :type
+  xmlattr :unit
+  
+  xmlsubelements
+end

data/lib/elements/dsc.rb

@@ -0,0 +1,21 @@
+class Subordinates < EADElement
+  elname "dsc"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encondinganalog
+  xmlattr :id
+  xmlattr :othertype
+  xmlattr :tpattern
+  xmlattr :type
+  
+  xmlsubelements
+
+  def description_level
+    0
+  end
+
+  def unnumbered?
+    false
+  end
+end

data/lib/elements/ead.rb

@@ -0,0 +1,39 @@
+class Document < 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 = Header.new(id, title)
+    self.archdesc = ArchDesc.new
+  end
+
+  def export(filename)
+    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")
+
+    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

data/lib/elements/eadheader.rb

@@ -0,0 +1,28 @@
+class Header < 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 = Id.new(id)
+		self.filedesc = FileDesc.new(title)
+	end
+
+	def eadtitle
+		self.filedesc.titlestmt.titleproper
+	end
+end

data/lib/elements/event.rb

@@ -0,0 +1,9 @@
+class Event < EADElement
+  elname "event"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/extent.rb

@@ -0,0 +1,13 @@
+class Extent < EADElement
+  elname "extent"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :label
+  xmlattr :type
+  xmlattr :unit
+  
+  xmlsubelements
+end

data/lib/elements/filedesc.rb

@@ -0,0 +1,13 @@
+class FileDesc < EADElement
+	elname 'filedesc'
+
+	xmlattr :altrender
+	xmlattr :audience
+	xmlattr :encodinganalog
+	xmlattr :id
+	xmlsubel :titlestmt
+
+	def initialize(title)
+		self.titlestmt = TitleStatement.new(title)
+	end
+end

data/lib/elements/fileplan.rb

@@ -0,0 +1,10 @@
+class FilePlan< EADElement
+  elname "fileplan"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/geogname.rb

@@ -0,0 +1,16 @@
+class GeogName < EADElement
+  include WithText
+  elname 'geogname'
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :authfilenumber
+  xmlattr :encondinganalog
+  xmlattr :id
+  xmlattr :normal
+  xmlattr :role
+  xmlattr :rules
+  xmlattr :source
+  
+  xmlsubelements
+end

data/lib/elements/head.rb

@@ -0,0 +1,11 @@
+class Head < EADElement
+  include WithText
+  elname "head"
+  
+  xmlattr :althead
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :id
+    
+  xmlsubelements
+end

data/lib/elements/id.rb

@@ -0,0 +1,12 @@
+class Id < EADElement
+	elname 'eadid'
+	elwithvalue
+
+	xmlattr :countrycode
+	xmlattr :encodinganalog
+	xmlattr :identifier
+	xmlattr :mainagencycode
+	xmlattr :publicid
+	xmlattr :url
+	xmlattr :urn
+end

data/lib/elements/item.rb

@@ -0,0 +1,9 @@
+class Item < EADElement 
+  elname "item"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/label.rb

@@ -0,0 +1,9 @@
+class Label < EADElement
+  elname "label"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :id
+  
+  xmlsubelements
+end

data/lib/elements/langmaterial.rb

@@ -0,0 +1,12 @@
+class LangMaterial < EADElement
+  include WithText
+  elname "langmaterial"
+  
+  xmlattr :altrender
+  xmlattr :audience
+  xmlattr :encodinganalog
+  xmlattr :id
+  xmlattr :label
+  
+  xmlsubelements
+end