rsinger-enhanced_marc 0.1 → 0.1.2

data/lib/enhanced_marc/score_record.rb

@@ -0,0 +1,38 @@
+module MARC
+
+  # A class that represents an individual MARC record. Every record
+  # is made up of a collection of MARC::Field objects. 
+
+  class ScoreRecord < Record
+
+    def initialize
+      super
+      @leader[6] = 'c' if @leader[6,1] == ' '
+      @leader[7] = 'm' if @leader[7,1] == ' '    
+      @record_type = 'SCO'  
+      @bibliographic_level = @leader.get_blvl
+      self.extend ScoreType      
+      self.inspect_fixed_fields      
+    end
+    
+    def is_valid_type?
+      return false unless @leader[6,1].match(/[cd]{1}/)
+      return true
+    end
+    def is_valid_blvl?
+      return true if @leader[7,1].match(/[acdim]{1}/) and @leader[6,1].match('d')
+      return true if @leader[7,1].match(/[abcdims]{1}/) and @leader[6,1].match('c')
+      return false
+    end
+    def self.new_from_record(record)
+      rec = ScoreRecord.new
+      record.instance_variables.each { | var |
+        rec.instance_variable_set(var, record.instance_variable_get(var))
+      }
+      return Exception.new("Incorrect type declaration in leader") unless rec.is_valid_type?
+      return Exception.new("Incorrect bibliographic declaration in leader") unless rec.is_valid_blvl?
+      return rec
+    end    
+    
+  end
+end

data/lib/enhanced_marc/score_type.rb

@@ -0,0 +1,4 @@
+module ScoreType
+  include RecordType
+  public :accompanying_matter, :audience_level, :form, :composition_form, :music_format, :is_conference?
+end

data/lib/enhanced_marc/serial_record.rb

@@ -0,0 +1,37 @@
+module MARC
+
+  # A class that represents an individual MARC record. Every record
+  # is made up of a collection of MARC::Field objects. 
+
+  class SerialRecord < Record
+
+    def initialize
+      super
+      @leader[6] = 'a' if @leader[6,1] == ' '
+      @leader[7] = 's' if @leader[7,1] == ' '    
+      @record_type = 'SER'  
+      @bibliographic_level = @leader.get_blvl
+      self.extend SerialType      
+      self.inspect_fixed_fields      
+    end
+    
+    def is_valid_type?
+      return false unless @leader[6,1].match('a')
+      return true
+    end
+    def is_valid_blvl?
+      return false unless @leader[7,1].match(/[bis]{1}/)    
+      return true
+    end
+    def self.new_from_record(record)
+      rec = SerialRecord.new
+      record.instance_variables.each { | var |
+        rec.instance_variable_set(var, record.instance_variable_get(var))
+      }
+      return Exception.new("Incorrect type declaration in leader") unless rec.is_valid_type?
+      return Exception.new("Incorrect bibliographic declaration in leader") unless rec.is_valid_blvl?
+      return rec
+    end    
+    
+  end
+end

data/lib/enhanced_marc/serial_type.rb

