cocina-models 0.2.0 → 0.6.0

data/docs/sampleETD/xn109qc9773_bibframe.ttl

@@ -0,0 +1,95 @@
+:xn109qc9773_work a bf:Work , bf:Text ;
+    rdfs:label "From superteacher to 'bad teacher': goals 2000, comic book films, and changing depictions of educators in the movies" ;
+    bf:title [ a bf:Title ;
+        bf:mainTitle "From superteacher to 'bad teacher'" ;
+        bf:subTitle "goals 2000, comic book films, and changing depictions of educators in the movies"
+    ] ;
+    bf:contribution [ a bf:Contribution ;
+        bf:agent [ a bf:Agent , bf:Person ;
+            rdfs:label "Grant, Derisa"
+        ] ;
+    ] ;
+    bf:contribution [ a bf:Contribution ;
+        bf:agent [ a bf:Agent , bf:Person ;
+            rdfs:label "Labaree, David F., 1947-"
+        ] ;
+        bf:role [ a bf:Role ;
+            rdfs:label "primary advisor"
+        ] ;
+        bf:role <http://id.loc.gov/vocabulary/relators/ths>
+    ] ;
+    bf:contribution [ a bf:Contribution ;
+        bf:agent [ a bf:Agent , bf:Person ;
+            rdfs:label "McDermott, Ray"
+        ] ;
+        bf:role [ a bf:Role ;
+            rdfs:label "advisor"
+        ] ;
+        bf:role <http://id.loc.gov/vocabulary/relators/ths>
+    ] ;
+    bf:contribution [ a bf:Contribution ;
+        bf:agent [ a bf:Agent , bf:Person ;
+            rdfs:label "Willinsky, John, 1950-"
+        ] ;
+        bf:role [ a bf:Role ;
+            rdfs:label "advisor"
+        ] ;
+        bf:role <http://id.loc.gov/vocabulary/relators/ths>
+    ] ;
+    bf:contribution [ a bf:Contribution ;
+        bf:agent [ a bf:Agent , bf:Organization ;
+            rdfs:label "Stanford University. Graduate School of Education"
+        ]
+    ]
+    bf:genreForm [ a bf:GenreForm ;
+        rdfs:label "theses" ;
+        bf:source [ a bf:Source ;
+            bf:code "marcgt"
+        ]
+    ] ;
+    bf:language <http://id.loc.gov/vocabulary/iso639-2/eng> ;
+    bf:summary [ a bf:Summary ;
+        rdfs:label "Since 1939, 46 eddies, or fictional movies about primary or secondary schooling that foreground a teacher..."
+    ] ;
+    bf:dissertation [ a bf:Dissertation ;
+        rdfs:label "Thesis (Ph.D.)--Stanford University, 2015."
+    ]
+] .
+
+:xn109qc9773_instance a bf:Instance ;
+    rdfs:label "From superteacher to 'bad teacher': goals 2000, comic book films, and changing depictions of educators in the movies" ;
+    bf:title [ a bf:Title ;
+        bf:mainTitle "From superteacher to 'bad teacher'" ;
+        bf:subTitle "goals 2000, comic book films, and changing depictions of educators in the movies"
+    ] ;
+    bf:provisionActivity [ a bf:ProvisionActivity , a bf:Publication ;
+        bf:date "2015" ;
+        bf:place [ a bf:Place ;
+            bf:code "xx" ;
+            bf:source [ a bf:Source ;
+                bf:code "marccountry"
+            ] ;
+        ] ;
+        bf:issuance <http://id.loc.gov/vocabulary/issuance/mono>
+    ] ;
+    bf:carrier [ a bf:Carrier ;
+        rdfs:label "digital"
+    ] ;
+    bf:extent [ a bf:Extent ;
+        rdfs:label "1 online resource"
+    ] ;
+    bf:note [ a bf:Note ;
+        rdfs:label "Submitted to the Graduate School of Education."
+    ] ;
+    bf:responsibilityStatement "Derisa Grant."
+] .
+
+:xn109qc9773_item [ a bf:Item ;
+    bf:electronicLocator [ a rdf:Resource ;
+        rdf:value <http://purl.stanford.edu/xn109qc9773> ;
+        bf:note [ a bf:Note ;
+            rdfs:label "primary display" ;
+            bf:noteType "URL usage"
+        ]
+    ]
+] .

