hyrax 5.0.1 → 5.0.3

data/app/models/concerns/hyrax/valkyrie_lazy_migration.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # This mixin is for {Valkyrie::Resource} objects to be able to read/write the same Solr document
+  # as their corresponding {ActiveFedora::Base} object.
+  #
+  # @see https://github.com/samvera/hyrax/pull/6221 Discussion about having one indexed document
+  module ValkyrieLazyMigration
+    ##
+    # Copy over even more of the {Wings::ModelRegistery} legacy model's model_name properties
+    #
+    # @note When we remove {Wings}, the downstream implementers will need to explicitly craft the
+    #       properties of the model_name.
+    class ResourceName < ResourceName
+      def initialize(klass, *args)
+        super
+
+        legacy_model = Wings::ModelRegistry.lookup(klass)
+        return unless legacy_model
+
+        instance_variables.each do |ivar|
+          next if ivar == :@name
+          next if ivar == :@klass
+          instance_variable_set(ivar, legacy_model.model_name.send(ivar[1..-1]))
+        end
+      end
+      attr_reader :klass
+    end
+
+    ##
+    # This function helps configuration a work for a valkyrie migration; namely by helping re-use
+    # an existing SOLR document, by specifying that the given :klass is a migration :from another
+    # class.
+    #
+    # @note This is similar to the {Wings::ModelRegistry.register}, but is envisioned as part of
+    # the Frigg and Freyja adapters for Postges and Fedora lazy migrations.
+    #
+    # @param klass [Hyrax::Resource, .attribute]
+    # @param from [ActiveFedora::Base, .to_rdf_representation]
+    # @param name_class [Hyrax::Name] responsible, in part, for determining the various routing
+    #        paths you might use.
+    #
+    # @example
+    #   class MyWork < ActiveFedora::Base
+    #   end
+    #
+    #   class MyWorkResource < Hyrax::Resource
+    #     Hyrax::ValkyrieLazyMigration.migrating(self, from: MyWork)
+    #   end
+    def self.migrating(klass, from:, name_class: Hyrax::ValkyrieLazyMigration::ResourceName)
+      Wings::ModelRegistry.register(klass, from)
+      from.singleton_class.define_method(:migrating_from) { from }
+      from.singleton_class.define_method(:migrating_to) { klass }
+      klass.singleton_class.define_method(:migrating_from) { from }
+      klass.singleton_class.define_method(:migrating_to) { klass }
+      klass.singleton_class.define_method(:_hyrax_default_name_class) { name_class }
+      klass.singleton_class.define_method(:to_rdf_representation) { migrating_from.to_rdf_representation }
+
+      klass.include(self)
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :internal_resource, Valkyrie::Types::Any.default(to_rdf_representation.freeze), internal: true
+    end
+
+    def members
+      return @members if @members.present?
+      @members = member_ids.map do |id|
+        Hyrax.query_service.find_by(id: id)
+      rescue Valkyrie::Persistence::ObjectNotFoundError
+        Rails.logger.warn("Could not find member #{id} for #{self.id}")
+      end
+    end
+
+    def to_solr
+      Hyrax::ValkyrieIndexer.for(resource: self).to_solr
+    end
+  end
+end

data/app/models/file_download_stat.rb

@@ -21,7 +21,7 @@ class FileDownloadStat < Hyrax::Statistic
 
     # this is called by the parent class
     def filter(file)
-      { file_id: file.id }
+      { file_id: file.id.to_s }
     end
   end
 end

data/app/models/file_view_stat.rb

@@ -6,7 +6,7 @@ class FileViewStat < Hyrax::Statistic
   class << self
     # this is called by the parent class
     def filter(file)
-      { file_id: file.id }
+      { file_id: file.id.to_s }
     end
   end
 end

data/app/models/hyrax/collection_type.rb

@@ -100,12 +100,20 @@ module Hyrax
 
     ##
     # @return [Enumerable<Collection, PcdmCollection>]
-    def collections(use_valkyrie: Hyrax.config.use_valkyrie?)
+    def collections(use_valkyrie: Hyrax.config.use_valkyrie?, model: Hyrax.config.collection_class)
       return [] unless id
