hydra-works 0.0.1

data/spec/hydra/works_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+
+describe Hydra::Works do
+
+  let(:works_coll)   { Hydra::Works::Collection.create }
+  let(:works_gwork)  { Hydra::Works::GenericWork::Base.create }
+  let(:works_gfile)  { Hydra::Works::GenericFile::Base.create }
+
+  let(:pcdm_coll)  { Hydra::PCDM::Collection.create }
+  let(:pcdm_obj)   { Hydra::PCDM::Object.create }
+  let(:pcdm_file)  { Hydra::PCDM::File.new }
+
+  describe 'Validations' do
+
+    describe "#collection?" do
+      it "should return true for a works collection" do
+        expect( Hydra::Works.collection? works_coll ).to be true
+      end
+
+      it "should return false for a works generic work" do
+        expect( Hydra::Works.collection? works_gwork ).to be false
+      end
+
+      it "should return false for a works generic file" do
+        expect( Hydra::Works.collection? works_gfile ).to be false
+      end
+
+      it "should return false for a pcdm collection" do
+        expect( Hydra::Works.collection? pcdm_coll ).to be false
+      end
+
+      it "should return false for a pcdm object" do
+        expect( Hydra::Works.collection? pcdm_obj ).to be false
+      end
+
+      it "should return false for a pcdm file" do
+        expect( Hydra::Works.collection? pcdm_file ).to be false
+      end
+    end
+
+    describe "#generic_work?" do
+      it "should return false for a works collection" do
+        expect( Hydra::Works.generic_work? works_coll ).to be false
+      end
+
+      it "should return true for a works generic work" do
+        expect( Hydra::Works.generic_work? works_gwork ).to be true
+      end
+
+      it "should return false for a works generic file" do
+        expect( Hydra::Works.generic_work? works_gfile ).to be false
+      end
+
+      it "should return false for a pcdm collection" do
+        expect( Hydra::Works.generic_work? pcdm_coll ).to be false
+      end
+
+      it "should return false for a pcdm object" do
+        expect( Hydra::Works.generic_work? pcdm_obj ).to be false
+      end
+
+      it "should return false for a pcdm file" do
+        expect( Hydra::Works.generic_work? pcdm_file ).to be false
+      end
+    end
+
+    describe "#generic_file?" do
+      it "should return false for a works collection" do
+        expect( Hydra::Works.generic_file? works_coll ).to be false
+      end
+
+      it "should return false for a works generic work" do
+        expect( Hydra::Works.generic_file? works_gwork ).to be false
+      end
+
+      it "should return true for a works generic file" do
+        expect( Hydra::Works.generic_file? works_gfile ).to be true
+      end
+
+      it "should return false for a pcdm collection" do
+        expect( Hydra::Works.generic_file? pcdm_coll ).to be false
+      end
+
+      it "should return false for a pcdm object" do
+        expect( Hydra::Works.generic_file? pcdm_obj ).to be false
+      end
+
+      it "should return false for a pcdm file" do
+        expect( Hydra::Works.generic_file? pcdm_file ).to be false
+      end
+    end
+  end
+
+  describe "Hydra::PCDM" do
+    describe "#collection?" do
+      it "should return true for a works collection" do
+        expect( Hydra::PCDM.collection? works_coll ).to be true
+      end
+
+      it "should return false for a works generic work" do
+        expect( Hydra::PCDM.collection? works_gwork ).to be false
+      end
+
+      it "should return false for a works generic file" do
+        expect( Hydra::PCDM.collection? works_gfile ).to be false
+      end
+
+      it "should return true for a pcdm collection" do
+        expect( Hydra::PCDM.collection? pcdm_coll ).to be true
+      end
+
+      it "should return false for a pcdm object" do
+        expect( Hydra::PCDM.collection? pcdm_obj ).to be false
+      end
+
+      it "should return false for a pcdm file" do
+        expect( Hydra::PCDM.collection? pcdm_file ).to be false
+      end
+    end
+
+    describe "#object?" do
+      it "should return false for a works collection" do
+        expect( Hydra::PCDM.object? works_coll ).to be false
+      end
+
+      it "should return true for a works generic work" do
+        expect( Hydra::PCDM.object? works_gwork ).to be true
+      end
+
+      it "should return true for a works generic file" do
+        expect( Hydra::PCDM.object? works_gfile ).to be true
+      end
+
+      it "should return false for a pcdm collection" do
+        expect( Hydra::PCDM.object? pcdm_coll ).to be false
+      end
+
+      it "should return true for a pcdm object" do
+        expect( Hydra::PCDM.object? pcdm_obj ).to be true
+      end
+
+      it "should return false for a pcdm file" do
+        expect( Hydra::PCDM.object? pcdm_file ).to be false
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+ENV['environment'] ||= 'test'
+require 'coveralls'
+Coveralls.wear!
+
+require 'bundler/setup'
+Bundler.setup
+
+require 'hydra/works'
+require 'pry' unless ENV['CI']
+require 'active_fedora'
+require 'active_fedora/cleaner'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+# require 'http_logger'
+# HttpLogger.logger = Logger.new(STDOUT)
+# HttpLogger.ignore = [/localhost:8983\/solr/]
+# HttpLogger.colorize = false
+# HttpLogger.log_headers = true
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+
+  # Uncomment the following line to get errors and backtrace for deprecation warnings
+  # config.raise_errors_for_deprecations!
+
+  # Use the specified formatter
+  config.formatter = :progress
+
+  config.before :each do |example|
+    unless example.metadata[:no_clean]
+      ActiveFedora::Cleaner.clean!
+    end
+  end
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end

