marc 0.0.7 → 0.0.8

data/lib/marc.rb

@@ -1,7 +1,7 @@
 require 'marc/constants'
 require 'marc/record'
-require 'marc/field'
-require 'marc/control'
+require 'marc/datafield'
+require 'marc/controlfield'
 require 'marc/subfield'
 require 'marc/reader'
 require 'marc/writer'

data/lib/marc/{control.rb → controlfield.rb}

@@ -1,10 +1,10 @@
 module MARC
 
-  # A class for representing fields with a tag less than 010.
-  # Ordinary MARC::Field objects are for fields with tags >= 010
-  # which have indicators and subfields.
+  # MARC records contain control fields, each of which has a 
+  # tag and value. Tags for control fields must be in the
+  # 001-009 range.
 
-  class Control
+  class ControlField
 
     # the tag value (007, 008, etc)
     attr_accessor :tag
@@ -23,6 +23,17 @@ module MARC
       end
     end
 
+    # Two control fields are equal if their tags and values are equal.
+
+    def ==(other)
+      if @tag != other.tag
+        return false 
+      elsif @value != other.value
+        return false
+      end
+      return true
+    end
+
     def to_s
       return "#{tag} #{value}" 
     end

data/lib/marc/{field.rb → datafield.rb}

@@ -3,12 +3,11 @@ require 'marc/record'
 
 module MARC
 
-  # MARC records are made up of fields, each of which has a tag, 
-  # indicators and subfields. If the tag is between 000-009 it is 
-  # known as a control field, and actually does not have any 
-  # indicators.
+  # MARC records contain data fields, each of which has a tag, 
+  # indicators and subfields. Tags for data fields must be in
+  # the range 010-999.
 
-  class Field
+  class DataField
     include Enumerable
 
     # The tag for the field
@@ -28,14 +27,14 @@ module MARC
     # Subfields are passed in as comma separated list of 
     # MARC::Subfield objects, 
     # 
-    #   field = MARC::Field.new('245','0','0',
+    #   field = MARC::DataField.new('245','0','0',
     #     MARC::Subfield.new('a', 'Consilience :'),
     #     MARC::Subfield.new('b', 'the unity of knowledge ',
     #     MARC::Subfield.new('c', 'by Edward O. Wilson.'))
     # 
     # or using a shorthand:
     # 
-    #   field = MARC::Field.new('245','0','0',
+    #   field = MARC::DataField.new('245','0','0',
     #     ['a', 'Consilience :'],['b','the unity of knowledge ',
     #     ['c', 'by Edward O. Wilson.'] )
 

data/lib/marc/reader.rb

@@ -103,11 +103,11 @@ module MARC
         # remove end of field
         field_data.delete!(END_OF_FIELD)
          
-        # add a control field or variable field
+        # add a control field or data field
         if tag < '010'
-          record.append(MARC::Control.new(tag,field_data))
+          record.append(MARC::ControlField.new(tag,field_data))
         else
-          field = MARC::Field.new(tag)
+          field = MARC::DataField.new(tag)
 
           # get all subfields
           subfields = field_data.split(SUBFIELD_INDICATOR)

data/lib/marc/subfield.rb

@@ -20,7 +20,7 @@ module MARC
     end
 
     def to_s
-      return "$#{code}#{value}"
+      return "$#{code} #{value} "
     end
   end
 end

data/lib/marc/writer.rb

@@ -43,12 +43,12 @@ module MARC
 
         # encode the field
         field_data = ''
-        if field.class == MARC::Field 
+        if field.class == MARC::DataField 
           field_data = field.indicator1 + field.indicator2 
           for s in field.subfields
             field_data += SUBFIELD_INDICATOR + s.code + s.value
           end
-        elsif field.class == MARC::Control
+        elsif field.class == MARC::ControlField
           field_data = field.value
         end
         field_data += END_OF_FIELD

data/lib/marc/xmlreader.rb

@@ -24,7 +24,7 @@ module MARC
     private
 
     def strip_ns(str)
-      return str.sub!(/^.*:/, '')
+      return str.sub(/^.*:/, '')
     end
 
     # will accept parse events until a record has been built up
@@ -50,10 +50,10 @@ module MARC
           case strip_ns(event[0])
           when 'controlfield'
             text = ''
-            control_field = MARC::Control.new(attrs['tag'])
+            control_field = MARC::ControlField.new(attrs['tag'])
           when 'datafield'
             text = ''
