hyrax 3.0.2 → 3.1.0

data/app/services/hyrax/solr_service.rb

@@ -37,7 +37,8 @@ module Hyrax
                                    'Use `Hyrax.config.solr_select_path` instead'
       end
 
-      delegate :add, :commit, :count, :delete, :get, :instance, :ping, :post, :query, :delete_by_query, :search_by_id, to: :new
+      delegate :add, :commit, :count, :delete, :get, :instance, :ping, :post,
+               :query, :delete_by_query, :search_by_id, :wipe!, to: :new
     end
 
     # Wraps rsolr get
@@ -100,6 +101,12 @@ module Hyrax
       connection.delete_by_id(id, params: COMMIT_PARAMS)
     end
 
+    # Deletes all solr documents
+    def wipe!
+      delete_by_query("*:*")
+      commit
+    end
+
     # Wraps rsolr add
     # @return [Hash] the hash straight form rsolr
     def add(solr_doc, commit: true)

data/app/services/hyrax/statistics/depositors/summary.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
-# Gather information about the depositors who have contributed to the repository
 module Hyrax
   module Statistics
     module Depositors
+      ##
+      # Gather information about the depositors who have contributed to the repository
       class Summary
         include Blacklight::SearchHelper
 

data/app/services/hyrax/work_uploads_handler.rb

@@ -48,7 +48,9 @@ module Hyrax
     #   @return [Enumberable<Hyrax::UploadedFile>]
     # @!attribute [r] work
     #   @return [Hyrax::Work]
-    attr_reader :files, :work
+    # @!attribute [r] file_set_params
+    #   @return [Enumerable<Hash>]
+    attr_reader :files, :work, :file_set_params
 
     ##
     # @param [Hyrax::Work] work
@@ -71,9 +73,10 @@ module Hyrax
     # @return [WorkFileSetManager] self
     # @raise [ArgumentError] if any of the uploaded files are not an
     #   `UploadedFile`
-    def add(files:)
+    def add(files:, file_set_params: [])
       validate_files(files) &&
         @files = Array.wrap(files).reject { |f| f.file_set_uri.present? }
+      @file_set_params = file_set_params
       self
     end
 
@@ -105,6 +108,10 @@ module Hyrax
 
       # copy ACLs; should we also be propogating embargo/lease?
       Hyrax::AccessControlList.copy_permissions(source: target_permissions, target: file_set)
+
+      # set visibility from params and save
+      file_set.visibility = file_set_extra_params(file)[:visibility] if file_set_extra_params(file)[:visibility].present?
+      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))
@@ -135,6 +142,14 @@ module Hyrax
         title: file.uploader.filename }
     end
 
+    ##
+    # @api private
+    #
+    # return [Hash(Symbol => Object)]
+    def file_set_extra_params(file)
+      file_set_params&.find { |fs| fs[:uploaded_file_id] == file.id.to_s } || {}
+    end
+
     ##
     # @api private
     #

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+module Hyrax
+  module Workflow
+    ##
+    # Produces a list of workflow-ready objects for a given user. Results are
+    # given as a presenter objects with SolrDocument-like behavior, with added
+    # support for workflow states.
+    #
+    # @example
+    #   Hyrax::Workflow::ActionableObjects.new(user: current_user).each do |object|
+    #     puts object.title
+    #     puts object.workflow_state
+    #   end
+    #
+    # @see Hyrax::Workflow::ObjectInWorkflowDecorator
+    class ActionableObjects
+      include Enumerable
+
+      ##
+      # @!attribute [rw] user
+      #   @return [::User]
+      attr_accessor :user
+
+      ##
+      # @param [::User] user the user whose
+      def initialize(user:)
+        @user = user
+      end
+
+      ##
+      # @return [Hyrax::Workflow::ObjectInWorkflowDecorator]
+      def each
+        return enum_for(:each) unless block_given?
+        ids_and_states = id_state_pairs
+        return if ids_and_states.none?
+
+        docs = Hyrax::SolrQueryService.new.with_ids(ids: ids_and_states.map(&:first)).solr_documents
+
+        docs.each do |solr_doc|
+          object = ObjectInWorkflowDecorator.new(solr_doc)
+          _, state = ids_and_states.find { |id, _| id == object.id }
+
+          object.workflow_state = state
+
+          yield object
+        end
+      end
+
+      private
+
+      ##
+      # @api private
+      # @return [Array[String, Sipity::WorkflowState]]
+      def id_state_pairs
+        gids_and_states = PermissionQuery
+                          .scope_entities_for_the_user(user: user)
+                          .pluck(:proxy_for_global_id, :workflow_state_id)
+
+        return [] if gids_and_states.none?
+
+        all_states = Sipity::WorkflowState.find(gids_and_states.map(&:last).uniq)
+
+        gids_and_states.map do |str, state_id|
+          [GlobalID.new(str).model_id,
+           all_states.find { |state| state.id == state_id }]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Workflow
+    ##
+    # Decorates objects with attributes with their workflow state.
+    class ObjectInWorkflowDecorator < Hyrax::ModelDecorator
+      delegate_all
+
+      ##
+      # @!attribute [w] workflow
+      #   @return [Sipity::Workflow]
+      # @!attribute [w] workflow_state
+      #   @return [Sipity::WorkflowState]
+      attr_writer :workflow, :workflow_state
+
+      ##
+      # @return [Boolean]
+      def published?
+        Hyrax::Admin::WorkflowsController.deposited_workflow_state_name ==
+          workflow_state
+      end
+
+      ##
+      # @return [String]
+      def workflow_state
+        @workflow_state&.name || 'unknown'
+      end
+    end
+  end
+end

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

