hydra-works 0.1.0 → 0.2.0

data/lib/hydra/works.rb

@@ -7,25 +7,36 @@ module Hydra
   module Works
     extend ActiveSupport::Autoload
 
-    # vocabularies
-    autoload :WorksVocabularies,      'hydra/works/vocab/works_terms'
+    module Vocab
+      extend ActiveSupport::Autoload
+      eager_autoload do
+        autoload :WorksTerms
+      end
+    end
 
-    # models
-    autoload :Collection,             'hydra/works/models/collection'
-    autoload :GenericWork,            'hydra/works/models/generic_work'
-    autoload :GenericFile,            'hydra/works/models/generic_file'
+    autoload_under 'models' do
+      autoload :Collection
+      autoload :GenericWork
+      autoload :GenericFile
+    end
 
-    #behaviors
-    autoload :CollectionBehavior,     'hydra/works/models/concerns/collection_behavior'
-    autoload :GenericWorkBehavior,    'hydra/works/models/concerns/generic_work_behavior'
-    autoload :GenericFileBehavior,    'hydra/works/models/concerns/generic_file_behavior'
-    autoload :GenericFile,            'hydra/works/models/generic_file'
-    autoload :BlockChildObjects,      'hydra/works/models/concerns/block_child_objects'
+    autoload_under 'models/concerns' do
+      autoload :CollectionBehavior
+      autoload :GenericWorkBehavior
+      autoload :GenericFileBehavior
+      autoload :BlockChildObjects
+    end
 
-    # generic_file services
-    autoload :AddFileToGenericFile,    'hydra/works/services/generic_file/add_file_to_generic_file'
-    autoload :GenerateThumbnail,       'hydra/works/services/generic_file/generate/thumbnail'
-    autoload :UploadFileToGenericFile, 'hydra/works/services/generic_file/upload_file'
-    autoload :PersistDerivative,       'hydra/works/services/generic_file/persist_derivative'
+    autoload_under 'services/generic_file' do
+      autoload :AddFileToGenericFile
+      autoload :GenerateThumbnail
+      autoload :UploadFileToGenericFile
+      autoload :PersistDerivative
+      autoload :FullTextExtractionService
+    end
+
+    autoload_under 'errors' do
+      autoload :FullTextExtractionError
+    end
   end
 end

data/lib/hydra/works/errors/full_text_extraction_error.rb

@@ -0,0 +1,5 @@
+module Hydra::Works #:nodoc:
+  # Raised when full text extraction fails.
+  class FullTextExtractionError < StandardError
+  end
+end

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

@@ -1,16 +1,22 @@
 module Hydra::Works
   # Do not allow aggregation of child objects
   module BlockChildObjects
+    def objects=(_objects)
+      fail StandardError, "method `objects=' not allowed for #{self}"
+    end
 
-    def child_objects= objects
-      raise StandardError, "method `child_objects=' not allowed for #{self}"
+    def objects
+      fail StandardError, "method `objects' not allowed for #{self}"
     end
 
-    def child_objects
-      raise StandardError, "method `child_objects' not allowed for #{self}"
+    def child_objects=(new_objects)
+      warn '[DEPRECATION] `child_objects=` is deprecated in Hydra::Works.  Please use `objects=` instead.  This has a target date for removal of 10-31-2015'
+      self.objects = new_objects
     end
 
+    def child_objects
+      warn '[DEPRECATION] `child_objects` is deprecated in Hydra::Works.  Please use `objects` instead.  This has a target date for removal of 10-31-2015'
+      objects
+    end
   end
 end
-
-

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

@@ -1,5 +1,4 @@
 module Hydra::Works
-
   # This module provides all of the Behaviors of a Hydra::Works::Collection
   #
   # behavior:
@@ -19,11 +18,11 @@ module Hydra::Works
     include Hydra::PCDM::CollectionBehavior
 
     included do
-      type [RDFVocabularies::PCDMTerms.Collection,WorksVocabularies::WorksTerms.Collection]
+      type [Hydra::PCDM::Vocab::PCDMTerms.Collection, Vocab::WorksTerms.Collection]
       include Hydra::Works::BlockChildObjects
 
-      filters_association :members, as: :child_collections, condition: :works_collection?
-      filters_association :members, as: :child_generic_works, condition: :works_generic_work?
+      filters_association :members, as: :collections, condition: :works_collection?
+      filters_association :members, as: :generic_works, condition: :works_generic_work?
     end
 
     # @return [Boolean] whether this instance is a Hydra::Works Collection.
@@ -41,13 +40,52 @@ module Hydra::Works
       false
     end
 
