hyrax 2.9.6 → 3.0.0.pre.beta1

data/.regen

@@ -1 +0,0 @@
-3.http_method

data/app/assets/javascripts/hyrax/skip_to_content.js

@@ -1,15 +0,0 @@
-// This code is to implement skip_to_content
-
-Blacklight.onLoad(function () {
-  $(".skip-to-content").click(function(event) {
-    event.preventDefault();
-    // element to focus on
-    var skipTo = '#' + $(this)[0].firstElementChild.hash.split('#')[1];
-
-    // Setting 'tabindex' to -1 takes an element out of normal
-    // tab flow but allows it to be focused via javascript
-    $(skipTo).attr('tabindex', -1).on('blur focusout', function () {
-      $(this).removeAttr('tabindex');
-    }).focus();
-  });
-});

data/app/helpers/hyrax/work_form_helper.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module WorkFormHelper
-    ##
-    # This helper allows downstream applications and engines to add/remove/reorder the tabs to be
-    # rendered on the work form.
-    #
-    # @example with additional tabs
-    #  Override this helper and ensure that it loads after Hyrax's helpers.
-    #  module WorksHelper
-    #    def form_tabs_for(form:)
-    #      super + ["my_new_tab"]
-    #    end
-    #  end
-    #  Add the new section partial at app/views/hyrax/base/_form_my_new_tab.html.erb
-    #
-    # @todo The share tab isn't included because it wasn't in guts4form.  guts4form should be
-    #   cleaned up so share is treated the same as other tabs and can be included below.
-    # @param form [Hyrax::Forms::WorkForm]
-    # @return [Array<String>] the list of names of tabs to be rendered in the form
-    def form_tabs_for(form:)
-      if form.instance_of? Hyrax::Forms::BatchUploadForm
-        %w[files metadata relationships]
-      else
-        %w[metadata files relationships]
-      end
-    end
-
-    ##
-    # This helper allows downstream applications and engines to add additional sections to be
-    # rendered after the visibility section in the Save Work panel on the work form.
-    #
-    # @example with additional sections
-    #  Override this helper and ensure that it loads after Hyrax's helpers.
-    #  module WorksHelper
-    #    def form_progress_sections_for(*)
-    #      super + ["my_new_section"]
-    #    end
-    #  end
-    #  Add the new section partial at app/views/hyrax/base/_form_progress_my_new_section.html.erb
-    #
-    # @param form [Hyrax::Forms::WorkForm]
-    # @return [Array<String>] the list of names of sections to be rendered in the form_progress panel
-    def form_progress_sections_for(*)
-      []
-    end
-  end
-end

data/app/jobs/embargo_expiry_job.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-class EmbargoExpiryJob < Hyrax::ApplicationJob
-  def perform
-    records_with_expired_embargos.each do |id|
-      work = ActiveFedora::Base.find(id)
-      Hyrax::Actors::EmbargoActor.new(work).destroy
-    end
-  end
-
-  ##
-  # @return [Enumerator<String>] ids for all the objects that have expired active embargoes
-  def records_with_expired_embargos
-    Hyrax::EmbargoService.assets_with_expired_embargoes.map(&:id)
-  end
-end

data/app/jobs/iiif_manifest_cache_prewarm_job.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-class IiifManifestCachePrewarmJob < Hyrax::ApplicationJob
-  ##
-  # @param work [ActiveFedora::Base]
-  def perform(work)
-    presenter = Hyrax::IiifManifestPresenter.new(work)
-    manifest_builder.manifest_for(presenter: presenter)
-  end
-
-  private
-
-    def manifest_builder
-      Hyrax::CachingIiifManifestBuilder.new
-    end
-end

