cocina-models 0.79.0 → 0.82.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 193f5886756d2fd6432e90ab5323f6ed5a11c699cb97f49d61394bc5fafd5f53
-  data.tar.gz: ecb1493a56b7b20f9733084c8a9a115e3a3c6639a8072bc371f53a51d69d0a2c
+  metadata.gz: ebc24ff8dbe8eb1fe740eb977abb73abc504409aa510905395e6660adcd05b3b
+  data.tar.gz: 62ad4e7cafce859250323e92cc2173257957b16775e767224a4de2e9fd639bae
 SHA512:
-  metadata.gz: 8cc210b897872f3b90fd59e12f381f049b1389b0cf3d798a0375eea57282cf456c6591a8d474c5c612253123bca01ed9a9b931129c89153b8a8dae3ad713254b
-  data.tar.gz: f1a23590223b7760780e3b547b053355a1ba600fdc468ce563aef20a4c38cd3571345bde621f3f9f23248d27c29f0f3b5a829dd0c7d5c08d95d27efec472453d
+  metadata.gz: 7a3b0ed8ab383f945450d42343dbaed6e709854ff0f3deca1f62b93c79883d3157b42f14cdaafd9392ef858620a0c58ae6867c16037c627499efddf3cb33880b
+  data.tar.gz: 9e1084ea73c6f547eab7b8a076d9e2a61a46361c9da1541effca8529d48d032621b6cd5868bd2886308aea1f834b4c586ae1058ca6f67f0315393e4eb632bbb9

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-04-27 19:20:35 UTC using RuboCop version 1.28.2.
+# on 2022-06-08 23:20:02 UTC using RuboCop version 1.28.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -35,7 +35,7 @@ Lint/UnusedMethodArgument:
     - 'lib/cocina/models/mapping/from_mods/subject.rb'
     - 'lib/cocina/models/mapping/to_mods/event.rb'
 
-# Offense count: 95
+# Offense count: 96
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 40
@@ -56,16 +56,17 @@ Metrics/ParameterLists:
 RSpec/DescribeClass:
   Enabled: false
 
-# Offense count: 89
+# Offense count: 87
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 128
 
-# Offense count: 9
+# Offense count: 10
 # Configuration parameters: Max.
 RSpec/NestedGroups:
   Exclude:
     - 'spec/cocina/models/mapping/normalizers/mods/origin_info_normalizer_spec.rb'
+    - 'spec/cocina/models/validators/date_time_validator_spec.rb'
 
 # Offense count: 1
 # Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
@@ -87,7 +88,7 @@ Style/MultilineBlockChain:
     - 'lib/cocina/models/mapping/to_mods/form.rb'
     - 'lib/cocina/models/mapping/to_mods/subject.rb'
 
-# Offense count: 206
+# Offense count: 223
 # This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
 # URISchemes: http, https

data/cocina-models.gemspec

@@ -28,12 +28,15 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'deprecation'
   spec.add_dependency 'dry-struct', '~> 1.0'
   spec.add_dependency 'dry-types', '~> 1.1'
+  spec.add_dependency 'edtf' # used for date/time validation
   spec.add_dependency 'equivalent-xml' # for diffing MODS
+  spec.add_dependency 'jsonpath' # used for date/time validation
   spec.add_dependency 'nokogiri'
   spec.add_dependency 'openapi3_parser' # Parsing openapi doc
   # Match these version requirements to what committee wants,
   # so that our client (non-committee) users have the same dependencies.
   spec.add_dependency 'openapi_parser', '>= 0.11.1', '< 1.0'
+  spec.add_dependency 'rss' # used for date/time validation
   spec.add_dependency 'super_diff'
   spec.add_dependency 'thor'
   spec.add_dependency 'zeitwerk', '~> 2.1'

data/docs/description_types.md

@@ -385,6 +385,7 @@ _Path: identifier.type_
   * record id
   * Senate Number
   * Series
+  * SICI
   * SIRSI
   * Source ID
   * sourceID

data/lib/cocina/generator/schema.rb

@@ -13,8 +13,8 @@ module Cocina
           # frozen_string_literal: true
 
           module Cocina
-            module Models
-              class #{name} < Struct
+            module Models#{'              '}
+              #{preamble}class #{name} < Struct
 
                 #{validate}
                 #{types}

data/lib/cocina/generator/schema_base.rb

@@ -41,6 +41,12 @@ module Cocina
         "# #{schema_doc.description}\n"
       end
 
+      def deprecation
+        return '' unless schema_doc.deprecated?
+
+        "# DEPRECATED\n"
+      end
+
       def example
         return '' unless schema_doc.example
 
@@ -82,6 +88,10 @@ module Cocina
           'Strict::String'
         end
       end
