hyrax 3.0.0.pre.beta2 → 3.0.0.pre.beta3

data/app/search_builders/hyrax/my/highlights_search_builder.rb

@@ -7,8 +7,6 @@ class Hyrax::My::HighlightsSearchBuilder < Hyrax::SearchBuilder
   def show_only_highlighted_works(solr_parameters)
     ids = scope.current_user.trophies.pluck(:work_id)
     solr_parameters[:fq] ||= []
-    solr_parameters[:fq] += [
-      ActiveFedora::SolrQueryBuilder.construct_query_for_ids(ids)
-    ]
+    solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query_for_ids([ids])]
   end
 end

data/app/search_builders/hyrax/nested_collections_parent_search_builder.rb

@@ -15,7 +15,7 @@ module Hyrax
     # Filters the query to only include the parent collections
     def parent_collections_only(solr_parameters)
       solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << ActiveFedora::SolrQueryBuilder.construct_query_for_ids(child.member_of_collection_ids)
+      solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query_for_ids(child.member_of_collection_ids)]
     end
     self.default_processor_chain += [:parent_collections_only]
 

data/app/search_builders/hyrax/parent_collection_search_builder.rb

@@ -6,7 +6,7 @@ module Hyrax
     # include filters into the query to only include the collections containing this item
     def include_item_ids(solr_parameters)
       solr_parameters[:fq] ||= []
-      solr_parameters[:fq] << ActiveFedora::SolrQueryBuilder.construct_query_for_ids(item.member_of_collection_ids)
+      solr_parameters[:fq] += [Hyrax::SolrQueryBuilderService.construct_query_for_ids([item.member_of_collection_ids])]
     end
   end
 end

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

@@ -57,7 +57,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
@@ -97,7 +97,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 +131,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 +157,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_service.rb

@@ -30,12 +30,8 @@ module Hyrax
       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|
@@ -57,11 +53,7 @@ module Hyrax
         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_results = Hyrax::SolrService.get(fq: [query, "has_model_ssim:FileSet"], rows: 0)
           file_counts[admin_set.id] = file_results['response']['numFound']
         end
         file_counts

data/app/services/hyrax/analytics.rb

@@ -5,11 +5,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 +19,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/collection_types/permissions_service.rb

@@ -13,7 +13,7 @@ module Hyrax
       #   If calling from Abilities, pass the ability.  If you try to get the ability from the user, you end up in an infinit loop.
       def self.collection_type_ids_for_user(roles:, user: nil, ability: nil)
         return false unless user.present? || ability.present?
-        return Hyrax::CollectionType.all.pluck('DISTINCT id') if user_admin?(user, ability)
+        return Hyrax::CollectionType.all.pluck(Arel.sql('DISTINCT id')) if user_admin?(user, ability)
         Hyrax::CollectionTypeParticipant.where(agent_type: Hyrax::CollectionTypeParticipant::USER_TYPE,
                                                agent_id: user_id(user, ability),
                                                access: roles)
@@ -21,7 +21,7 @@ module Hyrax
                                           Hyrax::CollectionTypeParticipant.where(agent_type: Hyrax::CollectionTypeParticipant::GROUP_TYPE,
                                                                                  agent_id: user_groups(user, ability),
                                                                                  access: roles)
-                                        ).pluck('DISTINCT hyrax_collection_type_id')
+                                        ).pluck(Arel.sql('DISTINCT hyrax_collection_type_id'))
       end
 
       # @api public
@@ -174,7 +174,7 @@ module Hyrax
       def self.agent_ids_for(collection_type:, agent_type:, access:)
         Hyrax::CollectionTypeParticipant.where(hyrax_collection_type_id: collection_type.id,
                                                agent_type: agent_type,
-                                               access: access).pluck('DISTINCT agent_id')
+                                               access: access).pluck(Arel.sql('DISTINCT agent_id'))
       end
       private_class_method :agent_ids_for
 
@@ -190,7 +190,7 @@ module Hyrax
         return [] unless collection_type
         Hyrax::CollectionTypeParticipant.joins(:hyrax_collection_type).where(hyrax_collection_type_id: collection_type.id,
                                                                              agent_type: Hyrax::CollectionTypeParticipant::USER_TYPE,
-                                                                             access: Hyrax::CollectionTypeParticipant::MANAGE_ACCESS).pluck('DISTINCT agent_id')
+                                                                             access: Hyrax::CollectionTypeParticipant::MANAGE_ACCESS).pluck(Arel.sql('DISTINCT agent_id'))
       end
 
       # @api public
@@ -205,7 +205,7 @@ module Hyrax
         return [] unless collection_type
         groups = Hyrax::CollectionTypeParticipant.joins(:hyrax_collection_type).where(hyrax_collection_type_id: collection_type.id,
                                                                                       agent_type: Hyrax::CollectionTypeParticipant::GROUP_TYPE,
-                                                                                      access: Hyrax::CollectionTypeParticipant::MANAGE_ACCESS).pluck('DISTINCT agent_id')
+                                                                                      access: Hyrax::CollectionTypeParticipant::MANAGE_ACCESS).pluck(Arel.sql('DISTINCT agent_id'))
         groups | ['admin']
       end
 

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

