hyrax 2.8.0 → 3.0.0.pre.rc2

data/app/services/hyrax/adapters/nesting_index_adapter.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Hyrax
   module Adapters
     module NestingIndexAdapter
-      FULL_REINDEX = "full".freeze
-      LIMITED_REINDEX = "limited".freeze
+      FULL_REINDEX = "full"
+      LIMITED_REINDEX = "limited"
 
       # @!group Providing interface for a Samvera::NestingIndexer::Adapter
       # @api public
@@ -21,7 +22,7 @@ module Hyrax
       def self.find_preservation_parent_ids_for(id:)
         # Not everything is guaranteed to have library_collection_ids
         # If it doesn't have it, what do we do?
-        fedora_object = ActiveFedora::Base.uncached do
+        fedora_object = Hyrax::Base.uncached do
           fedora_object = ActiveFedora::Base.find(id)
         end
 
@@ -47,7 +48,7 @@ module Hyrax
       # rubocop:disable Lint/UnusedMethodArgument
       def self.each_perservation_document_id_and_parent_ids(&block)
         ActiveFedora::Base.descendant_uris(ActiveFedora.fedora.base_uri, exclude_uri: true).each do |uri|
-          id = ActiveFedora::Base.uri_to_id(uri)
+          id = Hyrax::Base.uri_to_id(uri)
           object = ActiveFedora::Base.find(id)
           parent_ids = object.try(:member_of_collection_ids) || []
 
@@ -57,7 +58,7 @@ module Hyrax
             yield(id, parent_ids) if parent_ids.empty?
           else
             Rails.logger.info "Re-indexing via to_solr ... #{id}"
-            ActiveFedora::SolrService.add(object.to_solr, commit: true)
+            Hyrax::SolrService.add(object.to_solr, commit: true)
           end
         end
       end
@@ -70,7 +71,7 @@ module Hyrax
       # @param nesting_document [Samvera::NestingIndexer::Documents::IndexDocument]
       # @return Hash - the attributes written to the indexing layer
       def self.write_nesting_document_to_index_layer(nesting_document:)
-        solr_doc = ActiveFedora::Base.uncached do
+        solr_doc = Hyrax::Base.uncached do
           ActiveFedora::Base.find(nesting_document.id).to_solr # What is the current state of the solr document
         end
 
@@ -97,7 +98,7 @@ module Hyrax
         solr_doc[solr_field_name_for_storing_parent_ids] = parent_ids
         solr_doc[solr_field_name_for_storing_pathnames] = pathnames
         solr_doc[solr_field_name_for_deepest_nested_depth] = depth
-        ActiveFedora::SolrService.add(solr_doc, commit: true)
+        Hyrax::SolrService.add(solr_doc, commit: true)
         solr_doc
       end
 
@@ -131,8 +132,8 @@ module Hyrax
 
       # @api private
       def self.find_solr_document_by(id:)
-        query = ActiveFedora::SolrQueryBuilder.construct_query_for_ids([id])
-        document = ActiveFedora::SolrService.query(query, rows: 1).first
+        query = Hyrax::SolrQueryBuilderService.construct_query_for_ids([id])
+        document = Hyrax::SolrService.query(query, rows: 1).first
         document = ActiveFedora::Base.find(id).to_solr if document.nil?
         raise "Unable to find SolrDocument with ID=#{id}" if document.nil?
         document
@@ -157,8 +158,8 @@ module Hyrax
       # @todo What is the appropriate suffix to apply to the solr_field_name?
       def self.raw_child_solr_documents_of(parent_document:)
         # query Solr for all of the documents included as a member_of_collection parent. Or up to 10000 of them.
-        child_query = ActiveFedora::SolrQueryBuilder.construct_query(member_of_collection_ids_ssim: parent_document.id)
-        ActiveFedora::SolrService.query(child_query, rows: 10_000.to_i)
+        child_query = Hyrax::SolrQueryBuilderService.construct_query(member_of_collection_ids_ssim: parent_document.id)
+        Hyrax::SolrService.query(child_query, rows: 10_000.to_i)
       end
       private_class_method :raw_child_solr_documents_of
 

