hyrax 3.5.0 → 4.0.0.beta1

data/lib/generators/hyrax/templates/catalog_controller.rb

@@ -19,10 +19,6 @@ class CatalogController < ApplicationController
   configure_blacklight do |config|
     config.search_builder_class = Hyrax::CatalogSearchBuilder
 
-    # Show gallery view
-    config.view.gallery.partials = [:index_header, :index]
-    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 inadvertently exceeded the character limit of a GET request.
     config.http_method = :post
@@ -39,6 +35,17 @@ class CatalogController < ApplicationController
     config.index.display_type_field = "has_model_ssim"
     config.index.thumbnail_field = 'thumbnail_path_ss'
 
+    config.add_results_document_tool(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    config.add_results_collection_tool(:sort_widget)
+    config.add_results_collection_tool(:per_page_widget)
+    config.add_results_collection_tool(:view_type_group)
+    config.add_show_tools_partial(:bookmark, partial: 'bookmark_control', if: :render_bookmarks_control?)
+    config.add_show_tools_partial(:email, callback: :email_action, validator: :validate_email_params)
+    config.add_show_tools_partial(:sms, if: :render_sms_action?, callback: :sms_action, validator: :validate_sms_params)
+    config.add_show_tools_partial(:citation)
+    config.add_nav_action(:bookmark, partial: 'blacklight/nav/bookmark', if: :render_bookmarks_control?)
+    config.add_nav_action(:search_history, partial: 'blacklight/nav/search_history')
+
     # solr fields that will be treated as facets by the blacklight application
     #   The ordering of the field names is the order of the display
     config.add_facet_field "human_readable_type_sim", label: "Type", limit: 5
@@ -67,22 +74,22 @@ class CatalogController < ApplicationController
     #   The ordering of the field names is the order of the display
     config.add_index_field "title_tesim", label: "Title", itemprop: 'name', if: false
     config.add_index_field "description_tesim", itemprop: 'description', helper_method: :iconify_auto_link
-    config.add_index_field "keyword_tesim", itemprop: 'keywords', link_to_search: "keyword_sim"
-    config.add_index_field "subject_tesim", itemprop: 'about', link_to_search: "subject_sim"
-    config.add_index_field "creator_tesim", itemprop: 'creator', link_to_search: "creator_sim"
-    config.add_index_field "contributor_tesim", itemprop: 'contributor', link_to_search: "contributor_sim"
+    config.add_index_field "keyword_tesim", itemprop: 'keywords', link_to_facet: "keyword_sim"
+    config.add_index_field "subject_tesim", itemprop: 'about', link_to_facet: "subject_sim"
+    config.add_index_field "creator_tesim", itemprop: 'creator', link_to_facet: "creator_sim"
+    config.add_index_field "contributor_tesim", itemprop: 'contributor', link_to_facet: "contributor_sim"
     config.add_index_field "proxy_depositor_ssim", label: "Depositor", helper_method: :link_to_profile
     config.add_index_field "depositor_tesim", label: "Owner", helper_method: :link_to_profile
-    config.add_index_field "publisher_tesim", itemprop: 'publisher', link_to_search: "publisher_sim"
-    config.add_index_field "based_near_label_tesim", itemprop: 'contentLocation', link_to_search: "based_near_label_sim"
-    config.add_index_field "language_tesim", itemprop: 'inLanguage', link_to_search: "language_sim"
+    config.add_index_field "publisher_tesim", itemprop: 'publisher', link_to_facet: "publisher_sim"
+    config.add_index_field "based_near_label_tesim", itemprop: 'contentLocation', link_to_facet: "based_near_label_sim"
+    config.add_index_field "language_tesim", itemprop: 'inLanguage', link_to_facet: "language_sim"
     config.add_index_field "date_uploaded_dtsi", itemprop: 'datePublished', helper_method: :human_readable_date
     config.add_index_field "date_modified_dtsi", itemprop: 'dateModified', helper_method: :human_readable_date
     config.add_index_field "date_created_tesim", itemprop: 'dateCreated'
     config.add_index_field "rights_statement_tesim", helper_method: :rights_statement_links
     config.add_index_field "license_tesim", helper_method: :license_links
-    config.add_index_field "resource_type_tesim", label: "Resource Type", link_to_search: "resource_type_sim"
-    config.add_index_field "file_format_tesim", link_to_search: "file_format_sim"
+    config.add_index_field "resource_type_tesim", label: "Resource Type", link_to_facet: "resource_type_sim"
+    config.add_index_field "file_format_tesim", link_to_facet: "file_format_sim"
     config.add_index_field "identifier_tesim", helper_method: :index_field_link, field_name: 'identifier'
     config.add_index_field Hydra.config.permissions.embargo.release_date, label: "Embargo release date", helper_method: :human_readable_date
     config.add_index_field Hydra.config.permissions.lease.expiration_date, label: "Lease expiration date", helper_method: :human_readable_date

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

@@ -20,7 +20,7 @@ ActiveSupport::Reloader.to_prepare do
     end
   end
 
-  Riiif::Image.authorization_service = Hyrax::IIIFAuthorizationService
+  Riiif::Image.authorization_service = Hyrax::IiifAuthorizationService
 
   Riiif.not_found_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')
   Riiif.unauthorized_image = Rails.root.join('app', 'assets', 'images', 'us_404.svg')

data/lib/generators/hyrax/templates/config/locales/hyrax.pt-BR.yml

@@ -50,7 +50,7 @@ pt-BR:
     directory:
       suffix: "@ Example.org"
     footer:
-      copyright_html: "<strong>Copyright © 2018 Samvera </strong> Licenciado sob a Licença Apache, Versão 2.0"
+      copyright_html: "<strong>Copyright © 2022 Samvera </strong> Licenciado sob a Licença Apache, Versão 2.0"
       service_html: Um serviço de <a href="http://samvera.org/" class="navbar-link" target="_blank">Samvera</a> .
     institution_name: Instituição
     institution_name_full: O Nome da Instituição

data/lib/generators/hyrax/templates/hyrax.scss

@@ -4,14 +4,13 @@
  *= require_self
 */
 
-@import "bootstrap-sprockets";
 @import "bootstrap-default-overrides";
 @import 'bootstrap';
-@import 'blacklight/blacklight';
 @import "font-awesome";
 @import "blacklight_gallery/gallery";
 @import "blacklight_gallery/masonry";
 @import "blacklight_gallery/slideshow";
 @import "blacklight_gallery/osd_viewer";
+@import "hyrax/blacklight_gallery";
 @import 'hyrax/hyrax';
 @import 'hyrax/login_signup';

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

@@ -3,15 +3,14 @@
   "private": true,
   "repository": "git@github.com:samvera/hyrax.git",
   "dependencies": {
-  "universalviewer": "^3.0.16"
-},
-"scripts": {
-  "preinstall": "rm -rf ./public/uv",
-  "postinstall": "yarn run uv-install && yarn run uv-config",
-  "uv-install": "shx cp -r ./node_modules/universalviewer/dist ./public/uv",
-  "uv-config": "shx cp ./config/uv/uv.html ./public/uv/uv.html & shx cp ./config/uv/uv-config.json ./public/uv/"
+    "universalviewer": "^3.1.4"
+  },
+  "scripts": {
+    "preinstall": "rm -rf ./public/uv",
+    "postinstall": "yarn run uv-install && yarn run uv-config",
+    "uv-install": "cp -r ./node_modules/universalviewer/dist ./public/uv",
+    "uv-config": "cp ./config/uv/uv.html ./public/uv/uv.html & cp ./config/uv/uv-config.json ./public/uv/"
   },
   "devDependencies": {
-  "shx": "^0.3.2"
   }
 }

