Class: Accessly::Policy::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/accessly/policy/base.rb

Constant Summary collapse

ACTIONS_MODULE =

Module that will hold our meta-programmed action methods just above the policy class in the inheritance hierarchy; allowing for them to be overridden in the policy.

:Actions

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(actor) ⇒ Base

Returns a new instance of Base.



11
12
13
 
# File 'lib/accessly/policy/base.rb', line 11

def initialize(actor)
  @actor = actor
end

Instance Attribute Details

#actor ⇒ Object (readonly)

Returns the value of attribute actor.



9
10
11
 
# File 'lib/accessly/policy/base.rb', line 9

def actor
  @actor
end

Class Method Details

.actions(actions) ⇒ Hash

Meta-programs action methods from actions supplied. Used in policies as a DSL to declare actions.

This defines the actions on the ‘actions_module` so that they are positioned higher in the inheritance tree than methods defined on the class itself. This will allow us to define methods that override these base methods and call `super`.

Examples:

Define Actions


# This example causes the following methods to be defined:
# some_action? : Returns true if the actor has the some_action
#   permission, false otherwise
# flip_the_flop? : Returns true if the actor has the flip_the_flop
#   permission, false otherwise
# create? : Returns true if the actor has the create permission, false
#   otherwise
actions(
  some_action: 1,
  flip_the_flop: 2,
  create: 3
)

Parameters:

  • actions (Hash) —

    the actions to define on the policy

Returns:

  • (Hash) —

    actions



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/accessly/policy/base.rb', line 41

def self.actions(actions)
  _actions.merge!(actions)
  actions.each do |action, action_id|
    actions_module.module_eval do
      define_method(:"#{action}?") do |*args|
        _can_do_action?(action, action_id, args.first)
      end
    end
  end
end

.actions_on_objects(actions_on_objects) ⇒ Hash

Meta-programs action_on_objects methods from the actions supplied. Used in policies as a DSL to declare actions on objects. It is different from actions in that it will also define a method for listing all objects authorized with this action for the given actor and that these actions will always be associated not only with an actor, but with an object of the action.

on the policy

Examples:

Define Actions On Objects


# This example causes the following methods to be defined:
# edit : Returns an ActiveRecord::Relation of the objects on which
#   the actor has the edit permission
# edit?(object) : Returns true if the actor has the edit permission
#   on the given object, false otherwise
# show : Returns an ActiveRecord::Relation of the objects on which
#   the actor has the show permission
# show?(object) : Returns true if the actor has the show permission
#   on the given object, false otherwise
actions_on_objects(
  edit: 1,
  show: 2
)

Parameters:

  • actions_on_objects (Hash) —

    the actions on objects to define

Returns:

  • (Hash) —

    actions_on_objects



79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/accessly/policy/base.rb', line 79

def self.actions_on_objects(actions_on_objects)
  _actions_on_objects.merge!(actions_on_objects)
  actions_on_objects.each do |action, action_id|
    actions_module.module_eval do
      define_method(:"#{action}?") do |*args|
        _can_do_action?(action, action_id, args.first)
      end

      define_method(action) do |*args|
        _list_for_action(action, action_id)
      end
    end
  end
end

.model_scope ⇒ Object

Raises:

  • (ArgumentError) 


102
103
104
 
# File 'lib/accessly/policy/base.rb', line 102

def self.model_scope
  raise ArgumentError.new("#model_scope is not defined on #{self.name}.")
end

.namespace ⇒ Object 



94
95
96
 
# File 'lib/accessly/policy/base.rb', line 94

def self.namespace
  String(self)
end

Instance Method Details

#accessly_query ⇒ Object 



150
151
152
153
154
155
156
 
# File 'lib/accessly/policy/base.rb', line 150

def accessly_query
  @_accessly_query ||= begin
    query = Accessly::Query.new(actors)
    query.on_segment(segment_id) unless segment_id.nil?
    query
  end
end

#actors ⇒ Object

Specifies all the actors used in permission lookups. Override this method in child policy classes to specify other actors that the actor given in the initializer may inherit permissions from.



114
115
116
 
# File 'lib/accessly/policy/base.rb', line 114

def actors
  actor
end

#can?(action, object = nil) ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
129
130
131
132
 
# File 'lib/accessly/policy/base.rb', line 126

def can?(action, object = nil)
  if object.nil?
    send("#{action}?")
  else
    send("#{action}?", object)
  end
end

#grant!(action, object = nil) ⇒ Object 



138
139
140
141
142
 
# File 'lib/accessly/policy/base.rb', line 138

def grant!(action, object = nil)
  object_id = _get_object_id(object)
  action_id = _get_action_id(action, object_id)
  grant_object.grant!(action_id, namespace, object_id)
end

#grant_object ⇒ Object 



158
159
160
161
162
163
 
# File 'lib/accessly/policy/base.rb', line 158

def grant_object
  grant_object = Accessly::Permission::Grant.new(actor)
  grant_object.on_segment(segment_id) unless segment_id.nil?

  grant_object
end

#list(action) ⇒ Object 



134
135
136
 
# File 'lib/accessly/policy/base.rb', line 134

def list(action)
  send(action)
end

#model_scope ⇒ Object 



106
107
108
 
# File 'lib/accessly/policy/base.rb', line 106

def model_scope
  self.class.model_scope
end

#namespace ⇒ Object 



98
99
100
 
# File 'lib/accessly/policy/base.rb', line 98

def namespace
  self.class.namespace
end

#revoke!(action, object = nil) ⇒ Object 



144
145
146
147
148
 
# File 'lib/accessly/policy/base.rb', line 144

def revoke!(action, object = nil)
  object_id = _get_object_id(object)
  action_id = _get_action_id(action, object_id)
  revoke_object.revoke!(action_id, namespace, object_id)
end

#revoke_object ⇒ Object 



165
166
167
168
169
170
 
# File 'lib/accessly/policy/base.rb', line 165

def revoke_object
  revoke_object = Accessly::Permission::Revoke.new(actor)
  revoke_object.on_segment(segment_id) unless segment_id.nil?

  revoke_object
end

#segment_id ⇒ Object 



122
123
124
 
# File 'lib/accessly/policy/base.rb', line 122

def segment_id
  nil
end

#unrestricted? ⇒ Boolean

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/accessly/policy/base.rb', line 118

def unrestricted?
  false
end