hydra-works 0.2.0 → 0.3.0

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

@@ -3,10 +3,10 @@ module Hydra::Works
   #
   # behavior:
   #   1) Hydra::Works::Collection can aggregate Hydra::Works::Collection
-  #   2) Hydra::Works::Collection can aggregate Hydra::Works::GenericWork
+  #   2) Hydra::Works::Collection can aggregate Hydra::Works::Work
 
   #   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
+  #   4) Hydra::Works::Collection can NOT aggregate Hydra::Works::FileSet
   #   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
@@ -15,77 +15,85 @@ module Hydra::Works
   #   9) Hydra::Works::Collection can have access metadata
   module CollectionBehavior
     extend ActiveSupport::Concern
+    extend Deprecation
+    self.deprecation_horizon = "Hydra::Works 0.4.0"
     include Hydra::PCDM::CollectionBehavior
 
     included do
       type [Hydra::PCDM::Vocab::PCDMTerms.Collection, Vocab::WorksTerms.Collection]
-      include Hydra::Works::BlockChildObjects
 
-      filters_association :members, as: :collections, condition: :works_collection?
-      filters_association :members, as: :generic_works, condition: :works_generic_work?
+      alias_method :generic_works, :works
+      deprecation_deprecate :generic_works
+    end
+
+    def ordered_works
+      ordered_members.to_a.select(&:work?)
+    end
+
+    def ordered_work_ids
+      ordered_works.map(&:id)
+    end
+
+    def works
+      members.select(&:work?)
+    end
+
+    def work_ids
+      works.map(&:id)
     end
 
     # @return [Boolean] whether this instance is a Hydra::Works Collection.
-    def works_collection?
+    def collection?
       true
     end
 
+    alias_method :works_collection?, :collection?
+    deprecation_deprecate :works_collection?
+
     # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
-    def works_generic_work?
+    def work?
       false
     end
 
-    # @return [Boolean] whether this instance is a Hydra::Works Generic File.
-    def works_generic_file?
+    alias_method :works_generic_work?, :work?
+    deprecation_deprecate :works_generic_work?
+
+    # @return [Boolean] whether this instance is a Hydra::Works::FileSet.
+    def file_set?
       false
     end
 
-    def member_of
-      aggregated_by
-    end
+    alias_method :works_generic_file?, :file_set?
+    deprecation_deprecate :works_generic_file?
 
     def parents
-      warn '[DEPRECATION] `parents` is deprecated in Hydra::Works.  Please use `member_of` instead.  This has a target date for removal of 10-31-2015'
+      Deprecation.warn CollectionBehavior, '`parents` is deprecated in Hydra::Works.  Please use `member_of` instead.  This has a target date for removal of 10-31-2015'
       member_of
     end
 
-    def in_collections
-      aggregated_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::CollectionBehavior) }
-    end
-
     def parent_collections
-      warn '[DEPRECATION] `parent_collections` is deprecated in Hydra::Works.  Please use `in_collections` instead.  This has a target date for removal of 10-31-2015'
+      Deprecation.warn CollectionBehavior, '`parent_collections` is deprecated in Hydra::Works.  Please use `in_collections` instead.  This has a target date for removal of 10-31-2015'
       in_collections
     end
 
     def child_collections
-      warn '[DEPRECATION] `child_collections` is deprecated in Hydra::Works.  Please use `collections` instead.  This has a target date for removal of 10-31-2015'
+      Deprecation.warn CollectionBehavior, '`child_collections` is deprecated in Hydra::Works.  Please use `collections` instead.  This has a target date for removal of 10-31-2015'
       collections
     end
 
-    def child_collections=(new_collections)
-      warn '[DEPRECATION] `child_collections=` is deprecated in Hydra::Works.  Please use `collections=` instead.  This has a target date for removal of 10-31-2015'
-      self.collections = new_collections
-    end
-
     def child_collection_ids
-      warn '[DEPRECATION] `child_collection_ids` is deprecated in Hydra::Works.  Please use `collection_ids` instead.  This has a target date for removal of 10-31-2015'
+      Deprecation.warn CollectionBehavior, '`child_collection_ids` is deprecated in Hydra::Works.  Please use `collection_ids` instead.  This has a target date for removal of 10-31-2015'
       collection_ids
     end
 
     def child_generic_works
-      warn '[DEPRECATION] `child_generic_works` is deprecated in Hydra::Works.  Please use `generic_works` instead.  This has a target date for removal of 10-31-2015'
-      generic_works
-    end
-
-    def child_generic_works=(new_generic_works)
-      warn '[DEPRECATION] `child_generic_works=` is deprecated in Hydra::Works.  Please use `generic_works=` instead.  This has a target date for removal of 10-31-2015'
-      self.generic_works = new_generic_works
+      Deprecation.warn CollectionBehavior, '`child_generic_works` is deprecated in Hydra::Works.  Please use `works` instead.  This has a target date for removal of 10-31-2015'
+      works
     end
 
     def child_generic_work_ids
