hyrax 5.0.0.rc2 → 5.0.0

data/app/models/hyrax/file_metadata.rb

@@ -32,26 +32,39 @@ module Hyrax
     # Constants for PCDM Use URIs; use these constants in place of hard-coded
     # URIs in the `::Valkyrie::Vocab::PCDMUse` vocabulary.
     module Use
-      ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
       EXTRACTED_TEXT = ::Valkyrie::Vocab::PCDMUse.ExtractedText
-      THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
+      INTERMEDIATE_FILE = ::Valkyrie::Vocab::PCDMUse.IntermediateFile
+      ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
+      PRESERVATION_FILE = ::Valkyrie::Vocab::PCDMUse.PreservationFile
       SERVICE_FILE = ::Valkyrie::Vocab::PCDMUse.ServiceFile
+      THUMBNAIL_IMAGE = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
+      TRANSCRIPT = ::Valkyrie::Vocab::PCDMUse.Transcript
+
+      THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage # for compatibility with earlier versions of Hyrax; prefer +THUMBNAIL_IMAGE+
 
       ##
       # @param use [RDF::URI, Symbol]
       #
       # @return [RDF::URI]
       # @raise [ArgumentError] if no use is known for the argument
-      def uri_for(use:)
+      def uri_for(use:) # rubocop:disable Metrics/MethodLength
         case use
         when RDF::URI
           use
-        when :original_file
-          ORIGINAL_FILE
         when :extracted_file
           EXTRACTED_TEXT
+        when :intermediate_file
+          INTERMEDIATE_FILE
+        when :original_file
+          ORIGINAL_FILE
+        when :preservation_file
+          PRESERVATION_FILE
+        when :service_file
+          SERVICE_FILE
         when :thumbnail_file
-          THUMBNAIL
+          THUMBNAIL_IMAGE
+        when :transcript_file
+          TRANSCRIPT
         else
           raise ArgumentError, "No PCDM use is recognized for #{use}"
         end
@@ -127,6 +140,14 @@ module Hyrax
     # attributes set by fits for video
     attribute :aspect_ratio, ::Valkyrie::Types::Set
 
+    class << self
+      ##
+      # @return [String]
+      def to_rdf_representation
+        name
+      end
+    end
+
     ##
     # @return [Boolean]
     def original_file?
@@ -136,7 +157,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def thumbnail_file?
-      pcdm_use.include?(Use::THUMBNAIL)
+      pcdm_use.include?(Use::THUMBNAIL_IMAGE)
     end
 
     ##
@@ -145,6 +166,12 @@ module Hyrax
       pcdm_use.include?(Use::EXTRACTED_TEXT)
     end
 
+    ##
+    # @return [String]
+    def to_rdf_representation
+      self.class.to_rdf_representation
+    end
+
     def title
       label
     end

data/app/models/hyrax/file_set.rb

@@ -114,13 +114,13 @@ module Hyrax
 
     ##
     # @return [Boolean] true
-    def pcdm_object?
+    def self.file_set?
       true
     end
 
     ##
     # @return [Boolean] true
-    def file_set?
+    def self.pcdm_object?
       true
     end
   end

data/app/models/hyrax/group.rb

@@ -1,49 +1,20 @@
 # frozen_string_literal: true
+
 module Hyrax
+  ##
+  # A Plain Old Ruby Object (PORO) representing a named group.
+  #
+  # In Hyku, we replace the PORO with an Application Record.  But there is significant duplication
+  # of logic.
+  #
+  # @see Hyrax::GroupBehavior
   class Group
-    DEFAULT_NAME_PREFIX = 'group/'
-
-    def self.name_prefix
-      DEFAULT_NAME_PREFIX
-    end
-
-    ##
-    # @return [Hyrax::Group]
-    def self.from_agent_key(key)
-      new(key.delete_prefix(name_prefix))
-    end
+    include Hyrax::GroupBehavior
 
     def initialize(name)
       @name = name
     end
 
     attr_reader :name
-
-    ##
-    # @return [Boolean]
-    def ==(other)
-      other.class == self.class && other.name == name
-    end
-
-    ##
-    # @return [String] a local identifier for this group; for use (e.g.) in ACL
-    #   data
-    def agent_key
-      self.class.name_prefix + name
-    end
-
-    def to_sipity_agent
-      sipity_agent || create_sipity_agent!
-    end
-
-    private
-
-    def sipity_agent
-      Sipity::Agent.find_by(proxy_for_id: name, proxy_for_type: self.class.name)
-    end
-
-    def create_sipity_agent!
-      Sipity::Agent.create!(proxy_for_id: name, proxy_for_type: self.class.name)
-    end
   end
 end

