cocina-models 0.30.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae254699614b4355dea34dab3e0ef324123b21d30d592c24ceffbad5fed3515e
-  data.tar.gz: da8eecbff7bec360ed56445d61fc558b4a18684df9f0f92bc4a98668e2d16dac
+  metadata.gz: 258bc916aaaff62a84cd0bd264f8957e3c916310134ef3372cfdd3eca4c1ff4e
+  data.tar.gz: c26a6cc519230a25d19b218ddcec52fa552ea7780f647b6d449aee223be35eef
 SHA512:
-  metadata.gz: 4c6c2e1beb7cd1b28d73bee2641be223497e18764bbffae9953fde54995336ae970be70e8d1ac31fa96f131ad9c17a02b2a5ef7b9e9beb098ecf9925899333ad
-  data.tar.gz: 53246fecec8a7e4516aa3fef318dddfa644158678f4894d1eeb1285d0c247b6a2bdafd68a491ae18b19e41fa5a195bc2f078ba303adb9f83f37b26c4121585cf
+  metadata.gz: cd057f437502f2e54f6b2c689b6aef4c808ac4912c91d87755abfeb13c24100ef3380f262e7ec27f42592ecbd59b16d68669c878a31c55fc2402f069c5142f1e
+  data.tar.gz: 5a27ebb9108e9838117b02ec015bb025120d82e3f90749b12d23b523f3eea4efe865b6e405f649574f10f88ee0a70811334c339e9d522f5f1186b72f59df9240

data/.circleci/config.yml