data/lib/hyrax/active_fedora_dummy_model.rb

@@ -35,25 +35,12 @@ module Hyrax
       @id
     end
 
-    ##
-    # @api public
-    def to_key
-      [@id]
-    end
-
     ##
     # @api public
     def model_name
       @model.model_name
     end
 
-    ##
-    # @api public
-    # @return [String]
-    def human_readable_type
-      @model.human_readable_type
-    end
-
     ##
     # @api public
     #

data/lib/hyrax/configuration.rb

@@ -137,21 +137,6 @@ module Hyrax
     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
 
@@ -546,20 +531,6 @@ module Hyrax
       @ingest_queue_name ||= :default
     end
 
-    # @deprecated
-    def whitelisted_ingest_dirs
-      Deprecation.warn(self, "Samvera is deprecating #{self.class}#whitelisted_ingest_dirs " \
-        "in Hyrax 3.0. Instead use #{self.class}#registered_ingest_dirs.")
-      registered_ingest_dirs
-    end
-
-    # @deprecated
-    def whitelisted_ingest_dirs=(input)
-      Deprecation.warn(self, "Samvera is deprecating #{self.class}#whitelisted_ingest_dirs= " \
-        "in Hyrax 3.0. Instead use #{self.class}#registered_ingest_dirs=.")
-      self.registered_ingest_dirs = input
-    end
-
     # @!attribute [w] registered_ingest_dirs
     #   List of directories which can be used for local file system ingestion.
     attr_writer :registered_ingest_dirs