@@ -1,35 +1,65 @@
 # frozen_string_literal: true
 module Hyrax
   module Workflow
-    # Finds a list of works that we can perform a workflow action on
+    ##
+    # @deprecated use the Hyrax::Workflow::ActionableObjects enumerator instead.
+    #   that service is designed as a more efficient and ergonomic replacement
+    #   for this one, and has fewer dependencies on specific indexing behavior.
+    #
+    # Finds a list of works that a given user can perform a workflow action on.
     class StatusListService
-      # @param context [#current_user, #logger]
+      ##
+      # @param context_or_user [::User, #current_user]
       # @param filter_condition [String] a solr filter
-      def initialize(context, filter_condition)
-        @context = context
+      #
+      # @raise [ArgumentError] if th caller fails to provide a user
+      def initialize(context_or_user, filter_condition)
+        Deprecation
+          .warn("Use the Hyrax::Workflow::ActionableObjects enumerator instead.")
+
+        case context_or_user
+        when ::User
+          @user = context_or_user
+        when nil
+          raise ArgumentError, "A current user MUST be provided."
+        else
+          Deprecation.warn('Initializing StatusListService with a controller ' \
+                           '"context" is deprecated. Pass in a user instead.')
+          @context = context_or_user
+          @user = @context.current_user
+        end
         @filter_condition = filter_condition
       end
 
+      ##
+      # @!attribute [r] context
+      #   @deprecated
+      #   @return [#current_user]
       attr_reader :context
+      deprecation_deprecate :context
 
-      # TODO: We will want to paginate this
-      # @return [Array<StatusRow>] a list of results that the given user can take action on.
+      ##
+      # @todo We will want to paginate this
+      # @return [Enumerable<StatusRow>] a list of results that the given user can take action on.
       def each
         return enum_for(:each) unless block_given?
+
         solr_documents.each do |doc|
           yield doc
         end
       end
 
-      # TODO: Make this private for version 1.0
+      ##
+      # @deprecated
       def user
-        context.current_user
+        Deprecation.warn('This method was always intended to be private. ' \
+                         'It will be removed in Hyrax 4.0')
+        @user
       end
 
       private
 
-      delegate :logger, to: :context
-
+      ##
       # @return [Hash<String,SolrDocument>] a hash of id to solr document
       def solr_documents
         search_solr.map { |result| ::SolrDocument.new(result) }
@@ -37,9 +67,9 @@ module Hyrax
 
       def search_solr
         actionable_roles = roles_for_user
-        logger.debug("Actionable roles for #{user.user_key} are #{actionable_roles}")
+        Hyrax.logger.debug("Actionable roles for #{@user.user_key} are #{actionable_roles}")
         return [] if actionable_roles.empty?
-        WorkRelation.new.search_with_conditions(query(actionable_roles), rows: 1000, method: :post)
+        WorkRelation.new.search_with_conditions(query(actionable_roles), method: :post)
       end
 
       def query(actionable_roles)
@@ -59,7 +89,7 @@ module Hyrax
       # @param workflow [Sipity::Workflow]
       # @return [ActiveRecord::Relation<Sipity::WorkflowRole>]
       def workflow_roles_for_user_and_workflow(workflow)
-        Hyrax::Workflow::PermissionQuery.scope_processing_workflow_roles_for_user_and_workflow(user: user, workflow: workflow)
+        Hyrax::Workflow::PermissionQuery.scope_processing_workflow_roles_for_user_and_workflow(user: @user, workflow: workflow)
       end
     end
   end

data/app/views/hyrax/base/_form_relationships.html.erb

@@ -1,8 +1,7 @@
 <% if Flipflop.assign_admin_set? %>
-  <%# TODO: avoid direct dependency on AdminSetService and AdminSetOptionsPresenter in the view!! make the controller provide the options! %>
   <%= f.input :admin_set_id, as: :select,
       include_blank: false,
-      collection: Hyrax::AdminSetOptionsPresenter.new(Hyrax::AdminSetService.new(controller)).select_options,
+      collection: admin_set_options,
       input_html: { class: 'form-control' } %>
 <% end %>
 

data/app/views/hyrax/base/_form_rendering.html.erb

@@ -7,7 +7,7 @@
       <div class="form-group">
         <span class="help-block"><%= t("hyrax.base.form_rendering.help_html") %></span>
         <%= f.select :rendering_ids,
-                    f.object.select_files,
+                    form_file_set_select_for(parent: f.object),
                     { include_blank: true },
                     { class: 'form-control', multiple: true } %>
       </div>

data/app/views/hyrax/base/_form_representative.html.erb

@@ -6,7 +6,7 @@
         </legend>
         <div class="form-group">
           <span class="help-block"><%= t("hyrax.base.form_representative.help_html") %></span>
-          <%= f.select :representative_id, @form.select_files, {}, { class: 'form-control' } %>
+          <%= f.select :representative_id, form_file_set_select_for(parent: @form), {}, { class: 'form-control' } %>
         </div>
       </fieldset>
     </div>

data/app/views/hyrax/base/_form_thumbnail.html.erb

@@ -6,7 +6,7 @@
         </legend>
         <div class="form-group">
           <span class="help-block"><%= t("hyrax.base.form_thumbnail.help_html") %></span>
-          <%= f.select :thumbnail_id, @form.select_files, {}, { class: 'form-control' } %>
+          <%= f.select :thumbnail_id, form_file_set_select_for(parent: @form), {}, { class: 'form-control' } %>
         </div>
       </fieldset>
     </div>

data/app/views/hyrax/base/_guts4form.html.erb

@@ -11,14 +11,14 @@
             <li role="presentation">
           <% end %>
               <a href="#<%= tab %>" aria-controls="<%= tab %>" role="tab" data-toggle="tab">
-                <%= t("hyrax.works.form.tab.#{tab}") %>
+                <%= form_tab_label_for(form: f.object, tab: tab) %>
               </a>
             </li>
         <% end %>
 
         <li role="presentation" id="tab-share" class="hidden">
           <a href="#share" aria-controls="share" role="tab" data-toggle="tab">
-            <%= t("hyrax.works.form.tab.share") %>
+            <%= form_tab_label_for(form: f.object, tab: 'share') %>
           </a>
         </li>
       </ul>

data/app/views/hyrax/base/_representative_media.html.erb

@@ -2,7 +2,7 @@
   <% if defined?(viewer) && viewer %>
     <%= iiif_viewer_display presenter %>
   <% else %>
-    <%= media_display presenter.representative_presenter %>
+    <%= render media_display_partial(presenter.representative_presenter), file_set: presenter.representative_presenter  %>
   <% end %>
 <% else %>
   <%= image_tag 'default.png', class: "canonical-image", alt: 'default representative image' %>

data/app/views/hyrax/base/_show_actions.html.erb

@@ -27,7 +27,7 @@
   <div class="col-sm-6 text-right">
     <% if presenter.editor? && !workflow_restriction?(presenter) %>
       <%= link_to t('.edit'), edit_polymorphic_path([main_app, presenter]), class: 'btn btn-default' %>
-      <% if presenter.member_presenters.size > 1 %>
+      <% if presenter.member_count > 1 %>
           <%= link_to t("hyrax.file_manager.link_text"), polymorphic_path([main_app, :file_manager, presenter]), class: 'btn btn-default' %>
       <% end %>
       <% if presenter.valid_child_concerns.length > 0 %>

data/app/views/hyrax/dashboard/collections/_form.html.erb

@@ -5,17 +5,17 @@
       <a href="#description" role="tab" data-toggle="tab" class="nav-safety-confirm"><%= t('.tabs.description') %></a>
     </li>
     <% if @form.persisted? %>