data/app/models/hyrax/group_behavior.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # An {ActiveSupport::Concern} module that contains the {Hyrax::Group} logic.  It is extracted to a
+  # behavior because downstream Hyku has a Hyrax::Group that inherits from ApplicationRecord.  In
+  # other words it eschews the plain old Ruby object (PORO).  However, both Hyku and Hyrax's
+  # {Hyrax::Group} both have notable amounts of duplicated logic.
+  #
+  # @see Hyrax::Group
+  module GroupBehavior
+    extend ActiveSupport::Concern
+
+    DEFAULT_NAME_PREFIX = 'group/'
+
+    class_methods do
+      ##
+      # @return [String]
+      # @see DEFAULT_NAME_PREFIX
+      def name_prefix
+        DEFAULT_NAME_PREFIX
+      end
+
+      ##
+      # @return [Hyrax::Group]
+      def from_agent_key(key)
+        new(key.delete_prefix(name_prefix))
+      end
+    end
+
+    ##
+    # @return [Boolean]
+    def ==(other)
+      other.class == self.class && other.name == name
+    end
+
+    ##
+    # @return [String] a local identifier for this group; for use (e.g.) in ACL
+    #   data
+    def agent_key
+      self.class.name_prefix + name
+    end
+
+    def to_sipity_agent
+      sipity_agent || create_sipity_agent!
+    end
+
+    private
+
+    def sipity_agent
+      Sipity::Agent.find_by(proxy_for_id: name, proxy_for_type: self.class.name)
+    end
+
+    def create_sipity_agent!
+      Sipity::Agent.create!(proxy_for_id: name, proxy_for_type: self.class.name)
+    end
+  end
+end

data/app/models/hyrax/model_registry.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # There are four conceptual high-level models for the metadata modeling:
+  #
+  # - AdminSet :: Where things are "physically" stored.
+  # - Collection :: What things "logically" belong to.
+  # - Work :: What the thing is about; these are often sub-divided into different work types
+  #   (e.g. an Article, a Monograph, etc.)
+  # - FileSet :: Artifacts that further describe the thing.
+  #
+  # The purpose of this module is to provide an overview and map of the modeling concepts.  This is
+  # envisioned as a module to interrogate to see how Hyrax conceptually organizes your models.
+  #
+  # For each of the above high-level models the {Hyrax::ModelRegistry} implements two methods:
+  #
+  # - <model_type>_classes :: These are the Ruby constants that represent the conceptual models.
+  # - <model_type>_rdf_representations :: These are the stored strings that help us describe what #
+  # - the data models.  Very useful in our Solr queries when we want to filter/query on the
+  # - "has_model_ssim" attribute.
+  #
+  # Consider that an {AdminSet} and a {Hyrax::AdministrativeSet} conceptually model the same thing;
+  # the latter implements via Valkyrie and the former via ActiveFedora.
+  #
+  # @note Due to the shift from ActiveFedora to Valkyrie, we are at a crossroads where we might have
+  # multiple models for the versions: an ActiveFedora AdminSet and a Valkyrie AdminSet.
+  class ModelRegistry
+    ##
+    # @return [Array<String>]
+    def self.admin_set_class_names
+      ["::AdminSet", "::Hyrax::AdministrativeSet", Hyrax.config.admin_set_model].uniq
+    end
+
+    ##
+    # @return [Array<Class>]
+    def self.admin_set_classes
+      classes_from(admin_set_class_names)
+    end
+
+    ##
+    # @return [Array<String>]
+    def self.admin_set_rdf_representations
+      rdf_representations_from(admin_set_classes)
+    end
+
+    ##
+    # @return [Array<String>]
+    def self.collection_class_names
+      ["::Collection", "::Hyrax::PcdmCollection", Hyrax.config.collection_model].uniq
+    end
+
+    ##
+    # @return [Array<String>]
+    def self.collection_classes
+      classes_from(collection_class_names)
+    end
+
+    def self.collection_rdf_representations
+      rdf_representations_from(collection_classes)
+    end
+
+    def self.collection_has_model_ssim
+      collection_rdf_representations
+    end
+
+    ##
+    # @return [Array<String>]
+    def self.file_set_class_names
+      ["::FileSet", "::Hyrax::FileSet", Hyrax.config.file_set_model].uniq
+    end
+
+    def self.file_set_classes
+      classes_from(file_set_class_names)
+    end
+
+    ##
+    # @return [Array<String>]
+    def self.file_set_rdf_representations
+      rdf_representations_from(file_set_classes)
+    end
+
+    ##
+    # @return [Array<Class>]
+    #
+    # @todo Consider the Wings::ModelRegistry and how we perform mappings.
+    def self.work_class_names
+      Hyrax.config.registered_curation_concern_types
+    end
+
+    def self.work_classes
+      classes_from(work_class_names)
+    end
+
+    ##
+    # @return [Array<String>]
+    def self.work_rdf_representations
+      rdf_representations_from(work_classes)
+    end
+
+    def self.classes_from(strings)
+      strings.map(&:safe_constantize).flatten.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/pcdm_collection.rb

