sufia 6.2.0 → 6.3.0

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

@@ -5,7 +5,7 @@ module Sufia::Controller
     # Adds Hydra behaviors into the application controller
     include Hydra::Controller::ControllerBehavior
 
-    before_filter :notifications_number
+    before_action :notifications_number
   end
 
   def current_ability
@@ -28,24 +28,24 @@ module Sufia::Controller
   end
 
   def notifications_number
+    # These instance variables must appear above the return statements
     @notify_number = 0
     @batches = []
     return if action_name == "index" && controller_name == "mailbox"
-    if user_signed_in?
-      @notify_number = current_user.mailbox.inbox(unread: true).count
-      @batches = current_user.mailbox.inbox.map { |msg| msg.last_message.body[/<span id="(.*)"><a (href=|data-content=|rel=)(.*)/,1] }.select{ |val| !val.blank? }
-    end
+    return unless user_signed_in?
+    @notify_number = current_user.mailbox.inbox(unread: true).count
+    @batches = current_user.mailbox.inbox.map { |msg| msg.last_message.body[/<span id="(.*)"><a (href=|data-content=|rel=)(.*)/, 1] }.select { |val| !val.blank? }
   end
 
   # Override Devise method to redirect to dashboard after signing in
-  def after_sign_in_path_for(resource)
+  def after_sign_in_path_for(_resource)
     sufia.dashboard_index_path
   end
 
   protected
 
-  ### Hook which is overridden in Sufia::Ldap::Controller
-  def has_access?
-    true
-  end
+    ### Hook which is overridden in Sufia::Ldap::Controller
+    def has_access?
+      true
+    end
 end

data/app/controllers/concerns/sufia/dashboard_controller_behavior.rb

@@ -5,7 +5,7 @@ module Sufia
     included do
       include ActionView::Helpers::DateHelper
 
-      before_filter :authenticate_user!
+      before_action :authenticate_user!
 
       layout "sufia-dashboard"
     end
@@ -14,7 +14,7 @@ module Sufia
     def index
       gather_dashboard_information
       respond_to do |format|
-        format.html { }
+        format.html {}
         format.rss  { render layout: false }
         format.atom { render layout: false }
       end
@@ -27,23 +27,22 @@ module Sufia
 
     protected
 
-    # Gathers all the information that we'll display in the user's dashboard.
-    # Override this method if you want to exclude or gather additional data elements
-    # in your dashboard view.  You'll need to alter dashboard/index.html.erb accordingly.
-    def gather_dashboard_information
-      @user = current_user
-      @activity = current_user.get_all_user_activity(params[:since].blank? ? DateTime.now.to_i - Sufia.config.activity_to_show_default_seconds_since_now : params[:since].to_i)
-      @notifications = current_user.mailbox.inbox
-      @incoming = ProxyDepositRequest.where(receiving_user_id: current_user.id).reject &:deleted_file?
-      @outgoing = ProxyDepositRequest.where(sending_user_id: current_user.id)
-    end
-
-    # Formats the user's activities into human-readable strings used for rendering JSON
-    def human_readable_user_activity
-      current_user.get_all_user_activity.map do |event|
-        [event[:action], "#{time_ago_in_words(Time.at(event[:timestamp].to_i))} ago", event[:timestamp].to_i]
+      # Gathers all the information that we'll display in the user's dashboard.
+      # Override this method if you want to exclude or gather additional data elements
+      # in your dashboard view.  You'll need to alter dashboard/index.html.erb accordingly.
+      def gather_dashboard_information
+        @user = current_user
+        @activity = current_user.all_user_activity(params[:since].blank? ? DateTime.now.to_i - Sufia.config.activity_to_show_default_seconds_since_now : params[:since].to_i)
+        @notifications = current_user.mailbox.inbox
+        @incoming = ProxyDepositRequest.where(receiving_user_id: current_user.id).reject(&:deleted_file?)
+        @outgoing = ProxyDepositRequest.where(sending_user_id: current_user.id)
       end
-    end
 
+      # Formats the user's activities into human-readable strings used for rendering JSON
+      def human_readable_user_activity
+        current_user.all_user_activity.map do |event|
+          [event[:action], "#{time_ago_in_words(Time.at(event[:timestamp].to_i))} ago", event[:timestamp].to_i]
+        end
+      end
   end
 end

