cocina-models 0.22.1 → 0.22.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cd29c6b992de9819fa82a626bcafdea8f0f1e51b4560fa7d291cd4678fb41af
-  data.tar.gz: ee995bb6243004e09108a727f8bf8024c78387232f1915d3e2cdc3d4ad071729
+  metadata.gz: 93d0b9a2418a1c864d36b39293f1e89935519609a9e592594494bc332c0cf601
+  data.tar.gz: 59d36afc29361ed9fb1c8d26eb4506bf60b13f697a246a482ac08ef89adaf12c
 SHA512:
-  metadata.gz: 61268bb2e1ebf706e77f63878f82529910904efc8e549ccb9a6447dd53bcc7d28ff14f2d5b73f716791df9bdef6eea261e6b54145313a8640822a90386904187
-  data.tar.gz: 6280645ddd62135e4e8b0a283c724a5b4dbadd737f2840f83549ccd60b5094bb47d8ca10bcbfdbf95184a7228083696a6e73a0df6a6de1a45fdc0fb73b1319dc
+  metadata.gz: e0b4a1d3455d766b58fd3888b84917844a1854e1949bfc201089cfe88eb5893863f2f6d479fe33ddd62165feba1b3777bf5cb5d688f90a48ca6ec7099e92918b
+  data.tar.gz: 58d2204a1b24673dd719c51ee1b2623e48a94f6d72b47aea4a33ae1a7687d58ff13ccc3e01f47e919b30bedeb6f8f48709e03b072cde91b695683598a15b7d9e

data/docs/maps/Sequence.json

@@ -31,6 +31,16 @@
       "items": {
         "type": "string"
       }
+    },
+    "viewingDirection": {
+      "description": "The direction that a sequence of canvases should be displayed to the user",
+      "type": "string",
+      "enum": [
+        "left-to-right",
+        "right-to-left",
+        "top-to-bottom",
+        "bottom-to-top"
+      ]
     }
   }
 }

data/docs/schema.json

@@ -1548,6 +1548,18 @@
               "string"
             ]
           }
+        },
+        "viewingDirection": {
+          "description": "The direction that a sequence of canvases should be displayed to the user",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "left-to-right",
+            "right-to-left",
+            "top-to-bottom",
+            "bottom-to-top"
+          ]
         }
       }
     },

data/docs/schema.md

@@ -62,7 +62,7 @@ A group of Digital Repository Objects that indicate some type of conceptual grou
 | **precedingVersion** | *string* | Preceding version for the Collection within SDR. | `"example"` |
 | **structural:hasAgreement** | *string* | Agreement that covers the deposit of the Collection into SDR. | `"example"` |
 | **structural:hasMember** | *array* | Component digital repository objects or collections that are a part of this collection. | `[null]` |
-| **structural:hasMemberOrders** | *array* | Provided sequences or orderings of members of the Collection, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null]}]` |
+| **structural:hasMemberOrders** | *array* | Provided sequences or orderings of members of the Collection, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null],"viewingDirection":"left-to-right"}]` |
 | **structural:isTargetOf** | *string* | An Annotation instance that applies to the Collection. | `"example"` |
 | **version** | *integer* | Version for the Collection within SDR. | `42` |
 
@@ -122,7 +122,7 @@ Domain-defined abstraction of a 'work'. Digital Repository Objects' abstraction
 | **structural:contains** | *array* | Filesets that contain the digital representations (Files) of the DRO. | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/fileset.jsonld","depositor":{"name":"example","sunetID":"example"},"label":"example","externalIdentifier":"example","internalIdentifier":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"identifier":"example","sdrUUID":"example"},"structural":{"contains":[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/file.jsonld","depositor":{"name":"example","sunetID":"example"},"externalIdentifier":"example","filename":"example","format":"example","hasMessageDigests":[{"type":"md5","digest":"example"}],"hasMimeType":"example","label":"example","presentation":{"height":42,"width":42},"size":42,"internalIdentifier":"example","use":"example","version":42,"precedingVersion":"example","followingVersion":"example","access":{"access":"world","download":"world"},"administrative":{"created":"2015-01-01T12:00:00Z","deleted":true,"gravestoneMessage":"example","lastUpdated":"2015-01-01T12:00:00Z","partOfProject":"example","sdrPreserve":true,"shelve":true,"remediatedBy":[{"name":"example","sunetID":"example"}]},"identification":{"filename":"example","identifier":"example","sdrUUID":"example"},"structural":{"isContainedBy":"example","isTargetOf":"example"}}],"isContainedBy":"example","isTargetOf":"example"}}]` |
 | **structural:hasAgreement** | *string* | Agreement that covers the deposit of the DRO into SDR. | `"example"` |
 | **structural:hasMember** | *array* | Component or 'children' digital repository objects that are a part or portion of this 'parent' or aggregate DRO. | `[null]` |
-| **structural:hasMemberOrders** | *array* | Provided sequences or orderings of members of the Object, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null]}]` |
+| **structural:hasMemberOrders** | *array* | Provided sequences or orderings of members of the Object, including some metadata about each sequence (i.e. sequence label, sequence type, if the sequence is primary, etc.). | `[{"@context":"example","@type":"http://cocina.sul.stanford.edu/models/sequence.jsonld","label":"example","startMember":"example","members":[null],"viewingDirection":"left-to-right"}]` |
 | **structural:isMemberOf** | *string* | Collection that this DRO is a member of | `"example"` |
 | **structural:isTargetOf** | *string* | An Annotation instance that applies to the DRO. | `"example"` |
 | **version** | *integer* | Version for the DRO within SDR. | `42` |
