cocina-models 0.74.1 → 0.77.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6cb9999eaf14875627c7f5248ee0989a2780a7adb4c5a035341627667248678
-  data.tar.gz: b939b0889194eef22ea2ba184704cb4182f51fd57ff5722669ea438fb3236b94
+  metadata.gz: 3448513fd9c5a834a341c41dc2e532fe9196d5aafca3ed6812f4243ef952e960
+  data.tar.gz: 2c1e122cd5d903ce1d92a443f1d8ab2879aaf8cdc9550f3b27c67342ce32bdc8
 SHA512:
-  metadata.gz: e44e7a8c2b03956d62f798c451867fcf71314faf444c426734f4063e91ec353f90c61313481b3926f68a746b20c379b7820ef09ab0993d9d1fe501d5e23ce9ea
-  data.tar.gz: 0c6fb86b2b7b1961dbbeed1bb08e184baff2f6c3404e95f866b841f3484baa8a7ecf0e3085077d711fa45eb2456a10565471915ad8a18d884908157b90de21fb
+  metadata.gz: ca06ecb3bf3952a5190dbff8ce3510c4612a49e50f863d70511dd93f6678a184bd2f664197bc7a3ad5004b55d2bc7d66865b85796b39c5701e9eebdb71b580b7
+  data.tar.gz: 804c0deb6ec304f9e2ab44808ec7c9f9e47a4a8df15432ec66d4dd068939116f1f5a22405658a7e20651b961fba4949708b5bd28ede4f63ac0060c126416f7cc

data/.rubocop.yml

@@ -11,15 +11,13 @@ AllCops:
 
 # ----- Layout ------
 
-Layout/LineLength:
-  Max: 114
-  Exclude:
-    - lib/cocina/models/*
-
 Layout/BeginEndAlignment: # (new in 0.91)
   Enabled: true
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
+Layout/LineLength:
+  Exclude:
+    - lib/cocina/models/*
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
@@ -79,12 +77,36 @@ Metrics/BlockLength:
     - cocina-models.gemspec
     - spec/cocina/**/*
     - lib/cocina/rspec/matchers.rb
+    - 'spec/support/mods_mapping_spec_helper.rb'
+
+# Offense count: 16
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 100
+  Exclude:
+    - 'lib/cocina/rspec/factories.rb'
 
 Metrics/MethodLength:
   Max: 14
   Exclude:
     - 'spec/cocina/models/file_access_spec.rb'
     - 'spec/cocina/models/dro_access_spec.rb'
+    - 'lib/cocina/rspec/factories.rb'
+    - 'lib/cocina/models/mapping/to_mods/*'
+    - 'lib/cocina/models/mapping/from_mods/*'
+    - '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_normalizer.rb'
+
+
+# Offense count: 37
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  # Max: 20
+  Exclude:
+    - 'lib/cocina/models/mapping/from_mods/*'
+    - 'lib/cocina/models/mapping/to_mods/*'
+    - 'lib/cocina/models/mapping/normalizers/**/*'
 
 # ----- RSpec ------
 
@@ -94,12 +116,6 @@ RSpec/BeEq: # new in 2.9.0
 RSpec/BeNil: # new in 2.9.0
   Enabled: true
 
-RSpec/ExampleLength:
-  Max: 18
-  Exclude:
-    - spec/cocina/models/description_spec.rb
-    - spec/cocina/models/dro_shared_examples.rb
-
 RSpec/MultipleExpectations:
   Enabled: false
 
@@ -282,3 +298,16 @@ RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
 Style/NestedFileDirname: # new in 1.26
   Enabled: true
+
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,11 +1,16 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-01-14 00:32:36 UTC using RuboCop version 1.24.1.
+# on 2022-04-27 19:20:35 UTC using RuboCop version 1.28.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Lint/NoReturnInBeginEndBlocks:
+  Exclude:
+    - 'lib/cocina/models/mapping/to_mods/description.rb'
+
 # Offense count: 1
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: present?, blank?, presence, try, try!, in?
@@ -13,14 +18,78 @@ Lint/SafeNavigationChain:
   Exclude:
     - 'lib/cocina/generator/schema_base.rb'
 
