hyrax 1.1.1 → 2.0.0.beta1

data/app/services/hyrax/fixity_check_failure_service.rb

@@ -0,0 +1,25 @@
+module Hyrax
+  class FixityCheckFailureService < MessageUserService
+    attr_reader :log_date, :checksum_audit_log, :file_set
+
+    def initialize(file_set, checksum_audit_log:)
+      @file_set = file_set
+      @checksum_audit_log = checksum_audit_log
+      @log_date = checksum_audit_log.created_at
+
+      user = ::User.find_by_user_key(file_set.depositor)
+
+      super(file_set, user)
+    end
+
+    def message
+      uri = file_set.original_file.uri.to_s
+      file_title = file_set.title.first
+      "The fixity check run at #{log_date} for #{file_title} (#{uri}) failed."
+    end
+
+    def subject
+      'Failing Fixity Check'
+    end
+  end
+end

data/app/services/hyrax/form_metadata_service.rb

@@ -5,9 +5,15 @@ module Hyrax
     # @param [Symbol] field the field we want to know about
     # @return [Boolean] true if the passed in field is a multivalued field
     def self.multiple?(model_class, field)
-      return true if ['ordered_member_ids', 'in_works_ids', 'member_of_collection_ids'].include? field.to_s
-      # Inquire at the model level
-      super
+      case field.to_s
+      when 'rights_statement'
+        false
+      when 'ordered_member_ids', 'in_works_ids', 'member_of_collection_ids'
+        true
+      else
+        # Inquire at the model level
+        super
+      end
     end
   end
 end

data/app/services/hyrax/lock_manager.rb

@@ -10,7 +10,7 @@ module Hyrax
     # @param [Fixnum] retry_delay Maximum wait time in milliseconds before retrying. Wait time is a random value between 0 and retry_delay.
     def initialize(time_to_live, retry_count, retry_delay)
       @ttl = time_to_live
-      @client = Redlock::Client.new([uri], retry_count: retry_count, retry_delay: retry_delay)
+      @client = Redlock::Client.new([Redis.current], retry_count: retry_count, retry_delay: retry_delay)
     end
 
     # Blocks until lock is acquired or timeout.
@@ -22,18 +22,5 @@ module Hyrax
       end
       returned_from_block
     end
-
-    private
-
-      def uri
-        @uri ||= begin
-          opts = options
-          URI("#{opts[:scheme]}://#{opts[:host]}:#{opts[:port]}").to_s
-        end
-      end
-
-      def options
-        ::Redis.current.client.options
-      end
   end
 end

data/app/services/hyrax/microdata.rb

@@ -1,33 +1,66 @@
 module Hyrax
+  # Responsible for extracting information related to Schema.org microdata.
+  #
+  # You may load more than one source file. Source files that are later in the load process will overlay files that are earlier.
+  #
+  # @see Hyrax::Microdata.load_paths
+  # @see Hyrax::Microdata.fetch
+  #
+  # @note This was extracted from internationalization because Schema.org keys are not internationalized
   class Microdata
     include Singleton
     FILENAME = Hyrax::Engine.root + 'config/schema_org.yml'
     TOP_KEY = 'schema_org'.freeze
 
-    def self.fetch(key, options = {})
-      instance.fetch(key, options)
+    # @api private (See note regarding specific methods)
+    #
+    # @todo Should we make specific methods for fetching :property, :type, :value. This would mean privatizing the fetch method
+    #
+    # @param [String] key
+    # @param [String] default - if we don't have a key match, use the given default value
+    def self.fetch(key, default: nil)
+      instance.fetch(key, default: default)
     end
 
-    def fetch(key, options)
-      data.fetch(key) { options[:default] }
+    # @api private
+    def fetch(key, default:)
+      data.fetch(key) { default }
     end
 
+    # @api public
+    #
     # Allow clients to register paths providing config data sources.
     # Register a config files like this:
     #   Microdata.load_path << 'path/to/locale/en.yml'
-    def self.load_path
-      @load_path ||= [FILENAME]
+    #
+    # @note The load paths will be processed and loaded into in the natural array order. As each file is loaded, it overlays the already registered keys.
+    # @return [Array<String>]
+    def self.load_paths
+      @load_paths ||= [FILENAME]
     end
 