@@ -13,7 +13,7 @@ module Hyrax
       def self.source_ids_for_user(access:, ability:, source_type: nil, exclude_groups: [])
         scope = PermissionTemplateAccess.for_user(ability: ability, access: access, exclude_groups: exclude_groups)
                                         .joins(:permission_template)
-        ids = scope.pluck('DISTINCT source_id')
+        ids = scope.pluck(Arel.sql('DISTINCT source_id'))
         return ids unless source_type
         filter_source(source_type: source_type, ids: ids)
       end
@@ -29,7 +29,7 @@ module Hyrax
                   "_query_:\"{!raw f=has_model_ssim}Collection\""
                 end
         query += " AND #{id_clause}"
-        ActiveFedora::SolrService.query(query, fl: 'id', rows: ids.count).map { |hit| hit['id'] }
+        Hyrax::SolrService.query(query, fl: 'id', rows: ids.count).map { |hit| hit['id'] }
       end
       private_class_method :filter_source
 

data/app/services/hyrax/custom_queries/navigators/child_collections_navigator.rb

@@ -0,0 +1,39 @@
+# Navigate from a resource to the child collections in the resource.
+module Hyrax
+  module CustomQueries
+    module Navigators
+      class ChildCollectionsNavigator
+        # Define the queries that can be fulfilled by this navigator.
+        def self.queries
+          [:find_child_collections, :find_child_collection_ids]
+        end
+
+        attr_reader :query_service
+
+        def initialize(query_service:)
+          @query_service = query_service
+        end
+
+        # Find child collections of a given resource, and map to Valkyrie Resources
+        # @param [Valkyrie::Resource]
+        # @return [Array<Valkyrie::Resource>]
+        # TODO: By storing all children in a single relationship, it requires that the full resource be constructed for all children
+        #       and then selecting only the children of a particular type to return.
+        def find_child_collections(resource:)
+          query_service.find_inverse_references_by(resource: resource, property: :member_of_collection_ids).select(&:collection?)
+        end
+
+        # Find the ids of child collections of a given resource, and map to Valkyrie Resources
+        # @param [Valkyrie::Resource]
+        # @return [Array<Valkyrie::ID>]
+        # TODO: By storing all children in a single relationship, it requires that the full resource be constructed for all children
+        #       and then selecting only the children of a particular type.  If we stored collections in a collections relationship and
+        #       works in a works relationship, then a request for IDs would return all ids from the relationship and not instantiate
+        #       any resources.
+        def find_child_collection_ids(resource:)
+          find_child_collections(resource: resource).map(&:id)
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/custom_queries/navigators/child_filesets_navigator.rb

@@ -0,0 +1,39 @@
+# Navigate from a resource to the child filesets in the resource.
+module Hyrax
+  module CustomQueries
+    module Navigators
+      class ChildFilesetsNavigator
+        # Define the queries that can be fulfilled by this navigator.
+        def self.queries
+          [:find_child_filesets, :find_child_fileset_ids]
+        end
+
+        attr_reader :query_service
+
+        def initialize(query_service:)
+          @query_service = query_service
+        end
+
+        # Find child filesets of a given resource, and map to Valkyrie Resources
+        # @param [Valkyrie::Resource]
+        # @return [Array<Valkyrie::Resource>]
+        # TODO: By storing all children in a single relationship, it requires that the full resource be constructed for all children
+        #       and then selecting only the children of a particular type to return.
+        def find_child_filesets(resource:)
+          query_service.find_members(resource: resource).select(&:file_set?)
+        end
+
+        # Find the ids of child filesets of a given resource, and map to Valkyrie Resources
+        # @param [Valkyrie::Resource]
+        # @return [Array<Valkyrie::ID>]
+        # TODO: By storing all children in a single relationship, it requires that the full resource be constructed for all children
+        #       and then selecting only the children of a particular type.  If we stored works in a works relationship and filesets
+        #       in a filesets relationship, then a request for IDs would return all ids from the relationship and not instantiate
+        #       any resources.
+        def find_child_fileset_ids(resource:)
+          find_child_filesets(resource: resource).map(&:id)
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/custom_queries/navigators/child_works_navigator.rb

@@ -0,0 +1,39 @@
+# Navigate from a resource to the child works in the resource.
+module Hyrax
+  module CustomQueries
+    module Navigators
+      class ChildWorksNavigator
+        # Define the queries that can be fulfilled by this navigator.
+        def self.queries
+          [:find_child_works, :find_child_work_ids]
+        end
+
+        attr_reader :query_service
+
+        def initialize(query_service:)
+          @query_service = query_service
+        end
+
+        # Find child works of a given resource, and map to Valkyrie Resources
+        # @param [Valkyrie::Resource]
+        # @return [Array<Valkyrie::Resource>]
+        # TODO: By storing all children in a single relationship, it requires that the full resource be constructed for all children
+        #       and then selecting only the children of a particular type to return.
+        def find_child_works(resource:)
+          query_service.find_members(resource: resource).select(&:work?)
+        end
+
+        # Find the ids of child works of a given resource, and map to Valkyrie Resources
+        # @param [Valkyrie::Resource]
+        # @return [Array<Valkyrie::ID>]
+        # TODO: By storing all children in a single relationship, it requires that the full resource be constructed for all children
+        #       and then selecting only the children of a particular type.  If we stored works in a works relationship and filesets
+        #       in a filesets relationship, then a request for IDs would return all ids from the relationship and not instantiate
+        #       any resources.
+        def find_child_work_ids(resource:)
+          find_child_works(resource: resource).map(&:id)
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/custom_queries/wings.rb

