hyrax 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98e61b637b4f510e877e88c3f2f8020a411b7d83cd0c074e142f666fbda964f1
-  data.tar.gz: 17a8be1a76c9755d5e8b2b1387e907c2d70722809cdb28a62088d913dc584384
+  metadata.gz: 48404af16c40c5a6144f84f4747f391276dbbf03901c49947658904296ad1510
+  data.tar.gz: 6836a04cd80c63455b5670c591c102d5ac20224cd3746051eb6df0fc17daaaf5
 SHA512:
-  metadata.gz: 445d46c5b5b5ee45ea4262e1809e92356f9536f2f919af929b9d33fafcc13c584ae0ff1c6c2b27cac8ffbcdf35f9be6fd9a726b9bf5c9cafc0632fbd8596a90c
-  data.tar.gz: d5d5ca3a839a02af1fec27d262eb8301a5880a07caba29b9ce383b37a7c7aea098e57f3ddf9c3fbc1582f5a9ffa227e7d0fc3702833a645ae86b7ab94745a2f9
+  metadata.gz: 10235f122db54b7d649c42208982e93eee952d16ee921c4db12ab8e42fb3a30d4834e1a9ae509bec3aa8de9427d05bb78725f06ec9ce0455093ea58cc02c2cd8
+  data.tar.gz: 5e8df023cfdff3daedba28bdd012ddb7dbf26d8ef12dab69b6e648d4aca742db5948830510a5890a12f1220ca8f5350991ce95156bbab6f559c2669b6e1f10be

data/.dassie/config/analytics.yml

@@ -1,13 +1,15 @@
 analytics:
+  ga4:
+    analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
   google:
     analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
     app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME'] %>
     app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION'] %>
+    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE'] %>
     privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
     privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
     client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL'] %>
-  matomo: 
+  matomo:
     base_url: <%= ENV['MATOMO_BASE_URL'] %>
     site_id: <%= ENV['MATOMO_SITE_ID'] %>
     auth_token: <%= ENV['MATOMO_AUTH_TOKEN'] %>
-    

data/.regen

@@ -1 +1,2 @@
-46
+# When updating CI regen seed, set to current date.
+2023-05-24T10:43:07

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

@@ -1,75 +1,125 @@
 class TrackingTags {
   constructor(provider) {
     this.provider = provider
+    switch(this.provider) {
+    case 'matomo':
+      this.tracker = new MatomoTagTracker();
+      break;
+    case 'google':
+      this.tracker = new UATagTracker();
+      break;
+    case 'ga4':
+      this.tracker = new GA4TagTracker();
+      break;
+    default:
+      console.error('Unsupport analytics provider ' + this.provider + ', supported values are: matomo, google, ga4');
+    }
+  }
+
+  // Track an event with the configured provider
+  trackTagEvent(category, action, name) {
+    this.tracker.trackEvent(category, action, name);
   }
 
+  // Track a page view with the configured provider
+  trackPageView() {
+    this.tracker.trackPageView();
+  }
+
+  // Deprecated: use trackTagEvent and trackPageView instead.
   analytics() {
-    if(this.provider === "matomo") {
-      return _paq;
-    }
-    else {
-      return _gaq;
-    }
+    return this;
   }
 
-  pageView() {
-    if(this.provider === "matomo") {
-      return 'trackPageView'
+  // Deprecated: use trackTagEvent and trackPageView instead.
+  push(params) {
+    if (params[0] == 'trackPageView' || params[0] == '_trackPageView') {
+      this.tracker.trackPageView();
     } else {
-      return '_trackPageview'
+      this.tracker.trackTagEvent(params[1], params[2], params[3]);
     }
   }
 
+  // Deprecated
+  pageView() {
+    return 'trackPageView';
+  }
+
+  // Deprecated
   trackEvent() {
-    if(this.provider === "matomo") {
-      return 'trackEvent'
-    } else {
-      return '_trackEvent'
-    }
+    return 'trackEvent';
+  }
+}
+
+class GA4TagTracker {
+  trackEvent(category, action, name) {
+    gtag('event', action, {
+      'category': category,
+      'label': name
+    });
+  }
+
+  trackPageView() {
+    // No operation necessary, this event is automatically collected
+  }
+}
+
+class UATagTracker {
+  trackEvent(category, action, name) {
+    _gaq.push(['_trackEvent', category, action, name]);
+  }
+
+  trackPageView() {
+    _gaq.push(['_trackPageView']);
+  }
+}
+
+class MatomoTagTracker {
+  trackEvent(category, action, name) {
+    _paq.push(['trackEvent', category, action, name]);
+  }
+
+  trackPageView() {
+    _paq.push(['trackPageView']);
   }
 }
 
 function trackPageView() {
-  window.trackingTags.analytics().push([window.trackingTags.pageView()]);
+  window.trackingTags.trackPageView();
 }
 
 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')]);
+    var eventSpan = $(this);
+    window.trackingTags.trackTagEvent(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()
+  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()
-  })
+    setupTracking();
+  });
 } else {
   $(document).on('ready', function() {
-    setupTracking()
-  })
+    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')]);
+  window.trackingTags.trackTagEvent('file-set', 'file-set-download', $(this).data('label'));
+  window.trackingTags.trackTagEvent('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]);
+    window.trackingTags.trackTagEvent('file-set-in-collection', 'file-set-in-collection-download', collection);
+    window.trackingTags.trackTagEvent('work-in-collection', 'work-in-collection-download', collection);
   });
 });

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

