hyrax 3.3.0 → 3.4.2

data/app/services/hyrax/valkyrie_upload.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Hyrax::ValkyrieUpload
+  # @param [IO] io
+  # @param [String] filename
+  # @param [Hyrax::FileSet] file_set
+  # @param [RDF::URI] use
+  # @param [User] user
+  #
+  # @see Hyrax::FileMetadata::Use
+  # @return [Hyrax::FileMetadata] the metadata representing the uploaded file
+  # rubocop:disable Metrics/MethodLength
+  # rubocop:disable Metrics/ParameterLists
+  def self.file(
+    filename:,
+    file_set:,
+    io:,
+    storage_adapter: Hyrax.storage_adapter,
+    use: Hyrax::FileMetadata::Use::ORIGINAL_FILE,
+    user: nil
+  )
+
+    streamfile = storage_adapter.upload(
+      file: io,
+      original_filename: filename,
+      resource: file_set,
+      use: use
+    )
+    io.close
+
+    file_metadata = Hyrax::FileMetadata(streamfile)
+    file_metadata.file_set_id = file_set.id
+
+    case use
+    when Hyrax::FileMetadata::Use::ORIGINAL_FILE
+      # Set file set label.
+      reset_title = file_set.title.first == file_set.label
+      # set title to label if that's how it was before this characterization
+      file_set.title = file_metadata.original_filename if reset_title
+      # always set the label to the original_name
+      file_set.label = file_metadata.original_filename
+    when Hyrax::FileMetadata::Use::THUMBNAIL
+      # TODO: the parent work's thumbnail_id remains incorrect (it's set to the
+      # FileSet ID, rather than the ID of this thumbnail FileMetadata; but
+      # trying to update the parent attributes here doesn't seem to stick
+      file_set.thumbnail_id = file_metadata.id
+    end
+
+    saved_metadata = Hyrax.persister.save(resource: file_metadata)
+    Hyrax.publisher.publish("object.file.uploaded", metadata: saved_metadata)
+
+    add_file_to_file_set(file_set: file_set,
+                         file_metadata: saved_metadata,
+                         user: user)
+
+    Hyrax.publisher.publish('file.metadata.updated', metadata: saved_metadata, user: user)
+
+    saved_metadata
+  end
+
+  # @param [Hyrax::FileSet] file_set the file set to add to
+  # @param [Hyrax::FileMetadata] file_metadata the metadata object representing
+  #   the file to add
+  # @param [::User] user  the user performing the add
+  #
+  # @return [Hyrax::FileSet] updated file set
+  def self.add_file_to_file_set(file_set:, file_metadata:, user:)
+    file_set.file_ids << file_metadata.id
+    set_file_use_ids(file_set, file_metadata)
+
+    Hyrax.persister.save(resource: file_set)
+    Hyrax.publisher.publish('object.membership.updated', object: file_set, user: user)
+  end
+
+  # @api private
+  # @param [Hyrax::FileSet] file_set the file set to add to
+  # @param [Hyrax::FileMetadata] file_metadata the metadata object representing
+  #   the file to add
+  # @return [void]
+  def self.set_file_use_ids(file_set, file_metadata)
+    file_metadata.type.each do |type|
+      case type
+      when Hyrax::FileMetadata::Use::ORIGINAL_FILE
+        file_set.original_file_id = file_metadata.id
+      when Hyrax::FileMetadata::Use::THUMBNAIL
+        file_set.thumbnail_id = file_metadata.id
+      when Hyrax::FileMetadata::Use::EXTRACTED_TEXT
+        file_set.extracted_text_id = file_metadata.id
+      else
+        Rails.logger.warn "Unknown file use #{file_metadata.type} specified for #{file_metadata.file_identifier}"
+      end
+    end
+  end
+end

data/app/services/hyrax/work_uploads_handler.rb

@@ -116,9 +116,6 @@ module Hyrax
 
       ValkyrieIngestJob.perform_later(file)
 
-      # this triggers the re-index
-      Hyrax.publisher.publish('object.metadata.updated', object: file_set, user: file.user)
-
       { file_set: file_set, user: file.user }
     end
 
@@ -163,13 +160,6 @@ module Hyrax
       @target_permissions ||= Hyrax::AccessControlList.new(resource: work)
     end
 
