pennmarc 1.0.31 → 1.0.32

data/lib/pennmarc/helpers/subject.rb

@@ -30,8 +30,8 @@ module PennMARC
       # 69X, including any linked 880 fields. Fields must have an indicator2 value in {VALID_SOURCE_INDICATORS}.
       # @todo this includes subfields that may not be desired like 1 (uri) and 2 (source code) but this might be OK for
       #       a search (non-display) field?
-      # @param [Hash] relator_map
-      # @param [MARC::Record] record
+      # @param relator_map [Hash]
+      # @param record [MARC::Record]
       # @return [Array<String>] array of all subject values for search
       def search(record, relator_map: Mappers.relator)
         subject_fields(record, type: :search).filter_map { |field|
@@ -61,8 +61,8 @@ module PennMARC
       # All Subjects for faceting
       #
       # @note this is ported mostly form MG's new-style Subject parsing
-      # @param [MARC::Record] record
-      # @param [Boolean] override to remove undesirable terms or not
+      # @param record [MARC::Record]
+      # @param override [Boolean] remove undesirable terms or not
       # @return [Array<String>] array of all subject values for faceting
       def facet(record, override: true)
         values = subject_fields(record, type: :facet).filter_map { |field|
@@ -77,8 +77,8 @@ module PennMARC
       # All Subjects for display. This includes all {DISPLAY_TAGS} and {LOCAL_TAGS}. For tags that specify a source,
       # only those with an allowed source code (see ALLOWED_SOURCE_CODES) are included.
       #
-      # @param [MARC::Record] record
-      # @param [Boolean] override to remove undesirable terms or not
+      # @param record [MARC::Record]
+      # @param override [Boolean] to remove undesirable terms or not
       # @return [Array] array of all subject values for display
       def show(record, override: true)
         values = subject_fields(record, type: :all).filter_map { |field|
@@ -92,8 +92,8 @@ module PennMARC
 
       # Get Subjects from "Children" ontology
       #
-      # @param [MARC::Record] record
-      # @param [Boolean] override to remove undesirable terms or not
+      # @param record [MARC::Record]
+      # @param override [Boolean] remove undesirable terms or not
       # @return [Array] array of children's subject values for display
       def childrens_show(record, override: true)
         values = subject_fields(record, type: :display, options: { tags: DISPLAY_TAGS, indicator2: '1' })
@@ -108,8 +108,8 @@ module PennMARC
 
       # Get Subjects from "MeSH" ontology
       #
-      # @param [MARC::Record] record
-      # @param [Boolean] override to remove undesirable terms or not
+      # @param record [MARC::Record]
+      # @param override [Boolean] remove undesirable terms or not
       # @return [Array] array of MeSH subject values for display
       def medical_show(record, override: true)
         values = subject_fields(record, type: :display, options: { tags: DISPLAY_TAGS, indicator2: '2' })
@@ -125,8 +125,8 @@ module PennMARC
       # Get Subject values from {DISPLAY_TAGS} where indicator2 is 4 and {LOCAL_TAGS}. Do not include any values where
       # sf2 includes "penncoi" (Community of Interest).
       #
-      # @param [MARC::Record] record
-      # @param [Boolean] override to remove undesirable terms
+      # @param record [MARC::Record]
+      # @param override [Boolean] to remove undesirable terms
       # @return [Array] array of local subject values for display
       def local_show(record, override: true)
         local_fields = subject_fields(record, type: :display, options: { tags: DISPLAY_TAGS, indicator2: '4' }) +
@@ -149,9 +149,9 @@ module PennMARC
       # - facet
       # - display
       # - local
-      # @param [MARC::Record] record
-      # @param [String, Symbol] type of fields desired
-      # @param [Hash] options to be passed to the selector method
+      # @param record [MARC::Record]
+      # @param type [String, Symbol] type of fields desired
+      # @param options [Hash] options to be passed to the selector method
       # @return [Array<MARC::DataField>] selected fields
       def subject_fields(record, type:, options: {})
         selector_method = case type.to_sym
@@ -171,8 +171,8 @@ module PennMARC
       # Format a term hash as a string for display
       #
       # @todo support search field formatting?
-      # @param [Symbol] type
-      # @param [Hash] term components and information as a hash
+      # @param type [Symbol]
+      # @param term [Hash] components and information as a hash
       # @return [String]
       def format_term(type:, term:)
         return unless type.in? %i[facet display]
@@ -194,7 +194,7 @@ module PennMARC
       # indicator 2 is '7' - indicating "source specified", the specified source must be in our approved source code
       # list.
       # @see Util.valid_subject_genre_source_code?
-      # @param [MARC::DataField] field
+      # @param field [MARC::DataField]
       # @return [Boolean] whether a MARC field is intended for display under general "Subjects"
       def subject_general_display_field?(field)
         return false unless field.tag.in?(DISPLAY_TAGS + LOCAL_TAGS) && field.respond_to?(:indicator2)
@@ -206,14 +206,14 @@ module PennMARC
         true
       end
 
-      # @param [MARC::DataField] field
+      # @param field [MARC::DataField]
       # @return [Boolean] whether a MARC field is a local subject field (69X)
       def subject_local_field?(field)
         field.tag.in? LOCAL_TAGS
       end
 
-      # @param [MARC::DataField] field
-      # @param [Hash] options include :tags and :indicator2 values
+      # @param field [MARC::DataField]
+      # @param options [Hash] include :tags and :indicator2 values
       # @return [Boolean] whether a MARC field should be considered for display
       def subject_display_field?(field, options)
         return false unless field.respond_to?(:indicator2)
@@ -223,7 +223,7 @@ module PennMARC
         false
       end
 
-      # @param [MARC::DataField] field
+      # @param field [MARC::DataField]
       # @return [Boolean]
       def subject_facet_field?(field)
         return false unless field.respond_to?(:indicator2)
@@ -241,7 +241,7 @@ module PennMARC
       #       because we're using (where? - MK) "subdivision count" as a heuristic for the quality level of the
       #       heading. - MG
       # @todo do i need all this?
-      # @param [MARC::DataField] field
+      # @param field [MARC::DataField]
       # @return [Hash{Symbol => Integer, Array, Boolean}, Nil]
       def build_subject_hash(field)
         term_info = { count: 0, parts: [], append: [], uri: nil,
@@ -291,7 +291,7 @@ module PennMARC
 
       # Determine if a field should be considered for Subject search inclusion. It must be either contained in
       # {SEARCH_TAGS}, be an 880 field otherwise linked to a valid Search tag, or be in {LOCAL_TAGS}.
-      # @param [MARC::DataField] field
+      # @param field [MARC::DataField]
       # @return [Boolean]
       def subject_search_field?(field)
         return false unless field.respond_to?(:indicator2) && VALID_SOURCE_INDICATORS.include?(field.indicator2)
@@ -305,7 +305,7 @@ module PennMARC
       end
 
       # Is a given tag a subject search field? Yes if it is contained in {SEARCH_TAGS} or starts with 69.
-      # @param [String, NilClass] tag
+      # @param tag [String, nil]
       # @return [Boolean]
       def subject_search_tag?(tag)
         return false if tag.blank?
@@ -317,7 +317,7 @@ module PennMARC
       # when we've only encountered one subfield, assume that it might be a poorly-coded record
       # with a bunch of subdivisions mashed together, and attempt to convert it to a consistent
       # form.
-      # @param [String] first_part
+      # @param first_part [String]
       # @return [String, nil] normalized string
       def normalize_single_subfield(first_part)
         first_part.gsub!(/([[[:alnum:]])])(\s+--\s*|\s*--\s+)([[[:upper:]][[:digit:]]])/, '\1--\3')
@@ -326,8 +326,8 @@ module PennMARC
       end
 
       # removes trailing comma or period, manipulating the string in place
-      # @param [String, NilClass] subject_part
-      # @return [String, NilClass]
+      # @param subject_part [String, nil]
+      # @return [String, nil]
       def trim_trailing_commas_or_periods!(subject_part)
         return if subject_part.blank?
 

data/lib/pennmarc/helpers/title.rb

@@ -35,7 +35,7 @@ module PennMARC
     class << self
       # Main Title Search field. Takes from {https://www.loc.gov/marc/bibliographic/bd245.html 245} and linked 880.
       # @note Ported from get_title_1_search_values.
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Array<String>] array of title values for search
       def search(record)
         record.fields(%w[245 880]).filter_map { |field|
@@ -47,7 +47,7 @@ module PennMARC
 
       # Auxiliary Title Search field. Takes from many fields defined in {AUX_TITLE_TAGS} that contain title-like
       # information.
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Array<String>] array of auxiliary title values for search
       def search_aux(record)
         values = search_aux_values(record: record, title_type: :main, &subfield_not_in?(%w[c 6 8])) +
@@ -60,7 +60,7 @@ module PennMARC
       # Journal Title Search field. Takes from {https://www.loc.gov/marc/bibliographic/bd245.html 245} and linked 880.
       # We do not return any values if the {https://www.loc.gov/marc/bibliographic/bdleader.html MARC leader}
       # indicates that the record is not a serial.
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Array<String>] journal title information for search
       def journal_search(record)
         return [] if not_a_serial?(record)
@@ -75,7 +75,7 @@ module PennMARC
       # Auxiliary Journal Title Search field. Takes from many fields defined in {AUX_TITLE_TAGS} that contain title-like
       # information. Does not return any titles if the {https://www.loc.gov/marc/bibliographic/bdleader.html MARC leader}
       # indicates that the record is not a serial.
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Array<String>] auxiliary journal title information for search
       def journal_search_aux(record)
         values = search_aux_values(record: record, title_type: :main, journal: true, &subfield_not_in?(%w[c 6 8])) +
