cocina-models 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaac4eacd465708a36f6f62f975cf1af58eb17015ada6ce45785564547ab4e0e
-  data.tar.gz: 521e3b949290b6f61fd8a2b83ed984ae2fc4a5e5598ea3eab3a42765cf311218
+  metadata.gz: db9943bd397ca96d689ba22f2d9b5f47167d24c1a00ebe140129189bc2ac870c
+  data.tar.gz: cb1842b31d65dab3f9bf49f7ea9c228e1af92e50cbb3b4e9143d444210f26509
 SHA512:
-  metadata.gz: 51b3220584a9ac5ddfb75522b1def45b1f6f661f4fdb6259582f162b91db7d6b558f4dc9e6a752d9d85b49d4e6b622827397ff5612a97de4e0bee6cc6408c2e6
-  data.tar.gz: 2c0b9891af645153ddeb6c4ad4dec22c1af8fb413c6a47f546baf641c4b7a2e404fcdc31fd0fcec0ed219d2e23bde03f54366ec35248f8c1af81c6280cc67baa
+  metadata.gz: e104cabd5dc7d865028e13b90bc4646cc25d9a5b2a297156f4452f28c245bf66a9b864fe39fa8a00455f1d00063c3a780b6d5c7ff9ed40d95462a819a7c22171
+  data.tar.gz: a9d176f0df5c1f80a0532c0877973539e4550967eda88d7b0a0fab4d74db413692f58822d8a15037bb672dd3c53b8808707d2349aedf908d108a14de574ca11c

data/lib/cocina/models.rb

@@ -36,6 +36,11 @@ module Cocina
     # Raised when the type attribute is not valid.
     class UnknownTypeError < Error; end
 
+    # Base class for Cocina Structs
+    class Struct < Dry::Struct
+      transform_keys(&:to_sym)
+    end
+
     # @param [Hash] dyn a ruby hash representation of the JSON serialization of a collection or DRO
     # @return [DRO,Collection]
     # @raises [UnknownTypeError] if a valid type is not found in the data

data/lib/cocina/models/admin_policy.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     # An admin policy object.
-    class AdminPolicy < Dry::Struct
+    class AdminPolicy < Struct
       include Checkable
 
       TYPES = [
@@ -11,15 +11,11 @@ module Cocina
       ].freeze
 
       # Subschema for access concerns
-      class Access < Dry::Struct
-        def self.from_dynamic(_dyn)
-          params = {}
-          Access.new(params)
-        end
+      class Access < Struct
       end
 
       # Subschema for administrative concerns
-      class Administrative < Dry::Struct
+      class Administrative < Struct
         # This was copied from the ActiveFedora defaults: Dor::AdminPolicyObject.new.defaultObjectRights.content
         DEFAULT_OBJECT_RIGHTS = <<~XML
           <?xml version="1.0" encoding="UTF-8"?>
@@ -57,21 +53,12 @@ module Cocina
         # Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
         # but I think it's actually required for every Admin Policy
         attribute :hasAdminPolicy, Types::Coercible::String.optional.default(nil)
-
-        def self.from_dynamic(dyn)
-          params = {
-            default_object_rights: dyn['default_object_rights'],
-            registration_workflow: dyn['registration_workflow']
-          }
-          params[:hasAdminPolicy] = dyn['hasAdminPolicy']
-          Administrative.new(params)
-        end
       end
 
-      class Identification < Dry::Struct
+      class Identification < Struct
       end
 
-      class Structural < Dry::Struct
+      class Structural < Struct
       end
 
       attribute :externalIdentifier, Types::Strict::String
@@ -87,7 +74,7 @@ module Cocina
       attribute(:structural, Structural.default { Structural.new })
 
       def self.from_dynamic(dyn)
-        AdminPolicyBuilder.build(self, dyn)
+        AdminPolicy.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/catalog_link.rb

@@ -3,17 +3,9 @@
 module Cocina
   module Models
     # Metadata for a catalog link
-    class CatalogLink < Dry::Struct
+    class CatalogLink < Struct
       attribute :catalog, Types::Strict::String
       attribute :catalogRecordId, Types::Strict::String
