hyrax 5.1.0 → 5.3.0

data/app/models/concerns/hyrax/solr_document/ordered_members.rb

@@ -30,6 +30,10 @@ module Hyrax
         @ordered_member_ids ||= valkyrie? ? member_ids : query_for_ordered_ids
       end
 
+      def flexible?
+        respond_to?(:schema_version) && schema_version.present?
+      end
+
       private
 
       def query_for_ordered_ids(limit: 10_000,

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -12,6 +12,8 @@ module Hyrax
   #   end
   #
   # @see https://github.com/projectblacklight/blacklight/wiki/Understanding-Rails-and-Blacklight#models
+
+  # rubocop:disable Metrics/ModuleLength
   module SolrDocumentBehavior
     ModelWrapper = ActiveFedoraDummyModel # alias for backward compatibility
 
@@ -82,9 +84,15 @@ module Hyrax
 
     # Method to return the model
     def hydra_model(classifier: nil)
-      model = first('has_model_ssim')&.safe_constantize
-      model = (first('has_model_ssim')&.+ 'Resource')&.safe_constantize if Hyrax.config.valkyrie_transition?
-      model || model_classifier(classifier).classifier(self).best_model
+      valkyrie_model = Valkyrie.config.resource_class_resolver.call(hydra_model_name) if Hyrax.config.valkyrie_transition?
+
+      valkyrie_model ||
+        hydra_model_name&.safe_constantize ||
+        model_classifier(classifier).classifier(self).best_model
+    end
+
+    def hydra_model_name
+      @has_model ||= first('has_model_ssim')
     end
 
     def depositor(default = '')
@@ -146,10 +154,27 @@ module Hyrax
       JSON.parse(self['extensions_and_mime_types_ssm'].first).map(&:with_indifferent_access) if self['extensions_and_mime_types_ssm']
     end
 
+    def schema_version
+      self['schema_version_ssi']
+    end
+
+    def contexts
+      self['contexts_ssim']
+    end
+
+    def flexible?
+      schema_version.present?
+    end
+
+    def transcript_ids
+      self['transcript_ids_ssim']
+    end
+
     private
 
     def model_classifier(classifier)
       classifier || ActiveFedora.model_mapper
     end
   end
+  # rubocop:enable Metrics/ModuleLength
 end

data/app/models/concerns/hyrax/suppressible.rb

@@ -6,7 +6,7 @@ module Hyrax
 
     included do
       # This holds the workflow state
-      property :state, predicate: Vocab::FedoraResourceStatus.objState, multiple: false
+      property :state, predicate: Vocab::FedoraResourceStatus.objState, multiple: false if respond_to?(:property)
     end
 
     ##

data/app/models/concerns/hyrax/valkyrie_lazy_migration.rb

@@ -50,7 +50,7 @@ module Hyrax
     #     Hyrax::ValkyrieLazyMigration.migrating(self, from: MyWork)
     #   end
     def self.migrating(klass, from:, name_class: Hyrax::ValkyrieLazyMigration::ResourceName)
-      Wings::ModelRegistry.register(klass, from)
+      Wings::ModelRegistry.register(klass, from) if defined?(Wings::ModelRegistry)
       from.singleton_class.define_method(:migrating_from) { from }
       from.singleton_class.define_method(:migrating_to) { klass }
       klass.singleton_class.define_method(:migrating_from) { from }

data/app/models/concerns/hyrax/with_embargoes_and_leases.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module Hyrax
+  module WithEmbargoesAndLeases
+    extend ActiveSupport::Concern
+
+    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
+  end
+end

data/app/models/concerns/hyrax/work_behavior.rb

@@ -34,6 +34,10 @@ module Hyrax
       self.class.to_rdf_representation
     end
 
+    def flexible?
+      false
+    end
+
     module ClassMethods
       # This governs which partial to draw when you render this type of object
       def _to_partial_path # :nodoc:
@@ -43,6 +47,10 @@ module Hyrax
           "hyrax/#{collection}/#{element}"
         end
       end
+
+      def flexible?
+        false
+      end
     end
   end
 end

data/app/models/hyrax/administrative_set.rb

@@ -25,7 +25,7 @@ module Hyrax
   # @see Valkyrie query adapter's #find_inverse_references_by
   #
   class AdministrativeSet < Hyrax::Resource
-    include Hyrax::Schema(:core_metadata)
+    include Hyrax::Schema(:core_metadata) if Hyrax.config.admin_set_include_metadata?
 
     attribute :alternative_title, Valkyrie::Types::Set.of(Valkyrie::Types::String)
     attribute :creator,           Valkyrie::Types::Set.of(Valkyrie::Types::String)

data/app/models/hyrax/change_set.rb

@@ -13,7 +13,7 @@ module Hyrax
   # @example
   #   Hyrax::ChangeSet(Monograph)
   def self.ChangeSet(resource_class)
-    klass = (resource_class.to_s + "ChangeSet").safe_constantize || Hyrax::ChangeSet
+    klass = (resource_class.name + "ChangeSet").safe_constantize || Hyrax::ChangeSet
     Class.new(klass) do
       (resource_class.fields - resource_class.reserved_attributes).each do |field|
         property field, default: nil
@@ -29,6 +29,8 @@ module Hyrax
   end
 
   class ChangeSet < Valkyrie::ChangeSet
+    validates_with Hyrax::ControlledVocabularyValidator
+
     ##
     # @api public
     #

data/app/models/hyrax/embargo.rb

@@ -14,8 +14,10 @@ module Hyrax
     attribute :embargo_release_date,      Valkyrie::Types::DateTime
     attribute :embargo_history,           Valkyrie::Types::Array
 
+    # Fix releasing embargos on the day they are expired - this solves a 1 second bug around how
+    # midnights are calculated, which causes day of embargos to incorrectly set the permissions to private
     def active?
-      (embargo_release_date.present? && Hyrax::TimeService.time_in_utc < embargo_release_date)
+      (embargo_release_date.present? && Date.yesterday.end_of_day < embargo_release_date)
     end
   end
 end

data/app/models/hyrax/file_metadata.rb

@@ -44,16 +44,31 @@ module Hyrax
 
       # @return [Array<RDF::URI>] list of all uses
       def use_list
-        [ORIGINAL_FILE,
-         THUMBNAIL_IMAGE,
-         EXTRACTED_TEXT,
-         INTERMEDIATE_FILE,
-         PRESERVATION_FILE,
-         SERVICE_FILE,
-         TRANSCRIPT]
+        [
+          EXTRACTED_TEXT,
+          INTERMEDIATE_FILE,
+          ORIGINAL_FILE,
+          PRESERVATION_FILE,
+          SERVICE_FILE,
+          THUMBNAIL_IMAGE,
+          TRANSCRIPT
+        ]
       end
       module_function :use_list
 
+      def keys
+        [
+          :extracted_file,
+          :intermediate_file,
+          :original_file,
+          :preservation_file,
+          :service_file,
+          :thumbnail_file,
+          :transcript_file
+        ]
+      end
+      module_function :keys
+
       ##
       # @param use [RDF::URI, Symbol]
       #

data/app/models/hyrax/file_set.rb

@@ -49,8 +49,10 @@ module Hyrax
   # @see Hyrax::CustomQueries::Navigators::ParentWorkNavigator#find_parent_work
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
-    include Hyrax::Schema(:core_metadata)
-    include Hyrax::Schema(:file_set_metadata)
+    if Hyrax.config.file_set_include_metadata?
+      include Hyrax::Schema(:core_metadata)
+      include Hyrax::Schema(:file_set_metadata)
+    end
 
     def self.model_name(name_class: Hyrax::Name)
       @_model_name ||= name_class.new(self, nil, 'FileSet')

data/app/models/hyrax/flexible_schema.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+# rubocop:disable Metrics/ClassLength
+class Hyrax::FlexibleSchema < ApplicationRecord
+  serialize :profile, coder: YAML
+  serialize :contexts, coder: YAML
+
+  validate :validate_profile
+  validate :validate_property_name_conflicts
+
+  before_save :update_contexts
+
+  def warnings
+    @warnings ||= ActiveModel::Errors.new(self)
+  end
+
+  def self.current_version
+    order("created_at asc").last&.profile
+  end
+
+  def self.current_schema_id
+    order("created_at asc").last&.id
+  end
+
+  def self.create_default_schema
+    m3_profile_path = Hyrax::Schema.m3_schema_loader.config_paths&.first
+    raise ArgumentError, "No M3 profile found, check the Hyrax.config.schema_loader_config_search_paths" unless m3_profile_path
+    schema = Hyrax::FlexibleSchema.first
+    return if schema
+    schema = Hyrax::FlexibleSchema.new(profile: YAML.safe_load_file(m3_profile_path))
+    schema.save(validate: false)
+    schema
+  end
+
+  # Retrieve the properties for the model / work type
+  # This is a class method called by the model at class load
+  #   meaning AdminSet is not available and we cannot get the
+  #   contextual dynamic_schema
+  # Instead we use the default (contextless) dynamic_schema
+  #   which will add all properties available for that class
+  # @return [Array] property#to_sym
+  def self.default_properties
+    current_version['properties'].symbolize_keys!.keys
+  rescue StandardError
+    []
+  end
+
+  # Retrieve the required data to use for mappings
+  def self.mappings_data_for(mapping = 'simple_dc_pmh')
+    # for OAI-PMH we need the mappings and indexing info
+    # for properties with the specified mapping
+    return {} unless current_version
+    current_version['properties'].each_with_object({}) do |(key, values), obj|
+      next unless values['mappings'] && values['mappings'][mapping]
+      obj[key] = {
+        'indexing' => values['indexing'],
+        'mappings' => { mapping => values['mappings'][mapping] }
+      }
+    end
+  end
+
+  def update_contexts
+    self.contexts = profile['contexts']
+  end
+
+  def title
+    "#{profile['profile']['responsibility_statement']} - version #{id}"
+  end
+
+  def attributes_for(class_name)
+    class_names[class_name]
+  end
+
+  def schema_version
+    profile['m3_version']
+  end
+
+  def context_select
+    contexts&.map { |k, v| [v&.[]('display_label'), k] }
+  end
+
+  def metadata_profile_type
+    profile['profile']['type']
+  end
+
+  def version
+    id
+  end
+
+  def profile_created_at
+    created_at.strftime("%b %d, %Y")
+  end
+
+  private
+
+  def validate_profile
+    validation_service = Hyrax::FlexibleSchemaValidatorService.new(profile:)
+    validation_service.validate!
+
+    validation_service.errors.each do |e|
+      errors.add(:profile, e.to_s)
+    end
+
+    validation_service.warnings.each do |w|
+      warnings.add(:profile, "Warning: #{w.to_s}")
+    end
+  end
+
+  def validate_property_name_conflicts
+    return unless profile&.dig('properties')
+
+    # Group properties by their resolved name
+    properties_by_name = profile['properties'].each_with_object({}) do |(key, config), hash|
+      property_name = config['name'] || key
+      hash[property_name] ||= []
+      hash[property_name] << { key: key, config: config }
+    end
+
+    # Check for conflicts (same name with overlapping class/context)
+    properties_by_name.each do |property_name, properties|
+      next if properties.length == 1
+
+      # Check all pairs for conflicts
+      properties.combination(2).each do |prop1, prop2|
+        if properties_conflict?(prop1[:config], prop2[:config])
+          errors.add(:profile, "Property name '#{property_name}' conflicts between '#{prop1[:key]}' and '#{prop2[:key]}' - they have overlapping classes and contexts")
+        end
+      end
+    end
+  end
+
+  def properties_conflict?(config1, config2)
+    classes1 = Array(config1.dig('available_on', 'class'))
+    classes2 = Array(config2.dig('available_on', 'class'))
+
+    contexts1 = Array(config1.dig('available_on', 'context'))
+    contexts2 = Array(config2.dig('available_on', 'context'))
+
+    # If no contexts specified, consider as universal context
+    contexts1 = [nil] if contexts1.empty?
+    contexts2 = [nil] if contexts2.empty?
+
+    # Conflict if there's any overlap in both classes AND contexts
+    class_overlap = (classes1 & classes2).any?
+    context_overlap = !(contexts1 & contexts2).empty?
+
+    class_overlap && context_overlap
+  end
+
+  def class_names
+    return @class_names if @class_names
+    @class_names = {}
+    profile['classes'].keys.each do |class_name|
+      @class_names[class_name] = {}
+    end
+    profile['properties'].each do |key, values|
+      property_name = values['name'] || key
+      values['available_on']['class'].each do |property_class|
+        # map some m3 items to what Hyrax expects
+        values = values_map(values)
+        @class_names[property_class][property_name] = values
+      end
+    end
+    @class_names
+  end
+
+  def values_map(values)
+    values['type'] = lookup_type(values['range'])
+    values['predicate'] = values['property_uri']
+    values['index_keys'] = values['indexing']
+    values['context'] = values.dig('available_on', 'context')
+    values['multiple'] = determine_multiplicity(values)
+
+    normalize_form_attributes(values)
+
+    values
+  end
+
+  def determine_multiplicity(values)
+    return values['data_type'] == 'array' if values.key?('data_type')
+    return values['multi_value'] if values.key?('multi_value')
+
+    if (card = values['cardinality'])
+      max = card['maximum']
+      return max.nil? || max.to_i > 1
+    end
+
+    false
+  end
+
+  def normalize_form_attributes(values)
+    return unless values['form']
+
+    # Rename `multi_value` key to `multiple` (legacy support)
+    values['form']['multiple'] = values['form'].delete('multi_value') if values['form'].key?('multi_value')
+
+    values['form']['multiple'] = values['form'].delete('data_type') == 'array' if values['form'].key?('data_type')
+
+    assign_required_flag(values)
+  end
+
+  def assign_required_flag(values)
+    return unless (card = values['cardinality']) && card['minimum']
+
+    return if values['form'].key?('required')
+
+    required_flag = card['minimum'].to_i.positive?
+    values['form']['required'] = required_flag
+  end
+
+  def lookup_type(range)
+    case range
+    when "http://www.w3.org/2001/XMLSchema#dateTime"
+      'date_time'
+    else
+      range.split('#').last.underscore
+    end
+  end
+end
+# rubocop:enable Metrics/ClassLength

data/app/models/hyrax/lease.rb

@@ -14,8 +14,10 @@ module Hyrax
     attribute :lease_expiration_date,   Valkyrie::Types::DateTime
     attribute :lease_history,           Valkyrie::Types::Array
 
+    # Fix releasing leases on the day they are expired - this solves a 1 second bug around how
+    # midnights are calculated, which causes day of leases to incorrectly set the permissions to private
     def active?
-      (lease_expiration_date.present? && Hyrax::TimeService.time_in_utc < lease_expiration_date)
+      (lease_expiration_date.present? && Time.zone.today.end_of_day < lease_expiration_date)
     end
   end
 end

data/app/models/hyrax/pcdm_collection.rb

@@ -40,7 +40,10 @@ module Hyrax
   # @see Hyrax::CustomQueries::Navigators::CollectionMembers#find_members_of
   #
   class PcdmCollection < Hyrax::Resource
-    include Hyrax::Schema(:core_metadata)
+    include Hyrax::Schema(:core_metadata) if Hyrax.config.collection_include_metadata?
+    # See documentation/redirects.md for the redirects feature.
+    include Hyrax::Schema(:redirects) if Hyrax.config.collection_include_metadata? && Hyrax.config.redirects_enabled?
+    include Hyrax::RedirectsNormalization if Hyrax.config.redirects_enabled?
 
     attribute :collection_type_gid, Valkyrie::Types::String
     attribute :member_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)

