hyrax 4.0.0.beta2 → 4.0.0.rc1

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

@@ -52,25 +52,6 @@ module Hyrax
       self.collection_type_gid = new_collection_type.to_global_id
     end
 
-    # Add members using the members association.
-    def add_members(new_member_ids)
-      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
-      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
-                                                                     new_member_ids: new_member_ids,
-                                                                     user: nil)
-    end
-
-    # Add member objects by adding this collection to the objects' member_of_collection association.
-    # @param [Enumerable<String>] the ids of the new child collections and works collection ids
-    def add_member_objects(new_member_ids)
-      Deprecation.warn("'##{__method__}' will be removed in Hyrax 4.0.  " \
-                         "Instead, use Hyrax::Collections::CollectionMemberService.add_members_by_ids.")
-      Hyrax::Collections::CollectionMemberService.add_members_by_ids(collection_id: id,
-                                                                     new_member_ids: new_member_ids,
-                                                                     user: nil)
-    end
-
     # @return [Enumerable<ActiveFedora::Base>] an enumerable over the children of this collection
     def member_objects
       ActiveFedora::Base.where("member_of_collection_ids_ssim:#{id}")
@@ -96,22 +77,6 @@ module Hyrax
           "hyrax/#{collection}/#{element}"
         end
       end
-
-      def collection_type_gid_document_field_name
-        Deprecation.warn('use Hyrax.config.collection_type_index_field instead')
-        Hyrax.config.collection_type_index_field
-      end
-    end
-
-    # @deprecated to be removed in 4.0.0; this feature was replaced with a
-    #   hard-coded null implementation
-    # @return [Fixnum] 0
-    def bytes
-      Deprecation.warn('#bytes has been deprecated for removal in Hyrax 4.0.0; ' \
-                       'The implementation of the indexed Collection size ' \
-                       'feature is extremely inefficient, so it has been removed. ' \
-                       'This method now returns a hard-coded `0` for compatibility.')
-      0
     end
 
     # @api public
@@ -122,18 +87,6 @@ module Hyrax
       Hyrax::PermissionTemplate.find_by!(source_id: id)
     end
 
-    ##
-    # @deprecated use PermissionTemplate#reset_access_controls_for instead
-    #
-    # Calculate and update who should have read/edit access to the collections based on who
-    # has access in PermissionTemplateAccess
-    def reset_access_controls!
-      Deprecation.warn("reset_access_controls! is deprecated; use PermissionTemplate#reset_access_controls_for instead.")
-
-      permission_template
-        .reset_access_controls_for(collection: self, interpret_visibility: true)
-    end
-
     private
 
     # Solr field name works use to index member ids

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

@@ -69,6 +69,7 @@ module Hyrax
         attribute :date_created, Solr::Array, "date_created_tesim"
         attribute :rights_statement, Solr::Array, "rights_statement_tesim"
         attribute :rights_notes, Solr::Array, "rights_notes_tesim"
+        attribute :bibliographic_citation, Solr::Array, "bibliographic_citation_tesim"
         attribute :access_right, Solr::Array, "access_right_tesim"
         attribute :mime_type, Solr::String, "mime_type_ssi"
         attribute :workflow_state, Solr::String, "workflow_state_name_ssim"

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

@@ -22,13 +22,5 @@ module Hyrax
     def suppressed?
       Hyrax::ResourceStatus.new(resource: self).inactive?
     end
-
-    ##
-    # @deprecated Use `Sipity::Entity(entity)` instead.
-    def to_sipity_entity
-      Deprecation.warn "Use `Sipity::Entity(entity)` instead."
-      raise "Can't create an entity until the model has been persisted" unless persisted?
-      @sipity_entity ||= Sipity::Entity(to_global_id)
-    end
   end
 end

data/app/models/file_download_stat.rb

@@ -12,10 +12,10 @@ class FileDownloadStat < Hyrax::Statistic
         Hyrax.logger.error("Google Analytics profile has not been established. Unable to fetch statistics.")
         return []
       end
