hyrax 2.8.0 → 3.0.0.pre.rc2

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
   end

data/app/controllers/concerns/hyrax/collections/accepts_batches.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Collections
     module AcceptsBatches
@@ -16,38 +17,38 @@ module Hyrax
 
       private
 
-        def batch_ids_from_params
-          if params['batch_document_ids'].blank?
-            []
-          elsif params['batch_document_ids'] == 'all'
-            SearchService.new(session, current_user.user_key).last_search_documents.map(&:id)
-          else
-            params['batch_document_ids']
-          end
+      def batch_ids_from_params
+        if params['batch_document_ids'].blank?
+          []
+        elsif params['batch_document_ids'] == 'all'
+          SearchService.new(session, current_user.user_key).last_search_documents.map(&:id)
+        else
+          params['batch_document_ids']
         end
+      end
 
-        def filter_docs_with_read_access!
-          filter_docs_with_access!(:read)
-        end
+      def filter_docs_with_read_access!
+        filter_docs_with_access!(:read)
+      end
 
-        def filter_docs_with_edit_access!
-          filter_docs_with_access!(:edit)
-        end
+      def filter_docs_with_edit_access!
+        filter_docs_with_access!(:edit)
+      end
 
-        def filter_docs_with_access!(access_type = :edit)
-          no_permissions = []
-          if batch.empty?
-            flash[:notice] = 'Select something first'
-          else
-            batch.dup.each do |doc_id|
-              unless can?(access_type, doc_id)
-                batch.delete(doc_id)
-                no_permissions << doc_id
-              end
+      def filter_docs_with_access!(access_type = :edit)
+        no_permissions = []
+        if batch.empty?
+          flash[:notice] = 'Select something first'
+        else
+          batch.dup.each do |doc_id|
+            unless can?(access_type, doc_id)
+              batch.delete(doc_id)
+              no_permissions << doc_id
             end
-            flash[:notice] = "You do not have permission to edit the documents: #{no_permissions.join(', ')}" unless no_permissions.empty?
           end
+          flash[:notice] = "You do not have permission to edit the documents: #{no_permissions.join(', ')}" unless no_permissions.empty?
         end
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module CollectionsControllerBehavior
     extend ActiveSupport::Concern
@@ -25,7 +26,7 @@ module Hyrax
     end
 
     def show
-      @curation_concern ||= ActiveFedora::Base.find(params[:id])
+      @curation_concern ||= Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: params[:id])
       presenter
       query_collection_members
     end
@@ -36,73 +37,73 @@ module Hyrax
 
     private
 
-      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
+    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
 
-      # 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))
-      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))
+    end
 
-      def collection_params
-        form_class.model_attributes(params[:collection])
-      end
+    def collection_params
+      form_class.model_attributes(params[:collection])
+    end
 
-      # Include 'catalog' and 'hyrax/base' in the search path for views, while prefering
-      # our local paths. Thus we are unable to just override `self.local_prefixes`
-      def _prefixes
-        @_prefixes ||= super + ['catalog', 'hyrax/base']
-      end
+    # Include 'catalog' and 'hyrax/base' in the search path for views, while prefering
+    # our local paths. Thus we are unable to just override `self.local_prefixes`
+    def _prefixes
+      @_prefixes ||= super + ['catalog', 'hyrax/base']
+    end
 
-      def query_collection_members
-        member_works
-        member_subcollections if collection.collection_type.nestable?
-        parent_collections if collection.collection_type.nestable? && action_name == 'show'
-      end
+    def query_collection_members
+      member_works
+      member_subcollections if collection.collection_type.nestable?
+      parent_collections if collection.collection_type.nestable? && action_name == 'show'
+    end
 
-      # Instantiate the membership query service
-      def collection_member_service
-        @collection_member_service ||= membership_service_class.new(scope: self, collection: collection, params: params_for_query)
-      end
+    # Instantiate the membership query service
+    def collection_member_service
+      @collection_member_service ||= membership_service_class.new(scope: self, collection: collection, params: params_for_query)
+    end
 
-      def member_works
-        @response = collection_member_service.available_member_works
-        @member_docs = @response.documents
-        @members_count = @response.total
-      end
+    def member_works
+      @response = collection_member_service.available_member_works
+      @member_docs = @response.documents
+      @members_count = @response.total
+    end
 
-      def parent_collections
-        page = params[:parent_collection_page].to_i
-        query = Hyrax::Collections::NestedCollectionQueryService
-        collection.parent_collections = query.parent_collections(child: collection_object, scope: self, page: page)
-      end
+    def parent_collections
+      page = params[:parent_collection_page].to_i
+      query = Hyrax::Collections::NestedCollectionQueryService
+      collection.parent_collections = query.parent_collections(child: collection_object, scope: self, page: page)
+    end
 
