hyrax 3.2.0 → 3.3.0

data/config/locales/hyrax.zh.yml

@@ -31,6 +31,9 @@ zh:
       filters:
         title: '筛选:'
       start_over: 清除筛选
+  download:
+    one: 和 1 个下载
+    other: 和 %{count} 下载
   errors:
     messages:
       carrierwave_download_error: 图片不能下载。
@@ -178,6 +181,141 @@ zh:
           item_list_header: 集内作品
         show_actions:
           confirm_delete: 您确定要删除此管理集？此操作无法撤消。
+      analytics:
+        collection_reports:
+          custom_range:
+            collection_home_page_views: 馆藏主页浏览量
+            date_range_heading: 自定义日期范围
+            summary_heading: 用户活动摘要
+            work_downloads: 作品下载
+            work_views: 作品观
+          index:
+            activity: 活动
+            and: 和
+            custom_range: 自定义范围
+            date_range_heading: 自定义报告
+            downloads: 下载
+            enable_analytics: 启用分析以查看报告
+            export: 出口
+            monthly: 每月
+            repo_summary: 存储库包含
+            repo_summary_2: 共同拥有
+            report_generated_on: 此报告生成于
+            report_header: 自定义集合报告
+            summary: 概括
+            title: 收藏报告
+            views: 页面浏览量
+          monthly_summary:
+            collection_views: 馆藏主页浏览量
+            monthly_subtitle: 过去 12 个月的逐月状态
+            work_downloads: 作品下载
+            work_views: 作品观
+          show:
+            collection_type: 收藏类型
+            created_by: 由...制作
+            custom_range: 自定义范围
+            last_updated: 最后更新于
+            monthly: 每月
+            return_to_btn: 返回收藏报告
+            summary: 概括
+            title: 收款报告
+            view_collection_btn: 查看收藏
+            visibility: 能见度
+          summary:
+            all_time: 整天
+            collection_home_page_views: 馆藏主页浏览量
+            date_range: 日期范围
+            subtitle: 用户活动摘要
+            this_month: 这个月
+            this_week: 本星期
+            this_year: 今年
+            today: 今天
+            work_downloads: 作品下载
+            work_views: 作品观
+          top_collections:
+            collection_page_views: 收藏页面浏览量
+            collection_title: 馆藏名称
+            deleted: 集合已删除
+            export: 出口
+            file_downloads_in_collection: 此集合中的文件集下载
+            top_collections: 热门收藏
+            works_in_collection_views: 在此集合视图中的作品
+        date_range_form:
+          date_range_heading: 自定义日期范围
+          end_date: 结束日期
+          reset_date_range: 重置日期范围
+          set_date_range: 设置报告日期范围
+          start_date: 开始日期
+        work_reports:
+          custom_range:
+            date_range_heading: 自定义日期范围
+            file_downloads: 文件下载
+            page_views: 页面浏览量
+            summary_heading: 用户活动摘要
+            unique_visitors: 独立访客
+          index:
+            access_to: 您可以访问
+            activity: 活动
+            and: 和
+            custom_range: 自定义范围
+            date_range_heading: 自定义报告
+            downloads: 下载
+            enable_analytics: 启用分析以查看报告
+            export: 出口
+            monthly: 每月
+            repo_summary: 在这个存储库中，它们共同拥有
+            report_generated_on: 此报告生成于
+            report_header: 定制作品报告
+            subtitle: 用户活动摘要
+            summary: 概括
+            title: 作品报告
+            views: 意见
+            works: 作品
+          monthly_summary:
+            file_downloads: 文件下载
+            monthly_subtitle: 过去 12 个月的逐月状态
+            page_views: 页面浏览量
+          show:
+            custom_range: 自定义范围
+            deposited_by: 存款人
+            monthly: 每月
+            resource_type: 资源类型
+            return_to_btn: 复工报告
+            status: 地位
+            summary: 概括
+            title: 工作报告
+            view_work_btn: 查看工作
+            visibility: 能见度
+            work_type: 工作类型
+          summary:
+            all_time: 整天
+            date_range: 日期范围
+            file_downloads: 文件下载
+            page_views: 页面浏览量
+            subtitle: 用户活动摘要
+            this_month: 这个月
+            this_week: 本星期
+            this_year: 今年
+            today: 今天
+            unique_visitors: 独立访客
+          top_file_set_downloads:
+            file: 文件
+            file_downloads: 文件下载
+            file_name: 文档名称
+            top_downloads: 热门文件下载
+          top_works:
+            export: 出口
+            file_downloads: 文件下载
+            top_works: 热门作品
+            work_title: 作品名称
+            work_views: 工作页面浏览量
+          work_counts:
+            child_works: 儿童作品
+            files: 档案
+            total_size: 总尺寸
+          work_files:
+            title: 文件
+            total_downloads: 总下载量
       appearances:
         show:
           header: 表面
