cocina-models 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e23b0e03fa39eb46ba0dd2f99befd2a1eea00a1294c44da2717892ede74a2c3
-  data.tar.gz: 1149930ef7b568cdd28b96447148d58dd9e83846133a7316a317c179dbd6330a
+  metadata.gz: eb44299e9e86c9fdde5589710db813e3691add7bbf59b14d34ab6edf89cffa9b
+  data.tar.gz: a63852fd6c5a8369ff49236b4fea55504dfaa3e0944fcc74e6da03605031e504
 SHA512:
-  metadata.gz: 0cc112f49830c1b00a20fcad1c15d21e9563ba09fdf84406d55d5cbfb9e73a9612e7056b62d63629841b1c690f9fa06541e2a3a2c37d6f8f5995edc52ffa6342
-  data.tar.gz: cc12548903b6b5b1befc9a236611473f30af7323994f36de49822ad31f318770d1ecc8070344552b19019984b3899c2073bacead487ba9670123c17460873583
+  metadata.gz: be279159d4b042bc5265db234d6f938bcecfafd5240c969a5f5f77af6acf7a00aadfad6076110f3674596f7354b435c526de2559067fbd53539907e209c28369
+  data.tar.gz: 1bab7879c6051415a51226b5abd983f38fdc883dd93d5053c39240a51943e1ca4baae19034929861edc4579fa7fdca0b4b61bd4a08aab5539ebd7bb45ee520b6

data/.rubocop.yml

@@ -18,4 +18,4 @@ RSpec/MultipleExpectations:
   Enabled: false
 
 RSpec/ExampleLength:
-  Max: 12
+  Max: 15

data/lib/cocina/models.rb

@@ -12,6 +12,10 @@ class CocinaModelsInflector < Zeitwerk::Inflector
     case basename
     when 'dro'
       'DRO'
+    when 'dro_builder'
+      'DROBuilder'
+    when 'request_dro'
+      'RequestDRO'
     when 'version'
       'VERSION'
     else

data/lib/cocina/models/collection.rb

@@ -67,18 +67,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']
-        }
-
-        # params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
-        params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
-        params[:description] = Description.from_dynamic(dyn.fetch('description'))
-        params[:identification] = Identification.from_dynamic(dyn['identification']) if dyn['identification']
-        Collection.new(params)
+        CollectionBuilder.build(self, dyn)
       end
 
       def self.from_json(json)

data/lib/cocina/models/collection_builder.rb

@@ -0,0 +1,35 @@
+# 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.rb

@@ -90,23 +90,9 @@ module Cocina
       attribute(:identification, Identification.default { Identification.new })
       attribute(:structural, Structural.default { Structural.new })
 
-      # rubocop:disable Metrics/AbcSize
       def self.from_dynamic(dyn)
-        params = {
-          externalIdentifier: dyn['externalIdentifier'],
-          type: dyn['type'],
-          label: dyn['label'],
-          version: dyn['version']
-        }
-
-        params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
-        params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
-        params[:description] = Description.from_dynamic(dyn.fetch('description'))
-        params[:identification] = Identification.from_dynamic(dyn['identification']) if dyn['identification']
-        params[:structural] = Structural.from_dynamic(dyn['structural']) if dyn['structural']
-        DRO.new(params)
+        DROBuilder.build(self, dyn)
       end
-      # rubocop:enable Metrics/AbcSize
 
       def self.from_json(json)
         from_dynamic(JSON.parse(json))

data/lib/cocina/models/dro_builder.rb

@@ -0,0 +1,31 @@
+# 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

data/lib/cocina/models/request_collection.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # 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
+      attribute :type, Types::String.enum(*Collection::TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Coercible::Integer
+      attribute(:access, Collection::Access.default { Collection::Access.new })
+      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(:identification, Collection::Identification.default { Collection::Identification.new })
+      attribute(:structural, Collection::Structural.default { Collection::Structural.new })
+
+      def self.from_dynamic(dyn)
+        CollectionBuilder.build(self, dyn)
+      end
+
+      def self.from_json(json)
+        from_dynamic(JSON.parse(json))
+      end
+    end
+  end
+end

data/lib/cocina/models/request_dro.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Cocina
+  module Models
+    # 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
+      attribute :type, Types::String.enum(*DRO::TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Coercible::Integer
+      attribute(:access, DRO::Access.default { DRO::Access.new })
+      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(:identification, DRO::Identification.default { DRO::Identification.new })
+      attribute(:structural, DRO::Structural.default { DRO::Structural.new })
+
+      def self.from_dynamic(dyn)
+        DROBuilder.build(self, dyn)
+      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.17.0'
+    VERSION = '0.18.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocina-models
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -180,11 +180,15 @@ files:
 - 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
+- lib/cocina/models/request_collection.rb
+- lib/cocina/models/request_dro.rb
 - lib/cocina/models/types.rb
 - lib/cocina/models/version.rb
 - lib/cocina/models/vocab.rb