@@ -838,17 +809,6 @@ module Hyrax
       end
     end
 
-    attr_writer :resource_id_to_uri_transformer
-    def resource_id_to_uri_transformer
-      Deprecation.warn('Use Hyrax.config.translate_uri_to_id instead.')
-
-      @resource_id_to_uri_transformer ||= lambda do |resource, base_url|
-        file_id = CGI.escape(resource.file_identifier.to_s)
-        fs_id = CGI.escape(resource.file_set_id.to_s)
-        "#{base_url}#{::Noid::Rails.treeify(fs_id)}/files/#{file_id}"
-      end
-    end
-
     attr_writer :contact_email
     def contact_email
       @contact_email ||= "repo-admin@example.org"
@@ -875,17 +835,10 @@ module Hyrax
                     end
     end
 
-    def use_solr_graph_for_collection_nesting
-      ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_USE_SOLR_GRAPH_NESTING', false))
-    end
-
     attr_accessor :nested_relationship_reindexer
+
     def default_nested_relationship_reindexer
-      if use_solr_graph_for_collection_nesting
-        ->(id:, extent:) {}
-      else
-        ->(id:, extent:) { Samvera::NestingIndexer.reindex_relationships(id: id, extent: extent) }
-      end
+      ->(id:, extent:) { Samvera::NestingIndexer.reindex_relationships(id: id, extent: extent) }
     end
 
     attr_writer :solr_select_path

data/lib/hyrax/engine.rb

@@ -15,9 +15,8 @@ module Hyrax
     require 'flipflop'
     require 'flot-rails'
     require 'hydra-file_characterization'
-    require 'jquery-datatables-rails'
-    require 'jquery-ui-rails'
     require 'legato'
+    require 'openseadragon'
     require 'qa'
     require 'tinymce-rails'
     require 'valkyrie'

data/lib/hyrax/errors.rb

@@ -15,6 +15,4 @@ module Hyrax
   class SingleMembershipError < HyraxError; end
 
   class ObjectNotFoundError < ActiveFedora::ObjectNotFoundError; end
-
-  class ModelMismatchError < HyraxError; end
 end

data/lib/hyrax/publisher.rb

@@ -119,10 +119,6 @@ module Hyrax
     #     unique id), AND a `:user` (the ::User responsible for the update).
     register_event('collection.membership.updated')
 
-    # @since 3.5.0
-    # @macro a_registered_event
-    register_event('file.characterized')
-
     # @since 3.3.0
     # @macro a_registered_event
     register_event('file.downloaded')

data/lib/hyrax/specs/capybara.rb

@@ -17,6 +17,8 @@ require 'capybara-screenshot/rspec'
 require 'selenium-webdriver'
 require 'webdrivers' unless ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
 
+Capybara.save_path = ENV['CI'] ? "/tmp/test-results" : Rails.root.join('tmp', 'capybara')
+
 if ENV['IN_DOCKER'].present? || ENV['HUB_URL'].present?
   args = %w[disable-gpu no-sandbox whitelisted-ips window-size=1400,1400]
   args.push('headless') if ActiveModel::Type::Boolean.new.cast(ENV['CHROME_HEADLESS_MODE'])
@@ -67,8 +69,8 @@ Capybara::Screenshot.register_driver(:selenium_chrome_headless_sandboxless) do |
   driver.browser.save_screenshot(path)
 end
 
