hyrax 3.1.0 → 3.4.0

data/db/seeds.rb

@@ -10,7 +10,7 @@ errors = Hyrax::Workflow::WorkflowImporter.load_errors
 abort("Failed to process all workflows:\n  #{errors.join('\n  ')}") unless errors.empty?
 
 puts "\n== Creating default admin set"
-admin_set_id = AdminSet.find_or_create_default_admin_set_id
+admin_set_id = Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s
 
 # I have found that when I come back to a development
 # environment, that I may have an AdminSet in Fedora, but it is

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
@@ -27,8 +28,8 @@ services:
     ports:
       - 3000:3000
     volumes:
-      - .dassie:/app/samvera/hyrax-webapp:cached
-      - .:/app/samvera/hyrax-engine:cached
+      - .dassie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
       - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
       - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
       - rails-public:/app/samvera/hyrax-webapp/public
@@ -36,36 +37,67 @@ services:
     networks:
       - hyrax
 
-  chrome:
-    image: selenium/standalone-chrome:3.141
-    logging:
-      driver: none
+  sidekiq:
+    build:
+      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
+      - .dassie/.env
+    depends_on:
+      - db_migrate
+      - fcrepo
+      - memcached
+      - postgres
+      - redis
+      - solr
     volumes:
-      - /dev/shm:/dev/shm
-    shm_size: 2G
-    ports:
-      - "4444:4444"
-      - "5959:5900"
+      - .dassie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
+      - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
+      - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
+      - sidekiq-public:/app/samvera/hyrax-webapp/public
+      - sidekiq-tmp:/app/samvera/hyrax-webapp/tmp
     networks:
       - hyrax
 
   db_migrate:
+    build:
+      context: .
+      target: hyrax-engine-dev
+      args:
+        - EXTRA_APK_PACKAGES=git less
     image: ghcr.io/samvera/dassie
     user: root
     env_file:
       - .env
-    entrypoint: ["sh", "-c"]
-    command: db-migrate-seed.sh
+    command: sh -l -c 'bundle && db-migrate-seed.sh'
     depends_on:
       - postgres
     volumes:
-      - .dassie:/app/samvera/hyrax-webapp:cached
-      - .:/app/samvera/hyrax-engine:cached
+      - .dassie:/app/samvera/hyrax-webapp
+      - .:/app/samvera/hyrax-engine
       - rails-public:/app/samvera/hyrax-webapp/public
       - rails-tmp:/app/samvera/hyrax-webapp/tmp
     networks:
       - hyrax
 
+  chrome:
+    image: selenium/standalone-chrome:3.141
+    logging:
+      driver: none
+    volumes:
+      - /dev/shm:/dev/shm
+    shm_size: 2G
+    ports:
+      - "4444:4444"
+      - "5959:5900"
+    networks:
+      - hyrax
+
   postgres:
     image: postgres:latest
     restart: always
@@ -104,34 +136,8 @@ services:
     networks:
       - hyrax
 
-  sidekiq:
-    build:
-      context: .
-      target: hyrax-engine-dev-worker
-    image: ghcr.io/samvera/dassie-worker
-    user: root
-    env_file:
-      - .env
-      - .dassie/.env
-    depends_on:
-      - db_migrate
-      - fcrepo
-      - memcached
-      - postgres
-      - redis
-      - solr
-    volumes:
-      - .dassie:/app/samvera/hyrax-webapp:cached
-      - .:/app/samvera/hyrax-engine:cached
-      - hyrax-derivatives:/app/samvera/hyrax-webapp/derivatives
-      - hyrax-uploads:/app/samvera/hyrax-webapp/uploads
-      - sidekiq-public:/app/samvera/hyrax-webapp/public
-      - sidekiq-tmp:/app/samvera/hyrax-webapp/tmp
-    networks:
-      - 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.1.0/template.rb
+rails _5.2.6_ new my_app -m https://raw.githubusercontent.com/samvera/hyrax/v3.4.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.1.0__. If you are looking for instructions on installing a different
+v3.4.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'
@@ -82,7 +83,7 @@ SUMMARY
   spec.add_dependency 'select2-rails', '~> 3.5'
   spec.add_dependency 'signet'
   spec.add_dependency 'tinymce-rails'
