hyrax 3.2.0 → 3.4.1

data/app/actors/hyrax/actors/file_actor.rb

@@ -76,6 +76,8 @@ module Hyrax
       end
 
       def perform_ingest_file_through_valkyrie(io) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        Deprecation.warn "FileActor support for Valkyrie was experimental and " \
+                         "is slated to be removed in favor of WorkUploadsHandler."
         file =
           begin
             Hyrax.storage_adapter.upload(resource: file_set, file: io, original_filename: io.original_name, use: relation)
@@ -85,12 +87,12 @@ module Hyrax
           end
         file_metadata = Hyrax.custom_queries.find_file_metadata_by(id: file.id)
         create_version(file_metadata, user)
-        id = file_metadata.file_identifier
-        file_set.file_ids << id
-        file_set.original_file_id = id
+
+        file_set.file_ids << file_metadata.id
+        file_set.original_file_id = file_metadata.id
         Hyrax.persister.save(resource: file_set)
         Hyrax.publisher.publish('object.metadata.updated', object: file_set, user: user)
-        CharacterizeJob.perform_later(file_set, id.to_s, pathhint(io))
+        CharacterizeJob.perform_later(file_set, file_metadata.id.to_s, pathhint(io))
         file_metadata
       end
 

data/app/actors/hyrax/actors/transfer_request_actor.rb

@@ -1,17 +1,12 @@
 # frozen_string_literal: true
 module Hyrax
   module Actors
-    ##
-    # @deprecated transfer requests are now carried out in response to published
-    # 'object.deposited' events.
-    #
     # Notify the provided owner that their proxy wants to make a
     # deposit on their behalf
     class TransferRequestActor < AbstractActor
       # @param [Hyrax::Actors::Environment] env
       # @return [Boolean] true if create was successful
       def create(env)
-        Deprecation.warn('Use Hyrax::Listeners::ProxyDepositListener instead.')
         next_actor.create(env) && create_proxy_deposit_request(env)
       end
 
@@ -20,8 +15,9 @@ module Hyrax
       def create_proxy_deposit_request(env)
         proxy = env.curation_concern.on_behalf_of
         return true if proxy.blank?
-        ContentDepositorChangeEventJob.perform_later(env.curation_concern,
-                                                     ::User.find_by_user_key(proxy))
+        work = env.curation_concern
+        user = ::User.find_by_user_key(proxy)
+        Hyrax::ChangeDepositorService.call(work, user, false)
         true
       end
     end

data/app/assets/javascripts/hyrax/admin/graphs.es6

@@ -1,46 +1,44 @@
 export default class {
-
     constructor(data) {
         this.userSelector = 'user-activity'
         this.growthSelector = 'dashboard-growth'
         this.statusSelector = 'dashboard-repository-objects'
-
         if (this.hasSelector(this.userSelector))
             this.userActivity(data.userActivity);
         if (this.hasSelector(this.growthSelector))
             this.repositoryGrowth(data.repositoryGrowth);
         if (this.hasSelector(this.statusSelector))
             this.objectStatus(data.repositoryObjects);
-
     }
-
     // Don't attempt to initialize Morris if the selector is not on the page
     // otherwise it raises a "Graph container element not found" error
     hasSelector(selector) {
-      return $(`#${selector}`).length > 0;
+        return $(`#${selector}`).length > 0;
     }
-
     // Draws a bar chart of new user signups
     userActivity(data) {
-        if (typeof data === "undefined")
-            return
+        if (typeof data === 'undefined') return
         Morris.Bar({
-             element: this.userSelector,
-             data: data,
-             xkey: 'y',
-             // TODO: when we add returning users:
-             // ykeys: ['a', 'b'],
-             // labels: ['New Users', 'Returning'],
-             ykeys: ['a'],
-             labels: ['New Users', 'Returning'],
-             barColors: ['#33414E', '#3FBAE4'],
-             gridTextSize: '10px',
-             hideHover: true,
-             resize: true,
-             gridLineColor: '#E5E5E5'
-         });
+            element: this.userSelector,
+            data: data,
+            xkey: 'y',
+            ykeys: ['new_users', 'new_visitors', 'returning_visitors', 'total_visitors'],
+            labels: ['New Users', 'New Visitors', 'Returning Visitors', 'Total Visitors'],
+            // TODO: use the ykeys and labels below when the returning_users method in
+            // user_activity_presenter.rb returns data
+            // ykeys: ['new_users', 'returning_users', 'new_visitors', 'returning_visitors', 'total_visitors'],
+            // labels: ['New Users', 'Returning Users', 'New Visitors', 'Returning Visitors', 'Total Visitors'],
+            barColors: [
+                '#001219','#005f73','#0a9396','#94d2bd','#e9d8a6',
+                '#ee9b00','#ca6702','#bb3e03','#ae2012','#9b2226'
+            ],
+            gridTextSize: '12px',
+            hideHover: true,
+            resize: true,
+            gridLineColor: '#E5E5E5',
+            stacked: true
+        });
     }
