rmarc 0.1.1 → 0.2.0

data/lib/rmarc/constants.rb

@@ -1,4 +1,5 @@
-# $Id: constants.rb,v 1.2 2005/12/02 16:57:26 bpeters Exp $
+#--
+# $Id: constants.rb,v 1.3 2005/12/09 15:26:03 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,13 +18,13 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 module RMARC
   
   class Constants
     
     def Constants.VERSION
-      return "1.0rc1"
+      return "0.1.2"
     end
     
     def Constants.RT

data/lib/rmarc/marc_stream_reader.rb

@@ -1,4 +1,5 @@
-# $Id: marc_stream_reader.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: marc_stream_reader.rb,v 1.5 2005/12/11 15:33:22 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,30 +18,41 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 module RMARC
   
-  # An iterator over a collection of MARC records in ISO 2709 format.
+  # This class provides an iterator over a collection of MARC records in ISO 2709 format.
   #
   # Example usage:
   #
-  # File.open("file.mrc", "r") do |file|
-  # reader = RMARC::MarcStreamReader.new(file)
-  # while reader.has_next
-  #     record = reader.next()
-  # end
+  #   reader = RMARC::MarcStreamReader.new("file.mrc")
+  #   while reader.has_next
+  #       record = reader.next()
+  #   end
+  # 
+  # You can also pass a file object:
+  # 
+  #   input = File.new("file.mrc")
+  #   reader = RMARC::MarcStreamReader.new(input)
+  #   while reader.has_next
+  #       record = reader.next()
+  #   end
+  #   input.close
+  #
+  # Or any other IO subclass. 
+
   class MarcStreamReader
     
-    $input = nil
+    private
     
     def parse_data_field(entry)
       msg = "Unexpected EOF while reading field with tag #{entry.tag}" 
       
-      ind1 = $input.read(1)
+      ind1 = @input.read(1)
       
       raise msg if ind1 == nil
       
-      ind2 = $input.read(1)
+      ind2 = @input.read(1)
       
       raise msg if ind2 == nil
       
@@ -51,12 +63,12 @@ module RMARC
       i = 2
       
       while i < entry.length
-        s = $input.read(1)
+        s = @input.read(1)
         if s == nil
           raise msg
         elsif s == Constants.US        
           field.add(Subfield.new(code, data)) if code != nil
-          code = $input.read(1)
+          code = @input.read(1)
           i += 1
           data = ""
         elsif s == Constants.FT
@@ -69,9 +81,11 @@ module RMARC
       return field  
     end
     
+    public
+    
     # Returns the next record in the iteration.
     def next
-      ldr = $input.read(24)
+      ldr = @input.read(24)
       
       raise "Unexpected EOF while reading record label" if ldr == nil
       
@@ -83,18 +97,18 @@ module RMARC
       
       raise "Invalid directory" if length % 12 != 0
       
-      dir = $input.read(length)
+      dir = @input.read(length)
       
       entries = length / 12
       
-      raise "Expected field terminator" if $input.read(1) != Constants.FT
+      raise "Expected field terminator" if @input.read(1) != Constants.FT
       
       start = 0
       
       entries.times do
         entry = Directory.new(dir[start, 3], dir[start += 3, 4], dir[start += 4, 5])
         if (entry.tag.to_i < 10)
-          data = $input.read(entry.length)
+          data = @input.read(entry.length)
           
           raise "Unexpected EOF while reading field with tag #{entry.tag}" if data == nil
           
@@ -105,14 +119,14 @@ module RMARC
         start += 5
       end
       
-      raise "Expected record terminator" if $input.read(1) != Constants.RT
+      raise "Expected record terminator" if @input.read(1) != Constants.RT
       
       return record
     end
     
     # Returns true if the iteration has more records, false otherwise.
     def has_next
-      if $input.eof == false
+      if @input.eof == false
         return true
       else 
         return false
@@ -121,7 +135,13 @@ module RMARC
     
     # Default constructor    
     def initialize(input)
-      $input = input
+      if input.class == String
+        @input = File.new(input)
+      elsif input.class == File
+        @input = input
+      else
+        throw "Unable to read from path or file"                
+      end
     end
   end
   

data/lib/rmarc/marc_stream_writer.rb

@@ -1,4 +1,5 @@
-# $Id: marc_stream_writer.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: marc_stream_writer.rb,v 1.5 2005/12/11 15:33:22 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,28 +18,26 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+# ++
 module RMARC
   
   # Class for writing MARC record objects in ISO 2709 format.
   # 