-
-      def self.from_dynamic(dyn)
-        params = {
-          catalog: dyn['catalog'],
-          catalogRecordId: dyn['catalogRecordId']
-        }
-        CatalogLink.new(params)
-      end
     end
   end
 end

data/lib/cocina/models/collection.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     # A digital repository collection.  See http://sul-dlss.github.io/cocina-models/maps/Collection.json
-    class Collection < Dry::Struct
+    class Collection < Struct
       include Checkable
 
       TYPES = [
@@ -15,43 +15,23 @@ module Cocina
       ].freeze
 
       # Subschema for access concerns
-      class Access < Dry::Struct
-        def self.from_dynamic(_dyn)
-          params = {}
-          Access.new(params)
-        end
+      class Access < Struct
       end
 
       # Subschema for administrative concerns
-      class Administrative < Dry::Struct
+      class Administrative < Struct
         attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).default([].freeze)
         # Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
         # but I think it's actually required for every DRO
         attribute :hasAdminPolicy, Types::Coercible::String.optional.default(nil)
-
-        def self.from_dynamic(dyn)
-          params = {}
-          params[:releaseTags] = dyn['releaseTags'].map { |rt| ReleaseTag.from_dynamic(rt) } if dyn['releaseTags']
-          params[:hasAdminPolicy] = dyn['hasAdminPolicy']
-          Administrative.new(params)
-        end
       end
 
       # Identification sub-schema for the Collection
-      class Identification < Dry::Struct
+      class Identification < Struct
         attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
-
-        def self.from_dynamic(dyn)
-          params = {}
-          if dyn['catalogLinks']
-            params[:catalogLinks] = dyn['catalogLinks']
-                                    .map { |link| CatalogLink.from_dynamic(link) }
-          end
-          params
-        end
       end
 
-      class Structural < Dry::Struct
+      class Structural < Struct
       end
 
       attribute :externalIdentifier, Types::Strict::String
@@ -67,7 +47,7 @@ module Cocina
       attribute(:structural, Structural.default { Structural.new })
 
       def self.from_dynamic(dyn)
-        CollectionBuilder.build(self, dyn)
+        Collection.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/description.rb

@@ -3,26 +3,14 @@
 module Cocina
   module Models
     # Descriptive metadata.  See http://sul-dlss.github.io/cocina-models/maps/Description.json
-    class Description < Dry::Struct
+    class Description < Struct
       # Title element.  See http://sul-dlss.github.io/cocina-models/maps/Title.json
-      class Title < Dry::Struct
+      class Title < Struct
         attribute :primary, Types::Strict::Bool
         attribute :titleFull, Types::Strict::String
-
-        def self.from_dynamic(dyn)
-          Title.new(primary: dyn['primary'],
-                    titleFull: dyn['titleFull'])
-        end
       end
 
       attribute :title, Types::Strict::Array.of(Title)
-
-      def self.from_dynamic(dyn)
-        params = {
-          title: dyn.fetch('title').map { |title| Title.from_dynamic(title) }
-        }
-        Description.new(params)
-      end
     end
   end
 end

data/lib/cocina/models/dro.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     # A digital repository object.  See http://sul-dlss.github.io/cocina-models/maps/DRO.json
-    class DRO < Dry::Struct
+    class DRO < Struct
       include Checkable
 
       TYPES = [
@@ -25,57 +25,28 @@ module Cocina
       ].freeze
 
       # Subschema for access concerns
-      class Access < Dry::Struct
+      class Access < Struct
         attribute :embargoReleaseDate, Types::Params::DateTime.meta(omittable: true)
-
-        def self.from_dynamic(dyn)
-          params = {}
-          params[:embargoReleaseDate] = dyn['embargoReleaseDate'] if dyn['embargoReleaseDate']
-          Access.new(params)
-        end
       end
 
       # Subschema for administrative concerns
-      class Administrative < Dry::Struct
+      class Administrative < Struct
         attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true).default([].freeze)
         # Allowing hasAdminPolicy to be omittable for now (until rolled out to consumers),
         # but I think it's actually required for every DRO
         attribute :hasAdminPolicy, Types::Coercible::String.optional.default(nil)