+
+      def preamble
+        "#{deprecation}#{description}#{example}#{relaxed_comment}"
+      end
     end
   end
 end

data/lib/cocina/generator/schema_value.rb

@@ -19,10 +19,6 @@ module Cocina
         "Types::#{dry_datatype(schema_doc)}#{optional}#{default}#{enum}"
       end
 
-      def preamble
-        "#{description}#{example}#{relaxed_comment}"
-      end
-
       def enum
         return '' if !schema_doc.enum || relaxed
 

data/lib/cocina/models/access_role.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Access role conferred by an AdminPolicy to objects within it. (used by Argo)
     class AccessRole < Struct
       # Name of role
       attribute :name, Types::Strict::String.enum('dor-apo-depositor', 'dor-apo-manager', 'dor-apo-viewer', 'sdr-administrator', 'sdr-viewer', 'hydrus-collection-creator', 'hydrus-collection-manager', 'hydrus-collection-depositor', 'hydrus-collection-item-depositor', 'hydrus-collection-reviewer', 'hydrus-collection-viewer')

data/lib/cocina/models/access_role_member.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Represents a user or group that is a member of an AccessRole
     class AccessRoleMember < Struct
       include Checkable
 

data/lib/cocina/models/admin_policy_access_template.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Provides the template of access settings that is copied to the items goverend by an AdminPolicy. This is almost the same as DROAccess, but it provides no defaults and has no embargo.
     class AdminPolicyAccessTemplate < Struct
       attribute? :view, Types::Strict::String.enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
       # Available for controlled digital lending.

data/lib/cocina/models/admin_policy_administrative.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Administrative properties for an AdminPolicy
     class AdminPolicyAdministrative < Struct
       attribute(:accessTemplate, AdminPolicyAccessTemplate.default { AdminPolicyAccessTemplate.new })
       attribute :registrationWorkflow, Types::Strict::Array.of(Types::Strict::String).default([].freeze)

data/lib/cocina/models/admin_policy_with_metadata.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Admin Policy with addition object metadata.
     class AdminPolicyWithMetadata < Struct
       include Validatable
 

data/lib/cocina/models/applies_to.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Property model for indicating the parts, aspects, or versions of the resource to which a descriptive element is applicable.
     class AppliesTo < Struct
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).default([].freeze)
     end

data/lib/cocina/models/builders/name_title_group_builder.rb

@@ -92,7 +92,6 @@ module Cocina
           # ignoring groupedValue
           slices.flatten
         end
-        # private_class_method :value_slices
 
         # for a given Hash (from a Cocina DescriptiveValue or Title or Name or ...)
         # result will be either

data/lib/cocina/models/collection.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # A group of Digital Repository Objects that indicate some type of conceptual grouping within the domain that is worth reusing across the system.
     class Collection < Struct
       include Validatable
 

data/lib/cocina/models/collection_access.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Access metadata for collections
     class CollectionAccess < Struct
       # Access level
       attribute? :view, Types::Strict::String.default('dark').enum('world', 'dark')

data/lib/cocina/models/collection_with_metadata.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Collection with addition object metadata.
     class CollectionWithMetadata < Struct
       include Validatable
 

data/lib/cocina/models/contributor.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Property model for describing agents contributing in some way to the creation and history of the resource.
     class Contributor < Struct
       attribute :name, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Entity type of the contributor (person, organization, etc.). See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.

data/lib/cocina/models/descriptive_access_metadata.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Information about how to access digital and physical versions of the object.
     class DescriptiveAccessMetadata < Struct
       attribute :url, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :physicalLocation, Types::Strict::Array.of(DescriptiveValue).default([].freeze)

data/lib/cocina/models/descriptive_admin_metadata.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Information about this resource description.
     class DescriptiveAdminMetadata < Struct
       attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
       attribute :event, Types::Strict::Array.of(Event).default([].freeze)

data/lib/cocina/models/descriptive_basic_value.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Basic value model for descriptive elements. Can only have one of value, parallelValue, groupedValue, or structuredValue.
     class DescriptiveBasicValue < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)

data/lib/cocina/models/descriptive_geographic_metadata.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Value model for mods geographic extension metadata
     class DescriptiveGeographicMetadata < Struct
       attribute :form, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :subject, Types::Strict::Array.of(DescriptiveValue).default([].freeze)

data/lib/cocina/models/descriptive_grouped_value.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Value model for a set of descriptive elements grouped together in an unstructured way.
     class DescriptiveGroupedValue < Struct
       attribute :groupedValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end

data/lib/cocina/models/descriptive_parallel_contributor.rb

@@ -2,6 +2,8 @@
 
 module Cocina
   module Models
