hyrax 5.0.0.rc2 → 5.0.0

data/spec/support/features.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# spec/support/features.rb
+require File.expand_path('../features/session_helpers', __FILE__)
+require File.expand_path('../features/workflow', __FILE__)
+require File.expand_path('../features/batch_edit_actions', __FILE__)
+require File.expand_path('../selectors', __FILE__)
+require File.expand_path('../statistic_helper', __FILE__)
+
+RSpec.configure do |config|
+  config.include Features::SessionHelpers, type: :feature
+end

data/spec/support/form_with_validations.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module Hyrax
+  module Test
+    class FormWithValidations < Hyrax::Forms::ResourceForm
+      property :title
+
+      validates :title, presence: true
+
+      # Added to comply with Hyrax::Forms::FailedSubmissionFormWrapper
+      def permitted_params
+        { title: [] }
+      end
+    end
+  end
+end

data/spec/support/input_support.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module InputSupport
+  extend ActiveSupport::Concern
+
+  include RSpec::Rails::HelperExampleGroup
+
+  def input_for(object, attribute_name, options = {})
+    helper.simple_form_for object, url: '' do |f|
+      f.input attribute_name, options
+    end
+  end
+end

data/spec/support/logging_formatter.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+RSpec::Support.require_rspec_core "formatters/base_text_formatter"
+class LoggingFormatter < RSpec::Core::Formatters::ProgressFormatter
+  RSpec::Core::Formatters.register self, :example_started, :example_passed, :dump_profile
+  def initialize(output)
+    @profile = []
+    reset!
+    ActiveSupport::Notifications.subscribe("http.ldp", method(:record_request))
+    super
+  end
+
+  def record_request(*_unused, data)
+    @request_count += 1
+    @request_count_by_name[data[:name]] += 1
+  end
+
+  def example_passed(passed)
+    super
+    @profile << { description: passed.example.full_description,
+                  count: @request_count,
+                  location: passed.example.location,
+                  count_by_name: @request_count_by_name }
+  end
+
+  def example_started(_passed)
+    reset!
+  end
+
+  def reset!
+    @request_count = 0
+    @request_count_by_name = { 'HEAD' => 0,
+                               'GET' => 0,
+                               'POST' => 0,
+                               'DELETE' => 0,
+                               'PUT' => 0,
+                               'PATCH' => 0 }
+  end
+
+  def dump_profile(profile)
+    dump_most_ldp_exampes(profile)
+    output.puts ""
+    dump_slowest_examples(profile)
+  end
+
+  private
+
+  def dump_most_ldp_exampes(_prof)
+    output.puts "Examples with the most LDP requests"
+    top = @profile.sort_by { |hash| hash[:count] }.last(10)
+    top.each do |hash|
+      result = hash[:count_by_name].select { |_, v| v.positive? }
+      next if result.empty?
+      output.puts "  #{hash[:description]}"
+      output.puts "    #{hash[:location]}"
+      output.puts "    Total LDP: #{hash[:count]} #{result}"
+    end
+  end
+
+  def dump_slowest_examples(profile)
+    output.puts "Slowest examples"
+    profile.slowest_examples.each do |slowest_example|
+      output.puts "  #{slowest_example.full_description}"
+      output.puts "    #{slowest_example.location}"
+      output.puts "    #{slowest_example.execution_result.run_time} seconds"
+    end
+  end
+end

data/spec/support/matchers/api_responses.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# RSpec matchers for API default JSON responses.
+# Creates a matcher like respond_forbidden or respond_not_found corresponding to each of the Api::V1.default_responses
+# Accepts optional overrides to the expected response body.
+# @example Override the description expected in the JSON body of a :forbidden response
+#   expect(response).to respond_forbidden(description:"You can't create for that identity")
+::Hyrax::API.default_responses.each_pair do |response_type, default_response_body|
+  RSpec::Matchers.define "respond_#{response_type}".to_sym do |expectation_options|
+    match do |response|
+      @expected_response_body = expectation_options.nil? ? default_response_body : default_response_body.merge(expectation_options)
+      expect(response.body).not_to be_empty
+      json = JSON.parse(response.body)
+      expect(response.code).to eq(@expected_response_body[:code].to_s)
+      @expected_response_body.each_pair do |key, value|
+        expect(json[key.to_s]).to eq(value.as_json)
+      end
+    end
+
+    failure_message do |actual|
+      "expected #{default_response_body[:code]} status code. Got #{actual.code} status code.\n" \
+      "expected an Authentication Required response like this:\n" \
+      " #{@expected_response_body.to_json} \ngot\n #{actual.body}\n" \
+      "To override expectations about the response body, provide a Hash of overrides in " \
+      "your call to :respond_#{response_type} "
+    end
+  end
+end

