hydra-works 0.0.1

data/lib/hydra/works/models/concerns/aggregates_generic_works.rb

@@ -0,0 +1,20 @@
+module Hydra::Works
+  # Allows instances of a class to aggregate (pcdm:hasMember) hydra-works generic works
+  module AggregatesGenericWorks
+
+    def generic_works= generic_works
+      raise ArgumentError, "each generic_work must be a hydra works generic work" unless generic_works.all? { |w| Hydra::Works.generic_work? w }
+      raise ArgumentError, "a generic work can't be an ancestor of itself" if self.respond_to?(:object_ancestor?) && object_ancestor?(generic_works)
+      if self.respond_to?(:generic_files)
+        self.members = self.generic_files + generic_works
+      else
+        self.members = generic_works
+      end
+    end
+
+    def generic_works
+      members.to_a.select { |m| Hydra::Works.generic_work? m }
+    end
+
+  end
+end

data/lib/hydra/works/models/concerns/collection_behavior.rb

@@ -0,0 +1,28 @@
+module Hydra::Works
+
+  # This module provides all of the Behaviors of a Hydra::Works::Collection
+  #
+  # behavior:
+  #   1) Hydra::Works::Collection can aggregate Hydra::Works::Collection
+  #   2) Hydra::Works::Collection can aggregate Hydra::Works::GenericWork
+
+  #   3) Hydra::Works::Collection can NOT aggregate Hydra::PCDM::Collection unless it is also a Hydra::Works::Collection
+  #   4) Hydra::Works::Collection can NOT aggregate Hydra::Works::GenericFile
+  #   5) Hydra::Works::Collection can NOT aggregate non-PCDM object
+  #   6) Hydra::Works::Collection can NOT contain Hydra::PCDM::File
+  #   7) Hydra::Works::Collection can NOT contain
+
+  #   8) Hydra::Works::Collection can have descriptive metadata
+  #   9) Hydra::Works::Collection can have access metadata
+  module CollectionBehavior
+    extend ActiveSupport::Concern
+    include Hydra::PCDM::CollectionBehavior
+
+    included do
+      type [RDFVocabularies::PCDMTerms.Collection,WorksVocabularies::WorksTerms.Collection]
+      include Hydra::Works::AggregatesGenericWorks
+      include Hydra::Works::AggregatesCollections
+    end
+
+  end
+end

data/lib/hydra/works/models/concerns/generic_file/contained_files.rb

@@ -0,0 +1,22 @@
+module Hydra::Works::GenericFile::ContainedFiles
+  extend ActiveSupport::Concern
+
+  # HydraWorks supports only one each of original_file, thumbnail, and extracted_text. However
+  # you are free to add an unlimited number of addtition types such as different resolutions
+  # of images, different derivatives, etc, and use any established vocabulary you choose.
+
+  # TODO: se PCDM vocab class when projecthydra-labs/hydra-pcdm#80 is merged
+  
+  def original_file
+    file_of_type(::RDF::URI("http://pcdm.org/OriginalFile"))
+  end
+
+  def thumbnail
+    file_of_type(::RDF::URI("http://pcdm.org/ThumbnailImage"))
+  end
+
+  def extracted_text
+    file_of_type(::RDF::URI("http://pcdm.org/ExtractedText"))
+  end
+
+end

data/lib/hydra/works/models/concerns/generic_file/derivatives.rb

@@ -0,0 +1,32 @@
+module Hydra::Works::GenericFile
+  module Derivatives
+    extend ActiveSupport::Concern
+    
+    included do
+      include Hydra::Derivatives
+
+      # This was taken directly from Sufia's GenericFile::Derivatives and modified to exclude any processing that modified the original file
+      makes_derivatives do |obj|
+        case obj.mime_type
+        when *pdf_mime_types
+          obj.transform_file :original_file, { thumbnail: { format: 'jpg', size: '338x493', datastream: 'thumbnail' } }, processor: :work
+        when *office_document_mime_types
+          obj.transform_file :original_file, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }, processor: :document
+        when *video_mime_types
+          obj.transform_file :original_file, { thumbnail: { format: 'jpg', datastream: 'thumbnail' } }, processor: :video
+        when *image_mime_types
+          obj.transform_file :original_file, { thumbnail: { format: 'jpg', size: '200x150>', datastream: 'thumbnail' } }, processor: :work
+        end
+      end
+
+    end
+
+    # This bit was not in Sufia, but needs to be here for derivatives to work
+    # TODO: delegate mime type somewhere else?
+    def mime_type
+      return nil unless self.original_file
+      self.original_file.mime_type
+    end
+
+  end
+end