@@ -263,11 +401,14 @@ zh:
           header: 特征
       sidebar:
         activity: 活动
+        analytics: 分析
         appearance: 表面
         collection_types: 集合类型
         collections: 收藏
+        collections_report: 收藏报告
         configuration: 配置
         content_blocks: 内容块
+        dashboard: 仪表盘
         delete_all: 删除所有
         notifications: 通知
         pages: 网页
@@ -284,6 +425,7 @@ zh:
         workflow_roles: 工作流程角色
         works: 作品
         works_listing: 作品清单
+        works_report: 作品报告
       stats:
         deposited_form:
           end_label: 结束 [默认到此刻]
@@ -296,6 +438,10 @@ zh:
             unpublished: 非出版品
         user_deposits:
           end_label: 结束 [默认到此刻]
+          headers:
+            main: 工作统计
+            total: 总作品：
+            visibility: 可见性总计
           heading: 展示用户存储的文件
           start_label: 开始
         works:
@@ -690,13 +836,17 @@ zh:
       authorize_proxies: 授权代理
       breadcrumbs:
         admin: 管理
+        collections_report: 收藏报告
+        works_report: 作品报告
       collection_type_actions:
         close: 关
         create_collection: 创建集合
         select_type_of_collection: 选择收集类型
       collections:
+        collection_title: 藏品名称
         edit:
           header: 编辑收藏集：%{title}
+        files: 文件
         form:
           permission_update_errors:
             error: 无效的权限模板更新选项。
@@ -787,8 +937,10 @@ zh:
             remove: 去掉
             title: 观众
             type: 类型
+        last_updated: 最近更新时间
         new:
           header: 创建新收藏集
+        recent_activity: 近期活动
         show:
           header: 采集
           item_count: 作品
@@ -817,6 +969,7 @@ zh:
         sort_and_per_page:
           show_par_page_html: 显示%{select}每页
           sort_by: 排序：
+        title: 收藏
         work_action_menu:
           delete_work: 删除工作
           deleting_from_work: 从%{application_name}删除作品是永久性的。单击“确定”从%{application_name}中删除此工作，或单击“取消”取消此操作
@@ -825,6 +978,7 @@ zh:
           remove_from_collection: 从收藏中删除
           select_an_action: 选择一个动作
           transfer_ownership_of_work: 转移工作所有权
+        works: 作品
       create_work: 创建作品
       current_proxies: 目前代理
       delete_notification: 删除通知
@@ -884,6 +1038,7 @@ zh:
             view: 视图
           users: '用户:'
         collections: 你的收藏集
+        collections_report: 收藏报告
         facet_label:
           collections: '筛选您的收藏集:'
           highlighted: '筛选您的收藏精品:'
@@ -919,6 +1074,7 @@ zh:
           show_label: 展示所有细节
           thumbnail: 缩图
         works: 您的作品
+        works_report: 作品报告
         your_collections: 你的收藏
         your_works: 你的作品
       nest_collections_form:
@@ -952,12 +1108,18 @@ zh:
         objects: 对象
         subtitle: 过去90天
         title: 存储库增长
+        works: 作品
       repository_objects:
         status: 当前状态
         subtitle: 当前状态
         title: 存储库对象
+      resource_type_graph:
+        count: 数数
+        resource_type: 资源类型
+        title: 资源类型
       show_admin:
         current_registered_users: 电流
+        graph_reports: 自定义图表报告
         new_visitors: 新访问者
         past_30_days: 过去30天
         registered_users: 注册用户
@@ -971,6 +1133,8 @@ zh:
         heading: 您的【下载？】统计
         joined_on: 加入上
         works: 已建立的作品
+      tabs:
+        admin_sets: 管理集
       title: 我的控件板
       transfer_of_ownership: 转让所有权
       transfer_works_link: 选择作品转让
@@ -979,10 +1143,27 @@ zh:
       user_activity:
         date: 日期
         new_users: 新用户
+        new_visitors: 新访客
+        registered_users: 注册用户
+        returning_visitors: 回访者
         subtitle: 新用户注册
         title: 用户活动
+        total_visitors: 访客总数
+        user_summary: 用户摘要
+      user_activity_graph:
+        date: 日期
+        new_users: 新用户
+        new_visits: 新访问
+        return_visits: 回访
+        total_visits: 总访问量
       user_notifications: 用户通知
       view_files: 阅览文件
