hyrax 4.0.0 → 5.0.0.rc2

data/app/models/hyrax/counter_metric.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hyrax
+  class CounterMetric < ApplicationRecord
+    validates :work_id, :date, presence: true
+  end
+end

data/app/models/hyrax/file_metadata.rb

@@ -18,8 +18,7 @@ module Hyrax
                        "with id #{file.id}. Initializing a new one")
 
     FileMetadata.new(file_identifier: file.id,
-                     alternative_ids: [file.id],
-                     original_filename: File.basename(file.io))
+                     original_filename: File.basename(file.disk_path))
   end
 
   class FileMetadata < Valkyrie::Resource
@@ -36,6 +35,7 @@ module Hyrax
       ORIGINAL_FILE = ::Valkyrie::Vocab::PCDMUse.OriginalFile
       EXTRACTED_TEXT = ::Valkyrie::Vocab::PCDMUse.ExtractedText
       THUMBNAIL = ::Valkyrie::Vocab::PCDMUse.ThumbnailImage
+      SERVICE_FILE = ::Valkyrie::Vocab::PCDMUse.ServiceFile
 
       ##
       # @param use [RDF::URI, Symbol]
@@ -59,7 +59,7 @@ module Hyrax
       module_function :uri_for
     end
 
-    attribute :file_identifier, Valkyrie::Types::ID # id of the file stored by the storage adapter
+    attribute :file_identifier, ::Valkyrie::Types::ID # id of the file stored by the storage adapter
     attribute :alternate_ids, Valkyrie::Types::Set.of(Valkyrie::Types::ID) # id of the file, populated for queryability
     attribute :file_set_id, ::Valkyrie::Types::ID # id of parent file set resource
 
@@ -67,11 +67,11 @@ module Hyrax
     attribute :label, ::Valkyrie::Types::Set
     attribute :original_filename, ::Valkyrie::Types::String
     attribute :mime_type, ::Valkyrie::Types::String.default(GENERIC_MIME_TYPE)
-    attribute :type, ::Valkyrie::Types::Set.default([Use::ORIGINAL_FILE].freeze) # Use += to add types, not <<
+    attribute :pcdm_use, ::Valkyrie::Types::Set.default([Use::ORIGINAL_FILE].freeze) # Use += to add pcdm_uses, not <<
 
     # attributes set by fits
     attribute :format_label, ::Valkyrie::Types::Set
-    attribute :size, ::Valkyrie::Types::Set
+    attribute :recorded_size, ::Valkyrie::Types::Set
     attribute :well_formed, ::Valkyrie::Types::Set
     attribute :valid, ::Valkyrie::Types::Set
     attribute :date_created, ::Valkyrie::Types::Set
@@ -130,19 +130,19 @@ module Hyrax
     ##
     # @return [Boolean]
     def original_file?
-      type.include?(Use::ORIGINAL_FILE)
+      pcdm_use.include?(Use::ORIGINAL_FILE)
     end
 
     ##
     # @return [Boolean]
     def thumbnail_file?
-      type.include?(Use::THUMBNAIL)
+      pcdm_use.include?(Use::THUMBNAIL)
     end
 
     ##
     # @return [Boolean]
     def extracted_file?
-      type.include?(Use::EXTRACTED_TEXT)
+      pcdm_use.include?(Use::EXTRACTED_TEXT)
     end
 
     def title
@@ -154,7 +154,7 @@ module Hyrax
     end
 
     def valid?
-      file.valid?(size: size.first, digests: { sha256: checksum&.first&.sha256 })
+      file.valid?(size: recorded_size.first, digests: { sha256: checksum&.first&.sha256 })
     end
 
     ##

data/app/models/hyrax/file_set.rb

@@ -6,28 +6,47 @@ module Hyrax
   #
   # ## Relationships
   #
-  # ### File Set and Work
+  # ### FileSet and Work
   #
   # * Defined: The relationship is defined by the inverse relationship stored in the
   #   work's `:member_ids` attribute.