-    def parents
+    def member_of
       aggregated_by
     end
 
-    def parent_collections
+    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_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_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'
+      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'
+      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
+    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
+    end
   end
 end

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

@@ -7,8 +7,8 @@ module Hydra::Works::GenericFile::ContainedFiles
 
   # TODO: se PCDM vocab class when projecthydra-labs/hydra-pcdm#80 is merged
   included do
-    directly_contains_one :original_file, through: :files, type: ::RDF::URI("http://pcdm.org/use#OriginalFile"), class_name: "Hydra::PCDM::File"
-    directly_contains_one :thumbnail, through: :files, type: ::RDF::URI("http://pcdm.org/use#ThumbnailImage"), class_name: "Hydra::PCDM::File"
-    directly_contains_one :extracted_text, through: :files, type: ::RDF::URI("http://pcdm.org/use#ExtractedText"), class_name: "Hydra::PCDM::File"
+    directly_contains_one :original_file, through: :files, type: ::RDF::URI('http://pcdm.org/use#OriginalFile'), class_name: 'Hydra::PCDM::File'
+    directly_contains_one :thumbnail, through: :files, type: ::RDF::URI('http://pcdm.org/use#ThumbnailImage'), class_name: 'Hydra::PCDM::File'
+    directly_contains_one :extracted_text, through: :files, type: ::RDF::URI('http://pcdm.org/use#ExtractedText'), class_name: 'Hydra::PCDM::File'
   end
 end

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

@@ -1,7 +1,7 @@
 module Hydra::Works::GenericFile
   module Derivatives
     extend ActiveSupport::Concern
-    
+
     included do
       include Hydra::Derivatives
 
@@ -21,8 +21,6 @@ module Hydra::Works::GenericFile
           obj.transform_file :original_file, thumbnail: { format: 'jpg', size: '200x150>' }
         end
       end
-
     end
-
   end
-end
+end

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

@@ -30,13 +30,11 @@ module Hydra::Works::GenericFile
 
     def file_format
       if mime_type.present? && format_label.present?
-        "#{mime_type.split('/').last} (#{format_label.join(", ")})"
+        "#{mime_type.split('/').last} (#{format_label.join(', ')})"
       elsif mime_type.present?
         mime_type.split('/').last
       elsif format_label.present?
         format_label
-      else
-        nil
       end
     end
 

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

@@ -1,18 +1,16 @@
 module Hydra::Works::GenericFile
   # Allows a GenericFile to treat the version history of the original_file as the GenericFile's version history
   module VersionedContent
-
     def content_versions
-      self.original_file.versions.all
+      original_file.versions.all
     end
 
     def latest_content_version
-      self.original_file.versions.last
+      original_file.versions.last
     end
 
     def current_content_version_uri
-      self.original_file.versions.last.uri
+      original_file.versions.last.uri
     end
-
   end
-end
+end

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

@@ -1,7 +1,7 @@
 module Hydra::Works::GenericFile
   module VirusCheck
     extend ActiveSupport::Concern
-    
+
     included do
       validate :detect_viruses
     end
@@ -29,20 +29,19 @@ module Hydra::Works::GenericFile
 
     private
 
-    # Returns a path for reading the content of +file+
-    # @param [File] file object to retrieve a path for
-    def local_path_for_file(file)
-      if file.respond_to?(:path)
-        file.path
-      else
-        Tempfile.open('') do |t|
-          t.binmode
-          t.write(file)
-          t.close
-          t.path
+      # Returns a path for reading the content of +file+
+      # @param [File] file object to retrieve a path for
+      def local_path_for_file(file)
+        if file.respond_to?(:path)
+          file.path
+        else
+          Tempfile.open('') do |t|
+            t.binmode
+            t.write(file)
+            t.close
+            t.path
+          end
         end
       end
-    end
-
   end
 end

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

@@ -13,7 +13,7 @@ module Hydra::Works
     include Hydra::PCDM::ObjectBehavior
 
     included do
-      type [RDFVocabularies::PCDMTerms.Object,WorksVocabularies::WorksTerms.GenericFile]
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object, Vocab::WorksTerms.GenericFile]
 
       include Hydra::Works::GenericFile::ContainedFiles
       include Hydra::Works::GenericFile::Derivatives
@@ -37,12 +37,22 @@ module Hydra::Works
       true
     end
 
-    def parents
+    def member_of
       aggregated_by
     end
 
-    def generic_works
+    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
+    end
   end
 end

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

@@ -17,17 +17,13 @@ module Hydra::Works
     include Hydra::PCDM::ObjectBehavior
 
     included do
