hyrax 3.0.0.pre.beta1 → 3.0.0.pre.beta2

data/lib/wings/valkyrie/metadata_adapter.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Wings
+  module Valkyrie
+    class MetadataAdapter
+      def persister
+        @persister ||= Wings::Valkyrie::Persister.new(adapter: self)
+      end
+
+      # @return [Class] {Valkyrie::Persistence::Postgres::QueryService}
+      def query_service
+        @query_service ||= Wings::Valkyrie::QueryService.new(adapter: self)
+      end
+
+      # @return [Valkyrie::ID] Identifier for this metadata adapter.
+      def id
+        @id ||= begin
+          to_hash = "active_fedora"
+          ::Valkyrie::ID.new(Digest::MD5.hexdigest(to_hash))
+        end
+      end
+
+      # @return [Class] {Valkyrie::Persistence::Postgres::ResourceFactory}
+      def resource_factory
+        @resource_factory ||= Wings::Valkyrie::ResourceFactory.new(adapter: self)
+      end
+    end
+  end
+end

data/lib/wings/valkyrie/persister.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Wings
+  module Valkyrie
+    class Persister
+      attr_reader :adapter
+      extend Forwardable
+      def_delegator :adapter, :resource_factory
+
+      # @param adapter [Wings::Valkyrie::MetadataAdapter] The adapter which holds the resource_factory for this persister.
+      # @note Many persister methods are part of Valkyrie's public API, but instantiation itself is not
+      def initialize(adapter:)
+        @adapter = adapter
+      end
+
+      # Persists a resource using ActiveFedora
+      # @param [Valkyrie::Resource] resource
+      # @return [Valkyrie::Resource] the persisted/updated resource
+      def save(resource:)
+        af_object = resource_factory.from_resource(resource: resource)
+        af_object.save!
+        resource_factory.to_resource(object: af_object)
+      end
+
+      # # Persists a resource using ActiveFedora
+      # # @param [Valkyrie::Resource] resource
+      # # @return [Valkyrie::Resource] the persisted/updated resource
+      # def save_all(resources:)
+      #   resources.map do |resource|
+      #     save(resource: resource)
+      #   end
+      # end
+      #
+      # # Deletes a resource persisted using ActiveFedora
+      # # @param [Valkyrie::Resource] resource
+      # # @return [Valkyrie::Resource] the deleted resource
+      # def delete(resource:)
+      #   af_object = resource_factory.from_resource(resource: resource)
+      #   af_object.delete
+      # end
+      #
+      # # Deletes all resources from Fedora and Solr
+      # def wipe!
+      #   ActiveFedora::SolrService.instance.conn.delete_by_query("*:*")
+      #   ActiveFedora::SolrService.instance.conn.commit
+      #   ActiveFedora::Cleaner.clean!
+      # end
+    end
+  end
+end

data/lib/wings/valkyrie/query_service.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Wings
+  module Valkyrie
+    class QueryService
+      attr_reader :adapter
+      extend Forwardable
+      def_delegator :adapter, :resource_factory
+
+      # @param adapter [Wings::Valkyrie::MetadataAdapter] The adapter which holds the resource_factory for this query_service.
+      def initialize(adapter:)
+        @adapter = adapter
+      end
+
+      # Find a record using a Valkyrie ID, and map it to a Valkyrie Resource
+      # @param [Valkyrie::ID, String] id
+      # @return [Valkyrie::Resource]
+      # @raise [Valkyrie::Persistence::ObjectNotFoundError]
+      def find_by(id:)
+        id = ::Valkyrie::ID.new(id.to_s) if id.is_a?(String)
+        validate_id(id)
+        resource_factory.to_resource(object: ::ActiveFedora::Base.find(id.to_s))
+      rescue ::ActiveFedora::ObjectNotFoundError
+        raise ::Valkyrie::Persistence::ObjectNotFoundError
+      end
+
+      # Constructs a Valkyrie::Persistence::CustomQueryContainer using this query service
+      # @return [Valkyrie::Persistence::CustomQueryContainer]
+      def custom_queries
+        @custom_queries ||= ::Valkyrie::Persistence::CustomQueryContainer.new(query_service: self)
+      end
+
+      private
+
+        # Determines whether or not an Object is a Valkyrie ID
+        # @param [Object] id
+        # @raise [ArgumentError]
+        def validate_id(id)
+          raise ArgumentError, 'id must be a Valkyrie::ID' unless id.is_a? ::Valkyrie::ID
+        end
+    end
+  end
+end

