cocina-models 0.76.0 → 0.79.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff6e03954275e59dcc8fbf693f3aeef4b90742767771865508e81541f53f1cbf
-  data.tar.gz: dacc3005506e32d5cca5b599477d1c450844272715e9500f8242bc19bf69972b
+  metadata.gz: 193f5886756d2fd6432e90ab5323f6ed5a11c699cb97f49d61394bc5fafd5f53
+  data.tar.gz: ecb1493a56b7b20f9733084c8a9a115e3a3c6639a8072bc371f53a51d69d0a2c
 SHA512:
-  metadata.gz: bf5f815fb3c09ae4cba6d0e1cf16aafd7502cb731f523004c643806579475d6ac11882845a5d0178732f8d3c9edad56901bf8e05df7d5681a0afdc0032f14058
-  data.tar.gz: 5b88e55c0e25e6dad32a4326a2063bf5a72fedc8146e90a7ead461a1fad0bb1f0f293d360f16884daf5582fa16f4e95fdb61307487e21b7a28b2250c69c1d9ad
+  metadata.gz: 8cc210b897872f3b90fd59e12f381f049b1389b0cf3d798a0375eea57282cf456c6591a8d474c5c612253123bca01ed9a9b931129c89153b8a8dae3ad713254b
+  data.tar.gz: f1a23590223b7760780e3b547b053355a1ba600fdc468ce563aef20a4c38cd3571345bde621f3f9f23248d27c29f0f3b5a829dd0c7d5c08d95d27efec472453d

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/description_types.yml

@@ -132,6 +132,8 @@ event:
     description: The discussion of an academic or intellectual work for an audience, such as a seminar.
   - value: production
     description: The physical assembly of a resource not considered published, such as page proofs for a book.
+  - value: provenance
+    description: The resource's origins and history.
   - value: publication
     description: The publishing or issuing of a resource.
   - value: recording
@@ -389,6 +391,8 @@ identifier:
   - value: record id
   - value: Senate Number
   - value: Series
+  - value: SICI
+    code: sici
   - value: SIRSI
   - value: Source ID
   - value: sourceID

data/docs/description_types.md

@@ -141,6 +141,8 @@ _Path: event.type_
     * The discussion of an academic or intellectual work for an audience, such as a seminar.
   * production
     * The physical assembly of a resource not considered published, such as page proofs for a book.
+  * provenance
+    * The resource's origins and history.
   * publication
     * The publishing or issuing of a resource.
   * recording

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

@@ -15,7 +15,6 @@ module Cocina
           # @param [TitleBuilder] title_builder - defaults to Title class
           # @param [Cocina::Models::Mapping::ErrorNotifier] notifier
           # @return [Hash] a hash that can be mapped to a cocina descriptive model
-          # @raises [Cocina::Mapper::InvalidDescMetadata] if some assumption about descMetadata is violated
           def self.props(mods:, druid:, label:, title_builder: Title, notifier: nil)
             new(title_builder: title_builder, mods: mods, druid: druid, label: label, notifier: notifier).props
           end

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

@@ -5,8 +5,7 @@ module Cocina
     module Mapping
       # Utility methods for generating purl links
       class Purl
-        class_attribute :base_url
-        self.base_url = 'https://purl.stanford.edu'
+        class_attribute :base_url, default: 'https://purl.stanford.edu'
 
         def self.for(druid:)
           return nil if druid.nil?

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

@@ -199,8 +199,6 @@ module Cocina
                 xml.affiliation note.value
               when 'description'
                 xml.description note.value
-              when 'citation status'
-                xml.description UNCITED_DESCRIPTION if note.value == 'false'
               end
             end
           end

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

@@ -11,7 +11,7 @@ module Cocina
 
         def initialize(clazz, attributes)
           @clazz = clazz
-          @attributes = attributes.deep_symbolize_keys
+          @attributes = attributes
           @error_paths = []
         end
 
@@ -29,9 +29,7 @@ module Cocina
         attr_reader :clazz, :attributes, :error_paths
 
         def meets_preconditions?
-          resources.any? do |resource|
-            titles_with_associated_name_note_for(resource).present?
-          end
+          [Cocina::Models::Description, Cocina::Models::RequestDescription].include?(clazz)
         end
 
         def valid?(resource)

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

@@ -11,7 +11,7 @@ module Cocina
 
         def initialize(clazz, attributes)
           @clazz = clazz
-          @attributes = attributes.deep_symbolize_keys
+          @attributes = attributes
           @error_paths = []
         end
 
@@ -30,8 +30,7 @@ module Cocina
         attr_reader :clazz, :attributes, :error_paths
 
         def meets_preconditions?
-          attributes.key?(:description) || [Cocina::Models::Description,
-                                            Cocina::Models::RequestDescription].include?(clazz)
+          [Cocina::Models::Description, Cocina::Models::RequestDescription].include?(clazz)
         end
 
         def validate_hash(hash, path)

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

