hyrax 3.1.0 → 3.4.0

data/app/services/hyrax/permission_manager.rb

@@ -143,7 +143,7 @@ module Hyrax
     def groups_for(mode:)
       Enumerator.new do |yielder|
         acl.permissions.each do |permission|
-          next unless permission.mode == mode
+          next unless permission.mode.to_sym == mode
           next unless permission.agent.starts_with?(Hyrax::Group.name_prefix)
           yielder << permission.agent.gsub(Hyrax::Group.name_prefix, '')
         end
@@ -154,7 +154,7 @@ module Hyrax
       groups = groups.map(&:to_s)
 
       acl.permissions.each do |permission|
-        next unless permission.mode == mode
+        next unless permission.mode.to_sym == mode
         next unless permission.agent.starts_with?(Hyrax::Group.name_prefix)
 
         group_name = permission.agent.gsub(Hyrax::Group.name_prefix, '')
@@ -175,7 +175,7 @@ module Hyrax
       end
 
       acl.permissions.each do |permission|
-        next unless permission.mode == mode
+        next unless permission.mode.to_sym == mode
         next if permission.agent.starts_with?(Hyrax::Group.name_prefix)
         next if users.include? permission.agent
 
@@ -189,7 +189,7 @@ module Hyrax
     def users_for(mode:)
       Enumerator.new do |yielder|
         acl.permissions.each do |permission|
-          next unless permission.mode == mode
+          next unless permission.mode.to_sym == mode
           next if permission.agent.starts_with?(Hyrax::Group.name_prefix)
           yielder << permission.agent
         end

data/app/services/hyrax/resource_visibility_propagator.rb

@@ -39,7 +39,7 @@ module Hyrax
     #
     # @raise [RuntimeError] if visibility propagation fails
     def propagate
-      queries.find_child_filesets(resource: source).each do |file_set|
+      queries.find_child_file_sets(resource: source).each do |file_set|
         file_set.visibility = source.visibility
         embargo_manager.copy_embargo_to(target: file_set)
         lease_manager.copy_lease_to(target: file_set)

data/app/services/hyrax/restriction_service.rb

@@ -2,6 +2,10 @@
 module Hyrax
   class RestrictionService
     class << self
+      ##
+      # @note needed to construct SearchBuilders using self in Blacklight 7+
+      delegate :blacklight_config, to: :config
+
       private
 
       def presenter_class

data/app/services/hyrax/simple_schema_loader.rb

@@ -76,7 +76,11 @@ module Hyrax
       ##
       # @return [Dry::Types::Type]
       def type
-        collection_type = config['multiple'] ? Valkyrie::Types::Array : Identity
+        collection_type = if config['multiple']
+                            Valkyrie::Types::Array.constructor { |v| Array(v).select(&:present?) }
+                          else
+                            Identity
+                          end
         collection_type.of(type_for(config['type']))
       end
 

data/app/services/hyrax/solr_query_service.rb

@@ -59,10 +59,11 @@ module Hyrax
     end
 
     ##
+    # @param join_with [String] the connector (eg. 'AND', 'OR') used to join each clause (default: 'AND')
     # @return [String] the combined query that can be submitted to solr
-    def build
+    def build(join_with: 'AND')
       return 'id:NEVER_USE_THIS_ID' if @query.blank? # forces this method to always return a valid solr query
-      @query.join(' AND ')
+      @query.join(padded_join_with(join_with))
     end
 
     ##
@@ -106,8 +107,8 @@ module Hyrax
 
     ##
     # @param field_pairs [Hash] a list of pairs of property name and values (e.g. { field1: values, field2: values })
-    # @param join_with [String] the connector used to join the field pairs (default: ' AND ')
-    # @param type [String] type of query to run. Either 'raw' or 'field' (default: 'field')
+    # @param join_with [String] the connector (eg. 'AND', 'OR') used to join the field pairs (default: 'AND')
+    # @param type [String] type of query to run (e.g. 'raw', 'field', 'terms') (default: 'field')
     # @return [SolrQueryService] the existing service with field_pair query appended
     def with_field_pairs(field_pairs: {}, join_with: default_join_with, type: 'field')
       pairs_query = construct_query_for_pairs(field_pairs, join_with, type)