@@ -0,0 +1,87 @@
+module SerialType
+  include RecordType
+  public :is_govdoc?, :nature_of_contents, :is_conference?, :form
+  def alphabet(human_readable=false)
+    alph_map = {'a'=>'Roman', 'b'=>'Extended Roman', 'c'=>'Cyrillic',
+      'd'=>'Japanese', 'e'=>'Chinese', 'f'=>'Arabic', 'g'=>'Greek',
+      'h'=>'Hebrew', 'i'=>'Thai', 'j'=>'Devanagari', 'k'=>'Korean', 'l'=>'Tamil',
+      'u'=>'Unknown', 'z'=>'Other'
+      }
+    human_readable = alph_map if human_readable
+    return self.field_parser({:match=>'SER', :start=>33,:end=>1}, {:match=>'s', :start=>16,:end=>1}, human_readable)
+  end
+  
+  def frequency(human_readable=false) 
+    freq_map = {'a'=>'Annual','b'=>'Bimonthly','c'=>'Semiweekly','d'=>'Daily',
+      'e'=>'Biweekly','f'=>'Semiannual','g'=>'Biennial','h'=>'Triennial','i'=>'3 times/week',
+      'j'=>'3 times/month', 'k'=>'Continuously updated','m'=>'Monthly','q'=>'Quarterly',
+      's'=>'Semimonthly','t'=>'3 times/year','u'=>'Unknown','w'=>'Weekly','z'=>'Other'
+      }
+    human_readable = freq_map if human_readable
+    resp = self.field_parser({:match=>'SER', :start=>18,:end=>1}, {:match=>'s', :start=>1,:end=>1}, human_readable)
+    return resp if resp      
+    if human_readable
+      return 'No determinable frequency'
+    else
+      return false
+    end
+  end
+  
+  def regularity(human_readable=false)
+    regl_map = {'n'=>'Normalized irregular','r'=>'Regular','u'=>'Unknown','x'=>'Completely irregular'}
+    human_readable = regl_map if human_readable
+    return self.field_parser({:match=>'SER', :start=>19,:end=>1}, {:match=>'s', :start=>2,:end=>1}, human_readable)
+  end
+  
+  def serial_type(human_readable=false)
+    srtp_map = {'d'=>'Database','l'=>'Loose-leaf','m'=>'Monographic series','n'=>'Newspaper','p'=>'Periodical','w'=>'Website'}
+    human_readable = srtp_map if human_readable
+    resp = self.field_parser({:match=>'SER', :start=>21,:end=>1}, {:match=>'s', :start=>4,:end=>1}, human_readable)
+    return resp if resp    
+    if human_readable
+      return 'Other'
+    else
+      return false
+    end    
+  end
+  
+  def original_form(human_readable=false)
+    orig_map = {'a'=>'Microfilm','b'=>'Microfiche','c'=>'Microopaque','d'=>'Large print',
+      'e'=>'Newspaper format','f'=>'Braille','s'=>'Electronic'}
+    human_readable = orig_map if human_readable
+    resp = self.field_parser({:match=>'SER', :start=>22,:end=>1}, {:match=>'s', :start=>5,:end=>1}, human_readable)
+    return resp if resp      
+
+    if human_readable
+      return 'Other'
+    else
+      return false
+    end         
+  
+  end
+  
+  def nature_of_work(human_readable=false)
+    entw_map = {'a'=>'Abstracts','b'=>'Bibliography','c'=>'Catalog','d'=>'Dictionary',
+      'e'=>'Encyclopedia', 'f'=>'Handbook', 'g'=>'Legal article', 'h'=>'Biography', 'i'=>'Index',
+      'j'=>'Patent document', 'k'=>'Discography', 'l'=>'Legislation', 'm'=>'Thesis', 'n'=>'Literature survey',
+      'o'=>'Review', 'p'=>'Programmed text', 'q'=>'Filmography', 'r'=>'Directory', 's'=>'Statistics', 
+      't'=>'Technical report', 'u'=>'Standard/specification', 'v'=>'Legal case', 'w'=>'Law report', 'x'=>'Other report',
+      'z'=>'Treaty'}
+
+    human_readable = entw_map if human_readable
+    resp = self.field_parser({:match=>'SER', :start=>24,:end=>1}, {:match=>'s', :start=>7,:end=>1}, human_readable)
+    return resp if resp
+    if human_readable
+      return 'Not specified'
+    else
+      return false
+    end         
+  
+  end
+  
+  def entry(human_readable=false)
+    entry_map = {'0'=>'Successive','1'=>'Latest','2'=>'Integrated'}
+    human_readable = entry_map if human_readable
+    return self.field_parser({:match=>'SER', :start=>34,:end=>1}, {:match=>'s', :start=>17,:end=>1}, human_readable)    
+  end
+end

data/lib/enhanced_marc/sound_record.rb