data/lib/hydra/works/models/concerns/generic_file/mime_types.rb

@@ -0,0 +1,69 @@
+# This was taken directly from Sufia's GenericFile::MimeTypes
+module Hydra::Works::GenericFile
+  module MimeTypes
+    extend ActiveSupport::Concern
+
+    def pdf?
+      self.class.pdf_mime_types.include? self.mime_type
+    end
+
+    def image?
+      self.class.image_mime_types.include? self.mime_type
+    end
+
+    def video?
+      self.class.video_mime_types.include? self.mime_type
+    end
+
+    def audio?
+      self.class.audio_mime_types.include? self.mime_type
+    end
+
+    def office_document?
+      self.class.office_document_mime_types.include? self.mime_type
+    end
+
+    # TODO: remove?
+    def collection?
+      false
+    end
+
+    def file_format
+      return nil if self.mime_type.blank? and self.format_label.blank?
+      return self.mime_type.split('/')[1]+ " ("+self.format_label.join(", ")+")" unless self.mime_type.blank? or self.format_label.blank?
+      return self.mime_type.split('/')[1] unless self.mime_type.blank?
+      return self.format_label
+    end
+
+    module ClassMethods
+      def image_mime_types
+        ['image/png', 'image/jpeg', 'image/jpg', 'image/jp2', 'image/bmp', 'image/gif', 'image/tiff']
+      end
+
+      def pdf_mime_types
+        ['application/pdf']
+      end
+
+      def video_mime_types
+        ['video/mpeg', 'video/mp4', 'video/webm', 'video/x-msvideo', 'video/avi', 'video/quicktime', 'application/mxf']
+      end
+
+      def audio_mime_types
+        # audio/x-wave is the mime type that fits 0.6.0 returns for a wav file.
+        # audio/mpeg is the mime type that fits 0.6.0 returns for an mp3 file.
+        ['audio/mp3', 'audio/mpeg', 'audio/wav', 'audio/x-wave', 'audio/x-wav', 'audio/ogg']
+      end
+
+      def office_document_mime_types
+        ['text/rtf',
+         'application/msword',
+         'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+         'application/vnd.oasis.opendocument.text',
+         'application/vnd.ms-excel',
+         'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+         'application/vnd.ms-powerpoint',
+         'application/vnd.openxmlformats-officedocument.presentationml.presentation']
+      end
+    end
+  end
+end

data/lib/hydra/works/models/concerns/generic_file_behavior.rb

@@ -0,0 +1,25 @@
+module Hydra::Works
+  # This module provides all of the Behaviors of a Hydra::Works::GenericFile
+  #
+  # behavior:
+  #   1) Hydra::Works::GenericFile can contain (pcdm:hasFile) Hydra::PCDM::File   (inherits from Hydra::PCDM::Object)
+  #   2) Hydra::Works::GenericFile can contain (pcdm:hasRelatedFile) Hydra::PCDM::File   (inherits from Hydra::PCDM::Object)
+  #   3) Hydra::Works::GenericFile can aggregate (pcdm:hasMember) Hydra::Works::GenericFile
+  #   4) Hydra::Works::GenericFile can NOT aggregate anything other than Hydra::Works::GenericFiles
+  #   5) Hydra::Works::GenericFile can have descriptive metadata
+  #   6) Hydra::Works::GenericFile can have access metadata
+  module GenericFileBehavior
+    extend ActiveSupport::Concern
+    include Hydra::PCDM::ObjectBehavior
+
+    included do
+      type [RDFVocabularies::PCDMTerms.Object,WorksVocabularies::WorksTerms.GenericFile]
+
+      include Hydra::Works::AggregatesGenericFiles
+      include Hydra::Works::GenericFile::ContainedFiles
+      include Hydra::Works::GenericFile::Derivatives
+      include Hydra::Works::GenericFile::MimeTypes
+    end
+
+  end
+end

data/lib/hydra/works/models/concerns/generic_work_behavior.rb