@@ -140,7 +141,7 @@ module Hyrax
 
     # Construct a solr query from a list of pairs (e.g. { field1: values, field2: values })
     # @param [Hash] field_pairs a list of pairs of property name and values
-    # @param [String] join_with the value we're joining the clauses with (default: ' AND ')
+    # @param [String] join_with the value (e.g. 'AND', 'OR') we're joining the clauses with (default: 'AND')
     # @param [String] type of query to run. Either 'raw' or 'field' (default: 'field')
     # @return [String] a solr query
     # @example
@@ -150,7 +151,7 @@ module Hyrax
       clauses = pairs_to_clauses(field_pairs, type)
       return "" if clauses.count.zero?
       return clauses.first if clauses.count == 1
-      "(#{clauses.join(join_with)})"
+      "(#{clauses.join(padded_join_with(join_with))})"
     end
 
     # Construct a solr query from the model (e.g. Collection, Monograph)
@@ -184,7 +185,11 @@ module Hyrax
     end
 
     def default_join_with
-      ' AND '
+      'AND'
+    end
+
+    def padded_join_with(join_with)
+      " #{join_with.strip} "
     end
 
     # @param [Array<Array>] pairs a list of (key, value) pairs. The value itself may

data/app/services/hyrax/solr_service.rb

@@ -140,7 +140,7 @@ module Hyrax
     # valkyrie indexers used here would, at minimum, need to provide a
     # functioning `rsolr` connection.
     def valkyrie_index
-      Valkyrie::IndexingAdapter.find(:solr_index)
+      Hyrax.index_adapter
     end
 
     ##

data/app/services/hyrax/statistics/collections/over_time.rb

@@ -6,7 +6,8 @@ module Hyrax
         private
 
         def relation
-          ::Collection
+          AbstractTypeRelation
+            .new(allowable_types: [Hyrax.config.collection_class])
         end
       end
     end

data/app/services/hyrax/statistics/users/over_time.rb

@@ -8,9 +8,8 @@ module Hyrax
           Enumerator.new(size) do |y|
             x = @x_min
             while x <= @x_max
-              bottom = x
+              y.yield [@x_output.call(x), point(x)]
               x += @delta_x.days
-              y.yield [@x_output.call(x), point(bottom, x)]
             end
           end
         end
@@ -21,9 +20,13 @@ module Hyrax
           ::User.registered
         end
 
-        # Override to make an activerecord date range query
-        def query(min, max)
-          { created_at: min..max }
+        # Overridden to search one day at a time
+        def query(date_string)
+          { created_at: date_string.to_date.beginning_of_day..date_string.to_date.end_of_day }
+        end
+
+        def point(date_string)
+          relation.where(query(date_string)).count
         end
       end
     end

data/app/services/hyrax/statistics/works/over_time.rb

@@ -3,6 +3,16 @@ module Hyrax
   module Statistics
     module Works
       class OverTime < Statistics::OverTime
+        def points
+          Enumerator.new(size) do |y|
+            x = @x_min
+            while x <= @x_max
+              y.yield [@x_output.call(x), point(@x_min, x)]
+              x += @delta_x.days
+            end
+          end
+        end
+
         private
 
         def relation

data/app/services/hyrax/thumbnail_path_service.rb

@@ -9,7 +9,7 @@ module Hyrax
 
         thumb = fetch_thumbnail(object)
 
-        return unless thumb
+        return default_image unless thumb
         return call(thumb) unless thumb.file_set?
         if audio?(thumb)
           audio_image

data/app/services/hyrax/work_uploads_handler.rb

@@ -114,8 +114,8 @@ module Hyrax
       file_set.permission_manager.acl.save if file_set.permission_manager.acl.pending_changes?
       append_to_work(file_set)
 
-      IngestJob.perform_later(wrap_file(file, file_set))
-      Hyrax.publisher.publish('object.metadata.updated', object: file_set, user: file.user)
+      ValkyrieIngestJob.perform_later(file)
+
       { file_set: file_set, user: file.user }
     end
 
