hyrax 3.6.0 → 4.0.0.beta1

data/config/metadata/file_set_metadata.yaml

@@ -1,130 +0,0 @@
-# This is the metadata used for `Hyrax::FileSet`s.` It is similar to
-# `basic_metadata.yaml`, but not exactly the same.
-#
-# Terms which are already present in `core_metadata.yaml` are not repeated here.
-attributes:
-  # Required attributes:
-  creator:
-    type: string
-    multiple: true
-    form:
-      required: true
-      primary: true
-    index_keys:
-      - "creator_tesim"
-  license:
-    type: string
-    multiple: true
-    form:
-      required: true
-      primary: true
-
-  # Other attributes:
-  abstract:
-    type: string
-    multiple: true
-  # form:
-  #   primary: false
-  # missing: access_right
-  # missing: alternative_title
-  based_near:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "based_near_sim"
-      - "based_near_tesim"
-  # missing: bibliograpic_citation
-  contributor:
-    type: string
-    multiple: true
-    form:
-      primary: false
-  # required: creator
-  date_created:
-    type: date_time
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "date_created_tesim"
-  description:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "description_tesim"
-  identifier:
-    type: string
-    multiple: true
-    form:
-      primary: false
-  # missing: import_url
-  keyword:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "keyword_sim"
-      - "keyword_tesim"
-  # missing: publisher
-  label:
-    type: string
-  # form:
-  #   primary: false
-  language:
-    type: string
-    multiple: true
-    form:
-      primary: false
-  # required: license
-  publisher:
-    type: string
-    multiple: true
-    form:
-      primary: false
-  related_url:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "related_url_tesim"
-  relative_path:
-    type: string
-  resource_type:
-    type: string
-    multiple: true
-  # form:
-  #   primary: false
-    index_keys:
-      - "resource_type_sim"
-      - "resource_type_tesim"
-  rights_notes:
-    type: string
-    multiple: true
-  # form:
-  #   primary: false
-  rights_statement:
-    type: string
-    multiple: true
-  # form:
-  #   primary: true
-    index_keys:
-      - "rights_statement_tesim"
-  source:
-    type: string
-    multiple: true
-  # form:
-  #   primary: false
-  subject:
-    type: string
-    multiple: true
-    form:
-      primary: false
-    index_keys:
-      - "subject_sim"
-      - "subject_tesim"

data/lib/hyrax/transactions/create_work.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    ##
-    # A transaction for creating a Work ready for use in Hyrax. Handles
-    # ensuring admin sets and permission templates are present, and setting
-    # system managed dates prior to save.
-    #
-    # @note This is an experimental replacement for the actor stack's `#create`
-    #   stack. In time, we hope this will have feature parity with that stack,
-    #   along with improved architecture, error handling, readability, and
-    #   customizability. While this develops, please provide feedback.
-    #
-    # @since 2.4.0
-    #
-    # @example Creating a work transactionally
-    #   work   = MyWork.new(title: ['Comet in Moominland'])
-    #   result = Hyrax::Transactions::CreateWork.call(work)
-    #   result.success? => true
-    #
-    # @example Handling errors with procedural style
-    #   work   = MyWork.new # invalid work (no title)
-    #   result = Hyrax::Transactions::CreateWork.call(work)
-    #   result.success? => false
-    #
-    #   result.failure # => failure description or object
-    #
-    # @example Handling errors with `#or`
-    #   work   = MyWork.new # invalid work (no title)
-    #
-    #   Hyrax::Transactions::CreateWork
-    #     .call(work)
-    #     .or { |error| handle_error(error) }
-    #
-    # @see https://dry-rb.org/gems/dry-transaction/
-    #
-    # @todo add collection membership handling (@see CollectionsMembershipActor)
-    # @todo set depositor (@see BaseActor)
-    # @todo initialize workflow after save (@see BaseActor)
-    # @todo add to parent works post-save (see: 'AddToWorkActor`)
-    # @todo attach files (see: 'CreateWithFilesActor`, `CreateWithRemoteFilesActor`
-    # @todo validate PermissionTemplate against visibility, lease, and embargo (see: `InterpretVisibilityActor`)
-    # @todo add locking/transactionality. Just do better than the Actor Stack
-    # @todo add support for proxy deposit (see: TransferRequestActor)
-    #
-    # @deprecated Development on Dry::Transaction has been discontinued, we're
-    #   removing existing transactions and replacing them with Dry::Monad-based
-    #   valkyrie versions.
-    # @see Hyrax::Transactions::WorkCreate
-    class CreateWork
-      include Dry::Transaction(container: Hyrax::Transactions::Container)
-
-      # DO NOT USE - This class is deprecated.  See Hyrax::Transactions::WorkCreate for resource works.
-
-      step :set_default_admin_set,     with: 'work.set_default_admin_set'
-      step :ensure_admin_set,          with: 'work.ensure_admin_set'
-      step :apply_permission_template, with: 'work.apply_permission_template'
-      step :apply_collection_template, with: 'work.apply_collection_permission_template'
-      step :apply_visibility,          with: 'work.apply_visibility'
-      step :set_modified_date,         with: 'work.set_modified_date'
-      step :set_uploaded_date,         with: 'work.set_uploaded_date_unless_present'
-      step :save_work,                 with: 'work.save_work'
-    end
-  end
-end