@@ -56,13 +56,7 @@ module Hyrax
 
     ##
     # @return [Boolean] true
-    def collection?
-      true
-    end
-
-    ##
-    # @return [Boolean] true
-    def pcdm_object?
+    def self.pcdm_collection?
       true
     end
 

data/app/models/hyrax/resource.rb

@@ -35,8 +35,8 @@ module Hyrax
     include Hyrax::WithEvents
 
     attribute :alternate_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID)
-    attribute :embargo_id,    Valkyrie::Types::ID
-    attribute :lease_id,      Valkyrie::Types::ID
+    attribute :embargo_id,    Valkyrie::Types::Params::ID
+    attribute :lease_id,      Valkyrie::Types::Params::ID
 
     delegate :edit_groups, :edit_groups=,
              :edit_users,  :edit_users=,
@@ -50,6 +50,50 @@ module Hyrax
         I18n.translate("hyrax.models.#{model_name.i18n_key}", default: model_name.human)
       end
 
+      ##
+      # @return [Boolean]
+      def collection?
+        pcdm_collection?
+      end
+
+      ##
+      # @return [Boolean]
+      def file?
+        false
+      end
+
+      ##
+      # @return [Boolean]
+      def file_set?
+        false
+      end
+
+      ##
+      # @return [Boolean]
+      def pcdm_collection?
+        false
+      end
+
+      ##
+      # @return [Boolean]
+      def pcdm_object?
+        false
+      end
+
+      ##
+      # Works are PCDM Objects which are not File Sets.
+      #
+      # @return [Boolean]
+      def work?
+        pcdm_object? && !file_set?
+      end
+
+      ##
+      # @return [String]
+      def to_rdf_representation
+        name
+      end
+
       private
 
       ##
@@ -64,35 +108,49 @@ module Hyrax
     ##
     # @return [Boolean]
     def collection?
-      false
+      self.class.collection?
     end
 
     ##
     # @return [Boolean]
     def file?
-      false
+      self.class.file?
     end
 
     ##
     # @return [Boolean]
     def file_set?
-      false
+      self.class.file_set?
+    end
+
+    ##
+    # @return [Boolean]
+    def pcdm_collection?
+      self.class.pcdm_collection?
     end
 
     ##
     # @return [Boolean]
     def pcdm_object?
-      false
+      self.class.pcdm_object?
+    end
+
+    ##
+    # @return [String]
+    def to_rdf_representation
+      self.class.to_rdf_representation
     end
 
     ##
+    # Works are PCDM Objects which are not File Sets.
+    #
     # @return [Boolean]
     def work?
-      false
+      self.class.work?
     end
 
     def ==(other)
-      attributes.except(:created_at, :updated_at) == other.attributes.except(:created_at, :updated_at)
+      attributes.except(:created_at, :updated_at) == other.attributes.except(:created_at, :updated_at) if other.respond_to?(:attributes)
     end
 
     def permission_manager

data/app/models/hyrax/statistic.rb

@@ -43,7 +43,7 @@ module Hyrax
 
       def query_works(query)
         models = Hyrax.config.curation_concerns.map { |m| "\"#{m}\"" }
-        ActiveFedora::SolrService.query("has_model_ssim:(#{models.join(' OR ')})", fl: query, rows: 100_000)
+        Hyrax::SolrService.query("has_model_ssim:(#{models.join(' OR ')})", fl: query, rows: 100_000)
       end
 
       def work_types

data/app/models/hyrax/work.rb

@@ -108,13 +108,7 @@ module Hyrax
 
     ##
     # @return [Boolean] true
-    def pcdm_object?
-      true
-    end
-
-    ##
-    # @return [Boolean] true
-    def work?
+    def self.pcdm_object?
       true
     end
   end