-  # The following example reads a file with MARCXML records 
+  # The following example reads a file with MARC XML records 
   # and outputs the record set in ISO 2709 format: 
   #
-  # File.open("file.mrc", "r") do |file|
-  # reader = RMARC::MarcStreamReader.new(file)
-  # writer = RMARC::MarcStreamWriter.new(STDOUT)
-  # while reader.has_next
-  #     record = reader.next()
-  #     writer.write_record(record)
-  # end
+  #   writer = RMARC::MarcStreamWriter.new(STDOUT)
+  #   reader = RMARC::MarcXmlReader.new("file.xml")
+  #   while reader.has_next
+  #       record = reader.next()
+  #       writer.write_record(record)
+  #   end
+
   class MarcStreamWriter
     
-    $output = nil
-    
     # Default constructor.
     def initialize(output)
-      $output = output
+      @output = output
     end
     
     # Writes a single record to the given output stream.
@@ -66,7 +65,7 @@ module RMARC
       leader.base_address = 24 + dir.length
       leader.record_length = leader.base_address + data.length + 1
       
-      $output.write(leader.to_s << dir << data << Constants.RT)
+      @output.write(leader.to_s << dir << data << Constants.RT)
     end  
   end
   

data/lib/rmarc/marc_xml_reader.rb

@@ -1,4 +1,5 @@
-# $Id: marc_xml_reader.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: marc_xml_reader.rb,v 1.5 2005/12/11 15:33:22 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,7 +18,7 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 require 'rexml/document'
 require 'thread'
 
@@ -25,38 +26,32 @@ module RMARC
   
   class RecordStack < SizedQueue
     
-    attr_reader :has_next
-    attr_writer :has_next
+    attr_accessor :has_next
+
   end
   
   class Listener
     
-    $record = nil 
-    $queue = nil 
-    $field = nil  
-    $subfield = nil  
-    $data = nil
-    
     def tag_start(name, attrs)
       re = /(\w+):(\w+)/
       md = re.match(name)
       name = $2 if ($2 != nil)
       case name
       when "collection"
-        $queue.has_next = true
+        @queue.has_next = true
       when "record"
-        $record = Record.new
+        @record = Record.new
       when "controlfield"
-        $field = ControlField.new(attrs["tag"])
+        @field = ControlField.new(attrs["tag"])
       when "datafield"
-        $field = DataField.new(attrs["tag"], attrs["ind1"], attrs["ind2"])
+        @field = DataField.new(attrs["tag"], attrs["ind1"], attrs["ind2"])
       when "subfield"
-        $subfield = Subfield.new(attrs["code"])
+        @subfield = Subfield.new(attrs["code"])
       end
     end
     
     def text(text)
-      $data = text
+      @data = text
     end
     
     def tag_end(name)
@@ -65,23 +60,23 @@ module RMARC
       name = $2 if ($2 != nil)
       case name 
       when "collection"
-        $queue.has_next = false
+        @queue.has_next = false
       when "record"
-        $queue.push($record)
+        @queue.push(@record)
       when "leader"
-        leader = Leader.new($data)
-        $data = ""
-        $record.leader = leader
+        leader = Leader.new(@data)
+        @data = ""
+        @record.leader = leader
       when "controlfield"
-        $field.data = $data
-        $data = ""
-        $record.add($field)
+        @field.data = @data
+        @data = ""
+        @record.add(@field)
       when "datafield"
-        $record.add($field)
+        @record.add(@field)
       when "subfield"
-        $subfield.data = $data
-        $data = ""
-        $field.add($subfield)
+        @subfield.data = @data
+        @data = ""
+        @field.add(@subfield)
       end
     end
     
@@ -89,38 +84,52 @@ module RMARC
     end
     
     def initialize(queue)
-      $queue = queue
+      @queue = queue
     end
     
   end
   
-  # An iterator over a collection of MARC XML records.
+  # This class provides an iterator over a collection of MARC XML records.
   #
   # Example usage:
   #
