hyrax 3.6.0 → 4.0.0.beta1

data/app/services/hyrax/analytics/google.rb

@@ -1,24 +1,20 @@
 # frozen_string_literal: true
-
 require 'oauth2'
 require 'signet/oauth_2/client'
 
+# rubocop:disable Metrics/ModuleLength
 module Hyrax
   module Analytics
-    # rubocop:disable Metrics/ModuleLength
     module Google
       extend ActiveSupport::Concern
       # rubocop:disable Metrics/BlockLength
       class_methods do
-        # Loads configuration options from config/analytics.yml. You only need PRIVATE_KEY_PATH or
-        # PRIVATE_KEY_VALUE. VALUE takes precedence.
-        # Expected structure:
+        # Loads configuration options from config/analytics.yml. Expected structure:
         # `analytics:`
         # `  google:`
         # `    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
         # `    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
         # `    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
-        # `    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE']`
         # `    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
         # `    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
         # @return [Config]
@@ -45,8 +41,7 @@ module Hyrax
             new config
           end
 
-          KEYS = %w[analytics_id app_name app_version privkey_path privkey_value privkey_secret client_email].freeze
-          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_secret client_email].freeze
+          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_path privkey_secret client_email].freeze
 
           def initialize(config)
             @config = config
@@ -54,16 +49,18 @@ module Hyrax
 
           # @return [Boolean] are all the required values present?
           def valid?
-            return false unless @config['privkey_value'].present? || @config['privkey_path'].present?
+            config_keys = @config.keys
+            REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
+          end
 
