Class: Principal

Inherits:
ApplicationRecord show all
Defined in:
app/models/principal.rb

Overview

Redmine - project management software Copyright © 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.

Direct Known Subclasses

Group, User

Constant Summary collapse

STATUS_ANONYMOUS =

Account statuses

0
STATUS_ACTIVE = 
1
STATUS_REGISTERED = 
2
STATUS_LOCKED = 
3

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApplicationRecord

human_attribute_name

Class Method Details

.detect_by_keyword(principals, keyword) ⇒ Object

Returns the principal that matches the keyword among principals



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'app/models/principal.rb', line 187

def self.detect_by_keyword(principals, keyword)
  keyword = keyword.to_s
  return nil if keyword.blank?

  principal = nil
  principal ||= principals.detect {|a| keyword.casecmp(a..to_s) == 0}
  principal ||= principals.detect {|a| keyword.casecmp(a.mail.to_s) == 0}

  if principal.nil? && keyword.include?(' ')
    firstname, lastname = *(keyword.split) # "First Last Throwaway"
    principal ||=
      principals.detect do |a|
        a.is_a?(User) &&
          firstname.casecmp(a.firstname.to_s) == 0 &&
            lastname.casecmp(a.lastname.to_s) == 0
      end
  end
  if principal.nil?
    principal ||= principals.detect {|a| keyword.casecmp(a.name) == 0}
  end
  principal
end

.fields_for_order_statement(table = nil) ⇒ Object

Returns an array of fields names than can be used to make an order statement for principals. Users are sorted before Groups. Examples:



180
181
182
183
184
 
# File 'app/models/principal.rb', line 180

def self.fields_for_order_statement(table=nil)
  table ||= table_name
  columns = ['type DESC'] + (User.name_formatter[:order] - ['id']) + ['lastname', 'id']
  columns.uniq.map {|field| "#{table}.#{field}"}
end

Instance Method Details

#<=>(principal) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'app/models/principal.rb', line 164

def <=>(principal)
  # avoid an error when sorting members without roles (#10053)
  return -1 if principal.nil?
  return nil unless principal.is_a?(Principal)

  if self.instance_of?(principal.class)
    self.to_s.casecmp(principal.to_s)
  else
    # groups after users
    principal.class.name <=> self.class.name
  end
end

#active? ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
 
# File 'app/models/principal.rb', line 146

def active?
  self.status == STATUS_ACTIVE
end

#initials(formatter = nil) ⇒ Object

Returns nil by default, subclasses should implement this method



134
135
136
 
# File 'app/models/principal.rb', line 134

def initials(formatter = nil)
  nil
end

#mail ⇒ Object 



142
143
144
 
# File 'app/models/principal.rb', line 142

def mail
  nil
end

#mail=(*args) ⇒ Object 



138
139
140
 
# File 'app/models/principal.rb', line 138

def mail=(*args)
  nil
end

#member_of?(project) ⇒ Boolean

Returns true if the principal is a member of project

Returns:

  • (Boolean) 


155
156
157
 
# File 'app/models/principal.rb', line 155

def member_of?(project)
  project.is_a?(Project) && project_ids.include?(project.id)
end

#name(formatter = nil) ⇒ Object 



129
130
131
 
# File 'app/models/principal.rb', line 129

def name(formatter = nil)
  to_s
end

#nullify_projects_default_assigned_to ⇒ Object 



210
211
212
 
# File 'app/models/principal.rb', line 210

def nullify_projects_default_assigned_to
  Project.where(default_assigned_to: self).update_all(default_assigned_to_id: nil)
end

#project_ids ⇒ Object

Returns an array of the project ids that the principal is a member of



160
161
162
 
# File 'app/models/principal.rb', line 160

def project_ids
  @project_ids ||= super.freeze
end

#reload(*args) ⇒ Object 



124
125
126
127
 
# File 'app/models/principal.rb', line 124

def reload(*args)
  @project_ids = nil
  super
end

#visible?(user = User.current) ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'app/models/principal.rb', line 150

def visible?(user=User.current)
  Principal.visible(user).find_by(:id => id) == self
end