hyrax 5.0.0.rc2 → 5.0.0.rc3

data/lib/wings/model_transformer.rb

@@ -83,8 +83,25 @@ module Wings
       # otherwise, we can just rely on the `access_control_ids`.
       return unless resource.respond_to?(:permission_manager)
 
-      resource.permission_manager.acl.permissions =
-        pcdm_object.access_control.valkyrie_resource.permissions
+      # When the pcdm_object has an access_control (see above) but there's no access_control_id, we
+      # need to rely on the computed access_control object.  Why?  There are tests that fail.
+      acl = if pcdm_object.access_control_id.nil?
+              pcdm_object.access_control.valkyrie_resource
+            else
+              begin
+                # Given that we have an access_control AND an access_control_id, we want to ensure
+                # that we fetch the access_control from persistence.  Why?  Because when we update
+                # an ACL and are using those adapters, we will write the ACL to the Valkyrie adapter
+                # without writing the work to the Valkyrie adapter.  This might be a failing, but
+                # migrations in place are hard.
+                acl_id = pcdm_object.access_control_id
+                acl_id = ::Valkyrie::ID.new(acl_id) unless acl_id.is_a?(::Valkyrie::ID)
+                Hyrax.query_service.find_by(id: acl_id)
+              rescue ::Valkyrie::Persistence::ObjectNotFoundError
+                pcdm_object.access_control.valkyrie_resource
+              end
+            end
+      resource.permission_manager.acl.permissions = acl.permissions
     end
 
     ##

data/lib/wings/orm_converter.rb

@@ -40,6 +40,10 @@ module Wings
             _canonical_valkyrie_model&.name
           end
 
+          def to_rdf_representation
+            name
+          end
+
           ##
           # @return [String]
           def to_s

data/lib/wings/services/custom_queries/find_ids_by_model.rb

@@ -29,7 +29,7 @@ module Wings
         model_name = ModelRegistry.lookup(model).model_name
 
         solr_query = "_query_:\"{!raw f=has_model_ssim}#{model_name}\""
-        solr_response = ActiveFedora::SolrService.get(solr_query, fl: 'id', rows: @query_rows)['response']
+        solr_response = Hyrax::SolrService.get(solr_query, fl: 'id', rows: @query_rows)['response']
 
         loop do
           response_docs = solr_response['docs']
@@ -38,7 +38,7 @@ module Wings
           response_docs.each { |doc| yield doc['id'] }
 
           break if (solr_response['start'] + solr_response['docs'].count) >= solr_response['numFound']
-          solr_response = ActiveFedora::SolrService.get(solr_query, fl: 'id', rows: @query_rows, start: solr_response['start'] + @query_rows)['response']
+          solr_response = Hyrax::SolrService.get(solr_query, fl: 'id', rows: @query_rows, start: solr_response['start'] + @query_rows)['response']
         end
       end
     end

data/lib/wings/valkyrie/query_service.rb

@@ -23,7 +23,7 @@ module Wings
       def count_all_of_model(model:)
         ActiveFedora::Base
           .where(has_model_ssim: [model_class_for(model).to_rdf_representation,
-                                  model.new.internal_resource.to_s])
+                                  model.to_rdf_representation])
           .count
       end
 
@@ -63,6 +63,9 @@ module Wings
       #
       # @param model [Class]
       # @return [Array<Valkyrie::Resource>]
+      #
+      # @note Due to implementation details, .find_all_of_model and .count_all_of_model may not
+      #       return the same number of results.  Is that a bug?  Probably.
       def find_all_of_model(model:)
         model_class_for(model).all.map do |obj|
           resource_factory.to_resource(object: obj)
@@ -139,7 +142,7 @@ module Wings
         return find_many_by_ids(ids: Array(resource.send(property))) unless model
 
         results = resource.public_send(property).map do |reference|
-          resource_factory.to_resource(object: ::ActiveFedora::Base.find(reference))
+          resource_factory.to_resource(object: ::ActiveFedora::Base.find(reference.to_s))
         end
 
         results.select { |r| r.class.name == model.name }

data/lib/wings.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Short circuit loading if Wings is disabled
+return if Hyrax.config.disable_wings
+
 ##
 # Wings is a toolkit integrating Valkyrie into Hyrax as a bridge away from the
 # hard dependency on ActiveFedora.

data/spec/factories/access_control.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :access_control, class: Hyrax::AccessControl do
+    permissions { build(:permission) }
+
+    trait :with_target do
+      access_to { valkyrie_create(:hyrax_resource).id }
+
+      permissions { build(:permission, access_to: access_to) }
+    end
+  end
+end