-      profile.hyrax__analytics__google__download(sort: 'date',
-                                                 start_date: start_date,
-                                                 end_date: Date.yesterday,
-                                                 limit: 10_000)
+      profile.hyrax__download(sort: 'date',
+                              start_date: start_date,
+                              end_date: Date.yesterday,
+                              limit: 10_000)
              .for_file(file.id)
     end
 

data/app/models/hyrax/collection_type.rb

@@ -36,14 +36,6 @@ module Hyrax
       assign_machine_id
     end
 
-    # this class attribute is deprecated in favor of {.settings_attributes}
-    # these need to carefully align with boolean flag attributes/table columns,
-    # so making it settable is a liability. deprecating is challenging because
-    # +class_attribute+ calls +singleton_class.class_eval { redefine_method }+
-    # as the +name=+ implementation. there should be few callers outside hyrax.
-    class_attribute :collection_type_settings_methods, instance_writer: false
-    self.collection_type_settings_methods = SETTINGS_ATTRIBUTES
-
     # These are provided as a convenience method based on prior design discussions.
     alias_attribute :discovery, :discoverable
     alias_attribute :sharing, :sharable
@@ -123,14 +115,6 @@ module Hyrax
       ActiveFedora::Base.where(Hyrax.config.collection_type_index_field.to_sym => to_global_id.to_s)
     end
 
-    ##
-    # @deprecated Use #collections.any? instead
-    #
-    # @return [Boolean] True if there is at least one collection of this type
-    def collections?
-      Deprecation.warn('Use #collections.any? instead.') && collections.any?
-    end
-
     # @return [Boolean] True if this is the Admin Set type
     def admin_set?
       machine_id == ADMIN_SET_MACHINE_ID

data/app/models/hyrax/file_metadata.rb

@@ -13,11 +13,13 @@ module Hyrax
       file.is_a?(Valkyrie::Resource)
 
     Hyrax.custom_queries.find_file_metadata_by(id: file.id)
-  rescue Hyrax::ObjectNotFoundError, Ldp::BadRequest
+  rescue Hyrax::ObjectNotFoundError, Ldp::BadRequest, Valkyrie::Persistence::ObjectNotFoundError
     Hyrax.logger.debug('Could not find an existing metadata node for file ' \
                        "with id #{file.id}. Initializing a new one")
 
-    FileMetadata.new(file_identifier: file.id, alternative_ids: [file.id])
+    FileMetadata.new(file_identifier: file.id,
+                     alternative_ids: [file.id],
+                     original_filename: File.basename(file.io))
   end
 
   class FileMetadata < Valkyrie::Resource
@@ -65,7 +67,7 @@ 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)
+    attribute :type, ::Valkyrie::Types::Set.default([Use::ORIGINAL_FILE].freeze) # Use += to add types, not <<
 
     # attributes set by fits
     attribute :format_label, ::Valkyrie::Types::Set
@@ -125,15 +127,6 @@ module Hyrax
     # attributes set by fits for video
     attribute :aspect_ratio, ::Valkyrie::Types::Set
 
-    # @param [ActionDispatch::Http::UploadedFile] file
-    # @deprecated Use #new instead; for removal in 4.0.0
-    def self.for(file:)
-      Deprecation.warn "#{self.class}##{__method__} is deprecated; use #new instead."
-      new(label: file.original_filename,
-          original_filename: file.original_filename,
-          mime_type: file.content_type)
-    end
-
     ##
     # @return [Boolean]
     def original_file?

data/app/models/hyrax/file_set.rb

@@ -31,7 +31,7 @@ module Hyrax
   # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
   class FileSet < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
-    include Hyrax::Schema(:basic_metadata)
+    include Hyrax::Schema(:file_set_metadata)
 
     def self.model_name(name_class: Hyrax::Name)
       @_model_name ||= name_class.new(self, nil, 'FileSet')
@@ -51,14 +51,6 @@ module Hyrax
       id
     end
 
-    ##
-    # @return [Valkyrie::ID]
-    # If one is set then return it, otherwise use self as the ID to allow for
-    # derivative generators to find the on-disk path for the thumbnail.
-    def thumbnail_id
-      self.[](:thumbnail_id) || id
-    end
-
     ##
     # @return [Boolean] true
     def pcdm_object?