data/app/jobs/lease_expiry_job.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-class LeaseExpiryJob < Hyrax::ApplicationJob
-  def perform
-    records_with_expired_leases.each do |id|
-      work = ActiveFedora::Base.find(id)
-      Hyrax::Actors::LeaseActor.new(work).destroy
-    end
-  end
-
-  ##
-  # @return [Enumerator<String>] ids for all the objects that have expired active leases
-  def records_with_expired_leases
-    Hyrax::LeaseService.assets_with_expired_leases.map(&:id)
-  end
-end

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module SolrDocument
-    ##
-    # Decorates an object responding to `#id` with an `#ordered_member_ids` method.
-    #
-    # @note this decorator is intended for use with data representations other
-    #   than the core model objects, as an alternative to a direct query of the
-    #   canonical database. for example, it can be used with `SolrDocument` to
-    #   quickly retrieve member order in a way that is compatible with the
-    #   fast access required in Blacklight's search contexts.
-    #
-    # @example
-    #   base_document = SolrDocument.new(my_work.to_solr)
-    #   solr_document = Hyrax::SolrDocument::OrderedMembers.decorate(base_document)
-    #
-    #   solr_document.ordered_member_ids # => ['abc', '123']
-    #
-    class OrderedMembers < Draper::Decorator
-      delegate_all
-
-      ##
-      # @note the purpose of this method is to provide fast access to member
-      #   order. currently this is achieved by accessing indexed list proxies
-      #   from Solr. however, this strategy may change in the future.
-      #
-      # @return [Enumerable<String>] ids in the order of their membership,
-      #   only includes ids of ordered members.
-      def ordered_member_ids
-        return [] if id.blank?
-        @ordered_member_ids ||= query_for_ordered_ids
-      end
-
-      private
-
-        def query_for_ordered_ids(limit: 10_000,
-                                  proxy_field: 'proxy_in_ssi',
-                                  target_field: 'ordered_targets_ssim')
-          ActiveFedora::SolrService
-            .query("#{proxy_field}:#{id}", rows: limit, fl: target_field)
-            .flat_map { |x| x.fetch(target_field, nil) }
-            .compact
-        end
-    end
-  end
-end

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -1,232 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  ##
-  # This presenter wraps objects in the interface required by `IIIFManifiest`.
-  # It will accept either a Work-like resource or a SolrDocument.
-  #
-  # @example with a work
-  #
-  #   monograph = Monograph.new
-  #   presenter = IiifManifestPresenter.new(monograph)
-  #   presenter.title # => []
-  #
-  #   monograph.title = ['Comet in Moominland']
-  #   presenter.title # => ['Comet in Moominland']
-  #
-  # @see https://www.rubydoc.info/gems/iiif_manifest
-  class IiifManifestPresenter < Draper::Decorator
-    delegate_all
-
-    ##
-    # @!attribute [w] ability
-    #   @return [Ability]
-    # @!attribute [w] hostname
-    #   @return [String]
-    attr_writer :ability, :hostname
-
-    class << self
-      ##
-      # @param [Hyrax::Resource, SolrDocument]
-      def for(model)
-        klass = model.file_set? ? DisplayImagePresenter : IiifManifestPresenter
-
-        klass.new(model)
-      end
-    end
-
-    ##
-    # @return [#can?]
-    def ability
-      @ability ||= NullAbility.new
-    end
-
-    ##
-    # @return [String]
-    def description
-      Array(super).first || ''
-    end
-
-    ##
-    # @return [Boolean]
-    def file_set?
-      model.try(:file_set?) || Array(model[:has_model_ssim]).include?('FileSet')
-    end
-
-    ##
-    # @return [Array<DisplayImagePresenter>]
-    def file_set_presenters
-      member_presenters.select(&:file_set?)
-    end
-
-    ##
-    # IIIF metadata for inclusion in the manifest
-    #  Called by the `iiif_manifest` gem to add metadata
-    #
-    # @todo should this use the simple_form i18n keys?! maybe the manifest
-    #   needs its own?
-    #
-    # @return [Array<Hash{String => String}>] array of metadata hashes
-    def manifest_metadata
-      metadata_fields.map do |field_name|
-        {
-          'label' => I18n.t("simple_form.labels.defaults.#{field_name}"),
-          'value' => Array(self[field_name]).map { |value| scrub(value.to_s) }
-        }
-      end
-    end
-
-    ##
-    # @return [String] the URL where the manifest can be found
-    def manifest_url
-      return '' if id.blank?
-
-      Rails.application.routes.url_helpers.polymorphic_url([:manifest, model], host: hostname)
-    end
-
-    ##
-    # @return [Array<#to_s>]
-    def member_ids
-      Hyrax::SolrDocument::OrderedMembers.decorate(model).ordered_member_ids
-    end
-
-    ##
-    # @note cache member presenters to avoid querying repeatedly; we expect this
-    #   presenter to live only as long as the request.
-    #
-    # @note skips presenters for objects the current `@ability` cannot read.
-    #   the default ability has all permissions.
-    #
-    # @return [Array<IiifManifestPresenter>]
-    def member_presenters
-      @member_presenters_cache ||= Factory.build_for(ids: member_ids, presenter_class: self.class).map do |presenter|
-        next unless ability.can?(:read, presenter.model)
-
-        presenter.hostname = hostname
-        presenter.ability  = ability
-        presenter
-      end.compact
-    end
-
-    ##
-    # @return [Array<Hash{String => String}>]
-    def sequence_rendering
-      Array(try(:rendering_ids)).map do |file_set_id|
-        rendering = file_set_presenters.find { |p| p.id == file_set_id }
-        next unless rendering
-
-        { '@id' => Hyrax::Engine.routes.url_helpers.download_url(rendering.id, host: hostname),
-          'format' => rendering.mime_type.present? ? rendering.mime_type : I18n.t("hyrax.manifest.unknown_mime_text"),
-          'label' => I18n.t("hyrax.manifest.download_text") + (rendering.label || '') }
-      end.flatten
-    end
-
-    ##
-    # @return [Boolean]
-    def work?
-      object.try(:work?) || !file_set?
-    end
-
-    ##
-    # @return [Array<IiifManifestPresenter>]
-    def work_presenters
-      member_presenters.select(&:work?)
-    end
-
-    ##
-    # @note ideally, this value will be cheap to retrieve, and will reliably
-    #   change any time the manifest JSON will change. the current implementation
-    #   is more blunt than this, changing only when the work itself changes.
-    #
-    # @return [String] a string tag suitable for cache keys for this manifiest
-    def version
-      object.try(:modified_date)&.to_s || ''
-    end
-
-    ##
-    # An Ability-like object that gives `true` for all `can?` requests
-    class NullAbility
-      ##
-      # @return [Boolean] true
-      def can?(*)
-        true
-      end
-    end
-
-    class Factory < PresenterFactory
-      ##
-      # @return [Array]
-      def build
-        ids.map do |id|
-          solr_doc = load_docs.find { |doc| doc.id == id }
-          presenter_class.for(solr_doc) if solr_doc
-        end.compact
-      end
-
-      private
-
-        ##
-        # cache the docs in this method, rather than #build;
-        # this can probably be pushed up to the parent class
-        def load_docs
-          @cached_docs ||= super
-        end
-    end
-
-    ##
-    # a Presenter for producing `IIIFManifest::DisplayImage` objects
-    #
-    class DisplayImagePresenter < Draper::Decorator
-      delegate_all
-
-      include Hyrax::DisplaysImage
-
-      ##
-      # @!attribute [w] ability
-      #   @return [Ability]
-      # @!attribute [w] hostname
-      #   @return [String]
-      attr_writer :ability, :hostname
-
-      ##
-      # Creates a display image only where #model is an image.
-      #
-      # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
-      def display_image
-        return nil unless model.image?
-        return nil unless latest_file_id
-
-        IIIFManifest::DisplayImage
-          .new(display_image_url(hostname),
-               format: image_format(alpha_channels),
-               width: width,
-               height: height,
-               iiif_endpoint: iiif_endpoint(latest_file_id, base_url: hostname))
-      end
-
-      def hostname
-        @hostname || 'localhost'
-      end
-
-      ##
-      # @return [Boolean] false
-      def work?
-        false
-      end
-    end
-
-    private
-
-      def hostname
-        @hostname || 'localhost'
-      end
-
-      def metadata_fields
-        Hyrax.config.iiif_metadata_fields
-      end
-
-      def scrub(value)
-        Loofah.fragment(value).scrub!(:whitewash).to_s
-      end
-  end
-end

