hyrax 2.8.0 → 3.0.0.pre.rc2

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'oauth'
 
 module Hyrax::User
@@ -30,7 +31,7 @@ module Hyrax::User
 
     scope :guests, ->() { where(guest: true) }
     scope :registered, ->() { where(guest: false) }
-    scope :without_system_accounts, -> { where("#{Hydra.config.user_key_field} not in (?)", [::User.batch_user_key, ::User.audit_user_key]) }
+    scope :without_system_accounts, -> { where("#{::User.user_key_field} not in (?)", [::User.batch_user_key, ::User.audit_user_key]) }
 
     # Validate and normalize ORCIDs
     validates_with OrcidValidator
@@ -48,6 +49,10 @@ module Hyrax::User
     has_one :sipity_agent, as: :proxy_for, dependent: :destroy, class_name: 'Sipity::Agent'
   end
 
+  def user_key
+    public_send(self.class.user_key_field)
+  end
+
   # Look for, in order:
   #   A cached version of the agent
   #   A non-cached version (direct read of the database)
@@ -102,7 +107,7 @@ module Hyrax::User
     #   2. the orcid field is blank
     #   3. the orcid is already in its normalized form
     return if errors[:orcid].first.present? || orcid.blank? || orcid.starts_with?('https://orcid.org/')
-    bare_orcid = Hyrax::OrcidValidator.match(orcid)
+    bare_orcid = Hyrax::OrcidValidator.extract_bare_orcid(from: orcid)
     self.orcid = "https://orcid.org/#{bare_orcid}"
   end
 
@@ -149,6 +154,10 @@ module Hyrax::User
       Hyrax.config.audit_user_key
     end
 
+    def user_key_field
+      Hydra.config.user_key_field
+    end
+
     # Override this method if you aren't using email/password
     def batch_user
       find_or_create_system_user(batch_user_key)
@@ -159,7 +168,7 @@ module Hyrax::User
     end
 
     def find_or_create_system_user(user_key)
-      User.find_by_user_key(user_key) || User.create!(Hydra.config.user_key_field => user_key, password: Devise.friendly_token[0, 20])
+      User.find_by_user_key(user_key) || User.create!(user_key_field => user_key, password: Devise.friendly_token[0, 20])
     end
 
     def from_url_component(component)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax::UserUsageStats
   def stats
     @stats ||= UserStat.where(user_id: id).order(date: :asc)

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module Hyrax
+  module VirusCheck
+    extend ActiveSupport::Concern
+
+    included do
+      validate :must_not_detect_viruses
+
+      def viruses?
+        return false unless original_file&.new_record? # We have a new file to check
+        VirusCheckerService.file_has_virus?(original_file)
+      end
+
+      def must_not_detect_viruses
+        return true unless viruses?
+        errors.add(:base, "Failed to verify uploaded file is not a virus")
+        false
+      end
+    end
+  end
+end

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

@@ -1,13 +1,23 @@
+# frozen_string_literal: true
 module Hyrax
+  # A mixin module intended to provide an interface into creating the paper trail
+  # of activity on the target model of the mixin.
+  #
+  # @see Hyrax::Event
   module WithEvents
     def stream
       Nest.new(event_class)[to_param]
     end
 
+    # @return [String]
     def event_class
-      self.class.name
+      model_name.name
     end
 
+    ##
+    # @param [Integer] size  the maximum number of events to fetch from the log.
+    #   Offset by 1; to get one event, use `0`, for two, use `1`, etc...
+    #   `-1` gives all events.
     def events(size = -1)
       event_stream.fetch(size)
     end
@@ -18,12 +28,12 @@ module Hyrax
 
     private
 
-      def event_store
-        RedisEventStore
-      end
+    def event_store
+      RedisEventStore
+    end
 
-      def event_stream
-        event_store.for(stream[:event])
-      end
+    def event_stream
+      event_store.for(stream[:event])
+    end
   end
 end

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

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
 module Hyrax
   module WithFileSets
     extend ActiveSupport::Concern
+
+    ##
+    # @deprecated Use 'Hyrax::VisibilityPropagator' instead.
     def copy_visibility_to_files
+      Deprecation.warn "Use 'Hyrax::VisibilityPropagator' instead."
+
       file_sets.each do |fs|
         fs.visibility = visibility
         fs.save!

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   module WorkBehavior
     extend ActiveSupport::Concern
@@ -7,7 +8,6 @@ module Hyrax
     include Permissions
     include Serializers
     include Hydra::WithDepositor
-    include Solrizer::Common
     include HasRepresentative
     include HasRendering
     include WithFileSets
@@ -25,15 +25,11 @@ module Hyrax
 
     included do
       property :owner, predicate: RDF::URI.new('http://opaquenamespace.org/ns/hydra/owner'), multiple: false
