hyrax 4.0.0 → 5.0.0.rc2

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

@@ -5,7 +5,7 @@
 #
 # @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::ResourceForm(<%= class_name %>)
+class <%= class_name %>Form < Hyrax::Forms::PcdmObjectForm(<%= class_name %>)
   include Hyrax::FormFields(:basic_metadata)
   include Hyrax::FormFields(:<%= file_name %>)
 

data/lib/generators/hyrax/work_resource/templates/metadata.yaml

@@ -2,6 +2,8 @@
 # index key names, and form properties.
 #
 # Attributes must have a type but all other configuration options are optional.
+# Please note: If using Valkyrie's Fedora Metadata Adapter, predicates for attributes
+# must be placed here.
 #
 # attributes:
 #   attribute_name:

data/lib/hyrax/active_fedora_dummy_model.rb

@@ -69,7 +69,12 @@ module Hyrax
     ##
     # @api public
     def to_global_id
-      URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
+      # this covers the use case of creating a non Valkyrie::Resource, while using Valkyrie
+      if model_name.name.constantize <= Valkyrie::Resource
+        URI::GID.build app: GlobalID.app, model_name: Hyrax::ValkyrieGlobalIdProxy.to_s, model_id: @id
+      else
+        URI::GID.build app: GlobalID.app, model_name: model_name.name, model_id: @id
+      end
     end
   end
 end

data/lib/hyrax/configuration.rb

@@ -9,6 +9,8 @@ module Hyrax
   # engine options. For convenient reference, options are grouped into the
   # following functional areas:
   #
+  # - Analytics
+  # - Files
   # - Groups
   # - Identifiers
   # - IIIF
@@ -148,6 +150,132 @@ module Hyrax
     attr_writer :analytic_start_date
     attr_reader :analytic_start_date
 
+    # @!endgroup
+    # @!group Files
+
+    ##
+    # @!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
+
+    ##
+    # Options to pass to the characterization service
+    # @!attribute [rw] characterization_options
+    #  @return [Hash] of options like {ch12n_tool: :fits_servlet}
+    attr_writer :characterization_options
+    def characterization_options
+      @characterization_options ||= {}
+    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
+
+    # Override characterization runner
+    attr_accessor :characterization_runner
+
+    def mime_types_map # rubocop:disable Metrics/MethodLength
+      {
+        audio_mime_types: [
+          'audio/mp3',
+          'audio/mpeg',
+          'audio/wav',
+          'audio/x-wave',
+          'audio/x-wav',
+          'audio/ogg'
+        ],
+        image_mime_types: [
+          'image/png',
+          'image/jpeg',
+          'image/jpg',
+          'image/jp2',
+          'image/bmp',
+          'image/gif',
+          'image/tiff'
+        ],
+        office_mime_types: [
+          'text/rtf',
+          'application/msword',
+          'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+          'application/vnd.oasis.opendocument.text',
+          'application/vnd.ms-excel',
+          'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+          'application/vnd.ms-powerpoint',
+          'application/vnd.openxmlformats-officedocument.presentationml.presentation'
+        ],
+        pdf_mime_types: ['application/pdf'],
+        video_mime_types: [
+          'video/mpeg',
+          'video/mp4',
+          'video/webm',
+          'video/x-msvideo',
+          'video/avi',
+          'video/quicktime',
+          'application/mxf'
+        ]
+      }
+    end
+
+    # First see if we can get them from the FileSet model. If not, use
+    # configuration.
+    # @param [Symbol] type as listed in mime_types_map keys, aligned with
+    # FileSet method names for backwards compatibility.
+    def lookup_mimes(type)
+      vals = "FileSet".safe_constantize.try(type)
+      return vals if vals.is_a?(Array)
+      mime_types_map[type]
+    end
+
+    attr_writer :derivative_mime_type_mappings
+
+    ##
+    # Maps mimetypes to create_*_derivatives methods
+    #
+    # @note these used to be set by +Hydra::Works::MimeTypes+ methods injected
+    #   into `FileSet`. for backwards compatibility, those are used as defaults
+    #   if present, but since `FileSet` is an application side model (and slated
+    #   to be removed) we shouldn't count on it providing these methods.
+    #
+    # @see Hyrax::VaDerivativeService
+    def derivative_mime_type_mappings
+      @derivative_mime_type_mappings ||=
+        { audio: lookup_mimes(:audio_mime_types),
+          image: lookup_mimes(:image_mime_types),
+          office: lookup_mimes(:office_mime_types),
+          pdf: lookup_mimes(:pdf_mime_types),
+          video: lookup_mimes(:video_mime_types) }
+    end
+
+    attr_writer :derivative_services
+    # The registered candidate derivative services.  In the array, the first `valid?` candidate will
+    # handle the derivative generation.
+    #
+    # @return [Array] of objects that conform to Hyrax::DerivativeService interface.
+    # @see Hyrax::DerivativeService
+    def derivative_services
+      @derivative_services ||= [Hyrax::FileSetDerivativesService]
+    end
+
+    attr_writer :fixity_service
+    def fixity_service
+      @fixity_service ||= Hyrax::Fixity::ActiveFedoraFixityService
+    end
+
+    attr_writer :max_days_between_fixity_checks
+    def max_days_between_fixity_checks
+      @max_days_between_fixity_checks ||= 7
+    end
     # @!endgroup
     # @!group Groups
 