-  # * Tested: The work tests the relationship.
-  # * File Set to Work: (1..1)  A file set must be in one and only one work.
+  # * Tested: The test for the Work class tests the relationship.
+  # * FileSet to Work: (n..1)  A FileSet must be in one and only one work. A Work can have zero to many FileSets.
+  # * See Hyrax::Work for code to get and set file sets for the work.
   #
-  # @example Get work for a file set:
+  # @example Get Work for a FileSet:
   #       work = Hyrax.custom_queries.find_parent_work(resource: file_set)
   #
-  # * Work to File Set: (0..m)  A work can have many file sets.
-  #   * See Hyrax::Work for code to get and set file sets for the work.
+  # ### FileSet and FileMetadata
   #
-  # ### File Set and File (TBD)
+  # * Defined: The relationship is defined by the FileSet's `:file_ids` attribute.
+  # * FileSet to FileMetadata: (0..n) A FileSet can have many FileMetadatas. A FileMetadata must be in one and only one FileSet.
+  #
+  # @example Get all FileMetadata for a FileSet:
+  #     file_metadata = Hyrax.custom_queries.find_files(file_set: file_set)
+  #
+  # @example Attach a File to a FileSet through a FileMetadata. This will create
+  #   a FileMetadata for a File object, attach the File to the FileMetadata, and
+  #   attach that FileMetadata to a given FileSet.
+  #     ::Hyrax::ValkyrieUpload.file(
+  #       io: file_io,
+  #       filename: "myfile.jpg",
+  #       file_set: file_set,
+  #       use: pcdm_use,
+  #       user: user
+  #     )
+  #
+  # ### FileMetadata and Files
+  #
+  # * Defined: The relationship is defined by the FileMetadata's `:file_identifier` attribute.
+  # * FileMetadata to File: (1..1) A FileMetadata can have one and only one File
+  #
+  # @example Get a File for a FileMetadata
+  #     file = Hyrax.storage_adapter.find_by(id: file_metadata.file_identifier)
   #
   # @see Hyrax::Work
+  # @see Hyrax::CustomQueries::Navigators::FindFiles#find_files
   # @see Hyrax::CustomQueries::Navigators::ParentWorkNavigator#find_parent_work
-  #
-  # @todo The description in Hydra::Works Shared Modeling is out of date and uses
-  #   terminology to describe the relationships that is no longer used in code.
-  #   Update the model and link to it.  This can be a simple relationship diagram
-  #   with a link to the original Works Shared Modeling for historical perspective.
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
@@ -41,9 +60,51 @@ module Hyrax
     self.characterization_proxy = Hyrax.config.characterization_proxy
 
     attribute :file_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID) # id for FileMetadata resources
-    attribute :thumbnail_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
-    attribute :original_file_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
-    attribute :extracted_text_id, Valkyrie::Types::ID.optional # id for FileMetadata resource
+
+    # @return [Hyrax::FileMetadata, nil]
+    def original_file
+      Hyrax.custom_queries.find_original_file(file_set: self)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      nil
+    end
+
+    # @return [Valkyrie::ID, nil]
+    def original_file_id
+      original_file&.id
+    end
+
+    # @return [String, Nil] versioned identifier suitable for use in a IIIF manifest
+    def iiif_id
+      orig_file = original_file
+      return nil if orig_file.nil? || orig_file.file_identifier.blank?
+      latest_file = Hyrax::VersioningService.latest_version_of(orig_file)
+      version = latest_file&.version_id ? Digest::MD5.hexdigest(latest_file.version_id) : nil
+      "#{id}/files/#{orig_file.id}#{'/' + version if version}"
+    end
+
+    # @return [Hyrax::FileMetadata, nil]
+    def thumbnail
+      Hyrax.custom_queries.find_thumbnail(file_set: self)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      nil
+    end
+
+    # @return [Valkyrie::ID, nil]
+    def thumbnail_id
+      thumbnail&.id
+    end
+
+    # @return [Hyrax::FileMetadata, nil]
+    def extracted_text
+      Hyrax.custom_queries.find_extracted_text(file_set: self)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      nil
+    end
+
+    # @return [Valkyrie::ID, nil]
+    def extracted_text_id
+      extracted_text&.id
+    end
 
     ##
     # @return [Valkyrie::ID]