@@ -90,7 +90,7 @@ module PennMARC
       # {https://www.oclc.org/bibformats/en/2xx/245.html#punctuation punctuation practices}.
       # @todo still consider ǂh? medium, which OCLC doc says DO NOT USE...but that is OCLC...
       # @todo is punctuation handling still as desired? treatment here is described in spreadsheet from 2011
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [String] single title for display
       def show(record)
         field = record.fields('245').first
@@ -117,7 +117,7 @@ module PennMARC
       #       title_sort_tl (text left justified). It is not yet clear why this distinction is useful. For now, use a
       #       properly normalized (leading articles and punctuation removed) single title value here.
       # @todo refactor to reduce complexity
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [String] title value for sorting
       def sort(record)
         title_field = record.fields('245').first
@@ -152,7 +152,7 @@ module PennMARC
 
       # @note this is simplified from legacy practice as a linking hash is not returned. I believe this only supported
       #       title browse and we will not be supporting that at this time
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Array<String>] Array of standardized titles as strings
       def standardized_show(record)
         standardized_titles = record.fields(%w[130 240]).map do |field|
@@ -181,7 +181,7 @@ module PennMARC
       # Data comes from 246 ({https://www.oclc.org/bibformats/en/2xx/246.htm OCLC docs}) and 740
       # ({https://www.oclc.org/bibformats/en/7xx/740.html OCLC docs)}
       #
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Array<String>] Array of other titles as strings
       def other_show(record)
         other_titles = record.fields('246').map do |field|
