hyrax 2.8.0 → 3.0.0.pre.rc2

data/lib/hyrax/specs/shared_specs/identifiers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a Hyrax::Identifier::Builder' do
+  subject(:builder) { described_class.new }
+
+  describe '#build' do
+    it 'returns an identifier string' do
+      expect(builder.build(hint: 'moomin'))
+        .to respond_to :to_str
+    end
+  end
+end
+
+RSpec.shared_examples 'a Hyrax::Identifier::Registrar' do
+  subject(:registrar) { described_class.new(builder: builder) }
+  let(:builder)       { instance_double(Hyrax::Identifier::Builder, build: 'moomin') }
+  let(:object)        { instance_double(GenericWork, id: 'moomin_id') }
+
+  it { is_expected.to have_attributes(builder: builder) }
+
+  describe '#register!' do
+    it 'creates an identifier record' do
+      expect(registrar.register!(object: object).identifier)
+        .to respond_to :to_str
+    end
+  end
+end

data/lib/hyrax/specs/shared_specs/indexers.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+# These shared specs test various aspects of valkyrie based indexers by calling the #to_solr method.
+# All tests require two variables to be set in the caller using let statements:
+#   * indexer_class - class of the indexer being tested
+#   * resource - a Hyrax::Resource that defines attributes and values consistent with the indexer
+#
+# NOTE: It is important that the resource has required values that the indexer #to_solr customizations expects to be available.
+RSpec.shared_examples 'a Hyrax::Resource indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
+    resource.alternate_ids = ids
+  end
+  subject(:indexer)  { indexer_class.new(resource: resource) }
+  let(:ids)          { ['id1', 'id2'] }
+
+  describe '#to_solr' do
+    it 'indexes alternate_ids' do
+      expect(indexer.to_solr)
+        .to include(alternate_ids_sm: a_collection_containing_exactly(*ids))
+    end
+  end
+end
+
+RSpec.shared_examples 'a permission indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    # NOTE: resource must be persisted for these tests to pass
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
+    Hyrax::VisibilityWriter.new(resource: resource)
+        .assign_access_for(visibility: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC)
+    resource.permission_manager.edit_groups = edit_groups
+    resource.permission_manager.edit_users  = edit_users
+    resource.permission_manager.read_users  = read_users
+    resource.permission_manager.acl.save
+  end
+  subject(:indexer) { indexer_class.new(resource: resource) }
+  let(:edit_groups) { [:managers] }
+  let(:edit_users)  { [FactoryBot.create(:user)] }
+  let(:read_users)  { [FactoryBot.create(:user)] }
+
+  describe '#to_solr' do
+    it 'indexes read permissions' do
+      expect(indexer.to_solr)
+        .to include(Hydra.config.permissions.read.group => ['public'],
+                    Hydra.config.permissions.read.individual => read_users.map(&:user_key))
+    end
+
+    it 'indexes edit permissions' do
+      expect(indexer.to_solr)
+        .to include(Hydra.config.permissions.edit.group => edit_groups.map(&:to_s),
+                    Hydra.config.permissions.edit.individual => edit_users.map(&:user_key))
+    end
+  end
+end
+
+RSpec.shared_examples 'a visibility indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
+    # optionally can pass in default_visibility by setting it with a let statement if your application changes the default; Hyrax defines this as 'restricted'
+    # See samvera/hyrda-head hydra-access-controls/app/models/concerns/hydra/access_controls/access_rights.rb for possible VISIBILITY_TEXT_VALUE_...'
+  end
+  subject(:indexer)  { indexer_class.new(resource: resource) }
+
+  describe '#to_solr' do
+    it 'indexes default visibility as restricted or passed in default' do
+      expected_value = defined?(default_visibility) ? default_visibility : 'restricted'
+      expect(indexer.to_solr).to include(visibility_ssi: expected_value)
+    end
+
+    context 'when resource is public' do
+      before do
+        Hyrax::VisibilityWriter.new(resource: resource)
+          .assign_access_for(visibility: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC)
+      end
+
+      it 'indexes as open' do
+        expect(indexer.to_solr).to include(visibility_ssi: 'open')
+      end
+    end
+  end
+end
+
+RSpec.shared_examples 'a Core metadata indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    # NOTE: The resource's class is expected to have or inherit `include Hyrax::Schema(:core_metadata)`
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
+    resource.title = titles
+  end
+  subject(:indexer) { indexer_class.new(resource: resource) }
+  let(:titles)      { ['Comet in Moominland', 'Finn Family Moomintroll'] }
+
+  describe '#to_solr' do
+    it 'indexes title as text' do
+      expect(indexer.to_solr)
+        .to include(title_tesim: a_collection_containing_exactly(*titles))
+    end
+
+    it 'indexes title as string' do
+      expect(indexer.to_solr)
+        .to include(title_sim: a_collection_containing_exactly(*titles))
+    end
+  end
+end
+
+RSpec.shared_examples 'a Basic metadata indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    # NOTE: The resource's class is expected to to have or inherit `include Hyrax::Schema(:basic_metadata)`
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Resource' unless defined?(resource) && resource.kind_of?(Hyrax::Resource)
+    attributes.each { |k, v| resource.set_value(k, v) }
+  end
+  subject(:indexer) { indexer_class.new(resource: resource) }
+
+  let(:attributes) do
+    {
+      keyword: ['comic strip'],
+      subject: ['moomins', 'snorks']
+    }
+  end
+
+  describe '#to_solr' do
+    it 'indexes basic metadata' do
+      expect(indexer.to_solr)
+        .to include(keyword_sim:   a_collection_containing_exactly(*attributes[:keyword]),
+                    subject_tesim: a_collection_containing_exactly(*attributes[:subject]),
+                    subject_sim:   a_collection_containing_exactly(*attributes[:subject]))
+    end
+  end
+end
+
+RSpec.shared_examples 'a Work indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    # NOTE: resource must be persisted for permission tests to pass
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::Work' unless defined?(resource) && resource.kind_of?(Hyrax::Work)
+    # optionally can pass in default_visibility by setting it with a let statement if your application changes the default; Hyrax defines this as 'restricted'
+    # See samvera/hyrda-head hydra-access-controls/app/models/concerns/hydra/access_controls/access_rights.rb for possible VISIBILITY_TEXT_VALUE_...'
+  end
+  subject(:indexer) { indexer_class.new(resource: resource) }
+
+  it_behaves_like 'a Hyrax::Resource indexer'
+  it_behaves_like 'a Core metadata indexer'
+  it_behaves_like 'a permission indexer'
+  it_behaves_like 'a visibility indexer'
+end
+
+RSpec.shared_examples 'a Collection indexer' do
+  before do
+    raise 'indexer_class must be set with `let(:indexer_class)`' unless defined? indexer_class
+    # NOTE: resource must be persisted for permission tests to pass
+    raise 'resource must be set with `let(:resource)` and is expected to be a kind of Hyrax::PcdmCollection' unless defined?(resource) && resource.kind_of?(Hyrax::PcdmCollection)
+  end
+  subject(:indexer) { indexer_class.new(resource: resource) }
+
+  it_behaves_like 'a Hyrax::Resource indexer'
+  it_behaves_like 'a Core metadata indexer'
+  it_behaves_like 'a permission indexer'
+  it_behaves_like 'a visibility indexer'
+
+  describe '#to_solr' do
+    it 'indexes generic type' do
+      expect(indexer.to_solr)
+        .to include(generic_type_sim: a_collection_containing_exactly('Collection'))
+    end
+
+    it 'indexes thumbnail' do
+      expect(indexer.to_solr)
+        .to include(thumbnail_path_ss: include('assets/collection', '.png'))
+    end
+  end
+end

