hyrax 3.0.1 → 3.3.0

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

@@ -51,27 +51,22 @@ module Hyrax
     end
 
     # Add members using the members association.
-    # TODO: Confirm if this is ever used.  I believe all relationships are done through
-    #       add_member_objects using the member_of_collections relationship.  Deprecate?
     def add_members(new_member_ids)
-      return if new_member_ids.blank?
-      members << Hyrax.custom_queries.find_many_by_alternate_ids(alternate_ids: new_member_ids, use_valkyrie: false)
+      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
+      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
+                                                                     new_member_ids: new_member_ids,
+                                                                     user: nil)
     end
 
     # Add member objects by adding this collection to the objects' member_of_collection association.
     # @param [Enumerable<String>] the ids of the new child collections and works collection ids
     def add_member_objects(new_member_ids)
-      Array(new_member_ids).collect do |member_id|
-        member = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: member_id, use_valkyrie: false)
-        message = Hyrax::MultipleMembershipChecker.new(item: member).check(collection_ids: id, include_current_members: true)
-        if message
-          member.errors.add(:collections, message)
-        else
-          member.member_of_collections << self
-          member.save!
-        end
-        member
-      end
+      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
+                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
+      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
+                                                                     new_member_ids: new_member_ids,
+                                                                     user: nil)
     end
 
     # @return [Enumerable<ActiveFedora::Base>] an enumerable over the children of this collection
@@ -125,41 +120,19 @@ module Hyrax
       Hyrax::PermissionTemplate.find_by!(source_id: id)
     end
 
+    ##
+    # @deprecated use PermissionTemplate#reset_access_controls instead
+    #
     # Calculate and update who should have read/edit access to the collections based on who
     # has access in PermissionTemplateAccess
     def reset_access_controls!
-      update!(edit_users: permission_template_edit_users,
-              edit_groups: permission_template_edit_groups,
-              read_users: permission_template_read_users,
-              read_groups: (permission_template_read_groups + visibility_group).uniq)
-    end
-
-    private
-
-    def permission_template_edit_users
-      permission_template.agent_ids_for(access: 'manage', agent_type: 'user')
-    end
+      Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls instead.")
 
-    def permission_template_edit_groups
-      permission_template.agent_ids_for(access: 'manage', agent_type: 'group')
+      permission_template
+        .reset_access_controls_for(collection: self, interpret_visibility: true)
     end
 
-    def permission_template_read_users
-      (permission_template.agent_ids_for(access: 'view', agent_type: 'user') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'user')).uniq
-    end
-
-    def permission_template_read_groups
-      (permission_template.agent_ids_for(access: 'view', agent_type: 'group') +
-        permission_template.agent_ids_for(access: 'deposit', agent_type: 'group')).uniq -
-        [::Ability.registered_group_name, ::Ability.public_group_name]
-    end
-
-    def visibility_group
-      return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_PUBLIC] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
-      return [Hydra::AccessControls::AccessRight::PERMISSION_TEXT_VALUE_AUTHENTICATED] if visibility == Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED
-      []
-    end
+    private
 
     # Solr field name works use to index member ids
     def member_ids_field

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+module Hyrax
+  module Embargoable
+    extend ActiveSupport::Concern
+    include Hydra::AccessControls::Embargoable
+
+    included do
+      validates :lease_expiration_date, 'hydra/future_date': true, on: :create
+      validates :embargo_release_date, 'hydra/future_date': true, on: :create
+    end
+
+    ##
+    # Override aggressive Hydra::AccessControls validation
+    def enforce_future_date_for_embargo?
+      false
+    end
+
+    ##
+    # Override aggressive Hydra::AccessControls validation
+    def enforce_future_date_for_lease?
+      false
+    end
+  end
+end

data/app/models/concerns/hyrax/file_set/characterization.rb

@@ -1,18 +1,24 @@
 # frozen_string_literal: true
-# This module points the FileSet to the location of the technical metadata.
-# By default, the file holding the metadata is :original_file and the terms
-# are listed under ::characterization_terms.
-# Implementations may define their own terms or use a different source file, but
-# any terms must be set on the ::characterization_proxy by the Hydra::Works::CharacterizationService
-#
-# class MyFileSet
-#   include Hyrax::FileSetBehavior
-# end
-#
-# MyFileSet.characterization_proxy = :master_file
-# MyFileSet.characterization_terms = [:term1, :term2, :term3]
+
 module Hyrax
   class FileSet
