hyrax 3.5.0 → 4.0.0.beta1

data/app/controllers/concerns/hyrax/works_controller_behavior.rb

@@ -11,6 +11,10 @@ module Hyrax
       with_themed_layout :decide_layout
       copy_blacklight_config_from(::CatalogController)
 
+      before_action do
+        blacklight_config.track_search_session = false
+      end
+
       class_attribute :_curation_concern_type, :show_presenter, :work_form_service, :search_builder_class
       class_attribute :iiif_manifest_builder, instance_accessor: false
       self.show_presenter = Hyrax::WorkShowPresenter
@@ -245,15 +249,6 @@ module Hyrax
       ::Hyrax::ContextualPath.new(presenter, parent_presenter).show
     end
 
-    # @deprecated
-    def curation_concern_from_search_results
-      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                       "Instead, use '#search_result_document'.")
-      search_params = params.deep_dup
-      search_params.delete :page
-      search_result_document(search_params)
-    end
-
     ##
     # Only returns unsuppressed documents the user has read access to
     #

data/app/controllers/hyrax/batch_edits_controller.rb

@@ -54,7 +54,7 @@ module Hyrax
       obj.attributes = work_params(admin_set_id: obj.admin_set_id).except(*visibility_params)
       obj.date_modified = Time.current.ctime
 
-      InheritPermissionsJob.perform_now(obj, use_valkyrie: false)
+      InheritPermissionsJob.perform_now(obj)
       VisibilityCopyJob.perform_now(obj)
 
       obj.save

data/app/controllers/hyrax/dashboard/collections_controller.rb

@@ -220,7 +220,7 @@ module Hyrax
 
         @collection.visibility = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE unless @collection.discoverable?
         # we don't have to reindex the full graph when updating collection
-        @collection.try(:reindex_extent=, Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX)
+        @collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
         if @collection.update(collection_params.except(:members))
           after_update_response
         else
@@ -422,6 +422,7 @@ module Hyrax
           params.permit(collection: {})[:collection]
                 .merge(params.permit(:collection_type_gid)
                              .with_defaults(collection_type_gid: default_collection_type_gid))
+                .merge(member_of_collection_ids: Array(params[:parent_id]))
         end
       end
 

data/app/controllers/hyrax/dashboard/nest_collections_controller.rb

@@ -70,38 +70,6 @@ module Hyrax
 
       private
 