@@ -0,0 +1,76 @@
+# 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
+          @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?
+          [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)
@@ -25,8 +26,7 @@ module Cocina
           # 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
-
+          end.deep_symbolize_keys.with_indifferent_access
           VALIDATORS.each { |validator| validator.validate(clazz, attributes_hash) }
         end
 

data/lib/cocina/models/version.rb

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

data/lib/cocina/models.rb

@@ -119,7 +119,7 @@ module Cocina
     # @param [DROWithMetadata,CollectionWithMetadata,AdminPolicyWithMetadata] cocina_object
     # @return [DRO,Collection,AdminPolicy]
     def self.without_metadata(cocina_object)
-      build(cocina_object.to_h.except(:created, :modified, :lock))
+      build(cocina_object.to_h.except(:created, :modified, :lock), validate: false)
     end
 
     # Adds metadata to a DRO, Collection, AdminPolicy
@@ -144,7 +144,7 @@ module Cocina
               else
                 AdminPolicyWithMetadata
               end
-      clazz.new(props)
+      clazz.new(props, false, false)
     end
 
     def self.type_for(dyn)

data/lib/cocina/rspec/factories.rb

@@ -12,8 +12,20 @@ module Cocina
         end
       end
 
+      SUPPORTED_TYPES = %i[
+        admin_policy
+        admin_policy_with_metadata
+        collection
+        collection_with_metadata
+        dro
+        dro_with_metadata
+        request_admin_policy
+        request_collection
+        request_dro
+      ].freeze
+
       def self.supported_type?(type)
-        %i[dro collection admin_policy dro_with_metadata collection_with_metadata admin_policy_with_metadata].include?(type)
+        SUPPORTED_TYPES.include?(type)
       end
 
       WITH_METADATA_SUFFIX = '_with_metadata'
@@ -33,37 +45,60 @@ module Cocina
         type: Cocina::Models::ObjectType.object,
         id: 'druid:bc234fg5678',
         version: 1,
-        label: 'test object',
-        title: 'test object',
+        label: 'factory DRO label',
+        title: 'factory DRO title',
         source_id: 'sul:1234',
         admin_policy_id: 'druid:hv992ry2431'
       }.freeze
 
-      COLLECTION_DEFAULTS = DRO_DEFAULTS.except(:source_id).merge(type: Cocina::Models::ObjectType.collection)
+      REQUEST_DRO_DEFAULTS = DRO_DEFAULTS.except(:id)
+
+      COLLECTION_DEFAULTS = {
+        type: Cocina::Models::ObjectType.collection,
+        id: 'druid:bb222ff5555',
+        version: 1,
+        label: 'factory collection label',
+        title: 'factory collection title',
+        admin_policy_id: 'druid:hv992ry2431'
+      }.freeze
+
+      REQUEST_COLLECTION_DEFAULTS = COLLECTION_DEFAULTS.except(:id)
 
       ADMIN_POLICY_DEFAULTS = {
         type: Cocina::Models::ObjectType.admin_policy,
-        id: 'druid:bc234fg5678',
+        id: 'druid:cb432gf8765',
         version: 1,
-        label: 'test admin policy',
-        title: 'test admin policy',
+        label: 'factory APO label',
+        title: 'factory APO title',
         admin_policy_id: 'druid:hv992ry2431',
         agreement_id: 'druid:hp308wm0436'
       }.freeze
 
+      REQUEST_ADMIN_POLICY_DEFAULTS = ADMIN_POLICY_DEFAULTS.except(:id)
+
+      def self.build_dro_properties(id:, **kwargs)
+        build_request_dro_properties(**kwargs)
+          .merge(externalIdentifier: id)
+          .tap do |props|
+          props[:description][:purl] = "https://purl.stanford.edu/#{id.delete_prefix('druid:')}"
+        end
+      end
+
+      def self.build_dro(attributes)
+        Cocina::Models.build(build_dro_properties(**DRO_DEFAULTS.merge(attributes)))
+      end
+
       # rubocop:disable Metrics/ParameterLists