-
     // Draws a donut chart of active/inactive objects
     objectStatus(data) {
         if (typeof data === "undefined")
@@ -48,28 +46,27 @@ export default class {
         Morris.Donut({
             element: this.statusSelector,
             data: data,
-            colors: ['#33414E', '#3FBAE4', '#FEA223'],
-            gridTextSize: '9px',
+            colors: ['#001219','#005f73','#0a9396','#94d2bd','#e9d8a6','#ee9b00','#ca6702','#bb3e03','#ae2012','#9b2226'],
+            gridTextSize: '12px',
             resize: true
         });
     }
-
     // Creates a line graph of collections and object in the last 90 days
     repositoryGrowth(data) {
         if (typeof data === "undefined")
             return
         Morris.Line({
-           element: this.growthSelector,
-           data: data,
-           xkey: 'y',
-           ykeys: ['a','b'],
-           labels: ['Objects','Collections'],
-           resize: true,
-           hideHover: true,
-           xLabels: 'day',
-           gridTextSize: '10px',
-           lineColors: ['#3FBAE4','#33414E'],
-           gridLineColor: '#E5E5E5'
+            element: this.growthSelector,
+            data: data,
+            xkey: 'y',
+            ykeys: ['works','collections'],
+            labels: ['Works','Collections'],
+            resize: true,
+            hideHover: true,
+            xLabels: 'day',
+            gridTextSize: '12px',
+            lineColors: ['#001219','#005f73','#0a9396','#94d2bd','#e9d8a6','#ee9b00','#ca6702','#bb3e03','#ae2012','#9b2226'],
+            gridLineColor: '#E5E5E5'
         });
     }
 }

data/app/assets/javascripts/hyrax/analytics_events.js