+    ##
+    # This module points the FileSet to the location of the technical metadata.
+    # By default, the file holding the metadata is +:original_file+ and the terms
+    # are listed under +.characterization_terms+.
+    #
+    # Implementations may define their own terms or use a different source file, but
+    # any terms must be set on the +.characterization_proxy+ by the
+    # +Hydra::Works::CharacterizationService+.
+    #
+    # @example
+    #   class MyFileSet
+    #     include Hyrax::FileSetBehavior
+    #   end
+    #
+    #   MyFileSet.characterization_proxy = :master_file
+    #   MyFileSet.characterization_terms = [:term1, :term2, :term3]
+    #
     module Characterization
       extend ActiveSupport::Concern
 

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -54,6 +54,7 @@ module Hyrax
         attribute :admin_set, Solr::Array, "admin_set_tesim"
         attribute :member_ids, Solr::Array, "member_ids_ssim"
         attribute :member_of_collection_ids, Solr::Array, "member_of_collection_ids_ssim"
+        attribute :member_of_collections, Solr::Array, "member_of_collections_ssim"
         attribute :description, Solr::Array, "description_tesim"
         attribute :abstract, Solr::Array, "abstract_tesim"
         attribute :title, Solr::Array, "title_tesim"

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

@@ -13,6 +13,8 @@ module Hyrax
   #
   # @see https://github.com/projectblacklight/blacklight/wiki/Understanding-Rails-and-Blacklight#models
   module SolrDocumentBehavior
+    ModelWrapper = ActiveFedoraDummyModel # alias for backward compatibility
+
     extend ActiveSupport::Concern
     include Hydra::Works::MimeTypes
     include Hyrax::Permissions::Readable
@@ -39,70 +41,19 @@ module Hyrax
       title_or_label.to_s
     end
 
-    ##
-    # Given a model class and an +id+, provides +ActiveModel+ style model methods.
-    #
-    # @note access this via {SolrDocumentBehavior#to_model}.
-    class ModelWrapper
-      ##
-      # @api private
-      #
-      # @param [Class] model
-      # @param [String, nil] id
-      def initialize(model, id)
-        @model = model
-        @id = id
-      end
-
-      ##
-      # @api public
-      def persisted?
-        true
-      end
-
-      ##
-      # @api public
-      def to_param
-        @id
-      end
-
-      ##
-      # @api public
-      def model_name
-        @model.model_name
-      end
-
-      ##
-      # @api public
-      #
-      # @note uses the @model's `._to_partial_path` if implemented, otherwise
-      #   constructs a default
-      def to_partial_path
-        return @model._to_partial_path if
-          @model.respond_to?(:_to_partial_path)
-
-        "hyrax/#{model_name.collection}/#{model_name.element}"
-      end
-
-      ##
-      # @api public
-      def to_global_id
-        URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
-      end
-    end
     ##
     # Offer the source model to Rails for some of the Rails methods (e.g. link_to).
     #
     # @example
     #   link_to '...', SolrDocument(:id => 'bXXXXXX5').new => <a href="/dams_object/bXXXXXX5">...</a>
     def to_model
-      @model ||= ModelWrapper.new(hydra_model, id)
+      @model ||= ActiveFedoraDummyModel.new(hydra_model, id)
     end
 
     ##
     # @return [Boolean]
     def collection?
-      hydra_model == ::Collection
+      hydra_model == Hyrax.config.collection_class
     end
 
     ##
@@ -117,9 +68,15 @@ module Hyrax
       hydra_model == ::AdminSet
     end
 
+    ##
+    # @return [Boolean]
+    def work?
+      Hyrax.config.curation_concerns.include? hydra_model
+    end
+
     # Method to return the model
     def hydra_model(classifier: ActiveFedora.model_mapper)
-      "::#{first('has_model_ssim')}".safe_constantize ||
+      first('has_model_ssim')&.safe_constantize ||
         classifier.classifier(self).best_model
     end
 

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

@@ -10,6 +10,11 @@ module Hyrax
     end
 
     ##
+    # @deprecated use `Hyrax::ResourceStatus` instead. in most cases,
+    #   {#suppressed?} is being called on a {SolrDocumentBehavior}. we continue
+    #   to index `suppressed_bsi` and expose its value as an attribute on solr
+    #   document objects.
+    #
     # Used to restrict visibility on search results for a work that is inactive. If the state is not set, the
     # default behavior is to consider the work not to be suppressed.
     #

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

