cocina-models 0.97.0 → 0.98.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41b1ed014f467e4d5245d388ba185903b5bd8527399bbc3d52b22f1e5d313255
-  data.tar.gz: d7f1c463d42905960332923223bca29492a1f697062ea1dd5d2793484a5ff40f
+  metadata.gz: 760c4c58f3a365278d5a1b96607435cf99a3ac73cd070fce630ed99e40ebeb51
+  data.tar.gz: 9b66dd57dc5ed2b5a2eb3638ceb3ab5f10e1efe9bb8c5df5395c480c1c9b3bbd
 SHA512:
-  metadata.gz: 0af59e6e0002648b6fe5136b430526b7de35feec48ae4bf8b343d92fe4656b55642ed43a64658d4d0190c0703b9b247ec1ce2c0601463858ee3ba76eab07f742
-  data.tar.gz: 59ee48b89dde85e375a5887d28ee2d2bc242aadaf6d5364907309d0e28b801b7ddbe64081688a7a087f33c6cd777b554d4239fc485858ceb816823b887112357
+  metadata.gz: baaa5f6697353b9a261d0976d5ed6d60a79c87d2f2a83912c40c63e3dab3b3e30506f2fa86a93b7d35b681d5eb1a1222f2c31ee030259730155b99926fe2565b
+  data.tar.gz: 4cd05c60b8263e1cc39cbef3bca5b469a55c6f2c206cb260d56d5d6acc492ad29cab978e71ce8d8b3544a5151f5e9c1e606539e952fed68fe51b0dbf165cb987

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@4.1.0
+  ruby-rails: sul-dlss/ruby-rails@4.2.1
 workflows:
   build:
     jobs:

data/.rubocop.yml

@@ -303,7 +303,7 @@ RSpec/SubjectDeclaration: # new in 2.5
   Enabled: true
 FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
-RSpec/Rails/AvoidSetupHook: # new in 2.4
+RSpecRails/AvoidSetupHook: # new in 2.4
   Enabled: true
 Style/NestedFileDirname: # new in 1.26
   Enabled: true
@@ -343,7 +343,7 @@ RSpec/ChangeByZero: # new in 2.11.0
   Enabled: true
 Capybara/SpecificMatcher: # new in 2.12
   Enabled: false
-RSpec/Rails/HaveHttpStatus: # new in 2.12
+RSpecRails/HaveHttpStatus: # new in 2.12
   Enabled: false
 
 RSpec/ClassCheck: # new in 2.13
@@ -394,9 +394,9 @@ FactoryBot/ConsistentParenthesesStyle: # new in 2.14
   Enabled: true
 FactoryBot/FactoryNameStyle: # new in 2.16
   Enabled: true
-RSpec/Rails/InferredSpecType: # new in 2.14
+RSpecRails/InferredSpecType: # new in 2.14
   Enabled: true
-RSpec/Rails/MinitestAssertions: # new in 2.17
+RSpecRails/MinitestAssertions: # new in 2.17
   Enabled: true
 Style/RedundantHeredocDelimiterQuotes: # new in 1.45
   Enabled: true
@@ -411,7 +411,7 @@ RSpec/RedundantAround: # new in 2.19
   Enabled: true
 RSpec/SkipBlockInsideExample: # new in 2.19
   Enabled: true
-RSpec/Rails/TravelAround: # new in 2.19
+RSpecRails/TravelAround: # new in 2.19
   Enabled: true
 
 Lint/DuplicateMatchPattern: # new in 1.50
@@ -457,7 +457,7 @@ Style/YAMLFileRead: # new in 1.53
   Enabled: true
 RSpec/ReceiveMessages: # new in 2.23
   Enabled: true
-RSpec/Rails/NegationBeValid: # new in 2.23
+RSpecRails/NegationBeValid: # new in 2.23
   Enabled: true
 
 Lint/ItWithoutArgumentsInBlock: # new in 1.59
@@ -498,3 +498,16 @@ RSpec/IsExpectedSpecify: # new in 2.27
   Enabled: true
 RSpec/RepeatedSubjectCall: # new in 2.27
   Enabled: true