-  # File.open("test/file.xml", "r") do |file|
-  # reader = RMARC::MarcXmlReader.new(file)
-  # while reader.has_next
-  #     record = reader.next()
-  # end
+  #   reader = RMARC::MarcXmlReader.new("file.xml")
+  #   while reader.has_next
+  #       record = reader.next()
+  #   end
+  #
+  # You can also pass a file object:
+  # 
+  #   input = File.new("file.mrc")
+  #   reader = RMARC::MarcXmlReader.new(input)
+  #   while reader.has_next
+  #       record = reader.next()
+  #   end
+  #   input.close
+  #
+  # Or any other IO subclass.
+  
   class MarcXmlReader
     
-    $queue = nil  
-    $input = nil
-    
     # Default constructor
     def initialize(input)
-      $input = input
-      $queue = RecordStack.new(1)
+      if input.class == String
+        @input = File.new(input)
+      elsif input.class == File
+        @input = input
+      else
+        throw "Unable to read from path or file"                
+      end
+      @queue = RecordStack.new(1)
       Thread.new do
-        producer = Listener.new($queue)
-        REXML::Document.parse_stream($input, producer)
+        producer = Listener.new(@queue)
+        REXML::Document.parse_stream(@input, producer)
       end
     end
     
     # Returns true if the iteration has more records, false otherwise.
     def has_next
-      if ($queue.has_next == false && $queue.empty?) 
+      if (@queue.has_next == false && @queue.empty?) 
         return false
       else
         return true
@@ -129,7 +138,7 @@ module RMARC
     
     # Returns the next record in the iteration.
     def next
-      obj = $queue.pop
+      obj = @queue.pop
       return obj
     end  
   end

data/lib/rmarc/marc_xml_writer.rb

@@ -1,4 +1,5 @@
-# $Id: marc_xml_writer.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: marc_xml_writer.rb,v 1.5 2005/12/11 15:33:22 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,39 +18,65 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 require 'rexml/document'
 
 module RMARC
-
+  
   # Class for writing MARC record objects in MARC XML format.
-  #  
-  # writer = RMARC::MarcXmlWriter.new(STDOUT)
-  # File.open("file.mrc", "r") do |file|
-  # reader = RMARC::MarcStreamReader.new(file)
-  # writer.start_document        
-  # while reader.has_next
-  #     record = reader.next()
-  #     writer.write_record(record)
-  # end
-  # writer.end_document
+  # 
+  # The following example reads a file with MARC records 
+  # and outputs the record set in MARC XML format: 
+  # 
+  #   writer = RMARC::MarcXmlWriter.new(STDOUT)
+  #   reader = RMARC::MarcStreamReader.new("file.mrc")
+  #   writer.start_document        
+  #   while reader.has_next
+  #       record = reader.next()
+  #       writer.write_record(record)
+  #   end
+  #   writer.end_document
+  #
+  # See: http://www.loc.gov/standards/marcxml for more information about MARC XML.
+  
   class MarcXmlWriter
     
-    $output = nil
-    
     # Default constructor.
     def initialize(output)
-      $output = output
+      @output = output
     end
     
-    # Writes the XML declaration and the collection start tag.
-    def start_document
-      $output.write(REXML::XMLDecl.new)
-      $output.write("\n<collection xmlns=\"http://www.loc.gov/MARC21/slim\">\n  ")
+    # Writes the XML declaration and the collection start tag:
+    #
+    #   <?xml version='1.0' encoding='UTF-8'?>
+    #   <collection xmlns="http://www.loc.gov/MARC21/slim">
+    #
+    # The default encoding is UTF-8.
+    def start_document(encoding = nil)
+      decl = REXML::XMLDecl.new
+      if encoding
+        decl.encoding = encoding
+      else
+        decl.encoding = "UTF-8"
+      end
+      @output.write(decl)
+      @output.write("\n<collection xmlns=\"http://www.loc.gov/MARC21/slim\">")
     end
     
-    # Writes a single record element.
+    # Writes a single record element:
+    #
+    #   <record>
+    #     <leader>00714cam a2200205 a 4500</leader>
+    #     <controlfield tag='001'>12883376</controlfield>
+    #     ...
+    #     <datafield tag='245' ind1='1' ind2='0'>
+    #       <subfield code='a'>Summerland /</subfield>
+    #       <subfield code='c'>Michael Chabon.</subfield>
+    #     </datafield>
+    #     ...
+    #   </record>    
     def write_record(record)
+      @output.write("\n  ")
       rec = REXML::Element.new('record')
       ldr = REXML::Element.new('leader')
       ldr.add_text(record.leader.to_s)
@@ -75,12 +102,14 @@ module RMARC
           rec.add_element(fld)
         end
       }