data/app/models/hyrax/orcid_validator.rb

@@ -7,12 +7,6 @@ module Hyrax
       record.errors.add(:orcid, 'must be a string of 19 characters, e.g., "0000-0000-0000-0000"') unless ORCID_REGEXP.match?(record.orcid)
     end
 
-    # @deprecated
-    def self.match(string)
-      Deprecation.warn "Use 'Hyrax::OrcidValidator.extract_bare_orcid(from:)'"
-      extract_bare_orcid_from(from: string)
-    end
-
     # @api public
     # @param [String] from
     # @return nil if the given string is not in the Orcid form

data/app/models/hyrax/resource.rb

@@ -35,8 +35,8 @@ module Hyrax
     include Hyrax::WithEvents
 
     attribute :alternate_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID)
-    attribute :embargo,       Hyrax::Embargo.optional
-    attribute :lease,         Hyrax::Lease.optional
+    attribute :embargo_id,    Valkyrie::Types::ID
+    attribute :lease_id,      Valkyrie::Types::ID
 
     delegate :edit_groups, :edit_groups=,
              :edit_users,  :edit_users=,
@@ -91,6 +91,10 @@ module Hyrax
       false
     end
 
+    def ==(other)
+      attributes.except(:created_at, :updated_at) == other.attributes.except(:created_at, :updated_at)
+    end
+
     def permission_manager
       @permission_manager ||= Hyrax::PermissionManager.new(resource: self)
     end
@@ -103,6 +107,30 @@ module Hyrax
       visibility_reader.read
     end
 
+    def embargo=(value)
+      raise TypeError "can't convert #{value.class} into Hyrax::Embargo" unless value.is_a? Hyrax::Embargo
+
+      @embargo = value
+      self.embargo_id = @embargo.id
+    end
+
+    def embargo
+      return @embargo if @embargo
+      @embargo = Hyrax.query_service.find_by(id: embargo_id) if embargo_id.present?
+    end
+
+    def lease=(value)
+      raise TypeError "can't convert #{value.class} into Hyrax::Lease" unless value.is_a? Hyrax::Lease
+
+      @lease = value
+      self.lease_id = @lease.id
+    end
+
+    def lease
+      return @lease if @lease
+      @lease = Hyrax.query_service.find_by(id: lease_id) if lease_id.present?
+    end
+
     protected
 
     def visibility_writer

data/app/models/hyrax/work.rb

@@ -63,7 +63,7 @@ module Hyrax
   #   `it_behaves_like 'has_members'`.  Shared specs are defined in /lib/hyrax/specs/shared_specs/hydra_works.rb.
   # * Work to File Set: (0..m)  A work can have many file sets.
   # @example Add a file set to a work (code from Hyrax::WorkUploadsHandler#append_to_work)
-  #       work.member_ids << file_set.id
+  #       work.member_ids += [file_set.id]
   #       work.representative_id = file_set.id if work.respond_to?(:representative_id) && work.representative_id.blank?
   #       work.thumbnail_id = file_set.id if work.respond_to?(:thumbnail_id) && work.thumbnail_id.blank?
   #       Hyrax.persister.save(resource: work)
@@ -91,11 +91,8 @@ module Hyrax
   #
   # @see /lib/hyrax/specs/shared_specs/hydra_works.rb
   #
-  # @todo The description in Hydra::Works Shared Modeling is out of date and uses
-  #   terminology to describe the relationships that is no longer used in code.
-  #   Update the model and link to it.  This can be a simple relationship diagram
-  #   with a link to the original Works Shared Modeling for historical perspective.
   # @see https://wiki.lyrasis.org/display/samvera/Hydra::Works+Shared+Modeling
+  #   for a historical perspective.
   class Work < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
 

