hyrax 2.8.0 → 3.0.0.pre.rc2

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Dashboard
     class NestCollectionsController < ApplicationController
@@ -62,38 +63,38 @@ module Hyrax
 
       private
 
-        def build_within_form
-          child = Collection.find(params.fetch(:child_id))
-          authorize! :read, child
-          parent = params.key?(:parent_id) ? Collection.find(params[:parent_id]) : nil
-          form_class.new(child: child, parent: parent, context: self)
-        end
+      def build_within_form
+        child = ::Collection.find(params.fetch(:child_id))
+        authorize! :read, child
+        parent = params.key?(:parent_id) ? ::Collection.find(params[:parent_id]) : nil
+        form_class.new(child: child, parent: parent, context: self)
+      end
 
-        def build_under_form
-          parent = Collection.find(params.fetch(:parent_id))
-          authorize! :deposit, parent
-          child = params.key?(:child_id) ? Collection.find(params[:child_id]) : nil
-          form_class.new(child: child, parent: parent, context: self)
-        end
+      def build_under_form
+        parent = ::Collection.find(params.fetch(:parent_id))
+        authorize! :deposit, parent
+        child = params.key?(:child_id) ? ::Collection.find(params[:child_id]) : nil
+        form_class.new(child: child, parent: parent, context: self)
+      end
 
-        def build_create_collection_form
-          parent = Collection.find(params.fetch(:parent_id))
-          authorize! :deposit, parent
-          form_class.new(child: nil, parent: parent, context: self)
-        end
+      def build_create_collection_form
+        parent = ::Collection.find(params.fetch(:parent_id))
+        authorize! :deposit, parent
+        form_class.new(child: nil, parent: parent, context: self)
+      end
 
-        def build_remove_form
-          child = Collection.find(params.fetch(:child_id))
-          parent = Collection.find(params.fetch(:parent_id))
-          authorize! :edit, parent
-          form_class.new(child: child, parent: parent, context: self)
-        end
+      def build_remove_form
+        child = ::Collection.find(params.fetch(:child_id))
+        parent = ::Collection.find(params.fetch(:parent_id))
+        authorize! :edit, parent
+        form_class.new(child: child, parent: parent, context: self)
+      end
 
-        # determine appropriate redirect location depending on specified source
-        def redirect_path(item:)
-          return my_collections_path if params[:source] == 'my'
-          dashboard_collection_path(item)
-        end
+      # determine appropriate redirect location depending on specified source
+      def redirect_path(item:)
+        return my_collections_path if params[:source] == 'my'
+        dashboard_collection_path(item)
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Dashboard
     ## Shows and edit the profile of the current_user
@@ -35,37 +36,37 @@ module Hyrax
 
       private
 
-        # Update user if they sent user params, otherwise return true.
-        # This is important because this controller is also handling removing trophies.
-        # (but we should move that to a different controller)
-        def conditionally_update
-          return true unless params[:user]
-          @user.update(user_params)
-        end
+      # Update user if they sent user params, otherwise return true.
+      # This is important because this controller is also handling removing trophies.
+      # (but we should move that to a different controller)
+      def conditionally_update
+        return true unless params[:user]
+        @user.update(user_params)
+      end
 
-        def handle_successful_update
-          # TODO: this should be moved to TrophiesController
-          process_trophy_removal
-          UserEditProfileEventJob.perform_later(@user)
-        end
+      def handle_successful_update
+        # TODO: this should be moved to TrophiesController
+        process_trophy_removal
+        UserEditProfileEventJob.perform_later(@user)
+      end
 
-        # if the user wants to remove any trophies, do that here.
-        def process_trophy_removal
-          params.keys.select { |k, _v| k.starts_with? 'remove_trophy_' }.each do |smash_trophy|
-            smash_trophy = smash_trophy.sub(/^remove_trophy_/, '')
-            current_user.trophies.where(work_id: smash_trophy).destroy_all
-          end
+      # if the user wants to remove any trophies, do that here.
+      def process_trophy_removal
+        params.keys.select { |k, _v| k.starts_with? 'remove_trophy_' }.each do |smash_trophy|
+          smash_trophy = smash_trophy.sub(/^remove_trophy_/, '')
+          current_user.trophies.where(work_id: smash_trophy).destroy_all
         end
+      end
 