-      return Hyrax.custom_queries.find_collections_by_type(global_id: to_global_id.to_s) if use_valkyrie
+      return Hyrax.custom_queries.find_collections_by_type(global_id: to_global_id.to_s, model:) if use_valkyrie
       ActiveFedora::Base.where(Hyrax.config.collection_type_index_field.to_sym => to_global_id.to_s)
     end
 
+    # Query solr to see if any collections of this type exist
+    # This should be much more performant for certain adapters than calling collections.any?
+    # @return [Boolean] True if there are any collections of this collection type in the repository
+    def collections?
+      return false unless id
+      Hyrax::SolrQueryService.new.with_field_pairs(field_pairs: { Hyrax.config.collection_type_index_field.to_sym => to_global_id.to_s }).with_model(model: Hyrax.config.collection_class.to_rdf_representation).count > 0
+    end
+
     # @return [Boolean] True if this is the Admin Set type
     def admin_set?
       machine_id == ADMIN_SET_MACHINE_ID
@@ -154,7 +162,7 @@ module Hyrax
     end
 
     def ensure_no_collections
-      return true unless collections.any?
+      return true unless collections?
       errors[:base] << I18n.t('hyrax.admin.collection_types.errors.not_empty')
       throw :abort
     end
@@ -172,7 +180,7 @@ module Hyrax
     end
 
     def ensure_no_settings_changes_if_collections_exist
-      return true unless collections.any?
+      return true unless collections?
       return true unless collection_type_settings_changed?
       errors[:base] << I18n.t('hyrax.admin.collection_types.errors.no_settings_change_if_not_empty')
       throw :abort

data/app/models/hyrax/file_metadata.rb

@@ -42,6 +42,18 @@ module Hyrax
 
       THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage # for compatibility with earlier versions of Hyrax; prefer +THUMBNAIL_IMAGE+
 
+      # @return [Array<RDF::URI>] list of all uses
+      def use_list
+        [ORIGINAL_FILE,
+         THUMBNAIL_IMAGE,
+         EXTRACTED_TEXT,
+         INTERMEDIATE_FILE,
+         PRESERVATION_FILE,
+         SERVICE_FILE,
+         TRANSCRIPT]
+      end
+      module_function :use_list
+
       ##
       # @param use [RDF::URI, Symbol]
       #
@@ -166,6 +178,13 @@ module Hyrax
       pcdm_use.include?(Use::EXTRACTED_TEXT)
     end
 
+    ##
+    # Filters out uses not recognized by Hyrax (e.g. http://fedora.info/definitions/v4/repository#Binary)
+    # @return [Array]
+    def filtered_pcdm_use
+      pcdm_use.select { |use| Use.use_list.include?(use) }
+    end
+
     ##
     # @return [String]
     def to_rdf_representation

data/app/models/hyrax/file_set.rb

@@ -106,6 +106,31 @@ module Hyrax
       extracted_text&.id
     end
 
+    ##
+    # @return [Array] All ids, extensions, mime types, names, and uses
+    # @example
+    #   [{:id=>"123", :extension=>"pdf", :mime_type=>"application/pdf", :name=>nil, :use=>"OriginalFile"},
+    #    {:id=>"234", :extension=>"jpeg", :mime_type=>"application/octet-stream", :name=>"thumbnail", :use=>"ThumbnailImage"}]
+    # rubocop:disable Metrics/MethodLength
+    def extensions_and_mime_types
+      return [] if file_ids.empty?
+      Hyrax.custom_queries.find_files(file_set: self).each_with_object([]) do |fm, arr|
+        next unless fm.original_filename
+        extension = File.extname(fm.original_filename)
+        next if extension.empty?
+        use = fm.filtered_pcdm_use.first.to_s.split("#").last
+        name = use == 'OriginalFile' ? nil : File.basename(fm.original_filename, extension).split('-').last
+        arr << {
+          id: fm.id.to_s,
+          extension: extension[1..], # remove leading '.'
+          mime_type: fm.mime_type,
+          name: name,
+          use: use
+        }
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+
     ##
     # @return [Valkyrie::ID]
     def representative_id

data/app/models/hyrax/model_registry.rb