@@ -440,6 +568,20 @@ module Hyrax
       @derivatives_storage_adapter = Valkyrie::StorageAdapter.find(adapter.to_sym)
     end
 
+    # A HTTP connection to use for Valkyrie Fedora requests
+    #
+    # @return [#call] lambda/proc that generates a Faraday connection
+    def fedora_connection_builder
+      @fedora_connection_builder ||= lambda { |url|
+        Faraday.new(url) do |f|
+          f.request :multipart
+          f.request :url_encoded
+          f.adapter Faraday.default_adapter
+        end
+      }
+    end
+    attr_writer :fedora_connection_builder
+
     ##
     # @return [#save, #save_all, #delete, #wipe!] an indexing adapter
     def index_adapter
@@ -485,39 +627,6 @@ module Hyrax
       @microdata_default_type ||= 'http://schema.org/CreativeWork'
     end
 
-    attr_writer :fixity_service
-    def fixity_service
-      @fixity_service ||= Hyrax::Fixity::ActiveFedoraFixityService
-    end
-
-    attr_writer :max_days_between_fixity_checks
-    def max_days_between_fixity_checks
-      @max_days_between_fixity_checks ||= 7
-    end
-
-    # 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
@@ -672,6 +781,11 @@ module Hyrax
       Qa::Authorities::Geonames.username = username
     end
 
+    def location_service
+      @location_service ||= Hyrax::LocationService.new
+    end
+    attr_writer :location_service
+
     attr_writer :active_deposit_agreement_acceptance
     def active_deposit_agreement_acceptance?
       return true if @active_deposit_agreement_acceptance.nil?
@@ -876,16 +990,6 @@ module Hyrax
       @range_for_number_of_results_to_display_per_page ||= [10, 20, 50, 100]
     end
 
-    attr_writer :derivative_services
-    # The registered candidate derivative services.  In the array, the first `valid?` candidate will
-    # handle the derivative generation.
-    #
-    # @return [Array] of objects that conform to Hyrax::DerivativeService interface.
-    # @see Hyrax::DerivativeService
-    def derivative_services
-      @derivative_services ||= [Hyrax::FileSetDerivativesService]
-    end
-
     attr_writer :visibility_map
     # A mapping from visibility string values to permissions; the default and
     # reference implementation is provided by {Hyrax::VisibilityMap}.

data/lib/hyrax/controlled_vocabularies/location.rb

@@ -14,7 +14,13 @@ module Hyrax
       end
 
       def full_label
-        Hyrax::LocationService.new.full_label(rdf_subject.to_s)
+        location_service.full_label(rdf_subject.to_s)
+      end
+
+      private
+
+      def location_service
+        Hyrax.config.location_service
       end
     end
   end

data/lib/hyrax/engine.rb

@@ -8,7 +8,6 @@ module Hyrax
     require 'breadcrumbs_on_rails'
     require 'clipboard/rails'
     require 'draper'
-    require 'dry/equalizer'
     require 'dry/events'
     require 'dry/struct'
     require 'dry/validation'