-      warn '[DEPRECATION] `child_generic_work_ids` is deprecated in Hydra::Works.  Please use `generic_work_ids` instead.  This has a target date for removal of 10-31-2015'
-      generic_work_ids
+      Deprecation.warn CollectionBehavior, '`child_generic_work_ids` is deprecated in Hydra::Works.  Please use `work_ids` instead.  This has a target date for removal of 10-31-2015'
+      work_ids
     end
   end
 end

data/lib/hydra/works/models/concerns/file_set/characterization/audio.rb

@@ -0,0 +1,14 @@
+module Hydra::Works::Characterization
+  module Audio
+    extend ActiveSupport::Concern
+
+    included do
+      # Apply the audio schema. This will add properties defined in the schema.
+      apply_schema AudioSchema, AlreadyThereStrategy
+
+      # Update the configuration to map the parsed terms to the correct property.
+      parser_mapping.merge!(audio_sample_rate: :sample_rate,
+                            audio_duration: :duration)
+    end
+  end
+end

data/lib/hydra/works/models/concerns/file_set/characterization/base.rb

@@ -0,0 +1,23 @@
+module Hydra::Works::Characterization
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      # Apply the base schema. This will add properties defined in the schema.
+      apply_schema BaseSchema, AlreadyThereStrategy
+
+      # Parser config is :term => :property.
+      # Use this config to override the default behavior of value assignment which is:
+      # value is assigned to the property with the same name as the characterization term.
+      # use parser_config.merge! for subsequent modules.
+      class_attribute :parser_mapping
+      self.parser_mapping = { exif_tool_version: :exif_version,
+                              file_mime_type: :mime_type }
+
+      # Parser class is an OM terminology.
+      # It maps the characterization tool's output xml to terms and values.
+      class_attribute :parser_class
+      self.parser_class = FitsDatastream
+    end
+  end
+end

data/lib/hydra/works/models/concerns/file_set/characterization/document.rb

@@ -0,0 +1,10 @@
+module Hydra::Works::Characterization
+  module Document
+    extend ActiveSupport::Concern
+
+    included do
+      # Apply the document schema. This will add properties defined in the schema.
+      apply_schema DocumentSchema, AlreadyThereStrategy
+    end
+  end
+end

data/lib/hydra/works/models/concerns/file_set/characterization/image.rb

@@ -0,0 +1,10 @@
+module Hydra::Works::Characterization
+  module Image
+    extend ActiveSupport::Concern
+
+    included do
+      # Apply the image schema. This will add properties defined in the schema.
+      apply_schema ImageSchema, AlreadyThereStrategy
+    end
+  end
+end

data/lib/hydra/works/models/concerns/file_set/characterization/video.rb

@@ -0,0 +1,17 @@
+module Hydra::Works::Characterization
+  module Video
+    extend ActiveSupport::Concern
+
+    included do
+      # Apply the module schema. This will add properties defined in the schema.
+      apply_schema VideoSchema, AlreadyThereStrategy
+
+      # Update the configuration to map the parsed terms to the correct property.
+      parser_mapping.merge!(video_sample_rate: :sample_rate,
+                            video_audio_sample_rate: :sample_rate,
+                            video_duration: :duration,
+                            video_width: :width,
+                            video_height: :height)
+    end
+  end
+end

data/lib/hydra/works/models/concerns/{generic_file → file_set}/contained_files.rb

@@ -1,4 +1,4 @@
-module Hydra::Works::GenericFile::ContainedFiles
+module Hydra::Works::ContainedFiles
   extend ActiveSupport::Concern
 
   # HydraWorks supports only one each of original_file, thumbnail, and extracted_text. However

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

