cocina-models 0.70.0 → 0.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab6c36807c8585e07d8fc5529e6ef1aa08e88f7fc93d3dc7605aecb87e9138db
-  data.tar.gz: 8a5c302070e2beab4c3606124e1b68e64a1ab1063c8c32d05e47a66db3325d78
+  metadata.gz: 5058bc2927b8788ad9c04142decbfcc7cf42b7daa3b84665d64dd00b432d8ff4
+  data.tar.gz: 524263003bc679432b5c120690775de4ebc14ef5fa6158337e0beff9c2bfb332
 SHA512:
-  metadata.gz: 33fa2bd17896f666da8f4bdc1249a1e216f0344c0dc6d95e47b76a97b801a2ab1abf05fd1ca287e7bd23e134a34de8900e985e7db3bfea2e91b9c359be209722
-  data.tar.gz: 93ac31afd9d5da0587d4798c8e3ae571853f0e2b3c85d6edcda231ab886d9fd4f3559e7616a70f2290629028faa745bc40406f47f0bbe5ec95574bbe084bb532
+  metadata.gz: b84f98459177c74cc822a8dee105412c7023c3fda2e953e1f760c482ae3a2967f610207bb53cd33c510e2b0c861834b4cf1998459b70035ac9b22aa55c83b910
+  data.tar.gz: '018baa839ef5774c3969f91acb9545fb04ddf3be652ae3f3fafbc6458ddd7ec1d7c4ae5d5d33a9a8eab36476519cd310a33b61da34e4f934bef35ef490dc83fd'

data/.rubocop.yml

@@ -107,7 +107,7 @@ RSpec/StubbedMock: # (new in 1.44)
   Enabled: true
 
 RSpec/MultipleMemoizedHelpers:
-  Max: 6
+  Enabled: false
 
 # ----- Style ------
 

data/README.md

@@ -101,6 +101,16 @@ If for some reason the above method does not work, the sul-dlss/access-update-sc
 
 [sul-dlss/sdr-deploy](https://github.com/sul-dlss/sdr-deploy) has a flag in the deploy script to limit deploys to cocina dependent applications.  Refer to instructions in the [sdr-deploy/README](https://github.com/sul-dlss/sdr-deploy/blob/main/README.md#only-deploy-repos-related-to-cocina-models-update).
 
+Note that running the integration tests is currently the best way we have to check for unintended effects and/or bugs when rolling out cocina-models changes.
+
+#### Step 5A: Deploy to QA and/or Stage
+
+#### Step 5B: Run infrastructure_integration_tests
+
+It is safest to ensure _all_ the integration tests run cleanly.  However, patch releases of cocina-models may only warrant running individual tests that exercise the changes.
+
+#### Step 5C: Deploy to Production
+
 **[Turn off Google Books](https://sul-gbooks-prod.stanford.edu/features) when deploying to production.** This avoids failed deposit due to a temporary Cocina model mismatch. Unlike other applications, the deposits will fail without retry and require manual remediation.
 
 ## Usage conventions
@@ -108,6 +118,7 @@ If for some reason the above method does not work, the sul-dlss/access-update-sc
 The following are the recommended naming conventions for code using Cocina models:
 
 * `cocina_item`: `Cocina::Models::DRO` instance
+* `cocina_agreement`: `Cocina::Models::DRO` with type of Cocina::Models::ObjectType.agreement
 * `cocina_admin_policy`: `Cocina::Models::AdminPolicy` instance
 * `cocina_collection`: `Cocina::Models::Collection` instance
 * `cocina_object`: `Cocina::Models::DRO` or `Cocina::Models::AdminPolicy` or `Cocina::Models::Collection` instance

data/cocina-models.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7'
 
   spec.add_dependency 'activesupport'
+  spec.add_dependency 'deprecation'
   spec.add_dependency 'dry-struct', '~> 1.0'
   spec.add_dependency 'dry-types', '~> 1.1'
   spec.add_dependency 'openapi3_parser' # Parsing openapi doc

data/lib/cocina/models/identification.rb

@@ -12,7 +12,7 @@ module Cocina
       # Unique identifier in some other system. This is because a large proportion of what is deposited in SDR, historically and currently, are representations of objects that are also represented in other systems. For example, digitized paper and A/V collections have physical manifestations, and those physical objects are managed in systems that have their own identifiers. Similarly, books have barcodes, archival materials have collection numbers and physical locations, etc. The sourceId allows determining if an item has been deposited before and where to look for the original item if you're looking at its SDR representation. The format is: "namespace:identifier"
 
       # example: sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026
-      attribute :sourceId, Types::Strict::String.meta(omittable: true)
+      attribute :sourceId, Types::Strict::String
     end
   end
 end

data/lib/cocina/models/title_builder.rb

@@ -1,30 +1,35 @@
 # 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
-      # @param [Cocina::Models::D*] cocina_object is the object to extract the title for
+      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(cocina_object, strategy: :first, add_punctuation: true)
-        new(cocina_object, strategy: strategy, add_punctuation: add_punctuation).build_title
+      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(cocina_object, strategy:, add_punctuation:)
-        @cocina_object = cocina_object
+      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_title
-        @titles = cocina_object.description.title
-
-        cocina_title = primary_title || untyped_title
-        cocina_title = other_title if cocina_title.blank?
+      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)
@@ -35,7 +40,7 @@ module Cocina
 
       private
 
-      attr_reader :cocina_object, :strategy, :titles
+      attr_reader :strategy
 
       def extract_title(cocina_title)
         result = if cocina_title.value
@@ -44,7 +49,7 @@ module Cocina
                    title_from_structured_values(cocina_title.structuredValue,
                                                 non_sorting_char_count(cocina_title))
                  elsif cocina_title.parallelValue.present?
-                   return cocina_title.parallelValue.first.value
+                   return build(cocina_title.parallelValue)
                  end
         remove_trailing_punctuation(result.strip) if result.present?
       end
@@ -54,7 +59,7 @@ module Cocina
       end
 
       # @return [Cocina::Models::Title, nil] title that has status=primary
-      def primary_title
+      def primary_title(titles)
         primary_title = titles.find do |title|
           title.status == 'primary'
         end
@@ -69,7 +74,7 @@ module Cocina
         end
       end
 
-      def untyped_title
+      def untyped_title(titles)
         method = strategy == :first ? :find : :select
         untyped_title_for(titles.public_send(method))
       end
@@ -86,7 +91,7 @@ module Cocina
       end
 
       # This handles 'main title', 'uniform' or 'translated'
-      def other_title
+      def other_title(titles)
         if strategy == :first
           titles.first
         else

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.70.0'
+    VERSION = '0.71.0'
   end
 end

data/openapi.yml

@@ -1256,6 +1256,8 @@ components:
           $ref: '#/components/schemas/DOI'
         sourceId:
           $ref: '#/components/schemas/SourceId'
+      required:
+        - sourceId
     Language:
       description: Languages, scripts, symbolic systems, and notations used in all
         or part of a resource or its descriptive metadata.
@@ -1424,7 +1426,7 @@ components:
           format: date-time
         lock:
           description: Key for optimistic locking. The contents of the key is not specified.
-          type: string        
+          type: string
       required:
         - lock
     Presentation:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.70.0
+  version: 0.71.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: deprecation
+  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: dry-struct
   requirement: !ruby/object:Gem::Requirement
@@ -396,7 +410,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.9
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Data models for the SDR