-      rec.write($output, 1)
+      rec.write(@output, 1)
     end
     
-    # Writes the collection end tag. 
+    # Writes the collection end tag:
+    #
+    #   </collection> 
     def end_document
-      $output.write("\n</collection>")
+      @output.write("\n</collection>")
     end
     
   end

data/lib/rmarc/model/control_field.rb

@@ -1,4 +1,5 @@
-# $Id: control_field.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: control_field.rb,v 1.4 2005/12/09 15:25:52 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,16 +18,16 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 require 'rmarc/model/variable_field'
 
 module RMARC
   
-  # Represents a control field in a MARC record.
+  # This class represents a control field in a MARC record.
+
   class ControlField < VariableField
-    attr_reader :data
-    
-    attr_writer :data
+  
+    attr_accessor :data
     
     def initialize(tag, data = nil)
       super(tag)
@@ -34,6 +35,10 @@ module RMARC
     end
     
     # Returns a string representaiton for a conctrol field.
+    #
+    # Example:
+    # 
+    #   001 11939876
     def to_s
       super + "#@data"
     end

data/lib/rmarc/model/data_field.rb

@@ -1,4 +1,5 @@
-## $Id: data_field.rb,v 1.3 2005/12/05 19:37:09 bpeters Exp $
+#--
+# $Id: data_field.rb,v 1.4 2005/12/09 15:25:52 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,19 +18,31 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 require 'rmarc/model/variable_field'
 
 module RMARC
   
-  # Represents a data field in a MARC record. The module Enumerable is 
-  # mixed in to enable searching within subfields using each.
+  # This class represents a data field in a MARC record. 
+  #
+  # The module Enumerable is included to enable searching within subfields using each.
+  #
+  # To iterate over all subfields:
+  #
+  #   field.each { |s| print s }
+  #
+  # To retrieve subfield with code 'a':
+  #
+  #   field.find {|s| s.code == 'a'}
+  #
+  # To retrieve subfields with code 'a' through 'c':
+  #
+  #   field.find_all {|s| ('a'..'c' === s.code)}
+
   class DataField < VariableField
     include Enumerable
     
-    attr_reader :ind1, :ind2, :subfields
-    
-    attr_writer :ind1, :ind2, :subfields
+    attr_accessor :ind1, :ind2, :subfields
     
     def initialize(tag, ind1, ind2)
       super(tag)
@@ -57,6 +70,10 @@ module RMARC
     end
     
     # Returns a string representation of the data field.
+    #
+    # Example:
+    # 
+    #   100 1 $aChabon, Michael.
     def to_s
       a = "" 
       a << super << @ind1 << @ind2

data/lib/rmarc/model/directory.rb

@@ -1,4 +1,5 @@
-# $Id: directory.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: directory.rb,v 1.4 2005/12/09 15:25:52 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,15 +18,15 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 module RMARC
   
-  # Represents a directory in a MARC record.
+  # This class represents a directory in a MARC record.
+
   class Directory
-    attr_reader :tag, :length, :start
-    
-    attr_writer  :tag, :length, :start
-    
+  
+    attr_accessor :tag, :length, :start
+
     def initialize(tag, length, start)
       @tag = tag
       @length = length.to_i

data/lib/rmarc/model/leader.rb

@@ -1,4 +1,5 @@
-# $Id: leader.rb,v 1.4 2005/12/07 19:50:35 bpeters Exp $
+#--
+# $Id: leader.rb,v 1.5 2005/12/09 15:25:52 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,15 +18,14 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 module RMARC
   
-  # Represents a leader or record label in a MARC record.
+  # This class represents a leader or record label in a MARC record.
+  
   class Leader
     
-    attr_reader :record_length, :record_status, :record_type, :impl_defined1, :char_coding, :indicator_count, :subfield_code_length, :base_address, :impl_defined2, :entry_map
-    
-    attr_writer :record_length, :record_status, :record_type, :impl_defined1, :char_coding, :indicator_count, :subfield_code_length, :base_address, :impl_defined2, :entry_map
+    attr_accessor :record_length, :record_status, :record_type, :impl_defined1, :char_coding, :indicator_count, :subfield_code_length, :base_address, :impl_defined2, :entry_map
     
     def initialize(ldr = nil)
       if (ldr == nil)
@@ -53,7 +53,11 @@ module RMARC
       end
     end
     