-    # Sets the load path instance.
-    class << self
-      attr_writer :load_path
+    # @api public
+    #
+    # Sets the load_paths
+    #
+    # @param [String, Array<String>]
+    def self.load_paths=(input)
+      @load_paths = Array.wrap(input)
+      reload! # If we are obliterating load paths, we really should clear data
     end
 
+    # @api private
+    def self.clear_load_paths!
+      @load_paths = nil
+      reload!
+    end
+
+    # @api public
     def self.reload!
       instance.reload!
     end
 
+    # @api private
     def reload!
       @data = nil
     end
@@ -35,14 +68,12 @@ module Hyrax
     private
 
       def data
-        @data ||= begin
-          flatten(yaml)
-        end
+        @data ||= flatten(yaml)
       end
 
       def yaml
         yaml = {}
-        self.class.load_path.each do |path|
+        self.class.load_paths.each do |path|
           from_file = YAML.safe_load(File.open(path))[TOP_KEY]
           yaml.deep_merge!(from_file) if from_file
         end

data/app/services/hyrax/noid.rb

@@ -10,11 +10,6 @@ module Hyrax
       service.mint if Hyrax.config.enable_noids?
     end
 
-    # @todo Do we need this here? I'm a bit surprised to see it here [JNF]
-    def to_param
-      id
-    end
-
     private
 
       def service

data/app/services/hyrax/qa_select_service.rb

@@ -27,7 +27,7 @@ module Hyrax
     end
 
     def active_elements
-      authority.all.select { |e| active?(e.fetch('id')) }
+      authority.all.select { |e| e.fetch('active') }
     end
   end
 end

data/app/services/hyrax/quick_classification_query.rb

@@ -4,11 +4,11 @@ module Hyrax
 
     # @param [User] user the current user
     # @param [Hash] options
-    # @option options [#call] :concern_name_normalizer (ClassifyConcern.to_class) a proc that translates names to classes
+    # @option options [#call] :concern_name_normalizer (String#constantize) a proc that translates names to classes
     # @option options [Array<String>] :models the options to display, defaults to everything.
     def initialize(user, options = {})
       @user = user
-      @concern_name_normalizer = options.fetch(:concern_name_normalizer, ClassifyConcern.method(:to_class))
+      @concern_name_normalizer = options.fetch(:concern_name_normalizer, ->(str) { str.constantize })
       @models = options.fetch(:models, Hyrax.config.registered_curation_concern_types)
     end
 

data/app/services/hyrax/repository_fixity_check_service.rb

@@ -0,0 +1,12 @@
+module Hyrax
+  class RepositoryFixityCheckService
+    # This is a service that folks can use in their own rake tasks,
+    # etc. It is not otherwise called or relied upon in Hyrax.
+    # @see https://github.com/samvera/hyrax/wiki/Hyrax-Management-Guide#fixity-checking
+    def self.fixity_check_everything
+      ::FileSet.find_each do |file_set|
+        Hyrax::FileSetFixityCheckService.new(file_set).fixity_check
+      end
+    end
+  end
+end

data/app/services/hyrax/resource_types_service.rb

@@ -13,7 +13,10 @@ module Hyrax
       authority.find(id).fetch('term')
     end
 
-    # @param [String] id identifier of the resource type
+    ##
+    # @param [String, nil] id identifier of the resource type
+    #
+    # @return [String] a schema.org type. Gives the default type if `id` is nil.
     def self.microdata_type(id)
       return Hyrax.config.microdata_default_type if id.nil?
       Microdata.fetch("resource_type.#{id}", default: Hyrax.config.microdata_default_type)

data/app/services/hyrax/statistics/depositors/summary.rb

@@ -5,6 +5,14 @@ module Hyrax
       class Summary
         include Blacklight::SearchHelper
 
+        # @api public
+        # @param [Time] start_date optionally specify the start date to gather the stats from
+        # @param [Time] end_date optionally specify the end date to gather the stats from
+        # @return [Array<Hash>] With keys of: :key, :deposits, and :user
+        def self.depositors(start_date:, end_date:)
+          new(start_date, end_date).depositors
+        end
+
         # @param [Time] start_date optionally specify the start date to gather the stats from
         # @param [Time] end_date optionally specify the end date to gather the stats from
         def initialize(start_date, end_date)