@@ -20,6 +19,8 @@ module Hyrax
     require 'qa'
     require 'tinymce-rails'
     require 'valkyrie'
+    require 'cancancan'
+    require 'blacklight'
 
     require 'hydra/derivatives'
     require 'hyrax/active_fedora_dummy_model'

data/lib/hyrax/form_fields.rb

@@ -51,6 +51,12 @@ module Hyrax
         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
+
+      # Auto include any matching FormFieldBehaviors
+      schema_name = name.to_s.camelcase
+      behavior = "#{schema_name}FormFieldsBehavior".safe_constantize ||
+                 "Hyrax::#{schema_name}FormFieldsBehavior".safe_constantize
+      descendant.include(behavior) if behavior
     end
   end
 end

data/lib/hyrax/publisher.rb

@@ -137,6 +137,14 @@ module Hyrax
     #     a system user.
     register_event('file.metadata.updated')
 
+    # @since 5.0.0
+    # @macro a_registered_event
+    register_event('file.metadata.deleted')
+
+    # @since 5.0.0
+    # @macro a_registered_event
+    register_event('file.uploaded')
+
     # @since 3.0.0
     # @macro a_registered_event
     register_event('file.set.audited')
@@ -191,8 +199,20 @@ module Hyrax
     #     `#member_ids`)
     register_event('object.metadata.updated')
 
-    # @since 3.2.0
-    # @macro a_registered_event
-    register_event('object.file.uploaded')
+    ##
+    # @return Array[Object] the listeners Hyrax subscribes by default.
+    def default_listeners
+      @default_listeners ||=
+        [Hyrax::Listeners::AclIndexListener.new,
+         Hyrax::Listeners::BatchNotificationListener.new,
+         Hyrax::Listeners::FileMetadataListener.new,
+         Hyrax::Listeners::FileSetLifecycleListener.new,
+         Hyrax::Listeners::FileSetLifecycleNotificationListener.new,
+         Hyrax::Listeners::MemberCleanupListener.new,
+         Hyrax::Listeners::MetadataIndexListener.new,
+         Hyrax::Listeners::ObjectLifecycleListener.new,
+         Hyrax::Listeners::TrophyCleanupListener.new,
+         Hyrax::Listeners::WorkflowListener.new].freeze
+    end
   end
 end

data/lib/hyrax/redis_event_store.rb

@@ -25,15 +25,14 @@ module Hyrax
       #
       # @return [Redis]
       def instance
-        connection = Hyrax.config.redis_connection || Redis.current
-
-        if connection.is_a? Redis::Namespace
-          connection.namespace = namespace
-          connection
-        elsif connection == Redis.current
-          Redis.current = Redis::Namespace.new(namespace, redis: connection)
+        if  Hyrax.config.redis_connection&.is_a?(Redis::Namespace)
+          c = Hyrax.config.redis_connection
+          c.namespace = namespace
+          c
+        elsif Hyrax.config.redis_connection
+          Hyrax.config.redis_connection
         else
-          connection
+          Redis::Namespace.new(namespace, redis: Redis.new)
         end
       end
 

data/lib/hyrax/resource_name.rb

@@ -15,5 +15,9 @@ module Hyrax
       @route_key          = legacy_model.model_name.route_key
       @singular_route_key = legacy_model.model_name.singular_route_key
     end
+
+    def human
+      super.titleize
+    end
   end
 end

data/lib/hyrax/specs/capybara.rb

@@ -15,52 +15,40 @@ require 'capybara/rspec'
 require 'capybara/rails'
 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'])
-
-  options = Selenium::WebDriver::Options.chrome("goog:chromeOptions" => { args: args })
-
-  Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
-    driver = Capybara::Selenium::Driver.new(app,
-                                       browser: :remote,
-                                       capabilities: options,
-                                       url: ENV['HUB_URL'])
+options = Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+  opts.add_argument("--headless") if ENV["CHROME_HEADLESS_MODE"]
+  opts.add_argument("--disable-gpu") if Gem.win_platform?
+  # Workaround https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+  opts.add_argument("--disable-site-isolation-trials")
+  opts.add_argument("--window-size=1440,1440")
+  opts.add_argument("--enable-features=NetworkService,NetworkServiceInProcess")
+  opts.add_argument("--disable-features=VizDisplayCompositor")
+end
 
