hyrax 3.0.1 → 3.3.0

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/admin/permission_template_accesses_controller.rb

@@ -30,16 +30,12 @@ module Hyrax
         false
       end
 
-      def update_access(manage_changed:)
-        permission_template_form.update_access(manage_changed: manage_changed)
-      end
-
       def after_destroy_success
         if source.admin_set?
           redirect_to hyrax.edit_admin_admin_set_path(source_id,
                                                       anchor: 'participants'),
                       notice: translate('participants', scope: 'hyrax.admin.admin_sets.form.permission_update_notices')
-        elsif source.collection?
+        else
           redirect_to hyrax.edit_dashboard_collection_path(source_id,
                                                            anchor: 'sharing'),
                       notice: translate('sharing', scope: 'hyrax.dashboard.collections.form.permission_update_notices')
@@ -51,7 +47,7 @@ module Hyrax
           redirect_to hyrax.edit_admin_admin_set_path(source_id,
                                                       anchor: 'participants'),
                       alert: @permission_template_access.errors.full_messages.to_sentence
-        elsif source.collection?
+        else
           redirect_to hyrax.edit_dashboard_collection_path(source_id,
                                                            anchor: 'sharing'),
                       alert: @permission_template_access.errors.full_messages.to_sentence
@@ -60,6 +56,9 @@ module Hyrax
 
       delegate :source_id, to: :permission_template
 
+      ##
+      # @todo can we avoid querying solr to deciede where to redirect? we
+      #   otherwise don't need this data at all.
       def source
         @source ||= ::SolrDocument.find(source_id)
       end

data/app/controllers/hyrax/admin/workflows_controller.rb

@@ -15,8 +15,9 @@ module Hyrax
       add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
       add_breadcrumb t(:'hyrax.admin.sidebar.tasks'), '#'
       add_breadcrumb t(:'hyrax.admin.sidebar.workflow_review'), request.path
-      @status_list = Hyrax::Workflow::StatusListService.new(self, "-workflow_state_name_ssim:#{deposited_workflow_state_name}")
-      @published_list = Hyrax::Workflow::StatusListService.new(self, "workflow_state_name_ssim:#{deposited_workflow_state_name}")
+
+      @status_list = actionable_objects.reject(&:published?)
+      @published_list = actionable_objects.select(&:published?)
     end
 
     private
@@ -24,5 +25,10 @@ module Hyrax
     def ensure_authorized!
       authorize! :review, :submissions
     end
+
+    def actionable_objects
+      @actionable_objects ||=
+        Hyrax::Workflow::ActionableObjects.new(user: current_user)
+    end
   end
 end

data/app/controllers/hyrax/collections_controller.rb

@@ -4,7 +4,12 @@ module Hyrax
     include CollectionsControllerBehavior
     include BreadcrumbsForCollections
     with_themed_layout :decide_layout
-    load_and_authorize_resource except: [:index, :show, :create], instance_name: :collection
+    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

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

@@ -7,6 +7,10 @@ module Hyrax
 
       include Hyrax::Collections::AcceptsBatches
 
+      load_resource only: :update_members,
+                    instance_name: :collection,
+                    class: Hyrax.config.collection_model
+
       def after_update
         respond_to do |format|
           format.html { redirect_to success_return_path, notice: t('hyrax.dashboard.my.action.collection_update_success') }
@@ -21,30 +25,37 @@ module Hyrax
         end
       end
 
-      def update_members
+      def update_members # rubocop:disable Metrics/MethodLength
         err_msg = validate
         after_update_error(err_msg) if err_msg.present?
         return if err_msg.present?
 
-        collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
-        members = collection.add_member_objects batch_ids
-        messages = members.collect { |member| member.errors.full_messages }.flatten
-        if messages.size == members.size
-          after_update_error(messages.uniq.join(', '))
-        elsif messages.present?
-          flash[:error] = messages.uniq.join(', ')
-          after_update
-        else
+        @collection.try(:reindex_extent=, Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX)
+        begin
+          Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: collection_id,
+                                                                         new_member_ids: batch_ids,
+                                                                         user: current_user)
           after_update
+        rescue Hyrax::SingleMembershipError => err
+          messages = JSON.parse(err.message)
+          if messages.size == batch_ids.size
+            after_update_error(messages.uniq.join(', '))
+          elsif messages.present?
+            flash[:error] = messages.uniq.join(', ')
+            after_update
+          end
         end
       end
 
       private
 
       def validate