data/app/controllers/concerns/sufia/depositors_controller_behavior.rb

@@ -3,14 +3,13 @@ module Sufia
     extend ActiveSupport::Concern
 
     included do
-      before_filter :authenticate_user!
-      before_filter :validate_users, only: :create
+      before_action :authenticate_user!
+      before_action :validate_users, only: :create
     end
 
-
     # Overriding the default behavior from Hydra::Core::ContorllerBehavior
     def deny_access(exception)
-      if current_user and current_user.persisted?
+      if current_user && current_user.persisted?
         redirect_to root_path, alert: exception.message
       else
         session['user_return_to'.freeze] = request.url
@@ -36,17 +35,15 @@ module Sufia
     end
 
     def validate_users
-      if params[:user_id] == params[:grantee_id]
-        head :ok
-      end
+      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
-      return grantor
-    end
+      def authorize_and_return_grantor
+        grantor = ::User.from_url_component(params[:user_id])
+        authorize! :edit, grantor
+        grantor
+      end
   end
 end

data/app/controllers/concerns/sufia/files_controller/browse_everything.rb

@@ -2,7 +2,7 @@ module Sufia::FilesController
   module BrowseEverything
     include ActiveSupport::Concern
 
-    def create 
+    def create
       if params[:selected_files].present?
         create_from_browse_everything(params)
       else
@@ -13,16 +13,16 @@ module Sufia::FilesController
     protected
 
       def create_from_browse_everything(params)
-        Batch.find_or_create(params[:batch_id])        
-        params[:selected_files].each_pair do |index, file_info| 
+        Batch.find_or_create(params[:batch_id])
+        params[:selected_files].each_pair do |_index, file_info|
           next if file_info.blank? || file_info["url"].blank?
           create_file_from_url(file_info["url"], file_info["file_name"])
         end
-        redirect_to self.class.upload_complete_path( params[:batch_id])
+        redirect_to self.class.upload_complete_path(params[:batch_id])
       end
-      
+
       # Generic utility for creating GenericFile from a URL
-      # Used in to import files using URLs from a file picker like browse_everything 
+      # Used in to import files using URLs from a file picker like browse_everything
       def create_file_from_url(url, file_name)
         ::GenericFile.new(import_url: url, label: file_name) do |gf|
           actor = Sufia::GenericFile::Actor.new(gf, current_user)
@@ -31,6 +31,5 @@ module Sufia::FilesController
           Sufia.queue.push(ImportUrlJob.new(gf.id))
         end
       end
-
   end
 end

data/app/controllers/concerns/sufia/files_controller/local_ingest_behavior.rb

@@ -10,57 +10,56 @@ module Sufia
       end
     end
 
-
     private
 
-    def perform_local_ingest
-      if Sufia.config.enable_local_ingest && current_user.respond_to?(:directory)
-        if ingest_local_file
-          redirect_to GenericFilesController.upload_complete_path( params[:batch_id])
+      def perform_local_ingest
+        if Sufia.config.enable_local_ingest && current_user.respond_to?(:directory)
+          if ingest_local_file
+            redirect_to GenericFilesController.upload_complete_path(params[:batch_id])
+          else
+            flash[:alert] = "Error importing files from user directory."
+            render :new
+          end
         else
-          flash[:alert] = "Error importing files from user directory."
+          flash[:alert] = "Your account is not configured for importing files from a user-directory on the server."
           render :new
         end
-      else
-        flash[:alert] = "Your account is not configured for importing files from a user-directory on the server."
-        render :new
       end
-    end
 
-    def ingest_local_file
-      # Ingest files already on disk
-      has_directories = false
-      files = []
-      params[:local_file].each do |filename|
-        if File.directory?(File.join(current_user.directory, filename))
-          has_directories = true
-          Dir[File.join(current_user.directory, filename, '**', '*')].each do |single|
-            next if File.directory? single
-            logger.info("Ingesting file: #{single}")
-            files << single.sub(current_user.directory + '/', '')
-            logger.info("after removing the user directory #{current_user.directory} we have: #{files.last}")
+      def ingest_local_file
+        # Ingest files already on disk
+        has_directories = false
+        files = []
+        params[:local_file].each do |filename|
+          if File.directory?(File.join(current_user.directory, filename))
+            has_directories = true
+            Dir[File.join(current_user.directory, filename, '**', '*')].each do |single|
+              next if File.directory? single
+              logger.info("Ingesting file: #{single}")
+              files << single.sub(current_user.directory + '/', '')
+              logger.info("after removing the user directory #{current_user.directory} we have: #{files.last}")
+            end
+          else
+            files << filename
           end
