cocina-models 0.75.0 → 0.76.0

data/lib/cocina/models/mapping/from_mods/related_resource.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Mapping
+      module FromMods
+        # Maps MODS relatedItem to cocina relatedResource
+        class RelatedResource
+          TYPES = Cocina::Models::Mapping::ToMods::RelatedResource::TYPES.invert.freeze
+          DETAIL_TYPES = Cocina::Models::Mapping::ToMods::RelatedResource::DETAIL_TYPES.invert.freeze
+
+          # @param [Nokogiri::XML::Element] resource_element mods or relatedItem element
+          # @param [Cocina::Models::Mapping::FromMods::DescriptionBuilder] description_builder
+          # @param [String] purl
+          # @return [Hash] a hash that can be mapped to a cocina model
+          def self.build(resource_element:, description_builder:, purl:)
+            new(resource_element: resource_element, description_builder: description_builder, purl: purl).build
+          end
+
+          def initialize(resource_element:, description_builder:, purl:)
+            @resource_element = resource_element
+            @description_builder = description_builder
+            @notifier = description_builder.notifier
+            @purl = purl
+          end
+
+          def build
+            related_items + related_purls
+          end
+
+          private
+
+          attr_reader :resource_element, :description_builder, :notifier, :purl
+
+          def related_items
+            resource_element.xpath('mods:relatedItem', mods: Description::DESC_METADATA_NS).filter_map do |related_item|
+              check_other_type(related_item)
+              next { valueAt: related_item['xlink:href'] } if related_item['xlink:href']
+              next if related_item.elements.empty?
+
+              related_item = build_related_item(related_item)
+              # Skip if type only.
+              next if related_item.keys == [:type]
+
+              related_item.presence
+            end
+          end
+
+          def build_related_item(related_item)
+            description_builder.build(resource_element: related_item, require_title: false).tap do |item|
+              item[:displayLabel] = related_item['displayLabel']
+              if related_item['type']
+                item[:type] = normalized_type_for(related_item['type'])
+              elsif related_item['otherType']
+                item[:type] = 'related to'
+                item[:note] ||= []
+                item[:note] <<
+                  { type: 'other relation type', value: related_item['otherType'] }.tap do |note|
+                    note[:uri] = related_item['otherTypeURI'] if related_item['otherTypeURI']
+                    note[:source] = { value: related_item['otherTypeAuth'] } if related_item['otherTypeAuth']
+                  end
+              end
+            end.compact
+          end
+
+          # Normalize type so we can tolerate certain known data errors, but report anything that is not found or not an exact match
+          def normalized_type_for(type)
+            return TYPES.fetch(type) if TYPES.key?(type)
+
+            normalized_type = if type.casecmp('other version').zero?
+                                TYPES['otherVersion']
+                              elsif type.casecmp('isreferencedby').zero?
+                                TYPES['isReferencedBy']
+                              end
+
+            notifier.warn('Invalid related resource type', { resource_type: type })
+            normalized_type
+          end
+
+          def check_other_type(related_item)
+            return unless related_item['type'] && related_item['otherType']
+
+            notifier.warn('Related resource has type and otherType')
+          end
+
+          def related_purls
+            primary_purl_node = Purl.primary_purl_node(resource_element, purl)
+            purl_nodes = resource_element.xpath('mods:location/mods:url',
+                                                mods: Description::DESC_METADATA_NS).select do |url_node|
+              Cocina::Models::Mapping::Purl.purl?(url_node.text) && url_node != primary_purl_node
+            end
+            purl_nodes.map do |purl_node|
+              {
+                purl: Purl.purl_value(purl_node),
+                access: {
+                  note: Purl.purl_note(purl_node).presence
+                }.compact.presence
+              }.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cocina/models/mapping/from_mods/subject.rb