data/app/models/hyrax/statistic.rb

@@ -34,10 +34,10 @@ module Hyrax
           Hyrax.logger.error("Google Analytics profile has not been established. Unable to fetch statistics.")
           return []
         end
-        profile.hyrax__analytics__google__pageviews(sort: 'date',
-                                                    start_date: start_date,
-                                                    end_date: Date.yesterday,
-                                                    limit: 10_000)
+        profile.hyrax__pageview(sort: 'date',
+                                start_date: start_date,
+                                end_date: Date.yesterday,
+                                limit: 10_000)
                .for_path(path)
       end
 

data/app/models/sipity.rb

@@ -104,10 +104,33 @@ module Sipity
   end
   module_function :Role
 
+  ##
+  # Cast an object to a Workflow id
+  # rubocop:disable Metrics/MethodLength
+  def WorkflowId(input, &block) # rubocop:disable Naming/MethodName
+    result = case input
+             when Sipity::Workflow
+               input.id
+             when Integer
+               input
+             when String
+               input.to_i
+             else
+               if input.respond_to?(workflow_id)
+                 input.workflow_id
+               else
+                 WorkflowId(Entity(input))
+               end
+             end
+    handle_conversion(input, result, :to_workflow_id, &block)
+  end
+  module_function :WorkflowId
+  # rubocop:enable Metrics/MethodLength
+
   ##
   # Cast an object to a WorkflowAction in a given workflow
   def WorkflowAction(input, workflow, &block) # rubocop:disable Naming/MethodName
-    workflow_id = PowerConverter.convert_to_sipity_workflow_id(workflow)
+    workflow_id = WorkflowId(workflow)
 
     result = case input
              when WorkflowAction
@@ -138,11 +161,9 @@ module Sipity
   # A parent error class for all workflow errors caused by bad state
   class StateError < RuntimeError; end
 
-  class ConversionError < PowerConverter::ConversionError
-    def initialize(value, **options)
-      options[:scope] ||= nil
-      options[:to]    ||= nil
-      super(value, options)
+  class ConversionError < RuntimeError
+    def initialize(value)
+      super("Unable to convert #{value.inspect}")
     end
   end
 

data/app/presenters/hyrax/collection_presenter.rb

@@ -43,7 +43,7 @@ module Hyrax
     # Terms is the list of fields displayed by
     # app/views/collections/_show_descriptions.html.erb
     def self.terms
-      [:total_items, :size, :resource_type, :creator, :contributor, :keyword, :license, :publisher, :date_created, :subject,
+      [:total_items, :alternative_title, :size, :resource_type, :creator, :contributor, :keyword, :license, :publisher, :date_created, :subject,
        :language, :identifier, :based_near, :related_url]
     end
 

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -47,6 +47,12 @@ module Hyrax
       Array(super).first || ''
     end
 
+    ##
+    # @return [String]
+    def hostname
+      @hostname || 'localhost'
+    end
+
     ##
     # @return [Boolean]
     def file_set?
@@ -209,6 +215,14 @@ module Hyrax
                iiif_endpoint: iiif_endpoint(latest_file_id, base_url: hostname))
       end
 
+      ##
+      # @return [#can?]
+      def ability
+        @ability ||= NullAbility.new
+      end
+
+      ##
+      # @return [String]
       def hostname
         @hostname || 'localhost'
       end
@@ -222,10 +236,6 @@ module Hyrax
 
     private
 
-    def hostname
-      @hostname || 'localhost'
-    end
-
     def metadata_fields
       Hyrax.config.iiif_metadata_fields
     end

data/app/presenters/hyrax/work_show_presenter.rb

@@ -45,7 +45,7 @@ module Hyrax
     delegate :title, :date_created, :description,
              :creator, :contributor, :subject, :publisher, :language, :embargo_release_date,
              :lease_expiration_date, :license, :source, :rights_statement, :thumbnail_id, :representative_id,