-      ##
-      # @deprecated
-      def build_within_form
-        authorize! :read, form_params[:child_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_within_form
-
-      ##
-      # @deprecated
-      def build_under_form
-        authorize! :read, form_params[:parent_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_under_form
-
-      ##
-      # @deprecated
-      def build_create_collection_form
-        authorize! :deposit, form_params[:parent_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_create_collection_form
-
-      ##
-      # @deprecated
-      def build_remove_form
-        authorize! :edit, form_params[:parent_id]
-        form_class.new(context: self, **form_params.to_h.symbolize_keys)
-      end
-      deprecation_deprecate :build_create_collection_form
-
       ##
       # @api public
       # @since 3.2.0

data/app/controllers/hyrax/downloads_controller.rb

@@ -3,7 +3,6 @@ module Hyrax
   class DownloadsController < ApplicationController
     include Hydra::Controller::DownloadBehavior
     include Hyrax::LocalFileDownloadsControllerBehavior
-    include Hyrax::WorkflowsHelper # Provides #workflow_restriction?
 
     def self.default_content_path
       :original_file
@@ -38,26 +37,12 @@ module Hyrax
       { type: mime_type_for(file), disposition: 'inline' }
     end
 
-    def file_set_parent(file_set_id)
-      file_set = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: file_set_id, use_valkyrie: Hyrax.config.use_valkyrie?)
-      @parent ||=
-        case file_set
-        when Hyrax::Resource
-          Hyrax.query_service.find_parents(resource: file_set).first
-        else
-          file_set.parent
-        end
-    end
-
     # Customize the :read ability in your Ability class, or override this method.
     # Hydra::Ability#download_permissions can't be used in this case because it assumes
     # that files are in a LDP basic container, and thus, included in the asset's uri.
     def authorize_download!
       authorize! :download, params[asset_param_key]
-      # Deny access if the work containing this file is restricted by a workflow
-      return unless workflow_restriction?(file_set_parent(params[asset_param_key]), ability: current_ability)
-      raise Hyrax::WorkflowAuthorizationException
-    rescue CanCan::AccessDenied, Hyrax::WorkflowAuthorizationException
+    rescue CanCan::AccessDenied
       unauthorized_image = Rails.root.join("app", "assets", "images", "unauthorized.png")
       send_file unauthorized_image, status: :unauthorized
     end

data/app/controllers/hyrax/file_sets_controller.rb

@@ -10,7 +10,9 @@ module Hyrax
     before_action :authenticate_user!, except: [:show, :citation, :stats]
     load_and_authorize_resource class: ::FileSet, except: :show
     before_action :build_breadcrumbs, only: [:show, :edit, :stats]
-    before_action :presenter
+    before_action do
+      blacklight_config.track_search_session = false
+    end
 
     # provides the help_text view method
     helper PermissionsHelper
@@ -192,15 +194,7 @@ module Hyrax
     def initialize_edit_form
       guard_for_workflow_restriction_on!(parent: parent)
 
-      case file_set
-      when Hyrax::Resource
-        @form = Hyrax::Forms::ResourceForm.for(file_set)
-        @form.prepopulate!
-      else
-        @form = form_class.new(file_set)
-        @form[:visibility] = file_set.visibility # workaround for hydra-head < 12
-      end
-      @version_list = Hyrax::VersionListPresenter.for(file_set: file_set)
+      @version_list = Hyrax::VersionListPresenter.for(file_set: @file_set)
       @groups = current_user.groups
     end
 

data/app/controllers/hyrax/homepage_controller.rb

@@ -2,7 +2,6 @@
 class Hyrax::HomepageController < ApplicationController
   # Adds Hydra behaviors into the application controller
   include Blacklight::SearchContext
-  include Blacklight::SearchHelper
   include Blacklight::AccessControls::Catalog
 
   class_attribute :presenter_class

data/app/controllers/hyrax/my_controller.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
   class MyController < ApplicationController
-    extend Deprecation
     include Hydra::Catalog
     include Hyrax::Collections::AcceptsBatches
 
@@ -63,11 +62,6 @@ module Hyrax
       @add_works_to_collection_label = params.fetch(:add_works_to_collection_label, '')
     end
 
-    def query_solr
-      search_service.search_results
-    end
-    deprecation_deprecate :query_solr
-
     def search_service
       Hyrax::SearchService.new(config: blacklight_config, user_params: params, scope: self)
     end

data/app/controllers/hyrax/permissions_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   class PermissionsController < ApplicationController
-    load_resource class: Hyrax::Resource, instance_name: :curation_concern
+    load_resource class: ActiveFedora::Base, instance_name: :curation_concern
 
     attr_reader :curation_concern
     helper_method :curation_concern

data/app/controllers/hyrax/single_use_links_controller.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
   class SingleUseLinksController < ApplicationController
-    include Blacklight::SearchHelper
     class_attribute :show_presenter
     self.show_presenter = Hyrax::SingleUseLinkPresenter
     before_action :authenticate_user!
@@ -45,7 +44,7 @@ module Hyrax
     end
 
     def asset_show_path
-      polymorphic_path([main_app, fetch(params[:id]).last])
+      polymorphic_path([main_app, search_service.fetch(params[:id]).last])
     end
   end
 end

data/app/controllers/hyrax/transfers_controller.rb

@@ -23,6 +23,7 @@ module Hyrax
       add_breadcrumb t(:'hyrax.controls.home'), root_path
       add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
       add_breadcrumb t(:'hyrax.transfers.new.header'), hyrax.new_work_transfer_path
+      @work = Hyrax::WorkRelation.new.find(params[:id])
     end
 
     def create
@@ -30,6 +31,7 @@ module Hyrax
       if @proxy_deposit_request.save
         redirect_to hyrax.transfers_path, notice: "Transfer request created"
       else
+        @work = Hyrax::WorkRelation.new.find(params[:id])
         render :new
       end
     end

data/app/controllers/hyrax/workflow_actions_controller.rb

@@ -9,8 +9,7 @@ module Hyrax
     #   @return [Hyrax::Resource]
     attr_reader :curation_concern
 
-    resource_klass = Hyrax.config.use_valkyrie? ? Hyrax::Resource : ActiveFedora::Base
-    load_resource class: resource_klass, instance_name: :curation_concern
+    load_resource class: Hyrax::Resource, instance_name: :curation_concern
     before_action :authenticate_user!
 
     def update
@@ -40,7 +39,7 @@ module Hyrax
 
     def after_update_response
       respond_to do |wants|
-        wants.html { redirect_to [main_app, curation_concern], notice: "The #{curation_concern.class.human_readable_type} has been updated." }
+        wants.html { redirect_to [main_app, curation_concern], notice: "The #{curation_concern.human_readable_type} has been updated." }
         wants.json { render 'hyrax/base/show', status: :ok, location: polymorphic_path([main_app, curation_concern]) }
       end
     end

data/app/forms/hyrax/forms/collection_form.rb

@@ -9,7 +9,7 @@ module Hyrax
       attr_reader :scope
 
       delegate :id, :depositor, :permissions, :human_readable_type, :member_ids, :nestable?,
-               :alternative_title, :visibility, to: :model
+               :alternative_title, to: :model
 
       class_attribute :membership_service_class
 

data/app/forms/hyrax/forms/dashboard/nest_collection_form.rb

@@ -109,9 +109,7 @@ module Hyrax
         # needed to make the determination are too expensive to do for every possible
         # collection, so we only test for this situation prior to saving the new
         # relationship.
-        # note: the graph indexer does not care about nesting depth
         def nesting_within_maximum_depth
-          return true if Hyrax.config.use_solr_graph_for_collection_nesting
           return true if query_service.valid_combined_nesting_depth?(parent: parent, child: child, scope: context)
           errors.add(:collection, :exceeds_maximum_nesting_depth)
           false

data/app/forms/hyrax/forms/file_set_edit_form.rb

@@ -4,7 +4,7 @@ module Hyrax::Forms
     include HydraEditor::Form
     include HydraEditor::Form::Permissions
 
-    delegate :depositor, :permissions, :human_readable_type, to: :model
+    delegate :depositor, :permissions, to: :model
 
     self.required_fields = [:title, :creator, :license]
 

data/app/forms/hyrax/forms/file_set_form.rb

@@ -3,17 +3,44 @@
 module Hyrax
   module Forms
     ##
-    # A form for +Hyrax::FileSet+s.
-    class FileSetForm < Hyrax::Forms::ResourceForm
+    # @api public
+    class FileSetForm < Hyrax::ChangeSet
       include Hyrax::FormFields(:core_metadata)
 
-      # The fields in +:file_set_metadata+ were hardcoded into this form in a
-      # previous version of Hyrax, but ideally in the future this metadata will
-      # be configurable.
-      include Hyrax::FormFields(:file_set_metadata)
+      class << self
+        ##
+        # @return [Array<Symbol>] list of required field names as symbols
+        def required_fields
+          definitions
+            .select { |_, definition| definition[:required] }
+            .keys.map(&:to_sym)
+        end
+      end
 
-      property :representative_id, type: Valkyrie::Types::String
-      property :thumbnail_id, type: Valkyrie::Types::String
+      property :creator, required: true
+      property :license, required: true
+
+      property :based_near
+      property :contributor
+      property :date_created
+      property :description
+      property :identifier
+      property :keyword
+      property :language
+      property :publisher
+      property :related_url
+      property :subject
+
+      property :permissions, virtual: true
+      property :visibility, default: VisibilityIntention::PRIVATE
+
+      # virtual properties for embargo/lease;
+      property :embargo_release_date, virtual: true
+      property :visibility_after_embargo, virtual: true
+      property :visibility_during_embargo, virtual: true
+      property :lease_expiration_date, virtual: true
+      property :visibility_after_lease, virtual: true
+      property :visibility_during_lease, virtual: true
     end
   end
 end

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

@@ -11,16 +11,12 @@ module Hyrax
     #     # other WorkForm-like configuration here
     #   end
     #
-    # @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
+      Class.new(Hyrax::Forms::ResourceForm) do
         self.model_class = work_class
 
+        include Hyrax::FormFields(:core_metadata)
+
         ##
         # @return [String]
         def self.inspect
@@ -33,7 +29,7 @@ module Hyrax
     ##
     # @api public
     #
-    # This form wraps +Hyrax::ChangeSet+ in the +HydraEditor::Form+ interface.
+    # This form wraps `Hyrax::ChangeSet` in the `HydraEditor::Form` interface.
     class ResourceForm < Hyrax::ChangeSet # rubocop:disable Metrics/ClassLength
       ##
       # @api private
@@ -73,8 +69,10 @@ module Hyrax
       property :human_readable_type, writable: false
 
       property :depositor
+      property :on_behalf_of
+      property :proxy_depositor
 
-      property :visibility, default: VisibilityIntention::PRIVATE, populator: :visibility_populator
+      property :visibility, default: VisibilityIntention::PRIVATE
 
       property :date_modified, readable: false
       property :date_uploaded, readable: false
@@ -87,9 +85,6 @@ module Hyrax
                  populator: :permission_populator,
                  prepopulator: ->(_opts) { self.permissions = Hyrax::AccessControl.for(resource: model).permissions })
 
-      property :embargo, form: Hyrax::Forms::Embargo, populator: :embargo_populator
-      property :lease, form: Hyrax::Forms::Lease, populator: :lease_populator
-
       # virtual properties for embargo/lease;
       property :embargo_release_date, virtual: true, prepopulator: ->(_opts) { self.embargo_release_date = model.embargo&.embargo_release_date }
       property :visibility_after_embargo, virtual: true, prepopulator: ->(_opts) { self.visibility_after_embargo = model.embargo&.visibility_after_embargo }
@@ -99,7 +94,17 @@ module Hyrax
       property :visibility_after_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_after_lease = model.lease&.visibility_after_lease }
       property :visibility_during_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_during_lease = model.lease&.visibility_during_lease }
 
