mead 0.0.6 → 0.1.0

data/Gemfile

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 #   gem "activesupport", ">= 2.3.5"
 
 
-gem "nokogiri", "= 1.4.3.1"
+gem "nokogiri"
 gem "json", ">= 0"
 gem "trollop", ">= 0"
 

data/Gemfile.lock

@@ -10,9 +10,9 @@ GEM
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
-    json (1.5.0)
+    json (1.5.1)
     linecache (0.43)
-    nokogiri (1.4.3.1)
+    nokogiri (1.4.4)
     rake (0.8.7)
     rcov (0.9.9)
     reek (1.2.8)
@@ -30,7 +30,7 @@ GEM
     ruby2ruby (1.2.5)
       ruby_parser (~> 2.0)
       sexp_processor (~> 3.0)
-    ruby_parser (2.0.5)
+    ruby_parser (2.0.6)
       sexp_processor (~> 3.0)
     sexp_processor (3.0.5)
     shoulda (2.11.3)
@@ -46,7 +46,7 @@ DEPENDENCIES
   gbarcode (>= 0.98.20)
   jeweler (~> 1.5.1)
   json
-  nokogiri (= 1.4.3.1)
+  nokogiri
   rcov
   reek (~> 1.2.8)
   rmagick

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.1.0

data/lib/mead/component_part.rb

@@ -0,0 +1,80 @@
+module Mead
+  class ComponentPart
+    attr_accessor :unittitle, :unitdate, :unitid, :level, 
+      :series_sequence, :containers, 
+      :item_location #FIXME: temporary attribute while refactoring
+    
+    def initialize(opts={})
+      @item_location = opts[:item_location] if opts[:item_location]
+      @unittitle = opts[:unittitle] if opts[:unittitle]
+      @unitdate = opts[:unitdate] if opts[:unitdate]
+      @unitid = opts[:unitid] if opts[:unitid]
+      @level = opts[:level] if opts[:level]
+      self.series_sequence = opts[:series_sequence] if opts[:series_sequence]
+      
+      
+      if opts[:containers] 
+        @containers = []
+        # FIXME: What is a better way to insure the Array-ness of containers?
+        if opts[:containers].is_a? Array
+          opts[:containers].each do |container|
+            if container.is_a?(Mead::Container)
+              @containers << container
+            else
+              raise 'containers must have only Mead::Containers'
+            end
+          end
+        else
+          raise 'containers must be in an Array'
+        end
+      end
+    end
+    
+    def series_sequence=(integer)
+      if !integer.is_a?(Integer)
+        # FIXME: create better error class
+        raise RuntimeError, 'series_sequence must be an integer'
+      end
+      @series_sequence = integer
+    end
+    
+#    def <<(container)
+#      @containers << container
+#    end
+
+    # FIXME: must be a better way to implement my own equality. How to get all
+    # the symbols for the possible attributes for an instance of a class?
+    def ==(another_cp)
+      return false if !another_cp.is_a?(Mead::ComponentPart)
+      [:unittitle, :unitdate, :unitid, :level, 
+      :series_sequence, :containers, 
+      :item_location].each do |attribute|
+        if self.send(attribute) != another_cp.send(attribute)
+          return false
+        end
+      end
+      return true
+    end
+    
+    def containers=(container)
+      @containers = []
+      self.containers << container
+    end
+    
+    # FIXME: temporary method while refactoring
+    def [](attribute)
+      self.send(attribute)
+    end
+    
+    def to_json(*a)
+     h = {
+       'json_class'   => self.class.name
+     }
+     self.instance_variables.each do |var|
+       h[var.sub('@','').to_sym] = self.send(var.sub('@','').to_sym)
+     end
+     h.to_json(*a)
+   end
+        
+  end
+end

data/lib/mead/container.rb

@@ -16,6 +16,15 @@ module Mead
       self.text == another_container.text
     end
     
+    def to_json(*a)
+     h = {
+       'json_class'   => self.class.name
+     }
+     self.instance_variables.each do |var|
+       h[var.sub('@','').to_sym] = self.send(var.sub('@','').to_sym)
+     end
+     h.to_json(*a)
+   end
     
   end
 end

data/lib/mead/extractor.rb

@@ -57,14 +57,13 @@ module Mead
       additional_did[:item_location] = did_location_text if did_location_text
       
       add_containers(additional_did, node)
-      
       if additional_did[:level] == 'series'
