hyrax 5.0.0.rc1 → 5.0.0.rc3

data/spec/factories/hyrax_work.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+##
+# Use this factory for generic Hyrax/HydraWorks Works in valkyrie.
+FactoryBot.define do
+  factory :hyrax_work, class: 'Hyrax::Test::SimpleWork' do
+    trait :under_embargo do
+      association :embargo, factory: :hyrax_embargo
+
+      after(:create) do |work, _e|
+        Hyrax::EmbargoManager.new(resource: work).apply
+        work.permission_manager.acl.save
+      end
+    end
+
+    trait :with_expired_enforced_embargo do
+      after(:build) do |work, _evaluator|
+        work.embargo = FactoryBot.valkyrie_create(:hyrax_embargo, :expired)
+      end
+
+      after(:create) do |work, _evaluator|
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_return(10.days.ago)
+        Hyrax::EmbargoManager.new(resource: work).apply
+        work.permission_manager.acl.save
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_call_original
+      end
+    end
+
+    trait :under_lease do
+      association :lease, factory: :hyrax_lease
+
+      after(:create) do |work, _e|
+        Hyrax::LeaseManager.new(resource: work).apply
+        work.permission_manager.acl.save
+      end
+    end
+
+    trait :with_expired_enforced_lease do
+      after(:build) do |work, _evaluator|
+        work.lease = FactoryBot.valkyrie_create(:hyrax_lease, :expired)
+      end
+
+      after(:create) do |work, _evaluator|
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_return(10.days.ago)
+        Hyrax::LeaseManager.new(resource: work).apply
+        work.permission_manager.acl.save
+        allow(Hyrax::TimeService).to receive(:time_in_utc).and_call_original
+      end
+    end
+
+    transient do
+      edit_users         { [] }
+      edit_groups        { [] }
+      read_users         { [] }
+      read_groups        { [] }
+      members            { nil }
+      visibility_setting { nil }
+      with_index         { true }
+      uploaded_files { [] }
+    end
+
+    after(:build) do |work, evaluator|
+      if evaluator.visibility_setting
+        Hyrax::VisibilityWriter
+          .new(resource: work)
+          .assign_access_for(visibility: evaluator.visibility_setting)
+      end
+
+      work.permission_manager.edit_groups = work.permission_manager.edit_groups.to_a + evaluator.edit_groups
+      work.permission_manager.edit_users  = work.permission_manager.edit_users.to_a + evaluator.edit_users
+      work.permission_manager.read_users  = work.permission_manager.read_users.to_a + evaluator.read_users
+      work.permission_manager.read_groups = work.permission_manager.read_groups.to_a + evaluator.read_groups
+
+      work.member_ids = evaluator.members.compact.map(&:id) if evaluator.members
+    end
+
+    after(:create) do |work, evaluator|
+      if evaluator.visibility_setting
+        Hyrax::VisibilityWriter
+          .new(resource: work)
+          .assign_access_for(visibility: evaluator.visibility_setting)
+      end
+      work.permission_manager.edit_groups = work.permission_manager.edit_groups.to_a + evaluator.edit_groups
+      work.permission_manager.edit_users  = work.permission_manager.edit_users.to_a + evaluator.edit_users
+      work.permission_manager.read_users  = work.permission_manager.read_users.to_a + evaluator.read_users
+      work.permission_manager.read_groups = work.permission_manager.read_groups.to_a + evaluator.read_groups
+
+      # these are both no-ops if an active embargo/lease isn't present
+      Hyrax::EmbargoManager.new(resource: work).apply
+      Hyrax::LeaseManager.new(resource: work).apply
+
+      work.permission_manager.acl.save
+
+      # This has to happen after permissions for permissions to propagate.
+      if evaluator.uploaded_files.present?
+        allow(Hyrax.config.characterization_service).to receive(:run).and_return(true)
+        perform_enqueued_jobs(only: ValkyrieIngestJob) do
+          Hyrax::WorkUploadsHandler.new(work: Hyrax.query_service.find_by(id: work.id)).add(files: evaluator.uploaded_files).attach
+        end
+        # I'm not sure why, but Wings required this reload.
+        work.member_ids = Hyrax.query_service.find_by(id: work.id).member_ids
+      end
+
+      Hyrax.index_adapter.save(resource: Hyrax.query_service.find_by(id: work.id)) if evaluator.with_index
+    end
+
+    trait :public do
+      transient do
+        visibility_setting { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC }
+      end
+    end
+
+    trait :with_admin_set do
+      transient do
+        admin_set { valkyrie_create(:hyrax_admin_set) }
+      end
+
+      after(:build) do |work, evaluator|
+        work.admin_set_id = evaluator.admin_set&.id
+      end
+    end
+
+    trait :with_default_admin_set do
+      admin_set_id { Hyrax::EnsureWellFormedAdminSetService.call }
+    end
+
+    trait :with_member_works do
+      transient do
+        members do
+          # If you set a depositor on the containing work, propogate that into these members
+          additional_attributes = {}
+          additional_attributes[:depositor] = depositor if depositor
+          [valkyrie_create(:hyrax_work, additional_attributes), valkyrie_create(:hyrax_work, additional_attributes)]
+        end
+      end
+    end
+
+    trait :with_file_and_work do
+      transient do
+        members do
+          # If you set a depositor on the containing work, propogate that into these members
+          additional_attributes = {}
+          additional_attributes[:depositor] = depositor if depositor
+          [valkyrie_create(:hyrax_file_set, additional_attributes), valkyrie_create(:hyrax_work, additional_attributes)]
+        end
+      end
+    end
+
+    trait :with_one_file_set do
+      transient do
+        members do
+          # If you set a depositor on the containing work, propogate that into this member
+          additional_attributes = {}
+          additional_attributes[:depositor] = depositor if depositor
+          [valkyrie_create(:hyrax_file_set, additional_attributes)]
+        end
+      end
+    end
+
+    trait :with_member_file_sets do
+      transient do
+        members do
+          # If you set a depositor on the containing work, propogate that into these members
+          additional_attributes = {}
+          additional_attributes[:depositor] = depositor if depositor
+          [valkyrie_create(:hyrax_file_set, additional_attributes), valkyrie_create(:hyrax_file_set, additional_attributes)]
+        end
+      end
+    end
+
+    trait :with_thumbnail do
+      thumbnail_id do
+        file_set = members.find(&:file_set?) ||
+                   valkyrie_create(:hyrax_file_set)
+        file_set.id
+      end
+    end
+
+    trait :with_representative do
+      representative_id do
+        file_set = members&.find(&:file_set?) ||
+                   valkyrie_create(:hyrax_file_set)
+        file_set.id
+      end
+    end
+
+    trait :with_renderings do
+      rendering_ids do
+        file_set = members.find(&:file_set?) ||
+                   valkyrie_create(:hyrax_file_set)
+        file_set.id
+      end
+    end
+
+    trait :as_collection_member do
+      member_of_collection_ids { [valkyrie_create(:hyrax_collection).id] }
+    end
+
+    trait :as_member_of_multiple_collections do
+      member_of_collection_ids do
+        [valkyrie_create(:hyrax_collection).id,
+         valkyrie_create(:hyrax_collection).id,
+         valkyrie_create(:hyrax_collection).id]
+      end
+    end
+
+    factory :monograph, class: 'Monograph' do
+      factory :comet_in_moominland do
+        title { 'Comet in Moominland' }
+        creator { 'Tove Jansson' }
+        record_info { 'An example monograph with enough metadata fill in required fields.' }
+      end
+
+      trait :with_member_works do
+        transient do
+          members { [valkyrie_create(:monograph), valkyrie_create(:monograph)] }
+        end
+      end
+    end
+  end
+end

