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/Admin/DashboardController.html | 139 +++++ doc/code/classes/Admin/GroupsController.html | 586 ++++++++++++++++++++ doc/code/classes/Admin/HooksController.html | 294 +++++++++++ doc/code/classes/Admin/LogsController.html | 76 +++ doc/code/classes/Admin/ProjectsController.html | 436 +++++++++++++++ doc/code/classes/Admin/ResqueController.html | 130 +++++ doc/code/classes/Admin/TeamMembersController.html | 234 ++++++++ doc/code/classes/Admin/UsersController.html | 616 ++++++++++++++++++++++ 8 files changed, 2511 insertions(+) create mode 100644 doc/code/classes/Admin/DashboardController.html create mode 100644 doc/code/classes/Admin/GroupsController.html create mode 100644 doc/code/classes/Admin/HooksController.html create mode 100644 doc/code/classes/Admin/LogsController.html create mode 100644 doc/code/classes/Admin/ProjectsController.html create mode 100644 doc/code/classes/Admin/ResqueController.html create mode 100644 doc/code/classes/Admin/TeamMembersController.html create mode 100644 doc/code/classes/Admin/UsersController.html (limited to 'doc/code/classes/Admin') diff --git a/doc/code/classes/Admin/DashboardController.html b/doc/code/classes/Admin/DashboardController.html new file mode 100644 index 00000000000..02643b7fe39 --- /dev/null +++ b/doc/code/classes/Admin/DashboardController.html @@ -0,0 +1,139 @@ + + + + + Admin::DashboardController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
I
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + index() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/dashboard_controller.rb, line 2
+def index
+  @projects = Project.order("created_at DESC").limit(10)
+  @users = User.order("created_at DESC").limit(10)
+
+  @resque_accessible = true
+  @workers = Resque.workers
+  @pending_jobs = Resque.size(:post_receive)
+
+rescue Redis::InheritedError
+  @resque_accessible = false
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file diff --git a/doc/code/classes/Admin/GroupsController.html b/doc/code/classes/Admin/GroupsController.html new file mode 100644 index 00000000000..b3651e8b98e --- /dev/null +++ b/doc/code/classes/Admin/GroupsController.html @@ -0,0 +1,586 @@ + + + + + Admin::GroupsController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
C
+
+ +
+ +
D
+
+ +
+ +
E
+
+
    + + +
  • + edit +
    • + +
+
+ +
I
+
+ +
+ +
N
+
+
    + + +
  • + new +
    • + +
+
+ +
P
+
+ +
+ +
R
+
+ +
+ +
S
+
+
    + + +
  • + show +
    • + +
