cocina-models 0.96.0 → 0.97.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da05dda48140bb467d82b84614b44beea26884fcd4cd0891a507a53e6f967e5b
-  data.tar.gz: 322900e86d817d5d65820389fb7a6a13c92d98e4b9d6f2150e49de4ddd34785a
+  metadata.gz: 41b1ed014f467e4d5245d388ba185903b5bd8527399bbc3d52b22f1e5d313255
+  data.tar.gz: d7f1c463d42905960332923223bca29492a1f697062ea1dd5d2793484a5ff40f
 SHA512:
-  metadata.gz: ce287a4da425257a40eb13e68f7eb7c2819fcd4658cef4d1fa81dae961d4e47df7a33ed2fe385e69a122c5542f73e42a441064e8d4f36fdafa8fdf6cc1bdaa84
-  data.tar.gz: cf060d2984d736229e2fbd68ba28e7b3b68efae7e4f393ca0c6bdf7d09fa6ccaa8cfc6c2c0924b37c498b2d762b5817c36a74f31953a72550cd68b748ecdd355
+  metadata.gz: 0af59e6e0002648b6fe5136b430526b7de35feec48ae4bf8b343d92fe4656b55642ed43a64658d4d0190c0703b9b247ec1ce2c0601463858ee3ba76eab07f742
+  data.tar.gz: 59ee48b89dde85e375a5887d28ee2d2bc242aadaf6d5364907309d0e28b801b7ddbe64081688a7a087f33c6cd777b554d4239fc485858ceb816823b887112357

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocina-models (0.96.0)
+    cocina-models (0.97.0)
       activesupport
       deprecation
       dry-struct (~> 1.0)
@@ -13,7 +13,6 @@ PATH
       nokogiri
       openapi3_parser
       openapi_parser (~> 1.0)
-      rss
       super_diff
       thor
       zeitwerk (~> 2.1)
@@ -34,7 +33,7 @@ GEM
     ast (2.4.2)
     attr_extras (7.1.0)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     committee (5.0.0)
       json_schema (~> 0.14, >= 0.14.3)
@@ -72,19 +71,19 @@ GEM
       activesupport (>= 3.0, < 8.0)
     equivalent-xml (0.6.0)
       nokogiri (>= 1.4.3)
-    i18n (1.14.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.7.1)
+    json (2.7.2)
     json_schema (0.21.0)
     jsonpath (1.1.5)
       multi_json
     language_server-protocol (3.17.0.3)
-    mini_portile2 (2.8.5)
+    mini_portile2 (2.8.6)
     minitest (5.22.3)
     multi_json (1.15.0)
     mutex_m (0.2.0)
-    nokogiri (1.16.3)
+    nokogiri (1.16.5)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     openapi3_parser (0.9.2)
@@ -92,16 +91,16 @@ GEM
     openapi_parser (1.0.0)
     optimist (3.1.0)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     patience_diff (1.2.0)
       optimist (~> 3.0)
     racc (1.7.3)
-    rack (3.0.10)
+    rack (3.0.11)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
+    rake (13.2.1)
+    regexp_parser (2.9.1)
     rexml (3.2.6)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -112,15 +111,13 @@ GEM
     rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rss (0.3.0)
-      rexml
-    rubocop (1.62.1)
+    rubocop (1.63.5)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -131,18 +128,21 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.27.1)
+    rubocop-rspec (2.29.2)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -150,7 +150,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    super_diff (0.11.0)
+    super_diff (0.12.1)
       attr_extras (>= 6.2.4)
       diff-lcs
       patience_diff

data/README.md

@@ -143,7 +143,7 @@ which pushes the gem to rubygems.org.
 
 ### Step 2: Update client gems coupled to the models
 