data/spec/support/matchers/collection_type_property_matchers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+RSpec::Matchers.define :require_membership do
+  match do |actual|
+    actual&.require_membership?
+  end
+end
+
+RSpec::Matchers.define :allow_multiple_membership do
+  match do |actual|
+    actual&.allow_multiple_membership?
+  end
+end
+
+RSpec::Matchers.define :assign_visibility do
+  match do |actual|
+    actual&.assigns_visibility?
+  end
+end
+
+RSpec::Matchers.define :assign_workflow do
+  match do |actual|
+    actual&.assigns_workflow?
+  end
+end
+
+RSpec::Matchers.define :have_collections do
+  match do |actual|
+    actual&.collections&.any?
+  end
+end

data/spec/support/matchers/embargo.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :be_an_embargo_matching do |embargo_args|
+  match do |embargo|
+    (embargo.visibility_after_embargo == embargo_args[:after]) &&
+      (embargo.visibility_during_embargo == embargo_args[:during]) &&
+      embargo.embargo_release_date.to_s.start_with?(embargo_args[:release_date][0..9])
+  end
+end

data/spec/support/matchers/lease.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :be_a_lease_matching do |lease_args|
+  match do |lease|
+    (lease.visibility_after_lease == lease_args[:after]) &&
+      (lease.visibility_during_lease == lease_args[:during]) &&
+      lease.lease_expiration_date.to_s.start_with?(lease_args[:release_date][0..9])
+  end
+end

data/spec/support/matchers/match_valkyrie_ids_with_af_ids.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Hyrax::Matchers
+  class MatchValkyrieIdsWithActiveFedoraIds < RSpec::Matchers::BuiltIn::ContainExactly
+    def match_when_sorted?
+      values_match?(safe_sort(expected), safe_sort(actual.map(&:id)))
+    end
+  end
+
+  def match_valkyrie_ids_with_active_fedora_ids(expected_fedora_ids)
+    MatchValkyrieIdsWithActiveFedoraIds.new(expected_fedora_ids)
+  end
+end

data/spec/support/matchers/pcdm_matchers.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+RSpec::Matchers.define :have_file_set_members do |*expected_file_sets|
+  match do |actual_work|
+    actual_file_sets = Hyrax.custom_queries.find_child_file_sets(resource: actual_work)
+
+    expect(actual_file_sets).to contain_exactly(*expected_file_sets)
+  end
+end
+
+RSpec::Matchers.define :have_attached_files do |*expected_files|
+  match do |actual_file_set|
+    @actual_files = Hyrax.custom_queries.find_files(file_set: actual_file_set)
+
+    (expected_files.empty? && @actual_files.any?) ||
+      values_match?(expected_files, @actual_files)
+  end
+
+  failure_message_for_should do |actual_file_set|
+    if expected_files.empty?
+      "Expected #{actual_file_set} to have at least one file.\n" \
+      "Found #{@actual_files}."
+    else
+      "Expected #{actual_file_set} to have files: #{expected_files}\n" \
+      "Found #{@actual_files}."
+    end
+  end
+end
+
+RSpec::Matchers.define :be_a_resource_with_permissions do |*expected_permissions|
+  match do |actual_resource|
+    expect(Hyrax::AccessControlList.new(resource: actual_resource).permissions)
+      .to include(*expected_permissions)
+  end
+end

data/spec/support/matchers/permission.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :grant_permission do |acl_type|
+  match do |permission|
+    access_match = permission.access == acl_type.to_s
+
+    agent_match =
+      if user_id
+        permission.type == 'person' &&
+          permission.agent.first.id.include?(user_id.to_s)
+      elsif group_id
+        permission.type == 'group' &&
+          permission.agent.first.id.include?(group_id.to_s)
+      else
+        true
+      end
+
+    target_match =
+      if access_to_id
+        permission.access_to_id == access_to_id.to_s
+      else
+        true
+      end
+
+    return access_match && agent_match && target_match
+  end
+
+  chain :on,       :access_to_id
+  chain :to_user,  :user_id
+  chain :to_group, :group_id
+end

data/spec/support/matchers/response_matchers.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+RSpec::Matchers.define :fail_redirect_and_flash do |path, flash_message|
+  match do |response|
+    expect(response.status).to eq 302
+    expect(response).to redirect_to(path)
+    expect(flash[:alert]).to eq flash_message
+  end
+end