+
+ +
U
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + create() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 26
+def create
+  @group = Group.new(params[:group])
+  @group.path = @group.name.dup.parameterize if @group.name
+  @group.owner = current_user
+
+  if @group.save
+    redirect_to [:admin, @group], notice: 'Group was successfully created.'
+  else
+    render action: "new"
+  end
+end
+
+
+ +
+ +
+
+ + destroy() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 75
+def destroy
+  @group.truncate_teams
+
+  @group.destroy
+
+  redirect_to admin_groups_path, notice: 'Group was successfully deleted.'
+end
+
+
+ +
+ +
+
+ + edit() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 23
+def edit
+end
+
+
+ +
+ +
+
+ + index() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 4
+def index
+  @groups = Group.order('name ASC')
+  @groups = @groups.search(params[:name]) if params[:name].present?
+  @groups = @groups.page(params[:page]).per(20)
+end
+
+
+ +
+ +
+
+ + new() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 19
+def new
+  @group = Group.new
+end
+
+
+ +
+ +
+
+ + project_teams_update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 70
+def project_teams_update
+  @group.add_users_to_project_teams(params[:user_ids], params[:project_access])
+  redirect_to [:admin, @group], notice: 'Users was successfully added.'
+end
+
+
+ +
+ +
+
+ + project_update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 53
+def project_update
+  project_ids = params[:project_ids]
+
+  Project.where(id: project_ids).each do |project|
+    project.transfer(@group)
+  end
+
+  redirect_to :back, notice: 'Group was successfully updated.'
+end
+
+
+ +
+ +
+
+ + remove_project() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 63
+def remove_project
+  @project = Project.find(params[:project_id])
+  @project.transfer(nil)
+
+  redirect_to :back, notice: 'Group was successfully updated.'
+end
+
+
+ +
+ +
+
+ + show() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 10
+def show
+  @projects = Project.scoped
+  @projects = @projects.not_in_group(@group) if @group.projects.present?
+  @projects = @projects.all
+  @projects.reject!(&:empty_repo?)
+
+  @users = User.active
+end
+
+
+ +
+ +
+
+ + update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/groups_controller.rb, line 38
+def update
+  group_params = params[:group].dup
+  owner_id =group_params.delete(:owner_id)
+
+  if owner_id
+    @group.owner = User.find(owner_id)
+  end
+
+  if @group.update_attributes(group_params)
+    redirect_to [:admin, @group], notice: 'Group was successfully updated.'
+  else
+    render action: "edit"
+  end
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file diff --git a/doc/code/classes/Admin/HooksController.html b/doc/code/classes/Admin/HooksController.html new file mode 100644 index 00000000000..1d56fbc7b98 --- /dev/null +++ b/doc/code/classes/Admin/HooksController.html @@ -0,0 +1,294 @@ + + + + + Admin::HooksController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
C
+
+ +
+ +
D
+
+ +
+ +
I
+
+ +
+ +
T
+
+
    + + +
  • + test +
    • + +
+
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + create() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/hooks_controller.rb, line 7
+def create
+  @hook = SystemHook.new(params[:hook])
+
+  if @hook.save
+    redirect_to admin_hooks_path, notice: 'Hook was successfully created.'
+  else
+    @hooks = SystemHook.all
+    render :index
+  end
+end
+
+
+ +
+ +
+
+ + destroy() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/hooks_controller.rb, line 18
+def destroy
+  @hook = SystemHook.find(params[:id])
+  @hook.destroy
+
+  redirect_to admin_hooks_path
+end
+
+
+ +
+ +
+
+ + index() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/hooks_controller.rb, line 2
+def index
+  @hooks = SystemHook.all
+  @hook = SystemHook.new
+end
+
+
+ +
+ +
+
+ + test() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/hooks_controller.rb, line 26
+def test
+  @hook = SystemHook.find(params[:hook_id])
+  data = {
+    event_name: "project_create",
+    name: "Ruby",
+    path: "ruby",
+    project_id: 1,
+    owner_name: "Someone",
+    owner_email: "example@gitlabhq.com"
+  }
+  @hook.execute(data)
+
+  redirect_to :back
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file diff --git a/doc/code/classes/Admin/LogsController.html b/doc/code/classes/Admin/LogsController.html new file mode 100644 index 00000000000..8782d95f5ac --- /dev/null +++ b/doc/code/classes/Admin/LogsController.html @@ -0,0 +1,76 @@ + + + + + Admin::LogsController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + \ No newline at end of file diff --git a/doc/code/classes/Admin/ProjectsController.html b/doc/code/classes/Admin/ProjectsController.html new file mode 100644 index 00000000000..1a0bd492112 --- /dev/null +++ b/doc/code/classes/Admin/ProjectsController.html @@ -0,0 +1,436 @@ + + + + + Admin::ProjectsController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
D
+
+ +
+ +
E
+
+
    + + +
  • + edit +
    • + +
+
+ +
I
+
+ +
+ +
P
+
+ +
+ +
S
+
+
    + + +
  • + show +
    • + +