data/app/presenters/hyrax/collapsable_section_presenter.rb

@@ -2,15 +2,18 @@
 module Hyrax
   # Draws a collapsable list widget using the Bootstrap 3 / Collapse.js plugin
   class CollapsableSectionPresenter
-    def initialize(view_context:, text:, id:, icon_class:, open:)
+    # rubocop:disable Metrics/ParameterLists
+    def initialize(view_context:, text:, id:, icon_class:, open:, title: nil)
       @view_context = view_context
       @text = text
       @id = id
       @icon_class = icon_class
       @open = open
+      @title = title
     end
+    # rubocop:enable Metrics/ParameterLists
 
-    attr_reader :view_context, :text, :id, :icon_class, :open
+    attr_reader :view_context, :text, :id, :icon_class, :open, :title
     delegate :content_tag, :safe_join, :tag, to: :view_context
 
     def render(&block)
@@ -26,7 +29,8 @@ module Hyrax
             href: "##{id}",
             onclick: "toggleCollapse(this)",
             'aria-expanded' => open,
-            'aria-controls' => id) do
+            'aria-controls' => id,
+            title: title) do
         safe_join([tag.span('', class: icon_class, 'aria-hidden': true),
                    tag.span(text)], ' ')
       end

data/app/presenters/hyrax/file_set_presenter.rb

@@ -118,13 +118,15 @@ module Hyrax
     end
 
     def fetch_parent_presenter
-      ids = Hyrax::SolrService.query("{!field f=member_ids_ssim}#{id}", fl: Hyrax.config.id_field)
+      ids = Hyrax::SolrService.query("{!field f=member_ids_ssim}#{id}", fl: Hyrax.config.id_field, rows: 1)
                               .map { |x| x.fetch(Hyrax.config.id_field) }