data/app/services/hyrax/admin_set_create_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Responsible for creating an AdminSet and its corresponding data:
   #
@@ -67,66 +68,66 @@ module Hyrax
 
     private
 
-      def access_grants_attributes
-        [
-          { agent_type: 'group', agent_id: admin_group_name, access: Hyrax::PermissionTemplateAccess::MANAGE }
-        ].tap do |attribute_list|
-          # Grant manage access to the creating_user if it exists. Should exist for all but default Admin Set
-          attribute_list << { agent_type: 'user', agent_id: creating_user.user_key, access: Hyrax::PermissionTemplateAccess::MANAGE } if creating_user
-        end
+    def access_grants_attributes
+      [
+        { agent_type: 'group', agent_id: admin_group_name, access: Hyrax::PermissionTemplateAccess::MANAGE }
+      ].tap do |attribute_list|
+        # Grant manage access to the creating_user if it exists. Should exist for all but default Admin Set
+        attribute_list << { agent_type: 'user', agent_id: creating_user.user_key, access: Hyrax::PermissionTemplateAccess::MANAGE } if creating_user
       end
+    end
 
-      def admin_group_name
-        ::Ability.admin_group_name
-      end
+    def admin_group_name
+      ::Ability.admin_group_name
+    end
 
-      def create_permission_template
-        permission_template = PermissionTemplate.create!(source_id: admin_set.id, access_grants_attributes: access_grants_attributes)
-        admin_set.reset_access_controls!
-        permission_template
-      end
+    def create_permission_template
+      permission_template = PermissionTemplate.create!(source_id: admin_set.id, access_grants_attributes: access_grants_attributes)
+      admin_set.reset_access_controls!
+      permission_template
+    end
 
-      def create_workflows_for(permission_template:)
-        workflow_importer.call(permission_template: permission_template)
-        grant_all_workflow_roles_to_creating_user_and_admins!(permission_template: permission_template)
-        Sipity::Workflow.activate!(permission_template: permission_template, workflow_name: Hyrax.config.default_active_workflow_name)
-      end
+    def create_workflows_for(permission_template:)
+      workflow_importer.call(permission_template: permission_template)
+      grant_all_workflow_roles_to_creating_user_and_admins!(permission_template: permission_template)
+      Sipity::Workflow.activate!(permission_template: permission_template, workflow_name: Hyrax.config.default_active_workflow_name)
+    end
 
-      # Force creation of registered MANAGING role if it doesn't exist
-      def register_managing_role!
-        Sipity::Role[Hyrax::RoleRegistry::MANAGING]
-      end
+    # Force creation of registered MANAGING role if it doesn't exist
+    def register_managing_role!
+      Sipity::Role[Hyrax::RoleRegistry::MANAGING]
+    end
 
-      def grant_all_workflow_roles_to_creating_user_and_admins!(permission_template:)
-        # This code must be invoked before calling `Sipity::Role.all` or the managing role won't be there
-        register_managing_role!
-        # Grant all workflow roles to the creating_user and the admin group
-        permission_template.available_workflows.each do |workflow|
-          Sipity::Role.all.each do |role|
-            workflow.update_responsibilities(role: role,
-                                             agents: workflow_agents)
-          end
+    def grant_all_workflow_roles_to_creating_user_and_admins!(permission_template:)
+      # This code must be invoked before calling `Sipity::Role.all` or the managing role won't be there
+      register_managing_role!
+      # Grant all workflow roles to the creating_user and the admin group
+      permission_template.available_workflows.each do |workflow|
+        Sipity::Role.all.each do |role|
+          workflow.update_responsibilities(role: role,
+                                           agents: workflow_agents)
         end
       end
+    end
 
