hyrax 3.0.1 → 3.3.0

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/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/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/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/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/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/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 %>

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

@@ -0,0 +1,48 @@
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h4><%= t('.monthly_subtitle') %> <%= Time.zone.today.strftime("%B %Y") %></h4>
+  </div>
+  <div class="panel-body">
+    <table class="table table-striped">
+      <thead>
+      <tr>
+        <th>&nbsp;</th>
+        <% @month_names.each do |name| %>
+          <th><%= name %></th>
+        <% end %>
+      </tr>
+      </thead>
+      <tbody>
+      <% if @pageviews %>    
+        <tr>
+          <td><b><%= t('.collection_views') %></b></td>
+          <% @month_names.each do |name| %>
+            <td><%= @pageviews.month(name.to_date) %></td>
+          <% end %>
+        </tr>
+      <% end %>
+      <% if @work_page_views %>
+        <tr>
+          <td><b><%= t('.work_views') %></b></td>
+            <% @month_names.each do |name| %>
+            <td><%= @work_page_views.month(name.to_date) %></td>
+          <% end %>
+        </tr>
+      <% end %>
+      <% if @downloads %>
+        <tr>
+          <td><b><%= t('.work_downloads') %></b></td>
+            <% @month_names.each do |name| %>
+            <td><%= @downloads.month(name.to_date) %></td>
+          <% end %>
+        </tr>
+      <% end %>
+      
+      </tbody>
+    </table>
+  </div>
+</div>
+
+
+
+

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

@@ -0,0 +1,55 @@
+<div class="panel panel-default">
+  <div class="panel-heading">
+  <h4><%= t('.subtitle')%></h4>
+  </div>
+  <div class="panel-body">
+    <table class="table table-striped">
+      <thead>
+        <tr>
+          <th>&nbsp;</th>
+          <th><%= t('.today') %></th>
+          <th><%= t('.this_week') %></th>
+          <th><%= t('.this_month') %></th>
+          <th><%= t('.this_year') %></th>
+          <th><%= t('.all_time') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% if @pageviews %>
+          <tr>
+            <td><b><%= t('.collection_home_page_views') %></b></td>
+            <td><%= @pageviews.day %></td>
+            <td><%= @pageviews.week %></td>
+            <td><%= @pageviews.month %></td>
+            <td><%= @pageviews.year %></td>
+            <td><%= @pageviews.all %></td>
+          </tr>
+        <% end %>
+        <% if @work_page_views %>
+          <tr>
+            <td><b><%= t('.work_views') %></b></td>
+            <td><%= @work_page_views.day %></td>
+            <td><%= @work_page_views.week %></td>
+            <td><%= @work_page_views.month %></td>
+            <td><%= @work_page_views.year %></td>
+            <td><%= @work_page_views.all %></td>
+          </tr>
+        <% end %>
+        <% if @downloads %>
+          <tr>
+            <td><b><%= t('.work_downloads') %></b></td>
+            <td><%= @downloads.day %></td>
+            <td><%= @downloads.week %></td>
+            <td><%= @downloads.month %></td>
+            <td><%= @downloads.year %></td>
+            <td><%= @downloads.all %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<% if @top_collections %>
+  <%= render 'top_collections' %>
+<% end %>

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