@@ -207,7 +207,7 @@ module PennMARC
       # @note Ported from get_former_title_display. That method returns a hash for constructing a search link.
       #       We may need to do something like that eventually.
       # @todo what are e and w subfields?
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Array<String>] array of former titles
       def former_show(record)
         record.fields
@@ -221,7 +221,7 @@ module PennMARC
       end
 
       # Determine if the record is a "Host" bibliographic record for other bib records ("bound-withs")
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Boolean]
       def host_bib_record?(record)
         record.fields('245').any? do |f|
@@ -235,7 +235,7 @@ module PennMARC
       # Create prefix/filing hash for representing a title value with filing characters removed, with special
       # consideration for bracketed titles
       # @todo Is this still useful?
-      # @param [String] title
+      # @param title [String]
       # @return [Hash]
       def handle_bracket_prefix(title)
         if title.starts_with? '['
@@ -246,14 +246,14 @@ module PennMARC
       end
 
       # Evaluate {https://www.loc.gov/marc/bibliographic/bdleader.html MARC leader} to determine if record is a serial.
-      # @param [MARC::Record] record
+      # @param record [MARC::Record]
       # @return [Boolean]
       def not_a_serial?(record)
         !record.leader[6..7].ends_with?('s')
       end
 
-      # @param [MARC::DataField] field
-      # @param [String] value
+      # @param field [MARC::DataField]
+      # @param value [String]
       # @return [Boolean]
       def indicators_are_not_value?(field, value)
         field.indicator1 != value && field.indicator2 != value
