hyrax 1.1.1 → 2.0.0.beta1

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

@@ -7,6 +7,9 @@ module Hyrax
       # @return void
       def self.call(target:, **)
         target.read_users += [target.depositor]
+        # 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)
       end
     end
   end

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

@@ -48,10 +48,18 @@ module Hyrax
       # @return [Hash<String, Array>] a hash with keys being the strategy (e.g. "to", "cc") and
       #                               the values are a list of users.
       def recipients(notification)
-        notification.recipients.each_with_object({}) do |r, h|
-          h[r.recipient_strategy] ||= []
-          h[r.recipient_strategy] += PermissionQuery.scope_users_for_entity_and_roles(entity: entity,
-                                                                                      roles: r.role)
+        case entity.workflow_state.name
+        when 'pending_review'
+          # notify the managers to review the deposit (CC depositors)
+          {
+            to: entity.workflow.permission_template.agent_ids_for(access: 'manage',  agent_type: 'user'),
+            cc: entity.workflow.permission_template.agent_ids_for(access: 'deposit', agent_type: 'user')
+          }
+        else
+          notification.recipients.each_with_object({}) do |r, h|
+            h[r.recipient_strategy] ||= []
+            h[r.recipient_strategy] += PermissionQuery.scope_users_for_entity_and_roles(entity: entity, roles: r.role)
+          end
         end
       end
 

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

@@ -1,7 +1,7 @@
 module Hyrax
   module Workflow
     class PendingReviewNotification < AbstractNotification
-      protected
+      private
 
         def subject
           'Deposit needs review'
@@ -11,8 +11,6 @@ module Hyrax
           "#{title} (#{link_to work_id, document_path}) was deposited by #{user.user_key} and is awaiting approval #{comment}"
         end
 
-      private
-
         def users_to_notify
           super << user
         end

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

@@ -2,7 +2,17 @@ require 'active_support/core_ext/array/wrap'
 
 module Hyrax
   module Workflow
-    # A "power users" helper class. It builds out the permissions for a host of
+    # @api public
+    #
+    # This has three major uses:
+    #
+    # * To assign Work specific permissions (e.g. Sipity::EntitySpecificResponsibility)
+    #   - a depositor of a work has a Work specific permission
+    # * To assign Workflow specific permissions (e.g. Sipity::WorkflowResponsibility)
+    #   - the review of all deposited works has a Workflow specific permission
+    # * To assign Roles to different Actions, and thus allow users with those roles to take the given actions
+    #
+    # It is a "power users" helper class. It builds out the permissions for a host of
     # information.
     #
     # See the specs for more on what is happening, however the general idea is
@@ -10,11 +20,25 @@ module Hyrax
     # the :entity or the :workflow. Then creating the given :action_names for
     # the :workflow and :workflow_state and granting permission in that
     # :workflow_state for the given :role.
+    #
+    # @see Sipity::WorkflowResponsibility
+    # @see Sipity::EntitySpecificResponsibility
+    # @note And yes this violates some kind of single responsibility principle as it has many different access points
     class PermissionGenerator
+      # @todo Extract public class level methods that expose each of the primary purposes (instead of relying on parameters)
       def self.call(**keywords, &block)
         new(**keywords, &block).call
       end
 
+      # @param [Array<Sipity::Role, #string>] roles - converted to Sipity::Role
+      # @param [Sipity::Workflow] workflow -
+      # @param [Array<Object>] agents -
+      # @param [Sipity::Entity] entity - if given
+      #                                          - will grant the given :agents the given :roles for the given :entity (e.g. Sipity::EntitySpecificResponsibility)
+      #                                  if NOT given
+      #                                          - will grant the given :agents the given :roles for the given :workflow (e.g. Sipity::WorkflowResponsibility)
+      # @param [Array<String>] action_names - it will wire-up the workflow, allowing the given :roles to take the given :actions
+      # @todo Extract public class level methods that expose each of the options (and don't rely on an external parameter list)
       def initialize(roles:, workflow:, agents: [], **keywords)
         self.roles = roles
         self.workflow = workflow
@@ -67,7 +91,7 @@ module Hyrax
 
         def create_action_and_permission_for(action_name, workflow_role)
           workflow_action = Sipity::WorkflowAction.find_or_create_by!(workflow: workflow, name: action_name)