-      Hyrax.logger.warn("Couldn't find a parent work for FileSet: #{id}.") if ids.empty?
-      ids.each do |id|
-        doc = ::SolrDocument.find(id)
-        next if current_ability.can?(:edit, doc)
-        raise WorkflowAuthorizationException if doc.suppressed? && current_ability.can?(:read, doc)
+      if ids.empty?
+        Hyrax.logger.warn("Couldn't find a parent work for FileSet: #{id}.")
+      else
+        doc = ::SolrDocument.find(ids.first)
+        unless current_ability.can?(:edit, doc)
+          raise WorkflowAuthorizationException if doc.suppressed? && current_ability.can?(:read, doc)
+        end
       end
       Hyrax::PresenterFactory.build_for(ids: ids,
                                         presenter_class: WorkShowPresenter,

data/app/presenters/hyrax/lease_presenter.rb

@@ -27,5 +27,9 @@ module Hyrax
     def lease_history
       solr_document['lease_history_ssim']
     end
+
+    def enforced?
+      solr_document.lease_enforced?
+    end
   end
 end

data/app/presenters/hyrax/menu_presenter.rb

@@ -11,10 +11,20 @@ module Hyrax
     delegate :controller, :controller_name, :action_name, :content_tag,
              :current_page?, :link_to, :can?, :tag, to: :view_context
 
+    ##
+    # @!group Class Attributes
+    #
+    # @!attribute section_controller_names [r|w]
+    #   @return [Array<String>]
+    #   @see #settings_section?
+    class_attribute :section_controller_names, default: %w[appearances content_blocks features pages collection_types]
+    # @!endgroup Class Attributes
+    ##
+
     # Returns true if the current controller happens to be one of the controllers that deals
     # with settings.  This is used to keep the parent section on the sidebar open.
     def settings_section?
-      %w[appearances content_blocks features pages collection_types].include?(controller_name)
+      section_controller_names.include?(controller_name)
     end
 
     # @param options [Hash, String] a hash or string representing the path. Hash is prefered as it
@@ -47,12 +57,14 @@ module Hyrax
       %w[work_reports collection_reports].include?(controller_name)
     end
 
+    ##
     # Draw a collaspable menu section. The passed block should contain <li> items.
-    def collapsable_section(text, id:, icon_class:, open:, &block)
+    def collapsable_section(text, id:, icon_class:, open:, title: nil, &block)
       CollapsableSectionPresenter.new(view_context: view_context,
                                       text: text,
                                       id: id,
                                       icon_class: icon_class,
+                                      title: title,
                                       open: open).render(&block)
     end
 

data/app/presenters/hyrax/pcdm_member_presenter_factory.rb

@@ -97,7 +97,7 @@ module Hyrax
     # @return
     def presenter_for(document:, ability:)
       case document['has_model_ssim'].first
-      when Hyrax::FileSet.name, ::FileSet.name # ActiveFedora FileSet within a Valkyrie Resource
+      when *Hyrax::ModelRegistry.file_set_rdf_representations
         Hyrax::FileSetPresenter.new(document, ability)
       else
         Hyrax::WorkShowPresenter.new(document, ability)

data/app/presenters/hyrax/version_list_presenter.rb

@@ -19,13 +19,15 @@ module Hyrax
     # @return [Hyrax::VersionListPresenter] an enumerable of presenters for the
     #   relevant file versions.
     #
-    # @raise [ArgumentError] if we can't build an enu
-    def self.for(file_set:)
-      original_file = if file_set.respond_to?(:original_file)
+    # @raise [ArgumentError] if we can't build an enumerable
+    def self.for(file_set:, file_service: Hyrax.config.file_set_file_service)
+      original_file = case file_set
+                      when ActiveFedora::Base
                         file_set.original_file
                       else
-                        Hyrax::FileSetFileService.new(file_set: file_set).original_file
+                        file_service.new(file_set: file_set).primary_file
                       end
+
       new(Hyrax::VersioningService.new(resource: original_file))
     rescue NoMethodError
       raise ArgumentError

data/app/search_builders/hyrax/admin_set_search_builder.rb

@@ -14,7 +14,7 @@ module Hyrax
 
     # This overrides the models in FilterByType
     def models
-      [::AdminSet, Hyrax::AdministrativeSet]
+      Hyrax::ModelRegistry.admin_set_classes
     end
 
     # Overrides Hydra::AccessControlsEnforcement

data/app/search_builders/hyrax/catalog_search_builder.rb

@@ -78,8 +78,14 @@ class Hyrax::CatalogSearchBuilder < Hyrax::SearchBuilder
     "{!dismax v=$user_query}"
   end
 
-  # join from file id to work relationship solrized file_set_ids_ssim
+  # join from file id to work relationship solrized member_ids_ssim
   def join_for_works_from_files
-    "{!join from=#{Hyrax.config.id_field} to=file_set_ids_ssim}#{dismax_query}"
+    "{!join from=#{Hyrax.config.id_field} to=member_ids_ssim}#{file_set_filter}#{dismax_query}"
+  end
+
+  # Query segment to filter out non-FileSet documents
+  # A wildcard * is used to avoid attempting to escape the :: in Hyrax::FileSet
+  def file_set_filter
+    "{!lucene q.op=AND}has_model_ssim:*FileSet"
   end
 end

data/app/search_builders/hyrax/dashboard/collections_search_builder.rb

@@ -9,7 +9,7 @@ module Hyrax
 
       # This overrides the models in FilterByType
       def models
-        [::AdminSet, Hyrax::AdministrativeSet, ::Collection, Hyrax.config.collection_class].uniq.compact
+        Hyrax::ModelRegistry.admin_set_classes + Hyrax::ModelRegistry.collection_classes
       end
 
       # adds a filter to exclude collections and admin sets created by the
@@ -18,9 +18,11 @@ module Hyrax
       def show_only_managed_collections_for_non_admins(solr_parameters)
         return if current_ability.admin?
         clauses = [
-          '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: current_user_key),
-          '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: Hyrax.config.admin_set_model, creator: current_user_key)
+          '-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(depositor: current_user_key)
         ]
+        Hyrax::ModelRegistry.admin_set_rdf_representations.each do |has_model|
+          clauses += ['-' + ActiveFedora::SolrQueryBuilder.construct_query_for_rel(has_model: has_model, creator: current_user_key)]
+        end
         solr_parameters[:fq] ||= []
         solr_parameters[:fq] += ["(#{clauses.join(' OR ')})"]
       end

data/app/search_builders/hyrax/exposed_models_relation.rb

@@ -3,7 +3,7 @@ module Hyrax
   # A relation that scopes to all user visible models (e.g. works + collections + file sets)
   class ExposedModelsRelation < AbstractTypeRelation
     def allowable_types
-      (Hyrax.config.curation_concerns + [Hyrax.config.collection_class, ::Collection, ::FileSet]).uniq
+      Hyrax::ModelRegistry.work_classes + Hyrax::ModelRegistry.collection_classes + Hyrax::ModelRegistry.file_set_classes
     end
   end
 end