cocina-models 0.32.0 → 0.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bcad8e4f77e24566d85e9e60107eed4cc45b7e31daedf15106ae86d47c9f58b
-  data.tar.gz: 26fc29b912821bf4bd9874e3e758acb2777b90729f5dd69b0fd12aeb240cbf31
+  metadata.gz: 6f64b937df8c8d8c7bbd64af57d587e27843ebcd7e751ea4caff887aaa78c7a1
+  data.tar.gz: b697ab2535648dd6d1520f35da839e599756e7c49bbc2803d17a5d6e2db9307d
 SHA512:
-  metadata.gz: b91bd04128801af9435c9ae35a5157a4bb2e504906737f908da3f444bca4150e1132a223fc3709309d0df5a26e869eaea6128ba809e7bfcd261d24b248658b96
-  data.tar.gz: b6caf15cd36ee9faaebbb10be8f298c9501e727862510b0de0696e83ac863934e68320122ba35fcb7a82fd18a557aed62d987c9021a7c2447b80b73cbcf6d475
+  metadata.gz: c67039d09d1d04e7bba5aaf0199402e5e1e0b9008b56a268735f59d4d61bd92f5c6e17f0edaf8625102f5e7bfd25e7cc66b4e58e51193e811bf2635b43ff21cc
+  data.tar.gz: d7eeeccbc2a215cdee206b746bda7e38e7c86fca21b5c92f40057c5ffa760494cc539490dd35734314e82506f0ad922ae15f68bcf414034d9ce2fad06375397c

data/.github/pull_request_template.md

@@ -2,4 +2,11 @@
 
 
 
-## Was the documentation (README, wiki) updated?
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

data/.rubocop.yml

@@ -4,7 +4,10 @@ inherit_from: .rubocop_todo.yml
 require:
   - rubocop-rspec
 