data/spec/factories/admin_sets.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :admin_set do
+    sequence(:title) { |n| ["Title #{n}"] }
+
+    # Given the relationship between permission template and admin set, when
+    # an admin set is created via a factory, I believe it is appropriate to go ahead and
+    # create the corresponding permission template
+    #
+    # This way, we can go ahead
+    after(:create) do |admin_set, evaluator|
+      if evaluator.with_permission_template
+        attributes = { source_id: admin_set.id }
+        attributes = evaluator.with_permission_template.merge(attributes) if evaluator.with_permission_template.respond_to?(:merge)
+        # There is a unique constraint on permission_templates.source_id; I don't want to
+        # create a permission template if one already exists for this admin_set
+        create(:permission_template, attributes) unless Hyrax::PermissionTemplate.find_by(source_id: admin_set.id)
+      end
+    end
+
+    transient do
+      # false, true, or Hash with keys for permission_template
+      with_permission_template { false }
+    end
+
+    factory :complete_admin_set do
+      alternative_title { ['alternative admin set title'] }
+      creator           { ['moomin', 'snufkin'] }
+      description       { ['Before a revolution happens', 'it is perceived as impossible'] }
+    end
+  end
+end

data/spec/factories/admin_sets_lw.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  # Tests that create a Fedora Object are very slow.  This factory lets you control which parts of the object ecosystem
+  # get built.
+  #
+  # PREFERRED: Use build whenever possible.  You can control the creation of the permission template and solr document
+  #            by passing parameters to the build(:admin_set_lw) method.  That way you can build only the parts needed
+  #            for a specific test.
+  #
+  # AVOID: Do not use create unless absolutely necessary.  It will create everything including the Fedora object.
+  #
+  # @example Simple build of an admin set with no additional parts created.  Lightest weight.
+  #          NOTE: A user is automatically created as the owner of the admin set.
+  #   let(:adminset) { build(:adminset_lw) }
+  #
+  # @example Simple build of an admin set with no additional parts created.  User is the owner of the admin set.  Lightest weight.
+  #   let(:adminset) { build(:adminset_lw, user:) }
+  #
+  # @example Simple build of an admin set with only solr-document.  Owner is given edit-access in solr-document. Light weight.
+  #   let(:adminset) { build(:adminset_lw, with_solr_document: true) }
+  #
+  # @example Simple build of an admin set with only a permission template created.  Owner is set as a manager.  Light weight.
+  #   let(:adminset) { build(:adminset_lw, with_permission_template: true) }
+  #
+  # @example Build an admin set with only a permission template created.  Permissions are set based on
+  #          attributes set for `with_permission_template`.  Middle weight.
+  #   # permissions passed thru `with_permission_template` can be any of the following in any combination
+  #   let(:permissions) { { manage_users: [user.user_key],  # multiple users can be listed
+  #                         deposit_users: [user.user_key],
+  #                         view_users: [user.user_key],
+  #                         manage_groups: [group_name],    # multiple groups can be listed
+  #                         deposit_groups: [group_name],
+  #                         view_groups: [group_name],  } }
+  #   let(:adminset) { build(:adminset_lw, user: , with_permission_template: permissions) }
+  #
+  # @example Build an admin set with permission template and solr-document created.  Permissions are set based on
+  #          attributes set for `with_permission_template`.  Solr-document includes read/edit access defined based
+  #          on attributes passed thru `with_permission_template`.  Middle weight.
+  #   # permissions passed thru `with_permission_template` can be any of the following in any combination
+  #   let(:permissions) { { manage_users: [user.user_key],  # multiple users can be listed
+  #                         deposit_users: [user.user_key],
+  #                         view_users: [user.user_key],
+  #                         manage_groups: [group_name],    # multiple groups can be listed
+  #                         deposit_groups: [group_name],
+  #                         view_groups: [group_name],  } }
+  #   let(:adminset) { build(:adminset_lw, user: , with_permission_template: permissions, with_solr_document: true) }
+  #
+  # @example Create an admin set with everything.  Extreme heavy weight.  This is very slow and should be avoided.
+  #          NOTE: Everything gets created.
+  #          NOTE: Build options effect created admin sets as follows...
+  #                 * `with_permission_template` can specify user/group permissions.  A permission template is always created.
+  #                 * `with_solr_document` is ignored.  A solr document is always created.
+  #   let(:adminset) { create(:adminset_lw) }
+  #
+  # @example Build the default admin set with permission template, solr doc, and default adminset's metadata.
+  #   let(:default_adminset) { build(:default_adminset) }
+
+  factory :adminset_lw, class: AdminSet do
+    transient do
+      user { FactoryBot.create(:user) }
+
+      with_permission_template { false }
+      with_solr_document { false }
+    end
+    sequence(:title) { |n| ["Collection Title #{n}"] }
+
+    after(:build) do |adminset, evaluator|
+      adminset.creator = [evaluator.user.user_key]
+
+      AdminSetFactoryHelper.process_with_permission_template(adminset, evaluator)
+      AdminSetFactoryHelper.process_with_solr_document(adminset, evaluator)
+    end
+
+    before(:create) do |adminset, evaluator|
+      # force create a permission template if it doesn't exist for the newly created admin set
+      AdminSetFactoryHelper.process_with_permission_template(adminset, evaluator, true) unless evaluator.with_permission_template
+    end
+
+    after(:create) do |adminset, _evaluator|
+      adminset.permission_template.reset_access_controls_for(collection: adminset)
+    end
+
+    factory :default_adminset, class: AdminSet do
+      transient do
+        with_permission_template do
+          {
+            deposit_groups: [::Ability.registered_group_name],
+            manage_groups: [::Ability.admin_group_name]
+          }
+        end
+        with_solr_document { true }
+        with_persisted_default_id { true }
+      end
+      id { AdminSet::DEFAULT_ID }
+      title { AdminSet::DEFAULT_TITLE }
+
+      after(:create) do |admin_set, evaluator|
+        Hyrax::DefaultAdministrativeSet.update(default_admin_set_id: admin_set.id) if
+          evaluator.with_persisted_default_id
+      end
+    end
+  end
+
+  factory :no_solr_grants_adminset, class: AdminSet do
+    # Builds a pre-Hyrax 2.1.0 adminset without edit/view grants on the admin set.
+    # Do not use with create because the save will cause the solr grants to be created.
+    transient do
+      user { FactoryBot.create(:user) }
+      with_permission_template { true }
+      with_solr_document { true }
+    end
+
+    sequence(:title) { |n| ["No Solr Grant Admin Set Title #{n}"] }
+
+    after(:build) do |adminset, evaluator|
+      adminset.creator = [evaluator.user.user_key]
+      AdminSetFactoryHelper.process_with_permission_template(adminset, evaluator, true)
+      AdminSetFactoryHelper.process_with_solr_document(adminset, evaluator, true)
+    end
+  end
+
+  class AdminSetFactoryHelper
+    # @returns array of user keys
+    def self.permission_from_template(permission_template_attributes, permission_key)
+      permissions = []
+      return permissions if permission_template_attributes.blank?
+      return permissions unless permission_template_attributes.is_a? Hash
+      return permissions unless permission_template_attributes.key?(permission_key)
+      permission_template_attributes[permission_key]
+    end
+    private_class_method :permission_from_template
+
+    # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
+    # @parem [String] creator_user is the user who created the new admin set
+    # @param [Boolean] include_creator, when true, adds the creator_user as a manager
+    # @returns array of user keys
+    def self.user_managers(permission_template_attributes, creator_user)
+      managers = permission_from_template(permission_template_attributes, :manage_users)
+      managers << creator_user
+      managers.uniq
+    end
+
+    # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
+    # @returns array of user keys
+    def self.group_managers(permission_template_attributes)
+      permission_from_template(permission_template_attributes, :manage_groups).uniq
+    end
+
+    # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
+    # @returns array of user keys
+    def self.user_depositors(permission_template_attributes)
+      permission_from_template(permission_template_attributes, :deposit_users).uniq
+    end
+
+    # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
+    # @returns array of user keys
+    def self.group_depositors(permission_template_attributes)
+      permission_from_template(permission_template_attributes, :deposit_groups).uniq
+    end
+
+    # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
+    # @returns array of user keys
+    def self.user_viewers(permission_template_attributes)
+      permission_from_template(permission_template_attributes, :view_users).uniq
+    end
+
+    # @param [Hash] permission_template_attributes where names identify the role and value are the user keys for that role
+    # @returns array of user keys
+    def self.group_viewers(permission_template_attributes)
+      permission_from_template(permission_template_attributes, :view_groups).uniq
+    end
+
+    # Process the with_permission_template transient property such that...
+    # * a permission template is created for the admin set
+    # * a permission template access is created for the admin set creator
+    # * additional permission template accesses are created for each user/group identified in the attributes
+    #   of with_permission_template (created by the permission_template factory)
+    # @param [AdminSet] admin set object being built/created by the factory
+    # @param [Class] evaluator holding the transient properties for the current build/creation process
+    # @param [Boolean] if true, force the permission template to be created
+    def self.process_with_permission_template(adminset, evaluator, force = false)
+      return unless force || evaluator.with_permission_template
+      adminset.id ||= FactoryBot.generate(:object_id)
+      attributes = { source_id: adminset.id }
+      attributes[:manage_users] = user_managers(evaluator.with_permission_template, evaluator.user)
+      attributes = evaluator.with_permission_template.merge(attributes) if evaluator.with_permission_template.respond_to?(:merge)
+      FactoryBot.create(:permission_template, attributes) unless Hyrax::PermissionTemplate.find_by(source_id: adminset.id)
+    end
+
+    # Process the with_solr_document transient property such that...
+    # * a solr document is created for the admin set
+    # * permissions identified by with_permission_template, if any, are added to the solr fields
+    # @param [AdminSet] adminset object being built/created by the factory
+    # @param [Class] evaluator holding the transient properties for the current build/creation process
+    def self.process_with_solr_document(adminset, evaluator, creator_only = false)
+      return unless creator_only || evaluator.with_solr_document
+      Hyrax::SolrService.add(solr_document_with_permissions(adminset, evaluator, creator_only), commit: true)
+    end
+
+    # Return the admin set's solr document with permissions added, such that...
+    # * permissions identified by with_permission_template, if any, are added to the solr fields
+    # @param [AdminSet] adminset object being built/created by the factory
+    # @param [Class] evaluator holding the transient properties for the current build/creation process
+    # @returns the admin set's solr document with permissions added
+    def self.solr_document_with_permissions(adminset, evaluator, creator_only)
+      adminset.id ||= FactoryBot.generate(:object_id)
+      if creator_only
+        adminset.edit_users = [evaluator.user]
+      else
+        adminset.edit_users = user_managers(evaluator.with_permission_template, evaluator.user)
+        adminset.edit_groups = group_managers(evaluator.with_permission_template)
+        adminset.read_users = user_viewers(evaluator.with_permission_template) +
+                              user_depositors(evaluator.with_permission_template)
+        adminset.read_groups = group_viewers(evaluator.with_permission_template) +
+                               group_depositors(evaluator.with_permission_template) -
+                               [::Ability.registered_group_name, ::Ability.public_group_name]
+      end
+      adminset.to_solr
+    end
+    private_class_method :solr_document_with_permissions
+  end
+end

