hyrax 5.0.0.rc1 → 5.0.0.rc2

data/app/forms/hyrax/forms/resource_batch_edit_form.rb

@@ -7,6 +7,10 @@ module Hyrax
       self.required_fields = []
       self.model_class = Hyrax.primary_work_type
 
+      # Terms that need to exclude from batch edit
+      class_attribute :terms_excluded
+      self.terms_excluded = [:abstract, :label, :source]
+
       # Contains a list of titles of all the works in the batch
       attr_accessor :names
 
@@ -17,38 +21,39 @@ module Hyrax
         @names = []
         @batch_document_ids = batch_document_ids
         if @batch_document_ids.present?
-          super(model.class.new(initialize_combined_fields))
+          combined_fields = model_attributes(model, initialize_combined_fields)
+          super(model.class.new(combined_fields))
         else
           super(model)
         end
       end
 
       def terms
-        [:creator, :contributor, :description,
-         :keyword, :resource_type, :license, :publisher, :date_created,
-         :subject, :language, :identifier, :based_near,
-         :related_url]
+        self.class.terms
+      end
+
+      def self.terms
+        return Hyrax::Forms::BatchEditForm.terms if model_class < ActiveFedora::Base
+
+        terms_primary = definitions.select { |_, definition| definition[:primary] }
+                                   .keys.map(&:to_sym)
+        terms_secondary = definitions.select { |_, definition| definition[:display] && !definition[:primary] }
+                                     .keys.map(&:to_sym)
+
+        (terms_primary + terms_secondary) - terms_excluded
       end
 
       attr_reader :batch_document_ids
 
       # Returns a list of parameters we accept from the form
-      # rubocop:disable Metrics/MethodLength
       def self.build_permitted_params