data/lib/wings/valkyrie/resource_factory.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'wings/active_fedora_converter'
+
+module Wings
+  module Valkyrie
+    ##
+    # This class provides two-way mapping between `ActiveFedora::Base` and
+    # `Valkyrie::Resource` models.
+    #
+    # @see Wings::ActiveFedoraConverter
+    # @see Wings::Valkyrizable
+    class ResourceFactory
+      ##
+      # @!attribute [r] adapter
+      #   @return [MetadataAdapter]
+      attr_reader :adapter
+
+      delegate :id, to: :adapter, prefix: true
+
+      ##
+      # @param [MetadataAdapter] adapter
+      def initialize(adapter:)
+        @adapter = adapter
+      end
+
+      ##
+      # @param object [ActiveFedora::Base] AF record to be converted.
+      #
+      # @return [Valkyrie::Resource] Model representation of the AF record.
+      def to_resource(object:)
+        object.valkyrie_resource
+      end
+
+      ##
+      # @param resource [Valkyrie::Resource] Model to be converted to ActiveRecord.
+      #
+      # @return [ActiveFedora::Base] ActiveFedora
+      #   resource for the Valkyrie resource.
+      def from_resource(resource:)
+        ActiveFedoraConverter.new(resource: resource).convert
+      end
+    end
+  end
+end

data/lib/wings/valkyrizable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Wings
+  ##
+  # A mixin for `ActiveFedora::Base` models providing a convenience method
+  # mapping to a valkyrie resource.
+  #
+  # @example
+  #   GenericWork.include Wings::Valkyrizable
+  #
+  #   work     = GenericWork.new(title: ['Comet in Moominland'])
+  #   resource = work.valkyrie_resource
+  #
+  #   resource.title # => ['Comet in Moominland']
+  #
+  # @see Wings::ModelTransformer
+  module Valkyrizable
+    ##
+    # @return [Valkyrie::Resource] a valkyrie resource matching this model
+    def valkyrie_resource
+      ModelTransformer.for(self)
+    end
+  end
+end

data/lib/wings/value_mapper.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Wings
+  ##
+  # A base value mapper for converting property values in the
+  # `ActiveFedora`/`ActiveTriples` type system to `Valkyrie` types
+  #
+  # This top level matcher has registered several internal mappers which handle
+  # indivdual value types from the source data.
+  class ValueMapper < ::Valkyrie::ValueMapper; end
+
+  ##
+  # Maps `RDF::Term` values to their underlying types.
+  #
+  # Most importantly, this handles cases where a complex model implementing
+  # `RDF::Term` (e.g. an `ActiveFedora::Base` or `ActiveTriples::RDFSource`) is
+  # included as a value, casting it to an `RDF::URI` or `RDF::Node` which can be
+  # handled by `Valkyrie`.
+  #
+  # @see RDF::Term
+  class ResourceMapper < ValueMapper
+    ValueMapper.register(self)
+
+    ##
+    # @param value [Object]
+    #
+    # @return [Boolean]
+    def self.handles?(value)
+      value.respond_to?(:term?) && value.term?
+    end
+
+    ##
+    # @return [RDF::Term]
+    def result
+      value.to_term
+    end
+  end
+
+  ##
+  # Maps enumerable values (e.g. Array, Enumerable, Hash, etc...) by calling the
+  # parent `ValueMapper` on each member.
+  #
+  # @note a common value type this mapper handles is `ActiveTriples::Relation`
+  class EnumerableMapper < ValueMapper
+    ValueMapper.register(self)
+
+    ##
+    # @param value [Object]
+    def self.handles?(value)
+      value.is_a?(Enumerable)
+    end
+
+    ##
+    # @return [Enumerable<Object>]
+    def result
+      value.map { |v| calling_mapper.for(v).result }
+    end
+  end
+end