-        additional_did[:series_number] = series_number(node)
+        additional_did[:series_sequence] = series_number(node)
       end
       if @stack.last == additional_did
         return
       end
-      @stack << additional_did
+      @stack << Mead::ComponentPart.new(additional_did)
       if !node.parent.parent.xpath('xmlns:did').empty?
         push_to_stack(node.parent.parent.xpath('xmlns:did')[0])
       end
@@ -93,6 +92,8 @@ module Mead
       end
     end
 
+    # FIXME: This currently depends on series being numbered sequentially and being
+    # arranged in that order in the EAD XML.
     def get_series
       c01_series = @dsc.xpath(".//xmlns:c01[@level='series']")
       if c01_series and !c01_series.empty?

data/lib/mead/identifier.rb

@@ -1,7 +1,10 @@
 module Mead
   class Identifier
 
-    attr_accessor :mead, :eadid, :series, :container, :folder, :sequence, :page, 
+    attr_accessor :mead, :eadid, :series, 
+      # container is just the first container and folder the second container
+      :container, :folder, 
+      :sequence, :page, 
       :ead_location, :metadata
     include Mead::Validations
     validates_format_of_mead
@@ -92,21 +95,5 @@ module Mead
       self
     end
     
-#    def ead_has_series?
-#      if series > 1
-#        true
-#      else
-#        if 
-#        false
-#      end
-#    end
-
-#    def replace_underscores(*args)
-#      args.each do |field|
-#        value = instance_variable_get('@' + field).gsub('_', '.')
-#        instance_variable_set('@' + field, value)
-#      end
-#    end
-
   end
 end

data/lib/mead/validations.rb

@@ -82,7 +82,7 @@ module Mead
           if result.nil? or result.empty?
             add_error(instance, :mead, 'No matching container.')
           # even if the instance.series is 1 there may not be any series in the EAD XML yet
-          elsif result.last[:series_number] and instance.series != result.last[:series_number].to_s
+        elsif result.last[:series_sequence] and instance.series != result.last[:series_sequence].to_s
             add_error(instance, :mead, 'Bad series.') 
           end
           rescue => e

data/lib/mead.rb

@@ -55,6 +55,7 @@ require 'mead/identifier'
 require 'mead/extractor'
 require 'mead/ead'
 require 'mead/ead_validator'
+require 'mead/component_part'
 require 'mead/container'
 
 # if gbarcode and rmagick can both be loaded then load mead/barcode

data/mead.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mead}
-  s.version = "0.0.6"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jason Ronallo"]
-  s.date = %q{2011-02-03}
+  s.date = %q{2011-02-27}
   s.description = %q{Extract identifiers and metadata from EAD XML.}
   s.email = %q{jronallo@gmail.com}
   s.executables = ["mead2barcode", "meadbfv", "emv", "automead", "ead2meads"]
@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
     "bin/meadbfv",
     "lib/mead.rb",
     "lib/mead/barcode.rb",
+    "lib/mead/component_part.rb",
     "lib/mead/container.rb",
     "lib/mead/ead.rb",
     "lib/mead/ead_validator.rb",
@@ -51,6 +52,7 @@ Gem::Specification.new do |s|
     "test/fixtures/ua023_031.xml",
     "test/helper.rb",
     "test/test_barcode.rb",
+    "test/test_component_part.rb",
     "test/test_ead.rb",
     "test/test_ead_validator.rb",
     "test/test_extractor.rb",
@@ -73,6 +75,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
     "test/test_barcode.rb",
+    "test/test_component_part.rb",
     "test/test_ead.rb",
     "test/test_ead_validator.rb",
     "test/test_extractor.rb",
@@ -92,7 +95,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<trollop>, [">= 0"])
       s.add_runtime_dependency(%q<fastercsv>, [">= 0"])
@@ -107,7 +110,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<fakeweb>, [">= 0"])
       s.add_development_dependency(%q<ruby-debug>, [">= 0"])
     else
-      s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<trollop>, [">= 0"])
       s.add_dependency(%q<fastercsv>, [">= 0"])
@@ -123,7 +126,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<ruby-debug>, [">= 0"])
     end
   else
