hyrax 5.0.0.rc1 → 5.0.0.rc3

data/app/models/concerns/hyrax/ability/collection_ability.rb

@@ -3,52 +3,50 @@ module Hyrax
   module Ability
     module CollectionAbility
       def collection_abilities # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-        models = [Hyrax::PcdmCollection, Hyrax.config.collection_class].uniq
+        models = Hyrax::ModelRegistry.collection_classes
         if admin?
-          models.each do |collection_model|
-            can :manage, collection_model
-            can :manage_any, collection_model
-            can :create_any, collection_model
-            can :view_admin_show_any, collection_model
-          end
+          can :manage, models
+          can :manage_any, models
+          can :create_any, models
+          can :view_admin_show_any, models
         else
-          models.each { |collection_model| can :manage_any, collection_model } if
-            Hyrax::Collections::PermissionsService.can_manage_any_collection?(ability: self)
+          can :manage_any, models if Hyrax::Collections::PermissionsService.can_manage_any_collection?(ability: self)
 
-          models.each { |collection_model| can :create_any, collection_model } if
-            Hyrax::CollectionTypes::PermissionsService.can_create_any_collection_type?(ability: self)
+          can :create_any, models if Hyrax::CollectionTypes::PermissionsService.can_create_any_collection_type?(ability: self)
 
-          models.each { |collection_model| can :view_admin_show_any, collection_model } if
-          Hyrax::Collections::PermissionsService.can_view_admin_show_for_any_collection?(ability: self)
+          can :view_admin_show_any, models if Hyrax::Collections::PermissionsService.can_view_admin_show_for_any_collection?(ability: self)
 
-          models.each do |collection_model|
-            can [:edit, :update, :destroy], collection_model do |collection|
-              test_edit(collection.id)
-            end
+          can [:edit, :update, :destroy], models do |collection|
+            test_edit(collection.id)
+          end
 
-            can :deposit, collection_model do |collection|
-              Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: collection.id)
-            end
+          can :deposit, models do |collection|
+            Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: collection.id)
+          end
 
-            can :view_admin_show, collection_model do |collection| # admin show page
-              Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: collection.id)
-            end
+          can :view_admin_show, models do |collection| # admin show page
+            Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: collection.id)
+          end
 
-            can :read, collection_model do |collection| # public show page
-              test_read(collection.id)
-            end
+          can :read, models do |collection| # public show page
+            test_read(collection.id)
           end
 
           can :deposit, ::SolrDocument do |solr_doc|
             Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: solr_doc.id) # checks collections and admin_sets
           end
-          can :deposit, String do |collection_id|
-            Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: collection_id)
+
+          can :deposit, [::String, ::Valkyrie::ID] do |collection_id|
+            Hyrax::Collections::PermissionsService.can_deposit_in_collection?(ability: self, collection_id: collection_id.to_s)
           end
 
           can :view_admin_show, ::SolrDocument do |solr_doc| # admin show page
             Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: solr_doc.id) # checks collections and admin_sets
           end
+
+          can :view_admin_show, [::String, ::Valkyrie::ID] do |collection_id| # admin show page
+            Hyrax::Collections::PermissionsService.can_view_admin_show_for_collection?(ability: self, collection_id: collection_id.to_s) # checks collections and admin_sets
+          end
         end
       end
     end

data/app/models/concerns/hyrax/ability/resource_ability.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Hyrax
+  module Ability
+    module ResourceAbility
+      def resource_abilities
+        if admin?
+          can [:manage], ::Hyrax::Resource
+        else
+          can [:edit, :update, :destroy], ::Hyrax::Resource do |res|
+            test_edit(res.id)
+          end
+          can :read, ::Hyrax::Resource do |res|
+            test_read(res.id)
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/hyrax/ability.rb

@@ -53,6 +53,7 @@ module Hyrax
       include Hyrax::Ability::CollectionAbility
       include Hyrax::Ability::CollectionTypeAbility
       include Hyrax::Ability::PermissionTemplateAbility
+      include Hyrax::Ability::ResourceAbility
       include Hyrax::Ability::SolrDocumentAbility
 
       class_attribute :admin_group_name, :registered_group_name, :public_group_name
@@ -76,6 +77,7 @@ module Hyrax
                              :collection_abilities,
                              :collection_type_abilities,
                              :permission_template_abilities,
+                             :resource_abilities,
                              :solr_document_abilities,
                              :trophy_abilities]
     end
@@ -102,7 +104,7 @@ module Hyrax
     # Returns true if can create at least one type of work and they can deposit
     # into at least one AdminSet
     def can_create_any_work?