data/lib/hyrax/specs/shared_specs/metadata.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'a model with core metadata' do
+  subject(:resource) { described_class.new }
+  let(:date)         { Time.zone.today }
+
+  it 'has a date_modified' do
+    expect { resource.date_modified = date }
+      .to change { resource.date_modified }
+      .to eq date
+  end
+
+  it 'has a date_uploaded' do
+    expect { resource.date_uploaded = date }
+      .to change { resource.date_uploaded }
+      .to eq date
+  end
+
+  it 'has a depositor' do
+    expect { resource.depositor = 'userid' }
+      .to change { resource.depositor }
+      .to eq 'userid'
+  end
+
+  it 'has a title' do
+    expect { resource.title = ['title'] }
+      .to change { resource.title }
+      .to contain_exactly('title')
+  end
+end

data/lib/hyrax/specs/spy_listener.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Hyrax
+  module Specs
+    class SpyListener
+      attr_reader :file_set_attached, :file_set_url_imported, :object_deleted,
+                  :object_deposited, :object_failed_deposit, :object_acl_updated,
+                  :object_metadata_updated
+
+      def on_object_deleted(event)
+        @object_deleted = event
+      end
+
+      def on_object_deposited(event)
+        @object_deposited = event
+      end
+
+      def on_object_failed_deposit(event)
+        @object_failed_deposit = event
+      end
+
+      def on_object_acl_updated(event)
+        @object_acl_updated = event
+      end
+
+      def on_object_metadata_updated(event)
+        @object_metadata_updated = event
+      end
+
+      def on_file_set_attached(event)
+        @file_set_attached = event
+      end
+
+      def on_file_set_url_imported(event)
+        @file_set_url_imported = event
+      end
+    end
+  end
+end