@@ -5,7 +5,7 @@ module Hyrax
       class CollectionReportsController < AnalyticsController
         include Hyrax::BreadcrumbsForCollectionAnalytics
         def index
-          return unless Hyrax.config.analytics?
+          return unless Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4'
 
           @pageviews = Hyrax::Analytics.daily_events('collection-page-view')
           @work_page_views = Hyrax::Analytics.daily_events('work-in-collection-view')
@@ -21,7 +21,7 @@ module Hyrax
         end
 
         def show
-          return unless Hyrax.config.analytics?
+          return unless Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4'
           @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')

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

@@ -6,7 +6,7 @@ module Hyrax
         include Hyrax::BreadcrumbsForWorksAnalytics
 
         def index
-          return unless Hyrax.config.analytics?
+          return unless Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4'
 
           @accessible_works ||= accessible_works
           @accessible_file_sets ||= accessible_file_sets

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

@@ -7,7 +7,7 @@ module Hyrax
       end
 
       # TODO: we could remove this if we used an isolated engine
-      def features_url
+      def features_url(**_kargs)
         hyrax.admin_features_path
       end
     end

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

@@ -15,9 +15,8 @@ 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 = actionable_objects.reject(&:published?)
-      @published_list = actionable_objects.select(&:published?)
+      assign_action_objects_params
+      @response = WorkflowResponse.new(actionable_objects.to_a, actionable_objects.total_count, current_page, per_page, under_review?)
     end
 
     private
@@ -30,5 +29,51 @@ module Hyrax
       @actionable_objects ||=
         Hyrax::Workflow::ActionableObjects.new(user: current_user)
     end
+
+    def current_page
+      @page ||= params.fetch('page', 1).to_i
+    end
+
+    def per_page
+      @per_page ||= params.fetch('per_page', 10).to_i
+    end
+
+    def assign_action_objects_params
+      actionable_objects.page = current_page
+      actionable_objects.per_page = per_page
+      actionable_objects.workflow_state_filter = (under_review? ? '!' : '') + deposited_workflow_state_name
+    end
+
+    def under_review?
+      @under_review = params['state'] != 'published'
+    end
+
+    class WorkflowResponse
+      attr_reader :total_count
+      attr_reader :current_page
+      attr_reader :per_page
+      attr_reader :docs
+      attr_reader :under_review
+
+      def initialize(docs, total_count, page, per_page, under_review)
+        @docs = docs
+        @total_count = total_count
+        @per_page = per_page.to_i
+        @current_page = page.to_i
+        @under_review = under_review
+      end
+
+      def total_pages
+        (total_count.to_f / per_page).ceil
+      end
+
+      def limit_value
+        docs.length
+      end
+
+      def viewing_under_review?
+        under_review
+      end
+    end
   end
 end