-        def user_params
-          params.require(:user).permit(:avatar, :facebook_handle, :twitter_handle,
-                                       :googleplus_handle, :linkedin_handle, :remove_avatar, :orcid)
-        end
+      def user_params
+        params.require(:user).permit(:avatar, :facebook_handle, :twitter_handle,
+                                     :googleplus_handle, :linkedin_handle, :remove_avatar, :orcid)
+      end
 
-        def find_user
-          @user = ::User.from_url_component(params[:id])
-          raise ActiveRecord::RecordNotFound unless @user
-        end
+      def find_user
+        @user = ::User.from_url_component(params[:id])
+        raise ActiveRecord::RecordNotFound unless @user
+      end
     end
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Dashboard
     ## Shows a list of all works to the admins
@@ -10,14 +11,14 @@ module Hyrax
 
       private
 
-        def search_action_url(*args)
-          hyrax.dashboard_works_url(*args)
-        end
+      def search_action_url(*args)
+        hyrax.dashboard_works_url(*args)
+      end
 
-        # The url of the "more" link for additional facet values
-        def search_facet_path(args = {})
-          hyrax.dashboard_works_facet_path(args[:id])
-        end
+      # The url of the "more" link for additional facet values
+      def search_facet_path(args = {})
+        hyrax.dashboard_works_facet_path(args[:id])
+      end
     end
   end
 end

data/app/controllers/hyrax/dashboard_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class DashboardController < ApplicationController
     include Blacklight::Base
@@ -6,6 +7,15 @@ module Hyrax
     before_action :authenticate_user!
     before_action :build_breadcrumbs, only: [:show]
 
+    ##
+    # @!attribute [rw] sidebar_partials
+    #   @return [Hash]
+    #
+    # @example Add a custom partial to the tasks sidebar block
+    #   Hyrax::DashboardController.sidebar_partials[:tasks] << "hyrax/dashboard/sidebar/custom_task"
+    class_attribute :sidebar_partials
+    self.sidebar_partials = { activity: [], configuration: [], repository_content: [], tasks: [] }
+
     def show
       if can? :read, :admin_dashboard
         @presenter = Hyrax::Admin::DashboardPresenter.new

data/app/controllers/hyrax/depositors_controller.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
 module Hyrax
   class DepositorsController < ApplicationController
     include DenyAccessOverrideBehavior
 
     before_action :authenticate_user!
-    before_action :validate_users, only: :create
 
     layout :decide_layout
 
@@ -17,12 +17,15 @@ module Hyrax
     def create
       grantor = authorize_and_return_grantor
       grantee = ::User.from_url_component(params[:grantee_id])
-      if grantor.can_receive_deposits_from.include?(grantee)
+
+      if grantor == grantee
+        render_json_response(response_type: :unprocessable_entity, message: view_context.t('hyrax.dashboard.proxy_add_deny'))
+      elsif grantor.can_receive_deposits_from.include?(grantee)
         head :ok
       else
         grantor.can_receive_deposits_from << grantee
         send_proxy_depositor_added_messages(grantor, grantee)
-        render json: { name: grantee.name, delete_path: hyrax.user_depositor_path(grantor.user_key, grantee.user_key) }
+        render json: { name: grantee.name, delete_path: sanitize_route_string(hyrax.user_depositor_path(grantor.user_key, grantee.user_key)) }
       end
     end
 
@@ -32,33 +35,38 @@ module Hyrax
       head :ok
     end
 
-    def validate_users
-      head :ok if params[:user_id] == params[:grantee_id]
-    end
-
     private
 
-      def authorize_and_return_grantor
-        grantor = ::User.from_url_component(params[:user_id])
-        authorize! :edit, grantor
-        grantor
-      end
+    # The reason the period has to be converted to -dot- is because in the destroy method
+    # ::User.from_url_component is called, and from_url_componet expects -dot- in place of
+    # a period.  I believe this is done because Rails does not like periods in urls.
+    def sanitize_route_string(route)
+      route.gsub("\.", "-dot-")
+    end
 
-      def send_proxy_depositor_added_messages(grantor, grantee)
-        message_to_grantee = "#{grantor.name} has assigned you as a proxy depositor"
-        message_to_grantor = "You have assigned #{grantee.name} as a proxy depositor"
-        Hyrax::MessengerService.deliver(::User.batch_user, grantor, message_to_grantor, "Proxy Depositor Added")
-        Hyrax::MessengerService.deliver(::User.batch_user, grantee, message_to_grantee, "Proxy Depositor Added")
-      end
+    def authorize_and_return_grantor
+      grantor = ::User.from_url_component(params[:user_id])
+      authorize! :edit, grantor
+      grantor
+    end
 