data/docs/sampleETD/xn109qc9773_taco.json

@@ -0,0 +1,158 @@
+{   "version": "1.0",
+    "lastUpdated": "2018-11-13",
+    "druid": "xn109qc9773",
+    "descriptiveMetadata": {
+        "title": [{
+            "primary": "TRUE",
+            "titleParts": [
+                {"mainTitle": "From superteacher to 'bad teacher'"},
+                {"subTitle": "goals 2000, comic book films, and changing depictions of educators in the movies"}
+            ],
+            "titleFull": "From superteacher to 'bad teacher': goals 2000, comic book films, and changing depictions of educators in the movies",
+            "titleBrief": "From superteacher to 'bad teacher'"
+        }],
+        "origin": [
+            {
+                "primary": "TRUE",
+                "event": "creation",
+                "agent": [{
+                    "type": "personal",
+                    "name": {
+                        "nameFromSource": "Grant, Derisa",
+                        "lastName": "Grant",
+                        "firstName": "Derisa"
+                    }
+                }]
+            },
+            {
+                "event": "creation",
+                "agent": [{
+                    "type": "personal",
+                    "name": {
+                        "nameFromSource": "Labaree, David F.",
+                        "lastName": "Labaree",
+                        "firstName": "David F.",
+                        "nameDate": {
+                            "type": "life",
+                            "startDate": "1947",
+                            "endDate": "open"
+                        }
+                    }
+                }],
+                "role": [
+                    {"roleTerm": "primary advisor"},
+                    {
+                        "roleTerm": "thesis advisor",
+                        "roleAuthority": "marcrelator",
+                        "roleValueURI": "http://id.loc.gov/vocabulary/relators/ths"
+                    }
+                ]
+            },
+            {
+                "event": "creation",
+                "agent": [{
+                    "type": "personal",
+                    "name": {
+                        "nameFromSource": "McDermott, Ray",
+                        "lastName": "McDermott",
+                        "firstName": "Ray"
+                    }
+                }],
+                "role": [
+                    {"roleTerm": "advisor"},
+                    {
+                        "roleTerm": "thesis advisor",
+                        "roleAuthority": "marcrelator",
+                        "roleValueURI": "http://id.loc.gov/vocabulary/relators/ths"
+                    }
+                ]
+            },
+            {
+                "event": "creation",
+                "agent": [{
+                    "type": "personal",
+                    "name": {
+                        "nameFromSource": "Willinsky, John",
+                        "lastName": "Willinsky",
+                        "firstName": "John",
+                        "nameDate": {
+                            "type": "life",
+                            "startDate": "1950",
+                            "endDate": "open"
+                        }
+                    }
+                }],
+                "role": [
+                    {"roleTerm": "advisor"},
+                    {
+                        "roleTerm": "thesis advisor",
+                        "roleAuthority": "marcrelator",
+                        "roleValueURI": "http://id.loc.gov/vocabulary/relators/ths"
+                    }
+                ]
+            },
+            {
+                "event": "creation",
+                "agent": [{
+                    "type": "corporate",
+                    "name": {"nameParts": [
+                        "Stanford University",
+                        "Graduate School of Education"
+                    ]}
+                }]
+            },
+            {
+                "event": "publication",
+                "place": [{
+                    "code": "xx",
+                    "authority": "marccountry"
+                }],
+                "date": {"singleDate": "2015"},
+                "periodicity": [{
+                    "value": "monographic",
+                    "vocabulary": "MODS issuance"
+                }]
+            }
+        ],
+        "typeOfResource": [{
+            "typeOfResourceTerm": "text",
+            "authority": "MODS typeOfResource"
+        }],
+        "genre": [{
+            "genreTerm": "theses",
+            "authority": "marcgt"
+        }],
+        "language": [{
+            "languageTerm": "English",
+            "languageAuthority": "iso639-2b",
+            "languageValueURI": "http://id.loc.gov/vocabulary/iso639-2/eng"
+        }],
+        "form": {
+            "appliesTo": "resource",
+            "medium": "digital",
+            "extent": {
+                "extentStatement": "1 online resource",
+                "extentNumber": 1,
+                "extentUnit": "online resource"
+            }
+        },
+        "access": ["online"],
+        "abstract": "Since 1939, 46 eddies, or fictional movies about primary or secondary schooling that foreground a teacher, have been released in the United States. From the 1950s through the 1990s, eddies often featured two interconnected and dominant tropes: the separation of home and school, and a superteacher, or a dedicated educator who uses unconventional teaching methods. However, many of the eddies made after 2000 blur or wholly erase the boundary between home and school, and nearly half of the 15 eddies made after 2000 feature unsavory or morally ambiguous teacher protagonists. This dissertation explores the contexts surrounding the genre's shift in tropes, and asserts that changes in eddies coincide with broader changes within the film industry, as well as with changes in educational policy and rhetoric. Specifically, generic changes in eddies coincide with the rise of the comic book film in the early 2000s, and President Bill Clinton's 1994 Goals 2000: Educate America Act, through which the Clinton administration framed education reform as a systemic problem requiring federal interventions and gained the public's support for federally led reforms. By the early 2000s, caped crusaders had begun proving lucrative at the box office, and the federal government had gained unprecedented traction in schools. Concurrently, the cinematic teacher--with no mask, no cape, and no federal authority—was increasingly depicted as a drug addict, a coward, or a cheater who brought the dysfunction of her home life into the classroom.",
+        "note": [
+            {"value": "Submitted to the Graduate School of Education."},
+            {
+                "type": "thesis",
+                "value": "Thesis (Ph.D.)--Stanford University, 2015."
+            },
+            {
+                "type": "statementOfResponsibility",
+                "value": "Derisa Grant."
+            }
+        ],
+        "accessURL": [{
+            "type": "purl",
+            "url": "http://purl.stanford.edu/xn109qc9773",
+            "primary": "TRUE"
+        }]
+    }
+}