+
+Style/MapIntoArray: # new in 1.63
+  Enabled: true
+Style/SendWithLiteralMethodName: # new in 1.64
+  Enabled: true
+Style/SuperArguments: # new in 1.64
+  Enabled: true
+RSpec/EmptyOutput: # new in 2.29
+  Enabled: true
+RSpec/ExpectInLet: # new in 2.30
+  Enabled: true
+RSpec/UndescriptiveLiteralsDescription: # new in 2.29
+  Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.97.0)
+    cocina-models (0.98.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -20,7 +20,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -39,8 +39,9 @@ GEM
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser (~> 1.0)
       rack (>= 1.5)
-    commonmarker (0.23.10)
-    concurrent-ruby (1.2.3)
+    commonmarker (1.1.4)
+      rb_sys (~> 0.9)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     deprecation (1.1.0)
       activesupport
@@ -79,29 +80,31 @@ GEM
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
-    mini_portile2 (2.8.6)
-    minitest (5.22.3)
+    mini_portile2 (2.8.7)
+    minitest (5.23.1)
     multi_json (1.15.0)
     mutex_m (0.2.0)
     nokogiri (1.16.5)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    openapi3_parser (0.9.2)
-      commonmarker (~> 0.17)
+    openapi3_parser (0.10.0)
+      commonmarker (>= 1.0)
     openapi_parser (1.0.0)
     optimist (3.1.0)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.25.1)
+    parser (3.3.2.0)
       ast (~> 2.4.1)
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
-    racc (1.7.3)
+    racc (1.8.0)
     rack (3.0.11)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.1)
-    rexml (3.2.6)
+    rb_sys (0.9.97)
+    regexp_parser (2.9.2)
+    rexml (3.2.9)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -117,7 +120,7 @@ GEM
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.63.5)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -130,18 +133,18 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
+    rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
+    rubocop-factory_bot (2.26.0)
       rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.29.2)
+    rubocop-rspec (2.31.0)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
       rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
+    rubocop-rspec_rails (2.29.0)
       rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
@@ -150,6 +153,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
     super_diff (0.12.1)
       attr_extras (>= 6.2.4)
       diff-lcs
@@ -158,7 +162,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
-    zeitwerk (2.6.13)
+    zeitwerk (2.6.15)
 
 PLATFORMS
   ruby

data/README.md

@@ -53,10 +53,10 @@ Beyond what is necessary to test the generator, the Cocina model classes are not
 
 ## Testing validation changes
 
-If there is a possibility that a model, mapping, 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-infra since it requires deploying a branch of cocina-models.
+If there is a possibility that a model, mapping, 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 the `sdr-infra` VM 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-infra, check out `main`, update the `Gemfile` so that cocina-models references the branch, and `bundle install`.
+2. On the `sdr-infra` VM, while logged in as the `deploy` user, check out `main`, update the `Gemfile` so that cocina-models references the branch, and `bundle install`.
 3. Select the appropriate environment vars below - they are set to values in puppet.  (first 2 lines are the same;  last two lines use different variables)
 
 For QA:
@@ -94,33 +94,30 @@ RAILS_ENV=production bin/validate-cocina -p 8
 
 Custom reports stored in dor-services-app can be run similarly to validation testing described above.
 
-1. Go the sdr-infra box:
-
-```
-ssh deploy@sdr-infra
-```
-
-2. Go to the dor-services-app directory and reset to main if needed (verify nobody else is using this first though):
-
-```
-cd dor-services-app
-git status # see if there are any unsaved changes, if so, you may need to git stash them
-git pull # OR git reset --hard main   to just ditch any local unsaved changes
-```
-
-3. Connect to the desired database by setting the environment variables as described in the section above.  This must be done each time you SSH back into the box to run a new report.
-
-4. Run the report (good idea to do it in a screen or via background process in case you get disconnected):
-
-```
-bundle exec bin/rails r -e production "BadIso8601Dates.report" > BadIso8601Dates.csv
-```
-
-5. When done, you can pull the report to your laptop as needed:
-
-```
-scp deploy@sdr-infra:/opt/app/deploy/dor-services-app/BadIso8601Dates.csv BadIso8601Dates.csv
-```
+1. Connect to the `sdr-infra` box:
+    ```shell
+    ssh sdr-infra
+    ```
+1. Start a shell as the `deploy` user:
+    ```shell
+    # you may or may not need to supply the `-n SUNETID` argument
+    ksu deploy
+    ```
+1. Go to the `~/dor-services-app` directory and reset to main if needed (verify nobody else is using this first though):
+    ```shell
+    cd ~/dor-services-app
+    git status # see if there are any unsaved changes, if so, you may need to git stash them
+    git pull # OR git reset --hard main   to just ditch any local unsaved changes
+    ```
+1. Connect to the desired database by setting the environment variables as described in the section above.  This must be done each time you SSH back into the box to run a new report.
+1. Run the report (good idea to do it in a screen or via background process in case you get disconnected):
+    ```shell
+    bundle exec bin/rails r -e production "BadIso8601Dates.report" > BadIso8601Dates.csv
+    ```
+1. When done, you can pull the report to your laptop as needed:
+    ```shell
+    scp sdr-infra:/opt/app/deploy/dor-services-app/BadIso8601Dates.csv .
+    ```
 
 ## Releasing a patch change
 A patch change is a change that (1) does not affect the data model; (2) does not alter the openapi.yml; and more broadly (3) does not matter if some applications have the change and others do not.