@@ -0,0 +1,413 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/ClassLength
+module Cocina
+  module Models
+    module Mapping
+      module FromMods
+        # Maps subject elements from MODS to cocina
+        class Subject
+          NODE_TYPE = {
+            'classification' => 'classification',
+            'genre' => 'genre',
+            'geographic' => 'place',
+            'occupation' => 'occupation',
+            'temporal' => 'time',
+            'topic' => 'topic'
+          }.freeze
+
+          # @param [Nokogiri::XML::Element] resource_element mods or relatedItem element
+          # @param [Cocina::Models::Mapping::FromMods::DescriptionBuilder] description_builder
+          # @param [String] purl
+          # @return [Hash] a hash that can be mapped to a cocina model
+          def self.build(resource_element:, description_builder:, purl: nil)
+            new(resource_element: resource_element, description_builder: description_builder).build
+          end
+
+          def initialize(resource_element:, description_builder:)
+            @resource_element = resource_element
+            @notifier = description_builder.notifier
+          end
+
+          def build
+            altrepgroup_subject_nodes, other_subject_nodes = AltRepGroup.split(nodes: subject_nodes)
+
+            subjects = (altrepgroup_subject_nodes.map { |subject_nodes| build_parallel_subject(subject_nodes) } +
+              other_subject_nodes.filter_map { |subject_node| build_subject(subject_node) } +
+              build_cartographics).compact
+            Primary.adjust(subjects, 'classification', notifier, match_type: true)
+            Primary.adjust(subjects.reject { |subject| subject[:type] == 'classification' }, 'subject', notifier)
+            subjects
+          end
+
+          private
+
+          attr_reader :resource_element, :notifier
+
+          def build_parallel_subject(parallel_subject_nodes)
+            parallel_subjects = parallel_subject_nodes.filter_map { |subject_node| build_subject(subject_node) }
+            # Moving type up from parallel subjects if they are all the same.
+            move_type = parallel_subjects.uniq { |subject| subject[:type] }.size == 1
+            type = move_type ? parallel_subjects.filter_map { |subject| subject.delete(:type) }.first : nil
+            {
+              parallelValue: parallel_subjects.presence,
+              type: type
+            }.compact.presence
+          end
+
+          # rubocop:disable Metrics/CyclomaticComplexity
+          # rubocop:disable Metrics/AbcSize
+          def build_subject(subject_node)
+            if subject_node['xlink:href']
+              return { valueAt: subject_node['xlink:href'] } if subject_node.elements.empty?
+
+              notifier.warn('Element with both xlink and value')
+            end
+
+            attrs = common_attrs(subject_node)
+            return subject_classification(subject_node, attrs) if subject_node.name == 'classification'
+
+            if subject_node.elements.empty?
+              unless subject_node[:valueURI]
+                notifier.error('Subject has no children nodes', { subject: subject_node.to_s })
+                return nil
+              end
+              notifier.warn('Subject has text', { subject: subject_node.to_s }) if subject_node.content.present?
+            end
+
+            children_nodes = subject_node.xpath('mods:*', mods: Description::DESC_METADATA_NS).to_a.reject do |child_node|
+              child_node.children.empty? && child_node.attributes.empty?
+            end
+            first_child_node = children_nodes.first
+
+            if children_nodes.empty?
+              attrs if subject_node[:valueURI]
+            elsif temporal_range?(children_nodes)
+              temporal_range(children_nodes, attrs)
+            elsif children_nodes.size != 1
+              if geo_code?(children_nodes)
+                geo_code_and_terms(children_nodes, attrs)
+              else
+                structured_value(children_nodes, attrs)
+              end
+            elsif first_child_node.name == 'hierarchicalGeographic'
+              hierarchical_geographic(first_child_node, attrs)
+            else
+              simple_item(first_child_node, attrs)
+            end
+          end
+          # rubocop:enable Metrics/CyclomaticComplexity
+          # rubocop:enable Metrics/AbcSize
+
+          def temporal_range?(children_nodes)
+            children_nodes.all? { |node| node.name == 'temporal' && node['point'] }
+          end
+
+          def geo_code?(children_nodes)
+            children_nodes.any? { |node| node.name == 'geographicCode' }
+          end
+
+          def common_attrs(subject)
+            {
+              displayLabel: subject[:displayLabel],
+              valueAt: subject['xlink:href']
+            }.tap do |attrs|
+              source = {
+                code: code_for(subject),
+                uri: Authority.normalize_uri(subject[:authorityURI]),
+                version: subject['edition'].presence # We are not interested in blank versions
+              }.compact
+              attrs[:source] = source unless source.empty?
+              attrs[:uri] = ValueURI.sniff(subject[:valueURI], notifier)
+              attrs[:encoding] = { code: subject[:encoding] } if subject[:encoding]
+              language_script = LanguageScript.build(node: subject)
+              attrs[:valueLanguage] = language_script if language_script
+              attrs[:status] = 'primary' if subject['usage'] == 'primary'
+            end.compact
+          end
+
+          def code_for(subject)
+            code = Authority.normalize_code(subject[:authority], notifier)
+
+            return nil if code.nil?
+
+            unless SubjectAuthorityCodes::SUBJECT_AUTHORITY_CODES.include?(code)
+              notifier.warn('Subject has unknown authority code',
+                            { code: code })
+            end
+            code
+          end
+
+          def structured_value(node_set, attrs)
+            values = node_set.filter_map { |node| simple_item(node) }
+            if values.present?
+              Primary.adjust(values, 'genre', notifier, match_type: true)
+              attrs = attrs.merge(structuredValue: values)
+              adjust_source(attrs)
+              adjust_lang(attrs)
+            end
+
+            # Authority should be 'naf', not 'lcsh'
+            attrs[:source][:code] = 'naf' if attrs.dig(:source, :uri) == 'http://id.loc.gov/authorities/names/'
+
+            attrs.presence
+          end
+
+          def geo_code_and_terms(node_set, attrs)
+            values = node_set.filter_map { |node| simple_item(node) }
+            if values.present?
+              # Removes type from values
+
+              values.each { |value| value.delete(:type) }
+              # If nodes are all the same type then groupedValue; otherwise, a parallelValue.
+              attrs = if node_set.all? { |node| node.name == node_set.first.name }
+                        attrs.merge(groupedValue: values)
+                      else
+                        attrs.merge(parallelValue: values)
+                      end
+              adjust_source(attrs)
+            end
+            attrs[:type] = 'place'
+            attrs.presence
+          end
+
+          def adjust_lang(attrs)
+            # If all values have same valueLanguage then move to subject.
+            check_value_language = attrs[:structuredValue].first[:valueLanguage]
+            return unless check_value_language && attrs[:structuredValue].all? do |value|
+                            value[:valueLanguage] == check_value_language
+                          end
+
+            attrs[:valueLanguage] = check_value_language
+            attrs[:structuredValue].each { |value| value.delete(:valueLanguage) }
+          end
+
+          def adjust_source(attrs)
+            values = attrs[:structuredValue] || attrs[:groupedValue]
+            return if values.nil?
+
+            remove_source_prior(attrs)
+
+            values.each do |value|
+              uri_or_code = value[:uri] || value[:code]
+              # If attr has source, add to all values that have valueURI but no source.
+              value[:source] ||= attrs[:source] if attrs[:source] && uri_or_code
+              # If value has source and source matches subject source and no valueURI, then remove source.
+              value.delete(:source) if value[:source] && attrs[:source] == value[:source] && !uri_or_code
+            end
+
+            remove_source_post(attrs)
+          end
+
+          def remove_source_prior(attrs)
+            # Remove source if no uri and all values have source and all are not same type
+            values = attrs[:structuredValue] || attrs[:groupedValue]
+            return if attrs[:uri] ||
+                      values.any? { |value| value[:source].nil? } ||
+                      values.any? { |value| value[:type] != values.first[:types] }
+
+            attrs.delete(:source)
+          end
+
+          def remove_source_post(attrs)
+            # Delete source if no uri and all values have same source and any have uri or code.
+            values = attrs[:structuredValue] || attrs[:groupedValue]
+            return unless attrs[:uri].nil? &&
+                          values.all? { |value| equal_sources?(attrs[:source], value[:source]) } &&
+                          values.any? { |value| value[:uri] || value[:code] }
+
+            # values.all? { |value| value[:source] == attrs[:source] || value.dig(:source, :code) == attrs.dig(:source, :code) } &&
+
+            attrs.delete(:source)
+          end
+
+          def equal_sources?(source1, source2)
+            return true if source1 == source2
+            return false if source1.nil? || source2.nil?
+            return true if source1[:code] == source2[:code]
+            return true if lcsh?(source1[:code]) && lcsh?(source2[:code])
+
+            false
+          end
+
+          def lcsh?(code)
+            %w[lcsh naf].include?(code)
+          end
+
+          def hierarchical_geographic(hierarchical_geographic_node, attrs)
+            attrs = attrs.deep_merge(common_attrs(hierarchical_geographic_node))
+            node_set = hierarchical_geographic_node.xpath('*')
+            values = node_set.map do |node|
+              {
+                value: node.text,
+                type: decamelize(node.name)
+              }
+            end
+            attrs.merge(structuredValue: values, type: 'place')
+          end
+
+          def decamelize(str)
+            str.underscore.tr('_', ' ')
+          end
+
+          def subject_classification(subject_classification_node, attrs)
+            unless attrs[:uri] || attrs.dig(
+              :source, :code
+            ) || attrs.dig(:source, :uri)
+              notifier.warn('No source given for classification value',
+                            value: subject_classification_node.text)
+            end
+
+            classification_attributes = {}.tap do |attributes|
+              attributes[:type] = 'classification'
+              attributes[:value] = subject_classification_node.text
+              if subject_classification_node[:displayLabel]
+                attributes[:displayLabel] =
+                  subject_classification_node[:displayLabel]
+              end
+              attributes[:status] = 'primary' if subject_classification_node['usage'] == 'primary'
+            end
+            attrs.merge(classification_attributes)
+          end
+
+          # @return [Hash, NilClass]
+          def simple_item(node, orig_attrs = {})
+            attrs = orig_attrs.deep_merge(common_attrs(node))
+            case node.name
+            when 'name'
+              name(node, attrs)
+            when 'titleInfo'
+              title(node, attrs, orig_attrs)
+            when 'geographicCode'
+              code = node.text
+              code = normalized_marcgac(code) if attrs.dig(:source, :code) == 'marcgac'
+              attrs.merge(code: code, type: 'place')
+            when 'cartographics'
+              # Cartographics are built separately
+              nil
+            when 'Topic'
+              notifier.warn('<subject> has <Topic>; normalized to "topic"')
+              attrs.merge(value: node.text, type: 'topic')
+            else
+              node_type = node_type_for(node, attrs[:displayLabel])
+              attrs.merge(value: node.text, type: node_type) if node_type
+            end
+          end
+
+          # Strip any trailing dashes
+          def normalized_marcgac(code)
+            code.sub(/-+$/, '')
+          end
+
+          def title(node, attrs, orig_attrs)
+            title_attrs = TitleBuilder.build(title_info_element: node, notifier: notifier)
+            unless title_attrs
+              notifier.warn('<subject> found with an empty <titleInfo>; Skipping')
+              return
+            end
+
+            if node['type'] == 'uniform'
+              title_attrs[:type] = 'uniform'
+              attrs[:groupedValue] = [title_attrs]
+              if (uri = attrs.delete(:uri))
+                attrs[:groupedValue].each { |value| value[:uri] = uri }
+              end
+              if (source = attrs.delete(:source))
+                attrs[:groupedValue].each { |value| value[:source] = source }
+              end
+              attrs[:uri] = orig_attrs[:uri]
+              attrs[:source] = orig_attrs[:source]
+            else
+              attrs = attrs.merge(title_attrs)
+            end
+            attrs[:type] = 'title'
+            attrs.compact
+          end
+
+          def name(node, attrs)
+            name_type = name_type_for_subject(node)
+            attrs[:type] = name_type if name_type
+            full_name = NameBuilder.build(name_elements: [node], notifier: notifier)
+            return nil if full_name[:name].nil?
+
+            name_attrs = if full_name[:name].size > 1
+                           {
+                             parallelValue: full_name[:name]
+                           }
+                         else
+                           full_name[:name].first
+                         end
+            notes = name_notes_for(full_name[:role], node)
+            name_attrs[:note] = notes unless notes.empty?
+            name_attrs.merge(attrs)
+          end
+
+          def name_notes_for(roles, name_node)
+            notes = Array(roles).map { |role| role.merge({ type: 'role' }) }
+            name_node.xpath('mods:affiliation', mods: Description::DESC_METADATA_NS).each do |affil_node|
+              notes << { value: affil_node.text, type: 'affiliation' }
+            end
+            name_node.xpath('mods:description', mods: Description::DESC_METADATA_NS).each do |descr_node|
+              notes << { value: descr_node.text, type: 'description' }
+            end
+            notes
+          end
+
+          def node_type_for(node, display_label)
+            return 'event' if display_label == 'Event'
+
+            return NODE_TYPE.fetch(node.name) if NODE_TYPE.key?(node.name)
+
+            notifier.warn('Unexpected node type for subject', name: node.name)
+            nil
+          end
+
+          def name_type_for_subject(node)
+            name_type = node[:type]
+
+            return nil if node['xlink:href'] && node.children.empty?
+
+            return 'name' unless name_type
+
+            return 'topic' if name_type.casecmp('topic').zero?
+
+            Contributor::ROLES.fetch(name_type) if Contributor::ROLES.key?(name_type)
+          end
+
+          def subject_nodes
+            resource_element.xpath('mods:subject',
+                                   mods: Description::DESC_METADATA_NS) + resource_element.xpath('mods:classification',
+                                                                                                 mods: Description::DESC_METADATA_NS)
+          end
+
+          def temporal_range(children_nodes, attrs)
+            attrs[:structuredValue] = children_nodes.select { |node| node.content.present? }.map do |node|
+              {
+                type: node['point'],
+                value: node.content
+              }
+            end
+            attrs[:type] = 'time'
+            attrs[:encoding] = { code: children_nodes.first['encoding'] }
+            attrs
+          end
+
+          def build_cartographics
+            coordinates = subject_nodes.map do |subject_node|
+              subject_node.xpath('mods:cartographics/mods:coordinates',
+                                 mods: Description::DESC_METADATA_NS).filter_map do |coordinate_node|
+                coordinate = coordinate_node.content
+                next if coordinate.blank?
+
+                coordinate.delete_prefix('(').delete_suffix(')')
+              end
+            end.flatten.compact.uniq
+
+            coordinates.map { |coordinate| { value: coordinate, type: 'map coordinates' } }
+          end
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength