cocina-models 0.68.0 → 0.69.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d958e46bc006eefe8d06d8d1d82e877ba59b16efb805668fb3f269c04bfb200b
-  data.tar.gz: f5bdcce64f7471c944e39ddd9406f4ca93d87279cf95a1d0539943ce9481edf5
+  metadata.gz: 191508cff01be391223c83aba3e7c085e99b581a0f12a95dcd627572fbe5be36
+  data.tar.gz: b4eb3927706c3a5316f30d03d0352e742b3b0a72bf966cb9b0ed6bb593a0d48d
 SHA512:
-  metadata.gz: 40c18189082759e6611b18164ab793e26a8add49fdb8bc74b9e333e59d7be73a3268e3d98bc11e066a924206dc8501c52e56bcde64f1ef38d8b40d943ff3ef75
-  data.tar.gz: 0660a591a00e07846274f123f2a6f3e1715244e24c9a5998a5ed7e36753c6d6ab302365b1a09bf5368c61aeb7a15ad32b9656bd136cc4e194883345abf6e6dbd
+  metadata.gz: 8a4e9c462003e94e13992d20e2adc1a88515185820c11f851b0e709913addb541efadb35d11a0c841cb563e26d0b98cea15b0c0cc9d14aeddeb93f5bc953b147
+  data.tar.gz: 501f90b85f9386ff832b4147483d6e46fd6e8735fe87de6b868e7f68e2c6a02f1cf71759cb649103bcff93fb9e5830c11cd3ac0387e85336821237f8add0ee71

data/.rubocop.yml

@@ -78,6 +78,7 @@ Metrics/BlockLength:
   Exclude:
     - cocina-models.gemspec
     - spec/cocina/**/*
+    - lib/cocina/rspec/matchers.rb
 
 Metrics/MethodLength:
   Max: 14
@@ -105,6 +106,9 @@ RSpec/MultipleExpectations:
 RSpec/StubbedMock: # (new in 1.44)
   Enabled: true
 
+RSpec/MultipleMemoizedHelpers:
+  Max: 6
+
 # ----- Style ------
 
 Style/Documentation:
@@ -276,3 +280,5 @@ RSpec/FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
 RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true

data/README.md

@@ -103,3 +103,17 @@ The following are the recommended naming conventions for code using Cocina model
 * `cocina_admin_policy`: `Cocina::Models::AdminPolicy` instance
 * `cocina_collection`: `Cocina::Models::Collection` instance
 * `cocina_object`: `Cocina::Models::DRO` or `Cocina::Models::AdminPolicy` or `Cocina::Models::Collection` instance
+
+## RSpec matchers
+
+As of the 0.69.0 release, the `cocina-models` gem provides RSpec matchers for downstream apps to make it easier to compare Cocina data structures. The matchers provided include:
+
+* `equal_cocina_model`: Compare a Cocina JSON string with a model instance. This matcher is especially valuable coupled with the `super_diff` gem (a dependency of `cocina-models` since the 0.69.0 release). Example usage:
+  * `expect(http_response_body_with_cocina_json).to equal_cocina_model(cocina_instance)`
+* `cocina_object_with` (AKA `match_cocina_object_with`): Compare a Cocina model instance with a hash containining part of the structure of a Cocina object. Example usage:
+  * `expect(CocinaObjectStore).to have_received(:save).with(cocina_object_with(access: { view: 'world' }, structural: { contains: [...] }))`
+  * expect(updated_cocina_item).to match_cocina_object_with(structural: { hasMemberOrders: [] })
+* `cocina_object_with_types`: Check a Cocina object's type information. Example usage:
+  * `expect(object_client).to have_received(:update).with(params: cocina_object_with_types(content_type: Cocina::Models::ObjectType.book, viewing_direction: 'left-to-right'))`
+* `cocina_admin_policy_with_registration_collections`: Check a Cocina admin policy's collections. Example usage:
+  * `expect(object_client).to have_received(:update).with(params: cocina_admin_policy_with_registration_collections([collection_id]))`

data/cocina-models.gemspec

@@ -31,6 +31,7 @@ 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', '>= 0.11.1', '< 1.0'
+  spec.add_dependency 'super_diff'
   spec.add_dependency 'thor'
   spec.add_dependency 'zeitwerk', '~> 2.1'
 

data/lib/cocina/generator/generator.rb

@@ -71,18 +71,26 @@ module Cocina
         run("rubocop -a #{filepath} > /dev/null")
       end
 
-      # rubocop:disable Metrics/AbcSize
+      NO_CLEAN = [
+        'checkable.rb',
+        'dro_rights_description_builder.rb',
+        'license.rb',
+        'rights_description_builder.rb',
+        'title_builder.rb',
+        'validatable.rb',
+        'validator.rb',
+        'version.rb',
+        'vocabulary.rb'
+      ].freeze
+
       def clean_output
         FileUtils.mkdir_p(options[:output])
         files = Dir.glob("#{options[:output]}/*.rb")
         # Leave alone
-        files.delete("#{options[:output]}/version.rb")
-        files.delete("#{options[:output]}/checkable.rb")
-        files.delete("#{options[:output]}/validator.rb")
-        files.delete("#{options[:output]}/validatable.rb")
+        NO_CLEAN.each { |filename| files.delete("#{options[:output]}/#{filename}") }
+
         FileUtils.rm_f(files)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 end

data/lib/cocina/generator/vocab.rb

@@ -32,7 +32,7 @@ module Cocina
           module Cocina
             module Models
               # #{CLASS_COMMENT.fetch(namespace)}
-              class #{namespace}
+              class #{namespace} < Vocabulary('#{URIS.fetch(namespace)}')
           #{draw_ruby_methods(methods, 6)}
               end
             end
@@ -45,6 +45,10 @@ module Cocina
       attr_reader :schemas, :output_dir
 
       BASE = 'https://cocina.sul.stanford.edu/models/'
+      URIS = {
+        'ObjectType' => BASE,
+        'FileSetType' => "#{BASE}resources/"
+      }.freeze
 
       def vocabs
         type_properties = schemas.values.map { |schema| schema.properties['type'] }.compact
@@ -56,21 +60,24 @@ module Cocina
 
       def names
         @names ||= vocabs.each_with_object({}) do |vocab, object|
-          # Note special handling of 3d
           namespaced = vocab.delete_prefix(BASE)
-                            .gsub('-', '_').gsub('3d', 'three_dimensional')
           namespace, name = namespaced.include?('/') ? namespaced.split('/') : ['ObjectType', namespaced]
           namespace = 'FileSetType' if namespace == 'resources'
-          object[namespace] ||= {}
-          object[namespace][name] = vocab
+          object[namespace] ||= []
+          object[namespace] << name
         end
       end
 
       def draw_ruby_methods(methods, indent)
         spaces = ' ' * indent
-        methods.map do |name, vocab|
-          "#{spaces}def self.#{name}\n#{spaces}  '#{vocab}'\n#{spaces}end"
-        end.join("\n\n")
+        methods.map do |name|
+          if name == '3d'
+            "#{spaces}property :'3d', method_name: :three_dimensional"
+          else
+            name = "'#{name}'" if name.match?(/(^\d)|-/)
+            "#{spaces}property :#{name}"
+          end
+        end.join("\n")
       end
     end
   end

data/lib/cocina/models/dro_rights_description_builder.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # Rights description builder for items
+    class DroRightsDescriptionBuilder < RightsDescriptionBuilder
+      # @param [Cocina::Models::DRO] cocina_item
+
+      # This overrides the superclass
+      # @return [Cocina::Models::DROAccess]
+      def object_access
+        @object_access ||= cocina.access
+      end
+
+      private
+
+      def object_level_access
+        super + access_level_from_files.uniq.map { |str| "#{str} (file)" }
+      end
+
+      def access_level_from_files
+        # dark access doesn't permit any file access
+        return [] if object_access.view == 'dark'
+
+        file_access_nodes.reject { |fa| same_as_object_access?(fa) }.flat_map do |fa|
+          file_access_from_file(fa)
+        end
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def file_access_from_file(file_access)
+        basic_access = if file_access[:view] == 'location-based'
+                         "location: #{file_access[:location]}"
+                       else
+                         file_access[:view]
+                       end
+
+        return [basic_access] if file_access[:view] == file_access[:download]
+
+        basic_access += ' (no-download)' if file_access[:view] != 'dark'
+
+        case file_access[:download]
+        when 'stanford'
+          [basic_access, 'stanford']
+        when 'location-based'
+          # Here we're using location to mean download location.
+          [basic_access, "location: #{file_access[:location]}"]
+        else
+          [basic_access]
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def same_as_object_access?(file_access)
+        (file_access[:view] == object_access.view && file_access[:download] == object_access.download) ||
+          (object_access.view == 'citation-only' && file_access[:view] == 'dark')
+      end
+
+      def file_access_nodes
+        Array(cocina.structural.contains)
+          .flat_map { |fs| Array(fs.structural.contains) }
+          .map { |file| file.access.to_h }
+          .uniq
+      end
+    end
+  end
+end

data/lib/cocina/models/file_set_type.rb

@@ -3,70 +3,23 @@
 module Cocina
   module Models
     # This vocabulary defines the types of file sets
-    class FileSetType
-      def self.three_dimensional
-        'https://cocina.sul.stanford.edu/models/resources/3d'
-      end
-
-      def self.attachment
-        'https://cocina.sul.stanford.edu/models/resources/attachment'
-      end
-
-      def self.audio
-        'https://cocina.sul.stanford.edu/models/resources/audio'
-      end
-
-      def self.document
-        'https://cocina.sul.stanford.edu/models/resources/document'
-      end
-
-      def self.file
-        'https://cocina.sul.stanford.edu/models/resources/file'
-      end
-
-      def self.image
-        'https://cocina.sul.stanford.edu/models/resources/image'
-      end
-
-      def self.main_augmented
-        'https://cocina.sul.stanford.edu/models/resources/main-augmented'
-      end
-
-      def self.main_original
-        'https://cocina.sul.stanford.edu/models/resources/main-original'
-      end
-
-      def self.media
-        'https://cocina.sul.stanford.edu/models/resources/media'
-      end
-
-      def self.object
-        'https://cocina.sul.stanford.edu/models/resources/object'
-      end
-
-      def self.page
-        'https://cocina.sul.stanford.edu/models/resources/page'
-      end
-
-      def self.permissions
-        'https://cocina.sul.stanford.edu/models/resources/permissions'
-      end
-
-      def self.preview
-        'https://cocina.sul.stanford.edu/models/resources/preview'
-      end
-
-      def self.supplement
-        'https://cocina.sul.stanford.edu/models/resources/supplement'
-      end
-
-      def self.thumb
-        'https://cocina.sul.stanford.edu/models/resources/thumb'
-      end
-
-      def self.video
-        'https://cocina.sul.stanford.edu/models/resources/video'
-      end
+    class FileSetType < Vocabulary('https://cocina.sul.stanford.edu/models/resources/')
+      property :'3d', method_name: :three_dimensional
+      property :attachment
+      property :audio
+      property :document
+      property :file
+      property :image
+      property :'main-augmented'
+      property :'main-original'
+      property :media
+      property :object
+      property :page
+      property :permissions
+      property :preview
+      property :supplement
+      property :thumb
+      property :video
     end
   end
 end

data/lib/cocina/models/license.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # This vocabulary defines some of the supported licenses
+    class License < Vocabulary('https://cocina.sul.stanford.edu/licenses/')
+      property :none
+    end
+  end
+end

data/lib/cocina/models/object_type.rb

@@ -3,94 +3,29 @@
 module Cocina
   module Models
     # This vocabulary defines the top level object type
-    class ObjectType
-      def self.three_dimensional
-        'https://cocina.sul.stanford.edu/models/3d'
-      end
-
-      def self.admin_policy
-        'https://cocina.sul.stanford.edu/models/admin_policy'
-      end
-
-      def self.agreement
-        'https://cocina.sul.stanford.edu/models/agreement'
-      end
-
-      def self.book
-        'https://cocina.sul.stanford.edu/models/book'
-      end
-
-      def self.collection
-        'https://cocina.sul.stanford.edu/models/collection'
-      end
-
-      def self.curated_collection
-        'https://cocina.sul.stanford.edu/models/curated-collection'
-      end
-
-      def self.document
-        'https://cocina.sul.stanford.edu/models/document'
-      end
-
-      def self.exhibit
-        'https://cocina.sul.stanford.edu/models/exhibit'
-      end
-
-      def self.file
-        'https://cocina.sul.stanford.edu/models/file'
-      end
-
-      def self.geo
-        'https://cocina.sul.stanford.edu/models/geo'
-      end
-
-      def self.image
-        'https://cocina.sul.stanford.edu/models/image'
-      end
-
-      def self.manuscript
-        'https://cocina.sul.stanford.edu/models/manuscript'
-      end
-
-      def self.map
-        'https://cocina.sul.stanford.edu/models/map'
-      end
-
-      def self.media
-        'https://cocina.sul.stanford.edu/models/media'
-      end
-
-      def self.object
-        'https://cocina.sul.stanford.edu/models/object'
-      end
-
-      def self.page
-        'https://cocina.sul.stanford.edu/models/page'
-      end
-
-      def self.photograph
-        'https://cocina.sul.stanford.edu/models/photograph'
-      end
-
-      def self.series
-        'https://cocina.sul.stanford.edu/models/series'
-      end
-
-      def self.track
-        'https://cocina.sul.stanford.edu/models/track'
-      end
-
-      def self.user_collection
-        'https://cocina.sul.stanford.edu/models/user-collection'
-      end
-
-      def self.webarchive_binary
-        'https://cocina.sul.stanford.edu/models/webarchive-binary'
-      end
-
-      def self.webarchive_seed
-        'https://cocina.sul.stanford.edu/models/webarchive-seed'
-      end
+    class ObjectType < Vocabulary('https://cocina.sul.stanford.edu/models/')
+      property :'3d', method_name: :three_dimensional
+      property :admin_policy
+      property :agreement
+      property :book
+      property :collection
+      property :'curated-collection'
+      property :document
+      property :exhibit
+      property :file
+      property :geo
+      property :image
+      property :manuscript
+      property :map
+      property :media
+      property :object
+      property :page
+      property :photograph
+      property :series
+      property :track
+      property :'user-collection'
+      property :'webarchive-binary'
+      property :'webarchive-seed'
     end
   end
 end

data/lib/cocina/models/rights_description_builder.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # RightsDescriptionBuilder
+    class RightsDescriptionBuilder
+      # @param [Cocina::Models::AdminPolicy, Cocina::Models::DRO] cocina_object
+      def self.build(cocina_object)
+        new(cocina_object).build
+      end
+
+      def initialize(cocina_object)
+        @cocina = cocina_object
+      end
+
+      # This is set up to work for APOs, but this method is to be overridden on sub classes
+      # @return [Cocina::Models::AdminPolicyDefaultAccess]
+      def object_access
+        @object_access ||= cocina.administrative.accessTemplate
+      end
+
+      def build
+        return 'controlled digital lending' if object_access.controlledDigitalLending
+
+        return ['dark'] if object_access.view == 'dark'
+
+        object_level_access
+      end
+
+      private
+
+      attr_reader :cocina
+
+      # rubocop:disable Metrics/MethodLength
+      def object_level_access
+        case object_access.view
+        when 'citation-only'
+          ['citation']
+        when 'world'
+          world_object_access
+        when 'location-based'
+          case object_access.download
+          when 'none'
+            ["location: #{object_access.location} (no-download)"]
+          else
+            ["location: #{object_access.location}"]
+          end
+        when 'stanford'
+          stanford_object_access
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def stanford_object_access
+        case object_access.download
+        when 'none'
+          ['stanford (no-download)']
+        when 'location-based'
+          # this is an odd case we might want to move away from. See https://github.com/sul-dlss/cocina-models/issues/258
+          ['stanford (no-download)', "location: #{object_access.location}"]
+        else
+          ['stanford']
+        end
+      end
+
+      def world_object_access
+        case object_access.download
+        when 'stanford'
+          ['stanford', 'world (no-download)']
+        when 'none'
+          ['world (no-download)']
+        when 'world'
+          ['world']
+        when 'location-based'
+          # this is an odd case we might want to move away from. See https://github.com/sul-dlss/cocina-models/issues/258
+          ['world (no-download)', "location: #{object_access.location}"]
+        end
+      end
+    end
+  end
+end

data/lib/cocina/models/title_builder.rb

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # TitleBuilder selects the prefered title from the cocina object for solr indexing
+    # rubocop:disable Metrics/ClassLength
+    class TitleBuilder
+      # @param [Cocina::Models::D*] cocina_object is the object to extract the title for
+      # @param [Symbol] strategy ":first" is the strategy for selection when primary or display title are missing
+      # @param [Boolean] add_punctuation determines if the title should be formmated with punctuation
+      # @return [String] the title value for Solr
+      def self.build(cocina_object, strategy: :first, add_punctuation: true)
+        new(cocina_object, strategy: strategy, add_punctuation: add_punctuation).build_title
+      end
+
+      def initialize(cocina_object, strategy:, add_punctuation:)
+        @cocina_object = cocina_object
+        @strategy = strategy
+        @add_punctuation = add_punctuation
+      end
+
+      # @return [String] the title value for Solr
+      def build_title
+        @titles = cocina_object.description.title
+
+        cocina_title = primary_title || untyped_title
+        cocina_title = other_title if cocina_title.blank?
+
+        if strategy == :first
+          extract_title(cocina_title)
+        else
+          cocina_title.map { |one| extract_title(one) }
+        end
+      end
+
+      private
+
+      attr_reader :cocina_object, :strategy, :titles
+
+      def extract_title(cocina_title)
+        result = if cocina_title.value
+                   cocina_title.value
+                 elsif cocina_title.structuredValue.present?
+                   title_from_structured_values(cocina_title.structuredValue,
+                                                non_sorting_char_count(cocina_title))
+                 elsif cocina_title.parallelValue.present?
+                   return cocina_title.parallelValue.first.value
+                 end
+        remove_trailing_punctuation(result.strip) if result.present?
+      end
+
+      def add_punctuation?
+        @add_punctuation
+      end
+
+      # @return [Cocina::Models::Title, nil] title that has status=primary
+      def primary_title
+        primary_title = titles.find do |title|
+          title.status == 'primary'
+        end
+        return primary_title if primary_title.present?
+
+        # NOTE: structuredValues would only have status primary assigned as a sibling, not as an attribute
+
+        titles.find do |title|
+          title.parallelValue&.find do |parallel_title|
+            parallel_title.status == 'primary'
+          end
+        end
+      end
+
+      def untyped_title
+        method = strategy == :first ? :find : :select
+        untyped_title_for(titles.public_send(method))
+      end
+
+      # @return [Array[Cocina::Models::Title]] first title that has no type attribute
+      def untyped_title_for(titles)
+        titles.each do |title|
+          if title.parallelValue.present?
+            untyped_title_for(title.parallelValue)
+          else
+            title.type.nil? || title.type == 'title'
+          end
+        end
+      end
+
+      # This handles 'main title', 'uniform' or 'translated'
+      def other_title
+        if strategy == :first
+          titles.first
+        else
+          titles
+        end
+      end
+
+      # rubocop:disable Metrics/BlockLength
+      # rubocop:disable Metrics/CyclomaticComplexity
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      # @param [Array<Cocina::Models::StructuredValue>] structured_values - the pieces of a structuredValue
+      # @param [Integer] the length of the non_sorting_characters
+      # @return [String] the title value from combining the pieces of the structured_values by type and order
+      #   with desired punctuation per specs
+      def title_from_structured_values(structured_values, non_sorting_char_count)
+        structured_title = ''
+        part_name_number = ''
+        # combine pieces of the cocina structuredValue into a single title
+        structured_values.each do |structured_value|
+          # There can be a structuredValue inside a structuredValue.  For example,
+          #   a uniform title where both the name and the title have internal StructuredValue
+          if structured_value.structuredValue.present?
+            return title_from_structured_values(structured_value.structuredValue, non_sorting_char_count)
+          end
+
+          value = structured_value.value&.strip
+          next unless value
+
+          # additional types:  name, uniform ...
+          case structured_value.type&.downcase
+          when 'nonsorting characters'
+            non_sorting_size = [non_sorting_char_count - (value&.size || 0), 0].max
+            non_sort_value = "#{value}#{' ' * non_sorting_size}"
+            structured_title = if structured_title.present?
+                                 "#{structured_title}#{non_sort_value}"
+                               else
+                                 non_sort_value
+                               end
+          when 'part name', 'part number'
+            if part_name_number.blank?
+              part_name_number = part_name_number(structured_values)
+              structured_title = if !add_punctuation?
+                                   [structured_title, part_name_number].join(' ')
+                                 elsif structured_title.present?
+                                   "#{structured_title.sub(/[ .,]*$/, '')}. #{part_name_number}. "
+                                 else
+                                   "#{part_name_number}. "
+                                 end
+            end
+          when 'main title', 'title'
+            structured_title = "#{structured_title}#{value}"
+          when 'subtitle'
+            # subtitle is preceded by space colon space, unless it is at the beginning of the title string
+            structured_title = if !add_punctuation?
+                                 [structured_title, value].join(' ')
+                               elsif structured_title.present?
+                                 "#{structured_title.sub(/[. :]+$/, '')} : #{value.sub(/^:/, '').strip}"
+                               else
+                                 structured_title = value.sub(/^:/, '').strip
+                               end
+          end
+        end
+        structured_title
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/BlockLength
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+
+      def remove_trailing_punctuation(title)
+        title.sub(%r{[ .,;:/\\]+$}, '')
+      end
+
+      def non_sorting_char_count(title)
+        non_sort_note = title.note&.find { |note| note.type&.downcase == 'nonsorting character count' }
+        return 0 unless non_sort_note
+
+        non_sort_note.value.to_i
+      end
+
+      # combine part name and part number:
+      #   respect order of occurrence
+      #   separated from each other by comma space
+      def part_name_number(structured_values)
+        title_from_part = ''
+        structured_values.each do |structured_value|
+          case structured_value.type&.downcase
+          when 'part name', 'part number'
+            value = structured_value.value&.strip
+            next unless value
+
+            title_from_part = append_part_to_title(title_from_part, value)
+
+          end
+        end
+        title_from_part
+      end
+
+      def append_part_to_title(title_from_part, value)
+        if !add_punctuation?
+          [title_from_part, value].select(&:presence).join(' ')
+        elsif title_from_part.strip.present?
+          "#{title_from_part.sub(/[ .,]*$/, '')}, #{value}"
+        else
+          value
+        end
+      end
+    end
+    # rubocop:enable Metrics/ClassLength
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.68.0'
+    VERSION = '0.69.2'
   end
 end

data/lib/cocina/models/vocabulary.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    class Vocabulary
+      # @private
+      # Disabled this cop because we want @@uri to be inheritable.
+      # rubocop:disable Style/ClassVars
+      def self.create(uri)
+        @@uri = uri
+        self
+      end
+      # rubocop:enable Style/ClassVars
+
+      def self.to_s
+        @@uri
+      end
+
+      def self.property(name, method_name: name.to_s.underscore.to_sym)
+        uri = [to_s, name].join
+        properties[name] = uri
+        (class << self; self; end).send(:define_method, method_name) { uri }
+      end
+
+      def self.properties
+        @properties ||= {}
+      end
+    end
+  end
+end

data/lib/cocina/models.rb

@@ -22,6 +22,7 @@ class CocinaModelsInflector < Zeitwerk::Inflector
     'dro_access' => 'DROAccess',
     'dro_structural' => 'DROStructural',
     'request_dro_structural' => 'RequestDROStructural',
+    'rspec' => 'RSpec',
     'version' => 'VERSION'
   }.freeze
 
@@ -33,6 +34,8 @@ end
 loader = Zeitwerk::Loader.new
 loader.inflector = CocinaModelsInflector.new
 loader.push_dir(File.absolute_path("#{__FILE__}/../.."))
+loader.ignore("#{__dir__}/rspec.rb")
+loader.ignore("#{__dir__}/rspec/**/*.rb")
 loader.setup
 
 module Cocina
