hyrax 3.0.0.pre.rc2 → 3.0.0.pre.rc3

data/app/models/hyrax/event.rb

@@ -4,18 +4,16 @@ module Hyrax
   # Events are timestamped, named actions that provide a streamed 'paper trail'
   # of certain repository activities.
   #
-  # Not to be confused with the `Dry::Events`-based pub/sub interface at
-  # `Hyrax::Publisher`.
+  # Not to be confused with the +Dry::Events+-based pub/sub interface at
+  # {Hyrax::Publisher}.
   #
-  # @see `Hyrax::RedisEventStore`
+  # @see Hyrax::RedisEventStore
   class Event
     ##
     # Creates an event in Redis
     #
-    # @note it's advisable to use Hyrax::TimeService for timestamps, or use the
-    #   `.create_now` method provided
-    #
-    # @example
+    # @note it's advisable to use {Hyrax::TimeService} for timestamps, or use the
+    #   {.create_now} method provided
     #
     # @param [String] action
     # @param [Integer] timestamp

data/app/models/hyrax/file_metadata.rb

@@ -34,16 +34,15 @@ module Hyrax
       module_function :uri_for
     end
 
-    attribute :file_identifiers, ::Valkyrie::Types::Set # id of the file stored by the storage adapter
+    attribute :file_identifier, Valkyrie::Types::ID # id of the file stored by the storage adapter
     attribute :alternate_ids, Valkyrie::Types::Set.of(Valkyrie::Types::ID) # id of the Hydra::PCDM::File which holds metadata and the file in ActiveFedora
     attribute :file_set_id, ::Valkyrie::Types::ID # id of parent file set resource
 
     # all remaining attributes are on AF::File metadata_node unless otherwise noted
     attribute :label, ::Valkyrie::Types::Set
-    attribute :original_filename, ::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 :content, ::Valkyrie::Types::Set
 
     # attributes set by fits
     attribute :format_label, ::Valkyrie::Types::Set
@@ -140,8 +139,20 @@ module Hyrax
       file.valid?(size: size.first, digests: { sha256: checksum&.first&.sha256 })
     end
 
+    ##
+    # @deprecated get content from #file instead
+    #
+    # @return [#to_s]
+    def content
+      Deprecation.warn('This convienince method has been deprecated. ' \
+                       'Retrieve the file from the storage adapter instead.')
+      file.read
+    rescue Valkyrie::StorageAdapter::FileNotFound
+      ''
+    end
+
     def file
-      Hyrax.storage_adapter.find_by(id: file_identifiers.first)
+      Hyrax.storage_adapter.find_by(id: file_identifier)
     end
   end
 end

data/app/models/hyrax/pcdm_collection.rb

@@ -7,6 +7,7 @@ module Hyrax
   # Valkyrie model for Collection domain objects in the Hydra Works model.
   class PcdmCollection < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
+    include Hyrax::Schema(:basic_metadata)
 
     attribute :collection_type_gid, Valkyrie::Types::String
     attribute :member_ids, Valkyrie::Types::Array.of(Valkyrie::Types::ID).meta(ordered: true)
@@ -18,5 +19,17 @@ module Hyrax
     def self._hyrax_default_name_class
       Hyrax::CollectionName
     end
+
+    ##
+    # @return [Boolean] true
+    def collection?
+      true
+    end
+
+    ##
+    # @return [Boolean] true
+    def pcdm_object?
+      true
+    end
   end
 end

data/app/models/hyrax/uploaded_file.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 module Hyrax
-  # Store a file uploaded by a user. Eventually these files get
-  # attached to FileSets and pushed into Fedora.
+  ##
+  # Store a file uploaded by a user.
+  #
+  # Eventually these files get attached to {FileSet}s and pushed into Fedora.
   class UploadedFile < ActiveRecord::Base
     self.table_name = 'uploaded_files'
     mount_uploader :file, UploadedFileUploader
@@ -12,6 +14,11 @@ module Hyrax
              dependent: :destroy
     belongs_to :user, class_name: '::User'
 
+    ##
+    # Associate a {FileSet} with this uploaded file.
+    #
+    # @param [Hyrax::Resource, ActiveFedora::Base] file_set
+    # @return [void]
     def add_file_set!(file_set)
       uri = case file_set
             when ActiveFedora::Base

data/app/models/hyrax/{active_job_proxy.rb → valkyrie_global_id_proxy.rb}

@@ -2,19 +2,20 @@
 
 module Hyrax
   ##