data/app/models/hyrax/redirect.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Wraps a single redirect entry for use in form views, providing `.path`
+  # and `.is_display_url` readers over the underlying persisted hash.
+  #
+  # Redirects are persisted as plain hashes on the parent work or
+  # collection. Form-render code calls `Hyrax::Redirect.wrap(entry)` to
+  # get a value object the view can call methods on. Other code (the
+  # validator, indexer, sync step) reads the persisted hash directly.
+  #
+  # @example
+  #   Hyrax::Redirect.new(path: '/handle/12345/678', is_display_url: false)
+  #   Hyrax::Redirect.wrap('path' => '/foo', 'is_display_url' => true)
+  class Redirect
+    attr_reader :path, :is_display_url
+
+    ##
+    # Accept nil values so the view can build an empty trailing row.
+    def initialize(path: nil, is_display_url: false)
+      @path = path
+      @is_display_url = is_display_url
+    end
+
+    ##
+    # Build a presenter from a hash. If passed a presenter, returns it
+    # unchanged. Returns nil for nil input. Accepts string or symbol keys.
+    #
+    # @param input [Hyrax::Redirect, Hash, nil]
+    # @return [Hyrax::Redirect, nil]
+    def self.wrap(input)
+      return nil if input.nil?
+      return input if input.is_a?(Hyrax::Redirect)
+      raise ArgumentError, "cannot wrap #{input.class} as Hyrax::Redirect" unless input.respond_to?(:to_h)
+
+      h = input.to_h.transform_keys(&:to_s)
+      new(path: h['path'], is_display_url: h.fetch('is_display_url', false))
+    end
+
+    ##
+    # @return [Hash{String => Object}] string-keyed hash matching the persisted shape.
+    def to_h
+      { 'path' => path, 'is_display_url' => is_display_url }
+    end
+
+    def as_json(*)
+      to_h
+    end
+
+    ##
+    # Equality on attribute values, so `Array#uniq` works as expected.
+    def ==(other)
+      other.is_a?(Hyrax::Redirect) &&
+        other.path == path &&
+        other.is_display_url == is_display_url
+    end
+    alias eql? ==
+
+    def hash
+      [path, is_display_url].hash
+    end
+  end
+end

