Module: Permissable::ClassMethods

Defined in:
lib/permissable.rb

Instance Method Summary collapse

Instance Method Details

#has_permissions_for(resources, options = {}) ⇒ Object

has_permissions_for gives the class its called on the ability to effect various permission states on the resources it specifies. It requires two parameters, a resource or array of resources to add permissions to, and an options hash with instructions of how to handle the permissions. The options hash consists of the following keys, but only the :to key is required.

  • to: This is a permission or array of permissions allowed. You can use any number of values and those values can be whatever you want. You must include at least one.

  • through: Allows you to scope permissions through one of the member’s associations. For example, if your member is a User, and that user has_many Roles, you could set permissions :through => :roles. When looking up permissions Permissable will use the association instead of the main member object. This also applies to setting permissions. NOTE: The :through option uses the same value as your assocation. If the association is a has_many, the value will be plural. Likewise belongs_to or has_one associations will be singular. The best way to think of this is that the :through attribute would be exactly the same as the method you would call on your model to find its associations.

Raises:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/permissable.rb', line 62

def has_permissions_for(resources, options = {})
  raise Permissable::PermissionNotDefined, "has_permissions_for missing the :to option." unless options.has_key?(:to) and !options[:to].empty?
  
  write_inheritable_attribute(:permissable_associations, {}) if permissable_associations.nil?
  write_inheritable_attribute(:permissable_options, {}) if permissable_options.nil?
  resources = [resources].flatten
  
  resources.each do |resource| 
    resource = resource.to_s.classify          
    
    # If there is an association on these resources, add those to our associations attribute
    # so our classes and sub classes will know about it.
    if options.has_key?(:through)
      
      permissable_associations[resource] = options[:through]
      assoc = options[:through].to_s.classify.constantize
      
      # Our association also creates a has_many association on our permissions table.
      assoc.class_eval do              
        has_many(:permissions, :as => :member, :dependent => :destroy) unless respond_to? :permissions
        include Permissable::Member
        class_inheritable_accessor :permissable_types
        self.send :permissable_types=, options[:to]
        write_inheritable_attribute(:permissable_options, {}) if permissable_options.nil?
        permissable_options[:allow_permission_with_method] = options[:allow_with] if options.has_key?(:allow_with)        
        permissable_options[:permission_chain] = options[:chain] if options.has_key?(:chain)              
      end
                              
    end

    # Setup a has_many association of permissions on our resource.
    resource.constantize.class_eval do             
      has_many(:permissions, :as => :resource, :dependent => :destroy) unless respond_to? :permissions
    end
    
    resource.constantize.instance_eval{ include Permissable::Resource }
    
  end
  
  permissable_options[:allow_permission_with_method] = options[:allow_with] if options.has_key?(:allow_with)        
  permissable_options[:permission_chain] = options[:chain] if options.has_key?(:chain)
  
  # This class becomes a member to resources.
  include Permissable::Member
  class_inheritable_accessor :permissable_types
  class_inheritable_accessor :permissable_resources
  self.send :permissable_types=, options[:to]
  self.send :permissable_resources=, resources
  
  # Members create a has_many association on permissions as a member.
  has_many(:permissions, :as => :member, :dependent => :destroy) unless respond_to? :permissions
  
end

#permissable_associations ⇒ Object

Each time has_permissions_for is called, different associations may exist. This provides a way to store and update them all as necessary.



121
 
# File 'lib/permissable.rb', line 121

def permissable_associations; read_inheritable_attribute(:permissable_associations); end

#permissable_options ⇒ Object

Access options such as our method override, or our permission chain.



117
 
# File 'lib/permissable.rb', line 117

def permissable_options; read_inheritable_attribute(:permissable_options); end