-    # Fix for capybara vs remote files. Selenium handles this for us
-    driver.browser.file_detector = lambda do |args|
-      str = args.first.to_s
-      str if File.exist?(str)
-    end
+Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
+  driver = Capybara::Selenium::Driver.new(app,
+                                      browser: :remote,
+                                      capabilities: options,
+                                      url: ENV['HUB_URL'])
 
-    driver
+  # Fix for capybara vs remote files. Selenium handles this for us
+  driver.browser.file_detector = lambda do |args|
+    str = args.first.to_s
+    str if File.exist?(str)
   end
 
-  Capybara.server_host = '0.0.0.0'
-  Capybara.server_port = 3010
-
-  ip = IPSocket.getaddress(Socket.gethostname)
-  Capybara.app_host = "http://#{ip}:#{Capybara.server_port}"
-else
-  TEST_HOST = 'localhost:3000'.freeze
-  # @note In January 2018, TravisCI disabled Chrome sandboxing in its Linux
-  #       container build environments to mitigate Meltdown/Spectre
-  #       vulnerabilities, at which point Hyrax could no longer use the
-  #       Capybara-provided :selenium_chrome_headless driver (which does not
-  #       include the `--no-sandbox` argument).
-  Capybara.register_driver :selenium_chrome_headless_sandboxless do |app|
-    browser_options = ::Selenium::WebDriver::Chrome::Options.new
-    browser_options.args << '--headless'
-    browser_options.args << '--disable-gpu'
-    browser_options.args << '--no-sandbox'
-    Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
-  end
+  driver
 end
 
+Capybara.server_host = '0.0.0.0'
+Capybara.server_port = 3010
+
+ip = IPSocket.getaddress(Socket.gethostname)
+Capybara.app_host = "http://#{ip}:#{Capybara.server_port}"
+
 Capybara.default_driver = :rack_test # This is a faster driver
 Capybara.javascript_driver = :selenium_chrome_headless_sandboxless # This is slower
 Capybara.default_max_wait_time = ENV.fetch('CAPYBARA_WAIT_TIME', 10) # We may have a slow application, let's give it some time.

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

@@ -249,7 +249,7 @@ RSpec.shared_examples 'a Hyrax::Work' do
   end
 end
 
-RSpec.shared_examples 'a Hyrax::FileSet' do
+RSpec.shared_examples 'a Hyrax::FileSet', valkyrie_adapter: :test_adapter do
   subject(:fileset)   { described_class.new }
   let(:adapter)       { Valkyrie::MetadataAdapter.find(:test_adapter) }
   let(:persister)     { adapter.persister }
@@ -275,12 +275,10 @@ RSpec.shared_examples 'a Hyrax::FileSet' do
     end
 
     context 'with files' do
-      let(:file_class) { Hyrax::FileMetadata }
-      let(:files) do
-        [file_class.new, file_class.new, file_class.new]
-          .map! { |f| persister.save(resource: f) }
-      end
-
+      let(:original_file) { FactoryBot.valkyrie_create :hyrax_file_metadata, :original_file }
+      let(:thumbnail) { FactoryBot.valkyrie_create :hyrax_file_metadata, :thumbnail }
+      let(:extracted_text) { FactoryBot.valkyrie_create :hyrax_file_metadata, :extracted_text }
+      let(:files) { [original_file, thumbnail, extracted_text] }
       let(:file_ids) { files.map(&:id) }
 
       before { fileset.file_ids = file_ids }
@@ -301,6 +299,35 @@ RSpec.shared_examples 'a Hyrax::FileSet' do
         expect { fileset.file_ids << file_ids.first }
           .not_to change { query_service.custom_queries.find_files(file_set: fileset) }
       end
