Class: Role
- Inherits:
-
ActiveRecord::Base
- Object
- ActiveRecord::Base
- Role
- Defined in:
- app/models/role.rb
Overview
redMine - project management software Copyright (C) 2006 Jean-Philippe Lang
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Constant Summary
- BUILTIN_NON_MEMBER =
Built-in roles
1
- BUILTIN_ANONYMOUS =
2
Class Method Summary
-
+ (Object) anonymous
Return the builtin ‘anonymous’ role.
-
+ (Object) find_all_givable
Find all the roles that can be given to a project member.
-
+ (Object) non_member
Return the builtin ‘non member’ role.
Instance Method Summary
- - (Object) <=>(role)
- - (Object) add_permission!(*perms)
-
- (Boolean) allowed_to?(action)
Return true if role is allowed to do the specified action action can be:
- a parameter-like Hash (eg. :controller => ‘projects’, :action => ‘edit’)
- a permission Symbol (eg. :edit_project).
-
- (Boolean) builtin?
Return true if the role is a builtin role.
-
- (Boolean) has_permission?(perm)
Returns true if the role has the given permission.
-
- (Boolean) member?
Return true if the role is a project member role.
- - (Object) permissions
- - (Object) permissions(perms)
- - (Object) remove_permission!(*perms)
-
- (Object) setable_permissions
Return all the permissions that can be given to the role.
- - (Object) to_s
Methods inherited from ActiveRecord::Base
Class Method Details
+ (Object) anonymous
Return the builtin ‘anonymous’ role. If the role doesn’t exist, it will be created on the fly.
138 139 140 141 142 143 144 145 146 147 |
# File 'app/models/role.rb', line 138 def self.anonymous anonymous_role = find(:first, :conditions => {:builtin => BUILTIN_ANONYMOUS}) if anonymous_role.nil? anonymous_role = create(:name => 'Anonymous', :position => 0) do |role| role.builtin = BUILTIN_ANONYMOUS end raise 'Unable to create the anonymous role.' if anonymous_role.new_record? end anonymous_role end |
+ (Object) find_all_givable
Find all the roles that can be given to a project member
119 120 121 |
# File 'app/models/role.rb', line 119 def self.find_all_givable find(:all, :conditions => {:builtin => 0}, :order => 'position') end |
+ (Object) non_member
Return the builtin ‘non member’ role. If the role doesn’t exist, it will be created on the fly.
125 126 127 128 129 130 131 132 133 134 |
# File 'app/models/role.rb', line 125 def self.non_member non_member_role = find(:first, :conditions => {:builtin => BUILTIN_NON_MEMBER}) if non_member_role.nil? non_member_role = create(:name => 'Non member', :position => 0) do |role| role.builtin = BUILTIN_NON_MEMBER end raise 'Unable to create the non-member role.' if non_member_role.new_record? end non_member_role end |
Instance Method Details
- (Object) <=>(role)
80 81 82 |
# File 'app/models/role.rb', line 80 def <=>(role) role ? position <=> role.position : -1 end |
- (Object) add_permission!(*perms)
57 58 59 60 61 62 63 64 65 66 |
# File 'app/models/role.rb', line 57 def (*perms) self. = [] unless .is_a?(Array) perms.each do |p| p = p.to_sym << p unless .include?(p) end save! end |
- (Boolean) allowed_to?(action)
Return true if role is allowed to do the specified action action can be:
- a parameter-like Hash (eg. :controller => ‘projects’, :action => ‘edit’)
- a permission Symbol (eg. :edit_project)
102 103 104 105 106 107 108 |
# File 'app/models/role.rb', line 102 def allowed_to?(action) if action.is_a? Hash allowed_actions.include? "#{action[:controller]}/#{action[:action]}" else .include? action end end |
- (Boolean) builtin?
Return true if the role is a builtin role
89 90 91 |
# File 'app/models/role.rb', line 89 def builtin? self.builtin != 0 end |
- (Boolean) has_permission?(perm)
Returns true if the role has the given permission
76 77 78 |
# File 'app/models/role.rb', line 76 def (perm) !.nil? && .include?(perm.to_sym) end |
- (Boolean) member?
Return true if the role is a project member role
94 95 96 |
# File 'app/models/role.rb', line 94 def member? !self.builtin? end |
- (Object) permissions
48 49 50 |
# File 'app/models/role.rb', line 48 def read_attribute(:permissions) || [] end |
- (Object) permissions=(perms)
52 53 54 55 |
# File 'app/models/role.rb', line 52 def (perms) perms = perms.collect {|p| p.to_sym unless p.blank? }.compact.uniq if perms write_attribute(:permissions, perms) end |
- (Object) remove_permission!(*perms)
68 69 70 71 72 73 |
# File 'app/models/role.rb', line 68 def (*perms) return unless .is_a?(Array) perms.each { |p| .delete(p.to_sym) } save! end |
- (Object) setable_permissions
Return all the permissions that can be given to the role
111 112 113 114 115 116 |
# File 'app/models/role.rb', line 111 def = Redmine::AccessControl. - Redmine::AccessControl. -= Redmine::AccessControl. if self.builtin == BUILTIN_NON_MEMBER -= Redmine::AccessControl. if self.builtin == BUILTIN_ANONYMOUS end |
- (Object) to_s
84 85 86 |
# File 'app/models/role.rb', line 84 def to_s name end |