cocina-models 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d545662f72b0cc61f2d380d2a659b5eceedd07261e3bbcbf093748bb83313921
-  data.tar.gz: 0e7dfe39087cf1550e6d5ec421cfc19247e1345dc1ccc6789936a11b5f48f143
+  metadata.gz: 2e7900ad5ccfc3731276f0fbe6e27d77094b72b309e461206c46f41ff9b9a09d
+  data.tar.gz: d5b1fbbd90d37daa1ac3538be417ae5ea61a8c7ec130ddbae842bb6d541fa806
 SHA512:
-  metadata.gz: 87e6e541b2de60c90a0a788367cef62a1c3d55ab8f2bbf687fd85a1198a025e81fe2ccd258a1cc59ce5bbcaa1dbfe3020aa8c687cba29d813af5e9df09df9c97
-  data.tar.gz: b35a5fecfbcef1376ca2d61d7b046787814c6a0a106fa4625fff4c6c024dab56803426f5253e36bfd2ed9723c6ea8363480ee88323ba74efce436d00cbf41509
+  metadata.gz: fdc52de4683d5e72207fe93902ecf207b2dea375be47d32599f69d2b11b9147cb27287032f6d1d7e87af991471c0680c23cc59927baa70cc62cc04cfb03ff8c3
+  data.tar.gz: 173b81c88469efcc665af88943389a155e4c98f5de726c5087c8f44e59e313a26f5f3be22848d65ffdb269337ef987b91be328a2fd7107e1ccc16c5637b750de

data/.github/pull_request_template.md

@@ -0,0 +1,5 @@
+## Why was this change made?
+
+
+
+## Was the documentation (README, wiki) updated?

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-10-24 15:36:09 -0500 using RuboCop version 0.74.0.
+# on 2020-01-13 15:35:17 -0800 using RuboCop version 0.74.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -10,11 +10,6 @@
 Metrics/AbcSize:
   Max: 18
 
-# Offense count: 1
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 14
-
 # Offense count: 2
 # Configuration parameters: Max.
 RSpec/ExampleLength:

data/.travis.yml

@@ -4,8 +4,20 @@ language: ruby
 cache: bundler
 rvm:
   - 2.5.3
-before_install: gem install bundler -v 2.0.1
+  - 2.6.4
+before_install: gem install bundler -v 2.1.4
 
-script:
-  - bundle exec rspec
-  - bundle exec rubocop
+before_script:
+  - 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
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  email: false
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=882e943342bed5285a6078be9a41b7738ae7ebd17458c08414581cbece99b8e6

data/README.md

@@ -1,7 +1,12 @@
+[![Build Status](https://travis-ci.com/sul-dlss/cocina-models.svg?branch=master)](https://travis-ci.com/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)
 
 # 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.
+
 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).

data/Rakefile

@@ -2,7 +2,10 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+desc 'Run linter and tests'
+task default: %i[rubocop spec]

data/cocina-models.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'Data models for the SDR'
   spec.description   = 'SDR data models that can be validated'
-  spec.homepage      = 'https://github.com/sul-dlss-labs/cocina-models'
+  spec.homepage      = 'https://github.com/sul-dlss/cocina-models'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   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'
 end

data/docs/cocina-base.jsonld

@@ -0,0 +1,24 @@
+{
+  "@context": {
+        "type": "@type",
+        "id": "@id",
+        "@vocab": "http://cocina.sul.stanford.edu/contexts/cocina-base.jsonld",
+        "cocina": "http://cocina.sul.stanford.edu/models/",
+        "Book": {"@id": "cocina:Book"}
+        "3D": {"@id": "cocina:3D"}
+        "Agreement": {"@id": "cocina:Agreement"}
+        "Document": {"@id": "cocina:Document"}
+        "Collection": {"@id": "cocina:Collection"}
+        "Fileset": {"@id": "cocina:Fileset"}
+        "Geo": {"@id": "cocina:Geo"}
+        "Image": {"@id": "cocina:Image"}
+        "Page": {"@id": "cocina:Page"}
+        "Photograph": {"@id": "cocina:Photograph"}
+        "Manuscript": {"@id": "cocina:Manuscript"}
+        "Map": {"@id": "cocina:Map"}
+        "Media": {"@id": "cocina:Media"}
+        "Track": {"@id": "cocina:Track"}
+        "WebarchiveBinary": {"@id": "cocina:WebarchiveBinary"}
+        "WebarchiveSeed": {"@id": "cocina:WebarchiveSeed"}
+  }
+}

data/docs/maps/File.json

@@ -144,6 +144,10 @@
           "description": "If this resource should be sent to Preservation.",
           "type": "boolean"
         },