-      class_attribute :human_readable_short_description
+      class_attribute :human_readable_short_description, :default_system_virus_scanner
       # TODO: do we need this line?
       self.indexer = WorkIndexer
-    end
-
-    # TODO: This can be removed when we upgrade to ActiveFedora 12.0
-    def etag
-      raise "Unable to produce an etag for a unsaved object" unless persisted?
-      ldp_source.head.etag
+      # Default VirusScanner, configurable for Hyrax work types
+      self.default_system_virus_scanner = Hyrax::VirusScanner
     end
 
     module ClassMethods
@@ -42,7 +38,7 @@ module Hyrax
         @_to_partial_path ||= begin
           element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
           collection = ActiveSupport::Inflector.tableize(name)
-          "hyrax/#{collection}/#{element}".freeze
+          "hyrax/#{collection}/#{element}"
         end
       end
     end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax::Works
   module Metadata
     extend ActiveSupport::Concern

data/app/models/content_block.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class ContentBlock < ActiveRecord::Base
   # The keys in this registry are "public" names for collaborator
   # objects, and the values are reserved names of ContentBlock
@@ -18,12 +19,18 @@ class ContentBlock < ActiveRecord::Base
   # `for` is a reserved word in Ruby.
   def self.for(key)
     key = key.respond_to?(:to_sym) ? key.to_sym : key
-    raise ArgumentError, "#{key} is not a ContentBlock name" unless whitelisted?(key)
+    raise ArgumentError, "#{key} is not a ContentBlock name" unless registered?(key)
     ContentBlock.public_send(NAME_REGISTRY[key])
   end
 
   class << self
+    # @deprecated
     def whitelisted?(key)
+      Deprecation.warn(self, "Samvera is deprecating '#{self}.whitelisted?' in Hyrax 3.0. Use #{self}.registered? instead.")
+      registered?(key)
+    end
+
+    def registered?(key)
       NAME_REGISTRY.include?(key)
     end
 

data/app/models/featured_work.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FeaturedWork < ActiveRecord::Base
   FEATURE_LIMIT = 5
   validate :count_within_limit, on: :create

data/app/models/featured_work_list.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FeaturedWorkList
   include ActiveModel::Model
 
@@ -26,24 +27,24 @@ class FeaturedWorkList
 
   private
 
-    def add_solr_document_to_works
-      work_presenters.each do |presenter|
-        work_with_id(presenter.id).presenter = presenter
-      end
+  def add_solr_document_to_works
+    work_presenters.each do |presenter|
+      work_with_id(presenter.id).presenter = presenter
     end
+  end
 
-    def ids
-      @works.pluck(:work_id)
-    end
+  def ids
+    @works.pluck(:work_id)
+  end
 
-    def work_presenters
-      ability = nil
-      Hyrax::PresenterFactory.build_for(ids: ids,
-                                        presenter_class: Hyrax::WorkShowPresenter,
-                                        presenter_args: ability)
-    end
+  def work_presenters
+    ability = nil
+    Hyrax::PresenterFactory.build_for(ids: ids,
+                                      presenter_class: Hyrax::WorkShowPresenter,
+                                      presenter_args: ability)
+  end
 
-    def work_with_id(id)
-      @works.find { |w| w.work_id == id }
-    end
+  def work_with_id(id)
+    @works.find { |w| w.work_id == id }
+  end
 end

data/app/models/file_download_stat.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FileDownloadStat < Hyrax::Statistic
   self.cache_column = :downloads
   self.event_type = :totalEvents
@@ -13,7 +14,8 @@ class FileDownloadStat < Hyrax::Statistic
       end
       profile.hyrax__download(sort: 'date',
                               start_date: start_date,
-                              end_date: Date.yesterday)
+                              end_date: Date.yesterday,
+                              limit: 10_000)
              .for_file(file.id)
     end
 

data/app/models/file_view_stat.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class FileViewStat < Hyrax::Statistic
   self.cache_column = :views
   self.event_type = :pageviews

data/app/models/hyrax/access_control.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # A list of permissions pertaining to a specific object.
+  #
+  # `AccessControl`s consist of a set of permissions and an `#access_to`
+  # reference to the object that set governs.
+  #
+  # @see Hyrax::AccessControlList for a low level DSL for managing
+  #   `AccessControl` and `Permission` relationships for `Hyrax::Resource`
+  # @see Hyrax::PermissionManager for `read_groups`/`read_users` style setters
+  #   and getters
+  # @see Hyrax::VisibilityWriter, Hyrax::VisibilityReader for
+  #   "open"/"restricted" style visibility management
+  class AccessControl < Valkyrie::Resource
+    ##
+    # @!attribute [rw] access_to
+    #   Supports query for ACLs at the resource level. Permissions should be
+    #   grouped under an AccessControl with a matching `#access_to` so they can
+    #   be retrieved in batch.
+    #
+    #   @return [Valkyrie::ID] the id of the Resource these permissions apply to
+    # @!attribute [rw] permissions
+    #   @return [Enumerable<Hyrax::Permission>]
+    attribute :access_to,   Valkyrie::Types::ID
+    attribute :permissions, Valkyrie::Types::Set.of(Hyrax::Permission)
+
+    ##
+    # A finder/factory method for getting an appropriate ACL for a given
+    # resource.
+    #
+    # @param resource [Valkyrie::Resource]
+    # @param query_service [#find_inverse_references_by]
+    #
+    # @return [AccessControl]
+    # @raise [ArgumentError] if the resource is not persisted
+    def self.for(resource:, query_service: Hyrax.query_service)
+      query_service.custom_queries.find_access_control_for(resource: resource)
+    rescue Valkyrie::Persistence::ObjectNotFoundError
+      new(access_to: resource.id)
+    end
+  end
+end