+      # pcdm relationships
+      property :admin_set_id, prepopulator: ->(_opts) { self.admin_set_id = Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s }
       property :in_works_ids, virtual: true, prepopulator: InWorksPrepopulator
+      property :member_ids, default: [], type: Valkyrie::Types::Array
+      property :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
+      property :member_of_collections_attributes, virtual: true, populator: :in_collections_populator
+      validates_with CollectionMembershipValidator
+
+      property :representative_id, type: Valkyrie::Types::String
+      property :thumbnail_id, type: Valkyrie::Types::String
+      property :rendering_ids, default: [], type: Valkyrie::Types::Array
 
       # provide a lock token for optimistic locking; we name this `version` for
       # backwards compatibility
@@ -111,6 +116,10 @@ module Hyrax
       # @see https://github.com/samvera/valkyrie/wiki/Optimistic-Locking
       property :version, virtual: true, prepopulator: LockKeyPrepopulator
 
+      # backs the child work search element;
+      # @todo: look for a way for the view template not to depend on this
+      property :find_child_work, default: nil, virtual: true
+
       class << self
         ##
         # @api public
@@ -131,7 +140,6 @@ module Hyrax
           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
         end
@@ -200,12 +208,18 @@ module Hyrax
 
       private
 
-      def embargo_populator(**)
-        self.embargo = Hyrax::EmbargoManager.embargo_for(resource: model)
-      end
+      def in_collections_populator(fragment:, **_options)
+        adds = []
+        deletes = []
+        fragment.each do |_, h|
+          if h["_destroy"] == "true"
+            deletes << Valkyrie::ID.new(h["id"])
+          else
+            adds << Valkyrie::ID.new(h["id"])
+          end
+        end
 