@@ -250,6 +250,7 @@ A sequence or ordering of resources within a Collection or Object.
 | **label** | *string* | Label for the sequence or ordering. | `"example"` |
 | **members** | *array* | Identifiers for Members in their stated Order for the Sequence. | `[null]` |
 | **startMember** | *string* | Identifier for the first member of the sequence. | `"example"` |
+| **viewingDirection** | *string* | The direction that a sequence of canvases should be displayed to the user<br/> **one of:**`"left-to-right"` or `"right-to-left"` or `"top-to-bottom"` or `"bottom-to-top"` | `"left-to-right"` |
 
 
 ## <a name="resource-Title">Title</a>

data/lib/cocina/models/admin_policy.rb

@@ -69,7 +69,7 @@ module Cocina
       attribute(:administrative, Administrative.default { Administrative.new })
       # Allowing description to be omittable for now (until rolled out to consumers),
       # but I think it's actually required for every DRO
-      attribute :description, Description.optional.default(nil)
+      attribute :description, Description.optional.meta(omittable: true)
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
 

data/lib/cocina/models/collection.rb

@@ -16,6 +16,8 @@ module Cocina
 
       # Subschema for access concerns
       class Access < Struct
+        attribute :access, Types::String.default('dark')
+                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
       end
 
       # Subschema for administrative concerns
@@ -42,7 +44,7 @@ module Cocina
       attribute(:administrative, Administrative.default { Administrative.new })
       # Allowing description to be omittable for now (until rolled out to consumers),
       # but I think it's actually required for every DRO
-      attribute :description, Description.optional.default(nil)
+      attribute :description, Description.optional.meta(omittable: true)
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
 

data/lib/cocina/models/dro.rb

@@ -34,6 +34,8 @@ module Cocina
         end
 
         attribute :embargo, Embargo.optional.meta(omittable: true)
+        attribute :access, Types::String.default('dark')
+                                        .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
       end
 
       # Subschema for administrative concerns
@@ -54,6 +56,7 @@ module Cocina
       class Structural < Struct
         attribute :contains, Types::Strict::Array.of(FileSet).meta(omittable: true)
         attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
+        attribute :hasMemberOrders, Types::Strict::Array.of(Sequence).meta(omittable: true)
       end
 
       attribute :externalIdentifier, Types::Strict::String
@@ -64,7 +67,7 @@ module Cocina
       attribute(:administrative, Administrative.default { Administrative.new })
       # Allowing description to be omittable for now (until rolled out to consumers),
       # but I think it's actually required for every DRO
-      attribute :description, Description.optional.default(nil)
+      attribute :description, Description.optional.meta(omittable: true)
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
 

data/lib/cocina/models/request_admin_policy.rb

@@ -12,7 +12,7 @@ module Cocina
       attribute(:administrative, AdminPolicy::Administrative.default { AdminPolicy::Administrative.new })
       # Allowing description to be omittable for now (until rolled out to consumers),
       # but I think it's actually required for every DRO
-      attribute :description, Description.optional.default(nil)
+      attribute :description, Description.optional.meta(omittable: true)
       attribute(:identification, AdminPolicy::Identification.default { AdminPolicy::Identification.new })
       attribute(:structural, AdminPolicy::Structural.default { AdminPolicy::Structural.new })
 

data/lib/cocina/models/request_collection.rb

@@ -13,7 +13,7 @@ module Cocina
       attribute(:administrative, Collection::Administrative.default { Collection::Administrative.new })
       # Allowing description to be omittable for now (until rolled out to consumers),
       # but I think it's actually required for every DRO
-      attribute :description, Description.optional.default(nil)
+      attribute :description, Description.optional.meta(omittable: true)
       attribute(:identification, Collection::Identification.default { Collection::Identification.new })
       attribute(:structural, Collection::Structural.default { Collection::Structural.new })
 

data/lib/cocina/models/request_dro.rb

@@ -13,7 +13,7 @@ module Cocina
       attribute(:administrative, DRO::Administrative.default { DRO::Administrative.new })
       # Allowing description to be omittable for now (until rolled out to consumers),
       # but I think it's actually required for every DRO
-      attribute :description, Description.optional.default(nil)
+      attribute :description, Description.optional.meta(omittable: true)
       attribute(:identification, DRO::Identification.default { DRO::Identification.new })
       attribute(:structural, DRO::Structural.default { DRO::Structural.new })
 

data/lib/cocina/models/sequence.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # Metadata for a sequence.  See http://sul-dlss.github.io/cocina-models/maps/Sequence.json
+    class Sequence < Struct
+      attribute :viewingDirection, Types::String.enum('left-to-right',
+                                                      'right-to-left',
+                                                      'top-to-bottom',
+                                                      'bottom-to-top').optional
+    end
+  end
+end

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.22.1'
+    VERSION = '0.22.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.22.1
+  version: 0.22.2
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -188,6 +188,7 @@ files:
 - lib/cocina/models/request_admin_policy.rb
 - lib/cocina/models/request_collection.rb
 - lib/cocina/models/request_dro.rb
+- lib/cocina/models/sequence.rb
 - lib/cocina/models/types.rb
 - lib/cocina/models/version.rb
 - lib/cocina/models/vocab.rb