-    ##
-    # @api private
-    # @return [JobIoWrapper]
-    def wrap_file(file, file_set)
-      JobIoWrapper.create_with_varied_file_handling!(user: file.user, file: file, relation: :original_file, file_set: file_set)
-    end
-
     ##
     # @api private
     #

data/app/services/hyrax/workflow/workflow_importer.rb

@@ -128,16 +128,14 @@ module Hyrax
       def call
         self.errors = []
         Array.wrap(data.fetch(:workflows)).map do |configuration|
-          begin
-            find_or_create_from(configuration: configuration)
-          rescue InvalidStateRemovalException => e
-            e.states.each do |state|
-              error = I18n.t('hyrax.workflow.load.state_error', workflow_name: state.workflow.name, state_name: state.name, entity_count: state.entities.count)
-              Rails.logger.error(error)
-              errors << error
-            end
-            Sipity::Workflow.find_by(name: configuration[:name])
+          find_or_create_from(configuration: configuration)
+        rescue InvalidStateRemovalException => e
+          e.states.each do |state|
+            error = I18n.t('hyrax.workflow.load.state_error', workflow_name: state.workflow.name, state_name: state.name, entity_count: state.entities.count)
+            Rails.logger.error(error)
+            errors << error
           end
+          Sipity::Workflow.find_by(name: configuration[:name])
         end
       end
 

data/app/services/hyrax/workflow/workflow_schema.rb

@@ -20,11 +20,9 @@ module Hyrax
         include Dry::Types()
 
         Constant = Types::Class.constructor do |v|
-          begin
-            v.constantize
-          rescue NameError => _err
-            v
-          end
+          v.constantize
+        rescue NameError => _err
+          v
         end
       end
 

data/app/strategies/hyrax/strategies/yaml_strategy.rb

@@ -34,12 +34,10 @@ module Hyrax::Strategies
 
     def yaml_file
       @yaml_file ||=
-        begin
-          if File.exist?(@config_file)
-            YAML.load_file(@config_file)
-          else
-            {}
-          end
+        if File.exist?(@config_file)
+          YAML.load_file(@config_file)
+        else
+          {}
         end
     end
   end

data/app/uploaders/hyrax/uploaded_file_uploader.rb

@@ -4,21 +4,21 @@ module Hyrax
     # Override the directory where uploaded files will be stored.
     # This is a sensible default for uploaders that are meant to be mounted:
     def store_dir
-      configured_upload_path + "#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      (configured_upload_path / model.class.to_s.underscore / mounted_as.to_s / model.id.to_s).to_s
     end
 
     def cache_dir
-      configured_cache_path + "#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+      (configured_cache_path / model.class.to_s.underscore / mounted_as.to_s / model.id.to_s).to_s
     end
 
     private
 
     def configured_upload_path
-      Hyrax.config.upload_path.call
+      Pathname.new(Hyrax.config.upload_path.call)
     end
 
     def configured_cache_path
-      Hyrax.config.cache_path.call
+      Pathname.new(Hyrax.config.cache_path.call)
     end
   end
 end