-      def lease_populator(**)
-        self.lease = Hyrax::LeaseManager.lease_for(resource: model)
+        self.member_of_collection_ids = ((member_of_collection_ids + adds) - deletes).uniq
       end
 
       # https://trailblazer.to/2.1/docs/reform.html#reform-populators-populator-collections
@@ -213,24 +227,6 @@ module Hyrax
         Hyrax::Forms::Permission.new(collection[index])
       end
 
-      def visibility_populator(fragment:, doc:, **)
-        case fragment
-        when "embargo"
-          self.visibility = doc['visibility_during_embargo']
-
-          doc['embargo'] = doc.slice('visibility_after_embargo',
-                                     'visibility_during_embargo',
-                                     'embargo_release_date')
-        when "lease"
-          self.visibility = doc['visibility_during_lease']
-          doc['lease'] = doc.slice('visibility_after_lease',
-                                     'visibility_during_lease',
-                                     'lease_expiration_date')
-        else
-          self.visibility = fragment
-        end
-      end
-
       def _form_field_definitions
         self.class.definitions
       end

data/app/helpers/hyrax/embargo_helper.rb

@@ -40,16 +40,5 @@ module Hyrax
         Hyrax::EmbargoManager.new(resource: resource).enforced?
       end
     end
-
-    ##
-    # @since 3.5.0
-    #
-    # @param [#embargo_history, #embargo] resource
-    #
-    # @return [Array]
-    def embargo_history(resource)
-      resource.try(:embargo_history) ||
-        Array(resource.embargo&.embargo_history)
-    end
   end
 end

