rmarc 0.1.1

data/lib/rmarc.rb

@@ -0,0 +1,14 @@
+require 'rexml/document'
+
+require 'rmarc/constants'
+require 'rmarc/marc_stream_reader'
+require 'rmarc/marc_stream_writer'
+require 'rmarc/marc_xml_reader'
+require 'rmarc/marc_xml_writer'
+require 'rmarc/model/control_field'
+require 'rmarc/model/data_field'
+require 'rmarc/model/directory'
+require 'rmarc/model/leader'
+require 'rmarc/model/record'
+require 'rmarc/model/subfield'
+require 'rmarc/model/variable_field'

data/lib/rmarc/constants.rb

@@ -0,0 +1,43 @@
+# $Id: constants.rb,v 1.2 2005/12/02 16:57:26 bpeters Exp $
+#
+# Copyright (c) 2005 Bas Peters
+#
+# This file is part of RMARC
+# 
+# RMARC is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public 
+# License as published by the Free Software Foundation; either 
+# version 2.1 of the License, or (at your option) any later version.
+# 
+# RMARC is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# 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"
+    end
+    
+    def Constants.RT
+      return "\035"
+    end
+    
+    def Constants.FT
+      return "\036"
+    end
+    
+    def Constants.US
+      return "\037"
+    end
+    
+  end
+  
+end

data/lib/rmarc/marc_stream_reader.rb

@@ -0,0 +1,128 @@
+# $Id: marc_stream_reader.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#
+# Copyright (c) 2005 Bas Peters
+#
+# This file is part of RMARC
+# 
+# RMARC is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public 
+# License as published by the Free Software Foundation; either 
+# version 2.1 of the License, or (at your option) any later version.
+# 
+# RMARC is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# 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.
+  #
+  # Example usage:
+  #
+  # File.open("file.mrc", "r") do |file|
+  # reader = RMARC::MarcStreamReader.new(file)
+  # while reader.has_next
+  #     record = reader.next()
+  # end
+  class MarcStreamReader
+    
+    $input = nil
+    
+    def parse_data_field(entry)
+      msg = "Unexpected EOF while reading field with tag #{entry.tag}" 
+      
+      ind1 = $input.read(1)
+      
+      raise msg if ind1 == nil
+      
+      ind2 = $input.read(1)
+      
+      raise msg if ind2 == nil
+      
+      field = DataField.new(entry.tag, ind1, ind2)
+      
+      data = nil
+      code = nil
+      i = 2
+      
+      while i < entry.length
+        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)
+          i += 1
+          data = ""
+        elsif s == Constants.FT
+          field.add(Subfield.new(code, data)) if code != nil
+        else
+          data << s if data != nil
+        end
+        i += 1
+      end
+      return field  
+    end
+    
+    # Returns the next record in the iteration.
+    def next
+      ldr = $input.read(24)
+      
+      raise "Unexpected EOF while reading record label" if ldr == nil
+      
+      leader = Leader.new(ldr)
+      
+      record = Record.new(leader)
+      
+      length = leader.base_address - 25
+      
+      raise "Invalid directory" if length % 12 != 0
+      
+      dir = $input.read(length)
+      
+      entries = length / 12
+      
+      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)
+          
+          raise "Unexpected EOF while reading field with tag #{entry.tag}" if data == nil
+          
+          record.add(ControlField.new(entry.tag, data.chop))
+        else
+          record.add(parse_data_field(entry))
+        end
+        start += 5
+      end
+      
+      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
+        return true
+      else 
+        return false
+      end
+    end
+    
+    # Default constructor    
+    def initialize(input)
+      $input = input
+    end
+  end
+  
+end

data/lib/rmarc/marc_stream_writer.rb

@@ -0,0 +1,73 @@
+# $Id: marc_stream_writer.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#
+# Copyright (c) 2005 Bas Peters
+#
+# This file is part of RMARC
+# 
+# RMARC is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public 
+# License as published by the Free Software Foundation; either 
+# version 2.1 of the License, or (at your option) any later version.
+# 
+# RMARC is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# 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 
+  # 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
+  class MarcStreamWriter
+    
+    $output = nil
+    
+    # Default constructor.
+    def initialize(output)
+      $output = output
+    end
+    
+    # Writes a single record to the given output stream.
+    def write_record(record)
+      data = ""
+      dir = ""
+      prev = 0
+      
+      record.fields.each { 
+        |field| 
+        if field.tag.to_i < 10
+          data << field.data << Constants.FT
+        else
+          data << field.ind1 << field.ind2
+          field.subfields.each { |subf| data << Constants.US << subf.code << subf.data }
+          data << Constants.FT
+        end
+        len = data.length
+        dir << field.tag << "%04d" % (len - prev) << "%05d" % prev
+        prev = len
+      }
+      dir << Constants.FT
+      
+      leader = record.leader
+      leader.base_address = 24 + dir.length
+      leader.record_length = leader.base_address + data.length + 1
+      
+      $output.write(leader.to_s << dir << data << Constants.RT)
+    end  
+  end
+  
+end