@@ -263,10 +263,10 @@ module PennMARC
       # {https://www.loc.gov/marc/bibliographic/bdleader.html MARC leader} indicates that the record is not a serial.
       # We take special consideration for the {https://www.loc.gov/marc/bibliographic/bd505.html 505 field}, extracting
       # values only when indicator1 and indicator2 are both '0'.
-      # @param [MARC::Record] record
-      # @param [Symbol] title_type
-      # @param [Boolean] journal
-      # @bloc [Proc] join_selector
+      # @param record [MARC::Record]
+      # @param title_type [Symbol]
+      # @param journal [Boolean]
+      # @param join_selector [Proc]
       # @return [Array<String>]
       def search_aux_values(record:, title_type:, journal: false, &join_selector)
         return [] if journal && not_a_serial?(record)

data/lib/pennmarc/parser.rb

@@ -12,7 +12,7 @@ module PennMARC
   # Access point for magic calls to helper methods
   class Parser
     # Allow calls to `respond_to?` on parser instances to respond accurately by checking helper classes
-    # @param [String, Symbol] name
+    # @param name [String, Symbol]
     # @return [Boolean]
     def respond_to_missing?(name, include_private = false)
       helper, method_name = parse_call(name)
@@ -26,9 +26,9 @@ module PennMARC
     # Call helper class methods, passing along additional arguments as needed, e.g.:
     # #title_show -> PennMARC::Title.show
     # #subject_facet -> PennMARC::Subject.facet
-    # @param [Symbol] name
-    # @param [MARC::Record] record
-    # @param [Array] opts
+    # @param name [Symbol]
+    # @param record [MARC::Record]
+    # @param opts [Array]
     def method_missing(name, record, *opts)
       helper, method_name = parse_call(name)
       raise NoMethodError unless helper && method_name
@@ -44,7 +44,7 @@ module PennMARC
     private
 
     # Parse out a method call name in the way method_missing is configured to handle
-    # @param [String, Symbol] name
+    # @param name [String, Symbol]
     # @return [Array]
     def parse_call(name)
       call = name.to_s.split('_')

data/lib/pennmarc/test/marc_helpers.rb

@@ -8,23 +8,23 @@ module PennMARC
     # Helper methods for use in constructing MARC objects for testing
     module MarcHelpers
       # Return a MARC::XMLReader that will parse a given file and return MARC::Record objects
-      # @param [String] filename of MARCXML fixture
+      # @param filename [String] filename of MARCXML fixture
       # @return [MARC::Record, NilClass]
       def record_from(filename)
         MARC::XMLReader.new(marc_xml_path(filename)).first
       end
 
       # Create an isolated MARC::Subfield object for use in specs or as part of a MARC::Field
