cocina-models 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa8dd7285b70bcc1a81fd099ada06d39ceba9f24900076deec73dd46573df2f4
-  data.tar.gz: c196659cf0ce69aee69ffc3472235d68d9e4eb0503ed70aa5c79f517c8412498
+  metadata.gz: 258bc916aaaff62a84cd0bd264f8957e3c916310134ef3372cfdd3eca4c1ff4e
+  data.tar.gz: c26a6cc519230a25d19b218ddcec52fa552ea7780f647b6d449aee223be35eef
 SHA512:
-  metadata.gz: a001d343d4233b377aa0c666383ce2f70abb36f3fc05169f007fc7f1b6f8e9784f5ff67f204255a585b1f4e9ddd6c3d624a4baf0057b78607c73b7df93e3b173
-  data.tar.gz: cb9db638c1ffaad358e05bc097c5fc9ec44a3df56bb4b13418f417daf2a71879561885a9e26adfcaf37e37bdf3542fca9055340816f2253b8f5f9f4c69b0eef0
+  metadata.gz: cd057f437502f2e54f6b2c689b6aef4c808ac4912c91d87755abfeb13c24100ef3380f262e7ec27f42592ecbd59b16d68669c878a31c55fc2402f069c5142f1e
+  data.tar.gz: 5a27ebb9108e9838117b02ec015bb025120d82e3f90749b12d23b523f3eea4efe865b6e405f649574f10f88ee0a70811334c339e9d522f5f1186b72f59df9240

data/.rubocop.yml