-      Hyrax.config.curation_concerns.any? do |curation_concern_type|
+      curation_concerns_models.any? do |curation_concern_type|
         can?(:create, curation_concern_type)
       end && admin_set_with_deposit?
     end
@@ -122,8 +124,8 @@ module Hyrax
     #
     # Overrides hydra-head, (and restores the method from blacklight-access-controls)
     def download_permissions
-      can :download, String do |id|
-        test_download(id)
+      can :download, [::String, ::Valkyrie::ID] do |id|
+        test_download(id.to_s)
       end
 
       can :download, ::SolrDocument do |obj|
@@ -187,8 +189,8 @@ module Hyrax
     #   self.ability_logic += [:proxy_deposit_abilities]
     def proxy_deposit_abilities
       if Flipflop.transfer_works?
-        can :transfer, String do |id|
-          user_is_depositor?(id)
+        can :transfer, [::String, Valkyrie::ID] do |id|
+          user_is_depositor?(id.to_s)
         end
       end
 
@@ -366,10 +368,11 @@ module Hyrax
       alias_action :show, to: :read
       alias_action :discover, to: :read
       can :update, :appearance
-      can :manage, String # The identifier of a work or FileSet
+      can :manage, [String, Valkyrie::ID] # The identifier of a work or FileSet
       can :manage, curation_concerns_models
       can :manage, Sipity::WorkflowResponsibility
       can :manage, :collection_types
+      can :manage, ::FileSet
     end
 
     ##
@@ -411,14 +414,14 @@ module Hyrax
     end
 
     # Returns true if the current user is the depositor of the specified work
-    # @param document_id [String] the id of the document.
+    # @param document_id [String, Valkyrie::ID] the id of the document.
     def user_is_depositor?(document_id)
-      doc = Hyrax::SolrService.search_by_id(document_id, fl: 'depositor_ssim')
+      doc = Hyrax::SolrService.search_by_id(document_id.to_s, fl: 'depositor_ssim')
       current_user.user_key == doc['depositor_ssim']&.first
     end
 
     def curation_concerns_models
-      [::FileSet, Hyrax.config.collection_class] + Hyrax.config.curation_concerns
+      Hyrax::ModelRegistry.collection_classes + Hyrax::ModelRegistry.file_set_classes + Hyrax::ModelRegistry.work_classes
     end
 
     def can_review_submissions?

data/app/models/concerns/hyrax/collection_behavior.rb

@@ -17,7 +17,15 @@ module Hyrax
 
       self.indexer = Hyrax::CollectionIndexer
 
+      ##
+      # @!group Class Attributes
+      #
+      # @!attribute internal_resource
+      #   @return [String]
+      class_attribute :internal_resource, default: "Collection"
+
       class_attribute :index_collection_type_gid_as, instance_writer: false
+      ##
       self.index_collection_type_gid_as = [:symbol]
 
       property :collection_type_gid, predicate: ::RDF::Vocab::SCHEMA.additionalType, multiple: false do |index|
@@ -28,9 +36,11 @@ module Hyrax
       validates :collection_type_gid, presence: true
 
       # Need to define here in order to override setter defined by ActiveTriples
-      def collection_type_gid=(new_collection_type_gid, force: false)
+      def collection_type_gid=(new_collection_type_gid)
         new_collection_type_gid = new_collection_type_gid&.to_s
-        raise "Can't modify collection type of this collection" if !force && persisted? && !collection_type_gid_was.nil? && collection_type_gid_was != new_collection_type_gid
+        raise "Can't modify collection type of this collection" if
+          !Thread.current[:force_collection_type_gid] && # Used by update_collection_type_global_ids rake task
+          persisted? && !collection_type_gid_was.nil? && collection_type_gid_was != new_collection_type_gid
         new_collection_type = Hyrax::CollectionType.find_by_gid!(new_collection_type_gid)
         super(new_collection_type_gid)
         @collection_type = new_collection_type
@@ -38,16 +48,6 @@ module Hyrax
       end
     end
 
-    delegate(*Hyrax::CollectionType.settings_attributes, to: :collection_type)
-    ActiveSupport::Deprecation.deprecate_methods(self, *Hyrax::CollectionType.settings_attributes)
-
-    # Get the collection_type when accessed
-    def collection_type
-      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                         "Instead, use Hyrax::CollectionType.for(collection: collection).")
-      @collection_type ||= Hyrax::CollectionType.find_by_gid!(collection_type_gid)
-    end
-
     def collection_type=(new_collection_type)
       self.collection_type_gid = new_collection_type.to_global_id
     end

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -53,25 +53,25 @@ module Hyrax
     ##
     # @return [Boolean]
     def collection?