-      def workflow_agents
-        [
-          Hyrax::Group.new(admin_group_name)
-        ].tap do |agent_list|
-          # The default admin set does not have a creating user
-          agent_list << creating_user if creating_user
-        end
+    def workflow_agents
+      [
+        Hyrax::Group.new(admin_group_name)
+      ].tap do |agent_list|
+        # The default admin set does not have a creating user
+        agent_list << creating_user if creating_user
       end
+    end
 
-      # Gives deposit access to registered users to default AdminSet
-      def create_default_access_for(permission_template:, workflow:)
-        permission_template.access_grants.create(agent_type: 'group', agent_id: ::Ability.registered_group_name, access: Hyrax::PermissionTemplateAccess::DEPOSIT)
-        deposit = Sipity::Role[Hyrax::RoleRegistry::DEPOSITING]
-        workflow.update_responsibilities(role: deposit, agents: Hyrax::Group.new('registered'))
-      end
+    # Gives deposit access to registered users to default AdminSet
+    def create_default_access_for(permission_template:, workflow:)
+      permission_template.access_grants.create(agent_type: 'group', agent_id: ::Ability.registered_group_name, access: Hyrax::PermissionTemplateAccess::DEPOSIT)
+      deposit = Sipity::Role[Hyrax::RoleRegistry::DEPOSITING]
+      workflow.update_responsibilities(role: deposit, agents: Hyrax::Group.new('registered'))
+    end
 
-      def default_workflow_importer
-        Hyrax::Workflow::WorkflowImporter.method(:load_workflow_for)
-      end
+    def default_workflow_importer
+      Hyrax::Workflow::WorkflowImporter.method(:load_workflow_for)
+    end
   end
 end

data/app/services/hyrax/admin_set_member_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   # Responsible for retrieving admin set's members
   class AdminSetMemberService
@@ -5,7 +6,7 @@ module Hyrax
     delegate :repository, to: :scope
 
     # @param scope [#repository] Typically acontroller object which responds to :repository
-    # @param [Collection] an collection of type admin set
+    # @param [::Collection] an collection of type admin set
     # @param [ActionController::Parameters] query params
     def initialize(scope:, collection:, params:)
       @scope = scope
@@ -23,18 +24,18 @@ module Hyrax
 
     private
 
-      # @api public
-      #
-      # set up a member search builder admin set members
-      # @return [AdminAdminSetMemberSearchBuilder] new or existing
-      def members_search_builder
-        @members_search_builder ||= Hyrax::AdminAdminSetMemberSearchBuilder.new(scope: scope, collection: collection)
-      end
+    # @api public
+    #
+    # set up a member search builder admin set members
+    # @return [AdminAdminSetMemberSearchBuilder] new or existing
+    def members_search_builder
+      @members_search_builder ||= Hyrax::AdminAdminSetMemberSearchBuilder.new(scope: scope, collection: collection)
+    end
 
-      # @api private
-      #
-      def query_solr(query_builder:, query_params:)
-        repository.search(query_builder.with(query_params).query)
-      end
+    # @api private
+    #
+    def query_solr(query_builder:, query_params:)
+      repository.search(query_builder.with(query_params).query)
+    end
   end
 end

data/app/services/hyrax/admin_set_service.rb

@@ -26,16 +26,12 @@ module Hyrax
     # @param [Symbol] access :read or :edit
     # @param join_field [String] how are we joining the admin_set ids (by default "isPartOf_ssim")
     # @return [Array<Hyrax::AdminSetService::SearchResultForWorkCount>] a list with document, then work and file count
-    def search_results_with_work_count(access, join_field: "isPartOf_ssim")
+    def search_results_with_work_count(access, join_field: "#{Hyrax.config.admin_set_predicate.qname.last}_ssim")
       admin_sets = search_results(access)
       ids = admin_sets.map(&:id).join(',')
       query = "{!terms f=#{join_field}}#{ids}"