-  # Support ActiveJob Serialization/Deserialization for `Valkyrie::Resource`
-  # models.
+  # Support GlobalID and ActiveJob Serialization/Deserialization for
+  # `Valkyrie::Resource` models.
+  #
   #
   # @example Serializing a Valkyrie::Resource for ActiveJob
   #   resource = Hyrax.query_service.find_by(id: Valkyrie::ID.new('an_id'))
   #
   #   MyJob.perform_later(resource) # #<ActiveJob::SerializationError: Unsupported argument type: >
   #
-  #   proxy = Hyrax::ActiveJobProxy.new(resource: resource)
+  #   proxy = Hyrax::ValkyrieGlobalIdProxy.new(resource: resource)
   #   MyJob.perform_later(proxy) # deserializes for `MyJob#perform` as `resource`
   #
   # @see https://github.com/rails/globalid
-  class ActiveJobProxy
+  class ValkyrieGlobalIdProxy
     include GlobalID::Identification
 
     ##
@@ -31,7 +32,7 @@ module Hyrax
     ##
     # @return [Valkyrie::Resource]
     def self.find(id)
-      Hyrax.query_adapter.find_by(id: id)
+      Hyrax.query_service.find_by(id: id)
     end
 
     ##

data/app/models/hyrax/virus_scanner.rb

@@ -44,7 +44,8 @@ module Hyrax
     # Always return zero if there's nothing available to check for viruses. This means that
     # we assume all files have no viruses because we can't conclusively say if they have or not.
     def null_scanner
-      warning "Unable to check #{file} for viruses because no virus scanner is defined"
+      warning "Unable to check #{file} for viruses because no virus scanner is defined" unless
+        Rails.env.test?
       false
     end
 

data/app/models/hyrax/work.rb

@@ -4,7 +4,7 @@ module Hyrax
   ##
   # Valkyrie model for `Work` domain objects in the Hydra Works model.
   #
-  # @see https://wiki.duraspace.org/display/samvera/Hydra%3A%3AWorks+Shared+Modeling
+  # @see https://wiki.lyrasis.org/display/samvera/Hydra::Works+Shared+Modeling
   class Work < Hyrax::Resource
     include Hyrax::Schema(:core_metadata)
 

data/app/models/sipity.rb

@@ -26,6 +26,8 @@ module Sipity
                Entity(input.model)
              when Sipity::Comment
                Entity(input.entity)
+             when Valkyrie::Resource
+               Entity(Hyrax::GlobalID(input))
              else
                Entity(input.to_global_id) if input.respond_to?(:to_global_id)
              end
@@ -81,6 +83,10 @@ module Sipity
   end
   module_function :WorkflowState
 
+  ##
+  # 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

data/app/models/sipity/entity.rb

@@ -9,7 +9,7 @@ module Sipity
   # extract the information.
   # @example To get the Sipity::Entity for a work
   #   work = GenericWork.first
-  #   work_global_id = work.to_global_id.to_s
+  #   work_global_id = Hyrax::GlobalID(work).to_s
   #   => "gid://whatever/GenericWork/3x816m604"
   #   Sipity::Entity.where(proxy_for_global_id: work_global_id).first
   #   => #<Sipity::Entity id: 1, proxy_for_global_id: "gid://whatever/GenericWork/3x816m604",

data/app/models/sipity/workflow.rb

@@ -30,9 +30,11 @@ module Sipity
       workflows = Sipity::Workflow.arel_table
       Sipity::Workflow.where(active: true).where(
         workflows[:permission_template_id].in(
-          templates.project(templates[:id]).where(templates[:source_id].eq(admin_set_id))
+          templates.project(templates[:id]).where(templates[:source_id].eq(admin_set_id.to_s))
         )
       ).first!
+    rescue ActiveRecord::RecordNotFound => err
+      raise NoActiveWorkflowError, err.message
     end
 
     # @api public
@@ -45,9 +47,10 @@ module Sipity
     # @param workflow_name [String] The name of the workflow within the given permission template that should be activated
     # @return [Sipity::Workflow] active workflow
     # @raise [ActiveRecord::RecordNotFound] When we have a mismatch on permission template and workflow id or workflow name
-    # @raise [RuntimeError] When you don't specify a workflow_id or workflow_name
+    # @raise [ArgumentError] When you don't specify a workflow_id or workflow_name
     def self.activate!(permission_template:, workflow_id: nil, workflow_name: nil)