@@ -0,0 +1,30 @@
+module Hydra::Works
+  # This module provides all of the Behaviors of a Hydra::Works::GenericWork
+  #
+  # behavior:
+  #   1) Hydra::Works::GenericWork can aggregate Hydra::Works::GenericWork
+  #   2) Hydra::Works::GenericWork can aggregate Hydra::Works::GenericFile
+  #   3) Hydra::Works::GenericWork can NOT aggregate Hydra::PCDM::Collection
+  #   4) Hydra::Works::GenericWork can NOT aggregate Hydra::Works::Collection
+  #   5) Hydra::Works::GenericWork can NOT aggregate Works::Object unless it is also a Hydra::Works::GenericFile
+  #   6) Hydra::Works::GenericWork can NOT contain PCDM::File
+  #   7) Hydra::Works::GenericWork can NOT aggregate non-PCDM object
+  #   8) Hydra::Works::GenericWork can NOT contain Hydra::Works::GenericFile
+  #   9) Hydra::Works::GenericWork can have descriptive metadata
+  #   10) Hydra::Works::GenericWork can have access metadata
+  module GenericWorkBehavior
+    extend ActiveSupport::Concern
+    include Hydra::PCDM::ObjectBehavior
+
+    included do
+      type [RDFVocabularies::PCDMTerms.Object,WorksVocabularies::WorksTerms.GenericWork]
+      include Hydra::Works::AggregatesGenericFiles
+      include Hydra::Works::AggregatesGenericWorks
+    end
+
+    def contains= files
+      raise NoMethodError, "works can not directly contain files.  You must add a GenericFile to the work's members and add files to that GenericFile."
+    end
+
+  end
+end

data/lib/hydra/works/models/generic_file.rb

@@ -0,0 +1,17 @@
+module Hydra::Works
+  # Namespace for Modules with functionality specific to GenericFiles
+  module GenericFile
+
+    extend ActiveSupport::Concern
+
+    autoload :Derivatives,            'hydra/works/models/concerns/generic_file/derivatives'
+    autoload :MimeTypes,              'hydra/works/models/concerns/generic_file/mime_types'
+    autoload :ContainedFiles,         'hydra/works/models/concerns/generic_file/contained_files'
+
+    # Base class for creating objects that behave like Hydra::Works::GenericFiles
+    class Base < ActiveFedora::Base
+      include Hydra::Works::GenericFileBehavior
+    end
+
+  end
+end

data/lib/hydra/works/models/generic_work.rb

@@ -0,0 +1,9 @@
+module Hydra::Works
+  # Namespace for Modules with functionality specific to GenericWorks
+  module GenericWork
+    # Base class for creating objects that behave like Hydra::Works::GenericWorks
+    class Base < ActiveFedora::Base
+      include Hydra::Works::GenericWorkBehavior
+    end
+  end
+end

data/lib/hydra/works/processor.rb

@@ -0,0 +1,9 @@
+module Hydra::Derivatives
+  class Work < Hydra::Derivatives::Image
+
+    def source_file
+      object.send(source_name.to_s)
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/add_collection.rb

@@ -0,0 +1,19 @@
+module Hydra::Works
+  class AddCollectionToCollection
+
+    ##
+    # Add a collection to a collection.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection to which to add collection
+    # @param [Hydra::Works::Collection] :child_collection being added
+    #
+    # @return [Hydra::Works::Collection] the updated hydra works collection
+
+    def self.call( parent_collection, child_collection )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      raise ArgumentError, 'child_collection must be a hydra-works collection' unless Hydra::Works.collection? child_collection
+      Hydra::PCDM::AddCollectionToCollection.call( parent_collection, child_collection )
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/add_generic_work.rb

@@ -0,0 +1,19 @@
+module Hydra::Works
+  class AddGenericWorkToCollection
+
+    ##
+    # Add a generic_work to a collection.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection to which to add generic_work
+    # @param [Hydra::Works::GenericWork::Base] :child_generic_work being added
+    #
+    # @return [Hydra::Works::Collection] the updated hydra works collection
+
+    def self.call( parent_collection, child_generic_work )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      raise ArgumentError, 'child_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? child_generic_work
+      Hydra::PCDM::AddObjectToCollection.call( parent_collection, child_generic_work )
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/add_related_object.rb