-
-        def self.from_dynamic(dyn)
-          params = {}
-          params[:releaseTags] = dyn['releaseTags'].map { |rt| ReleaseTag.from_dynamic(rt) } if dyn['releaseTags']
-          params[:hasAdminPolicy] = dyn['hasAdminPolicy']
-          Administrative.new(params)
-        end
       end
 
       # Identification sub-schema for the DRO
-      class Identification < Dry::Struct
+      class Identification < Struct
         attribute :sourceId, Types::Strict::String.meta(omittable: true)
         attribute :catalogLinks, Types::Strict::Array.of(CatalogLink).meta(omittable: true)
-        def self.from_dynamic(dyn)
-          params = {}
-          params[:sourceId] = dyn['sourceId'] if dyn['sourceId']
-          if dyn['catalogLinks']
-            params[:catalogLinks] = dyn['catalogLinks']
-                                    .map { |link| CatalogLink.from_dynamic(link) }
-          end
-          params
-        end
       end
 
       # Structural sub-schema for the DRO
-      class Structural < Dry::Struct
+      class Structural < Struct
         attribute :contains, Types::Strict::Array.of(FileSet).meta(omittable: true)
         attribute :isMemberOf, Types::Strict::String.meta(omittable: true)
-
-        def self.from_dynamic(dyn)
-          params = {}
-          params[:isMemberOf] = dyn['isMemberOf'] if dyn['isMemberOf']
-          params[:contains] = dyn['contains'].map { |fs| FileSet.from_dynamic(fs) } if dyn['contains']
-          Structural.new(params)
-        end
       end
 
       attribute :externalIdentifier, Types::Strict::String
@@ -91,7 +62,7 @@ module Cocina
       attribute(:structural, Structural.default { Structural.new })
 
       def self.from_dynamic(dyn)
-        DROBuilder.build(self, dyn)
+        DRO.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/file.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     # Metadata for a file.  See http://sul-dlss.github.io/cocina-models/maps/File.json
-    class File < Dry::Struct
+    class File < Struct
       include Checkable
 
       TYPES = [
@@ -11,72 +11,33 @@ module Cocina
       ].freeze
 
       # Represents access controls on the file
-      class Access < Dry::Struct
+      class Access < Struct
         attribute :access, Types::String.default('dark')
                                         .enum('world', 'stanford', 'location-based', 'citation-only', 'dark')
-
-        def self.from_dynamic(dyn)
-          return unless dyn
-
-          params = {}
-          params[:access] = dyn['access'] if dyn['access']
-
-          Access.new(params)
-        end
       end
 
       # Represents the administration of the file
-      class Administrative < Dry::Struct
+      class Administrative < Struct
         attribute :sdrPreserve, Types::Params::Bool.optional.default(false)
         attribute :shelve, Types::Params::Bool.optional.default(false)
-
-        def self.from_dynamic(dyn)
-          return unless dyn
-
-          params = {
-            sdrPreserve: dyn['sdrPreserve'],
-            shelve: dyn['shelve']
-          }
-          Administrative.new(params)
-        end
       end
 
-      class Identification < Dry::Struct
+      class Identification < Struct
       end
 
-      class Structural < Dry::Struct
+      class Structural < Struct
       end
 
       # Represents a digest value for a file
-      class Fixity < Dry::Struct
+      class Fixity < 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
+      class Presentation < Struct
         attribute :height, Types::Coercible::Integer.optional.default(nil)
         attribute :width, Types::Coercible::Integer.optional.default(nil)
-
-        def self.from_dynamic(dyn)
-          return unless dyn
-
-          params = {
-            height: dyn['height'],
-            width: dyn['width']
-          }
-
-          Presentation.new(params)
-        end
       end
 
       attribute(:access, Access.optional.default { Access.new })
@@ -94,19 +55,7 @@ module Cocina
       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[:administrative] = Administrative.from_dynamic(dyn['administrative'])