+      visibility_graph:
+        visibility: 能见度
+      work_type_graph:
+        count: 数数
+        title: 工作类型
+        work_type: 工作类型
     document_language: zh
     edit_profile: 编辑个人资料
     embargoes:
@@ -1363,6 +1544,16 @@ zh:
         contact_form: 联系表
         export_to_zotero: 导出到Zotero
         export_to_zotero_details: 通过嵌入式元数据支持导出到Zotero。如果Zotero没有自动获取存放文件的元数据，请通过以下方式报告问题
+    stats:
+      downloads:
+        downloads: 下载
+      pageviews:
+        pageviews: 页面浏览量
+      work:
+        and: 和
+        downloads: 下载
+        header: 工作分析
+        pageviews: 浏览量
     toolbar:
       dashboard:
         menu: 控件板
@@ -1641,3 +1832,6 @@ zh:
         member_of_collection_ids: 选择一个集合...
     required:
       html: <span class="label label-info required-tag">需要的</span>
+  total_view:
+    one: 该作品共有 1 次浏览
+    other: 此作品总浏览量为 %{count}

data/config/routes.rb

@@ -224,6 +224,10 @@ Hyrax::Engine.routes.draw do
   end
 
   namespace :admin do
+    namespace :analytics do
+      resources :collection_reports, only: [:index, :show]
+      resources :work_reports, only: [:index, :show]
+    end
     resources :admin_sets do
       member do
         get :files

data/docker-compose.yml

@@ -8,6 +8,7 @@ services:
       args:
         - EXTRA_APK_PACKAGES=git less
     image: ghcr.io/samvera/dassie
+    command: sh -l -c 'bundle && bundle exec puma -v -b tcp://0.0.0.0:3000'
     stdin_open: true
     tty: true
     user: root
@@ -109,6 +110,7 @@ services:
       context: .
       target: hyrax-engine-dev-worker
     image: ghcr.io/samvera/dassie-worker
+    command: sh -l -c 'bundle && bundle exec sidekiq'
     user: root
     env_file:
       - .env
@@ -131,7 +133,7 @@ services:
       - hyrax
 
   solr:
-    image: solr:8.7
+    image: solr:8.11.1
     ports:
       - 8983:8983
     command:

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

@@ -43,7 +43,7 @@ Prerequisites are required for both creating a Hyrax\-based app and contributing
 
 Hyrax requires the following software to work:
 