-      <% if @collection.brandable? %>
+      <% if collection_brandable?(collection: @collection) %>
       <li>
         <a href="#branding" role="tab" data-toggle="tab" class="nav-safety-confirm"><%= t('.tabs.branding') %></a>
       </li>
       <% end %>
-      <% if @collection.discoverable? %>
+      <% if collection_discoverable?(collection: @collection) %>
       <li>
         <a href="#discovery" role="tab" data-toggle="tab" class="nav-safety-confirm"><%= t('.tabs.discovery') %></a>
       </li>
       <% end %>
-      <% if @collection.sharable? %>
+      <% if collection_sharable?(collection: @collection) %>
       <li>
         <a href="#sharing" role="tab" data-toggle="tab" class="nav-safety-confirm"><%= t('.tabs.sharing') %></a>
       </li>

data/app/views/hyrax/dashboard/collections/_list_collections.html.erb

@@ -2,7 +2,7 @@
 <% id = collection_presenter.id %>
 <tr id="document_<%= id %>"
   data-id="<%= id %>"
-  data-colls-hash="<%= collection_presenter.available_parent_collections(scope: controller) %>"
+  data-colls-hash="<%= available_parent_collections_data(collection: collection_presenter) %>"
   data-post-url="<%= hyrax.dashboard_create_nest_collection_within_path(id) %>"
   data-post-delete-url="<%= is_admin_set ? hyrax.admin_admin_set_path(id) : hyrax.dashboard_collection_path(id) %>">
 

data/app/views/hyrax/dashboard/collections/edit.html.erb

@@ -1,7 +1,9 @@
-<% provide :page_title, construct_page_title( t('.header', type_title: @collection.collection_type.title, title: @form.title.first) ) %>
+<% type_title = collection_type_label_for(collection: @collection) %>
+
+<% provide :page_title, construct_page_title( t('.header', type_title: type_title, title: @form.title.first) ) %>
 
 <% provide :page_header do %>
-  <h1><span class="fa fa-edit" aria-hidden="true"></span><%= t('.header', type_title: @collection.collection_type.title, title: @form.title.first) %></h1>
+  <h1><span class="fa fa-edit" aria-hidden="true"></span><%= t('.header', type_title: type_title, title: @form.title.first) %></h1>
 <% end %>
 
 <div class="row">

data/app/views/hyrax/dashboard/collections/new.html.erb

@@ -1,6 +1,8 @@
-<% provide :page_title, construct_page_title( t('.header', type_title: @collection.collection_type.title) ) %>
+<% type_title = collection_type_label_for(collection: @collection) %>
+
+<% provide :page_title, construct_page_title( t('.header', type_title: type_title)) %>
 <% provide :page_header do %>
-  <h1><span class="fa fa-edit" aria-hidden="true"></span> <%= t('.header', type_title: @collection.collection_type.title) %> </h1>
+  <h1><span class="fa fa-edit" aria-hidden="true"></span> <%= t('.header', type_title: type_title) %> </h1>
 <% end %>
 
 <div class="row">

data/app/views/hyrax/dashboard/collections/show.html.erb

@@ -96,7 +96,7 @@
 
 <% if @presenter.collection_type_is_nestable? && !collection_search_parameters? %>
   <%= render 'hyrax/my/collections/modal_add_to_collection', source: 'show' %>
-  <%= render 'hyrax/my/collections/modal_add_subcollection', id: @presenter.id, source: 'show' %>
+  <%= render 'hyrax/my/collections/modal_add_subcollection', id: @presenter.id, presenter: @presenter, source: 'show' %>
   <%= render 'hyrax/dashboard/collections/modal_parent_collection_remove_deny', source: 'show' %>
 <% end %>
 

data/app/views/hyrax/file_sets/edit.html.erb

@@ -6,7 +6,7 @@
 
 <div class="row">
   <div class="col-xs-12 col-sm-4">
-    <%= media_display curation_concern.to_presenter %>
+    <%= render media_display_partial(curation_concern.to_presenter), file_set: curation_concern.to_presenter %>
   </div>
   <div class="col-xs-12 col-sm-8">
     <div class="panel panel-default tabs">

data/app/views/hyrax/file_sets/media_display/_audio.html.erb

@@ -1,4 +1,4 @@
-<% if Hyrax.config.display_media_download_link? && !workflow_restriction?(file_set.try(:parent)) %>
+<% if display_media_download_link?(file_set: file_set) %>
   <div>
       <h2 class="sr-only"><%= t('hyrax.file_set.show.downloadable_content.heading') %></h2>
       <audio controls="controls" class="audiojs" style="width:100%" controlsList="nodownload" preload="auto">