-        return t('hyrax.dashboard.my.action.members_no_access') if batch_ids.blank?
-        return t('hyrax.dashboard.my.action.collection_deny_add_members') unless current_ability.can?(:deposit, collection)
-        return t('hyrax.dashboard.my.action.add_to_collection_only') unless member_action == "add" # should never happen
+        return t('hyrax.dashboard.my.action.members_no_access') if
+          batch_ids.blank?
+        return t('hyrax.dashboard.my.action.collection_deny_add_members') unless
+          current_ability.can?(:deposit, @collection)
+        return t('hyrax.dashboard.my.action.add_to_collection_only') unless
+          member_action == "add" # should never happen
       end
 
       def success_return_path
@@ -59,10 +70,6 @@ module Hyrax
         params[:id]
       end
 
-      def collection
-        @collection ||= ::Collection.find(collection_id)
-      end
-
       def batch_ids
         params[:batch_document_ids]
       end

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

@@ -41,9 +41,14 @@ module Hyrax
       # The search builder to find the collection
       self.single_item_search_builder_class = SingleCollectionSearchBuilder
       # The search builder to find the collections' members
-      self.membership_service_class = Collections::CollectionMemberService
+      self.membership_service_class = Collections::CollectionMemberSearchService
 
-      load_and_authorize_resource except: [:index, :create], instance_name: :collection
+      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
 
       def deny_collection_access(exception)
         if exception.action == :edit
@@ -63,14 +68,14 @@ module Hyrax
         @collection.collection_type_gid = CollectionType.find(collection_type_id).to_global_id
         add_breadcrumb t(:'hyrax.controls.home'), root_path
         add_breadcrumb t(:'hyrax.dashboard.breadcrumbs.admin'), hyrax.dashboard_path
-        add_breadcrumb t('.header', type_title: @collection.collection_type.title), request.path
-        @collection.apply_depositor_metadata(current_user.user_key)
+        add_breadcrumb t('.header', type_title: collection_type.title), request.path
+        @collection.try(:apply_depositor_metadata, current_user.user_key)
         form
       end
 
       def show
         # @todo: remove this unused assignment in 4.0.0
-        @banner_file = presenter.banner_file if @collection.collection_type.brandable?
+        @banner_file = presenter.banner_file if collection_type.brandable?
 
         presenter
         query_collection_members
@@ -81,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') }
@@ -102,20 +109,21 @@ module Hyrax
       end
 
       def create
+        return valkyrie_create if @collection.is_a?(Valkyrie::Resource)
         # Manual load and authorize necessary because Cancan will pass in all
         # form attributes. When `permissions_attributes` are present the
         # collection is saved without a value for `has_model.`
-        @collection = ::Collection.new
+        @collection = Hyrax.config.collection_class.new
         authorize! :create, @collection
         # Coming from the UI, a collection type gid should always be present.  Coming from the API, if a collection type gid is not specified,
         # use the default collection type (provides backward compatibility with versions < Hyrax 2.1.0)
         @collection.collection_type_gid = params[:collection_type_gid].presence || default_collection_type.to_global_id
         @collection.attributes = collection_params.except(:members, :parent_id, :collection_type_gid)
         @collection.apply_depositor_metadata(current_user.user_key)
-        add_members_to_collection unless batch.empty?
         @collection.visibility = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE unless @collection.discoverable?
         if @collection.save
           after_create
+          add_members_to_collection unless batch.empty?
         else
           after_create_error
         end
@@ -143,6 +151,9 @@ module Hyrax
         end
 
         process_member_changes
+
+        return valkyrie_update if @collection.is_a?(Valkyrie::Resource)
+
         @collection.visibility = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE unless @collection.discoverable?
         # we don't have to reindex the full graph when updating collection
         @collection.reindex_extent = Hyrax::Adapters::NestingIndexAdapter::LIMITED_REINDEX
@@ -175,11 +186,20 @@ module Hyrax
       end
 
       def destroy
-        if @collection.destroy
+        case @collection
+        when Valkyrie::Resource
+          Hyrax.persister.delete(resource: @collection)
           after_destroy(params[:id])
         else
-          after_destroy_error(params[:id])
+          if @collection.destroy
+            after_destroy(params[:id])
+          else
+            after_destroy_error(params[:id])
+          end
         end
+      rescue StandardError => err
+        Rails.logger.error(err)
+        after_destroy_error(params[:id])
       end
 
       def collection
@@ -197,13 +217,47 @@ module Hyrax
 
       private
 