-      hydra_model == Hyrax.config.collection_class
+      Hyrax::ModelRegistry.collection_classes.include?(hydra_model)
     end
 
     ##
     # @return [Boolean]
     def file_set?
-      hydra_model == ::FileSet || hydra_model == Hyrax::FileSet
+      Hyrax::ModelRegistry.file_set_classes.include?(hydra_model)
     end
 
     ##
     # @return [Boolean]
     def admin_set?
-      hydra_model == Hyrax.config.admin_set_class
+      Hyrax::ModelRegistry.admin_set_classes.include?(hydra_model)
     end
 
     ##
     # @return [Boolean]
     def work?
-      Hyrax.config.curation_concerns.include? hydra_model
+      Hyrax::ModelRegistry.work_classes.include?(hydra_model)
     end
 
     # Method to return the model
@@ -86,14 +86,15 @@ module Hyrax
     end
 
     def creator
+      # TODO: should we replace "hydra_model == AdminSet" with by #admin_set?
       solr_term = hydra_model == AdminSet ? "creator_ssim" : "creator_tesim"
       fetch(solr_term, [])
     end
 
     def visibility
-      @visibility ||= if embargo_release_date.present?
+      @visibility ||= if embargo_enforced?
                         Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_EMBARGO
-                      elsif lease_expiration_date.present?
+                      elsif lease_enforced?
                         Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_LEASE
                       elsif public?
                         Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
@@ -108,6 +109,32 @@ module Hyrax
       first(Hyrax.config.collection_type_index_field)
     end
 
+    def embargo_enforced?
+      return false if embargo_release_date.blank?
+
+      indexed_embargo_visibility = first('visibility_during_embargo_ssim')
+      # if we didn't index an embargo visibility, assume the release date means
+      # it's enforced
+      return true if indexed_embargo_visibility.blank?
+
+      # if the visibility and the visibility during embargo are the same, we're
+      # enforcing the embargo
+      self['visibility_ssi'] == indexed_embargo_visibility
+    end
+
+    def lease_enforced?
+      return false if lease_expiration_date.blank?
+
+      indexed_lease_visibility = first('visibility_during_lease_ssim')
+      # if we didn't index an embargo visibility, assume the release date means
+      # it's enforced
+      return true if indexed_lease_visibility.blank?
+
+      # if the visibility and the visibility during lease are the same, we're
+      # enforcing the lease
+      self['visibility_ssi'] == indexed_lease_visibility
+    end
+
     private
 
     def model_classifier(classifier)

data/app/models/concerns/hyrax/work_behavior.rb

@@ -30,6 +30,10 @@ module Hyrax
       self.default_system_virus_scanner = Hyrax::VirusScanner
     end
 
+    def to_rdf_representation
+      self.class.to_rdf_representation
+    end
+
     module ClassMethods
       # This governs which partial to draw when you render this type of object
       def _to_partial_path # :nodoc:

data/app/models/featured_work.rb

@@ -1,21 +1,29 @@
 # frozen_string_literal: true
 class FeaturedWork < ActiveRecord::Base
-  FEATURE_LIMIT = 5
+  ##
+  # @!group Class Attributes
+  #
+  # @!attribute feature_limit [r|w]
+  #   @return [Integer]
+  class_attribute :feature_limit, default: 5
+  # @!endgroup Class Attributes
+  ##
+
   validate :count_within_limit, on: :create
-  validates :order, inclusion: { in: proc { 0..FEATURE_LIMIT } }
+  validates :order, inclusion: { in: proc { 0..feature_limit } }
 
   default_scope { order(:order) }
 
   def count_within_limit
     return if FeaturedWork.can_create_another?
-    errors.add(:base, "Limited to #{FEATURE_LIMIT} featured works.")
+    errors.add(:base, "Limited to #{feature_limit} featured works.")
   end
 
   attr_accessor :presenter
 
   class << self
     def can_create_another?
-      FeaturedWork.count < FEATURE_LIMIT
+      FeaturedWork.count < feature_limit
     end
   end
 end

data/app/models/file_set.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Provide plain file set model if not defined by the application.
+# Needed until Hyrax internals do not assume its existence.
+class ::FileSet < Hyrax.config.file_set_class; end unless '::FileSet'.safe_constantize

data/app/models/hyrax/administrative_set.rb

@@ -33,7 +33,7 @@ module Hyrax
 
     ##
     # @return [Boolean] true
-    def collection?
+    def self.pcdm_collection?
       true
     end
 