-Capybara::Screenshot.autosave_on_failure = false
-Capybara::Screenshot.prune_strategy = { keep: 10 }
+Capybara::Screenshot.autosave_on_failure = true
+Capybara::Screenshot.prune_strategy = :keep_last_run
 
 # Save CircleCI artifacts
 
@@ -79,7 +81,7 @@ def save_timestamped_page_and_screenshot(page, meta)
   time_now = Time.zone.now
   timestamp = "#{time_now.strftime('%Y-%m-%d-%H-%M-%S.')}#{'%03d' % (time_now.usec / 1000).to_i}"
 
-  artifact_dir = ENV['CI'] ? "/tmp/test-results" : Rails.root.join('tmp', 'capybara')
+  artifact_dir = Capybara.save_path
 
   screenshot_name = "screenshot-#{filename}-#{line_number}-#{timestamp}.png"
   screenshot_path = "#{artifact_dir}/#{screenshot_name}"

data/lib/hyrax/specs/shared_specs/factories/strategies/valkyrie_resource.rb

@@ -3,12 +3,6 @@
 # @example
 #   let(:resource) { FactoryBot.valkyrie_create(:hyrax_work) }
 class ValkyrieCreateStrategy
-  def initialize
-    @strategy = FactoryBot.strategy_by_name(:create).new
-  end
-
-  delegate :association, to: :@strategy
-
   def result(evaluation)
     evaluation.notify(:after_build, evaluation.object)
     evaluation.notify(:before_create, evaluation.object)

data/lib/hyrax/specs/shared_specs/indexers.rb

@@ -266,11 +266,6 @@ RSpec.shared_examples 'a Collection indexer' do
         .to include(generic_type_sim: a_collection_containing_exactly('Collection'))
     end
 