@@ -31,7 +31,7 @@ module Hyrax::User
 
     scope :guests, ->() { where(guest: true) }
     scope :registered, ->() { where(guest: false) }
-    scope :without_system_accounts, -> { where("#{::User.user_key_field} not in (?)", [::User.batch_user_key, ::User.audit_user_key]) }
+    scope :without_system_accounts, -> { where("#{::User.user_key_field} not in (?)", [::User.batch_user_key, ::User.audit_user_key, ::User.system_user_key]) }
 
     # Validate and normalize ORCIDs
     validates_with OrcidValidator
@@ -145,7 +145,14 @@ module Hyrax::User
   end
 
   module ClassMethods
-    # Override this method if you aren't using email/password
+    def system_user
+      find_or_create_system_user(system_user_key)
+    end
+
+    def system_user_key
+      Hyrax.config.system_user_key
+    end
+
     def audit_user
       find_or_create_system_user(audit_user_key)
     end
@@ -158,7 +165,6 @@ module Hyrax::User
       Hydra.config.user_key_field
     end
 
-    # Override this method if you aren't using email/password
     def batch_user
       find_or_create_system_user(batch_user_key)
     end

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

@@ -14,7 +14,7 @@ module Hyrax
     include Naming
     include CoreMetadata
     include InAdminSet
-    include Hydra::AccessControls::Embargoable
+    include Hyrax::Embargoable
     include GlobalID::Identification
     include NestedWorks
     include Suppressible

data/app/models/file_download_stat.rb

@@ -12,10 +12,10 @@ class FileDownloadStat < Hyrax::Statistic
         Rails.logger.error("Google Analytics profile has not been established. Unable to fetch statistics.")
         return []
       end
-      profile.hyrax__download(sort: 'date',
-                              start_date: start_date,
-                              end_date: Date.yesterday,
-                              limit: 10_000)
+      profile.hyrax__analytics__google__download(sort: 'date',
+                                                 start_date: start_date,
+                                                 end_date: Date.yesterday,
+                                                 limit: 10_000)
              .for_file(file.id)
     end
 

data/app/models/hyrax/administrative_set.rb

@@ -4,9 +4,15 @@ module Hyrax
   ##
   # Valkyrie model for Admin Set domain objects.
   class AdministrativeSet < Hyrax::Resource
+    include Hyrax::Schema(:core_metadata)
+
     attribute :alternative_title, Valkyrie::Types::Set.of(Valkyrie::Types::String)
     attribute :creator,           Valkyrie::Types::Set.of(Valkyrie::Types::String)
     attribute :description,       Valkyrie::Types::Set.of(Valkyrie::Types::String)
-    attribute :title,             Valkyrie::Types::Set.of(Valkyrie::Types::String)
+
+    def collection_type_gid
+      # allow AdministrativeSet to behave more like a regular PcdmCollection
+      Hyrax::CollectionType.find_or_create_admin_set_type.to_global_id
+    end
   end
 end

data/app/models/hyrax/default_administrative_set.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Hyrax
+  # This class stores the id of the default `Hyrax::AdministrativeSet`.  This is
+  # used to populate a cache of the default admin set in Hyrax::Configuration.
+  #
+  # @see Hyrax::Configuration.default_admin_set
+  # @see Hyrax::Configuration.default_admin_set_id
+  # @see Hyrax::Configuration.reset_default_admin_set
+  class DefaultAdministrativeSet < ActiveRecord::Base
+    self.table_name = 'hyrax_default_administrative_set'
+
+    class << self
+      # Set the default admin set id in the first record.
+      # @param default_admin_set_id [String | Valkyrie::ID] id of the new default admin set
+      def update(default_admin_set_id:)
+        validate_id(default_admin_set_id)
+        Hyrax.config.reset_default_admin_set
+
+        # saving default_admin_set_id for the first time
+        return new(default_admin_set_id: default_admin_set_id.to_s).save if count.zero?
+
+        # replacing previously saved default_admin_set_id
+        existing = first
+        existing.default_admin_set_id = default_admin_set_id.to_s
+        existing.save
+      end
+
+      def save_supported?
+        ActiveRecord::Base.connection.table_exists? table_name
+      end
+
+      private
+
+      def validate_id(id)
+        # The id is validated prior to updating because a bad default admin set
+        # will cause lots of problems.
+        return true if id.is_a?(String) || id.is_a?(Valkyrie::ID)
+        raise ArgumentError, "default_admin_set_id must be a non-blank String or Valkyrie::ID"
+      end
+    end
+  end
+end