-      results = ActiveFedora::SolrService.instance.conn.get(
-        ActiveFedora::SolrService.select_path,
-        params: { fq: query,
-                  rows: 0,
-                  'facet.field' => join_field }
-      )
+      results = Hyrax::SolrService.get(fq: query, rows: 0, 'facet.field': join_field)
+
       counts = results['facet_counts']['facet_fields'][join_field].each_slice(2).to_h
       file_counts = count_files(admin_sets)
       admin_sets.map do |admin_set|
@@ -45,26 +41,22 @@ module Hyrax
 
     private
 
-      # @param [Symbol] access :read or :edit
-      def builder(access)
-        search_builder.new(context, access).rows(100)
-      end
+    # @param [Symbol] access :read or :edit
+    def builder(access)
+      search_builder.new(context, access).rows(100)
+    end
 
-      # Count number of files from admin set works
-      # @param [Array] AdminSets to count files in
-      # @return [Hash] admin set id keys and file count values
-      def count_files(admin_sets)
-        file_counts = Hash.new(0)
-        admin_sets.each do |admin_set|
-          query = "{!join from=file_set_ids_ssim to=id}isPartOf_ssim:#{admin_set.id}"
-          file_results = ActiveFedora::SolrService.instance.conn.get(
-            ActiveFedora::SolrService.select_path,
-            params: { fq: [query, "has_model_ssim:FileSet"],
-                      rows: 0 }
-          )
-          file_counts[admin_set.id] = file_results['response']['numFound']
-        end
-        file_counts
+    # Count number of files from admin set works
+    # @param [Array] AdminSets to count files in
+    # @return [Hash] admin set id keys and file count values
+    def count_files(admin_sets)
+      file_counts = Hash.new(0)
+      admin_sets.each do |admin_set|
+        query = "{!join from=file_set_ids_ssim to=id}isPartOf_ssim:#{admin_set.id}"
+        file_results = Hyrax::SolrService.get(fq: [query, "has_model_ssim:FileSet"], rows: 0)
+        file_counts[admin_set.id] = file_results['response']['numFound']
       end
+      file_counts
+    end
   end
 end

data/app/services/hyrax/analytics.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'oauth2'
 require 'signet/oauth_2/client'
 
@@ -5,11 +6,11 @@ module Hyrax
   module Analytics
     # Loads configuration options from config/analytics.yml. Expected structure:
     # `analytics:`
-    # `  app_name: GOOGLE_OAUTH_APP_NAME`
-    # `  app_version: GOOGLE_OAUTH_APP_VERSION`
-    # `  privkey_path: GOOGLE_OAUTH_PRIVATE_KEY_PATH`
-    # `  privkey_secret: GOOGLE_OAUTH_PRIVATE_KEY_SECRET`
-    # `  client_email: GOOGLE_OAUTH_CLIENT_EMAIL`
+    # `  app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
+    # `  app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
+    # `  privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
+    # `  privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
+    # `  client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
     # @return [Config]
     def self.config
       @config ||= Config.load_from_yaml
@@ -19,7 +20,7 @@ module Hyrax
     class Config
       def self.load_from_yaml
         filename = Rails.root.join('config', 'analytics.yml')
-        yaml = YAML.safe_load(File.read(filename))
+        yaml = YAML.safe_load(ERB.new(File.read(filename)).result)
         unless yaml
           Rails.logger.error("Unable to fetch any keys from #{filename}.")
           return new({})

data/app/services/hyrax/batch_create_failure_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class BatchCreateFailureService < AbstractMessageService
     attr_reader :user, :messages
@@ -7,11 +8,11 @@ module Hyrax
     end
 
     def message
-      "The batch create for #{user} failed: #{messages}"
+      I18n.t('hyrax.notifications.batch_create_failure.message', user: user, messages: messages)
     end
 
     def subject
-      'Failing batch create'
+      I18n.t('hyrax.notifications.batch_create_failure.subject')
     end
   end
 end

data/app/services/hyrax/batch_create_success_service.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class BatchCreateSuccessService < AbstractMessageService
     attr_reader :user