-  spec.add_dependency 'valkyrie', '>= 2.1.1', "< 3.0"
+  spec.add_dependency 'valkyrie', '~> 2', '>= 2.1.1'
 
   spec.add_development_dependency "capybara", '~> 3.29'
   spec.add_development_dependency 'capybara-screenshot', '~> 1.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/catalog_controller.rb

@@ -5,6 +5,8 @@ class CatalogController < ApplicationController
 
   # This filter applies the hydra access controls
   before_action :enforce_show_permissions, only: :show
+  # Allow all search options when in read-only mode
+  skip_before_action :check_read_only
 
   def self.uploaded_field
     "system_create_dtsi"
@@ -22,7 +24,7 @@ class CatalogController < ApplicationController
     config.view.slideshow.partials = [:index]
 
     # Because too many times on Samvera tech people raise a problem regarding a failed query to SOLR.
-    # Often, it's because they inadvertantly exceeded the character limit of a GET request.
+    # Often, it's because they inadvertently exceeded the character limit of a GET request.
     config.http_method = :post
 
     ## Default parameters to send to solr for all search-like requests. See also SolrHelper#solr_search_params

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
@@ -238,6 +225,16 @@ Hyrax.config do |config|
   #                                "#{ActiveFedora.fedora.host}#{ActiveFedora.fedora.base_path}/#{Noid::Rails.treeify(id)}"
   #                              end
 
+  # Identify the model class name that will be used for Collections in your app
+  # (i.e. ::Collection for ActiveFedora, Hyrax::PcdmCollection for Valkyrie)
+  # config.collection_model = '::Collection'
+  # config.collection_model = 'Hyrax::PcdmCollection'
+
+  # Identify the model class name that will be used for Admin Sets in your app
+  # (i.e. AdminSet for ActiveFedora, Hyrax::AdministrativeSet for Valkyrie)
+  # config.admin_set_model = 'AdminSet'
+  # config.admin_set_model = 'Hyrax::AdministrativeSet'
+
   # When your application is ready to use the valkyrie index instead of the one
   # maintained by active fedora, you will need to set this to true. You will
   # also need to update your Blacklight configuration.

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

@@ -12,7 +12,7 @@ RSpec.feature 'Create a <%= class_name %>', js: false do
     let(:user) do
       User.new(user_attributes) { |u| u.save(validate: false) }
     end
-    let(:admin_set_id) { AdminSet.find_or_create_default_admin_set_id }
+    let(:admin_set_id) { Hyrax::AdminSetCreateService.find_or_create_default_admin_set.id.to_s }
     let(:permission_template) { Hyrax::PermissionTemplate.find_or_create_by!(source_id: admin_set_id) }
     let(:workflow) { Sipity::Workflow.create!(active: true, name: 'test-workflow', permission_template: permission_template) }
 
@@ -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/generators/hyrax/work_resource/templates/indexer_spec.rb.erb

@@ -7,6 +7,7 @@ require 'hyrax/specs/shared_specs/indexers'
 
 RSpec.describe <%= class_name %>Indexer do
   let(:indexer_class) { described_class }
+  let(:resource) { <%= class_name %>.new }
 
   it_behaves_like 'a Hyrax::Resource indexer'
 end

data/lib/hyrax/administrative_set_name.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A custom name for Valkyrie AdministrativeSet objects. Route keys are mapped to `admin_set`
+  # not be the same as the model name.
+  class AdministrativeSetName < Name
+    def initialize(klass, namespace = nil, name = nil)
+      super
+      @human              = 'AdminSet'
+      @i18n_key           = :admin_set
+      @param_key          = 'admin_set'
+      @plural             = 'admin_sets'
+      @route_key          = 'admin_sets'
+      @singular_route_key = 'admin_set'
+    end
+  end
+end

data/lib/hyrax/collection_name.rb

@@ -8,8 +8,14 @@ module Hyrax
     def initialize(klass, namespace = nil, name = nil)
       super
 
-      @route_key          = Collection.model_name.route_key
-      @singular_route_key = Collection.model_name.singular_route_key
+      @human              = 'Collection'
+      @i18n_key           = :collection
+      @param_key          = 'collection'
+      @plural             = 'collections'
+      @route_key          = 'collections'
+      @singular_route_key = 'collection'
+      @collection         = 'collections'
+      @element            = 'collection'
     end
   end
 end

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
 