data/lib/hyrax/transactions.rb

@@ -5,17 +5,12 @@ module Hyrax
   ##
   # This is a parent module for DRY Transaction classes handling Hyrax
   # processes. Especially: transactions and steps for creating, updating, and
-  # destroying PCDM Objects are located here. Loading this module provides an
-  # easy way to load the full suite of transactions included for these purposes.
-  #
-  # @note These uses of `dry-transaction` are currently experimental
-  #   replacements for actor stack behavior. They are not loaded during normal
-  #   execution in a stock Hyrax application.
+  # destroying PCDM Objects are located here.
   #
   # @since 2.4.0
   #
   # @example
-  #   require 'hyrax/transactions'
+  #   Hyrax::Transaction::Container['transaction_name'].call(:input)
   #
   # @see https://dry-rb.org/gems/dry-transaction/
   module Transactions

data/lib/hyrax/transactions/apply_change_set.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require 'hyrax/transactions/transaction'
+
+module Hyrax
+  module Transactions
+    ##
+    # Applies and saves a `ChangeSet`.
+    #
+    # This transaction is intended to ensure appropriate results for a Hyrax
+    # model when saving changes from a `ChangeSet`. For example: it will set the
+    # system-managed metadata like modified date.
+    #
+    # If your application has custom system managed metadata, this is an
+    # appropriate place to inject that behavior.
+    #
+    # This will also validate the `ChangeSet`. Which validations to use is
+    # delegated on the `ChangeSet` itself.
+    #
+    # @since 3.0.0
+    #
+    # @example Applying a ChangeSet to a Work
+    #   work = Hyrax::Work.new
+    #   change_set = Hyrax::ChangeSet.for(work)
+    #   change_set.title = ['Comet in Moominland']
+    #
+    #   transaction = Hyrax::Transactions::ApplyChangeSet.new
+    #   result = transaction.call(change_set) # => Success(#<Hyrax::Work ...>)
+    #
+    #   result.bind(&:persisted?) => true
+    #
+    #   persisted = result.value_or { raise 'oh no!' } # safe unwrap
+    #   persisted.title      # => ['Comet in Moominland']
+    #
+    class ApplyChangeSet < Transaction
+      DEFAULT_STEPS = ['change_set.set_modified_date',
+                       'change_set.set_uploaded_date_unless_present',
+                       'change_set.validate',
+                       'change_set.save'].freeze
+
+      ##
+      # @see Hyrax::Transactions::Transaction
+      def initialize(container: Container, steps: DEFAULT_STEPS)
+        super
+      end
+    end
+  end
+end