-            REQUIRED_KEYS.all? { |required| @config[required].present? }
+          REQUIRED_KEYS.each do |key|
+            class_eval %{ def #{key};  @config.fetch('#{key}'); end }
           end
 
-          KEYS.each do |key|
-            # rubocop:disable Style/EvalWithLocation
-            class_eval %{ def #{key}; @config.fetch('#{key}'); end }
-            class_eval %{ def #{key}=(value); @config['#{key}'] = value; end }
-            # rubocop:enable Style/EvalWithLocation
+          # This method allows setting the analytics id in the initializer
+          # @deprecated set the analytics id in either ENV['GOOGLE_ANALYTICS_ID'] or config/analytics.yaml
+          def analytics_id=(value)
+            @config['analytics_id'] = value
           end
         end
 
@@ -80,12 +77,8 @@ module Hyrax
         end
 
         def auth_client(scope)
-          private_key = Base64.decode64(config.privkey_value) if config.privkey_value.present?
-          if private_key.blank?
-            raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
-
-            private_key = File.read(config.privkey_path)
-          end
+          raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
+          private_key = File.read(config.privkey_path)
           Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
                                      audience: 'https://accounts.google.com/o/oauth2/token',
                                      scope: scope,
@@ -130,7 +123,7 @@ module Hyrax
 
           [start_date, end_date]
         end
-        # rubocop:enable Metrics/MethodLength
+        # rubocop:enabl e Metrics/MethodLength
 
         def keyword_conversion(date)
           case date
@@ -206,7 +199,6 @@ module Hyrax
       end
       # rubocop:enable Metrics/BlockLength
     end
-    # rubocop:enable Metrics/ModuleLength
   end
 end
 # rubocop:enable Metrics/ModuleLength

data/app/services/hyrax/analytics/matomo.rb

@@ -11,16 +11,15 @@ module Hyrax
         # Loads configuration options from config/analytics.yml. Expected structure:
         # `analytics:`
         # `  matomo:`
-        # `    base_url: <%= ENV['MATOMO_BASE_URL']`
-        # `    site_id: <%= ENV['MATOMO_SITE_ID']`
-        # `    auth_token: <%= ENV['MATOMO_AUTH_TOKEN']`
+        # `    base_url: <%= ENV['MATOMOT_BASE_URL']`
+        # `    site_id: <%= ENV['MATOMOT_SITE_ID']`
+        # `    auth_token: <%= ENV['MATOMOT_AUTH_TOKEN']`
         # @return [Config]
         def config
           @config ||= Config.load_from_yaml
         end
 
         class Config
-          # TODO: test matomo and see if it needs any of the updates from https://github.com/samvera/hyrax/pull/6063
           def self.load_from_yaml
             filename = Rails.root.join('config', 'analytics.yml')
             yaml = YAML.safe_load(ERB.new(File.read(filename)).result)

data/app/services/hyrax/collection_member_service.rb

@@ -5,7 +5,6 @@ module Hyrax
   # Returns a list of solr documents for collections the item is a part of
   class CollectionMemberService
     include Blacklight::Configurable
-    include Blacklight::SearchHelper
 
     attr_reader :item, :current_ability
 
@@ -25,7 +24,7 @@ module Hyrax
 
     def list_collections
       query = collection_search_builder.rows(1000)
-      resp = repository.search(query)
+      resp = blacklight_config.repository.search(query)
       resp.documents
     end
 

data/app/services/hyrax/collections/nested_collection_query_service.rb

@@ -86,7 +86,7 @@ module Hyrax
       #   id is in the response. Useful for validation.
       # @param nest_direction [Symbol] :as_child or :as_parent
       def self.query_solr(collection:, access:, scope:, limit_to_id:, nest_direction:)
-        nesting_attributes = (Hyrax.config.use_solr_graph_for_collection_nesting ? nil : NestingAttributes.new(id: collection.id.to_s, scope: scope))
+        nesting_attributes = NestingAttributes.new(id: collection.id.to_s, scope: scope)
         query_builder = Hyrax::Dashboard::NestedCollectionsSearchBuilder.new(
           access: access,
           collection: collection,

data/app/services/hyrax/collections/search_service.rb

@@ -3,7 +3,6 @@ module Hyrax
   module Collections
     class SearchService
       include Blacklight::Configurable
-      include Blacklight::SearchHelper
 
       def initialize(session, user_key)
         @session = session

data/app/services/hyrax/custom_queries.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Hyrax
+  ##
+  # These custom queries are used throughout the Hyrax codebase. They are
+  # intended for use with Valkyrie's custom query interface (i.e. you
+  # shouldn't call classes in this namespace directly except to configure that
+  # interface).
+  #
+  # In this namespace, we provide default/reference implementations, with the
+  # restriction that they cannot use any adapter-specific knowledge. I.e. these
+  # queries use the Valkyrie core queries and client side data manipulation
+  # only. This restriction limits performance expectations for these
+  # implementations, but guarantees a basic level of compatibility for all
+  # conforming Valkyrie adapters.
+  #
+  # In order for a Valkyrie adapter to be "supported" by Hyrax, these queries
+  # should be individually evaluated for performance when using the adapter.
+  # Where appropriate, optimized implementations should be provided taking
+  # advantage of backend-specific query features.
+  #
+  # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+  # @see https://github.com/samvera/hyrax/wiki/Hyrax-Valkyrie-Usage-Guide#custom-queriesy
+  module CustomQueries
+  end
+end

data/app/services/hyrax/edit_permissions_service.rb

@@ -20,35 +20,17 @@ module Hyrax
     # @note
     #   +form object.class = SimpleForm::FormBuilder+
     #    For works (i.e. GenericWork):
-    #    * form_object.object = Hyrax::GenericWorkForm
-    #    * form_object.object.model = GenericWork
+    #    * form object.object = Hyrax::GenericWorkForm
+    #    * form object.object.model = GenericWork
     #    * use the work itself
     #    For file_sets:
-    #    * form_object.object.class = FileSet
-    #    * use work the file_set is in
-    #    For file set forms:
-    #    * form_object.object.class = Hyrax::Forms::FileSetForm OR
-    #      Hyrax::Forms::FileSetEditForm
-    #    * form_object.object.model = FileSet
+    #    * form object.object.class = FileSet
     #    * use work the file_set is in
     #    No other object types are supported by this view.
     def self.build_service_object_from(form:, ability:)
       if form.object.respond_to?(:model) && form.object.model.work?
-        # The provided form object is a work form.
         new(object: form.object, ability: ability)
-      elsif form.object.respond_to?(:model) && form.object.model.file_set?
-        # The provided form object is a FileSet form. For Valkyrie forms
-        # (+Hyrax::Forms::FileSetForm+), +:in_works_ids+ is prepopulated onto
-        # the form object itself. For +Hyrax::Forms::FileSetEditForm+, the
-        # +:in_works+ method is present on the wrapped +:model+.
-        if form.object.is_a?(Hyrax::Forms::FileSetForm)
-          object_id = form.object.in_works_ids.first
-          new(object: Hyrax.query_service.find_by(id: object_id), ability: ability)
-        else
-          new(object: form.object.model.in_works.first, ability: ability)
-        end
       elsif form.object.file_set?
-        # The provided form object is a FileSet.
         new(object: form.object.in_works.first, ability: ability)
       end
     end

data/app/services/hyrax/embargo_manager.rb

@@ -161,15 +161,6 @@ module Hyrax
       resource.embargo || Embargo.new
     end
 
-    ##
-    # Drop the embargo by setting its release date to `nil`.
-    #
-    # @return [void]
-    def nullify
-      return unless under_embargo?
-      embargo.embargo_release_date = nil
-    end
-
     ##
     # Sets the visibility of the resource to the embargo's visibility condition.
     # no-op if the embargo period is current.

data/app/services/hyrax/file_set_csv_service.rb

@@ -8,7 +8,7 @@ module Hyrax
   # @attr_reader [FileSet] file_set file that will be examined to generate the CSVs
   # @attr_reader [Array] terms list of terms that will be output in CSV form
   # @attr_reader [String] multi_value_separator separator for terms that have more than one value
-  class FileSetCSVService
+  class FileSetCsvService
     attr_reader :file_set, :terms, :multi_value_separator
 
     # @param [SolrDocument] file solr document that will be examined to generate the CSVs

data/app/services/hyrax/graph_exporter.rb

@@ -10,11 +10,9 @@ module Hyrax
     # @param [SolrDocument, #id] solr_document idea here is that in the future, ActiveFedora may serialize the object as JSON+LD
     # @param [ActionDispatch::Request] request the http request context
     # @param [String] hostname  the current http host
-    def initialize(solr_document, request = nil, hostname: nil)
-      Deprecation.warn('passing `request` is deprecated; pass a host as `hostname:` instead.') if request
+    def initialize(solr_document, hostname:)
       @solr_document = solr_document
-      @request = request
-      @hostname = hostname || request.host
+      @hostname = hostname
       @additional_resources = []
       @visited_subresources = Set.new
     end
@@ -22,15 +20,12 @@ module Hyrax
     ##
     # @!attribute [r] additional_resources
     #   @return [Array<RDF::Graph>]
-    # @!attribute [r] request
-    #   @deprecated use {#hostname} to access the host
     #   @return [ActionDispatch::Request]
     # @!attribute [r] solr_document
     #   @return [#id]
     # @!attribute [r] hostname
     #   @return [String]
-    attr_reader :solr_document, :request, :additional_resources, :hostname
-    deprecation_deprecate :request
+    attr_reader :solr_document, :additional_resources, :hostname
 
     ##
     # @return [RDF::Graph]

data/app/services/hyrax/iiif_authorization_service.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Hyrax
-  class IIIFAuthorizationService
+  class IiifAuthorizationService
     attr_reader :controller
     def initialize(controller)
       @controller = controller

data/app/services/hyrax/lease_manager.rb

@@ -89,15 +89,6 @@ module Hyrax
       resource.lease || Lease.new
     end
 
-    ##
-    # Drop the lease by setting its release date to `nil`.
-    #
-    # @return [void]
-    def nullify
-      return unless under_lease?
-      lease.lease_expiration_date = nil
-    end
-
     ##
     # @return [Boolean]
     def release

data/app/services/hyrax/listeners/file_metadata_listener.rb

@@ -5,17 +5,6 @@ module Hyrax
     ##
     # Listens for events related to {Hyrax::FileMetadata}
     class FileMetadataListener
-      ##
-      # Called when 'file.characterized' event is published;
-      # allows post-characterization handling, like derivatives generation.
-      #
-      # @param [Dry::Events::Event] event
-      # @return [void]
-      def on_file_characterized(event)
-        CreateDerivativesJob
-          .perform_later(event[:file_set], event[:file_id], event[:path_hint])
-      end
-
       ##
       # Called when 'file.metadata.updated' event is published; reindexes a
       # {Hyrax::FileSet} when a file claiming to be its `pcdm_use:OriginalFile`

data/app/services/hyrax/search_service.rb

@@ -1,66 +1,9 @@
 # frozen_string_literal: true
 
 module Hyrax
-  ##
-  # Returns search results from the repository.
-  #
-  # @note Adapted from Blacklight 7
-  class SearchService
-    def initialize(config:, user_params: nil, search_builder_class: config.search_builder_class, **context)
-      @blacklight_config = config
-      @user_params = user_params || {}
-      @search_builder_class = search_builder_class
-      @context = context
-    end
-
-    # The blacklight_config + controller are accessed by the search_builder
-    attr_reader :blacklight_config, :context
-
-    def search_builder
-      search_builder_class.new(self)
-    end
-
-    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-    # a solr query method
-    # @yield [search_builder] optional block yields configured SearchBuilder, caller can modify or create new SearchBuilder to be used. Block should return SearchBuilder to be used.
-    # @return [Blacklight::Solr::Response] the solr response object
-    def search_results
-      builder = search_builder.with(user_params)
-      builder.page = user_params[:page] if user_params[:page]
-      builder.rows = (user_params[:per_page] || user_params[:rows]) if user_params[:per_page] || user_params[:rows]
-
-      builder = yield(builder) if block_given?
-      response = repository.search(builder)
-
-      if response.grouped? && grouped_key_for_results
-        [response.group(grouped_key_for_results), []]
-      elsif response.grouped? && response.grouped.length == 1
-        [response.grouped.first, []]
-      else
-        [response, response.documents]
-      end
-    end
-    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
-    # retrieve a document, given the doc id
-    # @param [Array{#to_s},#to_s] id
-    # @return [Blacklight::Solr::Response, Blacklight::SolrDocument] the solr response object and the first document
-    def fetch(id = nil, extra_controller_params = {})
-      if id.is_a? Array
-        fetch_many(id, extra_controller_params)
-      else
-        fetch_one(id, extra_controller_params)
-      end
-    end
-
+  class SearchService < Blacklight::SearchService
     private
 
-    attr_reader :search_builder_class, :user_params, :search_state
-
-    def repository
-      blacklight_config.repository || blacklight_config.repository_class.new(blacklight_config)
-    end
-
     def scope
       @context[:scope]
     end
@@ -83,28 +26,5 @@ module Hyrax
     def current_ability
       @current_ability || @context[:current_ability]
     end
-
-    ##
-    # Retrieve a set of documents by id
-    # @param [Array] ids
-    # @param [HashWithIndifferentAccess] extra_controller_params
-    def fetch_many(ids, extra_controller_params)
-      extra_controller_params ||= {}
-
-      query = search_builder
-              .with(user_params)
-              .where(blacklight_config.document_model.unique_key => ids)
-              .merge(blacklight_config.fetch_many_document_params)
-              .merge(extra_controller_params)
-
-      solr_response = repository.search(query)
-
-      [solr_response, solr_response.documents]
-    end
-
-    def fetch_one(id, extra_controller_params)
-      solr_response = repository.find id, extra_controller_params
-      [solr_response, solr_response.documents.first]
-    end
   end
 end

data/app/services/hyrax/solr_query_service.rb

@@ -27,14 +27,14 @@ module Hyrax
 
     ##
     # @return [Hash] the results returned from solr for the current query
-    def get(*args)
-      solr_service.get(build, *args)
+    def get
+      solr_service.get(build)
     end
 
     ##
     # @return [Enumerable<SolrDocument>]
-    def solr_documents(*args)
-      get(*args)['response']['docs'].map { |doc| self.class.document_model.new(doc) }
+    def solr_documents
+      get['response']['docs'].map { |doc| self.class.document_model.new(doc) }
     end
 
     ##

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

@@ -5,8 +5,6 @@ module Hyrax
       ##
       # Gather information about the depositors who have contributed to the repository
       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
@@ -43,7 +41,7 @@ module Hyrax
         # [ abc123, 55, ccczzz, 205 ]
         # @return [#each] an enumerable object of tuples (user and count)
         def results
-          facet_results = repository.search(query)
+          facet_results = blacklight_config.repository.search(query)
           facet_results.facet_fields[depositor_field].each_slice(2)
         end
 

data/app/services/hyrax/user_stat_importer.rb

@@ -84,8 +84,6 @@ module Hyrax
     rescue StandardError => exception
       log_message fail_message
       log_message "Last exception #{exception}"
-      # Without returning false, we return the results of log_message; which is true.
-      false
     end
 
     def date_since_last_cache(user)

data/app/services/hyrax/valkyrie_upload.rb

@@ -28,7 +28,7 @@ module Hyrax::ValkyrieUpload
     )
     io.close
 
-    file_metadata = Hyrax::FileMetadata(streamfile)
+    file_metadata = find_or_create_metadata(id: streamfile.id, file: streamfile)
     file_metadata.file_set_id = file_set.id
 
     case use
@@ -91,4 +91,16 @@ module Hyrax::ValkyrieUpload
       end
     end
   end
+
+  # @api private
+  # @param [#to_s] id
+  # @param [Valkyrie::StorageAdapter::StreamFile] file
+  def self.find_or_create_metadata(id:, file:)
+    Hyrax.custom_queries.find_file_metadata_by(id: id)
+  rescue Valkyrie::Persistence::ObjectNotFoundError => e
+    Hyrax.logger.warn "Failed to find existing metadata for #{id}:"
+    Hyrax.logger.warn e.message
+    Hyrax.logger.warn "Creating Hyrax::FileMetadata now"
+    Hyrax::FileMetadata.for(file: file)
+  end
 end

data/app/services/hyrax/versioning_service.rb

@@ -1,80 +1,7 @@
 # frozen_string_literal: true
 
 module Hyrax
-  ##
-  # Provides methods for dealing with versions of files across both ActiveFedora
-  # and Valkyrie.
-  #
-  # Note that many of the methods pertaining to version creation are currently
-  # implemented as static methods.
   class VersioningService
-    ##
-    # @!attribute [rw] resource
-    #   @return [ActiveFedora::File | Hyrax::FileMetadata | NilClass]
-    attr_accessor :resource
-
-    ##
-    # @!attribute [r] storage_adapter
-    #   @return [#supports?]
-    attr_reader :storage_adapter
-
-    ##
-    # @param resource [ActiveFedora::File | Hyrax::FileMetadata | NilClass]
-    def initialize(resource:, storage_adapter: Hyrax.storage_adapter)
-      @storage_adapter = storage_adapter
-      self.resource = resource
-    end
-
-    ##
-    # Returns an array of versions for the resource associated with this
-    # Hyrax::VersioningService.
-    #
-    # If the resource is nil, or if it is a Hyrax::FileMetadata and versioning
-    # is not supported in the storage adapter, an empty array will be returned.
-    def versions
-      if resource.nil?
-        []
-      elsif resource.is_a?(Hyrax::FileMetadata)
-        if storage_adapter.try(:"supports?", :versions)
-          storage_adapter.find_versions(id: resource.file_identifier).to_a
-        else
-          []
-        end
-      else
-        resource.versions.all.to_a
-      end
-    end
-
-    ##
-    # Returns the latest version of the file associated with this
-    # Hyrax::VersioningService.
-    def latest_version
-      versions.last
-    end
-
-    ##
-    # Returns the file ID of the latest version of the file associated with this
-    # Hyrax::VersioningService, or the ID of the file resource itself if no
-    # latest version is defined.
-    #
-    # If the resource is nil, this method returns an empty string.
-    def versioned_file_id
-      latest = latest_version
-      if latest
-        if latest.respond_to?(:id)
-          latest.id
-        else
-          Hyrax.config.translate_uri_to_id.call(latest.uri)
-        end
-      elsif resource.nil?
-        ""
-      elsif resource.is_a?(Hyrax::FileMetadata)
-        resource.file_identifier
-      else
-        resource.id
-      end
-    end
-
     class << self
       # Make a version and record the version committer
       # @param [ActiveFedora::File | Hyrax::FileMetadata] content
@@ -84,14 +11,19 @@ module Hyrax
         perform_create(content, user, use_valkyrie)
       end
 
-      # @param [ActiveFedora::File | Hyrax::FileMetadata] file
+      # @param [ActiveFedora::File | Hyrax::FileMetadata] content
       def latest_version_of(file)
-        Hyrax::VersioningService.new(resource: file).latest_version
+        file.versions.last
       end
 
-      # @param [ActiveFedora::File | Hyrax::FileMetadata] file
+      # @param [ActiveFedora::File | Hyrax::FileMetadata] content
       def versioned_file_id(file)
-        Hyrax::VersioningService.new(resource: file).versioned_file_id
+        versions = file.versions.all
+        if versions.present?
+          Hyrax.config.translate_uri_to_id.call(versions.last.uri)
+        else
+          file.id
+        end
       end
 
       # Record the version committer of the last version

data/app/services/hyrax/visibility_propagator.rb

@@ -15,13 +15,13 @@ module Hyrax
       when Hyrax::Resource # Valkyrie
         ResourceVisibilityPropagator.new(source: source)
       else
-        NullVisibilityPropagator.new(source: source)
+        NullVisibilityPropogator.new(source: source)
       end
     end
 
     ##
-    # Provides a null/logging implementation of the visibility propagator.
-    class NullVisibilityPropagator
+    # Provides a null/logging implementation of the visibility propogator.
+    class NullVisibilityPropogator
       ##
       # @!attribute [rw] source
       #   @return [#visibility]
@@ -36,8 +36,8 @@ module Hyrax
       ##
       # @return [void]
       # @raise [RuntimeError] if we're in development mode
-      def propagate
-        message =  "Tried to propagate visibility to members of #{source} " \
+      def propogate
+        message =  "Tried to propogate visibility to members of #{source} " \
                    "but didn't know what kind of object it is. Model " \
                    "name #{source.try(:model_name)}. Called from #{caller[0]}."
 

data/app/services/hyrax/work_query_service.rb

@@ -53,7 +53,7 @@ module Hyrax
     end
 
     def query
-      Hyrax::SolrQueryBuilderService.construct_query_for_ids([id])
+      Hyrax::SolrQueryService.new.with_ids(ids: [id]).build
     end
   end
 end