-          return unless workflow_state.present?
+          return if workflow_state.blank?
           state_action = Sipity::WorkflowStateAction.find_or_create_by!(
             workflow_action: workflow_action, originating_workflow_state: workflow_state
           )

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

@@ -20,6 +20,18 @@ module Hyrax
     module PermissionQuery
       module_function
 
+      def entity_responsibilities
+        @entity_responsibilities ||= Sipity::EntitySpecificResponsibility.arel_table
+      end
+
+      def workflow_responsibilities
+        @workflow_responsibilities ||= Sipity::WorkflowResponsibility.arel_table
+      end
+
+      def workflow_roles
+        @workflow_roles ||= Sipity::WorkflowRole.arel_table
+      end
+
       # @api public
       #
       # For the given :user and :entity return only workflow actions that meet all of the following:
@@ -56,9 +68,6 @@ module Hyrax
       def scope_agents_associated_with_entity_and_role(entity:, role:)
         entity = PowerConverter.convert_to_sipity_entity(entity)
         role = PowerConverter.convert_to_sipity_role(role)
-        workflow_roles = Sipity::WorkflowRole.arel_table
-        workflow_responsibilities = Sipity::WorkflowResponsibility.arel_table
-        entity_responsibilities = Sipity::EntitySpecificResponsibility.arel_table
 
         agents = Sipity::Agent.arel_table
 
@@ -119,7 +128,6 @@ module Hyrax
       def scope_roles_associated_with_the_given_entity(entity:)
         entity = PowerConverter.convert_to_sipity_entity(entity)
         return Sipity::Role.none unless entity