data/lib/hyrax/transactions/destroy_work.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    ##
-    # A transaction for destroying a Hyrax Work.
-    #
-    # @note This is an experimental replacement for the actor stack's `#destroy`
-    #   stack. In time, we hope this will have feature parity with that stack,
-    #   along with improved architecture, error handling, readability, and
-    #   customizability. While this develops, please provide feedback.
-    #
-    # @since 3.0.0
-    #
-    # @see https://dry-rb.org/gems/dry-transaction/
-    #
-    # @deprecated Development on Dry::Transaction has been discontinued, we're
-    #   removing existing transactions and replacing them with Dry::Monad-based
-    #   valkyrie versions.
-    # @see Hyrax::Transactions::WorkDestroy
-    class DestroyWork
-      include Dry::Transaction(container: Hyrax::Transactions::Container)
-
-      # DO NOT USE - This class is deprecated.  See Hyrax::Transactions::WorkDestroy for resource works.
-
-      step :destroy_work, with: 'work.destroy_work'
-    end
-  end
-end

data/lib/hyrax/transactions/steps/apply_collection_permission_template.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    module Steps
-      ##
-      # A `dry-transcation` step that applies permission templates for a set of
-      # collections on a given work.
-      #
-      # @since 3.0.0
-      # @deprecated This is part of the legacy AF set of transaction steps for works.
-      #   Transactions are not being used with AF works.  This will be removed in 4.0.
-      class ApplyCollectionPermissionTemplate
-        include Dry::Transaction::Operation
-
-        ##
-        # @param [Hyrax::WorkBehavior] work
-        # @param [Array<#permision_template>] collections  a list of collections for which
-        #   permission templates should be applied
-        #
-        # @return [Dry::Monads::Result]
-        def call(work, collections: [])
-          collections.each do |collection|
-            template = Hyrax::PermissionTemplate.find_by!(source_id: collection.id)
-            Hyrax::PermissionTemplateApplicator.apply(template).to(model: work)
-          end
-
-          Success(work)
-        rescue ActiveRecord::RecordNotFound => err
-          Failure(err)
-        end
-      end
-    end
-  end
-end

data/lib/hyrax/transactions/steps/apply_permission_template.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    module Steps
-      ##
-      # A `dry-transcation` step that applies a permission template for a given
-      # work's AdminSet.
-      #
-      # @since 2.4.0
-      # @deprecated This is part of the legacy AF set of transaction steps for works.
-      #   Transactions are not being used with AF works.  This will be removed in 4.0.
-      class ApplyPermissionTemplate
-        include Dry::Transaction::Operation
-
-        ##
-        # @param [Hyrax::WorkBehavior] work
-        #
-        # @return [Dry::Monads::Result]
-        def call(work)
-          return Failure(:missing_permission) unless
-            (template = work&.admin_set&.permission_template)
-
-          Hyrax::PermissionTemplateApplicator.apply(template).to(model: work)
-
-          Success(work)
-        rescue ActiveRecord::RecordNotFound => err
-          Failure(err)
-        end
-      end
-    end
-  end
-end

data/lib/hyrax/transactions/steps/apply_visibility.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    module Steps
-      ##
-      # A `dry-transaction` step that interprets visibility/lease/embargo from
-      # passed arguments.
-      #
-      # @since 3.0.0
-      # @deprecated This is part of the legacy AF set of transaction steps for works.
-      #   Transactions are not being used with AF works.  This will be removed in 4.0.
-      class ApplyVisibility
-        include Dry::Transaction::Operation
-
-        ##
-        # @param [Hyrax::WorkBehavior] work
-        # @param [String] visibility
-        # @param [String] release_date
-        # @param [String] during
-        # @param [String] after
-        #
-        # @return [Dry::Monads::Result] `Failure` if there is no
-        #   `PermissionTemplate` for the input; `Success(input)`, otherwise.
-        def call(work, visibility: nil, release_date: nil, during: nil, after: nil)
-          return Success(work) if visibility.blank?
-
-          intention = Hyrax::VisibilityIntention.new(visibility: visibility,
-                                                     release_date: release_date,
-                                                     during: during,
-                                                     after: after)
-
-          Hyrax::VisibilityIntentionApplicator.apply(intention).to(model: work)
-
-          Success(work)
-        rescue Hyrax::VisibilityIntentionApplicator::InvalidIntentionError => err
-          Failure(err)
-        end
-      end
-    end
-  end
-end