+        "shelve": {
+          "description": "If this resource should be sent to Stacks.",
+          "type": "boolean"
+        },
         "remediatedBy": {
           "description": "The Agent (User, Group, Application, Department, other) that remediated this File in SDR.",
           "type": "array",

data/lib/cocina/models/admin_policy.rb

@@ -6,7 +6,9 @@ module Cocina
   module Models
     # An admin policy object.
     class AdminPolicy < Dry::Struct
-      TYPES = %w[http://cocina.sul.stanford.edu/models/admin_policy.jsonld].freeze
+      TYPES = [
+        Vocab.admin_policy
+      ].freeze
 
       # Subschema for access concerns
       class Access < Dry::Struct

data/lib/cocina/models/collection.rb

@@ -6,11 +6,13 @@ module Cocina
   module Models
     # A digital repository collection.  See http://sul-dlss.github.io/cocina-models/maps/Collection.json
     class Collection < Dry::Struct
-      TYPES = %w[http://cocina.sul.stanford.edu/models/collection.jsonld
-                 http://cocina.sul.stanford.edu/models/curated-collection.jsonld
-                 http://cocina.sul.stanford.edu/models/user-collection.jsonld
-                 http://cocina.sul.stanford.edu/models/exhibit.jsonld
-                 http://cocina.sul.stanford.edu/models/series.jsonld].freeze
+      TYPES = [
+        Vocab.collection,
+        Vocab.curated_collection,
+        Vocab.user_collection,
+        Vocab.exhibit,
+        Vocab.series
+      ].freeze
 
       # Subschema for access concerns
       class Access < Dry::Struct

data/lib/cocina/models/dro.rb

@@ -6,23 +6,24 @@ module Cocina
   module Models
     # A digital repository object.  See http://sul-dlss.github.io/cocina-models/maps/DRO.json
     class DRO < Dry::Struct
-      TYPES = %w[
-        http://cocina.sul.stanford.edu/models/object.jsonld
-        http://cocina.sul.stanford.edu/models/3d.jsonld
-        http://cocina.sul.stanford.edu/models/agreement.jsonl
-        http://cocina.sul.stanford.edu/models/book.jsonld
-        http://cocina.sul.stanford.edu/models/document.jsonld
-        http://cocina.sul.stanford.edu/models/geo.jsonld
-        http://cocina.sul.stanford.edu/models/image.jsonld
-        http://cocina.sul.stanford.edu/models/page.jsonld
-        http://cocina.sul.stanford.edu/models/photograph.jsonld
-        http://cocina.sul.stanford.edu/models/manuscript.jsonld
-        http://cocina.sul.stanford.edu/models/map.jsonld
-        http://cocina.sul.stanford.edu/models/media.jsonld
-        http://cocina.sul.stanford.edu/models/track.jsonld
-        http://cocina.sul.stanford.edu/models/webarchive-binary.jsonld
-        http://cocina.sul.stanford.edu/models/webarchive-seed.jsonld
+      TYPES = [
+        Vocab.object,
+        Vocab.three_dimensional,
+        Vocab.agreement,
+        Vocab.book,
+        Vocab.document,
+        Vocab.geo,
+        Vocab.image,
+        Vocab.page,
+        Vocab.photograph,
+        Vocab.manuscript,
+        Vocab.map,
+        Vocab.media,
+        Vocab.track,
+        Vocab.webarchive_binary,
+        Vocab.webarchive_seed
       ].freeze
+
       # Subschema for release tags
       class ReleaseTag < Dry::Struct
         attribute :to, Types::Strict::String
@@ -104,6 +105,10 @@ module Cocina
       def self.from_json(json)
         from_dynamic(JSON.parse(json))
       end
+
+      def image?
+        type == Vocab.image
+      end
     end
   end
 end

data/lib/cocina/models/file.rb

@@ -6,8 +6,8 @@ module Cocina
   module Models
     # Metadata for a file.  See http://sul-dlss.github.io/cocina-models/maps/File.json
     class File < Dry::Struct
-      TYPES = %w[
-        http://cocina.sul.stanford.edu/models/file.jsonld
+      TYPES = [
+        Vocab.file
       ].freeze
 
       class Identification < Dry::Struct

data/lib/cocina/models/file_set.rb

@@ -6,8 +6,8 @@ module Cocina
   module Models
     # Metadata for a File Set.  See http://sul-dlss.github.io/cocina-models/maps/Fileset.json
     class FileSet < Dry::Struct
-      TYPES = %w[
-        http://cocina.sul.stanford.edu/models/fileset.jsonld
+      TYPES = [
+        Vocab.fileset
       ].freeze
 
       class Identification < Dry::Struct

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.7.0'
+    VERSION = '0.8.0'
   end
 end

data/lib/cocina/models/vocab.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # A digital repository object.  See http://sul-dlss.github.io/cocina-models/maps/DRO.json
+    class Vocab
+      ROOT = 'http://cocina.sul.stanford.edu/models/'
+
+      ### Object types ###
+
+      # This is the most generic type
+      def self.object
+        "#{ROOT}object.jsonld"
+      end
+
+      def self.agreement
+        "#{ROOT}agreement.jsonld"
+      end
+
+      def self.document
+        "#{ROOT}document.jsonld"
+      end
+
+      def self.geo
+        "#{ROOT}geo.jsonld"
+      end
+
+      def self.page
+        "#{ROOT}page.jsonld"
+      end
+
+      def self.photograph
+        "#{ROOT}photograph.jsonld"
+      end
+
+      def self.manuscript
+        "#{ROOT}manuscript.jsonld"
+      end
+
+      def self.map
+        "#{ROOT}map.jsonld"
+      end
+
+      def self.track
+        "#{ROOT}track.jsonld"
+      end
+
+      def self.webarchive_binary
+        "#{ROOT}webarchive-binary.jsonld"
+      end
+
+      def self.webarchive_seed
+        "#{ROOT}webarchive-seed.jsonld"
+      end
+
+      # For time based media
+      def self.media
+        "#{ROOT}media.jsonld"
+      end
+
+      def self.image
+        "#{ROOT}image.jsonld"
+      end
+
+      def self.book
+        "#{ROOT}book.jsonld"
+      end
+
+      def self.three_dimensional
+        "#{ROOT}3d.jsonld"
+      end
+
+      ### File type ###
+
+      def self.file
+        "#{ROOT}file.jsonld"
+      end
+
+      ### Fileset type ###
+
+      def self.fileset
+        "#{ROOT}fileset.jsonld"
+      end
+
+      ### Collection types ###
+
+      # The most generic type of collection
+      def self.collection
+        "#{ROOT}collection.jsonld"
+      end
+
+      def self.curated_collection
+        "#{ROOT}curated-collection.jsonld"
+      end
+
+      def self.user_collection
+        "#{ROOT}user-collection.jsonld"
+      end
+
+      def self.exhibit
+        "#{ROOT}exhibit.jsonld"
+      end
+
+      def self.series
+        "#{ROOT}series.jsonld"
+      end
+
+      ### Admin Policy type ###
+
+      def self.admin_policy
+        "#{ROOT}admin_policy.jsonld"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-28 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: SDR data models that can be validated
 email:
 - jcoyne@justincoyne.com
@@ -129,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -142,6 +157,7 @@ files:
 - cocina-models.gemspec
 - docs/README.md
 - docs/_config.yml
+- docs/cocina-base.jsonld
 - docs/maps/Agent.json
 - docs/maps/Collection.json
 - docs/maps/DRO.json
@@ -161,7 +177,8 @@ files:
 - lib/cocina/models/file_set.rb
 - lib/cocina/models/types.rb
 - lib/cocina/models/version.rb
-homepage: https://github.com/sul-dlss-labs/cocina-models
+- lib/cocina/models/vocab.rb
+homepage: https://github.com/sul-dlss/cocina-models
 licenses: []
 metadata: {}
 post_install_message: 
@@ -179,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Data models for the SDR