data/app/models/hyrax/file_set.rb

@@ -9,6 +9,12 @@ module Hyrax
     include Hyrax::Schema(:core_metadata)
     include Hyrax::Schema(:basic_metadata)
 
+    def self.model_name(name_class: Hyrax::Name)
+      @_model_name ||= begin
+        name_class.new(self, nil, 'FileSet')
+      end
+    end
+
     attribute :file_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID) # id for FileMetadata resources
     attribute :original_file_id, Valkyrie::Types::ID # id for FileMetadata resource
     attribute :thumbnail_id, Valkyrie::Types::ID # id for FileMetadata resource

data/app/models/hyrax/pcdm_collection.rb

@@ -11,6 +11,7 @@ module Hyrax
 
     attribute :collection_type_gid, Valkyrie::Types::String
     attribute :member_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)
+    attribute :member_of_collection_ids, Valkyrie::Types::Set.of(Valkyrie::Types::ID)
 
     ##
     # @api private

data/app/models/hyrax/permission.rb

@@ -14,6 +14,6 @@ module Hyrax
 
     attribute :access_to, Valkyrie::Types::ID
     attribute :agent,     Valkyrie::Types::String
-    attribute :mode,      Valkyrie::Types::String
+    attribute :mode,      Valkyrie::Types::Coercible::Symbol
   end
 end

data/app/models/hyrax/permission_template.rb

@@ -1,20 +1,61 @@
 # frozen_string_literal: true
 module Hyrax
   ##
-  # Defines behavior that is applied to objects added as members of an AdminSet
+  # Holds policy data about the workflow and permissions applied objects when
+  # they are deposited through an Administrative Set or a Collection. Each
+  # template record has a {#source} (through {#source_id}); the template's
+  # rules inform the behavior of objects deposited through that {#source_model}.
   #
-  #  * access rights to stamp on each object
-  #  * calculate embargo/lease release dates
+  # The {PermissionTemplate} specifies:
   #
-  # There is an interplay between an AdminSet and a PermissionTemplate.
+  # - an {#active_workflow} that the object will enter and be processed through.
+  # - {#access_grants} that can be applied to each object (especially at deposit
+  #   time).
+  # - an embargo configuration ({#release_date} {#release_period}) for default
+  #   embargo behavior.
   #
-  # @see Hyrax::AdminSet for further discussion
-  class PermissionTemplate < ActiveRecord::Base
+  # Additionally, the {PermissionTemplate} grants authority to perform actions
+  # that relate to the Administrative Set/Collection itself. Rules for who can
+  # deposit to, view(?!), or manage the admin set are governed by related
+  # {PermissionTemplateAccess} records. Administrat Sets should have a manager
+  # granted by some such record.
+  #
+  # @todo write up what "default embargo behavior", when it is applied, and how
+  #   it interacts with embargoes specified by user input.
+  #
+  # @example cerating a permission template and manager for an admin set
+  #   admin_set = Hyrax::AdministrativeSet.new(title: 'My Admin Set')
+  #   admin_set = Hyrax.persister.save(resource: admin_set)
+  #
+  #   template = PermissionTemplate.create!(source_id: admin_set.id.to_s)
+  #   Hyrax::PermissionTemplateAccess.create!(permission_template: template,
+  #                                          agent_type: Hyrax::PermissionTemplateAccess::USER,
+  #                                          agent_id: user.user_key,
+  #                                          access: Hyrax::PermissionTemplateAccess::MANAGE)
+  #
+  # @see Hyrax::AdministrativeSet
+  class PermissionTemplate < ActiveRecord::Base # rubocop:disable Metrics/ClassLength
     self.table_name = 'permission_templates'
 
+    ##
+    # @!attribute [rw] source_id
+    #   @return [String] identifier for the {Collection} or {AdministrativeSet}
+    #     to which this template applies.
+    # @!attribute [rw] access_grants
+    #   @return [Hyrax::PermissionTemplateAccess]
+    # @!attribute [rw] active_workflow
+    #   @return [Sipity::Workflow]
+    # @!attribute [rw] available_workflows
+    #   @return [Enumerable<Sipity::Workflow>]
     has_many :access_grants, class_name: 'Hyrax::PermissionTemplateAccess', dependent: :destroy
     accepts_nested_attributes_for :access_grants, reject_if: :all_blank
 