data/app/services/hyrax/analytics/ga4.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+require 'oauth2'
+require 'signet/oauth_2/client'
+
+# rubocop:disable Metrics/ModuleLength
+module Hyrax
+  module Analytics
+    module Ga4
+      extend ActiveSupport::Concern
+      # rubocop:disable Metrics/BlockLength
+      class_methods do
+        # Loads configuration options from config/analytics.yml. Expected structure:
+        # `analytics:`
+        # `  ga4:`
+        # `    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
+        # `    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
+        # `    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
+        # `    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
+        # `    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
+        # @return [Config]
+        def config
+          @config ||= Config.load_from_yaml
+        end
+
+        class Config
+          def self.load_from_yaml
+            filename = Rails.root.join('config', 'analytics.yml')
+            yaml = YAML.safe_load(ERB.new(File.read(filename)).result)
+            unless yaml
+              Hyrax.logger.error("Unable to fetch any keys from #{filename}.")
+              return new({})
+            end
+            config = yaml.fetch('analytics')&.fetch('ga4', nil)
+            unless config
+              Deprecation.warn("Deprecated analytics configuration format found. Please update config/analytics.yml.")
+              config = yaml.fetch('analytics')
+              # this has to exist here with a placeholder so it can be set in the Hyrax initializer
+              # it is only for backward compatibility
+              config['analytics_id'] = '-'
+            end
+            new config
+          end
+
+          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_path privkey_secret client_email].freeze
+
+          def initialize(config)
+            @config = config
+          end
+
+          # @return [Boolean] are all the required values present?
+          def valid?
+            config_keys = @config.keys
+            REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
+          end
+
+          REQUIRED_KEYS.each do |key|
+            class_eval %{ def #{key};  @config.fetch('#{key}'); end }
+          end
+
+          # This method allows setting the analytics id in the initializer
+          # @deprecated set the analytics id in either ENV['GOOGLE_ANALYTICS_ID'] or config/analytics.yaml
+          def analytics_id=(value)
+            @config['analytics_id'] = value
+          end
+        end
+
+        # Generate an OAuth2 token for Google Analytics
+        # @return [OAuth2::AccessToken] An OAuth2 access token for GA
+        def token(scope = 'https://www.googleapis.com/auth/analytics.readonly')
+          access_token = auth_client(scope).fetch_access_token!
+          OAuth2::AccessToken.new(oauth_client, access_token['access_token'], expires_in: access_token['expires_in'])
+        end
+
+        def oauth_client
+          OAuth2::Client.new('', '', authorize_url: 'https://accounts.google.com/o/oauth2/auth',
+                                     token_url: 'https://accounts.google.com/o/oauth2/token')
+        end
+
+        def auth_client(scope)
+          raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
+          private_key = File.read(config.privkey_path)
+          Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
+                                     audience: 'https://accounts.google.com/o/oauth2/token',
+                                     scope: scope,
+                                     issuer: config.client_email,
+                                     signing_key: OpenSSL::PKCS12.new(private_key, config.privkey_secret).key,
+                                     sub: config.client_email
+        end
+
+        # Return a user object linked to a Google Analytics account
+        # @return [Legato::User] A user account with GA access
+        def user
+          Legato::User.new(token)
+        end
+
+        # Return a Google Analytics profile matching specified ID
+        # @ return [Legato::Management::Profile] A user profile associated with GA
+        def profile
+          return unless config.valid?
+          @profile = user.profiles.detect do |profile|
+            profile.web_property_id == config.analytics_id
+          end
+          raise 'User does not have access to this property' unless @profile
+          @profile
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def to_date_range(period)
+          case period
+          when "day"
+            start_date = Time.zone.today
+            end_date = Time.zone.today
+          when "week"
+            start_date = Time.zone.today - 7.days
+            end_date = Time.zone.today
+          when "month"
+            start_date = Time.zone.today - 1.month
+            end_date = Time.zone.today
+          when "year"
+            start_date = Time.zone.today - 1.year
+            end_date = Time.zone.today
+          end
+
+          [start_date, end_date]
+        end
+        # rubocop:enabl e Metrics/MethodLength
+
+        def keyword_conversion(date)
+          case date
+          when "last12"
+            start_date = Time.zone.today - 11.months
+            end_date = Time.zone.today
+
+            [start_date, end_date]
+          else
+            date.split(",")
+          end
+        end
+
+        def date_period(period, date)
+          if period == "range"
+            date.split(",")
+          else
+            to_date_range(period)
+          end
+        end
+
+        # Configure analytics_start_date in ENV file
+        def default_date_range
+          "#{Hyrax.config.analytics_start_date},#{Time.zone.today + 1.day}"
+        end
+
+        # The number of events by day for an action
+        def daily_events(action, date = default_date_range)
+          date = date.split(",")
+          EventsDaily.summary(profile, date[0], date[1], action)
+        end
+
+        # The number of events by day for an action and ID
+        def daily_events_for_id(id, action, date = default_date_range)
+          date = date.split(",")
+          EventsDaily.by_id(profile, date[0], date[1], id, action)
+        end
+
+        # A list of events sorted by highest event count
+        def top_events(action, date = default_date_range)
+          date = date.split(",")
+          Events.send('list', profile, date[0], date[1], action)
+        end
+
+        def unique_visitors(date = default_date_range); end
+
+        def unique_visitors_for_id(id, date = default_date_range); end
+
+        def new_visitors(period = 'month', date = default_date_range)
+          date = date_period(period, date)
+          Visits.new_visits(profile, date[0], date[1])
+        end
+
+        def new_visits_by_day(date = default_date_range, _period = 'day')
+          date = date.split(",")
+          VisitsDaily.new_visits(profile, date[0], date[1])
+        end
+
+        def returning_visitors(period = 'month', date = default_date_range)
+          date = date_period(period, date)
+          Visits.return_visits(profile, date[0], date[1])
+        end
+
+        def returning_visits_by_day(date = default_date_range, _period = 'day')
+          date = date.split(",")
+          VisitsDaily.return_visits(profile, date[0], date[1])
+        end
+
+        def total_visitors(period = 'month', date = default_date_range)
+          date = date_period(period, date)
+          Visits.total_visits(profile, date[0], date[1])
+        end
+      end
+      # rubocop:enable Metrics/BlockLength
+    end
+  end
+end
+# rubocop:enable Metrics/ModuleLength

data/app/services/hyrax/analytics/google.rb

@@ -1,20 +1,24 @@
 # frozen_string_literal: true
+
 require 'oauth2'
 require 'signet/oauth_2/client'
 
-# rubocop:disable Metrics/ModuleLength
 module Hyrax
   module Analytics
+    # rubocop:disable Metrics/ModuleLength
     module Google
       extend ActiveSupport::Concern
       # rubocop:disable Metrics/BlockLength
       class_methods do
-        # Loads configuration options from config/analytics.yml. Expected structure:
+        # Loads configuration options from config/analytics.yml. You only need PRIVATE_KEY_PATH or
+        # PRIVATE_KEY_VALUE. VALUE takes precedence.
+        # Expected structure:
         # `analytics:`
         # `  google:`
         # `    app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME']`
         # `    app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION']`
         # `    privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH']`
+        # `    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE']`
         # `    privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET']`
         # `    client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL']`
         # @return [Config]
@@ -41,7 +45,8 @@ module Hyrax
             new config
           end
 
-          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_path privkey_secret client_email].freeze
+          KEYS = %w[analytics_id app_name app_version privkey_path privkey_value privkey_secret client_email].freeze
+          REQUIRED_KEYS = %w[analytics_id app_name app_version privkey_secret client_email].freeze
 
           def initialize(config)
             @config = config
