hyrax 4.0.0 → 5.0.0.rc1

data/app/models/hyrax/file_metadata.rb

@@ -18,7 +18,6 @@ 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))
   end
 
@@ -67,11 +66,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 +129,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 +153,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

@@ -51,6 +51,14 @@ module Hyrax
       id
     end
 
+    ##
+    # @return [Valkyrie::ID]
+    def representative_id=(_input)
+      # saving a file set using valkyrie would err because this method didn't exist.
+      Rails.logger.warn('This is not a valid method for file sets')
+      id
+    end
+
     ##
     # @return [Boolean] true
     def pcdm_object?

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/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/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/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/characterization/valkyrie_characterization_service.rb

@@ -27,25 +27,27 @@ class Hyrax::Characterization::ValkyrieCharacterizationService
   # @!attribute [rw] source
   #   @return [Valkyrie::StorageAdapter::StreamFile]
   # @!attribute [rw] tools
-  #   @todo clarify what this is for. it gets passed to {#characterize}
-  #     on the characterizer, but it's not clear how to customize
-  #     effectively.
+  #   can be :fits, :fits_servlet, :ffprobe or any other service added to HydraFileCharacterization
+  #   note that ffprope is faster but only works on AV files.
   #   @return [Symbol]
   attr_accessor :mapping, :metadata, :parser, :source, :tools
 
   ##
   # @api private
-  def initialize(metadata:, # rubocop:disable Metrics/ParameterLists
-                 file:,
-                 characterizer: Hydra::FileCharacterization,
-                 parser_mapping: Hydra::Works::Characterization.mapper,
-                 parser: Hydra::Works::Characterization::FitsDocument.new)
+  def initialize( # rubocop:disable Metrics/ParameterLists
+    metadata:,
+    file:,
+    characterizer: Hydra::FileCharacterization,
+    parser_mapping: Hydra::Works::Characterization.mapper,
+    parser: Hydra::Works::Characterization::FitsDocument.new,
+    ch12n_tool: :fits
+  )
     @characterizer = characterizer
     @metadata      = metadata
     @source        = file
     @mapping       = parser_mapping
     @parser        = parser
-    @tools         = :fits
+    @tools         = ch12n_tool
   end
 
   ##

data/app/services/hyrax/custom_queries/find_by_date_range.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module Hyrax
+  module CustomQueries
+    ##
+    # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+    class FindByDateRange
+      def self.queries
+        [:find_by_date_range]
+      end
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+      delegate :orm_class, to: :resource_factory
+
+      ##
+      # @note this is an unoptimized default implementation of this custom
+      #   query. it's Hyrax's policy to provide such implementations of custom
+      #   queries in use for cross-compatibility of Valkyrie query services.
+      #   it's advisable to provide an optimized query for the specific adapter.
+      #
+      # @param models [Array]
+      # @param start_datetime [DateTime]
+      # @param end_datetime [DateTime]
+      def find_by_date_range(start_datetime:, end_datetime: nil, models: nil)
+        end_datetime = 1.second.since(Time.zone.now) if end_datetime.blank?
+        if models.present?
+          query_service.run_query(find_models_by_date_range_query, start_datetime.to_s, end_datetime.to_s, models)
+        else
+          query_service.run_query(find_by_date_range_query, start_datetime.to_s, end_datetime.to_s)
+        end
+      end
+
+      def find_models_by_date_range_query
+        <<-SQL
+          SELECT * FROM orm_resources
+          WHERE created_at >= ?
+          AND created_at <= ?
+          AND internal_resource IN (?);
+        SQL
+      end
+
+      def find_by_date_range_query
+        <<-SQL
+          SELECT * FROM orm_resources
+          WHERE created_at >= ?
+          AND created_at <= ?;
+        SQL
+      end
+    end
+  end
+end

data/app/services/hyrax/custom_queries/find_count_by.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+module Hyrax
+  module CustomQueries
+    ##
+    # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+    class FindCountBy
+      def self.queries
+        [:find_count_by]
+      end
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+      delegate :orm_class, to: :resource_factory
+
+      ##
+      # @note this is an unoptimized default implementation of this custom
+      #   query. it's Hyrax's policy to provide such implementations of custom
+      #   queries in use for cross-compatibility of Valkyrie query services.
+      #   it's advisable to provide an optimized query for the specific adapter.
+      #
+      # @param hash [Hash] the hash representation of the query
+      def find_count_by(hash = {}, models: nil)
+        return nil if models.empty? && hash.blank?
+
+        internal_array = ["{ #{hash.map { |k, v| "\"#{k}\": #{v}" }.join(', ')} }"] if hash.present?
+        if models.empty?
+          query_service.orm_class.count_by_sql(([find_count_by_properties_query] + internal_array))
+        elsif hash.blank?
+          query_service.orm_class.count_by_sql([find_count_by_models_query] + [models])
+        else
+          query_service.orm_class.count_by_sql(([find_count_by_properties_and_models_query] + internal_array + [models]))
+        end
+      end
+
+      def find_count_by_properties_and_models_query
+        <<-SQL
+          SELECT count(*) FROM orm_resources
+          WHERE metadata @> ?
+          AND internal_resource IN (?);
+        SQL
+      end
+
+      def find_count_by_models_query
+        <<-SQL
+          SELECT count(*) FROM orm_resources
+          WHERE internal_resource IN (?);
+        SQL
+      end
+
+      def find_count_by_properties_query
+        <<-SQL
+          SELECT count(*) FROM orm_resources
+          WHERE metadata @> ?;
+        SQL
+      end
+    end
+  end
+end

