RubyGems - stead - Versions diffs - 0.0.2 - Mend

stead 0.0.2

Files changed (19) hide show

data/LICENSE +21 -0
data/README.rdoc +75 -0
data/Rakefile +72 -0
data/VERSION +1 -0
data/bin/csv2ead +70 -0
data/examples/ncsu.rb +74 -0
data/lib/stead/ead.rb +270 -0
data/lib/stead/error.rb +6 -0
data/lib/stead/stead.rb +80 -0
data/lib/stead/templates/ead.xml +44 -0
data/lib/stead/templates/ead.xsd +2728 -0
data/lib/stead/templates/ncsu_ead.xml +69 -0
data/lib/stead.rb +56 -0
data/test/helper.rb +25 -0
data/test/test_ead_bad_container_type.rb +42 -0
data/test/test_ead_no_series.rb +89 -0
data/test/test_ead_series.rb +42 -0
data/test/test_stead.rb +43 -0
metadata +167 -0

data/lib/stead/templates/ncsu_ead.xml ADDED Viewed

@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<ead xsi:schemaLocation="urn:isbn:1-931666-22-9 http://www.loc.gov/ead/ead.xsd"
+     xmlns:ns2="http://www.w3.org/1999/xlink"
+     xmlns="urn:isbn:1-931666-22-9"
+     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <eadheader findaidstatus="Completed" repositoryencoding="iso15511"
+             countryencoding="iso3166-1" dateencoding="iso8601">
+    <eadid></eadid>
+    <filedesc>
+      <titlestmt>
+        <titleproper>
+          Preliminary Inventory to the
+        </titleproper>
+        <author></author>
+      </titlestmt>
+      <publicationstmt>
+        <publisher>Special Collections Research Center</publisher>
+      </publicationstmt>
+    </filedesc>
+    <profiledesc>
+      <langusage>
+        Finding aid written in
+        <language langcode="eng" encodinganalog="Language">English.</language>
+      </langusage>
+    </profiledesc>
+  </eadheader>
+  <archdesc level="subgrp">
+    <did>
+      <unittitle>Preliminary Inventory to the</unittitle>
+      <unitid></unitid>
+      <langmaterial>
+        <language langcode="eng"/>
+      </langmaterial>
+      <physloc label="Location">
+        For current information on the location of these materials, please consult the
+        <extref ns2:type="simple" ns2:href="http://www.lib.ncsu.edu/specialcollections/research/requestinformation.html">
+          Special Collections Research Center Reference Staff
+        </extref>
+        .
+      </physloc>
+    </did>
+    <accessrestrict >
+      <head>Access to Collection</head>
+      <p>
+        Collection is open for research; access requires at least 24 hours advance notice.
+      </p>
+    </accessrestrict>
+    <userestrict>
+      <head>Copyright Notice</head>
+      <p>
+        The nature of the NCSU Libraries' Special Collections means that copyright or other information about restrictions may be difficult or even impossible to determine despite reasonable efforts. The NCSU Libraries claims only physical ownership of most Special Collections materials.
+      </p>
+      <p>
+        The materials from our collections are made available for use in research, teaching, and private study, pursuant to U.S. Copyright law. The user must assume full responsibility for any use of the materials, including but not limited to, infringement of copyright and publication rights of reproduced materials. Any materials used for academic research or otherwise should be fully credited with the source.
+      </p>
+    </userestrict>
+    <prefercite id="ref8">
+      <head>Preferred Citation</head>
+      <p>
+        [Identification of item], Collection title, Collection number, NCSU Libraries' Special Collections Research Center.
+      </p>
+    </prefercite>
+    <dsc>
+    </dsc>
+  </archdesc>
+</ead>

data/lib/stead.rb ADDED Viewed

@@ -0,0 +1,56 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+module Stead
+  VERSION = '0.0.1'
+  CONTAINER_TYPES = [
+    "album",
+    "artifactbox",
+    "audiocassette",
+    "audiotape",
+    "box",
+    "cardbox",
+    "carton",
+    "cassette",
+    "cassettebox",
+    "cdbox",
+    "diskette",
+    "drawingsbox",
+    "flatbox",
+    "flatfile",
+    "flatfolder",
+    "folder",
+    "halfbox",
+    "item",
+    "largeenvelope",
+    "legalbox",
+    "mapcase",
+    "mapfolder",
+    "notecardbox",
+    "othertype",
+    "oversize",
+    "oversizebox",
+    "oversizeflatbox",
+    "reel",
+    "reelbox",
+    "scrapbook",
+    "slidebox",
+    "tube",
+    "tubebox",
+    "videotape",
+    "volume"
+  ]
+end
+require 'rubygems'
+require 'nokogiri'
+require 'fastercsv'
+require 'active_support'
+require 'pp'
+require 'stead/stead'
+require 'stead/ead'
+require 'stead/error'