data/app/services/hyrax/caching_iiif_manifest_builder.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  ##
-  # constructs IIIF Manifests and holds them in the Rails cache,
-  # this approach avoids long manifest build times for some kinds of requests,
-  # at the cost of introducing cache invalidation issues.
-  class CachingIiifManifestBuilder < ManifestBuilderService
-    KEY_PREFIX = 'iiif-cache-v1'
-
-    attr_accessor :expires_in
-
-    ##
-    # @api public
-    #
-    # @param iiif_manifest_factory [Class] a class that initializes with presenter
-    #        object and returns an object that responds to `#to_h`
-    # @param expires_in [Integer] the number of seconds until the cache expires
-    # @see Hyrax::Configuration#iiif_manifest_cache_duration
-    def initialize(iiif_manifest_factory: ::IIIFManifest::ManifestFactory, expires_in: Hyrax.config.iiif_manifest_cache_duration)
-      self.expires_in = expires_in
-
-      super(iiif_manifest_factory: iiif_manifest_factory)
-    end
-
-    ##
-    # @see ManifestBuilderService#as_json
-    def manifest_for(presenter:)
-      Rails.cache.fetch(manifest_cache_key(presenter: presenter), expires_in: expires_in) do
-        super
-      end
-    end
-
-    private
-
-      ##
-      # @note adding a version_for suffix helps us manage cache expiration,
-      #   reducing false cache hits
-      #
-      # @param presenter [Hyrax::IiifManifestPresenter]
-      #
-      # @return [String]
-      def manifest_cache_key(presenter:)
-        "#{KEY_PREFIX}_#{presenter.id}/#{version_for(presenter)}"
-      end
-
-      ##
-      # @return [String]
-      def version_for(presenter)
-        presenter.version
-      end
-  end
-end