-    s.add_dependency(%q<nokogiri>, ["= 1.4.3.1"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<trollop>, [">= 0"])
     s.add_dependency(%q<fastercsv>, [">= 0"])

data/test/test_component_part.rb

@@ -0,0 +1,135 @@
+require 'helper'
+
+class TestComponentPart < Test::Unit::TestCase
+  
+  should "create a new component part with no options" do
+    assert Mead::ComponentPart.new 
+  end
+  
+  context "creating a component part with good options" do
+    should "have a unittitle attribute" do
+      cp = Mead::ComponentPart.new(:unittitle => 'unit title')
+      assert_equal 'unit title', cp.unittitle
+    end
+    
+    should "have a unitdate attribute" do
+      cp = Mead::ComponentPart.new(:unitdate => 'unit date')
+      assert_equal 'unit date', cp.unitdate
+    end
+    
+    should 'have a unitid attribute' do
+      cp = Mead::ComponentPart.new(:unitid => 'unit id')
+      assert_equal 'unit id', cp.unitid
+    end
+    
+    should 'have a level attribute' do
+      cp = Mead::ComponentPart.new(:level => 'level')
+      assert_equal 'level', cp.level
+    end
+    
+    should 'have a series_sequence attribute' do
+      cp = Mead::ComponentPart.new(:series_sequence => 8)
+      assert_equal 8, cp.series_sequence
+    end
+    
+    should 'not allow a non-Integer as the series_sequence' do
+      assert_raise(RuntimeError){ Mead::ComponentPart.new(:series_sequence => '8')}
+    end
+    
+    should 'allow for assinging containers as an option' do
+      container1 = Mead::Container.new(:level => 'file')
+      container2 = Mead::Container.new(:level => 'series')
+      cp = Mead::ComponentPart.new(:containers => [container1, container2])
+      assert_equal [container1, container2], cp.containers
+    end
+    
+    should 'raise if trying to mass assign non-Array to containers' do
+      assert_raise(RuntimeError){ Mead::ComponentPart.new(:containers => 'asdfa')}      
+    end
+    
+    should 'raise if trying to mass assign non-Containers to containers' do
+      assert_raise(RuntimeError){Mead::ComponentPart.new(:containers => ['asdfa'])}
+    end
+    
+    should 'not automatically create an empty array for containers' do
+      cp = Mead::ComponentPart.new
+      assert_nil cp.containers
+    end
+    
+  end
+  
+  context "build up component part values" do
+    setup do
+      @cp = Mead::ComponentPart.new
+    end
+    
+    should 'allow a unittitle to be assigned' do
+      @cp.unittitle = 'unit title'
+      assert_equal 'unit title', @cp.unittitle
+    end
+    
+    should 'allow a unitdate to be assigned' do
+      @cp.unitdate = 'unit date'
+      assert_equal 'unit date', @cp.unitdate
+    end
+    
+    should 'allow a unitid to be assigned' do
+      @cp.unitid = 'unit id'
+      assert_equal 'unit id', @cp.unitid
+    end
+    
+    should 'allow a level to be assigned' do
+      @cp.level = 'level'
+      assert_equal 'level', @cp.level
+    end
+    
+    should 'allow a series_sequence to be assigned' do
+      @cp.series_sequence = 8
+      assert_equal 8, @cp.series_sequence
+    end
+    
+    should 'not allow a string to be assigned to the series_sequence' do
+      assert_raise(RuntimeError) {@cp.series_sequence = '9'}
+    end
+    
+    should 'store containers as an array' do
+      @cp.containers = [Mead::Container.new]
+      assert @cp.containers.is_a? Array
+    end
+    
+    should 'allow for adding to the containers array' #do
+#      container = Mead::Container.new
+#      @cp.containers << container
+#      assert_equal [container], @cp.containers
+#    end
+    
+    should 'not allow for adding a non-Container to containers' #do
+#      assert_raise(RuntimeError){@cp.containers << 'asdf'}
+#    end
+    
+    context 'multiple containers' do
+      setup do
+        @container1 = Mead::Container.new(:type => 'file')
+        @container2 = Mead::Container.new(:type => 'series')
+      end      
+      
+      should 'allow assigning directly to containers, but resetting everything there' #do        
+#        @cp.containers << @container1
+#        assert_equal [@container1], @cp.containers
+#        
+#        @cp.containers = @container2
+#        assert_equal [@container2], @cp.containers
+#      end
+      
+      should 'add a container on to the end of the containers' #do
+#        @cp.containers << @container1 
+#        @cp.containers << @container2
+#        assert_equal [@container1, @container2], @cp.containers
+#      end
+      
+    end
+    
+  end
+  
+  
+end

data/test/test_extractor.rb

@@ -6,6 +6,7 @@ class TestMeadExtractor < Test::Unit::TestCase
 
       @identifier = 'ua023_031-008-cb0013-001-001'
       @expected_1 = [
+       Mead::ComponentPart.new(
         {:level=>"file", 
         :unitdate=>nil, 
         :unitid=>nil, 
@@ -15,9 +16,9 @@ class TestMeadExtractor < Test::Unit::TestCase
         :containers => [
           Mead::Container.new(:type => 'cardbox', :label => "Mixed materials", :text => '13'), 
           Mead::Container.new(:type => 'Envelope', :text => '1')]
-        },
-        {:level=>"subseries", :unitdate=>nil, :unitid=>nil, :unittitle=>"Students"},
-        {:level=>"series", :unitdate=>nil, :series_number=>8, :unitid=>"Series 8", :unittitle=>"People"}]
+        }),
+        Mead::ComponentPart.new({:level=>"subseries", :unitdate=>nil, :unitid=>nil, :unittitle=>"Students"}),
+        Mead::ComponentPart.new({:level=>"series", :unitdate=>nil, :series_sequence=>8, :unitid=>"Series 8", :unittitle=>"People"})]
     end
 
     should "produce a good extraction with a filehandle location for the Ead" do
