hyrax 2.8.0 → 3.0.0.pre.rc2

data/lib/hyrax/arkivo/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Arkivo
     def self.config

data/lib/hyrax/arkivo/create_subscription_job.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Arkivo
     class SubscriptionError < RuntimeError
@@ -21,41 +22,41 @@ module Hyrax
 
       private
 
-        def logger
-          Hyrax.logger
-        end
+      def logger
+        Hyrax.logger
+      end
 
-        def validate_user!
-          log_and_raise('User not found') if user.blank?
-          log_and_raise('User does not have an Arkivo token') if user.arkivo_token.blank?
-          log_and_raise('User has not yet connected with Zotero') if user.zotero_userid.blank?
-          log_and_raise('User already has a subscription') if user.arkivo_subscription.present?
-        end
+      def validate_user!
+        log_and_raise('User not found') if user.blank?
+        log_and_raise('User does not have an Arkivo token') if user.arkivo_token.blank?
+        log_and_raise('User has not yet connected with Zotero') if user.zotero_userid.blank?
+        log_and_raise('User already has a subscription') if user.arkivo_subscription.present?
+      end
 
-        def log_and_raise(message)
-          logger.error "*** Arkivo error: #{message}: #{user}"
-          raise SubscriptionError, message
-        end
+      def log_and_raise(message)
+        logger.error "*** Arkivo error: #{message}: #{user}"
+        raise SubscriptionError, message
+      end
 
-        def post_to_api
-          Faraday.new(url: Hyrax::Arkivo.config[:url]).post do |request|
-            request.url Hyrax::Arkivo.new_subscription_url
-            request.headers['Content-Type'] = 'application/json'
-            request.body = new_subscription_json
-          end
+      def post_to_api
+        Faraday.new(url: Hyrax::Arkivo.config[:url]).post do |request|
+          request.url Hyrax::Arkivo.new_subscription_url
+          request.headers['Content-Type'] = 'application/json'
+          request.body = new_subscription_json
         end
+      end
 
-        def new_subscription_json
-          {
-            url: Hyrax::Zotero.publications_url(@user.zotero_userid),
-            plugins: [
-              {
-                name: "hyrax",
-                options: { token: @user.arkivo_token }
-              }
-            ]
-          }.to_json
-        end
+      def new_subscription_json
+        {
+          url: Hyrax::Zotero.publications_url(@user.zotero_userid),
+          plugins: [
+            {
+              name: "hyrax",
+              options: { token: @user.arkivo_token }
+            }
+          ]
+        }.to_json
+      end
     end
   end
 end