data/spec/factories/object_id.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# Defines a new sequence
+FactoryBot.define do
+  sequence :object_id do |n|
+    "object_id_#{n}"
+  end
+end

data/spec/factories/operations.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :operation, class: Hyrax::Operation do
+    operation_type { "Test operation" }
+
+    trait :failing do
+      status { Hyrax::Operation::FAILURE }
+    end
+
+    trait :pending do
+      status { Hyrax::Operation::PENDING }
+    end
+
+    trait :successful do
+      status { Hyrax::Operation::SUCCESS }
+    end
+
+    factory :batch_create_operation, class: Hyrax::BatchCreateOperation do
+      operation_type { "Batch Create" }
+    end
+  end
+end

data/spec/factories/permission.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :permission, class: "Hyrax::Permission" do
+    agent { create(:user).user_key.to_s }
+    mode  { :read }
+  end
+end

data/spec/factories/permission_template_accesses.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :permission_template_access, class: Hyrax::PermissionTemplateAccess do
+    permission_template
+    trait :manage do
+      access { 'manage' }
+    end
+
+    trait :deposit do
+      access { 'deposit' }
+    end
+
+    trait :view do
+      access { 'view' }
+    end
+  end
+end

data/spec/factories/permission_templates.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :permission_template, class: Hyrax::PermissionTemplate do
+    # Given that there is a one to one strong relation between permission_template and admin_set,
+    # with a unique index on the source_id, I don't want to have duplication in source_id
+    sequence(:source_id) { |n| format("%010d", n) }
+
+    trait :with_immediate_release do
+      release_period { Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY }
+    end
+
+    trait :with_delayed_release do
+      release_period { Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_6_MONTHS }
+    end
+
+    before(:create) do |permission_template, evaluator|
+      if evaluator.with_admin_set
+        source_id = permission_template.source_id
+        admin_set = SourceFinder.find_or_create_admin_set(source_id)
+        permission_template.source_id = admin_set.id
+      elsif evaluator.with_collection
+        source_id = permission_template.source_id
+        collection =
+          if source_id.present?
+            begin
+              Collection.find(source_id)
+            rescue ActiveFedora::ObjectNotFoundError
+              create(:collection, id: source_id)
+            end
+          else
+            create(:collection)
+          end
+        permission_template.source_id = collection.id
+      end
+    end
+
+    after(:create) do |permission_template, evaluator|
+      if evaluator.with_workflows
+        Hyrax::Workflow::WorkflowImporter.load_workflow_for(permission_template: permission_template)
+        Sipity::Workflow.activate!(permission_template: permission_template, workflow_id: permission_template.available_workflows.pick(:id))
+      end
+      if evaluator.with_active_workflow
+        workflow = create(:workflow, active: true, permission_template: permission_template)
+        create(:workflow_action, workflow: workflow) # Need to create a single action that can be taken
+      end
+      AccessHelper.create_access(permission_template, 'user', :manage, evaluator.manage_users) if evaluator.manage_users.present?
+      AccessHelper.create_access(permission_template, 'group', :manage, evaluator.manage_groups) if evaluator.manage_groups.present?
+      AccessHelper.create_access(permission_template, 'user', :deposit, evaluator.deposit_users) if evaluator.deposit_users.present?
+      AccessHelper.create_access(permission_template, 'group', :deposit, evaluator.deposit_groups) if evaluator.deposit_groups.present?
+      AccessHelper.create_access(permission_template, 'user', :view, evaluator.view_users) if evaluator.view_users.present?
+      AccessHelper.create_access(permission_template, 'group', :view, evaluator.view_groups) if evaluator.view_groups.present?
+    end
+
+    transient do
+      with_admin_set { false }
+      with_collection { false }
+      with_workflows { false }
+      with_active_workflow { false }
+      manage_users { nil }
+      manage_groups { nil }
+      deposit_users { nil }
+      deposit_groups { nil }
+      view_users { nil }
+      view_groups { nil }
+    end
+  end
+
+  class AccessHelper
+    def self.create_access(permission_template_id, agent_type, access, agent_ids)
+      agent_ids.each do |agent_id|
+        FactoryBot.create(:permission_template_access,
+                          access,
+                          permission_template: permission_template_id,
+                          agent_type: agent_type,
+                          agent_id: agent_id)
+      end
+    end
+  end
+
+  class SourceFinder
+    def self.find_or_create_admin_set(source_id)
+      Hyrax.config.use_valkyrie? ? find_or_create_admin_set_valkyrie(source_id) : find_or_create_admin_set_active_fedora(source_id)
+    end
+
+    def self.find_or_create_admin_set_active_fedora(source_id)
+      if source_id.present?
+        begin
+          AdminSet.find(source_id)
+        rescue ActiveFedora::ObjectNotFoundError
+          FactoryBot.create(:admin_set, id: source_id)
+        end
+      else
+        FactoryBot.create(:admin_set)
+      end
+    end
+
+    def self.find_or_create_admin_set_valkyrie(source_id)
+      if source_id.present?
+        begin
+          Hyrax.query_service.find_by(id: source_id)
+        rescue Valkyrie::Persistence::ObjectNotFoundError
+          # Creating an Administrative set with a pre-determined id will not work for all adapters
+          # so we're letting the adapter assign the id
+          FactoryBot.valkyrie_create(:hyrax_admin_set)
+        end
+      else
+        FactoryBot.valkyrie_create(:hyrax_admin_set)
+      end
+    end
+  end
+end

