hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/app/controllers/hyrax/my/works_controller.rb

@@ -5,6 +5,7 @@ module Hyrax
       # Define collection specific filter facets.
       def self.configure_facets
         configure_blacklight do |config|
+          config.search_builder_class = Hyrax::My::WorksSearchBuilder
           config.add_facet_field "admin_set_sim", limit: 5
           config.add_facet_field "member_of_collections_ssim", limit: 5
         end
@@ -14,12 +15,6 @@ module Hyrax
       class_attribute :create_work_presenter_class
       self.create_work_presenter_class = Hyrax::SelectTypeListPresenter
 
-      # Search builder for a list of works that belong to me
-      # Override of Blacklight::RequestBuilders
-      def search_builder_class
-        Hyrax::My::WorksSearchBuilder
-      end
-
       def index
         # The user's collections for the "add to collection" form
         @user_collections = collections_service.search_results(:deposit)

data/app/controllers/hyrax/my_controller.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   class MyController < ApplicationController
+    extend Deprecation
     include Hydra::Catalog
     include Hyrax::Collections::AcceptsBatches
 
@@ -35,7 +36,9 @@ module Hyrax
 
     def index
       @user = current_user
-      (@response, @document_list) = query_solr
+      Deprecation.silence(Hyrax::MyController) do
+        (@response, @document_list) = query_solr
+      end
       prepare_instance_variables_for_batch_control_display
 
       respond_to do |format|
@@ -61,7 +64,12 @@ module Hyrax
     end
 
     def query_solr
-      search_results(params)
+      search_service.search_results
+    end
+    deprecation_deprecate :query_solr
+
+    def search_service
+      Hyrax::SearchService.new(config: blacklight_config, user_params: params, scope: self)
     end
   end
 end

data/app/controllers/hyrax/permissions_controller.rb

@@ -6,6 +6,7 @@ module Hyrax
     def confirm
       # intentional noop to display default view
     end
+    deprecation_deprecate confirm: "Use the #confirm_access action instead."
 
     def copy
       authorize! :edit, curation_concern

data/app/controllers/hyrax/single_use_links_viewer_controller.rb

@@ -13,15 +13,16 @@ module Hyrax
     self.presenter_class = FileSetPresenter
     copy_blacklight_config_from(::CatalogController)
 
+    configure_blacklight do |config|
+      config.search_builder_class = SingleUseLinkSearchBuilder
+    end
+
     def download
       raise not_found_exception unless single_use_link.path == hyrax.download_path(id: @asset)
       send_content
     end
 
     def show
-      _, document_list = search_results(id: single_use_link.item_id)
-      curation_concern = document_list.first
-
       # Authorize using SingleUseLinksViewerController::Ability
       authorize! :read, curation_concern
       raise not_found_exception unless single_use_link.path == polymorphic_path([main_app, curation_concern])
@@ -36,8 +37,13 @@ module Hyrax
 
     private
 
-    def search_builder_class
-      SingleUseLinkSearchBuilder
+    def curation_concern
+      response, _document_list = search_service.search_results
+      response.documents.first
+    end
+
+    def search_service
+      Hyrax::SearchService.new(config: blacklight_config, user_params: { id: single_use_link.item_id }, scope: self)
     end
 
     def content_options

data/app/controllers/hyrax/users_controller.rb

@@ -20,20 +20,15 @@ module Hyrax
 
     private
 
-    # TODO: this should move to a service.
-    #
-    # @todo Given that this method sends its methods to ::User, I
-    # believe it could be extracted to User; I don't think the
-    # base_query can be as it may require controller level context
-    #
-    # Returns a list of users excluding the system users and guest_users
+    ##
     # @param query [String] the query string
+    #
+    # @return [Enumerable] a list of users excluding the system users and guest_users
     def search(query)
       base = ::User
       clause = query.blank? ? nil : "%#{base.sanitize_sql_like(query.downcase)}%"
       base = base.where(*Array.wrap(base_query))
-      # This may have some DB adapter specific behavior, which is
-      # definitely logic I'd like to keep out of a controller.
+      # This may have some DB adapter specific behavior.
       base = base.where("LOWER(#{base.user_key_field}) LIKE :clause OR LOWER(display_name) LIKE :clause", clause: clause) if clause.present?
       base.registered
           .without_system_accounts
