hyrax 3.2.0 → 3.3.0

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

@@ -29,6 +29,28 @@ 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
+
   private
 
   ##

data/app/controllers/hyrax/admin/analytics/analytics_controller.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+module Hyrax
+  module Admin
+    module Analytics
+      class AnalyticsController < ApplicationController
+        include Hyrax::SingularSubresourceController
+        before_action :set_months
+        before_action :set_date_range
+        before_action :set_document, only: [:show]
+        with_themed_layout 'dashboard'
+
+        def set_document
+          @document = ::SolrDocument.find(params[:id])
+        end
+
+        def set_months
+          @month_names = 12.downto(1).map { |n| DateTime::ABBR_MONTHNAMES.drop(1)[(Time.zone.today.month - n) % 12] }.reverse
+        end
+
+        def set_date_range
+          @start_date = params[:start_date] || Hyrax.config.analytics_start_date
+          @end_date = params[:end_date] || Time.zone.today + 1.day
+        end
+
+        def date_range
+          "#{@start_date},#{@end_date}"
+        end
+
+        def paginate(results_array, rows: 10)
+          return if results_array.nil?
+
+          total_pages = (results_array.size.to_f / rows.to_f).ceil
+          page = request.params[:page].nil? ? 1 : request.params[:page].to_i
+          current_page = page > total_pages ? total_pages : page
+          Kaminari.paginate_array(results_array, total_count: results_array.size).page(current_page).per(rows)
+        end
+      end
+    end
+  end
+end

data/app/controllers/hyrax/admin/analytics/collection_reports_controller.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module Hyrax
+  module Admin
+    module Analytics
+      class CollectionReportsController < AnalyticsController
+        include Hyrax::BreadcrumbsForCollectionAnalytics
+        def index
+          return unless Hyrax.config.analytics?
+
+          @pageviews = Hyrax::Analytics.daily_events('collection-page-view')
+          @work_page_views = Hyrax::Analytics.daily_events('work-in-collection-view')
+          @downloads = Hyrax::Analytics.daily_events('work-in-collection-download')
+          @all_top_collections = Hyrax::Analytics.top_events('work-in-collection-view', date_range)
+          @top_collections = paginate(@all_top_collections, rows: 10)
+          @top_downloads = Hyrax::Analytics.top_events('work-in-collection-download', date_range)
+          @top_collection_pages = Hyrax::Analytics.top_events('collection-page-view', date_range)
+          respond_to do |format|
+            format.html
+            format.csv { export_data }
+          end
+        end
+
+        def show
+          return unless Hyrax.config.analytics?
+          @document = ::SolrDocument.find(params[:id])
+          @pageviews = Hyrax::Analytics.daily_events_for_id(@document.id, 'collection-page-view')
+          @work_page_views = Hyrax::Analytics.daily_events_for_id(@document.id, 'work-in-collection-view')
+          @uniques = Hyrax::Analytics.unique_visitors_for_id(@document.id)
+          @downloads = Hyrax::Analytics.daily_events_for_id(@document.id, 'work-in-collection-download')
+          respond_to do |format|
+            format.html
+            format.csv { export_data }
+          end
+        end
+
+       private
+
+        # rubocop:disable Metrics/MethodLength
+        def export_data
+          csv_row = CSV.generate do |csv|
+            csv << ["Name", "ID", "View of Works In Collection", "Downloads of Works In Collection", "Collection Page Views"]
+            @all_top_collections.each do |collection|
+              document = begin
+                           ::SolrDocument.find(collection[0])
+                         rescue
+                           "Collection deleted"
+                         end
+              download_match = @top_downloads.detect { |a, _b| a == collection[0] }
+              download_count = download_match ? download_match[1] : 0
+              collection_match = @top_collection_pages.detect { |a, _b| a == collection[0] }
+              collection_count = collection_match ? collection_match[1] : 0
+              csv << [document, collection[0], collection[1], download_count, collection_count]
+            end
+          end
+          send_data csv_row, filename: "#{@start_date}-#{@end_date}-collections.csv"
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+    end
+  end
+end