data/spec/factories/administrative_sets.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  ##
+  # This factory creates a Valkyrized adminstrative set; by default a Hyrax::AdministrativeSet
+  #
+  # Why the antics around the class?  Because of the Hyrax needs and potential downstream
+  # applciation needs.
+  #
+  # Downstream applications might implement a different # administrative set and the downstream
+  # application might leverage other Hyrax factories that create a `:hyrax_admin_set`
+  # (e.g. `:permission_template`)
+  factory :hyrax_admin_set, class: (Hyrax.config.admin_set_class < Valkyrie::Resource ? Hyrax.config.admin_set_class : Hyrax::AdministrativeSet) do
+    title { ['My Admin Set'] }
+
+    transient do
+      with_permission_template { false }
+      user { FactoryBot.create(:user) }
+      access_grants { [] }
+      with_index { true }
+    end
+
+    after(:build) do |adminset, evaluator|
+      adminset.creator = [evaluator.user.user_key]
+    end
+
+    after(:create) do |admin_set, evaluator|
+      admin_set.permission_manager.edit_groups = evaluator.edit_groups
+      admin_set.permission_manager.edit_users  = evaluator.edit_users
+      admin_set.permission_manager.read_users  = evaluator.read_users
+      admin_set.permission_manager.read_groups = evaluator.read_groups
+
+      admin_set.permission_manager.acl.save
+
+      if evaluator.with_permission_template
+        template = Hyrax::PermissionTemplate.find_or_create_by(source_id: admin_set.id.to_s)
+        evaluator.access_grants.each do |grant|
+          Hyrax::PermissionTemplateAccess.find_or_create_by(permission_template_id: template.id,
+                                                            agent_type: grant[:agent_type],
+                                                            agent_id: grant[:agent_id],
+                                                            access: grant[:access])
+        end
+        Hyrax::PermissionTemplateAccess.find_or_create_by(permission_template_id: template.id,
+                                                          agent_type: Hyrax::PermissionTemplateAccess::USER,
+                                                          agent_id: evaluator.user.user_key,
+                                                          access: Hyrax::PermissionTemplateAccess::MANAGE)
+        template.reset_access_controls_for(collection: admin_set)
+      end
+      Hyrax.index_adapter.save(resource: admin_set) if evaluator.with_index
+    end
+  end
+
+  trait :with_permission_template do
+    with_permission_template { true }
+    access_grants do
+      [{ agent_type: Hyrax::PermissionTemplateAccess::USER,
+         agent_id: user.user_key,
+         access: Hyrax::PermissionTemplateAccess::MANAGE }]
+    end
+  end
+
+  factory :invalid_hyrax_admin_set, class: 'Hyrax::AdministrativeSet' do
+    # Title is required.  Without title, the admin set is invalid.
+  end
+
+  factory :default_hyrax_admin_set, class: 'Hyrax::AdministrativeSet' do
+    id { Hyrax::AdminSetCreateService::DEFAULT_ID }
+    title { Hyrax::AdminSetCreateService::DEFAULT_TITLE }
+
+    transient do
+      with_persisted_default_id { true }
+    end
+
+    after(:create) do |admin_set, evaluator|
+      Hyrax::DefaultAdministrativeSet.update(default_admin_set_id: admin_set.id) if
+        evaluator.with_persisted_default_id
+    end
+  end
+end