data/lib/hyrax/transactions/container.rb

@@ -18,22 +18,93 @@ module Hyrax
     #
     # @see https://dry-rb.org/gems/dry-container/
     class Container
+      require 'hyrax/transactions/apply_change_set'
       require 'hyrax/transactions/create_work'
+      require 'hyrax/transactions/destroy_work'
+      require 'hyrax/transactions/work_create'
+      require 'hyrax/transactions/update_work'
+      require 'hyrax/transactions/steps/add_to_collections'
+      require 'hyrax/transactions/steps/apply_collection_permission_template'
       require 'hyrax/transactions/steps/apply_permission_template'
+      require 'hyrax/transactions/steps/apply_visibility'
+      require 'hyrax/transactions/steps/destroy_work'
       require 'hyrax/transactions/steps/ensure_admin_set'
       require 'hyrax/transactions/steps/ensure_permission_template'
+      require 'hyrax/transactions/steps/save'
       require 'hyrax/transactions/steps/save_work'
       require 'hyrax/transactions/steps/set_default_admin_set'
       require 'hyrax/transactions/steps/set_modified_date'
-      require 'hyrax/transactions/steps/set_uploaded_date'
+      require 'hyrax/transactions/steps/set_uploaded_date_unless_present'
+      require 'hyrax/transactions/steps/set_user_as_depositor'
+      require 'hyrax/transactions/steps/validate'
 
       extend Dry::Container::Mixin
 
+      # Disable BlockLength rule for DSL code
+      # rubocop:disable Metrics/BlockLength
+      namespace 'change_set' do |ops|
+        ops.register 'add_to_collections' do
+          Steps::AddToCollections.new
+        end
+
+        ops.register 'apply' do
+          ApplyChangeSet.new
+        end
+
+        ops.register 'create_work' do
+          WorkCreate.new
+        end
+
+        ops.register 'ensure_admin_set' do
+          Steps::EnsureAdminSet.new
+        end
+
+        ops.register 'save' do
+          Steps::Save.new
+        end
+
+        ops.register 'set_default_admin_set' do
+          Steps::SetDefaultAdminSet.new
+        end
+
+        ops.register 'set_modified_date' do
+          Steps::SetModifiedDate.new
+        end
+
+        ops.register 'set_uploaded_date_unless_present' do
+          Steps::SetUploadedDateUnlessPresent.new
+        end
+
+        ops.register 'set_user_as_depositor' do
+          Steps::SetUserAsDepositor.new
+        end
+
+        ops.register 'update_work' do
+          UpdateWork.new
+        end
+
+        ops.register 'validate' do
+          Steps::Validate.new
+        end
+      end
+
       namespace 'work' do |ops|
+        ops.register 'apply_collection_permission_template' do
+          Steps::ApplyCollectionPermissionTemplate.new
+        end
+
         ops.register 'apply_permission_template' do
           Steps::ApplyPermissionTemplate.new
         end
 
+        ops.register 'apply_visibility' do
+          Steps::ApplyVisibility.new
+        end
+
+        ops.register 'destroy_work' do
+          Steps::DestroyWork.new
+        end
+
         ops.register 'ensure_admin_set' do
           Steps::EnsureAdminSet.new
         end
@@ -54,10 +125,11 @@ module Hyrax
           Steps::SetModifiedDate.new
         end
 
-        ops.register 'set_uploaded_date' do
-          Steps::SetUploadedDate.new
+        ops.register 'set_uploaded_date_unless_present' do
+          Steps::SetUploadedDateUnlessPresent.new
         end
       end
+      # rubocop:enable Metrics/BlockLength
     end
   end
 end