@@ -419,6 +449,7 @@ module Hyrax
     ##
     # @return [Boolean] whether to use experimental valkyrie storage features
     def use_valkyrie?
+      return true if disable_wings # always return true if wings is disabled
       ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_VALKYRIE', false))
     end
     # @!endgroup
@@ -454,6 +485,26 @@ 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
+
+    ##
+    # @!attribute [w] characterization_proxy
+    #   Which FileSet file to use for mime type resolution
+    #   @ see Hyrax::FileSetTypeService
+    attr_writer :characterization_proxy
+    def characterization_proxy
+      @characterization_proxy ||= :original_file
+    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
@@ -666,6 +717,55 @@ module Hyrax
       @collection_type_index_field ||= 'collection_type_gid_ssim'
     end
 
+    attr_writer :collection_model
+    ##
+    # @return [#constantize] a string representation of the collection
+    #   model
+    def collection_model
+      @collection_model ||= '::Collection'
+    end
+
+    ##
+    # @return [Class] the configured collection model class
+    def collection_class
+      collection_model.safe_constantize
+    end
+
+    attr_writer :admin_set_model
+    ##
+    # @return [#constantize] a string representation of the admin set
+    #   model
+    def admin_set_model
+      @admin_set_model ||= 'AdminSet'
+    end
+
+    ##
+    # @return [Class] the configured admin set model class
+    def admin_set_class
+      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/controlled_vocabularies/location.rb

@@ -4,10 +4,17 @@ module Hyrax
     class Location < ActiveTriples::Resource
       configure rdf_label: ::RDF::Vocab::GEONAMES.name
 
+      include ResourceLabelCaching
+
       # Return a tuple of url & label
       def solrize
-        return [rdf_subject.to_s] if rdf_label.first.to_s.blank? || rdf_label.first.to_s == rdf_subject.to_s
-        [rdf_subject.to_s, { label: "#{rdf_label.first}$#{rdf_subject}" }]
+        label = full_label || rdf_label.first.to_s
+        return [rdf_subject.to_s] if label.blank? || label == rdf_subject.to_s
+        [rdf_subject.to_s, { label: "#{label}$#{rdf_subject}" }]
+      end
+
+      def full_label
+        Hyrax::LocationService.new.full_label(rdf_subject.to_s)
       end
     end
   end

data/lib/hyrax/controlled_vocabularies/resource_label_caching.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Hyrax
+  module ControlledVocabularies
+    ##
+    # adds caching to the {#rdf_label} method.
+    #
+    # for systems that check the {#rdf_label}and use {#fetch} to get upstream
+    # data if it is not present, this can be used to avoid making round trips
+    # to an authoritative web source.
+    #
+    # @see Hyrax::DeepIndexingService
+    module ResourceLabelCaching
+      CACHE_KEY_PREFIX = "hy_label-v1-"
+
+      ##
+      # @note uses the Rails cache to avoid repeated lookups.
+      # @see ActiveTriples::Resource#rdf_label
+      def rdf_label
+        # only cache if this rdf source is represented by a URI;
+        # i.e. don't cache for blank nodes
+        return super unless uri?
+
+        Rails.cache.fetch(cache_key) { super }
+      end
+
+      ##
+      # @note adds behavior to clear the cache whenever a manual fetch of data
+      #   is performed.
+      # @see ActiveTriples::Resource#fetch
+      def fetch(*)
+        Rails.cache.delete(cache_key)
+        super
+      end
+
+      private
+
+      def cache_key
+        "#{CACHE_KEY_PREFIX}#{to_uri.canonicalize.pname}"
+      end
+    end
+  end
+end

data/lib/hyrax/controlled_vocabularies.rb

@@ -5,6 +5,7 @@ module Hyrax
 
     eager_autoload do
       autoload :Location
+      autoload :ResourceLabelCaching
     end
   end
 end

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/form_fields.rb

@@ -49,6 +49,7 @@ module Hyrax
 
       form_field_definitions.each do |field_name, options|
         descendant.property field_name.to_sym, options.merge(display: true, default: [])
+        descendant.validates field_name.to_sym, presence: true if options.fetch(:required, false)
       end
     end
   end