-            data_field = MARC::Field.new(attrs['tag'], attrs['ind1'], 
+            data_field = MARC::DataField.new(attrs['tag'], attrs['ind1'], 
               attrs['ind2'])
           when 'subfield'
             text = ''

data/lib/marc/xmlwriter.rb

@@ -20,9 +20,9 @@ module MARC
       
       @fh.write("<?xml version='1.0'?>")
       
-      @fh.write("<marc:collection xmlns:marc='" + MARC_NS + "' " \
-      + "xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' " \
-      + "xsi:schemaLocation='" + MARC_NS + " " + MARC_XSD + "'>")
+      @fh.write("<collection xmlns='" + MARC_NS + "' " +
+        "xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' " +
+        "xsi:schemaLocation='" + MARC_NS + " " + MARC_XSD + "'>")
     end
     
     
@@ -36,7 +36,7 @@ module MARC
     # close underlying filehandle
     
     def close
-      @fh.write("</marc:collection>")
+      @fh.write("</collection>")
       @fh.close
     end
 
@@ -45,38 +45,38 @@ module MARC
     # and returns a REXML::Document for the XML serialization
 
     def self.encode(record)
-      root = "<marc:record xmlns:marc='" + MARC_NS + "'/>"
+      root = "<record/>"
       doc = REXML::Document.new root
 
       # MARCXML is particular about this; ILSes aren't
       record.leader[20..24] = "4500"
       
-      leader = REXML::Element.new "marc:leader"
+      leader = REXML::Element.new "leader"
       leader.add_text record.leader
       doc.root.add_element leader
       
       for field in record.fields
-        if field.class == MARC::Field 
-          dfElem = REXML::Element.new "marc:datafield"
-          dfElem.add_attributes({
+        if field.class == MARC::DataField 
+          datafield_elem = REXML::Element.new "datafield"
+          datafield_elem.add_attributes({
             "tag"=>field.tag,
             "ind1"=>field.indicator1,
             "ind2"=>field.indicator2
           })
 
           for subfield in field.subfields
-            sfElem = REXML::Element.new "marc:subfield"
-            sfElem.add_attribute("code", subfield.code)
-            sfElem.add_text subfield.value
-            dfElem.add_element sfElem
+            subfield_element = REXML::Element.new "subfield"
+            subfield_element.add_attribute("code", subfield.code)
+            subfield_element.add_text subfield.value
+            datafield_elem.add_element subfield_element
           end
           
-          doc.root.add_element dfElem
-        elsif field.class == MARC::Control
-          cfElem = REXML::Element.new "marc:controlfield"
-          cfElem.add_attribute("tag", field.tag)
-          cfElem.add_text field.value
-          doc.root.add_element cfElem
+          doc.root.add_element datafield_elem
+        elsif field.class == MARC::ControlField
+          control_element = REXML::Element.new "controlfield"
+          control_element.add_attribute("tag", field.tag)
+          control_element.add_text field.value
+          doc.root.add_element control_element
         end
       end
       

data/test/foo.xml

@@ -0,0 +1 @@
+<?xml version='1.0'?><collection xmlns='http://www.loc.gov/MARC21/slim' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://www.loc.gov/MARC21/slim http://www.loc.gov/standards/marcxml/schema/MARC21slim.xsd'><record><leader>00925njm  22002777a 4500</leader><controlfield tag='007'>sdubumennmplu</controlfield><datafield tag='245' ind1='0' ind2='4'><subfield code='a'>The Great Ray Charles</subfield><subfield code='h'>[sound recording].</subfield></datafield></record></collection>

data/test/tc_controlfield.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'marc'
+
+class TestField < Test::Unit::TestCase
+
+    def test_control
+        control = MARC::ControlField.new('005', 'foobarbaz')
+        assert_equal(control.to_s, '005 foobarbaz')
+    end
+
+    def test_field_as_control
+        assert_raise(MARC::Exception) do
+            # can't have a field with a tag < 010
+            field = MARC::DataField.new('007') 
+        end
+    end
+
+    def test_control_as_field
+        assert_raise(MARC::Exception) do
+            # can't have a control with a tag > 009
+            f = MARC::ControlField.new('245')
+        end
+    end
+end
+

data/test/tc_datafield.rb

@@ -0,0 +1,62 @@
+require 'test/unit'
+require 'marc'
+
+class TestField < Test::Unit::TestCase
+
+    def test_tag
+        f1 = MARC::DataField.new('100')
+        assert_equal('100', f1.tag)
+        f2 = MARC::DataField.new(tag='100')
+        assert_equal('100', f2.tag)
+        assert_equal(f1, f2)
+        f3 = MARC::DataField.new('245')
+        assert_not_equal(f1, f3)
+    end
+
+    def test_indicators
+        f1 = MARC::DataField.new('100', '0', '1')
+        assert_equal('0', f1.indicator1)
+        assert_equal('1', f1.indicator2)
+        f2 = MARC::DataField.new(tag='100',i1='0',i2='1')
+        assert_equal('0', f2.indicator1)
+        assert_equal('1', f2.indicator2)
+        assert_equal(f1, f2)
+        f3 = MARC::DataField.new(tag='100', i1='1', i2='1')
+        assert_not_equal(f1, f3)
+    end
+
+    def test_subfields
+        f1 = MARC::DataField.new('100', '0', '1', 
+            MARC::Subfield.new('a', 'Foo'),
+            MARC::Subfield.new('b', 'Bar') )
+        assert_equal("100 01 $a Foo $b Bar ", f1.to_s)
+        f2 = MARC::DataField.new('100', '0', '1', 
+            MARC::Subfield.new('a', 'Foo'),
+            MARC::Subfield.new('b', 'Bar') )
+        assert_equal(f1,f2)
+        f3 = MARC::DataField.new('100', '0', '1', 
+            MARC::Subfield.new('a', 'Foo'),
+            MARC::Subfield.new('b', 'Bez') )
+        assert_not_equal(f1,f3)
+    end
+
+    def test_subfield_shorthand
+        f  = MARC::DataField.new('100', '0', '1', ['a', 'Foo'], ['b', 'Bar'])
+        assert_equal('100 01 $a Foo $b Bar ', f.to_s)
+    end
+            
+
+    def test_iterator
+        field = MARC::DataField.new('100', '0', '1', ['a', 'Foo'],['b', 'Bar'],
+            ['a', 'Bez'])
+        count = 0
+        field.each {|x| count += 1}
+        assert_equal(count,3)
+    end
+    
+    def test_lookup_shorthand
+        f  = MARC::DataField.new('100', '0', '1', ['a', 'Foo'], ['b', 'Bar'])
+        assert_equal(f['b'], 'Bar')
+    end
+
+end

data/test/tc_record.rb

@@ -24,26 +24,26 @@ class TestRecord < Test::Unit::TestCase
         raw = IO.read('test/one.dat')
         r = MARC::Record::new_from_marc(raw)
         assert_equal(r.class, MARC::Record)
-        assert_equal(r.leader,'00755cam  22002414a 4500')
+        assert_equal(r.leader, '00755cam  22002414a 4500')
         assert_equal(r.fields.length(), 18)
         assert_equal(r.find {|f| f.tag == '245'}.to_s,
-            '245 10 $aActivePerl with ASP and ADO /$cTobias Martinsson.')
+            '245 10 $a ActivePerl with ASP and ADO / $c Tobias Martinsson. ')
     end
 
     def test_decode_forgiving
         raw = IO.read('test/one.dat')
         r = MARC::Record::new_from_marc(raw, :forgiving => true)
         assert_equal(r.class, MARC::Record)
-        assert_equal(r.leader,'00755cam  22002414a 4500')
+        assert_equal(r.leader, '00755cam  22002414a 4500')
         assert_equal(r.fields.length(), 18)
         assert_equal(r.find {|f| f.tag == '245'}.to_s,
-            '245 10 $aActivePerl with ASP and ADO /$cTobias Martinsson.')
+            '245 10 $a ActivePerl with ASP and ADO / $c Tobias Martinsson. ')
     end
 
     def test_encode
         r1 = MARC::Record.new()
-        r1.append(MARC::Field.new('100','2','0', ['a','Thomas, Dave']))
-        r1.append(MARC::Field.new('245','0','0', ['a','Pragmatic Programmer']))
+        r1.append(MARC::DataField.new('100', '2', '0', ['a', 'Thomas, Dave']))
+        r1.append(MARC::DataField.new('245', '0', '0', ['a', 'Pragmatic Programmer']))
         raw = r1.to_marc()
         r2 = MARC::Record::new_from_marc(raw)
         assert_equal(r1, r2)
@@ -56,8 +56,8 @@ class TestRecord < Test::Unit::TestCase
 
     def get_record
         r = MARC::Record.new()
-        r.append(MARC::Field.new('100', '2', '0', ['a', 'Thomas, Dave'])) 
-        r.append(MARC::Field.new('245', '0', '4', ['The Pragmatic Programmer']))
+        r.append(MARC::DataField.new('100', '2', '0', ['a', 'Thomas, Dave'])) 
+        r.append(MARC::DataField.new('245', '0', '4', ['The Pragmatic Programmer']))
         return r
     end
 

data/test/tc_subfield.rb

@@ -4,14 +4,14 @@ require 'marc/subfield'
 class SubfieldTest < Test::Unit::TestCase
 
     def test_ok
-        s = MARC::Subfield.new('a','foo')
-        assert_equal(s.code,'a')
-        assert_equal(s.value,'foo')
+        s = MARC::Subfield.new('a', 'foo')
+        assert_equal(s.code, 'a')
+        assert_equal(s.value, 'foo')
     end
 
     def test_equals
-        s1 =MARC::Subfield.new('a','foo')
-        s2 =MARC::Subfield.new('a','foo')
+        s1 =MARC::Subfield.new('a', 'foo')
+        s2 =MARC::Subfield.new('a', 'foo')
         assert_equal(s1,s2)
     end
 

data/test/tc_writer.rb

@@ -6,7 +6,7 @@ class WriterTest < Test::Unit::TestCase
     def test_writer()
         writer = MARC::Writer.new('test/writer.dat')
         record = MARC::Record.new()
-        record.append(MARC::Field.new('245', '0', '1', ['a','foo']))
+        record.append(MARC::DataField.new('245', '0', '1', ['a', 'foo']))
         writer.write(record)
         writer.close()
 

data/test/tc_xmlreader.rb

@@ -3,7 +3,7 @@ require 'marc'
 
 class XMLReaderTest < Test::Unit::TestCase
 
-  def test_batch
+  def otest_batch
     reader = MARC::XMLReader.new('test/batch.xml')
     count = 0
     for record in reader
@@ -16,9 +16,9 @@ class XMLReaderTest < Test::Unit::TestCase
   def test_read_write
     record1 = MARC::Record.new
     record1.leader =  '00925njm  22002777a 4500'
-    record1.append MARC::Control.new('007', 'sdubumennmplu')
-    record1.append MARC::Field.new('245','0','4', 
-      ['a','The Great Ray Charles'], ['h', '[sound recording].'])
+    record1.append MARC::ControlField.new('007', 'sdubumennmplu')
+    record1.append MARC::DataField.new('245', '0', '4', 
+      ['a', 'The Great Ray Charles'], ['h', '[sound recording].'])
 
     writer = MARC::XMLWriter.new('test/foo.xml')
     writer.write(record1)
@@ -28,7 +28,7 @@ class XMLReaderTest < Test::Unit::TestCase
     record2 = reader.entries[0]
     assert_equal(record1, record2)
 
-    File.unlink('test/foo.xml')
+    #File.unlink('test/foo.xml')
   end
 end
 

data/test/ts_marc.rb

@@ -6,7 +6,8 @@ $LOAD_PATH.unshift("lib")
 
 require 'test/unit'
 require 'test/tc_subfield'
-require 'test/tc_field'
+require 'test/tc_datafield'
+require 'test/tc_controlfield'
 require 'test/tc_record'
 require 'test/tc_reader'
 require 'test/tc_writer'

metadata

@@ -3,11 +3,11 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: marc
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
-date: 2006-01-02 00:00:00 -06:00
+  version: 0.0.8
+date: 2006-01-16 00:00:00 -05:00
 summary: A ruby library for working with Machine Readable Cataloging
 require_paths: 
-  - lib
+- lib
 email: ehs@pobox.com
 homepage: http://www.textualize.com/ruby_marc
 rubyforge_project: 
@@ -18,45 +18,52 @@ bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
 signing_key: 
 cert_chain: 
 authors: 
-  - Ed Summers
+- Ed Summers
 files: 
-  - lib/marc
-  - lib/marc.rb
-  - lib/marc/constants.rb
-  - lib/marc/control.rb
-  - lib/marc/exception.rb
-  - lib/marc/field.rb
-  - lib/marc/reader.rb
-  - lib/marc/record.rb
-  - lib/marc/subfield.rb
-  - lib/marc/writer.rb
-  - lib/marc/xmlreader.rb
-  - lib/marc/xmlwriter.rb
-  - test/batch.dat
-  - test/batch.xml
-  - test/one.dat
-  - test/tc_field.rb
-  - test/tc_reader.rb
-  - test/tc_record.rb
-  - test/tc_subfield.rb
-  - test/tc_writer.rb
-  - test/tc_xmlreader.rb
-  - test/tc_xmlwriter.rb
-  - test/ts_marc.rb
+- lib/marc
+- lib/marc.rb
+- lib/marc/writer.rb
+- lib/marc/subfield.rb
+- lib/marc/datafield.rb
+- lib/marc/record.rb
+- lib/marc/constants.rb
+- lib/marc/xmlreader.rb
+- lib/marc/xmlwriter.rb
+- lib/marc/exception.rb
+- lib/marc/controlfield.rb
+- lib/marc/reader.rb
+- test/batch.dat
+- test/batch.xml
+- test/tc_datafield.rb
+- test/tc_reader.rb
+- test/foo.xml
+- test/tc_writer.rb
+- test/tc_controlfield.rb
+- test/tc_subfield.rb
+- test/one.dat
+- test/tc_xmlreader.rb
+- test/tc_xmlwriter.rb
+- test/tc_record.rb
+- test/ts_marc.rb
 test_files: 
-  - test/ts_marc.rb
+- test/ts_marc.rb
 rdoc_options: []
+
 extra_rdoc_files: []
+
 executables: []
+
 extensions: []
+
 requirements: []
-dependencies: []
+
+dependencies: []
+

data/test/tc_field.rb

@@ -1,81 +0,0 @@
-require 'test/unit'
-require 'marc'
-
-class TestField < Test::Unit::TestCase
-
-    def test_tag
-        f1 = MARC::Field.new('100')
-        assert_equal('100', f1.tag)
-        f2 = MARC::Field.new(tag='100')
-        assert_equal('100', f2.tag)
-        assert_equal(f1, f2)
-        f3 = MARC::Field.new('245')
-        assert_not_equal(f1, f3)
-    end
-
-    def test_indicators
-        f1 = MARC::Field.new('100', '0', '1')
-        assert_equal('0', f1.indicator1)
-        assert_equal('1', f1.indicator2)
-        f2 = MARC::Field.new(tag='100',i1='0',i2='1')
-        assert_equal('0', f2.indicator1)
-        assert_equal('1', f2.indicator2)
-        assert_equal(f1, f2)
-        f3 = MARC::Field.new(tag='100', i1='1', i2='1')
-        assert_not_equal(f1, f3)
-    end
-
-    def test_subfields
-        f1 = MARC::Field.new('100', '0', '1', 
-            MARC::Subfield.new('a', 'Foo'),
-            MARC::Subfield.new('b', 'Bar') )
-        assert_equal("100 01 $aFoo$bBar", f1.to_s)
-        f2 = MARC::Field.new('100', '0', '1', 
-            MARC::Subfield.new('a', 'Foo'),
-            MARC::Subfield.new('b', 'Bar') )
-        assert_equal(f1,f2)
-        f3 = MARC::Field.new('100', '0', '1', 
-            MARC::Subfield.new('a', 'Foo'),
-            MARC::Subfield.new('b', 'Bez') )
-        assert_not_equal(f1,f3)
-    end
-
-    def test_subfield_shorthand
-        f  = MARC::Field.new('100', '0', '1', ['a', 'Foo'], ['b', 'Bar'])
-        assert_equal('100 01 $aFoo$bBar', f.to_s)
-    end
-            
-
-    def test_iterator
-        field = MARC::Field.new('100','0','1', ['a', 'Foo'],['b', 'Bar'],
-            ['a', 'Bez'])
-        count = 0
-        field.each {|x| count += 1}
-        assert_equal(count,3)
-    end
-    
-    def test_lookup_shorthand
-        f  = MARC::Field.new('100', '0', '1', ['a', 'Foo'], ['b', 'Bar'])
-        assert_equal(f['b'], 'Bar')
-    end
-
-    def test_control
-        control = MARC::Control.new('005','foobarbaz')
-        assert_equal(control.to_s,'005 foobarbaz')
-    end
-
-    def test_field_as_control
-        assert_raise(MARC::Exception) do
-            # can't have a field with a tag < 010
-            field = MARC::Field.new('007') 
-        end
-    end
-
-    def test_control_as_field
-        assert_raise(MARC::Exception) do
-            # can't have a control with a tag > 009
-            f = MARC::Control.new('245')
-        end
-    end
-
-end