+
+ +
T
+
+ +
+ +
U
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + destroy() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/projects_controller.rb, line 37
+def destroy
+  # Delete team first in order to prevent multiple gitolite calls
+  @project.truncate_team
+
+  @project.destroy
+
+  redirect_to admin_projects_path, notice: 'Project was successfully deleted.'
+end
+
+
+ +
+ +
+
+ + edit() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/projects_controller.rb, line 18
+def edit
+end
+
+
+ +
+ +
+
+ + index() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/projects_controller.rb, line 4
+def index
+  @projects = Project.scoped
+  @projects = @projects.where(namespace_id: params[:namespace_id]) if params[:namespace_id].present?
+  @projects = @projects.where(namespace_id: nil) if params[:namespace_id] == Namespace.global_id
+  @projects = @projects.search(params[:name]) if params[:name].present?
+  @projects = @projects.includes(:namespace).order("namespaces.path, projects.name ASC").page(params[:page]).per(20)
+end
+
+
+ +
+ +
+
+ + show() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/projects_controller.rb, line 12
+def show
+  @users = User.active
+  @users = @users.not_in_project(@project) if @project.users.present?
+  @users = @users.all
+end
+
+
+ +
+ +
+
+ + team_update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/projects_controller.rb, line 21
+def team_update
+  @project.add_users_ids_to_team(params[:user_ids], params[:project_access])
+
+  redirect_to [:admin, @project], notice: 'Project was successfully updated.'
+end
+
+
+ +
+ +
+
+ + update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/projects_controller.rb, line 27
+def update
+  status = ProjectUpdateContext.new(project, current_user, params).execute(:admin)
+
+  if status
+    redirect_to [:admin, @project], notice: 'Project was successfully updated.'
+  else
+    render action: "edit"
+  end
+end
+
+
+ +
+ +
Instance Protected methods
+ +
+
+ + project() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/projects_controller.rb, line 48
+def project
+  id = params[:project_id] || params[:id]
+
+  @project = Project.find_with_namespace(id)
+  @project || render_404
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file diff --git a/doc/code/classes/Admin/ResqueController.html b/doc/code/classes/Admin/ResqueController.html new file mode 100644 index 00000000000..52cb2f870e9 --- /dev/null +++ b/doc/code/classes/Admin/ResqueController.html @@ -0,0 +1,130 @@ + + + + + Admin::ResqueController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
S
+
+
    + + +
  • + show +
    • + +
+
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + show() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/resque_controller.rb, line 2
+def show
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file diff --git a/doc/code/classes/Admin/TeamMembersController.html b/doc/code/classes/Admin/TeamMembersController.html new file mode 100644 index 00000000000..b055f509137 --- /dev/null +++ b/doc/code/classes/Admin/TeamMembersController.html @@ -0,0 +1,234 @@ + + + + + Admin::TeamMembersController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
D
+
+ +
+ +
E
+
+
    + + +
  • + edit +
    • + +
+
+ +
U
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + destroy() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/team_members_controller.rb, line 16
+def destroy
+  @admin_team_member = UsersProject.find(params[:id])
+  @admin_team_member.destroy
+
+  redirect_to :back
+end
+
+
+ +
+ +
+
+ + edit() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/team_members_controller.rb, line 2
+def edit
+  @admin_team_member = UsersProject.find(params[:id])
+end
+
+
+ +
+ +
+
+ + update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/team_members_controller.rb, line 6
+def update
+  @admin_team_member = UsersProject.find(params[:id])
+
+  if @admin_team_member.update_attributes(params[:team_member])
+    redirect_to [:admin, @admin_team_member.project],  notice: 'Project Access was successfully updated.'
+  else
+    render action: "edit"
+  end
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file diff --git a/doc/code/classes/Admin/UsersController.html b/doc/code/classes/Admin/UsersController.html new file mode 100644 index 00000000000..cfe1e514ae8 --- /dev/null +++ b/doc/code/classes/Admin/UsersController.html @@ -0,0 +1,616 @@ + + + + + Admin::UsersController + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
B
+
+ +
+ +
C
+
+ +
+ +
D
+
+ +
+ +
E
+
+
    + + +
  • + edit +
    • + +