+      def valkyrie_create
+        form.validate(collection_params) &&
+          @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
+
+      def valkyrie_update
+        form.validate(collection_params) &&
+          @collection = transactions['change_set.update_collection']
+                        .call(form)
+                        .value_or { return after_update_error }
+        after_update
+      end
+
       def default_collection_type
         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
+
       def link_parent_collection(parent_id)
-        parent = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: parent_id, use_valkyrie: false)
-        Hyrax::Collections::NestedCollectionPersistenceService.persist_nested_collection_for(parent: parent, child: @collection)
+        child = collection.respond_to?(:valkyrie_resource) ? collection.valkyrie_resource : collection
+        Hyrax::Collections::CollectionMemberService.add_member(collection_id: parent_id,
+                                                               new_member: child,
+                                                               user: current_user)
       end
 
       def uploaded_files(uploaded_file_ids)
@@ -339,8 +393,15 @@ module Hyrax
       deprecation_deprecate :single_item_search_builder
 
       def collection_params
-        @participants = extract_old_style_permission_attributes(params[:collection])
-        form_class.model_attributes(params[:collection])
+        if Hyrax.config.collection_class < ActiveFedora::Base
+          @participants = extract_old_style_permission_attributes(params[:collection])
+          form_class.model_attributes(params[:collection])
+        else
+          params.permit(collection: {})[:collection]
+                .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
 
       def extract_old_style_permission_attributes(attributes)
@@ -377,28 +438,36 @@ module Hyrax
         end
       end
 
-      def add_members_to_collection(collection = nil)
-        collection ||= @collection
-        collection.add_member_objects batch
+      def add_members_to_collection(collection = nil, collection_id: nil)
+        collection_id ||= (collection.try(:id) || @collection.id)
+
+        Hyrax::Collections::CollectionMemberService
+          .add_members_by_ids(collection_id: collection_id,
+                              new_member_ids: batch,
+                              user: current_user)
       end
 
       def remove_members_from_collection
-        batch.each do |pid|
-          work = Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: pid, use_valkyrie: false)
-          work.member_of_collections.delete @collection
-          work.save!
-        end
+        Hyrax::Collections::CollectionMemberService
+          .remove_members_by_ids(collection_id: @collection.id,
+                                 member_ids: batch,
+                                 user: current_user)
       end
 
       def move_members_between_collections
-        destination_collection = ::Collection.find(params[:destination_collection_id])
         remove_members_from_collection
-        add_members_to_collection(destination_collection)
-        if destination_collection.save
-          flash[:notice] = "Successfully moved #{batch.count} files to #{destination_collection.title} Collection."
-        else
-          flash[:error] = "An error occured. Files were not moved to #{destination_collection.title} Collection."
-        end
+        add_members_to_collection(collection_id: params[:destination_collection_id])
+
+        destination_title =
+          Hyrax.query_service.find_by(id: params[:destination_collection_id]).title.first ||
+          params[:destination_collection_id]
+        flash[:notice] = "Successfully moved #{batch.count} files to #{destination_title} Collection."
+      rescue StandardError => err
+        Rails.logger.error(err)
+        destination_title =
+          Hyrax.query_service.find_by(id: params[:destination_collection_id]).title.first ||
+          destination_id
+        flash[:error] = "An error occured. Files were not moved to #{destination_title} Collection."
       end
 
       # Include 'catalog' and 'hyrax/base' in the search path for views, while prefering
@@ -418,7 +487,13 @@ module Hyrax
       end
 
       def form
-        @form ||= form_class.new(@collection, current_ability, repository)
+        @form ||=
+          case @collection
+          when Valkyrie::Resource
+            Hyrax::Forms::ResourceForm.for(@collection)
+          else
+            form_class.new(@collection, current_ability, repository)
+          end
       end
 
       def set_default_permissions
@@ -428,8 +503,8 @@ module Hyrax
 
       def query_collection_members
         member_works
-        member_subcollections if collection.collection_type.nestable?
-        parent_collections if collection.collection_type.nestable? && action_name == 'show'
+        member_subcollections if collection_type.nestable?
+        parent_collections if collection_type.nestable? && action_name == 'show'
       end
 
       # Instantiate the membership query service
@@ -457,7 +532,7 @@ module Hyrax
       end
 
       def collection_object
-        action_name == 'show' ? ::Collection.find(collection.id) : collection
+        @collection
       end
 
       # You can override this method if you need to provide additional