Potential Issues Around Knapsack and Rails.root

[jeremyf]

In Hyku and Hyrax there are long-standing references to Rails.root. This works when Hyku is the base application. However, with Knapsack, we need to consider an alternate approach to Rails.root.

The issue is as follows:

• Rails.root resolves to the root of the Hyku application
• Knapsack is intended to be an overlay of that application; meaning if I add a static file in Knapsack we would want Hyku to pick that up.

A proposed solution for Hyku is available here:

• ♻️ TO MAIN: Add handling for Knapsack theme overrides samvera/hyku#2011
• ♻️ Add handling for Knapsack theme overrides samvera/hyku#2010
• ♻️ TO MAIN: Introduce Hyku::Application.theme_view_path_roots samvera/hyku#2008
• ♻️ Introduce Hyku::Application.theme_view_path_roots samvera/hyku#2007

We'll also want to add a rubocop to indicate the Rails.root is an anti-pattern.

However, Hyrax also uses Rails.root to reference static files. I used rg Rails.root app lib --files-with-matches | awk '{ print "- [ ] " $1 } to generate the list of files that need reviewing:

• app/services/hyrax/simple_schema_loader.rb
• app/services/hyrax/analytics/google.rb
• app/services/hyrax/analytics/matomo.rb
• app/services/hyrax/workflow/workflow_importer.rb
• app/controllers/hyrax/downloads_controller.rb
• lib/hyrax/configuration.rb
• lib/hyrax/controlled_vocabulary/importer/language.rb
• lib/tasks/universal_viewer.rake
• lib/generators/hyrax/templates/config/initializers/redis_config.rb
• lib/generators/hyrax/templates/config/initializers/hyrax.rb
• lib/generators/hyrax/templates/config/initializers/riiif.rb
• lib/hyrax/arkivo/config.rb
• lib/hyrax/zotero/config.rb
• lib/hyrax/specs/capybara.rb

This is repeated in:

• Potential Issues Around Knapsack and Rails.root scientist-softserv/adventist_knapsack#60