data/lib/hyrax/arkivo/metadata_munger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Arkivo
     CREATOR_TYPES = ['author', 'interviewer', 'director', 'scriptwriter',
@@ -26,29 +27,29 @@ module Hyrax
 
       private
 
-        def normalize_keys_and_values
-          # First, normalize camelCase symbols to underscore strings
-          @metadata.each do |key, value|
-            @munged[key.to_s.underscore] = Array.wrap(value)
-          end
+      def normalize_keys_and_values
+        # First, normalize camelCase symbols to underscore strings
+        @metadata.each do |key, value|
+          @munged[key.to_s.underscore] = Array.wrap(value)
         end
+      end
 
-        def rename_key(from:, to:)
-          @munged[to] = @munged.delete(from) if @munged.key?(from)
-        end
+      def rename_key(from:, to:)
+        @munged[to] = @munged.delete(from) if @munged.key?(from)
+      end
 
-        def extract_creator_and_contributor_from_creators
-          creator_names = []
-          contributor_names = []
-          @munged['creators'].each do |entry|
-            entry['name'] ||= "#{entry.delete('lastName')}, #{entry.delete('firstName')}".strip
-            creator_names << entry['name'] if Hyrax::Arkivo::CREATOR_TYPES.include?(entry['creatorType'])
-            contributor_names << entry['name'] if Hyrax::Arkivo::CONTRIBUTOR_TYPES.include?(entry['creatorType'])
-          end
-          @munged['creator'] = creator_names if creator_names.present?
-          @munged['contributor'] = contributor_names if contributor_names.present?
-          @munged.delete('creators')
+      def extract_creator_and_contributor_from_creators
+        creator_names = []
+        contributor_names = []
+        @munged['creators'].each do |entry|
+          entry['name'] ||= "#{entry.delete('lastName')}, #{entry.delete('firstName')}".strip
+          creator_names << entry['name'] if Hyrax::Arkivo::CREATOR_TYPES.include?(entry['creatorType'])
+          contributor_names << entry['name'] if Hyrax::Arkivo::CONTRIBUTOR_TYPES.include?(entry['creatorType'])
         end
+        @munged['creator'] = creator_names if creator_names.present?
+        @munged['contributor'] = contributor_names if contributor_names.present?
+        @munged.delete('creators')
+      end
     end
   end
 end

data/lib/hyrax/arkivo/schema_validator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json-schema'
 
 module Hyrax

data/lib/hyrax/callbacks.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'active_support/concern'
 require 'hyrax/callbacks/registry'
 

data/lib/hyrax/callbacks/registry.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module Callbacks
     class Registry
@@ -23,7 +24,8 @@ module Hyrax
       end
 
       # Defines a callback for a given hook.
-      def set(hook, &block)
+      def set(hook, warn: true, &block)
+        Deprecation.warn(self, warning_for_set) if warn
         raise NoBlockGiven, "a block is required when setting a callback" unless block_given?
         @callbacks[hook] = proc(&block)
       end
@@ -34,10 +36,25 @@ module Hyrax
       end
 
       # Runs the callback defined for a given hook, with the arguments provided
-      def run(hook, *args)
+      def run(hook, *args, warn: true, **opts)
+        Deprecation.warn(self, warning_for_run) if warn
         raise NotEnabled unless enabled?(hook)
         return nil unless set?(hook)
-        @callbacks[hook].call(*args)
+        @callbacks[hook].call(*args, **opts)
+      end
+
+      private
+
+      def warning_for_set
+        "Hyrax.config.callback is deprecated; register your callback handler " \
+          "as a listener on Hyrax.publisher instead. See Hyrax::Publisher " \
+          "and Dry::Events"
+      end
+
+      def warning_for_run
+        "Hyrax.config.callback is deprecated; to trigger handlers publish " \
+          "events to Hyrax.publisher instead of running callbacks. See " \
+          "Hyrax::Publisher and Dry::Events"
       end
     end
 

data/lib/hyrax/collection_name.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A custom name for Valkyrie PcdmCollection objects. Route keys are mapped to `collection`
+  # not be the same as the model name.
+  class CollectionName < Name
+    def initialize(klass, namespace = nil, name = nil)
+      super
+
+      @route_key          = Collection.model_name.route_key
+      @singular_route_key = Collection.model_name.singular_route_key
+    end
+  end
+end

data/lib/hyrax/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'hyrax/callbacks'
 require 'hyrax/role_registry'
 require 'samvera/nesting_indexer'
@@ -13,7 +14,7 @@ module Hyrax
       @nested_relationship_reindexer = default_nested_relationship_reindexer
     end
 
-    DEFAULT_ACTIVE_WORKFLOW_NAME = 'default'.freeze
+    DEFAULT_ACTIVE_WORKFLOW_NAME = 'default'
     private_constant :DEFAULT_ACTIVE_WORKFLOW_NAME
 
     # @api public
@@ -100,6 +101,11 @@ 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
@@ -183,11 +189,37 @@ module Hyrax
       @bagit_dir ||= "tmp/descriptions"
     end
 
-    # @!attribute [w] whitelisted_ingest_dirs
-    #   List of directories which can be used for local file system ingestion.
-    attr_writer :whitelisted_ingest_dirs
+    # @!attribute [w] virus_scanner
+    #   @return [Hyrax::VirusScanner] the default system virus scanner
+    attr_writer :virus_scanner
+    def virus_scanner
+      @virus_scanner ||=
+        if Hyrax.primary_work_type.respond_to?(:default_system_virus_scanner)
+          Hyrax.primary_work_type.default_system_virus_scanner
+        else
+          Hyrax::VirusScanner
+        end
+    end
+
+    # @deprecated
     def whitelisted_ingest_dirs
-      @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
+    def registered_ingest_dirs
+      @registered_ingest_dirs ||= \
         if defined? BrowseEverything
           file_system_dirs = Array.wrap(BrowseEverything.config['file_system'].try(:[], :home)).compact
           # Include the Rails tmp directory for cases where the BrowseEverything provider is required to download the file to a temporary directory first
@@ -299,7 +331,7 @@ module Hyrax
       @arkivo_api ||= false
     end
 
-    # rubocop:disable Metrics/LineLength
+    # rubocop:disable Layout/LineLength
     attr_writer :realtime_notifications
     def realtime_notifications?
       # Coerce @realtime_notifications to false if server software
@@ -313,7 +345,11 @@ module Hyrax
       return @realtime_notifications unless @realtime_notifications.nil?
       @realtime_notifications = true
     end
-    # rubocop:enable Metrics/LineLength
+    # rubocop:enable Layout/LineLength
+
+    def use_valkyrie?
+      ActiveModel::Type::Boolean.new.cast(ENV.fetch('HYRAX_VALKYRIE', false))
+    end
 
     def geonames_username=(username)
       Qa::Authorities::Geonames.username = username
@@ -369,6 +405,11 @@ module Hyrax
       @cache_path ||= ->() { Rails.root + 'tmp' + 'uploads' + 'cache' }
     end
 
+    attr_writer :id_field
+    def id_field
+      @id_field || index_field_mapper.id_field
+    end
+
     # Enable IIIF image service. This is required to use the
     # IIIF viewer enabled show page
     #
@@ -395,7 +436,7 @@ module Hyrax
     #
     # @return [#call] lambda/proc that generates a URL to an image
     def iiif_image_url_builder
-      @iiif_image_url_builder ||= ->(file_id, base_url, _size) { "#{base_url}/downloads/#{file_id.split('/').first}" }
+      @iiif_image_url_builder ||= ->(file_id, base_url, _size, _format) { "#{base_url}/downloads/#{file_id.split('/').first}" }
     end
     attr_writer :iiif_image_url_builder
 
@@ -431,6 +472,33 @@ module Hyrax
     end
     attr_writer :iiif_metadata_fields
 
+    # Duration in which we should cache the generated IIIF manifest.
+    # Default is 30 days (in seconds).
+    #
+    # @return [Integer] number of seconds
+    # @see https://api.rubyonrails.org/classes/ActiveSupport/Cache/Store.html#method-i-fetch
+    def iiif_manifest_cache_duration
+      @iiif_manifest_cache_duration ||= 30.days.to_i
+    end
+    attr_writer :iiif_manifest_cache_duration
+
+    ##
+    # @return [#save, #save_all, #delete, #wipe!] an indexing adapter
+    def index_adapter
+      @index_adapter ||= Valkyrie::IndexingAdapter.find(:null_index)
+    end
+
+    ##
+    # @param [#to_sym] adapter
+    def index_adapter=(adapter)
+      @index_adapter ||= Valkyrie::IndexingAdapter.find(adapter.to_sym)
+    end
+
+    attr_writer :index_field_mapper
+    def index_field_mapper
+      @index_field_mapper ||= ActiveFedora.index_field_mapper
+    end
+
     # Should a button with "Share my work" show on the front page to users who are not logged in?
     attr_writer :display_share_button_when_not_logged_in
     def display_share_button_when_not_logged_in?
@@ -450,20 +518,25 @@ module Hyrax
 
     attr_writer :permission_levels
     def permission_levels
-      @permission_levels ||= { "View/Download" => "read",
-                               "Edit access" => "edit" }
+      @permission_levels ||= { I18n.t('hyrax.permission_levels.read') => "read",
+                               I18n.t('hyrax.permission_levels.edit') => "edit" }
     end
 
     attr_writer :owner_permission_levels
     def owner_permission_levels
-      @owner_permission_levels ||= { "Edit access" => "edit" }
+      @owner_permission_levels ||= { I18n.t('hyrax.permission_levels.owner.edit') => "edit" }
     end
 
     attr_writer :permission_options
     def permission_options
-      @permission_options ||= { "Choose Access" => "none",
-                                "View/Download" => "read",
-                                "Edit" => "edit" }
+      @permission_options ||= { I18n.t('hyrax.permission_levels.options.none') => "none",
+                                I18n.t('hyrax.permission_levels.options.read') => "read",
+                                I18n.t('hyrax.permission_levels.options.edit') => "edit" }
+    end
+
+    attr_writer :publisher
+    def publisher
+      @publisher ||= Hyrax::Publisher.instance
     end
 
     attr_writer :translate_uri_to_id
@@ -482,6 +555,15 @@ module Hyrax
       end
     end
 
+    attr_writer :resource_id_to_uri_transformer
+    def resource_id_to_uri_transformer
+      @resource_id_to_uri_transformer ||= lambda do |resource, base_url|
+        file_id = CGI.escape(resource.file_identifiers.first.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"
@@ -514,21 +596,36 @@ module Hyrax
       ->(id:, extent:) { Samvera::NestingIndexer.reindex_relationships(id: id, extent: extent) }
     end
 
+    attr_writer :solr_select_path
+    def solr_select_path
+      @solr_select_path ||= ActiveFedora.solr_config.fetch(:select_path, 'select')
+    end
+
+    attr_writer :query_index_from_valkyrie
+    def query_index_from_valkyrie
+      @query_index_from_valkyrie ||= false
+    end
+
+    attr_writer :identifier_registrars
+    def identifier_registrars
+      @identifier_registrars ||= {}
+    end
+
     private
 
-      # @param [Symbol, #to_s] model_name - symbol representing the model
-      # @return [String] the class name for the model
-      def normalize_concern_name(model_name)
-        model_name.to_s.camelize
-      end
+    # @param [Symbol, #to_s] model_name - symbol representing the model
+    # @return [String] the class name for the model
+    def normalize_concern_name(model_name)
+      model_name.to_s.camelize
+    end
 
-      # @return [Hash] config options for the uploader
-      def default_uploader_config
-        {
-          limitConcurrentUploads: 6,
-          maxNumberOfFiles: 100,
-          maxFileSize: 500.megabytes
-        }
-      end
+    # @return [Hash] config options for the uploader
+    def default_uploader_config
+      {
+        limitConcurrentUploads: 6,
+        maxNumberOfFiles: 100,
+        maxFileSize: 500.megabytes
+      }
+    end
   end
 end

data/lib/hyrax/controlled_vocabularies.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module ControlledVocabularies
     extend ActiveSupport::Autoload