@@ -85,7 +85,8 @@ module Hyrax
     #
     # @todo Consider the Wings::ModelRegistry and how we perform mappings.
     def self.work_class_names
-      Hyrax.config.registered_curation_concern_types
+      @work_class_names ||= (Hyrax.config.registered_curation_concern_types +
+        Array(Rails.application.class.try(:work_types))).map(&:to_s).uniq
     end
 
     def self.work_classes
@@ -101,11 +102,9 @@ module Hyrax
     def self.classes_from(strings)
       strings.map(&:safe_constantize).compact.uniq
     end
-    private_class_method :classes_from
 
     def self.rdf_representations_from(klasses)
       klasses.map { |klass| klass.respond_to?(:to_rdf_representation) ? klass.to_rdf_representation : klass.name }.uniq
     end
-    private_class_method :rdf_representations_from
   end
 end

data/app/models/hyrax/resource.rb

@@ -149,6 +149,11 @@ module Hyrax
       self.class.work?
     end
 
+    # Its nice to know if a record is still in AF or not
+    def wings?
+      respond_to?(:head) && respond_to?(:tail)
+    end
+
     def ==(other)
       attributes.except(:created_at, :updated_at) == other.attributes.except(:created_at, :updated_at) if other.respond_to?(:attributes)
     end

data/app/models/hyrax/statistic.rb

@@ -25,47 +25,22 @@ module Hyrax
         combined_stats object, start_date, cache_column, event_type, user_id
       end
 
-      # Hyrax::Download is sent to Hyrax::Analytics.profile as #hyrax__download
-      # see Legato::ProfileMethods.method_name_from_klass
-      def ga_statistics(start_date, object)
-        path = polymorphic_path(object)
-        profile = Hyrax::Analytics.profile
-        unless profile
-          Hyrax.logger.error("Google Analytics profile has not been established. Unable to fetch statistics.")
-          return []
-        end
-        profile.hyrax__pageview(sort: 'date',
-                                start_date: start_date,
-                                end_date: Date.yesterday,
-                                limit: 10_000)
-               .for_path(path)
-      end
-
       def query_works(query)
-        models = Hyrax.config.curation_concerns.map { |m| "\"#{m}\"" }
-        Hyrax::SolrService.query("has_model_ssim:(#{models.join(' OR ')})", fl: query, rows: 100_000)
+        models = Hyrax::ModelRegistry.work_rdf_representations.map { |m| "\"#{m}\"" }
+        response = Hyrax::SolrService.get(fq: "has_model_ssim:(#{models.join(' OR ')})", 'facet.field': query, 'facet.missing': true, rows: 0)
+        Hash[*response['facet_counts']['facet_fields'][query]]
       end
 
       def work_types
-        results = query_works("human_readable_type_tesim")
-        results.group_by { |result| result['human_readable_type_tesim'].join('') }.transform_values(&:count)
+        types = query_works("human_readable_type_sim")
+        types['Unknown'] = types.delete(nil)
+        types
       end
 
       def resource_types
-        results = query_works("resource_type_tesim")
-        resource_types = []
-        results.each do |y|
-          if y["resource_type_tesim"].nil? || (y["resource_type_tesim"] == [""])
-            resource_types.push("Unknown")
-          elsif y["resource_type_tesim"].count > 1
-            y["resource_type_tesim"].each do |t|
-              resource_types.push(t)
-            end
-          else
-            resource_types.push(y["resource_type_tesim"].join(""))
-          end
-        end
-        resource_types.group_by { |rt| rt }.transform_values(&:count)
+        types = query_works("resource_type_sim")
+        types['Unknown'] = types.delete(nil)
+        types
       end
 
       private
@@ -80,10 +55,10 @@ module Hyrax
         stat_cache_info = cached_stats(object, start_date, object_method)
         stats = stat_cache_info[:cached_stats]
         if stat_cache_info[:ga_start_date] < Time.zone.today
-          ga_stats = ga_statistics(stat_cache_info[:ga_start_date], object)
-          ga_stats.each do |stat|
+          page_stats = Hyrax::Analytics.page_statistics(stat_cache_info[:ga_start_date], object)
+          page_stats.each do |stat|
             lstat = build_for(object, date: stat[:date], object_method => stat[ga_key], user_id: user_id)