@@ -62,7 +57,7 @@ module Hyrax
 
     def find_user
       @user = ::User.from_url_component(params[:id])
-      redirect_to root_path, alert: "User '#{params[:id]}' does not exist" if @user.nil?
+      redirect_to root_path, alert: "User does not exist" unless @user
     end
 
     def sort_value

data/app/forms/hyrax/forms/failed_submission_form_wrapper.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+module Hyrax
+  module Forms
+    # @deprecated This class should be removed when we switch to
+    #   Valkyrie::ChangeSet instead of Hydra::Forms.
+    #
+    # This object is responsible for exposing the user submitted
+    # params from a failed POST/PUT/PATCH.
+    #
+    # @see https://github.com/samvera/hyrax/issues/3978
+    class FailedSubmissionFormWrapper < SimpleDelegator
+      # @param form
+      # @param input_params [ActionController::Parameters]
+      #
+      # @param permitted_params [Hash] this likely comes from a class
+      #        method on the given form.  It's used for enforcing
+      #        strong parameters.  It's more of a schema for what the
+      #        input parameters should be.  Why not rely on the
+      #        form.class.permitted_params?  This is a violation of
+      #        the Law of Demeter, and due to object delegation, the
+      #        form.class may be a delegate class, and not the one
+      #        that has permitted_params.
+      #
+      # @see Hyrax::WorkForm.build_permitted_params
+      def initialize(form:, input_params:, permitted_params: nil)
+        @form = form
+        super(@form)
+        @input_params = input_params
+        @exposed_params = {}
+        @permitted_params = permitted_params || __default_permitted_params__(form: form)
+        build_exposed_params!
+      end
+
+      # Yes, I don't want to delegate class to the form, but based on
+      # past experiences, there are times where SimpleForm requests
+      # class.model_name and that had better align with the underlying
+      # form.
+      #
+      # Upon testing, when I don't have this method, the Javascript
+      # for "Requirements" on the new form will not properly
+      # acknowledge that we have re-filled the HTML form with the
+      # submitted non-file fields.
+      def class
+        @form.class
+      end
+
+      def model_name
+        @form.model_name
+      end
+
+      def to_model
+        self
+      end
+
+      def inspect
+        "Hyrax::Forms::FailedSubmissionFormWrapper(#{@form})"
+      end
+
+      def [](key)
+        if @exposed_params.key?(key)
+          @exposed_params.fetch(key)
+        else
+          super
+        end
+      end
+
+      private
+
+      def method_missing(method_name, *args, &block)
+        if @exposed_params.key?(method_name)
+          @exposed_params.fetch(method_name)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, *args)
+        return true if @exposed_params.key?(method_name)
+        super
+      end
+
+      def build_exposed_params!
+        @permitted_params.each do |permitted_param|
+          case permitted_param
+          when ::Symbol
+            @exposed_params[permitted_param] = @input_params.fetch(permitted_param) if @input_params.key?(permitted_param)
+          when ::Hash
+            permitted_param.each do |key, value_schema|
+              build_exposed_param_hash_element!(key: key, value_schema: value_schema)
+            end
+          end
+        end
+      end
+
+      def build_exposed_param_hash_element!(key:, value_schema:)
+        # The input may not include the given key, so don't attempt a fetch.
+        return unless @input_params.key?(key)
+        # I don't have a non-Array example of what this value_schema could be.
+        return unless value_schema.is_a?(::Array)
+        if value_schema.empty?
+          @exposed_params[key] = ::Array.wrap(@input_params.fetch(key))
+        elsif value_schema.is_a?(::Array)
+          # We're expecting nested attributes which will have the form:
+          # { "0" => <Hash with value_schema as keys>, "1" => <Hash with value_schema as keys> }
+          hash = {}
+          @input_params.fetch(key).each_pair do |nested_key, nested_value|
+            hash[nested_key] = nested_value.slice(*value_schema)
+          end
+          @exposed_params[key] = hash
+        end
+      end
+
+      # This method is specifically named __default_permitted_params__
+      # because the form object may well have a
+      # default_permitted_params; I know it's class most certainly
+      # does.
+      #
+      # In running tests, I'm seeing that in some cases a form object
+      # has an instance method for permitted_params, other times, a
+      # form object has a class method for permitted_params, and
+      # though I haven't seen it in specs, I do see that forms have a
+      # build_permitted_params method.
+      def __default_permitted_params__(form:)
+        if form.respond_to?(:permitted_params)
+          form.permitted_params
+        elsif form.class.respond_to?(:permitted_params)
+          form.class.permitted_params
+        elsif form.class.respond_to?(:build_permitted_params)
+          form.class.build_permitted_params
+        else
+          raise ArgumentError, "Unable to extract a suitable permitted_params from #{form.inspect}"
+        end
+      end
+    end
+  end
+end

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