data/app/models/hyrax/change_set.rb

@@ -21,8 +21,8 @@ module Hyrax
 
       ##
       # @return [String]
-      def self.inspect
-        return "Hyrax::ChangeSet(#{model_class})" if name.blank?
+      define_singleton_method :inspect do
+        return "Hyrax::ChangeSet(#{resource_class})" if name.blank?
         super
       end
     end

data/app/models/hyrax/counter_metric.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hyrax
+  class CounterMetric < ApplicationRecord
+    validates :work_id, :date, presence: true
+  end
+end

data/app/models/hyrax/file_metadata.rb

@@ -18,7 +18,7 @@ module Hyrax
                        "with id #{file.id}. Initializing a new one")
 
     FileMetadata.new(file_identifier: file.id,
-                     original_filename: File.basename(file.io))
+                     original_filename: File.basename(file.disk_path))
   end
 
   class FileMetadata < Valkyrie::Resource
@@ -32,25 +32,39 @@ module Hyrax
     # Constants for PCDM Use URIs; use these constants in place of hard-coded
     # URIs in the `::Valkyrie::Vocab::PCDMUse` vocabulary.
     module Use
-      ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
       EXTRACTED_TEXT = ::Valkyrie::Vocab::PCDMUse.ExtractedText
-      THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
+      INTERMEDIATE_FILE = ::Valkyrie::Vocab::PCDMUse.IntermediateFile
+      ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
+      PRESERVATION_FILE = ::Valkyrie::Vocab::PCDMUse.PreservationFile
+      SERVICE_FILE = ::Valkyrie::Vocab::PCDMUse.ServiceFile
+      THUMBNAIL_IMAGE = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
+      TRANSCRIPT = ::Valkyrie::Vocab::PCDMUse.Transcript
+
+      THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage # for compatibility with earlier versions of Hyrax; prefer +THUMBNAIL_IMAGE+
 
       ##
       # @param use [RDF::URI, Symbol]
       #
       # @return [RDF::URI]
       # @raise [ArgumentError] if no use is known for the argument
-      def uri_for(use:)
+      def uri_for(use:) # rubocop:disable Metrics/MethodLength
         case use
         when RDF::URI
           use
-        when :original_file
-          ORIGINAL_FILE
         when :extracted_file
           EXTRACTED_TEXT
+        when :intermediate_file
+          INTERMEDIATE_FILE
+        when :original_file
+          ORIGINAL_FILE
+        when :preservation_file
+          PRESERVATION_FILE
+        when :service_file
+          SERVICE_FILE
         when :thumbnail_file
-          THUMBNAIL
+          THUMBNAIL_IMAGE
+        when :transcript_file
+          TRANSCRIPT
         else
           raise ArgumentError, "No PCDM use is recognized for #{use}"
         end
@@ -58,7 +72,7 @@ module Hyrax
       module_function :uri_for
     end
 
-    attribute :file_identifier, Valkyrie::Types::ID # id of the file stored by the storage adapter
+    attribute :file_identifier, ::Valkyrie::Types::ID # id of the file stored by the storage adapter
     attribute :alternate_ids, Valkyrie::Types::Set.of(Valkyrie::Types::ID) # id of the file, populated for queryability
     attribute :file_set_id, ::Valkyrie::Types::ID # id of parent file set resource
 
@@ -126,6 +140,14 @@ module Hyrax
     # attributes set by fits for video
     attribute :aspect_ratio, ::Valkyrie::Types::Set
 
+    class << self
+      ##
+      # @return [String]
+      def to_rdf_representation
+        name
+      end
+    end
+
     ##
     # @return [Boolean]
     def original_file?
@@ -135,7 +157,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def thumbnail_file?
-      pcdm_use.include?(Use::THUMBNAIL)
+      pcdm_use.include?(Use::THUMBNAIL_IMAGE)
     end
 
     ##
@@ -144,6 +166,12 @@ module Hyrax
       pcdm_use.include?(Use::EXTRACTED_TEXT)
     end
 
+    ##
+    # @return [String]
+    def to_rdf_representation
+      self.class.to_rdf_representation
+    end
+
     def title
       label
     end

data/app/models/hyrax/file_set.rb

@@ -6,28 +6,47 @@ module Hyrax
   #
   # ## Relationships
   #
-  # ### File Set and Work
+  # ### FileSet and Work
   #
   # * Defined: The relationship is defined by the inverse relationship stored in the
   #   work's `:member_ids` attribute.