+
+      it 'returns an original_file' do
+        expect(fileset.original_file).to eq original_file
+        expect(fileset.original_file_id).to eq original_file.id
+      end
+
+      it 'returns a thumbnail' do
+        expect(fileset.thumbnail).to eq thumbnail
+        expect(fileset.thumbnail_id).to eq thumbnail.id
+      end
+
+      it 'returns an extracted_text' do
+        expect(fileset.extracted_text).to eq extracted_text
+        expect(fileset.extracted_text_id).to eq extracted_text.id
+      end
+
+      context 'with simulated original file' do
+        let(:file_metadata_double) { double("Fake Hyrax::FileMetadata", id: SecureRandom.uuid, file_identifier: SecureRandom.uuid, versions: [file_double]) }
+        let(:file_double) { double("Fake Valkyrie::StorageAdapter::File", id: SecureRandom.uuid, version_id: SecureRandom.uuid)}
+
+        before do
+          allow(fileset).to receive(:original_file).and_return(file_metadata_double)
+          fileset.id = Valkyrie::ID.new(SecureRandom.uuid)
+        end
+
+        it 'returns a iiif_id with matching ids' do
+          expect(fileset.iiif_id).to eq "#{fileset.id}/files/#{fileset.original_file_id}/#{Digest::MD5.hexdigest(file_double.version_id)}"
+        end
+      end
     end
   end
 end

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

@@ -89,8 +89,6 @@ RSpec.shared_examples 'a thumbnail indexer' do
   before do
     raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
     raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
-    # optionally can pass in default_visibility by setting it with a let statement if your application changes the default; Hyrax defines this as 'restricted'
-    # See samvera/hyrda-head hydra-access-controls/app/models/concerns/hydra/access_controls/access_rights.rb for possible VISIBILITY_TEXT_VALUE_...'
   end
   subject(:indexer)  { indexer_class.new(resource: resource) }
   let(:thumbnail_path) { '/downloads/foo12345?file=thumbnail' }
@@ -106,6 +104,27 @@ RSpec.shared_examples 'a thumbnail indexer' do
   end
 end
 
+RSpec.shared_examples 'a location indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
+    resource.based_near = based_near
+  end
+  subject(:indexer)  { indexer_class.new(resource: resource) }
+  let(:based_near) { ["https://sws.geonames.org/4254679/"] }
+  let(:based_near_label) { ["Bloomington, Indiana, United States"] }
+
+  before do
+    allow(Hyrax.config.location_service).to receive(:full_label).with(based_near[0]).and_return(based_near_label[0])
+  end
+
+  describe '#to_solr' do
+    it 'indexes locations' do
+      expect(indexer.to_solr).to include(based_near_tesim: based_near, based_near_label_tesim: based_near_label)
+    end
+  end
+end
+
 RSpec.shared_examples 'a Core metadata indexer' do
   before do
     raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
@@ -138,9 +157,10 @@ RSpec.shared_examples 'a Basic metadata indexer' do
   end
   subject(:indexer) { indexer_class.new(resource: resource) }
 
+  it_behaves_like 'a location indexer'
+
   let(:attributes) do
     {
-      based_near: ['helsinki', 'finland'],
       date_created: ['tuesday'],
       keyword: ['comic strip'],
       related_url: ['http://example.com/moomin'],
@@ -152,9 +172,7 @@ RSpec.shared_examples 'a Basic metadata indexer' do
   describe '#to_solr' do
     it 'indexes basic metadata' do
       expect(indexer.to_solr)
-        .to include(based_near_tesim: a_collection_containing_exactly(*attributes[:based_near]),
-                    based_near_sim: a_collection_containing_exactly(*attributes[:based_near]),
-                    date_created_tesim: a_collection_containing_exactly(*attributes[:date_created]),
+        .to include(date_created_tesim: a_collection_containing_exactly(*attributes[:date_created]),
                     keyword_sim: a_collection_containing_exactly(*attributes[:keyword]),
                     related_url_tesim: a_collection_containing_exactly(*attributes[:related_url]),
                     resource_type_tesim: a_collection_containing_exactly(*attributes[:resource_type]),

data/lib/hyrax/transactions/collection_destroy.rb

@@ -9,8 +9,9 @@ module Hyrax
     # @since 3.4.0
     class CollectionDestroy < Transaction
       # TODO: Add step that checks if collection is empty for collections of types that require it
-      DEFAULT_STEPS = ['collection_resource.delete',
-                       'collection_resource.delete_acl'].freeze
+      DEFAULT_STEPS = ['collection_resource.delete_acl',
+                       'collection_resource.remove_from_membership',
+                       'collection_resource.delete'].freeze
 
       ##
       # @see Hyrax::Transactions::Transaction