@@ -0,0 +1,55 @@
+<div class="panel panel-default">
+  
+  <div class="panel-heading">
+    <h4><%= t('.top_collections') %>
+    <div class="btn-group pull-right">
+      <%= link_to "#{t('.export')}", admin_analytics_collection_reports_path(start_date: @start_date, end_date: @end_date, format: :csv, disposition: "attachment"), class: "btn btn-default" %>
+    </div>
+    </h4>
+  </div>
+
+  <div class="panel-body">
+    <table class="table table-striped">
+      <thead>
+        <tr>
+          <th><%= t('.collection_title') %></th>
+          <th><%= t('.works_in_collection_views') %></th>
+          <th><%= t('.file_downloads_in_collection') %></th>
+          <th><%= t('.collection_page_views') %></th>
+        </tr>
+      </thead>
+      <tbody>
+        <% @top_collections.each do |collection| %>
+          <% document = ::SolrDocument.find(collection[0]) rescue document = nil %>
+            <tr>
+            <% if document %>
+              <td><%= link_to document, admin_analytics_collection_report_path(collection[0]) %></td>
+            <% else %>
+              <td><i><%= t('.deleted') %></i></td>
+            <% end %>
+              <td><%= collection[1] %></td>
+              <td>
+                  <% match = @top_downloads.detect {|a,b| a == collection[0]} %>
+                <%= match ? match[1] : 0 %>
+              </td>
+              <td>
+                  <% match = @top_collection_pages.detect {|a,b| a == collection[0]} %>
+                  <%= match ? match[1] : 0 %>
+              </td>
+            </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+  
+  <div class="panel-footer">
+    <div class="pull-right">
+      <%= paginate @top_collections %>
+    </div>
+  </div>
+
+</div>
+
+
+
+

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