-      def self.build_dro_properties(type:, id:, version:, label:, title:, source_id:, admin_policy_id:,
-                                    barcode: nil, catkeys: [], collection_ids: [])
+      def self.build_request_dro_properties(type:, version:, label:, title:, source_id:, admin_policy_id:,
+                                            barcode: nil, catkeys: [], collection_ids: [])
         {
           type: type,
-          externalIdentifier: id,
           version: version,
           label: label,
           access: {},
           administrative: { hasAdminPolicy: admin_policy_id },
           description: {
-            title: [{ value: title }],
-            purl: "https://purl.stanford.edu/#{id.delete_prefix('druid:')}"
+            title: [{ value: title }]
           },
           identification: {
             sourceId: source_id
@@ -82,22 +117,28 @@ module Cocina
       end
       # rubocop:enable Metrics/ParameterLists
 
-      def self.build_dro(attributes)
-        Cocina::Models.build(build_dro_properties(**DRO_DEFAULTS.merge(attributes)))
+      def self.build_request_dro(attributes)
+        Cocina::Models.build_request(build_request_dro_properties(**REQUEST_DRO_DEFAULTS.merge(attributes)))
+      end
+
+      def self.build_collection_properties(id:, **kwargs)
+        build_request_collection_properties(**kwargs)
+          .merge(externalIdentifier: id)
+          .tap do |props|
+          props[:description][:purl] = "https://purl.stanford.edu/#{id.delete_prefix('druid:')}"
+        end
       end
 
       # rubocop:disable Metrics/ParameterLists
-      def self.build_collection_properties(type:, id:, version:, label:, title:, admin_policy_id:, source_id: nil, catkeys: [])
+      def self.build_request_collection_properties(type:, version:, label:, title:, admin_policy_id:, source_id: nil, catkeys: [])
         {
           type: type,
-          externalIdentifier: id,
           version: version,
           label: label,
           access: {},
           administrative: { hasAdminPolicy: admin_policy_id },
           description: {
-            title: [{ value: title }],
-            purl: "https://purl.stanford.edu/#{id.delete_prefix('druid:')}"
+            title: [{ value: title }]
           },
           identification: {}
         }.tap do |props|
@@ -115,19 +156,34 @@ module Cocina
         Cocina::Models.build(build_collection_properties(**COLLECTION_DEFAULTS.merge(attributes)))
       end
 
+      def self.build_request_collection(attributes)
+        Cocina::Models.build_request(build_request_collection_properties(**REQUEST_COLLECTION_DEFAULTS.merge(attributes)))
+      end
+
       def self.build_admin_policy(attributes)
         Cocina::Models.build(build_admin_policy_properties(**ADMIN_POLICY_DEFAULTS.merge(attributes)))
       end
 
+      def self.build_request_admin_policy(attributes)
+        Cocina::Models.build_request(build_request_admin_policy_properties(**REQUEST_ADMIN_POLICY_DEFAULTS.merge(attributes)))
+      end
+
+      def self.build_admin_policy_properties(id:, **kwargs)
+        build_request_admin_policy_properties(**kwargs)
+          .merge(externalIdentifier: id)
+          .tap do |props|
+          props[:description][:purl] = "https://purl.stanford.edu/#{id.delete_prefix('druid:')}"
+        end
+      end
+
       # rubocop:disable Metrics/ParameterLists
-      def self.build_admin_policy_properties(type:, id:, version:, label:, title:,
-                                             admin_policy_id:, agreement_id:,
-                                             use_statement: nil, copyright: nil, license: nil,
-                                             registration_workflow: nil, collections_for_registration: nil,
-                                             without_description: false)
+      def self.build_request_admin_policy_properties(type:, version:, label:, title:,
+                                                     admin_policy_id:, agreement_id:,
+                                                     use_statement: nil, copyright: nil, license: nil,
+                                                     registration_workflow: nil, collections_for_registration: nil,
+                                                     without_description: false)
         {
           type: type,
-          externalIdentifier: id,
           version: version,
           label: label,
           administrative: {
@@ -139,8 +195,7 @@ module Cocina
             }
           },
           description: {
-            title: [{ value: title }],
-            purl: "https://purl.stanford.edu/#{id.delete_prefix('druid:')}"
+            title: [{ value: title }]
           }
         }.tap do |props|
           props[:administrative][:accessTemplate][:useAndReproductionStatement] = use_statement if use_statement

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.76.0
+  version: 0.79.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-28 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -306,20 +306,6 @@ files:
 - docs/cocina-base.jsonld
 - docs/description_types.md
 - docs/index.html
-- docs/maps/Agent.json
-- docs/maps/Collection.json
-- docs/maps/DRO.json
-- docs/maps/Description.json
-- docs/maps/File.json
-- docs/maps/Fileset.json
-- docs/maps/README.md
-- docs/maps/ReleaseTag.json
-- docs/maps/Sequence.json
-- docs/maps/Title.json
-- docs/sampleETD/foxml-export.xml
-- docs/sampleETD/foxml.xml
-- docs/sampleETD/xn109qc9773_bibframe.ttl
-- docs/sampleETD/xn109qc9773_taco.json
 - exe/generator
 - lib/cocina/generator.rb
 - lib/cocina/generator/datatype.rb
@@ -476,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

data/docs/maps/Agent.json

@@ -1,18 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-06/schema#",
-  "id": "http://cocina.sul.stanford.edu/schemas/Agent",
-  "title": "Agent",
-  "description": "An Agent - Person, Group, Organization, or other Acting body.",
-  "type": "object",
-  "required": ["name"],
-  "properties": {
-    "name": {
-      "description": "Primary label or name for an Agent.",
-      "type": "string"
-    },
-    "sunetID": {
-      "description": "Stanford University NetID for the Agent.",
-      "type": "string"
-    }
-  }
-}