@@ -36,18 +37,18 @@ class TestMeadExtractor < Test::Unit::TestCase
 
     context 'mc00240-001-ff0052-000-001' do
       setup do
-        @expected_mc00240 = [{:unittitle=>"Friends Church",
+        @expected_mc00240 = [Mead::ComponentPart.new({:unittitle=>"Friends Church",
                     :item_location=>"flatfolder 52",
                     :unitdate=>"1927",
                     :level=>"file",
                     :unitid=>"903",
                     :containers => 
-                    [Mead::Container.new(:type => 'flatfolder', :label => 'Mixed materials', :text => '52')]},
-                   {:series_number=>1,
+                    [Mead::Container.new(:type => 'flatfolder', :label => 'Mixed materials', :text => '52')]}),
+                   Mead::ComponentPart.new({:series_sequence=>1,
                     :unittitle=>"Drawings",
                     :unitdate=>"1917-1980",
                     :level=>"series",
-                    :unitid=>"MC 240 Series 1"}]
+                    :unitid=>"MC 240 Series 1"})]
       end
       should 'handle empty folder properly' do
         mead = Mead::Identifier.new('mc00240-001-ff0052-000-001', File.open('test/ead/mc00240.xml'))

data/test/test_mc00240.rb

@@ -10,15 +10,15 @@ class TestMeadMC00240 < Test::Unit::TestCase
     end
     should "retrieve the correct metadata" do
       @mead.extract
-      expected = [{:unittitle=>"Moravian Chapel at Southside", :level=>"file",
+      expected = [Mead::ComponentPart.new({:unittitle=>"Moravian Chapel at Southside", :level=>"file",
                     :item_location=>"flatfolder 147", :unitdate=>"1928", :unitid=>"1034",
                       :containers => 
                       [Mead::Container.new(:type => 'flatfolder', 
                                             :label => "Mixed materials",
                                             :text => '147')]
-                    }, 
-                   {:unittitle=>"Drawings", :series_number=>1,
-                    :level=>"series", :unitdate=>"1917-1980", :unitid=>"MC 240 Series 1"}]
+                    }), 
+                   Mead::ComponentPart.new({:unittitle=>"Drawings", :series_sequence=>1,
+                    :level=>"series", :unitdate=>"1917-1980", :unitid=>"MC 240 Series 1"})]
       assert_equal expected, @mead.metadata
     end
   end
@@ -116,18 +116,10 @@ class TestMeadMC00240 < Test::Unit::TestCase
         end
         
         should "extract a series' series number" do
-          assert_equal 1, @extractor.stack[1][:series_number]
+          assert_equal 1, @extractor.stack[1][:series_sequence]
         end
 
-#        should "only extract up to the series level" do
-#          assert_equal [
-#            {:unittitle=>"Amos Hosiery Mill - Addition", :unitdate=>"1953",
-#            :level => 'file', :unitid => '1421', :item_location => 'flatfolder 42'},
-#            {:unittitle=>"Drawings", :unitdate=>"1917-1980", :level => 'series',
-#              :unitid => 'MC 240 Series 1', :series_number => 1
-#            }
-#          ], @extractor.stack
-#        end
+
 
       end
 

data/test/test_ua015_010.rb

@@ -86,19 +86,10 @@ class TestMeadUA015_010 < Test::Unit::TestCase
         end
         
         should "extract a series' series number" do
