pennmarc 1.0.0 → 1.0.1

data/lib/pennmarc/parser.rb

@@ -2,79 +2,53 @@
 
 require 'active_support/all'
 require_relative 'helpers/helper'
-require_relative 'helpers/creator'
-require_relative 'helpers/database'
-require_relative 'helpers/date'
-require_relative 'helpers/format'
-require_relative 'helpers/genre'
-require_relative 'helpers/identifier'
-require_relative 'helpers/language'
-require_relative 'helpers/link'
-require_relative 'helpers/location'
-require_relative 'helpers/subject'
-require_relative 'helpers/title'
-require_relative 'helpers/citation'
-require_relative 'helpers/relation'
-require_relative 'helpers/production'
-require_relative 'helpers/edition'
-require_relative 'helpers/note'
-require_relative 'helpers/series'
+
+# Require all files in helpers directory
+# TODO: this double-requires Helper, but that needs to be required before other helpers...
+Dir[File.join(__dir__, 'helpers', '*.rb')].each { |file| require file }
 
 # Top level gem namespace
 module PennMARC
-  attr_accessor :mappings
-
-  DEFINED_HELPERS = %w[Creator Database Date Format Genre Language Link Location Subject Title Relation].freeze
-
-  # Methods here should return values used in the indexer. The parsing logic should
-  # NOT return values specific to any particular site/interface, but just general
-  # MARC parsing logic for "title", "subject", "author", etc., as much as reasonably
-  # possible. We'll see how it goes.
-  #
-  # Methods should, by default, take in a MARC::Record
+  # Access point for magic calls to helper methods
   class Parser
-    def initialize(helpers: DEFINED_HELPERS)
-      @mappings = {}
-      @helpers = Array.wrap(helpers) # TODO: load helpers dynamically?
+    # Allow calls to `respond_to?` on parser instances to respond accurately by checking helper classes
+    # @param [String, Symbol] name
+    # @return [Boolean]
+    def respond_to_missing?(name, include_private = false)
+      helper, method_name = parse_call(name)
+      begin
+        "PennMARC::#{helper}".constantize.respond_to?(method_name)
+      rescue NameError
+        super # Helper is not defined, so check self
+      end
     end
 
-    def respond_to_missing?(name)
-      name.split('_').first.in? @helpers
-    end
-
-    # Call helper class methods, e.g.,
+    # Call helper class methods, passing along additional arguments as needed, e.g.:
     # #title_show -> PennMARC::Title.show
     # #subject_facet -> PennMARC::Subject.facet
-    def method_missing(name, opts)
-      call = name.to_s.split('_')
-      helper = call.shift
-      meth = call.join('_')
-      "PennMARC::#{helper.titleize}".constantize.public_send(meth, opts)
+    # @param [Symbol] name
+    # @param [MARC::Record] record
+    # @param [Array] opts
+    def method_missing(name, record, *opts)
+      helper, method_name = parse_call(name)
+      raise NoMethodError unless helper && method_name
+
+      helper_klass = "PennMARC::#{helper.titleize}".constantize
+      if opts.any?
+        helper_klass.public_send(method_name, record, **opts.first)
+      else
+        helper_klass.public_send(method_name, record)
+      end
     end
 
-    # Load language map from YAML and memoize in @mappings hash
-    # @return [Hash]
-    def language_map
-      @mappings[:language] ||= load_map('language.yml')
-    end
-
-    # Load location map from YAML and memoize in @mappings hash
-    # @return [Hash]
-    def location_map
-      @mappings[:location] ||= load_map('locations.yml')
-    end
+    private
 
-    # Load relator map from YAML and memoize in @mappings hash
-    # @return [Hash]
-    def relator_map
-      @mappings[:relator] ||= load_map('relator.yml')
-    end
-
-    # @param [String] filename of mapping file in config directory, with file extension
-    # @return [Hash] mapping as hash
-    def load_map(filename)
-      YAML.safe_load(File.read(File.join(File.expand_path(__dir__), 'mappings', filename)),
-                     symbolize_names: true)
+    # Parse out a method call name in the way method_missing is configured to handle
+    # @param [String, Symbol] name
+    # @return [Array]
+    def parse_call(name)
+      call = name.to_s.split('_')
+      [call.shift&.titleize, call.join('_').to_sym]
     end
   end
 end