-             :rendering_ids, :member_of_collection_ids, :alternative_title, to: :solr_document
+             :rendering_ids, :member_of_collection_ids, :alternative_title, :bibliographic_citation, to: :solr_document
 
     def workflow
       @workflow ||= WorkflowPresenter.new(solr_document, current_ability)

data/app/presenters/hyrax/workflow_presenter.rb

@@ -44,7 +44,7 @@ module Hyrax
 
     def sipity_entity
       Sipity::Entity(solr_document)
-    rescue PowerConverter::ConversionError
+    rescue Sipity::ConversionError
       nil
     end
   end

data/app/search_builders/hyrax/collection_search_builder.rb

@@ -37,6 +37,7 @@ module Hyrax
     # This overrides the default 'relevance' sort.
     def add_sorting_to_solr(solr_parameters)
       return if solr_parameters[:q]
+      solr_parameters[:sort] ||= sort
       solr_parameters[:sort] ||= "#{sort_field} asc"
     end
 

data/app/search_builders/hyrax/filter_suppressed_with_roles.rb

@@ -32,7 +32,7 @@ module Hyrax
 
     def user_has_active_workflow_role?(current_work:)
       Hyrax::Workflow::PermissionQuery.scope_permitted_workflow_actions_available_for_current_state(user: current_ability.current_user, entity: current_work).any?
-    rescue PowerConverter::ConversionError
+    rescue Sipity::ConversionError
       # The current_work doesn't have a sipity workflow entity
       false
     end

data/app/services/hyrax/admin_set_service.rb

@@ -15,7 +15,7 @@ module Hyrax
 
     # @param [Symbol] access :deposit, :read or :edit
     def search_results(access)
-      response = context.repository.search(builder(access))
+      response = context.blacklight_config.repository.search(builder(access))
       response.documents
     end
 

data/app/services/hyrax/collections/nested_collection_query_service.rb

@@ -51,7 +51,7 @@ module Hyrax
       def self.parent_collections(child:, scope:, page: 1)
         return [] unless nestable?(collection: child)
         query_builder = Hyrax::NestedCollectionsParentSearchBuilder.new(scope: scope, child: child, page: page)
-        scope.repository.search(query_builder.query)
+        scope.blacklight_config.repository.search(query_builder.query)
       end
 
       ##
@@ -73,7 +73,7 @@ module Hyrax
         )
 
         query_builder.where(id: limit_to_id.to_s) if limit_to_id
-        scope.repository.search(query_builder.query)
+        scope.blacklight_config.repository.search(query_builder.query)
       end
       private_class_method :query_solr
 

data/app/services/hyrax/database_migrator.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-require 'rails/generators/actions'
+require 'rails/generators'
 require 'rails/generators/active_record'
 
 module Hyrax

data/app/services/hyrax/edit_permissions_service.rb

@@ -20,17 +20,35 @@ module Hyrax
     # @note
     #   +form object.class = SimpleForm::FormBuilder+
     #    For works (i.e. GenericWork):
-    #    * form object.object = Hyrax::GenericWorkForm
-    #    * form object.object.model = GenericWork
+    #    * form_object.object = Hyrax::GenericWorkForm
+    #    * form_object.object.model = GenericWork
     #    * use the work itself
     #    For file_sets:
-    #    * form object.object.class = FileSet
+    #    * form_object.object.class = FileSet
+    #    * use work the file_set is in
+    #    For file set forms:
+    #    * form_object.object.class = Hyrax::Forms::FileSetForm OR
+    #      Hyrax::Forms::FileSetEditForm
+    #    * form_object.object.model = FileSet
     #    * use work the file_set is in
     #    No other object types are supported by this view.
     def self.build_service_object_from(form:, ability:)
       if form.object.respond_to?(:model) && form.object.model.work?
+        # The provided form object is a work form.
         new(object: form.object, ability: ability)