@@ -49,18 +54,16 @@ module Hyrax
 
           # @return [Boolean] are all the required values present?
           def valid?
-            config_keys = @config.keys
-            REQUIRED_KEYS.all? { |required| config_keys.include?(required) }
-          end
+            return false unless @config['privkey_value'].present? || @config['privkey_path'].present?
 
-          REQUIRED_KEYS.each do |key|
-            class_eval %{ def #{key};  @config.fetch('#{key}'); end }
+            REQUIRED_KEYS.all? { |required| @config[required].present? }
           end
 
-          # This method allows setting the analytics id in the initializer
-          # @deprecated set the analytics id in either ENV['GOOGLE_ANALYTICS_ID'] or config/analytics.yaml
-          def analytics_id=(value)
-            @config['analytics_id'] = value
+          KEYS.each do |key|
+            # rubocop:disable Style/EvalWithLocation
+            class_eval %{ def #{key}; @config.fetch('#{key}'); end }
+            class_eval %{ def #{key}=(value); @config['#{key}'] = value; end }
+            # rubocop:enable Style/EvalWithLocation
           end
         end
 
@@ -77,8 +80,12 @@ module Hyrax
         end
 
         def auth_client(scope)
-          raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
-          private_key = File.read(config.privkey_path)
+          private_key = Base64.decode64(config.privkey_value) if config.privkey_value.present?
+          if private_key.blank?
+            raise "Private key file for Google analytics was expected at '#{config.privkey_path}', but no file was found." unless File.exist?(config.privkey_path)
+
+            private_key = File.read(config.privkey_path)
+          end
           Signet::OAuth2::Client.new token_credential_uri: 'https://accounts.google.com/o/oauth2/token',
                                      audience: 'https://accounts.google.com/o/oauth2/token',
                                      scope: scope,
@@ -123,7 +130,7 @@ module Hyrax
 
           [start_date, end_date]
         end
-        # rubocop:enabl e Metrics/MethodLength
+        # rubocop:enable Metrics/MethodLength
 
         def keyword_conversion(date)
           case date
@@ -199,6 +206,7 @@ module Hyrax
       end
       # rubocop:enable Metrics/BlockLength
     end
+    # rubocop:enable Metrics/ModuleLength
   end
 end
 # rubocop:enable Metrics/ModuleLength

data/app/services/hyrax/analytics/matomo.rb

@@ -11,15 +11,16 @@ module Hyrax
         # Loads configuration options from config/analytics.yml. Expected structure:
         # `analytics:`
         # `  matomo:`
-        # `    base_url: <%= ENV['MATOMOT_BASE_URL']`
-        # `    site_id: <%= ENV['MATOMOT_SITE_ID']`
-        # `    auth_token: <%= ENV['MATOMOT_AUTH_TOKEN']`
+        # `    base_url: <%= ENV['MATOMO_BASE_URL']`
+        # `    site_id: <%= ENV['MATOMO_SITE_ID']`
+        # `    auth_token: <%= ENV['MATOMO_AUTH_TOKEN']`
         # @return [Config]
         def config
           @config ||= Config.load_from_yaml
         end
 
         class Config
+          # TODO: test matomo and see if it needs any of the updates from https://github.com/samvera/hyrax/pull/6063
           def self.load_from_yaml
             filename = Rails.root.join('config', 'analytics.yml')
             yaml = YAML.safe_load(ERB.new(File.read(filename)).result)

data/app/services/hyrax/solr_query_service.rb

@@ -27,14 +27,14 @@ module Hyrax
 
     ##
     # @return [Hash] the results returned from solr for the current query
-    def get
-      solr_service.get(build)
+    def get(*args)
+      solr_service.get(build, *args)
     end
 
     ##
     # @return [Enumerable<SolrDocument>]
-    def solr_documents
-      get['response']['docs'].map { |doc| self.class.document_model.new(doc) }
+    def solr_documents(*args)
+      get(*args)['response']['docs'].map { |doc| self.class.document_model.new(doc) }
     end
 
     ##

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

@@ -20,11 +20,27 @@ module Hyrax
       # @!attribute [rw] user
       #   @return [::User]
       attr_accessor :user
+      ##
+      # @!attribute [rw] workflow_state_filter
+      #   @return [String]
+      attr_accessor :workflow_state_filter
+      ##
+      # @!attribute [rw] page of results to return, 1 based
+      #   @return [Integer]
+      attr_accessor :page
+      ##
+      # @!attribute [rw] per_page number of results in the page
+      #   @return [Integer]
+      attr_accessor :per_page
 
       ##
       # @param [::User] user the user whose
-      def initialize(user:)
+      # @param [String] optional filter by workstate name
+      def initialize(user:, workflow_state_filter: nil)
         @user = user
+        @workflow_state_filter = workflow_state_filter
+        @page = 1
+        @per_page = 10
       end
 
       ##
@@ -34,7 +50,8 @@ module Hyrax
         ids_and_states = id_state_pairs
         return if ids_and_states.none?
 
-        docs = Hyrax::SolrQueryService.new.with_ids(ids: ids_and_states.map(&:first)).solr_documents
+        docs = Hyrax::SolrQueryService.new.with_ids(ids: ids_and_states.map(&:first))
+                                      .solr_documents(page: @page, rows: @per_page, sort: 'system_create_dtsi ASC')
 
         docs.each do |solr_doc|
           object = ObjectInWorkflowDecorator.new(solr_doc)
@@ -46,6 +63,13 @@ module Hyrax
         end
       end
 
+      ##
+      # @return [Integer] total number of entities selected
+      def total_count
+        PermissionQuery.scope_entities_for_the_user(user: user, workflow_state_filter: workflow_state_filter)
+                       .count
+      end
+
       private
 
       ##
@@ -53,7 +77,8 @@ module Hyrax
       # @return [Array[String, Sipity::WorkflowState]]
       def id_state_pairs
         gids_and_states = PermissionQuery
-                          .scope_entities_for_the_user(user: user)
+                          .scope_entities_for_the_user(user: user, page: page, per_page: per_page, workflow_state_filter: workflow_state_filter)
+                          .order(created_at: :asc)
                           .pluck(:proxy_for_global_id, :workflow_state_id)
 
         return [] if gids_and_states.none?

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

@@ -194,7 +194,7 @@ module Hyrax
       # @return [ActiveRecord::Relation<Sipity::Entity>]
       #
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-      def scope_entities_for_the_user(user:)
+      def scope_entities_for_the_user(user:, page: 1, per_page: nil, workflow_state_filter: nil)
         entities = Sipity::Entity.arel_table
         workflow_state_actions = Sipity::WorkflowStateAction.arel_table
         workflow_states = Sipity::WorkflowState.arel_table
@@ -227,13 +227,34 @@ module Hyrax
         entity_specific_where = where_builder.call(entity_responsibilities).and(
           entities[:id].eq(entity_responsibilities[:entity_id])
         )
+        entity_specific_where = filter_by_workflow_state(entity_specific_where, workflow_states, workflow_state_filter) if workflow_state_filter
         workflow_specific_where = where_builder.call(workflow_responsibilities)
+        workflow_specific_where = filter_by_workflow_state(workflow_specific_where, workflow_states, workflow_state_filter) if workflow_state_filter
 
-        Sipity::Entity.where(
+        result = Sipity::Entity.where(
           entities[:id].in(entity_specific_joins.where(entity_specific_where))
           .or(entities[:id].in(workflow_specific_joins.where(workflow_specific_where)))
         )
+        # Apply paging if provided
+        if per_page.nil?
+          result
+        else
+          result.page(page).per(per_page)
+        end
       end
+
+      # @api private
+      #
+      # Append a filter by workflow state name to the provided where builder.
+      # If the filter begins with a !, it will filter to states not equal to the filter.
+      def filter_by_workflow_state(where_builder, workflow_states, filter)
+        if filter.start_with?('!')
+          where_builder.and(workflow_states[:name].not_eq(filter[1..-1]))
+        else
+          where_builder.and(workflow_states[:name].eq(filter))
+        end
+      end
+
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       # @api public

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

@@ -8,7 +8,7 @@
   <div class="col-sm-12">
     <div class="collection-reports">
 
-<% if Hyrax.config.analytics? %>
+<% if Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
       <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">

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

@@ -9,7 +9,7 @@
     <div class="work-reports">
 
     <div class="panel panel-default">
-    <% if Hyrax.config.analytics? %>
+    <% if Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
       <% if current_user.ability.admin? %>
         <div class="panel-heading"><b><%= @works_count %> <%= t('.works') %></b> <%= t('.repo_summary') %> <b><%= @pageviews.all if @pageviews %> <%= t('.views') %></b> <%= t('.and') %> <b><%= @downloads.all if @downloads %> <%= t('.downloads') %></b>.</div>
       <% else %>

data/app/views/hyrax/admin/workflows/_tabs.html.erb

@@ -0,0 +1,9 @@
+<ul class="nav nav-tabs" id="my_nav" role="list">
+  <li<%= ' class="active"'.html_safe if @response.viewing_under_review? %>>
+      <%= link_to t('hyrax.admin.workflows.index.tabs.under_review'),
+        hyrax.admin_workflows_path(state: 'under-review'), class: "nav-link#{' active' if @response.viewing_under_review?}" %>
+  </li>
+  <li<%= ' class="active"'.html_safe if !@response.viewing_under_review? %>>
+    <%= link_to t('hyrax.admin.workflows.index.tabs.published'), hyrax.admin_workflows_path(state: 'published'), class: "nav-link#{' active' if !@response.viewing_under_review?}" %>
+  </li>
+</ul>

data/app/views/hyrax/admin/workflows/index.html.erb

@@ -5,87 +5,62 @@
 <div class="row">
   <div class="col-md-12">
     <div class="panel panel-default tabs">
-      <ul class="nav nav-tabs" role="tablist">
-        <li class="active">
-          <a href="#under-review" role="tab" data-toggle="tab"><%= t('.tabs.under_review') %></a>
-        </li>
-        <li>
-          <a href="#published" role="tab" data-toggle="tab"><%= t('.tabs.published') %></a>
-        </li>
-      </ul>
-      <div class="tab-content">
-        <div id="under-review" class="tab-pane active">
-          <div class="panel panel-default labels">
-            <div class="panel-body">
-              <div class="table-responsive">
-                <table class="table table-condensed table-striped datatable">
-                  <thead>
-                    <tr>
-                      <th width="40%">Work</th>
-                      <th width="20%">Depositor</th>
-                      <th width="20%">Submission Date</th>
-                      <th width="20%">Status</th>
-                    </tr>
-                  </thead>
-                  <tbody>
-                    <% @status_list.each do |document| %>
-                      <tr>
-                        <td>
-                          <%= link_to document, [main_app, document] %>
-                        </td>
-                        <td>
-                          <%= safe_join(document.creator, tag(:br)) %>
-                        </td>
-                        <td>
-                          <%= document.date_modified %>
-                        </td>
-                        <td>
-                          <span class="state state-pending"><%= document.workflow_state %></span>
-                        </td>
-                      </tr>
-                    <% end %>
-                  </tbody>
-                </table>
-              </div>
-            </div>
-          </div>
-        </div>
-        <div id="published" class="tab-pane">
-          <div class="panel panel-default labels">
-            <div class="panel-body">
-              <div class="table-responsive">
-                <table class="table table-condensed table-striped datatable">
-                  <thead>
-                    <tr>
-                      <th width="40%">Work</th>
-                      <th width="20%">Depositor</th>
-                      <th width="20%">Submission Date</th>
-                      <th width="20%">Status</th>
-                    </tr>
-                  </thead>
-                  <tbody>
-                    <% @published_list.each do |document| %>
-                      <tr>
-                        <td>
-                          <%= link_to document, [main_app, document] %>
-                        </td>
-                        <td>
-                          <%= safe_join(document.creator, tag(:br)) %>
-                        </td>
-                        <td>
-                          <%= document.date_modified %>
-                        </td>
-                        <td>
-                          <span class="state state-pending"><%= document.workflow_state %></span>
-                        </td>
-                      </tr>
-                    <% end %>
-                  </tbody>
-                </table>
-              </div>
+      <%= render 'tabs' %>
+      <div class="panel-heading">
+        <span class="count-display">
+          <% if @response.viewing_under_review? %>
+            <%= I18n.t('hyrax.admin.workflows.index.works_under_review', total_count: @response.total_count).html_safe %>
+          <% else %>
+            <%= I18n.t('hyrax.admin.workflows.index.works_published', total_count: @response.total_count).html_safe %>
+          <% end %>
+        </span>
+      </div>
+      <div class="panel-body">
+        <div class="row">
+          <div class="col-sm-12">
+            <div class="sort-toggle mt-2">
+              <%= form_tag hyrax.admin_workflows_path, method: :get, class: 'per_page' do %>
+                <fieldset class="col-12">
+                  <legend class="sr-only"><%= t('hyrax.dashboard.my.sr.results_per_page') %></legend>
+                  <%= label_tag :per_page do %>
+                      Show <%= select_tag :per_page, options_for_select(Hyrax.config.range_for_number_of_results_to_display_per_page.map(&:to_s), h(params[:per_page])), title: "entries" %> per page
+                  <% end %>
+                  <%= render_hash_as_hidden_fields(search_state.params_for_search.except(:per_page, :sort, :utf8)) %>
+                </fieldset>
+              <% end %>
             </div>
           </div>
         </div>
+        <h2 class="sr-only"><%= t('.works_listing') %></h2>
+        <table class="table table-sm table-striped works-list">
+          <thead>
+            <tr>
+              <th width="40%"><%= t(".heading.work") %></th>
+              <th width="20%"><%= t(".heading.depositor") %></th>
+              <th width="20%"><%= t(".heading.submission_date") %></th>
+              <th width="20%"><%= t(".heading.status") %></th>
+            </tr>
+          </thead>
+          <tbody>
+            <% @response.docs.each do |document| %>
+              <tr>
+                <td>
+                  <%= link_to document, [main_app, document] %>
+                </td>
+                <td>
+                  <%= safe_join(document.creator, tag(:br)) %>
+                </td>
+                <td>
+                  <%= document.date_modified %>
+                </td>
+                <td>
+                  <span class="state state-pending"><%= document.workflow_state %></span>
+                </td>
+              </tr>
+            <% end %>
+          </tbody>
+        </table>
+        <%= render 'hyrax/my/results_pagination' %>
       </div>
     </div>
   </div>

data/app/views/hyrax/base/_show_actions.html.erb

@@ -17,7 +17,7 @@
             class: presenter.display_unfeature_link? ? 'btn btn-default' : 'btn btn-default collapse' %>
       <% end %>
     <% end %>
-    <% if Hyrax.config.analytics? %>
+    <% if Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
       <% # turbolinks needs to be turned off or the page will use the cache and the %>
       <% # analytics graph will not show unless the page is refreshed. %>
       <%= link_to t('.analytics'), presenter.stats_path, id: 'stats', class: 'btn btn-default', data: { turbolinks: false } %>

data/app/views/hyrax/base/_work_button_row.html.erb

@@ -37,7 +37,7 @@
           data: { behavior: 'unfeature' },
           class: presenter.display_feature_link? ? 'btn btn-default collapse' : 'btn btn-default' %>
     <% end %>
-    <% if Hyrax.config.analytics? %>
+    <% if Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
       <%= link_to t(".analytics"), presenter.stats_path, id: 'stats', class: 'btn btn-default' %>
     <% end %>
   </div>

data/app/views/hyrax/dashboard/_user_activity.html.erb

@@ -2,7 +2,7 @@
   <h3 class="panel-title"><%= t('.title') %></h3>
 </div>
 <div class="panel-body text-center">
-  <% if Hyrax.config.analytics? %>
+  <% if Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
     <%= render 'user_activity_graph' %>
 
     <div class="col-md-3">

data/app/views/hyrax/dashboard/show_admin.html.erb

@@ -2,7 +2,7 @@
   <h1><%= t("hyrax.dashboard.title") %></h1>
 <% end %>
 
-<% if Hyrax.config.analytics? %>
+<% if Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
 <div class="row">
   <div class="col-md-12">
     <div class="panel panel-default">

data/app/views/hyrax/dashboard/sidebar/_activity.html.erb

@@ -32,7 +32,7 @@
     <% end %>
   <% end %>
 
-  <% if current_ability.can_create_any_work? && Hyrax.config.analytics? %>
+  <% if current_ability.can_create_any_work? && Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
     <li>
       <%= menu.collapsable_section t('hyrax.admin.sidebar.analytics'),
                                         icon_class: "fa fa-pie-chart",

data/app/views/hyrax/file_sets/_show_actions.html.erb

@@ -1,5 +1,5 @@
 <div class="form-actions">
-  <% if Hyrax.config.analytics? %>
+  <% if Hyrax.config.analytics? && Hyrax.config.analytics_provider != 'ga4' %>
     <% # turbolinks needs to be turned off or the page will use the cache and the %>
     <% # analytics graph will not show unless the page is refreshed. %>
     <%= link_to t('.analytics'), @presenter.stats_path, id: 'stats', class: 'btn btn-default', data: { turbolinks: false } %>

data/app/views/layouts/_head_tag_content.html.erb

@@ -26,9 +26,12 @@ signed in %>
 <%= render 'shared/appearance_styles' %>
 
 <% if Hyrax.config.analytics? %>
-  <% if Hyrax.config.analytics_provider == 'google' %>
+  <% case Hyrax.config.analytics_provider %>
+  <% when 'ga4' %>
+    <%= render partial: 'shared/ga4', formats: [:html] %>
+  <% when 'google' %>
     <%= render partial: 'shared/ga', formats: [:html]  %>
-  <% elsif Hyrax.config.analytics_provider == 'matomo' %>
+  <% when 'matomo' %>
     <%= render partial: 'shared/matomo', formats: [:html] %>
   <% end %>
 <% end %>

data/app/views/shared/_ga4.html.erb

@@ -0,0 +1,10 @@
+<!-- Google tag (gtag.js) -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=<%= Hyrax::Analytics.config.analytics_id %>"></script>
+<script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+
+    gtag('config', '<%= Hyrax::Analytics.config.analytics_id %>');
+</script>
+<meta name="analytics-provider" content="ga4">

data/config/locales/hyrax.en.yml

@@ -459,6 +459,14 @@ en:
       workflows:
         index:
           header: Review Submissions
+          heading:
+            work: Work
+            depositor: Depositor
+            submission_date: Submission Date
+            status: status
+          works_published: "<strong>%{total_count} works</strong> published"
+          works_under_review: "<strong>%{total_count} works</strong> under review"
+          works_listing: Works listing
           tabs:
             published: Published
             under_review: Under Review

data/documentation/developing-your-hyrax-based-app.md

@@ -125,7 +125,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.8.1_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.5.0/template.rb
+rails _5.2.8.1_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.6.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/documentation/legacyREADME.md

@@ -50,7 +50,7 @@ The Samvera community is here to help. Please see our [support guide](./.github/
 # Getting started
 
 This document contains instructions specific to setting up an app with __Hyrax
-v3.5.0__. If you are looking for instructions on installing a different
+v3.6.0__. If you are looking for instructions on installing a different
 version, be sure to select the appropriate branch or tag from the drop-down
 menu above.
 
@@ -159,7 +159,7 @@ NOTE: The steps need to be done in order to create a new Hyrax based app.
 Generate a new Rails application using the template.
 
 ```
-rails _5.2.8.1_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.5.0/template.rb
+rails _5.2.8.1_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.6.0/template.rb
 ```
 
 Generating a new Rails application using Hyrax's template above takes cares of a number of steps for you, including:

data/hyrax.gemspec

@@ -79,7 +79,7 @@ SUMMARY
   spec.add_dependency 'rdf-vocab', '~> 3.0'
   spec.add_dependency 'redis', '~> 4.0'
   spec.add_dependency 'redis-namespace', '~> 1.5'
-  spec.add_dependency 'redlock', '>= 0.1.2'
+  spec.add_dependency 'redlock', '>= 0.1.2', '< 2.0'
   spec.add_dependency 'reform', '~> 2.3'
   spec.add_dependency 'reform-rails', '~> 0.2.0'
   spec.add_dependency 'retriable', '>= 2.9', '< 4.0'

data/lib/generators/hyrax/templates/config/analytics.yml

@@ -2,10 +2,13 @@
 # You can manually fill in these values or use the ENV variables.
 #
 analytics:
+  ga4:
+    analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
   google:
     analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
     app_name: <%= ENV['GOOGLE_OAUTH_APP_NAME'] %>
     app_version: <%= ENV['GOOGLE_OAUTH_APP_VERSION'] %>
+    privkey_value: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_VALUE'] %>
     privkey_path: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_PATH'] %>
     privkey_secret: <%= ENV['GOOGLE_OAUTH_PRIVATE_KEY_SECRET'] %>
     client_email: <%= ENV['GOOGLE_OAUTH_CLIENT_EMAIL'] %>

data/lib/hyrax/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hyrax
-  VERSION = '3.5.0'
+  VERSION = '3.6.0'
 end

data/template.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 # Hack for https://github.com/rails/rails/issues/35153
 gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"'
-gem 'hyrax', '3.5.0'
+gem 'hyrax', '3.6.0'
 run 'bundle install'
 generate 'hyrax:install', '-f'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hyrax
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -14,7 +14,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -723,6 +723,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -730,6 +733,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: reform
   requirement: !ruby/object:Gem::Requirement
@@ -1527,8 +1533,6 @@ files:
 - ".github/SUPPORT.md"
 - ".github/release.yml"
 - ".github/stale.yml"
-- ".github/workflows/main.yml"
-- ".github/workflows/release.yml"
 - ".gitignore"
 - ".hound.yml"
 - ".regen"
@@ -2162,6 +2166,7 @@ files:
 - app/services/hyrax/admin_set_member_service.rb
 - app/services/hyrax/admin_set_service.rb
 - app/services/hyrax/analytics.rb
+- app/services/hyrax/analytics/ga4.rb
 - app/services/hyrax/analytics/google.rb
 - app/services/hyrax/analytics/google/events.rb
 - app/services/hyrax/analytics/google/events_daily.rb
@@ -2435,6 +2440,7 @@ files:
 - app/views/hyrax/admin/stats/show.html.erb
 - app/views/hyrax/admin/users/index.html.erb
 - app/views/hyrax/admin/workflow_roles/index.html.erb
+- app/views/hyrax/admin/workflows/_tabs.html.erb
 - app/views/hyrax/admin/workflows/index.html.erb
 - app/views/hyrax/base/_actions.html.erb
 - app/views/hyrax/base/_attribute_rows.html.erb
@@ -2779,6 +2785,7 @@ files:
 - app/views/shared/_citations.html.erb
 - app/views/shared/_footer.html.erb
 - app/views/shared/_ga.html.erb
+- app/views/shared/_ga4.html.erb
 - app/views/shared/_locale_picker.html.erb
 - app/views/shared/_matomo.html.erb
 - app/views/shared/_nav_safety_modal.html.erb
@@ -3184,7 +3191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.4.12
 signing_key:
 specification_version: 4
 summary: Hyrax is a front-end based on the robust Samvera framework, providing a user

data/.github/workflows/main.yml

@@ -1,17 +0,0 @@
-name: Trigger Nurax build
-on:
-  workflow_dispatch:
-  push:
-
-jobs:
-  trigger:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: peter-evans/repository-dispatch@v1
-      with:
-         token: ${{ secrets.NURAX_ACCESS_TOKEN }}
-         event-type: push
-         repository: curationexperts/nurax
-         client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
-
-

data/.github/workflows/release.yml

@@ -1,17 +0,0 @@
-name: Trigger Nurax build
-on:
-  workflow_dispatch:
-  release:
-
-jobs:
-  trigger:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: peter-evans/repository-dispatch@v1
-      with:
-         token: ${{ secrets.NURAX_ACCESS_TOKEN }}
-         event-type: release
-         repository: curationexperts/nurax
-         client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
-
-