-            lstat.save unless Date.parse(stat[:date]) == Time.zone.today
+            lstat.save unless stat[:date].to_date == Time.zone.today
             stats << lstat
           end
         end

data/app/presenters/hyrax/file_set_presenter.rb

@@ -20,7 +20,8 @@ module Hyrax
 
     # CurationConcern methods
     delegate :stringify_keys, :human_readable_type, :collection?, :image?, :video?,
-             :audio?, :pdf?, :office_document?, :representative_id, :to_s, to: :solr_document
+             :audio?, :pdf?, :office_document?, :representative_id, :to_s,
+             :extensions_and_mime_types, to: :solr_document
 
     # Methods used by blacklight helpers
     delegate :has?, :first, :fetch, to: :solr_document

data/app/presenters/hyrax/file_usage.rb

@@ -5,7 +5,7 @@ module Hyrax
   # and prepares it for visualization in /app/views/stats/file.html.erb
   class FileUsage < StatsUsagePresenter
     def initialize(id)
-      self.model = ::FileSet.find(id)
+      self.model = Hyrax.query_service.find_by(id: id)
     end
 
     alias file model
@@ -29,11 +29,11 @@ module Hyrax
     private
 
     def downloads
-      to_flots(FileDownloadStat.statistics(model, created, user_id))
+      @downloads ||= to_flots(FileDownloadStat.statistics(model, created, user_id))
     end
 
     def pageviews
-      to_flots(FileViewStat.statistics(model, created, user_id))
+      @pageviews ||= to_flots(FileViewStat.statistics(model, created, user_id))
     end
   end
 end

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -56,7 +56,8 @@ module Hyrax
     ##
     # @return [Boolean]
     def file_set?
-      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet') || Array(model[:has_model_ssim]).include?('Hyrax::FileSet')
+      return true if model.try(:file_set?)
+      (Array(model[:has_model_ssim]) & Hyrax::ModelRegistry.file_set_rdf_representations).any?
     end
 
     ##

data/app/presenters/hyrax/member_presenter_factory.rb

@@ -47,7 +47,9 @@ module Hyrax
     # in order.
     # Arbitrarily maxed at 10 thousand; had to specify rows due to solr's default of 10
     def file_set_ids