data/app/controllers/hyrax/admin/analytics/work_reports_controller.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+module Hyrax
+  module Admin
+    module Analytics
+      class WorkReportsController < AnalyticsController
+        include Hyrax::BreadcrumbsForWorksAnalytics
+
+        def index
+          return unless Hyrax.config.analytics?
+
+          @accessible_works ||= accessible_works
+          @accessible_file_sets ||= accessible_file_sets
+          @works_count = @accessible_works.count
+          @top_works = paginate(top_works_list, rows: 10)
+          @top_file_set_downloads = paginate(top_files_list, rows: 10)
+
+          if current_user.ability.admin?
+            @pageviews = Hyrax::Analytics.daily_events('work-view')
+            @downloads = Hyrax::Analytics.daily_events('file-set-download')
+          end
+
+          respond_to do |format|
+            format.html
+            format.csv { export_data }
+          end
+        end
+
+        def show
+          @pageviews = Hyrax::Analytics.daily_events_for_id(@document.id, 'work-view')
+          @uniques = Hyrax::Analytics.unique_visitors_for_id(@document.id)
+          @downloads = Hyrax::Analytics.daily_events_for_id(@document.id, 'file_set_in_work_download')
+          @files = paginate(@document._source["file_set_ids_ssim"], rows: 5)
+          respond_to do |format|
+            format.html
+            format.csv { export_data }
+          end
+        end
+
+  private
+
+        def accessible_works
+          models = Hyrax.config.curation_concerns.map { |m| "\"#{m}\"" }
+          if current_user.ability.admin?
+            ActiveFedora::SolrService.query("has_model_ssim:(#{models.join(' OR ')})",
+              fl: 'title_tesim, id, member_of_collections',
+              rows: 50_000)
+          else
+            ActiveFedora::SolrService.query(
+              "edit_access_person_ssim:#{current_user} AND has_model_ssim:(#{models.join(' OR ')})",
+              fl: 'title_tesim, id, member_of_collections',
+              rows: 50_000
+            )
+          end
+        end
+
+        def accessible_file_sets
+          if current_user.ability.admin?
+            ActiveFedora::SolrService.query(
+              "has_model_ssim:FileSet",
+              fl: 'title_tesim, id',
+              rows: 50_000
+            )
+          else
+            ActiveFedora::SolrService.query(
+              "edit_access_person_ssim:#{current_user} AND has_model_ssim:FileSet",
+              fl: 'title_tesim, id',
+              rows: 50_000
+            )
+          end
+        end
+
+        def top_analytics_works
+          @top_analytics_works ||= Hyrax::Analytics.top_events('work-view', date_range)
+        end
+
+        def top_analytics_downloads
+          @top_analytics_downloads ||= Hyrax::Analytics.top_events('file-set-in-work-download', date_range)
+        end
+
+        def top_analytics_file_sets
+          @top_analytics_file_sets ||= Hyrax::Analytics.top_events('file-set-download', date_range)
+        end
+
+        def top_works_list
+          list = []
+          top_analytics_works
+          top_analytics_downloads
+          @accessible_works.each do |doc|
+            views_match = @top_analytics_works.detect { |id, _count| id == doc["id"] }
+            @view_count = views_match ? views_match[1] : 0
+            downloads_match = @top_analytics_downloads.detect { |id, _count| id == doc["id"] }
+            @download_count = downloads_match ? downloads_match[1] : 0
+            list.push([doc["id"], doc["title_tesim"].join(''), @view_count, @download_count, doc["member_of_collections"]])
+          end
+          list.sort_by { |l| -l[2] }
+        end
+
+        def top_files_list
+          list = []
+          top_analytics_file_sets
+          @accessible_file_sets.each do |doc|
+            downloads_match = @top_analytics_file_sets.detect { |id, _count| id == doc["id"] }
+            @download_count = downloads_match ? downloads_match[1] : 0
+            list.push([doc["id"], doc["title_tesim"].join(''), @download_count]) if doc["title_tesim"].present?
+          end
+          list.sort_by { |l| -l[2] }
+        end
+
+        def export_data
+          data = top_works_list
+          csv_row = CSV.generate do |csv|
+            csv << ["Name", "ID", "Work Page Views", "Total Downloads of File Sets In Work", "Collections"]
+            data.each do |d|
+              csv << [d[0], d[1], d[2], d[3], d[4]]
+            end
+          end
+          send_data csv_row, filename: "#{params[:start_date]}-#{params[:end_date]}-works.csv"
+        end
+      end
+    end
+  end
+end

