Class: Ability

Inherits:
Object
  • Object
show all
Includes:
CanCan::Ability
Defined in:
lib/ability.rb

Overview

Canard provides a CanCan Ability class for you. The Canard Ability class looks for and applies abilities for the object passed when a new Ability instance is initialized.

If the passed object has a reference to user the user is set to that. Otherwise the passed object is assumed to be the user. This gives the flexibility to have a seperate model for authorization from the model used to authenticate the user.

Abilities are applied in the order they are set with the acts_as_user method for example for the User model

class User < ActiveRecord::Base

  acts_as_user :roles =>  :manager, :admin

end

the abilities would be applied in the order: users, managers, admins with each subsequent set of abilities building on or overriding the existing abilities.

If there is no object passed to the Ability.new method a guest ability is created and Canard will look for a guests.rb amongst the ability definitions and give the guest those abilities.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(object = nil) ⇒ Ability

Returns a new instance of Ability



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/ability.rb', line 32

def initialize(object=nil)
  
  # If object has a user attribute set the user from it otherwise assume
  # this is the user.
  @user = object.respond_to?(:user) ? object.user : object
  
  if @user
    # Add the base user abilities.
    append_abilities @user.class.name.underscore.to_sym
  else
    # If user not set then lets create a guest
    @user = Object.new
    append_abilities :guest
  end
  
  # If user has roles get those abilities
  if @user.respond_to?(:roles)
    # Add roles on top of the base user abilities
    @user.roles.each { |role| append_abilities(role) }
  end

end

Instance Attribute Details

#userObject (readonly)

Returns the value of attribute user



30
31
32
# File 'lib/ability.rb', line 30

def user
  @user
end