+
+ +
I
+
+ +
+ +
N
+
+
    + + +
  • + new +
    • + +
+
+ +
S
+
+
    + + +
  • + show +
    • + +
+
+ +
T
+
+ +
+ +
U
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + block() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 40
+def block
+  @admin_user = User.find(params[:id])
+
+  if @admin_user.block
+    redirect_to :back, alert: "Successfully blocked"
+  else
+    redirect_to :back, alert: "Error occured. User was not blocked"
+  end
+end
+
+
+ +
+ +
+
+ + create() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 60
+def create
+  admin = params[:user].delete("admin")
+
+  @admin_user = User.new(params[:user], as: :admin)
+  @admin_user.admin = (admin && admin.to_i > 0)
+
+  respond_to do |format|
+    if @admin_user.save
+      format.html { redirect_to [:admin, @admin_user], notice: 'User was successfully created.' }
+      format.json { render json: @admin_user, status: :created, location: @admin_user }
+    else
+      format.html { render action: "new" }
+      format.json { render json: @admin_user.errors, status: :unprocessable_entity }
+    end
+  end
+end
+
+
+ +
+ +
+
+ + destroy() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 99
+def destroy
+  @admin_user = User.find(params[:id])
+  if @admin_user.my_own_projects.count > 0
+    redirect_to admin_users_path, alert: "User is a project owner and can't be removed." and return
+  end
+  @admin_user.destroy
+
+  respond_to do |format|
+    format.html { redirect_to admin_users_url }
+    format.json { head :ok }
+  end
+end
+
+
+ +
+ +
+
+ + edit() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 36
+def edit
+  @admin_user = User.find(params[:id])
+end
+
+
+ +
+ +
+
+ + index() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 2
+def index
+  @admin_users = User.scoped
+  @admin_users = @admin_users.filter(params[:filter])
+  @admin_users = @admin_users.search(params[:name]) if params[:name].present?
+  @admin_users = @admin_users.alphabetically.page(params[:page])
+end
+
+
+ +
+ +
+
+ + new() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 32
+def new
+  @admin_user = User.new({ projects_limit: Gitlab.config.gitlab.default_projects_limit }, as: :admin)
+end
+
+
+ +
+ +
+
+ + show() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 9
+def show
+  @admin_user = User.find(params[:id])
+
+  @projects = if @admin_user.projects.empty?
+             Project
+           else
+             Project.without_user(@admin_user)
+           end.all
+end
+
+
+ +
+ +
+
+ + team_update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 19
+def team_update
+  @admin_user = User.find(params[:id])
+
+  UsersProject.user_bulk_import(
+    @admin_user,
+    params[:project_ids],
+    params[:project_access]
+  )
+
+  redirect_to [:admin, @admin_user], notice: 'Teams were successfully updated.'
+end
+
+
+ +
+ +
+
+ + unblock() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 50
+def unblock
+  @admin_user = User.find(params[:id])
+
+  if @admin_user.update_attribute(:blocked, false)
+    redirect_to :back, alert: "Successfully unblocked"
+  else
+    redirect_to :back, alert: "Error occured. User was not unblocked"
+  end
+end
+
+
+ +
+ +
+
+ + update() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/controllers/admin/users_controller.rb, line 77
+def update
+  admin = params[:user].delete("admin")
+
+  if params[:user][:password].blank?
+    params[:user].delete(:password)
+    params[:user].delete(:password_confirmation)
+  end
+
+  @admin_user = User.find(params[:id])
+  @admin_user.admin = (admin && admin.to_i > 0)
+
+  respond_to do |format|
+    if @admin_user.update_attributes(params[:user], as: :admin)
+      format.html { redirect_to [:admin, @admin_user], notice: 'User was successfully updated.' }
+      format.json { head :ok }
+    else
+      format.html { render action: "edit" }
+      format.json { render json: @admin_user.errors, status: :unprocessable_entity }
+    end
+  end
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file -- cgit v1.2.1