-  # * Tested: The work tests the relationship.
-  # * File Set to Work: (1..1)  A file set must be in one and only one work.
+  # * Tested: The test for the Work class tests the relationship.
+  # * FileSet to Work: (n..1)  A FileSet must be in one and only one work. A Work can have zero to many FileSets.
+  # * See Hyrax::Work for code to get and set file sets for the work.
   #
-  # @example Get work for a file set:
+  # @example Get Work for a FileSet:
   #       work = Hyrax.custom_queries.find_parent_work(resource: file_set)
   #
-  # * Work to File Set: (0..m)  A work can have many file sets.
-  #   * See Hyrax::Work for code to get and set file sets for the work.
+  # ### FileSet and FileMetadata
   #
-  # ### File Set and File (TBD)
+  # * Defined: The relationship is defined by the FileSet's `:file_ids` attribute.
+  # * FileSet to FileMetadata: (0..n) A FileSet can have many FileMetadatas. A FileMetadata must be in one and only one FileSet.
+  #
+  # @example Get all FileMetadata for a FileSet:
+  #     file_metadata = Hyrax.custom_queries.find_files(file_set: file_set)
+  #
+  # @example Attach a File to a FileSet through a FileMetadata. This will create
+  #   a FileMetadata for a File object, attach the File to the FileMetadata, and
+  #   attach that FileMetadata to a given FileSet.
+  #     ::Hyrax::ValkyrieUpload.file(
+  #       io: file_io,
+  #       filename: "myfile.jpg",
+  #       file_set: file_set,
+  #       use: pcdm_use,
+  #       user: user
+  #     )
+  #
+  # ### FileMetadata and Files
+  #
+  # * Defined: The relationship is defined by the FileMetadata's `:file_identifier` attribute.
+  # * FileMetadata to File: (1..1) A FileMetadata can have one and only one File
+  #
+  # @example Get a File for a FileMetadata
+  #     file = Hyrax.storage_adapter.find_by(id: file_metadata.file_identifier)
   #
   # @see Hyrax::Work
+  # @see Hyrax::CustomQueries::Navigators::FindFiles#find_files
   # @see Hyrax::CustomQueries::Navigators::ParentWorkNavigator#find_parent_work
-  #
-  # @todo The description in Hydra::Works Shared Modeling is out of date and uses
-  #   terminology to describe the relationships that is no longer used in code.
-  #   Update the model and link to it.  This can be a simple relationship diagram
-  #   with a link to the original Works Shared Modeling for historical perspective.
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
@@ -41,33 +60,67 @@ module Hyrax
     self.characterization_proxy = Hyrax.config.characterization_proxy
 
     attribute :file_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID) # id for FileMetadata resources
-    attribute :thumbnail_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
-    attribute :original_file_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
-    attribute :extracted_text_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
 
-    ##
-    # @return [Valkyrie::ID]
-    def representative_id
-      id
+    # @return [Hyrax::FileMetadata, nil]
+    def original_file
+      Hyrax.custom_queries.find_original_file(file_set: self)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      nil
+    end
+
+    # @return [Valkyrie::ID, nil]
+    def original_file_id
+      original_file&.id
+    end
+
+    # @return [String, Nil] versioned identifier suitable for use in a IIIF manifest
+    def iiif_id
+      orig_file = original_file
+      return nil if orig_file.nil? || orig_file.file_identifier.blank?
+      latest_file = Hyrax::VersioningService.latest_version_of(orig_file)
+      version = latest_file&.version_id ? Digest::MD5.hexdigest(latest_file.version_id) : nil
+      "#{id}/files/#{orig_file.id}#{'/' + version if version}"
+    end
+
+    # @return [Hyrax::FileMetadata, nil]
+    def thumbnail
+      Hyrax.custom_queries.find_thumbnail(file_set: self)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      nil
+    end
+
+    # @return [Valkyrie::ID, nil]
+    def thumbnail_id
+      thumbnail&.id
+    end
+
+    # @return [Hyrax::FileMetadata, nil]
+    def extracted_text
+      Hyrax.custom_queries.find_extracted_text(file_set: self)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      nil
+    end
+
+    # @return [Valkyrie::ID, nil]
+    def extracted_text_id
+      extracted_text&.id
     end
 
     ##
     # @return [Valkyrie::ID]
-    def representative_id=(_input)
-      # saving a file set using valkyrie would err because this method didn't exist.
-      Rails.logger.warn('This is not a valid method for file sets')
+    def representative_id
       id
     end
 
     ##
     # @return [Boolean] true
-    def pcdm_object?
+    def self.file_set?
       true
     end
 
     ##
     # @return [Boolean] true
-    def file_set?
+    def self.pcdm_object?
       true
     end
   end