data/app/models/hyrax/redirect_path.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # ActiveRecord-backed redirects table for global path uniqueness.
+  #
+  # Maintained by Hyrax::Transactions::Steps::SyncRedirectPaths and
+  # Hyrax::Transactions::Steps::RemoveRedirectPaths; queried by
+  # Hyrax::RedirectsLookup. The unique index on `from_path` is the source
+  # of truth for "no two records share a redirect alias"; this class just
+  # exposes it.
+  class RedirectPath < ActiveRecord::Base
+    self.table_name = 'hyrax_redirect_paths'
+  end
+end

data/app/models/hyrax/resource.rb

@@ -30,9 +30,11 @@ module Hyrax
   #   `Hyrax::VisibilityWriter` (which provide their underlying
   #   implementations).
   #
-  class Resource < Valkyrie::Resource
+  class Resource < Valkyrie::Resource # disable:rubocop Metrics/ClassLength
     include Hyrax::Naming
     include Hyrax::WithEvents
+    include Hyrax::WithEmbargoesAndLeases
+    include Hyrax::Suppressible
 
     attribute :alternate_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID)
     attribute :embargo_id,    Valkyrie::Types::Params::ID
@@ -44,6 +46,21 @@ module Hyrax
              :read_users,  :read_users=, to: :permission_manager
 
     class << self