data/test/helper.rb ADDED Viewed

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'stead'
+class Test::Unit::TestCase
+end
+module SteadTestHelpers
+  def assert_main_elements_equal(did, example_did)
+    ['unitid', 'unittitle', 'unitdate', 'extent', 'container'].each do |elem|
+      #puts example_did.xpath('.//xmlns:' + elem)
+      if !example_did.xpath('.//xmlns:' + elem).blank?
+        did_content = did.xpath('.//xmlns:' + elem).first.content
+        assert_not_nil did_content
+        assert_equal example_did.xpath('.//xmlns:' + elem).first.content,
+          did_content
+      end
+    end
+  end
+end

data/test/test_ead_bad_container_type.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require 'helper'
+class TestSteadErrors < Test::Unit::TestCase
+  def setup
+    @ead_generator = Stead::EadGenerator.from_csv(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000_container_list_bad_container_type.csv' )))
+    @ead_generator_good = Stead::EadGenerator.from_csv(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000_container_list_no_series.csv' )))
+  end
+  def test_bad_container_type_raises
+    assert_raise(Stead::InvalidContainerType) {@ead_generator.to_ead}
+  end
+  def test_bad_container_type_error_message
+    begin
+      @ead_generator.to_ead
+    rescue Stead::InvalidContainerType => error
+      assert_equal 'Box', error.message
+    end
+  end
+  # create an invalid ead document so that we can test that validation of the ead
+  # is working
+  def test_invalid_ead_error_message
+    assert_raise(Stead::InvalidEad) {
+      @ead_generator_good.to_ead
+      a = Nokogiri::XML::Node.new('asdfasd', @ead_generator_good.ead)
+      @ead_generator_good.ead.xpath('//xmlns:archdesc').first.add_child(a)
+      @ead_generator_good.valid?
+    }
+  end
+  def test_csv_with_nil_header
+    assert_raise(Stead::InvalidCsv) {
+      Stead::EadGenerator.from_csv(File.read(File.join(File.dirname(__FILE__),
+            'container_lists', 'mc00084_container_list_empty_header.csv' ))) }
+  end
+end

data/test/test_ead_no_series.rb ADDED Viewed

@@ -0,0 +1,89 @@
+require 'helper'
+class TestSteadEadNoSeries < Test::Unit::TestCase
+  include SteadTestHelpers
+  def setup
+    @xsd = Nokogiri::XML::Schema(File.read(Stead.ead_schema))
+    #@template = Nokogiri::XML(File.read(Stead.ead_template))
+    @example = Nokogiri::XML(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000-ead.xml' )))
+    @ead_generator = Stead::EadGenerator.from_csv(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000_container_list_no_series.csv' )))
+    @generated_ead = @ead_generator.to_ead
+    #puts Stead.pretty_write(@generated_ead)
+    @did_xpath = '//xmlns:dsc/xmlns:c01/xmlns:did'
+  end
+  def test_creation_of_eadxml_counts
+    assert_equal 1, @example.xpath('//xmlns:dsc').length
+    assert_equal 1, @generated_ead.xpath('//xmlns:dsc').length
+    assert_equal 5, @generated_ead.xpath('//xmlns:c01').length
+  end
+  def test_created_ead_matches_example_content
+    (0..4).each do |number|
+      #puts number
+      did = @generated_ead.xpath(@did_xpath)[number]
+      example_did = @example.xpath(@did_xpath)[number]
+      assert_equal 'file', did.parent['level']
+      assert_main_elements_equal(did, example_did)
+    end
+  end
+  def test_notes
+    notes = @generated_ead.xpath(@did_xpath).first.xpath('xmlns:note')
+    assert_equal 'note1', notes.first.xpath('xmlns:p').first.content
+    assert_equal 'note2', notes[1].xpath('xmlns:p').first.content
+  end
+  def test_scopecontent
+    last_cp = @generated_ead.xpath('//xmlns:c01').last
+    scopecontent = last_cp.xpath('./xmlns:scopecontent/xmlns:p').first.content
+    assert_equal 'Sessions 32-38', scopecontent
+  end
+  def test_validity
+    assert @xsd.valid?(@generated_ead)
+  end
+  def test_internal_only
+    assert_equal 'internal',
+      @generated_ead.xpath(@did_xpath).first.parent['audience']
+  end
+  def test_accessrestrict
+    last_cp = @generated_ead.xpath('//xmlns:c01')[3]
+    accessrestrict = last_cp.xpath('./xmlns:accessrestrict').first.content
+    assert_equal 'Restricted', accessrestrict
+  end
+  def test_container_label
+    container = @generated_ead.xpath('//xmlns:container').first
+    assert_equal 'Mixed materials', container['label']
+  end
+  def test_three_containers
+    first_did = @generated_ead.xpath(@did_xpath).first
+    containers = first_did.xpath('xmlns:container')
+    assert_equal 3, containers.length
+    assert_equal 'box', containers.first['type']
+    assert_equal '45', containers.first.content
+    assert_equal 'folder', containers[1]['type']
+    assert_equal '404', containers[1].content
+    assert_equal 'artifactbox', containers[2]['type']
+    assert_equal '3', containers[2].content
+  end
+  def test_missing_container_type
+    did = @generated_ead.xpath(@did_xpath)[3]
+    containers = did.xpath('xmlns:container')
+    assert_equal 2, containers.length
+    assert_equal 'box', containers[0]['type']
+    assert_equal '58', containers[0].content
+    assert_equal 'othertype', containers[1]['type']
+    assert_equal '551', containers[1].content
+  end
+end

data/test/test_ead_series.rb ADDED Viewed

@@ -0,0 +1,42 @@
+require 'helper'
+class TestSteadEadSeries < Test::Unit::TestCase
+  include SteadTestHelpers
+  def setup
+    @xsd = Nokogiri::XML::Schema(File.read(Stead.ead_schema))
+    #@template = Nokogiri::XML(File.read(Stead.ead_template))
+    @example = Nokogiri::XML(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000-ead-series.xml' )))
+    @ead_generator = Stead::EadGenerator.from_csv(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000_container_list.csv' )))
+    @generated_ead = @ead_generator.to_ead
+    #puts Stead.pretty_write(@generated_ead)
+    @did_xpath = '//xmlns:c02/xmlns:did'
+  end
+  def test_ead_c01_counts
+    assert_equal 3, @generated_ead.xpath('//xmlns:c01').length
+  end
+  def test_ead_c02_counts
+    assert_equal 5, @generated_ead.xpath('//xmlns:c02').length
+  end
+  def test_validity
+    assert @xsd.valid?(@generated_ead)
+  end
+  def test_created_ead_matches_example_content
+    (0..4).each do |number|
+      #puts number
+      did = @generated_ead.xpath(@did_xpath)[number]
+      example_did = @example.xpath(@did_xpath)[number]
+      assert_equal 'file', did.parent['level']
+      assert_main_elements_equal(did, example_did)
+    end
+  end
+end

data/test/test_stead.rb ADDED Viewed

@@ -0,0 +1,43 @@
+require 'helper'
+class TestStead < Test::Unit::TestCase
+  def setup
+    @xsd = Stead.xsd
+    @template = Nokogiri::XML(File.read(Stead.ead_template))
+    @example = Nokogiri::XML(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000-ead.xml' )))
+    @output = Stead::EadGenerator.from_csv(File.read(File.join(File.dirname(__FILE__),
+          'container_lists', 'mc00000_container_list_no_series.csv' )))
+  end
+  def test_truth
+    assert true
+  end
+  def test_validity_of_ead_template
+    assert @xsd.valid?(@template)
+  end
+  def test_validity_of_ead_example_document
+    assert @xsd.valid?(@example)
+  end
+  context "optional elements to add" do
+    setup do
+      file = File.read(File.join(File.dirname(__FILE__),
+        'container_lists', 'mc00000_container_list_no_series.csv' ))
+      options = {:eadid => 'mc00000', :base_url => 'http://www.lib.ncsu.edu/findingaids'}
+      @generator = Stead::EadGenerator.from_csv(file, options)
+      @ead = @generator.to_ead
+    end
+    should "add the eadid if supplied" do
+      assert_equal 'mc00000', @ead.xpath('//xmlns:eadid').first.content
+    end
+    should "add an ead url if supplied" do
+      assert_equal 'http://www.lib.ncsu.edu/findingaids/mc00000', @ead.xpath('//xmlns:eadid').first['url']
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: stead
+version: !ruby/object:Gem::Version
+  hash: 27
+  prerelease: false
+  segments:
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors:
+- Jason Ronallo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-08-08 00:00:00 -04:00
+default_executable: csv2ead
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 5
+        segments:
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: fastercsv
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 9
+        segments:
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: trollop
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 83
+        segments:
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        hash: 3
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Converts CSV files of a specific schema into EAD XML.
+email: jronallo@gmail.com
+executables:
+- csv2ead
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/csv2ead
+- examples/ncsu.rb
+- lib/stead.rb
+- lib/stead/ead.rb
+- lib/stead/error.rb
+- lib/stead/stead.rb
+- lib/stead/templates/ead.xml
+- lib/stead/templates/ead.xsd
+- lib/stead/templates/ncsu_ead.xml
+- test/test_ead_bad_container_type.rb
+- test/helper.rb
+- test/test_stead.rb
+- test/test_ead_no_series.rb
+- test/test_ead_series.rb
+has_rdoc: true
+homepage: http://github.com/jronallo/stead
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Spreadsheets To Encoded Archival Description
+test_files:
+- test/test_ead_bad_container_type.rb
+- test/helper.rb
+- test/test_stead.rb
+- test/test_ead_no_series.rb
+- test/test_ead_series.rb
+- examples/ncsu.rb