@@ -7,11 +8,11 @@ module Hyrax
     end
 
     def message
-      "The batch create for #{user} passed."
+      I18n.t('hyrax.notifications.batch_create_success.message', user: user)
     end
 
     def subject
-      'Passing batch create'
+      I18n.t('hyrax.notifications.batch_create_success.subject')
     end
   end
 end

data/app/services/hyrax/caching_iiif_manifest_builder.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # constructs IIIF Manifests and holds them in the Rails cache,
+  # this approach avoids long manifest build times for some kinds of requests,
+  # at the cost of introducing cache invalidation issues.
+  class CachingIiifManifestBuilder < ManifestBuilderService
+    KEY_PREFIX = 'iiif-cache-v1'
+
+    attr_accessor :expires_in
+
+    ##
+    # @api public
+    #
+    # @param iiif_manifest_factory [Class] a class that initializes with presenter
+    #        object and returns an object that responds to `#to_h`
+    # @param expires_in [Integer] the number of seconds until the cache expires
+    # @see Hyrax::Configuration#iiif_manifest_cache_duration
+    def initialize(iiif_manifest_factory: ::IIIFManifest::ManifestFactory, expires_in: Hyrax.config.iiif_manifest_cache_duration)
+      self.expires_in = expires_in
+
+      super(iiif_manifest_factory: iiif_manifest_factory)
+    end
+
+    ##
+    # @see ManifestBuilderService#as_json
+    def manifest_for(presenter:)
+      Rails.cache.fetch(manifest_cache_key(presenter: presenter), expires_in: expires_in) do
+        super
+      end
+    end
+
+    private
+
+    ##
+    # @note adding a version_for suffix helps us manage cache expiration,
+    #   reducing false cache hits
+    #
+    # @param presenter [Hyrax::IiifManifestPresenter]
+    #
+    # @return [String]
+    def manifest_cache_key(presenter:)
+      "#{KEY_PREFIX}_#{presenter.id}/#{version_for(presenter)}"
+    end
+
+    ##
+    # @note `etag` is a better option than the solr document `_version_`; the
+    #   latter isn't always available, depending on how the presenter was
+    #   built!
+    #
+    # @return [String]
+    def version_for(presenter)
+      presenter.version
+    end
+  end
+end

data/app/services/hyrax/change_content_depositor_service.rb

@@ -1,9 +1,19 @@
+# frozen_string_literal: true
 module Hyrax
   class ChangeContentDepositorService
-    # @param [ActiveFedora::Base] work
+    # @param [ActiveFedora::Base, Valkyrie::Resource] work
     # @param [User] user
     # @param [TrueClass, FalseClass] reset
     def self.call(work, user, reset)
+      case work
+      when ActiveFedora::Base
+        call_af(work, user, reset)
+      when Valkyrie::Resource
+        call_valkyrie(work, user, reset)
+      end
+    end
+
+    def self.call_af(work, user, reset)
       work.proxy_depositor = work.depositor
       work.permissions = [] if reset
       work.apply_depositor_metadata(user)
@@ -14,5 +24,27 @@ module Hyrax
       work.save!
       work
     end
+    private_class_method :call_af
+
+    def self.call_valkyrie(work, user, reset)
+      if reset
+        work.permission_manager.acl.permissions = []
+        work.permission_manager.acl.save
+      end
+      work.proxy_depositor = work.depositor
+      apply_depositor_metadata(work, user)
+      work.file_sets.each do |f|
+        apply_depositor_metadata(f, user)
+      end
+      work
+    end
+    private_class_method :call_valkyrie
+
+    def self.apply_depositor_metadata(resource, depositor)
+      depositor_id = depositor.respond_to?(:user_key) ? depositor.user_key : depositor
+      resource.depositor = depositor_id if resource.respond_to? :depositor
+      Hyrax::AccessControlList.new(resource: resource).grant(:edit).to(::User.find_by_user_key(depositor_id)).save
+    end
+    private_class_method :apply_depositor_metadata
   end
 end