data/app/services/hyrax/collection_size_service.rb

@@ -1,52 +0,0 @@
-# returns a list of solr documents for collections the item is a part of
-module Hyrax
-  ##
-  # @deprecated This class is broken for base Hyrax applications. Current users
-  #   should call with extreme caution and consider a local implementation as
-  #   an alternative.
-  # @see https://github.com/samvera/hyrax/issues/2801
-  class CollectionSizeService
-    include Blacklight::Configurable
-    include Blacklight::SearchHelper
-
-    attr_reader :collection
-
-    copy_blacklight_config_from(CatalogController)
-
-    def self.run(collection)
-      new(collection).collection_size
-    end
-
-    def initialize(collection)
-      Deprecation
-        .warn(self, 'CollectionSizeService has been deprecated for removal in ' \
-                    'Hyrax 3.0. This class is broken for base Hyrax ' \
-                    'applications. Current users should call with extreme ' \
-                    'caution and consider a local implementation as an ' \
-                    'alternative.')
-
-      @collection = collection
-    end
-
-    def collection_size
-      query = collection_search_builder.with('id' => collection.id).rows(max_collection_size).merge(fl: [size_field])
-      resp = repository.search(query)
-      field_name = size_field
-      resp.documents.reduce(0) do |total, doc|
-        total + (doc[field_name].blank? ? 0 : doc[field_name][0].to_f)
-      end
-    end
-
-    def collection_search_builder
-      @collection_search_builder ||= MemberWithFilesSearchBuilder.new([:include_contained_files, :add_paging_to_solr], self)
-    end
-
-    def size_field
-      Solrizer.solr_name(:file_size, :symbol)
-    end
-
-    def max_collection_size
-      1000
-    end
-  end
-end