-        params[:presentation] = Presentation.from_dynamic(dyn['presentation'])
-        params[:access] = Access.from_dynamic(dyn['access'])
-        params[:hasMessageDigests] = Array(dyn['hasMessageDigests']).map { |p| Fixity.from_dynamic(p) }
-        File.new(params)
+        File.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/file_set.rb

@@ -3,25 +3,19 @@
 module Cocina
   module Models
     # Metadata for a File Set.  See http://sul-dlss.github.io/cocina-models/maps/Fileset.json
-    class FileSet < Dry::Struct
+    class FileSet < Struct
       include Checkable
 
       TYPES = [
         Vocab.fileset
       ].freeze
 
-      class Identification < Dry::Struct
+      class Identification < Struct
       end
 
       # Structural sub-schema for the FileSet
-      class Structural < Dry::Struct
+      class Structural < Struct
         attribute :contains, Types::Strict::Array.of(Cocina::Models::File).meta(omittable: true)
-
-        def self.from_dynamic(dyn)
-          params = {}
-          params[:contains] = dyn['contains'].map { |f| Cocina::Models::File.from_dynamic(f) } if dyn['contains']
-          Structural.new(params)
-        end
       end
 
       attribute :externalIdentifier, Types::Strict::String
@@ -32,21 +26,7 @@ module Cocina
       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)
+        FileSet.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/release_tag.rb

@@ -3,7 +3,7 @@
 module Cocina
   module Models
     # Subschema for release tags
-    class ReleaseTag < Dry::Struct
+    class ReleaseTag < Struct
       attribute :to, Types::Strict::String.enum('Searchworks', 'Earthworks')
       attribute :what, Types::Strict::String.enum('self', 'collection')
       # we use 'when' other places, but that's reserved word, so 'date' it is!
@@ -12,11 +12,7 @@ module Cocina
       attribute :release, Types::Params::Bool
 
       def self.from_dynamic(dyn)
-        ReleaseTag.new(to: dyn['to'],
-                       what: dyn['what'],
-                       date: dyn['date'],
-                       who: dyn['who'],
-                       release: dyn['release'])
+        ReleaseTag.new(dyn)
       end
     end
   end

data/lib/cocina/models/request_admin_policy.rb

@@ -4,7 +4,7 @@ module Cocina
   module Models
     # An request to create an AdminPolicy object.
     # This is the same as AdminPolicy, except it doesn't have externalIdentifier.