-    # Returns a string representation for a MARC record.
+    # Returns a string representation for a leader.
+    #
+    # Example:
+    #
+    #   00714cam a2200205 a 4500
     def to_s
     "%05d" % @record_length + 
     "#@record_status#@record_type#@impl_defined1#@char_coding" +

data/lib/rmarc/model/record.rb

@@ -1,4 +1,5 @@
-# $Id: record.rb,v 1.3 2005/12/05 19:37:09 bpeters Exp $
+#--
+# $Id: record.rb,v 1.5 2005/12/11 15:32:37 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,18 +18,25 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 module RMARC
   
-  # Represents a MARC record. The module Enumerable is 
-  # mixed in to enable searching within variable fields 
-  # using each.
+  # This class represents a MARC record. 
+  #
+  # The module Enumerable is included to enable searching within variable fields using each.
+  #
+  # To iterate over all fields:
+  #
+  #   record.each { |f| print f }
+  #
+  # To retrieve the data field for tag 245:
+  #
+  #   field = record.find {|f| f.tag == '245'}
+  
   class Record
     include Enumerable
     
-    attr_reader :leader, :fields
-    
-    attr_writer :leader, :fields
+    attr_accessor :leader, :fields
     
     def initialize(leader = nil)
       @leader = leader
@@ -45,8 +53,7 @@ module RMARC
       @fields.delete(fld)
     end
     
-    # Implements Enumarable.each to provide an iterator over all 
-    # variable fields.
+    # Implements Enumarable.each to provide an iterator over all variable fields.
     def each
       for field in @fields
         yield field
@@ -54,6 +61,26 @@ module RMARC
     end
     
     # Returns a string representation of the record.
+    #
+    # Example:
+    #
+    #   Leader: 00714cam a2200205 a 4500
+    #   001 12883376
+    #   005 20030616111422.0
+    #   008 020805s2002    nyu    j      000 1 eng  
+    #   020   $a0786808772
+    #   020   $a0786816155 (pbk.)
+    #   040   $aDLC$cDLC$dDLC
+    #   100 1 $aChabon, Michael.
+    #   245 10$aSummerland /$cMichael Chabon.
+    #   250   $a1st ed.
+    #   260   $aNew York :$bMiramax Books/Hyperion Books for Children,$cc2002.
+    #   300   $a500 p. ;$c22 cm.
+    #   650  1$aFantasy.
+    #   650  1$aBaseball$vFiction.
+    #   650  1$aMagic$vFiction.
+    #
+    # Use RMARC::MarcStreamWriter to serialize records to ISO 2709 format.
     def to_s
       a = "Leader: #{@leader.to_s}\n"
       @fields.each { |f| a << "#{f.to_s}\n" }

data/lib/rmarc/model/subfield.rb

@@ -1,4 +1,5 @@
-# $Id: subfield.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: subfield.rb,v 1.4 2005/12/09 15:25:52 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,20 +18,26 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 module RMARC
   
-  # Represents a subfield in a MARC record.
+  # This class represents a subfield in a MARC record.
+
   class Subfield 
-    attr_reader :code, :data
-    
-    attr_writer :code, :data
+
+    attr_accessor :code, :data
     
+    # Default constructor
     def initialize(code, data = nil)
       @code = code
       @data = data
     end
     
+    # Returns a string representation for a subfield.
+    #
+    # Example:
+    #
+    #   $aChabon, Michael.
     def to_s
     "$#@code#@data"
     end

data/lib/rmarc/model/variable_field.rb

@@ -1,4 +1,5 @@
-# $Id: variable_field.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#--
+# $Id: variable_field.rb,v 1.4 2005/12/09 15:25:52 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,19 +18,21 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 module RMARC
   
-  # Represents a variable field in a MARC record.
+  # This class represents a variable field in a MARC record.
+
   class VariableField
-    attr_reader :tag
-    
-    attr_writer :tag
+
+    attr_accessor :tag
     
+    # Default constructor
     def initialize(tag)
       @tag = tag
     end
     
+    # Returns a string representation for the tag value.
     def to_s
     "#@tag "
     end

data/test/test_model.rb

@@ -1,4 +1,5 @@
-# $Id: test_model.rb,v 1.1 2005/12/07 19:56:56 bpeters Exp $
+#--
+# $Id: test_model.rb,v 1.3 2005/12/10 16:27:52 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,7 +18,7 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 $: << File.dirname(__FILE__) + "/.." << File.dirname(__FILE__) + "/../lib"
 
 require 'test/unit'
