cocina-models 0.75.0 → 0.76.0

data/lib/cocina/rspec/factories.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+module Cocina
+  module RSpec
+    # Factories for Cocina model objects.
+    class Factories
+      # Provides the build method.
+      module Methods
+        def build(type, ...)
+          # If we don't support this factory, maybe factory_bot does.
+          Factories.supported_type?(type) ? Factories.build(type, ...) : super
+        end
+      end
+
+      def self.supported_type?(type)
+        %i[dro collection admin_policy dro_with_metadata collection_with_metadata admin_policy_with_metadata].include?(type)
+      end
+
+      WITH_METADATA_SUFFIX = '_with_metadata'
+
+      def self.build(type, attributes = {})
+        raise "Unsupported factory type #{type}" unless supported_type?(type)
+
+        build_type = type.to_s.delete_suffix(WITH_METADATA_SUFFIX)
+
+        fixture = public_send("build_#{build_type}".to_sym, attributes)
+        return fixture unless type.end_with?(WITH_METADATA_SUFFIX)
+
+        Cocina::Models.with_metadata(fixture, 'abc123')
+      end
+
+      DRO_DEFAULTS = {
+        type: Cocina::Models::ObjectType.object,
+        id: 'druid:bc234fg5678',
+        version: 1,
+        label: 'test object',
+        title: 'test object',
+        source_id: 'sul:1234',
+        admin_policy_id: 'druid:hv992ry2431'
+      }.freeze
+
+      COLLECTION_DEFAULTS = DRO_DEFAULTS.except(:source_id).merge(type: Cocina::Models::ObjectType.collection)
+
+      ADMIN_POLICY_DEFAULTS = {
+        type: Cocina::Models::ObjectType.admin_policy,
+        id: 'druid:bc234fg5678',
+        version: 1,
+        label: 'test admin policy',
+        title: 'test admin policy',
+        admin_policy_id: 'druid:hv992ry2431',
+        agreement_id: 'druid:hp308wm0436'
+      }.freeze
+
+      # rubocop:disable Metrics/ParameterLists
+      def self.build_dro_properties(type:, id:, 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:')}"
+          },
+          identification: {
+            sourceId: source_id
+          },
+          structural: {
+            isMemberOf: collection_ids
+          }
+        }.tap do |props|
+          if catkeys.present?
+            props[:identification][:catalogLinks] = catkeys.map.with_index do |catkey, index|
+              { catalog: 'symphony', catalogRecordId: catkey, refresh: index.zero? }
+            end
+          end
+          props[:identification][:barcode] = barcode if barcode
+        end
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def self.build_dro(attributes)
+        Cocina::Models.build(build_dro_properties(**DRO_DEFAULTS.merge(attributes)))
+      end
+
+      # rubocop:disable Metrics/ParameterLists
+      def self.build_collection_properties(type:, id:, 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:')}"
+          },
+          identification: {}
+        }.tap do |props|
+          if catkeys.present?
+            props[:identification][:catalogLinks] = catkeys.map.with_index do |catkey, index|
+              { catalog: 'symphony', catalogRecordId: catkey, refresh: index.zero? }
+            end
+          end
+          props[:identification][:sourceId] = source_id if source_id
+        end
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def self.build_collection(attributes)
+        Cocina::Models.build(build_collection_properties(**COLLECTION_DEFAULTS.merge(attributes)))
+      end
+
+      def self.build_admin_policy(attributes)
+        Cocina::Models.build(build_admin_policy_properties(**ADMIN_POLICY_DEFAULTS.merge(attributes)))
+      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)
+        {
+          type: type,
+          externalIdentifier: id,
+          version: version,
+          label: label,
+          administrative: {
+            hasAdminPolicy: admin_policy_id,
+            hasAgreement: agreement_id,
+            accessTemplate: {
+              view: 'world',
+              download: 'world'
+            }
+          },
+          description: {
+            title: [{ value: title }],
+            purl: "https://purl.stanford.edu/#{id.delete_prefix('druid:')}"
+          }
+        }.tap do |props|
+          props[:administrative][:accessTemplate][:useAndReproductionStatement] = use_statement if use_statement
+          props[:administrative][:accessTemplate][:copyright] = copyright if copyright
+          props[:administrative][:accessTemplate][:license] = license if license
+          props[:administrative][:registrationWorkflow] = registration_workflow if registration_workflow
+          props[:administrative][:collectionsForRegistration] = collections_for_registration if collections_for_registration
+          props.delete(:description) if without_description
+        end
+      end
+      # rubocop:enable Metrics/ParameterLists
+    end
+  end
+end

data/lib/cocina/rspec.rb

@@ -4,7 +4,9 @@ require 'rspec/core'
 require 'rspec/matchers'
 require 'super_diff/rspec'
 require 'cocina/rspec/matchers'
+require 'cocina/rspec/factories'
 
 RSpec.configure do |config|
   config.include Cocina::RSpec::Matchers
+  config.include Cocina::RSpec::Factories::Methods
 end

data/openapi.yml

@@ -383,6 +383,7 @@ components:
         catalogRecordId:
           description: Record identifier that is unique within the context of the linked record's catalog.
           type: string
+          pattern: '^\d+(:\d+)*$'
           example: '11403803'
       required:
         - catalog
@@ -523,7 +524,7 @@ components:
           items:
             $ref: "#/components/schemas/DescriptiveValue"
         type:
-          description: Entity type of the contributor (person, organization, etc.). See https://sul-dlss.github.io/cocina-models/description_types.html for valid types.
+          description: 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.
           type: string
         status:
           description: Status of the contributor relative to other parallel contributors
@@ -579,7 +580,6 @@ components:
       required:
         - view
         - download
-        - controlledDigitalLending
     DarkAccess:
       type: object
       properties:
@@ -712,7 +712,7 @@ components:
               # https://github.com/interagent/committee/issues/286
               # - type: integer
             type:
-              description: Type of value provided by the descriptive element. See https://sul-dlss.github.io/cocina-models/description_types.html for valid types.
+              description: Type of value provided by the descriptive element. See https://github.com/sul-dlss/cocina-models/blob/main/docs/description_types.md for valid types.
               type: string
             status:
               description: Status of the descriptive element value relative to other instances
@@ -788,7 +788,7 @@ components:
           items:
             $ref: "#/components/schemas/DescriptiveValue"
         type:
-          description: Entity type of the contributor (person, organization, etc.). See https://sul-dlss.github.io/cocina-models/description_types.html for valid types.
+          description: 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.
           type: string
         status:
           description: Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.75.0
+  version: 0.76.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: equivalent-xml
+  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
+    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: openapi3_parser
   requirement: !ruby/object:Gem::Requirement
@@ -275,7 +303,6 @@ files:
 - bin/setup
 - cocina-models.gemspec
 - description_types.yml
-- docs/_config.yml
 - docs/cocina-base.jsonld
 - docs/description_types.md
 - docs/index.html
@@ -363,6 +390,63 @@ files:
 - lib/cocina/models/license.rb
 - 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/from_mods/access.rb
+- lib/cocina/models/mapping/from_mods/admin_metadata.rb
+- lib/cocina/models/mapping/from_mods/alt_rep_group.rb
+- lib/cocina/models/mapping/from_mods/authority.rb
+- lib/cocina/models/mapping/from_mods/contributor.rb
+- lib/cocina/models/mapping/from_mods/description.rb
+- lib/cocina/models/mapping/from_mods/description_builder.rb
+- lib/cocina/models/mapping/from_mods/event.rb
+- lib/cocina/models/mapping/from_mods/form.rb
+- lib/cocina/models/mapping/from_mods/geographic.rb
+- lib/cocina/models/mapping/from_mods/hydrus_default_title_builder.rb
+- lib/cocina/models/mapping/from_mods/identifier.rb
+- lib/cocina/models/mapping/from_mods/identifier_builder.rb
+- lib/cocina/models/mapping/from_mods/identifier_type.rb
+- lib/cocina/models/mapping/from_mods/language.rb
+- lib/cocina/models/mapping/from_mods/language_script.rb
+- lib/cocina/models/mapping/from_mods/language_term.rb
+- lib/cocina/models/mapping/from_mods/name_builder.rb
+- lib/cocina/models/mapping/from_mods/note.rb
+- lib/cocina/models/mapping/from_mods/part_builder.rb
+- lib/cocina/models/mapping/from_mods/primary.rb
+- lib/cocina/models/mapping/from_mods/purl.rb
+- lib/cocina/models/mapping/from_mods/related_resource.rb
+- lib/cocina/models/mapping/from_mods/subject.rb
+- lib/cocina/models/mapping/from_mods/subject_authority_codes.rb
+- lib/cocina/models/mapping/from_mods/title.rb
+- lib/cocina/models/mapping/from_mods/title_builder.rb
+- lib/cocina/models/mapping/from_mods/title_builder_strategy.rb
+- lib/cocina/models/mapping/from_mods/value_uri.rb
+- lib/cocina/models/mapping/normalizers/base.rb
+- lib/cocina/models/mapping/normalizers/mods/geo_extension_normalizer.rb
+- lib/cocina/models/mapping/normalizers/mods/name_normalizer.rb
+- lib/cocina/models/mapping/normalizers/mods/origin_info_normalizer.rb
+- lib/cocina/models/mapping/normalizers/mods/subject_normalizer.rb
+- lib/cocina/models/mapping/normalizers/mods/title_normalizer.rb
+- lib/cocina/models/mapping/normalizers/mods_normalizer.rb
+- lib/cocina/models/mapping/purl.rb
+- lib/cocina/models/mapping/to_mods/access.rb
+- lib/cocina/models/mapping/to_mods/admin_metadata.rb
+- lib/cocina/models/mapping/to_mods/contributor.rb
+- lib/cocina/models/mapping/to_mods/description.rb
+- lib/cocina/models/mapping/to_mods/event.rb
+- lib/cocina/models/mapping/to_mods/form.rb
+- lib/cocina/models/mapping/to_mods/geographic.rb
+- lib/cocina/models/mapping/to_mods/id_generator.rb
+- lib/cocina/models/mapping/to_mods/identifier.rb
+- lib/cocina/models/mapping/to_mods/language.rb
+- lib/cocina/models/mapping/to_mods/mods_writer.rb
+- lib/cocina/models/mapping/to_mods/name_title_group.rb
+- lib/cocina/models/mapping/to_mods/name_writer.rb
+- lib/cocina/models/mapping/to_mods/note.rb
+- lib/cocina/models/mapping/to_mods/part_writer.rb
+- lib/cocina/models/mapping/to_mods/related_resource.rb
+- lib/cocina/models/mapping/to_mods/role_writer.rb
+- lib/cocina/models/mapping/to_mods/subject.rb
+- lib/cocina/models/mapping/to_mods/title.rb
 - lib/cocina/models/message_digest.rb
 - lib/cocina/models/object_metadata.rb
 - lib/cocina/models/object_type.rb
@@ -399,6 +483,7 @@ files:
 - lib/cocina/models/vocabulary.rb
 - lib/cocina/models/world_access.rb
 - lib/cocina/rspec.rb
+- lib/cocina/rspec/factories.rb
 - lib/cocina/rspec/matchers.rb
 - openapi.yml
 homepage: https://github.com/sul-dlss/cocina-models

data/docs/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-tactile