-      def decide_layout
-        layout = case action_name
-                 when 'index'
-                   'dashboard'
-                 else
-                   '1_column'
-                 end
-        File.join(theme, layout)
-      end
+    def send_proxy_depositor_added_messages(grantor, grantee)
+      message_to_grantee = I18n.t('hyrax.notifications.proxy_depositor_added.grantee_message', grantor: grantor.name)
+      message_to_grantor = I18n.t('hyrax.notifications.proxy_depositor_added.grantor_message', grantee: grantee.name)
+      Hyrax::MessengerService.deliver(::User.batch_user, grantor, message_to_grantor,
+                                      I18n.t('hyrax.notifications.proxy_depositor_added.subject'))
+      Hyrax::MessengerService.deliver(::User.batch_user, grantee, message_to_grantee,
+                                      I18n.t('hyrax.notifications.proxy_depositor_added.subject'))
+    end
+
+    def decide_layout
+      layout = case action_name
+               when 'index'
+                 'dashboard'
+               else
+                 '1_column'
+               end
+      File.join(theme, layout)
+    end
   end
 end

data/app/controllers/hyrax/downloads_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class DownloadsController < ApplicationController
     include Hydra::Controller::DownloadBehavior
@@ -18,75 +19,66 @@ module Hyrax
         # For derivatives stored on the local file system
         send_local_content
       else
-        raise ActiveFedora::ObjectNotFoundError
+        raise Hyrax::ObjectNotFoundError
       end
     end
 
     private
 
-      # Override the Hydra::Controller::DownloadBehavior#content_options so that
-      # we have an attachement rather than 'inline'
-      def content_options
-        super.merge(disposition: 'attachment')
-      end
-
-      # Override this method if you want to change the options sent when downloading
-      # a derivative file
-      def derivative_download_options
-        { type: mime_type_for(file), disposition: 'inline' }
-      end
+    # Override the Hydra::Controller::DownloadBehavior#content_options so that
+    # we have an attachement rather than 'inline'
+    def content_options
+      super.merge(disposition: 'attachment')
+    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]
-      rescue CanCan::AccessDenied
-        unauthorized_image = Rails.root.join("app", "assets", "images", "unauthorized.png")
-        if File.exist? unauthorized_image
-          send_file unauthorized_image, status: :unauthorized
-        else
-          Deprecation.warn(self, "redirect_to default_image is deprecated and will be removed from Hyrax 3.0 (copy unauthorized.png image to directory assets/images instead)")
-          redirect_to default_image
-        end
-      end
+    # Override this method if you want to change the options sent when downloading
+    # a derivative file
+    def derivative_download_options
+      { type: mime_type_for(file), disposition: 'inline' }
+    end
 
-      def default_image
-        ActionController::Base.helpers.image_path 'default.png'
-      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]
+    rescue CanCan::AccessDenied
+      unauthorized_image = Rails.root.join("app", "assets", "images", "unauthorized.png")
+      send_file unauthorized_image, status: :unauthorized
+    end
 
-      # Overrides Hydra::Controller::DownloadBehavior#load_file, which is hard-coded to assume files are in BasicContainer.
-      # Override this method to change which file is shown.
-      # Loads the file specified by the HTTP parameter `:file`.
-      # If this object does not have a file by that name, return the default file
-      # as returned by {#default_file}
-      # @return [ActiveFedora::File, File, NilClass] Returns the file from the repository or a path to a file on the local file system, if it exists.
-      def load_file
-        file_reference = params[:file]
-        return default_file unless file_reference
+    # Overrides Hydra::Controller::DownloadBehavior#load_file, which is hard-coded to assume files are in BasicContainer.
+    # Override this method to change which file is shown.
+    # Loads the file specified by the HTTP parameter `:file`.
+    # If this object does not have a file by that name, return the default file
+    # as returned by {#default_file}
+    # @return [ActiveFedora::File, File, NilClass] Returns the file from the repository or a path to a file on the local file system, if it exists.
+    def load_file
+      file_reference = params[:file]
+      return default_file unless file_reference
 
-        file_path = Hyrax::DerivativePath.derivative_path_for_reference(params[asset_param_key], file_reference)
-        File.exist?(file_path) ? file_path : nil
-      end
+      file_path = Hyrax::DerivativePath.derivative_path_for_reference(params[asset_param_key], file_reference)
+      File.exist?(file_path) ? file_path : nil
+    end
 