-      @file_set_ids ||= Hyrax::SolrService.query("{!field f=has_model_ssim}FileSet",
+      pairs = file_set_models.map { |model| ["has_model_ssim", model] }
+      query = Hyrax::SolrQueryBuilderService.construct_query(pairs, "OR")
+      @file_set_ids ||= Hyrax::SolrService.query(query,
                                                    rows: 10_000,
                                                    fl: Hyrax.config.id_field,
                                                    fq: "{!join from=ordered_targets_ssim to=id}id:\"#{id}/list_source\"")
@@ -61,5 +63,9 @@ module Hyrax
     def composite_presenter_class
       CompositePresenterFactory.new(file_presenter_class, work_presenter_class, ordered_ids & file_set_ids)
     end
+
+    def file_set_models
+      Hyrax::ModelRegistry.file_set_rdf_representations
+    end
   end
 end

data/app/presenters/hyrax/menu_presenter.rb

@@ -33,7 +33,7 @@ module Hyrax
     def nav_link(options, also_active_for: nil, **link_html_options)
       active_urls = [options, also_active_for].compact
       list_options = active_urls.any? { |url| current_page?(url) } ? { class: 'active nav-item' } : { class: 'nav-item' }
-      tag.li(list_options) do
+      tag.li(**list_options) do
         link_to(options, link_html_options) do
           yield
         end

data/app/presenters/hyrax/stats_usage_presenter.rb

@@ -30,12 +30,13 @@ module Hyrax
     def date_for_analytics
       earliest = Hyrax.config.analytic_start_date
       date_uploaded = string_to_date(model.date_uploaded)
-      date_analytics = date_uploaded ? date_uploaded : model.create_date
+      date_analytics = date_uploaded ? date_uploaded : (model.create_date || model.created_at)
       return date_analytics if earliest.blank?
       earliest > date_analytics ? earliest : date_analytics
     end
 
     def string_to_date(date_str)
+      return date_str if date_str.is_a?(Date)
       Time.zone.parse(date_str)
     rescue ArgumentError, TypeError
       nil

data/app/presenters/hyrax/work_show_presenter.rb

@@ -16,13 +16,6 @@ module Hyrax
     self.collection_presenter_class = CollectionPresenter
     self.presenter_factory_class = MemberPresenterFactory
 
-    # Methods used by blacklight helpers
-    delegate :has?, :first, :fetch, :export_formats, :export_as, to: :solr_document
-
-    # delegate fields from Hyrax::Works::Metadata to solr_document
-    delegate :based_near_label, :related_url, :depositor, :identifier, :resource_type,
-             :keyword, :itemtype, :admin_set, :rights_notes, :access_right, :abstract, to: :solr_document
-
     # @param [SolrDocument] solr_document
     # @param [Ability] current_ability
     # @param [ActionDispatch::Request] request the http request context. Used so
@@ -33,20 +26,14 @@ module Hyrax
       @request = request
     end
 
+    # We cannot rely on the method missing to catch this delegation.  Because
+    # most all objects implicitly implicitly implement #to_s
+    delegate :to_s, to: :solr_document
+
     def page_title
       "#{human_readable_type} | #{title.first} | ID: #{id} | #{I18n.t('hyrax.product_name')}"
     end
 
-    # CurationConcern methods
-    delegate :stringify_keys, :human_readable_type, :collection?, :to_s, :suppressed?,
-             to: :solr_document
-
-    # Metadata Methods
-    delegate :title, :date_created, :description,
-             :creator, :contributor, :subject, :publisher, :language, :embargo_release_date,
-             :lease_expiration_date, :license, :source, :rights_statement, :thumbnail_id, :representative_id,
-             :rendering_ids, :member_of_collection_ids, :alternative_title, :bibliographic_citation, to: :solr_document
-
     def workflow
       @workflow ||= WorkflowPresenter.new(solr_document, current_ability)
     end
@@ -259,6 +246,15 @@ module Hyrax
 
     private
 
+    def method_missing(method_name, *args, &block)
+      return solr_document.public_send(method_name, *args, &block) if solr_document.respond_to?(method_name)
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      solr_document.respond_to?(method_name, include_private) || super
+    end
+
     # list of item ids to display is based on ordered_ids
     def authorized_item_ids(filter_unreadable: Flipflop.hide_private_items?)
       @member_item_list_ids ||=

data/app/presenters/hyrax/work_usage.rb

@@ -8,11 +8,14 @@ module Hyrax
   # and prepares it for visualization in /app/views/stats/work.html.erb
   class WorkUsage < StatsUsagePresenter
     def initialize(id)
-      self.model = Hyrax::WorkRelation.new.find(id)
+      self.model = Hyrax.query_service.find_by(id: id)
     end
 
     alias work model
-    delegate :to_s, to: :model
+
+    def to_s
+      model.title.first
+    end
 
     def total_pageviews
       pageviews.reduce(0) { |total, result| total + result[1].to_i }

data/app/search_builders/hyrax/expired_embargo_search_builder.rb

@@ -6,7 +6,13 @@ module Hyrax
 
     def only_expired_embargoes(solr_params)
       solr_params[:fq] ||= []
-      solr_params[:fq] = 'embargo_release_date_dtsi:[* TO NOW]'
+      solr_params[:fq] = "embargo_release_date_dtsi:[* TO #{now}]"
+    end
+
+    private
+
+    def now
+      Hyrax::TimeService.time_in_utc.utc.xmlschema
     end
   end
 end

data/app/search_builders/hyrax/expired_lease_search_builder.rb

@@ -6,7 +6,13 @@ module Hyrax
 
     def only_expired_leases(solr_params)
       solr_params[:fq] ||= []
-      solr_params[:fq] = 'lease_expiration_date_dtsi:[* TO NOW]'
+      solr_params[:fq] = "lease_expiration_date_dtsi:[* TO #{now}]"
+    end
+
+    private
+
+    def now
+      Hyrax::TimeService.time_in_utc.utc.xmlschema
     end
   end
 end

data/app/search_builders/hyrax/filter_by_type.rb

@@ -30,9 +30,7 @@ module Hyrax
     end
 
     def models_to_solr_clause
-      models.map do |model|
-        model.respond_to?(:to_rdf_representation) ? model.to_rdf_representation : model.name
-      end.join(',')
+      Hyrax::ModelRegistry.rdf_representations_from(models).join(',')
     end
 
     def generic_type_field

data/app/search_builders/hyrax/valkyrie_abstract_type_relation.rb

@@ -19,8 +19,13 @@ module Hyrax
       Hyrax.query_service.custom_queries.find_count_by(models: allowable_types)
     end
 
-    def where(hash)
-      Hyrax.query_service.find_references_by(resource: hash.values.first, property: hash.keys.first)
+    def where(hash_or_string)
+      case hash_or_string
+      when String
+        Hyrax::SolrService.query(hash_or_string)
+      else
+        Hyrax.query_service.find_references_by(resource: hash_or_string.values.first, property: hash_or_string.keys.first)
+      end
     end
 
     def ==(other)

data/app/services/hyrax/access_control_list.rb

@@ -136,7 +136,7 @@ module Hyrax
     #
     # @return [Boolean]
     def pending_changes?
-      change_set.changed?
+      !change_set.resource.persisted? || change_set.changed?
     end
 
     ##

data/app/services/hyrax/admin_set_create_service.rb

@@ -10,7 +10,7 @@ module Hyrax
   # @see Hyrax::PermissionTemplate
   # @see Sipity::Workflow
   class AdminSetCreateService # rubocop:disable Metrics/ClassLength
-    DEFAULT_ID = 'admin_set/default'
+    DEFAULT_ID = 'admin_set_default'
     DEFAULT_TITLE = ['Default Admin Set'].freeze
 
     class_attribute :permissions_create_service, :default_admin_set_persister
@@ -124,11 +124,22 @@ module Hyrax
       #       do not support hardcoded IDs (e.g. postgres)
       # @return [Hyrax::AdministrativeSet] the default admin set; nil if not found
       def find_unsaved_default_admin_set
-        admin_set = Hyrax.query_service.find_by(id: DEFAULT_ID)
-        default_admin_set_persister.update(default_admin_set_id: DEFAULT_ID) if save_default?
+        admin_set = begin
+                      # to support repositories still using the deprecated 'admin_set/default' as DEFAULT_ID
+                      Hyrax.query_service.find_by(id: 'admin_set/default')
+                    rescue Ldp::BadRequest, Valkyrie::Persistence::ObjectNotFoundError
+                      # Fedora 6.5+ does not support slashes in IDs, hence the need to rescue Ldp::BadRequest
+                      # if an admin set with deprecated ID 'admin_set/default' does not exist, check again for admin set with DEFAULT_ID
+                      begin
+                        Hyrax.query_service.find_by(id: DEFAULT_ID)
+                      rescue Valkyrie::Persistence::ObjectNotFoundError
+                        nil
+                      end
+                    end
+
+        default_admin_set_persister.update(default_admin_set_id: admin_set.id.to_s) if admin_set.present? && save_default?
+
         admin_set
-      rescue Valkyrie::Persistence::ObjectNotFoundError
-        # a default admin set hasn't been created yet
       end
 
       # @return [String | nil] the default admin set id; returns nil if not set

data/app/services/hyrax/admin_set_service.rb

@@ -51,9 +51,10 @@ module Hyrax
     # @return [Hash] admin set id keys and file count values
     def count_files(admin_sets)
       file_counts = Hash.new(0)
+      file_set_models = Hyrax::ModelRegistry.file_set_rdf_representations
       admin_sets.each do |admin_set|
         query = "{!join from=member_ids_ssim to=id}isPartOf_ssim:#{admin_set.id}"
-        file_results = Hyrax::SolrService.get(fq: [query, "{!terms f=has_model_ssim}FileSet,Hyrax::FileSet"], rows: 0)
+        file_results = Hyrax::SolrService.get(fq: [query, "{!terms f=has_model_ssim}#{file_set_models.join(',')}"], rows: 0)
         file_counts[admin_set.id] = file_results['response']['numFound']
       end
       file_counts