-      type [RDFVocabularies::PCDMTerms.Object,WorksVocabularies::WorksTerms.GenericWork]
+      type [Hydra::PCDM::Vocab::PCDMTerms.Object, Vocab::WorksTerms.GenericWork]
       include Hydra::Works::BlockChildObjects
 
-      filters_association :members, as: :child_generic_works, condition: :works_generic_work?
+      filters_association :members, as: :generic_works, condition: :works_generic_work?
       filters_association :members, as: :generic_files, condition: :works_generic_file?
     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
-
     # @return [Boolean] whether this instance is a Hydra::Works Collection.
     def works_collection?
       false
@@ -43,17 +39,46 @@ module Hydra::Works
       false
     end
 
-    def parents
+    def member_of
       aggregated_by
     end
 
-    def parent_generic_works
+    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_collections
+    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
+    end
   end
 end

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

@@ -1,7 +1,6 @@
 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'
@@ -10,11 +9,9 @@ module Hydra::Works
     autoload :VersionedContent,       'hydra/works/models/concerns/generic_file/versioned_content'
     autoload :VirusCheck,             'hydra/works/models/concerns/generic_file/virus_check'
 
-
     # 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/services/generic_file/add_file_to_generic_file.rb

@@ -1,6 +1,5 @@
 module Hydra::Works
   class AddFileToGenericFile
-
     # Adds a file to the generic_file
     # @param [Hydra::PCDM::GenericFile::Base] generic_file the file will be added to
     # @param [IO,File,Rack::Multipart::UploadedFile, #read] object that will be the contents. If file responds to :mime_type, :content_type, :original_name, or :original_filename, those will be called to provide metadata.
@@ -9,10 +8,10 @@ module Hydra::Works
     # @param [Boolean] versioning whether to create new version entries (only applicable if +type+ corresponds to a versionable file)
 
     def self.call(generic_file, file, type, update_existing: true, versioning: true)
-      raise ArgumentError, "supplied object must be a generic file" unless generic_file.works_generic_file?
-      raise ArgumentError, "supplied file must respond to read" unless file.respond_to? :read
+      fail ArgumentError, 'supplied object must be a generic file' unless generic_file.works_generic_file?
+      fail ArgumentError, 'supplied file must respond to read' unless file.respond_to? :read
 
-      # TODO required as a workaround for https://github.com/projecthydra/active_fedora/pull/858
+      # TODO: required as a workaround for https://github.com/projecthydra/active_fedora/pull/858
       generic_file.save unless generic_file.persisted?
 
       updater_class = versioning ? VersioningUpdater : Updater
@@ -48,7 +47,7 @@ module Hydra::Works
           end
         end
 
-        def attach_attributes(file) 
+        def attach_attributes(file)
           current_file.content = file
           current_file.original_name = determine_original_name(file)
           current_file.mime_type = determine_mime_type(file)
@@ -64,7 +63,7 @@ module Hydra::Works
           elsif file.respond_to? :path
             return Hydra::PCDM::GetMimeTypeForFile.call(file.path)
           else
-            return "application/octet-stream"
+            return 'application/octet-stream'
           end
         end
 
@@ -78,7 +77,7 @@ module Hydra::Works
           elsif file.respond_to? :path
             return ::File.basename(file.path)
           else
-            return ""
+            return ''
           end
         end
 
@@ -87,10 +86,10 @@ module Hydra::Works
         def find_or_create_file(type, update_existing)
           if type.instance_of? Symbol
             association = generic_file.association(type)
-            raise ArgumentError, "you're attempting to add a file to a generic_file using '#{type}' association but the generic_file does not have an association called '#{type}''" unless association
+            fail ArgumentError, "you're attempting to add a file to a generic_file using '#{type}' association but the generic_file does not have an association called '#{type}''" unless association
 
             current_file = association.reader if update_existing
-            current_file ||= association.build
+            current_file || association.build
           else
             current_file = generic_file.filter_files_by_type(type_to_uri(type)).first if update_existing
             unless current_file
@@ -112,16 +111,15 @@ module Hydra::Works
           when String
             ::RDF::URI(type)
           else
-            raise ArgumentError, "Invalid file type.  You must submit a URI or a symbol."
+            fail ArgumentError, 'Invalid file type.  You must submit a URI or a symbol.'
           end
         end
-      end  
+    end
 
-      class VersioningUpdater < Updater
-        def update(*)
-          super && current_file.create_version
-        end
+    class VersioningUpdater < Updater
+      def update(*)
+        super && current_file.create_version
       end
+    end
   end
 end
-