data/app/presenters/hyrax/collection_presenter.rb

@@ -172,23 +172,6 @@ module Hyrax
       create_work_presenter.first_model
     end
 
-    ##
-    # @deprecated this implementation requires an extra db round trip, had a
-    #   buggy cacheing mechanism, and was largely duplicative of other code.
-    #   all versions of this code are replaced by
-    #   {CollectionsHelper#available_parent_collections_data}.
-    def available_parent_collections(scope:)
-      Deprecation.warn("#{self.class}#available_parent_collections is " \
-                       "deprecated. Use available_parent_collections_data " \
-                       "helper instead.")
-      return @available_parents if @available_parents.present?
-      collection = Hyrax.config.collection_class.find(id)
-      colls = Hyrax::Collections::NestedCollectionQueryService.available_parent_collections(child: collection, scope: scope, limit_to_id: nil)
-      @available_parents = colls.map do |col|
-        { "id" => col.id, "title_first" => col.title.first }
-      end.to_json
-    end
-
     def subcollection_count=(total)
       @subcollection_count = total unless total.nil?
     end

data/app/presenters/hyrax/embargo_presenter.rb

@@ -23,5 +23,9 @@ module Hyrax
     def embargo_history
       solr_document['embargo_history_ssim']
     end
+
+    def enforced?
+      solr_document.embargo_enforced?
+    end
   end
 end

data/app/presenters/hyrax/file_set_presenter.rb

@@ -105,6 +105,12 @@ module Hyrax
       current_ability.can?(:edit, id) || current_ability.can?(:destroy, id) || current_ability.can?(:download, id)
     end
 
+    ##
+    # @return [Array<String>]
+    def show_partials
+      ['show_details']
+    end
+
     private
 
     def link_presenter_class

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -56,7 +56,7 @@ module Hyrax
     ##
     # @return [Boolean]
     def file_set?
-      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet')
+      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet') || Array(model[:has_model_ssim]).include?('Hyrax::FileSet')
     end
 
     ##
@@ -93,12 +93,8 @@ module Hyrax
     ##
     # @return [Array<#to_s>]
     def member_ids
-      case model
-      when Valkyrie::Resource
-        Array(model.try(:member_ids))
-      else
-        Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
-      end
+      m = model.is_a?(::SolrDocument) ? model.hydra_model : model.class
+      m < Hyrax::Resource ? Array(model.member_ids) : Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
     end
 
     ##

data/app/presenters/hyrax/pcdm_member_presenter_factory.rb

@@ -28,7 +28,7 @@ module Hyrax
     # @return [Array<FileSetPresenter, WorkShowPresenter>]
     # @return [Enumerator<FileSetPresenter>]
     def file_set_presenters
-      return enum_for(:file_set_presenters) unless block_given?
+      return enum_for(:file_set_presenters).to_a unless block_given?
 
       results = query_docs(generic_type: "FileSet")
 
@@ -47,14 +47,14 @@ module Hyrax
     #   we recommend making sparing use of this feature.
     #
     # @overload member_presenters
-    #   @return [Enumerator<FileSetPresenter, WorkShowPresenter>]
+    #   @return [Array<FileSetPresenter, WorkShowPresenter>]
     #   @raise [ArgumentError] if an unindexed id is passed
     # @overload member_presenters
     #   @param [Array<#to_s>] ids
-    #   @return [Enumerator<FileSetPresenter, WorkShowPresenter>]
+    #   @return [Array<FileSetPresenter, WorkShowPresenter>]
     #   @raise [ArgumentError] if an unindexed id is passed
     def member_presenters(ids = object.member_ids)
-      return enum_for(:member_presenters, ids) unless block_given?
+      return enum_for(:member_presenters, ids).to_a unless block_given?
 
       results = query_docs(ids: ids)
 
@@ -109,6 +109,8 @@ module Hyrax
     def query_docs(generic_type: nil, ids: object.member_ids)
       query = "{!terms f=id}#{ids.join(',')}"
       query += "{!term f=generic_type_si}#{generic_type}" if generic_type
