Sha256: 8479f0bde72463dbed535b4e6eddd6d9b39390deb3046695b393f15db5235b7a
Contents?: true
Size: 1.66 KB
Versions: 28
Compression:
Stored size: 1.66 KB
Contents
# frozen_string_literal: true
module Hyrax
##
# A list of permissions pertaining to a specific object.
#
# `AccessControl`s consist of a set of permissions and an `#access_to`
# reference to the object that set governs.
#
# @see Hyrax::AccessControlList for a low level DSL for managing
# `AccessControl` and `Permission` relationships for `Hyrax::Resource`
# @see Hyrax::PermissionManager for `read_groups`/`read_users` style setters
# and getters
# @see Hyrax::VisibilityWriter, Hyrax::VisibilityReader for
# "open"/"restricted" style visibility management
class AccessControl < Valkyrie::Resource
##
# @!attribute [rw] access_to
# Supports query for ACLs at the resource level. Permissions should be
# grouped under an AccessControl with a matching `#access_to` so they can
# be retrieved in batch.
#
# @return [Valkyrie::ID] the id of the Resource these permissions apply to
# @!attribute [rw] permissions
# @return [Enumerable<Hyrax::Permission>]
attribute :access_to, Valkyrie::Types::ID
attribute :permissions, Valkyrie::Types::Set.of(Hyrax::Permission)
##
# A finder/factory method for getting an appropriate ACL for a given
# resource.
#
# @param resource [Valkyrie::Resource]
# @param query_service [#find_inverse_references_by]
#
# @return [AccessControl]
# @raise [ArgumentError] if the resource is not persisted
def self.for(resource:, query_service: Hyrax.query_service)
query_service.custom_queries.find_access_control_for(resource: resource)
rescue Valkyrie::Persistence::ObjectNotFoundError
new(access_to: resource.id)
end
end
end
Version data entries
28 entries across 28 versions & 1 rubygems