+    # DEPRECATED
+    # Value model for multiple representations of information about the same contributor (e.g. in different languages).
     class DescriptiveParallelContributor < Struct
       attribute :name, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Entity type of the contributor (person, organization, etc.). See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.

data/lib/cocina/models/descriptive_parallel_event.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Value model for multiple representations of information about the same event (e.g. in different languages).
     class DescriptiveParallelEvent < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Description of the event (creation, publication, etc.).

data/lib/cocina/models/descriptive_parallel_value.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Value model for multiple representations of the same information (e.g. in different languages).
     class DescriptiveParallelValue < Struct
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end

data/lib/cocina/models/descriptive_structured_value.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Value model for descriptive elements structured as typed, ordered values.
     class DescriptiveStructuredValue < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
     end

data/lib/cocina/models/descriptive_value.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Default value model for descriptive elements.
     class DescriptiveValue < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)

data/lib/cocina/models/descriptive_value_language.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Language of the descriptive element value
     class DescriptiveValueLanguage < Struct
       # Code representing the standard or encoding.
       attribute? :code, Types::Strict::String

data/lib/cocina/models/dro.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction is describable for our domain’s purposes, i.e. for management needs within our system.
     class DRO < Struct
       include Validatable
 

data/lib/cocina/models/dro_structural.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Structural metadata
     class DROStructural < Struct
       attribute :contains, Types::Strict::Array.of(FileSet).default([].freeze)
       attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).default([].freeze)

data/lib/cocina/models/dro_with_metadata.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # DRO with addition object metadata.
     class DROWithMetadata < Struct
       include Validatable
 

data/lib/cocina/models/event.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Property model for describing events in the history of the resource.
     class Event < Struct
       attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).default([].freeze)
       # Description of the event (creation, publication, etc.).

data/lib/cocina/models/file.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Binaries that are the basis of what our domain manages. Binaries here do not include metadata files generated for the domain's own management purposes.
     class File < Struct
       include Checkable
 

data/lib/cocina/models/file_access.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Access metadata for files
     class FileAccess < Struct
       # Access level.
       # Validation of this property is relaxed. See the openapi for full validation.

data/lib/cocina/models/file_set.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Relevant groupings of Files. Also called a File Grouping.
     class FileSet < Struct
       include Checkable
 

data/lib/cocina/models/file_set_structural.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Structural metadata
     class FileSetStructural < Struct
       attribute :contains, Types::Strict::Array.of(File).default([].freeze)
     end

data/lib/cocina/models/geographic.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Geographic metadata
     class Geographic < Struct
       # Geographic ISO 19139 XML metadata
       attribute :iso19139, Types::Strict::String

data/lib/cocina/models/language.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Languages, scripts, symbolic systems, and notations used in all or part of a resource or its descriptive metadata.
     class Language < Struct
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).default([].freeze)
       # Code value of the descriptive element.

data/lib/cocina/models/mapping/escape_html.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Mapping
+      # Escaps HTML entities as CDATA for MODS since HTML is not permitted in MODS
+      class EscapeHtml
+        # @param [String] data
+        # @param [Nokogiri::XML::Builder]
+        def self.with_cdata(data, builder)
+          tokens = data.split(%r{(</?(?:i|cite)>)})
+          tokens.map do |token|
+            if /\A<.+>\z/.match? token
+              builder.cdata(token)
+            else
+              builder.text(token)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -36,13 +36,13 @@ module Cocina
 
           def build_parallel
             names = {
-              parallelValue: name_elements.map { |name_node| build_parallel_name(name_node) },
+              parallelValue: build_parallel_values,
               type: type_for(name_elements.first['type']),
               status: name_elements.filter_map { |name_element| name_element['usage'] }.first
             }.compact
             { name: [names] }.tap do |attrs|
-              roles = name_elements.flat_map { |name_node| build_roles(name_node) }.compact.uniq
-              attrs[:role] = roles.presence
+              attrs[:role] = name_elements.flat_map { |name_node| build_roles(name_node) }.compact.uniq.presence
+              attrs[:note] = name_elements.flat_map { |name_node| build_affiliation_notes(name_node) }.compact.uniq.presence
             end.compact
           end
 
@@ -51,8 +51,8 @@ module Cocina
               status: name_node['usage']
             }.compact.merge(common_lang_script(name_node))
 
-            name_attrs = name_attrs.merge(common_name(name_node, name_attrs[:name]))
-            name_parts = build_name_parts(name_node)
+            name_attrs = name_attrs.merge(common_name(name_node, name_attrs[:name], is_parallel: true))
+            name_parts = build_name_parts(name_node, parallel: true)
             notifier.warn('Missing name/namePart element') if name_parts.all?(&:empty?)
             name_parts.each { |name_part| name_attrs = name_part.merge(name_attrs) }
             name_attrs.compact