data/app/utils/hyrax/data_destroyers/collection_branding_destroyer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Collection branding info is tightly coupled to collections.  When they are
+    # removed using wipe!, the associated database entries for collection branding
+    # also have to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    # @todo This destroys branding info in the database.  Should it also delete
+    #   related banner and logo files?
+    class CollectionBrandingDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("CollectionBrandingDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying collection branding...")
+
+          Hyrax::CollectionBrandingInfo.destroy_all
+          logger.info("   collection branding -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/collection_types_destroyer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Collection types are recreated by the release seed data.  Clear out here to
+    # start with a fresh set.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class CollectionTypesDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("CollectionTypesDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying collection types...")
+
+          Hyrax::CollectionType.destroy_all
+          logger.info("   collection types -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/default_admin_set_id_cache_destroyer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # When the default admin set is removed using wipe!, the cache of the default
+    # admin set id also needs to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class DefaultAdminSetIdCacheDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("DefaultAdminSetIdCacheDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying default admin set id cache...")
+
+          Hyrax::DefaultAdministrativeSet.destroy_all
+          logger.info("   default admin set id cache -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/featured_works_destroyer.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Featured works are tightly coupled to works in the repository. When they
+    # are removed using wipe!, the associated database entries for featured
+    # works also need to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class FeaturedWorksDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("FeaturedWorksDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying featured works...")
+
+          FeaturedWork.destroy_all
+          logger.info("   featured works -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/permission_templates_destroyer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # PermissionTemplates are tightly coupled to admin sets and collections.
+    # When they are removed using wipe!, the associated database entries for
+    # permission templates also have to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class PermissionTemplatesDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("PermissionTemplatesDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying permission templates...")
+
+          Hyrax::PermissionTemplateAccess.destroy_all
+          logger.info("   permission templates access -- DESTROYED")
+
+          Hyrax::PermissionTemplate.destroy_all
+          logger.info("   permission templates -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/repository_metadata_destroyer.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Clear all repository metadata from the datastore (e.g. Fedora, Postgres)
+    # and from Solr.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    # @note When using Wings adapter, which wraps ActiveFedora, the persister wipe!
+    #   method clears both Fedora and Solr.  Optionally, an index_adapter may also
+    #   be set to use Valkyrie to write to a second Solr core.  If the Hyrax index
+    #   adapter is the NullIndexingAdapter, that means that Valkyrie is not being
+    #   used to index the repository metadata and does not need to be cleared using
+    #   the Hyrax index adapter.
+    #
+    #   When using other Valkyrie persistence adapters, wipe! only clears the repository
+    #   metadata from the datastore (e.g. ORM table in Postgres).  The index adapter
+    #   is used to clear metadata from Solr.
+    #
+    class RepositoryMetadataDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_metadata(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("RepositoryMetadataDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying all repository metadata...")
+
+          unless Hyrax.index_adapter.is_a? Valkyrie::Indexing::NullIndexingAdapter
+            conn = Hyrax.index_adapter.connection
+            conn.delete_by_query('*:*', params: { 'softCommit' => true })
+          end
+          Hyrax.persister.wipe!
+
+          logger.info("   repository metadata -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_destroyers/stats_destroyer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module Hyrax
+  module DataDestroyers
+    # Stats are tightly coupled to works and files in the repository. When they
+    # are removed using wipe!, the associated database entries for stats also
+    # need to be deleted.
+    #
+    # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+    #   Data can not be recovered.
+    #
+    class StatsDestroyer
+      class << self
+        attr_accessor :logger
+
+        def destroy_data(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+          raise("StatsDataDestroyer is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+          @logger = logger
+
+          logger.info("Destroying stats...")
+
+          FileDownloadStat.destroy_all
+          logger.info("   file download stats -- DESTROYED")
+
+          FileViewStat.destroy_all
+          logger.info("   file view stats -- DESTROYED")
+
+          WorkViewStat.destroy_all
+          logger.info("   work view stats -- DESTROYED")
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/data_maintenance.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # These methods created for use in rake tasks and db/seeds.rb  They can be used to:
+  # * clear repository metadata and related data and files
+  # * clear temporary files
+  # * clear logs
+  #
+  # @note WARNING: DO NOT USE IN PRODUCTION!  The methods in this class are destructive.
+  #   Data can not be recovered.
+  #
+  class DataMaintenance
+    attr_accessor :logger, :allow_destruction_in_production
+
+    def initialize(logger: Logger.new(STDOUT), allow_destruction_in_production: false)
+      raise("Destruction of data is not for use in production!") if Rails.env.production? && !allow_destruction_in_production
+      @logger = logger
+      @allow_destruction_in_production = allow_destruction_in_production
+    end
+
+    # Clear repository metadata and related data
+    # * clear repository metadata from the datastore (e.g. Fedora, Postgres) and from Solr
+    # * clear targeted application data that is tightly coupled to repository metadata
+    # * delete files that are tightly coupled to repository metadata
+    def destroy_repository_metadata_and_related_data
+      Hyrax::DataDestroyers::RepositoryMetadataDestroyer.destroy_metadata(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::StatsDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::FeaturedWorksDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::PermissionTemplatesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::CollectionBrandingDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::DefaultAdminSetIdCacheDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+      Hyrax::DataDestroyers::CollectionTypesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+
+      # TODO: Stubbed until RepositoryFilesDestroyer is written
+      # Hyrax::DataDestroyers::RepositoryFilesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+    end
+
+    # @todo write code to clear out log files
+    def destroy_log_files
+      # Stubbed until LogFilesDestroyer is written
+      # Hyrax::DataDestroyers::LogFilesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+    end
+
+    # @todo write code to delete tmp files
+    def destroy_tmp_files
+      # Stubbed until TmpFilesDestroyer is written
+      # Hyrax::DataDestroyers::TmpFilesDestroyer.destroy_data(logger: logger, allow_destruction_in_production: allow_destruction_in_production)
+    end
+  end
+end

data/app/utils/hyrax/required_data_seeder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Hyrax
+  # This class was created for use in rake tasks and db/seeds.rb.  It generates
+  # required repository metadata including Admin Set and User collection types and
+  # the default admin set.
+  #
+  # Seeders of required data are non-destructive.  If the data already exists,
+  # it will not be replaced.
+  class RequiredDataSeeder
+    attr_accessor :logger
+
+    def initialize(logger: Logger.new(STDOUT))
+      @logger = logger
+    end
+
+    def generate_seed_data
+      Hyrax::RequiredDataSeeders::CollectionTypeSeeder.generate_seeds(logger: logger)
+      Hyrax::RequiredDataSeeders::CollectionSeeder.generate_seeds(logger: logger)
+    end
+  end
+end

data/app/utils/hyrax/required_data_seeders/collection_seeder.rb

@@ -0,0 +1,26 @@
+
+
+# frozen_string_literal: true
+module Hyrax
+  module RequiredDataSeeders
+    # This class was created for use in rake tasks and db/seeds.rb.  It generates
+    # collections that are required for all Hyrax applications.
+    #
+    # Seeders of required data are non-destructive.  If the data already exists,
+    # it will not be replaced.
+    class CollectionSeeder
+      class << self
+        attr_accessor :logger
+
+        def generate_seeds(logger: Logger.new(STDOUT))
+          @logger = logger
+
+          logger.info("Adding required collections...")
+
+          default_admin_set = Hyrax::AdminSetCreateService.find_or_create_default_admin_set
+          logger.info "   #{default_admin_set.title.first} -- FOUND OR CREATED"
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/required_data_seeders/collection_type_seeder.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module Hyrax
+  module RequiredDataSeeders
+    # This class was created for use in rake tasks and db/seeds.rb.  It generates
+    # collection types that are required for all Hyrax applications.
+    #
+    # Seeders of required data are non-destructive.  If the data already exists,
+    # it will not be replaced.
+    class CollectionTypeSeeder
+      class << self
+        attr_accessor :logger
+
+        def generate_seeds(logger: Logger.new(STDOUT))
+          @logger = logger
+
+          logger.info("Adding required collection types...")
+
+          as_ct = Hyrax::CollectionType.find_or_create_admin_set_type
+          set_badge_color(as_ct, '#990000')
+          logger.info("   #{as_ct.title} -- FOUND OR CREATED")
+
+          user_ct = Hyrax::CollectionType.find_or_create_default_collection_type
+          set_badge_color(user_ct, '#0099cc')
+          logger.info("   #{user_ct.title} -- FOUND OR CREATED")
+        end
+
+        private
+
+        def set_badge_color(collection_type, badge_color = nil)
+          collection_type.badge_color = badge_color
+          collection_type.save
+        end
+      end
+    end
+  end
+end

data/app/utils/hyrax/test_data_seeder.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # This class was created for use in rake tasks and db/seeds.rb.  It generates
+  # repository metadata needed for release testing.  This data can also be helpful
+  # for local development testing.
+  class TestDataSeeder
+    attr_accessor :logger, :allow_seeding_in_production
+
+    def initialize(logger: Logger.new(STDOUT), allow_seeding_in_production: false)
+      raise("TestDataSeeder is not for use in production!") if Rails.env.production? && !allow_seeding_in_production
+      @logger = logger
+      @allow_seeding_in_production = allow_seeding_in_production
+    end
+
+    def generate_seed_data
+      Hyrax::TestDataSeeders::UserSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+      Hyrax::TestDataSeeders::CollectionTypeSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+      Hyrax::TestDataSeeders::CollectionSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+      # TODO: add work seeder
+      # Hyrax::TestDataSeeders::WorkSeeder.generate_seeds(logger: logger, allow_seeding_in_production: allow_seeding_in_production)
+    end
+  end
+end