cocina-models 0.29.0 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76b2604162a420ba454bf72d767dd17cffd588c585644e7af5713a626528c354
-  data.tar.gz: a120a35df55448923beb33b256001ea711de2a41b89a6b353e7eb8770aea160c
+  metadata.gz: fa8dd7285b70bcc1a81fd099ada06d39ceba9f24900076deec73dd46573df2f4
+  data.tar.gz: c196659cf0ce69aee69ffc3472235d68d9e4eb0503ed70aa5c79f517c8412498
 SHA512:
-  metadata.gz: 8339f6d67fa9ce0d717383e377d68c935ec77b6eab99248a74ea0b70ef74379c449a9a004942d5495df97f3a00aedb671323cdd9a1f040961d7b85c285094c64
-  data.tar.gz: c1e9c0dd4dbd1c079e863d914519e7c173d79eb85e164a1c2121b69b23d87b3323823c93e52fcd4227fde46338c6987bef4ec75d85b3517a62869ac5eb40a259
+  metadata.gz: a001d343d4233b377aa0c666383ce2f70abb36f3fc05169f007fc7f1b6f8e9784f5ff67f204255a585b1f4e9ddd6c3d624a4baf0057b78607c73b7df93e3b173
+  data.tar.gz: cb9db638c1ffaad358e05bc097c5fc9ec44a3df56bb4b13418f417daf2a71879561885a9e26adfcaf37e37bdf3542fca9055340816f2253b8f5f9f4c69b0eef0

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,13 +4,16 @@ inherit_from: .rubocop_todo.yml
 require:
   - rubocop-rspec
 
+Metrics/LineLength:
+  Max: 114
+  Exclude:
+    - lib/cocina/models/*
+
 Metrics/BlockLength:
   Exclude:
+    - cocina-models.gemspec
     - spec/cocina/**/*
 
-Metrics/LineLength:
-  Max: 114
-
 Metrics/MethodLength:
   Max: 14
 
@@ -19,3 +22,11 @@ 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/*

data/README.md

@@ -1,31 +1,39 @@
-[![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
 
-## Generate Documentation
+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
 ```
-gem install prmd
-cd docs
 
-# Combine into a single schema
-prmd combine --meta meta.json  maps/ > schema.json
+### Single model
+```
+exe/generator generate_schema DRO
+```
 
-# Check it’s all good
-prmd verify schema.json
+## Testing
 
-# Build docs
-prmd doc schema.json > schema.md
-```
+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`.
+
+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`.
+
+## Using this gem
+
+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

@@ -23,14 +23,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'dry-struct', '~> 1.0'
   spec.add_dependency 'dry-types', '~> 1.1'
+  spec.add_dependency 'openapi3_parser' # Parsing openapi doc
+  spec.add_dependency 'openapi_parser' # Validating openapi requests
+  spec.add_dependency 'thor'
   spec.add_dependency 'zeitwerk', '~> 2.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'committee'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.74.0'
   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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+$LOAD_PATH.unshift 'lib'
+
+require 'cocina/models'
+
+Cocina::Generator::Generator.start(ARGV)

data/lib/cocina/generator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Cocina
+  # Module for generating Cocina models from openapi.
+  module Generator
+  end
+end

data/lib/cocina/generator/generator.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Generator
+    # Class for generating Cocina models from openapi.
+    class Generator < Thor
+      include Thor::Actions
+
+      class_option :openapi, desc: 'Path of openapi.yml', default: 'openapi.yml'
+      class_option :output, desc: 'Path for output', default: 'lib/cocina/models'
+
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      desc 'generate', 'generate for all schemas'
+      def generate
+        clean_output
+
+        schemas.keys.each do |schema_name|
+          schema = schema_for(schema_name)
+          generate_for(schema) if schema
+        end
+
+        generate_vocab
+      end
+
+      desc 'generate_schema SCHEMA_NAME', 'generate for SCHEMA_NAME'
+      def generate_schema(schema_name)
+        schema = schema_for(schema_name)
+        raise 'Cannot generate' if schema.nil?
+
+        FileUtils.mkdir_p(options[:output])
+
+        generate_for(schema)
+      end
+
+      desc 'generate_vocab', 'generate vocab'
+      def generate_vocab
+        vocab = Vocab.new(schemas)
+        filepath = "#{options[:output]}/#{vocab.filename}"
+        FileUtils.rm_f(filepath)
+
+        create_file filepath, vocab.generate
+        run("rubocop -a #{filepath}")
+      end
+
+      private
+
+      def schemas
+        @schemas ||= Openapi3Parser.load_file(options[:openapi]).components.schemas
+      end
+
+      def schema_for(schema_name)
+        schema_doc = schemas[schema_name]
+        return nil if schema_doc.nil? || schema_doc.type != 'object'
+
+        Schema.new(schema_doc)
+      end
+
+      def generate_for(schema)
+        filepath = "#{options[:output]}/#{schema.filename}"
+        FileUtils.rm_f(filepath)
+
+        create_file filepath, schema.generate
+        run("rubocop -a #{filepath}")
+      end
+
+      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")
+        FileUtils.rm_f(files)
+      end
+    end
+  end
+end

data/lib/cocina/generator/schema.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Generator
+    # Class for generating from an openapi schema
+    class Schema < SchemaBase
+      def schema_properties
+        @schema_properties ||= (properties + all_of_properties).uniq(&:key)
+      end
+
+      def generate
+        <<~RUBY
+          # frozen_string_literal: true
+
+          module Cocina
+            module Models
+              class #{name} < Struct
+
+                #{types}
+
+                #{model_attributes}
+
+                #{validate}
+              end
+            end
+          end
+        RUBY
+      end
+
+      private
+
+      def property_class_for(properties_doc)
+        case properties_doc.type
+        when 'object'
+          # As a useful simplification, all objects must be references to schemas.
+          raise "Must use a reference for #{schema_doc.inspect}" unless properties_doc.name
+
+          SchemaRef
+        when 'array'
+          SchemaArray
+        else
+          SchemaValue
+        end
+      end
+
+      def model_attributes
+        schema_properties.map(&:generate).join("\n")
+      end
+
+      def types
+        type_properties_doc = schema_doc.properties['type']
+        return '' if type_properties_doc.nil? || type_properties_doc.enum.nil?
+
+        types_list = type_properties_doc.enum.map { |item| "'#{item}'" }.join(",\n ")
+
+        <<~RUBY
+          include Checkable
+
+          TYPES = [#{types_list}].freeze
+        RUBY
+      end
+
+      def validate
+        return '' unless validatable?
+
+        <<~RUBY
+          def self.new(attributes = default_attributes, safe = false, validate = true, &block)
+            Validator.validate(self, attributes.with_indifferent_access) if validate && name
+            super(attributes, safe, &block)
+                end
+        RUBY
+      end
+
+      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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Generator
+    # Class for generating from an openapi array
+    class SchemaArray < SchemaBase
+      def generate
+        "attribute :#{name.camelize(:lower)}, Types::Strict::Array.of(#{array_of_type})#{omittable}"
+      end
+
+      def omittable
+        if required
+          '.default([].freeze)'
+        else
+          '.meta(omittable: true)'
+        end
+      end
+
+      def array_of_type
+        schema_doc.items.name || "Types::#{dry_datatype(schema_doc.items)}"
+      end
+    end
+  end
+end