-        workflow_roles = Sipity::WorkflowRole.arel_table
         Sipity::Role.where(
           Sipity::Role.arel_table[:id].in(
             workflow_roles.project(workflow_roles[:role_id]).where(
@@ -153,7 +161,7 @@ module Hyrax
       # @param user [User]
       # @return [ActiveRecord::Relation<Sipity::Agent>]
       def scope_processing_agents_for(user:)
-        return Sipity::Agent.none unless user.present?
+        return Sipity::Agent.none if user.blank?
         return Sipity::Agent.none unless user.persisted?
         user_agent = PowerConverter.convert_to_sipity_agent(user)
         group_agents = user.groups.map do |g|
@@ -183,8 +191,6 @@ module Hyrax
         workflow_state_actions = Sipity::WorkflowStateAction.arel_table
         workflow_states = Sipity::WorkflowState.arel_table
         workflow_state_action_permissions = Sipity::WorkflowStateActionPermission.arel_table
-        workflow_responsibilities = Sipity::WorkflowResponsibility.arel_table
-        entity_responsibilities = Sipity::EntitySpecificResponsibility.arel_table
 
         user_agent_scope = scope_processing_agents_for(user: user)
         user_agent_contraints = user_agent_scope.arel_table.project(
@@ -238,9 +244,6 @@ module Hyrax
         role_ids = Array.wrap(roles).map { |role| PowerConverter.convert_to_sipity_role(role).id }
         user_polymorphic_type = PowerConverter.convert_to_polymorphic_type(::User)
 
-        workflow_roles = Sipity::WorkflowRole.arel_table
-        workflow_responsibilities = Sipity::WorkflowResponsibility.arel_table
-        entity_responsibilities = Sipity::EntitySpecificResponsibility.arel_table
         user_table = ::User.arel_table
         agent_table = Sipity::Agent.arel_table
 
@@ -306,23 +309,19 @@ module Hyrax
       # @param workflow [Sipity::Workflow]
       # @return [ActiveRecord::Relation<Sipity::WorkflowRole>]
       def scope_processing_workflow_roles_for_user_and_workflow(user:, workflow:)
-        responsibility_table = Sipity::WorkflowResponsibility.arel_table
-        workflow_role_table = Sipity::WorkflowRole.arel_table
-
         agent_constraints = scope_processing_agents_for(user: user)
-        workflow_role_subquery = workflow_role_table[:id].in(
-          responsibility_table.project(responsibility_table[:workflow_role_id])
+        workflow_role_subquery = workflow_roles[:id].in(
+          workflow_responsibilities.project(workflow_responsibilities[:workflow_role_id])
           .where(
-            responsibility_table[:agent_id].in(
+            workflow_responsibilities[:agent_id].in(
               agent_constraints.arel_table.project(
                 agent_constraints.arel_table[:id]
               ).where(agent_constraints.arel.constraints)
             )
           )
         )
-
         Sipity::WorkflowRole.where(
-          workflow_role_table[:workflow_id].eq(workflow.id).and(workflow_role_subquery)
+          workflow_roles[:workflow_id].eq(workflow.id).and(workflow_role_subquery)
         )
       end
 
@@ -338,18 +337,16 @@ module Hyrax
       def scope_processing_workflow_roles_for_user_and_entity_specific(user:, entity:)
         entity = PowerConverter.convert_to_sipity_entity(entity)
         agent_scope = scope_processing_agents_for(user: user)
-        specific_resp_table = Sipity::EntitySpecificResponsibility.arel_table
-        workflow_role_table = Sipity::WorkflowRole.arel_table
 
         Sipity::WorkflowRole.where(
-          workflow_role_table[:id].in(
-            specific_resp_table.project(specific_resp_table[:workflow_role_id])
+          workflow_roles[:id].in(
+            entity_responsibilities.project(entity_responsibilities[:workflow_role_id])
             .where(
-              specific_resp_table[:agent_id].in(
+              entity_responsibilities[:agent_id].in(
                 agent_scope.arel_table.project(
                   agent_scope.arel_table[:id]
                 ).where(
-                  agent_scope.arel.constraints.reduce.and(specific_resp_table[:entity_id].eq(entity.id))
+                  agent_scope.arel.constraints.reduce.and(entity_responsibilities[:entity_id].eq(entity.id))
                 )
               )
             )

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

@@ -5,6 +5,9 @@ module Hyrax
     module RevokeEditFromDepositor
       def self.call(target:, **)
         target.edit_users -= [target.depositor]
+        # 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)
       end
     end
   end

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

@@ -22,15 +22,15 @@ module Hyrax
         subject.work.update_index # So that the new actions and state are written into solr.
       end
 
-      protected
+      private
 
         def update_sipity_workflow_state
-          return true unless action.resulting_workflow_state_id.present?
+          return true if action.resulting_workflow_state_id.blank?
           subject.entity.update!(workflow_state_id: action.resulting_workflow_state_id)
         end
 
         def create_sipity_comment
-          return true unless comment_text.present?
+          return true if comment_text.blank?
           Sipity::Comment.create!(entity: subject.entity, agent: subject.agent, comment: comment_text)
         end
 

data/app/services/hyrax/working_directory.rb

@@ -1,6 +1,9 @@
 module Hyrax
+  # @deprecated Use JobIoWrapper instead
   class WorkingDirectory
     class << self
+      # Returns the file passed as filepath if that file exists. Otherwise it grabs the file from repository,
+      # puts it on the disk and returns that path.
       # @param [String] repository_file_id identifier for Hydra::PCDM::File
       # @param [String] id the identifier of the FileSet
       # @param [String, NilClass] filepath path to existing cached copy of the file

data/app/uploaders/hyrax/avatar_uploader.rb

@@ -11,6 +11,6 @@ class Hyrax::AvatarUploader < CarrierWave::Uploader::Base
   end
 
   def extension_whitelist
-    %w(jpg jpeg png gif bmp tif tiff)
+    %w[jpg jpeg png gif bmp tif tiff]
   end
 end

data/app/views/_flash_msg.html.erb

@@ -2,7 +2,7 @@
   <% if flash[type].present? %>
     <div class="alert <%= flash_dom_class %> alert-dismissable" role="alert">
       <button type="button" class="close" data-dismiss="alert" aria-label="Close"><span aria-hidden="true">&times;</span></button>
-      <%= sanitize Array.wrap(flash[type]).join(tag(:br)) %>
+      <%= safe_join(Array.wrap(flash[type]).map(&:html_safe), '<br/>'.html_safe) %>
     </div>
     <% flash.delete(type) %>
   <% end %>

data/app/views/_masthead.html.erb

@@ -13,8 +13,6 @@
     </div>
 
     <div class="collapse navbar-collapse" id="top-navbar-collapse">
-      <%= render '/toolbar' %>
-
       <%= render '/user_util_links' %>
     </div>
   </div>

data/app/views/_user_util_links.html.erb

@@ -1,14 +1,11 @@
 <ul id="user_utility_links" class="nav navbar-nav navbar-right">
-    <%= render 'shared/locale_picker' if available_translations.size > 1 %>
-    <% if user_signed_in? %>
+  <%= render 'shared/locale_picker' if available_translations.size > 1 %>
+  <% if user_signed_in? %>
     <li>
-      <%= link_to hyrax.notifications_path do %>
-        <%= t("hyrax.toolbar.notifications") %>
-        <%= render 'hyrax/users/notify_number' %>
-      <% end %>
+      <%= render 'hyrax/users/notify_number' %>
     </li>
     <li class="dropdown">
-      <%= link_to hyrax.profile_path(current_user), role: 'button', data: { toggle: 'dropdown' }, aria: { haspopup: true, expanded: false} do %>
+      <%= link_to hyrax.dashboard_profile_path(current_user), role: 'button', data: { toggle: 'dropdown' }, aria: { haspopup: true, expanded: false} do %>
         <span class="sr-only"><%= t("hyrax.toolbar.profile.sr_action") %></span>
         <span class="hidden-xs">&nbsp;<%= current_user.name %></span>
         <span class="sr-only"> <%= t("hyrax.toolbar.profile.sr_target") %></span>
@@ -16,8 +13,8 @@
         <span class="caret"></span>
       <% end %>
       <ul class="dropdown-menu dropdown-menu-right" role="menu">
-        <li><%= link_to t("hyrax.toolbar.profile.view"), hyrax.profile_path(current_user) %></li>
-        <li><%= link_to t("hyrax.toolbar.profile.edit"), hyrax.edit_profile_path(current_user) %></li>
+        <li><%= link_to t("hyrax.toolbar.dashboard.menu"), hyrax.dashboard_path %></li>
+
         <li class="divider"></li>
         <li><%= link_to t("hyrax.toolbar.profile.logout"), main_app.destroy_user_session_path %></li>
       </ul>
@@ -25,7 +22,7 @@
   <% else %>
     <li>
       <%= link_to main_app.new_user_session_path do %>
-        <span class="glyphicon glyphicon-log-in" aria-hidden="true"></span > <%= t("hyrax.toolbar.profile.login") %>
+        <span class="glyphicon glyphicon-log-in" aria-hidden="true"></span> <%= t("hyrax.toolbar.profile.login") %>
       <% end %>
     </li>
   <% end %>

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

@@ -1,5 +1,3 @@
 <li id="document_<%= document.to_param %>" class="document <%= render_document_class document %>" itemscope itemtype="<%= document.itemtype %>">
-  <div class="row">
-    <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, document_counter: document_counter %>
-  </div>
+  <%= render_document_partials document, blacklight_config.view_config(document_index_view_type).partials, document_counter: document_counter %>
 </li>

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

@@ -1,4 +1,4 @@
-    <div class="col-sm-9">
+    <div class="metadata">
       <table class="table">
         <% doc_presenter = index_presenter(document) %>
         <% index_fields(document).each do |field_name, field| -%>
@@ -12,3 +12,4 @@
       </table>
     </div>
 
+    <div class="clearfix"></div>

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

@@ -3,7 +3,7 @@
   <%= hidden_field_tag :search_field, 'all_fields' %>
   <div class="input-group">
 
-    <label class="sr-only" for="search-field-header"><%= t("hyrax.search.form.q.label") %></label>
+    <label class="sr-only" for="search-field-header"><%= t("hyrax.search.form.q.label", application_name: application_name) %></label>
     <%= text_field_tag :q, current_search_parameters , class: "q form-control", id: "search-field-header", placeholder: t("hyrax.search.form.q.placeholder") %>
 
     <div class="input-group-btn">
@@ -11,24 +11,24 @@
         <%= t('hyrax.search.button.html') %>
       </button>
       <button class="btn btn-default dropdown-toggle" type="button" data-toggle="dropdown">
-        <span data-search-element="label"><%= t("hyrax.search.form.option.all.label_long") %></span>
+        <span data-search-element="label"><%= t("hyrax.search.form.option.all.label_long", application_name: application_name) %></span>
         <span class="caret"></span>
       </button>
 
       <ul class="dropdown-menu pull-right">
         <li>
-          <%= link_to t("hyrax.search.form.option.all.label_long"), "#",
+          <%= link_to t("hyrax.search.form.option.all.label_long", application_name: application_name), "#",
               data: { "search-option" => main_app.search_catalog_path, "search-label" => t("hyrax.search.form.option.all.label_short") } %>
         </li>
 
         <% if current_user %>
           <li>
             <%= link_to t("hyrax.search.form.option.my_works.label_long"), "#",
-                data: { "search-option" => hyrax.dashboard_works_path, "search-label" => t("hyrax.search.form.option.my_works.label_short") } %>
+                data: { "search-option" => hyrax.my_works_path, "search-label" => t("hyrax.search.form.option.my_works.label_short") } %>
           </li>
           <li>
             <%= link_to t("hyrax.search.form.option.my_collections.label_long"), "#",
-                data: { "search-option" => hyrax.dashboard_collections_path, "search-label" => t("hyrax.search.form.option.my_collections.label_short") } %>
+                data: { "search-option" => hyrax.my_collections_path, "search-label" => t("hyrax.search.form.option.my_collections.label_short") } %>
           </li>
           <li>
             <%= link_to t("hyrax.search.form.option.my_shares.label_long"), "#",

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

@@ -1,4 +1,3 @@
-    <div class="col-sm-3">
+    <div class="list-thumbnail">
       <%= render_thumbnail_tag document %>
     </div>
-

data/app/views/collections/edit_fields/_based_near.html.erb

@@ -0,0 +1,8 @@
+<%= f.input key,
+            as: :multi_value,
+            input_html: {
+              class: 'form-control',
+              data: { 'autocomplete-url' => "/authorities/search/geonames",
+                      'autocomplete' => key }
+            },
+            required: f.object.required?(key) %>

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

@@ -23,7 +23,9 @@
                 <%= render 'form_metadata', f: f %>
 
                 <% if f.object.persisted? && f.object.member_ids.present? %>
-                  <%= f.input :thumbnail_id, collection: @form.select_files %>
+                  <%# we're loading these values dynamically to speed page load %>
+                  <%= f.input :thumbnail_id,
+                              input_html: { data: { text: f.object.thumbnail_title } } %>
                 <% end %>
 
               </div>

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

@@ -12,13 +12,22 @@
                       <tbody>
                       <% @form.permission_template.access_grants.select(&filter).each do |g| %>
                         <tr>
-                          <td><%= g.agent_id %></td>
+                          <td data-agent="<%= g.agent_id %>"><%= g.label %></td>
                           <td><%= g.agent_type.titleize %></td>
-                          <td><%= button_to t(".#{access}.remove"), hyrax.admin_permission_template_access_path(g), method: :delete, class: 'btn btn-danger' %></td>
+                          <td>
+                            <% if g.admin_group? %>
+                              <%= button_to t(".#{access}.remove"), hyrax.admin_permission_template_access_path(g), method: :delete, class: 'btn btn-danger disabled', disabled: true, title: t('hyrax.admin.admin_sets.form.permission_destroy_errors.admin_group') %>
+                            <% else %>
+                              <%= button_to t(".#{access}.remove"), hyrax.admin_permission_template_access_path(g), method: :delete, class: 'btn btn-danger' %>
+                            <% end %>
+                          </td>
                         </tr>
                       <% end %>
                       </tbody>
                     </table>
                   <% else %>
-                    <em><%= t(".#{access}.empty") %></em>
+                    <p><em><%= t(".#{access}.empty") %></em></p>
                   <% end %>
+                  <%= button_tag t('.allow_all_registered'),
+                                 class: 'btn btn-info',
+                                 data: { behavior: 'add-registered-users' } if access == 'depositors'%>

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

@@ -7,7 +7,7 @@
     <th>Date Uploaded</th>
     <th>Visibility</th>
     <th>Status</th>
-    <th>Action</th>
+    <th>Actions</th>
   </tr>
   </thead>
   <tbody>