enhanced_marc 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ad98f5c0586a829731494c6607834f40172ecaa
+  data.tar.gz: 66b1336d2b53c0d3e961369afb600cd9c19f68d2
+SHA512:
+  metadata.gz: 01f621f5eed7ccca3d200284d9c0241c65122a134e545837262d78074fe4126388f18b0697fec18c17f8cc6769fdbb70df105be880ea4192c21c540a8ce845b2
+  data.tar.gz: 6c065bbd2ff56ffff49b31630614252ca302238d0a18753295d506822e0c26b4da12801cc51878a8a69f156ce04a682f25ddaeb0680eb0fa0df5f9d0df09fcf5

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{sh,markdown}]
+indent_size = 4

data/.gitignore

@@ -0,0 +1,2 @@
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.2
+  - 2.3
+  - jruby
+script: bundle exec rspec spec

data/Changes

@@ -1 +1,2 @@
-2009-08-07:  Refactored to monkeypatch ruby-marc rather than replace it.
+2017-05-20:  Fixed a bug with how leader was parsed from MARC::Reader, added some specs, style changes
+2009-08-07:  Refactored to monkeypatch ruby-marc rather than replace it.

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem 'marc'
+gem 'locale'
+
+group :test do
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,59 @@
+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.
+
+[![Build Status](https://travis-ci.org/rsinger/enhanced-marc.svg?branch=master)](https://travis-ci.org/rsinger/enhanced-marc)
+
+Installation:
+  sudo gem install enhanced_marc
+
+Usage:
+```
+  require 'enhanced_marc'
+
+  reader = MARC::Reader.new('marc.dat')
+
+  records = []
+
+  reader.each do | record |
+    records << record
+  end
+```
+Note: enhanced-marc only works directly with `MARC::Reader`.  If you want to use it with MARCXML or MARC-JSON, etc.
+you'll need to do something like:
+```
+  reader.each do | record |
+    records << record.to_typed_record
+  end
+```
+for the same effect
+```
+  >> 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"]
+```

data/Rakefile

@@ -1,4 +1,4 @@
-RUBY_ENHANCED_MARC_VERSION = '0.1'
+RUBY_ENHANCED_MARC_VERSION = '0.3.0'
 
 require 'rubygems'
 require 'rake'

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/enhanced_marc.gemspec

@@ -1,11 +1,6 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
   s.name = %q{enhanced_marc}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ross Singer"]
@@ -14,40 +9,9 @@ Gem::Specification.new do |s|
   s.email = %q{rossfsinger@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README"
-  ]
-  s.files = [
-    "Changes",
-     "LICENSE",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "enhanced_marc.gemspec",
-     "lib/enhanced_marc.rb",
-     "lib/enhanced_marc/book_record.rb",
-     "lib/enhanced_marc/book_type.rb",
-     "lib/enhanced_marc/computer_record.rb",
-     "lib/enhanced_marc/computer_type.rb",
-     "lib/enhanced_marc/leader.rb",
-     "lib/enhanced_marc/leftovers.rb",
-     "lib/enhanced_marc/map_record.rb",
-     "lib/enhanced_marc/map_type.rb",
-     "lib/enhanced_marc/mixed_record.rb",
-     "lib/enhanced_marc/mixed_type.rb",
-     "lib/enhanced_marc/reader.rb",
-     "lib/enhanced_marc/record.rb",
-     "lib/enhanced_marc/record_type.rb",
-     "lib/enhanced_marc/score_record.rb",
-     "lib/enhanced_marc/score_type.rb",
-     "lib/enhanced_marc/serial_record.rb",
-     "lib/enhanced_marc/serial_type.rb",
-     "lib/enhanced_marc/sound_record.rb",
-     "lib/enhanced_marc/sound_type.rb",
-     "lib/enhanced_marc/visual_record.rb",
-     "lib/enhanced_marc/visual_type.rb",
-     "lib/enhanced_marc/xmlreader.rb",
-     "test/ts_enhanced_marc.rb"
+    "README.md"
   ]
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.homepage = %q{http://github.com/rsinger/enhanced-marc/tree}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]

data/lib/enhanced_marc.rb

@@ -2,7 +2,6 @@ require 'marc'
 require 'locale/info'
 require File.dirname(__FILE__) + '/enhanced_marc/reader'
 require File.dirname(__FILE__) + '/enhanced_marc/record'
-require File.dirname(__FILE__) + '/enhanced_marc/xmlreader'
 require File.dirname(__FILE__) + '/enhanced_marc/leader'
 require File.dirname(__FILE__) + '/enhanced_marc/book_record'
 require File.dirname(__FILE__) + '/enhanced_marc/serial_record'

data/lib/enhanced_marc/book_record.rb

@@ -1,37 +1,42 @@
 module MARC
 
   # A class that represents an individual MARC record. Every record
-  # is made up of a collection of MARC::Field objects. 
-
+  # is made up of a collection of MARC::Field objects.
   class BookRecord < Record
 
     def initialize
       super
-      @leader[6] = 'a' if @leader[6,1] == ' '
-      @leader[7] = 'm' if @leader[7,1] == ' '    
-      @record_type = 'BKS'  
+      @leader[6] = 'a' if @leader[6, 1] == ' '
+      @leader[7] = 'm' if @leader[7, 1] == ' '
+      @record_type = 'BKS'
       @bibliographic_level = @leader.get_blvl
-      self.extend BookType
-      self.inspect_fixed_fields
+      extend BookType
+      inspect_fixed_fields
     end
-    
-    def is_valid_type?
-      return false unless @leader[6,1].match(/[at]{1}/)
-      return true
+
+    def valid_type?
+      return false unless @leader[6, 1] =~ /[at]{1}/
+      true
     end
-    def is_valid_blvl?
-      return false unless @leader[7,1].match(/[acdm]{1}/)    
-      return true
+    alias is_valid_type? valid_type?
+
+    def valid_blvl?
+      return false unless @leader[7, 1] =~ /[acdm]{1}/
+      true
     end
+    alias is_valid_blvl? valid_blvl?
+
     def self.new_from_record(record)
       rec = BookRecord.new
-      record.instance_variables.each { | var |
+      record.instance_variables.each do |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
+      error = rec.valid_type? ? nil : 'Incorrect type declaration in leader'
+      if !error && !rec.valid_blvl?
+        error = 'Incorrect bibliographic declaration in leader'
+      end
+      return Exception.new(error) if error
+      rec
+    end
   end
 end

data/lib/enhanced_marc/book_type.rb

@@ -1,87 +1,101 @@
+# Methods for Book records
 module BookType
   include RecordType
-  public :is_govdoc?, :nature_of_contents, :is_conference?, :audience_level, :form, :has_index?
-  # Checks the leader and any 006 fields to 
+  public :is_govdoc?, :nature_of_contents, :is_conference?, :audience_level,
+         :form, :has_index?, :govdoc?, :conference?
+  # Checks the leader and any 006 fields to
   # determine if the record is a manuscript.
   # Returns a boolean.
-  def is_manuscript?
+  def manuscript?
     return true if @leader[6,1] == 't'
-    @fields.find_all {|f| ('006') === f.tag}.each { | fxd_fld |
-      return true if fxd_fld.value[0,1] == 't'
-    }       
-    return false
+    @fields.each_by_tag('006') do |fxd_fld|
+      return true if fxd_fld.value[0, 1] == 't'
+    end
+    false
   end
-  
-  def set_manuscript(value=false, field=nil)
+
+  alias is_manuscript? manuscript?
+
+  def set_manuscript(value = false, field = nil)
     if field
-      return Exception.new("Field is not an 006") unless field.tag == '006'
-      if value
-        field.value[0] = 't'
-      else
-        field.value[0] = 'a'
-      end
-    else  
-      if value
-        @leader[6] = 't'
-      else
-        @leader[6] = 'a'
-      end
+      return Exception.new('Field is not an 006') unless field.tag == '006'
+      field.value[0] = value ? 't' : 'a'
+    else
+      @leader[6] = value ? 't' : 'a'
     end
   end
-  
-  def literary_form(human_readable=false)
-    lit_map={'0'=>'Non-fiction', '1'=>'Fiction', 'c'=>'Comic',
-      'd'=>'Drama', 'e'=>'Essay', 'f'=>'Novel', 'h'=>'Humor/satire', 'i'=>'Letter', 'j'=>'Short story',
-      'm'=>'Mixed', 'p'=>'Poetry', 's'=>'Speech', 'u'=>'Unknown'}
+
+  def literary_form(human_readable = false)
+    lit_map = { '0' => 'Non-fiction', '1' => 'Fiction', 'c' => 'Comic',
+                'd' => 'Drama', 'e' => 'Essay', 'f' => 'Novel',
+                'h' => 'Humor/satire', 'i' => 'Letter', 'j' => 'Short story',
+                'm' => 'Mixed', 'p' => 'Poetry', 's' => 'Speech',
+                'u' => 'Unknown' }
     human_readable = lit_map if human_readable
-    return self.field_parser({:match=>'BKS', :start=>33,:end=>1}, {:match=>/[at]{1}/, :start=>16,:end=>1}, human_readable)          
-  end    
-        
-  def is_biography?(human_readable=false)
-    biog_map = {'a'=>'Autobiography', 'b'=>'Individual biography',
-     'c'=>'Collective biography', 'd'=>'Contains biographical information'}
+    field_parser({ match: 'BKS', start: 33, end: 1 },
+                 { match: /[at]{1}/, start: 16, end: 1 },
+                 human_readable)
+  end
+
+  def biography?(human_readable = false)
+    biog_map = { 'a' => 'Autobiography', 'b' => 'Individual biography',
+                 'c' => 'Collective biography',
+                 'd' => 'Contains biographical information' }
     human_readable = biog_map if human_readable
-    return self.field_parser({:match=>'BKS', :start=>34,:end=>1}, {:match=>/[at]{1}/, :start=>17,:end=>1}, human_readable)               
-  end    
-  
-  def is_festschrift?
-    return true if self['008'].value[30,1] == "1" and @record_type == "BKS"
-    @fields.find_all {|f| ('006') === f.tag}.each { | fxd_fld |
-      next unless fxd_fld.value[0,1].match(/[at]{1}/) and fxd_fld.value[13,1] == "1"
+    field_parser({ match: 'BKS', start: 34, end: 1},
+                 { match: /[at]{1}/, start: 17, end: 1},
+                 human_readable)
+  end
+
+  alias is_biography? biography?
+
+  def festschrift?
+    return true if self['008'].value[30, 1] == '1' && @record_type == 'BKS'
+    @fields.each_by_tag('006') do |fxd_fld|
+      if fxd_fld.value[0, 1].match(/[at]{1}/) && fxd_fld.value[13, 1] == '1'
+        next
+      end
       return true
-    }        
-    return false
-  end    
-        
-  def is_illustrated?(human_readable=false)
-    ills_map = {'a'=>'Illustrations','b'=>'Maps','c'=>'Portraits','d'=>'Charts',
-      'e'=>'Plans', 'f'=>'Plates', 'g'=>'Music', 'h'=>'Facsimilies', 'i'=>'Coats of arms',
-      'j'=>'Genealogical tables', 'k'=>'Forms', 'l'=>'Samples',
-      'm'=>'Phonodisc', 'o'=>'Photographs', 'p'=>'Illuminations'}
-      
+    end
+    false
+  end
+
+  alias is_festchrift? festschrift?
+
+  # TODO: simplify this method
+  def illustrated?(human_readable = false)
+    ills_map = { 'a' => 'Illustrations', 'b' => 'Maps', 'c' => 'Portraits',
+                 'd' => 'Charts', 'e' => 'Plans', 'f' => 'Plates',
+                 'g' => 'Music', 'h' => 'Facsimilies', 'i' => 'Coats of arms',
+                 'j' => 'Genealogical tables', 'k' => 'Forms', 'l' => 'Samples',
+                 'm' => 'Phonodisc', 'o' => 'Photographs',
+                 'p' => 'Illuminations' }
+
     contents = []
-    if self.record_type == 'BKS'
-      self['008'].value[18,4].split(//).each { | char | 
-        next if char == " "
+    if record_type == 'BKS'
+      self['008'].value[18, 4].split(//).each do |char|
+        next if char == ' '
         if human_readable
           contents << ills_map[char] if ills_map[char]
         else
           contents << char
         end
-      }
+      end
     end
-    @fields.find_all {|f| ('006') === f.tag}.each { | fxd_fld |
-      next unless fxd_fld.value[0,1].match(/[at]{1}/)     
-      fxd_fld.value[1,4].split(//).each { | char | 
-        next if char == " "
+    @fields.each_by_tag('006') do |fxd_fld|
+      next unless fxd_fld.value[0, 1] =~ /[at]{1}/
+      fxd_fld.value[1, 4].split(//).each do |char|
+        next if char == ' '
         if human_readable
           contents << ills_map[char] if ills_map[char]
         else
           contents << char
         end
-      }
-    }       
+      end
+    end
     return false if contents.empty?
-    return contents      
-  end        
-end
+    contents
+  end
+
+  alias is_illustrated? illustrated?
+end

data/lib/enhanced_marc/computer_record.rb

@@ -1,37 +1,42 @@
 module MARC
 
   # A class that represents an individual MARC record. Every record
-  # is made up of a collection of MARC::Field objects. 
-
+  # is made up of a collection of MARC::Field objects.
   class ComputerRecord < Record
-    
+
     def initialize
       super
       @leader[6] = 'm' if @leader[6,1] == ' '
-      @leader[7] = 'm' if @leader[7,1] == ' '    
-      @record_type = 'COM'  
+      @leader[7] = 'm' if @leader[7,1] == ' '
+      @record_type = 'COM'
       @bibliographic_level = @leader.get_blvl
-      self.extend ComputerType      
-      self.inspect_fixed_fields      
+      extend ComputerType
+      inspect_fixed_fields
     end
-    
-    def is_valid_type?
-      return false unless @leader[6,1].match('m')
-      return true
+
+    def valid_type?
+      return false unless @leader[6, 1] == 'm'
+      true
     end
-    def is_valid_blvl?
-      return false unless @leader[7,1].match(/[abcdims]{1}/)
-      return true
+    alias is_valid_type? valid_type?
+
+    def valid_blvl?
+      return false unless @leader[7, 1] =~ /[abcdims]{1}/
+      true
     end
+    alias is_valid_blvl? valid_blvl?
+
     def self.new_from_record(record)
       rec = ComputerRecord.new
-      record.instance_variables.each { | var |
+      record.instance_variables.each do |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
+      error = rec.valid_type? ? nil : 'Incorrect type declaration in leader'
+      if !error && !rec.valid_blvl?
+        error = 'Incorrect bibliographic declaration in leader'
+      end
+      return Exception.new(error) if error
+      rec
+    end
   end
-end
+end