data/lib/cocina/models.rb

@@ -5,6 +5,7 @@ require 'zeitwerk'
 require 'dry-struct'
 require 'dry-types'
 
+# Help Zeitwerk find some of our classes
 class CocinaModelsInflector < Zeitwerk::Inflector
   def camelize(basename, _abspath)
     case basename
@@ -24,8 +25,27 @@ loader.push_dir(File.absolute_path("#{__FILE__}/../.."))
 loader.setup
 
 module Cocina
+  # Provides Ruby objects for the repository and serializing them to/from JSON.
   module Models
     class Error < StandardError; end
-    # Your code goes here...
+    # Raised when the type attribute is not valid.
+    class UnknownTypeError < Error; 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
+    # @raises [KeyError] if a type field cannot be found in the data
+    def self.build(dyn)
+      case dyn.fetch('type')
+      when *DRO::TYPES
+        DRO.from_dynamic(dyn)
+      when *Collection::TYPES
+        Collection.from_dynamic(dyn)
+      when *AdminPolicy::TYPES
+        AdminPolicy.from_dynamic(dyn)
+      else
+        raise UnknownTypeError, "Unknown type: '#{dyn.fetch('type')}'"
+      end
+    end
   end
 end

data/lib/cocina/models/admin_policy.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Cocina
+  module Models
+    # An admin policy object.
+    class AdminPolicy < Dry::Struct
+      TYPES = %w[http://cocina.sul.stanford.edu/models/admin_policy.jsonld].freeze
+
+      # Subschema for access concerns
+      class Access < Dry::Struct
+        def self.from_dynamic(_dyn)
+          params = {}
+          Access.new(params)
+        end
+      end
+
+      # Subschema for administrative concerns
+      class Administrative < Dry::Struct
+        def self.from_dynamic(_dyn)
+          params = {}
+          Administrative.new(params)
+        end
+      end
+
+      class Identification < Dry::Struct
+      end
+
+      class Structural < Dry::Struct
+      end
+
+      attribute :externalIdentifier, Types::Strict::String
+      attribute :type, Types::String.enum(*TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Coercible::Integer
+      attribute(:access, Access.default { Access.new })
+      attribute(:administrative, Administrative.default { Administrative.new })
+      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']
+        }
+
+        # params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
+        # params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
+
+        AdminPolicy.new(params)
+      end
+
+      def self.from_json(json)
+        from_dynamic(JSON.parse(json))
+      end
+    end
+  end
+end

data/lib/cocina/models/collection.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'json'
+
+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
+
+      # Subschema for access concerns
+      class Access < Dry::Struct
+        def self.from_dynamic(_dyn)
+          params = {}
+          Access.new(params)
+        end
+      end
+
+      # Subschema for administrative concerns
+      class Administrative < Dry::Struct
+        def self.from_dynamic(_dyn)
+          params = {}
+          Administrative.new(params)
+        end
+      end
+
+      class Identification < Dry::Struct
+      end
+
+      class Structural < Dry::Struct
+      end
+
+      attribute :externalIdentifier, Types::Strict::String
+      attribute :type, Types::String.enum(*TYPES)
+      attribute :label, Types::Strict::String
+      attribute :version, Types::Coercible::Integer
+      attribute(:access, Access.default { Access.new })
+      attribute(:administrative, Administrative.default { Administrative.new })
+      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']
+        }
+
+        # params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
+        # params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
+
+        Collection.new(params)
+      end
+
+      def self.from_json(json)
+        from_dynamic(JSON.parse(json))
+      end
+    end
+  end
+end