@@ -85,9 +85,9 @@ module Cocina
             }.compact.merge(common_name(name_node, name_parts))
           end
 
-          def common_name(name_node, name)
+          def common_name(name_node, name, is_parallel: false)
             {
-              note: build_notes(name_node),
+              note: build_notes(name_node, is_parallel: is_parallel),
               identifier: build_identifier(name_node)
             }.tap do |attrs|
               roles = build_roles(name_node)
@@ -106,7 +106,17 @@ module Cocina
             end.compact
           end
 
-          def build_name_parts(name_node)
+          def build_parallel_values
+            parallel_values = []
+            name_elements.each do |name_node|
+              parallel_values << build_parallel_name(name_node)
+              display_val = display_value(name_node)
+              parallel_values << display_val if display_val
+            end
+            parallel_values.compact
+          end
+
+          def build_name_parts(name_node, parallel: false)
             name_part_nodes = name_node.xpath('mods:namePart', mods: Description::DESC_METADATA_NS)
             alternative_name_nodes = name_node.xpath('mods:alternativeName', mods: Description::DESC_METADATA_NS)
 
@@ -116,23 +126,64 @@ module Cocina
               parts << { valueAt: name_node['xlink:href'] } if name_node['xlink:href']
               parts << common_authority(name_node) if name_node['valueURI']
             when 1
-              parts << build_name_part(name_node, name_part_nodes.first,
-                                       default_type: alternative_name_nodes.present?)
-                       .merge(common_authority(name_node)).merge(common_lang_script(name_node)).presence
+              name = build_simple_value_name(name_node, name_part_nodes.first, alternative_name_nodes, parallel)
+              parts << name.merge(common_authority(name_node)).merge(common_lang_script(name_node)).presence
             else
-              vals = name_part_nodes.filter_map do |name_part|
-                build_name_part(name_node, name_part, default_type: name_node['type'] != 'corporate').presence
-              end
-              parts << { structuredValue: vals }.merge(common_authority(name_node)).merge(common_lang_script(name_node))
+              name = build_structured_value_name(name_node, name_part_nodes)
+              parts << name.merge(common_authority(name_node)).merge(common_lang_script(name_node))
             end
 
             parts = build_alternative_name(alternative_name_nodes, parts) if alternative_name_nodes.present?
-
-            display_form = name_node.xpath('mods:displayForm', mods: Description::DESC_METADATA_NS).first
-            parts << { value: display_form.text, type: 'display' } if display_form
             parts.compact
           end
 
+          def build_simple_value_name(name_node, name_part_node, alternative_name_nodes, parallel)
+            name_value_hash = build_name_part(name_node, name_part_node, default_type: alternative_name_nodes.present?)
+            display_form_node = name_node.xpath('mods:displayForm', mods: Description::DESC_METADATA_NS).first
+            if display_form_node.present? && !parallel
+              cocina_contrib_name =
+                {
+                  parallelValue: [
+                    name_value_hash
+                  ]
+                }
+              add_display_parallel_value(name_node, cocina_contrib_name)
+            else
+              name_value_hash
+            end
+          end
+
+          def build_structured_value_name(name_node, name_part_nodes)
+            vals = name_part_nodes.filter_map { |name_part_node| build_name_part(name_node, name_part_node, default_type: name_node['type'] != 'corporate').presence }
+            display_form_node = name_node.xpath('mods:displayForm', mods: Description::DESC_METADATA_NS).first
+            if display_form_node.present?
+              cocina_contrib_name =
+                {
+                  parallelValue: [
+                    { structuredValue: vals }
+                  ]
+                }
+              add_display_parallel_value(name_node, cocina_contrib_name)
+            else
+              { structuredValue: vals }
+            end
+          end
+
+          def add_display_parallel_value(name_node, cocina_contrib_name)
+            display_form = name_node.xpath('mods:displayForm', mods: Description::DESC_METADATA_NS)&.text
+            return cocina_contrib_name if display_form.blank?
+
+            display_parallel_value = display_value(name_node)
+            cocina_contrib_name[:parallelValue] << display_parallel_value if display_parallel_value && cocina_contrib_name[:parallelValue].present?
+
+            cocina_contrib_name
+          end
+
+          def display_value(name_node)
+            display_form = name_node.xpath('mods:displayForm', mods: Description::DESC_METADATA_NS)&.text
+            { value: display_form, type: 'display' } if display_form.present?
+          end
+
           def build_name_part(name_node, name_part_node, default_type: true)
             if name_part_node.content.blank? && !name_part_node['xlink:href']
               notifier.warn('name/namePart missing value')
@@ -224,12 +275,8 @@ module Cocina
             end.presence
           end
 
-          def build_notes(name_node)
+          def build_notes(name_node, is_parallel:)
             [].tap do |parts|