data/app/controllers/hyrax/collections_controller.rb

@@ -4,10 +4,13 @@ module Hyrax
     include CollectionsControllerBehavior
     include BreadcrumbsForCollections
     with_themed_layout :decide_layout
-    load_and_authorize_resource except: [:index, :create],
+    load_and_authorize_resource except: [:index],
                                 instance_name: :collection,
                                 class: Hyrax.config.collection_model
 
+    skip_load_resource only: :create if
+      Hyrax.config.collection_class < ActiveFedora::Base
+
     # Renders a JSON response with a list of files in this collection
     # This is used by the edit form to populate the thumbnail_id dropdown
     def files

data/app/controllers/hyrax/dashboard/collections_controller.rb

@@ -86,11 +86,13 @@ module Hyrax
       end
 
       def after_create
-        form
-        set_default_permissions
-        # if we are creating the new collection as a subcollection (via the nested collections controller),
-        # we pass the parent_id through a hidden field in the form and link the two after the create.
-        link_parent_collection(params[:parent_id]) unless params[:parent_id].nil?
+        if @collection.is_a?(ActiveFedora::Base)
+          form
+          set_default_permissions
+          # if we are creating the new collection as a subcollection (via the nested collections controller),
+          # we pass the parent_id through a hidden field in the form and link the two after the create.
+          link_parent_collection(params[:parent_id]) unless params[:parent_id].nil?
+        end
         respond_to do |format|
           Hyrax::SolrService.commit
           format.html { redirect_to edit_dashboard_collection_path(@collection), notice: t('hyrax.dashboard.my.action.collection_create_success') }
@@ -220,11 +222,13 @@ module Hyrax
           @collection = transactions['change_set.create_collection']
                         .with_step_args(
                           'change_set.set_user_as_depositor' => { user: current_user },
+                          'change_set.add_to_collections' => { collection_ids: Array(params[:parent_id]) },
                           'collection_resource.apply_collection_type_permissions' => { user: current_user }
                         )
                         .call(form)
                         .value_or { return after_create_error }
 
+        after_create
         add_members_to_collection unless batch.empty?
         @collection
       end
@@ -241,6 +245,10 @@ module Hyrax
         Hyrax::CollectionType.find_or_create_default_collection_type
       end
 
+      def default_collection_type_gid
+        default_collection_type.to_global_id.to_s
+      end
+
       def collection_type
         @collection_type ||= CollectionType.find_by_gid!(collection.collection_type_gid)
       end
@@ -390,7 +398,8 @@ module Hyrax
           form_class.model_attributes(params[:collection])
         else
           params.permit(collection: {})[:collection]
-                .merge(params.permit(:collection_type_gid))
+                .merge(params.permit(:collection_type_gid)
+                             .with_defaults(collection_type_gid: default_collection_type_gid))
                 .merge(member_of_collection_ids: Array(params[:parent_id]))
         end
       end

data/app/controllers/hyrax/dashboard_controller.rb

@@ -6,6 +6,7 @@ module Hyrax
     with_themed_layout 'dashboard'
     before_action :authenticate_user!
     before_action :build_breadcrumbs, only: [:show]