+      def inherited(subclass)
+        super
+        subclass.acts_as_flexible_resource if Hyrax.config.flexible_classes.include?(subclass.name)
+      end
+
+      def acts_as_flexible_resource
+        include Hyrax::Flexibility
+        include Hyrax::Schema(name, schema_loader: Hyrax::Schema.m3_schema_loader)
+        Hyrax.config.flexible_classes << name unless Hyrax.config.flexible_classes.include?(name)
+      end
+
+      def flexible?
+        defined?(super) ? super : false
+      end
+
       ##
       # @return [String] a human readable name for the model
       def human_readable_type
@@ -105,6 +122,10 @@ module Hyrax
       end
     end
 
+    def flexible?
+      self.class.flexible?
+    end
+
     ##
     # @return [Boolean]
     def collection?
@@ -170,30 +191,6 @@ 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/riiif/file.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+if defined?(::Riiif::File)
+  module Hyrax
+    module Riiif
+      class File < ::Riiif::File
+        include ActiveSupport::Benchmarkable
+
+        attr_reader :id
+
+        def initialize(input_path, tempfile = nil, id:)
+          super(input_path, tempfile)
+          raise(ArgumentError, "must specify id") if id.blank?
+          @id = id
+        end
+
+        # Wrap extract in a read lock and benchmark it
+        def extract(transformation, image_info = nil)
+          ::Riiif::Image.file_resolver.file_locks[id].with_read_lock do
+            benchmark "Hyrax::Riiif::File extracted #{path} with #{transformation.to_params}", level: :debug do
+              super
+            end
+          end
+        end
+
+        private
+
+        def logger
+          Hyrax.logger
+        end
+      end
+    end
+  end
+else
+  module Hyrax
+    module Riiif
+      class File
+        def initialize(*)
+          raise 'Riiif not available'
+        end
+      end
+    end
+  end
+end