-              name_node.xpath('mods:affiliation', mods: Description::DESC_METADATA_NS).each do |affiliation_node|
-                parts << { value: affiliation_node.text, type: 'affiliation' }
-              end
-
               description = name_node.xpath('mods:description', mods: Description::DESC_METADATA_NS).first
               if description
                 parts << if description.text == UNCITED_DESCRIPTION
@@ -238,9 +285,18 @@ module Cocina
                            { value: description.text, type: 'description' }
                          end
               end
+              parts.concat(build_affiliation_notes(name_node)) unless is_parallel
             end.presence
           end
 
+          def build_affiliation_notes(name_node)
+            [].tap do |parts|
+              name_node.xpath('mods:affiliation', mods: Description::DESC_METADATA_NS).each do |affiliation_node|
+                parts << { value: affiliation_node.text, type: 'affiliation' }
+              end
+            end
+          end
+
           def build_roles(name_node)
             role_nodes = name_node.xpath('mods:role', mods: Description::DESC_METADATA_NS)
             role_nodes.filter_map { |role_node| role_for(role_node) }.presence

data/lib/cocina/models/mapping/normalizers/mods/name_normalizer.rb

@@ -20,6 +20,7 @@ module Cocina
 
             def normalize
               normalize_parallel_name_role
+              normalize_parallel_affiliation_note
               normalize_text_role_term
               normalize_role_term
               normalize_role # must be after normalize_role_term
@@ -35,10 +36,13 @@ module Cocina
 
             attr_reader :ng_xml
 
+            def grouped_name_nodes
+              name_nodes = ng_xml.root.xpath('//mods:name[@altRepGroup]', mods: ModsNormalizer::MODS_NS)
+              name_nodes.group_by { |name_node| name_node['altRepGroup'] }.values.reject { |name_node_group| name_node_group.size == 1 }
+            end
+
             def normalize_parallel_name_role
               # For parallel names, all should have the same roles.
-              name_nodes = ng_xml.root.xpath('//mods:name[@altRepGroup]', mods: ModsNormalizer::MODS_NS)
-              grouped_name_nodes = name_nodes.group_by { |name_node| name_node['altRepGroup'] }.values.reject { |name_node_group| name_node_group.size == 1 }
               grouped_name_nodes.each do |name_node_group|
                 name_node_with_role = name_node_group.find { |name_node| role_node_for(name_node) }
                 next unless name_node_with_role
@@ -58,6 +62,27 @@ module Cocina
               name_node.xpath('mods:role', mods: ModsNormalizer::MODS_NS).first
             end
 
+            def normalize_parallel_affiliation_note
+              # For parallel names, all should have the same affiliation.
+              grouped_name_nodes.each do |name_node_group|
+                name_node_with_affiliation = name_node_group.find { |name_node| affiliation_node_for(name_node) }
+                next unless name_node_with_affiliation
+
+                name_node_group.each do |name_node|
+                  next if name_node == name_node_with_affiliation
+
+                  existing_affiliation_node = affiliation_node_for(name_node)
+                  existing_affiliation_node&.remove
+
+                  name_node << affiliation_node_for(name_node_with_affiliation).dup
+                end
+              end
+            end
+
+            def affiliation_node_for(name_node)
+              name_node.xpath('mods:affiliation', mods: ModsNormalizer::MODS_NS).first
+            end
+
             def normalize_text_role_term
               # Add the type="text" attribute to roleTerms that don't have a type (seen in MODS 3.3 druid:yy910cj7795)
               ng_xml.root.xpath('//mods:roleTerm[not(@type)]', mods: ModsNormalizer::MODS_NS).each do |role_term_node|

data/lib/cocina/models/mapping/to_mods/name_writer.rb

@@ -36,25 +36,11 @@ module Cocina
             if contributor.type == 'unspecified others'
               write_etal
             elsif contributor.name.present?
+              # Expect contributor to have a single value for name property
               contrib_name = contributor.name.first
-              parallel_values = contrib_name.parallelValue
-              if parallel_values.present?
-                altrepgroup_id = id_generator.next_altrepgroup
-                parallel_values.each do |parallel_contrib_name|
-                  Cocina::Models::Builders::NameTitleGroupBuilder.value_slices(parallel_contrib_name)&.each do |parallel_contrib_name_slice|
-                    if name_title_vals_index[parallel_contrib_name_slice]
-                      name_title_group = name_title_vals_index[parallel_contrib_name_slice]&.values&.first
-                      write_parallel_contributor(contributor, contrib_name, parallel_contrib_name,
-                                                 name_title_group, altrepgroup_id)
-                    else
-                      # TODO:  want a way to notify that we hit a problem - either notifier or HB error (issue #3751)
-                      #  OR validate for semantic correctness upon creation/update so we can't get here.
-                      #  notifier.warn("For contributor name '#{parallel_contrib_name_val}', no title matching '#{title_from_contrib}'")
-                      write_parallel_contributor(contributor, contrib_name, parallel_contrib_name, nil,
-                                                 altrepgroup_id)
-                    end
-                  end
-                end
+              parallel_name_values = contrib_name.parallelValue
+              if parallel_name_values.present?
+                write_contributor_with_parallel_names(parallel_name_values, contrib_name)
               else
                 write_contributor(contributor)
               end