data/lib/rmarc/marc_xml_reader.rb

@@ -0,0 +1,137 @@
+# $Id: marc_xml_reader.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#
+# Copyright (c) 2005 Bas Peters
+#
+# This file is part of RMARC
+# 
+# RMARC is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public 
+# License as published by the Free Software Foundation; either 
+# version 2.1 of the License, or (at your option) any later version.
+# 
+# RMARC is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# 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'
+
+module RMARC
+  
+  class RecordStack < SizedQueue
+    
+    attr_reader :has_next
+    attr_writer :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
+      when "record"
+        $record = Record.new
+      when "controlfield"
+        $field = ControlField.new(attrs["tag"])
+      when "datafield"
+        $field = DataField.new(attrs["tag"], attrs["ind1"], attrs["ind2"])
+      when "subfield"
+        $subfield = Subfield.new(attrs["code"])
+      end
+    end
+    
+    def text(text)
+      $data = text
+    end
+    
+    def tag_end(name)
+      re = /(\w+):(\w+)/
+      md = re.match(name)
+      name = $2 if ($2 != nil)
+      case name 
+      when "collection"
+        $queue.has_next = false
+      when "record"
+        $queue.push($record)
+      when "leader"
+        leader = Leader.new($data)
+        $data = ""
+        $record.leader = leader
+      when "controlfield"
+        $field.data = $data
+        $data = ""
+        $record.add($field)
+      when "datafield"
+        $record.add($field)
+      when "subfield"
+        $subfield.data = $data
+        $data = ""
+        $field.add($subfield)
+      end
+    end
+    
+    def xmldecl(version, encoding, standalone)
+    end
+    
+    def initialize(queue)
+      $queue = queue
+    end
+    
+  end
+  
+  # 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
+  class MarcXmlReader
+    
+    $queue = nil  
+    $input = nil
+    
+    # Default constructor
+    def initialize(input)
+      $input = input
+      $queue = RecordStack.new(1)
+      Thread.new do
+        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?) 
+        return false
+      else
+        return true
+      end
+    end
+    
+    # Returns the next record in the iteration.
+    def next
+      obj = $queue.pop
+      return obj
+    end  
+  end
+  
+end

data/lib/rmarc/marc_xml_writer.rb

@@ -0,0 +1,88 @@
+# $Id: marc_xml_writer.rb,v 1.3 2005/12/05 19:36:41 bpeters Exp $
+#
+# Copyright (c) 2005 Bas Peters
+#
+# This file is part of RMARC
+# 
+# RMARC is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public 
+# License as published by the Free Software Foundation; either 
+# version 2.1 of the License, or (at your option) any later version.
+# 
+# RMARC is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# 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
+  class MarcXmlWriter
+    
+    $output = nil
+    
+    # Default constructor.
+    def initialize(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  ")
+    end
+    
+    # Writes a single record element.
+    def write_record(record)
+      rec = REXML::Element.new('record')
+      ldr = REXML::Element.new('leader')
+      ldr.add_text(record.leader.to_s)
+      rec.add_element(ldr)
+      
+      record.fields.each { |field| 
+        if field.tag.to_i < 10
+          fld = REXML::Element.new('controlfield')
+          fld.add_attribute('tag', field.tag)
+          fld.add_text(field.data)
+          rec.add_element(fld)
+        else
+          fld = REXML::Element.new('datafield')
+          fld.add_attribute('tag', field.tag)
+          fld.add_attribute('ind1', field.ind1)
+          fld.add_attribute('ind2', field.ind2)
+          field.subfields.each { |subf| 
+            sub = REXML::Element.new('subfield')
+            sub.add_attribute('code', subf.code)
+            sub.add_text(subf.data)
+            fld.add_element(sub)
+          }
+          rec.add_element(fld)
+        end
+      }
+      rec.write($output, 1)
+    end
+    
+    # Writes the collection end tag. 
+    def end_document
+      $output.write("\n</collection>")
+    end
+    
+  end
+  
+end