+      elsif form.object.respond_to?(:model) && form.object.model.file_set?
+        # The provided form object is a FileSet form. For Valkyrie forms
+        # (+Hyrax::Forms::FileSetForm+), +:in_works_ids+ is prepopulated onto
+        # the form object itself. For +Hyrax::Forms::FileSetEditForm+, the
+        # +:in_works+ method is present on the wrapped +:model+.
+        if form.object.is_a?(Hyrax::Forms::FileSetForm)
+          object_id = form.object.in_works_ids.first
+          new(object: Hyrax.query_service.find_by(id: object_id), ability: ability)
+        else
+          new(object: form.object.model.in_works.first, ability: ability)
+        end
       elsif form.object.file_set?
+        # The provided form object is a FileSet.
         new(object: form.object.in_works.first, ability: ability)
       end
     end

data/app/services/hyrax/restriction_service.rb

@@ -18,7 +18,7 @@ module Hyrax
       end
 
       def repository
-        config.repository
+        config.blacklight_config.repository
       end
 
       def config

data/app/services/hyrax/solr_query_service.rb

@@ -26,21 +26,29 @@ module Hyrax
     end
 
     ##
+    # execute the query using a GET request
     # @return [Hash] the results returned from solr for the current query
     def get
       solr_service.get(build)
     end
 
+    ##
+    # execute the solr query and return results
+    # @return [Hash] the results returned from solr for the current query
+    def query_result
+      solr_service.query_result(build)
+    end
+
     ##
     # @return [Enumerable<SolrDocument>]
     def solr_documents
-      get['response']['docs'].map { |doc| self.class.document_model.new(doc) }
+      query_result['response']['docs'].map { |doc| self.class.document_model.new(doc) }
     end
 
     ##
     # @return [Array<String>] ids of documents matching the current query
     def get_ids # rubocop:disable Naming/AccessorMethodName
-      results = get
+      results = query_result
       results['response']['docs'].map { |doc| doc['id'] }
     end
 

data/app/services/hyrax/solr_service.rb

@@ -38,7 +38,7 @@ module Hyrax
       end
 
       delegate :add, :commit, :count, :delete, :get, :instance, :ping, :post,
-               :query, :delete_by_query, :search_by_id, :wipe!, to: :new
+               :query, :query_result, :delete_by_query, :search_by_id, :wipe!, to: :new
     end
 
     # Wraps rsolr get
@@ -72,21 +72,27 @@ module Hyrax
       connection.post(solr_path, data: args)
     end
 
-    # Wraps get by default
+    # Query solr using the provided or default http method, returning the result as a hash.
+    # @return [Hash] raw query result from solr
+    def query_result(query, **args)
+      Hyrax.logger.warn rows_warning unless args.key?(:rows)
+      # Use the provided solr query method, or fall back to the configured default
+      method = args.delete(:method) || Hyrax.config.solr_default_method
+
+      case method
+      when :get
+        get(query, **args)
+      when :post
+        post(query, **args)
+      else
+        raise "Unsupported HTTP method for querying SolrService (#{method.inspect})"
+      end
+    end
+
+    # Execute the provided query. Uses the configured http method by default.
     # @return [Array<SolrHit>] the response docs wrapped in SolrHit objects
     def query(query, **args)
-      Hyrax.logger.warn rows_warning unless args.key?(:rows)
-      method = args.delete(:method) || :get
-
-      result = case method
-               when :get
-                 get(query, **args)
-               when :post
-                 post(query, **args)
-               else
-                 raise "Unsupported HTTP method for querying SolrService (#{method.inspect})"
-               end
-      result['response']['docs'].map do |doc|
+      query_result(query, **args)['response']['docs'].map do |doc|
         ::SolrHit.new(doc)
       end
     end
@@ -114,10 +120,10 @@ module Hyrax
     end
 
     # Wraps rsolr count
-    # @return [Hash] the hash straight form rsolr
+    # @return [Hash] the hash straight from rsolr
     def count(query)
       args = { rows: 0 }
-      get(query, **args)['response']['numFound'].to_i
+      query_result(query, **args)['response']['numFound'].to_i
     end
 
     # Wraps ActiveFedora::Base#search_by_id(id, opts)

data/app/services/hyrax/thumbnail_path_service.rb

@@ -28,7 +28,8 @@ module Hyrax
       end
 
       def fetch_thumbnail(object)