data/spec/support/optional_example.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module OptionalExample
+  RSpec.configure do |config|
+    config.after do |example|
+      if example.metadata[:optional] && (RSpec::Core::Pending::PendingExampleFixedError === example.display_exception) # rubocop:disable Style/CaseEquality
+        ex = example.display_exception
+        example.display_exception = nil
+        example.execution_result.pending_exception = ex
+      end
+    end
+  end
+
+  def optional(message)
+    RSpec.current_example.metadata[:optional] = true
+    pending(message)
+  end
+end

data/spec/support/rake.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'rake'
+
+module RakeHelper
+  def load_rake_environment(files)
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    Rake::Task.define_task(:environment)
+    files.each { |file| load file }
+  end
+
+  def run_task(task, arg = nil)
+    capture_stdout_stderr do
+      @rake[task].invoke(arg)
+    end
+  end
+
+  # saves original $stdout in variable
+  # set $stdout as local instance of StringIO
+  # yields to code execution
+  # returns the local instance of StringIO
+  # resets $stdout to original value
+  def capture_stdout_stderr
+    out = StringIO.new
+    err = StringIO.new
+    $stdout = out
+    $stderr = err
+    begin
+      yield
+    rescue SystemExit => e
+      puts "error = #{e.inspect}"
+    end
+    "Output: #{out.string}\n Errors:#{err.string}"
+  ensure
+    $stdout = STDOUT
+    $stdout = STDERR
+  end
+
+  RSpec.configure do |config|
+    config.include RakeHelper
+  end
+end

data/spec/support/selectors.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+module Selectors
+  module Dashboard
+    def db_item_actions_toggle(item)
+      within "#document_#{item.id}" do
+        find '.dropdown-toggle'
+      end
+    end
+
+    # For use with javascript user selector that allows for searching for an existing user
+    # and granting them permission to an object.
+    # @param [User] user to select
+    # @param [String] role granting the user permission (e.g. 'Manager' | 'Depositor' | 'Viewer')
+    def select_user_for_admin_set(user, role = 'Depositor')
+      first('a.select2-choice').click
+      find('.select2-input').set(user.user_key)
+      first('div.select2-result-label').click
+      within('form.add-users') do
+        select(role)
+        click_button('Add')
+      end
+    end
+
+    # For use with javascript user selector that allows for searching for an existing user
+    # and granting them permission to an object.
+    # @param [User] user to select
+    # @param [String] role granting the user permission (e.g. 'Manager' | 'Depositor' | 'Viewer')
+    def select_user(user, role = 'Depositor')
+      first('a.select2-choice').click
+      find('.select2-input').set(user.user_key)
+      first('div.select2-result-label').click
+      within('div.add-users') do
+        select(role)
+        find('input.edit-collection-add-sharing-button').click
+      end
+    end
+
+    # For use with javascript collection selector that allows for searching for an existing collection from works relationship tab.
+    # Adds the collection and validates that the collection is listed in the Collection Relationship table once added.
+    # @param [Collection] collection to select
+    def select_collection(collection)
+      first('a.select2-choice').click
+      find('.select2-input').set(collection.title.first)
+      expect(page).to have_css('div.select2-result-label')
+      first('div.select2-result-label').click
+      first('[data-behavior~=add-relationship]').click
+      within('[data-behavior~=collection-relationships]') do
+        within('table.table.table-striped') do
+          expect(page).to have_content(collection.title.first)
+        end
+      end
+    end
+
+    # For use with javascript collection selector that allows for searching for an existing collection from add to collection modal.
+    # Does not save the selection.  The calling test is expected to click Save and validate the collection membership was added to the work.
+    # @param [Collection] collection to select
+    def select_member_of_collection(collection) # rubocop:disable Metrics/MethodLength
+      find('#s2id_member_of_collection_ids').click
+      find('.select2-input').set(collection.title.first)
+
+      # Crude way of waiting for the AJAX response
+      select2_results = false
+      begin_time = current_time = Time.now.to_f
+      while !select2_results && (current_time - begin_time) < 3
+        select2_results = page.has_css?('li.select2-result')
+        current_time = Time.now.to_f
+      end
+
+      within ".select2-result" do
+        find("span", text: collection.title.first).click
+      end
+    end
+  end
+
+  module NewTransfers
+    def new_owner_dropdown
+      find '#s2id_proxy_deposit_request_transfer_to'
+    end
+
+    def new_owner_search_field
+      within '#select2-drop' do
+        find '.select2-input'
+      end
+    end
+
+    def new_owner_search_result
+      within '#select2-drop' do
+        find '.select2-result-selectable'
+      end
+    end
+  end
+
+  module Transfers
+    def first_sent_cancel_button
+      within '#outgoing-transfers' do
+        find '.btn.btn-danger'
+      end
+    end
+
+    def first_received_accept_dropdown
+      within '#incoming-transfers' do
+        find '.dropdown-toggle.accept'
+      end
+    end
+
+    def first_received_reject_button
+      within '#incoming-transfers' do
+        find '.btn.btn-danger'
+      end
+    end
+  end
+end