@@ -56,6 +59,17 @@ module Cocina
       include Dry.Types()
     end
 
+    ##
+    # Alias for `Cocina::Models::Vocabulary.create`.
+    #
+    # @param (see Cocina::Models::Vocabulary#initialize)
+    # @return [Class]
+    # rubocop:disable Naming/MethodName
+    def self.Vocabulary(uri)
+      Vocabulary.create(uri)
+    end
+    # rubocop:enable Naming/MethodName
+
     # @param [Hash] dyn a ruby hash representation of the JSON serialization of a collection or DRO
     # @param [boolean] validate
     # @return [DRO,Collection,AdminPolicy]

data/lib/cocina/rspec/matchers.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Provides RSpec matchers for Cocina models
+module Cocina
+  module RSpec
+    # Cocina-related RSpec matchers
+    module Matchers
+      extend ::RSpec::Matchers::DSL
+
+      # NOTE: each k/v pair in the hash passed to this matcher will need to be present in actual
+      matcher :cocina_object_with do |**kwargs|
+        kwargs.each do |cocina_section, expected|
+          match do |actual|
+            expected.all? do |expected_key, expected_value|
+              # NOTE: there's no better method on Hash that I could find for this.
+              #        #include? and #member? only check keys, not k/v pairs
+              actual.public_send(cocina_section).to_h.any? do |actual_key, actual_value|
+                if expected_value.is_a?(Hash) && actual_value.is_a?(Hash)
+                  expected_value.all? { |pair| actual_value.to_a.include?(pair) }
+                else
+                  actual_key == expected_key && actual_value == expected_value
+                end
+              end
+            end
+          end
+        end
+      end
+
+      alias_matcher :match_cocina_object_with, :cocina_object_with
+
+      # The `equal_cocina_model` matcher compares a JSON string as actual value
+      # against a Cocina model coerced to JSON as expected value. We want to compare
+      # these as JSON rather than as hashes, else we'll have to start
+      # deep-converting some values within the hashes, thinking of date/time values
+      # in particular. This matching behavior continues what dor-services-app was
+      # already doing before this custom matcher was written.
+      #
+      # Note, though, that when actual and expected values do *not* match, we coerce
+      # both values to hashes to allow the `super_diff` gem to highlight the areas
+      # that differ. This is easier to scan than two giant JSON strings.
+      matcher :equal_cocina_model do |expected|
+        match do |actual|
+          Cocina::Models.build(JSON.parse(actual)).to_json == expected.to_json
+        rescue NoMethodError
+          warn "Could not match cocina models because expected is not a valid JSON string: #{expected}"
+          false
+        end
+
+        failure_message do |actual|
+          SuperDiff::EqualityMatchers::Hash.new(
+            expected: expected.to_h.deep_symbolize_keys,
+            actual: JSON.parse(actual, symbolize_names: true)
+          ).fail
+        rescue StandardError => e
+          "ERROR in CocinaMatchers: #{e}"
+        end
+      end
+
+      matcher :cocina_object_with_types do |expected|
+        match do |actual|
+          return false if expected[:without_order] && !match_no_orders?
+
+          if expected[:content_type] && expected[:resource_types]
+            match_cocina_type?(actual, expected) && match_contained_cocina_types?(actual, expected)
+          elsif expected[:content_type] && expected[:viewing_direction]
+            match_cocina_type?(actual, expected) && match_cocina_viewing_direction?(actual, expected)
+          elsif expected[:content_type]
+            match_cocina_type?(actual, expected)
+          elsif expected[:resource_types]
+            match_contained_cocina_types?(actual, expected)
+          else
+            raise ArgumentError, 'must provide content_type and/or resource_types keyword args'
+          end
+        end
+
+        def match_no_orders?
+          actual.structural.hasMemberOrders.blank?
+        end
+
+        def match_cocina_type?(actual, expected)
+          actual.type == expected[:content_type]
+        end
+
+        def match_cocina_viewing_direction?(actual, expected)
+          actual.structural.hasMemberOrders.map(&:viewingDirection).all? do |viewing_direction|
+            viewing_direction == expected[:viewing_direction]
+          end
+        end
+
+        def match_contained_cocina_types?(actual, expected)
+          Array(actual.structural.contains).map(&:type).all? { |type| type.in?(expected[:resource_types]) }
+        end
+      end
+
+      matcher :cocina_admin_policy_with_registration_collections do |expected|
+        match do |actual|
+          actual.type == Cocina::Models::ObjectType.admin_policy &&
+            expected.all? { |collection_id| collection_id.in?(actual.administrative.collectionsForRegistration) }
+        end
+      end
+    end
+  end
+end