@@ -0,0 +1,34 @@
+module Hyrax
+  module CustomQueries
+    class Wings
+      # Holds custom queries for wings
+      # Use:
+      # Hyrax.query_service.custom_queries.find_many_by_alternate_ids(alternate_ids: ids, use_valkyrie: true)
+
+      def self.queries
+        [:find_many_by_alternate_ids]
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      # implements a combination of two Valkyrie queries:
+      # => find_many_by_ids & find_by_alternate_identifier
+      # @param [Enumerator<#to_s>] ids
+      # @param [boolean] defaults to true; optionally return ActiveFedora::Base objects if false
+      # @return [Array<Valkyrie::Resource>, Array<ActiveFedora::Base>]
+      def find_many_by_alternate_ids(alternate_ids:, use_valkyrie: true)
+        af_objects = ActiveFedora::Base.find(alternate_ids.map(&:to_s))
+        return af_objects unless use_valkyrie == true
+
+        af_objects.map do |af_object|
+          resource_factory.to_resource(object: af_object)
+        end
+      end
+    end
+  end
+end

data/app/services/hyrax/database_migrator.rb

@@ -1,3 +1,4 @@
+require 'rails/generators/actions'
 require 'rails/generators/active_record'
 
 module Hyrax

data/app/services/hyrax/derivative_path.rb

@@ -20,7 +20,7 @@ module Hyrax
     # @param [ActiveFedora::Base, String] object either the AF object or its id
     # @param [String] destination_name
     def initialize(object, destination_name = nil)
-      @id = object.is_a?(String) ? object : object.id
+      @id = object.is_a?(String) ? object : object.id.to_s
       @destination_name = destination_name.gsub(/^original_file_/, '') if destination_name
     end
 

data/app/services/hyrax/embargo_manager.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Provides utilities for managing the lifecycle of an `Hyrax::Embargo` on a
+  # `Hyrax::Resource`.
+  #
+  # This can do things like
+  #
+  # @example check whether a resource is under an active embargo
+  #   manager = EmbargoManager.new(resource: my_resource)
+  #   manager.under_embargo? # => false
+  #
+  # @example applying an embargo
+  #   embargo = Hyrax::Embargo.new(visibility_during_embargo: 'restricted',
+  #                                visibility_after_embargo:  'open',
+  #                                embargo_release_date:      Time.zone.today + 1000)
+  #
+  #   resource            = Hyrax::Resource.new(embargo: embargo)
+  #   resource.visibility = 'open'
+  #
+  #   manager = EmbargoManager.new(resource: resource)
+  #
+  #   manager.apply
+  #   resource.visibility # => 'restricted'
+  #
+  class EmbargoManager
+    ##
+    # @!attribute [rw] resource
+    #   @return [Hyrax::Resource]
+    attr_accessor :resource
+
+    ##
+    # @!attribute [r] query_service
+    #   @return [#find_by]
+    attr_reader :query_service
+
+    ##
+    # @param resource [Hyrax::Resource]
+    def initialize(resource:, query_service: Hyrax.query_service)
+      @query_service = query_service
+      self.resource  = resource
+    end
+
+    class << self
+      def apply_embargo_for(resource:, query_service: Hyrax.query_service)
+        new(resource: resource, query_service: query_service)
+          .apply
+      end
+
+      def embargo_for(resource:, query_service: Hyrax.query_service)
+        new(resource: resource, query_service: query_service)
+          .embargo
+      end
+    end
+
+    ##
+    # Copies and applies the embargo to a new (target) resource.
+    #
+    # @param target [Hyrax::Resource]
+    #
+    # @return [Boolean]
+    def copy_embargo_to(target:)
+      return false unless under_embargo?
+
+      target.embargo = Embargo.new(clone_attributes)
+      self.class.apply_embargo_for(resource: target)
+    end
+
+    ##
+    # @return [Boolean]
+    def apply
+      return false unless under_embargo?
+
+      resource.visibility = embargo.visibility_during_embargo
+    end
+
+    ##
+    # @return [Valkyrie::Resource]
+    def embargo
+      resource.embargo || Embargo.new
+    end
+
+    ##
+    # @return [Boolean]
+    def under_embargo?
+      embargo.active?
+    end
+
+    private
+
+      def clone_attributes
+        embargo.attributes.slice(*core_attribute_keys)
+      end
+
+      def core_attribute_keys
+        [:visibility_after_embargo, :visibility_during_embargo, :embargo_release_date]
+      end
+  end
+end