data/app/services/hyrax/identifier/builder.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Identifier
-    ##
-    # Builds an identifier string.
-    #
-    # Implementations must accept a `prefix:` to `#initialize`, and a `hint:` to
-    # `#build`. Either or both may be used at the preference of the specific
-    # implementer or ignored entirely when `#build` is called.
-    #
-    # @example
-    #   builder = Hyrax::Identifier::Builder.new(prefix: 'moomin')
-    #   builder.build(hint: '1') # => "moomin/1"
-    class Builder
-      ##
-      # @!attribute prefix [rw]
-      #   @return [String] the prefix to use when building identifiers
-      attr_accessor :prefix
-
-      ##
-      # @param prefix [String] the prefix to use when building identifiers
-      def initialize(prefix: 'pfx')
-        @prefix = prefix
-      end
-
-      ##
-      # @note this default builder requires a `hint` which it appends to the
-      #   prefix to generate the identifier string.
-      #
-      # @param hint [#to_s] a string-able object which may be used by the builder
-      #   to generate an identifier. Hints may be required by some builders, while
-      #   others may ignore them to generate an identifier by other means.
-      #
-      # @return [String]
-      # @raise [ArgumentError] if an identifer can't be built from the provided
-      #   hint.
-      def build(hint: nil)
-        raise(ArgumentError, "No hint provided to #{self.class}#build") if
-          hint.nil?
-
-        "#{prefix}/#{hint}"
-      end
-    end
-  end
-end

data/app/services/hyrax/identifier/dispatcher.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Identifier
-    class Dispatcher
-      ##
-      # @!attribute [rw] registrar
-      #   @return [Hyrax::Identifier::Registrar]
-      attr_accessor :registrar
-
-      ##
-      # @param registrar [Hyrax::Identifier::Registrar]
-      def initialize(registrar:)
-        @registrar = registrar
-      end
-
-      class << self
-        ##
-        # @param type           [Symbol]
-        # @param registrar_opts [Hash]
-        # @option registrar_opts [Hyrax::Identifier::Builder] :builder
-        #
-        # @return [Hyrax::Identifier::Dispatcher] a dispatcher with an registrar for the
-        #   given type
-        # @see IdentifierRegistrar.for
-        def for(type, **registrar_opts)
-          new(registrar: Hyrax::Identifier::Registrar.for(type, **registrar_opts))
-        end
-      end
-
-      ##
-      # Assigns an identifier to the object.
-      #
-      # This involves two steps:
-      #   - Registering the identifier with the registrar service via `registrar`.
-      #   - Storing the new identifier on the object, in the provided `attribute`.
-      #
-      # @note the attribute for identifier storage must be multi-valued, and will
-      #  be overwritten during assignment.
-      #
-      # @param attribute [Symbol] the attribute in which to store the identifier.
-      #   This attribute will be overwritten during assignment.
-      # @param object    [ActiveFedora::Base, Hyrax::Resource] the object to assign an identifier.
-      #
-      # @return [ActiveFedora::Base, Hyrax::Resource] object
-      def assign_for(object:, attribute: :identifier)
-        record = registrar.register!(object: object)
-        object.public_send("#{attribute}=".to_sym, [record.identifier])
-        object
-      end
-
-      ##
-      # Assigns an identifier and saves the object.
-      #
-      # @see #assign_for
-      def assign_for!(object:, attribute: :identifier)
-        assign_for(object: object, attribute: attribute).save!
-        object
-      end
-    end
-  end
-end

data/app/services/hyrax/identifier/registrar.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-module Hyrax
-  module Identifier
-    class Registrar
-      class << self
-        ##
-        # @param type [Symbol]
-        # @param opts [Hash]
-        # @option opts [Hyrax::Identifier::Builder] :builder
-        #
-        # @return [Hyrax::Identifier::Registrar] a registrar for the given type
-        def for(type, **opts)
-          return Hyrax.config.identifier_registrars[type].new(**opts) if Hyrax.config.identifier_registrars.include?(type)
-          raise ArgumentError, "Hyrax::Identifier::Registrar not found to handle #{type}"
-        end
-      end
-
-      ##
-      # @!attribute builder [rw]
-      #   @return [Hyrax::Identifier::Builder]
-      attr_accessor :builder
-
-      ##
-      # @param builder [Hyrax::Identifier::Builder]
-      def initialize(builder:)
-        @builder = builder
-      end
-
-      ##
-      # @abstract
-      #
-      # @param object [#id]
-      #
-      # @return [#identifier]
-      # @raise [NotImplementedError] when the method is abstract
-      def register!(*)
-        raise NotImplementedError
-      end
-    end
-  end
-end