@@ -47,7 +55,7 @@ module Hyrax
           end
 
           def date_query
-            Hyrax::QueryService.new.build_date_query(start_dt, end_dt) unless start_dt.blank?
+            Hyrax::QueryService.new.build_date_query(start_dt, end_dt) if start_dt.present?
           end
       end
     end

data/app/services/hyrax/statistics/system_stats.rb

@@ -12,6 +12,15 @@ module Hyrax
     class SystemStats
       attr_reader :limit, :start_date, :end_date
 
+      # @api public
+      # @param [Fixnum] limit_records limits the results returned from top_depositors and top_formats. Maximum is 20, minimum is 5
+      # @param [Time] start_date Filters the statistics returned by the class to after this date. nil means no filter
+      # @param [Time] end_date Filters the statistics returned by the class to before this date. nil means today
+      # @return [Array<User>]
+      def self.recent_users(limit: 5, start_date: nil, end_date: nil)
+        new(limit, start_date, end_date).recent_users
+      end
+
       # @param [Fixnum] limit_records limits the results returned from top_depositors and top_formats. Maximum is 20, minimum is 5
       # @param [Time] start_date Filters the statistics returned by the class to after this date. nil means no filter
       # @param [Time] end_date Filters the statistics returned by the class to before this date. nil means today

data/app/services/hyrax/statistics/term_query.rb

@@ -5,6 +5,13 @@ module Hyrax
     #
     # WARNING: you must use a term that isn't parsed (i.e. use _sim instead of _tesim)
     class TermQuery
+      # @api public
+      # @param [Integer] limit - Limit the number of responses
+      # @return [Array<Hyrax::Statistics::TermQuery::Result>]
+      def self.query(limit: 5)
+        new(limit).query
+      end
+
       def initialize(limit = 5)
         @limit = limit
       end

data/app/services/hyrax/statistics/works/count.rb

@@ -4,6 +4,17 @@ module Hyrax
       class Count
         attr_reader :start_date, :end_date
 
+        # @api public
+        # Retrieves the count of works in the system filtered by the start_date and end_date if present
+        #
+        # @param [Time] start_date Filters the statistics returned by the class to after this date. nil means no filter
+        # @param [Time] end_date Filters the statistics returned by the class to before this date. nil means today
+        # @return [Hash] A hash with the total files by permission for the system
+        # @see #by_permission
+        def self.by_permission(start_date: nil, end_date: nil)
+          new(start_date, end_date).by_permission
+        end
+
         # @param [Time] start_date Filters the statistics returned by the class to after this date. nil means no filter
         # @param [Time] end_date Filters the statistics returned by the class to before this date. nil means today
         def initialize(start_date = nil, end_date = nil)

data/app/services/hyrax/thumbnail_path_service.rb

@@ -18,7 +18,7 @@ module Hyrax
         end
       end
 
-      protected
+      private
 
         def fetch_thumbnail(object)
           return object if object.thumbnail_id == object.id

data/app/services/hyrax/user_stat_importer.rb

@@ -12,7 +12,7 @@ module Hyrax
       end
       @logging = options[:logging]
       @delay_secs = options[:delay_secs].to_f
-      @number_of_retries = options[:number_of_retries].to_i
+      @number_of_tries = options[:number_of_retries].to_i + 1
     end
 
     delegate :depositor_field, to: DepositSearchBuilder
@@ -49,11 +49,11 @@ module Hyrax
       def process_files(stats, user, start_date)
         file_ids_for_user(user).each do |file_id|
           file = ::FileSet.find(file_id)
-          view_stats = rescue_and_retry("Retried FileViewStat on #{user} for file #{file_id} too many times.") { FileViewStat.statistics(file, start_date, user.id) }
-          stats = tally_results(view_stats, :views, stats) unless view_stats.blank?
+          view_stats = extract_stats_for(object: file, from: FileViewStat, start_date: start_date, user: user)
+          stats = tally_results(view_stats, :views, stats) if view_stats.present?
           delay
-          dl_stats = rescue_and_retry("Retried FileDownloadStat on #{user} for file #{file_id} too many times.") { FileDownloadStat.statistics(file, start_date, user.id) }
-          stats = tally_results(dl_stats, :downloads, stats) unless dl_stats.blank?
+          dl_stats = extract_stats_for(object: file, from: FileDownloadStat, start_date: start_date, user: user)
+          stats = tally_results(dl_stats, :downloads, stats) if dl_stats.present?
           delay
         end
       end
