cocina-models 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 918a0472029fa8a0ca3b66adb2984203f3d830ee30c449f44d9d3fa6a1ba7592
-  data.tar.gz: 1bb461d3aba413ceb273912c34abb20c87aae08fdece11356ccff6ef44b22415
+  metadata.gz: d545662f72b0cc61f2d380d2a659b5eceedd07261e3bbcbf093748bb83313921
+  data.tar.gz: 0e7dfe39087cf1550e6d5ec421cfc19247e1345dc1ccc6789936a11b5f48f143
 SHA512:
-  metadata.gz: 245d6b97f84147c73c61404527d5bef0f3b3dccf8c18bf9d02183f65a3e5111af300c5b964e006c3bd547e3bd5de134ed5c4b8de3ca7242ae4430c4901ef0d05
-  data.tar.gz: 4c5cc681c427448de988238584d37986c6af158c553ebdf8fe7cbbbca118d4e946cd8d0bed5031a9b35f29a0c4f3ac99f3846db39662daa948332b14e3914fc0
+  metadata.gz: 87e6e541b2de60c90a0a788367cef62a1c3d55ab8f2bbf687fd85a1198a025e81fe2ccd258a1cc59ce5bbcaa1dbfe3020aa8c687cba29d813af5e9df09df9c97
+  data.tar.gz: b35a5fecfbcef1376ca2d61d7b046787814c6a0a106fa4625fff4c6c024dab56803426f5253e36bfd2ed9723c6ea8363480ee88323ba74efce436d00cbf41509

data/.rubocop.yml

@@ -12,7 +12,7 @@ Metrics/LineLength:
   Max: 114
 
 Metrics/MethodLength:
-  Max: 13
+  Max: 14
 
 RSpec/MultipleExpectations:
   Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-10-24 15:36:09 -0500 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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 2
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/cocina/models/dro_spec.rb'
+    - 'spec/cocina/models/file_spec.rb'

data/docs/maps/File.json