data/app/services/hyrax/custom_queries/find_file_metadata.rb

@@ -67,7 +67,7 @@ module Hyrax
         return [] unless resource.try(:file_ids)
 
         results = find_many_file_metadata_by_ids(ids: resource.file_ids)
-        results.select { |fm| fm.type.include?(use) }
+        results.select { |fm| fm.pcdm_use.include?(use) }
       end
     end
   end

data/app/services/hyrax/custom_queries/find_models_by_access.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+module Hyrax
+  module CustomQueries
+    ##
+    # @see https://github.com/samvera/valkyrie/wiki/Queries#custom-queries
+    class FindModelsByAccess
+      def self.queries
+        [:find_models_by_access]
+      end
+
+      def initialize(query_service:)
+        @query_service = query_service
+      end
+
+      attr_reader :query_service
+      delegate :resource_factory, to: :query_service
+      delegate :orm_class, to: :resource_factory
+
+      ##
+      # @note this is an unoptimized default implementation of this custom
+      #   query. it's Hyrax's policy to provide such implementations of custom
+      #   queries in use for cross-compatibility of Valkyrie query services.
+      #   it's advisable to provide an optimized query for the specific adapter.
+      #
+      # @param model [Class]
+      # @param ids [Enumerable<#to_s>, Symbol]
+      #
+      def find_models_by_access(mode:, models: nil, agent:, group: nil)
+        agent = "group/#{agent}" if group.present?
+        internal_array = "{\"permissions\": [{\"mode\": \"#{mode}\", \"agent\": \"#{agent}\"}]}"
+        if models.present?
+          query_service.run_query(find_models_by_access_query, internal_array, models)
+        else
+          query_service.run_query(find_by_access_query, internal_array)
+        end
+      end
+
+      def find_models_by_access_query
+        <<-SQL
+          SELECT * FROM orm_resources
+          WHERE id IN (
+            SELECT uuid(metadata::json#>'{access_to,0}'->>'id') FROM orm_resources
+            WHERE metadata @> ?
+          ) AND internal_resource IN (?);
+        SQL
+      end
+
+      def find_by_access_query
+        <<-SQL
+          SELECT * FROM orm_resources
+          WHERE id IN (
+            SELECT uuid(metadata::json#>'{access_to,0}'->>'id') FROM orm_resources
+            WHERE metadata @> ?
+          );
+        SQL
+      end
+    end
+  end
+end

data/app/services/hyrax/derivative_bucketed_storage.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# this class overrides the Valkyrie::Storage::Disk::BucketStorage class so that file paths match
+module Hyrax
+  class DerivativeBucketedStorage
+    attr_reader :base_path
+
+    def initialize(base_path:)
+      @base_path = base_path
+    end
+
+    # rubocop:disable Lint/UnusedMethodArgument
+    def generate(resource:, file:, original_filename:)
+      raise ArgumentError, "original_filename must be provided" unless original_filename
+      Pathname.new(base_path).join(*bucketed_path(resource.id)).join(original_filename)
+    end
+    # rubocop:enable Lint/UnusedMethodArgument
+
+    def bucketed_path(id)
+      # We want to use the same code the derivative process uses so that items end up
+      # stored in the place we expect them.
+      Hyrax::DerivativePath.new(id.to_s).pair_directory
+    end
+  end
+end

data/app/services/hyrax/derivative_path.rb

@@ -35,6 +35,18 @@ module Hyrax
       end
     end
 
+    def pairs
+      @pairs ||= id.split('').each_slice(2).map(&:join)
+    end
+
+    def pair_directory
+      pairs[0..-2]
+    end
+
+    def pair_path
+      (pair_directory + pairs[-1..-1]).join('/')
+    end
+
     private
 
     # @return [String] Returns the root path where derivatives will be generated into.
@@ -47,10 +59,6 @@ module Hyrax
       Pathname.new(Hyrax.config.derivatives_path).join(pair_path)
     end
 
-    def pair_path
-      id.split('').each_slice(2).map(&:join).join('/')
-    end
-
     def file_name
       return unless destination_name
       destination_name + extension
@@ -60,6 +68,8 @@ module Hyrax
       case destination_name
       when 'thumbnail'
         ".#{MIME::Types.type_for('jpg').first.extensions.first}"
+      when 'extracted_text'
+        ".#{MIME::Types.type_for('txt').first.extensions.first}"
       else
         ".#{destination_name}"
       end