-        else
-          files << filename
         end
+        Batch.find_or_create(params[:batch_id]) unless files.empty?
+        files.each do |filename|
+          ingest_one(filename, has_directories)
+        end
+        true
       end
-      Batch.find_or_create(params[:batch_id]) unless files.empty?
-      files.each do |filename|
-        ingest_one(filename, has_directories)
-      end
-      true
-    end
 
-    def ingest_one(filename, unarranged)
-      basename = File.basename(filename)
-      # do not remove ::
-      ::GenericFile.new(label: basename) do |gf|
-        gf.relative_path = filename if filename != basename
-        actor = Sufia::GenericFile::Actor.new(gf, current_user)
-        actor.create_metadata(params[:batch_id])
-        gf.save!
-        Sufia.queue.push(IngestLocalFileJob.new(gf.id, current_user.directory, filename, current_user.user_key))
+      def ingest_one(filename, _unarranged)
+        basename = File.basename(filename)
+        # do not remove ::
+        ::GenericFile.new(label: basename) do |gf|
+          gf.relative_path = filename if filename != basename
+          actor = Sufia::GenericFile::Actor.new(gf, current_user)
+          actor.create_metadata(params[:batch_id])
+          gf.save!
+          Sufia.queue.push(IngestLocalFileJob.new(gf.id, current_user.directory, filename, current_user.user_key))
+        end
       end
-    end
   end # /FilesController::LocalIngestBehavior
 end # /Sufia

data/app/controllers/concerns/sufia/files_controller/upload_complete_behavior.rb

@@ -4,7 +4,7 @@ module Sufia
       Sufia::Engine.routes.url_helpers.batch_edit_path(batch_id)
     end
 
-    def destroy_complete_path(params)
+    def destroy_complete_path(_params)
       Sufia::Engine.routes.url_helpers.dashboard_files_path
     end
   end # /FilesController::UploadCompleteBehavior

data/app/controllers/concerns/sufia/files_controller_behavior.rb

@@ -19,13 +19,13 @@ module Sufia
 
       layout "sufia-one-column"
 
-      self.copy_blacklight_config_from(CatalogController)
+      copy_blacklight_config_from(CatalogController)
 
       # Catch permission errors
       rescue_from Hydra::AccessDenied, CanCan::AccessDenied do |exception|
         if exception.action == :edit
-          redirect_to(sufia.url_for({action: 'show'}), alert: "You do not have sufficient privileges to edit this document")
-        elsif current_user and current_user.persisted?
+          redirect_to(sufia.url_for(action: 'show'), alert: "You do not have sufficient privileges to edit this document")
+        elsif current_user && current_user.persisted?
           redirect_to root_url, alert: exception.message
         else
           session["user_return_to"] = request.url
@@ -35,15 +35,15 @@ module Sufia
 
       # actions: audit, index, create, new, edit, show, update,
       #          destroy, permissions, citation, stats
-      before_filter :authenticate_user!, except: [:show, :citation, :stats]
-      before_filter :has_access?, except: [:show]
-      before_filter :build_breadcrumbs, only: [:show, :edit, :stats]
+      before_action :authenticate_user!, except: [:show, :citation, :stats]
+      before_action :has_access?, except: [:show]
+      before_action :build_breadcrumbs, only: [:show, :edit, :stats]
       load_resource only: [:audit]
       load_and_authorize_resource except: [:index, :audit, :show]
 
       # since we are only displaying data we are makingthe show action fast by loading the information from solr
       # these two steps replace load_and_authorize_resource for the show action
-      before_filter :load_resource_from_solr, only: [:show]
+      before_action :load_resource_from_solr, only: [:show]
       authorize_resource only: [:show]
 
       class_attribute :edit_form_class, :presenter_class
@@ -86,20 +86,20 @@ module Sufia
 
     def create_from_upload(params)
       # check error condition No files
-      return json_error("Error! No file to save") if !params.has_key?(:files)
+      return json_error("Error! No file to save") unless params.key?(:files)
 
