scooby_snacks 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b87091a22b0b5120938e906df166f14b6ae4de4a
+  data.tar.gz: 766c375f977bf1e44159f07d9727bb35f488040b
+SHA512:
+  metadata.gz: 513ac55096f13424f39d50afe1b2a584298a506339d2f7af26e1d38c92c761c98e9262f91219e74473d4cddf1d64ca97fa775845c56ed9bab83955af9cde3ccd
+  data.tar.gz: 45fe49a08de19ca5d10c6fda5f55b379c9415719f59b0aed45ba746e1ee48642b98c080525686ebafc69adc440a18a0e517ea68a3a64a17fafa60efa44fef244

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in scooby_snacks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ned Henry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# ScoobySnacks
+
+This gem allows administrators of a Hyrax application to define their metadata schema in a human readable configuration file (or files). The Hyrax application is configured automatically with the metadata properties defined in the configuration file when the application loads. This makes it easy to update the metadata schema details in one place, and implementing changes only requires restarting the application. 
+Hopefully this approach will also make it easier to share metadata schema between institutions, and to write Samvera code that is independent of the details of a specific schema and is therefore more portable between institutions.
+
+This project is currently designed on Hyrax 2.4. 
+
+The documentation for this gem is currently outdated. Some major updates to both the gem and the documentation are expected in Spring 2019.
+
+## Metadata Schema Configuration File & The M3 Project
+The central goal of this gem is to define the metadata schema in a human readable configuration file. This includes all the attributes of each metadata property ("meta-metadata properties"). It is difficult to create a univerally functional and intuitive specification/format for this configuration file.  
+The M3 project is working to address this issue by creating a shared metadata schema specification in collaboration with several institutions. We plan to use the resulting specification in future versions of ScoobySnacks.
+ScoobySnacks currently uses its own type of YML metadata schema configuration file whose specification/format is not very well documented (although it is fairly intuitive). Thie schema meets UCSC's immediate needs, but it may require extension for other instituions application specific needs.
+
+## The Name 'ScoobySnacks'
+
+The name ScoobySnacks reflects the fact that this gem addresses a similar need to the ['dog-biscuits'](https://github.com/ULCC/dog_biscuits/wiki) gem, but takes a different approach. We plan to explore the possibility of merging the gems in the future, retaining the best aspects of each. 
+
+## Installation
+
+* First, install the gem by adding this line to your application's Gemfile:
+
+```ruby
+gem 'scooby_snacks'
+```
+
+And then execute:
+
+    $ bundle
+
+* Create a file called `config/initializers/metadata.rb` with the following contents:
+```ruby
+ScoobySnacks::METADATA_SCHEMA = ScoobySnacks::MetadataSchema.new
+```
+
+* In `app/controllers/catalog_controller.rb`, 
+    * replace all `config.add_facet_field` lines related to your metadata schema with `ScoobySnacks::BlacklightConfiguration.add_facet_fields(config)`
+    * replace all `config.add_index_field` lines related to your metadata schema with
+`ScoobySnacks::BlacklightConfiguration.add_search_result_display_fields(config)`
+    * replace all `config.add_show_field` lines related to your metadata schema with `ScoobySnacks::BlacklightConfiguration.add_show_fields(config)`
+    * replace all `config.add_search_field` lines related to your metadata schema with `ScoobySnacks::BlacklightConfiguration.add_search_fields(config)`
+    * replace all `config.add_sort_field` lines related to your metadata schema with `ScoobySnacks::BlacklightConfiguration.add_sort_fields(config)`
+
+* In `app/models/solr_document.rb`, under the line `include Hyrax::SolrDocumentBehavior`, add the following:
+```ruby
+include ScoobySnacks::SolrDocumentBehavior
+```
+
+* The following three modifications need to be done for each of the work types you have defined in your application. Replace `WORK_TYPE` with the name of your work type, in lower case.
+    * In `app/forms/hyrax/WORK_TYPE_form.rb`, under the line `class {WORK_TYPE}Form < Hyrax::Forms::WorkForm`, include the following: `include ScoobySnacks::WorkFormBehavior`
+    * In `app/models/WORK_TYPE.rb`, comment out the line `include Hyrax::BasicMetadata` and add the folling underneath it: `include ScoobySnacks::WorkModelBehavior`
+
+    * In `app/presenters/WORK_TYPE_show_presenter.rb` (or wherever you define your custom presenter classes), include the following: `include ScoobySnacks::PresenterBehavior`
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scooby_snacks"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/config/metadata.yml

@@ -0,0 +1,283 @@
+#-------------------
+# Other Schema Files
+#-------------------
+# This section specifies other configuration files that contain
+# metadata information. Each other metadata file may contain 
+# any information that would be valid in this file. Schema information
+# from all files is merged together.
+# When possible, information from all files is combined. For example, 
+# if a property is defined in one file, it cannot be un-defined in 
+# another file, though more options can be added.
+# Some options associated with properties can be defined in one file
+# and overwritten by another. Options like this include 'required'
+# and 'multiple'. 
+# Other options must be defined only once per property
+# and cannot be overwritten. These include "predicate" and "definition". 
+
+
+
+
+
+#-------------------
+# Property Settings
+#-------------------
+# This section defines every metadata property that can be used 
+# in the system. Individual work types may override some settings 
+# defined here. Predicates for each property should be defined
+# here, and cannot be overridden once defined.
+
+properties:
+
+  default:
+    definition: "This property has not yet been documented."
+    usage_note: "This is the default usage note for a metadata property. If you are seeing this in an active application, you need to define a usage note for your property."
+    usage_warning: 
+    required: false
+    multiple: true
+    primary: false
+    hidden: false
+    work_title: false
+    input: scalar
+    range: RDF:Literal
+
+  title:
+    definition: "The title of the resource."
+    predicate: "DC:title"
+    label: "Title"
+    range: "rdfs:Literal"
+    required: true
+    primary: true
+    work_title: true
+
+  title_alternative:
+    definition: "An alternative title for the resource."
+    predicate: "DC:alternative"
+    range: "rdfs:Literal"
+  creator:
+    definition: "A person or organization responsible for creating the resource."
+    predicate: "DC:creator"
+    range: "Agent"
+#    vocabularies: "NAF, ULAN, Local"
+    primary: true
+    required: true
+    facet: true
+
+  contributor:
+    definition: "A person or organization responsible for making contributions to the resource."
+    predicate: "DC:contributor"
+    range: "Agent"
+#    vocabularies: "NAF, ULAN, Local"
+    facet: true
+
+  publisher:
+    definition: "An entity responsible for making the resource available."
+    predicate: "DC:publisher"
+    range: "Agent"
+    facet: true
+
+  description:
+    definition: "A summary or account of the resource."
+    predicate: "DC:description"
+    range: "rdfs:Literal"
+    primary: true
+
+  description_abstract:
+    definition: "A summary of the resource."
+    predicate: "DC:description"
+    range: "rdfs:Literal"
+
+  description_contents:
+    definition: "A list of subunits of the resource."
+    predicate: "DC:tableOfContents"
+    range: "rdfs:Literal"
+
+  scale:
+    definition: "Ratio of the dimensions of a form contained or embodied in a resource to the dimensions of the entity it represents, e.g., for images or cartographic resources."
+    predicate: "Bibframe:cartographicScale"
+    range: "rdfs:Literal"
+
+  subject:
+    definition: "The topic of the resource."
+    predicate: "DC:subject"
+    range: "skos:Concept"
+#    vocabularies: LCSH, NAF, ULAN, GNIS, AAT, Local
+    facet: true
+    primary: true
+
+  genre_form:
+    definition: "The genre, form, and/or physical characteristics of the resource being described. The material or physical carrier of the resource. Does not capture aboutness."
+    predicate: "DC:medium"
+    range: "skos:Concept"
+#    vocabularies: AAT
+    facet: true
+
+  coordinates:
+    definition: Spatial characteristics of the resource.
+    predicate: "DC:spatial"
+    range: Geospatial
+
+  date_created: 
+    definition: "Date of creation of the resource."
+    predicate: "DC:created"
+    range: "edm:TimeSpan"
+    label: "Date Created"
+    primary: true
+    required: true
+
+  date_published:
+    definition: "Date of formal issuance (e.g., publication) of the resource."
+    predicate: "DC:issued"
+    range: "edm:TimeSpan"
+    label: "Date Published"
+
+  language:
+    definition: "A language of the resource."
+    predicate: "DC:language"
+    range: skos:concept
+
+  dcmi_type:
+    definition: "General nature or type of the resource (e.g., image, text, etc.). Does not capture aboutness."
+    predicate: "DC:type"
+    range: "skos:concept"
+#    vocabularies: DCMI
+    facet: true
+#    display_type: true
+
+  source:
+    definition: "Use to record and previous publication information, e.g., the place of publication and publisher name for a physical resource."
+    predicate: "DC:source"
+
+  physical_extent:
+    definition: "Physical dimensions of the source resource."
+    predicate: "DC:extent"
+
+  box_folder:
+    definition: "Location in the holding agency where the item is shelved or stored."
+    predicate: "BF2:physicalLocation"
+
+  accession_number:
+    definition: "An archival accession number for the resource."
+    predicate: "DC:identifier"
+    range: "rdfs:Literal"
+#    multiple: false
+
+  call_number:
+    definition: "A call number identifier for the resource."
+    predicate: "Bibframe:classification"
+#    multiple: false
+
+  donor_provenance:
+    definition: "A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation."
+    predicate: "DC:provenance"
+    range: "rdf:Object"
+
+  rights_holder:
+    definition: "A person or organization owning or managing rights over the resource."
+    predicate: "DC:rightsHolder"
+    range: "rdf:Object"
+
+  rights_copyright_statement:
+    definition: "Information about rights held in and over the resource."
+    predicate: "DC:rights"
+    primary: true
+    required: true
+
+  rights_status:
+    definition: "Information about who can access the resource or an indication of its security status."
+    predicate: "DC:accessRights"
+    primary: true
+    required: true
+    facet: true
+
+  rights_license:
+    definition: "An associated license for the object (i.e. Creative Commons license, software licenses, etc.)."
+    predicate: "DC:license"
+
+  "collection_series":
+    definition: "A related resource in which the described resource is physically or logically included."
+    predicate: "DC:isPartOf"
+    facet: true
+
+  related_resource:
+    definition: "A resource related to this resource in a publicly visible way"
+    predicate: "DC:relation"
+    range: RelatedResource
+
+
+#-------------------
+# Class Settings
+#-------------------
+# This sections defines classes of nested objects defined in 
+# the system that are not PCDM works. These may be used as the objects
+# of predicates, and may have their own predicates applied.  
+# Here, we define which properties are available to each Class.
+
+classes:
+  Agent:
+    parent: "ActiveTripes::Resource"
+    rdf_label: "::RDF::Vocab::FOAF.Agent"
+    properties: 
+      local_label:
+        definition: "If set, this is a local label for this agent to be indexed and displayed instead of any label fetched from remote authority"
+        predicate: 'skos:altLabel'
+#  Timespan:
+#    parent: "ActiveTripes::Resource"
+#    rdf_label: "::RDF::Vocab::FOAF.Agent"
+#    properties:
+#      label:
+#        definition: "A name or label for this timespan"
+#        predicate: "skos:prefLabel"
+#      begin:
+#        definition: "The time when a time period began or commenced."
+#        predicate: "edm:begin"
+#      end:
+#        definition: "The time when a time period ended."
+#        predicate: "edm:end"
+#  Link:
+#    properties:
+#      "label":
+#        definition: "The title of this resource to be displayed publicly"
+#        predicate: "skos:prefLabel"
+#      "linked_resource_type":
+#        definition: "The human-readable type of linked resource (e.g. finding aid)."
+#        predicate: "ucsd:relatedType"
+#      url:
+#        definition: "The address of the resource to link to"
+#        predicate: "schema:url"
+#        range: "xsd:anyURI"
+
+#-------------------
+# Work Type Settings
+#-------------------
+# Here we define metadata settings based on work type.
+# This section specifies which properties (defined above)
+# may be applied to each work type, and may specify display
+# settings such as "required" or "hidden".
+# 
+# In the future, this may be extended to actually define 
+# the work types for the application here.
+
+
+work_types:
+  work:
+    properties:
+      title:
+      description:
+        required: true
+      creator:
+      contributor:
+      physical_extent:
+#      rights_license:
+  lecture:
+  course:
+  gdao_work:
+
+#-------------------
+# RDF Namespaces
+#-------------------
+# Here we can define additional namespaces for rdf predicates.
+# The most common namespaces are predefined by the system, but
+# this allows us to define more.
+
+namespaces:
+  edm: "http://www.europeana.eu/schemas/edm/"

data/examples/example_config_1/README.md

@@ -0,0 +1,7 @@
+# Simple Configuration Example
+
+This example is an example of a simple metadata schema definition. A shared core metadata schema is used a few local customizations. Two simple work types are defined. No classes are defined outside of the PCDM. 
+
+# DISCLAIMER: NOT AN ACTUAL SCHEMA
+
+This is an example of how one might specify a metadata schema using ScoobySnacks. It does not reflect any schema that UCSC has ever used or planned to use. Our developer made this up to demonstrate how the schema configuration files might work.

data/examples/example_config_1/metadata.yml

@@ -0,0 +1,96 @@
+#-------------------
+# Other Schema Files
+#-------------------
+# This section specifies other configuration files that contain
+# metadata information. Files are loaded in order, and the 
+# directives in this file are loaded last. 
+# File paths are specified relative to the application's 'config' directory. 
+# Schema information from all files are merged together. Some options
+# may be overridden in files loaded later. 
+# Other options must be defined only once per property
+# and cannot be overwritten. These include "predicate" and "definition". 
+
+schema_files:
+  - shared_shema.yml
+
+
+
+#-------------------
+# Property Settings
+#-------------------
+# This section defines every metadata property that can be used 
+# in the system. Individual work types may override some settings 
+# defined here. Predicates for each property should be defined
+# here, and cannot be overridden once defined.
+
+properties:
+
+  call_number:
+    label: "Internal Idenfication Number"
+    usage_note: "Use this for both call numbers and GQQQWYKID numbers."
+
+  scale:
+    label: "Scale"
+    definition: "Ratio of the dimensions of a form contained or embodied in a resource to the dimensions of the entity it represents, e.g., for images or cartographic resources."
+    usage_note: "Use this for scales of maps, aerial photos, and/or scanned documents. "
+    
+    predicate: "Bibframe:cartographicScale"
+    range: "rdfs:Literal"
+
+  date_published:
+    definition: "Date of formal issuance (e.g., publication) of the resource."
+    predicate: "DC:issued"
+    range: "edm:TimeSpan"
+    label: "Date Published"
+
+    date_created:
+      required: false
+
+    source:
+      label: "Provenance / Source"
+
+#-------------------
+# Work Type Settings
+#-------------------
+# Here we define metadata settings based on work type.
+# This section specifies which properties (defined above)
+# may be applied to each work type, and may specify display
+# settings such as "required" or "hidden".
+# 
+# In the future, this may be extended to actually define 
+# the work types for the application here.
+
+
+work_types:
+  generic_work:
+    properties:
+      title:
+      description:
+        primary: true
+        required: true
+      creator:
+        primary: true
+        required: true
+      contributor:
+        primary: true
+      rights_license:
+        primary: true
+  magazine:
+    properties:
+      title:
+      description:
+        primary: true
+        required: true
+      creator:
+        primary: true
+        required: true
+      publisher:
+        primary: true
+      date_published:
+        primary: true
+      scale:
+        primary: true
+      contributor:
+        primary: true
+      rights_license:
+        primary: true