-      def collection_object
-        action_name == 'show' ? Collection.find(collection.id) : collection
-      end
+    def collection_object
+      action_name == 'show' ? Collection.find(collection.id) : collection
+    end
 
-      def member_subcollections
-        results = collection_member_service.available_member_subcollections
-        @subcollection_solr_response = results
-        @subcollection_docs = results.documents
-        @subcollection_count = @presenter.subcollection_count = results.total
-      end
+    def member_subcollections
+      results = collection_member_service.available_member_subcollections
+      @subcollection_solr_response = results
+      @subcollection_docs = results.documents
+      @subcollection_count = @presenter.subcollection_count = results.total
+    end
 
-      # You can override this method if you need to provide additional inputs to the search
-      # builder. For example:
-      #   search_field: 'all_fields'
-      # @return <Hash> the inputs required for the collection member query service
-      def params_for_query
-        params.merge(q: params[:cq])
-      end
+    # You can override this method if you need to provide additional inputs to the search
+    # builder. For example:
+    #   search_field: 'all_fields'
+    # @return <Hash> the inputs required for the collection member query service
+    def params_for_query
+      params.merge(q: params[:cq])
+    end
   end
 end

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

@@ -1,3 +1,11 @@
+# frozen_string_literal: true
+
+##
+# A mixin for Hyrax support methods. This is meant to be included in
+# `ApplicationController`.
+#
+# @note private methods within this module are normally still "public API",
+#   since they are meant to be called by inheriting controllers.
 module Hyrax::Controller
   extend ActiveSupport::Concern
 
@@ -15,20 +23,6 @@ module Hyrax::Controller
     hyrax.dashboard_path
   end
 
-  ##
-  # @deprecated this helper is no longer used by Hyrax; if you need access to
-  #   this presenter on every page, you may need to readd it manually.
-  #
-  # A presenter for selecting a work type to create this is needed here because
-  # the selector is in the header on every page.
-  def create_work_presenter
-    Deprecation.warn(self, "The `create_work_presenter` helper is deprecated " \
-                           "for removal in Hyrax 3.0. The work selector has " \
-                           "been removed the masthead in Hyrax 2.1.")
-
-    Hyrax::SelectTypeListPresenter.new(current_user)
-  end
-
   # Ensure that the locale choice is persistent across requests
   def default_url_options
     super.merge(locale: I18n.locale)
@@ -36,47 +30,62 @@ module Hyrax::Controller
 
   private
 
-    def set_locale
-      I18n.locale = params[:locale] || I18n.default_locale
-    end
+  ##
+  # @api public
+  #
+  # @return [#[]] a resolver for Hyrax's Transactions; this *should* be a
+  #   thread-safe Dry::Container, but callers to this method should strictly
+  #   use #[] for access
+  #
+  # @example
+  #   transactions['change_set.create_work'].call(my_form)
+  #
+  # @see https://dry-rb.org/gems/dry-container
+  def transactions
+    Hyrax::Transactions::Container
+  end
 
-    # render a json response for +response_type+
-    def render_json_response(response_type: :success, message: nil, options: {})
-      json_body = Hyrax::API.generate_response_body(response_type: response_type, message: message, options: options)
-      render json: json_body, status: response_type
-    end
+  def set_locale
+    I18n.locale = params[:locale] || I18n.default_locale
+  end
 
-    # Called by Hydra::Controller::ControllerBehavior when CanCan::AccessDenied is caught
-    # @param [CanCan::AccessDenied] exception error to handle
-    def deny_access(exception)
-      # For the JSON message, we don't want to display the default CanCan messages,
-      # just custom Hydra messages such as "This item is under embargo.", etc.
-      json_message = exception.message if exception.is_a? Hydra::AccessDenied
-      if current_user&.persisted?
-        deny_access_for_current_user(exception, json_message)
-      else
-        deny_access_for_anonymous_user(exception, json_message)
-      end
+  # render a json response for +response_type+
+  def render_json_response(response_type: :success, message: nil, options: {})
+    json_body = Hyrax::API.generate_response_body(response_type: response_type, message: message, options: options)
+    render json: json_body, status: response_type
+  end
+
+  # Called by Hydra::Controller::ControllerBehavior when CanCan::AccessDenied is caught
+  # @param [CanCan::AccessDenied] exception error to handle
+  def deny_access(exception)
+    # For the JSON message, we don't want to display the default CanCan messages,
+    # just custom Hydra messages such as "This item is under embargo.", etc.
+    json_message = exception.message if exception.is_a? Hydra::AccessDenied
+    if current_user&.persisted?
+      deny_access_for_current_user(exception, json_message)
+    else
+      deny_access_for_anonymous_user(exception, json_message)
     end
+  end
 