@@ -129,6 +126,14 @@ A patch change can be released as part of regular dependency updates or selectiv
 
 ## Releasing major or minor change
 
+NOTE: If dependency updates are about to be released, you have the option of shortening the process and stopping after Step 3. This is because Steps 4 onwards will be taken care of by the regular dependency updates process (basically the updating of cocina-models, dor-services-client and sdr-client as needed in the rest of the associated apps).  You still do need to manually bump some gems and the pinned version of cocina-models in a couple apps and get those PRs approved and merged, as described in Steps 1-3 below.
+
+IMPORTANT: If you do opt to skip steps 4 onward, you should NOT merge the cocina-models bump dor-services-app and sdr-api PRs you created in step 3 until you are ready to finish the dependency updates process.  You can have them reviewed and approved, but if you merge, you will greatly increase the risk of issues if the main branch of DSA or sdr-api are deployed after steps 1-3 are complete but before the rest of the apps are updated to use the new cocina-models via regular dependency updates. The fix for this is to either roll-back DSA and sdr-api to the previous release tag, or proceed forwards with step 4-5.
+
+Before you release a major or minor change, think about if this release will include new validations.  Even if your change didn't make any changes that would affect validation, there may be other unreleased changes since the previous version of the gem was cut and released.  Best practice is to scan back through the commit history until you get to the last version bump and see if there any significant changes that may affect validation.
+
+If unsure, ask the team or ask for help to just run the validation report anyway (as described above).
+
 ### Step 0: Share intent to change the models
 
 Send a note to `#dlss-infra-chg-mgmt` on Slack to let people know what is changing and when.