-        [{ creator: [] },
-         { contributor: [] },
-         { description: [] },
-         { keyword: [] },
-         { resource_type: [] },
-         { license: [] },
-         { publisher: [] },
-         { date_created: [] },
-         { subject: [] },
-         { language: [] },
-         { identifier: [] },
-         { based_near: [] },
-         { related_url: [] },
-         { permissions_attributes: [:type, :name, :access, :id, :_destroy] },
+        terms_permitted_params + additional_permitted_params
+      end
+
+      # Returns a list of parameters other than those terms for the form
+      # rubocop:disable Metrics/MethodLength
+      def self.additional_permitted_params
+        [{ permissions_attributes: [:type, :name, :access, :id, :_destroy] },
          :on_behalf_of,
          :version,
          :add_works_to_collection,
@@ -63,6 +68,19 @@ module Hyrax
       end
       # rubocop:enable Metrics/MethodLength
 
+      # Returns a list of permitted parameters for the terms
+      # @param terms Array[Symbol]
+      # @return Array[Hash]
+      def self.terms_permitted_params
+        [].tap do |params|
+          terms.each do |term|
+            h = {}
+            h[term] = []
+            params << h
+          end
+        end
+      end
+
       # @param name [Symbol]
       # @return [Symbol]
       # @note Added for ActiveModel compatibility.
@@ -80,11 +98,21 @@ module Hyrax
           work = Hyrax.query_service.find_by(id: doc_id)
           terms.each do |field|
             combined_attributes[field] ||= []
-            combined_attributes[field] = (combined_attributes[field] + work[field].to_a).uniq
+            combined_attributes[field] = (combined_attributes[field] + Array.wrap(work[field])).uniq
           end
           names << work.to_s
         end
       end
+
+      # Model attributes for ActiveFedora compatibility
+      def model_attributes(model, attrs)
+        return attrs unless model.is_a? ActiveFedora::Base
+
+        attrs.keys.each do |k|
+          attrs[k] = Array.wrap(attrs[k]).first unless model.class.properties[k.to_s]&.multiple?
+        end
+        attrs
+      end
     end
   end
 end

data/app/forms/hyrax/forms/resource_form.rb

@@ -5,29 +5,26 @@ module Hyrax
     ##
     # @api public
     #
-    # @example defining a form class using HydraEditor-like configuration
-    #   class MonographForm < Hyrax::Forms::ResourceForm(Monograph)
-    #     self.required_fields = [:title, :creator, :rights_statement]
-    #     # other WorkForm-like configuration here
-    #   end
+    # Returns the form class associated with a given model.
     #
-    # @note The returned class will extend +Hyrax::Forms::PcdmObjectForm+, not
-    #   only +Hyrax::Forms::ResourceForm+. This is for backwards‐compatibility
-    #   with existing Hyrax instances and satisfies the expected general use
-    #   case (building forms for various PCDM object classes), but is *not*
-    #   necessarily suitable for other kinds of Hyrax resource, like
-    #   +Hyrax::FileSet+s.
-    def self.ResourceForm(work_class)
-      Class.new(Hyrax::Forms::PcdmObjectForm) do
-        self.model_class = work_class
-
-        ##
-        # @return [String]
-        def self.inspect
-          return "Hyrax::Forms::ResourceForm(#{model_class})" if name.blank?
-          super
+    # @note The default case assumes that the provided model class is for a
+    #   PCDM object and returns a +Hyrax::Forms::PcdmObjectForm+. This is for
+    #   backwards‐compatibility with existing Hyrax instances. However, a
+    #   different +Hyrax::Forms::ResourceForm+ subclass will be returned in
+    #   some known cases where that is preferable.
+    def self.ResourceForm(model_class)
+      @resource_forms ||= {}.compare_by_identity
+      @resource_forms[model_class] ||=
+        if model_class <= Hyrax::AdministrativeSet
+          Hyrax::Forms::AdministrativeSetForm
+        elsif model_class <= Hyrax::FileSet
+          Hyrax::Forms::FileSetForm
+        elsif model_class <= Hyrax::PcdmCollection
+          Hyrax::Forms::PcdmCollectionForm
+        else
+          "Hyrax::Forms::PcdmObjectForm".constantize # autoload
+          Hyrax::Forms::PcdmObjectForm(model_class)
         end
-      end
     end
 
     ##
@@ -121,19 +118,9 @@ module Hyrax
         #   monograph  = Monograph.new
         #   change_set = Hyrax::Forms::ResourceForm.for(monograph)
         def for(resource)
-          "#{resource.class.name}Form".constantize.new(resource)
-        rescue NameError => _err
-          case resource
-          when Hyrax::AdministrativeSet
-            Hyrax::Forms::AdministrativeSetForm.new(resource)
-          when Hyrax::FileSet
-            Hyrax::Forms::FileSetForm.new(resource)
-          when Hyrax::PcdmCollection
-            Hyrax::Forms::PcdmCollectionForm.new(resource)
-          else
-            # NOTE: This will create a +Hyrax::Forms::PcdmObjectForm+.
-            Hyrax::Forms::ResourceForm(resource.class).new(resource)
-          end
+          klass = "#{resource.class.name}Form".safe_constantize
+          klass ||= Hyrax::Forms::ResourceForm(resource.class)
+          klass.new(resource)
         end
 
         ##

data/app/helpers/hyrax/dashboard_helper_behavior.rb

@@ -17,6 +17,19 @@ module Hyrax
       'n/a'
     end
 
+    def link_to_works(user = current_user)
+      state = Blacklight::SearchState.new(params, CatalogController.blacklight_config)
+      facet_type = if Hyrax.config.use_valkyrie?
+                     state.add_facet_params('generic_type_si', 'Work')
+                   else
+                     state.add_facet_params('generic_type_sim', 'Work')
+                   end
+      facet_depositor = state.add_facet_params('depositor_ssim', user.to_s)
+      state = Hash.new {}
+      state["f"] = facet_type["f"].merge(facet_depositor["f"])
+      link_to(t("hyrax.dashboard.stats.works"), main_app.search_catalog_path(state))
+    end
+
     # @param user [User]
     # @return [Integer] number of FileSets the user deposited
     def number_of_files(user = current_user)

data/app/indexers/hyrax/location_indexer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Indexes properties common to Hyrax::Resource types
+  module LocationIndexer
+    def to_solr
+      super.tap do |index_document|
+        index_document[:based_near_label_tesim] = based_near_label_lookup(resource.based_near) if resource.respond_to? :based_near
+      end
+    end
+
+    private
+
+    def based_near_label_lookup(locations)
+      locations.map do |loc|
+        if URI.parse(loc)
+          location_service.full_label(loc)
+        else
+          loc
+        end
+      end
+    end
+
+    def location_service
+      Hyrax.config.location_service
+    end
+  end
+end

data/app/indexers/hyrax/pcdm_collection_indexer.rb

@@ -19,14 +19,6 @@ module Hyrax
         index_document[:member_of_collection_ids_ssim] = resource.member_of_collection_ids.map(&:to_s)
         index_document[:depositor_ssim] = [resource.depositor]
         index_document[:depositor_tesim] = [resource.depositor]
-        # add all attributes that should be indexed for collections here
-        tesim_and_ssim_attributes = ['abstract', 'access_right', 'alternative_title', 'based_near',
-                                     'bibliographic_citation', 'contributor', 'identifier', 'import_url', 'publisher', 'label',
-                                     'language', 'license', 'publisher', 'rights_notes', 'rights_statement', 'source', 'subject']
-        tesim_and_ssim_attributes.each do |attribute|
-          index_document["#{attribute}_ssim"] = resource[attribute.to_s]
-          index_document["#{attribute}_tesim"] = resource[attribute.to_s]
-        end
       end
     end
   end

data/app/indexers/hyrax/valkyrie_file_set_indexer.rb

@@ -17,7 +17,7 @@ module Hyrax
 
         # Metadata from the FileSet
         solr_doc['file_ids_ssim']                = resource.file_ids&.map(&:to_s)
-        solr_doc['original_file_id_ssi']         = original_file_id
+        solr_doc['original_file_id_ssi']         = resource.iiif_id
         solr_doc['extracted_text_id_ssi']        = resource.extracted_text_id.to_s
         solr_doc['hasRelatedMediaFragment_ssim'] = resource.representative_id.to_s
         solr_doc['hasRelatedImage_ssim']         = resource.thumbnail_id.to_s
@@ -106,11 +106,6 @@ module Hyrax
 
     private
 
-    # Convert Valkyrie Original File Pointer to versioned url syntax expected by the iiif_presenter
-    def original_file_id
-      "#{resource.id}/files/#{resource.original_file_id}"
-    end
-
     def file_format(file)
       if file.mime_type.present? && file.format_label.present?
         "#{file.mime_type.split('/').last} (#{file.format_label.join(', ')})"

data/app/indexers/hyrax/valkyrie_work_indexer.rb

@@ -7,6 +7,7 @@ module Hyrax
     include Hyrax::ResourceIndexer
     include Hyrax::PermissionIndexer
     include Hyrax::VisibilityIndexer
+    include Hyrax::LocationIndexer
     include Hyrax::ThumbnailIndexer
     include Hyrax::Indexer(:core_metadata)
 

data/app/inputs/controlled_vocabulary_input.rb

@@ -44,7 +44,7 @@ class ControlledVocabularyInput < MultiValueInput
   def hidden_id_field(value, index)
     name = name_for(attribute_name, index, 'id')
     id = id_for(attribute_name, index, 'id')
-    hidden_value = value.node? ? '' : value.rdf_subject
+    hidden_value = value.try(:node?) ? '' : value.rdf_subject
     @builder.hidden_field(attribute_name, name: name, id: id, value: hidden_value, data: { id: 'remote' })
   end
 

data/app/jobs/characterize_job.rb

@@ -51,7 +51,7 @@ class CharacterizeJob < Hyrax::ApplicationJob
     # value. So later we'll ensure it's set to the new file's filename.
     reset_title = file_set.title.first == file_set.label
 
-    characterization_service.run(file_set.characterization_proxy, filepath)
+    characterization_service.run(file_set.characterization_proxy, filepath, **Hyrax.config.characterization_options)
     Hyrax.logger.debug "Ran characterization on #{file_set.characterization_proxy.id} (#{file_set.characterization_proxy.mime_type})"
     file_set.characterization_proxy.alpha_channels = channels(filepath) if file_set.image? && Hyrax.config.iiif_image_server?
     file_set.characterization_proxy.save!

data/app/jobs/create_work_job.rb

@@ -17,15 +17,47 @@ class CreateWorkJob < Hyrax::ApplicationJob
   def perform(user, model, attributes, operation)
     operation.performing!
     work = model.constantize.new
-    current_ability = Ability.new(user)
-    env = Hyrax::Actors::Environment.new(work, current_ability, attributes)
-    status = work_actor.create(env)
+    if model.constantize < ActiveFedora::Base
+      status = batch_create_af_work(work, attributes, user)
+      errors = work.errors
+    else
+      result = batch_create_valkyrie_work(work, attributes, user)
+      status = result.success?
+      errors = result.failure&.last
+    end
+
     return operation.success! if status
-    operation.fail!(work.errors.full_messages.join(' '))
+    operation.fail!(errors.full_messages.join(' '))
   end
 
   private
 
+  def batch_create_af_work(work, attributes, user)
+    current_ability = Ability.new(user)
+    env = Hyrax::Actors::Environment.new(work, current_ability, attributes)
+    work_actor.create(env)
+  end
+
+  def batch_create_valkyrie_work(work, attributes, user)
+    uploaded_file_ids = attributes.delete(:uploaded_files)
+    files = Hyrax::UploadedFile.find(uploaded_file_ids)
+    permissions_params = attributes.delete(:permissions_attributes)
+    form = Hyrax::FormFactory.new.build(work, nil, nil)
+    form.validate(attributes)
+
+    transactions['change_set.create_work']
+      .with_step_args(
+        'work_resource.add_file_sets' => { uploaded_files: files },
+        'change_set.set_user_as_depositor' => { user: user },
+        'work_resource.save_acl' => { permissions_params: permissions_params }
+      )
+      .call(form)
+  end
+
+  def transactions
+    Hyrax::Transactions::Container
+  end
+
   def work_actor
     Hyrax::CurationConcern.actor
   end

data/app/jobs/valkyrie_characterization_job.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+class ValkyrieCharacterizationJob < Hyrax::ApplicationJob
+  queue_as Hyrax.config.ingest_queue_name
+  def perform(file_metadata_id)
+    file_metadata = Hyrax.custom_queries.find_file_metadata_by(id: file_metadata_id)
+    Hyrax.config.characterization_service
+         .run(metadata: file_metadata, file: file_metadata.file, **Hyrax.config.characterization_options)
+  end
+end

data/app/jobs/valkyrie_ingest_job.rb

@@ -25,14 +25,12 @@ class ValkyrieIngestJob < Hyrax::ApplicationJob
   def ingest(file:, pcdm_use:)
     file_set_uri = Valkyrie::ID.new(file.file_set_uri)
     file_set = Hyrax.query_service.find_by(id: file_set_uri)
-    updated_metadata = upload_file(
+    upload_file(
       file: file,
       file_set: file_set,
       pcdm_use: pcdm_use,
       user: file.user
     )
-
-    ValkyrieCreateDerivativesJob.perform_later(file_set.id.to_s, updated_metadata.id.to_s)
   end
 
   ##

data/app/models/collection_branding_info.rb

@@ -19,15 +19,8 @@ class CollectionBrandingInfo < ApplicationRecord
     super()
   end
 
-  def delete(location_path = nil)
-    id = if location_path
-           Deprecation.warn('Passing an explict location path is ' \
-                            'deprecated. Call without arguments instead.')
-           location_path
-         else
-           local_path
-         end
-    storage.delete(id: id)
+  def delete(_location_path = nil)
+    storage.delete(id: local_path)
   end
 
   def find_local_filename(collection_id, role, filename)

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

@@ -370,6 +370,7 @@ module Hyrax
       can :manage, curation_concerns_models
       can :manage, Sipity::WorkflowResponsibility
       can :manage, :collection_types
+      can :manage, ::FileSet
     end
 
     ##
@@ -418,7 +419,7 @@ module Hyrax
     end
 
     def curation_concerns_models
-      [::FileSet, Hyrax.config.collection_class] + Hyrax.config.curation_concerns
+      [::FileSet, ::Hyrax::FileSet, Hyrax.config.collection_class] + Hyrax.config.curation_concerns
     end
 
     def can_review_submissions?

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

@@ -28,9 +28,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 +40,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/riiif_file.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Hyrax
+  # Adds file locking to Riiif::File
+  # @see RiiifFileResolver
+  class RiiifFile < Riiif::File
+    include ActiveSupport::Benchmarkable
+
+    attr_reader :id
+    def initialize(input_path, tempfile = nil, id:)
+      super(input_path, tempfile)
+      raise(ArgumentError, "must specify id") if id.blank?
+      @id = id
+    end
+
+    # Wrap extract in a read lock and benchmark it
+    def extract(transformation, image_info = nil)
+      Riiif::Image.file_resolver.file_locks[id].with_read_lock do
+        benchmark "RiiifFile extracted #{path} with #{transformation.to_params}", level: :debug do
+          super
+        end
+      end
+    end
+
+    private
+
+    def logger
+      Hyrax.logger
+    end
+  end
+end

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

@@ -91,9 +91,9 @@ module Hyrax
     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 +108,23 @@ 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?
+      lease_expiration_date.present?
+    end
+
     private
 
     def model_classifier(classifier)

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
@@ -35,6 +35,7 @@ module Hyrax
       ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
       EXTRACTED_TEXT = ::Valkyrie::Vocab::PCDMUse.ExtractedText
       THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
+      SERVICE_FILE = ::Valkyrie::Vocab::PCDMUse.ServiceFile
 
       ##
       # @param use [RDF::URI, Symbol]
@@ -58,7 +59,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