data/app/helpers/hyrax/facets_helper.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module FacetsHelper
+    # Methods in this module are from Blacklight::FacetsHelperBehavior, blacklight v6.24.0
+    # This module is used to ensure Hyrax facet views that rely on deprecated Blacklight helper methods are still functional
+
+    include Blacklight::Facet
+
+    ##
+    # Renders the list of values
+    # removes any elements where render_facet_item returns a nil value. This enables an application
+    # to filter undesireable facet items so they don't appear in the UI
+    def render_facet_limit_list(paginator, facet_field, wrapping_element = :li)
+      safe_join(paginator.items.map { |item| render_facet_item(facet_field, item) }.compact.map { |item| content_tag(wrapping_element, item) })
+    end
+
+    ##
+    # Renders a single facet item
+    def render_facet_item(facet_field, item)
+      if facet_in_params?(facet_field, item.value)
+        render_selected_facet_value(facet_field, item)
+      else
+        render_facet_value(facet_field, item)
+      end
+    end
+
+    ##
+    # Standard display of a facet value in a list. Used in both _facets sidebar
+    # partial and catalog/facet expanded list. Will output facet value name as
+    # a link to add that to your restrictions, with count in parens.
+    #
+    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+    # @param [Blacklight::Solr::Response::Facets::FacetItem] item
+    # @param [Hash] options
+    # @option options [Boolean] :suppress_link display the facet, but don't link to it
+    # @return [String]
+    def render_facet_value(facet_field, item, options = {})
+      path = path_for_facet(facet_field, item)
+      content_tag(:span, class: "facet-label") do
+        link_to_unless(options[:suppress_link], facet_display_value(facet_field, item), path, class: "facet_select")
+      end + render_facet_count(item.hits)
+    end
+
+    ##
+    # Where should this facet link to?
+    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+    # @param [String] item
+    # @return [String]
+    def path_for_facet(facet_field, item)
+      facet_config = facet_configuration_for_field(facet_field)
+      if facet_config.url_method
+        send(facet_config.url_method, facet_field, item)
+      else
+        search_action_path(search_state.add_facet_params_and_redirect(facet_field, item))
+      end
+    end
+
+    ##
+    # Standard display of a SELECTED facet value (e.g. without a link and with a remove button)
+    # @see #render_facet_value
+    # @param [Blacklight::Solr::Response::Facets::FacetField] facet_field
+    # @param [String] item
+    def render_selected_facet_value(facet_field, item)
+      remove_href = search_action_path(search_state.remove_facet_params(facet_field, item))
+      content_tag(:span, class: "facet-label") do
+        content_tag(:span, facet_display_value(facet_field, item), class: "selected") +
+          # remove link
+          link_to(remove_href, class: "remove") do
+            content_tag(:i, '', class: "fa fa-times") +
+              content_tag(:span, '[remove]', class: 'sr-only')
+          end
+      end + render_facet_count(item.hits, classes: ["selected"])
+    end
+
+    ##
+    # Renders a count value for facet limits. Can be over-ridden locally
+    # to change style. And can be called by plugins to get consistent display.
+    #
+    # @param [Integer] num number of facet results
+    # @param [Hash] options
+    # @option options [Array<String>]  an array of classes to add to count span.
+    # @return [String]
+    def render_facet_count(num, options = {})
+      classes = (options[:classes] || []) << "facet-count"
+      content_tag("span", t('blacklight.search.facets.count', number: number_with_delimiter(num)), class: classes)
+    end
+
+    ##
+    # Check if the query parameters have the given facet field with the
+    # given value.
+    #
+    # @param [Object] field
+    # @param [Object] item facet value
+    # @return [Boolean]
+    def facet_in_params?(field, item)
+      value = facet_value_for_facet_item(item)
+
+      (facet_params(field) || []).include? value
+    end
+
+    ##
+    # Get the values of the facet set in the blacklight query string
+    def facet_params(field)
+      config = facet_configuration_for_field(field)
+
+      params[:f][config.key] if params[:f]
+    end
+
+    ##
+    # Get the displayable version of a facet's value
+    #
+    # @param [Object] field
+    # @param [String] item value
+    # @return [String]
+    # rubocop:disable Metrics/MethodLength
+    def facet_display_value(field, item)
+      facet_config = facet_configuration_for_field(field)
+
+      value = if item.respond_to? :label
+                item.label
+              else
+                facet_value_for_facet_item(item)
+              end
+
+      if facet_config.helper_method
+        send facet_config.helper_method, value
+      elsif facet_config.query && facet_config.query[value]
+        facet_config.query[value][:label]
+      elsif facet_config.date
+        localization_options = facet_config.date == true ? {} : facet_config.date
+
+        l(value.to_datetime, localization_options)
+      else
+        value
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    def facet_value_for_facet_item(item)
+      if item.respond_to? :value
+        item.value
+      else
+        item
+      end
+    end
+  end
+end