cocina-models 0.73.6 → 0.75.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 010b22a3ad2f8bfe8f1c9fc020538adf0b89b2c77dc0ad0219c2321dfec5f6da
-  data.tar.gz: c51eae2641ca506f08abaedbd99e8385b291b4ac144f6bdffacb9cc5c5379576
+  metadata.gz: 5ec67ece77b9025a117182d0213342e180e7b87dcd003a44e3d9dffeb03d08e1
+  data.tar.gz: 3ee4eee501728b92c356760c660514789082da70c41c990fc3822f5833a7f47d
 SHA512:
-  metadata.gz: 0b65ccf18b933dc8287371765ff66f1d17b13f3d206a960b6afcdaf337819fd3d1ddebb4146458c0eaacdc77064817f41aae5fe86edf2a58ab07de24ba5902a7
-  data.tar.gz: bb93e938a05ce9a3370f245074a72e5c0ad009e6bd81c1330db7bc595578caaeb93f068550ec0b92060b9c1d299ff6250bb598bee37b43f1f685405881bb7f24
+  metadata.gz: 4b0b94409167d640cfd84c7202468664ec32887405b17973e05ebdd77a55f608e53ad2c2956aabc85ac09dd9edecb6281eaafea7822d77bdea1075301e04aae6
+  data.tar.gz: 821ba48bca0b9c92031eb6ba2dbde666f2116c6c7f9076663730636f1c61f11e098551f2e81b975dea06289bd9ba09aa4f498ef67b36dbfa76d6581f29c515c4

data/.rubocop.yml

@@ -99,6 +99,7 @@ RSpec/ExampleLength:
   Exclude:
     - spec/cocina/models/description_spec.rb
     - spec/cocina/models/dro_shared_examples.rb
+    - spec/cocina/models/builders/name_title_group_builder_spec.rb
 
 RSpec/MultipleExpectations:
   Enabled: false

data/README.md

@@ -42,6 +42,15 @@ The generator is tested via its output when run against `openapi.yml`, viz., the
 
 Beyond what is necessary to test the generator, the Cocina model classes are not tested, i.e., they are assumed to be as specified in `openapi.yml`.
 