@@ -105,7 +91,50 @@ module Cocina
             end
           end
 
-          def write_parallel_contributor(contributor, name, parallel_name, name_title_group, altrepgroup_id)
+          def write_contributor_with_parallel_names(parallel_name_values, contrib_name)
+            display_type_parallel_name = display_type_parallel_name(parallel_name_values)
+            if parallel_name_values.size == 1
+              contrib_name_value_slice = Cocina::Models::Builders::NameTitleGroupBuilder.value_slices(parallel_name_values.first)
+              name_title_group = name_title_vals_index[contrib_name_value_slice]&.values&.first
+              write_name_from_parallel(contributor, contributor.name.first, parallel_name_values, name_title_group, nil)
+            elsif parallel_name_values.size == 2 && display_type_parallel_name
+              contrib_name_value_slice = Cocina::Models::Builders::NameTitleGroupBuilder.value_slices(parallel_name_values.first)
+              name_title_group = name_title_vals_index[contrib_name_value_slice]&.values&.first
+              write_name_with_display_form(contributor, contributor.name.first, parallel_name_values, 0, name_title_group, nil)
+            else
+              write_multiple_parallel_contributors(parallel_name_values, contrib_name)
+            end
+          end
+
+          def write_multiple_parallel_contributors(parallel_name_values, contrib_name)
+            altrepgroup_id = id_generator.next_altrepgroup
+            parallel_name_values.each_with_index do |parallel_contrib_name, index|
+              display_name_present = parallel_name_values[index + 1].present? && parallel_name_values[index + 1].type == 'display'
+              Cocina::Models::Builders::NameTitleGroupBuilder.value_slices(parallel_contrib_name)&.each do |parallel_contrib_name_slice|
+                if name_title_vals_index[parallel_contrib_name_slice]
+                  name_title_group = name_title_vals_index[parallel_contrib_name_slice]&.values&.first
+                  if display_name_present
+                    # associate type 'display' with the previous value
+                    write_name_with_display_form(contributor, contrib_name, parallel_name_values, index, name_title_group, altrepgroup_id)
+                  else
+                    write_name_from_parallel(contributor, contrib_name, parallel_contrib_name, name_title_group, altrepgroup_id)
+                  end
+                elsif display_name_present
+                  # TODO:  want a way to notify that we hit a problem - either notifier or HB error (issue #3751)
+                  #  OR validate for semantic correctness upon creation/update so we can't get here.
+                  #  notifier.warn("For contributor name '#{parallel_contrib_name_slice}', no contrib matching")
+                  write_name_with_display_form(contributor, contrib_name, parallel_name_values, index, nil, altrepgroup_id)
+                elsif parallel_name_values[index].type == 'display'
+                  # we assume we included this as part of a previous name
+                  next
+                else
+                  write_name_from_parallel(contributor, contrib_name, parallel_contrib_name, nil, altrepgroup_id)
+                end
+              end
+            end
+          end
+
+          def write_name_from_parallel(contributor, name, parallel_name, name_title_group, altrepgroup_id)
             attributes = parallel_name_attributes(name, parallel_name, name_title_group, altrepgroup_id)
             type_attr = NAME_TYPE.fetch(contributor.type, name_title_group ? 'personal' : nil)
             attributes[:type] = type_attr if type_attr
@@ -121,6 +150,37 @@ module Cocina
             end
           end
 