-1. [Solr](http://lucene.apache.org/solr/) version >= 5.x (tested up to 8.7.0)
+1. [Solr](http://lucene.apache.org/solr/) version >= 5.x (tested up to 8.11.1, which includes the log4j library update)
 1. [Fedora Commons](http://www.fedora-commons.org/) digital repository version >= 4.5.1 (tested up to 4.7.5)
 1. A SQL RDBMS (MySQL, PostgreSQL), though **note** that SQLite will be used by default if you're looking to get up and running quickly
 1. [Redis](http://redis.io/), a key-value store
@@ -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.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.2.0/template.rb
+rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.3.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.2.0__. If you are looking for instructions on installing a different
+v3.3.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.
 

data/hyrax.gemspec

@@ -52,8 +52,9 @@ SUMMARY
   spec.add_dependency 'font-awesome-rails', '~> 4.2'
   spec.add_dependency 'hydra-derivatives', '~> 3.3'
   spec.add_dependency 'hydra-editor', '~> 5.0', ">= 5.0.4"
+  spec.add_dependency 'hydra-file_characterization', '~> 1.1.2'
   spec.add_dependency 'hydra-head', '~> 11.0', ">= 11.0.1"
-  spec.add_dependency 'hydra-works', '>= 0.16', '< 2.0'
+  spec.add_dependency 'hydra-works', '>= 0.16'
   spec.add_dependency 'iiif_manifest', '>= 0.3', '< 2.0'
   spec.add_dependency 'jquery-datatables-rails', '~> 3.4'
   spec.add_dependency 'jquery-ui-rails', '~> 6.0'
@@ -95,6 +96,7 @@ SUMMARY
   spec.add_development_dependency "jasmine-core", '~> 2.3', '< 2.99'
   spec.add_development_dependency 'mida', '~> 0.3'
   spec.add_development_dependency 'okcomputer'
+  spec.add_development_dependency 'pg', '~> 1.2'
   spec.add_development_dependency 'rspec-activemodel-mocks', '~> 1.0'
   spec.add_development_dependency 'rspec-its', '~> 1.1'
   spec.add_development_dependency 'rspec-rails', '~> 3.1'

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

@@ -1,9 +1,15 @@
 #
-# To integrate your app with Google Analytics, uncomment the lines below and add your API key information.
+# You can manually fill in these values or use the ENV variables.
 #
-# analytics:
-#   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']
+analytics:
+  google:
+    analytics_id: <%= ENV['GOOGLE_ANALYTICS_ID'] %>
+    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'] %>
+  matomo:
+    base_url: <%= ENV['MATOMO_BASE_URL'] %>
+    site_id: <%= ENV['MATOMO_SITE_ID'] %>
+    auth_token: <%= ENV['MATOMO_AUTH_TOKEN'] %>

data/lib/generators/hyrax/templates/config/initializers/hyrax.rb

@@ -41,19 +41,6 @@ Hyrax.config do |config|
   #   maxFileSize: 500.megabytes
   # }
 
-  # Enable displaying usage statistics in the UI
-  # Defaults to false
-  # Requires a Google Analytics id and OAuth2 keyfile.  See README for more info
-  # config.analytics = false
-
-  # Google Analytics tracking ID to gather usage statistics
-  # config.google_analytics_id = 'UA-99999999-1'
-
-  # Date you wish to start collecting Google Analytic statistics for
-  # Leaving it blank will set the start date to when ever the file was uploaded by
-  # NOTE: if you have always sent analytics to GA for downloads and page views leave this commented out
-  # config.analytic_start_date = DateTime.new(2014, 9, 10)
-
   # Enables a link to the citations page for a work
   # Default is false
   # config.citations = false

data/lib/generators/hyrax/templates/db/migrate/20211130181150_create_default_administrative_set.rb.erb

@@ -0,0 +1,8 @@
+class CreateDefaultAdministrativeSet < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :hyrax_default_administrative_set do |t|
+      t.string :default_admin_set_id, null: false
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/hyrax/work/templates/feature_spec.rb.erb

@@ -31,11 +31,13 @@ RSpec.feature 'Create a <%= class_name %>', js: false do
     end
 
     scenario do
+      pending 'Changes may be required for this test to pass.  See TODO in test.'
+
       visit '/dashboard'
       click_link "Works"
       click_link "Add new work"
 
-      # If you generate more than one work uncomment these lines
+      # TODO: If you generate more than one work uncomment these lines
       # choose "payload_concern", option: "<%= class_name %>"
       # click_button "Create work"
 

data/lib/hyrax/configuration.rb

@@ -112,16 +112,46 @@ module Hyrax
         ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_ANALYTICS', false))
     end
 
-    attr_writer :google_analytics_id
-    def google_analytics_id
-      @google_analytics_id ||= nil
+    # Currently supports 'google' or 'matomo'
+    # google is default for backward compatability
+    attr_writer :analytics_provider
+    def analytics_provider
+      @analytics_provider ||=
+        ENV.fetch('HYRAX_ANALYTICS_PROVIDER', 'google')
+    end
+
+    ##
+    # @!attribute [w] analytics_start_date
+    #   @note this can be set using the +ANALITICS_START_DATE+ environment variable (format is YYYY-MM-DD)
+    #   @return [String] date you wish to start collecting analytics for. used to compute the
+    #     "all-time" metrics.
+    # This is used to compute the "all-time" metrics
+    # Set this in your .env file (format is YYYY-MM-DD)
+    attr_writer :analytics_start_date
+    def analytics_start_date
+      @analytics_start_date ||=
+        ENV.fetch('ANALYTICS_START_DATE', Time.zone.today - 1.year)
     end
-    alias google_analytics_id? google_analytics_id
 
     # Defaulting analytic start date to whenever the file was uploaded by leaving it blank
     attr_writer :analytic_start_date
     attr_reader :analytic_start_date
 
+    ##
+    # @deprecated use analytics_id from config/analytics.yml instead
+    def google_analytics_id=(value)
+      Deprecation.warn("google_analytics_id is deprecated; use analytics_id from config/analytics.yml instead.")
+      Hyrax::Analytics.config.analytics_id = value
+    end
+
+    ##
+    # @deprecated use analytics_id from config/analytics.yml instead
+    def google_analytics_id
+      Deprecation.warn("google_analytics_id is deprecated; use analytics_id from config/analytics.yml instead.")
+      Hyrax::Analytics.config.analytics_id
+    end
+    alias google_analytics_id? google_analytics_id
+
     # @!endgroup
     # @!group Groups
 
@@ -454,6 +484,17 @@ module Hyrax
     # Override characterization runner
     attr_accessor :characterization_runner
 
+    ##
+    # @!attribute [rw] characterization_service
+    #   @return [#run] the service to use for charactaerization for Valkyrie
+    #     objects
+    #   @ see Hyrax::Characterization::ValkyrieCharacterizationService
+    attr_writer :characterization_service
+    def characterization_service
+      @characterization_service ||=
+        Hyrax::Characterization::ValkyrieCharacterizationService
+    end
+
     # Attributes for the lock manager which ensures a single process/thread is mutating a ore:Aggregation at once.
     # @!attribute [w] lock_retry_count
     #   How many times to retry to acquire the lock before raising UnableToAcquireLockError
@@ -677,7 +718,7 @@ module Hyrax
     ##
     # @return [Class] the configured collection model class
     def collection_class
-      collection_model.constantize
+      collection_model.safe_constantize
     end
 
     attr_writer :admin_set_model
@@ -694,6 +735,27 @@ module Hyrax
       admin_set_model.constantize
     end
 
+    ##
+    # @return [String] the default admin set id
+    def default_admin_set_id
+      default_admin_set.id.to_s
+    end
+
+    ##
+    # @return [Hyrax::AdministrativeSet] the default admin set
+    # @see Hyrax::AdminSetCreateService.find_or_create_default_admin_set
+    def default_admin_set
+      @default_admin_set ||= Hyrax::AdminSetCreateService.find_or_create_default_admin_set
+    end
+
+    ##
+    # If the default admin set is changed, call reset.  The next time one of the default
+    # admin set configs is checked, the default_admin_set variable will be updated.
+    # @see Hyrax::DefaultAdministrativeSet.update
+    def reset_default_admin_set
+      @default_admin_set = nil
+    end
+
     attr_writer :id_field
     def id_field
       @id_field || index_field_mapper.id_field

data/lib/hyrax/engine.rb

@@ -3,22 +3,23 @@ module Hyrax
   class Engine < ::Rails::Engine
     isolate_namespace Hyrax
 
+    require 'almond-rails'
     require 'awesome_nested_set'
     require 'breadcrumbs_on_rails'
+    require 'clipboard/rails'
     require 'draper'
-    require 'dry/struct'
     require 'dry/equalizer'
     require 'dry/events'
+    require 'dry/struct'
     require 'dry/validation'
-    require 'jquery-ui-rails'
+    require 'flipflop'
     require 'flot-rails'
-    require 'almond-rails'
+    require 'hydra-file_characterization'
     require 'jquery-datatables-rails'
-    require 'flipflop'
+    require 'jquery-ui-rails'
+    require 'legato'
     require 'qa'
-    require 'clipboard/rails'
     require 'tinymce-rails'
-    require 'legato'
     require 'valkyrie'
 
     require 'hydra/derivatives'

data/lib/hyrax/publisher.rb

@@ -141,5 +141,9 @@ module Hyrax
     # @since 3.0.0
     # @macro a_registered_event
     register_event('object.metadata.updated')
+
+    # @since 3.2.0
+    # @macro a_registered_event
+    register_event('object.file.uploaded')
   end
 end

data/lib/hyrax/transactions/admin_set_create.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Creates a Hyrax::AdministrativeSet from a ChangeSet
+    #
+    # @since 3.2.0
+    class AdminSetCreate < Transaction
+      DEFAULT_STEPS = ['change_set.apply',
+                       'admin_set_resource.apply_collection_type_permissions',
+                       'admin_set_resource.save_acl'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/container.rb

@@ -18,6 +18,7 @@ module Hyrax
     #
     # @see https://dry-rb.org/gems/dry-container/
     class Container # rubocop:disable Metrics/ClassLength
+      require 'hyrax/transactions/admin_set_create'
       require 'hyrax/transactions/apply_change_set'
       require 'hyrax/transactions/collection_create'
       require 'hyrax/transactions/collection_update'
@@ -125,6 +126,16 @@ module Hyrax
         end
       end
 
+      namespace 'admin_set_resource' do |ops| # valkyrie administrative set
+        ops.register 'apply_collection_type_permissions' do
+          Steps::ApplyCollectionTypePermissions.new
+        end
+
+        ops.register 'save_acl' do
+          Steps::SaveAccessControl.new
+        end
+      end
+
       namespace 'collection_resource' do |ops| # valkyrie collection
         ops.register 'apply_collection_type_permissions' do
           Steps::ApplyCollectionTypePermissions.new

data/lib/hyrax/version.rb

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