+## Testing validation changes
+
+If there is a possibility that a model or validation change will conflict with some existing objects then [validate-cocina](https://github.com/sul-dlss/dor-services-app/blob/main/bin/validate-cocina) should be used for testing. This must be run on sdr-deploy since it requires deploying a branch of cocina-models.
+
+1. Create a cocina-models branch containing the proposed change and push to Github.
+2. On sdr-deploy, check out `main`, update the `Gemfile` so that cocina-models references the branch, and `bundle install`.
+3. Run `bin/validate-cocina`.
+4. Check `validate-cocina.csv` for validation errors.
+
 ## Releasing
 
 ### Step 0: Share intent to change the models

data/description_types.yml

@@ -17,6 +17,8 @@ access.note:
     description: License describing allowed uses of the resource.
   - value: use and reproduction
     description: Information related to allowed uses of the resource in other contexts.
+  - value: access constraints
+    status: TEMP
 access.physicalLocation:
   - value: discovery
     description: Location where a user may find the resource.
@@ -176,7 +178,7 @@ event.date:
     description: The delivery of the resource to an external audience.
   - value: generation
     description: The creation of a resource by an automatic or natural process.
-  - value: Hijiri calendar
+  - value: Hijri calendar
   - value: Islamic
   - value: Julian
   - value: letter
@@ -285,6 +287,9 @@ geographic.subject.structuredValue:
   - value: south
   - value: west
 identifier:
+  - value: accession
+    status: deprecated
+    use: accession number
   - value: accession number
   - value: alternate case number
   - value: anchor
@@ -296,8 +301,11 @@ identifier:
     code: arxiv
   - value: case identifier
   - value: case number
+  - value: CCP
+  - value: CLC
   - value: CSt
   - value: CStRLIN
+  - value: CTC
   - value: Data Provider Digital Object Identifier
   - value: document number
   - value: DOI
@@ -356,9 +364,17 @@ identifier:
     code: urn
   - value: videorecording identifier
     code: videorecording-identifier
-  - value: West Mat \#
+  - value: 'West Mat #'
   - value: Wikidata
     code: wikidata
+  - value: Bodley 342
+    status: TEMP
+  - value: vintage
+    status: TEMP
+  - value: accesion
+    status: TEMP
+  - value: Suri UUID
+    status: TEMP
 note:
   - value: abstract
   - value: access
@@ -480,6 +496,8 @@ note:
   - value: version
   - value: version identification
   - value: writing
+  - value: note
+    status: TEMP
 note.groupedValue:
   - value: caption
   - value: date
@@ -534,6 +552,8 @@ subject:
   - value: time
   - value: title
   - value: topic
+  - value: surname
+    status: TEMP
 subject.note:
   - value: affiliation
   - value: description
@@ -604,6 +624,10 @@ title:
     description: Title transliterated from non-Latin script to Latin script.
   - value: uniform
     description: Form of title in Library of Congress title authority.
+  - value: main
+    status: TEMP
+  - value: other title
+    status: TEMP
 title.note:
   - value: associated name
     description: A name linked to the title, such as for a name-title heading.

data/docs/description_types.md

@@ -15,6 +15,7 @@ _Path: access.note_
   * display label: Display label for the purl.
   * license: License describing allowed uses of the resource.
   * use and reproduction: Information related to allowed uses of the resource in other contexts.
+  * access constraints
 
 ## Access physicallocation types
 _Path: access.physicalLocation_
@@ -119,7 +120,7 @@ _Path: event.date_
   * development: The creation of a print from a photographic negative or other source medium.
   * distribution: The delivery of the resource to an external audience.
   * generation: The creation of a resource by an automatic or natural process.
-  * Hijiri calendar
+  * Hijri calendar
   * Islamic
   * Julian
   * letter: Athanasius
@@ -208,6 +209,7 @@ _Path: geographic.subject.structuredValue_
 
 # Identifier types
 _Path: identifier_
+  * accession
   * accession number
   * alternate case number
   * anchor
@@ -216,8 +218,11 @@ _Path: identifier_
   * arXiv
   * case identifier
   * case number
+  * CCP
+  * CLC
   * CSt
   * CStRLIN
+  * CTC
   * Data Provider Digital Object Identifier
   * document number
   * DOI
@@ -256,6 +261,10 @@ _Path: identifier_
   * videorecording identifier
   * West Mat \#
   * Wikidata
+  * Bodley 342
+  * vintage
+  * accesion
+  * Suri UUID
 
 # Note types
 _Path: note_
@@ -363,6 +372,7 @@ _Path: note_
   * version
   * version identification
   * writing
+  * note
 
 ## Note types for grouped value (MODS legacy)
 _Path: note.groupedValue_
@@ -410,6 +420,7 @@ _Path: subject_
   * time
   * title
   * topic
+  * surname
 
 ## Subject note types
 _Path: subject.note_
@@ -481,6 +492,8 @@ _Path: title_
   * translated: Title translated into another language.
   * transliterated: Title transliterated from non-Latin script to Latin script.
   * uniform: Form of title in Library of Congress title authority.
+  * main
+  * other title
 
 ## Title note types
 _Path: title.note_

data/lib/cocina/generator/generator.rb

@@ -122,10 +122,7 @@ module Cocina
 
       NO_CLEAN = [
         'checkable.rb',
-        'dro_rights_description_builder.rb',
         'license.rb',
-        'rights_description_builder.rb',
-        'title_builder.rb',
         'validatable.rb',
         'version.rb',
         'vocabulary.rb'

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Builders
+      # Rights description builder for items
+      class DroRightsDescriptionBuilder < RightsDescriptionBuilder
+        # @param [Cocina::Models::DRO] cocina_item
+
+        # This overrides the superclass
+        # @return [Cocina::Models::DROAccess]
+        def object_access
+          @object_access ||= cocina.access
+        end
+
+        private
+
+        def object_level_access
+          super + access_level_from_files.uniq.map { |str| "#{str} (file)" }
+        end
+
+        def access_level_from_files
+          # dark access doesn't permit any file access
+          return [] if object_access.view == 'dark'
+
+          file_access_nodes.reject { |fa| same_as_object_access?(fa) }.flat_map do |fa|
+            file_access_from_file(fa)
+          end
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def file_access_from_file(file_access)
+          basic_access = if file_access[:view] == 'location-based'
+                           "location: #{file_access[:location]}"
+                         else
+                           file_access[:view]
+                         end
+
+          return [basic_access] if file_access[:view] == file_access[:download]
+
+          basic_access += ' (no-download)' if file_access[:view] != 'dark'
+
+          case file_access[:download]
+          when 'stanford'
+            [basic_access, 'stanford']
+          when 'location-based'
+            # Here we're using location to mean download location.
+            [basic_access, "location: #{file_access[:location]}"]
+          else
+            [basic_access]
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def same_as_object_access?(file_access)
+          (file_access[:view] == object_access.view && file_access[:download] == object_access.download) ||
+            (object_access.view == 'citation-only' && file_access[:view] == 'dark')
+        end
+
+        def file_access_nodes
+          Array(cocina.structural.contains)
+            .flat_map { |fs| Array(fs.structural.contains) }
+            .map { |file| file.access.to_h }
+            .uniq
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Builders
+      # Helpers for MODS nameTitleGroups.
+      #   MODS titles need to know if they match a contributor and thus need a nameTitleGroup
+      #   MODS contributors need to know if they match a title and thus need a nameTitleGroup
+      #     If there is a match, the nameTitleGroup number has to be consistent for the matching title(s)
+      #     and the contributor(s)
+      class NameTitleGroupBuilder
+        # When to assign nameTitleGroup to MODS from cocina:
+        #   for cocina title of type "uniform",
+        #     look for cocina title properties :value or :structuredValue (recurse down through :parallelValue
+        #     as needed), and look for associated :note with :type of "associated name" at the level of the
+        #     non-empty title [value|structuredValue]
+        #     The note of type "associated name" will have [value|structuredValue] which will match
+        #     [value|structuredValue] for a contributor (possibly after recursing through :parallelValue).
+        #   Thus, a title [value|structuredValue] and a contributor [value|structuredValue] are associated in
+        #   cocina.
+        #
+        # If those criteria not met in Cocina, do not assign nameTitleGroup in MODS
+        #
+        # @params [Cocina::Models::Title] title
+        # @return [Hash<Hash, Hash>] key:  hash of value or structuredValue property for title
+        #   value: hash of value or structuredValue property for contributor
+        #   e.g. {{:value=>"Portrait of the artist as a young man"}=>{:value=>"James Joyce"}}
+        #   e.g. {{:value=>"Portrait of the artist as a young man"}=>{:structuredValue=>
+        #         [{:value=>"Joyce, James", :type=>"name"},{:value=>"1882-1941", :type=>"life dates"}]}}
+        #   e.g. {{:structuredValue=>[{:value=>"Demanding Food", :type=>"main"},
+        #           {:value=>"A Cat's Life", :type=>"subtitle"}]}=>{:value=>"James Joyce"}}
+        #   this complexity is needed for multilingual titles mapping to multilingual names.
+        def self.build_title_values_to_contributor_name_values(title)
+          result = {}
+          return result if title.blank?
+
+          # pair title value with contributor name value
+          title_value_note_slices(title).each do |value_note_slice|
+            title_val_slice = slice_of_value_or_structured_value(value_note_slice)
+            next if title_val_slice.blank?
+
+            associated_name_note = value_note_slice[:note]&.detect { |note| note[:type] == 'associated name' }
+            next if associated_name_note.blank?
+
+            # relevant note will be Array of either
+            #   {
+            #     value: 'string contributor name',
+            #     type: 'associated name'
+            #   }
+            # OR
+            #   {
+            #     structuredValue: [ structuredValue contributor name ],
+            #     type: 'associated name'
+            #   }
+            # and we want the hash without the :type attribute
+            result[title_val_slice] = slice_of_value_or_structured_value(associated_name_note)
+          end
+          result
+        end
+
+        def self.contributor_for_contributor_name_value_slice(contributor_name_value_slice:, contributors:)
+          Array(contributors).find do |contributor|
+            contrib_name_value_slices = contributor_name_value_slices(contributor)
+            contrib_name_value_slices.include?(contributor_name_value_slice)
+          end
+        end
+
+        # @params [Cocina::Models::Contributor] contributor
+        # @return [Hash] where we are only interested in
+        #   hashes containing (either :value or :structureValue)
+        def self.contributor_name_value_slices(contributor)
+          return if contributor&.name.blank?
+
+          slices = []
+          Array(contributor.name).each do |contrib_name|
+            slices << value_slices(contrib_name)
+          end
+          slices.flatten
+        end
+
+        # @params [Cocina::Models::DescriptiveValue] desc_value
+        # @return [Array<Cocina::Models::DescriptiveValue>] where we are only interested in
+        #   hashes containing (either :value or :structuredValue)
+        # rubocop:disable Metrics/AbcSize
+        def self.value_slices(desc_value)
+          slices = []
+          desc_value_slice = desc_value.to_h.slice(:value, :structuredValue, :parallelValue)
+          if desc_value_slice[:value].present? || desc_value_slice[:structuredValue].present?
+            slices << desc_value_slice.select { |_k, value| value.present? }
+          elsif desc_value_slice[:parallelValue].present?
+            desc_value_slice[:parallelValue].each { |parallel_val| slices << value_slices(parallel_val) }
+          end
+          # ignoring groupedValue
+          slices.flatten
+        end
+        # rubocop:enable Metrics/AbcSize
+        # private_class_method :value_slices
+
+        # for a given Hash (from a Cocina DescriptiveValue or Title or Name or ...)
+        # result will be either
+        #   { value: 'string value' }
+        # OR
+        #   { structuredValue: [ some structuredValue ] }
+        def self.slice_of_value_or_structured_value(hash)
+          if hash[:value].present?
+            hash.slice(:value).select { |_k, value| value.present? }
+          elsif hash[:structuredValue].present?
+            hash.slice(:structuredValue).select { |_k, value| value.present? }
+          end
+        end
+
+        # reduce parallelValues down to value or structuredValue for these slices
+        # @params [Cocina::Models::Title] title
+        # @return [Array<Cocina::Models::DescriptiveValue>] where we are only interested in
+        #   hashes containing (either :value or :structureValue) and :note if present
+        # rubocop:disable Metrics/AbcSize
+        def self.title_value_note_slices(title)
+          slices = []
+          title_slice = title.to_h.slice(:value, :structuredValue, :parallelValue, :note)
+          if title_slice[:value].present? || title_slice[:structuredValue].present?
+            slices << title_slice.select { |_k, value| value.present? }
+          elsif title_slice[:parallelValue].present?
+            title_slice[:parallelValue].each do |parallel_val|
+              slices << title_value_note_slices(parallel_val)
+            end
+          end
+          # ignoring groupedValue
+          slices.flatten
+        end
+        # rubocop:enable Metrics/AbcSize
+      end
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Builders
+      # RightsDescriptionBuilder
+      class RightsDescriptionBuilder
+        # @param [Cocina::Models::AdminPolicy, Cocina::Models::DRO] cocina_object
+        def self.build(cocina_object)
+          new(cocina_object).build
+        end
+
+        def initialize(cocina_object)
+          @cocina = cocina_object
+        end
+
+        # This is set up to work for APOs, but this method is to be overridden on sub classes
+        # @return [Cocina::Models::AdminPolicyDefaultAccess]
+        def object_access
+          @object_access ||= cocina.administrative.accessTemplate
+        end
+
+        def build
+          return 'controlled digital lending' if object_access.controlledDigitalLending
+
+          return ['dark'] if object_access.view == 'dark'
+
+          object_level_access
+        end
+
+        private
+
+        attr_reader :cocina
+
+        # rubocop:disable Metrics/MethodLength
+        def object_level_access
+          case object_access.view
+          when 'citation-only'
+            ['citation']
+          when 'world'
+            world_object_access
+          when 'location-based'
+            case object_access.download
+            when 'none'
+              ["location: #{object_access.location} (no-download)"]
+            else
+              ["location: #{object_access.location}"]
+            end
+          when 'stanford'
+            stanford_object_access
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        def stanford_object_access
+          case object_access.download
+          when 'none'
+            ['stanford (no-download)']
+          when 'location-based'
+            # this is an odd case we might want to move away from. See https://github.com/sul-dlss/cocina-models/issues/258
+            ['stanford (no-download)', "location: #{object_access.location}"]
+          else
+            ['stanford']
+          end
+        end
+
+        def world_object_access
+          case object_access.download
+          when 'stanford'
+            ['stanford', 'world (no-download)']
+          when 'none'
+            ['world (no-download)']
+          when 'world'
+            ['world']
+          when 'location-based'
+            # this is an odd case we might want to move away from. See https://github.com/sul-dlss/cocina-models/issues/258
+            ['world (no-download)', "location: #{object_access.location}"]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require 'deprecation'
+
+module Cocina
+  module Models
+    module Builders
+      # TitleBuilder selects the prefered title from the cocina object for solr indexing
+      # rubocop:disable Metrics/ClassLength
+      class TitleBuilder
+        extend Deprecation
+        # @param [[Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
+        # @param [Symbol] strategy ":first" is the strategy for selection when primary or display
+        #   title are missing
+        # @param [Boolean] add_punctuation determines if the title should be formmated with punctuation
+        # @return [String] the title value for Solr
+        def self.build(titles, strategy: :first, add_punctuation: true)
+          if titles.respond_to?(:description)
+            Deprecation.warn(self,
+                             "Calling TitleBuilder.build with a #{titles.class} is deprecated. " \
+                             'It must be called with an array of titles')
+            titles = titles.description.title
+          end
+          new(strategy: strategy, add_punctuation: add_punctuation).build(titles)
+        end
+
+        def initialize(strategy:, add_punctuation:)
+          @strategy = strategy
+          @add_punctuation = add_punctuation
+        end
+
+        # @param [[Array<Cocina::Models::Title>] titles the titles to consider
+        # @return [String] the title value for Solr
+        def build(titles)
+          cocina_title = primary_title(titles) || untyped_title(titles)
+          cocina_title = other_title(titles) if cocina_title.blank?
+
+          if strategy == :first
+            extract_title(cocina_title)
+          else
+            cocina_title.map { |one| extract_title(one) }
+          end
+        end
+
+        private
+
+        attr_reader :strategy
+
+        def extract_title(cocina_title)
+          result = if cocina_title.value
+                     cocina_title.value
+                   elsif cocina_title.structuredValue.present?
+                     title_from_structured_values(cocina_title)
+                   elsif cocina_title.parallelValue.present?
+                     return build(cocina_title.parallelValue)
+                   end
+          remove_trailing_punctuation(result.strip) if result.present?
+        end
+
+        def add_punctuation?
+          @add_punctuation
+        end
+
+        # @return [Cocina::Models::Title, nil] title that has status=primary
+        def primary_title(titles)
+          primary_title = titles.find do |title|
+            title.status == 'primary'
+          end
+          return primary_title if primary_title.present?
+
+          # NOTE: structuredValues would only have status primary assigned as a sibling, not as an attribute
+
+          titles.find do |title|
+            title.parallelValue&.find do |parallel_title|
+              parallel_title.status == 'primary'
+            end
+          end
+        end
+
+        def untyped_title(titles)
+          method = strategy == :first ? :find : :select
+          untyped_title_for(titles.public_send(method))
+        end
+
+        # @return [Array[Cocina::Models::Title]] first title that has no type attribute
+        def untyped_title_for(titles)
+          titles.each do |title|
+            if title.parallelValue.present?
+              untyped_title_for(title.parallelValue)
+            else
+              title.type.nil? || title.type == 'title'
+            end
+          end
+        end
+
+        # This handles 'main title', 'uniform' or 'translated'
+        def other_title(titles)
+          if strategy == :first
+            titles.first
+          else
+            titles
+          end
+        end
+
+        # rubocop:disable Metrics/BlockLength
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
+        # rubocop:disable Metrics/MethodLength
+        # rubocop:disable Metrics/AbcSize
+        # @param [Cocina::Models::Title] title with structured values
+        # @return [String] the title value from combining the pieces of the structured_values by type and order
+        #   with desired punctuation per specs
+        def title_from_structured_values(title)
+          structured_title = ''
+          part_name_number = ''
+          # combine pieces of the cocina structuredValue into a single title
+          title.structuredValue.each do |structured_value|
+            # There can be a structuredValue inside a structuredValue.  For example,
+            #   a uniform title where both the name and the title have internal StructuredValue
+            return title_from_structured_values(structured_value) if structured_value.structuredValue.present?
+
+            value = structured_value.value&.strip
+            next unless value
+
+            # additional types:  name, uniform ...
+            case structured_value.type&.downcase
+            when 'nonsorting characters'
+              non_sort_value = "#{value}#{non_sorting_padding(title, value)}"
+              structured_title = if structured_title.present?
+                                   "#{structured_title}#{non_sort_value}"
+                                 else
+                                   non_sort_value
+                                 end
+            when 'part name', 'part number'
+              if part_name_number.blank?
+                part_name_number = part_name_number(title.structuredValue)
+                structured_title = if !add_punctuation?
+                                     [structured_title, part_name_number].join(' ')
+                                   elsif structured_title.present?
+                                     "#{structured_title.sub(/[ .,]*$/, '')}. #{part_name_number}. "
+                                   else
+                                     "#{part_name_number}. "
+                                   end
+              end
+            when 'main title', 'title'
+              structured_title = "#{structured_title}#{value}"
+            when 'subtitle'
+              # subtitle is preceded by space colon space, unless it is at the beginning of the title string
+              structured_title = if !add_punctuation?
+                                   [structured_title, value].join(' ')
+                                 elsif structured_title.present?
+                                   "#{structured_title.sub(/[. :]+$/, '')} : #{value.sub(/^:/, '').strip}"
+                                 else
+                                   structured_title = value.sub(/^:/, '').strip
+                                 end
+            end
+          end
+          structured_title
+        end
+        # rubocop:enable Metrics/AbcSize
+        # rubocop:enable Metrics/MethodLength
+        # rubocop:enable Metrics/BlockLength
+        # rubocop:enable Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/PerceivedComplexity
+
+        def remove_trailing_punctuation(title)
+          title.sub(%r{[ .,;:/\\]+$}, '')
+        end
+
+        def non_sorting_padding(title, non_sorting_value)
+          non_sort_note = title.note&.find { |note| note.type&.downcase == 'nonsorting character count' }
+          if non_sort_note
+            padding_count = [non_sort_note.value.to_i - non_sorting_value.length, 0].max
+            ' ' * padding_count
+          elsif ['\'', '-'].include?(non_sorting_value.last)
+            ''
+          else
+            ' '
+          end
+        end
+
+        # combine part name and part number:
+        #   respect order of occurrence
+        #   separated from each other by comma space
+        def part_name_number(structured_values)
+          title_from_part = ''
+          structured_values.each do |structured_value|
+            case structured_value.type&.downcase
+            when 'part name', 'part number'
+              value = structured_value.value&.strip
+              next unless value
+
+              title_from_part = append_part_to_title(title_from_part, value)
+
+            end
+          end
+          title_from_part
+        end
+
+        def append_part_to_title(title_from_part, value)
+          if !add_punctuation?
+            [title_from_part, value].select(&:presence).join(' ')
+          elsif title_from_part.strip.present?
+            "#{title_from_part.sub(/[ .,]*$/, '')}, #{value}"
+          else
+            value
+          end
+        end
+      end
+      # rubocop:enable Metrics/ClassLength
+    end
+  end
+end

data/lib/cocina/models/validatable.rb

@@ -8,7 +8,7 @@ module Cocina
 
       class_methods do
         def new(attributes = default_attributes, safe = false, validate = true, &block)
-          Validators::Validator.validate(self, attributes.with_indifferent_access) if validate
+          Validators::Validator.validate(self, attributes) if validate
           super(attributes, safe, &block)
         end
       end
@@ -16,7 +16,7 @@ module Cocina
       def new(*args)
         validate = args.first.delete(:validate) if args.present?
         new_model = super(*args)
-        Validators::Validator.validate(new_model.class, new_model.to_h) if validate || validate.nil?
+        Validators::Validator.validate(new_model.class, new_model) if validate || validate.nil?
         new_model
       end
     end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates that when title.note with type "associated name" has a value, it must match a contributor name.
+      class AssociatedNameValidator
+        def self.validate(clazz, attributes)
+          new(clazz, attributes).validate
+        end
+
+        def initialize(clazz, attributes)
+          @clazz = clazz
+          @attributes = attributes.deep_symbolize_keys
+          @error_paths = []
+        end
+
+        def validate
+          return unless meets_preconditions?
+
+          return if resources.all? { |resource| valid?(resource) }
+
+          raise ValidationError,
+                'Missing data: Name associated with uniform title does not match any contributor.'
+        end
+
+        private
+
+        attr_reader :clazz, :attributes, :error_paths
+
+        def meets_preconditions?
+          resources.any? do |resource|
+            titles_with_associated_name_note_for(resource).present?
+          end
+        end
+
+        def valid?(resource)
+          titles_with_associated_name_note_for(resource).all? do |title|
+            contributor_name_value_slices = Builders::NameTitleGroupBuilder
+                                            .build_title_values_to_contributor_name_values(
+                                              Cocina::Models::Title.new(title)
+                                            ).values
+            contributor_name_value_slices.all? do |contributor_name_value_slice|
+              contributors = Array(resource[:contributor]).map do |contributor|
+                Cocina::Models::Contributor.new(contributor)
+              end
+              Builders::NameTitleGroupBuilder.contributor_for_contributor_name_value_slice(
+                contributor_name_value_slice: contributor_name_value_slice, contributors: contributors
+              ).present?
+            end
+          end
+        end
+
+        def resources
+          @resources ||= [description_attributes] + Array(description_attributes[:relatedResource])
+        end
+
+        def description_attributes
+          @description_attributes ||= if [Cocina::Models::Description,
+                                          Cocina::Models::RequestDescription].include?(clazz)
+                                        attributes
+                                      else
+                                        attributes[:description] || {}
+                                      end
+        end
+
+        def associated_name_note_for(title)
+          Array(title[:note]).detect { |note| note[:type] == 'associated name' }
+        end
+
+        def titles_with_associated_name_note_for(resource)
+          Array(resource[:title]).select { |title| associated_name_note_for(title).present? }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates that Purl matches the external identifier (druid)
+      class PurlValidator
+        def self.validate(clazz, attributes)
+          new(clazz, attributes).validate
+        end
+
+        def initialize(clazz, attributes)
+          @clazz = clazz
+          @attributes = attributes
+        end
+
+        def validate
+          return unless meets_preconditions?
+
+          return if identifier_from_druid == identifier_from_purl
+
+          raise ValidationError, "Purl mismatch: #{druid} purl does not match object druid."
+        end
+
+        private
+
+        attr_reader :clazz, :attributes
+
+        def meets_preconditions?
+          purl
+        end
+
+        def druid
+          @druid ||= attributes[:externalIdentifier]
+        end
+
+        def purl
+          @purl ||= attributes.dig(:description, :purl)
+        end
+
+        def identifier_from_druid
+          druid.delete_prefix('druid:')
+        end
+
+        def identifier_from_purl
+          purl.split('/').last
+        end
+      end
+    end
+  end
+end

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

@@ -8,13 +8,39 @@ module Cocina
         VALIDATORS = [
           OpenApiValidator,
           DarkValidator,
+          PurlValidator,
           CatalogLinksValidator,
+          AssociatedNameValidator,
           DescriptionTypesValidator
         ].freeze
 
         def self.validate(clazz, attributes)
-          VALIDATORS.each { |validator| validator.validate(clazz, attributes) }
+          # This gets rid of nested model objects.
+          # Once DSA is on Rails 6, this can be:
+          # attributes_hash = attributes.to_h.deep_transform_values do |value|
+          #   value.class.name.starts_with?('Cocina::Models') ? value.to_h : value
+          # end.with_indifferent_access
+          # And add require 'active_support/core_ext/hash/deep_transform_values' to models file.
+
+          # In the meantime, copying code.
+          attributes_hash = deep_transform_values(attributes.to_h) do |value|
+            value.class.name.starts_with?('Cocina::Models') ? value.to_h : value
+          end.with_indifferent_access
+
+          VALIDATORS.each { |validator| validator.validate(clazz, attributes_hash) }
+        end
+
+        def self.deep_transform_values(object, &block)
+          case object
+          when Hash
+            object.transform_values { |value| deep_transform_values(value, &block) }
+          when Array
+            object.map { |e| deep_transform_values(e, &block) }
+          else
+            yield(object)
+          end
         end
+        private_class_method :deep_transform_values
       end
     end
   end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.73.6'
+    VERSION = '0.75.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.73.6
+  version: 0.75.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -313,6 +313,10 @@ files:
 - lib/cocina/models/admin_policy_with_metadata.rb
 - lib/cocina/models/administrative.rb
 - lib/cocina/models/applies_to.rb
+- lib/cocina/models/builders/dro_rights_description_builder.rb
+- lib/cocina/models/builders/name_title_group_builder.rb
+- lib/cocina/models/builders/rights_description_builder.rb
+- lib/cocina/models/builders/title_builder.rb
 - lib/cocina/models/business_barcode.rb
 - lib/cocina/models/catalog_link.rb
 - lib/cocina/models/catkey_barcode.rb
@@ -341,7 +345,6 @@ files:
 - lib/cocina/models/doi.rb
 - lib/cocina/models/dro.rb
 - lib/cocina/models/dro_access.rb
-- lib/cocina/models/dro_rights_description_builder.rb
 - lib/cocina/models/dro_structural.rb
 - lib/cocina/models/dro_with_metadata.rb
 - lib/cocina/models/druid.rb
@@ -377,7 +380,6 @@ files:
 - lib/cocina/models/request_file_set.rb
 - lib/cocina/models/request_file_set_structural.rb
 - lib/cocina/models/request_identification.rb
-- lib/cocina/models/rights_description_builder.rb
 - lib/cocina/models/sequence.rb
 - lib/cocina/models/source.rb
 - lib/cocina/models/source_id.rb
@@ -385,12 +387,13 @@ files:
 - lib/cocina/models/standard_barcode.rb
 - lib/cocina/models/stanford_access.rb
 - lib/cocina/models/title.rb
-- lib/cocina/models/title_builder.rb
 - lib/cocina/models/validatable.rb
+- 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/description_types_validator.rb
 - lib/cocina/models/validators/open_api_validator.rb
+- lib/cocina/models/validators/purl_validator.rb
 - lib/cocina/models/validators/validator.rb
 - lib/cocina/models/version.rb
 - lib/cocina/models/vocabulary.rb

data/lib/cocina/models/dro_rights_description_builder.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # Rights description builder for items
-    class DroRightsDescriptionBuilder < RightsDescriptionBuilder
-      # @param [Cocina::Models::DRO] cocina_item
-
-      # This overrides the superclass
-      # @return [Cocina::Models::DROAccess]
-      def object_access
-        @object_access ||= cocina.access
-      end
-
-      private
-
-      def object_level_access
-        super + access_level_from_files.uniq.map { |str| "#{str} (file)" }
-      end
-
-      def access_level_from_files
-        # dark access doesn't permit any file access
-        return [] if object_access.view == 'dark'
-
-        file_access_nodes.reject { |fa| same_as_object_access?(fa) }.flat_map do |fa|
-          file_access_from_file(fa)
-        end
-      end
-
-      # rubocop:disable Metrics/MethodLength
-      def file_access_from_file(file_access)
-        basic_access = if file_access[:view] == 'location-based'
-                         "location: #{file_access[:location]}"
-                       else
-                         file_access[:view]
-                       end
-
-        return [basic_access] if file_access[:view] == file_access[:download]
-
-        basic_access += ' (no-download)' if file_access[:view] != 'dark'
-
-        case file_access[:download]
-        when 'stanford'
-          [basic_access, 'stanford']
-        when 'location-based'
-          # Here we're using location to mean download location.
-          [basic_access, "location: #{file_access[:location]}"]
-        else
-          [basic_access]
-        end
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def same_as_object_access?(file_access)
-        (file_access[:view] == object_access.view && file_access[:download] == object_access.download) ||
-          (object_access.view == 'citation-only' && file_access[:view] == 'dark')
-      end
-
-      def file_access_nodes
-        Array(cocina.structural.contains)
-          .flat_map { |fs| Array(fs.structural.contains) }
-          .map { |file| file.access.to_h }
-          .uniq
-      end
-    end
-  end
-end

data/lib/cocina/models/rights_description_builder.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # RightsDescriptionBuilder
-    class RightsDescriptionBuilder
-      # @param [Cocina::Models::AdminPolicy, Cocina::Models::DRO] cocina_object
-      def self.build(cocina_object)
-        new(cocina_object).build
-      end
-
-      def initialize(cocina_object)
-        @cocina = cocina_object
-      end
-
-      # This is set up to work for APOs, but this method is to be overridden on sub classes
-      # @return [Cocina::Models::AdminPolicyDefaultAccess]
-      def object_access
-        @object_access ||= cocina.administrative.accessTemplate
-      end
-
-      def build
-        return 'controlled digital lending' if object_access.controlledDigitalLending
-
-        return ['dark'] if object_access.view == 'dark'
-
-        object_level_access
-      end
-
-      private
-
-      attr_reader :cocina
-
-      # rubocop:disable Metrics/MethodLength
-      def object_level_access
-        case object_access.view
-        when 'citation-only'
-          ['citation']
-        when 'world'
-          world_object_access
-        when 'location-based'
-          case object_access.download
-          when 'none'
-            ["location: #{object_access.location} (no-download)"]
-          else
-            ["location: #{object_access.location}"]
-          end
-        when 'stanford'
-          stanford_object_access
-        end
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def stanford_object_access
-        case object_access.download
-        when 'none'
-          ['stanford (no-download)']
-        when 'location-based'
-          # this is an odd case we might want to move away from. See https://github.com/sul-dlss/cocina-models/issues/258
-          ['stanford (no-download)', "location: #{object_access.location}"]
-        else
-          ['stanford']
-        end
-      end
-
-      def world_object_access
-        case object_access.download
-        when 'stanford'
-          ['stanford', 'world (no-download)']
-        when 'none'
-          ['world (no-download)']
-        when 'world'
-          ['world']
-        when 'location-based'
-          # this is an odd case we might want to move away from. See https://github.com/sul-dlss/cocina-models/issues/258
-          ['world (no-download)', "location: #{object_access.location}"]
-        end
-      end
-    end
-  end
-end

data/lib/cocina/models/title_builder.rb

@@ -1,208 +0,0 @@
-# frozen_string_literal: true
-
-require 'deprecation'
-
-module Cocina
-  module Models
-    # TitleBuilder selects the prefered title from the cocina object for solr indexing
-    # rubocop:disable Metrics/ClassLength
-    class TitleBuilder
-      extend Deprecation
-      # @param [[Array<Cocina::Models::Title,Cocina::Models::DescriptiveValue>] titles the titles to consider
-      # @param [Symbol] strategy ":first" is the strategy for selection when primary or display title are missing
-      # @param [Boolean] add_punctuation determines if the title should be formmated with punctuation
-      # @return [String] the title value for Solr
-      def self.build(titles, strategy: :first, add_punctuation: true)
-        if titles.respond_to?(:description)
-          Deprecation.warn(self, "Calling TitleBuilder.build with a #{titles.class} is deprecated. It must be called with an array of titles")
-          titles = titles.description.title
-        end
-        new(strategy: strategy, add_punctuation: add_punctuation).build(titles)
-      end
-
-      def initialize(strategy:, add_punctuation:)
-        @strategy = strategy
-        @add_punctuation = add_punctuation
-      end
-
-      # @param [[Array<Cocina::Models::Title>] titles the titles to consider
-      # @return [String] the title value for Solr
-      def build(titles)
-        cocina_title = primary_title(titles) || untyped_title(titles)
-        cocina_title = other_title(titles) if cocina_title.blank?
-
-        if strategy == :first
-          extract_title(cocina_title)
-        else
-          cocina_title.map { |one| extract_title(one) }
-        end
-      end
-
-      private
-
-      attr_reader :strategy
-
-      def extract_title(cocina_title)
-        result = if cocina_title.value
-                   cocina_title.value
-                 elsif cocina_title.structuredValue.present?
-                   title_from_structured_values(cocina_title)
-                 elsif cocina_title.parallelValue.present?
-                   return build(cocina_title.parallelValue)
-                 end
-        remove_trailing_punctuation(result.strip) if result.present?
-      end
-
-      def add_punctuation?
-        @add_punctuation
-      end
-
-      # @return [Cocina::Models::Title, nil] title that has status=primary
-      def primary_title(titles)
-        primary_title = titles.find do |title|
-          title.status == 'primary'
-        end
-        return primary_title if primary_title.present?
-
-        # NOTE: structuredValues would only have status primary assigned as a sibling, not as an attribute
-
-        titles.find do |title|
-          title.parallelValue&.find do |parallel_title|
-            parallel_title.status == 'primary'
-          end
-        end
-      end
-
-      def untyped_title(titles)
-        method = strategy == :first ? :find : :select
-        untyped_title_for(titles.public_send(method))
-      end
-
-      # @return [Array[Cocina::Models::Title]] first title that has no type attribute
-      def untyped_title_for(titles)
-        titles.each do |title|
-          if title.parallelValue.present?
-            untyped_title_for(title.parallelValue)
-          else
-            title.type.nil? || title.type == 'title'
-          end
-        end
-      end
-
-      # This handles 'main title', 'uniform' or 'translated'
-      def other_title(titles)
-        if strategy == :first
-          titles.first
-        else
-          titles
-        end
-      end
-
-      # rubocop:disable Metrics/BlockLength
-      # rubocop:disable Metrics/CyclomaticComplexity
-      # rubocop:disable Metrics/PerceivedComplexity
-      # rubocop:disable Metrics/MethodLength
-      # rubocop:disable Metrics/AbcSize
-      # @param [Cocina::Models::Title] title with structured values
-      # @return [String] the title value from combining the pieces of the structured_values by type and order
-      #   with desired punctuation per specs
-      def title_from_structured_values(title)
-        structured_title = ''
-        part_name_number = ''
-        # combine pieces of the cocina structuredValue into a single title
-        title.structuredValue.each do |structured_value|
-          # There can be a structuredValue inside a structuredValue.  For example,
-          #   a uniform title where both the name and the title have internal StructuredValue
-          return title_from_structured_values(structured_value) if structured_value.structuredValue.present?
-
-          value = structured_value.value&.strip
-          next unless value
-
-          # additional types:  name, uniform ...
-          case structured_value.type&.downcase
-          when 'nonsorting characters'
-            non_sort_value = "#{value}#{non_sorting_padding(title, value)}"
-            structured_title = if structured_title.present?
-                                 "#{structured_title}#{non_sort_value}"
-                               else
-                                 non_sort_value
-                               end
-          when 'part name', 'part number'
-            if part_name_number.blank?
-              part_name_number = part_name_number(title.structuredValue)
-              structured_title = if !add_punctuation?
-                                   [structured_title, part_name_number].join(' ')
-                                 elsif structured_title.present?
-                                   "#{structured_title.sub(/[ .,]*$/, '')}. #{part_name_number}. "
-                                 else
-                                   "#{part_name_number}. "
-                                 end
-            end
-          when 'main title', 'title'
-            structured_title = "#{structured_title}#{value}"
-          when 'subtitle'
-            # subtitle is preceded by space colon space, unless it is at the beginning of the title string
-            structured_title = if !add_punctuation?
-                                 [structured_title, value].join(' ')
-                               elsif structured_title.present?
-                                 "#{structured_title.sub(/[. :]+$/, '')} : #{value.sub(/^:/, '').strip}"
-                               else
-                                 structured_title = value.sub(/^:/, '').strip
-                               end
-          end
-        end
-        structured_title
-      end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/BlockLength
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
-
-      def remove_trailing_punctuation(title)
-        title.sub(%r{[ .,;:/\\]+$}, '')
-      end
-
-      def non_sorting_padding(title, non_sorting_value)
-        non_sort_note = title.note&.find { |note| note.type&.downcase == 'nonsorting character count' }
-        if non_sort_note
-          padding_count = [non_sort_note.value.to_i - non_sorting_value.length, 0].max
-          ' ' * padding_count
-        elsif ['\'', '-'].include?(non_sorting_value.last)
-          ''
-        else
-          ' '
-        end
-      end
-
-      # combine part name and part number:
-      #   respect order of occurrence
-      #   separated from each other by comma space
-      def part_name_number(structured_values)
-        title_from_part = ''
-        structured_values.each do |structured_value|
-          case structured_value.type&.downcase
-          when 'part name', 'part number'
-            value = structured_value.value&.strip
-            next unless value
-
-            title_from_part = append_part_to_title(title_from_part, value)
-
-          end
-        end
-        title_from_part
-      end
-
-      def append_part_to_title(title_from_part, value)
-        if !add_punctuation?
-          [title_from_part, value].select(&:presence).join(' ')
-        elsif title_from_part.strip.present?
-          "#{title_from_part.sub(/[ .,]*$/, '')}, #{value}"
-        else
-          value
-        end
-      end
-    end
-    # rubocop:enable Metrics/ClassLength
-  end
-end