-    class RequestAdminPolicy < Dry::Struct
+    class RequestAdminPolicy < Struct
       attribute :type, Types::String.enum(*AdminPolicy::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Coercible::Integer
@@ -17,7 +17,7 @@ module Cocina
       attribute(:structural, AdminPolicy::Structural.default { AdminPolicy::Structural.new })
 
       def self.from_dynamic(dyn)
-        AdminPolicyBuilder.build(self, dyn)
+        RequestAdminPolicy.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/request_collection.rb

@@ -5,7 +5,7 @@ module Cocina
     # A request to create a digital repository collection.
     # This is the same as Collection, except it doesn't have externalIdentifier.
     # See http://sul-dlss.github.io/cocina-models/maps/Collection.json
-    class RequestCollection < Dry::Struct
+    class RequestCollection < Struct
       attribute :type, Types::String.enum(*Collection::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Coercible::Integer
@@ -18,7 +18,7 @@ module Cocina
       attribute(:structural, Collection::Structural.default { Collection::Structural.new })
 
       def self.from_dynamic(dyn)
-        CollectionBuilder.build(self, dyn)
+        RequestCollection.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/request_dro.rb

@@ -5,7 +5,7 @@ module Cocina
     # A Request to create a digital repository object. (to create) object.
     # This is same as a DRO, but without externalIdentifier (as that wouldn't have been created yet)
     # See http://sul-dlss.github.io/cocina-models/maps/DRO.json
-    class RequestDRO < Dry::Struct
+    class RequestDRO < Struct
       attribute :type, Types::String.enum(*DRO::TYPES)
       attribute :label, Types::Strict::String
       attribute :version, Types::Coercible::Integer
@@ -18,7 +18,7 @@ module Cocina
       attribute(:structural, DRO::Structural.default { DRO::Structural.new })
 
       def self.from_dynamic(dyn)
-        DROBuilder.build(self, dyn)
+        RequestDRO.new(dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/version.rb

@@ -2,6 +2,6 @@
 
 module Cocina
   module Models
-    VERSION = '0.19.0'
+    VERSION = '0.20.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Justin Coyne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-struct
@@ -177,14 +177,11 @@ files:
 - docs/schema.md
 - lib/cocina/models.rb
 - lib/cocina/models/admin_policy.rb
-- lib/cocina/models/admin_policy_builder.rb
 - lib/cocina/models/catalog_link.rb
 - lib/cocina/models/checkable.rb
 - lib/cocina/models/collection.rb
-- lib/cocina/models/collection_builder.rb
 - lib/cocina/models/description.rb
 - lib/cocina/models/dro.rb
-- lib/cocina/models/dro_builder.rb
 - lib/cocina/models/file.rb
 - lib/cocina/models/file_set.rb
 - lib/cocina/models/release_tag.rb

data/lib/cocina/models/admin_policy_builder.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # This creates an AdminPolicy or a RequestAdminPolicy from dynamic attributes
-    class AdminPolicyBuilder
-      # @return [AdminPolicy,RequestAdminPolicy]
-      def self.build(klass, dyn)
-        params = {
-          type: dyn['type'],
-          label: dyn['label'],
-          version: dyn['version']
-        }
-        params[:externalIdentifier] = dyn['externalIdentifier'] if needs_id?(klass)
-
-        # params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
-        if dyn['administrative']
-          params[:administrative] = AdminPolicy::Administrative
-                                    .from_dynamic(dyn['administrative'])
-        end
-        params[:description] = Description.from_dynamic(dyn.fetch('description'))
-        klass.new(params)
-      end
-
-      def self.needs_id?(klass)
-        klass.attribute_names.include?(:externalIdentifier)
-      end
-    end
-  end
-end

data/lib/cocina/models/collection_builder.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # This creates a Collection or a RequestCollection from dynamic attributes
-    class CollectionBuilder
-      # @return [Collection,RequestCollection]
-      # rubocop:disable Metrics/MethodLength
-      def self.build(klass, dyn)
-        params = {
-          type: dyn['type'],
-          label: dyn['label'],
-          version: dyn['version'],
-          description: Description.from_dynamic(dyn.fetch('description'))
-        }
-        params[:externalIdentifier] = dyn['externalIdentifier'] if needs_id?(klass)
-        # params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
-        if dyn['administrative']
-          params[:administrative] = Collection::Administrative
-                                    .from_dynamic(dyn['administrative'])
-        end
-        if dyn['identification']
-          params[:identification] = Collection::Identification
-                                    .from_dynamic(dyn['identification'])
-        end
-        klass.new(params)
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      def self.needs_id?(klass)
-        klass.attribute_names.include?(:externalIdentifier)
-      end
-    end
-  end
-end

data/lib/cocina/models/dro_builder.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Cocina
-  module Models
-    # This creates a DRO or a RequestDRO from dynamic attributes
-    class DROBuilder
-      # @return [DRO,RequestDRO]
-      # rubocop:disable Metrics/AbcSize
-      def self.build(klass, dyn)
-        params = {
-          type: dyn['type'],
-          label: dyn['label'],
-          version: dyn['version'],
-          description: Description.from_dynamic(dyn.fetch('description'))
-        }
-        params[:externalIdentifier] = dyn['externalIdentifier'] if needs_id?(klass)
-
-        params[:access] = DRO::Access.from_dynamic(dyn['access']) if dyn['access']
-        params[:administrative] = DRO::Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
-        params[:identification] = DRO::Identification.from_dynamic(dyn['identification']) if dyn['identification']
-        params[:structural] = DRO::Structural.from_dynamic(dyn['structural']) if dyn['structural']
-        klass.new(params)
-      end
-      # rubocop:enable Metrics/AbcSize
-
-      def self.needs_id?(klass)
-        klass.attribute_names.include?(:externalIdentifier)
-      end
-    end
-  end
-end