data/spec/factories/api_items.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :post_item, class: Hash do
+    skip_create
+
+    token { 'mock_token' }
+
+    metadata do
+      {
+        resourceType: 'Dataset',
+        title: 'Findings from NSF Study',
+        creators: [
+          {
+            creatorType: 'author',
+            firstName: 'John',
+            lastName: 'Doe'
+          },
+          {
+            creatorType: 'seriesEditor',
+            firstName: 'Rafael',
+            lastName: 'Nadal'
+          },
+          {
+            creatorType: 'inventor',
+            name: 'Babs McGee'
+          },
+          {
+            creatorType: 'contributor',
+            name: 'Jane Doeski'
+          }
+        ],
+        description: 'This was funded by the NSF in 2013',
+        publisher: 'National Science Foundation',
+        dateCreated: '2014-11-02T14:24:64Z',
+        basedNear: 'Paris, France',
+        identifier: 'isbn:1234567890',
+        url: 'http://example.org/nsf/2013/datasets/',
+        language: 'English--New Jerseyan',
+        license: 'http://creativecommons.org/licenses/by-sa/3.0/us/',
+        tags: [
+          'datasets',
+          'nsf',
+          'stuff'
+        ]
+      }
+    end
+
+    file do
+      {
+        base64: 'YXJraXZvCg==',
+        md5: 'f03313ded2feb96f0a641b8eb098aae0',
+        filename: 'file.txt',
+        contentType: 'text/plain'
+      }
+    end
+
+    initialize_with { attributes }
+  end
+
+  factory :put_item, class: Hash, parent: :post_item do
+    metadata do
+      {
+        resourceType: 'Article',
+        title: 'THE REAL FINDINGS',
+        creators: [
+          {
+            creatorType: 'author',
+            firstName: 'John',
+            lastName: 'Doe'
+          },
+          {
+            creatorType: 'inventor',
+            name: 'Babs McGee'
+          }
+        ],
+        license: 'http://creativecommons.org/licenses/by-sa/3.0/us/',
+        tags: [
+          'datasets'
+        ]
+      }
+    end
+
+    file do
+      {
+        base64: 'IyBIRUFERVIKClRoaXMgaXMgYSBwYXJhZ3JhcGghCg==',
+        md5: '3923077bb477097b8496dbcff5fa44b3',
+        filename: 'replaced.md',
+        contentType: 'text/x-markdown'
+      }
+    end
+  end
+end

data/spec/factories/collection_branding_infos.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :collection_branding_info do
+    collection_id { "1" }
+    role { "banner" }
+    local_path { "/fake/path/to/banner.png" }
+    alt_text { "This is the banner" }
+    target_url { "http://example.com/" }
+    height { "" }
+    width { "" }
+  end
+end

data/spec/factories/collection_type_participants.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+FactoryBot.define do
+  factory :collection_type_participant, class: Hyrax::CollectionTypeParticipant do
+    association :hyrax_collection_type, factory: :collection_type
+    sequence(:agent_id) { |n| "user#{n}@example.com" }
+    agent_type  { 'user' }
+    access      { Hyrax::CollectionTypeParticipant::MANAGE_ACCESS }
+  end
+end