+    # The list of workflows that could be activated; It includes the active workflow
+    has_many :available_workflows, class_name: 'Sipity::Workflow', dependent: :destroy
+
+    # In a perfect world, there would be a join table that enforced uniqueness on the ID.
+    has_one :active_workflow, -> { where(active: true) }, class_name: 'Sipity::Workflow', foreign_key: :permission_template_id
+
     ##
     # @api public
     #
@@ -28,12 +69,6 @@ module Hyrax
       access_grants.where(agent_type: agent_type, access: access).pluck(:agent_id)
     end
 
-    # The list of workflows that could be activated; It includes the active workflow
-    has_many :available_workflows, class_name: 'Sipity::Workflow', dependent: :destroy
-
-    # In a perfect world, there would be a join table that enforced uniqueness on the ID.
-    has_one :active_workflow, -> { where(active: true) }, class_name: 'Sipity::Workflow', foreign_key: :permission_template_id
-
     ##
     # @note this is a convenience method for +Hyrax.query_service.find_by(id: template.source_id)+
     #
@@ -153,6 +188,71 @@ module Hyrax
       visibility == value
     end
 
+    ##
+    # @return [Array<String>]
+    def edit_users
+      agent_ids_for(access: 'manage', agent_type: 'user')
+    end
+
+    ##
+    # @return [Array<String>]
+    def edit_groups
+      agent_ids_for(access: 'manage', agent_type: 'group')
+    end
+
+    ##
+    # @return [Array<String>]
+    def read_users
+      (agent_ids_for(access: 'view', agent_type: 'user') +
+        agent_ids_for(access: 'deposit', agent_type: 'user')).uniq
+    end
+
+    ##
+    # @return [Array<String>]
+    def read_groups
+      (agent_ids_for(access: 'view', agent_type: 'group') +
+        agent_ids_for(access: 'deposit', agent_type: 'group')).uniq -
+        [::Ability.registered_group_name, ::Ability.public_group_name]
+    end
+
+    ##
+    # @param interpret_visibility [Boolean] whether to retain the existing
+    #   visibility when applying permission template ACLs
+    # @return [Boolean]
+    def reset_access_controls(interpret_visibility: false)
+      reset_access_controls_for(collection: source_model,
+                                interpret_visibility: interpret_visibility)
+    end
+
+    ##
+    # @param collection [::Collection, Hyrax::Resource]
+    # @param interpret_visibility [Boolean] whether to retain the existing
+    #   visibility when applying permission template ACLs
+    # @return [Boolean]
+    def reset_access_controls_for(collection:, interpret_visibility: false) # rubocop:disable Metrics/MethodLength
+      interpreted_read_groups = read_groups
+
+      if interpret_visibility
+        visibilities = Hyrax::VisibilityMap.instance
+        interpreted_read_groups -= visibilities.deletions_for(visibility: collection.visibility)
+        interpreted_read_groups += visibilities.additions_for(visibility: collection.visibility)
+      end
+
+      case collection
+      when Valkyrie::Resource
+        collection.permission_manager.edit_groups = edit_groups
+        collection.permission_manager.edit_users  = edit_users
+        collection.permission_manager.read_groups = interpreted_read_groups
+        collection.permission_manager.read_users  = read_users
+        collection.permission_manager.acl.save
+      else
+        collection.update!(edit_users: edit_users,
+                           edit_groups: edit_groups,
+                           read_users: read_users,
+                           read_groups: interpreted_read_groups.uniq)
+      end
+    end
+
     private
 
     # If template requires no delays, check if date is exactly today

data/app/models/hyrax/statistic.rb

@@ -34,13 +34,40 @@ module Hyrax
           Rails.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)
+        profile.hyrax__analytics__google__pageviews(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}\"" }
+        ActiveFedora::SolrService.query("has_model_ssim:(#{models.join(' OR ')})", fl: query, rows: 100_000)
+      end
+
+      def work_types
+        results = query_works("human_readable_type_tesim")
+        results.group_by { |result| result['human_readable_type_tesim'].join('') }.transform_values(&:count)
+      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)
+      end
+
       private
 
       def cached_stats(object, start_date, _method)