data/lib/pennmarc/util.rb

@@ -9,8 +9,10 @@ module PennMARC
     # @param [MARC::DataField] field
     # @param [Proc] selector
     # @return [String]
-    def join_subfields(field, &)
-      field.select(&).filter_map { |sf|
+    def join_subfields(field, &selector)
+      return '' unless field
+
+      field.select(&selector).filter_map { |sf|
         value = sf.value&.strip
         next if value.blank?
 
@@ -26,7 +28,7 @@ module PennMARC
     # @param [Regexp] regex
     # @return [TrueClass, FalseClass]
     def subfield_value?(field, subfield, regex)
-      field.any? { |sf| sf.code == subfield.to_s && sf.value =~ regex }
+      field&.any? { |sf| sf.code == subfield.to_s && sf.value =~ regex }
     end
 
     # returns true if a given field has a given subfield value in a given array
@@ -49,7 +51,6 @@ module PennMARC
     end
 
     # returns a lambda checking if passed-in subfield's code is a member of array
-    # TODO: include lambda returning methods in their own module?
     # @param [Array] array
     # @return [Proc]
     def subfield_in?(array)
@@ -57,7 +58,6 @@ module PennMARC
     end
 
     # returns a lambda checking if passed-in subfield's code is NOT a member of array
-    # TODO: include lambda returning methods in their own module?
     # @param [Array] array
     # @return [Proc]
     def subfield_not_in?(array)
@@ -124,16 +124,15 @@ module PennMARC
     # See: https://www.loc.gov/marc/bibliographic/bd880.html
     # @param [MARC::Record] record
     # @param [String|Array] subfield6_value either a string to look for in sub6 or an array of them
-    # @param selector [Proc] takes a subfield as argument, returns a boolean
+    # @param [Proc] selector takes a subfield as argument, returns a boolean
     # @return [Array] array of linked alternates
-    def linked_alternate(record, subfield6_value, &)
+    def linked_alternate(record, subfield6_value, &selector)
       record.fields('880').filter_map do |field|
         next unless subfield_value?(field, '6', /^#{Array.wrap(subfield6_value).join('|')}/)
 
-        field.select(&).map(&:value).join(' ')
+        field.select(&selector).map(&:value).join(' ')
       end
     end
-    alias get_880 linked_alternate
 
     # Common case of wanting to extract all the subfields besides 6 or 8,
     # from 880 datafield that has a particular subfield 6 value. We exclude 6 because
@@ -142,8 +141,9 @@ module PennMARC
     # @param [String|Array] subfield6_value either a string to look for in sub6 or an array of them
     # @return [Array] array of linked alternates without 8 or 6 values
     def linked_alternate_not_6_or_8(record, subfield6_value)
+      excluded_subfields = %w[6 8]
       linked_alternate(record, subfield6_value) do |sf|
-        %w[6 8].exclude?(sf.code)
+        excluded_subfields.exclude?(sf.code)
       end
     end
 
@@ -179,7 +179,6 @@ module PennMARC
     def join_and_squish(array)
       array.join(' ').squish
     end
-    alias join_and_trim_whitespace join_and_squish
 
     # If there's a subfield i, extract its value, and if there's something
     # in parentheses in that value, extract that.

data/pennmarc.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'pennmarc'
-  s.version     = '1.0.0'
+  s.version     = '1.0.1'
   s.summary     = 'Penn Libraries Catalog MARC parsing wisdom for cross-project usage'
   s.description = 'This gem provides methods for parsing a Penn Libraries MARCXML record into string, array and date
                    objects for use in discovery or preservation applications.'

data/spec/lib/pennmarc/helpers/creator_spec.rb

@@ -17,9 +17,9 @@ describe 'PennMARC::Creator' do
       end
 
       it 'contains the expected search field values for a single author work' do
-        expect(helper.search(record, mapping)).to eq ['Name Surname http://cool.uri/12345 author 1900-2000.',
-                                                      'Surname, Name http://cool.uri/12345 author 1900-2000.',
-                                                      'Alternative Surname']
+        expect(helper.search(record, relator_map: mapping)).to eq ['Name Surname http://cool.uri/12345 author 1900-2000.',
+                                                                   'Surname, Name http://cool.uri/12345 author 1900-2000.',
+                                                                   'Alternative Surname']
       end
     end
 
@@ -30,8 +30,8 @@ describe 'PennMARC::Creator' do
       end
 
       it 'contains the expected search field values for a corporate author work' do
-        expect(helper.search(record, mapping)).to eq ['Group of People Annual Meeting Author.',
-                                                      'Alt. Group Name Alt. Annual Meeting']
+        expect(helper.search(record, relator_map: mapping)).to eq ['Group of People Annual Meeting Author.',
+                                                                   'Alt. Group Name Alt. Annual Meeting']
       end
     end
   end
@@ -46,7 +46,7 @@ describe 'PennMARC::Creator' do
       end
 
       it 'returns values for the author, including mapped relator code from ǂ4' do
-        values = helper.values(record, mapping)
+        values = helper.values(record, relator_map: mapping)
         expect(values).to contain_exactly 'Author Fancy active 24th century AD, Author.'
         expect(values.join.downcase).not_to include 'alt'
       end
@@ -58,7 +58,7 @@ describe 'PennMARC::Creator' do
       end
 
       it 'returns values for the corporate author, including mapped relator code from ǂ4' do
-        expect(helper.values(record, mapping)).to contain_exactly 'Annual Report Leader author, Author.'
+        expect(helper.values(record, relator_map: mapping)).to contain_exactly 'Annual Report Leader author, Author.'
       end
     end
   end
@@ -160,7 +160,7 @@ describe 'PennMARC::Creator' do
     end
 
     it 'returns conference name information for display, ignoring any linked 880 fields' do
-      expect(helper.conference_show(record, mapping)).to eq ['MARC History Symposium, Author.']
+      expect(helper.conference_show(record, relator_map: mapping)).to eq ['MARC History Symposium, Author.']
     end
   end
 
@@ -204,7 +204,7 @@ describe 'PennMARC::Creator' do
     end
 
     it 'returns expected contributor values' do
-      expect(helper.contributor_show(record, mapping)).to contain_exactly(
+      expect(helper.contributor_show(record, relator_map: mapping)).to contain_exactly(
         'Name I laureate 1968 pseud Fuller Name author affiliation materials, Author',
         'Corporation A division Office 1968 author affiliation materials, Author',
         'Alt Name Alt num Alt title Alt date Alt qualifier Alt Fuller Name Alt relator Alt affiliation Alt materials',

data/spec/lib/pennmarc/helpers/edition_spec.rb

@@ -28,8 +28,9 @@ describe 'PennMARC::Edition' do
 
   describe '.other_show' do
     it 'returns other edition values' do
-      expect(helper.other_show(record, mapping)).to contain_exactly('Autre Editione',
-                                                                    'Other Edition: Author. (Cool Book)')
+      expect(helper.other_show(record, relator_map: mapping)).to(
+        contain_exactly('Autre Editione', 'Other Edition: Author. (Cool Book)')
+      )
     end
   end
 end

data/spec/lib/pennmarc/helpers/format_spec.rb

@@ -7,7 +7,7 @@ describe 'PennMARC::Format' do
 
   describe '.facet' do
     let(:map) { location_map }
-    let(:formats) { helper.facet(record, map) }
+    let(:formats) { helper.facet(record, location_map: map) }
 
     context 'with an "Archive"' do
       let(:map) do

data/spec/lib/pennmarc/helpers/genre_spec.rb

@@ -43,7 +43,7 @@ describe 'PennMARC::Genre' do
   end
 
   describe '.facet' do
-    let(:values) { helper.facet(record, location_map) }
+    let(:values) { helper.facet(record, location_map: location_map) }
     let(:location_map) do
       { manu: { specific_location: 'Secure Manuscripts Storage' },
         vanp: { specific_location: 'Van Pelt' } }

data/spec/lib/pennmarc/helpers/language_spec.rb

@@ -18,7 +18,7 @@ describe 'PennMARC::Language' do
 
   describe '.search' do
     it 'returns the expected display value' do
-      expect(helper.search(record, mapping)).to eq 'English'
+      expect(helper.search(record, language_map: mapping)).to eq 'English'
     end
   end
 

data/spec/lib/pennmarc/helpers/location_spec.rb

@@ -11,9 +11,9 @@ describe 'PennMARC::Location' do
       let(:record) { marc_record(fields: [marc_field(tag: 'itm', subfields: { g: 'stor' })]) }
 
       it 'returns expected value' do
-        expect(helper.location(record: record, location_mapping: mapping,
+        expect(helper.location(record: record, location_map: mapping,
                                display_value: :library)).to contain_exactly('LIBRA')
-        expect(helper.location(record: record, location_mapping: mapping,
+        expect(helper.location(record: record, location_map: mapping,
                                display_value: 'specific_location')).to contain_exactly('LIBRA')
       end
     end
@@ -22,9 +22,9 @@ describe 'PennMARC::Location' do
       let(:record) { marc_record(fields: [marc_field(tag: 'hld', subfields: { c: 'stor' })]) }
 
       it 'returns expected value' do
-        expect(helper.location(record: record, location_mapping: mapping,
+        expect(helper.location(record: record, location_map: mapping,
                                display_value: :library)).to contain_exactly('LIBRA')
-        expect(helper.location(record: record, location_mapping: mapping,
+        expect(helper.location(record: record, location_map: mapping,
                                display_value: 'specific_location')).to contain_exactly('LIBRA')
       end
     end
@@ -36,7 +36,7 @@ describe 'PennMARC::Location' do
       end
 
       it 'returns item location' do
-        expect(helper.location(record: record, location_mapping: mapping,
+        expect(helper.location(record: record, location_map: mapping,
                                display_value: :library)).to contain_exactly('LIBRA')
       end
     end
@@ -45,7 +45,7 @@ describe 'PennMARC::Location' do
       let(:record) { marc_record(fields: [marc_field(tag: 'itm', subfields: { g: %w[dent] })]) }
 
       it 'returns expected value' do
-        expect(helper.location(record: record, location_mapping: mapping,
+        expect(helper.location(record: record, location_map: mapping,
                                display_value: :library)).to contain_exactly('Health Sciences Libraries',
                                                                             'Levy Dental Medicine Library')
       end
@@ -55,7 +55,7 @@ describe 'PennMARC::Location' do
       let(:record) { marc_record(fields: [marc_field(tag: '852', subfields: { g: 'stor' })]) }
 
       it 'returns expected value' do
-        expect(helper.location(record: record, location_mapping: mapping, display_value: :library)).to be_empty
+        expect(helper.location(record: record, location_map: mapping, display_value: :library)).to be_empty
       end
     end
 
@@ -63,7 +63,7 @@ describe 'PennMARC::Location' do
       let(:record) { marc_record(fields: [marc_field(tag: 'itm', subfields: { g: 'stor' }), marc_field(tag: 'prt')]) }
 
       it 'returns expected value' do
-        expect(helper.location(record: record, location_mapping: mapping,
+        expect(helper.location(record: record, location_map: mapping,
                                display_value: :library)).to contain_exactly('LIBRA', 'Online library')
       end
     end

data/spec/lib/pennmarc/helpers/relation_spec.rb

@@ -65,7 +65,7 @@ describe 'PennMARC::Relation' do
     end
 
     it 'returns specified subfield values from specified field with blank indicator2' do
-      values = helper.related_work_show record, relator_map
+      values = helper.related_work_show record, relator_map: relator_map
       expect(values).to contain_exactly 'Translation of: Some Author Aphorisms, Translator',
                                         'Alt. Prefix: Alt. Author Alt. Aphorisms'
       expect(values).not_to include 'Ignored'
@@ -81,7 +81,7 @@ describe 'PennMARC::Relation' do
     end
 
     it "returns specified subfield values from specified field with '2' in indicator2" do
-      values = helper.contains_show record, relator_map
+      values = helper.contains_show record, relator_map: relator_map
       expect(values).to contain_exactly 'Alt. Prefix: Alt. Name', 'Container of: Some Author Works, Author'
       expect(values).not_to include 'Ignored'
     end

data/spec/lib/pennmarc/helpers/series_spec.rb

@@ -18,7 +18,7 @@ describe 'PennMARC::Series' do
 
   describe '.show' do
     it 'returns the series' do
-      expect(helper.show(record, mapping)).to contain_exactly('Bean Bagatolvski 1997- bk. 1',
+      expect(helper.show(record, relator_map: mapping)).to contain_exactly('Bean Bagatolvski 1997- bk. 1',
                                                               'Teachings of the feathered pillow',
                                                               'Учения пернатой подушки')
     end
@@ -26,7 +26,7 @@ describe 'PennMARC::Series' do
 
   describe '.values' do
     it 'returns the values' do
-      expect(helper.values(record, mapping)).to contain_exactly('Bean Bagatolvski 1997- bk. 1.')
+      expect(helper.values(record, relator_map: mapping)).to contain_exactly('Bean Bagatolvski 1997- bk. 1.')
     end
   end
 

data/spec/lib/pennmarc/helpers/subject_spec.rb

@@ -10,7 +10,7 @@ describe 'PennMARC::Subject' do
 
   describe '.search' do
     let(:record) { marc_record fields: fields }
-    let(:values) { helper.search(record, relator_map) }
+    let(:values) { helper.search(record, relator_map: relator_map) }
 
     context 'with a mix of included and excluded tags' do
       let(:fields) do

data/spec/lib/pennmarc/parser_spec.rb

@@ -8,6 +8,27 @@ describe PennMARC::Parser do
   let(:record) { record_from 'test.xml' }
 
   it 'delegates to helper modules properly' do
-    expect { parser.title_show(record) }.not_to raise_exception
+    expect(parser.language_search(record)).to eq 'English'
+  end
+
+  it 'delegates to helper modules properly with extra params' do
+    bogus_map = { eng: 'American' }
+    expect(parser.language_search(record, language_map: bogus_map)).to eq 'American'
+  end
+
+  it 'raises an exception if the method call is invalid' do
+    expect { parser.title(record) }.to raise_error NoMethodError
+    expect { parser.title_nope(record) }.to raise_error NoMethodError
+  end
+
+  describe '#respond_to?' do
+    it 'returns true if a helper has the expected method' do
+      expect(parser).to respond_to :language_search
+    end
+
+    it 'returns false if a helper does not have the expected method' do
+      expect(parser).not_to respond_to :language_nope
+      expect(parser).not_to respond_to :nope
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pennmarc
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mike Kanning
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,9 +84,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
-- legacy/indexer.rb
-- legacy/marc.rb
-- legacy/test_file_output.json
 - lib/pennmarc.rb
 - lib/pennmarc/encoding_level.rb
 - lib/pennmarc/enriched_marc.rb
@@ -109,6 +106,7 @@ files:
 - lib/pennmarc/helpers/series.rb
 - lib/pennmarc/helpers/subject.rb
 - lib/pennmarc/helpers/title.rb
+- lib/pennmarc/mappers.rb
 - lib/pennmarc/mappings/language.yml
 - lib/pennmarc/mappings/locations.yml
 - lib/pennmarc/mappings/relator.yml