data/spec/factories/proxy_deposit_requests.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# Read about factories at https://github.com/thoughtbot/factory_bot
+
+FactoryBot.define do
+  factory :proxy_deposit_request do
+  end
+end

data/spec/factories/single_use_links.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :single_use_link do
+    factory :show_link do
+      item_id { 'fs-id' }
+      path    { '/concerns/generic_work/1234' }
+    end
+
+    factory :download_link do
+      item_id { 'fs-id' }
+      path    { '/downloads/1234' }
+    end
+  end
+end

data/spec/factories/sipity_entities.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :sipity_entity, class: Sipity::Entity do
+    transient do
+      proxy_for { nil }
+    end
+
+    proxy_for_global_id { 'gid://internal/Mock/1' }
+    workflow { workflow_state.workflow }
+    workflow_state
+
+    after(:build) do |entity, evaluator|
+      entity.proxy_for_global_id = Hyrax::GlobalID(evaluator.proxy_for).to_s if
+        evaluator.proxy_for
+    end
+  end
+end

data/spec/factories/uploaded_files.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :uploaded_file, class: Hyrax::UploadedFile do
+    user
+    file { File.open(Hyrax::Engine.root.join('spec', 'fixtures', 'image.jp2').to_s) }
+
+    trait :audio do
+      file { File.open(Hyrax::Engine.root.join('spec', 'fixtures', 'sample_mpeg4.mp4').to_s) }
+    end
+  end
+end

