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

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

@@ -39,20 +39,29 @@ module Hyrax
 
     def presenter
       @presenter ||= begin
-        # Query Solr for the collection.
-        # run the solr query to find the collection members
-        response = repository.search(single_item_search_builder.query)
-        curation_concern = response.documents.first
-        raise CanCan::AccessDenied unless curation_concern
         presenter_class.new(curation_concern, current_ability)
       end
     end
 
+    def curation_concern
+      # Query Solr for the collection.
+      # run the solr query to find the collection members
+      response, _docs = search_service.search_results
+      curation_concern = response.documents.first
+      raise CanCan::AccessDenied unless curation_concern
+      curation_concern
+    end
+
+    def search_service
+      Hyrax::SearchService.new(config: blacklight_config, user_params: params.except(:q, :page), scope: self, search_builder_class: single_item_search_builder_class)
+    end
+
     # Instantiates the search builder that builds a query for a single item
     # this is useful in the show view.
     def single_item_search_builder
-      single_item_search_builder_class.new(self).with(params.except(:q, :page))
+      search_service.search_builder
     end
+    deprecation_deprecate :single_item_search_builder
 
     def collection_params
       form_class.model_attributes(params[:collection])

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

@@ -11,11 +11,12 @@ module Hyrax
       with_themed_layout :decide_layout
       copy_blacklight_config_from(::CatalogController)
 
-      class_attribute :_curation_concern_type, :show_presenter, :work_form_service, :search_builder_class, :iiif_manifest_builder
+      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
       self.work_form_service = Hyrax::WorkFormService
       self.search_builder_class = WorkSearchBuilder
-      self.iiif_manifest_builder = (Flipflop.cache_work_iiif_manifest? ? Hyrax::CachingIiifManifestBuilder.new : Hyrax::ManifestBuilderService.new)
+      self.iiif_manifest_builder = nil
       attr_accessor :curation_concern
       helper_method :curation_concern, :contextual_path
 
@@ -53,12 +54,17 @@ module Hyrax
     end
 
     def create
+      # Caching the original input params in case the form is not valid
+      original_input_params_for_form = params[hash_key_for_curation_concern].deep_dup
       if create_work
         after_create_response
       else
         respond_to do |wants|
           wants.html do
             build_form
+            # Creating a form object that can re-render most of the
+            # submitted parameters
+            @form = Hyrax::Forms::FailedSubmissionFormWrapper.new(form: @form, input_params: original_input_params_for_form)
             render 'new', status: :unprocessable_entity
           end
           wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: curation_concern.errors }) }
@@ -137,12 +143,13 @@ module Hyrax
     private
 
     def iiif_manifest_builder
-      self.class.iiif_manifest_builder
+      self.class.iiif_manifest_builder ||
+        (Flipflop.cache_work_iiif_manifest? ? Hyrax::CachingIiifManifestBuilder.new : Hyrax::ManifestBuilderService.new)
     end
 
     def iiif_manifest_presenter
       IiifManifestPresenter.new(search_result_document(id: params[:id])).tap do |p|
-        p.hostname = request.hostname
+        p.hostname = request.base_url
         p.ability = current_ability
       end
     end
@@ -182,8 +189,12 @@ module Hyrax
       else
         form = build_form
 
-        @curation_concern = form.validate(params[hash_key_for_curation_concern]) &&
-                            transactions['change_set.create_work'].call(form).value!
+        @curation_concern =
+          form.validate(params[hash_key_for_curation_concern]) &&
+          transactions['change_set.create_work']
+          .with_step_args('work_resource.add_file_sets' => { uploaded_files: uploaded_files },
+                          'change_set.set_user_as_depositor' => { user: current_user })
+          .call(form).value!
       end
     end
 
@@ -194,8 +205,11 @@ module Hyrax
       else
         form = build_form
 
-        @curation_concern = form.validate(params[hash_key_for_curation_concern]) &&
-                            transactions['change_set.update_work'].call(form).value!
+        @curation_concern =
+          form.validate(params[hash_key_for_curation_concern]) &&
+          transactions['change_set.update_work']
+          .with_step_args('work_resource.add_file_sets' => { uploaded_files: uploaded_files })
+          .call(form).value!
       end
     end
 
@@ -237,37 +251,37 @@ module Hyrax
       search_result_document(search_params)
     end
 
+    ##
     # Only returns unsuppressed documents the user has read access to
     #
     # @api public
     #
     # @param search_params [ActionController::Parameters] this should