-      # @param [String] code
-      # @param [String] value
+      # @param code [String]
+      # @param value [String]
       # @return [MARC::Subfield]
       def marc_subfield(code, value)
         MARC::Subfield.new code.to_s, value
       end
 
       # Return a new ControlField (000-009)
-      # @param [String] tag
-      # @param [String] value
+      # @param tag [String]
+      # @param value [String]
       # @return [MARC::ControlField]
       def marc_control_field(tag:, value:)
         MARC::ControlField.new tag, value
@@ -38,10 +38,10 @@ module PennMARC
       #                         z: 'United States.',
       #                         '0': http://id.loc.gov/authorities/subjects/sh2008112546 }
       #            )
-      # @param [String (frozen)] tag MARC tag, e.g., 001, 665
-      # @param [String (frozen)] indicator1 MARC indicator, e.g., 0
-      # @param [String (frozen)] indicator2
-      # @param [Hash] subfields hash of subfield values as code => value or code => [value, value]
+      # @param tag [String (frozen)] MARC tag, e.g., 001, 665
+      # @param indicator1 [String (frozen)]  MARC indicator 1, e.g., 0
+      # @param indicator2 [String (frozen)]
+      # @param subfields [Hash] hash of subfield values as code => value or code => [value, value]
       # @return [MARC::DataField]
       def marc_field(tag: 'TST', indicator1: ' ', indicator2: ' ', subfields: {})
         subfield_objects = subfields.each_with_object([]) do |(code, value), array|
@@ -51,8 +51,8 @@ module PennMARC
       end
 
       # Return a MARC::Record containing passed in DataFields
-      # @param [Array<MARC::DataField>] fields
-      # @param [String, nil] leader
+      # @param fields [Array<MARC::DataField>]
+      # @param leader [String, nil]
       # @return [MARC::Record]
       def marc_record(fields: [], leader: nil)
         record = MARC::Record.new

data/lib/pennmarc/util.rb

@@ -56,7 +56,7 @@ module PennMARC
     end
 
     # returns true if a given field has a given subfield value in a given array
-    # @param field [MARC:DataField]
+    # @param field [MARC::DataField]
     # @param subfield [String|Integer|Symbol]
     # @param array [Array]
     # @return [Boolean]
@@ -118,9 +118,9 @@ module PennMARC
     end
 
     # Get all subfield values for a provided subfield from any occurrence of a provided tag/tags
-    # @param tag [String|Array] tags to consider
-    # @param subfield [String|Symbol] to take the values from
-    # @param record [MARC::Record]
+    # @param tag [String,Array] tags to consider
+    # @param subfield [String,Symbol] subfield to take the values from
+    # @param record [MARC::Record] source
     # @return [Array] array of subfield values
     def subfield_values_for(tag:, subfield:, record:)
       record.fields(tag).flat_map do |field|
@@ -155,8 +155,8 @@ module PennMARC
     end
 
     # trim trailing punctuation, manipulating string in place
-    # @param trailer [Symbol|String] to target for removal
-    # @param string [String] to modify
+    # @param trailer [Symbol,String] trailer to target for removal
+    # @param string [String] string to modify
     # @return [String, Nil] string to modify
     def trim_trailing!(trailer, string)
       string.sub! TRAILING_PUNCTUATIONS_PATTERNS[trailer.to_sym], ''
@@ -218,17 +218,17 @@ module PennMARC
     end
 
     # Get the substring of a string up to a given target character
-    # @param string [Object] to split
-    # @param target [Object] character to split upon
-    # @return [String (frozen)]
+    # @param string [String] string to split
+    # @param target [String] character to split upon
+    # @return [String (frozen), nil]
     def substring_before(string, target)
       string.scan(target).present? ? string.split(target, 2).first : ''
     end
 
     # Get the substring of a string after the first occurrence of a target character