@@ -0,0 +1,75 @@
+class TrackingTags {
+  constructor(provider) {
+    this.provider = provider
+  }
+
+  analytics() {
+    if(this.provider === "matomo") {
+      return _paq;
+    }
+    else {
+      return _gaq;
+    }
+  }
+
+  pageView() {
+    if(this.provider === "matomo") {
+      return 'trackPageView'
+    } else {
+      return '_trackPageview'
+    }
+  }
+
+  trackEvent() {
+    if(this.provider === "matomo") {
+      return 'trackEvent'
+    } else {
+      return '_trackEvent'
+    }
+  }
+}
+
+function trackPageView() {
+  window.trackingTags.analytics().push([window.trackingTags.pageView()]);
+}
+
+function trackAnalyticsEvents() {
+  $('span.analytics-event').each(function(){
+    var eventSpan = $(this)
+    window.trackingTags.analytics().push([window.trackingTags.trackEvent(), eventSpan.data('category'), eventSpan.data('action'), eventSpan.data('name')]);
+  })
+}
+
+function setupTracking() {
+    var provider = $('meta[name="analytics-provider"]').prop('content')
+    if (provider === undefined) {
+      return;
+    }
+    window.trackingTags = new TrackingTags(provider)
+    trackPageView()
+    trackAnalyticsEvents()
+}
+
+if (typeof Turbolinks !== 'undefined') {
+  $(document).on('turbolinks:load', function() {
+    setupTracking()
+  })
+} else {
+  $(document).on('ready', function() {
+    setupTracking()
+  })
+}
+
+$(document).on('click', '#file_download', function(e) {
+  var provider = $('meta[name="analytics-provider"]').prop('content')
+  if (provider === undefined) {
+    return;
+  }
+  window.trackingTags = new TrackingTags(provider)
+  window.trackingTags.analytics().push([trackingTags.trackEvent(), 'file-set', 'file-set-download', $(this).data('label')]);
+  window.trackingTags.analytics().push([trackingTags.trackEvent(), 'file-set-in-work', 'file-set-in-work-download', $(this).data('work-id')]);
+  $(this).data('collection-ids').forEach(function (collection) {
+    window.trackingTags.analytics().push([trackingTags.trackEvent(), 'file-set-in-collection', 'file-set-in-collection-download', collection]);
+    window.trackingTags.analytics().push([trackingTags.trackEvent(), 'work-in-collection', 'work-in-collection-download', collection]);
+  });
+});

data/app/assets/javascripts/hyrax/autocomplete/linked_data.es6

@@ -40,11 +40,9 @@ export default class LinkedData {
         // Called when Select2 is created to allow the user to initialize the
         // selection based on the value of the element select2 is attached to.
         // Essentially this is an id->object mapping function.
-
-        // TODO: Presently we're just showing a URI, but we should show the label.
         var data = {
           id: element.val(),
-          label: element.val()
+          label: element[0].dataset.label || element.val()
         };
         callback(data);
       },

data/app/assets/javascripts/hyrax/collapse.js

@@ -62,6 +62,21 @@ function getStatusSettings(){
     }
 }
 
+function getStatusAnalytics(){
+    const resultDiv = document.getElementById('collapseAnalytics');
+    const isCollapsed = getCollapsedSettings();
+    if (resultDiv === null) {
+        return;
+    }
+    else if(isCollapsed){
+        resultDiv.classList.remove("in");
+        resultDiv.setAttribute("aria-expanded", "false");
+    }else{
+        resultDiv.classList.add("in");
+        resultDiv.setAttribute("aria-expanded", "true");
+    }
+}
+
 function toggleCollapse(input){
     var type = input.href;
     var start = type.indexOf("#");
@@ -76,6 +91,15 @@ function toggleCollapse(input){
         }
     }
 
+    if (type === "collapseReports"){
+        const isCollapsedReports = getCollapsedReports();
+        if(isCollapsedReports){
+            localStorage.setItem('collapsedReports', 'un-collapsed');
+        }else{
+            localStorage.setItem('collapsedReports', 'collapsed');
+        }
+    }
+
     if (type === "collapseSettings"){
         const isCollapsedSettings = getCollapsedSettings();
         if(isCollapsedSettings){

data/app/assets/javascripts/hyrax/collections.js

@@ -319,10 +319,9 @@ Blacklight.onLoad(function () {
     submitModalAjax(url, 'POST', data, $(this));
   });
 
-
   // Handle add a subcollection button click on the collections show page
   $('.sub-collections-wrapper button.add-subcollection').on('click', function (e) {
     $('#add-subcollection-modal-' + $(this).data('presenterId')).modal('show');
   });
 
-});
+});

data/app/assets/javascripts/hyrax/ga_events.js

@@ -1,10 +1,4 @@
 // Callbacks for tracking events using Google Analytics