@@ -4,7 +4,7 @@ inherit_from: .rubocop_todo.yml
 require:
   - rubocop-rspec
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 114
   Exclude:
     - lib/cocina/models/*
@@ -26,7 +26,58 @@ RSpec/ExampleLength:
     - spec/cocina/models/description_spec.rb
     - spec/cocina/models/dro_shared_examples.rb
 
-
 Style/Documentation:
   Exclude:
     - lib/cocina/models/*
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+  

data/cocina-models.gemspec

@@ -33,9 +33,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'committee'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.74.0'
+  spec.add_development_dependency 'rubocop', '~> 0.87'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov', '~> 0.17.0'
 end

data/lib/cocina/generator/generator.rb

@@ -17,7 +17,7 @@ module Cocina
       def generate
         clean_output
 
-        schemas.keys.each do |schema_name|
+        schemas.each_key do |schema_name|
           schema = schema_for(schema_name)
           generate_for(schema) if schema
         end

data/lib/cocina/generator/schema_value.rb

@@ -4,11 +4,11 @@ module Cocina
   module Generator
     # Class for generating from an openapi value
     class SchemaValue < SchemaBase
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
       def generate
         "#{description}#{example}attribute :#{name.camelize(:lower)}, Types::#{dry_datatype(schema_doc)}#{default}#{enum}#{omittable}"
       end
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
 
       private
 

data/lib/cocina/models.rb

@@ -14,7 +14,6 @@ require 'thor'
 
 # Help Zeitwerk find some of our classes
 class CocinaModelsInflector < Zeitwerk::Inflector
-  # rubocop:disable Metrics/CyclomaticComplexity
   # rubocop:disable Metrics/MethodLength
   def camelize(basename, _abspath)
     case basename
@@ -34,7 +33,7 @@ class CocinaModelsInflector < Zeitwerk::Inflector
       super
     end
   end
-  # rubocop:enable Metrics/CyclomaticComplexity
+
   # rubocop:enable Metrics/MethodLength
 end
 

data/lib/cocina/models/admin_policy_administrative.rb

@@ -5,7 +5,7 @@ module Cocina
     class AdminPolicyAdministrative < Struct
       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 :registrationWorkflow, Types::Strict::String.meta(omittable: true)
-      attribute :hasAdminPolicy, Types::Strict::String.meta(omittable: true)
+      attribute :hasAdminPolicy, Types::Strict::String
     end
   end
 end

data/lib/cocina/models/administrative.rb

@@ -4,7 +4,7 @@ module Cocina
   module Models
     class Administrative < Struct
       # example: druid:bc123df4567
-      attribute :hasAdminPolicy, Types::Strict::String.meta(omittable: true)
+      attribute :hasAdminPolicy, Types::Strict::String
       attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true)
       # Administrative or Internal project this resource is a part of
       # example: Google Books

data/lib/cocina/models/dro.rb

@@ -31,7 +31,7 @@ module Cocina
       # Version for the DRO within SDR.
       attribute :version, Types::Strict::Integer
       attribute(:access, DROAccess.default { DROAccess.new })
-      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute(:administrative, Administrative.default { Administrative.new })
       attribute :description, Description.optional.meta(omittable: true)
       attribute :identification, Identification.optional.meta(omittable: true)
       attribute :structural, DROStructural.optional.meta(omittable: true)

data/lib/cocina/models/request_collection.rb

@@ -16,7 +16,7 @@ module Cocina
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
       attribute(:access, Access.default { Access.new })
-      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute(:administrative, Administrative.default { Administrative.new })
       attribute :description, Description.optional.meta(omittable: true)
       attribute :identification, CollectionIdentification.optional.meta(omittable: true)
 

data/lib/cocina/models/request_dro.rb

@@ -25,8 +25,8 @@ module Cocina
       attribute :type, Types::Strict::String.enum(*RequestDRO::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Strict::Integer
-      attribute :access, DROAccess.optional.meta(omittable: true)
-      attribute :administrative, Administrative.optional.meta(omittable: true)
+      attribute(:access, DROAccess.default { DROAccess.new })
+      attribute(:administrative, Administrative.default { Administrative.new })
       attribute :description, Description.optional.meta(omittable: true)
       attribute(:identification, RequestIdentification.default { RequestIdentification.new })
       attribute :structural, RequestDROStructural.optional.meta(omittable: true)

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.33.0'
+    VERSION = '0.34.0'
   end
 end

data/openapi.yml

@@ -142,6 +142,8 @@ components:
           description: Administrative or Internal project this resource is a part of
           example: Google Books
           type: string
+      required:
+        - hasAdminPolicy
     AdminPolicy:
       type: object
       additionalProperties: false
@@ -162,11 +164,11 @@ components:
         description:
           $ref: '#/components/schemas/Description'
       required:
+        - administrative
         - externalIdentifier
         - label
         - type
         - version
-        - administrative
     AdminPolicyAdministrative:
       type: object
       additionalProperties: false
@@ -178,6 +180,8 @@ components:
           type: string
         hasAdminPolicy:
           type: string
+      required:
+        - hasAdminPolicy
     AppliesTo:
       description: Property model for indicating the parts, aspects, or versions of the resource to which a
         descriptive element is applicable.
@@ -461,11 +465,12 @@ components:
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - access
+        - administrative
         - externalIdentifier
         - label
         - type
         - version
-        - access
     DROAccess:
       type: object
       additionalProperties: false
@@ -710,6 +715,13 @@ components:
       properties:
         sourceId:
           type: string
+          description: >
+            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.
           example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
         catalogLinks:
           type: array
@@ -790,10 +802,10 @@ components:
         description:
           $ref: '#/components/schemas/Description'
       required:
+        - administrative
         - label
         - type
         - version
-        - administrative
     RequestCollection:
       description: Same as a Collection, but doesn't have an externalIdentifier as one will be created
       type: object
@@ -821,10 +833,11 @@ components:
         identification:
           $ref: '#/components/schemas/CollectionIdentification'
       required:
+        - access
+        - administrative
         - label
         - type
         - version
-        - access
     RequestDRO:
       description: A request to create a DRO.  This has the same general structure as a DRO but doesn't have externalIdentifier and doesn't require the access subschema. If no access subschema is provided, these values will be inherited from the AdminPolicy.
       type: object
@@ -866,10 +879,12 @@ components:
         geographic:
           $ref: '#/components/schemas/Geographic'
       required:
+        - access
+        - administrative
+        - identification
         - label
         - type
         - version
-        - identification
     RequestDROStructural:
       description: Structural metadata
       type: object
@@ -962,6 +977,13 @@ components:
       properties:
         sourceId:
           type: string
+          description: >
+            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.
           example: 'sul:PC0170_s3_Fiesta_Bowl_2012-01-02_210609_2026'
         catalogLinks:
           type: array

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.87'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: '0.87'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -314,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Data models for the SDR