@@ -34,7 +34,21 @@
     },
     "hasMessageDigests": {
       "description": "The output of the message digest algorithm.",
-      "type": "object"
+      "type": "array",
+      "items": {
+        "required": ["type", "digest"],
+        "properties": {
+          "type": {
+            "description": "The algorithm that was used",
+            "type": "string",
+            "enum": ["md5", "sha1"]
+          },
+          "digest": {
+            "description": "The digest value",
+            "type": "string"
+          }
+        }
+      }
     },
     "hasMimeType": {
       "description": "MIME Type of the File.",
@@ -46,7 +60,17 @@
     },
     "presentation": {
       "description": "Presentation data for the File.",
-      "type": "object"
+      "type": "object",
+      "properties": {
+        "height": {
+          "description": "Height in pixels",
+          "type": "integer",
+        },
+        "width": {
+          "description": "Width in pixels",
+          "type": "integer",
+        },
+      }
     },
     "size": {
       "description": "Size of the File (binary) in bytes.",

data/docs/maps/Fileset.json

@@ -121,6 +121,13 @@
       "type": "object",
       "required": ["isContainedBy"],
       "properties": {
+        "contains": {
+          "description": "Files that are members of the fileset.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
         "isContainedBy": {
           "description": "Parent DRO that is represented by the files in this Fileset.",
           "type": "string"

data/lib/cocina/models/dro.rb

@@ -66,7 +66,15 @@ module Cocina
       class Identification < Dry::Struct
       end
 
+      # Structural sub-schema for the DRO
       class Structural < Dry::Struct
+        attribute :contains, Types::Strict::Array.of(Types::Coercible::String).meta(omittable: true)
+
+        def self.from_dynamic(dyn)
+          params = {}
+          params[:contains] = dyn['contains'] if dyn['contains']
+          Structural.new(params)
+        end
       end
 
       attribute :externalIdentifier, Types::Strict::String
@@ -88,6 +96,7 @@ module Cocina
 
         params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
         params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
+        params[:structural] = Structural.from_dynamic(dyn['structural']) if dyn['structural']
 
         DRO.new(params)
       end

data/lib/cocina/models/file.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'json'
+
+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
+      ].freeze
+
+      class Identification < Dry::Struct
+      end
+
+      class Structural < Dry::Struct
+      end
+
+      # Represents a digest value for a file
+      class Fixity < Dry::Struct
+        attribute :type, Types::String.enum('md5', 'sha1')
+        attribute :digest, Types::Strict::String
+
+        def self.from_dynamic(dyn)
+          params = {
+            type: dyn['type'],
+            digest: dyn['digest']
+          }
+
+          Fixity.new(params)
+        end
+      end
+
+      # Represents some technical aspect of the file
+      class Presentation < Dry::Struct
+        attribute :height, Types::Coercible::Integer.optional.default(nil)
+        attribute :width, Types::Coercible::Integer.optional.default(nil)
+
+        def self.from_dynamic(dyn)
+          params = {
+            height: dyn['height'],
+            width: dyn['width']
+          }
+
+          Presentation.new(params)
+        end
+      end
+
+      attribute :externalIdentifier, Types::Strict::String
+      attribute :type, Types::String.enum(*TYPES)
+      attribute :label, Types::Strict::String
+      attribute :filename, Types::String.optional.default(nil)
+      attribute :use, Types::String.enum('original', 'preservation', 'access').optional.default(nil)
+      attribute :size, Types::Coercible::Integer.optional.default(nil)
+      attribute :hasMessageDigests, Types::Strict::Array.of(Fixity).default([])
+      attribute :presentation, Presentation.optional.default(Presentation.new)
+      attribute :version, Types::Coercible::Integer
+      attribute(:identification, Identification.default { Identification.new })
+      attribute(:structural, Structural.default { Structural.new })
+
+      def self.from_dynamic(dyn)
+        params = {
+          externalIdentifier: dyn['externalIdentifier'],
+          type: dyn['type'],
+          label: dyn['label'],
+          version: dyn['version'],
+          size: dyn['size'],
+          use: dyn['use']
+        }
+        params[:presentation] = Presentation.from_dynamic(dyn['presentation']) if dyn['presentation']
+        if dyn['hasMessageDigests']
+          params[:hasMessageDigests] = dyn['hasMessageDigests'].map { |p| Fixity.from_dynamic(p) }
+        end
+        File.new(params)
+      end
+
+      def self.from_json(json)
+        from_dynamic(JSON.parse(json))
+      end
+    end
+  end
+end

data/lib/cocina/models/file_set.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'json'
+
+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
+      ].freeze
+
+      class Identification < Dry::Struct
+      end
+
+      # Structural sub-schema for the FileSet
+      class Structural < Dry::Struct
+        attribute :contains, Types::Strict::Array.of(Types::Coercible::String).meta(omittable: true)
+
+        def self.from_dynamic(dyn)
+          params = {}
+          params[:contains] = dyn['contains'] if dyn['contains']
+          Structural.new(params)
+        end
+      end
+
+      attribute :externalIdentifier, Types::Strict::String
+      attribute :type, Types::String.enum(*TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Coercible::Integer
+      attribute(:identification, Identification.default { Identification.new })
+      attribute(:structural, Structural.default { Structural.new })
+
+      def self.from_dynamic(dyn)
+        params = {
+          externalIdentifier: dyn['externalIdentifier'],
+          type: dyn['type'],
+          label: dyn['label'],
+          version: dyn['version'],
+          size: dyn['size'],
+          use: dyn['use']
+        }
+        params[:presentation] = Presentation.from_dynamic(dyn['presentation']) if dyn['presentation']
+        if dyn['hasMessageDigests']
+          params[:hasMessageDigests] = dyn['hasMessageDigests'].map { |p| Fixity.from_dynamic(p) }
+        end
+        params[:structural] = Structural.from_dynamic(dyn['structural']) if dyn['structural']
+
+        FileSet.new(params)
+      end
+
+      def self.from_json(json)
+        from_dynamic(JSON.parse(json))
+      end
+    end
+  end
+end

data/lib/cocina/models/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -157,6 +157,8 @@ files:
 - lib/cocina/models/admin_policy.rb
 - lib/cocina/models/collection.rb
 - lib/cocina/models/dro.rb
+- lib/cocina/models/file.rb
+- 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