@@ -0,0 +1,70 @@
+<% provide :page_title, "#{t('.title')}" %>
+
+<% provide :page_header do %>
+  <h1><span class="fa fa-bar-chart" aria-hidden="true"></span> <%= t('.title') %></h1>
+<% end %>
+
+<div class="row">
+  <div class="col-sm-12">
+    <div class="collection-reports">
+
+<% if Hyrax.config.analytics? %>
+      <div class="panel panel-default">
+        <div class="panel-heading"><%= t('.repo_summary') %> <b><%= pluralize(Collection.count, "collection") %></b>, <%= t('.repo_summary_2') %> <b><%= @pageviews.all %> <%= t('.views') %></b> <%= t('.and') %> <b><%= @downloads.all %> <%= t('.downloads') %></b>.</div>
+        <div class="panel-body">
+      
+               <div class="row text-center">
+                <div class="nav nav-pills btn-group" role="group">
+                    <% if params[:start_date] %>
+                     <a button id='summary-btn' class="btn btn-default nav-link" type="button" href="#summary" data-toggle="pill">
+                    <% else %>
+                     <a button id='summary-btn' class="btn btn-primary nav-link" type="button" href="#summary" data-toggle="pill">
+                    <% end %>
+                        <%= t('.summary') %>
+                     </a>
+                      <a button id='monthly-btn' class="btn btn-default nav-link" type="button" href="#monthly" data-toggle="pill">
+                        <%= t('.monthly') %>
+                      </a>
+                    <% if params[:start_date] %>
+                      <a button id='range-btn' class="btn btn-primary nav-link" type="button" href="#custom-range" data-toggle="pill">
+                    <% else %>
+                      <a button id='range-btn' class="btn btn-default nav-link" type="button" href="#custom-range" data-toggle="pill">
+                    <% end %>
+                        <%= t('.custom_range') %>
+                      </a>
+                </div>
+              </div>
+              <br>
+              <div class="tab-content">
+              <% if params[:start_date] %>
+                <div class="tab-pane" id="summary">
+              <% else %>
+                <div class="tab-pane active" id="summary">
+              <% end %>
+                  <%= render "summary" %>
+                </div>
+                <div class="tab-pane" id="monthly">
+                  <%= render "monthly_summary" %>
+                </div>
+                 <% if params[:start_date] %>
+                  <div class="tab-pane active" id="custom-range">
+                <% else %>
+                  <div class="tab-pane" id="custom-range">
+                <% end %>
+                  <%= render "hyrax/admin/analytics/date_range_form", redirect_path: hyrax.admin_analytics_collection_reports_path %>
+                  <%= render "custom_range" %></div>
+              </div>
+            
+            </div>
+          </div>
+          <p class="text-center"><%= t('.report_generated_on') %> <b><%= Time.current %></b>.</p>
+        </div>
+      </div>
+  <% else %>
+    <div class="alert alert-warning" role="alert">
+      <%= t('.enable_analytics') %>
+    </div>
+  <% end %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,94 @@
+<% provide :page_title, "#{t('.title')}" %>
+
+<% provide :page_header do %>
+  <h1><span class="fa fa-bar-chart" aria-hidden="true"></span> <%= t('.title') %>
+  <%= link_to "#{t('.return_to_btn')}", admin_analytics_collection_reports_path, class: "btn btn-primary pull-right" %>
+  </h1>
+  <br>
+<% end %>
+
+<div class="row">
+  <div class="col-sm-12">
+    <div class="collection-reports">
+
+      <div class="panel panel-default">
+        <div class="panel-heading">
+          <div class="col-sm-10">
+            <h3><%= @document %></h3>
+          </div>
+          <div class="col-sm-2">
+            <%= link_to "#{t('.view_collection_btn')}", collection_path(@document.id), class: "btn btn-default pull-right" %>
+          </div>
+        </div>
+
+        <div class="panel-body">
+          <div class="row">
+            <div class="col-xs-12 col-md-5">
+              <p><%= t('.created_by') %> <b><%= @document.depositor %></b> on <b><%= @document.create_date %></b></p>
+              <p><%= t('.collection_type') %> <b><%= @document.collection_type_gid %></b></p>
+            </div>
+            <div class="col-xs-12 col-md-5">
+              <p><%= t('.last_updated') %> <b><%= @document.modified_date.strftime("%B %d, %Y") %></b></p>
+              <p><%= t('.visibility') %> <b><%= @document.read_groups.join(",") %></b></p>
+            </div>
+          </div>
+        </div>
+      </div>          
+
+            <div class="row text-center">
+        <div class="nav nav-pills btn-group" role="group">
+            <% if params[:start_date] %>
+              <a button id='summary-btn' class="btn btn-default nav-link" type="button" href="#summary" data-toggle="pill">
+            <% else %>
+              <a button id='summary-btn' class="btn btn-primary nav-link" type="button" href="#summary" data-toggle="pill">
+            <% end %>
+                <%= t('.summary') %>
+              </a>
+              <a button id='monthly-btn' class="btn btn-default nav-link" type="button" href="#monthly" data-toggle="pill">
+                <%= t('.monthly') %>
+              </a>
+            <% if params[:start_date] %>
+              <a button id='range-btn' class="btn btn-primary nav-link" type="button" href="#custom-range" data-toggle="pill">
+            <% else %>
+              <a button id='range-btn' class="btn btn-default nav-link" type="button" href="#custom-range" data-toggle="pill">
+            <% end %>
+                <%= t('.custom_range') %>
+              </a>
+        </div>
+      </div>
+  <br>
+       <div class="tab-content">
+          <% if params[:start_date] %>
+            <div class="tab-pane" id="summary">
+          <% else %>
+            <div class="tab-pane active" id="summary">
+          <% end %>
+              <%= render "summary" %>
+            </div>
+
+            <div class="tab-pane" id="monthly">
+              <%= render "monthly_summary" %>
+            </div>
+            
+          <% if params[:start_date] %>
+            <div class="tab-pane active" id="custom-range">
+          <% else %>
+            <div class="tab-pane" id="custom-range">
+          <% end %>
+              <%= render "hyrax/admin/analytics/date_range_form", redirect_path: hyrax.admin_analytics_collection_report_path(@document) %>
+              <%= render "custom_range" %>
+            </div>
+        </div>
+         
+         
+          <% if @files&.any? %>
+           <%= render "collection_files" %>
+          <% end %>
+
+        </div>
+
+      </div>
+
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,43 @@
+<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('.page_views') %></b></td>
+            <td><%= @pageviews.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+        <% if @downloads %>
+          <tr>
+            <td><b><%= t('.file_downloads') %></b></td>
+            <td><%= @downloads.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+        <% if @uniques %>
+          <tr>
+            <td><b><%= t('.unique_visitors') %></b></td>
+            <td><%= @uniques.range(@start_date.to_date, @end_date.to_date) %></td>
+          </tr>
+        <% end %>
+      </tbody>
+    </table>
+  </div>
+</div>
+
+<% if params[:start_date] %>
+  <% if @top_works %>
+      <div><%= render 'top_works' %></div>
+  <% end %>
+
+  <% if @top_file_set_downloads %>
+    <div><%= render 'top_file_set_downloads' %></div>
+  <% end %>
+<% end %>