-
-// Note: there is absence of testing here.  I'm not sure how or to what extent we can test what's getting
-// sent to Google Analytics.
-
 $(document).on('click', '#file_download', function(e) {
-  _gaq.push(['_trackEvent', 'Files', 'Downloaded', $(this).data('label')]);
-    
-});
-
+  _gaq.push(['_trackEvent', 'Files', 'Downloaded', $(this).data('label')]);    
+});

data/app/assets/javascripts/hyrax/reports-buttons.js

@@ -0,0 +1,33 @@
+Blacklight.onLoad(function() {
+  var summaryButton = $('#summary-btn');
+  var monthlyButton = $('#monthly-btn');
+  var rangeButton = $('#range-btn');
+
+  $('#monthly-btn').on('click', function() {
+    $(this).addClass('btn-primary');
+    $(this).removeClass('btn-default');
+    summaryButton.removeClass('btn-primary');
+    summaryButton.addClass('btn-default');
+    rangeButton.removeClass('btn-primary');
+    rangeButton.addClass('btn-default');
+  });
+
+  $('#summary-btn').on('click', function() {
+    
+    $(this).addClass('btn-primary');
+    $(this).removeClass('btn-default');
+    monthlyButton.removeClass('btn-primary');
+    monthlyButton.addClass('btn-default');
+    rangeButton.removeClass('btn-primary');
+    rangeButton.addClass('btn-default');
+  });
+
+  $('#range-btn').on('click', function() {
+    $(this).addClass('btn-primary');
+    $(this).removeClass('btn-default');
+    monthlyButton.removeClass('btn-primary');
+    monthlyButton.addClass('btn-default');
+    summaryButton.removeClass('btn-primary');
+    summaryButton.addClass('btn-default');
+  });
+});

data/app/assets/javascripts/hyrax.js

@@ -56,7 +56,7 @@
 //= require hyrax/search
 //= require hyrax/content_blocks
 //= require hyrax/nav_safety
-//= require hyrax/ga_events
+//= require hyrax/analytics_events
 //= require hyrax/select_submit
 //= require hyrax/tabs
 //= require hyrax/user_search
@@ -107,6 +107,7 @@
 //= require hyrax/i18n_helper
 //= require hyrax/collapse
 //= require hyrax/skip_to_content
+//= require hyrax/reports-buttons
 
 // this needs to be after batch_select so that the form ids get setup correctly
 //= require hyrax/batch_edit

data/app/assets/stylesheets/_bootstrap-default-overrides.scss

@@ -18,3 +18,12 @@ $brand-warning: #565653 !default;
 // * Darkens the text for disabled pagination buttons on every page.
 $breadcrumb-active-color: #4c4c4c;
 $pagination-disabled-color: #4c4c4c;
+
+// Date picker on safari placeholder text was misaligned
+@media screen {
+  @media screen and (-webkit-min-device-pixel-ratio: 0) {
+    input[type="date"].form-control {
+      line-height: 16px;
+    }
+  }
+}

data/app/authorities/qa/authorities/collections.rb

@@ -7,12 +7,11 @@ module Qa::Authorities
     def search(_q, controller)
       # The Hyrax::CollectionSearchBuilder expects a current_user
       return [] unless controller.current_user
-      response, _docs = search_response(controller)
+      response, = search_response(controller)
       docs = response.documents
+
       docs.map do |doc|
-        id = doc.id
-        title = doc.title
-        { id: id, label: title, value: id }
+        { id: doc.id, label: doc.title, value: doc.id }
       end
     end
 
@@ -32,7 +31,7 @@ module Qa::Authorities
       access = controller.params[:access] || 'read'
 
       search_service(controller).search_results do |builder|
-        builder.where(controller.params[:q])
+        builder.with({ q: controller.params[:q] })
                .with_access(access)
                .rows(100)
       end

data/app/authorities/qa/authorities/find_works.rb