@@ -164,7 +169,7 @@ This can be accomplished by copying and pasting the cocina-models schemas to the
 
 If step 3A was needed, use the same PRs to also bump the versions of cocina-models, sdr-client, and dor-services-client in these applications/services. Why? When [dor-services-app](https://github.com/sul-dlss/dor-services-app), for example, is updated to use the new models (via the auto-update script), these clients should be updated at the same time or there is risk of models produced by dor-services-app not being acceptable to the clients.
 
-With or without step 3A, perform `bundle update` for cocina-models, sdr-client, and dor-services-client gems in the listed services and then make PRs for those repos. You may need to update how these gems are pinned in the `Gemfile` in order to bump them.
+With or without step 3A, perform `bundle update` for cocina-models, sdr-client, and dor-services-client gems in the listed services and then make PRs for those repos. You may first need to update how these gems are pinned in the `Gemfile` in order to bump them.  Note that dor-services-app only needs a bump to cocina-models gem and sdr-api only needs a bump to cocina-models and dor-services-client gems.
 
 #### Step 3C: Merge 'em
 

data/lib/cocina/generator/generator.rb

@@ -127,11 +127,12 @@ module Cocina
         run("rubocop -a #{filepaths.join(' ')} > /dev/null")
       end
 
-      NO_CLEAN = [
-        'checkable.rb',
-        'validatable.rb',
-        'version.rb',
-        'vocabulary.rb'
+      NO_CLEAN = %w[
+        checkable.rb
+        utils.rb
+        validatable.rb
+        version.rb
+        vocabulary.rb
       ].freeze
 
       def clean_output

data/lib/cocina/models/administrative.rb

@@ -5,7 +5,6 @@ module Cocina
     class Administrative < Struct
       # example: druid:bc123df4567
       attribute :hasAdminPolicy, Druid
-      attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
     end
   end
 end

data/lib/cocina/models/builders/name_title_group_builder.rb

@@ -71,11 +71,7 @@ module Cocina
         def self.contributor_name_value_slices(contributor)
           return if contributor&.name.blank?
 
-          slices = []
-          Array(contributor.name).each do |contrib_name|
-            slices << value_slices(contrib_name)
-          end
-          slices.flatten
+          Array(contributor.name).map { |contrib_name| value_slices(contrib_name) }.flatten
         end
 
         # @params [Cocina::Models::DescriptiveValue] desc_value

data/lib/cocina/models/mapping/from_mods/admin_metadata.rb

@@ -73,9 +73,8 @@ module Cocina
           end
 
           def build_note
-            notes = []
-            record_origins.each do |record_origin|
-              notes << {
+            notes = record_origins.map do |record_origin|
+              {
                 type: 'record origin',
                 value: record_origin.text
               }

data/lib/cocina/models/mapping/from_mods/event.rb

@@ -196,9 +196,8 @@ module Cocina
           end
 
           def build_date_values(origin_info_node)
-            date_values = []
-            DATE_ELEMENTS_2_TYPE.each do |mods_el_name, cocina_type|
-              date_values << build_date_desc_values(mods_el_name, origin_info_node, cocina_type)
+            date_values = DATE_ELEMENTS_2_TYPE.map do |mods_el_name, cocina_type|
+              build_date_desc_values(mods_el_name, origin_info_node, cocina_type)
             end
             date_values.flatten.compact
           end

data/lib/cocina/models/request_administrative.rb

@@ -5,7 +5,6 @@ module Cocina
     class RequestAdministrative < Struct
       # example: druid:bc123df4567
       attribute :hasAdminPolicy, Druid
-      attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
       # Internal project this resource is a part of. This governs routing of messages about this object.
       # example: Google Books
       attribute? :partOfProject, Types::Strict::String

data/lib/cocina/models/utils.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Utils
+      # @param [Cocina::Models::Dro] dro
+      # @param [Array<Cocina::Models::File>]
+      def self.files(dro)
+        dro.structural.contains.flat_map do |fileset|
+          fileset.structural.contains
+        end
+      end
+    end
+  end
+end

data/lib/cocina/models/validatable.rb

@@ -15,7 +15,7 @@ module Cocina
 
       def new(*args)
         validate = args.first.delete(:validate) if args.present?
-        new_model = super(*args)
+        new_model = super
         Validators::Validator.validate(new_model.class, new_model) if validate || validate.nil?
         new_model
       end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.97.0'
+    VERSION = '0.98.0'
   end
 end

data/openapi.yml

@@ -229,11 +229,6 @@ components:
       properties:
         hasAdminPolicy:
           $ref: '#/components/schemas/Druid'
-        releaseTags:
-          description: Tags for release
-          type: array
-          items:
-            $ref: '#/components/schemas/ReleaseTag'
       required:
         - hasAdminPolicy
     AdminPolicyAccessTemplate:
@@ -1528,35 +1523,6 @@ components:
         valueAt:
           description: URL or other pointer to the location of the related resource information.
           type: string
-    ReleaseTag:
-      description: A tag that indicates the item or collection should be released.
-      type: object
-      additionalProperties: false
-      required:
-        - release
-        - what
-      properties:
-        who:
-          description: Who did this release
-          type: string
-          example: petucket
-        what:
-          description: What is being released. This item or the whole collection.
-          type: string
-          enum:
-            - self
-            - collection
-          example: self
-        date:
-          description: When did this action happen
-          type: string
-          format: date-time
-        to:
-          description: What platform is it released to
-          type: string
-          example: Searchworks
-        release:
-          type: boolean
     RequestAdminPolicy:
       description: Same as an AdminPolicy, but doesn't have an externalIdentifier as one will be created
       type: object

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.97.0
+  version: 0.98.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-17 00:00:00.000000000 Z
+date: 2024-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -491,7 +491,6 @@ files:
 - lib/cocina/models/presentation.rb
 - lib/cocina/models/purl.rb
 - lib/cocina/models/related_resource.rb
-- lib/cocina/models/release_tag.rb
 - lib/cocina/models/request_admin_policy.rb
 - lib/cocina/models/request_administrative.rb
 - lib/cocina/models/request_collection.rb
@@ -511,6 +510,7 @@ files:
 - lib/cocina/models/symphony_catalog_link.rb
 - lib/cocina/models/title.rb
 - lib/cocina/models/use_and_reproduction_statement.rb
+- lib/cocina/models/utils.rb
 - lib/cocina/models/validatable.rb
 - lib/cocina/models/validators/associated_name_validator.rb
 - lib/cocina/models/validators/catalog_links_validator.rb

data/lib/cocina/models/release_tag.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # A tag that indicates the item or collection should be released.
-    class ReleaseTag < Struct
-      # Who did this release
-      # example: petucket
-      attribute? :who, Types::Strict::String
-      # What is being released. This item or the whole collection.
-      # example: self
-      attribute :what, Types::Strict::String.enum('self', 'collection')
-      # When did this action happen
-      attribute? :date, Types::Params::DateTime
-      # What platform is it released to
-      # example: Searchworks
-      attribute? :to, Types::Strict::String
-      attribute :release, Types::Strict::Bool.default(false)
-    end
-  end
-end