-Metrics/LineLength:
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
   Max: 114
   Exclude:
     - lib/cocina/models/*
@@ -26,7 +29,117 @@ 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
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.com/sul-dlss/cocina-models.svg?branch=master)](https://travis-ci.com/sul-dlss/cocina-models)
+[![CircleCI](https://circleci.com/gh/sul-dlss/cocina-models.svg?style=svg)](https://circleci.com/gh/sul-dlss/cocina-models)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/472273351516ac01dce1/test_coverage)](https://codeclimate.com/github/sul-dlss/cocina-models/test_coverage)
 [![Maintainability](https://api.codeclimate.com/v1/badges/472273351516ac01dce1/maintainability)](https://codeclimate.com/github/sul-dlss/cocina-models/maintainability)
 [![Gem Version](https://badge.fury.io/rb/cocina-models.svg)](https://badge.fury.io/rb/cocina-models)

data/cocina-models.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '~> 2.5'
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'dry-struct', '~> 1.0'
@@ -33,9 +34,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,10 +17,13 @@ module Cocina
       def generate
         clean_output
 
+        # rubocop:disable Style/HashEachMethods
+        # This is not a Hash
         schemas.keys.each do |schema_name|
           schema = schema_for(schema_name)
           generate_for(schema) if schema
         end
+        # rubocop:enable Style/HashEachMethods
 
         generate_vocab
       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/contributor.rb

@@ -6,9 +6,11 @@ module Cocina
       attribute :name, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # Entity type of the contributor (person, organization, etc.).
       attribute :type, Types::Strict::String.meta(omittable: true)
-      # Status of the contributor relative to other parallel contributors.
+      # Status of the contributor relative to other parallel contributors (e.g. the primary author among a group of contributors).
       attribute :status, Types::Strict::String.meta(omittable: true)
       attribute :role, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/description.rb

@@ -7,12 +7,14 @@ module Cocina
       attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
       attribute :event, Types::Strict::Array.of(Event).meta(omittable: true)
       attribute :form, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
-      attribute :language, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :language, Types::Strict::Array.of(Language).meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :subject, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # Stanford persistent URL associated with the resource.
       attribute :purl, Types::Strict::String.meta(omittable: true)
-      attribute :url, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :access, DescriptiveAccessMetadata.optional.meta(omittable: true)
+      attribute :relatedResource, Types::Strict::Array.of(RelatedResource).meta(omittable: true)
       attribute :marcEncodedData, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :adminMetadata, DescriptiveAdminMetadata.optional.meta(omittable: true)
 

data/lib/cocina/models/descriptive_access_metadata.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveAccessMetadata < Struct
+      attribute :url, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :physicalLocation, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :accessContact, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :digitalRepository, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/descriptive_admin_metadata.rb

@@ -5,8 +5,10 @@ module Cocina
     class DescriptiveAdminMetadata < Struct
       attribute :contributor, Types::Strict::Array.of(Contributor).meta(omittable: true)
       attribute :event, Types::Strict::Array.of(Event).meta(omittable: true)
-      attribute :language, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :language, Types::Strict::Array.of(Language).meta(omittable: true)
       attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :standard, Standard.optional.meta(omittable: true)
+      attribute :identifier, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/descriptive_basic_value.rb

@@ -3,19 +3,26 @@
 module Cocina
   module Models
     class DescriptiveBasicValue < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # String value of the descriptive element.
       attribute :value, Types::Strict::String.meta(omittable: true)
       # Type of value provided by the descriptive element.
       attribute :type, Types::Strict::String.meta(omittable: true)
-      # Status of the descriptive element relative to other instances of the element.
+      # Status of the descriptive element value relative to other instances of the element.
       attribute :status, Types::Strict::String.meta(omittable: true)
       # Code value of the descriptive element.
       attribute :code, Types::Strict::String.meta(omittable: true)
       # URI value of the descriptive element.
       attribute :uri, Types::Strict::String.meta(omittable: true)
-      attribute :standard, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
-      attribute :encoding, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :standard, Standard.optional.meta(omittable: true)
+      attribute :encoding, Standard.optional.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
+      # The preferred display label to use for the descriptive element in access systems.
+      attribute :displayLabel, Types::Strict::String.meta(omittable: true)
+      # A term providing information about the circumstances of the statement (e.g., approximate dates).
+      attribute :qualifier, Types::Strict::String.meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/descriptive_parallel_value.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class DescriptiveParallelValue < Struct
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+    end
+  end
+end

data/lib/cocina/models/descriptive_structured_value.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     class DescriptiveStructuredValue < Struct
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
     end
   end
 end

data/lib/cocina/models/descriptive_value.rb

@@ -3,20 +3,26 @@
 module Cocina
   module Models
     class DescriptiveValue < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # String value of the descriptive element.
       attribute :value, Types::Strict::String.meta(omittable: true)
       # Type of value provided by the descriptive element.
       attribute :type, Types::Strict::String.meta(omittable: true)
-      # Status of the descriptive element relative to other instances of the element.
+      # Status of the descriptive element value relative to other instances of the element.
       attribute :status, Types::Strict::String.meta(omittable: true)
       # Code value of the descriptive element.
       attribute :code, Types::Strict::String.meta(omittable: true)
       # URI value of the descriptive element.
       attribute :uri, Types::Strict::String.meta(omittable: true)
-      attribute :standard, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
-      attribute :encoding, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :standard, Standard.optional.meta(omittable: true)
+      attribute :encoding, Standard.optional.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      # The preferred display label to use for the descriptive element in access systems.
+      attribute :displayLabel, Types::Strict::String.meta(omittable: true)
+      # A term providing information about the circumstances of the statement (e.g., approximate dates).
+      attribute :qualifier, Types::Strict::String.meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
     end
   end

data/lib/cocina/models/descriptive_value_required.rb

@@ -3,20 +3,26 @@
 module Cocina
   module Models
     class DescriptiveValueRequired < Struct
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
+      attribute :parallelValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # String value of the descriptive element.
       attribute :value, Types::Strict::String.meta(omittable: true)
       # Type of value provided by the descriptive element.
       attribute :type, Types::Strict::String.meta(omittable: true)
-      # Status of the descriptive element relative to other instances of the element.
+      # Status of the descriptive element value relative to other instances of the element.
       attribute :status, Types::Strict::String.meta(omittable: true)
       # Code value of the descriptive element.
       attribute :code, Types::Strict::String.meta(omittable: true)
       # URI value of the descriptive element.
       attribute :uri, Types::Strict::String.meta(omittable: true)
-      attribute :standard, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
-      attribute :encoding, Types::Strict::Array.of(Types::Strict::String).meta(omittable: true)
+      attribute :standard, Standard.optional.meta(omittable: true)
+      attribute :encoding, Standard.optional.meta(omittable: true)
       attribute :source, Source.optional.meta(omittable: true)
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      # The preferred display label to use for the descriptive element in access systems.
+      attribute :displayLabel, Types::Strict::String.meta(omittable: true)
+      # A term providing information about the circumstances of the statement (e.g., approximate dates).
+      attribute :qualifier, Types::Strict::String.meta(omittable: true)
+      attribute :note, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       attribute :appliesTo, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
     end
   end

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/dro_access.rb

@@ -4,6 +4,8 @@ module Cocina
   module Models
     class DROAccess < Struct
       attribute :access, Types::Strict::String.default('dark').enum('world', 'stanford', 'location-based', 'citation-only', 'dark').meta(omittable: true)
+      # Available for controlled digital lending.
+      attribute :controlledDigitalLending, Types::Strict::Bool.meta(omittable: true)
       # The human readable copyright statement that applies
       # example: Copyright World Trade Organization
       attribute :copyright, Types::Strict::String.meta(omittable: true)

data/lib/cocina/models/event.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     class Event < Struct
-      attribute :structuredValue, Types::Strict::Array.of(DescriptiveBasicValue).meta(omittable: true)
+      attribute :structuredValue, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)
       # Description of the event (creation, publication, etc.).
       attribute :type, Types::Strict::String.meta(omittable: true)
       attribute :date, Types::Strict::Array.of(DescriptiveValue).meta(omittable: true)