-      file = params[:files].detect {|f| f.respond_to?(:original_filename) }
+      file = params[:files].detect { |f| f.respond_to?(:original_filename) }
       if !file
         json_error "Error! No file for upload", 'unknown file', status: :unprocessable_entity
-      elsif (empty_file?(file))
+      elsif empty_file?(file)
         json_error "Error! Zero Length File!", file.original_filename
-      elsif (!terms_accepted?)
+      elsif !terms_accepted?
         json_error "You must accept the terms of service!", file.original_filename
       else
         process_file(file)
       end
     rescue => error
-      logger.error "GenericFilesController::create rescued #{error.class}\n\t#{error.to_s}\n #{error.backtrace.join("\n")}\n\n"
+      logger.error "GenericFilesController::create rescued #{error.class}\n\t#{error}\n #{error.backtrace.join("\n")}\n\n"
       json_error "Error occurred while creating generic file."
     ensure
       # remove the tempfile (only if it is a temp file)
@@ -113,11 +113,11 @@ module Sufia
     # routed to /files/:id
     def show
       respond_to do |format|
-        format.html {
+        format.html do
           @events = @generic_file.events(100)
           @presenter = presenter
           @audit_status = audit_service.human_readable_audit_status
-        }
+        end
         format.endnote { render text: @generic_file.export_as_endnote }
       end
     end
@@ -134,9 +134,9 @@ module Sufia
           update_version
         elsif wants_to_upload_new_version?
           update_file
-        elsif params.has_key? :generic_file
+        elsif params.key? :generic_file
           update_metadata
-        elsif params.has_key? :visibility
+        elsif params.key? :visibility
           update_visibility
         end
 
@@ -152,122 +152,121 @@ module Sufia
 
     protected
 
-    def set_variables_for_edit_form
-      @form = edit_form
-      @groups = current_user.groups
-      @version_list = version_list
-    end
-
-    def presenter
-      presenter_class.new(@generic_file)
-    end
-
-    def version_list
-      Sufia::VersionListPresenter.new(@generic_file.content.versions.all)
-    end
+      def set_variables_for_edit_form
+        @form = edit_form
+        @groups = current_user.groups
+        @version_list = version_list
+      end
 
-    def edit_form
-      edit_form_class.new(@generic_file)
-    end
+      def presenter
+        presenter_class.new(@generic_file)
+      end
 
-    def audit_service
-      Sufia::GenericFileAuditService.new(@generic_file)
-    end
+      def version_list
+        Sufia::VersionListPresenter.new(@generic_file.content.versions.all)
+      end
 
-    def wants_to_revert?
-      params.has_key?(:revision) && params[:revision] != @generic_file.content.latest_version.label
-    end
+      def edit_form
+        edit_form_class.new(@generic_file)
+      end
 
-    def wants_to_upload_new_version?
-      has_file_data = params.has_key?(:filedata)
-      on_version_tab = params[:redirect_tab] == 'versions'
+      def audit_service
+        Sufia::GenericFileAuditService.new(@generic_file)
+      end
 
-      has_file_data || (on_version_tab && !wants_to_revert?)
-    end
+      def wants_to_revert?
+        params.key?(:revision) && params[:revision] != @generic_file.content.latest_version.label
+      end
 
-    def actor
-      @actor ||= Sufia::GenericFile::Actor.new(@generic_file, current_user)
-    end
+      def wants_to_upload_new_version?
+        has_file_data = params.key?(:filedata)
+        on_version_tab = params[:redirect_tab] == 'versions'
 
-    def update_version
-      actor.revert_content(params[:revision])
-    end
+        has_file_data || (on_version_tab && !wants_to_revert?)
+      end
 
-    def update_file
-      if params[:filedata]
-        actor.update_content(params[:filedata], file_path)
-      else
-        flash[:error] = 'Please select a file.'
-        false
+      def actor
+        @actor ||= Sufia::GenericFile::Actor.new(@generic_file, current_user)
       end
-    end
 
-    # this is provided so that implementing application can override this behavior and map params to different attributes
-    def update_metadata
-      file_attributes = edit_form_class.model_attributes(params[:generic_file])
-      actor.update_metadata(file_attributes, params[:visibility])
-    end
+      def update_version
+        actor.revert_content(params[:revision])
+      end
 