@@ -160,13 +160,6 @@ module Hyrax
       @target_permissions ||= Hyrax::AccessControlList.new(resource: work)
     end
 
-    ##
-    # @api private
-    # @return [JobIoWrapper]
-    def wrap_file(file, file_set)
-      JobIoWrapper.create_with_varied_file_handling!(user: file.user, file: file, relation: :original_file, file_set: file_set)
-    end
-
     ##
     # @api private
     #

data/app/services/hyrax/workflow/abstract_notification.rb

@@ -39,9 +39,9 @@ module Hyrax
       # @option recipients [Array<Hyrax::User>] :to a list of users to which to send the notification
       # @option recipients [Array<Hyrax::User>] :cc a list of users to which to copy on the notification
       def initialize(entity, comment, user, recipients)
-        @work_id = entity.proxy_for_global_id.sub(/.*\//, '')
+        @work_id = entity.proxy_for.id
         @title = entity.proxy_for.title.first
-        @comment = comment.respond_to?(:comment) ? comment.comment.to_s : ''
+        @comment = comment&.comment.to_s
         # Convert to hash with indifferent access to allow both string and symbol keys
         @recipients = recipients.with_indifferent_access
         @user = user

data/app/services/hyrax/workflow/action_taken_service.rb

@@ -14,7 +14,14 @@ module Hyrax
       end
 
       def initialize(target:, action:, comment:, user:)
-        @target = target
+        @target =
+          case target
+          when Valkyrie::Resource
+            Hyrax::ChangeSet.for(target)
+          else
+            target
+          end
+
         @action = action
         @comment = comment
         @user = user
@@ -70,10 +77,15 @@ module Hyrax
       # @api private
       def save_target
         case target
-        when ActiveFedora::Base
-          target.save
+        when Valkyrie::ChangeSet
+          return target.model unless target.changed?
+
+          Hyrax::Transactions::Container['change_set.apply']
+            .with_step_args('change_set.save' => { user: user })
+            .call(target)
+            .value!
         else
-          Hyrax.persister.save(resource: target)
+          target.save
         end
       end
     end

data/app/services/hyrax/workflow/activate_object.rb

@@ -3,14 +3,15 @@ module Hyrax
   module Workflow
     module ActivateObject
       ##
-      # This is a built in function for workflow, setting the `#state`
-      # of the target to the Fedora 'active' status URI
+      # This is a built in function for workflow, setting the +#state+
+      # of the target to the Fedora +active+ status URI
       #
-      # @param target [#state] an instance of a model that includes `Hyrax::Suppressible`
+      # @param target [#state] an instance of a model with a +#state+ property;
+      #   e.g. a {Hyrax::Work}
       #
       # @return [RDF::Vocabulary::Term] the Fedora Resource Status 'active' term
       def self.call(target:, **)
-        target.state = Vocab::FedoraResourceStatus.active
+        target.state = Hyrax::ResourceStatus::ACTIVE
       end
     end
   end

data/app/services/hyrax/workflow/changes_required_notification.rb

@@ -9,14 +9,15 @@ module Hyrax
       end
 
       def message
-        I18n.t('hyrax.notifications.workflow.changes_required.message', title: title,
-                                                                        link: (link_to work_id, document_path),
-                                                                        comment: comment)
+        I18n.t('hyrax.notifications.workflow.changes_required.message',
+               title: title,
+               link: (link_to work_id, document_path),
+               comment: comment)
       end
 
       def users_to_notify
         user_key = document.depositor
-        super << ::User.find_by(email: user_key)
+        super << ::User.find_by_user_key(user_key)
       end
     end
   end

data/app/services/hyrax/workflow/deactivate_object.rb

@@ -2,15 +2,17 @@
 module Hyrax
   module Workflow
     ##
-    # This is a built in function for workflow, setting the `#state`
-    # of the target to the Fedora 'inactive' status URI
+    # This is a built in function for workflow, setting the +#state+
+    # of the target to the Fedora +inactive+ status URI
     #
-    # @param target [#state] an instance of a model that includes `Hyrax::Suppressible`
+    # @param target [#state] an instance of a model with a +#state+ property;
+    #   e.g. a {Hyrax::Work}
     #
-    # @return [RDF::Vocabulary::Term] the Fedora Resource Status 'inactive' term
+    # @return [RDF::URI] the Fedora Resource Status 'inactive' term
+    # @see Hyrax::ResourceStatus
     module DeactivateObject
       def self.call(target:, **)
-        target.state = Vocab::FedoraResourceStatus.inactive
+        target.state = Hyrax::ResourceStatus::INACTIVE
       end
     end
   end

data/app/services/hyrax/workflow/deposited_notification.rb

@@ -9,13 +9,17 @@ module Hyrax
       end
 
       def message
-        I18n.t('hyrax.notifications.workflow.deposited.message', title: title, link: (link_to work_id, document_path),
-                                                                 user: user.user_key, comment: comment)
+        I18n.t('hyrax.notifications.workflow.deposited.message',
+               title: title,
+               link: (link_to work_id, document_path),
+               user: user.user_key,
+               comment: comment)
       end
 
       def users_to_notify
-        user_key = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: work_id).depositor
-        super << ::User.find_by(email: user_key)
+        user_key = @entity.proxy_for.depositor
+
+        super << ::User.find_by_user_key(user_key)
       end
     end
   end