@@ -38,17 +39,26 @@ class TestModel < Test::Unit::TestCase
   end
   
   def test_data_field
-    field = RMARC::DataField.new("245", "1", "0")
+    field = RMARC::DataField.new("245", "1", "0")    
     assert_equal("245", field.tag)
     assert_equal("1", field.ind1)
     assert_equal("0", field.ind2)
     assert_equal(0, field.subfields.length)
+    
     subfield = RMARC::Subfield.new("a", "Summerland")
     field.add(subfield)
     assert_equal(1, field.subfields.length)
+    
     subfield = RMARC::Subfield.new("c", "Michael Chabon")
     field.add(subfield)
     assert_equal(2, field.subfields.length)
+    
+    author = field.find {|s| s.code == 'c'}
+    assert_equal("Michael Chabon", author.data)
+    
+    all = field.find_all {|s| ('a'..'e' === s.code)}
+    assert_equal(2, all.length)
+    
     field.remove(subfield)
     assert_equal(1, field.subfields.length)
     assert_equal("a", field.subfields.last.code)
@@ -68,11 +78,14 @@ class TestModel < Test::Unit::TestCase
     field = RMARC::ControlField.new("001", "12883376")
     record.add(field)
     assert_equal(1, record.fields.length)
+    
     field = RMARC::DataField.new("245", "1", "0")
     record.add(field)
-    assert_equal(2, record.fields.length)
-    record.remove(field)
-    assert_equal("001", record.fields.last.tag)
+    df = record.find {|f| f.tag == '245'}
+    assert_equal('245', df.tag)
+    
+    record.remove(field)    
+    assert_equal('001', record.fields.last.tag)
   end
   
 end

data/test/test_reader.rb

@@ -1,4 +1,5 @@
-# $Id: test_reader.rb,v 1.1 2005/12/07 19:56:56 bpeters Exp $
+#--
+# $Id: test_reader.rb,v 1.3 2005/12/09 15:30:46 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,32 +18,30 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 $: << File.dirname(__FILE__) + "/.." << File.dirname(__FILE__) + "/../lib"
 
 require 'test/unit'
 require 'rmarc'
 
-class TestMarcReader < Test::Unit::TestCase
+class TestReader < Test::Unit::TestCase
   
   def test_parse_marc
     assert_nothing_raised() {
-      File.open("test/chabon.mrc", "r") do |file|
-        reader = RMARC::MarcStreamReader.new(file)
-        while reader.has_next
-          record = reader.next()
-        end
+      reader = RMARC::MarcStreamReader.new("test/chabon.mrc")
+      while reader.has_next
+        record = reader.next()
+        puts record.to_s
       end
     }
   end
   
   def test_parse_marc_xml
     assert_nothing_raised() {
-      File.open("test/chabon.xml", "r") do |file|
-        reader = RMARC::MarcXmlReader.new(file)
-        while reader.has_next
-          record = reader.next()
-        end
+      reader = RMARC::MarcXmlReader.new("test/chabon.xml")
+      while reader.has_next
+        record = reader.next()
+        puts record.to_s
       end
     }
   end

data/test/test_writer.rb

@@ -1,4 +1,5 @@
-# $Id: test_writer.rb,v 1.1 2005/12/07 19:56:56 bpeters Exp $
+#--
+# $Id: test_writer.rb,v 1.3 2005/12/09 15:30:46 bpeters Exp $
 #
 # Copyright (c) 2005 Bas Peters
 #
@@ -17,13 +18,13 @@
 # You should have received a copy of the GNU Lesser General Public 
 # License along with RMARC; if not, write to the Free Software
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
-#
+#++
 $: << File.dirname(__FILE__) + "/.." << File.dirname(__FILE__) + "/../lib"
 
 require 'test/unit'
 require 'rmarc'
 
-class TestMarcWriter < Test::Unit::TestCase
+class TestWriter < Test::Unit::TestCase
 
   def test_write_marc
     assert_nothing_raised() {

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: rmarc
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2005-12-07
+  version: 0.2.0
+date: 2005-12-13
 summary: RMARC is a library for working with MARC and MARC XML data in Ruby
 require_paths: 
   - lib
@@ -15,7 +15,7 @@ description:
 autorequire: 
 default_executable: 
 bindir: bin
-has_rdoc: false
+has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
     -