-    it 'indexes member_of_collection_ids' do
-      expect(indexer.to_solr)
-        .to include(member_of_collection_ids_ssim: resource.member_of_collection_ids)
-    end
-
     it 'indexes depositor' do
       expect(indexer.to_solr)
         .to include(depositor_ssim: [resource.depositor],

data/lib/hyrax/transactions/container.rb

@@ -52,17 +52,6 @@ module Hyrax
       require 'hyrax/transactions/steps/update_work_members'
       require 'hyrax/transactions/steps/validate'
 
-      # The following transactions and steps are deprecated.
-      require 'hyrax/transactions/create_work'
-      require 'hyrax/transactions/destroy_work'
-      require 'hyrax/transactions/update_work'
-      require 'hyrax/transactions/steps/apply_collection_permission_template'
-      require 'hyrax/transactions/steps/apply_permission_template'
-      require 'hyrax/transactions/steps/apply_visibility'
-      require 'hyrax/transactions/steps/destroy_work'
-      require 'hyrax/transactions/steps/ensure_permission_template'
-      require 'hyrax/transactions/steps/save_work'
-
       extend Dry::Container::Mixin
 
       # Disable BlockLength rule for DSL code
@@ -240,49 +229,6 @@ module Hyrax
           Steps::UpdateWorkMembers.new
         end
       end
-
-      # legacy AF works processing by transactions is deprecated
-      namespace 'work' do |ops|
-        ops.register 'apply_collection_permission_template' do
-          Steps::ApplyCollectionPermissionTemplate.new
-        end
-
-        ops.register 'apply_permission_template' do
-          Steps::ApplyPermissionTemplate.new
-        end
-
-        ops.register 'apply_visibility' do
-          Steps::ApplyVisibility.new
-        end
-
-        ops.register 'destroy_work' do
-          Steps::DestroyWork.new
-        end
-
-        ops.register 'ensure_admin_set' do
-          Steps::EnsureAdminSet.new
-        end
-
-        ops.register 'ensure_permission_template' do
-          Steps::EnsurePermissionTemplate.new
-        end
-
-        ops.register 'save_work' do
-          Steps::SaveWork.new
-        end
-
-        ops.register 'set_default_admin_set' do
-          Steps::SetDefaultAdminSet.new
-        end
-
-        ops.register 'set_modified_date' do
-          Steps::SetModifiedDate.new
-        end
-
-        ops.register 'set_uploaded_date_unless_present' do
-          Steps::SetUploadedDateUnlessPresent.new
-        end
-      end
       # rubocop:enable Metrics/BlockLength
     end
   end

data/lib/hyrax/version.rb

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

data/lib/valkyrie/indexing/solr/indexing_adapter.rb

@@ -79,7 +79,7 @@ module Valkyrie
                    end
 
           # if any configuration is missing, derive it from Blacklight
-          config = blacklight_based_config.merge(config)
+          config = blacklight_based_config.with_indifferent_access.merge(config)
 
           "http://#{config['host']}:#{config['port']}/solr/#{config['core']}"
         end

data/lib/wings/valkyrie/persister.rb

@@ -74,7 +74,8 @@ module Wings
 
         def initialize(msg = nil, obj:)
           self.obj = obj
-          msg = "Failed to save object {obj}.\n" + msg
+
+          msg = "Failed to save object #{obj}.\n" + msg
           super(msg)
         end
       end

data/lib/wings/valkyrie/storage.rb

@@ -73,7 +73,7 @@ module Wings
             version_graph.query([uri, RDF::Vocab::Fcrepo4.created, :created])
                          .first_object
                          .object
-          Version.new(id: cast_to_valkyrie_id(uri.to_s), created: timestamp, adapter: self)
+          Version.new(cast_to_valkyrie_id(uri.to_s), timestamp, self)
         end.sort
       end
 
@@ -86,7 +86,7 @@ module Wings
       # this implementation uses an orderable {#version_token}. in practice
       # the token is the fcrepo created date for the version, as extracted from
       # the versions graph.
-      Version = Struct.new("Version", :id, :created, :adapter, keyword_init: true) do
+      Version = Struct.new(:id, :version_token, :adapter) do
         include Comparable
 
         ##
@@ -95,10 +95,6 @@ module Wings
           adapter.find_by(id: id)
         end
 
-        def version_token
-          created
-        end
-
         def <=>(other)
           raise ArgumentError unless other.respond_to?(:version_token)
           version_token <=> other.version_token

data/package.json

@@ -0,0 +1,11 @@
+{
+  "devDependencies": {
+    "dotenv": "^16.0.1",
+    "jasmine-core": "^3.99",
+    "karma": "^6.3.20",
+    "karma-chrome-launcher": "^3.1.1",
+    "karma-coffee-preprocessor": "^1.0.1",
+    "karma-jasmine": "^4.0.2",
+    "karma-spec-reporter": "^0.0.34"
+  }
+}

data/tasks/hyrax_dev.rake

@@ -34,6 +34,38 @@ task :i18n_sorter do
   end
 end
 
+Rake::Task["engine_cart:generate"].clear
+
+namespace :engine_cart do
+  desc "Create the test rails app"
+  task generate: [:setup] do
+    if EngineCart.fingerprint_expired?
+
+      # Create a new test rails app
+      Rake::Task['engine_cart:create_test_rails_app'].invoke
+      Rake::Task['engine_cart:inject_gemfile_extras'].invoke
+
+      # Copy our test app generators into the app and prepare it
+      Bundler.clean_system "cp -r #{EngineCart.templates_path}/lib/generators #{EngineCart.destination}/lib" if File.exist? "#{EngineCart.templates_path}/lib/generators"
+
+      within_test_app do
+        unless (system("bundle install --quiet") || system("bundle update --quiet")) &&
+               system("(bundle exec rails g | grep test_app) && bundle exec rails generate test_app") &&
+               system("bundle exec rake db:migrate") &&
+               system("bundle exec rake db:test:prepare")
+          raise "EngineCart failed on with: #{$CHILD_STATUS}"
+        end
+      end
+
+      Bundler.clean_system "bundle install --quiet"
+
+      EngineCart.write_fingerprint
+
+      puts "Done generating test app"
+    end
+  end
+end
+
 if Gem.loaded_specs.key? 'engine_cart'
   namespace :engine_cart do
     # This generate task should only add its action to an existing engine_cart:generate task

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', '4.0.0.beta1'
 run 'bundle install'
 generate 'hyrax:install', '-f'