-        return object if object.thumbnail_id == object.id
+        return object if object.thumbnail_id == object.id ||
+                         object.try(:file_ids)&.detect { |fid| fid == object.thumbnail_id }
         Hyrax.query_service.find_by_alternate_identifier(alternate_identifier: object.thumbnail_id)
       rescue Valkyrie::Persistence::ObjectNotFoundError, Hyrax::ObjectNotFoundError
         Hyrax.logger.error("Couldn't find thumbnail #{object.thumbnail_id} for #{object.id}")
@@ -53,13 +54,20 @@ module Hyrax
       # @return true if there a file on disk for this object, otherwise false
       # @param [FileSet] thumb - the object that is the thumbnail
       def thumbnail?(thumb)
-        File.exist?(thumbnail_filepath(thumb))
+        File.exist?(thumbnail_filepath(thumb)) ||
+          (thumb.is_a?(Hyrax::Resource) && file_in_storage?(thumb))
       end
 
       # @param [FileSet] thumb - the object that is the thumbnail
       def thumbnail_filepath(thumb)
         Hyrax::DerivativePath.derivative_path_for_reference(thumb, 'thumbnail')
       end
+
+      def file_in_storage?(thumb)
+        Hyrax.custom_queries.find_thumbnail(file_set: thumb)
+      rescue Valkyrie::StorageAdapter::FileNotFound, Valkyrie::Persistence::ObjectNotFoundError
+        false
+      end
     end
   end
 end

data/app/services/hyrax/valkyrie_persist_derivatives.rb

@@ -16,22 +16,25 @@ module Hyrax
     # @param [#read] stream the derivative filestream
     # @param [Hash] directives
     # @option directives [String] :url a url to the file destination
-    def self.call(stream, directives)
-      filepath = URI(directives.fetch(:url)).path
-      fileset_id = fileset_id_from_path(filepath)
-      fileset = Hyrax.metadata_adapter.query_service.find_by(id: fileset_id)
+    def self.call(stream,
+                  directives,
+                  uploader: Hyrax::ValkyrieUpload.new(storage_adapter: Hyrax.config.derivatives_storage_adapter))
+      file_set = fileset_for_directives(directives)
 
       # Valkyrie storage adapters will typically expect an IO-like object that
       # responds to #path -- here we only have a StringIO, so some
       # transformation is in order
-      tmpfile = Tempfile.new(fileset_id, encoding: 'ascii-8bit')
+      tmpfile = Tempfile.new(file_set.id, encoding: 'ascii-8bit')
       tmpfile.write stream.read
 
-      Hyrax.logger.debug "Uploading thumbnail for FileSet #{fileset_id} as #{filepath}"
-      Hyrax.config.derivatives_storage_adapter.upload(
-        file: tmpfile,
-        original_filename: filepath,
-        resource: fileset
+      filename = filename(directives)
+      Hyrax.logger.debug "Uploading thumbnail for FileSet #{file_set.id} as #{filename}"
+
+      uploader.upload(
+        io: tmpfile,
+        filename: filename,
+        file_set: file_set,
+        use: Hyrax::FileMetadata::Use::THUMBNAIL
       )
     end
 
@@ -40,11 +43,19 @@ module Hyrax
     # we want to extract the FileSet id, which in this case would be 9593tv123
     #
     # @param [String] path
-    # @return [String]
-    def self.fileset_id_from_path(path)
-      path.sub(Hyrax.config.derivatives_path.to_s, "")
-          .sub(/-[^\/]+\..*$/, "")
-          .delete("/")
+    # @return [Hyrax::FileSet]
+    def self.fileset_for_directives(directives)
+      path = URI(directives.fetch(:url)).path
+      id = path.sub(Hyrax.config.derivatives_path.to_s, "")
+               .delete('/')
+               .match(/^(.*)-\w*(\.\w+)*$/) { |m| m[1] }
+      raise "Could not extract fileset id from path #{path}" unless id
+
+      Hyrax.metadata_adapter.query_service.find_by(id: id)
+    end
+
+    def self.filename(directives)
+      URI(directives.fetch(:url)).path.split('/').last
     end
   end
 end