@@ -36,7 +36,7 @@ module Hyrax
       #
       # @note due to historical oddities with Hydra::AccessControls and Hydra
       #   Editor, Hyrax's views rely on `agent_name` and `access` as field
-      #   names. we provide these as virtual fields andprepopulate these from
+      #   names. we provide these as virtual fields and prepopulate these from
       #   `Hyrax::Permission`.
       class Permission < Hyrax::ChangeSet
         property :agent_name, virtual: true, prepopulator: ->(_opts) { self.agent_name = model.agent }
@@ -65,9 +65,13 @@ module Hyrax
 
       class_attribute :model_class
 
-      delegate :depositor, :human_readable_type, to: :model
+      property :human_readable_type, writable: false
 
-      property :visibility # visibility has an accessor on the model
+      property :depositor
+      property :on_behalf_of
+      property :proxy_depositor
+
+      property :visibility, default: VisibilityIntention::PRIVATE
 
       property :date_modified, readable: false
       property :date_uploaded, readable: false
@@ -85,7 +89,7 @@ module Hyrax
       property :visibility_during_lease, virtual: true, prepopulator: ->(_opts) { self.visibility_during_lease = model.lease&.visibility_during_lease }
 
       # pcdm relationships
-      property :admin_set_id
+      property :admin_set_id, prepopulator: ->(_opts) { self.admin_set_id = AdminSet::DEFAULT_ID }
       property :member_ids, default: [], type: Valkyrie::Types::Array
       property :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
 

data/app/helpers/hyrax/collections_helper.rb

@@ -101,7 +101,7 @@ module Hyrax
     # @return [String] The CollectionType's title if found, else the gid
     def collection_type_label(collection_type_gid)
       CollectionType.find_by_gid!(collection_type_gid).title
-    rescue ActiveRecord::RecordNotFound, URI::BadURIError
+    rescue ActiveRecord::RecordNotFound, URI::InvalidURIError, URI::BadURIError
       CollectionType.find_or_create_default_collection_type.title
     end
 

data/app/helpers/hyrax/dashboard_helper_behavior.rb

@@ -5,8 +5,13 @@ module Hyrax
       params[:controller].match(%r{^hyrax/dashboard|hyrax/my})
     end
 
-    def number_of_works(user = current_user)
-      Hyrax::WorkRelation.new.where(DepositSearchBuilder.depositor_field => user.user_key).count
+    # @param user [User]
+    # @param where [Hash] applied as the where clause when querying the Hyrax::WorkRelation
+    #
+    # @see Hyrax::WorkRelation
+    def number_of_works(user = current_user, where: { generic_type_sim: "Work" })
+      where_clause = where.merge(DepositSearchBuilder.depositor_field => user.user_key)
+      Hyrax::WorkRelation.new.where(where_clause).count
     rescue RSolr::Error::ConnectionRefused
       'n/a'
     end

data/app/helpers/hyrax/embargo_helper.rb

@@ -20,11 +20,15 @@ module Hyrax
     #
     # @return [Boolean] whether the resource has an embargo that is currently
     #   enforced (regardless of whether it has expired)
+    #
+    # @note Hyrax::Forms::Failedsubmissionformwrapper is a place
+    #   holder until we switch to Valkyrie::ChangeSet instead of Form
+    #   objects
     def embargo_enforced?(resource)
       case resource
       when Hydra::AccessControls::Embargoable
         !resource.embargo_release_date.nil?
-      when HydraEditor::Form
+      when HydraEditor::Form, Hyrax::Forms::FailedSubmissionFormWrapper
         embargo_enforced?(resource.model)
       when Valkyrie::ChangeSet
         Hyrax::EmbargoManager.new(resource: resource.model).enforced?

data/app/helpers/hyrax/hyrax_helper_behavior.rb

@@ -19,7 +19,7 @@ module Hyrax
     include Hyrax::WorkFormHelper
 
     # Which translations are available for the user to select