-    # include an :id key, but based on implementation and use of the
-    # WorkSearchBuilder, it need not.
+    #   include an :id key, but based on implementation and use of the
+    #   WorkSearchBuilder, it need not.
     #
     # @return [SolrDocument]
     #
-    #
     # @raise [WorkflowAuthorizationException] when the object is not
-    # found via the search builder's search logic BUT the object is
-    # suppressed AND the user can read it (Yeah, it's confusing but
-    # after a lot of debugging that's the logic)
+    #   found via the search builder's search logic BUT the object is
+    #   suppressed AND the user can read it (Yeah, it's confusing but
+    #   after a lot of debugging that's the logic)
     #
     # @raise [CanCan::AccessDenied] when the object is not found via
-    # the search builder's search logic BUT the object is not
-    # supressed OR not readable by the user (Yeah.)
-
+    #   the search builder's search logic BUT the object is not
+    #   supressed OR not readable by the user (Yeah.)
+    #
     # @note This is Jeremy, I have suspicions about the first line of
-    #       this comment (eg, "Only return unsuppressed...").  The
-    #       reason is that I've encounter situations in the specs
-    #       where the document_list is empty but if I then query Solr
-    #       for the object by ID, I get a document that is NOT
-    #       suppressed AND can be read.  In other words, I believe
-    #       there is more going on in the search_results method
-    #       (e.g. a filter is being applied that is beyond what the
-    #       comment indicates)
+    #   this comment (eg, "Only return unsuppressed...").  The
+    #   reason is that I've encounter situations in the specs
+    #   where the document_list is empty but if I then query Solr
+    #   for the object by ID, I get a document that is NOT
+    #   suppressed AND can be read.  In other words, I believe
+    #   there is more going on in the search_results method
+    #   (e.g. a filter is being applied that is beyond what the
+    #   comment indicates)
     #
-    # @see {#document_not_found!}
+    # @see #document_not_found!
     def search_result_document(search_params)
       _, document_list = search_results(search_params)
       return document_list.first unless document_list.empty?
@@ -356,10 +370,8 @@ module Hyrax
     end
 
     def after_update_response
-      if curation_concern.file_sets.present?
-        return redirect_to hyrax.confirm_access_permission_path(curation_concern) if permissions_changed?
-        return redirect_to main_app.confirm_hyrax_permission_path(curation_concern) if curation_concern.visibility_changed?
-      end
+      return redirect_to hyrax.confirm_access_permission_path(curation_concern) if permissions_changed? && concern_has_file_sets?
+
       respond_to do |wants|
         wants.html { redirect_to [main_app, curation_concern], notice: "Work \"#{curation_concern}\" successfully updated." }
         wants.json { render :show, status: :ok, location: polymorphic_path([main_app, curation_concern]) }
@@ -392,7 +404,26 @@ module Hyrax
     end
 
     def permissions_changed?
-      @saved_permissions != curation_concern.permissions.map(&:to_hash)
+      @saved_permissions !=
+        case curation_concern
+        when ActiveFedora::Base
+          curation_concern.permissions.map(&:to_hash)
+        else
+          Hyrax::AccessControl.for(resource: curation_concern).permissions
+        end
+    end
+
+    def concern_has_file_sets?
+      case curation_concern
+      when ActiveFedora::Common
+        curation_concern.file_sets.present?
+      else
+        Hyrax.custom_queries.find_child_fileset_ids(resource: curation_concern).any?
+      end
+    end
+
+    def uploaded_files
+      UploadedFile.find(params.fetch(:uploaded_files, []))
     end
   end
 end

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

@@ -5,6 +5,11 @@ module Hyrax
     class CollectionsController < Hyrax::My::CollectionsController
       include Blacklight::AccessControls::Catalog
       include Blacklight::Base
+
+      configure_blacklight do |config|
+        config.search_builder_class = Hyrax::Dashboard::CollectionsSearchBuilder
+      end
+
       include BreadcrumbsForCollections
       with_themed_layout 'dashboard'
 
@@ -55,7 +60,7 @@ module Hyrax
         # Coming from the UI, a collection type id should always be present.  Coming from the API, if a collection type id is not specified,
         # use the default collection type (provides backward compatibility with versions < Hyrax 2.1.0)
         collection_type_id = params[:collection_type_id].presence || default_collection_type.id