data/app/services/hyrax/workflow/grant_edit_to_depositor.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
+    ##
     # This is a built in function for workflow, so that a workflow action can be created that
     # grants the creator the ability to alter it.
     module GrantEditToDepositor
@@ -8,11 +9,14 @@ module Hyrax
       # @return void
       def self.call(target:, **)
         return true unless target.try(:depositor)
-        target.edit_users = target.edit_users.to_a + Array.wrap(target.depositor) # += works in Ruby 2.6+
-        target.try(:permission_manager)&.acl&.save
+
+        model = target.try(:model) || target # get the model if target is a ChangeSet
+        model.edit_users = model.edit_users.to_a + Array.wrap(target.depositor) # += works in Ruby 2.6+
+        model.try(:permission_manager)&.acl&.save
+
         # If there are a lot of members, granting access to each could take a
         # long time. Do this work in the background.
-        GrantEditToMembersJob.perform_later(target, target.depositor)
+        GrantEditToMembersJob.perform_later(model, target.depositor)
       end
     end
   end

data/app/services/hyrax/workflow/grant_read_to_depositor.rb

@@ -1,16 +1,23 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
+    ##
     # This is a built in function for workflow, so that a workflow action can be created that
     # grants the creator the ability to view their work.
     module GrantReadToDepositor
-      # @param [#read_users=, #read_users] target (likely an ActiveRecord::Base) to which we are adding read_users for the depositor
+      # @param [#read_users=, #read_users] target to which we are adding read_users
+      #   for the depositor
       # @return void
       def self.call(target:, **)
-        target.read_users += [target.depositor]
+        return true unless target.try(:depositor)
+
+        model = target.try(:model) || target # get the model if target is a ChangeSet
+        model.read_users = model.read_users.to_a + Array.wrap(target.depositor) # += works in Ruby 2.6+
+        model.try(:permission_manager)&.acl&.save
+
         # If there are a lot of members, granting access to each could take a
         # long time. Do this work in the background.
-        GrantReadToMembersJob.perform_later(target, target.depositor)
+        GrantReadToMembersJob.perform_later(model, target.depositor)
       end
     end
   end

data/app/services/hyrax/workflow/revoke_edit_from_depositor.rb

@@ -1,14 +1,20 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
+    ##
     # This is a built in function for workflow, so that a workflow action can be created that
     # removes the creators the ability to alter it.
     module RevokeEditFromDepositor
       def self.call(target:, **)
-        target.edit_users -= [target.depositor]
+        return true unless target.try(:depositor)
+
+        model = target.try(:model) || target # get the model if target is a ChangeSet
+        model.edit_users = model.edit_users.to_a - Array.wrap(target.depositor)
+        model.try(:permission_manager)&.acl&.save
+
         # If there are a lot of members, revoking access from each could take a
         # long time. Do this work in the background.