@@ -0,0 +1,27 @@
+module Hydra::Works
+  module Derivatives
+    extend ActiveSupport::Concern
+    include Hydra::Derivatives
+
+    included do
+      # Sets output_file_service to PersistDerivative instead of default Hydra::Derivatives::PersistBasicContainedOutputFileService
+      Hydra::Derivatives.output_file_service = Hydra::Works::PersistDerivative
+    end
+
+    # Note, these derivatives are being fetched from Fedora, so there may be more
+    # network traffic than necessary.  If you want to avoid this, set up a
+    # source_file_service that fetches the files locally, as is done in CurationConcerns.
+    def create_derivatives
+      case original_file.mime_type
+      when *self.class.pdf_mime_types
+        Hydra::Derivatives::PdfDerivatives.create(self, source: :original_file, outputs: [{ label: :thumbnail, format: 'jpg', size: '338x493', object: self }])
+      when *self.class.office_document_mime_types
+        Hydra::Derivatives::DocumentDerivatives.create(self, source: :original_file, outputs: [{ label: :thumbnail, format: 'jpg', size: '200x150>', object: self }])
+      when *self.class.video_mime_types
+        Hydra::Derivatives::VideoDerivatives.create(self, source: :original_file, outputs: [{ label: :thumbnail, format: 'jpg', object: self }])
+      when *self.class.image_mime_types
+        Hydra::Derivatives::ImageDerivatives.create(self, source: :original_file, outputs: [{ label: :thumbnail, format: 'jpg', size: '200x150>', object: self }])
+      end
+    end
+  end
+end

data/lib/hydra/works/models/concerns/{generic_file → file_set}/mime_types.rb

@@ -1,5 +1,5 @@
 # This was taken directly from Sufia's GenericFile::MimeTypes
-module Hydra::Works::GenericFile
+module Hydra::Works
   module MimeTypes
     extend ActiveSupport::Concern
 

data/lib/hydra/works/models/concerns/{generic_file → file_set}/versioned_content.rb

@@ -1,5 +1,5 @@
-module Hydra::Works::GenericFile
-  # Allows a GenericFile to treat the version history of the original_file as the GenericFile's version history
+module Hydra::Works
+  # Allows a FileSet to treat the version history of the original_file as the FileSet's version history
   module VersionedContent
     def content_versions
       original_file.versions.all

data/lib/hydra/works/models/concerns/{generic_file → file_set}/virus_check.rb

@@ -1,4 +1,4 @@
-module Hydra::Works::GenericFile
+module Hydra::Works
   module VirusCheck
     extend ActiveSupport::Concern
 

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

@@ -0,0 +1,67 @@
+module Hydra::Works
+  # This module provides all of the Behaviors of a Hydra::Works::GenericFile
+  #
+  # behavior:
+  #   1) Hydra::Works::FileSet can contain (pcdm:hasFile) Hydra::PCDM::File   (inherits from Hydra::PCDM::Object)
+  #   2) Hydra::Works::FileSet can contain (pcdm:hasRelatedFile) Hydra::PCDM::File   (inherits from Hydra::PCDM::Object)
+  #   3) Hydra::Works::FileSet can aggregate (pcdm:hasMember) Hydra::Works::FileSet
+  #   4) Hydra::Works::FileSet can NOT aggregate anything other than Hydra::Works::FileSets
+  #   5) Hydra::Works::FileSet can have descriptive metadata
+  #   6) Hydra::Works::FileSet can have access metadata
+  module FileSetBehavior
+    extend ActiveSupport::Concern
+    extend Deprecation
+    self.deprecation_horizon = "Hydra::Works 0.4.0"
+    include Hydra::PCDM::ObjectBehavior
+
+    included do
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object, Vocab::WorksTerms.FileSet]
+
+      include Hydra::Works::ContainedFiles
+      include Hydra::Works::Derivatives
+      include Hydra::Works::MimeTypes
+      include Hydra::Works::VersionedContent
+    end
+
+    # @return [Boolean] whether this instance is a Hydra::Works Collection.
+    def collection?
+      false
+    end
+
+    alias_method :works_collection?, :collection?
+    deprecation_deprecate :works_collection?
+
+    # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
+    def work?
+      false
+    end
+
+    alias_method :works_generic_work?, :work?
+    deprecation_deprecate :works_generic_work?
+
+    # @return [Boolean] whether this instance is a Hydra::Works::FileSet.
+    def file_set?
+      true
+    end
+
+    alias_method :works_generic_file?, :file_set?
+    deprecation_deprecate :works_generic_file?
+
+    def parents
+      Deprecation.warn GenericFileBehavior, '`parents` is deprecated in Hydra::Works.  Please use `member_of` instead.  This has a target date for removal of 10-31-2015'
+      member_of
+    end
+
+    def in_works
+      ordered_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::WorkBehavior) }.to_a
+    end
+
+    alias_method :in_generic_works, :in_works
+    deprecation_deprecate :in_generic_works
+
+    def generic_works
+      Deprecation.warn GenericFileBehavior, '`generic_works` is deprecated in Hydra::Works.  Please use `in_works` instead.  This has a target date for removal of 10-31-2015'
+      in_works
+    end
+  end
+end

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

@@ -1,58 +1,12 @@
 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
+  # @deprecated use FileSetBehavior instead
   module GenericFileBehavior
     extend ActiveSupport::Concern
-    include Hydra::PCDM::ObjectBehavior
+    extend Deprecation
 
     included do
-      type [Hydra::PCDM::Vocab::PCDMTerms.Object, Vocab::WorksTerms.GenericFile]
-
-      include Hydra::Works::GenericFile::ContainedFiles
-      include Hydra::Works::GenericFile::Derivatives
-      include Hydra::Works::GenericFile::MimeTypes
-      include Hydra::Works::GenericFile::VersionedContent
-      include Hydra::Works::BlockChildObjects
-    end
-
-    # @return [Boolean] whether this instance is a Hydra::Works Collection.
-    def works_collection?
-      false
-    end
-
-    # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
-    def works_generic_work?
-      false
-    end
-
-    # @return [Boolean] whether this instance is a Hydra::Works Generic File.
-    def works_generic_file?
-      true
-    end
-
-    def member_of
-      aggregated_by
-    end
-
-    def parents
-      warn '[DEPRECATION] `parents` is deprecated in Hydra::Works.  Please use `member_of` instead.  This has a target date for removal of 10-31-2015'
-      member_of
-    end
-
-    def in_generic_works
-      aggregated_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::GenericWorkBehavior) }
-    end
-
-    def generic_works
-      warn '[DEPRECATION] `generic_works` is deprecated in Hydra::Works.  Please use `in_generic_works` instead.  This has a target date for removal of 10-31-2015'
-      in_generic_works
+      Deprecation.warn GenericFileBehavior, "GenericFileBehavior is deprecated. Use FileSetBehavior instead. This will be removed in Hydra::Works 0.4.0"
+      include FileSetBehavior
     end
   end
 end

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

@@ -1,84 +1,12 @@
 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
+  # @deprecated use Hydra::Works::WorkBehavior instead
   module GenericWorkBehavior
     extend ActiveSupport::Concern
-    include Hydra::PCDM::ObjectBehavior
-
+    extend Deprecation
+    self.deprecation_horizon = "Hydra::Works 0.4.0"
     included do
-      type [Hydra::PCDM::Vocab::PCDMTerms.Object, Vocab::WorksTerms.GenericWork]
-      include Hydra::Works::BlockChildObjects
-
-      filters_association :members, as: :generic_works, condition: :works_generic_work?
-      filters_association :members, as: :generic_files, condition: :works_generic_file?
-    end
-
-    # @return [Boolean] whether this instance is a Hydra::Works Collection.
-    def works_collection?
-      false
-    end
-
-    # @return [Boolean] whether this instance is a Hydra::Works Generic Work.
-    def works_generic_work?
-      true
-    end
-
-    # @return [Boolean] whether this instance is a Hydra::Works Generic File.
-    def works_generic_file?
-      false
-    end
-
-    def member_of
-      aggregated_by
-    end
-
-    def parents
-      warn '[DEPRECATION] `parents` is deprecated in Hydra::Works.  Please use `member_of` instead.  This has a target date for removal of 10-31-2015'
-      member_of
-    end
-
-    def in_generic_works
-      aggregated_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::GenericWorkBehavior) }
-    end
-
-    def parent_generic_works
-      warn '[DEPRECATION] `parent_generic_works` is deprecated in Hydra::Works.  Please use `in_generic_works` instead.  This has a target date for removal of 10-31-2015'
-      in_generic_works
-    end
-
-    def in_collections
-      aggregated_by.select { |parent| parent.class.included_modules.include?(Hydra::Works::CollectionBehavior) }
-    end
-
-    def parent_collections
-      warn '[DEPRECATION] `parent_collections` is deprecated in Hydra::Works.  Please use `in_collections` instead.  This has a target date for removal of 10-31-2015'
-      in_collections
-    end
-
-    def child_generic_works
-      warn '[DEPRECATION] `child_generic_works` is deprecated in Hydra::Works.  Please use `generic_works` instead.  This has a target date for removal of 10-31-2015'
-      generic_works
-    end
-
-    def child_generic_works=(new_generic_works)
-      warn '[DEPRECATION] `child_generic_works=` is deprecated in Hydra::Works.  Please use `generic_works=` instead.  This has a target date for removal of 10-31-2015'
-      self.generic_works = new_generic_works
-    end
-
-    def child_generic_work_ids
-      warn '[DEPRECATION] `child_generic_work_ids` is deprecated in Hydra::Works.  Please use `generic_work_ids` instead.  This has a target date for removal of 10-31-2015'
-      generic_work_ids
+      Deprecation.warn self, "GenericWorkBehavior is deprecated. Use WorkBehavior instead. This module will be removed in Hydra::Works 0.4.0"
+      include Hydra::Works::WorkBehavior
     end
   end
 end