-    # @return [Hash<String,String>] locale abbreviations as keys and flags as values
+    # @return [Hash{String => String}] locale abbreviations as keys and flags as values
     def available_translations
       {
         'de' => 'Deutsch',
@@ -105,7 +105,11 @@ module Hyrax
     # @see Blacklight::SearchState#initialize
     def link_to_field(name, value, label = nil, facet_hash = {})
       label ||= value
-      params = { search_field: name, q: "\"#{value}\"" } if name != ''
+      params = {}
+      if name.present?
+        params[:search_field] = name
+        params[:q] = "\"#{value}\""
+      end
       state = search_state_with_facets(params, facet_hash)
       link_to(label, main_app.search_catalog_path(state))
     end
@@ -124,7 +128,7 @@ module Hyrax
     # A Blacklight helper_method
     # @param options [Hash{Symbol=>Object}] Blacklight sends :document, :field, :config, :value and whatever else was in options
     # @option options [Array{String}] :value
-    # @option options [Hash] :config including {:field_name => "my_name"}
+    # @option options [Hash] :config including +{:field_name => "my_name"}+
     # @option options [Hash] :document
     # @option options [Array{String}] :value the strings you might otherwise have passed to this method singly
     # @return [ActiveSupport::SafeBuffer] the html_safe link
@@ -171,7 +175,6 @@ module Hyrax
     # @option field [Array] :value array of values for the field
     # @param show_link [Boolean]
     # @return [ActiveSupport::SafeBuffer]
-    # @todo stop being a helper_method, start being part of the Blacklight render stack?
     def iconify_auto_link(field, show_link = true)
       if field.is_a? Hash
         options = field[:config].separator_options || {}
@@ -302,7 +305,9 @@ module Hyrax
     # rubocop:enable Metrics/MethodLength
 
     # @param [ActionController::Parameters] params first argument for Blacklight::SearchState.new
-    # @param [Hash] facet
+    # @param [Hash] facet(s)
+    # @return [Hash]
+    #
     # @note Assumes one facet is passed in. If a second facet is passed, then it must be the depositor
     # facet used by the Profile page.
     def search_state_with_facets(params, facet = {})

data/app/helpers/hyrax/lease_helper.rb

@@ -20,11 +20,15 @@ module Hyrax
     #
     # @return [Boolean] whether the resource has an lease that is currently
     #   enforced (regardless of whether it has expired)
+    #
+    # @note Hyrax::Forms::Failedsubmissionformwrapper is a place
+    #   holder until we switch to Valkyrie::ChangeSet instead of Form
+    #   objects
     def lease_enforced?(resource)
       case resource
       when Hydra::AccessControls::Embargoable
         !resource.lease_expiration_date.nil?
-      when HydraEditor::Form
+      when HydraEditor::Form, Hyrax::Forms::FailedSubmissionFormWrapper
         lease_enforced?(resource.model)
       when Valkyrie::ChangeSet
         Hyrax::LeaseManager.new(resource: resource.model).enforced?

data/app/indexers/hyrax/pcdm_collection_indexer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Indexes properties common to PCDM Collections
+  class PcdmCollectionIndexer < Hyrax::ValkyrieIndexer
+    include Hyrax::ResourceIndexer
+    include Hyrax::PermissionIndexer
+    include Hyrax::VisibilityIndexer
+    include Hyrax::Indexer(:core_metadata)
+    include Hyrax::Indexer(:basic_metadata)
+
+    def to_solr
+      super.tap do |index_document|
+        index_document[Hyrax.config.collection_type_index_field.to_sym] = Array(resource.try(:collection_type_gid)&.to_s)
+        index_document[:generic_type_sim] = ['Collection']
+        index_document[:thumbnail_path_ss] = Hyrax::CollectionThumbnailPathService.call(resource)
+      end
+    end
+  end
+end

data/app/indexers/hyrax/resource_indexer.rb

@@ -6,7 +6,9 @@ module Hyrax
   module ResourceIndexer
     def to_solr
       super.tap do |index_document|
-        index_document[:alternate_ids_sm] = resource.alternate_ids.map(&:to_s)
+        index_document[:has_model_ssim] = resource.class.name
+        index_document[:human_readable_type_tesim] = resource.human_readable_type
+        index_document[:alternate_ids_sim] = resource.alternate_ids.map(&:to_s)
       end
     end
   end