data/spec/factories/users.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :user do
+    sequence(:email) { |n| "user#{n}@example.com" }
+    password { 'password' }
+
+    transient do
+      # Allow for custom groups when a user is instantiated.
+      # @example create(:user, groups: 'avacado')
+      groups { [] }
+    end
+
+    after(:build) do |user, evaluator|
+      User.group_service.add(user: user, groups: evaluator.groups)
+    end
+
+    factory :admin do
+      groups { ['admin'] }
+    end
+
+    factory :user_with_mail do
+      after(:create) do |user|
+        # Create examples of single file successes and failures
+        (1..10).each do |number|
+          file = MockFile.new(number.to_s, "Single File #{number}")
+          User.batch_user.send_message(user, 'File 1 could not be updated. You do not have sufficient privileges to edit it.', file.to_s, false)
+          User.batch_user.send_message(user, 'File 1 has been saved', file.to_s, false)
+        end
+
+        # Create examples of mulitple file successes and failures
+        files = []
+        (1..50).each do |number|
+          files << MockFile.new(number.to_s, "File #{number}")
+        end
+        User.batch_user.send_message(user, 'These files could not be updated. You do not have sufficient privileges to edit them.', 'Batch upload permission denied', false)
+        User.batch_user.send_message(user, 'These files have been saved', 'Batch upload complete', false)
+      end
+    end
+  end
+
+  trait :guest do
+    guest { true }
+  end
+end
+
+class MockFile
+  attr_accessor :to_s, :id
+  def initialize(id, string)
+    self.id = id
+    self.to_s = string
+  end
+end

data/spec/factories/workflow_actions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :workflow_action, class: Sipity::WorkflowAction do
+    workflow
+    name { 'submit' }
+  end
+end

data/spec/factories/workflow_states.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :workflow_state, class: Sipity::WorkflowState do
+    workflow
+    name { 'initial' }
+  end
+end

data/spec/factories/workflows.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :workflow, class: Sipity::Workflow do
+    sequence(:name) { |n| "generic_work-#{n}" }
+    permission_template
+  end
+end