-    def update_visibility
-      actor.update_metadata({}, params[:visibility])
-    end
+      def update_file
+        if params[:filedata]
+          actor.update_content(params[:filedata], file_path)
+        else
+          flash[:error] = 'Please select a file.'
+          false
+        end
+      end
 
-    def json_error(error, name=nil, additional_arguments={})
-      args = {error: error}
-      args[:name] = name if name
-      render additional_arguments.merge(json: [args])
-    end
+      # this is provided so that implementing application can override this behavior and map params to different attributes
+      def update_metadata
+        file_attributes = edit_form_class.model_attributes(params[:generic_file])
+        actor.update_metadata(file_attributes, params[:visibility])
+      end
 
-    def empty_file?(file)
-      (file.respond_to?(:tempfile) && file.tempfile.size == 0) || (file.respond_to?(:size) && file.size == 0)
-    end
+      def update_visibility
+        actor.update_metadata({}, params[:visibility])
+      end
 
-    def process_file(file)
+      def json_error(error, name = nil, additional_arguments = {})
+        args = { error: error }
+        args[:name] = name if name
+        render additional_arguments.merge(json: [args])
+      end
 
-      Batch.find_or_create(params[:batch_id])
+      def empty_file?(file)
+        (file.respond_to?(:tempfile) && file.tempfile.size == 0) || (file.respond_to?(:size) && file.size == 0)
+      end
 
-      update_metadata_from_upload_screen
-      actor.create_metadata(params[:batch_id])
-      if actor.create_content(file, file.original_filename, file_path, file.content_type)
-        respond_to do |format|
-          format.html {
-            render 'jq_upload', formats: 'json', content_type: 'text/html'
-          }
-          format.json {
-            render 'jq_upload'
-          }
+      def process_file(file)
+        Batch.find_or_create(params[:batch_id])
+
+        update_metadata_from_upload_screen
+        actor.create_metadata(params[:batch_id])
+        if actor.create_content(file, file.original_filename, file_path, file.content_type)
+          respond_to do |format|
+            format.html do
+              render 'jq_upload', formats: 'json', content_type: 'text/html'
+            end
+            format.json do
+              render 'jq_upload'
+            end
+          end
+        else
+          msg = @generic_file.errors.full_messages.join(', ')
+          flash[:error] = msg
+          json_error "Error creating generic file: #{msg}"
         end
-      else
-        msg = @generic_file.errors.full_messages.join(', ')
-        flash[:error] = msg
-        json_error "Error creating generic file: #{msg}"
       end
-    end
 
-    # override this method if you want to change how the terms are accepted on upload.
-    def terms_accepted?
-      params[:terms_of_service] == '1'
-    end
+      # override this method if you want to change how the terms are accepted on upload.
+      def terms_accepted?
+        params[:terms_of_service] == '1'
+      end
 
-    # override this method if you need to initialize more complex RDF assertions (b-nodes)
-    # @deprecated use @generic_file.initialize_fields instead
-    def initialize_fields(file)
-      file.initialize_fields
-    end
+      # override this method if you need to initialize more complex RDF assertions (b-nodes)
+      # @deprecated use @generic_file.initialize_fields instead
+      def initialize_fields(file)
+        file.initialize_fields
+      end
 
-    ActiveSupport::Deprecation.deprecate_methods(FilesControllerBehavior, :initialize_fields)
+      ActiveSupport::Deprecation.deprecate_methods(FilesControllerBehavior, :initialize_fields)
 
-    # The path of the fedora node where we store the file data
-    def file_path
-      'content'
-    end
+      # The path of the fedora node where we store the file data
+      def file_path
+        'content'
+      end
 
-    # this is provided so that implementing application can override this behavior and map params to different attributes
-    # called when creating or updating metadata
-    def update_metadata_from_upload_screen
-      # Relative path is set by the jquery uploader when uploading a directory
-      @generic_file.relative_path = params[:relative_path] if params[:relative_path]
-      @generic_file.on_behalf_of = params[:on_behalf_of] if params[:on_behalf_of]
-    end
+      # this is provided so that implementing application can override this behavior and map params to different attributes
+      # called when creating or updating metadata
+      def update_metadata_from_upload_screen
+        # Relative path is set by the jquery uploader when uploading a directory
+        @generic_file.relative_path = params[:relative_path] if params[:relative_path]
+        @generic_file.on_behalf_of = params[:on_behalf_of] if params[:on_behalf_of]
+      end
   end
 end