-      def default_file
-        default_file_reference = if asset.class.respond_to?(:default_file_path)
-                                   asset.class.default_file_path
-                                 else
-                                   DownloadsController.default_content_path
-                                 end
-        association = dereference_file(default_file_reference)
-        association&.reader
-      end
+    def default_file
+      default_file_reference = if asset.class.respond_to?(:default_file_path)
+                                 asset.class.default_file_path
+                               else
+                                 DownloadsController.default_content_path
+                               end
+      association = dereference_file(default_file_reference)
+      association&.reader
+    end
 
-      def mime_type_for(file)
-        MIME::Types.type_for(File.extname(file)).first.content_type
-      end
+    def mime_type_for(file)
+      MIME::Types.type_for(File.extname(file)).first.content_type
+    end
 
-      def dereference_file(file_reference)
-        return false if file_reference.nil?
-        association = asset.association(file_reference.to_sym)
-        association if association && association.is_a?(ActiveFedora::Associations::SingularAssociation)
-      end
+    def dereference_file(file_reference)
+      return false if file_reference.nil?
+      association = asset.association(file_reference.to_sym)
+      association if association&.is_a?(ActiveFedora::Associations::SingularAssociation)
+    end
   end
 end

data/app/controllers/hyrax/embargoes_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class EmbargoesController < ApplicationController
     include Hyrax::EmbargoesControllerBehavior

data/app/controllers/hyrax/featured_work_lists_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class FeaturedWorkListsController < ApplicationController
     def create
@@ -11,8 +12,8 @@ module Hyrax
 
     private
 
-      def list_params
-        params.require(:featured_work_list).permit(featured_works_attributes: [:id, :order])
-      end
+    def list_params
+      params.require(:featured_work_list).permit(featured_works_attributes: [:id, :order])
+    end
   end
 end

data/app/controllers/hyrax/featured_works_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class FeaturedWorksController < ApplicationController
     def create

data/app/controllers/hyrax/file_sets_controller.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class FileSetsController < ApplicationController
     include Blacklight::Base
@@ -48,7 +49,7 @@ module Hyrax
     def destroy
       parent = curation_concern.parent
       actor.destroy
-      redirect_to [main_app, parent], notice: 'The file has been deleted.'
+      redirect_to [main_app, parent], notice: view_context.t('hyrax.file_sets.asset_deleted_flash.message')
     end
 
     # PATCH /concern/file_sets/:id
@@ -74,111 +75,121 @@ module Hyrax
 
     private
 
-      # this is provided so that implementing application can override this behavior and map params to different attributes
-      def update_metadata
-        file_attributes = form_class.model_attributes(attributes)
-        actor.update_metadata(file_attributes)
-      end
+    # this is provided so that implementing application can override this behavior and map params to different attributes
+    def update_metadata
+      file_attributes = form_class.model_attributes(attributes)
+      actor.update_metadata(file_attributes)
+    end
 
-      def attempt_update
-        if wants_to_revert?
-          actor.revert_content(params[:revision])
-        elsif params.key?(:file_set)
-          if params[:file_set].key?(:files)
-            actor.update_content(params[:file_set][:files].first)
-          else
-            update_metadata
-          end
+    def attempt_update
+      if wants_to_revert?
+        actor.revert_content(params[:revision])
+      elsif params.key?(:file_set)
+        if params[:file_set].key?(:files)
+          actor.update_content(uploaded_file_from_path)
+        else
+          update_metadata
         end
+      elsif params.key?(:files_files) # version file already uploaded with ref id in :files_files array
+        uploaded_files = Array(Hyrax::UploadedFile.find(params[:files_files]))
+        actor.update_content(uploaded_files.first)
+        update_metadata
       end
+    end
+
+    def uploaded_file_from_path
+      uploaded_file = CarrierWave::SanitizedFile.new(params[:file_set][:files].first)
+      Hyrax::UploadedFile.create(user_id: current_user.id, file: uploaded_file)
+    end
 
-      def after_update_response
-        respond_to do |wants|
-          wants.html do
-            redirect_to [main_app, curation_concern], notice: "The file #{view_context.link_to(curation_concern, [main_app, curation_concern])} has been updated."
-          end
-          wants.json do
-            @presenter = show_presenter.new(curation_concern, current_ability)
-            render :show, status: :ok, location: polymorphic_path([main_app, curation_concern])
-          end
+    def after_update_response
+      respond_to do |wants|
+        wants.html do
+          link_to_file = view_context.link_to(curation_concern, [main_app, curation_concern])
+          redirect_to [main_app, curation_concern], notice: view_context.t('hyrax.file_sets.asset_updated_flash.message', link_to_file: link_to_file)
+        end
+        wants.json do
+          @presenter = show_presenter.new(curation_concern, current_ability)
+          render :show, status: :ok, location: polymorphic_path([main_app, curation_concern])
         end
       end