-        @collection.collection_type_gid = CollectionType.find(collection_type_id).gid
+        @collection.collection_type_gid = CollectionType.find(collection_type_id).to_global_id
         add_breadcrumb t(:'hyrax.controls.home'), root_path
         add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
         add_breadcrumb t('.header', type_title: @collection.collection_type.title), request.path
@@ -106,7 +111,7 @@ module Hyrax
         authorize! :create, @collection
         # Coming from the UI, a collection type gid should always be present.  Coming from the API, if a collection type gid is not specified,
         # use the default collection type (provides backward compatibility with versions < Hyrax 2.1.0)
-        @collection.collection_type_gid = params[:collection_type_gid].presence || default_collection_type.gid
+        @collection.collection_type_gid = params[:collection_type_gid].presence || default_collection_type.to_global_id
         @collection.attributes = collection_params.except(:members, :parent_id, :collection_type_gid)
         @collection.apply_depositor_metadata(current_user.user_key)
         add_members_to_collection unless batch.empty?
@@ -192,10 +197,6 @@ module Hyrax
         render json: result
       end
 
-      def search_builder_class
-        Hyrax::Dashboard::CollectionsSearchBuilder
-      end
-
       private
 
       def default_collection_type
@@ -315,20 +316,29 @@ module Hyrax
 
       def presenter
         @presenter ||= begin
-          # Query Solr for the collection.
-          # run the solr query to find the collection members
-          response = repository.search(single_item_search_builder.query)
-          curation_concern = response.documents.first
-          raise CanCan::AccessDenied unless curation_concern
           presenter_class.new(curation_concern, current_ability)
         end
       end
 
+      def curation_concern
+        # Query Solr for the collection.
+        # run the solr query to find the collection members
+        response, _docs = single_item_search_service.search_results
+        curation_concern = response.documents.first
+        raise CanCan::AccessDenied unless curation_concern
+        curation_concern
+      end
+
+      def single_item_search_service
+        Hyrax::SearchService.new(config: blacklight_config, user_params: params.except(:q, :page), scope: self, search_builder_class: single_item_search_builder_class)
+      end
+
       # Instantiates the search builder that builds a query for a single item
       # this is useful in the show view.
       def single_item_search_builder
-        single_item_search_builder_class.new(self).with(params.except(:q, :page))
+        search_service.search_builder
       end
+      deprecation_deprecate :single_item_search_builder
 
       def collection_params
         @participants = extract_old_style_permission_attributes(params[:collection])

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

@@ -3,10 +3,9 @@ module Hyrax
   module Dashboard
     ## Shows a list of all works to the admins
     class WorksController < Hyrax::My::WorksController
-      # Search builder for a list of works
-      # Override of Blacklight::RequestBuilders
-      def search_builder_class
-        Hyrax::Dashboard::WorksSearchBuilder
+      # Define collection specific filter facets.
+      configure_blacklight do |config|
+        config.search_builder_class = Hyrax::Dashboard::WorksSearchBuilder
       end
 
       private

data/app/controllers/hyrax/file_sets_controller.rb

@@ -14,6 +14,10 @@ module Hyrax
 
     helper_method :curation_concern
     copy_blacklight_config_from(::CatalogController)
+    # Define collection specific filter facets.
+    configure_blacklight do |config|
+      config.search_builder_class = Hyrax::FileSetSearchBuilder
+    end
 
     class_attribute :show_presenter, :form_class
     self.show_presenter = Hyrax::FileSetPresenter
@@ -135,16 +139,11 @@ module Hyrax
       when 'edit'
         add_breadcrumb I18n.t("hyrax.file_set.browse_view"), main_app.hyrax_file_set_path(params["id"])
       when 'show'
-        add_breadcrumb presenter.parent.to_s, main_app.polymorphic_path(presenter.parent)
+        add_breadcrumb presenter.parent.to_s, main_app.polymorphic_path(presenter.parent) if presenter.parent.present?
         add_breadcrumb presenter.to_s, main_app.polymorphic_path(presenter)
       end
     end
 
-    # Override of Blacklight::RequestBuilders
-    def search_builder_class
-      Hyrax::FileSetSearchBuilder
-    end
-
     def initialize_edit_form
       @parent = @file_set.in_objects.first
       original = @file_set.original_file
@@ -162,13 +161,23 @@ module Hyrax
 
     def presenter
       @presenter ||= begin
-        _, document_list = search_results(params)
-        curation_concern = document_list.first
-        raise CanCan::AccessDenied unless curation_concern
-        show_presenter.new(curation_concern, current_ability, request)
+        show_presenter.new(curation_concern_document, current_ability, request)
       end
     end
 