-    # @param string [Object] to split
-    # @param target [Object] character to split upon
-    # @return [String (frozen)]
+    # @param string [String] string to split
+    # @param target [String] character to split upon
+    # @return [String (frozen), nil]
     def substring_after(string, target)
       string.scan(target).present? ? string.split(target, 2).second : ''
     end
@@ -262,7 +262,7 @@ module PennMARC
     # @todo handle case of receiving a URI? E.g., http://loc.gov/relator/aut
     # @param relator_code [String, NilClass]
     # @param mapping [Hash]
-    # @return [String, NilClass] full relator string
+    # @return [String, nil] full relator string
     def translate_relator(relator_code, mapping)
       return if relator_code.blank?
 
@@ -272,7 +272,7 @@ module PennMARC
     # Get 650 & 880 for Provenance and Chronology: prefix should be 'PRO' or 'CHR' and may be preceded by a '%'
     # @note 11/2018: do not display $5 in PRO or CHR subjs
     # @param record [MARC::Record]
-    # @param prefix [String] to select from subject field
+    # @param prefix [String] prefix to select from subject field
     # @return [Array] array of values
     def prefixed_subject_and_alternate(record, prefix)
       record.fields(%w[650 880]).filter_map { |field|
@@ -340,7 +340,7 @@ module PennMARC
 
       relator = subfield_values(field, '4').filter_map { |code| translate_relator(code, relator_map) }
 
-      relator = subfield_values(field, relator_term_sf) if relator.blank?
+      relator = subfield_values(field, relator_term_sf).map { |term| trim_trailing(:comma, term) } if relator.blank?
 
       relator = append_trailing(:period, relator.join(', ')) if relator.present?
 
@@ -349,9 +349,9 @@ module PennMARC
 
     # Returns a relator value of the given field. Like append_relator, it prioritizes relator codes found in subfileld
     # $4 and falls back to the specified relator term subfield relator_term_sf if no valid codes are found in $4
-    # @param [MARC::Field] field where relator values are stored
-    # @param [String] relator_term_sf MARC subfield that stores relator term
-    # @param [Hash] relator_map
+    # @param field [MARC::Field] where relator values are stored
+    # @param relator_term_sf [String] MARC subfield that stores relator term
+    # @param relator_map [Hash]
     # @return [String]
     def relator(field:, relator_term_sf:, relator_map: Mappers.relator)
       relator = subfield_values(field, '4').filter_map { |code| translate_relator(code, relator_map) }

data/lib/pennmarc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PennMARC
-  VERSION = '1.0.31'
+  VERSION = '1.0.32'
 end

data/spec/lib/pennmarc/marc_util_spec.rb

@@ -323,6 +323,18 @@ describe 'PennMARC::Util' do
       end
     end
 
+    context 'when relator term has trailing comma' do
+      let(:field) do
+        marc_field(tag: '100', subfields: {
+                     a: 'Capus, Alex,', e: ['author,', 'illustrator,', 'translator']
+                   })
+      end
+
+      it 'punctuates the value as expected' do
+        expect(result).to eq 'Capus, Alex, author, illustrator, translator.'
+      end
+    end
+
     context 'when joined subfield values ends with an open date' do
       let(:joined_subfields) { [field.subfields.first.value, field.subfields.second.value].join(' ') }
       let(:field) { marc_field(tag: '100', subfields: { a: 'Capus, Alex,', d: '1808-', '4': %w[aut ill] }) }

data/spec/support/fixture_helpers.rb

@@ -2,7 +2,7 @@
 
 module FixtureHelpers
   # Get the path for a test MARC XML file
-  # @param [String] filename of MARCXML fixture
+  # @param filename [String] filename of MARCXML fixture
   # @return [String] full path of MARCXML fixture
   def marc_xml_path(filename)
     File.join File.dirname(__FILE__), '..', 'fixtures', 'marcxml', filename

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pennmarc
 version: !ruby/object:Gem::Version
-  version: 1.0.31
+  version: 1.0.32
 platform: ruby
 authors:
 - Mike Kanning
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-29 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport