cocina-models 0.64.0 → 0.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9539fc314563e23d96f0f90cf2a97eca07ebbc2a63e9678581530a2cd7843396
-  data.tar.gz: 2a8d73a4d425dd4ad399431108e987590cc9aea97515aeb77edc7c49758fb4d5
+  metadata.gz: def07c3b758899fb7dafda2ab26d7376318137895cb1335ab22404ab939e6e15
+  data.tar.gz: cb8f57478510d3f40a9241e944484437889dbf4b0b09e992696da7b9d1e595c1
 SHA512:
-  metadata.gz: 447c58bbc28217dabd2664a23527eeedfa5588684700316b5507735d9d832e8905fbf9177f1918a1abb30d2cc4ce693e4d111cb47631d0f579a3fe7a780275cf
-  data.tar.gz: 61d83471e7b68292b2c945bbfb07d47d3bf179b40552b03e190eda1cf5915d7569606e6873275fdd327542e7c1d0767903797cd1c73d2c08241c8aa9ed0af33a
+  metadata.gz: 1de2f3d0703139311d8f58f1ec24b5b579b330c0461c645ebe76d153930ab91850d694a2b7a138a8ee6c63ee8ba5562f6c24ff044a7dd0bf40355eb1007afd51
+  data.tar.gz: ecdfd2b784a0e42c30e348d08dbe7a6f092c369d7830dd86b11c2ff8185fef4238068fdc4b5e7fe8af90d1d9477e17436d03fde5058855d97819a7270ebc304e

data/.github/pull_request_template.md

@@ -1,11 +1,12 @@
 **NOTE:  Changes to openapi.yml require updating openapi.yml for sdr-api and dor-services-app and generating models - see README.**
 
-## Why was this change made?
+## Why was this change made? 🤔
 
 
 
-## How was this change tested?
+## How was this change tested? 🤨
+
+⚡ ⚠ If this change has cross service impact, ***run [integration tests](https://github.com/sul-dlss/infrastructure-integration-test)*** and/or test in [stage|qa] environment, in addition to specs. ⚡
 
 
 
-## Which documentation and/or configurations were updated?

data/lib/cocina/generator/generator.rb

@@ -76,6 +76,7 @@ module Cocina
         run("rubocop -a #{filepath} > /dev/null")
       end
 
+      # rubocop:disable Metrics/AbcSize
       def clean_output
         FileUtils.mkdir_p(options[:output])
         files = Dir.glob("#{options[:output]}/*.rb")
@@ -83,8 +84,10 @@ module Cocina
         files.delete("#{options[:output]}/version.rb")
         files.delete("#{options[:output]}/checkable.rb")
         files.delete("#{options[:output]}/validator.rb")
+        files.delete("#{options[:output]}/validatable.rb")
         FileUtils.rm_f(files)
       end
+      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/cocina/generator/schema.rb

@@ -16,11 +16,10 @@ module Cocina
             module Models
               class #{name} < Struct
 
+                #{validate}
                 #{types}
 
                 #{model_attributes}
-
-                #{validate}
               end
             end
           end
@@ -64,10 +63,7 @@ module Cocina
         return '' unless validatable?
 
         <<~RUBY
-          def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-            Validator.validate(self, attributes.with_indifferent_access) if validate && name
-            super(attributes, safe, &block)
-                end
+          include Validatable
         RUBY
       end
 

data/lib/cocina/models/admin_policy.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class AdminPolicy < Struct
+      include Validatable
+
       include Checkable
 
       TYPES = ['http://cocina.sul.stanford.edu/models/admin_policy.jsonld'].freeze
@@ -17,11 +19,6 @@ module Cocina
       attribute :version, Types::Strict::Integer
       attribute(:administrative, AdminPolicyAdministrative.default { AdminPolicyAdministrative.new })
       attribute :description, Description.optional.meta(omittable: true)
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/admin_policy_administrative.rb

@@ -3,8 +3,6 @@
 module Cocina
   module Models
     class AdminPolicyAdministrative < Struct
-      # This is an XML expression of the default access (see defaultAccess)
-      attribute :defaultObjectRights, Types::Strict::String.default('<?xml version="1.0" encoding="UTF-8"?><rightsMetadata><access type="discover"><machine><world/></machine></access><access type="read"><machine><world/></machine></access><use><human type="useAndReproduction"/><human type="creativeCommons"/><machine type="creativeCommons" uri=""/><human type="openDataCommons"/><machine type="openDataCommons" uri=""/></use><copyright><human/></copyright></rightsMetadata>').meta(omittable: true)
       attribute :defaultAccess, AdminPolicyDefaultAccess.optional.meta(omittable: true)
       attribute :registrationWorkflow, Types::Strict::Array.of(Types::Strict::String).default([].freeze)
       # An additional workflow to start for objects managed by this admin policy once the end-accession workflow step is complete
@@ -15,8 +13,6 @@ module Cocina
       attribute :hasAdminPolicy, Types::Strict::String
       # example: druid:bc123df4567
       attribute :hasAgreement, Types::Strict::String
-      # example: druid:bc123df4567
-      attribute :referencesAgreement, Types::Strict::String.meta(omittable: true)
       attribute :roles, Types::Strict::Array.of(AccessRole).default([].freeze)
     end
   end

data/lib/cocina/models/collection.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class Collection < Struct
+      include Validatable
+
       include Checkable
 
       TYPES = ['http://cocina.sul.stanford.edu/models/collection.jsonld',
@@ -26,11 +28,6 @@ module Cocina
       attribute :administrative, Administrative.optional.meta(omittable: true)
       attribute :description, Description.optional.meta(omittable: true)
       attribute :identification, CollectionIdentification.optional.meta(omittable: true)
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/collection_access.rb

@@ -10,9 +10,9 @@ module Cocina
       attribute :copyright, Types::Strict::String.optional.meta(omittable: true)
       # The human readable use and reproduction statement that applies
       # example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
-      attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
+      attribute :useAndReproductionStatement, Types::Strict::String.optional.meta(omittable: true)
       # The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
-      attribute :license, Types::Strict::String.meta(omittable: true)
+      attribute :license, Types::Strict::String.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/description.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class Description < Struct
+      include Validatable
+
       attribute :title, Types::Strict::Array.of(Title).default([].freeze)
       attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
       attribute :event, Types::Strict::Array.of(Event).default([].freeze)
@@ -20,11 +22,6 @@ module Cocina
       attribute :valueAt, Types::Strict::String.meta(omittable: true)
       # Stanford persistent URL associated with the related resource. Note this is http, not https.
       attribute :purl, Types::Strict::String
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/dro.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class DRO < Struct
+      include Validatable
+
       include Checkable
 
       TYPES = ['http://cocina.sul.stanford.edu/models/object.jsonld',
@@ -38,11 +40,6 @@ module Cocina
       attribute :identification, Identification.optional.meta(omittable: true)
       attribute :structural, DROStructural.optional.meta(omittable: true)
       attribute :geographic, Geographic.optional.meta(omittable: true)
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/dro_access.rb

@@ -20,9 +20,9 @@ module Cocina
       attribute :embargo, Embargo.optional.meta(omittable: true)
       # The human readable use and reproduction statement that applies
       # example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
-      attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
+      attribute :useAndReproductionStatement, Types::Strict::String.optional.meta(omittable: true)
       # The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
-      attribute :license, Types::Strict::String.enum('https://www.gnu.org/licenses/agpl.txt', 'https://www.apache.org/licenses/LICENSE-2.0', 'https://opensource.org/licenses/BSD-2-Clause', 'https://opensource.org/licenses/BSD-3-Clause', 'https://creativecommons.org/licenses/by/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode', 'https://creativecommons.org/licenses/by-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-sa/4.0/legalcode', 'https://creativecommons.org/publicdomain/zero/1.0/legalcode', 'https://opensource.org/licenses/cddl1', 'https://www.eclipse.org/legal/epl-2.0', 'https://www.gnu.org/licenses/gpl-3.0-standalone.html', 'https://www.isc.org/downloads/software-support-policy/isc-license/', 'https://www.gnu.org/licenses/lgpl-3.0-standalone.html', 'https://opensource.org/licenses/MIT', 'https://www.mozilla.org/MPL/2.0/', 'https://opendatacommons.org/licenses/by/1-0/', 'http://opendatacommons.org/licenses/odbl/1.0/', 'https://opendatacommons.org/licenses/odbl/1-0/', 'https://creativecommons.org/publicdomain/mark/1.0/', 'https://opendatacommons.org/licenses/pddl/1-0/', 'https://creativecommons.org/licenses/by/3.0/legalcode', 'https://creativecommons.org/licenses/by-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nd/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode', 'http://cocina.sul.stanford.edu/licenses/none').meta(omittable: true)
+      attribute :license, Types::Strict::String.optional.enum('https://www.gnu.org/licenses/agpl.txt', 'https://www.apache.org/licenses/LICENSE-2.0', 'https://opensource.org/licenses/BSD-2-Clause', 'https://opensource.org/licenses/BSD-3-Clause', 'https://creativecommons.org/licenses/by/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode', 'https://creativecommons.org/licenses/by-nd/4.0/legalcode', 'https://creativecommons.org/licenses/by-sa/4.0/legalcode', 'https://creativecommons.org/publicdomain/zero/1.0/legalcode', 'https://opensource.org/licenses/cddl1', 'https://www.eclipse.org/legal/epl-2.0', 'https://www.gnu.org/licenses/gpl-3.0-standalone.html', 'https://www.isc.org/downloads/software-support-policy/isc-license/', 'https://www.gnu.org/licenses/lgpl-3.0-standalone.html', 'https://opensource.org/licenses/MIT', 'https://www.mozilla.org/MPL/2.0/', 'https://opendatacommons.org/licenses/by/1-0/', 'http://opendatacommons.org/licenses/odbl/1.0/', 'https://opendatacommons.org/licenses/odbl/1-0/', 'https://creativecommons.org/publicdomain/mark/1.0/', 'https://opendatacommons.org/licenses/pddl/1-0/', 'https://creativecommons.org/licenses/by/3.0/legalcode', 'https://creativecommons.org/licenses/by-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nd/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode', 'https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode', 'http://cocina.sul.stanford.edu/licenses/none').meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/embargo.rb

@@ -19,7 +19,7 @@ module Cocina
       attribute :releaseDate, Types::Params::DateTime
       # The human readable use and reproduction statement that applies when the embargo expires.
       # example: These materials are in the public domain.
-      attribute :useAndReproductionStatement, Types::Strict::String.meta(omittable: true)
+      attribute :useAndReproductionStatement, Types::Strict::String.optional.meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/request_admin_policy.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class RequestAdminPolicy < Struct
+      include Validatable
+
       include Checkable
 
       TYPES = ['http://cocina.sul.stanford.edu/models/admin_policy.jsonld'].freeze
@@ -15,11 +17,6 @@ module Cocina
       attribute :version, Types::Strict::Integer
       attribute(:administrative, AdminPolicyAdministrative.default { AdminPolicyAdministrative.new })
       attribute :description, RequestDescription.optional.meta(omittable: true)
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/request_collection.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class RequestCollection < Struct
+      include Validatable
+
       include Checkable
 
       TYPES = ['http://cocina.sul.stanford.edu/models/collection.jsonld',
@@ -21,11 +23,6 @@ module Cocina
       attribute(:administrative, Administrative.default { Administrative.new })
       attribute :description, RequestDescription.optional.meta(omittable: true)
       attribute :identification, CollectionIdentification.optional.meta(omittable: true)
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/request_description.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class RequestDescription < Struct
+      include Validatable
+
       attribute :title, Types::Strict::Array.of(Title).default([].freeze)
       attribute :contributor, Types::Strict::Array.of(Contributor).default([].freeze)
       attribute :event, Types::Strict::Array.of(Event).default([].freeze)
@@ -18,11 +20,6 @@ module Cocina
       attribute :adminMetadata, DescriptiveAdminMetadata.optional.meta(omittable: true)
       # URL or other pointer to the location of the resource description.
       attribute :valueAt, Types::Strict::String.meta(omittable: true)
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/request_dro.rb

@@ -3,6 +3,8 @@
 module Cocina
   module Models
     class RequestDRO < Struct
+      include Validatable
+
       include Checkable
 
       TYPES = ['http://cocina.sul.stanford.edu/models/object.jsonld',
@@ -33,11 +35,6 @@ module Cocina
       attribute(:identification, RequestIdentification.default { RequestIdentification.new })
       attribute :structural, RequestDROStructural.optional.meta(omittable: true)
       attribute :geographic, Geographic.optional.meta(omittable: true)
-
-      def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-        Validator.validate(self, attributes.with_indifferent_access) if validate && name
-        super(attributes, safe, &block)
-      end
     end
   end
 end

data/lib/cocina/models/validatable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # Validate upon construction
+    module Validatable
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def new(attributes = default_attributes, safe = false, validate = true, &block)
+          Validator.validate(self, attributes.with_indifferent_access) if validate && name
+          super(attributes, safe, &block)
+        end
+      end
+
+      def new(*args)
+        validate = args.first.delete(:validate) if args.present?
+        new_model = super(*args)
+        Validator.validate(new_model.class, new_model.to_h) if (validate || validate.nil?) && self.class.name
+        new_model
+      end
+    end
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.64.0'
+    VERSION = '0.66.0'
   end
 end

data/openapi.yml

@@ -212,11 +212,6 @@ components:
       type: object
       additionalProperties: false
       properties:
-        defaultObjectRights:
-          type: string
-          description: This is an XML expression of the default access (see defaultAccess)
-          deprecated: true
-          default: <?xml version="1.0" encoding="UTF-8"?><rightsMetadata><access type="discover"><machine><world/></machine></access><access type="read"><machine><world/></machine></access><use><human type="useAndReproduction"/><human type="creativeCommons"/><machine type="creativeCommons" uri=""/><human type="openDataCommons"/><machine type="openDataCommons" uri=""/></use><copyright><human/></copyright></rightsMetadata>
         defaultAccess:
           $ref: '#/components/schemas/AdminPolicyDefaultAccess'
         registrationWorkflow:
@@ -237,8 +232,6 @@ components:
           $ref: '#/components/schemas/Druid'
         hasAgreement:
           $ref: '#/components/schemas/Druid'
-        referencesAgreement:
-          $ref: '#/components/schemas/Druid'
         roles:
           description: The access roles conferred by this AdminPolicy (used by Argo)
           type: array
@@ -443,9 +436,11 @@ components:
           description: The human readable use and reproduction statement that applies
           example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
           type: string
+          nullable: true
         license:
           description: The license governing reuse of the Collection. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
           type: string
+          nullable: true
     CollectionIdentification:
       type: object
       additionalProperties: false
@@ -917,9 +912,11 @@ components:
               description: The human readable use and reproduction statement that applies
               example: Property rights reside with the repository. Literary rights reside with the creators of the documents or their heirs. To obtain permission to publish or reproduce, please contact the Public Services Librarian of the Dept. of Special Collections (http://library.stanford.edu/spc).
               type: string
+              nullable: true
             license:
               description: The license governing reuse of the DRO. Should be an IRI for known licenses (i.e. CC, RightsStatement.org URI, etc.).
               type: string
+              nullable: true
               enum:
                 - 'https://www.gnu.org/licenses/agpl.txt'
                 - 'https://www.apache.org/licenses/LICENSE-2.0'
@@ -991,6 +988,7 @@ components:
               description: The human readable use and reproduction statement that applies when the embargo expires.
               example: These materials are in the public domain.
               type: string
+              nullable: true
           required:
             - releaseDate
     Event:
@@ -1845,6 +1843,7 @@ components:
     StandardBarcode:
       description: The standard barcode associated with a DRO object, prefixed with 36105
       type: string
+      nullable: true
       pattern: '^36105[0-9]{9}$'
       example: '36105010362304'
     Title:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.64.0
+  version: 0.66.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -338,6 +338,7 @@ files:
 - lib/cocina/models/standard_barcode.rb
 - lib/cocina/models/stanford_access.rb
 - lib/cocina/models/title.rb
+- lib/cocina/models/validatable.rb
 - lib/cocina/models/validator.rb
 - lib/cocina/models/version.rb
 - lib/cocina/models/vocab.rb