data/spec/support/shared_examples_for_collection_presenter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "a total_viewable method" do
+  context('empty collection') { it { is_expected.to eq 0 } }
+
+  context "null members" do
+    let(:presenter) { described_class.new(SolrDocument.new(id: '123'), ability) }
+
+    it { is_expected.to eq 0 }
+  end
+end
+
+RSpec.shared_examples "a collection with public work and sub-collection" do
+  context "collection with public work and sub-collection" do
+    let!(:work) { create(:public_work, member_of_collections: [collection]) }
+    let!(:subcollection) { create(:public_collection_lw, member_of_collections: [collection]) }
+
+    it { is_expected.to eq 1 }
+  end
+end
+
+RSpec.shared_examples "a collection with public collection" do
+  context "collection with public collection" do
+    let!(:subcollection) { create(:public_collection_lw, member_of_collections: [collection]) }
+
+    it { is_expected.to eq 1 }
+  end
+end
+
+RSpec.shared_examples "a collection with public work" do
+  context "collection with public work" do
+    let!(:work) { create(:public_work, member_of_collections: [collection]) }
+
+    it { is_expected.to eq 1 }
+  end
+end
+
+RSpec.shared_examples "a collection with private work" do
+  context "collection with private work" do
+    let!(:work) { create(:private_work, member_of_collections: [collection]) }
+
+    it { is_expected.to eq 0 }
+  end
+end

data/spec/support/simple_work.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Test
+    ##
+    # A generic PCDM Work, with only Hyrax "core" (required) metadata.
+    #
+    # @example building with FactoryBot
+    #   work = FactoryBot.build(:hyrax_work, :public, title: ['Comet in Moominland'])
+    #
+    # @example creating with FactoryBot
+    #   work = FactoryBot.valkyrie_create(:hyrax_work, :public, title: ['Comet in Moominland'])
+    class SimpleWork < Hyrax::Work; end
+
+    class SimpleWorkLegacy < ActiveFedora::Base
+      include WorkBehavior
+      include CoreMetadata
+    end
+
+    class SimpleWorkSearchBuilder < Hyrax::WorkSearchBuilder
+      def work_types
+        [Hyrax::Test::SimpleWorkLegacy]
+      end
+    end
+  end
+end
+
+Wings::ModelRegistry.register(Hyrax::Test::SimpleWork, Hyrax::Test::SimpleWorkLegacy) if defined?(Wings)

data/spec/support/spec_statistic.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# This is a replacement for the OpenStruct usage. The idea is to expose
+# an object with a common interface.
+class SpecStatistic
+  def initialize(**kargs)
+    @attributes = kargs.symbolize_keys
+  end
+
+  def [](key)
+    @attributes[key.to_sym]
+  end
+
+  def method_missing(method_name, *arguments, &block)
+    if @attributes.key?(method_name.to_sym)
+      @attributes[method_name]
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    @attributes.key?(method_name.to_sym) || super
+  end
+end

data/spec/support/speedup.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+# Prevent recompiling assets in test.
+# See: https://github.com/rails/rails/pull/27271
+# This can be removed when we use Rails 5.1.0
+class << ActionView::LookupContext::DetailsKey
+  def clear; end
+end

data/spec/support/statistic_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module StatisticHelper
+  def statistic_date(date)
+    date.to_datetime.to_i * 1000
+  end
+
+  RSpec.configure do |config|
+    config.include StatisticHelper
+  end
+end

data/spec/support/valkyrie_indexing.rb

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+VALKYRIE_SOLR_TEST_URL = "http://127.0.0.1:#{ENV['TEST_JETTY_PORT'] || 8984}/solr/valkyrie-test-core"

data/spec/support/wings_models.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+return if Hyrax.config.disable_wings
+
+# Clear existing Collection mapping to allow reverse lookups to resolve CollectionResource.
+# Then restore PcdmCollection for any code directly using that model.
+Wings::ModelRegistry.unregister(Hyrax::PcdmCollection)
+Wings::ModelRegistry.register(CollectionResource, ::Collection)
+Wings::ModelRegistry.register(Hyrax::PcdmCollection, ::Collection)

data/template.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-# Hack for https://github.com/rails/rails/issues/35153
-gsub_file 'Gemfile', /^gem ["']sqlite3["']$/, 'gem "sqlite3", "~> 1.3.0"'
-gem 'hyrax', '5.0.0.rc2'
+gem 'hyrax', '5.0.0'
 run 'bundle install'
 generate 'hyrax:install', '-f'