-    def deny_access_for_current_user(exception, json_message)
-      respond_to do |wants|
-        wants.html do
-          if [:show, :edit, :create, :update, :destroy].include? exception.action
-            render 'hyrax/base/unauthorized', status: :unauthorized
-          else
-            redirect_to main_app.root_url, alert: exception.message
-          end
+  def deny_access_for_current_user(exception, json_message)
+    respond_to do |wants|
+      wants.html do
+        if [:show, :edit, :create, :update, :destroy].include? exception.action
+          render 'hyrax/base/unauthorized', status: :unauthorized
+        else
+          redirect_to main_app.root_url, alert: exception.message
         end
-        wants.json { render_json_response(response_type: :forbidden, message: json_message) }
       end
+      wants.json { render_json_response(response_type: :forbidden, message: json_message) }
     end
+  end
 
-    def deny_access_for_anonymous_user(exception, json_message)
-      session['user_return_to'.freeze] = request.url
-      respond_to do |wants|
-        wants.html { redirect_to main_app.new_user_session_path, alert: exception.message }
-        wants.json { render_json_response(response_type: :unauthorized, message: json_message) }
-      end
+  def deny_access_for_anonymous_user(exception, json_message)
+    session['user_return_to'] = request.url
+    respond_to do |wants|
+      wants.html { redirect_to main_app.new_user_session_path, alert: exception.message }
+      wants.json { render_json_response(response_type: :unauthorized, message: json_message) }
     end
+  end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module DenyAccessOverrideBehavior
     # Overriding the default behavior from Hydra::Core::ControllerBehavior
@@ -5,7 +6,7 @@ module Hyrax
       if current_user&.persisted?
         redirect_to root_path, alert: exception.message
       else
-        session['user_return_to'.freeze] = request.url
+        session['user_return_to'] = request.url
         redirect_to main_app.new_user_session_path, alert: exception.message
       end
     end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module EmbargoesControllerBehavior
     extend ActiveSupport::Concern
@@ -25,15 +26,17 @@ module Hyrax
     # Updates a batch of embargos
     def update
       filter_docs_with_edit_access!
-      copy_visibility = params[:embargoes].values.map { |h| h[:copy_visibility] }
-      ActiveFedora::Base.find(batch).each do |curation_concern|
+      copy_visibility = []
+      copy_visibility = params[:embargoes].values.map { |h| h[:copy_visibility] } if params[:embargoes]
+      af_objects = Hyrax.custom_queries.find_many_by_alternate_ids(alternate_ids: batch, use_valkyrie: false)
+      af_objects.each do |curation_concern|
         Hyrax::Actors::EmbargoActor.new(curation_concern).destroy
-        # if the concern is a FileSet, set its visibility and skip the copy_visibility_to_files, which is built for Works
+        # if the concern is a FileSet, set its visibility and visibility propagation
         if curation_concern.file_set?
           curation_concern.visibility = curation_concern.to_solr["visibility_after_embargo_ssim"]
           curation_concern.save!
         elsif copy_visibility.include?(curation_concern.id)
-          curation_concern.copy_visibility_to_files
+          Hyrax::VisibilityPropagator.for(source: curation_concern).propagate
         end
       end
       redirect_to embargoes_path, notice: t('.embargo_deactivated')

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module LeasesControllerBehavior
     extend ActiveSupport::Concern
@@ -24,10 +25,13 @@ module Hyrax
 
     def update
       filter_docs_with_edit_access!
-      copy_visibility = params[:leases].values.map { |h| h[:copy_visibility] }
-      ActiveFedora::Base.find(batch).each do |curation_concern|
+      copy_visibility = []
+      copy_visibility = params[:leases].values.map { |h| h[:copy_visibility] } if params[:leases]
+      af_objects = Hyrax.custom_queries.find_many_by_alternate_ids(alternate_ids: batch, use_valkyrie: false)
+      af_objects.each do |curation_concern|
         Hyrax::Actors::LeaseActor.new(curation_concern).destroy
-        curation_concern.copy_visibility_to_files if copy_visibility.include?(curation_concern.id)
+        Hyrax::VisibilityPropagator.for(source: curation_concern).propagate if
+          copy_visibility.include?(curation_concern.id)
       end
       redirect_to leases_path
     end

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

@@ -1,87 +1,88 @@
+# frozen_string_literal: true
 module Hyrax
   module LocalFileDownloadsControllerBehavior
     protected
 
-      # Handle the HTTP show request
-      def send_local_content
-        response.headers['Accept-Ranges'] = 'bytes'
-        if request.head?
-          local_content_head
-        elsif request.headers['Range']
-          send_range_for_local_file
-        else
-          send_local_file_contents
-        end
+    # Handle the HTTP show request
+    def send_local_content
+      response.headers['Accept-Ranges'] = 'bytes'
+      if request.head?
+        local_content_head
+      elsif request.headers['Range']
+        send_range_for_local_file
+      else
+        send_local_file_contents
       end