@@ -0,0 +1,19 @@
+module Hydra::Works
+  class AddRelatedObjectToCollection
+
+    ##
+    # Add a related object to a collection.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection to which to add the related object
+    # @param [Hydra::PCDM::Object] :child_related_object being added
+    #
+    # @return [Hydra::Works::Collection] the updated hydra works collection
+
+    def self.call( parent_collection, child_related_object )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      raise ArgumentError, 'child_related_object must be a pcdm object' unless Hydra::PCDM.object? child_related_object
+      Hydra::PCDM::AddRelatedObjectToCollection.call( parent_collection, child_related_object )
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/get_collections.rb

@@ -0,0 +1,17 @@
+module Hydra::Works
+  class GetCollectionsFromCollection
+
+    ##
+    # Get member collections from a collection in order.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection in which the child collections are members
+    #
+    # @return [Array<Hydra::Works::Collection>] all member collections
+
+    def self.call( parent_collection )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      parent_collection.collections
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/get_generic_works.rb

@@ -0,0 +1,17 @@
+module Hydra::Works
+  class GetGenericWorksFromCollection
+
+    ##
+    # Get member generic works from a collection in order.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection in which the child generic works are members
+    #
+    # @return [Array<Hydra::Works::GenericWork::Base>] all member generic works
+
+    def self.call( parent_collection )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      parent_collection.generic_works
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/get_related_objects.rb

@@ -0,0 +1,17 @@
+module Hydra::Works
+  class GetRelatedObjectsFromCollection
+
+    ##
+    # Get related objects from a collection.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection to which the child objects are related
+    #
+    # @return [Array<Hydra::Works::Collection>] all related objects
+
+    def self.call( parent_collection )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      Hydra::PCDM::GetRelatedObjectsFromCollection.call( parent_collection )
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/remove_collection.rb

@@ -0,0 +1,19 @@
+module Hydra::Works
+  class RemoveCollectionFromCollection
+
+    ##
+    # Remove a collection from a collection.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection from which to remove collection
+    # @param [Hydra::Works::Collection] :child_collection being removed
+    #
+    # @return [Hydra::Works::Collection] the updated hydra works collection
+
+    def self.call( parent_collection, child_collection )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      raise ArgumentError, 'child_collection must be a hydra-works collection' unless Hydra::Works.collection? child_collection
+      Hydra::PCDM::RemoveCollectionFromCollection.call( parent_collection, child_collection )
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/remove_generic_work.rb

@@ -0,0 +1,20 @@
+module Hydra::Works
+  class RemoveGenericWorkFromCollection
+
+    ##
+    # Remove a generic_work from a collection.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection from which to remove generic_work
+    # @param [Hydra::Works::GenericWork::Base] :child_generic_work being removed
+    # @param [Fixnum] :nth_occurrence remove nth occurrence of this generic_work in the list (default=1)
+    #
+    # @return [Hydra::Works::Collection] the updated hydra works collection
+
+    def self.call( parent_collection, child_generic_work, nth_occurrence=1 )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      raise ArgumentError, 'child_generic_work must be a hydra-works generic work' unless Hydra::Works.generic_work? child_generic_work
+      Hydra::PCDM::RemoveObjectFromCollection.call( parent_collection, child_generic_work, nth_occurrence )
+    end
+
+  end
+end

data/lib/hydra/works/services/collection/remove_related_object.rb

@@ -0,0 +1,19 @@
+module Hydra::Works
+  class RemoveRelatedObjectFromCollection
+
+    ##
+    # Remove a related object from a collection.
+    #
+    # @param [Hydra::Works::Collection] :parent_collection from which to remove the related object
+    # @param [Hydra::PCDM::Object] :child_related_object being removed
+    #
+    # @return [Hydra::Works::Collection] the updated hydra works collection
+
+    def self.call( parent_collection, child_related_object )
+      raise ArgumentError, 'parent_collection must be a hydra-works collection' unless Hydra::Works.collection? parent_collection
+      raise ArgumentError, 'child_related_object must be a pcdm object' unless Hydra::PCDM.object? child_related_object
+      Hydra::PCDM::RemoveRelatedObjectFromCollection.call( parent_collection, child_related_object )
+    end
+
+  end
+end