+          # rubocop:disable Metrics/ParameterLists
+          def write_name_with_display_form(contributor, name, parallel_name_values, index, name_title_group, altrepgroup_id)
+            display_type_parallel_name = display_type_parallel_name(parallel_name_values)
+            parallel_name = parallel_name_values[index]
+            return if parallel_name.blank?
+
+            attributes = if altrepgroup_id.present?
+                           parallel_name_attributes(name, parallel_name, name_title_group, altrepgroup_id)
+                         else
+                           name_attributes(contributor, name, nil)
+                         end
+            type_attr = NAME_TYPE.fetch(contributor.type, name_title_group ? 'personal' : nil)
+            attributes[:type] = type_attr if type_attr
+            xml.name attributes do
+              if parallel_name.structuredValue.present?
+                write_structured(parallel_name)
+              else
+                write_basic(parallel_name)
+              end
+              write_display_form(display_type_parallel_name) if display_type_parallel_name.present?
+              write_identifier(contributor) if contributor.identifier.present?
+              write_note(contributor)
+              write_roles(contributor)
+            end
+          end
+          # rubocop:enable Metrics/ParameterLists
+
+          def display_type_parallel_name(parallel_name_values)
+            parallel_name_values.detect { |parallel_value| parallel_value.type == 'display' }
+          end
+
           def parallel_name_attributes(name, parallel_name, name_title_group, altrepgroup_id)
             {
               nameTitleGroup: name_title_group,

data/lib/cocina/models/mapping/to_mods/note.rb

@@ -68,7 +68,9 @@ module Cocina
                     else
                       note.value
                     end
-            xml.public_send tag_name, value, attributes
+            xml.public_send tag_name, attributes do |builder|
+              EscapeHtml.with_cdata(value, builder) if value
+            end
           end
 
           def write_basic(note)

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

@@ -394,7 +394,7 @@ module Cocina
             xml.name name_attrs do
               write_name_part(subject_value)
               write_display_form(display_values)
-              write_roles(subject.note)
+              write_roles(subject_value.note)
               write_other_notes(subject.note, 'description')
               write_other_notes(subject.note, 'affiliation')
             end
@@ -410,7 +410,7 @@ module Cocina
               write_display_form(display_values)
               write_roles(subject.note)
               write_other_notes(subject.note, 'description')
-              write_other_notes(subject.note, 'affiliation')
+              write_other_notes(subject_value.note, 'affiliation')
             end
             write_genres(subject_value)
           end

data/lib/cocina/models/message_digest.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # The output of the message digest algorithm.
     class MessageDigest < Struct
       include Checkable
 

data/lib/cocina/models/object_metadata.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Metadata for a cocina object.
     class ObjectMetadata < Struct
       # When the object was created.
       attribute? :created, Types::Params::DateTime

data/lib/cocina/models/presentation.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Presentation data for the File.
     class Presentation < Struct
       # Height in pixels
       attribute? :height, Types::Strict::Integer

data/lib/cocina/models/related_resource.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Other resource associated with the described resource.
     class RelatedResource < Struct
       # The relationship of the related resource to the described resource.
       attribute? :type, Types::Strict::String

data/lib/cocina/models/release_tag.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # A tag that indicates the item or collection should be released.
     class ReleaseTag < Struct
       # Who did this release
       # example: petucket

data/lib/cocina/models/request_admin_policy.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Same as an AdminPolicy, but doesn't have an externalIdentifier as one will be created
     class RequestAdminPolicy < Struct
       include Validatable
 

data/lib/cocina/models/request_collection.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Same as a Collection, but doesn't have an externalIdentifier as one will be created
     class RequestCollection < Struct
       include Validatable
 

data/lib/cocina/models/request_description.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Description that is included in a request to create a DRO. This is the same as a Description, except excludes PURL.
     class RequestDescription < Struct
       include Validatable
 

data/lib/cocina/models/request_dro.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # A request to create a DRO.  This has the same general structure as a DRO but doesn't have externalIdentifier and doesn't require the access subschema. If no access subschema is provided, these values will be inherited from the AdminPolicy.
     class RequestDRO < Struct
       include Validatable
 

data/lib/cocina/models/request_dro_structural.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Structural metadata
     class RequestDROStructural < Struct
       attribute :contains, Types::Strict::Array.of(RequestFileSet).default([].freeze)
       attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).default([].freeze)

data/lib/cocina/models/request_file_set_structural.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Structural metadata
     class RequestFileSetStructural < Struct
       attribute :contains, Types::Strict::Array.of(RequestFile).default([].freeze)
     end

data/lib/cocina/models/request_identification.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Same as a Identification, but requires a sourceId and doesn't permit a DOI.
     class RequestIdentification < Struct
       # A barcode
       attribute? :barcode, Types::Nominal::Any

data/lib/cocina/models/sequence.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # A sequence or ordering of resources within a Collection or Object.
     class Sequence < Struct
       attribute :members, Types::Strict::Array.of(Types::Strict::String).default([].freeze)
       # The direction that a sequence of canvases should be displayed to the user

data/lib/cocina/models/source.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Property model for indicating the vocabulary, authority, or other origin for a term, code, or identifier.
     class Source < Struct
       # Code representing the value source.
       attribute? :code, Types::Strict::String

data/lib/cocina/models/standard.rb

@@ -2,6 +2,7 @@
 
 module Cocina
   module Models
+    # Property model for indicating the encoding, standard, or syntax to which a value conforms (e.g. RDA).
     class Standard < Struct
       # Code representing the standard or encoding.
       attribute? :code, Types::Strict::String

