hyrax 2.9.5 → 3.0.0.pre.beta1

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

data/app/services/hyrax/manifest_builder_service.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module Hyrax
-  ##
-  # A class responsible for converting a Hyrax::Work like thing into a IIIF
-  # manifest.
-  #
-  # @see !{.as_json}
-  class ManifestBuilderService
-    ##
-    # @api public
-    #
-    # @param presenter [Hyrax::WorkShowPresenter] the work presenter from which
-    #        we'll build a manifest.
-    # @param iiif_manifest_factory [Class] a class that initializes with presenter
-    #        object and returns an object that responds to `#to_h`
-    #
-    # @note While the :presenter may be a Hyrax::WorkShowPresenter it is likely
-    #       defined by Hyrax::WorksControllerBehavior.show_presenter
-    #
-    # @return [Hash] a Ruby hash representation of a IIIF manifest document
-    #
-    # @see Hyrax::WorksControllerBehavior
-    def self.manifest_for(presenter:, iiif_manifest_factory: ::IIIFManifest::ManifestFactory)
-      new(iiif_manifest_factory: iiif_manifest_factory)
-        .manifest_for(presenter: presenter)
-    end
-
-    ##
-    # @!attribute [r] manifest_factory
-    #   @return [#to_h]
-    attr_reader :manifest_factory
-
-    ##
-    # @api public
-    #
-    # @param iiif_manifest_factory [Class] a class that initializes with presenter
-    #        object and returns an object that responds to `#to_h`
-    def initialize(iiif_manifest_factory: ::IIIFManifest::ManifestFactory)
-      @manifest_factory = iiif_manifest_factory
-    end
-
-    ##
-    # @api public
-    #
-    # @param presenter [Hyrax::WorkShowPresenter]
-    #
-    # @return [Hash] a Ruby hash representation of a IIIF manifest document
-    def manifest_for(presenter:)
-      sanitized_manifest(presenter: presenter)
-    end
-
-    private
-
-      ##
-      # @api private
-      # @param presenter [Hyrax::WorkShowPresenter]
-      def sanitized_manifest(presenter:)
-        # ::IIIFManifest::ManifestBuilder#to_h returns a
-        # IIIFManifest::ManifestBuilder::IIIFManifest, not a Hash.
-        # to get a Hash, we have to call its #to_json, then parse.
-        #
-        # wild times. maybe there's a better way to do this with the
-        # ManifestFactory interface?
-        manifest = manifest_factory.new(presenter).to_h
-        hash = JSON.parse(manifest.to_json)
-
-        hash['label'] = sanitize_value(hash['label']) if hash.key?('label')
-        hash['description'] = Array(hash['description'])&.collect { |elem| sanitize_value(elem) } if hash.key?('description')
-
-        hash['sequences']&.each do |sequence|
-          sequence['canvases']&.each do |canvas|
-            canvas['label'] = sanitize_value(canvas['label'])
-          end
-        end
-
-        hash
-      end
-
-      ##
-      # @api private
-      # @param [#to_s] text
-      # @return [String] a sanitized verison of `text`
-      def sanitize_value(text)
-        Loofah.fragment(text.to_s).scrub!(:prune).to_s
-      end
-  end
-end

data/lib/hyrax/specs/shared_specs/identifiers.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_examples 'a Hyrax::Identifier::Builder' do
-  subject(:builder) { described_class.new }
-
-  describe '#build' do
-    it 'returns an identifier string' do
-      expect(builder.build(hint: 'moomin'))
-        .to respond_to :to_str
-    end
-  end
-end
-
-RSpec.shared_examples 'a Hyrax::Identifier::Registrar' do
-  subject(:registrar) { described_class.new(builder: builder) }
-  let(:builder)       { instance_double(Hyrax::Identifier::Builder, build: 'moomin') }
-  let(:object)        { instance_double(GenericWork, id: 'moomin_id') }
-
-  it { is_expected.to have_attributes(builder: builder) }
-
-  describe '#register!' do
-    it 'creates an identifier record' do
-      expect(registrar.register!(object: object).identifier)
-        .to respond_to :to_str
-    end
-  end
-end