@@ -0,0 +1,51 @@
+version: 2.1
+executors:
+  docker-publisher:
+    docker:
+    - image: circleci/buildpack-deps:stretch
+jobs:
+  test:
+    docker:
+    - image: circleci/ruby:2.7.0-node
+    steps:
+    - checkout
+    - run:
+        name: install bundler
+        command: gem install bundler -v 2.1.4
+    - run:
+        name: Install gem dependencies
+        command: bundle check || bundle install
+    - run:
+        name: Lint using rubocop
+        command: bundle exec rubocop
+    - run:
+        name: Setup Code Climate test-reporter
+        command: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+    - run:
+        name: Run RSpec test suite
+        command: bundle exec rspec
+    - run:
+        name: upload test coverage report to Code Climate
+        command: ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?
+    - run:
+        name: Validate API specification
+        command: |
+          sudo npm install -g openapi-enforcer-cli
+          result=$(openapi-enforcer validate openapi.yml)
+          [[ $result =~ "Document is valid" ]] && {
+          echo "Validation good"
+          exit 0
+          } || {
+          echo $result
+          exit 1
+          }
+
+workflows:
+  version: 2
+
+  test:
+    jobs:
+    - test

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,7 @@ inherit_from: .rubocop_todo.yml
 require:
   - rubocop-rspec
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 114
   Exclude:
     - lib/cocina/models/*
@@ -22,7 +22,62 @@ RSpec/MultipleExpectations:
 
 RSpec/ExampleLength:
   Max: 18
+  Exclude:
+    - 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
+  

data/README.md

@@ -1,18 +1,21 @@
-[![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)
+[![OpenAPI Validator](http://validator.swagger.io/validator?url=https://raw.githubusercontent.com/sul-dlss/cocina-models/master/openapi.yml)](http://validator.swagger.io/validator/debug?url=https://raw.githubusercontent.com/sul-dlss/cocina-models/master/openapi.yml)
 
 # Cocina::Models
 
 This is a Ruby implementation of the SDR data model (named "COCINA"). The data being modeled includes digital repository objects.
 
-It provides a way for consumers to validate objects against models using dry-struct and dry-types gems.
+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 thos 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).
 
 ## Generate models from openapi.yml
 
+Note that only a small subset of openapi is supported. If you are using a new openapi feature or pattern, verify that the model will be generated as expected.
+
 ### All
 ```
 exe/generator generate
@@ -23,20 +26,14 @@ exe/generator generate
 exe/generator generate_schema DRO
 ```
 
-## Generate Documentation
+## Testing
 
-```
-gem install prmd
-cd docs
+The generator is tested via its output when run against `openapi.yml`, viz., the Cocina model classes. Thus, `generate` should be run after any changes to `openapi.yml`.
 
-# Combine into a single schema
-prmd combine --meta meta.json  maps/ > schema.json
+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`.
 
-# Check it’s all good
-prmd verify schema.json
+## Using this gem
 
-# Build docs
-prmd doc schema.json > schema.md
-```
+If you are using this gem in an application that has an API that accepts Cocina models (e.g., SDR API, Dor-Services-App), make sure that the `openapi.yml` for the application includes the schemas that match the schemas in this `openapi.yml`.
 
-Then check in the resulting changes to `docs/schema.json` and `docs/schema.md`
+This can be accomplished by cutting and pasting these schemas. By convention, these schemas are listed first in the `openapi.yml` of the associated projects, followed by the application-specific schemas.

data/cocina-models.gemspec

@@ -33,9 +33,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'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
 end

data/docs/index.html

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>API documentation</title>
+
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <redoc spec-url='https://raw.githubusercontent.com/sul-dlss/cocina-models/master/openapi.yml'></redoc>
+    <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
+  </body>
+</html>

data/docs/maps/DRO.json

@@ -84,7 +84,7 @@
         "download": {
           "description": "Download level for the DRO metadata.",
           "type": "string",
-          "enum": ["world", "stanford", "location-based", "citation-only", "dark"]
+          "enum": ["world", "stanford", "location-based", "none"]
         },
         "embargo": {
           "description": "Embargo metadata",

data/exe/generator

@@ -4,6 +4,6 @@
 require 'bundler/setup'
 $LOAD_PATH.unshift 'lib'
 
-require 'cocina/generator'
+require 'cocina/models'
 
 Cocina::Generator::Generator.start(ARGV)

data/lib/cocina/generator.rb

@@ -1,16 +1,5 @@
 # frozen_string_literal: true
 
-require 'zeitwerk'
-require 'yaml'
-require 'active_support/core_ext/string'
-require 'thor'
-require 'openapi3_parser'
-require 'byebug'
-
-loader = Zeitwerk::Loader.new
-loader.push_dir(File.absolute_path("#{__FILE__}/../.."))
-loader.setup
-
 module Cocina
   # Module for generating Cocina models from openapi.
   module Generator

data/lib/cocina/generator/generator.rb

@@ -17,7 +17,7 @@ module Cocina
       def generate
         clean_output
 
-        schemas.keys.each do |schema_name|
+        schemas.each_key do |schema_name|
           schema = schema_for(schema_name)
           generate_for(schema) if schema
         end

data/lib/cocina/generator/schema.rb

@@ -5,12 +5,7 @@ module Cocina
     # Class for generating from an openapi schema
     class Schema < SchemaBase
       def schema_properties
-        @schema_properties ||= schema_doc.properties.map do |key, properties_doc|
-          property_class_for(properties_doc).new(properties_doc,
-                                                 key: key,
-                                                 required: schema_doc.requires?(properties_doc),
-                                                 parent: self)
-        end
+        @schema_properties ||= (properties + all_of_properties).uniq(&:key)
       end
 
       def generate
@@ -54,7 +49,7 @@ module Cocina
 
       def types
         type_properties_doc = schema_doc.properties['type']
-        return '' if type_properties_doc.nil?
+        return '' if type_properties_doc.nil? || type_properties_doc.enum.nil?
 
         types_list = type_properties_doc.enum.map { |item| "'#{item}'" }.join(",\n ")
 
@@ -70,7 +65,7 @@ module Cocina
 
         <<~RUBY
           def self.new(attributes = default_attributes, safe = false, validate = true, &block)
-            Validator.validate(self, attributes.with_indifferent_access) if validate
+            Validator.validate(self, attributes.with_indifferent_access) if validate && name
             super(attributes, safe, &block)
                 end
         RUBY
@@ -79,6 +74,32 @@ module Cocina
       def validatable?
         !schema_doc.node_context.document.paths["/validate/#{schema_doc.name}"].nil?
       end
+
+      def properties
+        schema_properties_for(schema_doc)
+      end
+
+      def all_of_properties
+        all_of_properties_for(schema_doc)
+      end
+
+      def all_of_properties_for(doc)
+        return [] if doc.all_of.nil?
+
+        doc.all_of.map do |all_of_schema|
+          # All of for this + recurse
+          schema_properties_for(all_of_schema) + all_of_properties_for(all_of_schema)
+        end.flatten
+      end
+
+      def schema_properties_for(doc)
+        doc.properties.map do |key, properties_doc|
+          property_class_for(properties_doc).new(properties_doc,
+                                                 key: key,
+                                                 required: doc.requires?(properties_doc),
+                                                 parent: self)
+        end
+      end
     end
   end
 end

data/lib/cocina/generator/schema_array.rb

@@ -5,7 +5,7 @@ module Cocina
     # Class for generating from an openapi array
     class SchemaArray < SchemaBase
       def generate
-        "attribute :#{name.camelize(:lower)}, Types::Strict::Array.of(#{schema_doc.items.name})#{omittable}"
+        "attribute :#{name.camelize(:lower)}, Types::Strict::Array.of(#{array_of_type})#{omittable}"
       end
 
       def omittable
@@ -15,6 +15,10 @@ module Cocina
           '.meta(omittable: true)'
         end
       end
+
+      def array_of_type
+        schema_doc.items.name || "Types::#{dry_datatype(schema_doc.items)}"
+      end
     end
   end
 end

data/lib/cocina/generator/schema_base.rb

@@ -44,6 +44,28 @@ module Cocina
 
         "# example: #{schema_doc.example}\n"
       end
+
+      def dry_datatype(doc)
+        case doc.type
+        when 'integer'
+          'Strict::Integer'
+        when 'string'
+          string_dry_datatype(doc)
+        when 'boolean'
+          'Strict::Bool'
+        else
+          raise "#{schema_doc.type} not supported"
+        end
+      end
+
+      def string_dry_datatype(doc)
+        case doc.format
+        when 'date-time'
+          'Params::DateTime'
+        else
+          'Strict::String'
+        end
+      end
     end
   end
 end

data/lib/cocina/generator/schema_value.rb

@@ -4,36 +4,14 @@ 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}#{default}#{enum}#{omittable}"
+        "#{description}#{example}attribute :#{name.camelize(:lower)}, Types::#{dry_datatype(schema_doc)}#{default}#{enum}#{omittable}"
       end
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
 
       private
 
-      def dry_datatype
-        case schema_doc.type
-        when 'integer'
-          'Strict::Integer'
-        when 'string'
-          string_dry_datatype
-        when 'boolean'
-          'Strict::Bool'
-        else
-          raise "#{schema_doc.type} not supported"
-        end
-      end
-
-      def string_dry_datatype
-        case schema_doc.format
-        when 'date-time'
-          'Params::DateTime'
-        else
-          'Strict::String'
-        end
-      end
-
       def enum
         return '' unless schema_doc.enum
 

data/lib/cocina/models.rb

@@ -5,13 +5,15 @@ require 'zeitwerk'
 require 'dry-struct'
 require 'dry-types'
 require 'json'
+require 'yaml'
 require 'openapi_parser'
+require 'openapi3_parser'
 require 'active_support/core_ext/hash/indifferent_access'
-require 'yaml'
+require 'active_support/core_ext/string'
+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
@@ -31,7 +33,7 @@ class CocinaModelsInflector < Zeitwerk::Inflector
       super
     end
   end
-  # rubocop:enable Metrics/CyclomaticComplexity
+
   # rubocop:enable Metrics/MethodLength
 end
 
@@ -78,7 +80,7 @@ module Cocina
               else
                 raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
               end
-      clazz.new(dyn, validate: validate)
+      clazz.new(dyn, false, validate)
     end
 
     # @param [Hash] dyn a ruby hash representation of the JSON serialization of a request for a Collection or DRO
@@ -98,7 +100,7 @@ module Cocina
               else
                 raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
               end
-      clazz.new(dyn, validate: validate)
+      clazz.new(dyn, false, validate)
     end
   end
 end