+    end
 
-      # render an HTTP Range response
-      def send_range_for_local_file
-        _, range = request.headers['Range'].split('bytes=')
-        from, to = range.split('-').map(&:to_i)
-        to = local_file_size - 1 unless to
-        length = to - from + 1
-        response.headers['Content-Range'] = "bytes #{from}-#{to}/#{local_file_size}"
-        response.headers['Content-Length'] = length.to_s
-        self.status = 206
-        prepare_local_file_headers
-        # For derivatives stored on the local file system
-        send_data IO.binread(file, length, from), local_derivative_download_options.merge(status: status)
-      end
+    # render an HTTP Range response
+    def send_range_for_local_file
+      _, range = request.headers['Range'].split('bytes=')
+      from, to = range.split('-').map(&:to_i)
+      to = local_file_size - 1 unless to
+      length = to - from + 1
+      response.headers['Content-Range'] = "bytes #{from}-#{to}/#{local_file_size}"
+      response.headers['Content-Length'] = length.to_s
+      self.status = 206
+      prepare_local_file_headers
+      # For derivatives stored on the local file system
+      send_data IO.binread(file, length, from), local_derivative_download_options.merge(status: status)
+    end
 
-      def send_local_file_contents
-        return unless stale?(last_modified: local_file_last_modified, template: false)
-        self.status = 200
-        prepare_local_file_headers
-        # For derivatives stored on the local file system
-        send_file file, local_derivative_download_options
-      end
+    def send_local_file_contents
+      return unless stale?(last_modified: local_file_last_modified, template: false)
+      self.status = 200
+      prepare_local_file_headers
+      # For derivatives stored on the local file system
+      send_file file, local_derivative_download_options
+    end
 
-      def local_file_size
-        File.size(file)
-      end
+    def local_file_size
+      File.size(file)
+    end
 
-      def local_file_mime_type
-        mime_type_for(file)
-      end
+    def local_file_mime_type
+      mime_type_for(file)
+    end
 
-      # @return [String] the filename
-      def local_file_name
-        params[:filename] || File.basename(file) || (asset.respond_to?(:label) && asset.label)
-      end
+    # @return [String] the filename
+    def local_file_name
+      params[:filename] || File.basename(file) || (asset.respond_to?(:label) && asset.label)
+    end
 
-      def local_file_last_modified
-        File.mtime(file) if file.is_a? String
-      end
+    def local_file_last_modified
+      File.mtime(file) if file.is_a? String
+    end
 
-      # Override
-      # render an HTTP HEAD response
-      def local_content_head
-        response.headers['Content-Length'] = local_file_size.to_s
-        head :ok, content_type: local_file_mime_type
-      end
+    # Override
+    # render an HTTP HEAD response
+    def local_content_head
+      response.headers['Content-Length'] = local_file_size.to_s
+      head :ok, content_type: local_file_mime_type
+    end
 
-      # Override
-      def prepare_local_file_headers
-        send_file_headers! local_content_options
-        response.headers['Content-Type'] = local_file_mime_type
-        response.headers['Content-Length'] ||= local_file_size.to_s
-        # Prevent Rack::ETag from calculating a digest over body
-        response.headers['Last-Modified'] ||= local_file_last_modified.httpdate
-        self.content_type = local_file_mime_type
-      end
+    # Override
+    def prepare_local_file_headers
+      send_file_headers! local_content_options
+      response.headers['Content-Type'] = local_file_mime_type
+      response.headers['Content-Length'] ||= local_file_size.to_s
+      # Prevent Rack::ETag from calculating a digest over body
+      response.headers['Last-Modified'] = local_file_last_modified.httpdate
+      self.content_type = local_file_mime_type
+    end
 
     private
 
-      # Override the Hydra::Controller::DownloadBehavior#content_options so that
-      # we have an attachement rather than 'inline'
-      def local_content_options
-        { type: local_file_mime_type, filename: local_file_name, disposition: 'attachment' }
-      end
+    # Override the Hydra::Controller::DownloadBehavior#content_options so that
+    # we have an attachement rather than 'inline'
+    def local_content_options
+      { type: local_file_mime_type, filename: local_file_name, disposition: 'attachment' }
+    end
 
-      # Override this method if you want to change the options sent when downloading
-      # a derivative file
-      def local_derivative_download_options
-        { type: local_file_mime_type, filename: local_file_name, disposition: 'inline' }
-      end
+    # Override this method if you want to change the options sent when downloading
+    # a derivative file
+    def local_derivative_download_options
+      { type: local_file_mime_type, filename: local_file_name, disposition: 'inline' }
+    end
   end
 end