data/use-cases/conference_event_use_case.md

@@ -0,0 +1,16 @@
+#### Sponsors
+UC San Diego Library (Metadata Services): @MetadataDeluxe @Juliane666 @remerjohnson 
+
+#### Goal and Reason
+Given an event (a conference), with many sub-events with many creative works created by many entities about related but different topics: 
+
+As a user:
+* I want to see a hierarchical list of all sub-events that can sorted by date, title, or creator while maintaining the order of any sub-components (for example, parts 1-3 of a single music performance are kept together and in order).
+* I want to see a timeline of events with dates and times, so that there is greater context for the event. 
+* I want to see descriptive metadata for the entire event (the conference).
+* I want to see descriptive metadata for each sub-event (for example, a musical demonstration as part of a presentation).
+* I want to see technical metadata for each file (let's say an .mp3).
+* I want to see components by descriptive characteristics, so that I could for example access all the performances of electronic percussion music. 
+
+
+![screenshot from 2014-10-17 14 09 41](https://cloud.githubusercontent.com/assets/5183580/4686135/0d27e954-5642-11e4-9519-2236a6e967d7.png)

data/use-cases/lafayette_college_geospatial_use_case.md

@@ -0,0 +1,80 @@
+# Lafayette College Libraries Geospatial Data Set Use Case
+
+Sponsor: @jrgriffiniii
+
+```
+Given an Esri Shapefile containing many Features
+As a user
+I want to view all point Features in the Shapefile on a raster base layer
+And I want to view all polygon Features in the Shapefile on a raster base layer
+And I want to discover all Features for the related Shapefile
+And I want to discover all Features using a box bounded by geospatial coordinates
+And I want to discover the Shapefile using MODS element values
+And I want to discover the Shapefile using a box bounded by geospatial coordinates
+```
+
+```
+Given an Esri Shapefile containing many Features
+As a curator
+Or as an archivist
+I want to create MODS element values for Esri Shapefiles
+And I want to edit MODS element values for Esri Shapefiles
+And I want to delete MODS element values for Esri Shapefiles
+```
+
+```
+Given an Esri Shapefile containing many Features
+And given a TIFF image
+As a curator
+Or as an archivist
+I want to reference a TIFF image from a Feature
+And I want to view a thumbnail for the referenced TIFF image when I click on the Feature
+```
+
+```
+Given a GeoTIFF referencing many geospatial coordinates
+As a user
+I want to view the GeoTIFF image on a raster base layer
+And I want to discover the GeoTIFF using a box bounded by geospatial coordinates
+And I want to discover the GeoTIFF using MODS element values
+```
+
+```
+Given a GeoTIFF referencing many geospatial coordinates
+As a curator
+Or as an archivist
+I want to create MODS element values for Esri Shapefiles
+And I want to edit MODS element values for Esri Shapefiles
+And I want to delete MODS element values for Esri Shapefiles
+```
+
+```
+Given an Esri Shapefile containing many Features
+As a user
+I want to view all point Features in the Shapefile and the GeoTIFF image on a raster base layer
+And I want to view all polygon Features in the Shapefile and the GeoTIFF image on a raster base layer
+```
+
+## Esri Shapefile
+
+Characteristics:
+
+ * Descriptive MD
+    * We've been working with the MODS
+ * Rights MD
+ * Geospatial MD
+   * Ideally, this should be managed within either FGDC XML Documents or in compliance with ISO 19139
+ * Keyhole Markup Language (KML) Document
+ * GeoJSON Objects
+   * Preferably, these would be deprecated in favor of [TopoJSON Objects](https://github.com/mbostock/topojson/wiki)
+
+## GeoTIFF Image
+
+Characteristics:
+
+ * Descriptive MD
+   * We've been working with the MODS
+ * Rights MD
+ * Technical MD
+   * Structured using a METS-PREMIS profile and extracted using the FITS
+   * Perhaps gdalinfo could also be integrated for additional metadata?

data/use-cases/northwestern_adminset_use-case.md

@@ -0,0 +1,19 @@
+Northwestern AdminSet Use Case
+Sponsor: @julesies
+
+Given an administrative grouping of items 
+As an administrative unit that is ultimately responsible for managing. The set itself helps to manage the items within it. 
+I want to maintain the following relationships of an AdminSet.
+  Can not contain other sets of any kind 
+  Only staff with permission to create or manage an admin set can do so
+  All items must be in an AdminSet (there could be a default collection)
+  Items can only be in one AdminSet
+  Admin sets contain a set of default values (permissions, metadata, etc) that can be applied to new objects in the set
+  Any changes to default settings should not automatically change all items in a collection but prompt the user with options
+  Can be faceted for discovery (but it would be nice if that was optional)
+  Order does not matter
+So that an Administrative Set's primary use is to manage distinct collections of digital objects over time
+
+Here are some example object we need to represent, and their characteristics, from least to most complex.
+
+AdminSet

data/use-cases/northwestern_displayset_use_case.md

@@ -0,0 +1,23 @@
+Northwestern DisplaySets Use Case
+Sponsor: @julesies
+
+Given a Display Set is an intellectual grouping of items that a curator (or person who has the rights to) creates
+As an aid in the discovery and presentation of collections of materials. 
+The display set is distinct from User Collections because it's primary purpose is the visual display of Display Sets. The Display Set is distinct from an Admin Set because the Display Set itself does not affect items within it. 
+I want to maintain the folllowing relationships of a DisplaySet.
+  Supports hierarchical display of collections in facets
+  Items in a repository may be in more than one Display Set
+  Items in a repository do not have to be in a Display Set
+  Display Sets can contain other Display Sets
+So that a curator makes a library collection of Maps of Africa, some of which are contained in different collections. 
+The Biology Department has a collection of departmental masters theses and wants viewers to navigate the collections via facets like this:
+  Biology Department
+    Master's Theses
+      1972
+      1973
+      1974
+
+Here are some example object we need to represent, and their characteristics, from least to most complex.
+
+DisplaySet
+User Collection

data/use-cases/northwestern_playlist_use_case.md

@@ -0,0 +1,21 @@
+Northwestern Playlist Use Case
+Sponsor: @julesies
+
+Given a User Collection with an intellectual grouping of items 
+As a primary list used by individual users to create groups of items or favorites. 
+I want to maintain the following relationships of a Nested User Collection.  
+  A bookmark-like approach to grouping items
+  A User Collection can be shared with others in some way or kept private
+  Items within User Collections are not governed by the collection in any way
+  Items can belong to more than one User Collection
+  Items in a repository do not have to belong to any User Collection
+  Items can appear in the same User Collection more than once 
+  Ordered items 
+So that a Researcher who creates a group of intellectually related items for a research purpose. Example:
+Professor who creates a group of items for a particular course or presentation. Examples: Art History professor creates an group of images for a lecture. A history professor creates a playlist of audio and video for an entire course. 
+Audio and Video playlists.
+
+Here are some example object we need to represent, and their characteristics, from least to most complex.
+
+Playlist
+User Collection

data/use-cases/princeton_book_use_case.md

@@ -0,0 +1,117 @@
+# Princeton Book Use Case
+
+Sponsor: @jpstroop
+
+```
+Given a book with many pages, and many images of each page  
+As a repository comprised of digitized books and manuscripts  
+I want to maintain the relationships between images of a page and technical, 
+    descriptive, and provenance metadata about each image
+And I want to maintain sorting, label, and other metadata, as well as files
+    that represent the whole object in one place
+So that I can have multiple images of a page tied to one instance of a model 
+    without relying on naming conventions (e.g. jp2_md5_checksum)  
+```
+
+Here are some example object we need to represent, and their characteristics, from least to most complex.
+
+## A Photograph or Poster
+
+Characteristics:
+
+ * Descriptive MD
+ * Rights MD (rights could theoretically apply at any level but that's not in my use case)
+ * Provenance MD
+ * A PDF
+    * Technical metadata about the PDF
+ * Has one or two images (of front and back):
+    * A label for each surface
+    * A sort integer for each surface
+    * A TIFF of each surface
+      * Technical MD about the TIFF
+    * A JPEG2000 of each surface
+      * Technical MD about the JP2
+    * OCR of each page potentially in one or more flavors
+      * Technical MD about the OCR
+
+## A Book, Manuscript, or Ephemera
+
+Characteristics:
+
+ * Descriptive MD
+ * Rights MD (rights could theoretically apply at any level but that's not in my use case)
+ * Structural MD
+ * Provenance MD
+ * A PDF
+    * Technical metadata about the PDF
+ * Has many pages:
+    * A label for each page
+    * A sort integer for each page
+    * A TIFF of each page 
+      * Technical MD about the TIFF
+    * A JPEG2000 of each page 
+      * Technical MD about the JP2
+    * OCR of each page potentially in one or more flavors
+      * Technical MD about the OCR
+
+## A Book Set or (or Multi-part Manuscripts)
+
+Characteristics:
+
+Can have one or more physical volumes; below assumes multi. 
+
+ * Descriptive MD about the set
+ * Rights MD about the set
+ * For each member/volume:
+   * Descriptive MD
+   * Rights MD
+   * Structural MD
+   * Provenance MD
+   * A PDF
+      * Technical metadata about the PDF
+   * Has many pages:
+      * A label for each page
+      * A sort integer for each page
+      * A TIFF of each page 
+        * Technical MD about the TIFF
+      * A JPEG2000 of each page 
+        * Technical MD about the JP2
+      * OCR of each page potentially in one or more flavors
+        * Technical MD about the OCR
+
+## Photo Albums
+
+Characteristics:
+
+Can have one or more physical volumes. Below assumes this is the case.
+
+ * Descriptive MD about the set
+ * Rights MD about the set
+ * For each member/volume:
+   * Descriptive MD
+   * Rights MD
+   * Structural MD
+   * Provenance MD
+   * A PDF
+      * Technical metadata about the PDF
+   * Has many pages:
+      * A label for each page
+      * A sort integer for each page
+      * A TIFF of each page 
+        * Technical MD about the TIFF
+      * A JPEG2000 of each page 
+        * Technical MD about the JP2
+      * OCR of each page potentially in one or more flavors
+        * Technical MD about the OCR
+      * Has many detail images representing individual photos mounted on the page:
+        * A label for each page
+        * A sort integer for each page
+        * A TIFF of each page 
+          * Technical MD about the TIFF
+        * A JPEG2000 of each page 
+          * Technical MD about the JP2
+
+
+## Proposal
+
+No doubt there are other ways, but I feel confident that [this approach](https://github.com/projecthydra-labs/hydra-works/issues/9#issuecomment-58511913) would solve all of the above use cases. Validations included in subclasses of Hydra::Work would serve to constrain recursion.