-      raise "You must specify a workflow_id or workflow_name to activate!" if workflow_id.blank? && workflow_name.blank?
+      raise(ArgumentError, "You must specify a workflow_id or workflow_name to activate!") if
+        workflow_id.blank? && workflow_name.blank?
       workflow_to_activate = Sipity::Workflow.find_by!({ permission_template: permission_template, id: workflow_id, name: workflow_name }.compact)
       active_workflow = Sipity::Workflow.where(permission_template: permission_template, active: true)
       return workflow_to_activate if workflow_to_activate == active_workflow.first
@@ -57,6 +60,21 @@ module Sipity
       end
     end
 
+    ##
+    # @api public
+    # Find an action in this workflow that has no starting state. This is the deposit action.
+    #
+    # @return [Sipity::WorkflowAction]
+    # @raise [Sipity::StateError]
+    def find_deposit_action
+      actions_that_lead_to_states = Sipity::WorkflowStateAction.all.pluck(:workflow_action_id)
+      relation = Sipity::WorkflowAction.where(workflow: self)
+      relation = relation.where('id NOT IN (?)', actions_that_lead_to_states) if actions_that_lead_to_states.any?
+      relation.first!
+    rescue ActiveRecord::RecordNotFound => err
+      raise NoActiveWorkflowError, err.message
+    end
+
     # Grant a workflow responsibility to a set of agents and remove it from any
     # agents who currently have the workflow responsibility, but are not in the
     # provided list
@@ -86,5 +104,7 @@ module Sipity
       wf_role = Sipity::WorkflowRole.find_by(workflow: self, role_id: role)
       wf_role.workflow_responsibilities.where.not(agent: allowed_agents).destroy_all
     end
+
+    class NoActiveWorkflowError < StateError; end
   end
 end

data/app/presenters/hyrax/admin/repository_object_presenter.rb

@@ -22,8 +22,9 @@ module Hyrax
       end
 
       def search_builder
-        Stats::WorkStatusSearchBuilder.new(self)
+        search_service.search_builder
       end
+      deprecation_deprecate :search_builder
 
       # results come from Solr in an array where the first item is the status and
       # the second item is the count
@@ -31,9 +32,13 @@ module Hyrax
       #   [ "true", 55, "false", 205, nil, 11 ]
       # @return [#each] an enumerable object of tuples (status and count)
       def results
-        facet_results = repository.search(search_builder)
+        facet_results, _docs = search_service.search_results
         facet_results.facet_fields[IndexesWorkflow.suppressed_field].each_slice(2)
       end
+
+      def search_service
+        Hyrax::SearchService.new(config: CatalogController.blacklight_config, user_params: {}, scope: self, search_builder_class: Stats::WorkStatusSearchBuilder)
+      end
     end
   end
 end

data/app/presenters/hyrax/collection_presenter.rb

@@ -27,7 +27,7 @@ module Hyrax
     delegate :stringify_keys, :human_readable_type, :collection?, :representative_id,
              :to_s, to: :solr_document
 
-    delegate(*Hyrax::CollectionType.collection_type_settings_methods, to: :collection_type, prefix: :collection_type_is)
+    delegate(*Hyrax::CollectionType.settings_attributes, to: :collection_type, prefix: :collection_type_is)
 
     def collection_type
       @collection_type ||= Hyrax::CollectionType.find_by_gid!(collection_type_gid)

data/app/presenters/hyrax/file_set_presenter.rb

@@ -83,6 +83,8 @@ module Hyrax
       Hyrax::FixityStatusPresenter.new(id).render_file_set_status
     end
 
+    ##
+    # @return [WorkShowPresenter, nil] +nil+ if no parent can be found
     def parent
       @parent_presenter ||= fetch_parent_presenter
     end
@@ -100,6 +102,7 @@ module Hyrax
     def fetch_parent_presenter
       ids = Hyrax::SolrService.query("{!field f=member_ids_ssim}#{id}", fl: Hyrax.config.id_field)
                               .map { |x| x.fetch(Hyrax.config.id_field) }
+      Hyrax.logger.warn("Couldn't find a parent work for FileSet: #{id}.") if ids.empty?
       Hyrax::PresenterFactory.build_for(ids: ids,
                                         presenter_class: WorkShowPresenter,
                                         presenter_args: current_ability).first

data/app/presenters/hyrax/iiif_manifest_presenter.rb

@@ -2,8 +2,8 @@
 
 module Hyrax
   ##
-  # This presenter wraps objects in the interface required by `IIIFManifiest`.
-  # It will accept either a Work-like resource or a SolrDocument.
+  # 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
   #
@@ -27,7 +27,7 @@ module Hyrax
 
     class << self
       ##
