cocina-models 0.77.0 → 0.78.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3448513fd9c5a834a341c41dc2e532fe9196d5aafca3ed6812f4243ef952e960
-  data.tar.gz: 2c1e122cd5d903ce1d92a443f1d8ab2879aaf8cdc9550f3b27c67342ce32bdc8
+  metadata.gz: '09a3e28b24593aeb0e75c0318067e72fc8e10bb98e189d00b3f166357b198cab'
+  data.tar.gz: 688dbfe3ef449fe8caccd5c3518a6cd059cff2920ad9af3d9fb11553516b520e
 SHA512:
-  metadata.gz: ca06ecb3bf3952a5190dbff8ce3510c4612a49e50f863d70511dd93f6678a184bd2f664197bc7a3ad5004b55d2bc7d66865b85796b39c5701e9eebdb71b580b7
-  data.tar.gz: 804c0deb6ec304f9e2ab44808ec7c9f9e47a4a8df15432ec66d4dd068939116f1f5a22405658a7e20651b961fba4949708b5bd28ede4f63ac0060c126416f7cc
+  metadata.gz: 3bc1bce3e8624fa829ce0f41b69362d723e77549d102d561b41245c462c178cbcac5733fcd0816fd7750fa7bf736611e46de503e1e6b93dfce009ae6bd33eea4
+  data.tar.gz: 5cb526603a08485e0c04abccfa962b92b890fbf9d966d5dc00cb5ddd9aec64b24ebb4aa555397d769d5814edb914960d7d83a1b7f5c23be6752252f34b64a033

data/README.md

@@ -55,8 +55,37 @@ If there is a possibility that a model or validation change will conflict with s
 
 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.
+3. Select the appropriate database.
+For QA:
+```
+export DATABASE_NAME="dor_services"
+export DATABASE_USERNAME=$DOR_SERVICES_DB_USER
+export DATABASE_HOSTNAME=$DOR_SERVICES_DB_QA_HOST
+export DATABASE_PASSWORD=$DOR_SERVICES_DB_QA_PWD
+```
+
+For stage:
+```
+export DATABASE_NAME="dor_services"
+export DATABASE_USERNAME=$DOR_SERVICES_DB_USER
+export DATABASE_HOSTNAME=$DOR_SERVICES_DB_STAGE_HOST
+export DATABASE_PASSWORD=$DOR_SERVICES_DB_STAGE_PWD
+```
+
+For production:
+```
+export DATABASE_NAME="dor_services"
+export DATABASE_USERNAME=$DOR_SERVICES_DB_USER
+export DATABASE_HOSTNAME=$DOR_SERVICES_DB_PROD_HOST
+export DATABASE_PASSWORD=$DOR_SERVICES_DB_PROD_PWD
+```
+
+4. Run `bin/validate-cocina`:
+```
+export RUBYOPT='-W:no-deprecated -W:no-experimental'
+RAILS_ENV=production bin/validate-cocina -p 8
+```
+5. Check `validate-cocina.csv` for validation errors.
 
 ## Releasing
 

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates that there is only one of value, groupedValue, structuredValue, or parallelValue.
+      class DescriptionValuesValidator
+        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?
+
+          validate_obj(attributes, [])
+
+          return if error_paths.empty?
+
+          raise ValidationError, "Multiple value, groupedValue, structuredValue, and parallelValue in description: #{error_paths.join(', ')}"
+        end
+
+        private
+
+        attr_reader :clazz, :attributes, :error_paths
+
+        def meets_preconditions?
+          attributes.key?(:description) || [Cocina::Models::Description,
+                                            Cocina::Models::RequestDescription].include?(clazz)
+        end
+
+        def validate_hash(hash, path)
+          validate_values(hash, path)
+          hash.each do |key, obj|
+            validate_obj(obj, path + [key])
+          end
+        end
+
+        def validate_array(array, path)
+          array.each_with_index do |obj, index|
+            validate_obj(obj, path + [index])
+          end
+        end
+
+        def validate_obj(obj, path)
+          validate_hash(obj, path) if obj.is_a?(Hash)
+          validate_array(obj, path) if obj.is_a?(Array)
+        end
+
+        def validate_values(hash, path)
+          return unless hash.count { |key, value| %i[value groupedValue structuredValue parallelValue].include?(key) && value.present? } > 1
+
+          error_paths << path_to_s(path)
+        end
+
+        def path_to_s(path)
+          # This matches the format used by descriptive spreadsheets
+          path_str = ''
+          path.each_with_index do |part, index|
+            if part.is_a?(Integer)
+              path_str += (part + 1).to_s
+            else
+              path_str += '.' if index.positive?
+              path_str += part.to_s
+            end
+          end
+          path_str
+        end
+      end
+    end
+  end
+end

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

@@ -11,7 +11,8 @@ module Cocina
           PurlValidator,
           CatalogLinksValidator,
           AssociatedNameValidator,
-          DescriptionTypesValidator
+          DescriptionTypesValidator,
+          DescriptionValuesValidator
         ].freeze
 
         def self.validate(clazz, attributes)

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.77.0'
+    VERSION = '0.78.0'
   end
 end

data/openapi.yml

@@ -691,7 +691,7 @@ components:
           items:
             $ref: "#/components/schemas/DescriptiveValue"
     DescriptiveBasicValue:
-      description: Basic value model for descriptive elements.
+      description: Basic value model for descriptive elements. Can only have one of value, parallelValue, groupedValue, or structuredValue.
       type: object
       # additionalProperties breaks the validator for allOf, unclear as to why.
       # additionalProperties: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.77.0
+  version: 0.78.0
 platform: ruby
 authors:
 - Justin Coyne
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-02 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -462,6 +462,7 @@ files:
 - 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/description_values_validator.rb
 - lib/cocina/models/validators/open_api_validator.rb
 - lib/cocina/models/validators/purl_validator.rb
 - lib/cocina/models/validators/validator.rb
@@ -476,7 +477,7 @@ homepage: https://github.com/sul-dlss/cocina-models
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -491,8 +492,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key: 
+rubygems_version: 3.3.9
+signing_key:
 specification_version: 4
 summary: Data models for the SDR
 test_files: []