+# Offense count: 13
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/cocina/models/mapping/from_mods/admin_metadata.rb'
+    - 'lib/cocina/models/mapping/from_mods/contributor.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/language.rb'
+    - 'lib/cocina/models/mapping/from_mods/note.rb'
+    - 'lib/cocina/models/mapping/from_mods/subject.rb'
+    - 'lib/cocina/models/mapping/to_mods/event.rb'
+
+# Offense count: 95
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 40
+
+# Offense count: 42
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 12
+
 # Offense count: 1
 # Configuration parameters: Max, CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Exclude:
     - 'lib/cocina/generator/schema_base.rb'
 
+# Offense count: 41
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Enabled: false
+
+# Offense count: 89
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 128
+
+# Offense count: 9
+# Configuration parameters: Max.
+RSpec/NestedGroups:
+  Exclude:
+    - 'spec/cocina/models/mapping/normalizers/mods/origin_info_normalizer_spec.rb'
+
 # Offense count: 1
-# Configuration parameters: MinBodyLength.
+# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
 Style/GuardClause:
   Exclude:
     - 'lib/cocina/generator/schema_base.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/cocina/models/validators/open_api_validator.rb'
+
+# Offense count: 9
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/cocina/models/mapping/to_mods/access.rb'
+    - 'lib/cocina/models/mapping/to_mods/contributor.rb'
+    - 'lib/cocina/models/mapping/to_mods/form.rb'
+    - 'lib/cocina/models/mapping/to_mods/subject.rb'
+
+# Offense count: 206
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 187

data/README.md

@@ -6,11 +6,18 @@
 
 # Cocina::Models
 
-This is a Ruby implementation of the SDR data model (named "COCINA"). The data being modeled includes digital repository objects.
+The cocina-models gem is a Ruby implementation of the Stanford Digital Repository (SDR) data model, which we named "Cocina." The data being modeled is oriented around digital repository objects.
 
-Validation is performed by openapi (using OpenAPIParser). Modeling is provided by dry-struct and dry-types. Together, these provide a way for consumers to validate objects against models and to manipulate those objects.
+The data model is expressed in an OpenAPI specification that lives in this codebase. Expressing the model in such a spec allows for rich validation (using gems such as `OpenAPIParser` and `committee`). The gem provides a set of generators (see below) to generate Ruby classes from the specification, with modeling provided by dry-struct / dry-types. Together, these provide a way for consumers to validate objects against models and to manipulate those objects.
 
-This is a work in progress that will ultimately implement the full [COCINA data model](http://sul-dlss.github.io/cocina-models/). See also [architecture documentation](https://sul-dlss.github.io/taco-truck/COCINA.html#cocina-data-models--shapes).
+Note that the data model encodes properties as camelCase, which the team believes to be consistent with other HTTP APIs and the original design of the Cocina data model. While using camelCase in Ruby code may look and feel wrong, we did explore automagic conversion between camelCase in the model and snake_case in the Ruby context. We ultimately concluded that we have enough representations of the data model in enough codebases to reasonably worry about data inconsistency problems, none of which we need in our work on SDR.
+
+## Configuration
+
+Set the PURL url base:
+```ruby
+Cocina::Models::Mapping::Purl.base_url = Settings.release.purl_base_url
+```
 
 ## Generate models from openapi.yml
 
@@ -42,6 +49,15 @@ The generator is tested via its output when run against `openapi.yml`, viz., the
 
 Beyond what is necessary to test the generator, the Cocina model classes are not tested, i.e., they are assumed to be as specified in `openapi.yml`.
 
+## Testing validation changes
+
+If there is a possibility that a model or validation change will conflict with some existing objects then [validate-cocina](https://github.com/sul-dlss/dor-services-app/blob/main/bin/validate-cocina) should be used for testing. This must be run on sdr-deploy since it requires deploying a branch of cocina-models.
+
+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.
+
 ## Releasing
 
 ### Step 0: Share intent to change the models

data/cocina-models.gemspec

@@ -28,6 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'deprecation'
   spec.add_dependency 'dry-struct', '~> 1.0'
   spec.add_dependency 'dry-types', '~> 1.1'
+  spec.add_dependency 'equivalent-xml' # for diffing MODS
+  spec.add_dependency 'nokogiri'
   spec.add_dependency 'openapi3_parser' # Parsing openapi doc
   # Match these version requirements to what committee wants,
   # so that our client (non-committee) users have the same dependencies.