data/spec/support/book_resource.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+module Hyrax
+  module Test
+    ##
+    # A simple Hyrax::Resource with some metadata.
+    #
+    # Use this for testing valkyrie models generically, with Hyrax assumptions
+    # but no PCDM modelling behavior.
+    class BookResource < Hyrax::Resource
+      attribute :author,    Valkyrie::Types::String
+      attribute :created,   Valkyrie::Types::Date
+      attribute :isbn,      Valkyrie::Types::String
+      attribute :publisher, Valkyrie::Types::String
+      attribute :title,     Valkyrie::Types::String
+    end
+
+    ##
+    # A simple Hyrax::ChangeSet with one custom validation.
+    #
+    # Hyrax::Test::BookResource will use this based on naming convention by adding `ChangeSet`
+    # to the end of the resource class name.
+    class BookResourceChangeSet < Hyrax::ChangeSet
+      validates :isbn, presence: true
+    end
+
+    class Book < ActiveFedora::Base
+      property :author,    predicate: ::RDF::URI('http://example.com/ns/author')
+      property :created,   predicate: ::RDF::URI('http://example.com/ns/created')
+      property :isbn,      predicate: ::RDF::URI('http://example.com/ns/isbn')
+      property :publisher, predicate: ::RDF::URI('http://example.com/ns/publisher')
+      property :title,     predicate: ::RDF::URI("http://example.com/ns/title")
+    end
+  end
+end
+
+Wings::ModelRegistry.register(Hyrax::Test::BookResource, Hyrax::Test::Book) if defined?(Wings)

data/spec/support/can_can_overrides.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+##
+# This monkey-patch shim is for both active_fedora and valkyrie resources for tests
+# This shim handles the case where controllers are loaded with an ActiveFedora collection class
+# different than a test mocks Hyrax.config.collection_class.
+# This override checks the value in Hyrax.config and uses it when it is a known collection or admin set class.
+# This override also memoizes the resource_class to avoid multiple lookups.
+CanCan::ControllerResource.class_eval do
+  def resource_class
+    return @resource_class if @resource_class.present?
+    @resource_class = case @options[:class]
+                      when false then
+                        name.to_sym
+                      when nil then
+                        namespaced_name.to_s.camelize.constantize
+                      when String then
+                        @options[:class].constantize
+                      else
+                        @options[:class]
+                      end
+    @resource_class = dynamically_resolve_class(@resource_class)
+  end
+
+  private
+
+  def dynamically_resolve_class(resource_class)
+    if collection_class?(resource_class)
+      Hyrax.config.collection_class
+    elsif admin_set_class?(resource_class)
+      Hyrax.config.admin_set_class
+    else
+      resource_class
+    end
+  end
+
+  def collection_class?(model_class)
+    model_class == Hyrax::PcdmCollection || model_class < Hyrax::PcdmCollection || model_class == ::Collection || model_class < ::Collection
+  end
+
+  def admin_set_class?(model_class)
+    model_class == Hyrax::AdministrativeSet || model_class < Hyrax::AdministrativeSet || model_class == AdminSet || model_class < AdminSet
+  end
+end

data/spec/support/clean_solr.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+RSpec.configure do |config|
+  config.before(:each, clean_index: true) do
+    client = Valkyrie::IndexingAdapter.find(:solr_index).connection
+    client.delete_by_query("*:*", params: { softCommit: true })
+  end
+end

data/spec/support/controller_level_helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ControllerLevelHelpers
+  # This provides some common mock methods for view tests.
+  # These are normally provided by the controller.
+  module ControllerViewHelpers
+    def search_state
+      @search_state ||= CatalogController.search_state_class.new(params, blacklight_config, controller)
+    end
+
+    # This allows you to set the configuration
+    # @example: view.blacklight_config = Blacklight::Configuration.new
+    attr_writer :blacklight_config
+
+    def blacklight_config
+      @blacklight_config ||= CatalogController.blacklight_config
+    end
+
+    def blacklight_configuration_context
+      @blacklight_configuration_context ||= Blacklight::Configuration::Context.new(controller)
+    end
+  end
+
+  def initialize_controller_helpers(helper)
+    helper.extend ControllerViewHelpers
+  end
+end