+    before_action :set_date_range
 
     ##
     # @!attribute [rw] sidebar_partials
@@ -26,5 +27,12 @@ module Hyrax
         render 'show_user'
       end
     end
+
+    private
+
+    def set_date_range
+      @start_date = params[:start_date] || Time.zone.today - 1.month
+      @end_date = params[:end_date] || Time.zone.today + 1.day
+    end
   end
 end

data/app/controllers/hyrax/stats_controller.rb

@@ -7,7 +7,9 @@ module Hyrax
     before_action :build_breadcrumbs, only: [:work, :file]
 
     def work
-      @stats = Hyrax::WorkUsage.new(params[:id])
+      @document = ::SolrDocument.find(params[:id])
+      @pageviews = Hyrax::Analytics.daily_events_for_id(@document.id, 'work-view')
+      @downloads = Hyrax::Analytics.daily_events_for_id(@document.id, 'file-set-in-work-download')
     end
 
     def file

data/app/forms/hyrax/forms/pcdm_collection_form.rb

@@ -17,6 +17,9 @@ module Hyrax
 
       property :member_of_collection_ids, default: [], type: Valkyrie::Types::Array
 
+      validates :title, presence: true
+      validates :collection_type_gid, presence: true
+
       class << self
         def model_class
           Hyrax::PcdmCollection

data/app/indexers/hyrax/valkyrie_file_set_indexer.rb

@@ -37,7 +37,7 @@ module Hyrax
         solr_doc['file_format_tesim']       = file_format(file_metadata)
         solr_doc['file_format_sim']         = file_format(file_metadata)
         solr_doc['file_size_lts']           = file_metadata.size[0]
-        solr_doc['type_tesim']              = file_metadata.type if file_metadata.type.present?
+        solr_doc['type_tesim']              = file_metadata.type.map(&:to_s) if file_metadata.type.present?
 
         # attributes set by fits
         solr_doc['format_label_tesim']      = file_metadata.format_label if file_metadata.format_label.present?

data/app/jobs/characterize_job.rb

@@ -1,7 +1,27 @@
 # frozen_string_literal: true
+
+##
+# a +ActiveJob+ job to process file characterization.
+#
+# the characterization process is handled by a service object, which is
+# configurable via {CharacterizeJob.characterization_service}.
+#
+# @example setting a custom characterization service
+#   class MyCharacterizer
+#     def run(file, path)
+#       # do custom characterization
+#     end
+#   end
+#
+#   # in a Rails initializer
+#   CharacterizeJob.characterization_service = MyCharacterizer.new
+# end
 class CharacterizeJob < Hyrax::ApplicationJob
   queue_as Hyrax.config.ingest_queue_name
 
+  class_attribute :characterization_service
+  self.characterization_service = Hydra::Works::CharacterizationService
+
   # Characterizes the file at 'filepath' if available, otherwise, pulls a copy from the repository
   # and runs characterization on that file.
   # @param [FileSet] file_set
@@ -17,7 +37,7 @@ class CharacterizeJob < Hyrax::ApplicationJob
   private
 
   def characterize(file_set, _file_id, filepath)
-    Hydra::Works::CharacterizationService.run(file_set.characterization_proxy, filepath)
+    characterization_service.run(file_set.characterization_proxy, filepath)
     Rails.logger.debug "Ran characterization on #{file_set.characterization_proxy.id} (#{file_set.characterization_proxy.mime_type})"
     file_set.characterization_proxy.alpha_channels = channels(filepath) if file_set.image? && Hyrax.config.iiif_image_server?
     file_set.characterization_proxy.save!
@@ -31,4 +51,11 @@ class CharacterizeJob < Hyrax::ApplicationJob
     end
     [ch]
   end
+
+  ##
+  # @api public
+  # @return [#run]
+  def characterization_service
+    self.class.characterization_service
+  end
 end