@@ -0,0 +1,37 @@
+module MARC
+
+  # A class that represents an individual MARC record. Every record
+  # is made up of a collection of MARC::Field objects. 
+
+  class SoundRecord < Record
+
+    def initialize
+      super
+      @leader[6] = 'i' if @leader[6,1] == ' '
+      @leader[7] = 'm' if @leader[7,1] == ' '    
+      @record_type = 'REC'  
+      @bibliographic_level = @leader.get_blvl
+      self.extend SoundType      
+      self.inspect_fixed_fields      
+    end
+    
+    def is_valid_type?
+      return false unless @leader[6,1].match(/[ij]{1}/)
+      return true
+    end
+    def is_valid_blvl?
+      return false unless @leader[7,1].match(/[abcdims]{1}/)
+      return true
+    end
+    def self.new_from_record(record)
+      rec = SoundRecord.new
+      record.instance_variables.each { | var |
+        rec.instance_variable_set(var, record.instance_variable_get(var))
+      }
+      return Exception.new("Incorrect type declaration in leader") unless rec.is_valid_type?
+      return Exception.new("Incorrect bibliographic declaration in leader") unless rec.is_valid_blvl?
+      return rec
+    end    
+    
+  end
+end

data/lib/enhanced_marc/sound_type.rb

@@ -0,0 +1,4 @@
+module SoundType
+  include RecordType
+  public :accompanying_matter, :audience_level, :form, :composition_form, :music_format, :is_conference?
+end

data/lib/enhanced_marc/visual_record.rb

@@ -0,0 +1,37 @@
+module MARC
+
+  # A class that represents an individual MARC record. Every record
+  # is made up of a collection of MARC::Field objects. 
+
+  class VisualRecord < Record
+
+    def initialize
+      super
+      @leader[6] = 'g' if @leader[6,1] == ' '
+      @leader[7] = 'm' if @leader[7,1] == ' '    
+      @record_type = 'VIS'  
+      @bibliographic_level = @leader.get_blvl
+      self.extend VisualType      
+      self.inspect_fixed_fields      
+    end
+    
+    def is_valid_type?
+      return false unless @leader[6,1].match(/[gkro]{1}/)
+      return true
+    end
+    def is_valid_blvl?
+      return false unless @leader[7,1].match(/[abcdims]{1}/)    
+      return true
+    end
+    def self.new_from_record(record)
+      rec = VisualRecord.new
+      record.instance_variables.each { | var |
+        rec.instance_variable_set(var, record.instance_variable_get(var))
+      }
+      return Exception.new("Incorrect type declaration in leader") unless rec.is_valid_type?
+      return Exception.new("Incorrect bibliographic declaration in leader") unless rec.is_valid_blvl?
+      return rec
+    end    
+    
+  end
+end

data/lib/enhanced_marc/visual_type.rb

@@ -0,0 +1,38 @@
+module VisualType
+  include RecordType
+  public :form, :audience_level, :is_govdoc?
+  
+  def running_time
+    if @record_type == 'VIS'
+      unless self['008'].value[18,3] == 'nnn'
+        return "Unknown" if self['008'].value[18,3] == "---"
+        return self['008'].value[18,3].sub(/^0*/, '')
+      end
+    end
+    @fields.find_all {|f| ('006') === f.tag}.each { | fxd_fld |
+      next unless fxd_fld.value[0,1].match(/[gkor]{1}/)
+      unless fxd_fld.value[1,3] == 'nnn'
+        return "Unknown" if fxd_fld.value[1,3] == "---"
+        return fxd_fld.value[1,3].sub(/^0*/, '')
+      end
+    }       
+    return false    
+  end
+  
+  def material_type(human_readable=false)
+    tmat_map = {'a'=>'Art original', 'b'=>'Kit','c'=>'Art reproduction','d'=>'Diorama',
+      'f'=>'Filmstrip','g'=>'Game','i'=>'Picture','k'=>'Graphic','l'=>'Technical drawing',
+      'm'=>'Motion picture','n'=>'Chart','o'=>'Flash card','p'=>'Microscope slide',
+      'q'=>'Model','r'=>'Realia','s'=>'Slide','t'=>'Transparency','v'=>'Videorecording',
+      'w'=>'Toy','z'=>'Other'}
+    human_readable = tmat_map if human_readable
+    return self.field_parser({:match=>'VIS', :start=>33,:end=>1}, {:match=>/[gkor]{1}/, :start=>16,:end=>1}, human_readable)   
+  end
+  
+  def technique(human_readable=false)
+    tech_map = {'a'=>'Animation','c'=>'Animation and live action','l'=>'Live action',
+      'n'=>'N/A','u'=>'Unknown','z'=>'Other'}
+    human_readable = tmat_map if human_readable
+    return self.field_parser({:match=>'VIS', :start=>34,:end=>1}, {:match=>/[gkor]{1}/, :start=>17,:end=>1}, human_readable)       
+  end
+end