+      # works created via ActiveFedora use the _sim field
+      query += "{!term f=generic_type_sim}#{generic_type}" if generic_type
 
       Hyrax::SolrService
         .post(q: query, rows: 10_000)

data/app/presenters/hyrax/presenter_renderer.rb

@@ -22,13 +22,6 @@ module Hyrax
         default: [:"defaults.#{field}", field.to_s.humanize]).presence
     end
 
-    ##
-    # @deprecated
-    def fields(terms, &_block)
-      Deprecation.warn("Fields is deprecated for removal in Hyrax 4.0.0. use #value and #label directly instead.")
-      @view_context.safe_join(terms.map { |term| yield self, term })
-    end
-
     private
 
     def render_show_field_partial(field_name, locals)

data/app/presenters/hyrax/version_list_presenter.rb

@@ -5,17 +5,19 @@ module Hyrax
   class VersionListPresenter
     include Enumerable
 
+    attr_reader :versioning_service
+
     ##
-    # @param version_list [Array<#created>]
-    def initialize(version_list)
-      @raw_list = version_list
+    # @param service [Hyrax::VersioningService]
+    def initialize(service)
+      @versioning_service = service
     end
 
     ##
     # @param [Object] an object representing the File Set
     #
-    # @return [Enumerable<Hyrax::VersionPresenter>] an enumerable of presenters
-    #   for the relevant file versions.
+    # @return [Hyrax::VersionListPresenter] an enumerable of presenters for the
+    #   relevant file versions.
     #
     # @raise [ArgumentError] if we can't build an enu
     def self.for(file_set:)
@@ -24,20 +26,27 @@ module Hyrax
                       else
                         Hyrax::FileSetFileService.new(file_set: file_set).original_file
                       end
-      new(Hyrax::VersioningService.new(resource: original_file).versions)
+      new(Hyrax::VersioningService.new(resource: original_file))
     rescue NoMethodError
       raise ArgumentError
     end
 
-    delegate :each, to: :wrapped_list
+    delegate :each, :empty?, to: :wrapped_list
+    delegate :supports_multiple_versions?, to: :versioning_service
 
     private
 
     def wrapped_list
       @wrapped_list ||=
-        @raw_list.map { |v| Hyrax::VersionPresenter.new(v) } # wrap each item in a presenter
-                 .sort { |a, b| b.version.created <=> a.version.created } # sort list of versions based on creation date
-                 .tap { |l| l.first.try(:current!) } # set the first version to the current version
+        begin
+          presenters = @versioning_service.versions.map { |v| Hyrax::VersionPresenter.new(v) } # wrap each item in a presenter
+          if presenters.first&.version&.respond_to?(:created)
+            presenters.sort! { |a, b| b.version.created <=> a.version.created } if presenters.first&.version.respond_to?(:created) # sort list of versions based on creation date
+          else
+            presenters.reverse!
+          end
+          presenters.tap { |l| l.first.try(:current!) } # set the first version to the current version
+        end
     end
   end
 end

data/app/presenters/hyrax/version_presenter.rb

@@ -15,14 +15,29 @@ module Hyrax
       @current = true
     end
 
+    def label
+      version.try(:label) || version.version_id.to_s
+    end
+
+    def uri
+      version.try(:uri) || version.version_id.to_s
+    end
+
     def created
-      @created ||= version.created.in_time_zone.to_formatted_s(:long_ordinal)
+      @created ||= created_time&.in_time_zone&.to_formatted_s(:long_ordinal) || "Unknown"
     end
 
-    def committer
+    def created_time
+      version.try(:created) || version_committer.try(:created_at)
+    end
+
+    def version_committer
       Hyrax::VersionCommitter
-        .find_by(version_id: @version.uri)
-        &.committer_login
+        .find_by(version_id: @version.try(:uri) || @version.try(:version_id))
+    end
+
+    def committer
+      version_committer&.committer_login
     end
   end
 end

data/app/presenters/hyrax/work_show_presenter.rb