+    def curation_concern_document
+      # Query Solr for the collection.
+      # run the solr query to find the collection members
+      response, _docs = single_item_search_service.search_results
+      curation_concern = response.documents.first
+      raise CanCan::AccessDenied unless curation_concern
+      curation_concern
+    end
+
+    def single_item_search_service
+      Hyrax::SearchService.new(config: blacklight_config, user_params: params.except(:q, :page), scope: self, search_builder_class: search_builder_class)
+    end
+
     def wants_to_revert?
       params.key?(:revision) && params[:revision] != curation_concern.latest_content_version.label
     end

data/app/controllers/hyrax/homepage_controller.rb

@@ -5,12 +5,6 @@ class Hyrax::HomepageController < ApplicationController
   include Blacklight::SearchHelper
   include Blacklight::AccessControls::Catalog
 
-  # The search builder for finding recent documents
-  # Override of Blacklight::RequestBuilders
-  def search_builder_class
-    Hyrax::HomepageSearchBuilder
-  end
-
   class_attribute :presenter_class
   self.presenter_class = Hyrax::HomepagePresenter
   layout 'homepage'
@@ -29,21 +23,27 @@ class Hyrax::HomepageController < ApplicationController
 
   # Return 5 collections
   def collections(rows: 5)
-    builder = Hyrax::CollectionSearchBuilder.new(self)
-                                            .rows(rows)
-    response = repository.search(builder)
-    response.documents
+    Hyrax::CollectionsService.new(self).search_results do |builder|
+      builder.rows(rows)
+    end
   rescue Blacklight::Exceptions::ECONNREFUSED, Blacklight::Exceptions::InvalidRequest
     []
   end
 
   def recent
     # grab any recent documents
-    (_, @recent_documents) = search_results(q: '', sort: sort_field, rows: 4)
+    (_, @recent_documents) = search_service.search_results do |builder|
+      builder.rows(4)
+      builder.merge(sort: sort_field)
+    end
   rescue Blacklight::Exceptions::ECONNREFUSED, Blacklight::Exceptions::InvalidRequest
     @recent_documents = []
   end
 
+  def search_service
+    Hyrax::SearchService.new(config: blacklight_config, user_params: { q: '' }, scope: self, search_builder_class: Hyrax::HomepageSearchBuilder)
+  end
+
   def sort_field
     "date_uploaded_dtsi desc"
   end

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

@@ -2,13 +2,16 @@
 module Hyrax
   module My
     class CollectionsController < MyController
+      configure_blacklight do |config|
+        config.search_builder_class = Hyrax::My::CollectionsSearchBuilder
+      end
       # Define collection specific filter facets.
       def self.configure_facets
         configure_blacklight do |config|
           # Name of pivot facet must match field name that uses helper_method
-          config.add_facet_field ::Collection.collection_type_gid_document_field_name,
+          config.add_facet_field Hyrax.config.collection_type_index_field,
                                  helper_method: :collection_type_label, limit: 5,
-                                 pivot: ['has_model_ssim', ::Collection.collection_type_gid_document_field_name],
+                                 pivot: ['has_model_ssim', Hyrax.config.collection_type_index_field],
                                  label: I18n.t('hyrax.dashboard.my.heading.collection_type')
           # This causes AdminSets to also be shown with the Collection Type label
           config.add_facet_field 'has_model_ssim',
@@ -18,10 +21,6 @@ module Hyrax
       end
       configure_facets
 
-      def search_builder_class
-        Hyrax::My::CollectionsSearchBuilder
-      end
-
       def index
         add_breadcrumb t(:'hyrax.controls.home'), root_path
         add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path

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

@@ -2,9 +2,8 @@
 module Hyrax
   module My
     class HighlightsController < MyController
-      # Override of Blacklight::RequestBuilders
-      def search_builder_class
-        Hyrax::My::HighlightsSearchBuilder
+      configure_blacklight do |config|
+        config.search_builder_class = Hyrax::My::HighlightsSearchBuilder
       end
 
       def index

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

@@ -2,9 +2,8 @@
 module Hyrax
   module My
     class SharesController < MyController
-      # Override of Blacklight::RequestBuilders
-      def search_builder_class
-        Hyrax::My::SharesSearchBuilder
+      configure_blacklight do |config|
+        config.search_builder_class = Hyrax::My::SharesSearchBuilder
       end
 
       def index