-        RevokeEditFromMembersJob.perform_later(target, target.depositor)
+        RevokeEditFromMembersJob.perform_later(model, target.depositor)
       end
     end
   end

data/app/services/hyrax/workflow/workflow_action_service.rb

@@ -31,7 +31,8 @@ module Hyrax
       end
 
       def create_sipity_comment
-        return true if comment_text.blank?
+        return Sipity::NullComment.new(entity: subject.entity, agent: subject.agent) if
+          comment_text.blank?
         Sipity::Comment.create!(entity: subject.entity, agent: subject.agent, comment: comment_text)
       end
 
@@ -44,7 +45,9 @@ module Hyrax
         )
       end
 
+      ##
       # Run any configured custom methods
+      #
       def handle_additional_sipity_workflow_action_processing(comment:)
         Hyrax::Workflow::ActionTakenService.handle_action_taken(
           target: subject.work,

data/app/validators/hyrax/collection_membership_validator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Hyrax
+  # Validates that the record passes the multiple membership checker
+  class CollectionMembershipValidator < ActiveModel::Validator
+    def validate(record)
+      update_collections(record)
+      validation = validate_multi_membership(record)
+      return if validation == true
+      record.errors[:member_of_collection_ids] << validation
+    end
+
+    private
+
+    def validate_multi_membership(record)
+      # collections-in-collections do not have multi-membership restrictions
+      return true if record.is_a? Hyrax::Forms::PcdmCollectionForm
+
+      Hyrax::MultipleMembershipChecker.new(item: record).validate
+    end
+
+    def update_collections(record)
+      record.member_of_collection_ids = collections_ids(record)
+      record.member_of_collection_ids.uniq!
+    end
+
+    def collections_ids(record)
+      collection_ids = []
+      if record.member_of_collections_attributes.present?
+        record.member_of_collections_attributes
+              .each do |_k, h|
+                next if h["_destroy"] == "true"
+                collection_ids << Valkyrie::ID.new(h["id"])
+              end
+      end
+      collection_ids
+    end
+  end
+end

data/app/views/catalog/_index_header_list_hyrax_pcdm_collection.html.erb

@@ -0,0 +1,4 @@
+<div class="search-results-title-row">
+  <h3 class="search-result-title"><%= link_to document.title_or_label, [hyrax, document] %></h3>
+  <%= Hyrax::CollectionPresenter.new(document, current_ability).collection_type_badge %>
+</div>

data/app/views/hyrax/admin/admin_sets/_form.html.erb

@@ -26,7 +26,7 @@
                 <% if f.object.persisted? && f.object.member_ids.present? %>
                   <%# we're loading these values dynamically to speed page load %>
                   <%= f.input :thumbnail_id,
-                              input_html: { data: { text: f.object.thumbnail_title } } %>
+                              input_html: { data: { text: thumbnail_label_for(object: f.object) } } %>
                 <% end %>
 
               </div>

data/app/views/hyrax/admin/admin_sets/_form_participant_table.html.erb

@@ -1,6 +1,6 @@
                   <h3><%= t(".#{access}.title") %></h3>
                   <p><%= t(".#{access}.help") %></p>
-                  <% if @form.permission_template.access_grants.select(&filter).any? %>
+                  <% if collection_permission_template_form_for(form: @form).access_grants.select(&filter).any? %>
                     <table class="table table-striped share-status">
                       <thead>
                         <tr>
@@ -10,7 +10,7 @@
                         </tr>
                       </thead>
                       <tbody>
-                      <% @form.permission_template.access_grants.select(&filter).each do |g| %>
+                      <% collection_permission_template_form_for(form: @form).access_grants.select(&filter).each do |g| %>
                         <tr>
                           <td data-agent="<%= g.agent_id %>"><%= g.label %></td>
                           <td><%= g.agent_type.titleize %></td>

data/app/views/hyrax/admin/admin_sets/_form_participants.html.erb

@@ -5,7 +5,7 @@
                   <h3><%= t('.add_participants') %></h3>
                   <% access_options = options_for_select([['Manager', 'manage'], ['Depositor', 'deposit'], ['Viewer', 'view']]) %>
                   <div class="sharing-row-form">
-                    <%= simple_form_for @form.permission_template,
+                    <%= simple_form_for collection_permission_template_form_for(form: @form),
                         url: [hyrax, :admin, @form, :permission_template],
                         html: { id: 'group-participants-form', class: 'form-inline' } do |f| %>
 
@@ -33,7 +33,7 @@
                   </div>
 
                   <div class="sharing-row-form">
-                    <%= simple_form_for @form.permission_template,
+                    <%= simple_form_for collection_permission_template_form_for(form: @form),
                         url: [hyrax, :admin, @form, :permission_template],
                         html: { id: 'user-participants-form', class: 'form-inline add-users' } do |f| %>
 

data/app/views/hyrax/admin/admin_sets/_form_visibility.html.erb

@@ -1,6 +1,6 @@
           <div id="visibility" class="tab-pane">
             <div class="panel panel-default labels">
-              <%= simple_form_for @form.permission_template,
+              <%= simple_form_for collection_permission_template_form_for(form: @form),
                                   url: [hyrax, :admin, @form, :permission_template],
                                   html: { class: 'nav-safety' } do |f| %>
                 <div class="panel-body">
@@ -62,4 +62,4 @@
                 </div>
               <% end %>
             </div>
-          </div>
+          </div>

data/app/views/hyrax/admin/admin_sets/_form_workflow.erb

@@ -1,6 +1,6 @@
                 <div id="workflow" class="tab-pane">
                   <div class="panel panel-default labels">
-                    <%= simple_form_for @form.permission_template,
+                    <%= simple_form_for collection_permission_template_form_for(form: @form),
                       url: [hyrax, :admin, @form, :permission_template],
                       html: { id: 'form_workflows', class: 'nav-safety' } do |f| %>
                       <% if f.object.available_workflows.any? %>

data/app/views/hyrax/admin/analytics/_date_range_form.html.erb

@@ -0,0 +1,11 @@
+<div class="panel panel-default">
+  <div class="panel-heading"><h4><%= t('.date_range_heading') %></h4></div>
+  <div class="panel-body">
+    <%= form_tag(redirect_path, method: :get, class: "form-inline") do %>
+      <%= t('.start_date') %>: <%= date_field_tag :start_date, "", class: 'datepicker form-control', placeholder: 'mm/dd/yyyy', required: true %>
+      <%= t('.end_date') %>: <%= date_field_tag :end_date, "", class: 'datepicker form-control', placeholder: 'mm/dd/yyyy', required: true %>
+      <%= submit_tag "#{t('.set_date_range')}", class: 'btn btn-primary' %>
+      <%= link_to "#{t('.reset_date_range')}", redirect_path if params[:start_date] %>
+    <% end %>
+  </div>
+</div>

data/app/views/hyrax/admin/analytics/collection_reports/_custom_range.html.erb

@@ -0,0 +1,39 @@
+<div class="panel panel-default">
+  <div class="panel-heading"><h4><%= t('.summary_heading') %></h4></div>
+  <div class="panel-body">
+    <table class="table table-striped">
+      <thead>
+        <tr>
+          <th>&nbsp;</th>
+          <th><%= @start_date.to_date.strftime("%B %d, %Y") %> through <%= @end_date.to_date.strftime("%B %d, %Y") %></th>
+        </tr>
+      </thead>
+            <tbody>
+        <% if @pageviews %>
+          <tr>
+            <td><b><%= t('.collection_home_page_views') %></b></td>
+            <td><%= @pageviews.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+        <% if @work_page_views %>
+          <tr>
+            <td><b><%= t('.work_views') %></b></td>
+            <td><%= @work_page_views.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+        <% if @downloads %>
+          <tr>
+            <td><b><%= t('.work_downloads') %></b></td>
+            <td><%= @downloads.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<% if params[:start_date] %>
+  <% if @top_collections %>
+    <%= render 'top_collections' %>
+  <% end %>
+<% end %>