@@ -61,30 +61,28 @@ module Hyrax
       def process_works(stats, user, start_date)
         work_ids_for_user(user).each do |work_id|
           work = Hyrax::WorkRelation.new.find(work_id)
-          work_stats = rescue_and_retry("Retried WorkViewStat on #{user} for work #{work_id} too many times.") { WorkViewStat.statistics(work, start_date, user.id) }
-          stats = tally_results(work_stats, :work_views, stats) unless work_stats.blank?
+          work_stats = extract_stats_for(object: work, from: WorkViewStat, start_date: start_date, user: user)
+          stats = tally_results(work_stats, :work_views, stats) if work_stats.present?
           delay
         end
       end
 
+      def extract_stats_for(object:, from:, start_date:, user:)
+        rescue_and_retry("Retried #{from} on #{user} for #{object.class} #{object.id} too many times.") { from.statistics(object, start_date, user.id) }
+      end
+
       def delay
         sleep @delay_secs
       end
 
+      # This method never fails. It tries multiple times and finally logs the exception
       def rescue_and_retry(fail_message)
-        retry_count = 0
-        begin
+        Retriable.retriable(retry_options) do
           return yield
-        rescue StandardError => e
-          retry_count += 1
-          if retry_count < @number_of_retries
-            delay
-            retry
-          else
-            log_message fail_message
-            log_message "Last exception #{e}"
-          end
         end
+      rescue StandardError => exception
+        log_message fail_message
+        log_message "Last exception #{exception}"
       end
 
       def date_since_last_cache(user)
@@ -148,5 +146,9 @@ module Hyrax
       def log_message(message)
         Rails.logger.info "#{self.class}: #{message}" if @logging
       end
+
+      def retry_options
+        { tries: @number_of_tries }
+      end
   end
 end

data/app/services/hyrax/workflow/abstract_notification.rb

@@ -52,7 +52,7 @@ module Hyrax
         end
       end
 
-      protected
+      private
 
         def subject
           raise NotImplementedError, "Implement #subject in a child class"
@@ -72,8 +72,6 @@ module Hyrax
           Rails.application.routes.url_helpers.send(key + "_path", document.id)
         end
 
-      private
-
         def users_to_notify
           recipients.fetch('to', []) + recipients.fetch('cc', [])
         end

data/app/services/hyrax/workflow/changes_required_notification.rb

@@ -1,7 +1,7 @@
 module Hyrax
   module Workflow
     class ChangesRequiredNotification < AbstractNotification
-      protected
+      private
 
         def subject
           'Your deposit requires changes'
@@ -11,8 +11,6 @@ module Hyrax
           "#{title} (#{link_to work_id, document_path}) requires additional changes before approval.\n\n '#{comment}'"
         end
 
-      private
-
         def users_to_notify
           user_key = document.depositor
           super << ::User.find_by(email: user_key)

data/app/services/hyrax/workflow/deposited_notification.rb

@@ -1,7 +1,7 @@
 module Hyrax
   module Workflow
     class DepositedNotification < AbstractNotification
-      protected
+      private
 
         def subject
           'Deposit has been approved'
@@ -11,8 +11,6 @@ module Hyrax
           "#{title} (#{link_to work_id, document_path}) was approved by #{user.user_key}. #{comment}"
         end
 
-      private
-
         def users_to_notify
           user_key = ActiveFedora::Base.find(work_id).depositor
           super << ::User.find_by(email: user_key)

data/app/services/hyrax/workflow/grant_edit_to_depositor.rb

@@ -3,8 +3,13 @@ module Hyrax
     # This is a built in function for workflow, so that a workflow action can be created that
     # grants the creator the ability to alter it.
     module GrantEditToDepositor
+      # @param [#read_users=, #read_users] target (likely an ActiveRecord::Base) to which we are adding edit_users for the depositor
+      # @return void
       def self.call(target:, **)
         target.edit_users += [target.depositor]
+        # If there are a lot of members, granting access to each could take a
+        # long time. Do this work in the background.
+        GrantEditToMembersJob.perform_later(target, target.depositor)
       end
     end
   end