data/lib/hyrax/transactions/steps/destroy_work.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    module Steps
-      ##
-      # A `dry-transcation` step that destroys a Work.
-      #
-      # @since 3.0.0
-      # @deprecated This is part of the legacy AF set of transaction steps for works.
-      #   Transactions are not being used with AF works.  This will be removed in 4.0.
-      # @see Hyrax::Transactions::Steps::DeleteResource
-      class DestroyWork
-        include Dry::Transaction::Operation
-
-        ##
-        # @param [Hyrax::WorkBehavior] work
-        #
-        # @return [Dry::Monads::Result]
-        def call(work)
-          work.destroy! && Success(work)
-        rescue => err
-          Failure(err)
-        end
-      end
-    end
-  end
-end

data/lib/hyrax/transactions/steps/ensure_permission_template.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    module Steps
-      ##
-      # A `dry-transaction` step that ensures the input `work` has a permission
-      # template.
-      #
-      # @since 2.4.0
-      # @deprecated This is part of the legacy AF set of transaction steps for works.
-      #   Transactions are not being used with AF works.  This will be removed in 4.0.
-      class EnsurePermissionTemplate
-        include Dry::Transaction::Operation
-
-        ##
-        # @param [Hyrax::WorkBehavior] work
-        #
-        # @return [Dry::Monads::Result] `Failure` if there is no
-        #   `PermissionTemplate` for the input; `Success(input)`, otherwise.
-        def call(work)
-          return Failure(:no_permission_template) unless
-            Hyrax::PermissionTemplate.find_by(source_id: work.admin_set&.id)
-
-          Success(work)
-        end
-      end
-    end
-  end
-end

data/lib/hyrax/transactions/steps/save_work.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    module Steps
-      ##
-      # A `dry-transaction` step that saves an input work.
-      #
-      # @example saving a work
-      #   step = Hyrax::Transactions::Steps::SaveWork.new
-      #   work = MyWork.new(title: ['Comet in Moominland'])
-      #
-      #   step.call(work) # => Success
-      #
-      # @example handling error cases
-      #   step = Hyrax::Transactions::Steps::SaveWork.new
-      #   work = MyWork.new(title: [:invalid_title])
-      #
-      #   step.call(work).or { |err| puts err.messages }
-      #
-      # @since 2.4.0
-      # @deprecated This is part of the legacy AF set of transaction steps for works.
-      #   Transactions are not being used with AF works.  This will be removed in 4.0.
-      # @see Hyrax::Transactions::Steps::Save
-      class SaveWork
-        include Dry::Transaction::Operation
-
-        ##
-        # @param [Hyrax::WorkBehavior] work
-        #
-        # @return [Dry::Monads::Result] `Failure` if the work fails to save;
-        #   `Success(input)`, otherwise.
-        def call(work)
-          work.save ? Success(work) : Failure(work.errors)
-        end
-      end
-    end
-  end
-end

data/lib/hyrax/transactions/update_work.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Transactions
-    ##
-    # @since 3.0.0
-    # @deprecated Use Hyrax::Transactions::WorkUpdate instead.
-    class UpdateWork < Transaction
-      DEFAULT_STEPS = Hyrax::Transactions::WorkUpdate::DEFAULT_STEPS
-
-      # DO NOT USE - This class is deprecated.  Use Hyrax::Transactions::WorkUpdate instead.
-
-      ##
-      # @see Hyrax::Transactions::Transaction
-      def initialize(container: Container, steps: DEFAULT_STEPS)
-        super
-      end
-    end
-  end
-end

data/lib/wings/services/file_converter_service.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-# Conversion service for going between files on a valkyrie resource and files on an active fedora object
-module Wings
-  # @deprecated use generic Wings converters instead.
-  # @see ModelTransformer, ActiveFedoraConverter
-  class FileConverterService
-    class << self
-      def af_file_to_resource(af_file:)
-        Deprecation.warn("Use ModelTransformer.for(af_file) instead.")
-        ModelTransformer.for(af_file)
-      end
-
-      def resource_to_af_file(metadata_resource:)
-        Deprecation.warn("Use ActiveFedoraConverter.convert(resource:) instead.")
-        ActiveFedoraConverter.convert(resource: metadata_resource)
-      end
-    end
-  end
-end

