From 96d49bf04ce77c975fe500f4d961e4a1ffed4c26 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Sun, 30 Dec 2012 14:43:00 +0200 Subject: Use sdoc to generate application code documentation --- doc/code/classes/Account.html | 1032 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1032 insertions(+) create mode 100644 doc/code/classes/Account.html (limited to 'doc/code/classes/Account.html') diff --git a/doc/code/classes/Account.html b/doc/code/classes/Account.html new file mode 100644 index 00000000000..21119cc8462 --- /dev/null +++ b/doc/code/classes/Account.html @@ -0,0 +1,1032 @@ + + + + + Account + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
A
+
+ +
+ +
B
+
+ +
+ +
C
+
+ +
+ +
F
+
+ +
+ +
I
+
+ +
+ +
L
+
+ +
+ +
M
+
+ +
+ +
N
+
+ +
+ +
P
+
+ +
+ +
R
+
+ +
+ +
S
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + abilities() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 29
+def abilities
+  @abilities ||= begin
+                   abilities = Six.new
+                   abilities << Ability
+                   abilities
+                 end
+end
+
+
+ +
+ +
+
+ + authorized_groups() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 109
+def authorized_groups
+  @authorized_groups ||= begin
+                         groups = Group.where(id: self.projects.pluck(:namespace_id)).all
+                         groups = groups + self.groups
+                         groups.uniq
+                       end
+end
+
+
+ +
+ +
+
+ + authorized_projects() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 117
+def authorized_projects
+  Project.authorized_for(self)
+end
+
+
+ +
+ +
+
+ + block() + + +
+ + +
+

Remove user from all projects and set blocked attribute to true

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 59
+def block
+  users_projects.find_each do |membership|
+    return false unless membership.destroy
+  end
+
+  self.blocked = true
+  save
+end
+
+
+ +
+ +
+
+ + can?(action, subject) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 37
+def can? action, subject
+  abilities.allowed?(self, action, subject)
+end
+
+
+ +
+ +
+
+ + can_create_group?() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 25
+def can_create_group?
+  is_admin?
+end
+
+
+ +
+ +
+
+ + can_create_project?() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 21
+def can_create_project?
+  projects_limit > my_own_projects.count
+end
+
+
+ +
+ +
+
+ + cared_merge_requests() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 49
+def cared_merge_requests
+  MergeRequest.where("author_id = :id or assignee_id = :id", id: self.id)
+end
+
+
+ +
+ +
+
+ + first_name() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 45
+def first_name
+  name.split.first unless name.blank?
+end
+
+
+ +
+ +
+
+ + identifier() + + +
+ + +
+

Returns a string for use as a Gitolite user identifier

+ +

Note that Gitolite 2.x requires the following +pattern for users:

+ +
^@?[0-9a-zA-Z][0-9a-zA-Z._\@+-]*$
+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 7
+def identifier
+  # Replace non-word chars with underscores, then make sure it starts with
+  # valid chars
+  email.gsub(%r\W/, '_').gsub(%r\A([\W\_])+/, '')
+end
+
+
+ +
+ +
+
+ + is_admin?() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 13
+def is_admin?
+  admin
+end
+
+
+ +
+ +
+
+ + last_activity_project() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 41
+def last_activity_project
+  projects.first
+end
+
+
+ +
+ +
+
+ + my_own_projects() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 121
+def my_own_projects
+  Project.personal(self)
+end
+
+
+ +
+ +
+
+ + namespace_id() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 105
+def namespace_id
+  namespace.try :id
+end
+
+
+ +
+ +
+
+ + namespaces() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 86
+def namespaces
+  namespaces = []
+
+  # Add user account namespace
+  namespaces << self.namespace if self.namespace
+
+  # Add groups you can manage
+  namespaces += if admin
+                  Group.all
+                else
+                  groups.all
+                end
+  namespaces
+end
+
+
+ +
+ +
+
+ + project_ids() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 53
+def project_ids
+  projects.map(&:id)
+end
+
+
+ +
+ +
+
+ + projects_limit_percent() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 68
+def projects_limit_percent
+  return 100 if projects_limit.zero?
+  (my_own_projects.count.to_f / projects_limit) * 100
+end
+
+
+ +
+ +
+
+ + projects_sorted_by_activity() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 82
+def projects_sorted_by_activity
+  projects.sorted_by_activity
+end
+
+
+ +
+ +
+
+ + recent_push(project_id = nil) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 73
+def recent_push project_id = nil
+  # Get push events not earlier than 2 hours ago
+  events = recent_events.code_push.where("created_at > ?", Time.now - 2.hours)
+  events = events.where(project_id: project_id) if project_id
+
+  # Take only latest one
+  events = events.recent.limit(1).first
+end
+
+
+ +
+ +
+
+ + require_ssh_key?() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 17
+def require_ssh_key?
+  keys.count == 0
+end
+
+
+ +
+ +
+
+ + several_namespaces?() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/roles/account.rb, line 101
+def several_namespaces?
+  namespaces.size > 1
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file -- cgit v1.2.1