data/app/models/hyrax/active_job_proxy.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Support 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)
+  #   MyJob.perform_later(proxy) # deserializes for `MyJob#perform` as `resource`
+  #
+  # @see https://github.com/rails/globalid
+  class ActiveJobProxy
+    include GlobalID::Identification
+
+    ##
+    # @!attribute [rw] resource
+    #   @return [Hyrax::Resource]
+    attr_accessor :resource
+
+    ##
+    # @param resource [Hyrax::Resource]
+    def initialize(resource:)
+      self.resource = resource
+    end
+
+    ##
+    # @return [Valkyrie::Resource]
+    def self.find(id)
+      Hyrax.query_adapter.find_by(id: id)
+    end
+
+    ##
+    # @return [String]
+    def id
+      resource.id.to_s
+    end
+  end
+end

data/app/models/hyrax/administrative_set.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # Valkyrie model for Admin Set domain objects.
+  class AdministrativeSet < Hyrax::Resource
+    attribute :alternative_title, Valkyrie::Types::Set.of(Valkyrie::Types::String)
+    attribute :creator,           Valkyrie::Types::Set.of(Valkyrie::Types::String)
+    attribute :description,       Valkyrie::Types::Set.of(Valkyrie::Types::String)
+    attribute :title,             Valkyrie::Types::Set.of(Valkyrie::Types::String)
+  end
+end

data/app/models/hyrax/avatar_validator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class AvatarValidator < ActiveModel::Validator
     def validate(record)

data/app/models/hyrax/base.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hyrax
+  # Isolate calls to ActiveFedora::Base
+  class Base
+    def self.uncached(&block)
+      ActiveFedora::Base.uncached(&block)
+    end
+
+    def self.uri_to_id(uri)
+      ActiveFedora::Base.uri_to_id(uri)
+    end
+
+    def self.id_to_uri(id)
+      ActiveFedora::Base.id_to_uri(id)
+    end
+  end
+end

data/app/models/hyrax/batch_create_operation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Hyrax
   class BatchCreateOperation < Operation
     set_callback :success, :after, :batch_success_message
@@ -5,12 +6,12 @@ module Hyrax
 
     def batch_success_message
       return unless Hyrax.config.callback.set?(:after_batch_create_success)
-      Hyrax.config.callback.run(:after_batch_create_success, user)
+      Hyrax.config.callback.run(:after_batch_create_success, user, warn: false)
     end
 
     def batch_failure_message
       return unless Hyrax.config.callback.set?(:after_batch_create_failure)
-      Hyrax.config.callback.run(:after_batch_create_failure, user, rollup_messages)
+      Hyrax.config.callback.run(:after_batch_create_failure, user, rollup_messages, warn: false)
     end
   end
 end

data/app/models/hyrax/change_set.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Hyrax
+  ##
+  # @api private
+  #
+  # Build a changeset class for the given resource class. The ChangeSet will
+  # have fields to match the resource class given.
+  #
+  # @example
+  #   Hyrax::ChangeSet(Monograph)
+  def self.ChangeSet(resource_class)
+    Class.new(Hyrax::ChangeSet) do
+      (resource_class.fields - resource_class.reserved_attributes).each do |field|
+        property field, default: nil
+      end
+
+      ##
+      # @return [String]
+      def self.inspect
+        return "Hyrax::ChangeSet(#{model_class})" if name.blank?
+        super
+      end
+    end
+  end
+
+  class ChangeSet < Valkyrie::ChangeSet
+    ##
+    # @api public
+    #
+    # Factory for resource ChangeSets
+    #
+    # @example
+    #   monograph  = Monograph.new
+    #   change_set = Hyrax::ChangeSet.for(monograph)
+    #
+    #   change_set.title = 'comet in moominland'
+    #   change_set.sync
+    #   monograph.title # => 'comet in moominland'
+    #
+    def self.for(resource)
+      Hyrax::ChangeSet(resource.class).new(resource)
+    end
+  end
+end