@@ -33,7 +33,7 @@ module Qa::Authorities
       access = controller.params[:access] || 'read'
 
       search_service(controller).search_results do |builder|
-        builder.where(controller.params[:q])
+        builder.with({ q: controller.params[:q] })
                .with_access(access)
                .rows(100)
       end

data/app/controllers/concerns/hyrax/breadcrumbs_for_collection_analytics.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Hyrax
+  module BreadcrumbsForCollectionAnalytics
+    extend ActiveSupport::Concern
+    include Hyrax::Breadcrumbs
+
+    included do
+      before_action :build_breadcrumbs, only: [:index, :show]
+    end
+
+    def add_breadcrumb_for_controller
+      add_breadcrumb I18n.t('hyrax.dashboard.breadcrumbs.collections_report'), hyrax.admin_analytics_collection_reports_path
+    end
+
+    def add_breadcrumb_for_action
+      case action_name
+      when 'show'
+        add_breadcrumb params[:id].to_s, hyrax.admin_analytics_collection_reports_path(params[:id]), mark_active_action
+      end
+    end
+
+    def mark_active_action
+      { "aria-current" => "page" }
+    end
+  end
+end

data/app/controllers/concerns/hyrax/breadcrumbs_for_works_analytics.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Hyrax
+  module BreadcrumbsForWorksAnalytics
+    extend ActiveSupport::Concern
+    include Hyrax::Breadcrumbs
+
+    included do
+      before_action :build_breadcrumbs, only: [:index, :show]
+    end
+
+    def add_breadcrumb_for_controller
+      add_breadcrumb I18n.t('hyrax.dashboard.breadcrumbs.works_report'), hyrax.admin_analytics_work_reports_path
+    end
+
+    def add_breadcrumb_for_action
+      case action_name
+      when 'show'
+        add_breadcrumb params[:id].to_s, hyrax.admin_analytics_work_reports_path(params[:id]), mark_active_action
+      end
+    end
+
+    def mark_active_action
+      { "aria-current" => "page" }
+    end
+  end
+end

data/app/controllers/concerns/hyrax/controller.rb

@@ -17,6 +17,9 @@ module Hyrax::Controller
     helper_method :create_work_presenter
     before_action :set_locale
     before_action :check_read_only, except: [:show, :index]
+
+    class_attribute :search_service_class
+    self.search_service_class = Hyrax::SearchService
   end
 
   # Provide a place for Devise to send the user to after signing in
@@ -29,6 +32,46 @@ module Hyrax::Controller
     super.merge(locale: I18n.locale)
   end
 
+  ##
+  # @deprecated provides short-term compatibility with Blacklight 6
+  # @return [Class<Blacklight::SearchBuilder>]
+  def search_builder_class
+    return super if defined?(super)
+    Deprecation.warn("Avoid direct calls to `#search_builder_class`; this" \
+                     " method provides short-term compatibility to" \
+                     " Blacklight 6 clients.")
+    blacklight_config.search_builder_class
+  end
+
+  ##
+  # @deprecated provides short-term compatibility with Blacklight 6
+  # @return [Blacklight::AbstractRepository]
+  def repository
+    return super if defined?(super)
+    Deprecation.warn("Avoid direct calls to `#repository`; this method" \
+                     " provides short-term compatibility to Blacklight 6 " \
+                     " clients.")
+    blacklight_config.repository
+  end
+
+  # @note for Blacklight 6/7 compatibility
+  def search_results(*args)
+    return super if defined?(super) # use the upstream if present (e.g. in BL 6)
+
+    search_service(*args).search_results
+  end
+
+  ##
+  # @note for Blacklight 6/7 compatibility
+  def search_service(**search_params)
+    return super if defined?(super) && search_params.empty?
+
+    search_service_class.new(config: blacklight_config,
+                             scope: self,
+                             user_params: search_params,
+                             search_builder_class: search_builder_class)
+  end
+
   private
 
   ##