-      # @param [Hyrax::Resource, SolrDocument]
+      # @param [Hyrax::Resource, SolrDocument] model
       def for(model)
         klass = model.file_set? ? DisplayImagePresenter : IiifManifestPresenter
 

data/app/presenters/hyrax/permission_badge.rb

@@ -24,7 +24,7 @@ module Hyrax
     private
 
     def dom_label_class
-      VISIBILITY_LABEL_CLASS.fetch(@visibility.to_sym)
+      VISIBILITY_LABEL_CLASS.fetch(@visibility.to_sym, 'label-info')
     end
 
     def text

data/app/presenters/hyrax/presenter_factory.rb

@@ -18,8 +18,6 @@ module Hyrax
     end
 
     attr_reader :ids, :presenter_class, :presenter_args
-    alias klass presenter_class
-    deprecation_deprecate klass: "use #presenter_class instead"
 
     def initialize(ids:, presenter_class:, presenter_args:)
       @ids = ids

data/app/presenters/hyrax/select_collection_type_presenter.rb

@@ -1,12 +1,25 @@
 # frozen_string_literal: true
 module Hyrax
   class SelectCollectionTypePresenter
-    # @param [CollectionType] a Hyrax::CollectionType
+    ##
+    # @!attribute [r] collection_type
+    #   @return [CollectionType]
+    attr_reader :collection_type
+
+    ##
+    # @param [CollectionType] collection_type a Hyrax::CollectionType
     def initialize(collection_type)
       @collection_type = collection_type
     end
-
-    attr_reader :collection_type
+    ##
+    # @!method admin_set?
+    #   @return [Boolean]
+    # @!method description
+    #   @see CollectionType#description
+    # @!method id
+    #   @see CollectionType#id
+    # @!method title
+    #   @see CollectionType#title
     delegate :title, :description, :admin_set?, :id, to: :collection_type
   end
 end

data/app/presenters/hyrax/select_type_presenter.rb

@@ -16,7 +16,7 @@ module Hyrax
     end
 
     def name
-      translate('name')
+      translate('name', object_name.to_s.titleize)
     end
 
     def switch_to_new_work_path(route_set:, params:)
@@ -43,9 +43,10 @@ module Hyrax
       @object_name ||= concern.model_name.i18n_key
     end
 
-    def translate(key)
+    def translate(key, default = nil)
       defaults = []
       defaults << :"hyrax.select_type.#{object_name}.#{key}"
+      defaults << default
       defaults << :"hyrax.select_type.#{key}"
       defaults << ''
       I18n.t(defaults.shift, default: defaults)

data/app/presenters/hyrax/stats_usage_presenter.rb

@@ -17,7 +17,6 @@ module Hyrax
                    end
     end
 
-    # TODO: make this a lazy enumerator
     def to_flots(stats)
       stats.map(&:to_flot)
     end

data/app/presenters/hyrax/work_show_presenter.rb

@@ -282,7 +282,7 @@ module Hyrax
     end
 
     def graph
-      GraphExporter.new(solr_document, request).fetch
+      GraphExporter.new(solr_document, hostname: request.host).fetch
     end
 
     # @return [Array<String>] member_of_collection_ids with current_ability access

data/app/renderers/hyrax/renderers/attribute_renderer.rb

@@ -14,6 +14,9 @@ module Hyrax
       # @param [Symbol] field
       # @param [Array] values
       # @param [Hash] options
+      # @option options [String] :label The field label to render
+      # @option options [String] :include_empty Do we render if if the values are empty?
+      # @option options [String] :work_type Used for some I18n logic
       def initialize(field, values, options = {})
         @field = field
         @values = values
@@ -53,16 +56,23 @@ module Hyrax
         markup.html_safe
       end
 
+      # Defaults to the label provided in the options, otherwise, it
+      # fallsback to the inner logic of the method.
+      #
       # @return The human-readable label for this field.
       # @note This is a central location for determining the label of a field
       #   name. Can be overridden if more complicated logic is needed.
       def label
-        translate(
-          :"blacklight.search.fields.#{work_type_label_key}.show.#{field}",
-          default: [:"blacklight.search.fields.show.#{field}",
-                    :"blacklight.search.fields.#{field}",
-                    options.fetch(:label, field.to_s.humanize)]
-        )
+        if options&.key?(:label)
+          options.fetch(:label)
+        else
+          translate(
+            :"blacklight.search.fields.#{work_type_label_key}.show.#{field}",
+            default: [:"blacklight.search.fields.show.#{field}",
+                      :"blacklight.search.fields.#{field}",
+                      field.to_s.humanize]
+          )
+        end
       end
 
       private