data/lib/wings/services/file_metadata_builder.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-module Wings
-  # Stores a file and an associated Hyrax::FileMetadata
-  #
-  # @deprecated use `Hyrax.storage_adapter` instead
-  class FileMetadataBuilder
-    include Hyrax::Noid
-
-    attr_reader :storage_adapter, :persister
-    def initialize(storage_adapter:, persister:)
-      Deprecation.warn('This class is deprecated; use Wings::Valkyrie::Storage instead.')
-      @storage_adapter = storage_adapter
-      @persister = persister
-    end
-
-    # @param io_wrapper [JobIOWrapper] with details about the uploaded file
-    # @param file_metadata [Hyrax::FileMetadata] the metadata to represent the file
-    # @param file_set [Valkyrie::Resouce, Hydra::Works::FileSet] the associated FileSet # TODO: WINGS - Remove Hydra::Works::FileSet as a potential type when valkyrization is complete.
-    # @return [Hyrax::FileMetadata] the persisted metadata file_metadata that represents the file
-    #
-    # @deprecated use `Hyrax.storage_adapter` instead
-    def create(io_wrapper:, file_metadata:, file_set:)
-      Deprecation.warn('Use storage_adapter.upload, Fedora creates a `FileMetadata` (describedBy) implictly. ' \
-                       'Query it with Hyrax.custom_queries.find_file_metadata_by(id: stored_file.id).')
-      io_wrapper = build_file(io_wrapper, file_metadata.type)
-      stored_file = storage_adapter.upload(file: io_wrapper,
-                                           original_filename: io_wrapper.original_filename,
-                                           content_type: io_wrapper.content_type,
-                                           resource: file_set,
-                                           use: Array(file_metadata.type).first,
-                                           id_hint: assign_id)
-
-      Hyrax.custom_queries.find_file_metadata_by(id: stored_file.id)
-    end
-
-    # @param file_metadata [Hyrax::FileMetadata] the metadata to represent the file
-    # @param file_set [Valkyrie::Resouce, Hydra::Works::FileSet] the associated FileSet # TODO: WINGS - Remove Hydra::Works::FileSet as a potential type when valkyrization is complete.
-    # @return [Hyrax::FileMetadata] the persisted metadata file_metadata that represents the file
-    def attach_file_metadata(file_metadata:, file_set:)
-      file_set.is_a?(::Valkyrie::Resource) ? attach_file_metadata_to_valkyrie_file_set(file_metadata, file_set) : file_metadata
-    end
-
-    private
-
-    ##
-    # @api private
-    def attach_file_metadata_to_valkyrie_file_set(file_metadata, file_set)
-      # This is for storage adapters other than wings.  The wings storage adapter already attached the file to the file_set.
-      # This process is a no-op for wings.  # TODO: WINGS - May need to verify this is a no-op for wings once file_set is passed in as a resource.
-      # TODO: WINGS - Need to test this against other adapters once they are available for use.
-      existing_file_metadata = current_original_file(file_set) || file_metadata
-      file_metadata = existing_file_metadata.new(file_metadata.to_h.except(:id))
-      saved_file_metadata = persister.save(resource: file_metadata)
-      file_set.file_ids = [saved_file_metadata.id]
-      persister.save(resource: file_set)
-      saved_file_metadata
-    end
-
-    ##
-    # @api private
-    # @return [Hyrax::FileMetadata, nil]
-    def current_original_file(file_set)
-      Hyrax.custom_queries.find_original_file(file_set: file_set)
-    rescue ::Valkyrie::Persistence::ObjectNotFoundError
-      nil
-    end
-
-    # Class for wrapping the file being ingested
-    class IoDecorator < SimpleDelegator
-      attr_reader :original_filename, :content_type, :length, :use, :tempfile
-
-      # @param [IO] io stream for the file content
-      # @param [String] original_filename
-      # @param [String] content_type
-      # @param [RDF::URI] use the URI for the PCDM predicate indicating the use for this resource
-      def initialize(io, original_filename, content_type, content_length, use)
-        @original_filename = original_filename
-        @content_type = content_type
-        @length = content_length
-        @use = use
-        @tempfile = io
-        super(io)
-      end
-    end
-
-    # Constructs the IoDecorator for ingesting the intermediate file
-    # @param [JobIOWrapper] io wrapper with details about the uploaded file
-    # @param [RDF::URI] use the URI for the PCDM predicate indicating the use for this resource
-    def build_file(io_wrapper, use)
-      IoDecorator.new(io_wrapper.file, io_wrapper.original_name, io_wrapper.mime_type, io_wrapper.size, use)
-    end
-  end
-end