data/lib/cocina/models/validators/date_time_validator.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'edtf'
+require 'jsonpath'
+require 'rss'
+
+module Cocina
+  module Models
+    module Validators
+      # Validates that dates of known types are type-valid
+      class DateTimeValidator
+        VALIDATABLE_TYPES = %w[edtf iso8601 w3cdtf].freeze
+
+        def self.validate(_clazz, attributes)
+          new(attributes).validate
+        end
+
+        def initialize(attributes)
+          @attributes = attributes
+        end
+
+        def validate
+          return unless meets_preconditions?
+
+          return if invalid_dates.empty?
+
+          raise ValidationError, "Invalid date(s) for #{druid}: #{invalid_dates}"
+        end
+
+        private
+
+        attr_reader :attributes
+
+        def meets_preconditions?
+          attributes.key?(:description)
+        end
+
+        def invalid_dates
+          @invalid_dates ||= validatable_dates.filter_map do |date_hash|
+            code = date_hash.dig('encoding', 'code')
+            bad_values = JsonPath.new('$..value').on(date_hash.to_json).reject do |value|
+              send("valid_#{code}?", value)
+            end
+
+            next if bad_values.empty?
+
+            [*bad_values, code]
+          end
+        end
+
+        def validatable_dates
+          # Why is the `uniq` needed below? Odd behavior when handling highly nested use cases:
+          #
+          # > JsonPath.new("$..date..[?(@.encoding.code =~ /#{VALIDATABLE_TYPES.join('|')}/)]").on(attributes[:description].to_json)
+          # > [
+          #     {"structuredValue"=>[{"value"=>"1996", "type"=>"start"}, {"value"=>"1998", "type"=>"end"}], "encoding"=>{"code"=>"iso8601"}},
+          #     {"structuredValue"=>[{"value"=>"1996", "type"=>"start"}, {"value"=>"1998", "type"=>"end"}], "encoding"=>{"code"=>"iso8601"}}
+          # ]
+          #
+          # Notice how the JSONPath expression returns the *same exact* structure twice despite only being present once in the data.
+          JsonPath
+            .new("$..date..[?(@.encoding.code =~ /#{VALIDATABLE_TYPES.join('|')}/)]")
+            .on(attributes[:description].to_json)
+            .uniq
+        end
+
+        def valid_edtf?(value)
+          Date.edtf!(value)
+          true
+        rescue StandardError
+          false
+        end
+
+        def valid_iso8601?(value)
+          DateTime.iso8601(value)
+          true
+        rescue StandardError
+          false
+        end
+
+        def valid_w3cdtf?(value)
+          Time.w3cdtf(value)
+          true
+        rescue StandardError
+          # NOTE: the upstream W3CDTF implementation in the `rss` gem does not
+          #       allow two patterns that should be valid per the specification:
+          #
+          # * YYYY
+          # * YYYY-MM
+          #
+          # So we catch the false positives from the upstream gem and allow
+          # these two patterns to validate
+          /\A\d{4}(-0[1-9]|1[0-2])?\Z/.match?(value)
+        end
+
+        def druid
+          @druid ||= attributes[:externalIdentifier]
+        end
+      end
+    end
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.79.0'
+    VERSION = '0.82.0'
   end
 end

data/openapi.yml

@@ -779,6 +779,7 @@ components:
             $ref: "#/components/schemas/DescriptiveValue"
     DescriptiveParallelContributor:
       description: Value model for multiple representations of information about the same contributor (e.g. in different languages).
+      deprecated: true
       type: object
       additionalProperties: false
       properties:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.79.0
+  version: 0.82.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-09 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: edtf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsonpath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +156,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: super_diff
   requirement: !ruby/object:Gem::Requirement
@@ -377,6 +419,7 @@ files:
 - lib/cocina/models/location_based_access.rb
 - lib/cocina/models/location_based_download_access.rb
 - lib/cocina/models/mapping/error_notifier.rb
+- lib/cocina/models/mapping/escape_html.rb
 - lib/cocina/models/mapping/from_mods/access.rb
 - lib/cocina/models/mapping/from_mods/admin_metadata.rb
 - lib/cocina/models/mapping/from_mods/alt_rep_group.rb
@@ -461,6 +504,7 @@ files:
 - lib/cocina/models/validators/associated_name_validator.rb
 - lib/cocina/models/validators/catalog_links_validator.rb
 - lib/cocina/models/validators/dark_validator.rb
+- lib/cocina/models/validators/date_time_validator.rb
 - lib/cocina/models/validators/description_types_validator.rb
 - lib/cocina/models/validators/description_values_validator.rb
 - lib/cocina/models/validators/open_api_validator.rb
@@ -492,7 +536,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Data models for the SDR