hyrax 5.2.0 → 5.3.0

data/lib/generators/hyrax/install_generator.rb

@@ -34,6 +34,8 @@ module Hyrax
   17. Install jquery-datatables
   18. Initializes the noid-rails database-backed minter
   19. Generates RIIIF image server implementation
+  20. Adds show builder for blacklight_dynamic_sitemaps
+  21. Removes the public/robots.txt in favor of a dynamic one
          """
 
     def run_required_generators
@@ -59,17 +61,31 @@ module Hyrax
     end
 
     # The engine routes have to come after the devise routes so that /users/sign_in will work
-    def inject_routes
+    def inject_routes # rubocop:disable Metrics/MethodLength
       # Remove root route that was added by blacklight generator
       gsub_file 'config/routes.rb', /root (:to =>|to:) "catalog#index"/, ''
 
       inject_into_file 'config/routes.rb', after: /devise_for :users\s*\n/ do
         "  mount Qa::Engine => '/authorities'\n"\
+        "  mount BlacklightDynamicSitemap::Engine => '/'\n"\
         "  mount Hyrax::Engine, at: '/'\n"\
         "  resources :welcome, only: 'index'\n"\
         "  root 'hyrax/homepage#index'\n"\
         "  curation_concerns_basic_routes\n"\
       end
+
+      # Catch-all redirect resolver. Must be the last route in the host
+      # application so that every other route — engine mounts, host-specific
+      # routes, curation concerns — gets first crack at matching the request.
+      # Gated by Hyrax.config.redirects_active? at request time so the route is
+      # transparent when the redirects feature is off.
+      # See documentation/redirects.md.
+      inject_into_file 'config/routes.rb', before: /^end\s*\Z/ do
+        "\n  # Catch-all redirect resolver — must be last. See documentation/redirects.md.\n"\
+        "  get '*alias_path', to: 'hyrax/redirects#show',\n"\
+        "                     constraints: ->(_req) { Hyrax.config.redirects_active? },\n"\
+        "                     format: false\n"
+      end
     end
 
     # Add behaviors to the SolrDocument model
@@ -203,11 +219,19 @@ module Hyrax
       copy_file '.lando.yml'
     end
 
+    def remove_robots
+      remove_file 'public/robots.txt'
+    end
+
     def dotenv
       copy_file '.env'
       gem_group :development, :test do
         gem 'dotenv-rails', '~> 2.8'
       end
     end
+
+    def blacklight_dynamic_sitemap
+      copy_file 'app/views/blacklight_dynamic_sitemap/sitemap/show.xml.builder', 'app/views/blacklight_dynamic_sitemap/sitemap/show.xml.builder'
+    end
   end
 end

data/lib/generators/hyrax/riiif_generator.rb

@@ -17,7 +17,7 @@ class Hyrax::RiiifGenerator < Rails::Generators::Base
   end
 
   def add_to_gemfile
-    gem 'riiif', '~> 2.1'
+    gem 'riiif', '~> 2.8'
   end
 
   def copy_initializer

data/lib/generators/hyrax/templates/app/views/blacklight_dynamic_sitemap/sitemap/show.xml.builder

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+xml.instruct! :xml, version: '1.0', encoding: 'UTF-8'
+xml.urlset(
+  'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
+  'xsi:schemaLocation' => 'http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd',
+  'xmlns' => 'http://www.sitemaps.org/schemas/sitemap/0.9'
+) do
+  config = BlacklightDynamicSitemap::Engine.config
+  @sitemap_entries.each do |doc|
+    solr_doc = SolrDocument.new(doc)
+
+    xml.url do
+      # Use Hyrax's routing logic: collections go through hyrax engine, works through main_app
+      url_parts = solr_doc.collection? ? [hyrax, solr_doc] : [main_app, solr_doc]
+      xml.loc(polymorphic_url(url_parts))
+
+      last_modified = doc[config.last_modified_field]
+      xml.lastmod(config.format_last_modified&.call(last_modified) || last_modified)
+    end
+  end
+end

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

@@ -1,2 +1,4 @@
 # frozen_string_literal: true
 ClamAV.instance.loaddb if defined? ClamAV
+
+Clamby.configure(daemonize: true, fdpass: true) if defined? Clamby

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

@@ -13,7 +13,7 @@ Rails.application.reloader.to_prepare do
   end
 
   if Hyrax.config.use_valkyrie?
-    Riiif::Image.file_resolver = Hyrax::RiiifFileResolver.new
+    Riiif::Image.file_resolver = Hyrax::Riiif::FileResolver.new
   else
     Riiif::Image.file_resolver = Riiif::HttpFileResolver.new
 
@@ -30,83 +30,7 @@ Rails.application.reloader.to_prepare do
   Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
 
   Riiif::Engine.config.cache_duration = 1.day
-end
-
-module Hyrax
-  # Adds file locking to Riiif::File
-  # @see RiiifFileResolver
-  Rails.application.reloader.to_prepare do
-    class RiiifFile < Riiif::File
-      include ActiveSupport::Benchmarkable
-
-      attr_reader :id
-      def initialize(input_path, tempfile = nil, id:)
-        super(input_path, tempfile)
-        raise(ArgumentError, "must specify id") if id.blank?
-        @id = id
-      end
-
-      # Wrap extract in a read lock and benchmark it
-      def extract(transformation, image_info = nil)
-        Riiif::Image.file_resolver.file_locks[id].with_read_lock do
-          benchmark "RiiifFile extracted #{path} with #{transformation.to_params}", level: :debug do
-            super
-          end
-        end
-      end
-
-      private
-
-      def logger
-        Hyrax.logger
-      end
-    end
-  end
-
-  class RiiifFileResolver
-    include ActiveSupport::Benchmarkable
-
-    # @param [String] id from iiif manifest
-    # @return [Riiif::File]
-    def find(id)
-      path = nil
-      file_locks[id].with_write_lock do
-        path = build_path(id)
-        path = build_path(id, force: true) unless File.exist?(path) # Ensures the file is locally available
-      end
-      RiiifFile.new(path, id: id)
-    end
-
-    # tracks individual file locks
-    # @see RiiifFile
-    # @return [Concurrent::Map<Concurrent::ReadWriteLock>]
-    def file_locks
-      @file_locks ||= Concurrent::Map.new do |k, v|
-        k.compute_if_absent(v) { Concurrent::ReadWriteLock.new }
-      end
-    end
-
-    private
-
-    def build_path(id, force: false)
-      Riiif::Image.cache.fetch("riiif:" + Digest::MD5.hexdigest("path:#{id}"),
-                               expires_in: Riiif::Image.expires_in,
-                               force: force) do
-        load_file(id)
-      end
-    end
-
-    def load_file(id)
-      benchmark "RiiifFileResolver loaded #{id}", level: :debug do
-        fs_id = id.sub(/\A([^\/]*)\/.*/, '\1')
-        file_set = Hyrax.query_service.find_by(id: fs_id)
-        file_metadata = Hyrax.custom_queries.find_original_file(file_set: file_set)
-        file_metadata.file.disk_path.to_s # Stores a local copy in tmpdir
-      end
-    end
-
-    def logger
-      Hyrax.logger
-    end
-  end
+  # Defaults to using Imagemagick - Set use_vips to true in order to use vips. lib-vips is already installed as part of hyrax-base
+  # Must be using riiif 2.8 or newer
+  # Riiif::Engine.config.use_vips = false
 end

data/lib/generators/hyrax/templates/db/migrate/20240606205215_create_hyrax_flexible_schemas.rb.erb

@@ -0,0 +1,9 @@
+class CreateHyraxFlexibleSchemas < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :hyrax_flexible_schemas do |t|
+      t.text :profile
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/hyrax/templates/db/migrate/20240606205216_add_contexts_to_hyrax_flexible_schemas.rb.erb

@@ -0,0 +1,5 @@
+class AddContextsToHyraxFlexibleSchemas < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :hyrax_flexible_schemas, :contexts, :text unless column_exists?(:hyrax_flexible_schemas, :contexts)
+  end
+end

data/lib/generators/hyrax/templates/db/migrate/20260430000001_create_hyrax_redirect_paths.rb.erb

@@ -0,0 +1,22 @@
+class CreateHyraxRedirectPaths < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :hyrax_redirect_paths do |t|
+      t.string :path, null: false
+      t.string :resource_id, null: false
+
+      t.timestamps
+    end
+
+    # Unique index on path enforces global uniqueness at the DB level (the hard
+    # guarantee under concurrent writes) and is the primary lookup index for
+    # validation. Whole-string equality only — paths are case-sensitive per
+    # RFC 3986, no LIKE patterns.
+    add_index :hyrax_redirect_paths, :path, unique: true
+
+    # Non-unique index supports the per-resource sync performed by
+    # Hyrax::Transactions::Steps::SyncRedirectPaths and
+    # Hyrax::Transactions::Steps::RemoveRedirectPaths, which delete all rows for
+    # a resource_id before reinserting (or on resource destroy).
+    add_index :hyrax_redirect_paths, :resource_id
+  end
+end

data/lib/generators/hyrax/templates/db/migrate/20260521003627_add_additional_redirect_info.rb.erb

@@ -0,0 +1,39 @@
+class AddAdditionalRedirectInfo < ActiveRecord::Migration<%= migration_version %>
+  def up
+    drop_table :hyrax_redirect_paths if table_exists?(:hyrax_redirect_paths)
+
+    create_table :hyrax_redirect_paths do |t|
+      t.string  :from_path,      null: false
+      t.string  :to_path,        null: false
+      t.string  :permalink_path, null: false
+      t.string  :resource_id,    null: false
+      t.boolean :is_display_url, null: false, default: false
+
+      t.timestamps
+    end
+
+    # Unique index on from_path enforces global uniqueness at the DB level
+    # (the hard guarantee under concurrent writes) and is the primary
+    # request-time lookup: the resolver finds rows by the visited alias.
+    add_index :hyrax_redirect_paths, :from_path, unique: true
+
+    # Non-unique index supports the per-resource sync performed by
+    # Hyrax::Transactions::Steps::SyncRedirectPaths and the per-resource
+    # cleanup performed by Hyrax::Transactions::Steps::RemoveRedirectPaths.
+    add_index :hyrax_redirect_paths, :resource_id
+  end
+
+  def down
+    drop_table :hyrax_redirect_paths
+
+    create_table :hyrax_redirect_paths do |t|
+      t.string :path,        null: false
+      t.string :resource_id, null: false
+
+      t.timestamps
+    end
+
+    add_index :hyrax_redirect_paths, :path, unique: true
+    add_index :hyrax_redirect_paths, :resource_id
+  end
+end

data/lib/generators/hyrax/templates/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "repository": "git@github.com:samvera/hyrax.git",
   "dependencies": {
-    "universalviewer": "^3.1.4"
+    "universalviewer": "^4.2.1"
   },
   "scripts": {
     "preinstall": "rm -rf ./public/uv",

data/lib/generators/hyrax/templates/uv.html

@@ -1,87 +1,65 @@
-
 <!--
     This is what the embed iframe src links to. It doesn't need to communicate with the parent page, only fill the available space and look for #? parameters
 -->
 
-<html>
-    <head>
-        <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0" />
-        <link rel="icon" href="favicon.ico">
-        <link rel="stylesheet" type="text/css" href="uv.css">
-        <script src="https://cdn.jsdelivr.net/npm/hls.js@latest"></script>
-        <script type="text/javascript" src="lib/offline.js"></script>
-        <script type="text/javascript" src="helpers.js"></script>
-        <style>
-            body {
-                margin: 0;
-                padding: 0;
-                overflow: hidden;
-            }
-        </style>
-        <script type="text/javascript">
-        window.addEventListener('uvLoaded', function(e) { 
-                urlDataProvider = new UV.URLDataProvider(true);
-                var formattedLocales;
-                var locales = urlDataProvider.get('locales', '');
-    
-                if (locales) {
-                    var names = locales.split(',');
-                    formattedLocales = [];
-    
-                    for (var i in names) {
-                        var nameparts = String(names[i]).split(':');
-                        formattedLocales[i] = {name: nameparts[0], label: nameparts[1]};
-                    }
-                    
-                } else {
-                    formattedLocales = [
-                        {
-                            name: 'en-GB'
-                        }
-                    ]
-                }
-    
-                uv = createUV('#uv', {
-                    root: '.',
-                    iiifResourceUri: urlDataProvider.get('manifest'),
-                    configUri: urlDataProvider.get('config'),
-                    collectionIndex: Number(urlDataProvider.get('c', 0)),
-                    manifestIndex: Number(urlDataProvider.get('m', 0)),
-                    sequenceIndex: Number(urlDataProvider.get('s', 0)),
-                    canvasIndex: Number(urlDataProvider.get('cv', 0)),
-                    rangeId: urlDataProvider.get('rid', 0),
-                    rotation: Number(urlDataProvider.get('r', 0)),
-                    xywh: urlDataProvider.get('xywh', ''),
-                    embedded: true,
-                    locales: formattedLocales
-                }, urlDataProvider);
-            }, false);
-        </script>
-    </head>    
-    <body>
-    
-        <div id="uv" class="uv"></div>
-    
-        <script>
-            $(function() {
-        
-                var $UV = $('#uv');
-        
-                function resize() {
-                    var windowWidth = window.innerWidth;
-                    var windowHeight = window.innerHeight;
-                    $UV.width(windowWidth);
-                    $UV.height(windowHeight);
-                }
-        
-                $(window).on('resize' ,function() {
-                    resize();
-                });
-                
-                resize();
-            });
-            
-        </script>
-        <script type="text/javascript" src="uv.js"></script>
-    </body>
+<!DOCTYPE html>
+<html lang="en" xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"
+    />
+    <link rel="icon" href="favicon.ico" />
+    <link rel="stylesheet" type="text/css" href="uv.css" />
+    <script type="text/javascript" src="umd/UV.js"></script>
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+        overflow: hidden;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="uv" class="uv"></div>
+
+    <script>
+      document.addEventListener("DOMContentLoaded", function() {
+        var urlAdapter = new UV.IIIFURLAdapter(true);
+
+        const data = urlAdapter.getInitialData({
+          embedded: true,
+        });
+
+        uv = UV.init("uv", data);
+
+
+        const configUrl = urlAdapter.get('config');
+        if (configUrl) {
+          uv.on("configure", function({ config, cb }) {
+            cb(
+              // new Promise(function (resolve) {
+              //   fetch(configUrl).then(function (response) {
+              //     resolve(response.json());
+              //   });
+              // })
+            );
+          })
+        }
+
+        var $UV = document.getElementById("uv");
+
+        function resize() {
+          $UV.setAttribute("style", "width:" + window.innerWidth + "px");
+          $UV.setAttribute("style", "height:" + window.innerHeight + "px");
+        }
+
+        addEventListener("resize", function() {
+          resize();
+        });
+
+        resize();
+      });
+    </script>
+  </body>
 </html>

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

@@ -7,7 +7,7 @@ class <%= class_name %>Indexer < Hyrax::WorkIndexer
 
   # Fetch remote labels for based_near. You can remove this if you don't want
   # this behavior
-  include Hyrax::IndexesLinkedMetadata
+  include Hyrax::IndexesLinkedMetadata if Hyrax.config.work_include_metadata?
 
   # Uncomment this block if you want to add custom indexing behavior:
   # def generate_solr_document

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

@@ -10,5 +10,9 @@ class <%= class_name %> < ActiveFedora::Base
 
   # This must be included at the end, because it finalizes the metadata
   # schema (by adding accepts_nested_attributes)
-  include ::Hyrax::BasicMetadata
+  if Hyrax.config.work_include_metadata?
+    include ::Hyrax::Schema(:core_metadata) unless Hyrax.config.work_default_metadata?
+    include ::Hyrax::BasicMetadata
+   end
+
 end

data/lib/generators/hyrax/work_resource/templates/form.rb.erb

@@ -6,8 +6,11 @@
 # @see https://github.com/samvera/hyrax/wiki/Hyrax-Valkyrie-Usage-Guide#forms
 # @see https://github.com/samvera/valkyrie/wiki/ChangeSets-and-Dirty-Tracking
 class <%= class_name %>Form < Hyrax::Forms::PcdmObjectForm(<%= class_name %>)
-  include Hyrax::FormFields(:basic_metadata)
-  include Hyrax::FormFields(:<%= file_name %>)
+  if Hyrax.config.work_include_metadata?
+    include Hyrax::FormFields(:basic_metadata)
+    include Hyrax::FormFields(:<%= file_name %>)
+  end
+  check_if_flexible(<%= class_name %>)
 
   # Define custom form fields using the Valkyrie::ChangeSet interface
   #

data/lib/generators/hyrax/work_resource/templates/indexer.rb.erb

@@ -3,8 +3,12 @@
 # Generated via
 #  `rails generate hyrax:work_resource <%= class_name %>`
 class <%= class_name %>Indexer < Hyrax::Indexers::PcdmObjectIndexer(<%= class_name %>)
-  include Hyrax::Indexer(:basic_metadata)
-  include Hyrax::Indexer(:<%= file_name %>)
+  if Hyrax.config.work_include_metadata?
+    include Hyrax::Indexer(:core_metadata)
+    include Hyrax::Indexer(:basic_metadata)
+    include Hyrax::Indexer(:<%= file_name %>)
+  end
+  check_if_flexible(<%= class_name %>)
 
   # Uncomment this block if you want to add custom indexing behavior:
   #  def to_solr

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

@@ -3,6 +3,9 @@
 # Generated via
 #  `rails generate hyrax:work_resource <%= class_name %>`
 class <%= class_name %> < Hyrax::Work
-  include Hyrax::Schema(:basic_metadata)
-  include Hyrax::Schema(:<%= file_name %>)
+  if Hyrax.config.work_include_metadata?
+    include Hyrax::Schema(:core_metadata) unless Hyrax.config.work_default_metadata?
+    include Hyrax::Schema(:basic_metadata)
+    include Hyrax::Schema(:<%= file_name %>)
+  end
 end

data/lib/generators/hyrax/work_resource/work_resource_generator.rb

@@ -37,6 +37,7 @@ class Hyrax::WorkResourceGenerator < Rails::Generators::NamedBase
   end
 
   def create_metadata_config
+    return if Hyrax.config.work_include_metadata?
     template('metadata.yaml', File.join('config/metadata/', "#{file_name}.yaml"))
     return if attributes.blank?
     gsub_file File.join('config/metadata/', "#{file_name}.yaml"),

data/lib/hyrax/active_fedora_dummy_model.rb

@@ -76,5 +76,11 @@ module Hyrax
         URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
       end
     end
+
+    ##
+    # @api public
+    def name
+      @model.name
+    end
   end
 end