data/spec/abilities/collection_ability_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe 'CollectionAbility' do
 
   context 'when admin user' do
     let(:user) { FactoryBot.create(:admin) }
-    let!(:collection) { create(:collection, id: 'col_au', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_au', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     it 'allows all abilities' do # rubocop:disable RSpec/ExampleLength
@@ -34,7 +34,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when collection manager' do
-    let!(:collection) { create(:collection, id: 'col_mu', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_mu', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     before do
@@ -69,7 +69,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when collection depositor' do
-    let!(:collection) { create(:collection, id: 'col_du', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_du', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     before do
@@ -104,7 +104,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when collection viewer' do
-    let!(:collection) { create(:collection, id: 'col_vu', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { build(:collection_lw, id: 'col_vu', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     before do
@@ -139,7 +139,7 @@ RSpec.describe 'CollectionAbility' do
   end
 
   context 'when user has no special access' do
-    let!(:collection) { create(:collection, id: 'as', with_permission_template: true, collection_type_gid: collection_type_gid) }
+    let!(:collection) { create(:collection_lw, id: 'as', with_permission_template: true, collection_type_gid: collection_type_gid) }
     let!(:solr_document) { SolrDocument.new(collection.to_solr) }
 
     it 'denies all abilities' do # rubocop:disable RSpec/ExampleLength

data/spec/abilities/permission_template_ability_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe 'PermissionTemplateAbility' do
   let(:current_user) { user }
   let(:collection_type_gid) { create(:collection_type).gid }
 
-  let!(:collection) { create(:collection, with_permission_template: true, collection_type_gid: collection_type_gid) }
+  let!(:collection) { create(:collection_lw, with_permission_template: true, collection_type_gid: collection_type_gid) }
   let(:permission_template) { collection.permission_template }
   let!(:permission_template_access) do
     create(:permission_template_access,

data/spec/actors/hyrax/actors/collections_membership_actor_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Hyrax::Actors::CollectionsMembershipActor do
   end
 
   describe 'the next actor' do
-    let(:collection) { create(:collection, create_access: true) }
+    let(:collection) { build(:collection_lw, with_permission_template: true) }
     let(:attributes) do
       {
         member_of_collections_attributes: { '0' => { id: '123' } },
@@ -68,7 +68,7 @@ RSpec.describe Hyrax::Actors::CollectionsMembershipActor do
     end
 
     context "when work is in user's own collection and destroy is passed" do
-      let(:collection) { create(:collection, user: user, title: ['A good title'], create_access: true) }
+      let(:collection) { build(:collection_lw, user: user, title: ['A good title'], with_permission_template: true) }
       let(:attributes) do
         { member_of_collections_attributes: { '0' => { id: collection.id, _destroy: 'true' } } }
       end
@@ -86,7 +86,7 @@ RSpec.describe Hyrax::Actors::CollectionsMembershipActor do
 
     context "when work is in another user's collection" do
       let(:other_user) { create(:user) }
-      let(:other_collection) { create(:collection, user: other_user, title: ['A good title'], create_access: true) }
+      let(:other_collection) { build(:collection_lw, user: other_user, title: ['A good title'], with_permission_template: true) }
 
       before do
         curation_concern.member_of_collections = [other_collection]
@@ -100,79 +100,9 @@ RSpec.describe Hyrax::Actors::CollectionsMembershipActor do
       end
     end
 
-    context 'when passing `member_of_collection_ids`' do
-      let(:attributes) { { member_of_collection_ids: [collection.id], title: ['test'] } }
-
-      it 'adds it to the collection' do
-        skip 'this behavior past its deprecation sunset time and can be removed' if
-          Hyrax::VERSION.split('.').first.to_i >= 3
-
-        expect(subject.create(env)).to be true
-        expect(collection.reload.member_objects).to eq [curation_concern]
-      end
-
-      context 'when it is empty' do
-        let(:attributes) { { member_of_collection_ids: [], title: ['test'] } }
-
-        it 'does not add it to a collection' do
-          skip 'this behavior past its deprecation sunset time and can be removed' if
-            Hyrax::VERSION.split('.').first.to_i >= 3
-
-          expect(subject.create(env)).to be true
-          expect(collection.reload.member_objects).to eq []
-        end
-      end
-
-      context 'when it is an empty string' do
-        let(:attributes) { { member_of_collection_ids: '', title: ['test'] } }
-
-        it 'does not add it to a collection' do
-          skip 'this behavior past its deprecation sunset time and can be removed' if
-            Hyrax::VERSION.split('.').first.to_i >= 3
-
-          expect(subject.create(env)).to be true
-          expect(collection.reload.member_objects).to eq []
-        end
-      end
-
-      context "when work is in user's own collection" do
-        let(:attributes) { { member_of_collection_ids: [] } }
-
-        it "removes the work from that collection" do
-          skip 'this behavior past its deprecation sunset time and can be removed' if
-            Hyrax::VERSION.split('.').first.to_i >= 3
-
-          expect(subject.create(env)).to be true
-          expect(collection.reload.member_objects).to be_empty
-        end
-      end
-
-      describe "when work is in another user's collection" do
-        let(:other_user)    { create(:user) }
-        let(:collection)    { create(:collection, user: other_user, title: ['A good title']) }
-        let(:my_collection) { create(:collection, title: ['My good title']) }
-
-        let(:attributes) { { member_of_collection_ids: [my_collection.id] } }
-
-        before do
-          curation_concern.member_of_collections = [collection]
-          curation_concern.save!
-        end
-
-        it "doesn't remove the work from the other user's collection" do
-          skip 'this behavior past its deprecation sunset time and can be removed' if
-            Hyrax::VERSION.split('.').first.to_i >= 3
-
-          expect(subject.create(env)).to be true
-          expect(curation_concern.member_of_collections)
-            .to contain_exactly(collection, my_collection)
-        end
-      end
-    end
-
     context "updates env" do
       let!(:collection_type) { create(:collection_type) }
-      let!(:collection) { create(:collection, collection_type_gid: collection_type.gid, create_access: true) }
+      let!(:collection) { create(:collection_lw, collection_type_gid: collection_type.gid, with_permission_template: true) }
 
       subject(:middleware) do
         stack = ActionDispatch::MiddlewareStack.new.tap do |middleware|
@@ -205,7 +135,7 @@ RSpec.describe Hyrax::Actors::CollectionsMembershipActor do
         end
 
         context "when more than one collection" do
-          let(:collection2) { create(:collection, create_access: true) }
+          let(:collection2) { create(:collection_lw, with_permission_template: true) }
           let(:attributes) do
             {
               member_of_collections_attributes: {
@@ -241,7 +171,7 @@ RSpec.describe Hyrax::Actors::CollectionsMembershipActor do
             }
           end
 
-          it "removes member_of_collection_ids and does NOT add collection_id" do
+          it "removes member_of_collections_attributes and does NOT add collection_id" do
             expect(env.attributes).to have_key(:member_of_collections_attributes)
             expect(env.attributes[:member_of_collections_attributes].size).to eq 1
             expect(subject.create(env)).to be true
@@ -253,105 +183,6 @@ RSpec.describe Hyrax::Actors::CollectionsMembershipActor do
     end
   end
 
-  context 'when old style env parameter' do
-    describe 'create' do
-      let(:collection) { create(:collection) }
-      let(:attributes) do
-        { member_of_collection_ids: [collection.id], title: ['test'] }
-      end
-
-      it 'adds it to the collection' do
-        expect(subject.create(env)).to be true
-        expect(collection.reload.member_objects).to eq [curation_concern]
-      end
-
-      context 'when multiple membership checker returns a non-nil value' do
-        before do
-          allow(Hyrax::MultipleMembershipChecker).to receive(:new).and_return(checker)
-          allow(checker).to receive(:check).and_return(error_message)
-        end
-
-        let(:checker) { double('checker') }
-        let(:error_message) { 'Error: foo bar' }
-
-        it 'adds an error and returns false' do
-          expect(env.curation_concern.errors).to receive(:add).with(:collections, error_message)
-          expect(subject.create(env)).to be false
-          expect(curation_concern.member_of_collections).to be_empty
-        end
-      end
-
-      context "when work is in user's own collection" do
-        let(:collection) { create(:collection, user: user, title: ['A good title']) }
-        let(:attributes) { { member_of_collection_ids: [] } }
-
-        before do
-          subject.create(Hyrax::Actors::Environment.new(curation_concern, ability,
-                                                        member_of_collection_ids: [collection.id], title: ['test']))
-        end
-
-        it "removes the work from that collection" do
-          expect(subject.create(env)).to be true
-          expect(curation_concern.member_of_collections).to eq []
-        end
-      end
-
-      context "when work is in another user's collection" do
-        let(:other_user) { create(:user) }
-        let(:collection) { create(:collection, user: other_user, title: ['A good title']) }
-
-        it "doesn't remove the work from that collection" do
-          subject.create(env)
-          expect(subject.create(env)).to be true
-          expect(curation_concern.member_of_collections).to eq [collection]
-        end
-      end
-
-      context "updates env" do
-        let(:collection) do
-          create(:collection, collection_type_settings: [:discoverable, :sharable])
-        end
-
-        subject(:middleware) do
-          stack = ActionDispatch::MiddlewareStack.new.tap do |middleware|
-            middleware.use described_class
-          end
-          stack.build(terminator)
-        end
-
-        context "when only one collection" do
-          let(:attributes) do
-            { member_of_collection_ids: [collection.id], title: ['test'] }
-          end
-
-          it "removes member_of_collection_ids and adds collection_id to env" do
-            expect(env.attributes).to have_key(:member_of_collection_ids)
-            expect(env.attributes[:member_of_collection_ids].size).to eq 1
-            expect(subject.create(env)).to be true
-            expect(env.attributes).not_to have_key(:member_of_collection_ids)
-            expect(env.attributes).to have_key(:collection_id)
-            expect(env.attributes[:collection_id]).to eq collection.id
-          end
-        end
-
-        context "when more than one collection" do
-          let(:collection2) { create(:collection) }
-          let(:attributes) do
-            { member_of_collection_ids: [collection.id, collection2.id], title: ['test'] }
-          end
-
-          it "removes member_of_collection_ids and does NOT add collection_id" do
-            expect(env.attributes).to have_key(:member_of_collection_ids)
-            expect(env.attributes[:member_of_collection_ids].size).to eq 2
-            expect(subject.create(env)).to be true
-            expect(env.attributes).not_to have_key(:member_of_collection_ids)
-            expect(env.attributes).not_to have_key(:collection_id)
-          end
-        end
-      end
-    end
-  end
-
   class RemoveCollectionActor < Hyrax::Actors::AbstractActor
     # The collection is normally removed by ApplyPermissionTemplateActor, but this test doesn't setup and call that actor.
     # So we are faking it here and removing it before the GenericWorkActor is called.  Otherwise, it tries to save a