-          assert_equal 4, @extractor.stack[1][:series_number]
+          assert_equal 4, @extractor.stack[1][:series_sequence]
         end
 
-#        should "only extract up to the series level" do
-#          assert_equal [
-#            {:unittitle=>"Programs", :unitdate=>"1949-1950",
-#            :level => 'file', :unitid => nil, :item_location => 'Box 39, Folder 5'},
-#            {:unittitle=>"Men's Basketball", :unitdate=>"1911-2006",
-#              :level => 'series', :unitid => 'Series 4',
-#              :series_number => 4
-#            }
-#          ], @extractor.stack
-#        end
+
 
       end
 

data/test/test_ua023_006_buildings.rb

@@ -86,19 +86,9 @@ class TestMeadUA023_006B < Test::Unit::TestCase
         end
 
         should "extract a series' series number" do
-          assert_equal 3, @extractor.stack[1][:series_number]
+          assert_equal 3, @extractor.stack[1][:series_sequence]
         end
 
-#        should "only extract up to the series level" do
-#          assert_equal [
-#            {:unittitle=>"Food Science Building and Phytotron", :unitdate=>nil,
-#            :level => 'file', :unitid => nil, :item_location => 'Box 1, Folder 8'},
-#            {:unittitle=>"Buildings", :unitdate=>"1968, 1970, undated",
-#              :level => 'series', :unitid => nil,
-#              :series_number => 3
-#            }
-#          ], @extractor.stack
-#        end
 
       end
 

data/test/test_ua023_006_faculty.rb

@@ -87,19 +87,10 @@ class TestMeadUA023_006 < Test::Unit::TestCase
         end
         
         should "extract a series' series number" do
-          assert_equal 2, @extractor.stack[1][:series_number]
+          assert_equal 2, @extractor.stack[1][:series_sequence]
         end
 
-#        should "only extract up to the series level" do
-#          assert_equal [
-#            {:unittitle=>"Faculty and Staff", :unitdate=>nil, :level => 'file',
-#            :unitid => nil, :item_location => 'Box 1, Folder 7'},
-#            {:unittitle=>"Faculty and Staff", :unitdate=>"circa 1900-1988",
-#              :level => 'series', :unitid => nil,
-#              :series_number => 2
-#            }
-#          ], @extractor.stack
-#        end
+
 
       end
 

data/test/test_ua110_041.rb

@@ -86,20 +86,10 @@ class TestMeadUA110_041 < Test::Unit::TestCase
         end
         
         should "extract a series' series number" do
-          assert_equal 1, @extractor.stack[1][:series_number]
+          assert_equal 1, @extractor.stack[1][:series_sequence]
         end
 
-#        should "only extract up to the series level" do
-#          assert_equal [
-#            {:unittitle=>"North Carolina, Wake County, Raleigh: Dix Hill [Dorothea Dix Hospital] Drawings",
-#              :unitdate=>nil, :level => 'file', :unitid => nil,
-#            :item_location => 'Folder 1.1'},
-#            {:unittitle=>"UA 110.041 Series 1: Projects", :unitdate=>"1951-1976",
-#              :level => 'series', :unitid => nil,
-#              :series_number => 1
-#            }
-#          ], @extractor.stack
-#        end
+
 
       end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mead
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 6
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jason Ronallo
@@ -15,22 +15,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-03 00:00:00 -05:00
+date: 2011-02-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 113
+        hash: 3
         segments: 
-        - 1
-        - 4
-        - 3
-        - 1
-        version: 1.4.3.1
+        - 0
+        version: "0"
   requirement: *id001
   prerelease: false
   type: :runtime
@@ -255,6 +252,7 @@ files:
 - bin/meadbfv
 - lib/mead.rb
 - lib/mead/barcode.rb
+- lib/mead/component_part.rb
 - lib/mead/container.rb
 - lib/mead/ead.rb
 - lib/mead/ead_validator.rb
@@ -274,6 +272,7 @@ files:
 - test/fixtures/ua023_031.xml
 - test/helper.rb
 - test/test_barcode.rb
+- test/test_component_part.rb
 - test/test_ead.rb
 - test/test_ead_validator.rb
 - test/test_extractor.rb
@@ -324,6 +323,7 @@ summary: Extract identifiers and metadata from EAD XML.
 test_files: 
 - test/helper.rb
 - test/test_barcode.rb
+- test/test_component_part.rb
 - test/test_ead.rb
 - test/test_ead_validator.rb
 - test/test_extractor.rb