data/lib/cocina/models/dro.rb

@@ -4,27 +4,90 @@ require 'json'
 
 module Cocina
   module Models
-    # A digital repository object.  See https://github.com/sul-dlss-labs/taco/blob/master/maps/DRO.json
+    # 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
+      ].freeze
+      # Subschema for release tags
+      class ReleaseTag < Dry::Struct
+        attribute :to, Types::Strict::String
+        attribute :what, Types::Strict::String.enum('self', 'collection')
+        # we use 'when' other places, but that's reserved word, so 'date' it is!
+        attribute :date, Types::Params::DateTime
+        attribute :who, Types::Strict::String
+        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'])
+        end
+      end
+
+      # Subschema for access concerns
+      class Access < Dry::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
+        attribute :releaseTags, Types::Strict::Array.of(ReleaseTag).meta(omittable: true)
+
+        def self.from_dynamic(dyn)
+          params = {}
+          params[:releaseTags] = dyn['releaseTags'].map { |rt| ReleaseTag.from_dynamic(rt) } if dyn['releaseTags']
+          Administrative.new(params)
+        end
+      end
+
+      class Identification < Dry::Struct
+      end
+
+      class Structural < Dry::Struct
+      end
+
       attribute :externalIdentifier, Types::Strict::String
-      attribute :type, Types::Strict::String
+      attribute :type, Types::String.enum(*TYPES)
       attribute :label, Types::Strict::String
-      attribute :access, Dry::Struct.meta(omittable: true) do
-        attribute :embargoReleaseDate, Types::Params::Date
-      end
+      attribute :version, Types::Coercible::Integer
+      attribute(:access, Access.default { Access.new })
+      attribute(:administrative, Administrative.default { Administrative.new })
+      attribute(:identification, Identification.default { Identification.new })
+      attribute(:structural, Structural.default { Structural.new })
 
-      def self.from_dynamic(d)
+      def self.from_dynamic(dyn)
         params = {
-          externalIdentifier: d['externalIdentifier'],
-          type: d['type'],
-          label: d['label']
+          externalIdentifier: dyn['externalIdentifier'],
+          type: dyn['type'],
+          label: dyn['label'],
+          version: dyn['version']
         }
-        if d['access']
-          access = {
-            embargoReleaseDate: d['access']['embargoReleaseDate']
-          }
-          params[:access] = access
-        end
+
+        params[:access] = Access.from_dynamic(dyn['access']) if dyn['access']
+        params[:administrative] = Administrative.from_dynamic(dyn['administrative']) if dyn['administrative']
 
         DRO.new(params)
       end