+    end
 
-      def after_update_failure_response
-        respond_to do |wants|
-          wants.html do
-            initialize_edit_form
-            flash[:error] = "There was a problem processing your request."
-            render 'edit', status: :unprocessable_entity
-          end
-          wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: curation_concern.errors }) }
+    def after_update_failure_response
+      respond_to do |wants|
+        wants.html do
+          initialize_edit_form
+          flash[:error] = "There was a problem processing your request."
+          render 'edit', status: :unprocessable_entity
         end
+        wants.json { render_json_response(response_type: :unprocessable_entity, options: { errors: curation_concern.errors }) }
       end
+    end
 
-      def add_breadcrumb_for_controller
-        add_breadcrumb I18n.t('hyrax.dashboard.my.works'), hyrax.my_works_path
-      end
+    def add_breadcrumb_for_controller
+      add_breadcrumb I18n.t('hyrax.dashboard.my.works'), hyrax.my_works_path
+    end
 
-      def add_breadcrumb_for_action
-        case action_name
-        when 'edit'.freeze
-          add_breadcrumb I18n.t("hyrax.file_set.browse_view"), main_app.hyrax_file_set_path(params["id"])
-        when 'show'.freeze
-          add_breadcrumb presenter.parent.to_s, main_app.polymorphic_path(presenter.parent)
-          add_breadcrumb presenter.to_s, main_app.polymorphic_path(presenter)
-        end
+    def add_breadcrumb_for_action
+      case action_name
+      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.to_s, main_app.polymorphic_path(presenter)
       end
+    end
 
-      # Override of Blacklight::RequestBuilders
-      def search_builder_class
-        Hyrax::FileSetSearchBuilder
-      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
-        @version_list = Hyrax::VersionListPresenter.new(original ? original.versions.all : [])
-        @groups = current_user.groups
-      end
+    def initialize_edit_form
+      @parent = @file_set.in_objects.first
+      original = @file_set.original_file
+      @version_list = Hyrax::VersionListPresenter.new(original ? original.versions.all : [])
+      @groups = current_user.groups
+    end
 
-      def actor
-        @actor ||= Hyrax::Actors::FileSetActor.new(@file_set, current_user)
-      end
+    def actor
+      @actor ||= Hyrax::Actors::FileSetActor.new(@file_set, current_user)
+    end
 
-      def attributes
-        params.fetch(:file_set, {}).except(:files).permit!.dup # use a copy of the hash so that original params stays untouched when interpret_visibility modifies things
-      end
+    def attributes
+      params.fetch(:file_set, {}).except(:files).permit!.dup # use a copy of the hash so that original params stays untouched when interpret_visibility modifies things
+    end
 
-      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)
-        end
+    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)
       end
+    end
 
-      def wants_to_revert?
-        params.key?(:revision) && params[:revision] != curation_concern.latest_content_version.label
-      end
+    def wants_to_revert?
+      params.key?(:revision) && params[:revision] != curation_concern.latest_content_version.label
+    end
 
-      # Override this method to add additional response formats to your local app
-      def additional_response_formats(_); end
+    # Override this method to add additional response formats to your local app
+    def additional_response_formats(_); end
 
-      # This allows us to use the unauthorized and form_permission template in hyrax/base,
-      # while prefering our local paths. Thus we are unable to just override `self.local_prefixes`
-      def _prefixes
-        @_prefixes ||= super + ['hyrax/base']
-      end
+    # This allows us to use the unauthorized and form_permission template in hyrax/base,
+    # while prefering our local paths. Thus we are unable to just override `self.local_prefixes`
+    def _prefixes
+      @_prefixes ||= super + ['hyrax/base']
+    end
 
-      def decide_layout
-        layout = case action_name
-                 when 'show'
-                   '1_column'
-                 else
-                   'dashboard'
-                 end
-        File.join(theme, layout)
-      end
+    def decide_layout
+      layout = case action_name
+               when 'show'
+                 '1_column'
+               else
+                 'dashboard'
+               end
+      File.join(theme, layout)
+    end
   end
 end