Module: ActivityPermissionEngine::ActivityPermissionsRegistry::Interface

Included in:
ActivityPermissionEngine::Adapters::ActivityPermissionsRegistry::Memory
Defined in:
lib/activity_permission_engine/activity_permissions_registry.rb

Overview

Include this module in adapters to provide expected behavior

Instance Method Summary collapse

Instance Method Details

#add(activity_ref) ⇒ Boolean

Returns true if added or false.

Parameters:

  • activity_ref (String)

Returns:

  • (Boolean) —

    true if added or false

Raises:

  • (NotImplementedError) 


8
9
10
 
# File 'lib/activity_permission_engine/activity_permissions_registry.rb', line 8

def add(activity_ref)
  raise NotImplementedError
end

#add_role(activity_ref, role_ref) ⇒ Boolean

Returns true if added or false.

Parameters:

  • activity_ref (String)
  • role_ref (Array(String))

Returns:

  • (Boolean) —

    true if added or false

Raises:

  • (NotImplementedError) 


26
27
28
 
# File 'lib/activity_permission_engine/activity_permissions_registry.rb', line 26

def add_role(activity_ref, role_ref)
  raise NotImplementedError
end

#all ⇒ Array(ActivityPermission)

Returns:



13
14
15
 
# File 'lib/activity_permission_engine/activity_permissions_registry.rb', line 13

def all
  get_all_activities.map { |activity| ActivityPermission.new(activity[:activity_ref], activity[:role_refs])}
end

#del(activity_ref) ⇒ Boolean

Returns true if deleted or false.

Parameters:

  • activity_ref (String)

Returns:

  • (Boolean) —

    true if deleted or false

Raises:

  • (NotImplementedError) 


19
20
21
 
# File 'lib/activity_permission_engine/activity_permissions_registry.rb', line 19

def del(activity_ref)
  raise NotImplementedError
end

#find_by_activity_ref(activity_ref) ⇒ ActivityPermission

Returns the found activity or false.

Parameters:

  • activity_ref (String)

Returns:



32
33
34
35
 
# File 'lib/activity_permission_engine/activity_permissions_registry.rb', line 32

def find_by_activity_ref(activity_ref)
  activity = get_activity_by_ref(activity_ref)
  activity && ActivityPermission.new(activity[:activity_ref], activity[:role_refs])
end