data/lib/enhanced_marc/xmlreader.rb

@@ -0,0 +1,58 @@
+module MARC  
+  class XMLReader
+    # will accept parse events until a record has been built up
+    #
+    def build_record
+      record = MARC::Record.new
+      data_field = nil
+      control_field = nil
+      subfield = nil
+      text = '' 
+      attrs = nil
+
+      while @parser.has_next?
+        event = @parser.pull
+
+        if event.text?
+          text += REXML::Text::unnormalize(event[0])
+          next
+        end
+
+        if event.start_element?
+          text = ''
+          attrs = event[1]
+          case strip_ns(event[0])
+          when 'controlfield'
+            text = ''
+            control_field = MARC::ControlField.new(attrs['tag'])
+          when 'datafield'
+            text = ''
+            data_field = MARC::DataField.new(attrs['tag'], attrs['ind1'], 
+              attrs['ind2'])
+          when 'subfield'
+            text = ''
+            subfield = MARC::Subfield.new(attrs['code'])
+          end
+        end
+
+        if event.end_element?
+          case strip_ns(event[0])
+          when 'leader'
+            record.leader = text
+          when 'record'
+            return record
+          when 'controlfield'
+            control_field.value = text
+            record.append(control_field)
+          when 'datafield'
+            record.append(data_field)
+          when 'subfield'
+            subfield.value = text
+            data_field.append(subfield)
+          end
+        end
+      end
+      record.to_typed_record
+    end
+  end
+end

data/lib/enhanced_marc.rb

@@ -0,0 +1,22 @@
+require 'marc'
+require 'enhanced_marc/reader'
+require 'enhanced_marc/record'
+require 'enhanced_marc/xmlreader'
+require 'enhanced_marc/leader'
+require 'enhanced_marc/book_record'
+require 'enhanced_marc/serial_record'
+require 'enhanced_marc/visual_record'
+require 'enhanced_marc/mixed_record'
+require 'enhanced_marc/map_record'
+require 'enhanced_marc/score_record'
+require 'enhanced_marc/sound_record'
+require 'enhanced_marc/computer_record'
+require 'enhanced_marc/record_type'
+require 'enhanced_marc/book_type'
+require 'enhanced_marc/computer_type'
+require 'enhanced_marc/map_type'
+require 'enhanced_marc/mixed_type'
+require 'enhanced_marc/score_type'
+require 'enhanced_marc/serial_type'
+require 'enhanced_marc/sound_type'
+require 'enhanced_marc/visual_type'

data/pkg/enhanced_marc-0.1/Changes

@@ -0,0 +1 @@
+2009-08-07:  Refactored to monkeypatch ruby-marc rather than replace it.

data/pkg/enhanced_marc-0.1/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2007 Ross Singer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/pkg/enhanced_marc-0.1/README

@@ -0,0 +1,51 @@
+Enhanced MARC is a set of classes, modules and methods that sit on top of ruby-marc (http://rubyforge.org/projects/marc) to help parse the contents of MARC records more easily and conveniently.
+Installation:
+  gem sources -a http://gems.github.com
+  sudo gem install rsinger-enhanced_marc
+  
+Usage:
+
+  require 'enhanced_marc'
+  
+  reader = MARC::Reader.new('marc.dat')
+  
+  records = []
+  
+  reader.each do | record |
+    records << record
+  end
+  
+  >> records[0].class
+  => MARC::BookRecord
+  
+  >> records[0].is_conference?
+  => false
+  
+  >> records[0].is_manuscript?
+  => false
+  
+  # Send a boolean true if you want human readable forms, rather than MARC codes.
+  >> records[0].literary_form(true)
+  => "Non-fiction"
+  
+  >> records[0].nature_of_contents(true)
+  => ["Bibliography", "Catalog"]
+  
+  >> records[1].class
+  => MARC::SoundRecord
+  
+  >> records[1].composition_form(true)
+  => "Jazz"
+  
+  >> records[2].class
+  => MARC::MapRecord
+  
+  >> records[2].projection(true)
+  => ["Cylindrical", "Mercator"]
+  
+  >> records[2].relief(true)
+  => ["Color"]
+  
+  
+  
+