data/lib/cocina/rspec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'rspec/matchers'
+require 'super_diff/rspec'
+require 'cocina/rspec/matchers'
+
+RSpec.configure do |config|
+  config.include Cocina::RSpec::Matchers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.68.0
+  version: 0.69.2
 platform: ruby
 authors:
 - Justin Coyne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-09 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: super_diff
+  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -308,6 +322,7 @@ files:
 - lib/cocina/models/doi.rb
 - lib/cocina/models/dro.rb
 - lib/cocina/models/dro_access.rb
+- lib/cocina/models/dro_rights_description_builder.rb
 - lib/cocina/models/dro_structural.rb
 - lib/cocina/models/druid.rb
 - lib/cocina/models/embargo.rb
@@ -322,6 +337,7 @@ files:
 - lib/cocina/models/identification.rb
 - lib/cocina/models/lane_medical_barcode.rb
 - lib/cocina/models/language.rb
+- lib/cocina/models/license.rb
 - lib/cocina/models/location_based_access.rb
 - lib/cocina/models/location_based_download_access.rb
 - lib/cocina/models/message_digest.rb
@@ -340,6 +356,7 @@ files:
 - lib/cocina/models/request_file_set.rb
 - lib/cocina/models/request_file_set_structural.rb
 - lib/cocina/models/request_identification.rb
+- lib/cocina/models/rights_description_builder.rb
 - lib/cocina/models/sequence.rb
 - lib/cocina/models/source.rb
 - lib/cocina/models/source_id.rb
@@ -347,16 +364,20 @@ files:
 - lib/cocina/models/standard_barcode.rb
 - lib/cocina/models/stanford_access.rb
 - lib/cocina/models/title.rb
+- lib/cocina/models/title_builder.rb
 - lib/cocina/models/validatable.rb
 - lib/cocina/models/validator.rb
 - lib/cocina/models/version.rb
+- lib/cocina/models/vocabulary.rb
 - lib/cocina/models/world_access.rb
+- lib/cocina/rspec.rb
+- lib/cocina/rspec/matchers.rb
 - openapi.yml
 homepage: https://github.com/sul-dlss/cocina-models
 licenses: []
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -371,8 +392,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: Data models for the SDR
 test_files: []