@@ -190,16 +190,6 @@ module Hyrax
       paginated_item_list(page_array: authorized_item_ids)
     end
 
-    ##
-    # @deprecated use `#member_presenters(ids)` instead
-    #
-    # @param [Array<String>] ids a list of ids to build presenters for
-    # @return [Array<presenter_class>] presenters for the array of ids (not filtered by class)
-    def member_presenters_for(an_array_of_ids)
-      Deprecation.warn("Use `#member_presenters` instead.")
-      member_presenters(an_array_of_ids)
-    end
-
     # @return [Integer] total number of pages of viewable items
     def total_pages
       (total_items.to_f / rows_from_params.to_f).ceil
@@ -262,6 +252,11 @@ module Hyrax
       Hyrax::ChildTypes.for(parent: solr_document.hydra_model).to_a
     end
 
+    # @return [Boolean]
+    def valkyrie_presenter?
+      solr_document.hydra_model < Valkyrie::Resource
+    end
+
     private
 
     # list of item ids to display is based on ordered_ids
@@ -308,7 +303,7 @@ module Hyrax
 
     def member_presenter_factory
       @member_presenter_factory ||=
-        if solr_document.hydra_model < Valkyrie::Resource
+        if valkyrie_presenter?
           PcdmMemberPresenterFactory.new(solr_document, current_ability)
         else
           self.class

data/app/search_builders/hyrax/file_set_search_builder.rb

@@ -5,7 +5,7 @@ module Hyrax
 
     # This overrides the models in FilterByType
     def models
-      [::FileSet]
+      [::FileSet, ::Hyrax::FileSet]
     end
   end
 end

data/app/search_builders/hyrax/valkyrie_abstract_type_relation.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Hyrax
+  class ValkyrieAbstractTypeRelation
+    def initialize(allowable_types: nil, _opts: {})
+      @allowable_types = allowable_types
+    end
+
+    def allowable_types
+      @allowable_types.present? ||
+        raise(NotImplementedException, "Implement allowable_types in a subclass")
+    end
+
+    def equivalent_class?(klass)
+      allowable_types.include?(klass)
+    end
+
+    def count
+      Hyrax.query_service.custom_queries.find_count_by(models: allowable_types)
+    end
+
+    def where(hash)
+      Hyrax.query_service.find_references_by(resource: hash.values.first, property: hash.keys.first)
+    end
+
+    def ==(other)
+      case other
+      when Relation
+        other.where_values == where_values
+      when Array
+        to_a == other
+      end
+    end
+
+    delegate :inspect, to: :to_a
+  end
+end

data/app/search_builders/hyrax/valkyrie_work_relation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Hyrax
+  class ValkyrieWorkRelation < ValkyrieAbstractTypeRelation
+    def allowable_types
+      Hyrax.config.curation_concerns
+    end
+  end
+end

data/app/services/hyrax/admin_set_create_service.rb

@@ -18,23 +18,6 @@ module Hyrax
     self.default_admin_set_persister = Hyrax::DefaultAdministrativeSet
 
     class << self
-      # @api public
-      # Creates the default Hyrax::AdministrativeSet and corresponding data
-      # @param admin_set_id [String] The default admin set ID
-      # @param title [Array<String>] The title of the default admin set
-      # @return [TrueClass]
-      # @see Hyrax::AdministrativeSet
-      # @deprecated
-      # TODO: When this deprecated method is removed, update private method
-      #       .create_default_admin_set! to remove the parameters.
-      def create_default_admin_set(admin_set_id: DEFAULT_ID, title: DEFAULT_TITLE)
-        Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                         "Instead, use 'Hyrax::AdminSetCreateService.find_or_create_default_admin_set'.")
-        create_default_admin_set!(admin_set_id: admin_set_id, title: title).present?
-      rescue RuntimeError => _err
-        false
-      end
-
       # @api public
       # Finds the default AdministrativeSet if it exists; otherwise, creates it and corresponding data
       # @return [Hyrax::AdministrativeSet] The default admin set.