hyrax 5.0.0.rc1 → 5.0.0.rc3

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/orcid_validator.rb

@@ -7,12 +7,6 @@ module Hyrax
       record.errors.add(:orcid, 'must be a string of 19 characters, e.g., "0000-0000-0000-0000"') unless ORCID_REGEXP.match?(record.orcid)
     end
 
-    # @deprecated
-    def self.match(string)
-      Deprecation.warn "Use 'Hyrax::OrcidValidator.extract_bare_orcid(from:)'"
-      extract_bare_orcid_from(from: string)
-    end
-
     # @api public
     # @param [String] from
     # @return nil if the given string is not in the Orcid form

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

@@ -63,7 +63,7 @@ module Hyrax
   #   `it_behaves_like 'has_members'`.  Shared specs are defined in /lib/hyrax/specs/shared_specs/hydra_works.rb.
   # * Work to File Set: (0..m)  A work can have many file sets.
   # @example Add a file set to a work (code from Hyrax::WorkUploadsHandler#append_to_work)
-  #       work.member_ids << file_set.id
+  #       work.member_ids += [file_set.id]
   #       work.representative_id = file_set.id if work.respond_to?(:representative_id) && work.representative_id.blank?
   #       work.thumbnail_id = file_set.id if work.respond_to?(:thumbnail_id) && work.thumbnail_id.blank?
   #       Hyrax.persister.save(resource: work)
@@ -91,11 +91,8 @@ module Hyrax
   #
   # @see /lib/hyrax/specs/shared_specs/hydra_works.rb
   #
-  # @todo The description in Hydra::Works Shared Modeling is out of date and uses
-  #   terminology to describe the relationships that is no longer used in code.
-  #   Update the model and link to it.  This can be a simple relationship diagram
-  #   with a link to the original Works Shared Modeling for historical perspective.
   # @see https://wiki.lyrasis.org/display/samvera/Hydra::Works+Shared+Modeling
+  #   for a historical perspective.
   class Work < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
 
@@ -111,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/collection_presenter.rb

@@ -172,23 +172,6 @@ module Hyrax
       create_work_presenter.first_model
     end
 
-    ##
-    # @deprecated this implementation requires an extra db round trip, had a
-    #   buggy cacheing mechanism, and was largely duplicative of other code.
-    #   all versions of this code are replaced by
-    #   {CollectionsHelper#available_parent_collections_data}.
-    def available_parent_collections(scope:)
-      Deprecation.warn("#{self.class}#available_parent_collections is " \
-                       "deprecated. Use available_parent_collections_data " \
-                       "helper instead.")
-      return @available_parents if @available_parents.present?
-      collection = Hyrax.config.collection_class.find(id)
-      colls = Hyrax::Collections::NestedCollectionQueryService.available_parent_collections(child: collection, scope: scope, limit_to_id: nil)
-      @available_parents = colls.map do |col|
-        { "id" => col.id, "title_first" => col.title.first }
-      end.to_json
-    end
-
     def subcollection_count=(total)
       @subcollection_count = total unless total.nil?
     end

data/app/presenters/hyrax/embargo_presenter.rb

@@ -23,5 +23,9 @@ module Hyrax
     def embargo_history
       solr_document['embargo_history_ssim']
     end
+
+    def enforced?
+      solr_document.embargo_enforced?
+    end
   end
 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

@@ -28,7 +28,7 @@ module Hyrax
     # @return [Array<FileSetPresenter, WorkShowPresenter>]
     # @return [Enumerator<FileSetPresenter>]
     def file_set_presenters
-      return enum_for(:file_set_presenters) unless block_given?
+      return enum_for(:file_set_presenters).to_a unless block_given?
 
       results = query_docs(generic_type: "FileSet")
 
@@ -47,14 +47,14 @@ module Hyrax
     #   we recommend making sparing use of this feature.
     #
     # @overload member_presenters
-    #   @return [Enumerator<FileSetPresenter, WorkShowPresenter>]
+    #   @return [Array<FileSetPresenter, WorkShowPresenter>]
     #   @raise [ArgumentError] if an unindexed id is passed
     # @overload member_presenters
     #   @param [Array<#to_s>] ids
-    #   @return [Enumerator<FileSetPresenter, WorkShowPresenter>]
+    #   @return [Array<FileSetPresenter, WorkShowPresenter>]
     #   @raise [ArgumentError] if an unindexed id is passed
     def member_presenters(ids = object.member_ids)
-      return enum_for(:member_presenters, ids) unless block_given?
+      return enum_for(:member_presenters, ids).to_a unless block_given?
 
       results = query_docs(ids: ids)
 
@@ -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)
@@ -109,6 +109,8 @@ module Hyrax
     def query_docs(generic_type: nil, ids: object.member_ids)
       query = "{!terms f=id}#{ids.join(',')}"
       query += "{!term f=generic_type_si}#{generic_type}" if generic_type
+      # works created via ActiveFedora use the _sim field
+      query += "{!term f=generic_type_sim}#{generic_type}" if generic_type
 
       Hyrax::SolrService
         .post(q: query, rows: 10_000)

data/app/presenters/hyrax/version_list_presenter.rb

@@ -5,39 +5,50 @@ module Hyrax
   class VersionListPresenter
     include Enumerable
 
+    attr_reader :versioning_service
+
     ##
-    # @param version_list [Array<#created>]
-    def initialize(version_list)
-      @raw_list = version_list
+    # @param service [Hyrax::VersioningService]
+    def initialize(service)
+      @versioning_service = service
     end
 
     ##
     # @param [Object] an object representing the File Set
     #
-    # @return [Enumerable<Hyrax::VersionPresenter>] an enumerable of presenters
-    #   for the relevant file versions.
+    # @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).versions)
+
+      new(Hyrax::VersioningService.new(resource: original_file))
     rescue NoMethodError
       raise ArgumentError
     end
 
-    delegate :each, to: :wrapped_list
+    delegate :each, :empty?, to: :wrapped_list
+    delegate :supports_multiple_versions?, to: :versioning_service
 
     private
 
     def wrapped_list
       @wrapped_list ||=
-        @raw_list.map { |v| Hyrax::VersionPresenter.new(v) } # wrap each item in a presenter
-                 .sort { |a, b| b.version.created <=> a.version.created } # sort list of versions based on creation date
-                 .tap { |l| l.first.try(:current!) } # set the first version to the current version
+        begin
+          presenters = @versioning_service.versions.map { |v| Hyrax::VersionPresenter.new(v) } # wrap each item in a presenter
+          if presenters.first&.version&.respond_to?(:created)
+            presenters.sort! { |a, b| b.version.created <=> a.version.created } if presenters.first&.version.respond_to?(:created) # sort list of versions based on creation date
+          else
+            presenters.reverse!
+          end
+          presenters.tap { |l| l.first.try(:current!) } # set the first version to the current version
+        end
     end
   end
 end