-Release new versions of [sdr-client](https://github.com/sul-dlss/sdr-client), [dor-services-client](https://github.com/sul-dlss/dor-services-client/), and [dor_indexing](https://github.com/sul-dlss/dor_indexing/) pinned to use the new cocina-models version because applications such as [Argo](https://github.com/sul-dlss/argo) and [Dor-Services-App](https://github.com/sul-dlss/dor-services-app) depend on these gems using the same models.
+Release new versions of [sdr-client](https://github.com/sul-dlss/sdr-client) and [dor-services-client](https://github.com/sul-dlss/dor-services-client/) pinned to use the new cocina-models version because applications such as [Argo](https://github.com/sul-dlss/argo) and [Dor-Services-App](https://github.com/sul-dlss/dor-services-app) depend on these gems using the same models.
 
 ### Step 3: Update services directly coupled to the models
 
@@ -164,9 +164,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, dor-services-client and dor_indexing 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. 
-
-NOTE: dor_indexing gem is used by dor-services-app and dor_indexing_app only. dor_indexing_app does NOT need to be updated in this step. 
+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.
 
 #### Step 3C: Merge 'em
 
@@ -186,7 +184,7 @@ If for some reason the above method does not work, the sul-dlss/access-update-sc
 
 #### Step 4B: Merge the Cocina Level 2 PRs
 
-[sul-dlss/access-update-scripts](https://github.com/sul-dlss/access-update-scripts) has a switch in the `merge-all.rb` script for this, as noted in the comments at the top of that script. 
+[sul-dlss/access-update-scripts](https://github.com/sul-dlss/access-update-scripts) has a switch in the `merge-all.rb` script for this, as noted in the comments at the top of that script.
 ```
 REPOS_PATH=infrastructure GH_ACCESS_TOKEN=abc123 COCINA_LEVEL2= ./merge-all.rb
 ```

data/cocina-models.gemspec

@@ -37,7 +37,6 @@ Gem::Specification.new do |spec|
   # Match these version requirements to what committee wants,
   # so that our client (non-committee) users have the same dependencies.
   spec.add_dependency 'openapi_parser', '~> 1.0'
-  spec.add_dependency 'rss' # used for date/time validation
   spec.add_dependency 'super_diff'
   spec.add_dependency 'thor'
   spec.add_dependency 'zeitwerk', '~> 2.1'

data/lib/cocina/models/file.rb

@@ -24,8 +24,12 @@ module Cocina
       attribute? :hasMimeType, Types::Strict::String
       # BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang
       attribute? :languageTag, LanguageTag.optional
-      # Use for the File.
+      # Use for the File (e.g. "transcription" for OCR).
       attribute? :use, FileUse.optional
+      # Indicates if the text (OCR/captioning) was generated by SDR.
+      attribute? :sdrGeneratedText, Types::Strict::Bool.default(false)
+      # Indicates if text that has been verified for accessibility/correctness.
+      attribute? :correctedForAccessibility, Types::Strict::Bool.default(false)
       attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
       attribute(:access, FileAccess.default { FileAccess.new })
       attribute(:administrative, FileAdministrative.default { FileAdministrative.new })

data/lib/cocina/models/request_file.rb

@@ -16,8 +16,12 @@ module Cocina
       # BCP 47 language tag: https://www.rfc-editor.org/rfc/rfc4646.txt -- other applications (like media players) expect language codes of this format, see e.g. https://videojs.com/guides/text-tracks/#srclang
       attribute? :languageTag, LanguageTag.optional
       attribute? :externalIdentifier, Types::Strict::String
-      # Use for the File.
+      # Use for the File (e.g. "transcription" for OCR).
       attribute? :use, FileUse.optional
+      # Indicates if the text (OCR/captioning) was generated by SDR.
+      attribute? :sdrGeneratedText, Types::Strict::Bool.default(false)
+      # Indicates if text that has been verified for accessibility/correctness.
+      attribute? :correctedForAccessibility, Types::Strict::Bool.default(false)
       attribute :hasMessageDigests, Types::Strict::Array.of(MessageDigest).default([].freeze)
       attribute(:access, FileAccess.default { FileAccess.new })
       attribute(:administrative, FileAdministrative.default { FileAdministrative.new })

data/lib/cocina/models/validators/date_time_validator.rb

@@ -2,7 +2,6 @@
 
 require 'edtf'
 require 'jsonpath'
-require 'rss'
 
 module Cocina
   module Models
@@ -87,18 +86,7 @@ module Cocina
         end
 
         def valid_w3cdtf?(value)
-          Time.w3cdtf(value)
-          true
-        rescue StandardError
-          # NOTE: the upstream W3CDTF implementation in the `rss` gem does not
-          #       allow two patterns that should be valid per the specification:
-          #
-          # * YYYY
-          # * YYYY-MM
-          #
-          # This catches the false positives from the upstream gem and allow
-          # these two patterns to validate
-          /\A\d{4}(-0[1-9]|-1[0-2])?\Z/.match?(value)
+          W3cdtfValidator.validate(value)
         end
 
         def druid

data/lib/cocina/models/validators/w3cdtf_validator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    module Validators
+      # Validates w3cdtf date
+      class W3cdtfValidator
+        REGEX = /\A(?<year>\d{4})(?:-(?<month>\d\d)(?:-(?<day>\d\d)(?<time>T\d\d:\d\d(?::\d\d(?:.\d+)?)?(?:Z|[+-]\d\d:\d\d))?)?)?\z/ix
+
+        def self.validate(date)
+          new(date).validate
+        end
+
+        def initialize(date)
+          @date = date
+        end
+
+        # The W3CDTF format is defined here: http://www.w3.org/TR/NOTE-datetime
+        #
+        # Year:
+        #    YYYY (eg 1997)
+        # Year and month:
+        #    YYYY-MM (eg 1997-07)
+        # Complete date:
+        #    YYYY-MM-DD (eg 1997-07-16)
+        # Complete date plus hours and minutes:
+        #    YYYY-MM-DDThh:mmTZD (eg 1997-07-16T19:20+01:00)
+        # Complete date plus hours, minutes and seconds:
+        #    YYYY-MM-DDThh:mm:ssTZD (eg 1997-07-16T19:20:30+01:00)
+        # Complete date plus hours, minutes, seconds and a decimal fraction of a second
+        #    YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45+01:00)
+        def validate
+          return false unless (matches = @date.match(REGEX))
+          return true unless matches[:month]
+          return (1..12).include? matches[:month].to_i unless matches[:day]
+
+          Date.parse(@date)
+
+          true
+        rescue Date::Error
+          false
+        end
+      end
+    end
+  end
+end

data/lib/cocina/models/version.rb

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

data/openapi.yml

@@ -1049,6 +1049,14 @@ components:
           $ref: '#/components/schemas/LanguageTag'
         use:
           $ref: '#/components/schemas/FileUse'
+        sdrGeneratedText:
+          description: Indicates if the text (OCR/captioning) was generated by SDR.
+          type: boolean
+          default: false
+        correctedForAccessibility:
+          description: Indicates if text that has been verified for accessibility/correctness.
+          type: boolean
+          default: false
         hasMessageDigests:
           type: array
           items:
@@ -1144,7 +1152,7 @@ components:
           items:
             $ref: '#/components/schemas/File'
     FileUse:
-      description: Use for the File.
+      description: Use for the File (e.g. "transcription" for OCR).
       type: string
       nullable: true
     FolioCatalogLink:
@@ -1792,6 +1800,14 @@ components:
           type: string
         use:
           $ref: '#/components/schemas/FileUse'
+        sdrGeneratedText:
+          description: Indicates if the text (OCR/captioning) was generated by SDR.
+          type: boolean
+          default: false
+        correctedForAccessibility:
+          description: Indicates if text that has been verified for accessibility/correctness.
+          type: boolean
+          default: false
         hasMessageDigests:
           type: array
           items:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.96.0
+  version: 0.97.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-29 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,20 +164,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rss
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: super_diff
   requirement: !ruby/object:Gem::Requirement
@@ -536,6 +522,7 @@ files:
 - lib/cocina/models/validators/open_api_validator.rb
 - lib/cocina/models/validators/purl_validator.rb
 - lib/cocina/models/validators/validator.rb
+- lib/cocina/models/validators/w3cdtf_validator.rb
 - lib/cocina/models/version.rb
 - lib/cocina/models/vocabulary.rb
 - lib/cocina/models/world_access.rb
@@ -562,7 +549,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Data models for the SDR