diff options
| author | Dmitriy Zaporozhets <dzaporozhets@sphereconsultinginc.com> | 2012-10-25 11:59:41 +0300 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dzaporozhets@sphereconsultinginc.com> | 2012-10-25 11:59:41 +0300 |
| commit | 1ea0dd0ffc37232d27f4fa1350af6ebb3b5439f2 (patch) | |
| tree | 9003ff2731c36db3522973e1d25c6e58e1a70019 | |
| parent | 03f43291cdf60c6a185383d7d218fd87196d6231 (diff) | |
| download | gitlab-ce-1ea0dd0ffc37232d27f4fa1350af6ebb3b5439f2.tar.gz | |
App docs
193 files changed, 100336 insertions, 0 deletions
diff --git a/doc/app/Ability.html b/doc/app/Ability.html new file mode 100644 index 00000000000..f780d067332 --- /dev/null +++ b/doc/app/Ability.html @@ -0,0 +1,570 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Ability - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/ability.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-allowed">::allowed</a> + + <li><a href="#method-c-project_abilities">::project_abilities</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Ability</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-allowed" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">allowed</span><span + class="method-args">(object, subject)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="allowed-source"> + <pre><span class="ruby-comment"># File app/models/ability.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">allowed</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-keyword">case</span> <span class="ruby-identifier">subject</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"Project"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">project_abilities</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"Issue"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">issue_abilities</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"Note"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">note_abilities</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"Snippet"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">snippet_abilities</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"MergeRequest"</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">merge_request_abilities</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-keyword">else</span> [] + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- allowed-source --> + + </div> + + + + + </div><!-- allowed-method --> + + + <div id="method-c-project_abilities" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_abilities</span><span + class="method-args">(user, project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_abilities-source"> + <pre><span class="ruby-comment"># File app/models/ability.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_abilities</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">project</span>) + <span class="ruby-identifier">rules</span> = [] + + <span class="ruby-identifier">rules</span> <span class="ruby-operator"><<</span> [ + <span class="ruby-value">:read_project</span>, + <span class="ruby-value">:read_wiki</span>, + <span class="ruby-value">:read_issue</span>, + <span class="ruby-value">:read_milestone</span>, + <span class="ruby-value">:read_snippet</span>, + <span class="ruby-value">:read_team_member</span>, + <span class="ruby-value">:read_merge_request</span>, + <span class="ruby-value">:read_note</span>, + <span class="ruby-value">:write_project</span>, + <span class="ruby-value">:write_issue</span>, + <span class="ruby-value">:write_note</span> + ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">guest_access_for?</span>(<span class="ruby-identifier">user</span>) + + <span class="ruby-identifier">rules</span> <span class="ruby-operator"><<</span> [ + <span class="ruby-value">:download_code</span>, + <span class="ruby-value">:write_merge_request</span>, + <span class="ruby-value">:write_snippet</span> + ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">report_access_for?</span>(<span class="ruby-identifier">user</span>) + + <span class="ruby-identifier">rules</span> <span class="ruby-operator"><<</span> [ + <span class="ruby-value">:write_wiki</span>, + <span class="ruby-value">:push_code</span> + ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">dev_access_for?</span>(<span class="ruby-identifier">user</span>) + + <span class="ruby-identifier">rules</span> <span class="ruby-operator"><<</span> [ + <span class="ruby-value">:push_code_to_protected_branches</span> + ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">master_access_for?</span>(<span class="ruby-identifier">user</span>) + + <span class="ruby-identifier">rules</span> <span class="ruby-operator"><<</span> [ + <span class="ruby-value">:modify_issue</span>, + <span class="ruby-value">:modify_snippet</span>, + <span class="ruby-value">:modify_merge_request</span>, + <span class="ruby-value">:admin_project</span>, + <span class="ruby-value">:admin_issue</span>, + <span class="ruby-value">:admin_milestone</span>, + <span class="ruby-value">:admin_snippet</span>, + <span class="ruby-value">:admin_team_member</span>, + <span class="ruby-value">:admin_merge_request</span>, + <span class="ruby-value">:admin_note</span>, + <span class="ruby-value">:accept_mr</span>, + <span class="ruby-value">:admin_wiki</span> + ] <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">master_access_for?</span>(<span class="ruby-identifier">user</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">owner</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">user</span> + + <span class="ruby-identifier">rules</span>.<span class="ruby-identifier">flatten</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project_abilities-source --> + + </div> + + + + + </div><!-- project_abilities-method --> + + + </section><!-- public-class-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Account.html b/doc/app/Account.html new file mode 100644 index 00000000000..58f657586b2 --- /dev/null +++ b/doc/app/Account.html @@ -0,0 +1,881 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Account - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/account.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-block">#block</a> + + <li><a href="#method-i-can_create_group-3F">#can_create_group?</a> + + <li><a href="#method-i-can_create_project-3F">#can_create_project?</a> + + <li><a href="#method-i-cared_merge_requests">#cared_merge_requests</a> + + <li><a href="#method-i-first_name">#first_name</a> + + <li><a href="#method-i-identifier">#identifier</a> + + <li><a href="#method-i-is_admin-3F">#is_admin?</a> + + <li><a href="#method-i-last_activity_project">#last_activity_project</a> + + <li><a href="#method-i-project_ids">#project_ids</a> + + <li><a href="#method-i-projects_limit_percent">#projects_limit_percent</a> + + <li><a href="#method-i-projects_with_events">#projects_with_events</a> + + <li><a href="#method-i-recent_push">#recent_push</a> + + <li><a href="#method-i-require_ssh_key-3F">#require_ssh_key?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Account</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-block" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">block</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Remove user from all projects and set blocked attribute to true</p> + + + + <div class="method-source-code" id="block-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">block</span> + <span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">find_each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">membership</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">membership</span>.<span class="ruby-identifier">destroy</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">blocked</span> = <span class="ruby-keyword">true</span> + <span class="ruby-identifier">save</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- block-source --> + + </div> + + + + + </div><!-- block-method --> + + + <div id="method-i-can_create_group-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can_create_group?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can_create_group-3F-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can_create_group?</span> + <span class="ruby-identifier">is_admin?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- can_create_group-3F-source --> + + </div> + + + + + </div><!-- can_create_group-3F-method --> + + + <div id="method-i-can_create_project-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can_create_project?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can_create_project-3F-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 21</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can_create_project?</span> + <span class="ruby-identifier">projects_limit</span> <span class="ruby-operator">></span> <span class="ruby-identifier">my_own_projects</span>.<span class="ruby-identifier">count</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- can_create_project-3F-source --> + + </div> + + + + + </div><!-- can_create_project-3F-method --> + + + <div id="method-i-cared_merge_requests" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">cared_merge_requests</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="cared_merge_requests-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 37</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">cared_merge_requests</span> + <span class="ruby-constant">MergeRequest</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"author_id = :id or assignee_id = :id"</span>, <span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">opened</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- cared_merge_requests-source --> + + </div> + + + + + </div><!-- cared_merge_requests-method --> + + + <div id="method-i-first_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">first_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="first_name-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">first_name</span> + <span class="ruby-identifier">name</span>.<span class="ruby-identifier">split</span>.<span class="ruby-identifier">first</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">blank?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- first_name-source --> + + </div> + + + + + </div><!-- first_name-method --> + + + <div id="method-i-identifier" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">identifier</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns a string for use as a Gitolite user identifier</p> + +<p><a href="Note.html">Note</a> that Gitolite 2.x requires the following +pattern for users:</p> + +<pre>^@?[0-9a-zA-Z][0-9a-zA-Z._\@+-]*$</pre> + + + + <div class="method-source-code" id="identifier-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">identifier</span> + <span class="ruby-comment"># Replace non-word chars with underscores, then make sure it starts with</span> + <span class="ruby-comment"># valid chars</span> + <span class="ruby-identifier">email</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r\W/</span>, <span class="ruby-string">'_'</span>).<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r\A([\W\_])+/</span>, <span class="ruby-string">''</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- identifier-source --> + + </div> + + + + + </div><!-- identifier-method --> + + + <div id="method-i-is_admin-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_admin?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="is_admin-3F-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_admin?</span> + <span class="ruby-identifier">admin</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- is_admin-3F-source --> + + </div> + + + + + </div><!-- is_admin-3F-method --> + + + <div id="method-i-last_activity_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_activity_project</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_activity_project-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_activity_project</span> + <span class="ruby-identifier">projects</span>.<span class="ruby-identifier">first</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_activity_project-source --> + + </div> + + + + + </div><!-- last_activity_project-method --> + + + <div id="method-i-project_ids" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_ids</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_ids-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 41</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_ids</span> + <span class="ruby-identifier">projects</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:id</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- project_ids-source --> + + </div> + + + + + </div><!-- project_ids-method --> + + + <div id="method-i-projects_limit_percent" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">projects_limit_percent</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="projects_limit_percent-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">projects_limit_percent</span> + <span class="ruby-keyword">return</span> <span class="ruby-value">100</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">projects_limit</span>.<span class="ruby-identifier">zero?</span> + (<span class="ruby-identifier">my_own_projects</span>.<span class="ruby-identifier">count</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">projects_limit</span>) * <span class="ruby-value">100</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- projects_limit_percent-source --> + + </div> + + + + + </div><!-- projects_limit_percent-method --> + + + <div id="method-i-projects_with_events" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">projects_with_events</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="projects_with_events-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 70</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">projects_with_events</span> + <span class="ruby-identifier">projects</span>.<span class="ruby-identifier">includes</span>(<span class="ruby-value">:events</span>).<span class="ruby-identifier">order</span>(<span class="ruby-string">"events.created_at DESC"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- projects_with_events-source --> + + </div> + + + + + </div><!-- projects_with_events-method --> + + + <div id="method-i-recent_push" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">recent_push</span><span + class="method-args">(project_id = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="recent_push-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">recent_push</span> <span class="ruby-identifier">project_id</span> = <span class="ruby-keyword">nil</span> + <span class="ruby-comment"># Get push events not earlier than 2 hours ago</span> + <span class="ruby-identifier">events</span> = <span class="ruby-identifier">recent_events</span>.<span class="ruby-identifier">code_push</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"created_at > ?"</span>, <span class="ruby-constant">Time</span>.<span class="ruby-identifier">now</span> <span class="ruby-operator">-</span> <span class="ruby-value">2</span>.<span class="ruby-identifier">hours</span>) + <span class="ruby-identifier">events</span> = <span class="ruby-identifier">events</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_id</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">project_id</span> + + <span class="ruby-comment"># Take only latest one</span> + <span class="ruby-identifier">events</span> = <span class="ruby-identifier">events</span>.<span class="ruby-identifier">recent</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-value">1</span>).<span class="ruby-identifier">first</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- recent_push-source --> + + </div> + + + + + </div><!-- recent_push-method --> + + + <div id="method-i-require_ssh_key-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">require_ssh_key?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="require_ssh_key-3F-source"> + <pre><span class="ruby-comment"># File app/roles/account.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">require_ssh_key?</span> + <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- require_ssh_key-3F-source --> + + </div> + + + + + </div><!-- require_ssh_key-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ActivityObserver.html b/doc/app/ActivityObserver.html new file mode 100644 index 00000000000..3b31271d5ca --- /dev/null +++ b/doc/app/ActivityObserver.html @@ -0,0 +1,531 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ActivityObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/activity_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-after_save">#after_save</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ActivityObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(record)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/activity_observer.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span>(<span class="ruby-identifier">record</span>) + <span class="ruby-constant">Event</span>.<span class="ruby-identifier">create</span>( + <span class="ruby-identifier">project</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">project</span>, + <span class="ruby-identifier">target_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">target_type</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-constant">Event</span>.<span class="ruby-identifier">determine_action</span>(<span class="ruby-identifier">record</span>), + <span class="ruby-identifier">author_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">author_id</span> + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + <div id="method-i-after_save" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_save</span><span + class="method-args">(record)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_save-source"> + <pre><span class="ruby-comment"># File app/observers/activity_observer.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_save</span>(<span class="ruby-identifier">record</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">changed</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"closed"</span>) + <span class="ruby-constant">Event</span>.<span class="ruby-identifier">create</span>( + <span class="ruby-identifier">project</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">project</span>, + <span class="ruby-identifier">target_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">target_type</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> (<span class="ruby-identifier">record</span>.<span class="ruby-identifier">closed</span> <span class="ruby-operator">?</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Closed</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Reopened</span>), + <span class="ruby-identifier">author_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">author_id_of_changes</span> + ) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_save-source --> + + </div> + + + + + </div><!-- after_save-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin.html b/doc/app/Admin.html new file mode 100644 index 00000000000..94fb27efb98 --- /dev/null +++ b/doc/app/Admin.html @@ -0,0 +1,432 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Admin - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Admin</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/DashboardController.html b/doc/app/Admin/DashboardController.html new file mode 100644 index 00000000000..00154b3dff3 --- /dev/null +++ b/doc/app/Admin/DashboardController.html @@ -0,0 +1,488 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::DashboardController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/dashboard_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-index">#index</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::DashboardController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/dashboard_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@workers</span> = <span class="ruby-constant">Resque</span>.<span class="ruby-identifier">workers</span> + <span class="ruby-ivar">@pending_jobs</span> = <span class="ruby-constant">Resque</span>.<span class="ruby-identifier">size</span>(<span class="ruby-value">:post_receive</span>) + <span class="ruby-ivar">@projects</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at DESC"</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">10</span>) + <span class="ruby-ivar">@users</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at DESC"</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">10</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/GroupsController.html b/doc/app/Admin/GroupsController.html new file mode 100644 index 00000000000..ef4dae9ecda --- /dev/null +++ b/doc/app/Admin/GroupsController.html @@ -0,0 +1,771 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::GroupsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/groups_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-project_update">#project_update</a> + + <li><a href="#method-i-remove_project">#remove_project</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::GroupsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@group</span> = <span class="ruby-constant">Group</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:group</span>]) + <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-identifier">current_user</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@group</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Group was successfully created.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"new"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 64</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">admin_groups_path</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Group was successfully deleted.'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@groups</span> = <span class="ruby-constant">Group</span>.<span class="ruby-identifier">scoped</span> + <span class="ruby-ivar">@groups</span> = <span class="ruby-ivar">@groups</span>.<span class="ruby-identifier">search</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:name</span>]) <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:name</span>].<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@groups</span> = <span class="ruby-ivar">@groups</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@group</span> = <span class="ruby-constant">Group</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-project_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_update-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_update</span> + <span class="ruby-identifier">project_ids</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:project_ids</span>] + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_ids</span>).<span class="ruby-identifier">update_all</span>(<span class="ruby-identifier">group_id</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">id</span>) + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Group was successfully updated.'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project_update-source --> + + </div> + + + + + </div><!-- project_update-method --> + + + <div id="method-i-remove_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">remove_project</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="remove_project-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_project</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:project_id</span>]) + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">group_id</span> = <span class="ruby-keyword">nil</span> + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">save</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Group was successfully updated.'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- remove_project-source --> + + </div> + + + + + </div><!-- remove_project-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@projects</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">scoped</span> + <span class="ruby-ivar">@projects</span> = <span class="ruby-ivar">@projects</span>.<span class="ruby-identifier">not_in_group</span>(<span class="ruby-ivar">@group</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@projects</span> = <span class="ruby-ivar">@projects</span>.<span class="ruby-identifier">all</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/groups_controller.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-identifier">group_params</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:group</span>].<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">owner_id</span> =<span class="ruby-identifier">group_params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:owner_id</span>) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">owner_id</span> + <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">owner_id</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">group_params</span>) + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@group</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Group was successfully updated.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"edit"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/HooksController.html b/doc/app/Admin/HooksController.html new file mode 100644 index 00000000000..48cd5d00454 --- /dev/null +++ b/doc/app/Admin/HooksController.html @@ -0,0 +1,603 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::HooksController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/hooks_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-test">#test</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::HooksController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/hooks_controller.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@hook</span> = <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:hook</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@hook</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">admin_hooks_path</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Hook was successfully created.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@hooks</span> = <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all</span> + <span class="ruby-identifier">render</span> <span class="ruby-value">:index</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/hooks_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@hook</span> = <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@hook</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">admin_hooks_path</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/hooks_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@hooks</span> = <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all</span> + <span class="ruby-ivar">@hook</span> = <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-test" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">test</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="test-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/hooks_controller.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">test</span> + <span class="ruby-ivar">@hook</span> = <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:hook_id</span>]) + <span class="ruby-identifier">data</span> = { + <span class="ruby-identifier">event_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"project_create"</span>, + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-string">"Ruby"</span>, + <span class="ruby-identifier">path</span><span class="ruby-operator">:</span> <span class="ruby-string">"ruby"</span>, + <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-value">1</span>, + <span class="ruby-identifier">owner_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"Someone"</span>, + <span class="ruby-identifier">owner_email</span><span class="ruby-operator">:</span> <span class="ruby-string">"example@gitlabhq.com"</span> + } + <span class="ruby-ivar">@hook</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-identifier">data</span>) + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- test-source --> + + </div> + + + + + </div><!-- test-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/LogsController.html b/doc/app/Admin/LogsController.html new file mode 100644 index 00000000000..8f70b1ade2c --- /dev/null +++ b/doc/app/Admin/LogsController.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::LogsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/logs_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::LogsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/ProjectsController.html b/doc/app/Admin/ProjectsController.html new file mode 100644 index 00000000000..5744746b47c --- /dev/null +++ b/doc/app/Admin/ProjectsController.html @@ -0,0 +1,733 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::ProjectsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/projects_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-team_update">#team_update</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::ProjectsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@admin_project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:project</span>]) + <span class="ruby-ivar">@admin_project</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-identifier">current_user</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_project</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@admin_project</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Project was successfully created.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"new"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 54</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@admin_project</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">admin_projects_url</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Project was successfully deleted.'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@admin_projects</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">scoped</span> + <span class="ruby-ivar">@admin_projects</span> = <span class="ruby-ivar">@admin_projects</span>.<span class="ruby-identifier">search</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:name</span>]) <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:name</span>].<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@admin_projects</span> = <span class="ruby-ivar">@admin_projects</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@admin_project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@users</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">scoped</span> + <span class="ruby-ivar">@users</span> = <span class="ruby-ivar">@users</span>.<span class="ruby-identifier">not_in_project</span>(<span class="ruby-ivar">@admin_project</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_project</span>.<span class="ruby-identifier">users</span>.<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@users</span> = <span class="ruby-ivar">@users</span>.<span class="ruby-identifier">all</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-team_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">team_update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="team_update-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">team_update</span> + <span class="ruby-ivar">@admin_project</span>.<span class="ruby-identifier">add_users_ids_to_team</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:user_ids</span>], <span class="ruby-identifier">params</span>[<span class="ruby-value">:project_access</span>]) + + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@admin_project</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Project was successfully updated.'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- team_update-source --> + + </div> + + + + + </div><!-- team_update-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/projects_controller.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-identifier">owner_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:project</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:owner_id</span>) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">owner_id</span> + <span class="ruby-ivar">@admin_project</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">owner_id</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_project</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:project</span>]) + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@admin_project</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Project was successfully updated.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"edit"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/ResqueController.html b/doc/app/Admin/ResqueController.html new file mode 100644 index 00000000000..db73599b4a7 --- /dev/null +++ b/doc/app/Admin/ResqueController.html @@ -0,0 +1,484 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::ResqueController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/resque_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::ResqueController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/resque_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/TeamMembersController.html b/doc/app/Admin/TeamMembersController.html new file mode 100644 index 00000000000..907bf279f8e --- /dev/null +++ b/doc/app/Admin/TeamMembersController.html @@ -0,0 +1,558 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::TeamMembersController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/team_members_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::TeamMembersController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/team_members_controller.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@admin_team_member</span> = <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@admin_team_member</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/team_members_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> + <span class="ruby-ivar">@admin_team_member</span> = <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/team_members_controller.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-ivar">@admin_team_member</span> = <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_team_member</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:team_member</span>]) + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@admin_team_member</span>.<span class="ruby-identifier">project</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Project Access was successfully updated.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"edit"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Admin/UsersController.html b/doc/app/Admin/UsersController.html new file mode 100644 index 00000000000..b300e4f7fc5 --- /dev/null +++ b/doc/app/Admin/UsersController.html @@ -0,0 +1,839 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Admin::UsersController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin/users_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../AdminController.html">AdminController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-block">#block</a> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-team_update">#team_update</a> + + <li><a href="#method-i-unblock">#unblock</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Admin::UsersController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-block" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">block</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="block-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">block</span> + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">block</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>, <span class="ruby-identifier">alert</span><span class="ruby-operator">:</span> <span class="ruby-string">"Successfully blocked"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>, <span class="ruby-identifier">alert</span><span class="ruby-operator">:</span> <span class="ruby-string">"Error occured. User was not blocked"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- block-source --> + + </div> + + + + + </div><!-- block-method --> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 60</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-identifier">admin</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-string">"admin"</span>) + + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>], <span class="ruby-identifier">as</span><span class="ruby-operator">:</span> <span class="ruby-value">:admin</span>) + <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">admin</span> = (<span class="ruby-identifier">admin</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">admin</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@admin_user</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'User was successfully created.'</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@admin_user</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:created</span>, <span class="ruby-identifier">location</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@admin_user</span> } + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"new"</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">errors</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:unprocessable_entity</span> } + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 99</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">admin_users_url</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">head</span> <span class="ruby-value">:ok</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@admin_users</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">scoped</span> + <span class="ruby-ivar">@admin_users</span> = <span class="ruby-ivar">@admin_users</span>.<span class="ruby-identifier">filter</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:filter</span>]) + <span class="ruby-ivar">@admin_users</span> = <span class="ruby-ivar">@admin_users</span>.<span class="ruby-identifier">search</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:name</span>]) <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:name</span>].<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@admin_users</span> = <span class="ruby-ivar">@admin_users</span>.<span class="ruby-identifier">order</span>(<span class="ruby-string">"updated_at DESC"</span>).<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 32</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">new</span>({ <span class="ruby-identifier">projects_limit</span><span class="ruby-operator">:</span> <span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">default_projects_limit</span> }, <span class="ruby-identifier">as</span><span class="ruby-operator">:</span> <span class="ruby-value">:admin</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + + <span class="ruby-ivar">@projects</span> = <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-constant">Project</span> + <span class="ruby-keyword">else</span> + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">without_user</span>(<span class="ruby-ivar">@admin_user</span>) + <span class="ruby-keyword">end</span>.<span class="ruby-identifier">all</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-team_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">team_update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="team_update-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 19</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">team_update</span> + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">user_bulk_import</span>( + <span class="ruby-ivar">@admin_user</span>, + <span class="ruby-identifier">params</span>[<span class="ruby-value">:project_ids</span>], + <span class="ruby-identifier">params</span>[<span class="ruby-value">:project_access</span>] + ) + + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@admin_user</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Teams were successfully updated.'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- team_update-source --> + + </div> + + + + + </div><!-- team_update-method --> + + + <div id="method-i-unblock" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">unblock</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="unblock-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 50</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">unblock</span> + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">update_attribute</span>(<span class="ruby-value">:blocked</span>, <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>, <span class="ruby-identifier">alert</span><span class="ruby-operator">:</span> <span class="ruby-string">"Successfully unblocked"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>, <span class="ruby-identifier">alert</span><span class="ruby-operator">:</span> <span class="ruby-string">"Error occured. User was not unblocked"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- unblock-source --> + + </div> + + + + + </div><!-- unblock-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/admin/users_controller.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-identifier">admin</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-string">"admin"</span>) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>][<span class="ruby-value">:password</span>].<span class="ruby-identifier">blank?</span> + <span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:password</span>) + <span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>].<span class="ruby-identifier">delete</span>(<span class="ruby-value">:password_confirmation</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@admin_user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">admin</span> = (<span class="ruby-identifier">admin</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">admin</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>], <span class="ruby-identifier">as</span><span class="ruby-operator">:</span> <span class="ruby-value">:admin</span>) + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> [<span class="ruby-value">:admin</span>, <span class="ruby-ivar">@admin_user</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'User was successfully updated.'</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">head</span> <span class="ruby-value">:ok</span> } + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"edit"</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">json</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@admin_user</span>.<span class="ruby-identifier">errors</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:unprocessable_entity</span> } + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/AdminController.html b/doc/app/AdminController.html new file mode 100644 index 00000000000..bdda7958da9 --- /dev/null +++ b/doc/app/AdminController.html @@ -0,0 +1,490 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class AdminController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/admin_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-authenticate_admin-21">#authenticate_admin!</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class AdminController</h1> + + <div id="description" class="description"> + +<p>Provides a base class for <a href="Admin.html">Admin</a> controllers to +subclass</p> + +<p>Automatically sets the layout and ensures an administrator is logged in</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-authenticate_admin-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authenticate_admin!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authenticate_admin-21-source"> + <pre><span class="ruby-comment"># File app/controllers/admin_controller.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authenticate_admin!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">is_admin?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- authenticate_admin-21-source --> + + </div> + + + + + </div><!-- authenticate_admin-21-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ApplicationController.html b/doc/app/ApplicationController.html new file mode 100644 index 00000000000..dafa341313a --- /dev/null +++ b/doc/app/ApplicationController.html @@ -0,0 +1,1015 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ApplicationController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/application_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActionController::Base + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-abilities">#abilities</a> + + <li><a href="#method-i-access_denied-21">#access_denied!</a> + + <li><a href="#method-i-add_project_abilities">#add_project_abilities</a> + + <li><a href="#method-i-after_sign_in_path_for">#after_sign_in_path_for</a> + + <li><a href="#method-i-authorize_code_access-21">#authorize_code_access!</a> + + <li><a href="#method-i-authorize_project-21">#authorize_project!</a> + + <li><a href="#method-i-can-3F">#can?</a> + + <li><a href="#method-i-dev_tools">#dev_tools</a> + + <li><a href="#method-i-git_not_found-21">#git_not_found!</a> + + <li><a href="#method-i-method_missing">#method_missing</a> + + <li><a href="#method-i-no_cache_headers">#no_cache_headers</a> + + <li><a href="#method-i-not_found-21">#not_found!</a> + + <li><a href="#method-i-project">#project</a> + + <li><a href="#method-i-reject_blocked-21">#reject_blocked!</a> + + <li><a href="#method-i-render_404">#render_404</a> + + <li><a href="#method-i-require_non_empty_project">#require_non_empty_project</a> + + <li><a href="#method-i-set_current_user_for_observers">#set_current_user_for_observers</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ApplicationController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-abilities" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">abilities</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="abilities-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 48</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">abilities</span> + <span class="ruby-ivar">@abilities</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Six</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- abilities-source --> + + </div> + + + + + </div><!-- abilities-method --> + + + <div id="method-i-access_denied-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">access_denied!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="access_denied-21-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 73</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">access_denied!</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"errors/access_denied"</span>, <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-string">"errors"</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">404</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- access_denied-21-source --> + + </div> + + + + + </div><!-- access_denied-21-method --> + + + <div id="method-i-add_project_abilities" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_project_abilities</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="add_project_abilities-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_project_abilities</span> + <span class="ruby-identifier">abilities</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Ability</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- add_project_abilities-source --> + + </div> + + + + + </div><!-- add_project_abilities-method --> + + + <div id="method-i-after_sign_in_path_for" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_sign_in_path_for</span><span + class="method-args">(resource)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_sign_in_path_for-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_sign_in_path_for</span> <span class="ruby-identifier">resource</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">resource</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">User</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">resource</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:blocked</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">resource</span>.<span class="ruby-identifier">blocked</span> + <span class="ruby-identifier">sign_out</span> <span class="ruby-identifier">resource</span> + <span class="ruby-identifier">flash</span>[<span class="ruby-value">:alert</span>] = <span class="ruby-string">"Your account was blocked"</span> + <span class="ruby-identifier">new_user_session_path</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">super</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_sign_in_path_for-source --> + + </div> + + + + + </div><!-- after_sign_in_path_for-method --> + + + <div id="method-i-authorize_code_access-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_code_access!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_code_access-21-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 69</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_code_access!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">access_denied!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:download_code</span>, <span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_code_access-21-source --> + + </div> + + + + + </div><!-- authorize_code_access-21-method --> + + + <div id="method-i-authorize_project-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_project!</span><span + class="method-args">(action)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_project-21-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_project!</span>(<span class="ruby-identifier">action</span>) + <span class="ruby-keyword">return</span> <span class="ruby-identifier">access_denied!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_project-21-source --> + + </div> + + + + + </div><!-- authorize_project-21-method --> + + + <div id="method-i-can-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can?</span><span + class="method-args">(object, action, subject)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can-3F-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-identifier">abilities</span>.<span class="ruby-identifier">allowed?</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- can-3F-source --> + + </div> + + + + + </div><!-- can-3F-method --> + + + <div id="method-i-dev_tools" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">dev_tools</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="dev_tools-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 107</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">dev_tools</span> + <span class="ruby-constant">Rack</span><span class="ruby-operator">::</span><span class="ruby-constant">MiniProfiler</span>.<span class="ruby-identifier">authorize_request</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- dev_tools-source --> + + </div> + + + + + </div><!-- dev_tools-method --> + + + <div id="method-i-git_not_found-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">git_not_found!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="git_not_found-21-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 81</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">git_not_found!</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"errors/git_not_found"</span>, <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-string">"errors"</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">404</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- git_not_found-21-source --> + + </div> + + + + + </div><!-- git_not_found-21-method --> + + + <div id="method-i-method_missing" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">method_missing</span><span + class="method-args">(method_sym, *arguments, &block)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="method_missing-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method_sym</span>, *<span class="ruby-identifier">arguments</span>, &<span class="ruby-identifier">block</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">method_sym</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%r^authorize_(.*)!$/</span> + <span class="ruby-identifier">authorize_project!</span>(<span class="ruby-node">$1</span>.<span class="ruby-identifier">to_sym</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">super</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- method_missing-source --> + + </div> + + + + + </div><!-- method_missing-method --> + + + <div id="method-i-no_cache_headers" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">no_cache_headers</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="no_cache_headers-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 101</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">no_cache_headers</span> + <span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-string">"Cache-Control"</span>] = <span class="ruby-string">"no-cache, no-store, max-age=0, must-revalidate"</span> + <span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-string">"Pragma"</span>] = <span class="ruby-string">"no-cache"</span> + <span class="ruby-identifier">response</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-string">"Expires"</span>] = <span class="ruby-string">"Fri, 01 Jan 1990 00:00:00 GMT"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- no_cache_headers-source --> + + </div> + + + + + </div><!-- no_cache_headers-method --> + + + <div id="method-i-not_found-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">not_found!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="not_found-21-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">not_found!</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"errors/not_found"</span>, <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-string">"errors"</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">404</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- not_found-21-source --> + + </div> + + + + + </div><!-- not_found-21-method --> + + + <div id="method-i-project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project</span> + <span class="ruby-ivar">@project</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">find_by_code</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:project_id</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@project</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">render_404</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project-source --> + + </div> + + + + + </div><!-- project-method --> + + + <div id="method-i-reject_blocked-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reject_blocked!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reject_blocked-21-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reject_blocked!</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">current_user</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">blocked</span> + <span class="ruby-identifier">sign_out</span> <span class="ruby-identifier">current_user</span> + <span class="ruby-identifier">flash</span>[<span class="ruby-value">:alert</span>] = <span class="ruby-string">"Your account was blocked"</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">new_user_session_path</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- reject_blocked-21-source --> + + </div> + + + + + </div><!-- reject_blocked-21-method --> + + + <div id="method-i-render_404" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">render_404</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="render_404-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 93</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">render_404</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">file</span><span class="ruby-operator">:</span> <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"public"</span>, <span class="ruby-string">"404"</span>), <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>, <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-string">"404"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- render_404-source --> + + </div> + + + + + </div><!-- render_404-method --> + + + <div id="method-i-require_non_empty_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">require_non_empty_project</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="require_non_empty_project-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 97</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">require_non_empty_project</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-ivar">@project</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">empty_repo?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- require_non_empty_project-source --> + + </div> + + + + + </div><!-- require_non_empty_project-method --> + + + <div id="method-i-set_current_user_for_observers" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">set_current_user_for_observers</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="set_current_user_for_observers-source"> + <pre><span class="ruby-comment"># File app/controllers/application_controller.rb, line 43</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_current_user_for_observers</span> + <span class="ruby-constant">MergeRequestObserver</span>.<span class="ruby-identifier">current_user</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-constant">IssueObserver</span>.<span class="ruby-identifier">current_user</span> = <span class="ruby-identifier">current_user</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- set_current_user_for_observers-source --> + + </div> + + + + + </div><!-- set_current_user_for_observers-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ApplicationDecorator.html b/doc/app/ApplicationDecorator.html new file mode 100644 index 00000000000..72a459bb686 --- /dev/null +++ b/doc/app/ApplicationDecorator.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ApplicationDecorator - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/decorators/application_decorator.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Draper::Base + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ApplicationDecorator</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ApplicationHelper.html b/doc/app/ApplicationHelper.html new file mode 100644 index 00000000000..9bc4243e2d0 --- /dev/null +++ b/doc/app/ApplicationHelper.html @@ -0,0 +1,1018 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module ApplicationHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/application_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-app_theme">#app_theme</a> + + <li><a href="#method-i-authbutton">#authbutton</a> + + <li><a href="#method-i-current_action-3F">#current_action?</a> + + <li><a href="#method-i-current_controller-3F">#current_controller?</a> + + <li><a href="#method-i-emoji_autocomplete_source">#emoji_autocomplete_source</a> + + <li><a href="#method-i-gravatar_icon">#gravatar_icon</a> + + <li><a href="#method-i-grouped_options_refs">#grouped_options_refs</a> + + <li><a href="#method-i-hexdigest">#hexdigest</a> + + <li><a href="#method-i-last_commit">#last_commit</a> + + <li><a href="#method-i-ldap_enable-3F">#ldap_enable?</a> + + <li><a href="#method-i-project_last_activity">#project_last_activity</a> + + <li><a href="#method-i-request_protocol">#request_protocol</a> + + <li><a href="#method-i-search_autocomplete_source">#search_autocomplete_source</a> + + <li><a href="#method-i-show_last_push_widget-3F">#show_last_push_widget?</a> + + <li><a href="#method-i-web_app_url">#web_app_url</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module ApplicationHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-app_theme" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">app_theme</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="app_theme-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 125</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">app_theme</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Theme</span>.<span class="ruby-identifier">css_class_by_id</span>(<span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">try</span>(<span class="ruby-value">:theme_id</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- app_theme-source --> + + </div> + + + + + </div><!-- app_theme-method --> + + + <div id="method-i-authbutton" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authbutton</span><span + class="method-args">(provider, size = 64)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authbutton-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 150</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authbutton</span>(<span class="ruby-identifier">provider</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">64</span>) + <span class="ruby-identifier">file_name</span> = <span class="ruby-node">"#{provider.to_s.split('_').first}_#{size}.png"</span> + <span class="ruby-identifier">image_tag</span>(<span class="ruby-node">"authbuttons/#{file_name}"</span>, + <span class="ruby-identifier">alt</span><span class="ruby-operator">:</span> <span class="ruby-node">"Sign in with #{provider.to_s.titleize}"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authbutton-source --> + + </div> + + + + + </div><!-- authbutton-method --> + + + <div id="method-i-current_action-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">current_action?</span><span + class="method-args">(*args)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Check if a partcular action is the current one</p> + +<p>args - One or more action names to check</p> + +<p>Examples</p> + +<pre class="ruby"><span class="ruby-comment"># On Projects#new</span> +<span class="ruby-identifier">current_action?</span>(:<span class="ruby-identifier">new</span>) <span class="ruby-comment"># => true</span> +<span class="ruby-identifier">current_action?</span>(:<span class="ruby-identifier">create</span>) <span class="ruby-comment"># => false</span> +<span class="ruby-identifier">current_action?</span>(:<span class="ruby-identifier">new</span>, :<span class="ruby-identifier">create</span>) <span class="ruby-comment"># => true</span> +</pre> + + + + <div class="method-source-code" id="current_action-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">current_action?</span>(*<span class="ruby-identifier">args</span>) + <span class="ruby-identifier">args</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">action_name</span> } +<span class="ruby-keyword">end</span></pre> + </div><!-- current_action-3F-source --> + + </div> + + + + + </div><!-- current_action-3F-method --> + + + <div id="method-i-current_controller-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">current_controller?</span><span + class="method-args">(*args)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Check if a particular controller is the current one</p> + +<p>args - One or more controller names to check</p> + +<p>Examples</p> + +<pre class="ruby"><span class="ruby-comment"># On TreeController</span> +<span class="ruby-identifier">current_controller?</span>(:<span class="ruby-identifier">tree</span>) <span class="ruby-comment"># => true</span> +<span class="ruby-identifier">current_controller?</span>(:<span class="ruby-identifier">commits</span>) <span class="ruby-comment"># => false</span> +<span class="ruby-identifier">current_controller?</span>(:<span class="ruby-identifier">commits</span>, :<span class="ruby-identifier">tree</span>) <span class="ruby-comment"># => true</span> +</pre> + + + + <div class="method-source-code" id="current_controller-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">current_controller?</span>(*<span class="ruby-identifier">args</span>) + <span class="ruby-identifier">args</span>.<span class="ruby-identifier">any?</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">controller_name</span> } +<span class="ruby-keyword">end</span></pre> + </div><!-- current_controller-3F-source --> + + </div> + + + + + </div><!-- current_controller-3F-method --> + + + <div id="method-i-emoji_autocomplete_source" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">emoji_autocomplete_source</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="emoji_autocomplete_source-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 115</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">emoji_autocomplete_source</span> + <span class="ruby-comment"># should be an array of strings</span> + <span class="ruby-comment"># so to_s can be called, because it is sufficient and to_json is too slow</span> + <span class="ruby-constant">Emoji</span>.<span class="ruby-identifier">names</span>.<span class="ruby-identifier">to_s</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- emoji_autocomplete_source-source --> + + </div> + + + + + </div><!-- emoji_autocomplete_source-method --> + + + <div id="method-i-gravatar_icon" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">gravatar_icon</span><span + class="method-args">(user_email = '', size = 40)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="gravatar_icon-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">gravatar_icon</span>(<span class="ruby-identifier">user_email</span> = <span class="ruby-string">''</span>, <span class="ruby-identifier">size</span> = <span class="ruby-value">40</span>) + <span class="ruby-keyword">if</span> <span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">disable_gravatar?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">user_email</span>.<span class="ruby-identifier">blank?</span> + <span class="ruby-string">'no_avatar.png'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">gravatar_prefix</span> = <span class="ruby-identifier">request</span>.<span class="ruby-identifier">ssl?</span> <span class="ruby-operator">?</span> <span class="ruby-string">"https://secure"</span> <span class="ruby-operator">:</span> <span class="ruby-string">"http://www"</span> + <span class="ruby-identifier">user_email</span>.<span class="ruby-identifier">strip!</span> + <span class="ruby-node">"#{gravatar_prefix}.gravatar.com/avatar/#{Digest::MD5.hexdigest(user_email.downcase)}?s=#{size}&d=identicon"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- gravatar_icon-source --> + + </div> + + + + + </div><!-- gravatar_icon-method --> + + + <div id="method-i-grouped_options_refs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">grouped_options_refs</span><span + class="method-args">(destination = :tree)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="grouped_options_refs-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">grouped_options_refs</span>(<span class="ruby-identifier">destination</span> = <span class="ruby-value">:tree</span>) + <span class="ruby-identifier">options</span> = [ + [<span class="ruby-string">"Branch"</span>, <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">branch_names</span> ], + [ <span class="ruby-string">"Tag"</span>, <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">tag_names</span> ] + ] + + <span class="ruby-comment"># If reference is commit id -</span> + <span class="ruby-comment"># we should add it to branch/tag selectbox</span> + <span class="ruby-keyword">if</span>(<span class="ruby-ivar">@ref</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">options</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@ref</span>) <span class="ruby-operator">&&</span> + <span class="ruby-ivar">@ref</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%r^[0-9a-zA-Z]{6,52}$/</span>) + <span class="ruby-identifier">options</span> <span class="ruby-operator"><<</span> [<span class="ruby-string">"Commit"</span>, [<span class="ruby-ivar">@ref</span>]] + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">grouped_options_for_select</span>(<span class="ruby-identifier">options</span>, <span class="ruby-ivar">@ref</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">default_branch</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- grouped_options_refs-source --> + + </div> + + + + + </div><!-- grouped_options_refs-method --> + + + <div id="method-i-hexdigest" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">hexdigest</span><span + class="method-args">(string)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="hexdigest-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 137</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">string</span>) + <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">hexdigest</span> <span class="ruby-identifier">string</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- hexdigest-source --> + + </div> + + + + + </div><!-- hexdigest-method --> + + + <div id="method-i-last_commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_commit</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_commit-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 51</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_commit</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo_exists?</span> + <span class="ruby-identifier">time_ago_in_words</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>.<span class="ruby-identifier">committed_date</span>) <span class="ruby-operator">+</span> <span class="ruby-string">" ago"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-string">"Never"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-string">"Never"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_commit-source --> + + </div> + + + + + </div><!-- last_commit-method --> + + + <div id="method-i-ldap_enable-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ldap_enable?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="ldap_enable-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 121</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ldap_enable?</span> + <span class="ruby-constant">Devise</span>.<span class="ruby-identifier">omniauth_providers</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:ldap</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- ldap_enable-3F-source --> + + </div> + + + + + </div><!-- ldap_enable-3F-method --> + + + <div id="method-i-project_last_activity" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_last_activity</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_last_activity-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 141</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_last_activity</span> <span class="ruby-identifier">project</span> + <span class="ruby-identifier">activity</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">last_activity</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">activity</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">activity</span>.<span class="ruby-identifier">created_at</span> + <span class="ruby-identifier">time_ago_in_words</span>(<span class="ruby-identifier">activity</span>.<span class="ruby-identifier">created_at</span>) <span class="ruby-operator">+</span> <span class="ruby-string">" ago"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-string">"Never"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project_last_activity-source --> + + </div> + + + + + </div><!-- project_last_activity-method --> + + + <div id="method-i-request_protocol" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">request_protocol</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="request_protocol-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 43</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">request_protocol</span> + <span class="ruby-identifier">request</span>.<span class="ruby-identifier">ssl?</span> <span class="ruby-operator">?</span> <span class="ruby-string">"https"</span> <span class="ruby-operator">:</span> <span class="ruby-string">"http"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- request_protocol-source --> + + </div> + + + + + </div><!-- request_protocol-method --> + + + <div id="method-i-search_autocomplete_source" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">search_autocomplete_source</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="search_autocomplete_source-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">search_autocomplete_source</span> + <span class="ruby-identifier">projects</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">map</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_path</span>(<span class="ruby-identifier">p</span>) } } + + <span class="ruby-identifier">default_nav</span> = [ + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"My Profile"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">profile_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"My SSH Keys"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">keys_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"My Dashboard"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">root_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"Admin Section"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">admin_root_path</span> }, + ] + + <span class="ruby-identifier">help_nav</span> = [ + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"Workflow Help"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">help_workflow_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"Permissions Help"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">help_permissions_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"Web Hooks Help"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">help_web_hooks_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"System Hooks Help"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">help_system_hooks_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"API Help"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">help_api_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"Markdown Help"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">help_markdown_path</span> }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-string">"SSH Keys Help"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">help_ssh_path</span> }, + ] + + <span class="ruby-identifier">project_nav</span> = [] + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@project</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@project</span>.<span class="ruby-identifier">new_record?</span> + <span class="ruby-identifier">project_nav</span> = [ + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Issues"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_issues_path</span>(<span class="ruby-ivar">@project</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Commits"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_commits_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">root_ref</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Merge Requests"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_merge_requests_path</span>(<span class="ruby-ivar">@project</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Milestones"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_milestones_path</span>(<span class="ruby-ivar">@project</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Snippets"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_snippets_path</span>(<span class="ruby-ivar">@project</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Team"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_team_index_path</span>(<span class="ruby-ivar">@project</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Tree"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_tree_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">root_ref</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Wall"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">wall_project_path</span>(<span class="ruby-ivar">@project</span>) }, + { <span class="ruby-identifier">label</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{@project.name} Wiki"</span>, <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_wikis_path</span>(<span class="ruby-ivar">@project</span>) }, + ] + <span class="ruby-keyword">end</span> + + [<span class="ruby-identifier">projects</span>, <span class="ruby-identifier">default_nav</span>, <span class="ruby-identifier">project_nav</span>, <span class="ruby-identifier">help_nav</span>].<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">to_json</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- search_autocomplete_source-source --> + + </div> + + + + + </div><!-- search_autocomplete_source-method --> + + + <div id="method-i-show_last_push_widget-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show_last_push_widget?</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show_last_push_widget-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 129</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show_last_push_widget?</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">event</span> <span class="ruby-operator">&&</span> + <span class="ruby-identifier">event</span>.<span class="ruby-identifier">last_push_to_non_root?</span> <span class="ruby-operator">&&</span> + <span class="ruby-operator">!</span><span class="ruby-identifier">event</span>.<span class="ruby-identifier">rm_ref?</span> <span class="ruby-operator">&&</span> + <span class="ruby-identifier">event</span>.<span class="ruby-identifier">project</span> <span class="ruby-operator">&&</span> + <span class="ruby-identifier">event</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">merge_requests_enabled</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show_last_push_widget-3F-source --> + + </div> + + + + + </div><!-- show_last_push_widget-3F-method --> + + + <div id="method-i-web_app_url" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">web_app_url</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="web_app_url-source"> + <pre><span class="ruby-comment"># File app/helpers/application_helper.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">web_app_url</span> + <span class="ruby-node">"#{request_protocol}://#{Gitlab.config.web_host}/"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- web_app_url-source --> + + </div> + + + + + </div><!-- web_app_url-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/AttachmentUploader.html b/doc/app/AttachmentUploader.html new file mode 100644 index 00000000000..b6e9d1bab37 --- /dev/null +++ b/doc/app/AttachmentUploader.html @@ -0,0 +1,486 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class AttachmentUploader - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/uploaders/attachment_uploader.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">CarrierWave::Uploader::Base + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-store_dir">#store_dir</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class AttachmentUploader</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-store_dir" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">store_dir</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Override the directory where uploaded files will be stored. This is a +sensible default for uploaders that are meant to be mounted:</p> + + + + <div class="method-source-code" id="store_dir-source"> + <pre><span class="ruby-comment"># File app/uploaders/attachment_uploader.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">store_dir</span> + <span class="ruby-node">"uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- store_dir-source --> + + </div> + + + + + </div><!-- store_dir-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Authority.html b/doc/app/Authority.html new file mode 100644 index 00000000000..92f46c55b0a --- /dev/null +++ b/doc/app/Authority.html @@ -0,0 +1,782 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Authority - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/authority.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-add_access">#add_access</a> + + <li><a href="#method-i-allow_read_for-3F">#allow_read_for?</a> + + <li><a href="#method-i-dev_access_for-3F">#dev_access_for?</a> + + <li><a href="#method-i-guest_access_for-3F">#guest_access_for?</a> + + <li><a href="#method-i-master_access_for-3F">#master_access_for?</a> + + <li><a href="#method-i-report_access_for-3F">#report_access_for?</a> + + <li><a href="#method-i-repository_masters">#repository_masters</a> + + <li><a href="#method-i-repository_readers">#repository_readers</a> + + <li><a href="#method-i-repository_writers">#repository_writers</a> + + <li><a href="#method-i-reset_access">#reset_access</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Authority</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-add_access" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_access</span><span + class="method-args">(user, *access)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Compatible with all access rights Should be rewrited for new access rights</p> + + + + <div class="method-source-code" id="add_access-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_access</span>(<span class="ruby-identifier">user</span>, *<span class="ruby-identifier">access</span>) + <span class="ruby-identifier">access</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">access</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:admin</span>) + { <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">MASTER</span> } + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">access</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value">:write</span>) + { <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">DEVELOPER</span> } + <span class="ruby-keyword">else</span> + { <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">REPORTER</span> } + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">opts</span> = { <span class="ruby-identifier">user</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span> } + <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">access</span>) + <span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">opts</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- add_access-source --> + + </div> + + + + + </div><!-- add_access-method --> + + + <div id="method-i-allow_read_for-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">allow_read_for?</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="allow_read_for-3F-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 39</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">allow_read_for?</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-operator">!</span><span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">empty?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- allow_read_for-3F-source --> + + </div> + + + + + </div><!-- allow_read_for-3F-method --> + + + <div id="method-i-dev_access_for-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">dev_access_for?</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="dev_access_for-3F-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 51</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">dev_access_for?</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-operator">!</span><span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> [<span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">DEVELOPER</span>, <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">MASTER</span>]).<span class="ruby-identifier">empty?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- dev_access_for-3F-source --> + + </div> + + + + + </div><!-- dev_access_for-3F-method --> + + + <div id="method-i-guest_access_for-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">guest_access_for?</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="guest_access_for-3F-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 43</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">guest_access_for?</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-operator">!</span><span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">empty?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- guest_access_for-3F-source --> + + </div> + + + + + </div><!-- guest_access_for-3F-method --> + + + <div id="method-i-master_access_for-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">master_access_for?</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="master_access_for-3F-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 55</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">master_access_for?</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-operator">!</span><span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> [<span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">MASTER</span>]).<span class="ruby-identifier">empty?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- master_access_for-3F-source --> + + </div> + + + + + </div><!-- master_access_for-3F-method --> + + + <div id="method-i-report_access_for-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">report_access_for?</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="report_access_for-3F-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">report_access_for?</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-operator">!</span><span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> [<span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">REPORTER</span>, <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">DEVELOPER</span>, <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">MASTER</span>]).<span class="ruby-identifier">empty?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- report_access_for-3F-source --> + + </div> + + + + + </div><!-- report_access_for-3F-method --> + + + <div id="method-i-repository_masters" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">repository_masters</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="repository_masters-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">repository_masters</span> + <span class="ruby-identifier">keys</span> = <span class="ruby-constant">Key</span>.<span class="ruby-identifier">joins</span>({<span class="ruby-identifier">user</span><span class="ruby-operator">:</span> <span class="ruby-value">:users_projects</span>}). + <span class="ruby-identifier">where</span>(<span class="ruby-string">"users_projects.project_id = ? AND users_projects.project_access = ?"</span>, <span class="ruby-identifier">id</span>, <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">MASTER</span>) + <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:identifier</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- repository_masters-source --> + + </div> + + + + + </div><!-- repository_masters-method --> + + + <div id="method-i-repository_readers" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">repository_readers</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="repository_readers-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 21</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">repository_readers</span> + <span class="ruby-identifier">keys</span> = <span class="ruby-constant">Key</span>.<span class="ruby-identifier">joins</span>({<span class="ruby-identifier">user</span><span class="ruby-operator">:</span> <span class="ruby-value">:users_projects</span>}). + <span class="ruby-identifier">where</span>(<span class="ruby-string">"users_projects.project_id = ? AND users_projects.project_access = ?"</span>, <span class="ruby-identifier">id</span>, <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">REPORTER</span>) + <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:identifier</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">deploy_keys</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:identifier</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- repository_readers-source --> + + </div> + + + + + </div><!-- repository_readers-method --> + + + <div id="method-i-repository_writers" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">repository_writers</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="repository_writers-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 27</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">repository_writers</span> + <span class="ruby-identifier">keys</span> = <span class="ruby-constant">Key</span>.<span class="ruby-identifier">joins</span>({<span class="ruby-identifier">user</span><span class="ruby-operator">:</span> <span class="ruby-value">:users_projects</span>}). + <span class="ruby-identifier">where</span>(<span class="ruby-string">"users_projects.project_id = ? AND users_projects.project_access = ?"</span>, <span class="ruby-identifier">id</span>, <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">DEVELOPER</span>) + <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:identifier</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- repository_writers-source --> + + </div> + + + + + </div><!-- repository_writers-method --> + + + <div id="method-i-reset_access" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reset_access</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reset_access-source"> + <pre><span class="ruby-comment"># File app/roles/authority.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reset_access</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">destroy</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- reset_access-source --> + + </div> + + + + + </div><!-- reset_access-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/BaseContext.html b/doc/app/BaseContext.html new file mode 100644 index 00000000000..b9c46738bf8 --- /dev/null +++ b/doc/app/BaseContext.html @@ -0,0 +1,605 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class BaseContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/base_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-abilities">#abilities</a> + + <li><a href="#method-i-can-3F">#can?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class BaseContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-current_user" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">current_user</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-params" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">params</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(project, user, params)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/contexts/base_context.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">params</span>) + <span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@current_user</span>, <span class="ruby-ivar">@params</span> = <span class="ruby-identifier">project</span>, <span class="ruby-identifier">user</span>, <span class="ruby-identifier">params</span>.<span class="ruby-identifier">dup</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-abilities" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">abilities</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="abilities-source"> + <pre><span class="ruby-comment"># File app/contexts/base_context.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">abilities</span> + <span class="ruby-ivar">@abilities</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span> + <span class="ruby-identifier">abilities</span> = <span class="ruby-constant">Six</span>.<span class="ruby-identifier">new</span> + <span class="ruby-identifier">abilities</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Ability</span> + <span class="ruby-identifier">abilities</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- abilities-source --> + + </div> + + + + + </div><!-- abilities-method --> + + + <div id="method-i-can-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can?</span><span + class="method-args">(object, action, subject)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can-3F-source"> + <pre><span class="ruby-comment"># File app/contexts/base_context.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-identifier">abilities</span>.<span class="ruby-identifier">allowed?</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- can-3F-source --> + + </div> + + + + + </div><!-- can-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/BlameController.html b/doc/app/BlameController.html new file mode 100644 index 00000000000..4b23b227c49 --- /dev/null +++ b/doc/app/BlameController.html @@ -0,0 +1,500 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class BlameController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/blame_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="ExtractsPath.html">ExtractsPath</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class BlameController</h1> + + <div id="description" class="description"> + +<p>Controller for viewing a file’s blame</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/blame_controller.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@repo</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">repo</span> + <span class="ruby-ivar">@blame</span> = <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Blob</span>.<span class="ruby-identifier">blame</span>(<span class="ruby-ivar">@repo</span>, <span class="ruby-ivar">@commit</span>.<span class="ruby-identifier">id</span>, <span class="ruby-ivar">@path</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/BlobController.html b/doc/app/BlobController.html new file mode 100644 index 00000000000..e8f069c2f4a --- /dev/null +++ b/doc/app/BlobController.html @@ -0,0 +1,519 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class BlobController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/blob_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="ExtractsPath.html">ExtractsPath</a> + + + + <li><a class="include" href="Gitlab/Encode.html">Gitlab::Encode</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class BlobController</h1> + + <div id="description" class="description"> + +<p>Controller for viewing a file’s blame</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/blob_controller.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">is_blob?</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">text?</span> + <span class="ruby-identifier">encoding</span> = <span class="ruby-identifier">detect_encoding</span>(<span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">data</span>) + <span class="ruby-identifier">mime_type</span> = <span class="ruby-identifier">encoding</span> <span class="ruby-operator">?</span> <span class="ruby-node">"text/plain; charset=#{encoding}"</span> <span class="ruby-operator">:</span> <span class="ruby-string">"text/plain"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">mime_type</span> = <span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">mime_type</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">send_data</span>( + <span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">data</span>, + <span class="ruby-identifier">type</span><span class="ruby-operator">:</span> <span class="ruby-identifier">mime_type</span>, + <span class="ruby-identifier">disposition</span><span class="ruby-operator">:</span> <span class="ruby-string">'inline'</span>, + <span class="ruby-identifier">filename</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">name</span> + ) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">not_found!</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Commit.html b/doc/app/Commit.html new file mode 100644 index 00000000000..05a3f3ceff8 --- /dev/null +++ b/doc/app/Commit.html @@ -0,0 +1,1191 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Commit - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/commit.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><span class="include">ActiveModel::Conversion</span> + + + + <li><a class="include" href="Gitlab/Encode.html">Gitlab::Encode</a> + + + + <li><a class="include" href="StaticModel.html">StaticModel</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-commits">::commits</a> + + <li><a href="#method-c-commits_between">::commits_between</a> + + <li><a href="#method-c-commits_since">::commits_since</a> + + <li><a href="#method-c-commits_with_refs">::commits_with_refs</a> + + <li><a href="#method-c-compare">::compare</a> + + <li><a href="#method-c-find_or_first">::find_or_first</a> + + <li><a href="#method-c-fresh_commits">::fresh_commits</a> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-author_email">#author_email</a> + + <li><a href="#method-i-author_name">#author_name</a> + + <li><a href="#method-i-committer_email">#committer_email</a> + + <li><a href="#method-i-committer_name">#committer_name</a> + + <li><a href="#method-i-created_at">#created_at</a> + + <li><a href="#method-i-different_committer-3F">#different_committer?</a> + + <li><a href="#method-i-parents_count">#parents_count</a> + + <li><a href="#method-i-prev_commit">#prev_commit</a> + + <li><a href="#method-i-prev_commit_id">#prev_commit_id</a> + + <li><a href="#method-i-safe_message">#safe_message</a> + + <li><a href="#method-i-short_id">#short_id</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Commit</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-commit" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">commit</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-head" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">head</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-refs" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">refs</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits</span><span + class="method-args">(repo, ref, path = nil, limit = nil, offset = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">limit</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">offset</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">max_count</span><span class="ruby-operator">:</span> <span class="ruby-identifier">limit</span>, <span class="ruby-identifier">skip</span><span class="ruby-operator">:</span> <span class="ruby-identifier">offset</span>) + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">limit</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">offset</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">limit</span>, <span class="ruby-identifier">offset</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-identifier">ref</span>) + <span class="ruby-keyword">end</span>.<span class="ruby-identifier">map</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>) } +<span class="ruby-keyword">end</span></pre> + </div><!-- commits-source --> + + </div> + + + + + </div><!-- commits-method --> + + + <div id="method-c-commits_between" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits_between</span><span + class="method-args">(repo, from, to)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits_between-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 68</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits_between</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">to</span>) + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">commits_between</span>(<span class="ruby-identifier">from</span>, <span class="ruby-identifier">to</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>) } +<span class="ruby-keyword">end</span></pre> + </div><!-- commits_between-source --> + + </div> + + + + + </div><!-- commits_between-method --> + + + <div id="method-c-commits_since" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits_since</span><span + class="method-args">(repo, date)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits_since-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 46</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits_since</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">date</span>) + <span class="ruby-identifier">commits</span> = <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">heads</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">h</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">log</span>(<span class="ruby-identifier">h</span>.<span class="ruby-identifier">name</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">since</span><span class="ruby-operator">:</span> <span class="ruby-identifier">date</span>).<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>, <span class="ruby-identifier">h</span>) } + <span class="ruby-keyword">end</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">uniq</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">id</span> } + + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">sort!</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span>, <span class="ruby-identifier">y</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">y</span>.<span class="ruby-identifier">committed_date</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">committed_date</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">commits</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- commits_since-source --> + + </div> + + + + + </div><!-- commits_since-method --> + + + <div id="method-c-commits_with_refs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits_with_refs</span><span + class="method-args">(repo, n = 20)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits_with_refs-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits_with_refs</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">n</span> = <span class="ruby-value">20</span>) + <span class="ruby-identifier">commits</span> = <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">branches</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">ref</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ref</span>.<span class="ruby-identifier">commit</span>, <span class="ruby-identifier">ref</span>) } + + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">sort!</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span>, <span class="ruby-identifier">y</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">y</span>.<span class="ruby-identifier">committed_date</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">committed_date</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">commits</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-identifier">n</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- commits_with_refs-source --> + + </div> + + + + + </div><!-- commits_with_refs-method --> + + + <div id="method-c-compare" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">compare</span><span + class="method-args">(project, from, to)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="compare-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 72</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">compare</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">to</span>) + <span class="ruby-identifier">result</span> = { + <span class="ruby-identifier">commits</span><span class="ruby-operator">:</span> [], + <span class="ruby-identifier">diffs</span><span class="ruby-operator">:</span> [], + <span class="ruby-identifier">commit</span><span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>, + <span class="ruby-identifier">same</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span> + } + + <span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">from</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">to</span> + + <span class="ruby-identifier">first</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">to</span>.<span class="ruby-identifier">try</span>(<span class="ruby-value">:strip</span>)) + <span class="ruby-identifier">last</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">from</span>.<span class="ruby-identifier">try</span>(<span class="ruby-value">:strip</span>)) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">first</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">last</span> + <span class="ruby-identifier">commits</span> = [<span class="ruby-identifier">first</span>, <span class="ruby-identifier">last</span>].<span class="ruby-identifier">sort_by</span>(&<span class="ruby-value">:created_at</span>) + <span class="ruby-identifier">younger</span> = <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">first</span> + <span class="ruby-identifier">older</span> = <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">last</span> + + <span class="ruby-identifier">result</span>[<span class="ruby-value">:same</span>] = (<span class="ruby-identifier">younger</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">older</span>.<span class="ruby-identifier">id</span>) + <span class="ruby-identifier">result</span>[<span class="ruby-value">:commits</span>] = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">commits_between</span>(<span class="ruby-identifier">younger</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">older</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>)} + <span class="ruby-identifier">result</span>[<span class="ruby-value">:diffs</span>] = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">diff</span>(<span class="ruby-identifier">younger</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">older</span>.<span class="ruby-identifier">id</span>) <span class="ruby-keyword">rescue</span> [] + <span class="ruby-identifier">result</span>[<span class="ruby-value">:commit</span>] = <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">older</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">result</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- compare-source --> + + </div> + + + + + </div><!-- compare-method --> + + + <div id="method-c-find_or_first" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">find_or_first</span><span + class="method-args">(repo, commit_id = nil, root_ref)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="find_or_first-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_or_first</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">commit_id</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">root_ref</span>) + <span class="ruby-identifier">commit</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">commit_id</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">commit_id</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-identifier">root_ref</span>).<span class="ruby-identifier">first</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">commit</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">commit</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- find_or_first-source --> + + </div> + + + + + </div><!-- find_or_first-method --> + + + <div id="method-c-fresh_commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">fresh_commits</span><span + class="method-args">(repo, n = 10)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="fresh_commits-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">fresh_commits</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">n</span> = <span class="ruby-value">10</span>) + <span class="ruby-identifier">commits</span> = <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">heads</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">h</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-identifier">h</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">n</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>, <span class="ruby-identifier">h</span>) } + <span class="ruby-keyword">end</span>.<span class="ruby-identifier">flatten</span>.<span class="ruby-identifier">uniq</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">id</span> } + + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">sort!</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">x</span>, <span class="ruby-identifier">y</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">y</span>.<span class="ruby-identifier">committed_date</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">x</span>.<span class="ruby-identifier">committed_date</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">commits</span>[<span class="ruby-value">0</span><span class="ruby-operator">...</span><span class="ruby-identifier">n</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- fresh_commits-source --> + + </div> + + + + + </div><!-- fresh_commits-method --> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(raw_commit, head = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 100</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">raw_commit</span>, <span class="ruby-identifier">head</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-ivar">@commit</span> = <span class="ruby-identifier">raw_commit</span> + <span class="ruby-ivar">@head</span> = <span class="ruby-identifier">head</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-author_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">author_email</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="author_email-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 117</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">author_email</span> + <span class="ruby-identifier">author</span>.<span class="ruby-identifier">email</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- author_email-source --> + + </div> + + + + + </div><!-- author_email-method --> + + + <div id="method-i-author_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">author_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="author_name-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 121</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">author_name</span> + <span class="ruby-identifier">utf8</span> <span class="ruby-identifier">author</span>.<span class="ruby-identifier">name</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- author_name-source --> + + </div> + + + + + </div><!-- author_name-method --> + + + <div id="method-i-committer_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">committer_email</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="committer_email-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 134</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">committer_email</span> + <span class="ruby-identifier">committer</span>.<span class="ruby-identifier">email</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- committer_email-source --> + + </div> + + + + + </div><!-- committer_email-method --> + + + <div id="method-i-committer_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">committer_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="committer_name-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 130</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">committer_name</span> + <span class="ruby-identifier">utf8</span> <span class="ruby-identifier">committer</span>.<span class="ruby-identifier">name</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- committer_name-source --> + + </div> + + + + + </div><!-- committer_name-method --> + + + <div id="method-i-created_at" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">created_at</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="created_at-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 113</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">created_at</span> + <span class="ruby-identifier">committed_date</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- created_at-source --> + + </div> + + + + + </div><!-- created_at-method --> + + + <div id="method-i-different_committer-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">different_committer?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Was this commit committed by a different person than the original author?</p> + + + + <div class="method-source-code" id="different_committer-3F-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 126</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">different_committer?</span> + <span class="ruby-identifier">author_name</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">committer_name</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">author_email</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">committer_email</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- different_committer-3F-source --> + + </div> + + + + + </div><!-- different_committer-3F-method --> + + + <div id="method-i-parents_count" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">parents_count</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="parents_count-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 146</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">parents_count</span> + <span class="ruby-identifier">parents</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">parents</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">||</span> <span class="ruby-value">0</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- parents_count-source --> + + </div> + + + + + </div><!-- parents_count-method --> + + + <div id="method-i-prev_commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">prev_commit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="prev_commit-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 138</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">prev_commit</span> + <span class="ruby-identifier">parents</span>.<span class="ruby-identifier">try</span> <span class="ruby-value">:first</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- prev_commit-source --> + + </div> + + + + + </div><!-- prev_commit-method --> + + + <div id="method-i-prev_commit_id" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">prev_commit_id</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="prev_commit_id-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 142</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">prev_commit_id</span> + <span class="ruby-identifier">prev_commit</span>.<span class="ruby-identifier">try</span> <span class="ruby-value">:id</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- prev_commit_id-source --> + + </div> + + + + + </div><!-- prev_commit_id-method --> + + + <div id="method-i-safe_message" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">safe_message</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="safe_message-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 109</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">safe_message</span> + <span class="ruby-ivar">@safe_message</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">utf8</span> <span class="ruby-identifier">message</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- safe_message-source --> + + </div> + + + + + </div><!-- safe_message-method --> + + + <div id="method-i-short_id" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">short_id</span><span + class="method-args">(length = 10)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="short_id-source"> + <pre><span class="ruby-comment"># File app/models/commit.rb, line 105</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">short_id</span>(<span class="ruby-identifier">length</span> = <span class="ruby-value">10</span>) + <span class="ruby-identifier">id</span>.<span class="ruby-identifier">to_s</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-identifier">length</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- short_id-source --> + + </div> + + + + + </div><!-- short_id-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/CommitController.html b/doc/app/CommitController.html new file mode 100644 index 00000000000..564161e90e3 --- /dev/null +++ b/doc/app/CommitController.html @@ -0,0 +1,509 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class CommitController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/commit_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class CommitController</h1> + + <div id="description" class="description"> + +<p>Controller for a specific <a href="Commit.html">Commit</a></p> + +<p>Not to be confused with <a +href="CommitsController.html">CommitsController</a>, plural.</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/commit_controller.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-identifier">result</span> = <span class="ruby-constant">CommitLoadContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> + + <span class="ruby-ivar">@commit</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:commit</span>] + <span class="ruby-identifier">git_not_found!</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@commit</span> + + <span class="ruby-ivar">@suppress_diff</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:suppress_diff</span>] + <span class="ruby-ivar">@note</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:note</span>] + <span class="ruby-ivar">@line_notes</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:line_notes</span>] + <span class="ruby-ivar">@notes_count</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:notes_count</span>] + <span class="ruby-ivar">@comments_allowed</span> = <span class="ruby-keyword">true</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>[<span class="ruby-value">:status</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:huge_commit</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"huge_commit"</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">return</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">patch</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/CommitDecorator.html b/doc/app/CommitDecorator.html new file mode 100644 index 00000000000..3cca57a4c16 --- /dev/null +++ b/doc/app/CommitDecorator.html @@ -0,0 +1,663 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class CommitDecorator - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/decorators/commit_decorator.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationDecorator.html">ApplicationDecorator</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-author_link">#author_link</a> + + <li><a href="#method-i-description">#description</a> + + <li><a href="#method-i-link_title">#link_title</a> + + <li><a href="#method-i-no_commit_message">#no_commit_message</a> + + <li><a href="#method-i-title">#title</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class CommitDecorator</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-author_link" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">author_link</span><span + class="method-args">(options)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns a link to the commit author. If the author has a matching user and +is a member of the current @project it will link to the team member page. +Otherwise it will link to the author email as specified in the commit.</p> + +<p>options:</p> + +<pre>avatar: true will prepend avatar image</pre> + + + + <div class="method-source-code" id="author_link-source"> + <pre><span class="ruby-comment"># File app/decorators/commit_decorator.rb, line 51</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">author_link</span>(<span class="ruby-identifier">options</span>) + <span class="ruby-identifier">text</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:avatar</span>] + <span class="ruby-identifier">avatar</span> = <span class="ruby-identifier">h</span>.<span class="ruby-identifier">image_tag</span> <span class="ruby-identifier">h</span>.<span class="ruby-identifier">gravatar_icon</span>(<span class="ruby-identifier">author_email</span>), <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">"avatar"</span>, <span class="ruby-identifier">width</span><span class="ruby-operator">:</span> <span class="ruby-value">16</span> + <span class="ruby-node">"#{avatar} #{author_name}"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">author_name</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">team_member</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">try</span>(<span class="ruby-value">:team_member_by_name_or_email</span>, <span class="ruby-identifier">author_name</span>, <span class="ruby-identifier">author_email</span>) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">team_member</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">mail_to</span> <span class="ruby-identifier">author_email</span>, <span class="ruby-identifier">text</span>.<span class="ruby-identifier">html_safe</span>, <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">"commit-author-link"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">link_to</span> <span class="ruby-identifier">text</span>, <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_team_member_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-identifier">team_member</span>), <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">"commit-author-link"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- author_link-source --> + + </div> + + + + + </div><!-- author_link-method --> + + + <div id="method-i-description" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">description</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns the commits description</p> + +<p>cut off, ellipses (`&hellp;`) are prepended to the commit message.</p> + + + + <div class="method-source-code" id="description-source"> + <pre><span class="ruby-comment"># File app/decorators/commit_decorator.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">description</span> + <span class="ruby-identifier">description</span> = <span class="ruby-identifier">safe_message</span> + + <span class="ruby-identifier">title_end</span> = <span class="ruby-identifier">description</span>.<span class="ruby-identifier">index</span>(<span class="ruby-regexp">%r\n/</span>) + <span class="ruby-keyword">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">title_end</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">description</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">80</span>) <span class="ruby-operator">||</span> (<span class="ruby-identifier">title_end</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">title_end</span> <span class="ruby-operator">></span> <span class="ruby-value">80</span>) + <span class="ruby-string">"&hellip;"</span>.<span class="ruby-identifier">html_safe</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">description</span>[<span class="ruby-value">70</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">description</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">%r\n/</span>, <span class="ruby-value">2</span>)[<span class="ruby-value">1</span>].<span class="ruby-identifier">try</span>(<span class="ruby-value">:chomp</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- description-source --> + + </div> + + + + + </div><!-- description-method --> + + + <div id="method-i-link_title" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_title</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns a string describing the commit for use in a link title</p> + +<p>Example</p> + +<pre>"Commit: Alex Denisov - Project git clone panel"</pre> + + + + <div class="method-source-code" id="link_title-source"> + <pre><span class="ruby-comment"># File app/decorators/commit_decorator.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_title</span> + <span class="ruby-node">"Commit: #{author_name} - #{title}"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- link_title-source --> + + </div> + + + + + </div><!-- link_title-method --> + + + <div id="method-i-title" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">title</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns the commits title.</p> + +<p>Usually, the commit title is the first line of the commit message. In case +this first line is longer than 80 characters, it is cut off after 70 +characters and ellipses (`&hellp;`) are appended.</p> + + + + <div class="method-source-code" id="title-source"> + <pre><span class="ruby-comment"># File app/decorators/commit_decorator.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">title</span> + <span class="ruby-identifier">title</span> = <span class="ruby-identifier">safe_message</span> + + <span class="ruby-keyword">return</span> <span class="ruby-identifier">no_commit_message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">title</span>.<span class="ruby-identifier">blank?</span> + + <span class="ruby-identifier">title_end</span> = <span class="ruby-identifier">title</span>.<span class="ruby-identifier">index</span>(<span class="ruby-regexp">%r\n/</span>) + <span class="ruby-keyword">if</span> (<span class="ruby-operator">!</span><span class="ruby-identifier">title_end</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">title</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">></span> <span class="ruby-value">80</span>) <span class="ruby-operator">||</span> (<span class="ruby-identifier">title_end</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">title_end</span> <span class="ruby-operator">></span> <span class="ruby-value">80</span>) + <span class="ruby-identifier">title</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">69</span>] <span class="ruby-operator"><<</span> <span class="ruby-string">"&hellip;"</span>.<span class="ruby-identifier">html_safe</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">title</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">%r\n/</span>, <span class="ruby-value">2</span>).<span class="ruby-identifier">first</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- title-source --> + + </div> + + + + + </div><!-- title-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-no_commit_message" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">no_commit_message</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="no_commit_message-source"> + <pre><span class="ruby-comment"># File app/decorators/commit_decorator.rb, line 69</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">no_commit_message</span> + <span class="ruby-string">"--no commit message"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- no_commit_message-source --> + + </div> + + + + + </div><!-- no_commit_message-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/CommitLoadContext.html b/doc/app/CommitLoadContext.html new file mode 100644 index 00000000000..feb6dbf4a42 --- /dev/null +++ b/doc/app/CommitLoadContext.html @@ -0,0 +1,513 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class CommitLoadContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/commit_load_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="BaseContext.html">BaseContext</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class CommitLoadContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/commit_load_context.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-identifier">result</span> = { + <span class="ruby-identifier">commit</span><span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>, + <span class="ruby-identifier">suppress_diff</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span>, + <span class="ruby-identifier">line_notes</span><span class="ruby-operator">:</span> [], + <span class="ruby-identifier">notes_count</span><span class="ruby-operator">:</span> <span class="ruby-value">0</span>, + <span class="ruby-identifier">note</span><span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>, + <span class="ruby-identifier">status</span><span class="ruby-operator">:</span> <span class="ruby-value">:ok</span> + } + + <span class="ruby-identifier">commit</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">commit</span> + <span class="ruby-identifier">commit</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-identifier">commit</span>) + <span class="ruby-identifier">line_notes</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit_line_notes</span>(<span class="ruby-identifier">commit</span>) + + <span class="ruby-identifier">result</span>[<span class="ruby-value">:commit</span>] = <span class="ruby-identifier">commit</span> + <span class="ruby-identifier">result</span>[<span class="ruby-value">:note</span>] = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">build_commit_note</span>(<span class="ruby-identifier">commit</span>) + <span class="ruby-identifier">result</span>[<span class="ruby-value">:line_notes</span>] = <span class="ruby-identifier">line_notes</span> + <span class="ruby-identifier">result</span>[<span class="ruby-value">:notes_count</span>] = <span class="ruby-identifier">line_notes</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit_notes</span>(<span class="ruby-identifier">commit</span>).<span class="ruby-identifier">count</span> + + <span class="ruby-keyword">begin</span> + <span class="ruby-identifier">result</span>[<span class="ruby-value">:suppress_diff</span>] = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">diffs</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">200</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">params</span>[<span class="ruby-value">:force_show_diff</span>] + <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">GitTimeout</span> + <span class="ruby-identifier">result</span>[<span class="ruby-value">:suppress_diff</span>] = <span class="ruby-keyword">true</span> + <span class="ruby-identifier">result</span>[<span class="ruby-value">:status</span>] = <span class="ruby-value">:huge_commit</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">result</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/CommitsController.html b/doc/app/CommitsController.html new file mode 100644 index 00000000000..52eaad041da --- /dev/null +++ b/doc/app/CommitsController.html @@ -0,0 +1,507 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class CommitsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/commits_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="ExtractsPath.html">ExtractsPath</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class CommitsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/commits_controller.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@repo</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">repo</span> + <span class="ruby-ivar">@limit</span>, <span class="ruby-ivar">@offset</span> = (<span class="ruby-identifier">params</span>[<span class="ruby-value">:limit</span>] <span class="ruby-operator">||</span> <span class="ruby-value">40</span>), (<span class="ruby-identifier">params</span>[<span class="ruby-value">:offset</span>] <span class="ruby-operator">||</span> <span class="ruby-value">0</span>) + + <span class="ruby-ivar">@commits</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-ivar">@ref</span>, <span class="ruby-ivar">@path</span>, <span class="ruby-ivar">@limit</span>, <span class="ruby-ivar">@offset</span>) + <span class="ruby-ivar">@commits</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@commits</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-comment"># index.html.erb</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">atom</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/CommitsHelper.html b/doc/app/CommitsHelper.html new file mode 100644 index 00000000000..58844bec1d3 --- /dev/null +++ b/doc/app/CommitsHelper.html @@ -0,0 +1,625 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module CommitsHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/commits_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-build_line_anchor">#build_line_anchor</a> + + <li><a href="#method-i-each_diff_line">#each_diff_line</a> + + <li><a href="#method-i-identification_type">#identification_type</a> + + <li><a href="#method-i-image_diff_class">#image_diff_class</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module CommitsHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-build_line_anchor" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">build_line_anchor</span><span + class="method-args">(index, line_new, line_old)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="build_line_anchor-source"> + <pre><span class="ruby-comment"># File app/helpers/commits_helper.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">build_line_anchor</span>(<span class="ruby-identifier">index</span>, <span class="ruby-identifier">line_new</span>, <span class="ruby-identifier">line_old</span>) + <span class="ruby-node">"#{index}_#{line_old}_#{line_new}"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- build_line_anchor-source --> + + </div> + + + + + </div><!-- build_line_anchor-method --> + + + <div id="method-i-each_diff_line" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">each_diff_line</span><span + class="method-args">(diff_arr, index) { |full_line, type, nil, nil, nil| ... }</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="each_diff_line-source"> + <pre><span class="ruby-comment"># File app/helpers/commits_helper.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">each_diff_line</span>(<span class="ruby-identifier">diff_arr</span>, <span class="ruby-identifier">index</span>) + <span class="ruby-identifier">line_old</span> = <span class="ruby-value">1</span> + <span class="ruby-identifier">line_new</span> = <span class="ruby-value">1</span> + <span class="ruby-identifier">type</span> = <span class="ruby-keyword">nil</span> + + <span class="ruby-identifier">lines_arr</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">InlineDiff</span>.<span class="ruby-identifier">processing</span> <span class="ruby-identifier">diff_arr</span> + <span class="ruby-identifier">lines_arr</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r^\-\-\- \/dev\/null/</span>) + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r^\+\+\+ \/dev\/null/</span>) + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r^\-\-\- a/</span>) + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r^\+\+\+ b/</span>) + + <span class="ruby-identifier">full_line</span> = <span class="ruby-identifier">html_escape</span>(<span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r\n/</span>, <span class="ruby-string">''</span>)) + <span class="ruby-identifier">full_line</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">InlineDiff</span>.<span class="ruby-identifier">replace_markers</span> <span class="ruby-identifier">full_line</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r^@@ -/</span>) + <span class="ruby-identifier">type</span> = <span class="ruby-string">"match"</span> + + <span class="ruby-identifier">line_old</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r\-[0-9]*/</span>)[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">abs</span> <span class="ruby-keyword">rescue</span> <span class="ruby-value">0</span> + <span class="ruby-identifier">line_new</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r\+[0-9]*/</span>)[<span class="ruby-value">0</span>].<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">abs</span> <span class="ruby-keyword">rescue</span> <span class="ruby-value">0</span> + + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">line_old</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">line_new</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> <span class="ruby-comment">#top of file</span> + <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">full_line</span>, <span class="ruby-identifier">type</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span>) + <span class="ruby-keyword">next</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">type</span> = <span class="ruby-identifier">identification_type</span>(<span class="ruby-identifier">line</span>) + <span class="ruby-identifier">line_code</span> = <span class="ruby-identifier">build_line_anchor</span>(<span class="ruby-identifier">index</span>, <span class="ruby-identifier">line_new</span>, <span class="ruby-identifier">line_old</span>) + <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">full_line</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">line_code</span>, <span class="ruby-identifier">line_new</span>, <span class="ruby-identifier">line_old</span>) + <span class="ruby-keyword">end</span> + + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"+"</span> + <span class="ruby-identifier">line_new</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">line</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span> + <span class="ruby-identifier">line_old</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">line_new</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> + <span class="ruby-identifier">line_old</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- each_diff_line-source --> + + </div> + + + + + </div><!-- each_diff_line-method --> + + + <div id="method-i-identification_type" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">identification_type</span><span + class="method-args">(line)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="identification_type-source"> + <pre><span class="ruby-comment"># File app/helpers/commits_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">identification_type</span>(<span class="ruby-identifier">line</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"+"</span> + <span class="ruby-string">"new"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">line</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"-"</span> + <span class="ruby-string">"old"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">nil</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- identification_type-source --> + + </div> + + + + + </div><!-- identification_type-method --> + + + <div id="method-i-image_diff_class" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">image_diff_class</span><span + class="method-args">(diff)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="image_diff_class-source"> + <pre><span class="ruby-comment"># File app/helpers/commits_helper.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">image_diff_class</span>(<span class="ruby-identifier">diff</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">diff</span>.<span class="ruby-identifier">deleted_file</span> + <span class="ruby-string">"diff_image_removed"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">diff</span>.<span class="ruby-identifier">new_file</span> + <span class="ruby-string">"diff_image_added"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">nil</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- image_diff_class-source --> + + </div> + + + + + </div><!-- image_diff_class-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/CompareController.html b/doc/app/CompareController.html new file mode 100644 index 00000000000..177e22d2520 --- /dev/null +++ b/doc/app/CompareController.html @@ -0,0 +1,556 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class CompareController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/compare_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class CompareController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/compare_controller.rb, line 22</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_compare_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-identifier">params</span>[<span class="ruby-value">:from</span>], <span class="ruby-identifier">params</span>[<span class="ruby-value">:to</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/compare_controller.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/compare_controller.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-identifier">result</span> = <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">compare</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">params</span>[<span class="ruby-value">:from</span>], <span class="ruby-identifier">params</span>[<span class="ruby-value">:to</span>]) + + <span class="ruby-ivar">@commits</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:commits</span>] + <span class="ruby-ivar">@commit</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:commit</span>] + <span class="ruby-ivar">@diffs</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:diffs</span>] + <span class="ruby-ivar">@refs_are_same</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:same</span>] + <span class="ruby-ivar">@line_notes</span> = [] + + <span class="ruby-ivar">@commits</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@commits</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/DashboardController.html b/doc/app/DashboardController.html new file mode 100644 index 00000000000..e3f4d1b49b2 --- /dev/null +++ b/doc/app/DashboardController.html @@ -0,0 +1,569 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class DashboardController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/dashboard_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-issues">#issues</a> + + <li><a href="#method-i-merge_requests">#merge_requests</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class DashboardController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/dashboard_controller.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@groups</span> = <span class="ruby-constant">Group</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">pluck</span>(<span class="ruby-value">:group_id</span>)) + <span class="ruby-ivar">@projects</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects_with_events</span> + <span class="ruby-ivar">@projects</span> = <span class="ruby-ivar">@projects</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">30</span>) + + <span class="ruby-ivar">@events</span> = <span class="ruby-constant">Event</span>.<span class="ruby-identifier">in_projects</span>(<span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">project_ids</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">20</span>).<span class="ruby-identifier">offset</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:offset</span>] <span class="ruby-operator">||</span> <span class="ruby-value">0</span>) + <span class="ruby-ivar">@last_push</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">recent_push</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">atom</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-issues" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issues</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Get only assigned issues</p> + + + + <div class="method-source-code" id="issues-source"> + <pre><span class="ruby-comment"># File app/controllers/dashboard_controller.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issues</span> + <span class="ruby-ivar">@projects</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">all</span> + <span class="ruby-ivar">@user</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">assigned_issues</span>.<span class="ruby-identifier">opened</span>.<span class="ruby-identifier">recent</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">includes</span>(<span class="ruby-value">:author</span>, <span class="ruby-value">:project</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">atom</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- issues-source --> + + </div> + + + + + </div><!-- issues-method --> + + + <div id="method-i-merge_requests" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge_requests</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Get authored or assigned open merge requests</p> + + + + <div class="method-source-code" id="merge_requests-source"> + <pre><span class="ruby-comment"># File app/controllers/dashboard_controller.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_requests</span> + <span class="ruby-ivar">@projects</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">all</span> + <span class="ruby-ivar">@merge_requests</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">cared_merge_requests</span>.<span class="ruby-identifier">recent</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- merge_requests-source --> + + </div> + + + + + </div><!-- merge_requests-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/DeployKeysController.html b/doc/app/DeployKeysController.html new file mode 100644 index 00000000000..318a1441a67 --- /dev/null +++ b/doc/app/DeployKeysController.html @@ -0,0 +1,626 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class DeployKeysController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/deploy_keys_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class DeployKeysController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/deploy_keys_controller.rb, line 21</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">deploy_keys</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:key</span>]) + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@key</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_deploy_keys_path</span>(<span class="ruby-ivar">@project</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"new"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/deploy_keys_controller.rb, line 30</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">deploy_keys</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@key</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_deploy_keys_url</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/deploy_keys_controller.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@keys</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">deploy_keys</span>.<span class="ruby-identifier">all</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/deploy_keys_controller.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">deploy_keys</span>.<span class="ruby-identifier">new</span> + + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@key</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/deploy_keys_controller.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">deploy_keys</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ErrorsController.html b/doc/app/ErrorsController.html new file mode 100644 index 00000000000..e77a67d7880 --- /dev/null +++ b/doc/app/ErrorsController.html @@ -0,0 +1,485 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ErrorsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/errors_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-githost">#githost</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ErrorsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-githost" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">githost</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="githost-source"> + <pre><span class="ruby-comment"># File app/controllers/errors_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">githost</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"errors/gitolite"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- githost-source --> + + </div> + + + + + </div><!-- githost-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Event.html b/doc/app/Event.html new file mode 100644 index 00000000000..1347cda316d --- /dev/null +++ b/doc/app/Event.html @@ -0,0 +1,1222 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Event - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/event.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="PushEvent.html">PushEvent</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-determine_action">::determine_action</a> + + <li><a href="#method-i-action_name">#action_name</a> + + <li><a href="#method-i-allowed-3F">#allowed?</a> + + <li><a href="#method-i-author">#author</a> + + <li><a href="#method-i-changed_issue-3F">#changed_issue?</a> + + <li><a href="#method-i-changed_merge_request-3F">#changed_merge_request?</a> + + <li><a href="#method-i-closed-3F">#closed?</a> + + <li><a href="#method-i-issue">#issue</a> + + <li><a href="#method-i-issue-3F">#issue?</a> + + <li><a href="#method-i-joined-3F">#joined?</a> + + <li><a href="#method-i-left-3F">#left?</a> + + <li><a href="#method-i-membership_changed-3F">#membership_changed?</a> + + <li><a href="#method-i-merge_request">#merge_request</a> + + <li><a href="#method-i-merge_request-3F">#merge_request?</a> + + <li><a href="#method-i-merged-3F">#merged?</a> + + <li><a href="#method-i-new_issue-3F">#new_issue?</a> + + <li><a href="#method-i-new_merge_request-3F">#new_merge_request?</a> + + <li><a href="#method-i-project_name">#project_name</a> + + <li><a href="#method-i-push-3F">#push?</a> + + <li><a href="#method-i-reopened-3F">#reopened?</a> + + <li><a href="#method-i-target_title">#target_title</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Event</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="Closed">Closed + + <dd class="description"> + + + <dt id="Commented">Commented + + <dd class="description"> + + + <dt id="Created">Created + + <dd class="description"> + + + <dt id="Joined">Joined + + <dd class="description"> + + + <dt id="Left">Left + + <dd class="description"> + + + <dt id="Merged">Merged + + <dd class="description"> + + + <dt id="Pushed">Pushed + + <dd class="description"> + + + <dt id="Reopened">Reopened + + <dd class="description"> + + + <dt id="Updated">Updated + + <dd class="description"> + + + </dl> + </section> + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-determine_action" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">determine_action</span><span + class="method-args">(record)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="determine_action-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">determine_action</span>(<span class="ruby-identifier">record</span>) + <span class="ruby-keyword">if</span> [<span class="ruby-constant">Issue</span>, <span class="ruby-constant">MergeRequest</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">class</span> + <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Created</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">record</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Note</span> + <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Commented</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- determine_action-source --> + + </div> + + + + + </div><!-- determine_action-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-action_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">action_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="action_name-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 133</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">action_name</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">closed?</span> + <span class="ruby-string">"closed"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">merged?</span> + <span class="ruby-string">"merged"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">joined?</span> + <span class="ruby-string">'joined'</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">left?</span> + <span class="ruby-string">'left'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-string">"opened"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- action_name-source --> + + </div> + + + + + </div><!-- action_name-method --> + + + <div id="method-i-allowed-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">allowed?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Next events currently enabled for system</p> + +<pre>- push +- new issue +- merge request</pre> + + + + <div class="method-source-code" id="allowed-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">allowed?</span> + <span class="ruby-identifier">push?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">issue?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">merge_request?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">membership_changed?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- allowed-3F-source --> + + </div> + + + + + </div><!-- allowed-3F-method --> + + + <div id="method-i-author" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">author</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="author-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 129</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">author</span> + <span class="ruby-ivar">@author</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">author_id</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- author-source --> + + </div> + + + + + </div><!-- author-method --> + + + <div id="method-i-changed_issue-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">changed_issue?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="changed_issue-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 104</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">changed_issue?</span> + <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"Issue"</span> <span class="ruby-operator">&&</span> + [<span class="ruby-constant">Closed</span>, <span class="ruby-constant">Reopened</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">action</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- changed_issue-3F-source --> + + </div> + + + + + </div><!-- changed_issue-3F-method --> + + + <div id="method-i-changed_merge_request-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">changed_merge_request?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="changed_merge_request-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 99</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">changed_merge_request?</span> + <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"MergeRequest"</span> <span class="ruby-operator">&&</span> + [<span class="ruby-constant">Closed</span>, <span class="ruby-constant">Reopened</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">action</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- changed_merge_request-3F-source --> + + </div> + + + + + </div><!-- changed_merge_request-3F-method --> + + + <div id="method-i-closed-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">closed?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="closed-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 73</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">closed?</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">Closed</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- closed-3F-source --> + + </div> + + + + + </div><!-- closed-3F-method --> + + + <div id="method-i-issue" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issue</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issue-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 121</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issue</span> + <span class="ruby-identifier">target</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"Issue"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- issue-source --> + + </div> + + + + + </div><!-- issue-method --> + + + <div id="method-i-issue-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issue?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issue-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 81</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issue?</span> + <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"Issue"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- issue-3F-source --> + + </div> + + + + + </div><!-- issue-3F-method --> + + + <div id="method-i-joined-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">joined?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="joined-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 109</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">joined?</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Joined</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- joined-3F-source --> + + </div> + + + + + </div><!-- joined-3F-method --> + + + <div id="method-i-left-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">left?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="left-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 113</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">left?</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Left</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- left-3F-source --> + + </div> + + + + + </div><!-- left-3F-method --> + + + <div id="method-i-membership_changed-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">membership_changed?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="membership_changed-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 117</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">membership_changed?</span> + <span class="ruby-identifier">joined?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">left?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- membership_changed-3F-source --> + + </div> + + + + + </div><!-- membership_changed-3F-method --> + + + <div id="method-i-merge_request" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge_request</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="merge_request-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 125</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_request</span> + <span class="ruby-identifier">target</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"MergeRequest"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- merge_request-source --> + + </div> + + + + + </div><!-- merge_request-method --> + + + <div id="method-i-merge_request-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge_request?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="merge_request-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_request?</span> + <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"MergeRequest"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- merge_request-3F-source --> + + </div> + + + + + </div><!-- merge_request-3F-method --> + + + <div id="method-i-merged-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merged?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="merged-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 69</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merged?</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">Merged</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- merged-3F-source --> + + </div> + + + + + </div><!-- merged-3F-method --> + + + <div id="method-i-new_issue-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_issue?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new_issue-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 89</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_issue?</span> + <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"Issue"</span> <span class="ruby-operator">&&</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Created</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new_issue-3F-source --> + + </div> + + + + + </div><!-- new_issue-3F-method --> + + + <div id="method-i-new_merge_request-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_merge_request?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new_merge_request-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 94</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_merge_request?</span> + <span class="ruby-identifier">target_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"MergeRequest"</span> <span class="ruby-operator">&&</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Created</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new_merge_request-3F-source --> + + </div> + + + + + </div><!-- new_merge_request-3F-method --> + + + <div id="method-i-project_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_name-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_name</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">name</span> + <span class="ruby-keyword">else</span> + <span class="ruby-string">"(deleted project)"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project_name-source --> + + </div> + + + + + </div><!-- project_name-method --> + + + <div id="method-i-push-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">push?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="push-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">push?</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">Pushed</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">valid_push?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- push-3F-source --> + + </div> + + + + + </div><!-- push-3F-method --> + + + <div id="method-i-reopened-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reopened?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reopened-3F-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reopened?</span> + <span class="ruby-identifier">action</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">Reopened</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- reopened-3F-source --> + + </div> + + + + + </div><!-- reopened-3F-method --> + + + <div id="method-i-target_title" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">target_title</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="target_title-source"> + <pre><span class="ruby-comment"># File app/models/event.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">target_title</span> + <span class="ruby-identifier">target</span>.<span class="ruby-identifier">try</span> <span class="ruby-value">:title</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- target_title-source --> + + </div> + + + + + </div><!-- target_title-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/EventDecorator.html b/doc/app/EventDecorator.html new file mode 100644 index 00000000000..dddb98a6147 --- /dev/null +++ b/doc/app/EventDecorator.html @@ -0,0 +1,578 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class EventDecorator - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/decorators/event_decorator.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationDecorator.html">ApplicationDecorator</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-feed_summary">#feed_summary</a> + + <li><a href="#method-i-feed_title">#feed_title</a> + + <li><a href="#method-i-feed_url">#feed_url</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class EventDecorator</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-feed_summary" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">feed_summary</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="feed_summary-source"> + <pre><span class="ruby-comment"># File app/decorators/event_decorator.rb, line 37</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">feed_summary</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issue?</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">render</span> <span class="ruby-string">"events/event_issue"</span>, <span class="ruby-identifier">issue</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issue</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">push?</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">render</span> <span class="ruby-string">"events/event_push"</span>, <span class="ruby-identifier">event</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- feed_summary-source --> + + </div> + + + + + </div><!-- feed_summary-method --> + + + <div id="method-i-feed_title" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">feed_title</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="feed_title-source"> + <pre><span class="ruby-comment"># File app/decorators/event_decorator.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">feed_title</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issue?</span> + <span class="ruby-node">"#{self.author_name} #{self.action_name} issue ##{self.target_id}: #{self.issue_title} at #{self.project.name}"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merge_request?</span> + <span class="ruby-node">"#{self.author_name} #{self.action_name} MR ##{self.target_id}: #{self.merge_request_title} at #{self.project.name}"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">push?</span> + <span class="ruby-node">"#{self.author_name} #{self.push_action_name} #{self.ref_type} #{self.ref_name} at #{self.project.name}"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">membership_changed?</span> + <span class="ruby-node">"#{self.author_name} #{self.action_name} #{self.project.name}"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-string">""</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- feed_title-source --> + + </div> + + + + + </div><!-- feed_title-method --> + + + <div id="method-i-feed_url" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">feed_url</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="feed_url-source"> + <pre><span class="ruby-comment"># File app/decorators/event_decorator.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">feed_url</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issue?</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_issue_url</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issue</span>) + <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merge_request?</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_merge_request_url</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merge_request</span>) + + <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">push?</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">push_with_commits?</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">commits_count</span> <span class="ruby-operator">></span> <span class="ruby-value">1</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_compare_url</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>, <span class="ruby-value">:from</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">parent_commit</span>.<span class="ruby-identifier">id</span>, <span class="ruby-value">:to</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">last_commit</span>.<span class="ruby-identifier">id</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_commit_url</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>, <span class="ruby-value">:id</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">last_commit</span>.<span class="ruby-identifier">id</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_commits_url</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">ref_name</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- feed_url-source --> + + </div> + + + + + </div><!-- feed_url-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/EventsHelper.html b/doc/app/EventsHelper.html new file mode 100644 index 00000000000..4f7c0454901 --- /dev/null +++ b/doc/app/EventsHelper.html @@ -0,0 +1,566 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module EventsHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/events_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-event_action_name">#event_action_name</a> + + <li><a href="#method-i-event_image">#event_image</a> + + <li><a href="#method-i-link_to_author">#link_to_author</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module EventsHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-event_action_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">event_action_name</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="event_action_name-source"> + <pre><span class="ruby-comment"># File app/helpers/events_helper.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">event_action_name</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">target</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">target_type</span> + <span class="ruby-identifier">event</span>.<span class="ruby-identifier">target_type</span>.<span class="ruby-identifier">titleize</span>.<span class="ruby-identifier">downcase</span> + <span class="ruby-keyword">else</span> + <span class="ruby-string">'project'</span> + <span class="ruby-keyword">end</span> + + [<span class="ruby-identifier">event</span>.<span class="ruby-identifier">action_name</span>, <span class="ruby-identifier">target</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- event_action_name-source --> + + </div> + + + + + </div><!-- event_action_name-method --> + + + <div id="method-i-event_image" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">event_image</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="event_image-source"> + <pre><span class="ruby-comment"># File app/helpers/events_helper.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">event_image</span> <span class="ruby-identifier">event</span> + <span class="ruby-identifier">event_image_path</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">push?</span> + <span class="ruby-string">"event_push.png"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">merged?</span> + <span class="ruby-string">"event_mr_merged.png"</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">event_image_path</span> + + <span class="ruby-identifier">content_tag</span> <span class="ruby-value">:div</span>, <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">'event_icon'</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">image_tag</span> <span class="ruby-identifier">event_image_path</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- event_image-source --> + + </div> + + + + + </div><!-- event_image-method --> + + + <div id="method-i-link_to_author" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_author</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="link_to_author-source"> + <pre><span class="ruby-comment"># File app/helpers/events_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_author</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">project</span> = <span class="ruby-identifier">event</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">tm</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">team_member_by_id</span>(<span class="ruby-identifier">event</span>.<span class="ruby-identifier">author_id</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">tm</span> + <span class="ruby-identifier">link_to</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">author_name</span>, <span class="ruby-identifier">project_team_member_path</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">tm</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">event</span>.<span class="ruby-identifier">author_name</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_author-source --> + + </div> + + + + + </div><!-- link_to_author-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ExtractsPath.html b/doc/app/ExtractsPath.html new file mode 100644 index 00000000000..e382530745c --- /dev/null +++ b/doc/app/ExtractsPath.html @@ -0,0 +1,614 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module ExtractsPath - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/extracts_path.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-assign_ref_vars">#assign_ref_vars</a> + + <li><a href="#method-i-extract_ref">#extract_ref</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module ExtractsPath</h1> + + <div id="description" class="description"> + +<p>Module providing methods for dealing with separating a tree-ish string and +a file path string when combined in a request parameter</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-assign_ref_vars" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">assign_ref_vars</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Assigns common instance variables for views working with Git tree-ish +objects</p> + +<p>Assignments are:</p> +<ul><li> +<p>@id - A string representing the joined ref and path</p> +</li><li> +<p>@ref - A string representing the ref (e.g., the branch, tag, or commit +SHA)</p> +</li><li> +<p>@path - A string representing the filesystem path</p> +</li><li> +<p>@commit - A <a href="CommitDecorator.html">CommitDecorator</a> representing +the commit from the given ref</p> +</li><li> +<p>@tree - A <a href="TreeDecorator.html">TreeDecorator</a> representing the +tree at the given ref/path</p> +</li></ul> + +<p>If the :id parameter appears to be requesting a specific response format, +that will be handled as well.</p> + +<p>Automatically renders `not_found!` if a valid tree path could not be +resolved (e.g., when a user inserts an invalid path or ref).</p> + + + + <div class="method-source-code" id="assign_ref_vars-source"> + <pre><span class="ruby-comment"># File lib/extracts_path.rb, line 94</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">assign_ref_vars</span> + <span class="ruby-comment"># Handle formats embedded in the id</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">ends_with?</span>(<span class="ruby-string">'.atom'</span>) + <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>].<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r\.atom$/</span>, <span class="ruby-string">''</span>) + <span class="ruby-identifier">request</span>.<span class="ruby-identifier">format</span> = <span class="ruby-value">:atom</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@ref</span>, <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">extract_ref</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + + <span class="ruby-ivar">@id</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@ref</span>, <span class="ruby-ivar">@path</span>) + + <span class="ruby-ivar">@commit</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-ivar">@ref</span>)) + + <span class="ruby-ivar">@tree</span> = <span class="ruby-constant">Tree</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@commit</span>.<span class="ruby-identifier">tree</span>, <span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>, <span class="ruby-ivar">@path</span>) + <span class="ruby-ivar">@tree</span> = <span class="ruby-constant">TreeDecorator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@tree</span>) + + <span class="ruby-identifier">raise</span> <span class="ruby-constant">InvalidPathError</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">invalid?</span> +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">NoMethodError</span>, <span class="ruby-constant">InvalidPathError</span> + <span class="ruby-identifier">not_found!</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- assign_ref_vars-source --> + + </div> + + + + + </div><!-- assign_ref_vars-method --> + + + <div id="method-i-extract_ref" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">extract_ref</span><span + class="method-args">(input)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Given a string containing both a Git tree-ish, such as a branch or tag, and +a filesystem path joined by forward slashes, attempts to separate the two.</p> + +<p>Expects a @project instance variable to contain the active project. This is +used to check the input against a list of valid repository refs.</p> + +<p>Examples</p> + +<pre class="ruby"><span class="ruby-comment"># No @project available</span> +<span class="ruby-identifier">extract_ref</span>(<span class="ruby-string">'master'</span>) +<span class="ruby-comment"># => ['', '']</span> + +<span class="ruby-identifier">extract_ref</span>(<span class="ruby-string">'master'</span>) +<span class="ruby-comment"># => ['master', '']</span> + +<span class="ruby-identifier">extract_ref</span>(<span class="ruby-string">"f4b14494ef6abf3d144c28e4af0c20143383e062/CHANGELOG"</span>) +<span class="ruby-comment"># => ['f4b14494ef6abf3d144c28e4af0c20143383e062', 'CHANGELOG']</span> + +<span class="ruby-identifier">extract_ref</span>(<span class="ruby-string">"v2.0.0/README.md"</span>) +<span class="ruby-comment"># => ['v2.0.0', 'README.md']</span> + +<span class="ruby-identifier">extract_ref</span>(<span class="ruby-string">'issues/1234/app/models/project.rb'</span>) +<span class="ruby-comment"># => ['issues/1234', 'app/models/project.rb']</span> + +<span class="ruby-comment"># Given an invalid branch, we fall back to just splitting on the first slash</span> +<span class="ruby-identifier">extract_ref</span>(<span class="ruby-string">'non/existent/branch/README.md'</span>) +<span class="ruby-comment"># => ['non', 'existent/branch/README.md']</span> +</pre> + +<p>Returns an Array where the first value is the tree-ish and the second is +the path</p> + + + + <div class="method-source-code" id="extract_ref-source"> + <pre><span class="ruby-comment"># File lib/extracts_path.rb, line 45</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">extract_ref</span>(<span class="ruby-identifier">input</span>) + <span class="ruby-identifier">pair</span> = [<span class="ruby-string">''</span>, <span class="ruby-string">''</span>] + + <span class="ruby-keyword">return</span> <span class="ruby-identifier">pair</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">input</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r^([[:alnum:]]{40})(.+)/</span>) + <span class="ruby-comment"># If the ref appears to be a SHA, we're done, just split the string</span> + <span class="ruby-identifier">pair</span> = <span class="ruby-identifier">$~</span>.<span class="ruby-identifier">captures</span> + <span class="ruby-keyword">else</span> + <span class="ruby-comment"># Otherwise, attempt to detect the ref using a list of the project's</span> + <span class="ruby-comment"># branches and tags</span> + + <span class="ruby-comment"># Append a trailing slash if we only get a ref and no file path</span> + <span class="ruby-identifier">id</span> = <span class="ruby-identifier">input</span> + <span class="ruby-identifier">id</span> <span class="ruby-operator">+=</span> <span class="ruby-string">'/'</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">id</span>.<span class="ruby-identifier">ends_with?</span>(<span class="ruby-string">'/'</span>) + + <span class="ruby-identifier">valid_refs</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">ref_names</span> + <span class="ruby-identifier">valid_refs</span>.<span class="ruby-identifier">select!</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">id</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-node">"#{v}/"</span>) } + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">valid_refs</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">!=</span> <span class="ruby-value">1</span> + <span class="ruby-comment"># No exact ref match, so just try our best</span> + <span class="ruby-identifier">pair</span> = <span class="ruby-identifier">id</span>.<span class="ruby-identifier">match</span>(<span class="ruby-regexp">%r([^\/]+)(.*)/</span>).<span class="ruby-identifier">captures</span> + <span class="ruby-keyword">else</span> + <span class="ruby-comment"># Partition the string into the ref and the path, ignoring the empty first value</span> + <span class="ruby-identifier">pair</span> = <span class="ruby-identifier">id</span>.<span class="ruby-identifier">partition</span>(<span class="ruby-identifier">valid_refs</span>.<span class="ruby-identifier">first</span>)[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># Remove ending slashes from path</span> + <span class="ruby-identifier">pair</span>[<span class="ruby-value">1</span>].<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r^\/|\/$/</span>, <span class="ruby-string">''</span>) + + <span class="ruby-identifier">pair</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- extract_ref-source --> + + </div> + + + + + </div><!-- extract_ref-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ExtractsPath/InvalidPathError.html b/doc/app/ExtractsPath/InvalidPathError.html new file mode 100644 index 00000000000..3c8c60fc91e --- /dev/null +++ b/doc/app/ExtractsPath/InvalidPathError.html @@ -0,0 +1,441 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ExtractsPath::InvalidPathError - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/extracts_path.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">StandardError + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ExtractsPath::InvalidPathError</h1> + + <div id="description" class="description"> + +<p>Raised when given an invalid file path</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/FileSizeValidator.html b/doc/app/FileSizeValidator.html new file mode 100644 index 00000000000..5acdf291b09 --- /dev/null +++ b/doc/app/FileSizeValidator.html @@ -0,0 +1,652 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class FileSizeValidator - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/file_size_validator.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveModel::EachValidator + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-check_validity-21">#check_validity!</a> + + <li><a href="#method-i-help">#help</a> + + <li><a href="#method-i-validate_each">#validate_each</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class FileSizeValidator</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="CHECKS">CHECKS + + <dd class="description"> + + + <dt id="DEFAULT_TOKENIZER">DEFAULT_TOKENIZER + + <dd class="description"> + + + <dt id="MESSAGES">MESSAGES + + <dd class="description"> + + + <dt id="RESERVED_OPTIONS">RESERVED_OPTIONS + + <dd class="description"> + + + </dl> + </section> + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(options)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/file_size_validator.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">range</span> = (<span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:in</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:within</span>)) + <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">":in and :within must be a Range"</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">range</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Range</span>) + <span class="ruby-identifier">options</span>[<span class="ruby-value">:minimum</span>], <span class="ruby-identifier">options</span>[<span class="ruby-value">:maximum</span>] = <span class="ruby-identifier">range</span>.<span class="ruby-identifier">begin</span>, <span class="ruby-identifier">range</span>.<span class="ruby-identifier">end</span> + <span class="ruby-identifier">options</span>[<span class="ruby-value">:maximum</span>] <span class="ruby-operator">-=</span> <span class="ruby-value">1</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">range</span>.<span class="ruby-identifier">exclude_end?</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">super</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-check_validity-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">check_validity!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="check_validity-21-source"> + <pre><span class="ruby-comment"># File lib/file_size_validator.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">check_validity!</span> + <span class="ruby-identifier">keys</span> = <span class="ruby-constant">CHECKS</span>.<span class="ruby-identifier">keys</span> & <span class="ruby-identifier">options</span>.<span class="ruby-identifier">keys</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">value</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">key</span>] + + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Integer</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">>=</span> <span class="ruby-value">0</span> + <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-node">":#{key} must be a nonnegative Integer"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- check_validity-21-source --> + + </div> + + + + + </div><!-- check_validity-21-method --> + + + <div id="method-i-help" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">help</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="help-source"> + <pre><span class="ruby-comment"># File lib/file_size_validator.rb, line 57</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">help</span> + <span class="ruby-constant">Helper</span>.<span class="ruby-identifier">instance</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- help-source --> + + </div> + + + + + </div><!-- help-method --> + + + <div id="method-i-validate_each" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">validate_each</span><span + class="method-args">(record, attribute, value)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="validate_each-source"> + <pre><span class="ruby-comment"># File lib/file_size_validator.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_each</span>(<span class="ruby-identifier">record</span>, <span class="ruby-identifier">attribute</span>, <span class="ruby-identifier">value</span>) + <span class="ruby-identifier">raise</span>(<span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">"A CarrierWave::Uploader::Base object was expected"</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">CarrierWave</span><span class="ruby-operator">::</span><span class="ruby-constant">Uploader</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span> + + <span class="ruby-identifier">value</span> = (<span class="ruby-identifier">options</span>[<span class="ruby-value">:tokenizer</span>] <span class="ruby-operator">||</span> <span class="ruby-constant">DEFAULT_TOKENIZER</span>).<span class="ruby-identifier">call</span>(<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>) + + <span class="ruby-constant">CHECKS</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">validity_check</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">check_value</span> = <span class="ruby-identifier">options</span>[<span class="ruby-identifier">key</span>] + + <span class="ruby-identifier">value</span> <span class="ruby-operator">||=</span> [] <span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span> <span class="ruby-operator">==</span> <span class="ruby-value">:maximum</span> + + <span class="ruby-identifier">value_size</span> = <span class="ruby-identifier">value</span>.<span class="ruby-identifier">size</span> + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value_size</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">validity_check</span>, <span class="ruby-identifier">check_value</span>) + + <span class="ruby-identifier">errors_options</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">except</span>(*<span class="ruby-constant">RESERVED_OPTIONS</span>) + <span class="ruby-identifier">errors_options</span>[<span class="ruby-value">:file_size</span>] = <span class="ruby-identifier">help</span>.<span class="ruby-identifier">number_to_human_size</span> <span class="ruby-identifier">check_value</span> + + <span class="ruby-identifier">default_message</span> = <span class="ruby-identifier">options</span>[<span class="ruby-constant">MESSAGES</span>[<span class="ruby-identifier">key</span>]] + <span class="ruby-identifier">errors_options</span>[<span class="ruby-value">:message</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">default_message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">default_message</span> + + <span class="ruby-identifier">record</span>.<span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span>(<span class="ruby-identifier">attribute</span>, <span class="ruby-constant">MESSAGES</span>[<span class="ruby-identifier">key</span>], <span class="ruby-identifier">errors_options</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- validate_each-source --> + + </div> + + + + + </div><!-- validate_each-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/FileSizeValidator/Helper.html b/doc/app/FileSizeValidator/Helper.html new file mode 100644 index 00000000000..4fd146c2887 --- /dev/null +++ b/doc/app/FileSizeValidator/Helper.html @@ -0,0 +1,455 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class FileSizeValidator::Helper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/file_size_validator.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><span class="include">Singleton</span> + + + + <li><span class="include">ActionView::Helpers::NumberHelper</span> + + + </ul> +</nav> + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class FileSizeValidator::Helper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/GitHost.html b/doc/app/GitHost.html new file mode 100644 index 00000000000..3197a73f3e5 --- /dev/null +++ b/doc/app/GitHost.html @@ -0,0 +1,479 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module GitHost - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/git_host.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-git_host">#git_host</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module GitHost</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-git_host" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">git_host</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="git_host-source"> + <pre><span class="ruby-comment"># File app/roles/git_host.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">git_host</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Gitolite</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- git_host-source --> + + </div> + + + + + </div><!-- git_host-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab.html b/doc/app/Gitlab.html new file mode 100644 index 00000000000..0e28a24bc3f --- /dev/null +++ b/doc/app/Gitlab.html @@ -0,0 +1,454 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Gitlab - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api.rb + <li>lib/gitlab/encode.rb + <li>lib/gitlab/graph_commit.rb + <li>lib/gitlab/theme.rb + <li>lib/gitlab/app_logger.rb + <li>lib/gitlab/inline_diff.rb + <li>lib/gitlab/merge.rb + <li>lib/gitlab/backend/gitolite.rb + <li>lib/gitlab/backend/gitolite_config.rb + <li>lib/gitlab/git_logger.rb + <li>lib/gitlab/markdown.rb + <li>lib/gitlab/file_editor.rb + <li>lib/gitlab/logger.rb + <li>lib/gitlab/satellite.rb + <li>lib/gitlab/auth.rb + <li>lib/api/issues.rb + <li>lib/api/projects.rb + <li>lib/api/helpers.rb + <li>lib/api/entities.rb + <li>lib/api/session.rb + <li>lib/api/users.rb + <li>lib/api/milestones.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Gitlab</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/API.html b/doc/app/Gitlab/API.html new file mode 100644 index 00000000000..8fad1eecafc --- /dev/null +++ b/doc/app/Gitlab/API.html @@ -0,0 +1,452 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::API - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::API + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::API</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="VERSION">VERSION + + <dd class="description"> + + + </dl> + </section> + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/APIHelpers.html b/doc/app/Gitlab/APIHelpers.html new file mode 100644 index 00000000000..47bf3fb193d --- /dev/null +++ b/doc/app/Gitlab/APIHelpers.html @@ -0,0 +1,846 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Gitlab::APIHelpers - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/helpers.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-attributes_for_keys">#attributes_for_keys</a> + + <li><a href="#method-i-authenticate-21">#authenticate!</a> + + <li><a href="#method-i-authenticated_as_admin-21">#authenticated_as_admin!</a> + + <li><a href="#method-i-authorize-21">#authorize!</a> + + <li><a href="#method-i-current_user">#current_user</a> + + <li><a href="#method-i-forbidden-21">#forbidden!</a> + + <li><a href="#method-i-not_allowed-21">#not_allowed!</a> + + <li><a href="#method-i-not_found-21">#not_found!</a> + + <li><a href="#method-i-paginate">#paginate</a> + + <li><a href="#method-i-render_api_error-21">#render_api_error!</a> + + <li><a href="#method-i-unauthorized-21">#unauthorized!</a> + + <li><a href="#method-i-user_project">#user_project</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Gitlab::APIHelpers</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-attributes_for_keys" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">attributes_for_keys</span><span + class="method-args">(keys)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="attributes_for_keys-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">attributes_for_keys</span>(<span class="ruby-identifier">keys</span>) + <span class="ruby-identifier">attrs</span> = {} + <span class="ruby-identifier">keys</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">attrs</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">params</span>[<span class="ruby-identifier">key</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">present?</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">attrs</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- attributes_for_keys-source --> + + </div> + + + + + </div><!-- attributes_for_keys-method --> + + + <div id="method-i-authenticate-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authenticate!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authenticate-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 21</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authenticate!</span> + <span class="ruby-identifier">unauthorized!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">current_user</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- authenticate-21-source --> + + </div> + + + + + </div><!-- authenticate-21-method --> + + + <div id="method-i-authenticated_as_admin-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authenticated_as_admin!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authenticated_as_admin-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authenticated_as_admin!</span> + <span class="ruby-identifier">forbidden!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">is_admin?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- authenticated_as_admin-21-source --> + + </div> + + + + + </div><!-- authenticated_as_admin-21-method --> + + + <div id="method-i-authorize-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize!</span><span + class="method-args">(action, subject)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize!</span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span> + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">abilities</span>.<span class="ruby-identifier">allowed?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-identifier">forbidden!</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize-21-source --> + + </div> + + + + + </div><!-- authorize-21-method --> + + + <div id="method-i-current_user" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">current_user</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="current_user-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">current_user</span> + <span class="ruby-ivar">@current_user</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_authentication_token</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:private_token</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">env</span>[<span class="ruby-string">"HTTP_PRIVATE_TOKEN"</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- current_user-source --> + + </div> + + + + + </div><!-- current_user-method --> + + + <div id="method-i-forbidden-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">forbidden!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>error helpers</p> + + + + <div class="method-source-code" id="forbidden-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 45</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">forbidden!</span> + <span class="ruby-identifier">render_api_error!</span>(<span class="ruby-string">'403 Forbidden'</span>, <span class="ruby-value">403</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- forbidden-21-source --> + + </div> + + + + + </div><!-- forbidden-21-method --> + + + <div id="method-i-not_allowed-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">not_allowed!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="not_allowed-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 60</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">not_allowed!</span> + <span class="ruby-identifier">render_api_error!</span>(<span class="ruby-string">'Method Not Allowed'</span>, <span class="ruby-value">405</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- not_allowed-21-source --> + + </div> + + + + + </div><!-- not_allowed-21-method --> + + + <div id="method-i-not_found-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">not_found!</span><span + class="method-args">(resource = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="not_found-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">not_found!</span>(<span class="ruby-identifier">resource</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">message</span> = [<span class="ruby-string">"404"</span>] + <span class="ruby-identifier">message</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">resource</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">resource</span> + <span class="ruby-identifier">message</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"Not Found"</span> + <span class="ruby-identifier">render_api_error!</span>(<span class="ruby-identifier">message</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">' '</span>), <span class="ruby-value">404</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- not_found-21-source --> + + </div> + + + + + </div><!-- not_found-21-method --> + + + <div id="method-i-paginate" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">paginate</span><span + class="method-args">(object)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="paginate-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">paginate</span>(<span class="ruby-identifier">object</span>) + <span class="ruby-identifier">object</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:per_page</span>].<span class="ruby-identifier">to_i</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- paginate-source --> + + </div> + + + + + </div><!-- paginate-method --> + + + <div id="method-i-render_api_error-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">render_api_error!</span><span + class="method-args">(message, status)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="render_api_error-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 64</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">render_api_error!</span>(<span class="ruby-identifier">message</span>, <span class="ruby-identifier">status</span>) + <span class="ruby-identifier">error!</span>({<span class="ruby-string">'message'</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">message</span>}, <span class="ruby-identifier">status</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- render_api_error-21-source --> + + </div> + + + + + </div><!-- render_api_error-21-method --> + + + <div id="method-i-unauthorized-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">unauthorized!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="unauthorized-21-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">unauthorized!</span> + <span class="ruby-identifier">render_api_error!</span>(<span class="ruby-string">'401 Unauthorized'</span>, <span class="ruby-value">401</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- unauthorized-21-source --> + + </div> + + + + + </div><!-- unauthorized-21-method --> + + + <div id="method-i-user_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">user_project</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="user_project-source"> + <pre><span class="ruby-comment"># File lib/api/helpers.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">user_project</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@project</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">find_by_id</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) <span class="ruby-operator">||</span> + <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects</span>.<span class="ruby-identifier">find_by_code</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">not_found!</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@project</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- user_project-source --> + + </div> + + + + + </div><!-- user_project-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/AppLogger.html b/doc/app/Gitlab/AppLogger.html new file mode 100644 index 00000000000..e3a352af70f --- /dev/null +++ b/doc/app/Gitlab/AppLogger.html @@ -0,0 +1,523 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::AppLogger - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/app_logger.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="Logger.html">Gitlab::Logger</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-file_name">::file_name</a> + + <li><a href="#method-i-format_message">#format_message</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::AppLogger</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-file_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">file_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="file_name-source"> + <pre><span class="ruby-comment"># File lib/gitlab/app_logger.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">file_name</span> + <span class="ruby-string">'application.log'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- file_name-source --> + + </div> + + + + + </div><!-- file_name-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-format_message" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">format_message</span><span + class="method-args">(severity, timestamp, progname, msg)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="format_message-source"> + <pre><span class="ruby-comment"># File lib/gitlab/app_logger.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">format_message</span>(<span class="ruby-identifier">severity</span>, <span class="ruby-identifier">timestamp</span>, <span class="ruby-identifier">progname</span>, <span class="ruby-identifier">msg</span>) + <span class="ruby-node">"#{timestamp.to_s(:long)}: #{msg}\n"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- format_message-source --> + + </div> + + + + + </div><!-- format_message-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Auth.html b/doc/app/Gitlab/Auth.html new file mode 100644 index 00000000000..ac4fd556a79 --- /dev/null +++ b/doc/app/Gitlab/Auth.html @@ -0,0 +1,630 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Auth - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/auth.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create_from_omniauth">#create_from_omniauth</a> + + <li><a href="#method-i-find_for_ldap_auth">#find_for_ldap_auth</a> + + <li><a href="#method-i-find_or_new_for_omniauth">#find_or_new_for_omniauth</a> + + <li><a href="#method-i-log">#log</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Auth</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create_from_omniauth" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create_from_omniauth</span><span + class="method-args">(auth, ldap = false)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create_from_omniauth-source"> + <pre><span class="ruby-comment"># File lib/gitlab/auth.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_from_omniauth</span>(<span class="ruby-identifier">auth</span>, <span class="ruby-identifier">ldap</span> = <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">provider</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">provider</span> + <span class="ruby-identifier">uid</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">uid</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">uid</span> + <span class="ruby-identifier">name</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"utf-8"</span>) + <span class="ruby-identifier">email</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">email</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">email</span>.<span class="ruby-identifier">nil?</span> + + <span class="ruby-identifier">ldap_prefix</span> = <span class="ruby-identifier">ldap</span> <span class="ruby-operator">?</span> <span class="ruby-string">'(LDAP) '</span> <span class="ruby-operator">:</span> <span class="ruby-string">''</span> + <span class="ruby-identifier">raise</span> <span class="ruby-constant">OmniAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-node">"#{ldap_prefix}#{provider} does not provide an email"</span> <span class="ruby-string">" address"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">email</span>.<span class="ruby-identifier">blank?</span> + + <span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"#{ldap_prefix}Creating user from #{provider} login"</span> <span class="ruby-node">" {uid => #{uid}, name => #{name}, email => #{email}}"</span> + <span class="ruby-identifier">password</span> = <span class="ruby-constant">Devise</span>.<span class="ruby-identifier">friendly_token</span>[<span class="ruby-value">0</span>, <span class="ruby-value">8</span>].<span class="ruby-identifier">downcase</span> + <span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">new</span>({ + <span class="ruby-identifier">extern_uid</span><span class="ruby-operator">:</span> <span class="ruby-identifier">uid</span>, + <span class="ruby-identifier">provider</span><span class="ruby-operator">:</span> <span class="ruby-identifier">provider</span>, + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">name</span>, + <span class="ruby-identifier">email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">email</span>, + <span class="ruby-identifier">password</span><span class="ruby-operator">:</span> <span class="ruby-identifier">password</span>, + <span class="ruby-identifier">password_confirmation</span><span class="ruby-operator">:</span> <span class="ruby-identifier">password</span>, + <span class="ruby-identifier">projects_limit</span><span class="ruby-operator">:</span> <span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">default_projects_limit</span>, + }, <span class="ruby-identifier">as</span><span class="ruby-operator">:</span> <span class="ruby-value">:admin</span>) + <span class="ruby-keyword">if</span> <span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">omniauth</span>[<span class="ruby-string">'block_auto_created_users'</span>] <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">ldap</span> + <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">blocked</span> = <span class="ruby-keyword">true</span> + <span class="ruby-keyword">end</span> + <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">save!</span> + <span class="ruby-ivar">@user</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create_from_omniauth-source --> + + </div> + + + + + </div><!-- create_from_omniauth-method --> + + + <div id="method-i-find_for_ldap_auth" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">find_for_ldap_auth</span><span + class="method-args">(auth, signed_in_resource = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="find_for_ldap_auth-source"> + <pre><span class="ruby-comment"># File lib/gitlab/auth.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_for_ldap_auth</span>(<span class="ruby-identifier">auth</span>, <span class="ruby-identifier">signed_in_resource</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">uid</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">uid</span> + <span class="ruby-identifier">provider</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">provider</span> + <span class="ruby-identifier">email</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">email</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">email</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-identifier">raise</span> <span class="ruby-constant">OmniAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>, <span class="ruby-string">"LDAP accounts must provide an uid and email address"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">uid</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">email</span>.<span class="ruby-identifier">nil?</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_extern_uid_and_provider</span>(<span class="ruby-identifier">uid</span>, <span class="ruby-identifier">provider</span>) + <span class="ruby-ivar">@user</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">email</span>) + <span class="ruby-identifier">log</span>.<span class="ruby-identifier">info</span> <span class="ruby-node">"Updating legacy LDAP user #{email} with extern_uid => #{uid}"</span> + <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-value">:extern_uid</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">uid</span>, <span class="ruby-value">:provider</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">provider</span>) + <span class="ruby-ivar">@user</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">create_from_omniauth</span>(<span class="ruby-identifier">auth</span>, <span class="ruby-keyword">true</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- find_for_ldap_auth-source --> + + </div> + + + + + </div><!-- find_for_ldap_auth-method --> + + + <div id="method-i-find_or_new_for_omniauth" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">find_or_new_for_omniauth</span><span + class="method-args">(auth)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="find_or_new_for_omniauth-source"> + <pre><span class="ruby-comment"># File lib/gitlab/auth.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_or_new_for_omniauth</span>(<span class="ruby-identifier">auth</span>) + <span class="ruby-identifier">provider</span>, <span class="ruby-identifier">uid</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">provider</span>, <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">uid</span> + <span class="ruby-identifier">email</span> = <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">email</span>.<span class="ruby-identifier">downcase</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">auth</span>.<span class="ruby-identifier">info</span>.<span class="ruby-identifier">email</span>.<span class="ruby-identifier">nil?</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_provider_and_extern_uid</span>(<span class="ruby-identifier">provider</span>, <span class="ruby-identifier">uid</span>) + <span class="ruby-ivar">@user</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">email</span>) + <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-value">:extern_uid</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">uid</span>, <span class="ruby-value">:provider</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">provider</span>) + <span class="ruby-ivar">@user</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">if</span> <span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">omniauth</span>[<span class="ruby-string">'allow_single_sign_on'</span>] + <span class="ruby-ivar">@user</span> = <span class="ruby-identifier">create_from_omniauth</span>(<span class="ruby-identifier">auth</span>) + <span class="ruby-ivar">@user</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- find_or_new_for_omniauth-source --> + + </div> + + + + + </div><!-- find_or_new_for_omniauth-method --> + + + <div id="method-i-log" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">log</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="log-source"> + <pre><span class="ruby-comment"># File lib/gitlab/auth.rb, line 66</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">log</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">AppLogger</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- log-source --> + + </div> + + + + + </div><!-- log-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Encode.html b/doc/app/Gitlab/Encode.html new file mode 100644 index 00000000000..387e0db22e0 --- /dev/null +++ b/doc/app/Gitlab/Encode.html @@ -0,0 +1,537 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Gitlab::Encode - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/encode.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-detect_encoding">#detect_encoding</a> + + <li><a href="#method-i-utf8">#utf8</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Gitlab::Encode</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-detect_encoding" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">detect_encoding</span><span + class="method-args">(message)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="detect_encoding-source"> + <pre><span class="ruby-comment"># File lib/gitlab/encode.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">detect_encoding</span> <span class="ruby-identifier">message</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">message</span> + + <span class="ruby-identifier">hash</span> = <span class="ruby-constant">CharlockHolmes</span><span class="ruby-operator">::</span><span class="ruby-constant">EncodingDetector</span>.<span class="ruby-identifier">detect</span>(<span class="ruby-identifier">message</span>) <span class="ruby-keyword">rescue</span> {} + <span class="ruby-keyword">return</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value">:encoding</span>] <span class="ruby-operator">?</span> <span class="ruby-identifier">hash</span>[<span class="ruby-value">:encoding</span>] <span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- detect_encoding-source --> + + </div> + + + + + </div><!-- detect_encoding-method --> + + + <div id="method-i-utf8" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">utf8</span><span + class="method-args">(message)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="utf8-source"> + <pre><span class="ruby-comment"># File lib/gitlab/encode.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">utf8</span> <span class="ruby-identifier">message</span> + <span class="ruby-comment"># return nil if message is nil</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">message</span> + + <span class="ruby-identifier">message</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">"utf-8"</span>) + <span class="ruby-comment"># return message if message type is binary</span> + <span class="ruby-identifier">detect</span> = <span class="ruby-constant">CharlockHolmes</span><span class="ruby-operator">::</span><span class="ruby-constant">EncodingDetector</span>.<span class="ruby-identifier">detect</span>(<span class="ruby-identifier">message</span>) + <span class="ruby-keyword">return</span> <span class="ruby-identifier">message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">detect</span>[<span class="ruby-value">:type</span>] <span class="ruby-operator">==</span> <span class="ruby-value">:binary</span> + + <span class="ruby-comment"># if message is utf-8 encoding, just return it</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">message</span>.<span class="ruby-identifier">valid_encoding?</span> + + <span class="ruby-comment"># if message is not utf-8 encoding, convert it</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">detect</span>[<span class="ruby-value">:encoding</span>] + <span class="ruby-identifier">message</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-identifier">detect</span>[<span class="ruby-value">:encoding</span>]) + <span class="ruby-identifier">message</span>.<span class="ruby-identifier">encode!</span>(<span class="ruby-string">"utf-8"</span>, <span class="ruby-identifier">detect</span>[<span class="ruby-value">:encoding</span>], <span class="ruby-keyword">undef</span><span class="ruby-operator">:</span> <span class="ruby-value">:replace</span>, <span class="ruby-identifier">replace</span><span class="ruby-operator">:</span> <span class="ruby-string">""</span>, <span class="ruby-identifier">invalid</span><span class="ruby-operator">:</span> <span class="ruby-value">:replace</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># ensure message encoding is utf8</span> + <span class="ruby-identifier">message</span>.<span class="ruby-identifier">valid_encoding?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">message</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">raise</span> + +<span class="ruby-comment"># Prevent app from crash cause of encoding errors</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-identifier">encoding</span> = <span class="ruby-identifier">detect</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">detect</span>[<span class="ruby-value">:encoding</span>] <span class="ruby-operator">:</span> <span class="ruby-string">"unknown"</span> + <span class="ruby-node">"--broken encoding: #{encoding}"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- utf8-source --> + + </div> + + + + + </div><!-- utf8-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities.html b/doc/app/Gitlab/Entities.html new file mode 100644 index 00000000000..8cd0d837ed9 --- /dev/null +++ b/doc/app/Gitlab/Entities.html @@ -0,0 +1,433 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Gitlab::Entities - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Gitlab::Entities</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/Hook.html b/doc/app/Gitlab/Entities/Hook.html new file mode 100644 index 00000000000..c9eba832bc8 --- /dev/null +++ b/doc/app/Gitlab/Entities/Hook.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::Hook - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::Hook</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/Issue.html b/doc/app/Gitlab/Entities/Issue.html new file mode 100644 index 00000000000..f713b7ab609 --- /dev/null +++ b/doc/app/Gitlab/Entities/Issue.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::Issue - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::Issue</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/Milestone.html b/doc/app/Gitlab/Entities/Milestone.html new file mode 100644 index 00000000000..f762ad29227 --- /dev/null +++ b/doc/app/Gitlab/Entities/Milestone.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::Milestone - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::Milestone</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/Project.html b/doc/app/Gitlab/Entities/Project.html new file mode 100644 index 00000000000..725e6b75d49 --- /dev/null +++ b/doc/app/Gitlab/Entities/Project.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::Project - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::Project</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/ProjectMember.html b/doc/app/Gitlab/Entities/ProjectMember.html new file mode 100644 index 00000000000..468d3dc1ac9 --- /dev/null +++ b/doc/app/Gitlab/Entities/ProjectMember.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::ProjectMember - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="UserBasic.html">Gitlab::Entities::UserBasic</a> + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::ProjectMember</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/ProjectSnippet.html b/doc/app/Gitlab/Entities/ProjectSnippet.html new file mode 100644 index 00000000000..e19fad759ac --- /dev/null +++ b/doc/app/Gitlab/Entities/ProjectSnippet.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::ProjectSnippet - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::ProjectSnippet</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/RepoCommit.html b/doc/app/Gitlab/Entities/RepoCommit.html new file mode 100644 index 00000000000..04c118a3f9c --- /dev/null +++ b/doc/app/Gitlab/Entities/RepoCommit.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::RepoCommit - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::RepoCommit</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/RepoObject.html b/doc/app/Gitlab/Entities/RepoObject.html new file mode 100644 index 00000000000..27f928c1b8e --- /dev/null +++ b/doc/app/Gitlab/Entities/RepoObject.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::RepoObject - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::RepoObject</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/SSHKey.html b/doc/app/Gitlab/Entities/SSHKey.html new file mode 100644 index 00000000000..43ed0f01dcf --- /dev/null +++ b/doc/app/Gitlab/Entities/SSHKey.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::SSHKey - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::SSHKey</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/User.html b/doc/app/Gitlab/Entities/User.html new file mode 100644 index 00000000000..fb978194084 --- /dev/null +++ b/doc/app/Gitlab/Entities/User.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::User - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::User</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/UserBasic.html b/doc/app/Gitlab/Entities/UserBasic.html new file mode 100644 index 00000000000..dcb1e78209d --- /dev/null +++ b/doc/app/Gitlab/Entities/UserBasic.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::UserBasic - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::Entity + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::UserBasic</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Entities/UserLogin.html b/doc/app/Gitlab/Entities/UserLogin.html new file mode 100644 index 00000000000..fde77335268 --- /dev/null +++ b/doc/app/Gitlab/Entities/UserLogin.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Entities::UserLogin - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/entities.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="UserBasic.html">Gitlab::Entities::UserBasic</a> + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Entities::UserLogin</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/FileEditor.html b/doc/app/Gitlab/FileEditor.html new file mode 100644 index 00000000000..0916d63cbe0 --- /dev/null +++ b/doc/app/Gitlab/FileEditor.html @@ -0,0 +1,647 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::FileEditor - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/file_editor.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-can_edit-3F">#can_edit?</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::FileEditor</h1> + + <div id="description" class="description"> + +<p>GitLab file editor</p> + +<p>It gives you ability to make changes to files & commit this changes +from GitLab UI.</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-ref" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">ref</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-user" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">user</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(user, project, ref)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/gitlab/file_editor.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">project</span>, <span class="ruby-identifier">ref</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">user</span> = <span class="ruby-identifier">user</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span> = <span class="ruby-identifier">project</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">ref</span> = <span class="ruby-identifier">ref</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">(path, content, commit_message, last_commit)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File lib/gitlab/file_editor.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">content</span>, <span class="ruby-identifier">commit_message</span>, <span class="ruby-identifier">last_commit</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can_edit?</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">last_commit</span>) + + <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Git</span>.<span class="ruby-identifier">with_timeout</span>(<span class="ruby-value">10</span>.<span class="ruby-identifier">seconds</span>) <span class="ruby-keyword">do</span> + <span class="ruby-identifier">lock_file</span> = <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"tmp"</span>, <span class="ruby-node">"#{project.path}.lock"</span>) + + <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">lock_file</span>, <span class="ruby-string">"w+"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">f</span>.<span class="ruby-identifier">flock</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_EX</span>) + + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">satellite</span>.<span class="ruby-identifier">exists?</span> + <span class="ruby-identifier">raise</span> <span class="ruby-string">"Satellite doesn't exist"</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">satellite</span>.<span class="ruby-identifier">clear</span> + + <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">satellite</span>.<span class="ruby-identifier">path</span>) <span class="ruby-keyword">do</span> + <span class="ruby-identifier">r</span> = <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Repo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'.'</span>) + <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-string">"git reset --hard"</span> + <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-string">"git fetch origin"</span> + <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-node">"git config user.name \"#{user.name}\""</span> + <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-node">"git config user.email \"#{user.email}\""</span> + <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-node">"git checkout -b #{ref} origin/#{ref}"</span> + <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>, <span class="ruby-string">'w'</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">content</span>)} + <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-string">"git add ."</span> + <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-node">"git commit -am '#{commit_message}'"</span> + <span class="ruby-identifier">output</span> = <span class="ruby-identifier">r</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">sh</span> <span class="ruby-node">"git push origin #{ref}"</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">output</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%rreject/</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-can_edit-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can_edit?</span><span + class="method-args">(path, last_commit)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can_edit-3F-source"> + <pre><span class="ruby-comment"># File lib/gitlab/file_editor.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can_edit?</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">last_commit</span>) + <span class="ruby-identifier">current_last_commit</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">last_commit_for</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span>).<span class="ruby-identifier">sha</span> + <span class="ruby-identifier">last_commit</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">current_last_commit</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- can_edit-3F-source --> + + </div> + + + + + </div><!-- can_edit-3F-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/GitLogger.html b/doc/app/Gitlab/GitLogger.html new file mode 100644 index 00000000000..c37bce98ca5 --- /dev/null +++ b/doc/app/Gitlab/GitLogger.html @@ -0,0 +1,523 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::GitLogger - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/git_logger.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="Logger.html">Gitlab::Logger</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-file_name">::file_name</a> + + <li><a href="#method-i-format_message">#format_message</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::GitLogger</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-file_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">file_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="file_name-source"> + <pre><span class="ruby-comment"># File lib/gitlab/git_logger.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">file_name</span> + <span class="ruby-string">'githost.log'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- file_name-source --> + + </div> + + + + + </div><!-- file_name-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-format_message" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">format_message</span><span + class="method-args">(severity, timestamp, progname, msg)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="format_message-source"> + <pre><span class="ruby-comment"># File lib/gitlab/git_logger.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">format_message</span>(<span class="ruby-identifier">severity</span>, <span class="ruby-identifier">timestamp</span>, <span class="ruby-identifier">progname</span>, <span class="ruby-identifier">msg</span>) + <span class="ruby-node">"#{timestamp.to_s(:long)} -> #{severity} -> #{msg}\n"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- format_message-source --> + + </div> + + + + + </div><!-- format_message-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Gitolite.html b/doc/app/Gitlab/Gitolite.html new file mode 100644 index 00000000000..60ef3b136e5 --- /dev/null +++ b/doc/app/Gitlab/Gitolite.html @@ -0,0 +1,716 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Gitolite - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/backend/gitolite.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-config">#config</a> + + <li><a href="#method-i-create_repository">#create_repository</a> + + <li><a href="#method-i-enable_automerge">#enable_automerge</a> + + <li><a href="#method-i-remove_key">#remove_key</a> + + <li><a href="#method-i-remove_repository">#remove_repository</a> + + <li><a href="#method-i-set_key">#set_key</a> + + <li><a href="#method-i-update_repository">#update_repository</a> + + <li><a href="#method-i-url_to_repo">#url_to_repo</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Gitolite</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-config" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">config</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="config-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">config</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">GitoliteConfig</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- config-source --> + + </div> + + + + + </div><!-- config-method --> + + + <div id="method-i-create_repository" class="method-detail method-alias"> + + <div class="method-heading"> + <span class="method-name">create_repository</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + </div> + + + + + <div class="aliases"> + Alias for: <a href="Gitolite.html#method-i-update_repository">update_repository</a> + </div> + + </div><!-- create_repository-method --> + + + <div id="method-i-enable_automerge" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">enable_automerge</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="enable_automerge-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite.rb, line 37</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">enable_automerge</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">admin_all_repo!</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- enable_automerge-source --> + + </div> + + + + + </div><!-- enable_automerge-method --> + + + <div id="method-i-remove_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">remove_key</span><span + class="method-args">(key_id, projects)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="remove_key-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_key</span> <span class="ruby-identifier">key_id</span>, <span class="ruby-identifier">projects</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">apply</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">rm_key</span>(<span class="ruby-identifier">key_id</span>) + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">update_projects</span>(<span class="ruby-identifier">projects</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- remove_key-source --> + + </div> + + + + + </div><!-- remove_key-method --> + + + <div id="method-i-remove_repository" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">remove_repository</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="remove_repository-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_repository</span> <span class="ruby-identifier">project</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">destroy_project!</span>(<span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- remove_repository-source --> + + </div> + + + + + </div><!-- remove_repository-method --> + + + <div id="method-i-set_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">set_key</span><span + class="method-args">(key_id, key_content, projects)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="set_key-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_key</span> <span class="ruby-identifier">key_id</span>, <span class="ruby-identifier">key_content</span>, <span class="ruby-identifier">projects</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">apply</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">write_key</span>(<span class="ruby-identifier">key_id</span>, <span class="ruby-identifier">key_content</span>) + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">update_projects</span>(<span class="ruby-identifier">projects</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- set_key-source --> + + </div> + + + + + </div><!-- set_key-method --> + + + <div id="method-i-update_repository" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_repository</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update_repository-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_repository</span> <span class="ruby-identifier">project</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">update_project!</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">path</span>, <span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- update_repository-source --> + + </div> + + + <div class="aliases"> + Also aliased as: <a href="Gitolite.html#method-i-create_repository">create_repository</a> + </div> + + + + </div><!-- update_repository-method --> + + + <div id="method-i-url_to_repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">url_to_repo</span><span + class="method-args">(path)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="url_to_repo-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">url_to_repo</span> <span class="ruby-identifier">path</span> + <span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">ssh_path</span> <span class="ruby-operator">+</span> <span class="ruby-node">"#{path}.git"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- url_to_repo-source --> + + </div> + + + + + </div><!-- url_to_repo-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Gitolite/AccessDenied.html b/doc/app/Gitlab/Gitolite/AccessDenied.html new file mode 100644 index 00000000000..64a3b17a30f --- /dev/null +++ b/doc/app/Gitlab/Gitolite/AccessDenied.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Gitolite::AccessDenied - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/backend/gitolite.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">StandardError + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Gitolite::AccessDenied</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/GitoliteConfig.html b/doc/app/Gitlab/GitoliteConfig.html new file mode 100644 index 00000000000..19671089b15 --- /dev/null +++ b/doc/app/Gitlab/GitoliteConfig.html @@ -0,0 +1,994 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::GitoliteConfig - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/backend/gitolite_config.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-admin_all_repo">#admin_all_repo</a> + + <li><a href="#method-i-admin_all_repo-21">#admin_all_repo!</a> + + <li><a href="#method-i-apply">#apply</a> + + <li><a href="#method-i-destroy_project">#destroy_project</a> + + <li><a href="#method-i-destroy_project-21">#destroy_project!</a> + + <li><a href="#method-i-log">#log</a> + + <li><a href="#method-i-rm_key">#rm_key</a> + + <li><a href="#method-i-update_project">#update_project</a> + + <li><a href="#method-i-update_project-21">#update_project!</a> + + <li><a href="#method-i-update_project_config">#update_project_config</a> + + <li><a href="#method-i-update_projects">#update_projects</a> + + <li><a href="#method-i-write_key">#write_key</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::GitoliteConfig</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-conf" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">conf</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-config_tmp_dir" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">config_tmp_dir</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-ga_repo" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">ga_repo</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-admin_all_repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">admin_all_repo</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Enable access to all repos for gitolite admin. We use it for accept merge +request feature</p> + + + + <div class="method-source-code" id="admin_all_repo-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 162</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">admin_all_repo</span> + <span class="ruby-identifier">owner_name</span> = <span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">gitolite_admin_key</span> + + <span class="ruby-comment"># @ALL repos premission for gitolite owner</span> + <span class="ruby-identifier">repo_name</span> = <span class="ruby-string">"@all"</span> + <span class="ruby-identifier">repo</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">has_repo?</span>(<span class="ruby-identifier">repo_name</span>) + <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">get_repo</span>(<span class="ruby-identifier">repo_name</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-operator">::</span><span class="ruby-constant">Gitolite</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">Repo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">repo_name</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">add_permission</span>(<span class="ruby-string">"RW+"</span>, <span class="ruby-string">""</span>, <span class="ruby-identifier">owner_name</span>) + <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">add_repo</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-keyword">true</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- admin_all_repo-source --> + + </div> + + + + + </div><!-- admin_all_repo-method --> + + + <div id="method-i-admin_all_repo-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">admin_all_repo!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="admin_all_repo-21-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 177</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">admin_all_repo!</span> + <span class="ruby-identifier">apply</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">admin_all_repo</span> } +<span class="ruby-keyword">end</span></pre> + </div><!-- admin_all_repo-21-source --> + + </div> + + + + + </div><!-- admin_all_repo-21-method --> + + + <div id="method-i-apply" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">apply</span><span + class="method-args">() { |self| ... }</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="apply-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">apply</span> + <span class="ruby-constant">Timeout</span><span class="ruby-operator">::</span><span class="ruby-identifier">timeout</span>(<span class="ruby-value">30</span>) <span class="ruby-keyword">do</span> + <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">'tmp'</span>, <span class="ruby-string">"gitlabhq-gitolite.lock"</span>), <span class="ruby-string">"w+"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">begin</span> + <span class="ruby-comment"># Set exclusive lock</span> + <span class="ruby-comment"># to prevent race condition</span> + <span class="ruby-identifier">f</span>.<span class="ruby-identifier">flock</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_EX</span>) + + <span class="ruby-comment"># Pull gitolite-admin repo</span> + <span class="ruby-comment"># in tmp dir before do any changes</span> + <span class="ruby-identifier">pull</span>(<span class="ruby-identifier">config_tmp_dir</span>) + + <span class="ruby-comment"># Build ga_repo object and @conf</span> + <span class="ruby-comment"># to access gitolite-admin configuration</span> + <span class="ruby-ivar">@conf</span> = <span class="ruby-identifier">ga_repo</span>.<span class="ruby-identifier">config</span> + + <span class="ruby-comment"># Do any changes</span> + <span class="ruby-comment"># in gitolite-admin</span> + <span class="ruby-comment"># config here</span> + <span class="ruby-keyword">yield</span>(<span class="ruby-keyword">self</span>) + + <span class="ruby-comment"># Save changes in</span> + <span class="ruby-comment"># gitolite-admin repo</span> + <span class="ruby-comment"># before push it</span> + <span class="ruby-identifier">ga_repo</span>.<span class="ruby-identifier">save</span> + + <span class="ruby-comment"># Push gitolite-admin repo</span> + <span class="ruby-comment"># to apply all changes</span> + <span class="ruby-identifier">push</span>(<span class="ruby-identifier">config_tmp_dir</span>) + <span class="ruby-keyword">ensure</span> + <span class="ruby-comment"># Remove tmp dir</span> + <span class="ruby-comment"># removing the gitolite folder first is important to avoid</span> + <span class="ruby-comment"># NFS issues.</span> + <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">config_tmp_dir</span>, <span class="ruby-string">'gitolite'</span>)) + + <span class="ruby-comment"># Remove parent tmp dir</span> + <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-identifier">config_tmp_dir</span>) + + <span class="ruby-comment"># Unlock so other task can access</span> + <span class="ruby-comment"># gitolite configuration</span> + <span class="ruby-identifier">f</span>.<span class="ruby-identifier">flock</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">LOCK_UN</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">PullError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-identifier">log</span>(<span class="ruby-string">"Pull error -> "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span>) + <span class="ruby-identifier">raise</span> <span class="ruby-constant">Gitolite</span><span class="ruby-operator">::</span><span class="ruby-constant">AccessDenied</span>, <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span> + +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">PushError</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-identifier">log</span>(<span class="ruby-string">"Push error -> "</span> <span class="ruby-operator">+</span> <span class="ruby-string">" "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span>) + <span class="ruby-identifier">raise</span> <span class="ruby-constant">Gitolite</span><span class="ruby-operator">::</span><span class="ruby-constant">AccessDenied</span>, <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span> + +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-identifier">log</span>(<span class="ruby-identifier">ex</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">+</span> <span class="ruby-string">" "</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span>) + <span class="ruby-identifier">raise</span> <span class="ruby-constant">Gitolite</span><span class="ruby-operator">::</span><span class="ruby-constant">AccessDenied</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"gitolite timeout"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- apply-source --> + + </div> + + + + + </div><!-- apply-method --> + + + <div id="method-i-destroy_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy_project</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy_project-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 81</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy_project</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">path_to_repo</span>) + <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">rm_repo</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">path</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy_project-source --> + + </div> + + + + + </div><!-- destroy_project-method --> + + + <div id="method-i-destroy_project-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy_project!</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy_project-21-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 86</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy_project!</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-identifier">apply</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">destroy_project</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy_project-21-source --> + + </div> + + + + + </div><!-- destroy_project-21-method --> + + + <div id="method-i-log" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">log</span><span + class="method-args">(message)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="log-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">log</span> <span class="ruby-identifier">message</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">GitLogger</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">message</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- log-source --> + + </div> + + + + + </div><!-- log-method --> + + + <div id="method-i-rm_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">rm_key</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="rm_key-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 98</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">rm_key</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-identifier">key_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">config_tmp_dir</span>, <span class="ruby-string">'gitolite/keydir'</span>, <span class="ruby-node">"#{user}.pub"</span>) + <span class="ruby-identifier">ga_key</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Gitolite</span><span class="ruby-operator">::</span><span class="ruby-constant">SSHKey</span>.<span class="ruby-identifier">from_file</span>(<span class="ruby-identifier">key_path</span>) + <span class="ruby-identifier">ga_repo</span>.<span class="ruby-identifier">rm_key</span>(<span class="ruby-identifier">ga_key</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- rm_key-source --> + + </div> + + + + + </div><!-- rm_key-method --> + + + <div id="method-i-update_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_project</span><span + class="method-args">(repo_name, project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>update or create</p> + + + + <div class="method-source-code" id="update_project-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 105</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_project</span>(<span class="ruby-identifier">repo_name</span>, <span class="ruby-identifier">project</span>) + <span class="ruby-identifier">repo</span> = <span class="ruby-identifier">update_project_config</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">conf</span>) + <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">add_repo</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-keyword">true</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- update_project-source --> + + </div> + + + + + </div><!-- update_project-method --> + + + <div id="method-i-update_project-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_project!</span><span + class="method-args">(repo_name, project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update_project-21-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 110</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_project!</span>(<span class="ruby-identifier">repo_name</span>, <span class="ruby-identifier">project</span>) + <span class="ruby-identifier">apply</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">config</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">config</span>.<span class="ruby-identifier">update_project</span>(<span class="ruby-identifier">repo_name</span>, <span class="ruby-identifier">project</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update_project-21-source --> + + </div> + + + + + </div><!-- update_project-21-method --> + + + <div id="method-i-update_project_config" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_project_config</span><span + class="method-args">(project, conf)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update_project_config-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 125</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_project_config</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">conf</span>) + <span class="ruby-identifier">repo_name</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">path</span> + + <span class="ruby-identifier">repo</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">has_repo?</span>(<span class="ruby-identifier">repo_name</span>) + <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">get_repo</span>(<span class="ruby-identifier">repo_name</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-operator">::</span><span class="ruby-constant">Gitolite</span><span class="ruby-operator">::</span><span class="ruby-constant">Config</span><span class="ruby-operator">::</span><span class="ruby-constant">Repo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">repo_name</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">name_readers</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repository_readers</span> + <span class="ruby-identifier">name_writers</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repository_writers</span> + <span class="ruby-identifier">name_masters</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repository_masters</span> + + <span class="ruby-identifier">pr_br</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:name</span>).<span class="ruby-identifier">join</span>(<span class="ruby-string">"$ "</span>) + + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">clean_permissions</span> + + <span class="ruby-comment"># Deny access to protected branches for writers</span> + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name_writers</span>.<span class="ruby-identifier">blank?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">pr_br</span>.<span class="ruby-identifier">blank?</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">add_permission</span>(<span class="ruby-string">"-"</span>, <span class="ruby-identifier">pr_br</span>.<span class="ruby-identifier">strip</span> <span class="ruby-operator">+</span> <span class="ruby-string">"$ "</span>, <span class="ruby-identifier">name_writers</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># Add read permissions</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">add_permission</span>(<span class="ruby-string">"R"</span>, <span class="ruby-string">""</span>, <span class="ruby-identifier">name_readers</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name_readers</span>.<span class="ruby-identifier">blank?</span> + + <span class="ruby-comment"># Add write permissions</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">add_permission</span>(<span class="ruby-string">"RW+"</span>, <span class="ruby-string">""</span>, <span class="ruby-identifier">name_writers</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name_writers</span>.<span class="ruby-identifier">blank?</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">add_permission</span>(<span class="ruby-string">"RW+"</span>, <span class="ruby-string">""</span>, <span class="ruby-identifier">name_masters</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">name_masters</span>.<span class="ruby-identifier">blank?</span> + + <span class="ruby-comment"># Add sharedRepository config</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">set_git_config</span>(<span class="ruby-string">"core.sharedRepository"</span>, <span class="ruby-string">"0660"</span>) + + <span class="ruby-identifier">repo</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update_project_config-source --> + + </div> + + + + + </div><!-- update_project_config-method --> + + + <div id="method-i-update_projects" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_projects</span><span + class="method-args">(projects)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Updates many projects and uses project.path as the repo path An order of +magnitude faster than <a +href="GitoliteConfig.html#method-i-update_project">#update_project</a></p> + + + + <div class="method-source-code" id="update_projects-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 118</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_projects</span>(<span class="ruby-identifier">projects</span>) + <span class="ruby-identifier">projects</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">repo</span> = <span class="ruby-identifier">update_project_config</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">conf</span>) + <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">add_repo</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-keyword">true</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update_projects-source --> + + </div> + + + + + </div><!-- update_projects-method --> + + + <div id="method-i-write_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">write_key</span><span + class="method-args">(id, key)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="write_key-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/gitolite_config.rb, line 92</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">write_key</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">key</span>) + <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">config_tmp_dir</span>, <span class="ruby-string">'gitolite/keydir'</span>,<span class="ruby-node">"#{id}.pub"</span>), <span class="ruby-string">'w'</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">%r\n/</span>,<span class="ruby-string">''</span>)) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- write_key-source --> + + </div> + + + + + </div><!-- write_key-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/GitoliteConfig/PullError.html b/doc/app/Gitlab/GitoliteConfig/PullError.html new file mode 100644 index 00000000000..8e5a1510d45 --- /dev/null +++ b/doc/app/Gitlab/GitoliteConfig/PullError.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::GitoliteConfig::PullError - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/backend/gitolite_config.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">StandardError + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::GitoliteConfig::PullError</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/GitoliteConfig/PushError.html b/doc/app/Gitlab/GitoliteConfig/PushError.html new file mode 100644 index 00000000000..c1541f49d66 --- /dev/null +++ b/doc/app/Gitlab/GitoliteConfig/PushError.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::GitoliteConfig::PushError - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/backend/gitolite_config.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">StandardError + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::GitoliteConfig::PushError</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/GraphCommit.html b/doc/app/Gitlab/GraphCommit.html new file mode 100644 index 00000000000..b8ffa6f4161 --- /dev/null +++ b/doc/app/Gitlab/GraphCommit.html @@ -0,0 +1,967 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::GraphCommit - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/graph_commit.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><span class="include">ActionView::Helpers::TagHelper</span> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-find_free_space">::find_free_space</a> + + <li><a href="#method-c-index_commits">::index_commits</a> + + <li><a href="#method-c-mark_reserved">::mark_reserved</a> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-c-place_chain">::place_chain</a> + + <li><a href="#method-c-take_left_leaves">::take_left_leaves</a> + + <li><a href="#method-c-to_graph">::to_graph</a> + + <li><a href="#method-i-add_refs">#add_refs</a> + + <li><a href="#method-i-method_missing">#method_missing</a> + + <li><a href="#method-i-to_graph_hash">#to_graph_hash</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::GraphCommit</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-refs" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">refs</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-space" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">space</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-time" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">time</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-find_free_space" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">find_free_space</span><span + class="method-args">(time_range)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="find_free_space-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 113</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">find_free_space</span>(<span class="ruby-identifier">time_range</span>) + <span class="ruby-identifier">reserved</span> = [] + <span class="ruby-keyword">for</span> <span class="ruby-identifier">day</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">time_range</span> + <span class="ruby-identifier">reserved</span> <span class="ruby-operator">+=</span> <span class="ruby-ivar">@_reserved</span>[<span class="ruby-identifier">day</span>] + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">space</span> = <span class="ruby-value">1</span> + <span class="ruby-keyword">while</span> <span class="ruby-identifier">reserved</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">space</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">space</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">space</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- find_free_space-source --> + + </div> + + + + + </div><!-- find_free_space-method --> + + + <div id="method-c-index_commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index_commits</span><span + class="method-args">(commits)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Method is adding time and space on the list of commits. As well as returns +date list corelated with time set on commits.</p> + +<p>@param [Array<GraphCommit>] comits to index</p> + +<p>@return [Array<TimeDate>] list of commit dates corelated with time on +commits</p> + + + + <div class="method-source-code" id="index_commits-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">index_commits</span>(<span class="ruby-identifier">commits</span>) + <span class="ruby-identifier">days</span>, <span class="ruby-identifier">heads</span> = [], [] + <span class="ruby-identifier">map</span> = {} + + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">i</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">c</span>.<span class="ruby-identifier">time</span> = <span class="ruby-identifier">i</span> + <span class="ruby-identifier">days</span>[<span class="ruby-identifier">i</span>] = <span class="ruby-identifier">c</span>.<span class="ruby-identifier">committed_date</span> + <span class="ruby-identifier">map</span>[<span class="ruby-identifier">c</span>.<span class="ruby-identifier">id</span>] = <span class="ruby-identifier">c</span> + <span class="ruby-identifier">heads</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">refs</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">refs</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">heads</span>.<span class="ruby-identifier">select!</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">h</span><span class="ruby-operator">|</span> <span class="ruby-identifier">h</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Head</span> <span class="ruby-keyword">or</span> <span class="ruby-identifier">h</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Remote</span>} + <span class="ruby-comment"># sort heads so the master is top and current branches are closer</span> + <span class="ruby-identifier">heads</span>.<span class="ruby-identifier">sort!</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span>,<span class="ruby-identifier">b</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"master"</span> + <span class="ruby-value">-1</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">b</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-string">"master"</span> + <span class="ruby-value">1</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">b</span>.<span class="ruby-identifier">commit</span>.<span class="ruby-identifier">committed_date</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">commit</span>.<span class="ruby-identifier">committed_date</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@_reserved</span> = {} + <span class="ruby-identifier">days</span>.<span class="ruby-identifier">each_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> + <span class="ruby-ivar">@_reserved</span>[<span class="ruby-identifier">i</span>] = [] + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">heads</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">h</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">map</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">h</span>.<span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span> <span class="ruby-keyword">then</span> + <span class="ruby-identifier">place_chain</span>(<span class="ruby-identifier">map</span>[<span class="ruby-identifier">h</span>.<span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>], <span class="ruby-identifier">map</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">days</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index_commits-source --> + + </div> + + + + + </div><!-- index_commits-method --> + + + <div id="method-c-mark_reserved" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">mark_reserved</span><span + class="method-args">(time_range, space)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="mark_reserved-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 107</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">mark_reserved</span>(<span class="ruby-identifier">time_range</span>, <span class="ruby-identifier">space</span>) + <span class="ruby-keyword">for</span> <span class="ruby-identifier">day</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">time_range</span> + <span class="ruby-ivar">@_reserved</span>[<span class="ruby-identifier">day</span>].<span class="ruby-identifier">push</span>(<span class="ruby-identifier">space</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- mark_reserved-source --> + + </div> + + + + + </div><!-- mark_reserved-method --> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(commit)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 148</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">commit</span>) + <span class="ruby-ivar">@_commit</span> = <span class="ruby-identifier">commit</span> + <span class="ruby-ivar">@time</span> = <span class="ruby-value">-1</span> + <span class="ruby-ivar">@space</span> = <span class="ruby-value">0</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-c-place_chain" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">place_chain</span><span + class="method-args">(commit, map, parent_time = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Add space mark on commit and its parents</p> + +<p>@param [GraphCommit] the commit object. @param +[Hash<String,GraphCommit>] map of commits</p> + + + + <div class="method-source-code" id="place_chain-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 73</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">place_chain</span>(<span class="ruby-identifier">commit</span>, <span class="ruby-identifier">map</span>, <span class="ruby-identifier">parent_time</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">leaves</span> = <span class="ruby-identifier">take_left_leaves</span>(<span class="ruby-identifier">commit</span>, <span class="ruby-identifier">map</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-keyword">then</span> + <span class="ruby-keyword">return</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">space</span> = <span class="ruby-identifier">find_free_space</span>(<span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">time</span><span class="ruby-operator">..</span><span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">time</span>) + <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">each</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> <span class="ruby-identifier">l</span>.<span class="ruby-identifier">space</span> = <span class="ruby-identifier">space</span>} + <span class="ruby-comment"># and mark it as reserved</span> + <span class="ruby-identifier">min_time</span> = <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">time</span> + <span class="ruby-identifier">parents</span> = <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">parents</span>.<span class="ruby-identifier">collect</span> + <span class="ruby-identifier">parents</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">map</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span> <span class="ruby-keyword">then</span> + <span class="ruby-identifier">parent</span> = <span class="ruby-identifier">map</span>[<span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span>] + <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">time</span> <span class="ruby-operator"><</span> <span class="ruby-identifier">min_time</span> <span class="ruby-keyword">then</span> + <span class="ruby-identifier">min_time</span> = <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">time</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent_time</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">then</span> + <span class="ruby-identifier">max_time</span> = <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">time</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">max_time</span> = <span class="ruby-identifier">parent_time</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">mark_reserved</span>(<span class="ruby-identifier">min_time</span><span class="ruby-operator">..</span><span class="ruby-identifier">max_time</span>, <span class="ruby-identifier">space</span>) + <span class="ruby-comment"># Visit branching chains</span> + <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">l</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">parents</span> = <span class="ruby-identifier">l</span>.<span class="ruby-identifier">parents</span>.<span class="ruby-identifier">collect</span> + .<span class="ruby-identifier">select</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-identifier">map</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">map</span>[<span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span>].<span class="ruby-identifier">space</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>} + <span class="ruby-keyword">for</span> <span class="ruby-identifier">p</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">parents</span> + <span class="ruby-identifier">place_chain</span>(<span class="ruby-identifier">map</span>[<span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span>], <span class="ruby-identifier">map</span>, <span class="ruby-identifier">l</span>.<span class="ruby-identifier">time</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- place_chain-source --> + + </div> + + + + + </div><!-- place_chain-method --> + + + <div id="method-c-take_left_leaves" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">take_left_leaves</span><span + class="method-args">(commit, map)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Takes most left subtree branch of commits which don’t have space mark yet.</p> + +<p>@param [GraphCommit] the commit object. @param +[Hash<String,GraphCommit>] map of commits</p> + +<p>@return [Array<GraphCommit>] list of branch commits</p> + + + + <div class="method-source-code" id="take_left_leaves-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 132</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">take_left_leaves</span>(<span class="ruby-identifier">commit</span>, <span class="ruby-identifier">map</span>) + <span class="ruby-identifier">leaves</span> = [] + <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">commit</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">space</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> + <span class="ruby-keyword">while</span> <span class="ruby-keyword">true</span> + <span class="ruby-identifier">parent</span> = <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">parents</span>.<span class="ruby-identifier">collect</span> + .<span class="ruby-identifier">select</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-identifier">map</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">map</span>[<span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span>].<span class="ruby-identifier">space</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>} + <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-keyword">then</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">leaves</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">commit</span> = <span class="ruby-identifier">map</span>[<span class="ruby-identifier">parent</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">id</span>] + <span class="ruby-identifier">leaves</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">commit</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- take_left_leaves-source --> + + </div> + + + + + </div><!-- take_left_leaves-method --> + + + <div id="method-c-to_graph" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_graph</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="to_graph-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">to_graph</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-ivar">@repo</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span> + <span class="ruby-identifier">commits</span> = <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Commit</span>.<span class="ruby-identifier">find_all</span>(<span class="ruby-ivar">@repo</span>, <span class="ruby-keyword">nil</span>, {<span class="ruby-identifier">max_count</span><span class="ruby-operator">:</span> <span class="ruby-value">650</span>}) + + <span class="ruby-identifier">ref_cache</span> = {} + + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">map!</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">GraphCommit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>))} + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">commit</span><span class="ruby-operator">|</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">add_refs</span>(<span class="ruby-identifier">ref_cache</span>, <span class="ruby-ivar">@repo</span>) } + + <span class="ruby-identifier">days</span> = <span class="ruby-constant">GraphCommit</span>.<span class="ruby-identifier">index_commits</span>(<span class="ruby-identifier">commits</span>) + <span class="ruby-ivar">@days_json</span> = <span class="ruby-identifier">days</span>.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">d</span><span class="ruby-operator">|</span> [<span class="ruby-identifier">d</span>.<span class="ruby-identifier">day</span>, <span class="ruby-identifier">d</span>.<span class="ruby-identifier">strftime</span>(<span class="ruby-string">"%b"</span>)] }.<span class="ruby-identifier">to_json</span> + <span class="ruby-ivar">@commits_json</span> = <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:to_graph_hash</span>).<span class="ruby-identifier">to_json</span> + + <span class="ruby-keyword">return</span> <span class="ruby-ivar">@days_json</span>, <span class="ruby-ivar">@commits_json</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_graph-source --> + + </div> + + + + + </div><!-- to_graph-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-add_refs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_refs</span><span + class="method-args">(ref_cache, repo)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="add_refs-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 174</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_refs</span>(<span class="ruby-identifier">ref_cache</span>, <span class="ruby-identifier">repo</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">ref_cache</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">refs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">ref</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">ref_cache</span>[<span class="ruby-identifier">ref</span>.<span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>] <span class="ruby-operator">||=</span> [] + <span class="ruby-identifier">ref_cache</span>[<span class="ruby-identifier">ref</span>.<span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>] <span class="ruby-operator"><<</span> <span class="ruby-identifier">ref</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-ivar">@refs</span> = <span class="ruby-identifier">ref_cache</span>[<span class="ruby-ivar">@_commit</span>.<span class="ruby-identifier">id</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">ref_cache</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@_commit</span>.<span class="ruby-identifier">id</span>) + <span class="ruby-ivar">@refs</span> <span class="ruby-operator">||=</span> [] +<span class="ruby-keyword">end</span></pre> + </div><!-- add_refs-source --> + + </div> + + + + + </div><!-- add_refs-method --> + + + <div id="method-i-method_missing" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">method_missing</span><span + class="method-args">(m, *args, &block)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="method_missing-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 154</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">m</span>, *<span class="ruby-identifier">args</span>, &<span class="ruby-identifier">block</span>) + <span class="ruby-ivar">@_commit</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">m</span>, *<span class="ruby-identifier">args</span>, &<span class="ruby-identifier">block</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- method_missing-source --> + + </div> + + + + + </div><!-- method_missing-method --> + + + <div id="method-i-to_graph_hash" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_graph_hash</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="to_graph_hash-source"> + <pre><span class="ruby-comment"># File lib/gitlab/graph_commit.rb, line 158</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_graph_hash</span> + <span class="ruby-identifier">h</span> = {} + <span class="ruby-identifier">h</span>[<span class="ruby-value">:parents</span>] = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">parents</span>.<span class="ruby-identifier">collect</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> + [<span class="ruby-identifier">p</span>.<span class="ruby-identifier">id</span>,<span class="ruby-value">0</span>,<span class="ruby-value">0</span>] + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">h</span>[<span class="ruby-value">:author</span>] = <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Encode</span>.<span class="ruby-identifier">utf8</span>(<span class="ruby-identifier">author</span>.<span class="ruby-identifier">name</span>) + <span class="ruby-identifier">h</span>[<span class="ruby-value">:time</span>] = <span class="ruby-identifier">time</span> + <span class="ruby-identifier">h</span>[<span class="ruby-value">:space</span>] = <span class="ruby-identifier">space</span> + <span class="ruby-identifier">h</span>[<span class="ruby-value">:refs</span>] = <span class="ruby-identifier">refs</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span><span class="ruby-identifier">r</span>.<span class="ruby-identifier">name</span>}.<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">refs</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-identifier">h</span>[<span class="ruby-value">:id</span>] = <span class="ruby-identifier">sha</span> + <span class="ruby-identifier">h</span>[<span class="ruby-value">:date</span>] = <span class="ruby-identifier">date</span> + <span class="ruby-identifier">h</span>[<span class="ruby-value">:message</span>] = <span class="ruby-identifier">escape_once</span>(<span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Encode</span>.<span class="ruby-identifier">utf8</span>(<span class="ruby-identifier">message</span>)) + <span class="ruby-identifier">h</span>[<span class="ruby-value">:login</span>] = <span class="ruby-identifier">author</span>.<span class="ruby-identifier">email</span> + <span class="ruby-identifier">h</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_graph_hash-source --> + + </div> + + + + + </div><!-- to_graph_hash-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/InlineDiff.html b/doc/app/Gitlab/InlineDiff.html new file mode 100644 index 00000000000..91eeae9c441 --- /dev/null +++ b/doc/app/Gitlab/InlineDiff.html @@ -0,0 +1,611 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::InlineDiff - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/inline_diff.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-_indexes_of_changed_lines">::_indexes_of_changed_lines</a> + + <li><a href="#method-c-processing">::processing</a> + + <li><a href="#method-c-replace_markers">::replace_markers</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::InlineDiff</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="FINISH">FINISH + + <dd class="description"> + + + <dt id="START">START + + <dd class="description"> + + + </dl> + </section> + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-_indexes_of_changed_lines" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">_indexes_of_changed_lines</span><span + class="method-args">(diff_arr)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="_indexes_of_changed_lines-source"> + <pre><span class="ruby-comment"># File lib/gitlab/inline_diff.rb, line 42</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">_indexes_of_changed_lines</span> <span class="ruby-identifier">diff_arr</span> + <span class="ruby-identifier">chain_of_first_symbols</span> = <span class="ruby-string">""</span> + <span class="ruby-identifier">diff_arr</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span>, <span class="ruby-identifier">i</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">chain_of_first_symbols</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">line</span>[<span class="ruby-value">0</span>] + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">chain_of_first_symbols</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r[^\-\+]/</span>, <span class="ruby-node">"#"</span>) + + <span class="ruby-identifier">offset</span> = <span class="ruby-value">0</span> + <span class="ruby-identifier">indexes</span> = [] + <span class="ruby-keyword">while</span> <span class="ruby-identifier">index</span> = <span class="ruby-identifier">chain_of_first_symbols</span>.<span class="ruby-identifier">index</span>(<span class="ruby-node">"#-+#"</span>, <span class="ruby-identifier">offset</span>) + <span class="ruby-identifier">indexes</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">index</span> + <span class="ruby-identifier">offset</span> = <span class="ruby-identifier">index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">indexes</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- _indexes_of_changed_lines-source --> + + </div> + + + + + </div><!-- _indexes_of_changed_lines-method --> + + + <div id="method-c-processing" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">processing</span><span + class="method-args">(diff_arr)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="processing-source"> + <pre><span class="ruby-comment"># File lib/gitlab/inline_diff.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">processing</span> <span class="ruby-identifier">diff_arr</span> + <span class="ruby-identifier">indexes</span> = <span class="ruby-identifier">_indexes_of_changed_lines</span> <span class="ruby-identifier">diff_arr</span> + + <span class="ruby-identifier">indexes</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">index</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">first_line</span> = <span class="ruby-identifier">diff_arr</span>[<span class="ruby-identifier">index</span><span class="ruby-operator">+</span><span class="ruby-value">1</span>] + <span class="ruby-identifier">second_line</span> = <span class="ruby-identifier">diff_arr</span>[<span class="ruby-identifier">index</span><span class="ruby-operator">+</span><span class="ruby-value">2</span>] + <span class="ruby-identifier">max_length</span> = [<span class="ruby-identifier">first_line</span>.<span class="ruby-identifier">size</span>, <span class="ruby-identifier">second_line</span>.<span class="ruby-identifier">size</span>].<span class="ruby-identifier">max</span> + + <span class="ruby-identifier">first_the_same_symbols</span> = <span class="ruby-value">0</span> + (<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-identifier">max_length</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">first_the_same_symbols</span> = <span class="ruby-identifier">i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">first_line</span>[<span class="ruby-identifier">i</span>] <span class="ruby-operator">!=</span> <span class="ruby-identifier">second_line</span>[<span class="ruby-identifier">i</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> + <span class="ruby-keyword">break</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">first_token</span> = <span class="ruby-identifier">first_line</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-identifier">first_the_same_symbols</span>][<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] + <span class="ruby-identifier">diff_arr</span>[<span class="ruby-identifier">index</span><span class="ruby-operator">+</span><span class="ruby-value">1</span>].<span class="ruby-identifier">sub!</span>(<span class="ruby-identifier">first_token</span>, <span class="ruby-identifier">first_token</span> <span class="ruby-operator">+</span> <span class="ruby-constant">START</span>) + <span class="ruby-identifier">diff_arr</span>[<span class="ruby-identifier">index</span><span class="ruby-operator">+</span><span class="ruby-value">2</span>].<span class="ruby-identifier">sub!</span>(<span class="ruby-identifier">first_token</span>, <span class="ruby-identifier">first_token</span> <span class="ruby-operator">+</span> <span class="ruby-constant">START</span>) + <span class="ruby-identifier">last_the_same_symbols</span> = <span class="ruby-value">0</span> + (<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-identifier">max_length</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">last_the_same_symbols</span> = <span class="ruby-operator">-</span><span class="ruby-identifier">i</span> + <span class="ruby-identifier">shortest_line</span> = <span class="ruby-identifier">second_line</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-identifier">first_line</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">first_line</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">second_line</span> + <span class="ruby-keyword">if</span> ( <span class="ruby-identifier">first_line</span>[<span class="ruby-operator">-</span><span class="ruby-identifier">i</span>] <span class="ruby-operator">!=</span> <span class="ruby-identifier">second_line</span>[<span class="ruby-operator">-</span><span class="ruby-identifier">i</span>] ) <span class="ruby-operator">||</span> <span class="ruby-node">"#{first_token}#{START}"</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">shortest_line</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-operator">-</span><span class="ruby-identifier">i</span>].<span class="ruby-identifier">size</span> + <span class="ruby-keyword">break</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">last_the_same_symbols</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</span> + <span class="ruby-identifier">last_token</span> = <span class="ruby-identifier">first_line</span>[<span class="ruby-identifier">last_the_same_symbols</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] + <span class="ruby-identifier">diff_arr</span>[<span class="ruby-identifier">index</span><span class="ruby-operator">+</span><span class="ruby-value">1</span>].<span class="ruby-identifier">sub!</span>(<span class="ruby-node">%r#{Regexp.escape(last_token)}$/</span>, <span class="ruby-constant">FINISH</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">last_token</span>) + <span class="ruby-identifier">diff_arr</span>[<span class="ruby-identifier">index</span><span class="ruby-operator">+</span><span class="ruby-value">2</span>].<span class="ruby-identifier">sub!</span>(<span class="ruby-node">%r#{Regexp.escape(last_token)}$/</span>, <span class="ruby-constant">FINISH</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">last_token</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">diff_arr</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- processing-source --> + + </div> + + + + + </div><!-- processing-method --> + + + <div id="method-c-replace_markers" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">replace_markers</span><span + class="method-args">(line)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="replace_markers-source"> + <pre><span class="ruby-comment"># File lib/gitlab/inline_diff.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">replace_markers</span> <span class="ruby-identifier">line</span> + <span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-constant">START</span>, <span class="ruby-string">"<span class='idiff'>"</span>) + <span class="ruby-identifier">line</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-constant">FINISH</span>, <span class="ruby-string">"</span>"</span>) + <span class="ruby-identifier">line</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- replace_markers-source --> + + </div> + + + + + </div><!-- replace_markers-method --> + + + </section><!-- public-class-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Issues.html b/doc/app/Gitlab/Issues.html new file mode 100644 index 00000000000..eda99ed10dc --- /dev/null +++ b/doc/app/Gitlab/Issues.html @@ -0,0 +1,441 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Issues - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/issues.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::API + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Issues</h1> + + <div id="description" class="description"> + +<p><a href="Issues.html">Issues</a> <a href="API.html">API</a></p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Logger.html b/doc/app/Gitlab/Logger.html new file mode 100644 index 00000000000..8cc6cdea81b --- /dev/null +++ b/doc/app/Gitlab/Logger.html @@ -0,0 +1,583 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Logger - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/logger.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Logger + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-build">::build</a> + + <li><a href="#method-c-error">::error</a> + + <li><a href="#method-c-info">::info</a> + + <li><a href="#method-c-read_latest">::read_latest</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Logger</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-build" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">build</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="build-source"> + <pre><span class="ruby-comment"># File lib/gitlab/logger.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">build</span> + <span class="ruby-identifier">new</span>(<span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"log"</span>, <span class="ruby-identifier">file_name</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- build-source --> + + </div> + + + + + </div><!-- build-method --> + + + <div id="method-c-error" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">error</span><span + class="method-args">(message)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="error-source"> + <pre><span class="ruby-comment"># File lib/gitlab/logger.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">message</span>) + <span class="ruby-identifier">build</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">message</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- error-source --> + + </div> + + + + + </div><!-- error-method --> + + + <div id="method-c-info" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">info</span><span + class="method-args">(message)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="info-source"> + <pre><span class="ruby-comment"># File lib/gitlab/logger.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">info</span>(<span class="ruby-identifier">message</span>) + <span class="ruby-identifier">build</span>.<span class="ruby-identifier">info</span>(<span class="ruby-identifier">message</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- info-source --> + + </div> + + + + + </div><!-- info-method --> + + + <div id="method-c-read_latest" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">read_latest</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="read_latest-source"> + <pre><span class="ruby-comment"># File lib/gitlab/logger.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">read_latest</span> + <span class="ruby-identifier">path</span> = <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"log"</span>, <span class="ruby-identifier">file_name</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">build</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">path</span>) + <span class="ruby-identifier">logs</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">path</span>).<span class="ruby-identifier">split</span>(<span class="ruby-string">"\n"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- read_latest-source --> + + </div> + + + + + </div><!-- read_latest-method --> + + + </section><!-- public-class-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Markdown.html b/doc/app/Gitlab/Markdown.html new file mode 100644 index 00000000000..12691455600 --- /dev/null +++ b/doc/app/Gitlab/Markdown.html @@ -0,0 +1,580 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Gitlab::Markdown - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/markdown.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-gfm">#gfm</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Gitlab::Markdown</h1> + + <div id="description" class="description"> + +<p>Custom parser for GitLab-flavored <a href="Markdown.html">Markdown</a></p> + +<p>It replaces references in the text with links to the appropriate items in +GitLab.</p> + +<p>Supported reference formats are:</p> + +<pre>* @foo for team members +* #123 for issues +* !123 for merge requests +* $123 for snippets +* 123456 for commits</pre> + +<p>It also parses Emoji codes to insert images. See <a +href="http://www.emoji-cheat-sheet.com/">www.emoji-cheat-sheet.com/</a> for +a list of the supported icons.</p> + +<p>Examples</p> + +<pre class="ruby"><span class="ruby-operator">>></span> <span class="ruby-identifier">gfm</span>(<span class="ruby-string">"Hey @david, can you fix this?"</span>) +=<span class="ruby-operator">></span> <span class="ruby-string">"Hey <a href="</span><span class="ruby-operator">/</span><span class="ruby-identifier">gitlab</span><span class="ruby-operator">/</span><span class="ruby-identifier">team_members</span><span class="ruby-operator">/</span><span class="ruby-value">1</span><span class="ruby-string">">@david</a>, can you fix this?"</span> + +<span class="ruby-operator">>></span> <span class="ruby-identifier">gfm</span>(<span class="ruby-node">"Commit 35d5f7c closes #1234"</span>) +=<span class="ruby-operator">></span> <span class="ruby-string">"Commit <a href="</span><span class="ruby-operator">/</span><span class="ruby-identifier">gitlab</span><span class="ruby-operator">/</span><span class="ruby-identifier">commits</span><span class="ruby-operator">/</span><span class="ruby-value">35</span><span class="ruby-identifier">d5f7c</span><span class="ruby-string">">35d5f7c</a> closes <a href="</span><span class="ruby-operator">/</span><span class="ruby-identifier">gitlab</span><span class="ruby-operator">/</span><span class="ruby-identifier">issues</span><span class="ruby-operator">/</span><span class="ruby-value">1234</span><span class="ruby-node">">#1234</a>"</span> + +<span class="ruby-operator">>></span> <span class="ruby-identifier">gfm</span>(<span class="ruby-string">":trollface:"</span>) +=<span class="ruby-operator">></span> <span class="ruby-string">"<img alt=\":trollface:\" class=\"emoji\" src=\"/images/trollface.png"</span> <span class="ruby-identifier">title</span>=\<span class="ruby-string">":trollface:\" /> +</span></pre> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="EMOJI_PATTERN">EMOJI_PATTERN + + <dd class="description"> + + + <dt id="REFERENCE_PATTERN">REFERENCE_PATTERN + + <dd class="description"> + + + </dl> + </section> + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-html_options" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">html_options</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-gfm" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">gfm</span><span + class="method-args">(text, html_options = {})</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Public: Parse the provided text with GitLab-Flavored <a +href="Markdown.html">Markdown</a></p> + +<p>text - the source text <a +href="Markdown.html#attribute-i-html_options">#html_options</a> - extra +options for the reference links as given to link_to</p> + +<p>Note: reference links will only be generated if @project is set</p> + + + + <div class="method-source-code" id="gfm-source"> + <pre><span class="ruby-comment"># File lib/gitlab/markdown.rb, line 48</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">gfm</span>(<span class="ruby-identifier">text</span>, <span class="ruby-identifier">html_options</span> = {}) + <span class="ruby-keyword">return</span> <span class="ruby-identifier">text</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">text</span>.<span class="ruby-identifier">nil?</span> + + <span class="ruby-comment"># Duplicate the string so we don't alter the original, then call to_str</span> + <span class="ruby-comment"># to cast it back to a String instead of a SafeBuffer. This is required</span> + <span class="ruby-comment"># for gsub calls to work as we need them to.</span> + <span class="ruby-identifier">text</span> = <span class="ruby-identifier">text</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">to_str</span> + + <span class="ruby-ivar">@html_options</span> = <span class="ruby-identifier">html_options</span> + + <span class="ruby-comment"># Extract pre blocks so they are not altered</span> + <span class="ruby-comment"># from http://github.github.com/github-flavored-markdown/</span> + <span class="ruby-identifier">extractions</span> = {} + <span class="ruby-identifier">text</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r{<pre>.*?</pre>|<code>.*?</code>}</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">md5</span> = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">MD5</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">match</span>) + <span class="ruby-identifier">extractions</span>[<span class="ruby-identifier">md5</span>] = <span class="ruby-identifier">match</span> + <span class="ruby-node">"{gfm-extraction-#{md5}}"</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># TODO: add popups with additional information</span> + + <span class="ruby-identifier">text</span> = <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">text</span>) + + <span class="ruby-comment"># Insert pre block extractions</span> + <span class="ruby-identifier">text</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r\{gfm-extraction-(\h{32})\}/</span>) <span class="ruby-keyword">do</span> + <span class="ruby-identifier">extractions</span>[<span class="ruby-node">$1</span>] + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">sanitize</span> <span class="ruby-identifier">text</span>.<span class="ruby-identifier">html_safe</span>, <span class="ruby-identifier">attributes</span><span class="ruby-operator">:</span> <span class="ruby-constant">ActionView</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">sanitized_allowed_attributes</span> <span class="ruby-operator">+</span> <span class="ruby-node">%w(id class)</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- gfm-source --> + + </div> + + + + + </div><!-- gfm-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Merge.html b/doc/app/Gitlab/Merge.html new file mode 100644 index 00000000000..99a66cd53bb --- /dev/null +++ b/doc/app/Gitlab/Merge.html @@ -0,0 +1,628 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Merge - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/merge.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-can_be_merged-3F">#can_be_merged?</a> + + <li><a href="#method-i-merge-21">#merge!</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Merge</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-merge_request" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">merge_request</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-user" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">user</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(merge_request, user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/gitlab/merge.rb, line 5</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">merge_request</span>, <span class="ruby-identifier">user</span>) + <span class="ruby-ivar">@merge_request</span> = <span class="ruby-identifier">merge_request</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">project</span> + <span class="ruby-ivar">@user</span> = <span class="ruby-identifier">user</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-can_be_merged-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can_be_merged?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can_be_merged-3F-source"> + <pre><span class="ruby-comment"># File lib/gitlab/merge.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can_be_merged?</span> + <span class="ruby-identifier">in_locked_and_timed_satellite</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">merge_repo</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">merge_in_satellite!</span>(<span class="ruby-identifier">merge_repo</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- can_be_merged-3F-source --> + + </div> + + + + + </div><!-- can_be_merged-3F-method --> + + + <div id="method-i-merge-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Merges the source branch into the target branch in the satellite and pushes +it back to <a href="Gitolite.html">Gitolite</a>. It also removes the source +branch if requested in the merge request.</p> + +<p>Returns false if the merge produced conflicts Returns false if pushing from +the satallite to <a href="Gitolite.html">Gitolite</a> failed or was +rejected Returns true otherwise</p> + + + + <div class="method-source-code" id="merge-21-source"> + <pre><span class="ruby-comment"># File lib/gitlab/merge.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge!</span> + <span class="ruby-identifier">in_locked_and_timed_satellite</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">merge_repo</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">merge_in_satellite!</span>(<span class="ruby-identifier">merge_repo</span>) + <span class="ruby-comment"># push merge back to Gitolite</span> + <span class="ruby-comment"># will raise CommandFailed when push fails</span> + <span class="ruby-identifier">merge_repo</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">push</span>({<span class="ruby-identifier">raise</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>}, <span class="ruby-value">:origin</span>, <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">target_branch</span>) + + <span class="ruby-comment"># remove source branch</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">should_remove_source_branch</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">project</span>.<span class="ruby-identifier">root_ref?</span>(<span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">source_branch</span>) + <span class="ruby-comment"># will raise CommandFailed when push fails</span> + <span class="ruby-identifier">merge_repo</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">push</span>({<span class="ruby-identifier">raise</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>}, <span class="ruby-value">:origin</span>, <span class="ruby-node">":#{merge_request.source_branch}"</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># merge, push and branch removal successful</span> + <span class="ruby-keyword">true</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">CommandFailed</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- merge-21-source --> + + </div> + + + + + </div><!-- merge-21-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Milestones.html b/doc/app/Gitlab/Milestones.html new file mode 100644 index 00000000000..aac605b2896 --- /dev/null +++ b/doc/app/Gitlab/Milestones.html @@ -0,0 +1,441 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Milestones - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/milestones.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::API + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Milestones</h1> + + <div id="description" class="description"> + +<p><a href="Milestones.html">Milestones</a> <a href="API.html">API</a></p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Projects.html b/doc/app/Gitlab/Projects.html new file mode 100644 index 00000000000..a44cba3c7c6 --- /dev/null +++ b/doc/app/Gitlab/Projects.html @@ -0,0 +1,441 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Projects - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/projects.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::API + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Projects</h1> + + <div id="description" class="description"> + +<p><a href="Projects.html">Projects</a> <a href="API.html">API</a></p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Satellite.html b/doc/app/Gitlab/Satellite.html new file mode 100644 index 00000000000..4615d1c67c2 --- /dev/null +++ b/doc/app/Gitlab/Satellite.html @@ -0,0 +1,664 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Satellite - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/satellite.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-clear">#clear</a> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-exists-3F">#exists?</a> + + <li><a href="#method-i-path">#path</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Satellite</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="PARKING_BRANCH">PARKING_BRANCH + + <dd class="description"> + + + </dl> + </section> + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/gitlab/satellite.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span> <span class="ruby-identifier">project</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span> = <span class="ruby-identifier">project</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-clear" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">clear</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>will be deleted all branches except <a +href="Satellite.html#PARKING_BRANCH">PARKING_BRANCH</a></p> + + + + <div class="method-source-code" id="clear-source"> + <pre><span class="ruby-comment"># File lib/gitlab/satellite.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">clear</span> + <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">chdir</span>(<span class="ruby-identifier">path</span>) <span class="ruby-keyword">do</span> + <span class="ruby-identifier">heads</span> = <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Repo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">"."</span>).<span class="ruby-identifier">heads</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">head</span><span class="ruby-operator">|</span> <span class="ruby-identifier">head</span>.<span class="ruby-identifier">name</span>} + <span class="ruby-keyword">if</span> <span class="ruby-identifier">heads</span>.<span class="ruby-identifier">include?</span> <span class="ruby-constant">PARKING_BRANCH</span> + <span class="ruby-node">%xgit checkout #{PARKING_BRANCH}`</span> + <span class="ruby-keyword">else</span> + <span class="ruby-node">%xgit checkout -b #{PARKING_BRANCH}`</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">heads</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-constant">PARKING_BRANCH</span>) + <span class="ruby-identifier">heads</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">head</span><span class="ruby-operator">|</span> + <span class="ruby-node">%xgit branch -D #{head}`</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- clear-source --> + + </div> + + + + + </div><!-- clear-method --> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File lib/gitlab/satellite.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-node">%xgit clone #{project.url_to_repo} #{path}`</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-exists-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">exists?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="exists-3F-source"> + <pre><span class="ruby-comment"># File lib/gitlab/satellite.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">exists?</span> + <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span> <span class="ruby-identifier">path</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- exists-3F-source --> + + </div> + + + + + </div><!-- exists-3F-method --> + + + <div id="method-i-path" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">path</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="path-source"> + <pre><span class="ruby-comment"># File lib/gitlab/satellite.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">path</span> + <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"tmp"</span>, <span class="ruby-string">"repo_satellites"</span>, <span class="ruby-identifier">project</span>.<span class="ruby-identifier">path</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- path-source --> + + </div> + + + + + </div><!-- path-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Session.html b/doc/app/Gitlab/Session.html new file mode 100644 index 00000000000..12f3433ebfd --- /dev/null +++ b/doc/app/Gitlab/Session.html @@ -0,0 +1,441 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Session - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/session.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::API + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Session</h1> + + <div id="description" class="description"> + +<p><a href="Users.html">Users</a> <a href="API.html">API</a></p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Theme.html b/doc/app/Gitlab/Theme.html new file mode 100644 index 00000000000..00b3e5f6b62 --- /dev/null +++ b/doc/app/Gitlab/Theme.html @@ -0,0 +1,493 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Theme - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/theme.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-css_class_by_id">::css_class_by_id</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Theme</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-css_class_by_id" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">css_class_by_id</span><span + class="method-args">(id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="css_class_by_id-source"> + <pre><span class="ruby-comment"># File lib/gitlab/theme.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">css_class_by_id</span>(<span class="ruby-identifier">id</span>) + <span class="ruby-identifier">themes</span> = { + <span class="ruby-value">1</span> =<span class="ruby-operator">></span> <span class="ruby-string">"ui_basic"</span>, + <span class="ruby-value">2</span> =<span class="ruby-operator">></span> <span class="ruby-string">"ui_mars"</span>, + <span class="ruby-value">3</span> =<span class="ruby-operator">></span> <span class="ruby-string">"ui_modern"</span> + } + + <span class="ruby-identifier">id</span> <span class="ruby-operator">||=</span> <span class="ruby-value">1</span> + + <span class="ruby-keyword">return</span> <span class="ruby-identifier">themes</span>[<span class="ruby-identifier">id</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- css_class_by_id-source --> + + </div> + + + + + </div><!-- css_class_by_id-method --> + + + </section><!-- public-class-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Gitlab/Users.html b/doc/app/Gitlab/Users.html new file mode 100644 index 00000000000..c9712874c65 --- /dev/null +++ b/doc/app/Gitlab/Users.html @@ -0,0 +1,441 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Gitlab::Users - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/api/users.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Grape::API + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Gitlab::Users</h1> + + <div id="description" class="description"> + +<p><a href="Users.html">Users</a> <a href="API.html">API</a></p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/GitlabMarkdownHelper.html b/doc/app/GitlabMarkdownHelper.html new file mode 100644 index 00000000000..6bf172ac8f8 --- /dev/null +++ b/doc/app/GitlabMarkdownHelper.html @@ -0,0 +1,559 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module GitlabMarkdownHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/gitlab_markdown_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="Gitlab/Markdown.html">Gitlab::Markdown</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-link_to_gfm">#link_to_gfm</a> + + <li><a href="#method-i-markdown">#markdown</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module GitlabMarkdownHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-link_to_gfm" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_gfm</span><span + class="method-args">(body, url, html_options = {})</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Use this in places where you would normally use link_to(gfm(…), …).</p> + +<p>It solves a problem occurring with nested links (i.e. “<a>outer text +<a>gfm ref</a> more outer text</a>”). This will not be +interpreted as intended. Browsers will parse something like “<a>outer +text </a><a>gfm ref</a> more outer text” (notice the last +part is not linked any more). <a +href="GitlabMarkdownHelper.html#method-i-link_to_gfm">#link_to_gfm</a> +corrects that. It wraps all parts to explicitly produce the correct linking +behavior (i.e. “<a>outer text </a><a>gfm +ref</a><a> more outer text</a>”).</p> + + + + <div class="method-source-code" id="link_to_gfm-source"> + <pre><span class="ruby-comment"># File app/helpers/gitlab_markdown_helper.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_gfm</span>(<span class="ruby-identifier">body</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">html_options</span> = {}) + <span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">body</span>.<span class="ruby-identifier">blank?</span> + + <span class="ruby-identifier">gfm_body</span> = <span class="ruby-identifier">gfm</span>(<span class="ruby-identifier">escape_once</span>(<span class="ruby-identifier">body</span>), <span class="ruby-identifier">html_options</span>) + + <span class="ruby-identifier">gfm_body</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp">%r{<a.*?>.*?</a>}</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">match</span><span class="ruby-operator">|</span> + <span class="ruby-node">"</a>#{match}#{link_to("", url, html_options)[0..-5]}"</span> <span class="ruby-comment"># "</a>".length +1</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">link_to</span>(<span class="ruby-identifier">gfm_body</span>.<span class="ruby-identifier">html_safe</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">html_options</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_gfm-source --> + + </div> + + + + + </div><!-- link_to_gfm-method --> + + + <div id="method-i-markdown" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">markdown</span><span + class="method-args">(text)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="markdown-source"> + <pre><span class="ruby-comment"># File app/helpers/gitlab_markdown_helper.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">markdown</span>(<span class="ruby-identifier">text</span>) + <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@markdown</span> + <span class="ruby-identifier">gitlab_renderer</span> = <span class="ruby-constant">Redcarpet</span><span class="ruby-operator">::</span><span class="ruby-constant">Render</span><span class="ruby-operator">::</span><span class="ruby-constant">GitlabHTML</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, + <span class="ruby-comment"># see https://github.com/vmg/redcarpet#darling-i-packed-you-a-couple-renderers-for-lunch-</span> + <span class="ruby-identifier">filter_html</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">with_toc_data</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">hard_wrap</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>) + <span class="ruby-ivar">@markdown</span> = <span class="ruby-constant">Redcarpet</span><span class="ruby-operator">::</span><span class="ruby-constant">Markdown</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">gitlab_renderer</span>, + <span class="ruby-comment"># see https://github.com/vmg/redcarpet#and-its-like-really-simple-to-use</span> + <span class="ruby-identifier">no_intra_emphasis</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">tables</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">fenced_code_blocks</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">autolink</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">strikethrough</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">lax_html_blocks</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">space_after_headers</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>, + <span class="ruby-identifier">superscript</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@markdown</span>.<span class="ruby-identifier">render</span>(<span class="ruby-identifier">text</span>).<span class="ruby-identifier">html_safe</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- markdown-source --> + + </div> + + + + + </div><!-- markdown-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Grack.html b/doc/app/Grack.html new file mode 100644 index 00000000000..e3c5bbd482e --- /dev/null +++ b/doc/app/Grack.html @@ -0,0 +1,433 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Grack - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/backend/grack_auth.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Grack</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Grack/Auth.html b/doc/app/Grack/Auth.html new file mode 100644 index 00000000000..5da483f791a --- /dev/null +++ b/doc/app/Grack/Auth.html @@ -0,0 +1,734 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Grack::Auth - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/gitlab/backend/grack_auth.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Rack::Auth::Basic + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-abilities">#abilities</a> + + <li><a href="#method-i-can-3F">#can?</a> + + <li><a href="#method-i-current_ref">#current_ref</a> + + <li><a href="#method-i-valid-3F">#valid?</a> + + <li><a href="#method-i-validate_get_request">#validate_get_request</a> + + <li><a href="#method-i-validate_post_request">#validate_post_request</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Grack::Auth</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-user" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">user</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-can-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can?</span><span + class="method-args">(object, action, subject)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can-3F-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/grack_auth.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span>) + <span class="ruby-identifier">abilities</span>.<span class="ruby-identifier">allowed?</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">subject</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- can-3F-source --> + + </div> + + + + + </div><!-- can-3F-method --> + + + <div id="method-i-current_ref" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">current_ref</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="current_ref-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/grack_auth.rb, line 60</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">current_ref</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@env</span>[<span class="ruby-string">"HTTP_CONTENT_ENCODING"</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">%rgzip/</span> + <span class="ruby-identifier">input</span> = <span class="ruby-constant">Zlib</span><span class="ruby-operator">::</span><span class="ruby-constant">GzipReader</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">body</span>).<span class="ruby-identifier">read</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">input</span> = <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">read</span> + <span class="ruby-keyword">end</span> + <span class="ruby-comment"># Need to reset seek point</span> + <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">body</span>.<span class="ruby-identifier">rewind</span> + <span class="ruby-regexp">%rrefs\/heads\/([\w-]+)/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">input</span>).<span class="ruby-identifier">to_a</span>.<span class="ruby-identifier">first</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- current_ref-source --> + + </div> + + + + + </div><!-- current_ref-method --> + + + <div id="method-i-valid-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">valid?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="valid-3F-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/grack_auth.rb, line 5</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">valid?</span> + <span class="ruby-comment"># Authentication with username and password</span> + <span class="ruby-identifier">email</span>, <span class="ruby-identifier">password</span> = <span class="ruby-ivar">@auth</span>.<span class="ruby-identifier">credentials</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">email</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">try</span>(<span class="ruby-value">:valid_password?</span>, <span class="ruby-identifier">password</span>) + + <span class="ruby-comment"># Set GL_USER env variable</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'GL_USER'</span>] = <span class="ruby-identifier">email</span> + <span class="ruby-comment"># Pass Gitolite update hook</span> + <span class="ruby-constant">ENV</span>[<span class="ruby-string">'GL_BYPASS_UPDATE_HOOK'</span>] = <span class="ruby-string">"true"</span> + + <span class="ruby-comment"># Need this patch due to the rails mount</span> + <span class="ruby-ivar">@env</span>[<span class="ruby-string">'PATH_INFO'</span>] = <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">path</span> + <span class="ruby-ivar">@env</span>[<span class="ruby-string">'SCRIPT_NAME'</span>] = <span class="ruby-string">""</span> + + <span class="ruby-comment"># Find project by PATH_INFO from env</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">m</span> = <span class="ruby-regexp">%r^\/([\w-]+).git/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-ivar">@request</span>.<span class="ruby-identifier">path_info</span>).<span class="ruby-identifier">to_a</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">find_by_path</span>(<span class="ruby-identifier">m</span>.<span class="ruby-identifier">last</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">project</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># Git upload and receive</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">get?</span> + <span class="ruby-identifier">validate_get_request</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">post?</span> + <span class="ruby-identifier">validate_post_request</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">false</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- valid-3F-source --> + + </div> + + + + + </div><!-- valid-3F-method --> + + + <div id="method-i-validate_get_request" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">validate_get_request</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="validate_get_request-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/grack_auth.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_get_request</span> + <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- validate_get_request-source --> + + </div> + + + + + </div><!-- validate_get_request-method --> + + + <div id="method-i-validate_post_request" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">validate_post_request</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="validate_post_request-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/grack_auth.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_post_request</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">path_info</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">'git-upload-pack'</span>) + <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">user</span>, <span class="ruby-value">:push_code</span>, <span class="ruby-identifier">project</span>) + <span class="ruby-keyword">elsif</span> <span class="ruby-ivar">@request</span>.<span class="ruby-identifier">path_info</span>.<span class="ruby-identifier">end_with?</span>(<span class="ruby-string">'git-receive-pack'</span>) + <span class="ruby-identifier">action</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">protected_branch?</span>(<span class="ruby-identifier">current_ref</span>) + <span class="ruby-value">:push_code_to_protected_branches</span> + <span class="ruby-keyword">else</span> + <span class="ruby-value">:push_code</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">action</span>, <span class="ruby-identifier">project</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">false</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- validate_post_request-source --> + + </div> + + + + + </div><!-- validate_post_request-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-abilities" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">abilities</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="abilities-source"> + <pre><span class="ruby-comment"># File lib/gitlab/backend/grack_auth.rb, line 73</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">abilities</span> + <span class="ruby-ivar">@abilities</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span> + <span class="ruby-identifier">abilities</span> = <span class="ruby-constant">Six</span>.<span class="ruby-identifier">new</span> + <span class="ruby-identifier">abilities</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Ability</span> + <span class="ruby-identifier">abilities</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- abilities-source --> + + </div> + + + + + </div><!-- abilities-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Group.html b/doc/app/Group.html new file mode 100644 index 00000000000..a23e1da6788 --- /dev/null +++ b/doc/app/Group.html @@ -0,0 +1,555 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Group - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/group.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-search">::search</a> + + <li><a href="#method-i-to_param">#to_param</a> + + <li><a href="#method-i-users">#users</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Group</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-search" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">search</span><span + class="method-args">(query)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="search-source"> + <pre><span class="ruby-comment"># File app/models/group.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">search</span> <span class="ruby-identifier">query</span> + <span class="ruby-identifier">where</span>(<span class="ruby-string">"name LIKE :query OR code LIKE :query"</span>, <span class="ruby-identifier">query</span><span class="ruby-operator">:</span> <span class="ruby-node">"%#{query}%"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- search-source --> + + </div> + + + + + </div><!-- search-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-to_param" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_param</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="to_param-source"> + <pre><span class="ruby-comment"># File app/models/group.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_param</span> + <span class="ruby-identifier">code</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_param-source --> + + </div> + + + + + </div><!-- to_param-method --> + + + <div id="method-i-users" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">users</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="users-source"> + <pre><span class="ruby-comment"># File app/models/group.rb, line 21</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">users</span> + <span class="ruby-constant">User</span>.<span class="ruby-identifier">joins</span>(<span class="ruby-value">:users_projects</span>).<span class="ruby-identifier">where</span>(<span class="ruby-identifier">users_projects</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_ids</span>}).<span class="ruby-identifier">uniq</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- users-source --> + + </div> + + + + + </div><!-- users-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/GroupsController.html b/doc/app/GroupsController.html new file mode 100644 index 00000000000..72e1022cc06 --- /dev/null +++ b/doc/app/GroupsController.html @@ -0,0 +1,735 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class GroupsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/groups_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-group">#group</a> + + <li><a href="#method-i-issues">#issues</a> + + <li><a href="#method-i-merge_requests">#merge_requests</a> + + <li><a href="#method-i-people">#people</a> + + <li><a href="#method-i-project_ids">#project_ids</a> + + <li><a href="#method-i-projects">#projects</a> + + <li><a href="#method-i-search">#search</a> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class GroupsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-issues" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issues</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Get only assigned issues</p> + + + + <div class="method-source-code" id="issues-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issues</span> + <span class="ruby-ivar">@user</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">assigned_issues</span>.<span class="ruby-identifier">opened</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">of_group</span>(<span class="ruby-ivar">@group</span>).<span class="ruby-identifier">recent</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">includes</span>(<span class="ruby-value">:author</span>, <span class="ruby-value">:project</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">atom</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- issues-source --> + + </div> + + + + + </div><!-- issues-method --> + + + <div id="method-i-merge_requests" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge_requests</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Get authored or assigned open merge requests</p> + + + + <div class="method-source-code" id="merge_requests-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_requests</span> + <span class="ruby-ivar">@merge_requests</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">cared_merge_requests</span> + <span class="ruby-ivar">@merge_requests</span> = <span class="ruby-ivar">@merge_requests</span>.<span class="ruby-identifier">of_group</span>(<span class="ruby-ivar">@group</span>).<span class="ruby-identifier">recent</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- merge_requests-source --> + + </div> + + + + + </div><!-- merge_requests-method --> + + + <div id="method-i-people" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">people</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="people-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 46</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">people</span> + <span class="ruby-ivar">@users</span> = <span class="ruby-identifier">group</span>.<span class="ruby-identifier">users</span>.<span class="ruby-identifier">all</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- people-source --> + + </div> + + + + + </div><!-- people-method --> + + + <div id="method-i-search" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">search</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="search-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 38</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">search</span> + <span class="ruby-identifier">result</span> = <span class="ruby-constant">SearchContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project_ids</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> + + <span class="ruby-ivar">@projects</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:projects</span>] + <span class="ruby-ivar">@merge_requests</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:merge_requests</span>] + <span class="ruby-ivar">@issues</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:issues</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- search-source --> + + </div> + + + + + </div><!-- search-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@events</span> = <span class="ruby-constant">Event</span>.<span class="ruby-identifier">in_projects</span>(<span class="ruby-identifier">project_ids</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">20</span>).<span class="ruby-identifier">offset</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:offset</span>] <span class="ruby-operator">||</span> <span class="ruby-value">0</span>) + <span class="ruby-ivar">@last_push</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">recent_push</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">atom</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-group" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">group</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="group-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">group</span> + <span class="ruby-ivar">@group</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Group</span>.<span class="ruby-identifier">find_by_code</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- group-source --> + + </div> + + + + + </div><!-- group-method --> + + + <div id="method-i-project_ids" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_ids</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_ids-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 60</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_ids</span> + <span class="ruby-identifier">projects</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:id</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- project_ids-source --> + + </div> + + + + + </div><!-- project_ids-method --> + + + <div id="method-i-projects" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">projects</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="projects-source"> + <pre><span class="ruby-comment"># File app/controllers/groups_controller.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">projects</span> + <span class="ruby-ivar">@projects</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">projects_with_events</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">group_id</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@group</span>.<span class="ruby-identifier">id</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- projects-source --> + + </div> + + + + + </div><!-- projects-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/HelpController.html b/doc/app/HelpController.html new file mode 100644 index 00000000000..afbbeb0bfc3 --- /dev/null +++ b/doc/app/HelpController.html @@ -0,0 +1,484 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class HelpController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/help_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-index">#index</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class HelpController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/help_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/HooksController.html b/doc/app/HooksController.html new file mode 100644 index 00000000000..70fd89c3317 --- /dev/null +++ b/doc/app/HooksController.html @@ -0,0 +1,595 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class HooksController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/hooks_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-test">#test</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class HooksController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/hooks_controller.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@hook</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:hook</span>]) + <span class="ruby-ivar">@hook</span>.<span class="ruby-identifier">save</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@hook</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_hooks_path</span>(<span class="ruby-ivar">@project</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@hooks</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">all</span> + <span class="ruby-identifier">render</span> <span class="ruby-value">:index</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/hooks_controller.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@hook</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@hook</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_hooks_path</span>(<span class="ruby-ivar">@project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/hooks_controller.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@hooks</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">all</span> + <span class="ruby-ivar">@hook</span> = <span class="ruby-constant">ProjectHook</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-test" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">test</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="test-source"> + <pre><span class="ruby-comment"># File app/controllers/hooks_controller.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">test</span> + <span class="ruby-constant">TestHookContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- test-source --> + + </div> + + + + + </div><!-- test-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Issue.html b/doc/app/Issue.html new file mode 100644 index 00000000000..e8a7881c484 --- /dev/null +++ b/doc/app/Issue.html @@ -0,0 +1,501 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Issue - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/issue.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="IssueCommonality.html">IssueCommonality</a> + + + + <li><a class="include" href="Votes.html">Votes</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-open_for">::open_for</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Issue</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-open_for" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">open_for</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="open_for-source"> + <pre><span class="ruby-comment"># File app/models/issue.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">open_for</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-identifier">opened</span>.<span class="ruby-identifier">assigned</span>(<span class="ruby-identifier">user</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- open_for-source --> + + </div> + + + + + </div><!-- open_for-method --> + + + </section><!-- public-class-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/IssueCommonality.html b/doc/app/IssueCommonality.html new file mode 100644 index 00000000000..336580d8f9b --- /dev/null +++ b/doc/app/IssueCommonality.html @@ -0,0 +1,641 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module IssueCommonality - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/issue_commonality.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-is_assigned-3F">#is_assigned?</a> + + <li><a href="#method-i-is_being_closed-3F">#is_being_closed?</a> + + <li><a href="#method-i-is_being_reassigned-3F">#is_being_reassigned?</a> + + <li><a href="#method-i-is_being_reopened-3F">#is_being_reopened?</a> + + <li><a href="#method-i-new-3F">#new?</a> + + <li><a href="#method-i-today-3F">#today?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module IssueCommonality</h1> + + <div id="description" class="description"> + +<p>Contains common functionality shared between Issues and MergeRequests</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-is_assigned-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_assigned?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="is_assigned-3F-source"> + <pre><span class="ruby-comment"># File app/roles/issue_commonality.rb, line 50</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_assigned?</span> + <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">assignee_id</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- is_assigned-3F-source --> + + </div> + + + + + </div><!-- is_assigned-3F-method --> + + + <div id="method-i-is_being_closed-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_being_closed?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="is_being_closed-3F-source"> + <pre><span class="ruby-comment"># File app/roles/issue_commonality.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_being_closed?</span> + <span class="ruby-identifier">closed_changed?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">closed</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- is_being_closed-3F-source --> + + </div> + + + + + </div><!-- is_being_closed-3F-method --> + + + <div id="method-i-is_being_reassigned-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_being_reassigned?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="is_being_reassigned-3F-source"> + <pre><span class="ruby-comment"># File app/roles/issue_commonality.rb, line 54</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_being_reassigned?</span> + <span class="ruby-identifier">assignee_id_changed?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- is_being_reassigned-3F-source --> + + </div> + + + + + </div><!-- is_being_reassigned-3F-method --> + + + <div id="method-i-is_being_reopened-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_being_reopened?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="is_being_reopened-3F-source"> + <pre><span class="ruby-comment"># File app/roles/issue_commonality.rb, line 62</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_being_reopened?</span> + <span class="ruby-identifier">closed_changed?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">closed</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- is_being_reopened-3F-source --> + + </div> + + + + + </div><!-- is_being_reopened-3F-method --> + + + <div id="method-i-new-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-3F-source"> + <pre><span class="ruby-comment"># File app/roles/issue_commonality.rb, line 46</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new?</span> + <span class="ruby-identifier">today?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">created_at</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">updated_at</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-3F-source --> + + </div> + + + + + </div><!-- new-3F-method --> + + + <div id="method-i-today-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">today?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="today-3F-source"> + <pre><span class="ruby-comment"># File app/roles/issue_commonality.rb, line 42</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">today?</span> + <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">created_at</span>.<span class="ruby-identifier">to_date</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- today-3F-source --> + + </div> + + + + + </div><!-- today-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/IssueCommonality/ClassMethods.html b/doc/app/IssueCommonality/ClassMethods.html new file mode 100644 index 00000000000..d4ab179d07c --- /dev/null +++ b/doc/app/IssueCommonality/ClassMethods.html @@ -0,0 +1,479 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module IssueCommonality::ClassMethods - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/issue_commonality.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-search">#search</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module IssueCommonality::ClassMethods</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-search" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">search</span><span + class="method-args">(query)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="search-source"> + <pre><span class="ruby-comment"># File app/roles/issue_commonality.rb, line 37</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">search</span>(<span class="ruby-identifier">query</span>) + <span class="ruby-identifier">where</span>(<span class="ruby-string">"title like :query"</span>, <span class="ruby-identifier">query</span><span class="ruby-operator">:</span> <span class="ruby-node">"%#{query}%"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- search-source --> + + </div> + + + + + </div><!-- search-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/IssueObserver.html b/doc/app/IssueObserver.html new file mode 100644 index 00000000000..7f16a8653f5 --- /dev/null +++ b/doc/app/IssueObserver.html @@ -0,0 +1,571 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class IssueObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/issue_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-after_update">#after_update</a> + + <li><a href="#method-i-send_reassigned_email">#send_reassigned_email</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class IssueObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(issue)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/issue_observer.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span>(<span class="ruby-identifier">issue</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">current_user</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">new_issue_email</span>(<span class="ruby-identifier">issue</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">deliver</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + <div id="method-i-after_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_update</span><span + class="method-args">(issue)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_update-source"> + <pre><span class="ruby-comment"># File app/observers/issue_observer.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_update</span>(<span class="ruby-identifier">issue</span>) + <span class="ruby-identifier">send_reassigned_email</span>(<span class="ruby-identifier">issue</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">is_being_reassigned?</span> + + <span class="ruby-identifier">status</span> = <span class="ruby-keyword">nil</span> + <span class="ruby-identifier">status</span> = <span class="ruby-string">'closed'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">is_being_closed?</span> + <span class="ruby-identifier">status</span> = <span class="ruby-string">'reopened'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">is_being_reopened?</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span> + <span class="ruby-constant">Note</span>.<span class="ruby-identifier">create_status_change_note</span>(<span class="ruby-identifier">issue</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">status</span>) + [<span class="ruby-identifier">issue</span>.<span class="ruby-identifier">author</span>, <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee</span>].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">recipient</span><span class="ruby-operator">|</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">issue_status_changed_email</span>(<span class="ruby-identifier">recipient</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">current_user</span>) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_update-source --> + + </div> + + + + + </div><!-- after_update-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-send_reassigned_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">send_reassigned_email</span><span + class="method-args">(issue)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="send_reassigned_email-source"> + <pre><span class="ruby-comment"># File app/observers/issue_observer.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_reassigned_email</span>(<span class="ruby-identifier">issue</span>) + <span class="ruby-identifier">recipient_ids</span> = [<span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee_id</span>, <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee_id_was</span>].<span class="ruby-identifier">keep_if</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">id</span><span class="ruby-operator">|</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">id</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">id</span> } + + <span class="ruby-identifier">recipient_ids</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">recipient_id</span><span class="ruby-operator">|</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">reassigned_issue_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee_id_was</span>).<span class="ruby-identifier">deliver</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- send_reassigned_email-source --> + + </div> + + + + + </div><!-- send_reassigned_email-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/IssuesBulkUpdateContext.html b/doc/app/IssuesBulkUpdateContext.html new file mode 100644 index 00000000000..1d87a757917 --- /dev/null +++ b/doc/app/IssuesBulkUpdateContext.html @@ -0,0 +1,503 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class IssuesBulkUpdateContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/issues_bulk_update_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="BaseContext.html">BaseContext</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class IssuesBulkUpdateContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/issues_bulk_update_context.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-identifier">update_data</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:update</span>] + + <span class="ruby-identifier">issues_ids</span> = <span class="ruby-identifier">update_data</span>[<span class="ruby-value">:issues_ids</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">","</span>) + <span class="ruby-identifier">milestone_id</span> = <span class="ruby-identifier">update_data</span>[<span class="ruby-value">:milestone_id</span>] + <span class="ruby-identifier">assignee_id</span> = <span class="ruby-identifier">update_data</span>[<span class="ruby-value">:assignee_id</span>] + <span class="ruby-identifier">status</span> = <span class="ruby-identifier">update_data</span>[<span class="ruby-value">:status</span>] + + <span class="ruby-identifier">opts</span> = {} + <span class="ruby-identifier">opts</span>[<span class="ruby-value">:milestone_id</span>] = <span class="ruby-identifier">milestone_id</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">milestone_id</span>.<span class="ruby-identifier">present?</span> + <span class="ruby-identifier">opts</span>[<span class="ruby-value">:assignee_id</span>] = <span class="ruby-identifier">assignee_id</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">assignee_id</span>.<span class="ruby-identifier">present?</span> + <span class="ruby-identifier">opts</span>[<span class="ruby-value">:closed</span>] = (<span class="ruby-identifier">status</span> <span class="ruby-operator">==</span> <span class="ruby-string">"closed"</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span>.<span class="ruby-identifier">present?</span> + + <span class="ruby-identifier">issues</span> = <span class="ruby-constant">Issue</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">issues_ids</span>).<span class="ruby-identifier">all</span> + <span class="ruby-identifier">issues</span> = <span class="ruby-identifier">issues</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">issue</span><span class="ruby-operator">|</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:modify_issue</span>, <span class="ruby-identifier">issue</span>) } + <span class="ruby-identifier">issues</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">issue</span><span class="ruby-operator">|</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">opts</span>) } + { + <span class="ruby-identifier">count</span><span class="ruby-operator">:</span> <span class="ruby-identifier">issues</span>.<span class="ruby-identifier">count</span>, + <span class="ruby-identifier">success</span><span class="ruby-operator">:</span> <span class="ruby-operator">!</span><span class="ruby-identifier">issues</span>.<span class="ruby-identifier">count</span>.<span class="ruby-identifier">zero?</span> + } +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/IssuesController.html b/doc/app/IssuesController.html new file mode 100644 index 00000000000..6b3edbb6354 --- /dev/null +++ b/doc/app/IssuesController.html @@ -0,0 +1,996 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class IssuesController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/issues_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-authorize_admin_issue-21">#authorize_admin_issue!</a> + + <li><a href="#method-i-authorize_modify_issue-21">#authorize_modify_issue!</a> + + <li><a href="#method-i-bulk_update">#bulk_update</a> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-issue">#issue</a> + + <li><a href="#method-i-issues_filtered">#issues_filtered</a> + + <li><a href="#method-i-module_enabled">#module_enabled</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-search">#search</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-sort">#sort</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class IssuesController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-bulk_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">bulk_update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="bulk_update-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 111</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">bulk_update</span> + <span class="ruby-identifier">result</span> = <span class="ruby-constant">IssuesBulkUpdateContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{result[:count]} issues updated"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- bulk_update-source --> + + </div> + + + + + </div><!-- bulk_update-method --> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 48</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@issue</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:issue</span>]) + <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">author</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">save</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_issue_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@issue</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-value">:new</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 80</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_issues_path</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@issue</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 19</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-identifier">issues_filtered</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-comment"># index.html.erb</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">atom</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">layout</span><span class="ruby-operator">:</span> <span class="ruby-keyword">false</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 30</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@issue</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:issue</span>]) + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@issue</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-search" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">search</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="search-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 101</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">search</span> + <span class="ruby-identifier">terms</span> = <span class="ruby-identifier">params</span>[<span class="ruby-string">'terms'</span>] + + <span class="ruby-ivar">@issues</span> = <span class="ruby-identifier">issues_filtered</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"title LIKE ?"</span>, <span class="ruby-node">"%#{terms}%"</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">terms</span>.<span class="ruby-identifier">blank?</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">100</span>) + + <span class="ruby-identifier">render</span> <span class="ruby-identifier">partial</span><span class="ruby-operator">:</span> <span class="ruby-string">'issues'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- search-source --> + + </div> + + + + + </div><!-- search-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 39</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@note</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">noteable</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@issue</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-sort" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">sort</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="sort-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 89</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">sort</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_issue</span>, <span class="ruby-ivar">@project</span>) + + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'issue'</span>]) + <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">issue</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">position</span> = <span class="ruby-identifier">params</span>[<span class="ruby-string">'issue'</span>].<span class="ruby-identifier">index</span>(<span class="ruby-identifier">issue</span>.<span class="ruby-identifier">id</span>.<span class="ruby-identifier">to_s</span>) <span class="ruby-operator">+</span> <span class="ruby-value">1</span> + <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">save</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- sort-source --> + + </div> + + + + + </div><!-- sort-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:issue</span>].<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">author_id_of_changes</span><span class="ruby-operator">:</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">id</span>)) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@issue</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-value">:edit</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-authorize_admin_issue-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_admin_issue!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_admin_issue-21-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 126</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_admin_issue!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_issue</span>, <span class="ruby-ivar">@issue</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_admin_issue-21-source --> + + </div> + + + + + </div><!-- authorize_admin_issue-21-method --> + + + <div id="method-i-authorize_modify_issue-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_modify_issue!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_modify_issue-21-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 122</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_modify_issue!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:modify_issue</span>, <span class="ruby-ivar">@issue</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_modify_issue-21-source --> + + </div> + + + + + </div><!-- authorize_modify_issue-21-method --> + + + <div id="method-i-issue" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issue</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issue-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 118</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issue</span> + <span class="ruby-ivar">@issue</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- issue-source --> + + </div> + + + + + </div><!-- issue-method --> + + + <div id="method-i-issues_filtered" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issues_filtered</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issues_filtered-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 134</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issues_filtered</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-constant">IssuesListContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- issues_filtered-source --> + + </div> + + + + + </div><!-- issues_filtered-method --> + + + <div id="method-i-module_enabled" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">module_enabled</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="module_enabled-source"> + <pre><span class="ruby-comment"># File app/controllers/issues_controller.rb, line 130</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">module_enabled</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues_enabled</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- module_enabled-source --> + + </div> + + + + + </div><!-- module_enabled-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/IssuesHelper.html b/doc/app/IssuesHelper.html new file mode 100644 index 00000000000..d58a5f7f1a5 --- /dev/null +++ b/doc/app/IssuesHelper.html @@ -0,0 +1,698 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module IssuesHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/issues_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-issue_css_classes">#issue_css_classes</a> + + <li><a href="#method-i-issue_tags">#issue_tags</a> + + <li><a href="#method-i-issues_filter">#issues_filter</a> + + <li><a href="#method-i-link_to_issue_assignee">#link_to_issue_assignee</a> + + <li><a href="#method-i-link_to_issue_author">#link_to_issue_author</a> + + <li><a href="#method-i-project_issues_filter_path">#project_issues_filter_path</a> + + <li><a href="#method-i-unassigned_filter">#unassigned_filter</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module IssuesHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-issue_css_classes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issue_css_classes</span><span + class="method-args">(issue)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issue_css_classes-source"> + <pre><span class="ruby-comment"># File app/helpers/issues_helper.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issue_css_classes</span> <span class="ruby-identifier">issue</span> + <span class="ruby-identifier">classes</span> = <span class="ruby-string">"issue"</span> + <span class="ruby-identifier">classes</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" closed"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">closed</span> + <span class="ruby-identifier">classes</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" today"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">today?</span> + <span class="ruby-identifier">classes</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- issue_css_classes-source --> + + </div> + + + + + </div><!-- issue_css_classes-method --> + + + <div id="method-i-issue_tags" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issue_tags</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issue_tags-source"> + <pre><span class="ruby-comment"># File app/helpers/issues_helper.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issue_tags</span> + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">tag_counts_on</span>(<span class="ruby-value">:labels</span>).<span class="ruby-identifier">map</span>(&<span class="ruby-value">:name</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- issue_tags-source --> + + </div> + + + + + </div><!-- issue_tags-method --> + + + <div id="method-i-issues_filter" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issues_filter</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issues_filter-source"> + <pre><span class="ruby-comment"># File app/helpers/issues_helper.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issues_filter</span> + { + <span class="ruby-identifier">all</span><span class="ruby-operator">:</span> <span class="ruby-string">"all"</span>, + <span class="ruby-identifier">closed</span><span class="ruby-operator">:</span> <span class="ruby-string">"closed"</span>, + <span class="ruby-identifier">to_me</span><span class="ruby-operator">:</span> <span class="ruby-string">"assigned-to-me"</span>, + <span class="ruby-identifier">open</span><span class="ruby-operator">:</span> <span class="ruby-string">"open"</span> + } +<span class="ruby-keyword">end</span></pre> + </div><!-- issues_filter-source --> + + </div> + + + + + </div><!-- issues_filter-method --> + + + <div id="method-i-link_to_issue_assignee" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_issue_assignee</span><span + class="method-args">(issue)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="link_to_issue_assignee-source"> + <pre><span class="ruby-comment"># File app/helpers/issues_helper.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_issue_assignee</span>(<span class="ruby-identifier">issue</span>) + <span class="ruby-identifier">project</span> = <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">project</span> + + <span class="ruby-identifier">tm</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">team_member_by_id</span>(<span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee_id</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">tm</span> + <span class="ruby-identifier">link_to</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee_name</span>, <span class="ruby-identifier">project_team_member_path</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">tm</span>), <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">"author_link"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">assignee_name</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_issue_assignee-source --> + + </div> + + + + + </div><!-- link_to_issue_assignee-method --> + + + <div id="method-i-link_to_issue_author" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_issue_author</span><span + class="method-args">(issue)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="link_to_issue_author-source"> + <pre><span class="ruby-comment"># File app/helpers/issues_helper.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_issue_author</span>(<span class="ruby-identifier">issue</span>) + <span class="ruby-identifier">project</span> = <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">project</span> + + <span class="ruby-identifier">tm</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">team_member_by_id</span>(<span class="ruby-identifier">issue</span>.<span class="ruby-identifier">author_id</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">tm</span> + <span class="ruby-identifier">link_to</span> <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">author_name</span>, <span class="ruby-identifier">project_team_member_path</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">tm</span>), <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">"author_link"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">issue</span>.<span class="ruby-identifier">author_name</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_issue_author-source --> + + </div> + + + + + </div><!-- link_to_issue_author-method --> + + + <div id="method-i-project_issues_filter_path" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_issues_filter_path</span><span + class="method-args">(project, params = {})</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_issues_filter_path-source"> + <pre><span class="ruby-comment"># File app/helpers/issues_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_issues_filter_path</span> <span class="ruby-identifier">project</span>, <span class="ruby-identifier">params</span> = {} + <span class="ruby-identifier">params</span>[<span class="ruby-value">:f</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">cookies</span>[<span class="ruby-string">'issue_filter'</span>] + <span class="ruby-identifier">project_issues_path</span> <span class="ruby-identifier">project</span>, <span class="ruby-identifier">params</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project_issues_filter_path-source --> + + </div> + + + + + </div><!-- project_issues_filter_path-method --> + + + <div id="method-i-unassigned_filter" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">unassigned_filter</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns an OpenStruct object suitable for use by +<code>options_from_collection_for_select</code> to allow filtering issues +by an unassigned <a href="User.html">User</a> or <a +href="Milestone.html">Milestone</a></p> + + + + <div class="method-source-code" id="unassigned_filter-source"> + <pre><span class="ruby-comment"># File app/helpers/issues_helper.rb, line 42</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">unassigned_filter</span> + <span class="ruby-comment"># Milestone uses :title, Issue uses :name</span> + <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-value">0</span>, <span class="ruby-identifier">title</span><span class="ruby-operator">:</span> <span class="ruby-string">'Unspecified'</span>, <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-string">'Unassigned'</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- unassigned_filter-source --> + + </div> + + + + + </div><!-- unassigned_filter-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/IssuesListContext.html b/doc/app/IssuesListContext.html new file mode 100644 index 00000000000..01acec4583e --- /dev/null +++ b/doc/app/IssuesListContext.html @@ -0,0 +1,537 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class IssuesListContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/issues_list_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="BaseContext.html">BaseContext</a> + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="IssuesHelper.html">IssuesHelper</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class IssuesListContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-issues" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">issues</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/issues_list_context.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:f</span>] + <span class="ruby-keyword">when</span> <span class="ruby-identifier">issues_filter</span>[<span class="ruby-value">:all</span>] <span class="ruby-keyword">then</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span> + <span class="ruby-keyword">when</span> <span class="ruby-identifier">issues_filter</span>[<span class="ruby-value">:closed</span>] <span class="ruby-keyword">then</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">closed</span> + <span class="ruby-keyword">when</span> <span class="ruby-identifier">issues_filter</span>[<span class="ruby-value">:to_me</span>] <span class="ruby-keyword">then</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">opened</span>.<span class="ruby-identifier">assigned</span>(<span class="ruby-identifier">current_user</span>) + <span class="ruby-keyword">else</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">opened</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">tagged_with</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:label_name</span>]) <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:label_name</span>].<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">includes</span>(<span class="ruby-value">:author</span>, <span class="ruby-value">:project</span>).<span class="ruby-identifier">order</span>(<span class="ruby-string">"updated_at"</span>) + + <span class="ruby-comment"># Filter by specific assignee_id (or lack thereof)?</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:assignee_id</span>].<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">assignee_id</span><span class="ruby-operator">:</span> (<span class="ruby-identifier">params</span>[<span class="ruby-value">:assignee_id</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'0'</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:assignee_id</span>])) + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># Filter by specific milestone_id (or lack thereof)?</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:milestone_id</span>].<span class="ruby-identifier">present?</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@issues</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">milestone_id</span><span class="ruby-operator">:</span> (<span class="ruby-identifier">params</span>[<span class="ruby-value">:milestone_id</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'0'</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">nil</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:milestone_id</span>])) + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@issues</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Key.html b/doc/app/Key.html new file mode 100644 index 00000000000..afbcea93b99 --- /dev/null +++ b/doc/app/Key.html @@ -0,0 +1,700 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Key - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/key.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-fingerprintable_key">#fingerprintable_key</a> + + <li><a href="#method-i-is_deploy_key">#is_deploy_key</a> + + <li><a href="#method-i-last_deploy-3F">#last_deploy?</a> + + <li><a href="#method-i-projects">#projects</a> + + <li><a href="#method-i-set_identifier">#set_identifier</a> + + <li><a href="#method-i-strip_white_space">#strip_white_space</a> + + <li><a href="#method-i-unique_key">#unique_key</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Key</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-fingerprintable_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">fingerprintable_key</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="fingerprintable_key-source"> + <pre><span class="ruby-comment"># File app/models/key.rb, line 30</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">fingerprintable_key</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">key</span> <span class="ruby-comment"># Don't test if there is no key.</span> + <span class="ruby-comment"># `ssh-keygen -lf /dev/stdin <<< "#{key}"` errors with: redirection unexpected</span> + <span class="ruby-identifier">file</span> = <span class="ruby-constant">Tempfile</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">'key_file'</span>) + <span class="ruby-keyword">begin</span> + <span class="ruby-identifier">file</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">key</span> + <span class="ruby-identifier">file</span>.<span class="ruby-identifier">rewind</span> + <span class="ruby-identifier">fingerprint_output</span> = <span class="ruby-node">%xssh-keygen -lf #{file.path} 2>&1`</span> <span class="ruby-comment"># Catch stderr.</span> + <span class="ruby-keyword">ensure</span> + <span class="ruby-identifier">file</span>.<span class="ruby-identifier">close</span> + <span class="ruby-identifier">file</span>.<span class="ruby-identifier">unlink</span> <span class="ruby-comment"># deletes the temp file</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span>(<span class="ruby-value">:key</span>, <span class="ruby-string">"can't be fingerprinted"</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">fingerprint_output</span>.<span class="ruby-identifier">match</span>(<span class="ruby-string">"failed"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- fingerprintable_key-source --> + + </div> + + + + + </div><!-- fingerprintable_key-method --> + + + <div id="method-i-is_deploy_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_deploy_key</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="is_deploy_key-source"> + <pre><span class="ruby-comment"># File app/models/key.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_deploy_key</span> + <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project_id</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- is_deploy_key-source --> + + </div> + + + + + </div><!-- is_deploy_key-method --> + + + <div id="method-i-last_deploy-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_deploy?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_deploy-3F-source"> + <pre><span class="ruby-comment"># File app/models/key.rb, line 66</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_deploy?</span> + <span class="ruby-constant">Key</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">identifier</span><span class="ruby-operator">:</span> <span class="ruby-identifier">identifier</span>).<span class="ruby-identifier">count</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_deploy-3F-source --> + + </div> + + + + + </div><!-- last_deploy-3F-method --> + + + <div id="method-i-projects" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">projects</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>projects that has this key</p> + + + + <div class="method-source-code" id="projects-source"> + <pre><span class="ruby-comment"># File app/models/key.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">projects</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">is_deploy_key</span> + [<span class="ruby-identifier">project</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">user</span>.<span class="ruby-identifier">projects</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- projects-source --> + + </div> + + + + + </div><!-- projects-method --> + + + <div id="method-i-set_identifier" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">set_identifier</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="set_identifier-source"> + <pre><span class="ruby-comment"># File app/models/key.rb, line 45</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_identifier</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">is_deploy_key</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">identifier</span> = <span class="ruby-node">"deploy_#{Digest::MD5.hexdigest(key)}"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">identifier</span> = <span class="ruby-node">"#{user.identifier}_#{Time.now.to_i}"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- set_identifier-source --> + + </div> + + + + + </div><!-- set_identifier-method --> + + + <div id="method-i-strip_white_space" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">strip_white_space</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="strip_white_space-source"> + <pre><span class="ruby-comment"># File app/models/key.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">strip_white_space</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key</span>.<span class="ruby-identifier">strip</span> <span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key</span>.<span class="ruby-identifier">blank?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- strip_white_space-source --> + + </div> + + + + + </div><!-- strip_white_space-method --> + + + <div id="method-i-unique_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">unique_key</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="unique_key-source"> + <pre><span class="ruby-comment"># File app/models/key.rb, line 22</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">unique_key</span> + <span class="ruby-identifier">query</span> = <span class="ruby-constant">Key</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">key</span><span class="ruby-operator">:</span> <span class="ruby-identifier">key</span>) + <span class="ruby-identifier">query</span> = <span class="ruby-identifier">query</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">'(project_id IS NULL OR project_id = ?)'</span>, <span class="ruby-identifier">project_id</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">project_id</span> + <span class="ruby-keyword">if</span> (<span class="ruby-identifier">query</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>) + <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span> <span class="ruby-value">:key</span>, <span class="ruby-string">'already exist.'</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- unique_key-source --> + + </div> + + + + + </div><!-- unique_key-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/KeyObserver.html b/doc/app/KeyObserver.html new file mode 100644 index 00000000000..bdaf9f84b0f --- /dev/null +++ b/doc/app/KeyObserver.html @@ -0,0 +1,530 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class KeyObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/key_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="GitHost.html">GitHost</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_destroy">#after_destroy</a> + + <li><a href="#method-i-after_save">#after_save</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class KeyObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_destroy</span><span + class="method-args">(key)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_destroy-source"> + <pre><span class="ruby-comment"># File app/observers/key_observer.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_destroy</span>(<span class="ruby-identifier">key</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">key</span>.<span class="ruby-identifier">is_deploy_key</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">key</span>.<span class="ruby-identifier">last_deploy?</span> + <span class="ruby-identifier">git_host</span>.<span class="ruby-identifier">remove_key</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">identifier</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">projects</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_destroy-source --> + + </div> + + + + + </div><!-- after_destroy-method --> + + + <div id="method-i-after_save" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_save</span><span + class="method-args">(key)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_save-source"> + <pre><span class="ruby-comment"># File app/observers/key_observer.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_save</span>(<span class="ruby-identifier">key</span>) + <span class="ruby-identifier">git_host</span>.<span class="ruby-identifier">set_key</span>(<span class="ruby-identifier">key</span>.<span class="ruby-identifier">identifier</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">key</span>, <span class="ruby-identifier">key</span>.<span class="ruby-identifier">projects</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_save-source --> + + </div> + + + + + </div><!-- after_save-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/KeysController.html b/doc/app/KeysController.html new file mode 100644 index 00000000000..13fac402005 --- /dev/null +++ b/doc/app/KeysController.html @@ -0,0 +1,624 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class KeysController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/keys_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class KeysController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/keys_controller.rb, line 19</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:key</span>]) + <span class="ruby-ivar">@key</span>.<span class="ruby-identifier">save</span> + + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@key</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/keys_controller.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@key</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">keys_url</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/keys_controller.rb, line 5</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@keys</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">all</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/keys_controller.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">new</span> + + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@key</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/keys_controller.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@key</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/LabelsController.html b/doc/app/LabelsController.html new file mode 100644 index 00000000000..7dece84091e --- /dev/null +++ b/doc/app/LabelsController.html @@ -0,0 +1,523 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class LabelsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/labels_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-module_enabled">#module_enabled</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class LabelsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/labels_controller.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@labels</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues_labels</span>.<span class="ruby-identifier">order</span>(<span class="ruby-string">'count DESC'</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-module_enabled" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">module_enabled</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="module_enabled-source"> + <pre><span class="ruby-comment"># File app/controllers/labels_controller.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">module_enabled</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues_enabled</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- module_enabled-source --> + + </div> + + + + + </div><!-- module_enabled-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/MergeRequest.html b/doc/app/MergeRequest.html new file mode 100644 index 00000000000..7dbe6f4f41c --- /dev/null +++ b/doc/app/MergeRequest.html @@ -0,0 +1,1478 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class MergeRequest - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/merge_request.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="IssueCommonality.html">IssueCommonality</a> + + + + <li><a class="include" href="Votes.html">Votes</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-find_all_by_branch">::find_all_by_branch</a> + + <li><a href="#method-i-automerge-21">#automerge!</a> + + <li><a href="#method-i-broken_diffs-3F">#broken_diffs?</a> + + <li><a href="#method-i-can_be_merged-3F">#can_be_merged?</a> + + <li><a href="#method-i-check_if_can_be_merged">#check_if_can_be_merged</a> + + <li><a href="#method-i-closed_event">#closed_event</a> + + <li><a href="#method-i-commits">#commits</a> + + <li><a href="#method-i-diffs">#diffs</a> + + <li><a href="#method-i-human_state">#human_state</a> + + <li><a href="#method-i-last_commit">#last_commit</a> + + <li><a href="#method-i-mark_as_merged-21">#mark_as_merged!</a> + + <li><a href="#method-i-mark_as_unchecked">#mark_as_unchecked</a> + + <li><a href="#method-i-mark_as_unmergable">#mark_as_unmergable</a> + + <li><a href="#method-i-merge-21">#merge!</a> + + <li><a href="#method-i-merge_event">#merge_event</a> + + <li><a href="#method-i-merged-3F">#merged?</a> + + <li><a href="#method-i-mr_and_commit_notes">#mr_and_commit_notes</a> + + <li><a href="#method-i-open-3F">#open?</a> + + <li><a href="#method-i-probably_merged-3F">#probably_merged?</a> + + <li><a href="#method-i-reload_code">#reload_code</a> + + <li><a href="#method-i-reloaded_commits">#reloaded_commits</a> + + <li><a href="#method-i-reloaded_diffs">#reloaded_diffs</a> + + <li><a href="#method-i-to_raw">#to_raw</a> + + <li><a href="#method-i-unchecked-3F">#unchecked?</a> + + <li><a href="#method-i-unmerged_commits">#unmerged_commits</a> + + <li><a href="#method-i-unmerged_diffs">#unmerged_diffs</a> + + <li><a href="#method-i-valid_diffs-3F">#valid_diffs?</a> + + <li><a href="#method-i-validate_branches">#validate_branches</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class MergeRequest</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="BROKEN_DIFF">BROKEN_DIFF + + <dd class="description"> + + + <dt id="CANNOT_BE_MERGED">CANNOT_BE_MERGED + + <dd class="description"> + + + <dt id="CAN_BE_MERGED">CAN_BE_MERGED + + <dd class="description"> + + + <dt id="UNCHECKED">UNCHECKED + + <dd class="description"> + + + </dl> + </section> + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-should_remove_source_branch" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">should_remove_source_branch</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-find_all_by_branch" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">find_all_by_branch</span><span + class="method-args">(branch_name)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="find_all_by_branch-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">find_all_by_branch</span>(<span class="ruby-identifier">branch_name</span>) + <span class="ruby-identifier">where</span>(<span class="ruby-string">"source_branch LIKE :branch OR target_branch LIKE :branch"</span>, <span class="ruby-identifier">branch</span><span class="ruby-operator">:</span> <span class="ruby-identifier">branch_name</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- find_all_by_branch-source --> + + </div> + + + + + </div><!-- find_all_by_branch-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-automerge-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">automerge!</span><span + class="method-args">(current_user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="automerge-21-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 169</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">automerge!</span>(<span class="ruby-identifier">current_user</span>) + <span class="ruby-keyword">if</span> <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Merge</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">current_user</span>).<span class="ruby-identifier">merge!</span> <span class="ruby-operator">&&</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">unmerged_commits</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">id</span>) + <span class="ruby-keyword">true</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">mark_as_unmergable</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- automerge-21-source --> + + </div> + + + + + </div><!-- automerge-21-method --> + + + <div id="method-i-broken_diffs-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">broken_diffs?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="broken_diffs-3F-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 86</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">broken_diffs?</span> + <span class="ruby-identifier">diffs</span> <span class="ruby-operator">==</span> [<span class="ruby-constant">BROKEN_DIFF</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- broken_diffs-3F-source --> + + </div> + + + + + </div><!-- broken_diffs-3F-method --> + + + <div id="method-i-can_be_merged-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">can_be_merged?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="can_be_merged-3F-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">can_be_merged?</span> + <span class="ruby-identifier">state</span> <span class="ruby-operator">==</span> <span class="ruby-constant">CAN_BE_MERGED</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- can_be_merged-3F-source --> + + </div> + + + + + </div><!-- can_be_merged-3F-method --> + + + <div id="method-i-check_if_can_be_merged" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">check_if_can_be_merged</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="check_if_can_be_merged-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 62</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">check_if_can_be_merged</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">state</span> = <span class="ruby-keyword">if</span> <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Merge</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">author</span>).<span class="ruby-identifier">can_be_merged?</span> + <span class="ruby-constant">CAN_BE_MERGED</span> + <span class="ruby-keyword">else</span> + <span class="ruby-constant">CANNOT_BE_MERGED</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">save</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- check_if_can_be_merged-source --> + + </div> + + + + + </div><!-- check_if_can_be_merged-method --> + + + <div id="method-i-closed_event" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">closed_event</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="closed_event-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 114</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">closed_event</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">events</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">target_id</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">target_type</span><span class="ruby-operator">:</span> <span class="ruby-string">"MergeRequest"</span>, <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Closed</span>).<span class="ruby-identifier">last</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- closed_event-source --> + + </div> + + + + + </div><!-- closed_event-method --> + + + <div id="method-i-commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 118</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits</span> + <span class="ruby-identifier">st_commits</span> <span class="ruby-operator">||</span> [] +<span class="ruby-keyword">end</span></pre> + </div><!-- commits-source --> + + </div> + + + + + </div><!-- commits-method --> + + + <div id="method-i-diffs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">diffs</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="diffs-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 71</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">diffs</span> + <span class="ruby-identifier">st_diffs</span> <span class="ruby-operator">||</span> [] +<span class="ruby-keyword">end</span></pre> + </div><!-- diffs-source --> + + </div> + + + + + </div><!-- diffs-method --> + + + <div id="method-i-human_state" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">human_state</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="human_state-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">human_state</span> + <span class="ruby-identifier">states</span> = { + <span class="ruby-constant">CAN_BE_MERGED</span> =<span class="ruby-operator">></span> <span class="ruby-string">"can_be_merged"</span>, + <span class="ruby-constant">CANNOT_BE_MERGED</span> =<span class="ruby-operator">></span> <span class="ruby-string">"cannot_be_merged"</span>, + <span class="ruby-constant">UNCHECKED</span> =<span class="ruby-operator">></span> <span class="ruby-string">"unchecked"</span> + } + <span class="ruby-identifier">states</span>[<span class="ruby-keyword">self</span>.<span class="ruby-identifier">state</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- human_state-source --> + + </div> + + + + + </div><!-- human_state-method --> + + + <div id="method-i-last_commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_commit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_commit-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 102</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_commit</span> + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">first</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_commit-source --> + + </div> + + + + + </div><!-- last_commit-method --> + + + <div id="method-i-mark_as_merged-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">mark_as_merged!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="mark_as_merged-21-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 131</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">mark_as_merged!</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merged</span> = <span class="ruby-keyword">true</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">closed</span> = <span class="ruby-keyword">true</span> + <span class="ruby-identifier">save</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- mark_as_merged-21-source --> + + </div> + + + + + </div><!-- mark_as_merged-21-method --> + + + <div id="method-i-mark_as_unchecked" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">mark_as_unchecked</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="mark_as_unchecked-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">mark_as_unchecked</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">state</span> = <span class="ruby-constant">UNCHECKED</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">save</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- mark_as_unchecked-source --> + + </div> + + + + + </div><!-- mark_as_unchecked-method --> + + + <div id="method-i-mark_as_unmergable" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">mark_as_unmergable</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="mark_as_unmergable-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 137</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">mark_as_unmergable</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">state</span> = <span class="ruby-constant">CANNOT_BE_MERGED</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">save</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- mark_as_unmergable-source --> + + </div> + + + + + </div><!-- mark_as_unmergable-method --> + + + <div id="method-i-merge-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge!</span><span + class="method-args">(user_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="merge-21-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 158</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">user_id</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">mark_as_merged!</span> + <span class="ruby-constant">Event</span>.<span class="ruby-identifier">create</span>( + <span class="ruby-identifier">project</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>, + <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Merged</span>, + <span class="ruby-identifier">target_id</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">target_type</span><span class="ruby-operator">:</span> <span class="ruby-string">"MergeRequest"</span>, + <span class="ruby-identifier">author_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user_id</span> + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- merge-21-source --> + + </div> + + + + + </div><!-- merge-21-method --> + + + <div id="method-i-merge_event" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge_event</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="merge_event-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 110</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_event</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">events</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">target_id</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">target_type</span><span class="ruby-operator">:</span> <span class="ruby-string">"MergeRequest"</span>, <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Merged</span>).<span class="ruby-identifier">last</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- merge_event-source --> + + </div> + + + + + </div><!-- merge_event-method --> + + + <div id="method-i-merged-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merged?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="merged-3F-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 106</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merged?</span> + <span class="ruby-identifier">merged</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">merge_event</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- merged-3F-source --> + + </div> + + + + + </div><!-- merged-3F-method --> + + + <div id="method-i-mr_and_commit_notes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">mr_and_commit_notes</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="mr_and_commit_notes-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 191</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">mr_and_commit_notes</span> + <span class="ruby-identifier">commit_ids</span> = <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:id</span>) + <span class="ruby-constant">Note</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"(noteable_type = 'MergeRequest' AND noteable_id = :mr_id) OR (noteable_type = 'Commit' AND noteable_id IN (:commit_ids))"</span>, <span class="ruby-identifier">mr_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">id</span>, <span class="ruby-identifier">commit_ids</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit_ids</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- mr_and_commit_notes-source --> + + </div> + + + + + </div><!-- mr_and_commit_notes-method --> + + + <div id="method-i-open-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">open?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="open-3F-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 127</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">open?</span> + <span class="ruby-operator">!</span><span class="ruby-identifier">closed</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- open-3F-source --> + + </div> + + + + + </div><!-- open-3F-method --> + + + <div id="method-i-probably_merged-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">probably_merged?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="probably_merged-3F-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 122</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">probably_merged?</span> + <span class="ruby-identifier">unmerged_commits</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-operator">&&</span> + <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">any?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">open?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- probably_merged-3F-source --> + + </div> + + + + + </div><!-- probably_merged-3F-method --> + + + <div id="method-i-reload_code" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reload_code</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reload_code-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 44</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reload_code</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reloaded_commits</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">reloaded_diffs</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- reload_code-source --> + + </div> + + + + + </div><!-- reload_code-method --> + + + <div id="method-i-reloaded_commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reloaded_commits</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reloaded_commits-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 142</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reloaded_commits</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">open?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">unmerged_commits</span>.<span class="ruby-identifier">any?</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">st_commits</span> = <span class="ruby-identifier">unmerged_commits</span> + <span class="ruby-identifier">save</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">commits</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- reloaded_commits-source --> + + </div> + + + + + </div><!-- reloaded_commits-method --> + + + <div id="method-i-reloaded_diffs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reloaded_diffs</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reloaded_diffs-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 75</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reloaded_diffs</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">open?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">unmerged_diffs</span>.<span class="ruby-identifier">any?</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">st_diffs</span> = <span class="ruby-identifier">unmerged_diffs</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">save</span> + <span class="ruby-keyword">end</span> + +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Git</span><span class="ruby-operator">::</span><span class="ruby-constant">GitTimeout</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">st_diffs</span> = [<span class="ruby-constant">BROKEN_DIFF</span>] + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">save</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- reloaded_diffs-source --> + + </div> + + + + + </div><!-- reloaded_diffs-method --> + + + <div id="method-i-to_raw" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_raw</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="to_raw-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 179</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_raw</span> + <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"tmp"</span>, <span class="ruby-string">"patches"</span>)) + <span class="ruby-identifier">patch_path</span> = <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"tmp"</span>, <span class="ruby-string">"patches"</span>, <span class="ruby-node">"merge_request_#{self.id}.patch"</span>) + + <span class="ruby-identifier">from</span> = <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">id</span> + <span class="ruby-identifier">to</span> = <span class="ruby-identifier">source_branch</span> + + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">run</span>(<span class="ruby-string">''</span>, <span class="ruby-string">"format-patch"</span> , <span class="ruby-node">" > #{patch_path.to_s}"</span>, {}, [<span class="ruby-node">"#{from}..#{to}"</span>, <span class="ruby-string">"--stdout"</span>]) + + <span class="ruby-identifier">patch_path</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_raw-source --> + + </div> + + + + + </div><!-- to_raw-method --> + + + <div id="method-i-unchecked-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">unchecked?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="unchecked-3F-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">unchecked?</span> + <span class="ruby-identifier">state</span> <span class="ruby-operator">==</span> <span class="ruby-constant">UNCHECKED</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- unchecked-3F-source --> + + </div> + + + + + </div><!-- unchecked-3F-method --> + + + <div id="method-i-unmerged_commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">unmerged_commits</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="unmerged_commits-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 150</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">unmerged_commits</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span>. + <span class="ruby-identifier">commits_between</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">target_branch</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">source_branch</span>). + <span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">c</span>)}. + <span class="ruby-identifier">sort_by</span>(&<span class="ruby-value">:created_at</span>). + <span class="ruby-identifier">reverse</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- unmerged_commits-source --> + + </div> + + + + + </div><!-- unmerged_commits-method --> + + + <div id="method-i-unmerged_diffs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">unmerged_diffs</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="unmerged_diffs-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 94</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">unmerged_diffs</span> + <span class="ruby-comment"># Only show what is new in the source branch compared to the target branch, not the other way around.</span> + <span class="ruby-comment"># The linex below with merge_base is equivalent to diff with three dots (git diff branch1...branch2)</span> + <span class="ruby-comment"># From the git documentation: "git diff A...B" is equivalent to "git diff $(git-merge-base A B) B"</span> + <span class="ruby-identifier">common_commit</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">git</span>.<span class="ruby-identifier">native</span>(<span class="ruby-value">:merge_base</span>, {}, [<span class="ruby-identifier">target_branch</span>, <span class="ruby-identifier">source_branch</span>]).<span class="ruby-identifier">strip</span> + <span class="ruby-identifier">diffs</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">diff</span>(<span class="ruby-identifier">common_commit</span>, <span class="ruby-identifier">source_branch</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- unmerged_diffs-source --> + + </div> + + + + + </div><!-- unmerged_diffs-method --> + + + <div id="method-i-valid_diffs-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">valid_diffs?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="valid_diffs-3F-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 90</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">valid_diffs?</span> + <span class="ruby-operator">!</span><span class="ruby-identifier">broken_diffs?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- valid_diffs-3F-source --> + + </div> + + + + + </div><!-- valid_diffs-3F-method --> + + + <div id="method-i-validate_branches" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">validate_branches</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="validate_branches-source"> + <pre><span class="ruby-comment"># File app/models/merge_request.rb, line 38</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">validate_branches</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">target_branch</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">source_branch</span> + <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span> <span class="ruby-value">:base</span>, <span class="ruby-string">"You can not use same branch for source and target branches"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- validate_branches-source --> + + </div> + + + + + </div><!-- validate_branches-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/MergeRequestObserver.html b/doc/app/MergeRequestObserver.html new file mode 100644 index 00000000000..f2d0dbd7dd1 --- /dev/null +++ b/doc/app/MergeRequestObserver.html @@ -0,0 +1,569 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class MergeRequestObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/merge_request_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-after_update">#after_update</a> + + <li><a href="#method-i-send_reassigned_email">#send_reassigned_email</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class MergeRequestObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(merge_request)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/merge_request_observer.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span>(<span class="ruby-identifier">merge_request</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">current_user</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">new_merge_request_email</span>(<span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">deliver</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + <div id="method-i-after_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_update</span><span + class="method-args">(merge_request)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_update-source"> + <pre><span class="ruby-comment"># File app/observers/merge_request_observer.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_update</span>(<span class="ruby-identifier">merge_request</span>) + <span class="ruby-identifier">send_reassigned_email</span>(<span class="ruby-identifier">merge_request</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">is_being_reassigned?</span> + + <span class="ruby-identifier">status</span> = <span class="ruby-keyword">nil</span> + <span class="ruby-identifier">status</span> = <span class="ruby-string">'closed'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">is_being_closed?</span> + <span class="ruby-identifier">status</span> = <span class="ruby-string">'reopened'</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">is_being_reopened?</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">status</span> + <span class="ruby-constant">Note</span>.<span class="ruby-identifier">create_status_change_note</span>(<span class="ruby-identifier">merge_request</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">status</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_update-source --> + + </div> + + + + + </div><!-- after_update-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-send_reassigned_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">send_reassigned_email</span><span + class="method-args">(merge_request)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="send_reassigned_email-source"> + <pre><span class="ruby-comment"># File app/observers/merge_request_observer.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_reassigned_email</span>(<span class="ruby-identifier">merge_request</span>) + <span class="ruby-identifier">recipients_ids</span> = <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee_id_was</span>, <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee_id</span> + <span class="ruby-identifier">recipients_ids</span>.<span class="ruby-identifier">delete</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">id</span> + + <span class="ruby-identifier">recipients_ids</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">recipient_id</span><span class="ruby-operator">|</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">reassigned_merge_request_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee_id_was</span>).<span class="ruby-identifier">deliver</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- send_reassigned_email-source --> + + </div> + + + + + </div><!-- send_reassigned_email-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/MergeRequestsController.html b/doc/app/MergeRequestsController.html new file mode 100644 index 00000000000..ef257c6cad0 --- /dev/null +++ b/doc/app/MergeRequestsController.html @@ -0,0 +1,1114 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class MergeRequestsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/merge_requests_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-authorize_admin_merge_request-21">#authorize_admin_merge_request!</a> + + <li><a href="#method-i-authorize_modify_merge_request-21">#authorize_modify_merge_request!</a> + + <li><a href="#method-i-automerge">#automerge</a> + + <li><a href="#method-i-automerge_check">#automerge_check</a> + + <li><a href="#method-i-branch_from">#branch_from</a> + + <li><a href="#method-i-branch_to">#branch_to</a> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-define_show_vars">#define_show_vars</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-diffs">#diffs</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-merge_request">#merge_request</a> + + <li><a href="#method-i-module_enabled">#module_enabled</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-raw">#raw</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-update">#update</a> + + <li><a href="#method-i-validates_merge_request">#validates_merge_request</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class MergeRequestsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-automerge" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">automerge</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="automerge-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 79</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">automerge</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">access_denied!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:accept_mr</span>, <span class="ruby-ivar">@project</span>) + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">open?</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">can_be_merged?</span> + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">should_remove_source_branch</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:should_remove_source_branch</span>] + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">automerge!</span>(<span class="ruby-identifier">current_user</span>) + <span class="ruby-ivar">@status</span> = <span class="ruby-keyword">true</span> + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@status</span> = <span class="ruby-keyword">false</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- automerge-source --> + + </div> + + + + + </div><!-- automerge-method --> + + + <div id="method-i-automerge_check" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">automerge_check</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="automerge_check-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 72</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">automerge_check</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">unchecked?</span> + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">check_if_can_be_merged</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">json</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">state</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">human_state</span>} +<span class="ruby-keyword">end</span></pre> + </div><!-- automerge_check-source --> + + </div> + + + + + </div><!-- automerge_check-method --> + + + <div id="method-i-branch_from" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branch_from</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="branch_from-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 98</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branch_from</span> + <span class="ruby-ivar">@commit</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:ref</span>]) + <span class="ruby-ivar">@commit</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@commit</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- branch_from-source --> + + </div> + + + + + </div><!-- branch_from-method --> + + + <div id="method-i-branch_to" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branch_to</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="branch_to-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 103</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branch_to</span> + <span class="ruby-ivar">@commit</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:ref</span>]) + <span class="ruby-ivar">@commit</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@commit</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- branch_to-source --> + + </div> + + + + + </div><!-- branch_to-method --> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 50</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@merge_request</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:merge_request</span>]) + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">author</span> = <span class="ruby-identifier">current_user</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">save</span> + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">reload_code</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@merge_request</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Merge request was successfully created.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"new"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 90</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_merge_requests_url</span>(<span class="ruby-ivar">@project</span>) } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-diffs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">diffs</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="diffs-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">diffs</span> + <span class="ruby-ivar">@diffs</span> = <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">diffs</span> + <span class="ruby-ivar">@commit</span> = <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">last_commit</span> + + <span class="ruby-ivar">@comments_allowed</span> = <span class="ruby-keyword">true</span> + <span class="ruby-ivar">@line_notes</span> = <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"line_code is not null"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- diffs-source --> + + </div> + + + + + </div><!-- diffs-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@merge_requests</span> = <span class="ruby-constant">MergeRequestsLoadContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 43</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@merge_request</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:merge_request</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-raw" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">raw</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="raw-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">raw</span> + <span class="ruby-identifier">send_file</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">to_raw</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- raw-source --> + + </div> + + + + + </div><!-- raw-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 62</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:merge_request</span>].<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">author_id_of_changes</span><span class="ruby-operator">:</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">id</span>)) + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">reload_code</span> + <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">mark_as_unchecked</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@merge_request</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Merge request was successfully updated.'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"edit"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-authorize_admin_merge_request-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_admin_merge_request!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_admin_merge_request-21-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 118</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_admin_merge_request!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_merge_request</span>, <span class="ruby-ivar">@merge_request</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_admin_merge_request-21-source --> + + </div> + + + + + </div><!-- authorize_admin_merge_request-21-method --> + + + <div id="method-i-authorize_modify_merge_request-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_modify_merge_request!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_modify_merge_request-21-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 114</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_modify_merge_request!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:modify_merge_request</span>, <span class="ruby-ivar">@merge_request</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_modify_merge_request-21-source --> + + </div> + + + + + </div><!-- authorize_modify_merge_request-21-method --> + + + <div id="method-i-define_show_vars" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">define_show_vars</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="define_show_vars-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 135</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_show_vars</span> + <span class="ruby-comment"># Build a note object for comment form</span> + <span class="ruby-ivar">@note</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">noteable</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@merge_request</span>) + + <span class="ruby-comment"># Get commits from repository</span> + <span class="ruby-comment"># or from cache if already merged</span> + <span class="ruby-ivar">@commits</span> = <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">commits</span> + <span class="ruby-ivar">@commits</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@commits</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- define_show_vars-source --> + + </div> + + + + + </div><!-- define_show_vars-method --> + + + <div id="method-i-merge_request" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">merge_request</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="merge_request-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 110</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">merge_request</span> + <span class="ruby-ivar">@merge_request</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- merge_request-source --> + + </div> + + + + + </div><!-- merge_request-method --> + + + <div id="method-i-module_enabled" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">module_enabled</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="module_enabled-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 122</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">module_enabled</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">merge_requests_enabled</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- module_enabled-source --> + + </div> + + + + + </div><!-- module_enabled-method --> + + + <div id="method-i-validates_merge_request" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">validates_merge_request</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="validates_merge_request-source"> + <pre><span class="ruby-comment"># File app/controllers/merge_requests_controller.rb, line 126</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">validates_merge_request</span> + <span class="ruby-comment"># Show git not found page if target branch doesnt exist</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">git_not_found!</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">heads</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:name</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">target_branch</span>) + + <span class="ruby-comment"># Show git not found page if source branch doesnt exist</span> + <span class="ruby-comment"># and there is no saved commits between source & target branch</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">git_not_found!</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@project</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">heads</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:name</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">source_branch</span>) <span class="ruby-operator">&&</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">commits</span>.<span class="ruby-identifier">blank?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- validates_merge_request-source --> + + </div> + + + + + </div><!-- validates_merge_request-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/MergeRequestsHelper.html b/doc/app/MergeRequestsHelper.html new file mode 100644 index 00000000000..fec9b0e01ab --- /dev/null +++ b/doc/app/MergeRequestsHelper.html @@ -0,0 +1,599 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module MergeRequestsHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/merge_requests_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-link_to_merge_request_assignee">#link_to_merge_request_assignee</a> + + <li><a href="#method-i-link_to_merge_request_author">#link_to_merge_request_author</a> + + <li><a href="#method-i-mr_css_classes">#mr_css_classes</a> + + <li><a href="#method-i-new_mr_path_from_push_event">#new_mr_path_from_push_event</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module MergeRequestsHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-link_to_merge_request_assignee" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_merge_request_assignee</span><span + class="method-args">(merge_request)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="link_to_merge_request_assignee-source"> + <pre><span class="ruby-comment"># File app/helpers/merge_requests_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_merge_request_assignee</span>(<span class="ruby-identifier">merge_request</span>) + <span class="ruby-identifier">project</span> = <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">project</span> + + <span class="ruby-identifier">tm</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">team_member_by_id</span>(<span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee_id</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">tm</span> + <span class="ruby-identifier">link_to</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee_name</span>, <span class="ruby-identifier">project_team_member_path</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">tm</span>), <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">"author_link"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">assignee_name</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_merge_request_assignee-source --> + + </div> + + + + + </div><!-- link_to_merge_request_assignee-method --> + + + <div id="method-i-link_to_merge_request_author" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_merge_request_author</span><span + class="method-args">(merge_request)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="link_to_merge_request_author-source"> + <pre><span class="ruby-comment"># File app/helpers/merge_requests_helper.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_merge_request_author</span>(<span class="ruby-identifier">merge_request</span>) + <span class="ruby-identifier">project</span> = <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">project</span> + + <span class="ruby-identifier">tm</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">team_member_by_id</span>(<span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">author_id</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">tm</span> + <span class="ruby-identifier">link_to</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">author_name</span>, <span class="ruby-identifier">project_team_member_path</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">tm</span>), <span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">"author_link"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">author_name</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_merge_request_author-source --> + + </div> + + + + + </div><!-- link_to_merge_request_author-method --> + + + <div id="method-i-mr_css_classes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">mr_css_classes</span><span + class="method-args">(mr)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="mr_css_classes-source"> + <pre><span class="ruby-comment"># File app/helpers/merge_requests_helper.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">mr_css_classes</span> <span class="ruby-identifier">mr</span> + <span class="ruby-identifier">classes</span> = <span class="ruby-string">"merge_request"</span> + <span class="ruby-identifier">classes</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" closed"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">mr</span>.<span class="ruby-identifier">closed</span> + <span class="ruby-identifier">classes</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" merged"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">mr</span>.<span class="ruby-identifier">merged?</span> + <span class="ruby-identifier">classes</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- mr_css_classes-source --> + + </div> + + + + + </div><!-- mr_css_classes-method --> + + + <div id="method-i-new_mr_path_from_push_event" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_mr_path_from_push_event</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new_mr_path_from_push_event-source"> + <pre><span class="ruby-comment"># File app/helpers/merge_requests_helper.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_mr_path_from_push_event</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">new_project_merge_request_path</span>( + <span class="ruby-identifier">event</span>.<span class="ruby-identifier">project</span>, + <span class="ruby-identifier">merge_request</span><span class="ruby-operator">:</span> { + <span class="ruby-identifier">source_branch</span><span class="ruby-operator">:</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">branch_name</span>, + <span class="ruby-identifier">target_branch</span><span class="ruby-operator">:</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">root_ref</span>, + <span class="ruby-identifier">title</span><span class="ruby-operator">:</span> <span class="ruby-identifier">event</span>.<span class="ruby-identifier">branch_name</span>.<span class="ruby-identifier">titleize</span> + } + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- new_mr_path_from_push_event-source --> + + </div> + + + + + </div><!-- new_mr_path_from_push_event-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/MergeRequestsLoadContext.html b/doc/app/MergeRequestsLoadContext.html new file mode 100644 index 00000000000..5c1b882939f --- /dev/null +++ b/doc/app/MergeRequestsLoadContext.html @@ -0,0 +1,496 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class MergeRequestsLoadContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/merge_requests_load_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="BaseContext.html">BaseContext</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class MergeRequestsLoadContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/merge_requests_load_context.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-identifier">type</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:f</span>] + + <span class="ruby-identifier">merge_requests</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">merge_requests</span> + + <span class="ruby-identifier">merge_requests</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">type</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">'all'</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">merge_requests</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">'closed'</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">closed</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">'assigned-to-me'</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">opened</span>.<span class="ruby-identifier">assigned</span>(<span class="ruby-identifier">current_user</span>) + <span class="ruby-keyword">else</span> <span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">opened</span> + <span class="ruby-keyword">end</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) + + <span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">includes</span>(<span class="ruby-value">:author</span>, <span class="ruby-value">:project</span>).<span class="ruby-identifier">order</span>(<span class="ruby-string">"closed, created_at desc"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Milestone.html b/doc/app/Milestone.html new file mode 100644 index 00000000000..cc3bdc585b1 --- /dev/null +++ b/doc/app/Milestone.html @@ -0,0 +1,589 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Milestone - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/milestone.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-active">::active</a> + + <li><a href="#method-i-expires_at">#expires_at</a> + + <li><a href="#method-i-participants">#participants</a> + + <li><a href="#method-i-percent_complete">#percent_complete</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Milestone</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-active" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">active</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="active-source"> + <pre><span class="ruby-comment"># File app/models/milestone.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">active</span> + <span class="ruby-identifier">where</span>(<span class="ruby-string">"due_date > ? OR due_date IS NULL"</span>, <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- active-source --> + + </div> + + + + + </div><!-- active-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-expires_at" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">expires_at</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="expires_at-source"> + <pre><span class="ruby-comment"># File app/models/milestone.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">expires_at</span> + <span class="ruby-node">"expires at #{due_date.stamp("Aug 21, 2011")}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">due_date</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- expires_at-source --> + + </div> + + + + + </div><!-- expires_at-method --> + + + <div id="method-i-participants" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">participants</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="participants-source"> + <pre><span class="ruby-comment"># File app/models/milestone.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">participants</span> + <span class="ruby-constant">User</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">issues</span>.<span class="ruby-identifier">pluck</span>(<span class="ruby-value">:assignee_id</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- participants-source --> + + </div> + + + + + </div><!-- participants-method --> + + + <div id="method-i-percent_complete" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">percent_complete</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="percent_complete-source"> + <pre><span class="ruby-comment"># File app/models/milestone.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">percent_complete</span> + ((<span class="ruby-keyword">self</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">closed</span>.<span class="ruby-identifier">count</span> * <span class="ruby-value">100</span>) <span class="ruby-operator">/</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">count</span>).<span class="ruby-identifier">abs</span> +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">ZeroDivisionError</span> + <span class="ruby-value">100</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- percent_complete-source --> + + </div> + + + + + </div><!-- percent_complete-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/MilestonesController.html b/doc/app/MilestonesController.html new file mode 100644 index 00000000000..e15d6fef06f --- /dev/null +++ b/doc/app/MilestonesController.html @@ -0,0 +1,816 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class MilestonesController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/milestones_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-authorize_admin_milestone-21">#authorize_admin_milestone!</a> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-milestone">#milestone</a> + + <li><a href="#method-i-module_enabled">#module_enabled</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class MilestonesController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 42</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@milestone</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">milestones</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:milestone</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@milestone</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_milestone_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@milestone</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"new"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 67</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">access_denied!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_milestone</span>, <span class="ruby-ivar">@milestone</span>) + + <span class="ruby-ivar">@milestone</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_milestones_path</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 28</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@milestone</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@milestones</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:f</span>] + <span class="ruby-keyword">when</span> <span class="ruby-string">'all'</span>; <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">milestones</span> + <span class="ruby-keyword">else</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">milestones</span>.<span class="ruby-identifier">active</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@milestones</span> = <span class="ruby-ivar">@milestones</span>.<span class="ruby-identifier">includes</span>(<span class="ruby-value">:project</span>).<span class="ruby-identifier">order</span>(<span class="ruby-string">"due_date"</span>) + <span class="ruby-ivar">@milestones</span> = <span class="ruby-ivar">@milestones</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@milestone</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">milestones</span>.<span class="ruby-identifier">new</span> + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@milestone</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 32</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@issues</span> = <span class="ruby-ivar">@milestone</span>.<span class="ruby-identifier">issues</span> + <span class="ruby-ivar">@users</span> = <span class="ruby-ivar">@milestone</span>.<span class="ruby-identifier">participants</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-ivar">@milestone</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:milestone</span>]) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@milestone</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@milestone</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-value">:edit</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-authorize_admin_milestone-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_admin_milestone!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_admin_milestone-21-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 84</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_admin_milestone!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_milestone</span>, <span class="ruby-ivar">@project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_admin_milestone-21-source --> + + </div> + + + + + </div><!-- authorize_admin_milestone-21-method --> + + + <div id="method-i-milestone" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">milestone</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="milestone-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 80</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">milestone</span> + <span class="ruby-ivar">@milestone</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">milestones</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- milestone-source --> + + </div> + + + + + </div><!-- milestone-method --> + + + <div id="method-i-module_enabled" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">module_enabled</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="module_enabled-source"> + <pre><span class="ruby-comment"># File app/controllers/milestones_controller.rb, line 88</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">module_enabled</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">issues_enabled</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- module_enabled-source --> + + </div> + + + + + </div><!-- module_enabled-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Note.html b/doc/app/Note.html new file mode 100644 index 00000000000..24a474b0296 --- /dev/null +++ b/doc/app/Note.html @@ -0,0 +1,777 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Note - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/note.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-create_status_change_note">::create_status_change_note</a> + + <li><a href="#method-i-commit_author">#commit_author</a> + + <li><a href="#method-i-downvote-3F">#downvote?</a> + + <li><a href="#method-i-for_commit-3F">#for_commit?</a> + + <li><a href="#method-i-for_diff_line-3F">#for_diff_line?</a> + + <li><a href="#method-i-noteable">#noteable</a> + + <li><a href="#method-i-notify_only_author-3F">#notify_only_author?</a> + + <li><a href="#method-i-upvote-3F">#upvote?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Note</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-notify" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">notify</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-notify_author" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">notify_author</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-create_status_change_note" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create_status_change_note</span><span + class="method-args">(noteable, author, status)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create_status_change_note-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">create_status_change_note</span>(<span class="ruby-identifier">noteable</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">status</span>) + <span class="ruby-identifier">create</span>({ + <span class="ruby-identifier">noteable</span><span class="ruby-operator">:</span> <span class="ruby-identifier">noteable</span>, + <span class="ruby-identifier">project</span><span class="ruby-operator">:</span> <span class="ruby-identifier">noteable</span>.<span class="ruby-identifier">project</span>, + <span class="ruby-identifier">author</span><span class="ruby-operator">:</span> <span class="ruby-identifier">author</span>, + <span class="ruby-identifier">note</span><span class="ruby-operator">:</span> <span class="ruby-node">"_Status changed to #{status}_"</span> + }, <span class="ruby-identifier">without_protection</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- create_status_change_note-source --> + + </div> + + + + + </div><!-- create_status_change_note-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-commit_author" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commit_author</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commit_author-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 90</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commit_author</span> + <span class="ruby-ivar">@commit_author</span> <span class="ruby-operator">||=</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">users</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">noteable</span>.<span class="ruby-identifier">author_email</span>) <span class="ruby-operator">||</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">users</span>.<span class="ruby-identifier">find_by_name</span>(<span class="ruby-identifier">noteable</span>.<span class="ruby-identifier">author_name</span>) +<span class="ruby-keyword">rescue</span> + <span class="ruby-keyword">nil</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- commit_author-source --> + + </div> + + + + + </div><!-- commit_author-method --> + + + <div id="method-i-downvote-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">downvote?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns true if this is a downvote note, otherwise false is returned</p> + + + + <div class="method-source-code" id="downvote-3F-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 106</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">downvote?</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">'-1'</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">':-1:'</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- downvote-3F-source --> + + </div> + + + + + </div><!-- downvote-3F-method --> + + + <div id="method-i-for_commit-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">for_commit?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="for_commit-3F-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 82</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">for_commit?</span> + <span class="ruby-identifier">noteable_type</span> <span class="ruby-operator">==</span> <span class="ruby-string">"Commit"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- for_commit-3F-source --> + + </div> + + + + + </div><!-- for_commit-3F-method --> + + + <div id="method-i-for_diff_line-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">for_diff_line?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="for_diff_line-3F-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 86</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">for_diff_line?</span> + <span class="ruby-identifier">line_code</span>.<span class="ruby-identifier">present?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- for_diff_line-3F-source --> + + </div> + + + + + </div><!-- for_diff_line-3F-method --> + + + <div id="method-i-noteable" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">noteable</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>override to return commits, which are not active record</p> + + + + <div class="method-source-code" id="noteable-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">noteable</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">for_commit?</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">noteable_id</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">super</span> + <span class="ruby-keyword">end</span> +<span class="ruby-comment"># Temp fix to prevent app crash</span> +<span class="ruby-comment"># if note commit id doesnt exist</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-keyword">nil</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- noteable-source --> + + </div> + + + + + </div><!-- noteable-method --> + + + <div id="method-i-notify_only_author-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">notify_only_author?</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Check if we can notify commit author with email about our comment</p> + +<p>If commit author email exist in project and commit author is not passed +user we can send email to him</p> + +<p>params:</p> + +<pre>user - current user</pre> + +<p>return:</p> + +<pre>Boolean</pre> + + + + <div class="method-source-code" id="notify_only_author-3F-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">notify_only_author?</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-identifier">for_commit?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">commit_author</span> <span class="ruby-operator">&&</span> + <span class="ruby-identifier">commit_author</span>.<span class="ruby-identifier">email</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">email</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- notify_only_author-3F-source --> + + </div> + + + + + </div><!-- notify_only_author-3F-method --> + + + <div id="method-i-upvote-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">upvote?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns true if this is an upvote note, otherwise false is returned</p> + + + + <div class="method-source-code" id="upvote-3F-source"> + <pre><span class="ruby-comment"># File app/models/note.rb, line 100</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">upvote?</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">'+1'</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">':+1:'</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- upvote-3F-source --> + + </div> + + + + + </div><!-- upvote-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/NoteObserver.html b/doc/app/NoteObserver.html new file mode 100644 index 00000000000..d0528833815 --- /dev/null +++ b/doc/app/NoteObserver.html @@ -0,0 +1,603 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class NoteObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/note_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-notify_team">#notify_team</a> + + <li><a href="#method-i-send_notify_mails">#send_notify_mails</a> + + <li><a href="#method-i-team_without_note_author">#team_without_note_author</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class NoteObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(note)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/note_observer.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span>(<span class="ruby-identifier">note</span>) + <span class="ruby-identifier">send_notify_mails</span>(<span class="ruby-identifier">note</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-notify_team" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">notify_team</span><span + class="method-args">(note)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Notifies the whole team except the author of note</p> + + + + <div class="method-source-code" id="notify_team-source"> + <pre><span class="ruby-comment"># File app/observers/note_observer.rb, line 22</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">notify_team</span>(<span class="ruby-identifier">note</span>) + <span class="ruby-comment"># Note: wall posts are not "attached" to anything, so fall back to "Wall"</span> + <span class="ruby-identifier">noteable_type</span> = <span class="ruby-identifier">note</span>.<span class="ruby-identifier">noteable_type</span> <span class="ruby-operator">||</span> <span class="ruby-string">"Wall"</span> + <span class="ruby-identifier">notify_method</span> = <span class="ruby-node">"note_#{noteable_type.underscore}_email"</span>.<span class="ruby-identifier">to_sym</span> + + <span class="ruby-keyword">if</span> <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">respond_to?</span> <span class="ruby-identifier">notify_method</span> + <span class="ruby-identifier">team_without_note_author</span>(<span class="ruby-identifier">note</span>).<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">u</span><span class="ruby-operator">|</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">notify_method</span>, <span class="ruby-identifier">u</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">note</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">deliver</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- notify_team-source --> + + </div> + + + + + </div><!-- notify_team-method --> + + + <div id="method-i-send_notify_mails" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">send_notify_mails</span><span + class="method-args">(note)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="send_notify_mails-source"> + <pre><span class="ruby-comment"># File app/observers/note_observer.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">send_notify_mails</span>(<span class="ruby-identifier">note</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">notify</span> + <span class="ruby-identifier">notify_team</span>(<span class="ruby-identifier">note</span>) + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">notify_author</span> + <span class="ruby-comment"># Notify only author of resource</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">note_commit_email</span>(<span class="ruby-identifier">note</span>.<span class="ruby-identifier">commit_author</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">note</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">deliver</span> + <span class="ruby-keyword">else</span> + <span class="ruby-comment"># Otherwise ignore it</span> + <span class="ruby-keyword">nil</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- send_notify_mails-source --> + + </div> + + + + + </div><!-- send_notify_mails-method --> + + + <div id="method-i-team_without_note_author" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">team_without_note_author</span><span + class="method-args">(note)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="team_without_note_author-source"> + <pre><span class="ruby-comment"># File app/observers/note_observer.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">team_without_note_author</span>(<span class="ruby-identifier">note</span>) + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">users</span>.<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">u</span><span class="ruby-operator">|</span> <span class="ruby-identifier">u</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">author</span>.<span class="ruby-identifier">id</span> } +<span class="ruby-keyword">end</span></pre> + </div><!-- team_without_note_author-source --> + + </div> + + + + + </div><!-- team_without_note_author-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Notes.html b/doc/app/Notes.html new file mode 100644 index 00000000000..d6bcc54011a --- /dev/null +++ b/doc/app/Notes.html @@ -0,0 +1,434 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Notes - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/notes/create_context.rb + <li>app/contexts/notes/load_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Notes</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Notes/CreateContext.html b/doc/app/Notes/CreateContext.html new file mode 100644 index 00000000000..6d4c8449323 --- /dev/null +++ b/doc/app/Notes/CreateContext.html @@ -0,0 +1,490 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Notes::CreateContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/notes/create_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../BaseContext.html">BaseContext</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Notes::CreateContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/notes/create_context.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-identifier">note</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:note</span>]) + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">author</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">notify</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:notify</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'1'</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">notify_author</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:notify_author</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'1'</span> + <span class="ruby-identifier">note</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">note</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Notes/LoadContext.html b/doc/app/Notes/LoadContext.html new file mode 100644 index 00000000000..273fc0f0c8d --- /dev/null +++ b/doc/app/Notes/LoadContext.html @@ -0,0 +1,513 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Notes::LoadContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/notes/load_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="../BaseContext.html">BaseContext</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Notes::LoadContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/notes/load_context.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-identifier">target_type</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:target_type</span>] + <span class="ruby-identifier">target_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:target_id</span>] + <span class="ruby-identifier">after_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:after_id</span>] + <span class="ruby-identifier">before_id</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:before_id</span>] + + + <span class="ruby-ivar">@notes</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">target_type</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"commit"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit_notes</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">target_id</span>)).<span class="ruby-identifier">fresh</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-value">20</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"issue"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">issues</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">target_id</span>).<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">inc_author</span>.<span class="ruby-identifier">fresh</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-value">20</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"merge_request"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">target_id</span>).<span class="ruby-identifier">mr_and_commit_notes</span>.<span class="ruby-identifier">inc_author</span>.<span class="ruby-identifier">fresh</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-value">20</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"snippet"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">target_id</span>).<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">fresh</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"wall"</span> + <span class="ruby-comment"># this is the only case, where the order is DESC</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">common_notes</span>.<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at DESC, id DESC"</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">50</span>) + <span class="ruby-keyword">when</span> <span class="ruby-string">"wiki"</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">wiki_notes</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-value">20</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@notes</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">after_id</span> + <span class="ruby-ivar">@notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"id > ?"</span>, <span class="ruby-identifier">after_id</span>) + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">before_id</span> + <span class="ruby-ivar">@notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"id < ?"</span>, <span class="ruby-identifier">before_id</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@notes</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/NotesController.html b/doc/app/NotesController.html new file mode 100644 index 00000000000..5623d4a2f5c --- /dev/null +++ b/doc/app/NotesController.html @@ -0,0 +1,636 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class NotesController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/notes_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-notes">#notes</a> + + <li><a href="#method-i-preview">#preview</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class NotesController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/notes_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@note</span> = <span class="ruby-constant">Notes</span><span class="ruby-operator">::</span><span class="ruby-constant">CreateContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> {<span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span>} + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/notes_controller.rb, line 27</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@note</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-keyword">return</span> <span class="ruby-identifier">access_denied!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_note</span>, <span class="ruby-ivar">@note</span>) + <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/notes_controller.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-identifier">notes</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:target_type</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"merge_request"</span> + <span class="ruby-ivar">@mixed_targets</span> = <span class="ruby-keyword">true</span> + <span class="ruby-ivar">@main_target_type</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:target_type</span>].<span class="ruby-identifier">camelize</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@notes</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-preview" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">preview</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="preview-source"> + <pre><span class="ruby-comment"># File app/controllers/notes_controller.rb, line 37</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">preview</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">text</span><span class="ruby-operator">:</span> <span class="ruby-identifier">view_context</span>.<span class="ruby-identifier">markdown</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:note</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- preview-source --> + + </div> + + + + + </div><!-- preview-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-notes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">notes</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="notes-source"> + <pre><span class="ruby-comment"># File app/controllers/notes_controller.rb, line 43</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">notes</span> + <span class="ruby-ivar">@notes</span> = <span class="ruby-constant">Notes</span><span class="ruby-operator">::</span><span class="ruby-constant">LoadContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">current_user</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- notes-source --> + + </div> + + + + + </div><!-- notes-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/NotesHelper.html b/doc/app/NotesHelper.html new file mode 100644 index 00000000000..c2940f8dc95 --- /dev/null +++ b/doc/app/NotesHelper.html @@ -0,0 +1,581 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module NotesHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/notes_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-link_to_commit_diff_line_note">#link_to_commit_diff_line_note</a> + + <li><a href="#method-i-loading_more_notes-3F">#loading_more_notes?</a> + + <li><a href="#method-i-loading_new_notes-3F">#loading_new_notes?</a> + + <li><a href="#method-i-note_for_main_target-3F">#note_for_main_target?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module NotesHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-link_to_commit_diff_line_note" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_commit_diff_line_note</span><span + class="method-args">(note)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="link_to_commit_diff_line_note-source"> + <pre><span class="ruby-comment"># File app/helpers/notes_helper.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_commit_diff_line_note</span>(<span class="ruby-identifier">note</span>) + <span class="ruby-identifier">commit</span> = <span class="ruby-identifier">note</span>.<span class="ruby-identifier">noteable</span> + <span class="ruby-identifier">diff_index</span>, <span class="ruby-identifier">diff_old_line</span>, <span class="ruby-identifier">diff_new_line</span> = <span class="ruby-identifier">note</span>.<span class="ruby-identifier">line_code</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'_'</span>) + + <span class="ruby-identifier">link_file</span> = <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">diffs</span>[<span class="ruby-identifier">diff_index</span>.<span class="ruby-identifier">to_i</span>].<span class="ruby-identifier">new_path</span> + <span class="ruby-identifier">link_line</span> = <span class="ruby-identifier">diff_new_line</span> + + <span class="ruby-identifier">link_to</span> <span class="ruby-node">"#{link_file}:L#{link_line}"</span>, <span class="ruby-identifier">project_commit_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-identifier">commit</span>, <span class="ruby-identifier">anchor</span><span class="ruby-operator">:</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">line_code</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_commit_diff_line_note-source --> + + </div> + + + + + </div><!-- link_to_commit_diff_line_note-method --> + + + <div id="method-i-loading_more_notes-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">loading_more_notes?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="loading_more_notes-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/notes_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">loading_more_notes?</span> + <span class="ruby-identifier">params</span>[<span class="ruby-value">:loading_more</span>].<span class="ruby-identifier">present?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- loading_more_notes-3F-source --> + + </div> + + + + + </div><!-- loading_more_notes-3F-method --> + + + <div id="method-i-loading_new_notes-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">loading_new_notes?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="loading_new_notes-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/notes_helper.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">loading_new_notes?</span> + <span class="ruby-identifier">params</span>[<span class="ruby-value">:loading_new</span>].<span class="ruby-identifier">present?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- loading_new_notes-3F-source --> + + </div> + + + + + </div><!-- loading_new_notes-3F-method --> + + + <div id="method-i-note_for_main_target-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">note_for_main_target?</span><span + class="method-args">(note)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Helps to distinguish e.g. commit notes in mr notes list</p> + + + + <div class="method-source-code" id="note_for_main_target-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/notes_helper.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">note_for_main_target?</span>(<span class="ruby-identifier">note</span>) + <span class="ruby-operator">!</span><span class="ruby-ivar">@mixed_targets</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@main_target_type</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">note</span>.<span class="ruby-identifier">noteable_type</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- note_for_main_target-3F-source --> + + </div> + + + + + </div><!-- note_for_main_target-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Notify.html b/doc/app/Notify.html new file mode 100644 index 00000000000..933e1cbc372 --- /dev/null +++ b/doc/app/Notify.html @@ -0,0 +1,883 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Notify - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/mailers/notify.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActionMailer::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><span class="include">Resque::Mailer</span> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-issue_status_changed_email">#issue_status_changed_email</a> + + <li><a href="#method-i-new_issue_email">#new_issue_email</a> + + <li><a href="#method-i-new_merge_request_email">#new_merge_request_email</a> + + <li><a href="#method-i-new_user_email">#new_user_email</a> + + <li><a href="#method-i-note_commit_email">#note_commit_email</a> + + <li><a href="#method-i-note_issue_email">#note_issue_email</a> + + <li><a href="#method-i-note_merge_request_email">#note_merge_request_email</a> + + <li><a href="#method-i-note_wall_email">#note_wall_email</a> + + <li><a href="#method-i-note_wiki_email">#note_wiki_email</a> + + <li><a href="#method-i-project_access_granted_email">#project_access_granted_email</a> + + <li><a href="#method-i-reassigned_issue_email">#reassigned_issue_email</a> + + <li><a href="#method-i-reassigned_merge_request_email">#reassigned_merge_request_email</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Notify</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-issue_status_changed_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issue_status_changed_email</span><span + class="method-args">(recipient_id, issue_id, status, updated_by_user_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issue_status_changed_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issue_status_changed_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">issue_id</span>, <span class="ruby-identifier">status</span>, <span class="ruby-identifier">updated_by_user_id</span>) + <span class="ruby-ivar">@issue</span> = <span class="ruby-constant">Issue</span>.<span class="ruby-identifier">find</span> <span class="ruby-identifier">issue_id</span> + <span class="ruby-ivar">@issue_status</span> = <span class="ruby-identifier">status</span> + <span class="ruby-ivar">@updated_by</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span> <span class="ruby-identifier">updated_by_user_id</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), + <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"changed issue ##{@issue.id}"</span>, <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">title</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- issue_status_changed_email-source --> + + </div> + + + + + </div><!-- issue_status_changed_email-method --> + + + <div id="method-i-new_issue_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_issue_email</span><span + class="method-args">(issue_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p><a href="Issue.html">Issue</a></p> + + + + <div class="method-source-code" id="new_issue_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_issue_email</span>(<span class="ruby-identifier">issue_id</span>) + <span class="ruby-ivar">@issue</span> = <span class="ruby-constant">Issue</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">issue_id</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">assignee_email</span>, <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"new issue ##{@issue.id}"</span>, <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">title</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- new_issue_email-source --> + + </div> + + + + + </div><!-- new_issue_email-method --> + + + <div id="method-i-new_merge_request_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_merge_request_email</span><span + class="method-args">(merge_request_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Merge Request</p> + + + + <div class="method-source-code" id="new_merge_request_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 45</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_merge_request_email</span>(<span class="ruby-identifier">merge_request_id</span>) + <span class="ruby-ivar">@merge_request</span> = <span class="ruby-constant">MergeRequest</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">merge_request_id</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">assignee_email</span>, <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"new merge request !#{@merge_request.id}"</span>, <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">title</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- new_merge_request_email-source --> + + </div> + + + + + </div><!-- new_merge_request_email-method --> + + + <div id="method-i-new_user_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_user_email</span><span + class="method-args">(user_id, password)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p><a href="User.html">User</a></p> + + + + <div class="method-source-code" id="new_user_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 118</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_user_email</span>(<span class="ruby-identifier">user_id</span>, <span class="ruby-identifier">password</span>) + <span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">user_id</span>) + <span class="ruby-ivar">@password</span> = <span class="ruby-identifier">password</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">email</span>, <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-string">"Account was created for you"</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- new_user_email-source --> + + </div> + + + + + </div><!-- new_user_email-method --> + + + <div id="method-i-note_commit_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">note_commit_email</span><span + class="method-args">(recipient_id, note_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p><a href="Note.html">Note</a></p> + + + + <div class="method-source-code" id="note_commit_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 64</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">note_commit_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@note</span> = <span class="ruby-constant">Note</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@commit</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">noteable</span> + <span class="ruby-ivar">@commit</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@commit</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"note for commit #{@commit.short_id}"</span>, <span class="ruby-ivar">@commit</span>.<span class="ruby-identifier">title</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- note_commit_email-source --> + + </div> + + + + + </div><!-- note_commit_email-method --> + + + <div id="method-i-note_issue_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">note_issue_email</span><span + class="method-args">(recipient_id, note_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="note_issue_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 72</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">note_issue_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@note</span> = <span class="ruby-constant">Note</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@issue</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">noteable</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"note for issue ##{@issue.id}"</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- note_issue_email-source --> + + </div> + + + + + </div><!-- note_issue_email-method --> + + + <div id="method-i-note_merge_request_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">note_merge_request_email</span><span + class="method-args">(recipient_id, note_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="note_merge_request_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 79</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">note_merge_request_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@note</span> = <span class="ruby-constant">Note</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@merge_request</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">noteable</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"note for merge request !#{@merge_request.id}"</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- note_merge_request_email-source --> + + </div> + + + + + </div><!-- note_merge_request_email-method --> + + + <div id="method-i-note_wall_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">note_wall_email</span><span + class="method-args">(recipient_id, note_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="note_wall_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 86</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">note_wall_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@note</span> = <span class="ruby-constant">Note</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- note_wall_email-source --> + + </div> + + + + + </div><!-- note_wall_email-method --> + + + <div id="method-i-note_wiki_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">note_wiki_email</span><span + class="method-args">(recipient_id, note_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="note_wiki_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 92</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">note_wiki_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@note</span> = <span class="ruby-constant">Note</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">note_id</span>) + <span class="ruby-ivar">@wiki</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">noteable</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@note</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-string">"note for wiki"</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- note_wiki_email-source --> + + </div> + + + + + </div><!-- note_wiki_email-method --> + + + <div id="method-i-project_access_granted_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_access_granted_email</span><span + class="method-args">(user_project_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p><a href="Project.html">Project</a></p> + + + + <div class="method-source-code" id="project_access_granted_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 105</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_access_granted_email</span>(<span class="ruby-identifier">user_project_id</span>) + <span class="ruby-ivar">@users_project</span> = <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">find</span> <span class="ruby-identifier">user_project_id</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@users_project</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@users_project</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">email</span>, + <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-string">"access to project was granted"</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- project_access_granted_email-source --> + + </div> + + + + + </div><!-- project_access_granted_email-method --> + + + <div id="method-i-reassigned_issue_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reassigned_issue_email</span><span + class="method-args">(recipient_id, issue_id, previous_assignee_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reassigned_issue_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reassigned_issue_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">issue_id</span>, <span class="ruby-identifier">previous_assignee_id</span>) + <span class="ruby-ivar">@issue</span> = <span class="ruby-constant">Issue</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">issue_id</span>) + <span class="ruby-ivar">@previous_assignee</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">previous_assignee_id</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"changed issue ##{@issue.id}"</span>, <span class="ruby-ivar">@issue</span>.<span class="ruby-identifier">title</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- reassigned_issue_email-source --> + + </div> + + + + + </div><!-- reassigned_issue_email-method --> + + + <div id="method-i-reassigned_merge_request_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reassigned_merge_request_email</span><span + class="method-args">(recipient_id, merge_request_id, previous_assignee_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reassigned_merge_request_email-source"> + <pre><span class="ruby-comment"># File app/mailers/notify.rb, line 51</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reassigned_merge_request_email</span>(<span class="ruby-identifier">recipient_id</span>, <span class="ruby-identifier">merge_request_id</span>, <span class="ruby-identifier">previous_assignee_id</span>) + <span class="ruby-ivar">@merge_request</span> = <span class="ruby-constant">MergeRequest</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">merge_request_id</span>) + <span class="ruby-ivar">@previous_assignee</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">User</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">previous_assignee_id</span>) + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">project</span> + <span class="ruby-identifier">mail</span>(<span class="ruby-identifier">to</span><span class="ruby-operator">:</span> <span class="ruby-identifier">recipient</span>(<span class="ruby-identifier">recipient_id</span>), <span class="ruby-identifier">subject</span><span class="ruby-operator">:</span> <span class="ruby-identifier">subject</span>(<span class="ruby-node">"changed merge request !#{@merge_request.id}"</span>, <span class="ruby-ivar">@merge_request</span>.<span class="ruby-identifier">title</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- reassigned_merge_request_email-source --> + + </div> + + + + + </div><!-- reassigned_merge_request_email-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/OmniauthCallbacksController.html b/doc/app/OmniauthCallbacksController.html new file mode 100644 index 00000000000..d40a16a3eb9 --- /dev/null +++ b/doc/app/OmniauthCallbacksController.html @@ -0,0 +1,527 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class OmniauthCallbacksController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/omniauth_callbacks_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Devise::OmniauthCallbacksController + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-failure_message">#failure_message</a> + + <li><a href="#method-i-ldap">#ldap</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class OmniauthCallbacksController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-failure_message" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">failure_message</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Extend the standard message generation to accept our custom exception</p> + + + + <div class="method-source-code" id="failure_message-source"> + <pre><span class="ruby-comment"># File app/controllers/omniauth_callbacks_controller.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">failure_message</span> + <span class="ruby-identifier">exception</span> = <span class="ruby-identifier">env</span>[<span class="ruby-string">"omniauth.error"</span>] + <span class="ruby-identifier">error</span> = <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">error_reason</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:error_reason</span>) + <span class="ruby-identifier">error</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">error</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:error</span>) + <span class="ruby-identifier">error</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">message</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">exception</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:message</span>) + <span class="ruby-identifier">error</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">env</span>[<span class="ruby-string">"omniauth.error.type"</span>].<span class="ruby-identifier">to_s</span> + <span class="ruby-identifier">error</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">humanize</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">error</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- failure_message-source --> + + </div> + + + + + </div><!-- failure_message-method --> + + + <div id="method-i-ldap" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ldap</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="ldap-source"> + <pre><span class="ruby-comment"># File app/controllers/omniauth_callbacks_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ldap</span> + <span class="ruby-comment"># We only find ourselves here if the authentication to LDAP was successful.</span> + <span class="ruby-ivar">@user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_for_ldap_auth</span>(<span class="ruby-identifier">request</span>.<span class="ruby-identifier">env</span>[<span class="ruby-string">"omniauth.auth"</span>], <span class="ruby-identifier">current_user</span>) + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">persisted?</span> + <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">remember_me</span> = <span class="ruby-keyword">true</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">sign_in_and_redirect</span> <span class="ruby-ivar">@user</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- ldap-source --> + + </div> + + + + + </div><!-- ldap-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/PostReceive.html b/doc/app/PostReceive.html new file mode 100644 index 00000000000..11468fd9ca9 --- /dev/null +++ b/doc/app/PostReceive.html @@ -0,0 +1,495 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class PostReceive - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/workers/post_receive.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-perform">::perform</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class PostReceive</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-perform" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">perform</span><span + class="method-args">(reponame, oldrev, newrev, ref, identifier)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="perform-source"> + <pre><span class="ruby-comment"># File app/workers/post_receive.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">perform</span>(<span class="ruby-identifier">reponame</span>, <span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">identifier</span>) + <span class="ruby-identifier">project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">find_by_path</span>(<span class="ruby-identifier">reponame</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">nil?</span> + + <span class="ruby-comment"># Ignore push from non-gitlab users</span> + <span class="ruby-keyword">if</span> <span class="ruby-regexp">%r^[A-Z0-9._%a-z\-]+@(?:[A-Z0-9a-z\-]+\.)+[A-Za-z]{2,4}$/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">identifier</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">user</span> = <span class="ruby-constant">User</span>.<span class="ruby-identifier">find_by_email</span>(<span class="ruby-identifier">identifier</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">user</span> = <span class="ruby-constant">Key</span>.<span class="ruby-identifier">find_by_identifier</span>(<span class="ruby-identifier">identifier</span>).<span class="ruby-identifier">try</span>(<span class="ruby-value">:user</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">trigger_post_receive</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- perform-source --> + + </div> + + + + + </div><!-- perform-method --> + + + </section><!-- public-class-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProfileController.html b/doc/app/ProfileController.html new file mode 100644 index 00000000000..deb4b0bcb67 --- /dev/null +++ b/doc/app/ProfileController.html @@ -0,0 +1,683 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ProfileController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/profile_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-design">#design</a> + + <li><a href="#method-i-history">#history</a> + + <li><a href="#method-i-password_update">#password_update</a> + + <li><a href="#method-i-reset_private_token">#reset_private_token</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-token">#token</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ProfileController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-design" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">design</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="design-source"> + <pre><span class="ruby-comment"># File app/controllers/profile_controller.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">design</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- design-source --> + + </div> + + + + + </div><!-- design-method --> + + + <div id="method-i-history" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">history</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="history-source"> + <pre><span class="ruby-comment"># File app/controllers/profile_controller.rb, line 34</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">history</span> + <span class="ruby-ivar">@events</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">recent_events</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>]).<span class="ruby-identifier">per</span>(<span class="ruby-value">20</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- history-source --> + + </div> + + + + + </div><!-- history-method --> + + + <div id="method-i-password_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">password_update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="password_update-source"> + <pre><span class="ruby-comment"># File app/controllers/profile_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">password_update</span> + <span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>].<span class="ruby-identifier">reject!</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span> <span class="ruby-operator">!=</span> <span class="ruby-string">"password"</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">k</span> <span class="ruby-operator">!=</span> <span class="ruby-string">"password_confirmation"</span>} + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>]) + <span class="ruby-identifier">flash</span>[<span class="ruby-value">:notice</span>] = <span class="ruby-string">"Password was successfully updated. Please login with it"</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">new_user_session_path</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"password"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- password_update-source --> + + </div> + + + + + </div><!-- password_update-method --> + + + <div id="method-i-reset_private_token" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">reset_private_token</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="reset_private_token-source"> + <pre><span class="ruby-comment"># File app/controllers/profile_controller.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">reset_private_token</span> + <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">reset_authentication_token!</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">profile_account_path</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- reset_private_token-source --> + + </div> + + + + + </div><!-- reset_private_token-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/profile_controller.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-token" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">token</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="token-source"> + <pre><span class="ruby-comment"># File app/controllers/profile_controller.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">token</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- token-source --> + + </div> + + + + + </div><!-- token-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/profile_controller.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-ivar">@user</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:user</span>]) + <span class="ruby-identifier">redirect_to</span> <span class="ruby-value">:back</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProfileHelper.html b/doc/app/ProfileHelper.html new file mode 100644 index 00000000000..ab7773ba6be --- /dev/null +++ b/doc/app/ProfileHelper.html @@ -0,0 +1,481 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module ProfileHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/profile_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-oauth_active_class">#oauth_active_class</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module ProfileHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-oauth_active_class" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">oauth_active_class</span><span + class="method-args">(provider)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="oauth_active_class-source"> + <pre><span class="ruby-comment"># File app/helpers/profile_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">oauth_active_class</span> <span class="ruby-identifier">provider</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">provider</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">provider</span>.<span class="ruby-identifier">to_s</span> + <span class="ruby-string">'active'</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- oauth_active_class-source --> + + </div> + + + + + </div><!-- oauth_active_class-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Project.html b/doc/app/Project.html new file mode 100644 index 00000000000..55868ef1838 --- /dev/null +++ b/doc/app/Project.html @@ -0,0 +1,1202 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Project - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/project.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="Repository.html">Repository</a> + + + + <li><a class="include" href="PushObserver.html">PushObserver</a> + + + + <li><a class="include" href="Authority.html">Authority</a> + + + + <li><a class="include" href="Team.html">Team</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-access_options">::access_options</a> + + <li><a href="#method-c-active">::active</a> + + <li><a href="#method-c-create_by_user">::create_by_user</a> + + <li><a href="#method-c-search">::search</a> + + <li><a href="#method-i-build_commit_note">#build_commit_note</a> + + <li><a href="#method-i-check_limit">#check_limit</a> + + <li><a href="#method-i-commit_line_notes">#commit_line_notes</a> + + <li><a href="#method-i-commit_notes">#commit_notes</a> + + <li><a href="#method-i-common_notes">#common_notes</a> + + <li><a href="#method-i-git_error-3F">#git_error?</a> + + <li><a href="#method-i-issues_labels">#issues_labels</a> + + <li><a href="#method-i-last_activity">#last_activity</a> + + <li><a href="#method-i-last_activity_date">#last_activity_date</a> + + <li><a href="#method-i-private-3F">#private?</a> + + <li><a href="#method-i-project_id">#project_id</a> + + <li><a href="#method-i-public-3F">#public?</a> + + <li><a href="#method-i-repo_name">#repo_name</a> + + <li><a href="#method-i-saved-3F">#saved?</a> + + <li><a href="#method-i-to_param">#to_param</a> + + <li><a href="#method-i-web_url">#web_url</a> + + <li><a href="#method-i-wiki_notes">#wiki_notes</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Project</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-error_code" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">error_code</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-access_options" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">access_options</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="access_options-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">access_options</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">access_roles</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- access_options-source --> + + </div> + + + + + </div><!-- access_options-method --> + + + <div id="method-c-active" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">active</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="active-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">active</span> + <span class="ruby-identifier">joins</span>(<span class="ruby-value">:issues</span>, <span class="ruby-value">:notes</span>, <span class="ruby-value">:merge_requests</span>).<span class="ruby-identifier">order</span>(<span class="ruby-string">"issues.created_at, notes.created_at, merge_requests.created_at DESC"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- active-source --> + + </div> + + + + + </div><!-- active-method --> + + + <div id="method-c-create_by_user" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create_by_user</span><span + class="method-args">(params, user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create_by_user-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 60</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_by_user</span>(<span class="ruby-identifier">params</span>, <span class="ruby-identifier">user</span>) + <span class="ruby-identifier">project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">params</span> + + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-identifier">user</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">save!</span> + + <span class="ruby-comment"># Add user as project master</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">create!</span>(<span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-constant">UsersProject</span><span class="ruby-operator">::</span><span class="ruby-constant">MASTER</span>, <span class="ruby-identifier">user</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>) + + <span class="ruby-comment"># when project saved no team member exist so</span> + <span class="ruby-comment"># project repository should be updated after first user add</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">update_repository</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">project</span> +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Gitolite</span><span class="ruby-operator">::</span><span class="ruby-constant">AccessDenied</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">error_code</span> = <span class="ruby-value">:gitolite</span> + <span class="ruby-identifier">project</span> +<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">error_code</span> = <span class="ruby-value">:db</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span>(<span class="ruby-value">:base</span>, <span class="ruby-string">"Can't save project. Please try again later"</span>) + <span class="ruby-identifier">project</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create_by_user-source --> + + </div> + + + + + </div><!-- create_by_user-method --> + + + <div id="method-c-search" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">search</span><span + class="method-args">(query)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="search-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">search</span> <span class="ruby-identifier">query</span> + <span class="ruby-identifier">where</span>(<span class="ruby-string">"name LIKE :query OR code LIKE :query OR path LIKE :query"</span>, <span class="ruby-identifier">query</span><span class="ruby-operator">:</span> <span class="ruby-node">"%#{query}%"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- search-source --> + + </div> + + + + + </div><!-- search-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-build_commit_note" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">build_commit_note</span><span + class="method-args">(commit)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="build_commit_note-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 124</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">build_commit_note</span>(<span class="ruby-identifier">commit</span>) + <span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">noteable_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">noteable_type</span><span class="ruby-operator">:</span> <span class="ruby-string">"Commit"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- build_commit_note-source --> + + </div> + + + + + </div><!-- build_commit_note-method --> + + + <div id="method-i-check_limit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">check_limit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="check_limit-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 98</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">check_limit</span> + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">owner</span>.<span class="ruby-identifier">can_create_project?</span> + <span class="ruby-identifier">errors</span>[<span class="ruby-value">:base</span>] <span class="ruby-operator"><<</span> (<span class="ruby-node">"Your own projects limit is #{owner.projects_limit}! Please contact administrator to increase it"</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-identifier">errors</span>[<span class="ruby-value">:base</span>] <span class="ruby-operator"><<</span> (<span class="ruby-string">"Can't check your ability to create project"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- check_limit-source --> + + </div> + + + + + </div><!-- check_limit-method --> + + + <div id="method-i-commit_line_notes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commit_line_notes</span><span + class="method-args">(commit)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commit_line_notes-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 132</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commit_line_notes</span>(<span class="ruby-identifier">commit</span>) + <span class="ruby-identifier">notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">noteable_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">noteable_type</span><span class="ruby-operator">:</span> <span class="ruby-string">"Commit"</span>).<span class="ruby-identifier">where</span>(<span class="ruby-string">"line_code IS NOT NULL"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commit_line_notes-source --> + + </div> + + + + + </div><!-- commit_line_notes-method --> + + + <div id="method-i-commit_notes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commit_notes</span><span + class="method-args">(commit)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commit_notes-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 128</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commit_notes</span>(<span class="ruby-identifier">commit</span>) + <span class="ruby-identifier">notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">noteable_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">noteable_type</span><span class="ruby-operator">:</span> <span class="ruby-string">"Commit"</span>, <span class="ruby-identifier">line_code</span><span class="ruby-operator">:</span> <span class="ruby-keyword">nil</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commit_notes-source --> + + </div> + + + + + </div><!-- commit_notes-method --> + + + <div id="method-i-common_notes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">common_notes</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="common_notes-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 120</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">common_notes</span> + <span class="ruby-identifier">notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">noteable_type</span><span class="ruby-operator">:</span> [<span class="ruby-string">""</span>, <span class="ruby-keyword">nil</span>]).<span class="ruby-identifier">inc_author_project</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- common_notes-source --> + + </div> + + + + + </div><!-- common_notes-method --> + + + <div id="method-i-git_error-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">git_error?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="git_error-3F-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 90</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">git_error?</span> + <span class="ruby-identifier">error_code</span> <span class="ruby-operator">==</span> <span class="ruby-value">:gitolite</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- git_error-3F-source --> + + </div> + + + + + </div><!-- git_error-3F-method --> + + + <div id="method-i-issues_labels" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">issues_labels</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="issues_labels-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 160</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">issues_labels</span> + <span class="ruby-identifier">issues</span>.<span class="ruby-identifier">tag_counts_on</span>(<span class="ruby-value">:labels</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- issues_labels-source --> + + </div> + + + + + </div><!-- issues_labels-method --> + + + <div id="method-i-last_activity" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_activity</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_activity-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 144</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_activity</span> + <span class="ruby-identifier">last_event</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_activity-source --> + + </div> + + + + + </div><!-- last_activity-method --> + + + <div id="method-i-last_activity_date" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_activity_date</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_activity_date-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 148</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_activity_date</span> + <span class="ruby-identifier">last_event</span>.<span class="ruby-identifier">try</span>(<span class="ruby-value">:created_at</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">updated_at</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_activity_date-source --> + + </div> + + + + + </div><!-- last_activity_date-method --> + + + <div id="method-i-private-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">private?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="private-3F-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 140</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">private?</span> + <span class="ruby-identifier">private_flag</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- private-3F-source --> + + </div> + + + + + </div><!-- private-3F-method --> + + + <div id="method-i-project_id" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_id</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_id-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 156</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_id</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project_id-source --> + + </div> + + + + + </div><!-- project_id-method --> + + + <div id="method-i-public-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">public?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="public-3F-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 136</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">public?</span> + <span class="ruby-operator">!</span><span class="ruby-identifier">private_flag</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- public-3F-source --> + + </div> + + + + + </div><!-- public-3F-method --> + + + <div id="method-i-repo_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">repo_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="repo_name-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 106</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">repo_name</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span> <span class="ruby-operator">==</span> <span class="ruby-string">"gitolite-admin"</span> + <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span>(<span class="ruby-value">:path</span>, <span class="ruby-string">" like 'gitolite-admin' is not allowed"</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- repo_name-source --> + + </div> + + + + + </div><!-- repo_name-method --> + + + <div id="method-i-saved-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">saved?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="saved-3F-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 94</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">saved?</span> + <span class="ruby-identifier">id</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">valid?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- saved-3F-source --> + + </div> + + + + + </div><!-- saved-3F-method --> + + + <div id="method-i-to_param" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_param</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="to_param-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 112</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_param</span> + <span class="ruby-identifier">code</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_param-source --> + + </div> + + + + + </div><!-- to_param-method --> + + + <div id="method-i-web_url" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">web_url</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="web_url-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 116</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">web_url</span> + [<span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">url</span>, <span class="ruby-identifier">code</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">"/"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- web_url-source --> + + </div> + + + + + </div><!-- web_url-method --> + + + <div id="method-i-wiki_notes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">wiki_notes</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="wiki_notes-source"> + <pre><span class="ruby-comment"># File app/models/project.rb, line 152</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">wiki_notes</span> + <span class="ruby-constant">Note</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">noteable_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">pluck</span>(<span class="ruby-value">:id</span>), <span class="ruby-identifier">noteable_type</span><span class="ruby-operator">:</span> <span class="ruby-string">'Wiki'</span>, <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- wiki_notes-source --> + + </div> + + + + + </div><!-- wiki_notes-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProjectHook.html b/doc/app/ProjectHook.html new file mode 100644 index 00000000000..e5d17ef0e0a --- /dev/null +++ b/doc/app/ProjectHook.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ProjectHook - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/project_hook.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="WebHook.html">WebHook</a> + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ProjectHook</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProjectObserver.html b/doc/app/ProjectObserver.html new file mode 100644 index 00000000000..d4ce78247d2 --- /dev/null +++ b/doc/app/ProjectObserver.html @@ -0,0 +1,589 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ProjectObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/project_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-after_destroy">#after_destroy</a> + + <li><a href="#method-i-after_save">#after_save</a> + + <li><a href="#method-i-log_info">#log_info</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ProjectObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/project_observer.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span> <span class="ruby-identifier">project</span> + <span class="ruby-identifier">log_info</span>(<span class="ruby-node">"#{project.owner.name} created a new project \"#{project.name}\""</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + <div id="method-i-after_destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_destroy</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_destroy-source"> + <pre><span class="ruby-comment"># File app/observers/project_observer.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_destroy</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-identifier">log_info</span>(<span class="ruby-node">"Project \"#{project.name}\" was removed"</span>) + + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">destroy_repository</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_destroy-source --> + + </div> + + + + + </div><!-- after_destroy-method --> + + + <div id="method-i-after_save" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_save</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_save-source"> + <pre><span class="ruby-comment"># File app/observers/project_observer.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_save</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">update_repository</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_save-source --> + + </div> + + + + + </div><!-- after_save-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-log_info" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">log_info</span><span + class="method-args">(message)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="log_info-source"> + <pre><span class="ruby-comment"># File app/observers/project_observer.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">log_info</span> <span class="ruby-identifier">message</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">AppLogger</span>.<span class="ruby-identifier">info</span> <span class="ruby-identifier">message</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- log_info-source --> + + </div> + + + + + </div><!-- log_info-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProjectResourceController.html b/doc/app/ProjectResourceController.html new file mode 100644 index 00000000000..aa972617cb5 --- /dev/null +++ b/doc/app/ProjectResourceController.html @@ -0,0 +1,439 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ProjectResourceController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/project_resource_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ProjectResourceController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProjectsController.html b/doc/app/ProjectsController.html new file mode 100644 index 00000000000..6982deabcf9 --- /dev/null +++ b/doc/app/ProjectsController.html @@ -0,0 +1,785 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ProjectsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/projects_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-files">#files</a> + + <li><a href="#method-i-graph">#graph</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-update">#update</a> + + <li><a href="#method-i-wall">#wall</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ProjectsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">create_by_user</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:project</span>], <span class="ruby-identifier">current_user</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">saved?</span> + <span class="ruby-identifier">redirect_to</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Project was successfully created.'</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"new"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-comment"># Disable the UsersProject update_repository call, otherwise it will be</span> + <span class="ruby-comment"># called once for every person removed from the project</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">skip_callback</span>(<span class="ruby-value">:destroy</span>, <span class="ruby-value">:after</span>, <span class="ruby-value">:update_repository</span>) + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">destroy</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">set_callback</span>(<span class="ruby-value">:destroy</span>, <span class="ruby-value">:after</span>, <span class="ruby-value">:update_repository</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">root_path</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-files" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">files</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="files-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 64</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">files</span> + <span class="ruby-ivar">@notes</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"attachment != 'NULL'"</span>).<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at DESC"</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">100</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- files-source --> + + </div> + + + + + </div><!-- files-method --> + + + <div id="method-i-graph" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">graph</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="graph-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 81</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">graph</span> + <span class="ruby-ivar">@days_json</span>, <span class="ruby-ivar">@commits_json</span> = <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">GraphCommit</span>.<span class="ruby-identifier">to_graph</span>(<span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- graph-source --> + + </div> + + + + + </div><!-- graph-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-identifier">limit</span> = (<span class="ruby-identifier">params</span>[<span class="ruby-value">:limit</span>] <span class="ruby-operator">||</span> <span class="ruby-value">20</span>).<span class="ruby-identifier">to_i</span> + <span class="ruby-ivar">@events</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">events</span>.<span class="ruby-identifier">recent</span>.<span class="ruby-identifier">limit</span>(<span class="ruby-identifier">limit</span>).<span class="ruby-identifier">offset</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:offset</span>] <span class="ruby-operator">||</span> <span class="ruby-value">0</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span> + <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">empty_repo?</span> + <span class="ruby-ivar">@last_push</span> = <span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">recent_push</span>(<span class="ruby-ivar">@project</span>.<span class="ruby-identifier">id</span>) + <span class="ruby-identifier">render</span> <span class="ruby-value">:show</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"projects/empty"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:project</span>]) + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">edit_project_path</span>(<span class="ruby-identifier">project</span>), <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Project was successfully updated.'</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"edit"</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + <div id="method-i-wall" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">wall</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Wall</p> + + + + <div class="method-source-code" id="wall-source"> + <pre><span class="ruby-comment"># File app/controllers/projects_controller.rb, line 72</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">wall</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wall_enabled</span> + <span class="ruby-ivar">@note</span> = <span class="ruby-constant">Note</span>.<span class="ruby-identifier">new</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- wall-source --> + + </div> + + + + + </div><!-- wall-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProjectsHelper.html b/doc/app/ProjectsHelper.html new file mode 100644 index 00000000000..5edd4592cc7 --- /dev/null +++ b/doc/app/ProjectsHelper.html @@ -0,0 +1,543 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module ProjectsHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/projects_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-grouper_project_members">#grouper_project_members</a> + + <li><a href="#method-i-link_to_project">#link_to_project</a> + + <li><a href="#method-i-remove_from_team_message">#remove_from_team_message</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module ProjectsHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-grouper_project_members" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">grouper_project_members</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="grouper_project_members-source"> + <pre><span class="ruby-comment"># File app/helpers/projects_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">grouper_project_members</span>(<span class="ruby-identifier">project</span>) + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">sort_by</span>(&<span class="ruby-value">:project_access</span>).<span class="ruby-identifier">reverse</span>.<span class="ruby-identifier">group_by</span>(&<span class="ruby-value">:project_access</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- grouper_project_members-source --> + + </div> + + + + + </div><!-- grouper_project_members-method --> + + + <div id="method-i-link_to_project" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">link_to_project</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="link_to_project-source"> + <pre><span class="ruby-comment"># File app/helpers/projects_helper.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">link_to_project</span> <span class="ruby-identifier">project</span> + <span class="ruby-identifier">link_to</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">name</span>, <span class="ruby-identifier">project</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- link_to_project-source --> + + </div> + + + + + </div><!-- link_to_project-method --> + + + <div id="method-i-remove_from_team_message" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">remove_from_team_message</span><span + class="method-args">(project, member)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="remove_from_team_message-source"> + <pre><span class="ruby-comment"># File app/helpers/projects_helper.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_from_team_message</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">member</span>) + <span class="ruby-node">"You are going to remove #{member.user_name} from #{project.name}. Are you sure?"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- remove_from_team_message-source --> + + </div> + + + + + </div><!-- remove_from_team_message-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProtectedBranch.html b/doc/app/ProtectedBranch.html new file mode 100644 index 00000000000..900646dc53a --- /dev/null +++ b/doc/app/ProtectedBranch.html @@ -0,0 +1,529 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ProtectedBranch - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/protected_branch.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="GitHost.html">GitHost</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-commit">#commit</a> + + <li><a href="#method-i-update_repository">#update_repository</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ProtectedBranch</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commit-source"> + <pre><span class="ruby-comment"># File app/models/protected_branch.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commit</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">name</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commit-source --> + + </div> + + + + + </div><!-- commit-method --> + + + <div id="method-i-update_repository" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_repository</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update_repository-source"> + <pre><span class="ruby-comment"># File app/models/protected_branch.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_repository</span> + <span class="ruby-identifier">git_host</span>.<span class="ruby-identifier">update_repository</span>(<span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- update_repository-source --> + + </div> + + + + + </div><!-- update_repository-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/ProtectedBranchesController.html b/doc/app/ProtectedBranchesController.html new file mode 100644 index 00000000000..7eb2b1fdae3 --- /dev/null +++ b/doc/app/ProtectedBranchesController.html @@ -0,0 +1,556 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class ProtectedBranchesController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/protected_branches_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-index">#index</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class ProtectedBranchesController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/protected_branches_controller.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:protected_branch</span>]) + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_protected_branches_path</span>(<span class="ruby-ivar">@project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/protected_branches_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]).<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_protected_branches_path</span> } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/protected_branches_controller.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@branches</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">all</span> + <span class="ruby-ivar">@protected_branch</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/PushEvent.html b/doc/app/PushEvent.html new file mode 100644 index 00000000000..002866a66fe --- /dev/null +++ b/doc/app/PushEvent.html @@ -0,0 +1,1105 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module PushEvent - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/push_event.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-branch-3F">#branch?</a> + + <li><a href="#method-i-branch_name">#branch_name</a> + + <li><a href="#method-i-commit_from">#commit_from</a> + + <li><a href="#method-i-commit_to">#commit_to</a> + + <li><a href="#method-i-commits">#commits</a> + + <li><a href="#method-i-commits_count">#commits_count</a> + + <li><a href="#method-i-last_commit">#last_commit</a> + + <li><a href="#method-i-last_push_to_non_root-3F">#last_push_to_non_root?</a> + + <li><a href="#method-i-md_ref-3F">#md_ref?</a> + + <li><a href="#method-i-new_branch-3F">#new_branch?</a> + + <li><a href="#method-i-new_ref-3F">#new_ref?</a> + + <li><a href="#method-i-parent_commit">#parent_commit</a> + + <li><a href="#method-i-push_action_name">#push_action_name</a> + + <li><a href="#method-i-push_with_commits-3F">#push_with_commits?</a> + + <li><a href="#method-i-ref_name">#ref_name</a> + + <li><a href="#method-i-ref_type">#ref_type</a> + + <li><a href="#method-i-rm_ref-3F">#rm_ref?</a> + + <li><a href="#method-i-tag-3F">#tag?</a> + + <li><a href="#method-i-tag_name">#tag_name</a> + + <li><a href="#method-i-valid_push-3F">#valid_push?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module PushEvent</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-branch-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branch?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="branch-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branch?</span> + <span class="ruby-identifier">data</span>[<span class="ruby-value">:ref</span>][<span class="ruby-string">"refs/heads"</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- branch-3F-source --> + + </div> + + + + + </div><!-- branch-3F-method --> + + + <div id="method-i-branch_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branch_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="branch_name-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 48</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branch_name</span> + <span class="ruby-ivar">@branch_name</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">data</span>[<span class="ruby-value">:ref</span>].<span class="ruby-identifier">gsub</span>(<span class="ruby-string">"refs/heads/"</span>, <span class="ruby-string">""</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- branch_name-source --> + + </div> + + + + + </div><!-- branch_name-method --> + + + <div id="method-i-commit_from" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commit_from</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commit_from-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 32</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commit_from</span> + <span class="ruby-identifier">data</span>[<span class="ruby-value">:before</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- commit_from-source --> + + </div> + + + + + </div><!-- commit_from-method --> + + + <div id="method-i-commit_to" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commit_to</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commit_to-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commit_to</span> + <span class="ruby-identifier">data</span>[<span class="ruby-value">:after</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- commit_to-source --> + + </div> + + + + + </div><!-- commit_to-method --> + + + <div id="method-i-commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Max 20 commits from push DESC</p> + + + + <div class="method-source-code" id="commits-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 57</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits</span> + <span class="ruby-ivar">@commits</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">data</span>[<span class="ruby-value">:commits</span>].<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">commit</span><span class="ruby-operator">|</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">commit</span>[<span class="ruby-value">:id</span>]) }.<span class="ruby-identifier">reverse</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- commits-source --> + + </div> + + + + + </div><!-- commits-method --> + + + <div id="method-i-commits_count" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits_count</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits_count-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits_count</span> + <span class="ruby-identifier">data</span>[<span class="ruby-value">:total_commits_count</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">||</span> <span class="ruby-value">0</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- commits_count-source --> + + </div> + + + + + </div><!-- commits_count-method --> + + + <div id="method-i-last_commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_commit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_commit-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_commit</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">commit_to</span>) +<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-keyword">nil</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_commit-source --> + + </div> + + + + + </div><!-- last_commit-method --> + + + <div id="method-i-last_push_to_non_root-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_push_to_non_root?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_push_to_non_root-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 97</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_push_to_non_root?</span> + <span class="ruby-identifier">branch?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">default_branch</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">branch_name</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_push_to_non_root-3F-source --> + + </div> + + + + + </div><!-- last_push_to_non_root-3F-method --> + + + <div id="method-i-md_ref-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">md_ref?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="md_ref-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 28</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">md_ref?</span> + <span class="ruby-operator">!</span>(<span class="ruby-identifier">rm_ref?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">new_ref?</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- md_ref-3F-source --> + + </div> + + + + + </div><!-- md_ref-3F-method --> + + + <div id="method-i-new_branch-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_branch?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new_branch-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_branch?</span> + <span class="ruby-identifier">commit_from</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%r^00000/</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new_branch-3F-source --> + + </div> + + + + + </div><!-- new_branch-3F-method --> + + + <div id="method-i-new_ref-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_ref?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new_ref-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_ref?</span> + <span class="ruby-identifier">commit_from</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%r^00000/</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new_ref-3F-source --> + + </div> + + + + + </div><!-- new_ref-3F-method --> + + + <div id="method-i-parent_commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">parent_commit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="parent_commit-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 79</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">parent_commit</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">commit_from</span>) +<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-keyword">nil</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- parent_commit-source --> + + </div> + + + + + </div><!-- parent_commit-method --> + + + <div id="method-i-push_action_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">push_action_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="push_action_name-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 69</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">push_action_name</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">new_ref?</span> + <span class="ruby-string">"pushed new"</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">rm_ref?</span> + <span class="ruby-string">"deleted"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-string">"pushed to"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- push_action_name-source --> + + </div> + + + + + </div><!-- push_action_name-method --> + + + <div id="method-i-push_with_commits-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">push_with_commits?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="push_with_commits-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 91</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">push_with_commits?</span> + <span class="ruby-identifier">md_ref?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">any?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">parent_commit</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">last_commit</span> +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">NoSuchPathError</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- push_with_commits-3F-source --> + + </div> + + + + + </div><!-- push_with_commits-3F-method --> + + + <div id="method-i-ref_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ref_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="ref_name-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ref_name</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">tag?</span> + <span class="ruby-identifier">tag_name</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">branch_name</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- ref_name-source --> + + </div> + + + + + </div><!-- ref_name-method --> + + + <div id="method-i-ref_type" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ref_type</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="ref_type-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ref_type</span> + <span class="ruby-identifier">tag?</span> <span class="ruby-operator">?</span> <span class="ruby-string">"tag"</span> <span class="ruby-operator">:</span> <span class="ruby-string">"branch"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- ref_type-source --> + + </div> + + + + + </div><!-- ref_type-method --> + + + <div id="method-i-rm_ref-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">rm_ref?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="rm_ref-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">rm_ref?</span> + <span class="ruby-identifier">commit_to</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%r^00000/</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- rm_ref-3F-source --> + + </div> + + + + + </div><!-- rm_ref-3F-method --> + + + <div id="method-i-tag-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tag?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="tag-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tag?</span> + <span class="ruby-identifier">data</span>[<span class="ruby-value">:ref</span>][<span class="ruby-string">"refs/tags"</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- tag-3F-source --> + + </div> + + + + + </div><!-- tag-3F-method --> + + + <div id="method-i-tag_name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tag_name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="tag_name-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 52</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tag_name</span> + <span class="ruby-ivar">@tag_name</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">data</span>[<span class="ruby-value">:ref</span>].<span class="ruby-identifier">gsub</span>(<span class="ruby-string">"refs/tags/"</span>, <span class="ruby-string">""</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- tag_name-source --> + + </div> + + + + + </div><!-- tag_name-method --> + + + <div id="method-i-valid_push-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">valid_push?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="valid_push-3F-source"> + <pre><span class="ruby-comment"># File app/roles/push_event.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">valid_push?</span> + <span class="ruby-identifier">data</span>[<span class="ruby-value">:ref</span>] +<span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">ex</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- valid_push-3F-source --> + + </div> + + + + + </div><!-- valid_push-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/PushObserver.html b/doc/app/PushObserver.html new file mode 100644 index 00000000000..804447a6917 --- /dev/null +++ b/doc/app/PushObserver.html @@ -0,0 +1,699 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module PushObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/push_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute_hooks">#execute_hooks</a> + + <li><a href="#method-i-observe_push">#observe_push</a> + + <li><a href="#method-i-post_receive_data">#post_receive_data</a> + + <li><a href="#method-i-trigger_post_receive">#trigger_post_receive</a> + + <li><a href="#method-i-update_merge_requests">#update_merge_requests</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module PushObserver</h1> + + <div id="description" class="description"> + +<p>Includes methods for handling Git Push events</p> + +<p>Triggered by <a href="PostReceive.html">PostReceive</a> job</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute_hooks" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute_hooks</span><span + class="method-args">(oldrev, newrev, ref, user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute_hooks-source"> + <pre><span class="ruby-comment"># File app/roles/push_observer.rb, line 33</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute_hooks</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + <span class="ruby-identifier">ref_parts</span> = <span class="ruby-identifier">ref</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'/'</span>) + + <span class="ruby-comment"># Return if this is not a push to a branch (e.g. new commits)</span> + <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ref_parts</span>[<span class="ruby-value">1</span>] <span class="ruby-operator">!~</span> <span class="ruby-regexp">%rheads/</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">oldrev</span> <span class="ruby-operator">==</span> <span class="ruby-string">"00000000000000000000000000000000"</span> + + <span class="ruby-identifier">data</span> = <span class="ruby-identifier">post_receive_data</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + + <span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">hook</span><span class="ruby-operator">|</span> <span class="ruby-identifier">hook</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-identifier">data</span>) } +<span class="ruby-keyword">end</span></pre> + </div><!-- execute_hooks-source --> + + </div> + + + + + </div><!-- execute_hooks-method --> + + + <div id="method-i-observe_push" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">observe_push</span><span + class="method-args">(oldrev, newrev, ref, user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="observe_push-source"> + <pre><span class="ruby-comment"># File app/roles/push_observer.rb, line 5</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">observe_push</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + <span class="ruby-identifier">data</span> = <span class="ruby-identifier">post_receive_data</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + + <span class="ruby-constant">Event</span>.<span class="ruby-identifier">create</span>( + <span class="ruby-identifier">project</span><span class="ruby-operator">:</span> <span class="ruby-keyword">self</span>, + <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Pushed</span>, + <span class="ruby-identifier">data</span><span class="ruby-operator">:</span> <span class="ruby-identifier">data</span>, + <span class="ruby-identifier">author_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">data</span>[<span class="ruby-value">:user_id</span>] + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- observe_push-source --> + + </div> + + + + + </div><!-- observe_push-method --> + + + <div id="method-i-post_receive_data" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">post_receive_data</span><span + class="method-args">(oldrev, newrev, ref, user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="post_receive_data-source"> + <pre><span class="ruby-comment"># File app/roles/push_observer.rb, line 44</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">post_receive_data</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + + <span class="ruby-identifier">push_commits</span> = <span class="ruby-identifier">commits_between</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>) + + <span class="ruby-comment"># Total commits count</span> + <span class="ruby-identifier">push_commits_count</span> = <span class="ruby-identifier">push_commits</span>.<span class="ruby-identifier">size</span> + + <span class="ruby-comment"># Get latest 20 commits ASC</span> + <span class="ruby-identifier">push_commits_limited</span> = <span class="ruby-identifier">push_commits</span>.<span class="ruby-identifier">last</span>(<span class="ruby-value">20</span>) + + <span class="ruby-comment"># Hash to be passed as post_receive_data</span> + <span class="ruby-identifier">data</span> = { + <span class="ruby-identifier">before</span><span class="ruby-operator">:</span> <span class="ruby-identifier">oldrev</span>, + <span class="ruby-identifier">after</span><span class="ruby-operator">:</span> <span class="ruby-identifier">newrev</span>, + <span class="ruby-identifier">ref</span><span class="ruby-operator">:</span> <span class="ruby-identifier">ref</span>, + <span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">user_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">repository</span><span class="ruby-operator">:</span> { + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">name</span>, + <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-identifier">web_url</span>, + <span class="ruby-identifier">description</span><span class="ruby-operator">:</span> <span class="ruby-identifier">description</span>, + <span class="ruby-identifier">homepage</span><span class="ruby-operator">:</span> <span class="ruby-identifier">web_url</span>, + }, + <span class="ruby-identifier">commits</span><span class="ruby-operator">:</span> [], + <span class="ruby-identifier">total_commits_count</span><span class="ruby-operator">:</span> <span class="ruby-identifier">push_commits_count</span> + } + + <span class="ruby-comment"># For perfomance purposes maximum 20 latest commits</span> + <span class="ruby-comment"># will be passed as post receive hook data.</span> + <span class="ruby-comment">#</span> + <span class="ruby-identifier">push_commits_limited</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">commit</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">data</span>[<span class="ruby-value">:commits</span>] <span class="ruby-operator"><<</span> { + <span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">message</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">safe_message</span>, + <span class="ruby-identifier">timestamp</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">date</span>.<span class="ruby-identifier">xmlschema</span>, + <span class="ruby-identifier">url</span><span class="ruby-operator">:</span> <span class="ruby-node">"#{Gitlab.config.url}/#{code}/commits/#{commit.id}"</span>, + <span class="ruby-identifier">author</span><span class="ruby-operator">:</span> { + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">author_name</span>, + <span class="ruby-identifier">email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">author_email</span> + } + } + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">data</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- post_receive_data-source --> + + </div> + + + + + </div><!-- post_receive_data-method --> + + + <div id="method-i-trigger_post_receive" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">trigger_post_receive</span><span + class="method-args">(oldrev, newrev, ref, user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>This method will be called after each post receive and only if the provided +user is present in GitLab.</p> + +<p>All callbacks for post receive should be placed here.</p> + + + + <div class="method-source-code" id="trigger_post_receive-source"> + <pre><span class="ruby-comment"># File app/roles/push_observer.rb, line 94</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">trigger_post_receive</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + <span class="ruby-comment"># Create push event</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">observe_push</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + + <span class="ruby-comment"># Close merged MR</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">update_merge_requests</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + + <span class="ruby-comment"># Execute web hooks</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">execute_hooks</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + + <span class="ruby-comment"># Create satellite</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">satellite</span>.<span class="ruby-identifier">create</span> <span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">satellite</span>.<span class="ruby-identifier">exists?</span> + + <span class="ruby-comment"># Discover the default branch, but only if it hasn't already been set to</span> + <span class="ruby-comment"># something else</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">default_branch</span>.<span class="ruby-identifier">nil?</span> + <span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">default_branch</span><span class="ruby-operator">:</span> <span class="ruby-identifier">discover_default_branch</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- trigger_post_receive-source --> + + </div> + + + + + </div><!-- trigger_post_receive-method --> + + + <div id="method-i-update_merge_requests" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_merge_requests</span><span + class="method-args">(oldrev, newrev, ref, user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update_merge_requests-source"> + <pre><span class="ruby-comment"># File app/roles/push_observer.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_merge_requests</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">user</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">ref</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%rheads/</span> + <span class="ruby-identifier">branch_name</span> = <span class="ruby-identifier">ref</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">"refs/heads/"</span>, <span class="ruby-string">""</span>) + <span class="ruby-identifier">c_ids</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">commits_between</span>(<span class="ruby-identifier">oldrev</span>, <span class="ruby-identifier">newrev</span>).<span class="ruby-identifier">map</span>(&<span class="ruby-value">:id</span>) + + <span class="ruby-comment"># Update code for merge requests</span> + <span class="ruby-identifier">mrs</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">opened</span>.<span class="ruby-identifier">find_all_by_branch</span>(<span class="ruby-identifier">branch_name</span>).<span class="ruby-identifier">all</span> + <span class="ruby-identifier">mrs</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">merge_request</span><span class="ruby-operator">|</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">reload_code</span>; <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">mark_as_unchecked</span> } + + <span class="ruby-comment"># Close merge requests</span> + <span class="ruby-identifier">mrs</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">merge_requests</span>.<span class="ruby-identifier">opened</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">target_branch</span><span class="ruby-operator">:</span> <span class="ruby-identifier">branch_name</span>).<span class="ruby-identifier">all</span> + <span class="ruby-identifier">mrs</span> = <span class="ruby-identifier">mrs</span>.<span class="ruby-identifier">select</span>(&<span class="ruby-value">:last_commit</span>).<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">mr</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c_ids</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">mr</span>.<span class="ruby-identifier">last_commit</span>.<span class="ruby-identifier">id</span>) } + <span class="ruby-identifier">mrs</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">merge_request</span><span class="ruby-operator">|</span> <span class="ruby-identifier">merge_request</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>) } + + <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update_merge_requests-source --> + + </div> + + + + + </div><!-- update_merge_requests-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Redcarpet.html b/doc/app/Redcarpet.html new file mode 100644 index 00000000000..238b7f2596c --- /dev/null +++ b/doc/app/Redcarpet.html @@ -0,0 +1,432 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Redcarpet - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Redcarpet</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Redcarpet/Render.html b/doc/app/Redcarpet/Render.html new file mode 100644 index 00000000000..acb7ba3cdf4 --- /dev/null +++ b/doc/app/Redcarpet/Render.html @@ -0,0 +1,432 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Redcarpet::Render - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Redcarpet::Render</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Redcarpet/Render/GitlabHTML.html b/doc/app/Redcarpet/Render/GitlabHTML.html new file mode 100644 index 00000000000..93212eaba21 --- /dev/null +++ b/doc/app/Redcarpet/Render/GitlabHTML.html @@ -0,0 +1,594 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Redcarpet::Render::GitlabHTML - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../../index.html">Home</a> + <a href="../../table_of_contents.html#classes">Classes</a> + <a href="../../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>lib/redcarpet/render/gitlab_html.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Redcarpet::Render::HTML + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-block_code">#block_code</a> + + <li><a href="#method-i-postprocess">#postprocess</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../../Gitlab.html">Gitlab</a> + + <li><a href="../../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../../Admin.html">Admin</a> + + <li><a href="../../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../../Notes.html">Notes</a> + + <li><a href="../../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../../Redcarpet.html">Redcarpet</a> + + <li><a href="../../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../../Grack.html">Grack</a> + + <li><a href="../../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../../StaticModel.html">StaticModel</a> + + <li><a href="../../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../../Ability.html">Ability</a> + + <li><a href="../../Account.html">Account</a> + + <li><a href="../../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../../AdminController.html">AdminController</a> + + <li><a href="../../ApplicationController.html">ApplicationController</a> + + <li><a href="../../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../../Authority.html">Authority</a> + + <li><a href="../../BaseContext.html">BaseContext</a> + + <li><a href="../../BlameController.html">BlameController</a> + + <li><a href="../../BlobController.html">BlobController</a> + + <li><a href="../../Commit.html">Commit</a> + + <li><a href="../../CommitController.html">CommitController</a> + + <li><a href="../../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../../CommitsController.html">CommitsController</a> + + <li><a href="../../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../../CompareController.html">CompareController</a> + + <li><a href="../../DashboardController.html">DashboardController</a> + + <li><a href="../../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../../ErrorsController.html">ErrorsController</a> + + <li><a href="../../Event.html">Event</a> + + <li><a href="../../EventDecorator.html">EventDecorator</a> + + <li><a href="../../EventsHelper.html">EventsHelper</a> + + <li><a href="../../GitHost.html">GitHost</a> + + <li><a href="../../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../../Group.html">Group</a> + + <li><a href="../../GroupsController.html">GroupsController</a> + + <li><a href="../../HelpController.html">HelpController</a> + + <li><a href="../../HooksController.html">HooksController</a> + + <li><a href="../../Issue.html">Issue</a> + + <li><a href="../../IssueObserver.html">IssueObserver</a> + + <li><a href="../../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../../IssuesController.html">IssuesController</a> + + <li><a href="../../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../../Key.html">Key</a> + + <li><a href="../../KeyObserver.html">KeyObserver</a> + + <li><a href="../../KeysController.html">KeysController</a> + + <li><a href="../../LabelsController.html">LabelsController</a> + + <li><a href="../../MergeRequest.html">MergeRequest</a> + + <li><a href="../../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../../Milestone.html">Milestone</a> + + <li><a href="../../MilestonesController.html">MilestonesController</a> + + <li><a href="../../Note.html">Note</a> + + <li><a href="../../NoteObserver.html">NoteObserver</a> + + <li><a href="../../NotesController.html">NotesController</a> + + <li><a href="../../NotesHelper.html">NotesHelper</a> + + <li><a href="../../Notify.html">Notify</a> + + <li><a href="../../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../../PostReceive.html">PostReceive</a> + + <li><a href="../../ProfileController.html">ProfileController</a> + + <li><a href="../../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../../Project.html">Project</a> + + <li><a href="../../ProjectHook.html">ProjectHook</a> + + <li><a href="../../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../../ProjectsController.html">ProjectsController</a> + + <li><a href="../../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../../PushEvent.html">PushEvent</a> + + <li><a href="../../PushObserver.html">PushObserver</a> + + <li><a href="../../RefsController.html">RefsController</a> + + <li><a href="../../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../../Repository.html">Repository</a> + + <li><a href="../../SearchContext.html">SearchContext</a> + + <li><a href="../../SearchController.html">SearchController</a> + + <li><a href="../../Snippet.html">Snippet</a> + + <li><a href="../../SnippetsController.html">SnippetsController</a> + + <li><a href="../../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../../SystemHook.html">SystemHook</a> + + <li><a href="../../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../../TabHelper.html">TabHelper</a> + + <li><a href="../../TagsHelper.html">TagsHelper</a> + + <li><a href="../../Team.html">Team</a> + + <li><a href="../../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../../TestHookContext.html">TestHookContext</a> + + <li><a href="../../Tree.html">Tree</a> + + <li><a href="../../TreeController.html">TreeController</a> + + <li><a href="../../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../../TreeHelper.html">TreeHelper</a> + + <li><a href="../../User.html">User</a> + + <li><a href="../../UserObserver.html">UserObserver</a> + + <li><a href="../../UsersProject.html">UsersProject</a> + + <li><a href="../../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../../Votes.html">Votes</a> + + <li><a href="../../WebHook.html">WebHook</a> + + <li><a href="../../Wiki.html">Wiki</a> + + <li><a href="../../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Redcarpet::Render::GitlabHTML</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-h" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">h</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-template" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">template</span><span + class="attribute-access-type">[R]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(template, options = {})</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File lib/redcarpet/render/gitlab_html.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">template</span>, <span class="ruby-identifier">options</span> = {}) + <span class="ruby-ivar">@template</span> = <span class="ruby-identifier">template</span> + <span class="ruby-ivar">@project</span> = <span class="ruby-ivar">@template</span>.<span class="ruby-identifier">instance_variable_get</span>(<span class="ruby-string">"@project"</span>) + <span class="ruby-keyword">super</span> <span class="ruby-identifier">options</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-block_code" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">block_code</span><span + class="method-args">(code, language)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="block_code-source"> + <pre><span class="ruby-comment"># File lib/redcarpet/render/gitlab_html.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">block_code</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">language</span>) + <span class="ruby-keyword">if</span> <span class="ruby-constant">Pygments</span><span class="ruby-operator">::</span><span class="ruby-constant">Lexer</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">language</span>) + <span class="ruby-constant">Pygments</span>.<span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">lexer</span><span class="ruby-operator">:</span> <span class="ruby-identifier">language</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">encoding</span><span class="ruby-operator">:</span> <span class="ruby-string">'utf-8'</span>}) + <span class="ruby-keyword">else</span> + <span class="ruby-constant">Pygments</span>.<span class="ruby-identifier">highlight</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">options</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">encoding</span><span class="ruby-operator">:</span> <span class="ruby-string">'utf-8'</span>}) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- block_code-source --> + + </div> + + + + + </div><!-- block_code-method --> + + + <div id="method-i-postprocess" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">postprocess</span><span + class="method-args">(full_document)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="postprocess-source"> + <pre><span class="ruby-comment"># File lib/redcarpet/render/gitlab_html.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">postprocess</span>(<span class="ruby-identifier">full_document</span>) + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">gfm</span>(<span class="ruby-identifier">full_document</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- postprocess-source --> + + </div> + + + + + </div><!-- postprocess-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/RefsController.html b/doc/app/RefsController.html new file mode 100644 index 00000000000..a8248da0ec0 --- /dev/null +++ b/doc/app/RefsController.html @@ -0,0 +1,638 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class RefsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/refs_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="Gitlab/Encode.html">Gitlab::Encode</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-define_tree_vars">#define_tree_vars</a> + + <li><a href="#method-i-logs_tree">#logs_tree</a> + + <li><a href="#method-i-ref">#ref</a> + + <li><a href="#method-i-switch">#switch</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class RefsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-logs_tree" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">logs_tree</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="logs_tree-source"> + <pre><span class="ruby-comment"># File app/controllers/refs_controller.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">logs_tree</span> + <span class="ruby-identifier">contents</span> = <span class="ruby-ivar">@tree</span>.<span class="ruby-identifier">contents</span> + <span class="ruby-ivar">@logs</span> = <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">content</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">file</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>] <span class="ruby-operator">?</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>], <span class="ruby-identifier">content</span>.<span class="ruby-identifier">name</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">content</span>.<span class="ruby-identifier">name</span> + <span class="ruby-identifier">last_commit</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-ivar">@commit</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">file</span>, <span class="ruby-value">1</span>).<span class="ruby-identifier">last</span> + <span class="ruby-identifier">last_commit</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-identifier">last_commit</span>) + { + <span class="ruby-identifier">file_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">content</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">commit</span><span class="ruby-operator">:</span> <span class="ruby-identifier">last_commit</span> + } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- logs_tree-source --> + + </div> + + + + + </div><!-- logs_tree-method --> + + + <div id="method-i-switch" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">switch</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="switch-source"> + <pre><span class="ruby-comment"># File app/controllers/refs_controller.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">switch</span> + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">new_path</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:destination</span>] <span class="ruby-operator">==</span> <span class="ruby-string">"tree"</span> + <span class="ruby-identifier">project_tree_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">project_commits_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">new_path</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> <span class="ruby-keyword">do</span> + <span class="ruby-ivar">@ref</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:ref</span>] + <span class="ruby-identifier">define_tree_vars</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">"tree"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- switch-source --> + + </div> + + + + + </div><!-- switch-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-define_tree_vars" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">define_tree_vars</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="define_tree_vars-source"> + <pre><span class="ruby-comment"># File app/controllers/refs_controller.rb, line 46</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">define_tree_vars</span> + <span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>] = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>].<span class="ruby-identifier">blank?</span> + + <span class="ruby-ivar">@repo</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">repo</span> + <span class="ruby-ivar">@commit</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-ivar">@ref</span>) + <span class="ruby-ivar">@commit</span> = <span class="ruby-constant">CommitDecorator</span>.<span class="ruby-identifier">decorate</span>(<span class="ruby-ivar">@commit</span>) + <span class="ruby-ivar">@tree</span> = <span class="ruby-constant">Tree</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@commit</span>.<span class="ruby-identifier">tree</span>, <span class="ruby-identifier">project</span>, <span class="ruby-ivar">@ref</span>, <span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>]) + <span class="ruby-ivar">@tree</span> = <span class="ruby-constant">TreeDecorator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@tree</span>) + <span class="ruby-ivar">@hex_path</span> = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>] <span class="ruby-operator">||</span> <span class="ruby-string">""</span>) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>] + <span class="ruby-ivar">@logs_path</span> = <span class="ruby-identifier">logs_file_project_ref_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>, <span class="ruby-identifier">params</span>[<span class="ruby-value">:path</span>]) + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@logs_path</span> = <span class="ruby-identifier">logs_tree_project_ref_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- define_tree_vars-source --> + + </div> + + + + + </div><!-- define_tree_vars-method --> + + + <div id="method-i-ref" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ref</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="ref-source"> + <pre><span class="ruby-comment"># File app/controllers/refs_controller.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ref</span> + <span class="ruby-ivar">@ref</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>] <span class="ruby-operator">||</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:ref</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- ref-source --> + + </div> + + + + + </div><!-- ref-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/RepositoriesController.html b/doc/app/RepositoriesController.html new file mode 100644 index 00000000000..3a22f71e49a --- /dev/null +++ b/doc/app/RepositoriesController.html @@ -0,0 +1,593 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class RepositoriesController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/repositories_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-archive">#archive</a> + + <li><a href="#method-i-branches">#branches</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-tags">#tags</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class RepositoriesController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-archive" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">archive</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="archive-source"> + <pre><span class="ruby-comment"># File app/controllers/repositories_controller.rb, line 19</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">archive</span> + <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:download_code</span>, <span class="ruby-ivar">@project</span>) + <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">and</span> <span class="ruby-keyword">return</span> + <span class="ruby-keyword">end</span> + + + <span class="ruby-identifier">file_path</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">archive_repo</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:ref</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">file_path</span> + <span class="ruby-comment"># Send file to user</span> + <span class="ruby-identifier">send_file</span> <span class="ruby-identifier">file_path</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render_404</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- archive-source --> + + </div> + + + + + </div><!-- archive-method --> + + + <div id="method-i-branches" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branches</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="branches-source"> + <pre><span class="ruby-comment"># File app/controllers/repositories_controller.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branches</span> + <span class="ruby-ivar">@branches</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">branches</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- branches-source --> + + </div> + + + + + </div><!-- branches-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/repositories_controller.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@activities</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">commits_with_refs</span>(<span class="ruby-value">20</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-tags" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tags</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="tags-source"> + <pre><span class="ruby-comment"># File app/controllers/repositories_controller.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tags</span> + <span class="ruby-ivar">@tags</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">tags</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- tags-source --> + + </div> + + + + + </div><!-- tags-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Repository.html b/doc/app/Repository.html new file mode 100644 index 00000000000..cb68146cfda --- /dev/null +++ b/doc/app/Repository.html @@ -0,0 +1,1566 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Repository - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/repository.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="GitHost.html">GitHost</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-archive_repo">#archive_repo</a> + + <li><a href="#method-i-branch_names">#branch_names</a> + + <li><a href="#method-i-branches">#branches</a> + + <li><a href="#method-i-commit">#commit</a> + + <li><a href="#method-i-commits">#commits</a> + + <li><a href="#method-i-commits_between">#commits_between</a> + + <li><a href="#method-i-commits_since">#commits_since</a> + + <li><a href="#method-i-commits_with_refs">#commits_with_refs</a> + + <li><a href="#method-i-destroy_repository">#destroy_repository</a> + + <li><a href="#method-i-discover_default_branch">#discover_default_branch</a> + + <li><a href="#method-i-empty_repo-3F">#empty_repo?</a> + + <li><a href="#method-i-fresh_commits">#fresh_commits</a> + + <li><a href="#method-i-has_commits-3F">#has_commits?</a> + + <li><a href="#method-i-has_post_receive_file-3F">#has_post_receive_file?</a> + + <li><a href="#method-i-heads">#heads</a> + + <li><a href="#method-i-http_url_to_repo">#http_url_to_repo</a> + + <li><a href="#method-i-last_commit_for">#last_commit_for</a> + + <li><a href="#method-i-open_branches">#open_branches</a> + + <li><a href="#method-i-path_to_repo">#path_to_repo</a> + + <li><a href="#method-i-protected_branch-3F">#protected_branch?</a> + + <li><a href="#method-i-ref_names">#ref_names</a> + + <li><a href="#method-i-repo">#repo</a> + + <li><a href="#method-i-repo_exists-3F">#repo_exists?</a> + + <li><a href="#method-i-root_ref">#root_ref</a> + + <li><a href="#method-i-root_ref-3F">#root_ref?</a> + + <li><a href="#method-i-satellite">#satellite</a> + + <li><a href="#method-i-ssh_url_to_repo">#ssh_url_to_repo</a> + + <li><a href="#method-i-tag_names">#tag_names</a> + + <li><a href="#method-i-tags">#tags</a> + + <li><a href="#method-i-tree">#tree</a> + + <li><a href="#method-i-update_repository">#update_repository</a> + + <li><a href="#method-i-url_to_repo">#url_to_repo</a> + + <li><a href="#method-i-valid_repo-3F">#valid_repo?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Repository</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-archive_repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">archive_repo</span><span + class="method-args">(ref)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Archive <a href="Project.html">Project</a> to .tar.gz</p> + +<p>Already packed repo archives stored at +app_root/tmp/repositories/project_name/project_name-commit-id.tag.gz</p> + + + + <div class="method-source-code" id="archive_repo-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 157</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">archive_repo</span>(<span class="ruby-identifier">ref</span>) + <span class="ruby-identifier">ref</span> = <span class="ruby-identifier">ref</span> <span class="ruby-operator">||</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">root_ref</span> + <span class="ruby-identifier">commit</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">commit</span>(<span class="ruby-identifier">ref</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">commit</span> + + <span class="ruby-comment"># Build file path</span> + <span class="ruby-identifier">file_name</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">+</span> <span class="ruby-string">"-"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">commit</span>.<span class="ruby-identifier">id</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">".tar.gz"</span> + <span class="ruby-identifier">storage_path</span> = <span class="ruby-constant">Rails</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"tmp"</span>, <span class="ruby-string">"repositories"</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">code</span>) + <span class="ruby-identifier">file_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">storage_path</span>, <span class="ruby-identifier">file_name</span>) + + <span class="ruby-comment"># Put files into a directory before archiving</span> + <span class="ruby-identifier">prefix</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">code</span> <span class="ruby-operator">+</span> <span class="ruby-string">"/"</span> + + <span class="ruby-comment"># Create file if not exists</span> + <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">file_path</span>) + <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span> <span class="ruby-identifier">storage_path</span> + <span class="ruby-identifier">file</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">archive_to_file</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">file_path</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">file_path</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- archive_repo-source --> + + </div> + + + + + </div><!-- archive_repo-method --> + + + <div id="method-i-branch_names" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branch_names</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns an Array of branch names</p> + + + + <div class="method-source-code" id="branch_names-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branch_names</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">branches</span>.<span class="ruby-identifier">collect</span>(&<span class="ruby-value">:name</span>).<span class="ruby-identifier">sort</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- branch_names-source --> + + </div> + + + + + </div><!-- branch_names-method --> + + + <div id="method-i-branches" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branches</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns an Array of Branches</p> + + + + <div class="method-source-code" id="branches-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 58</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branches</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">branches</span>.<span class="ruby-identifier">sort_by</span>(&<span class="ruby-value">:name</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- branches-source --> + + </div> + + + + + </div><!-- branches-method --> + + + <div id="method-i-commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commit</span><span + class="method-args">(commit_id = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commit-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commit</span>(<span class="ruby-identifier">commit_id</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">find_or_first</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">commit_id</span>, <span class="ruby-identifier">root_ref</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commit-source --> + + </div> + + + + + </div><!-- commit-method --> + + + <div id="method-i-commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits</span><span + class="method-args">(ref, path = nil, limit = nil, offset = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">limit</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">offset</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">limit</span>, <span class="ruby-identifier">offset</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commits-source --> + + </div> + + + + + </div><!-- commits-method --> + + + <div id="method-i-commits_between" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits_between</span><span + class="method-args">(from, to)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits_between-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 39</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits_between</span>(<span class="ruby-identifier">from</span>, <span class="ruby-identifier">to</span>) + <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">commits_between</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">from</span>, <span class="ruby-identifier">to</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commits_between-source --> + + </div> + + + + + </div><!-- commits_between-method --> + + + <div id="method-i-commits_since" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits_since</span><span + class="method-args">(date)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits_since-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 27</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits_since</span>(<span class="ruby-identifier">date</span>) + <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">commits_since</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">date</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commits_since-source --> + + </div> + + + + + </div><!-- commits_since-method --> + + + <div id="method-i-commits_with_refs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">commits_with_refs</span><span + class="method-args">(n = 20)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="commits_with_refs-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">commits_with_refs</span>(<span class="ruby-identifier">n</span> = <span class="ruby-value">20</span>) + <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">commits_with_refs</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">n</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- commits_with_refs-source --> + + </div> + + + + + </div><!-- commits_with_refs-method --> + + + <div id="method-i-destroy_repository" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy_repository</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy_repository-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 93</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy_repository</span> + <span class="ruby-identifier">git_host</span>.<span class="ruby-identifier">remove_repository</span>(<span class="ruby-keyword">self</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy_repository-source --> + + </div> + + + + + </div><!-- destroy_repository-method --> + + + <div id="method-i-discover_default_branch" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">discover_default_branch</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Discovers the default branch based on the repository’s available branches</p> +<ul><li> +<p>If no branches are present, returns nil</p> +</li><li> +<p>If one branch is present, returns its name</p> +</li><li> +<p>If two or more branches are present, returns the one that has a name +matching <a href="Repository.html#method-i-root_ref">#root_ref</a> +(default_branch or ‘master’ if default_branch is nil)</p> +</li></ul> + + + + <div class="method-source-code" id="discover_default_branch-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 128</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">discover_default_branch</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">branch_names</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> + <span class="ruby-keyword">nil</span> + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">branch_names</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span> + <span class="ruby-identifier">branch_names</span>.<span class="ruby-identifier">first</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">branch_names</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">root_ref</span> }.<span class="ruby-identifier">first</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- discover_default_branch-source --> + + </div> + + + + + </div><!-- discover_default_branch-method --> + + + <div id="method-i-empty_repo-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">empty_repo?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="empty_repo-3F-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 11</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">empty_repo?</span> + <span class="ruby-operator">!</span><span class="ruby-identifier">repo_exists?</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-identifier">has_commits?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- empty_repo-3F-source --> + + </div> + + + + + </div><!-- empty_repo-3F-method --> + + + <div id="method-i-fresh_commits" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">fresh_commits</span><span + class="method-args">(n = 10)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="fresh_commits-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 19</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">fresh_commits</span>(<span class="ruby-identifier">n</span> = <span class="ruby-value">10</span>) + <span class="ruby-constant">Commit</span>.<span class="ruby-identifier">fresh_commits</span>(<span class="ruby-identifier">repo</span>, <span class="ruby-identifier">n</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- fresh_commits-source --> + + </div> + + + + + </div><!-- fresh_commits-method --> + + + <div id="method-i-has_commits-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">has_commits?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="has_commits-3F-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 138</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">has_commits?</span> + <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">commit</span> +<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">NoSuchPathError</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- has_commits-3F-source --> + + </div> + + + + + </div><!-- has_commits-3F-method --> + + + <div id="method-i-has_post_receive_file-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">has_post_receive_file?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="has_post_receive_file-3F-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">has_post_receive_file?</span> + <span class="ruby-identifier">hook_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path_to_repo</span>, <span class="ruby-string">'hooks'</span>, <span class="ruby-string">'post-receive'</span>) + <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">hook_file</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- has_post_receive_file-3F-source --> + + </div> + + + + + </div><!-- has_post_receive_file-3F-method --> + + + <div id="method-i-heads" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">heads</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="heads-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 103</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">heads</span> + <span class="ruby-ivar">@heads</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">heads</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- heads-source --> + + </div> + + + + + </div><!-- heads-method --> + + + <div id="method-i-http_url_to_repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">http_url_to_repo</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="http_url_to_repo-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 183</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">http_url_to_repo</span> + <span class="ruby-identifier">http_url</span> = [<span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">url</span>, <span class="ruby-string">"/"</span>, <span class="ruby-identifier">path</span>, <span class="ruby-string">".git"</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">''</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- http_url_to_repo-source --> + + </div> + + + + + </div><!-- http_url_to_repo-method --> + + + <div id="method-i-last_commit_for" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">last_commit_for</span><span + class="method-args">(ref, path = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="last_commit_for-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">last_commit_for</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">commits</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span>, <span class="ruby-value">1</span>).<span class="ruby-identifier">first</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- last_commit_for-source --> + + </div> + + + + + </div><!-- last_commit_for-method --> + + + <div id="method-i-open_branches" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">open_branches</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="open_branches-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 113</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">open_branches</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">heads</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">pnames</span> = <span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:name</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">repo</span>.<span class="ruby-identifier">heads</span>.<span class="ruby-identifier">reject</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">h</span><span class="ruby-operator">|</span> <span class="ruby-identifier">pnames</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">h</span>.<span class="ruby-identifier">name</span>) } + <span class="ruby-keyword">end</span>.<span class="ruby-identifier">sort_by</span>(&<span class="ruby-value">:name</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- open_branches-source --> + + </div> + + + + + </div><!-- open_branches-method --> + + + <div id="method-i-path_to_repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">path_to_repo</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="path_to_repo-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 85</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">path_to_repo</span> + <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">Gitlab</span>.<span class="ruby-identifier">config</span>.<span class="ruby-identifier">git_base_path</span>, <span class="ruby-node">"#{path}.git"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- path_to_repo-source --> + + </div> + + + + + </div><!-- path_to_repo-method --> + + + <div id="method-i-protected_branch-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">protected_branch?</span><span + class="method-args">(branch_name)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Check if current branch name is marked as protected in the system</p> + + + + <div class="method-source-code" id="protected_branch-3F-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 188</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">protected_branch?</span> <span class="ruby-identifier">branch_name</span> + <span class="ruby-identifier">protected_branches</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:name</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">branch_name</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- protected_branch-3F-source --> + + </div> + + + + + </div><!-- protected_branch-3F-method --> + + + <div id="method-i-ref_names" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ref_names</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns an Array of branch and tag names</p> + + + + <div class="method-source-code" id="ref_names-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 73</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ref_names</span> + [<span class="ruby-identifier">branch_names</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">tag_names</span>].<span class="ruby-identifier">flatten</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- ref_names-source --> + + </div> + + + + + </div><!-- ref_names-method --> + + + <div id="method-i-repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">repo</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="repo-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 77</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">repo</span> + <span class="ruby-ivar">@repo</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Repo</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">path_to_repo</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- repo-source --> + + </div> + + + + + </div><!-- repo-method --> + + + <div id="method-i-repo_exists-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">repo_exists?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="repo_exists-3F-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 97</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">repo_exists?</span> + <span class="ruby-ivar">@repo_exists</span> <span class="ruby-operator">||=</span> (<span class="ruby-identifier">repo</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">repo</span>.<span class="ruby-identifier">branches</span>.<span class="ruby-identifier">empty?</span>) +<span class="ruby-keyword">rescue</span> + <span class="ruby-ivar">@repo_exists</span> = <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- repo_exists-3F-source --> + + </div> + + + + + </div><!-- repo_exists-3F-method --> + + + <div id="method-i-root_ref" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">root_ref</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="root_ref-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 144</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">root_ref</span> + <span class="ruby-identifier">default_branch</span> <span class="ruby-operator">||</span> <span class="ruby-string">"master"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- root_ref-source --> + + </div> + + + + + </div><!-- root_ref-method --> + + + <div id="method-i-root_ref-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">root_ref?</span><span + class="method-args">(branch)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="root_ref-3F-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 148</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">root_ref?</span>(<span class="ruby-identifier">branch</span>) + <span class="ruby-identifier">root_ref</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">branch</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- root_ref-3F-source --> + + </div> + + + + + </div><!-- root_ref-3F-method --> + + + <div id="method-i-satellite" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">satellite</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="satellite-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 43</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">satellite</span> + <span class="ruby-ivar">@satellite</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Satellite</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword">self</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- satellite-source --> + + </div> + + + + + </div><!-- satellite-method --> + + + <div id="method-i-ssh_url_to_repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">ssh_url_to_repo</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="ssh_url_to_repo-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 179</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">ssh_url_to_repo</span> + <span class="ruby-identifier">url_to_repo</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- ssh_url_to_repo-source --> + + </div> + + + + + </div><!-- ssh_url_to_repo-method --> + + + <div id="method-i-tag_names" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tag_names</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns an Array of tag names</p> + + + + <div class="method-source-code" id="tag_names-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 63</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tag_names</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">collect</span>(&<span class="ruby-value">:name</span>).<span class="ruby-identifier">sort</span>.<span class="ruby-identifier">reverse</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- tag_names-source --> + + </div> + + + + + </div><!-- tag_names-method --> + + + <div id="method-i-tags" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tags</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns an Array of Tags</p> + + + + <div class="method-source-code" id="tags-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 68</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tags</span> + <span class="ruby-identifier">repo</span>.<span class="ruby-identifier">tags</span>.<span class="ruby-identifier">sort_by</span>(&<span class="ruby-value">:name</span>).<span class="ruby-identifier">reverse</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- tags-source --> + + </div> + + + + + </div><!-- tags-method --> + + + <div id="method-i-tree" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tree</span><span + class="method-args">(fcommit, path = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="tree-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 107</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tree</span>(<span class="ruby-identifier">fcommit</span>, <span class="ruby-identifier">path</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">fcommit</span> = <span class="ruby-identifier">commit</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">fcommit</span> <span class="ruby-operator">==</span> <span class="ruby-value">:head</span> + <span class="ruby-identifier">tree</span> = <span class="ruby-identifier">fcommit</span>.<span class="ruby-identifier">tree</span> + <span class="ruby-identifier">path</span> <span class="ruby-operator">?</span> (<span class="ruby-identifier">tree</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">path</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">tree</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- tree-source --> + + </div> + + + + + </div><!-- tree-method --> + + + <div id="method-i-update_repository" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_repository</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update_repository-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 89</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_repository</span> + <span class="ruby-identifier">git_host</span>.<span class="ruby-identifier">update_repository</span>(<span class="ruby-keyword">self</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- update_repository-source --> + + </div> + + + + + </div><!-- update_repository-method --> + + + <div id="method-i-url_to_repo" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">url_to_repo</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="url_to_repo-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 81</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">url_to_repo</span> + <span class="ruby-identifier">git_host</span>.<span class="ruby-identifier">url_to_repo</span>(<span class="ruby-identifier">path</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- url_to_repo-source --> + + </div> + + + + + </div><!-- url_to_repo-method --> + + + <div id="method-i-valid_repo-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">valid_repo?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="valid_repo-3F-source"> + <pre><span class="ruby-comment"># File app/roles/repository.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">valid_repo?</span> + <span class="ruby-identifier">repo</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-identifier">errors</span>.<span class="ruby-identifier">add</span>(<span class="ruby-value">:path</span>, <span class="ruby-string">"Invalid repository path"</span>) + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- valid_repo-3F-source --> + + </div> + + + + + </div><!-- valid_repo-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/SearchContext.html b/doc/app/SearchContext.html new file mode 100644 index 00000000000..6a3d2bd5047 --- /dev/null +++ b/doc/app/SearchContext.html @@ -0,0 +1,599 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class SearchContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/search_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-execute">#execute</a> + + <li><a href="#method-i-result">#result</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class SearchContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-params" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">params</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-project_ids" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project_ids</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(project_ids, params)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/contexts/search_context.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">project_ids</span>, <span class="ruby-identifier">params</span>) + <span class="ruby-ivar">@project_ids</span>, <span class="ruby-ivar">@params</span> = <span class="ruby-identifier">project_ids</span>, <span class="ruby-identifier">params</span>.<span class="ruby-identifier">dup</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/search_context.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-identifier">query</span> = <span class="ruby-identifier">params</span>[<span class="ruby-value">:search</span>] + + <span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">query</span>.<span class="ruby-identifier">present?</span> + + <span class="ruby-identifier">result</span>[<span class="ruby-value">:projects</span>] = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_ids</span>).<span class="ruby-identifier">search</span>(<span class="ruby-identifier">query</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">10</span>) + <span class="ruby-identifier">result</span>[<span class="ruby-value">:merge_requests</span>] = <span class="ruby-constant">MergeRequest</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_ids</span>).<span class="ruby-identifier">search</span>(<span class="ruby-identifier">query</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">10</span>) + <span class="ruby-identifier">result</span>[<span class="ruby-value">:issues</span>] = <span class="ruby-constant">Issue</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_ids</span>).<span class="ruby-identifier">search</span>(<span class="ruby-identifier">query</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">10</span>) + <span class="ruby-identifier">result</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + <div id="method-i-result" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">result</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="result-source"> + <pre><span class="ruby-comment"># File app/contexts/search_context.rb, line 19</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">result</span> + <span class="ruby-ivar">@result</span> <span class="ruby-operator">||=</span> { + <span class="ruby-identifier">projects</span><span class="ruby-operator">:</span> [], + <span class="ruby-identifier">merge_requests</span><span class="ruby-operator">:</span> [], + <span class="ruby-identifier">issues</span><span class="ruby-operator">:</span> [] + } +<span class="ruby-keyword">end</span></pre> + </div><!-- result-source --> + + </div> + + + + + </div><!-- result-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/SearchController.html b/doc/app/SearchController.html new file mode 100644 index 00000000000..0c14ea8f557 --- /dev/null +++ b/doc/app/SearchController.html @@ -0,0 +1,489 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class SearchController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/search_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationController.html">ApplicationController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class SearchController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/search_controller.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-identifier">result</span> = <span class="ruby-constant">SearchContext</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">current_user</span>.<span class="ruby-identifier">project_ids</span>, <span class="ruby-identifier">params</span>).<span class="ruby-identifier">execute</span> + + <span class="ruby-ivar">@projects</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:projects</span>] + <span class="ruby-ivar">@merge_requests</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:merge_requests</span>] + <span class="ruby-ivar">@issues</span> = <span class="ruby-identifier">result</span>[<span class="ruby-value">:issues</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Snippet.html b/doc/app/Snippet.html new file mode 100644 index 00000000000..a24e4494f44 --- /dev/null +++ b/doc/app/Snippet.html @@ -0,0 +1,667 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Snippet - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/snippet.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><span class="include">Linguist::BlobHelper</span> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-content_types">::content_types</a> + + <li><a href="#method-i-data">#data</a> + + <li><a href="#method-i-expired-3F">#expired?</a> + + <li><a href="#method-i-mode">#mode</a> + + <li><a href="#method-i-name">#name</a> + + <li><a href="#method-i-size">#size</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Snippet</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-content_types" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">content_types</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="content_types-source"> + <pre><span class="ruby-comment"># File app/models/snippet.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">content_types</span> + [ + <span class="ruby-string">".rb"</span>, <span class="ruby-string">".py"</span>, <span class="ruby-string">".pl"</span>, <span class="ruby-string">".scala"</span>, <span class="ruby-string">".c"</span>, <span class="ruby-string">".cpp"</span>, <span class="ruby-string">".java"</span>, + <span class="ruby-string">".haml"</span>, <span class="ruby-string">".html"</span>, <span class="ruby-string">".sass"</span>, <span class="ruby-string">".scss"</span>, <span class="ruby-string">".xml"</span>, <span class="ruby-string">".php"</span>, <span class="ruby-string">".erb"</span>, + <span class="ruby-string">".js"</span>, <span class="ruby-string">".sh"</span>, <span class="ruby-string">".coffee"</span>, <span class="ruby-string">".yml"</span>, <span class="ruby-string">".md"</span> + ] +<span class="ruby-keyword">end</span></pre> + </div><!-- content_types-source --> + + </div> + + + + + </div><!-- content_types-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-data" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">data</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="data-source"> + <pre><span class="ruby-comment"># File app/models/snippet.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">data</span> + <span class="ruby-identifier">content</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- data-source --> + + </div> + + + + + </div><!-- data-method --> + + + <div id="method-i-expired-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">expired?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="expired-3F-source"> + <pre><span class="ruby-comment"># File app/models/snippet.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">expired?</span> + <span class="ruby-identifier">expires_at</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">expires_at</span> <span class="ruby-operator"><</span> <span class="ruby-constant">Time</span>.<span class="ruby-identifier">current</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- expired-3F-source --> + + </div> + + + + + </div><!-- expired-3F-method --> + + + <div id="method-i-mode" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">mode</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="mode-source"> + <pre><span class="ruby-comment"># File app/models/snippet.rb, line 43</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">mode</span> + <span class="ruby-keyword">nil</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- mode-source --> + + </div> + + + + + </div><!-- mode-method --> + + + <div id="method-i-name" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">name</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="name-source"> + <pre><span class="ruby-comment"># File app/models/snippet.rb, line 39</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">name</span> + <span class="ruby-identifier">file_name</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- name-source --> + + </div> + + + + + </div><!-- name-method --> + + + <div id="method-i-size" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">size</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="size-source"> + <pre><span class="ruby-comment"># File app/models/snippet.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">size</span> + <span class="ruby-value">0</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- size-source --> + + </div> + + + + + </div><!-- size-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/SnippetsController.html b/doc/app/SnippetsController.html new file mode 100644 index 00000000000..7585a295f72 --- /dev/null +++ b/doc/app/SnippetsController.html @@ -0,0 +1,833 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class SnippetsController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/snippets_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-authorize_admin_snippet-21">#authorize_admin_snippet!</a> + + <li><a href="#method-i-authorize_modify_snippet-21">#authorize_modify_snippet!</a> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-raw">#raw</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-snippet">#snippet</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class SnippetsController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@snippet</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:snippet</span>]) + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">author</span> = <span class="ruby-identifier">current_user</span> + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">save</span> + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@snippet</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@snippet</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 55</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">access_denied!</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_snippet</span>, <span class="ruby-ivar">@snippet</span>) + + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_snippets_path</span>(<span class="ruby-ivar">@project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 38</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> + <span class="ruby-ivar">@snippets</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 22</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@snippet</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-raw" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">raw</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="raw-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 63</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">raw</span> + <span class="ruby-identifier">send_data</span>( + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">content</span>, + <span class="ruby-identifier">type</span><span class="ruby-operator">:</span> <span class="ruby-string">"text/plain"</span>, + <span class="ruby-identifier">disposition</span><span class="ruby-operator">:</span> <span class="ruby-string">'inline'</span>, + <span class="ruby-identifier">filename</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">file_name</span> + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- raw-source --> + + </div> + + + + + </div><!-- raw-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 51</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@note</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">noteable</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@snippet</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 41</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:snippet</span>]) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@snippet</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@snippet</span>] + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">respond_with</span>(<span class="ruby-ivar">@snippet</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-authorize_admin_snippet-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_admin_snippet!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_admin_snippet-21-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 82</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_admin_snippet!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:admin_snippet</span>, <span class="ruby-ivar">@snippet</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_admin_snippet-21-source --> + + </div> + + + + + </div><!-- authorize_admin_snippet-21-method --> + + + <div id="method-i-authorize_modify_snippet-21" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">authorize_modify_snippet!</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="authorize_modify_snippet-21-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 78</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">authorize_modify_snippet!</span> + <span class="ruby-keyword">return</span> <span class="ruby-identifier">render_404</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:modify_snippet</span>, <span class="ruby-ivar">@snippet</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- authorize_modify_snippet-21-source --> + + </div> + + + + + </div><!-- authorize_modify_snippet-21-method --> + + + <div id="method-i-snippet" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">snippet</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="snippet-source"> + <pre><span class="ruby-comment"># File app/controllers/snippets_controller.rb, line 74</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">snippet</span> + <span class="ruby-ivar">@snippet</span> <span class="ruby-operator">||=</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">snippets</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) +<span class="ruby-keyword">end</span></pre> + </div><!-- snippet-source --> + + </div> + + + + + </div><!-- snippet-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/SnippetsHelper.html b/doc/app/SnippetsHelper.html new file mode 100644 index 00000000000..99c08d51189 --- /dev/null +++ b/doc/app/SnippetsHelper.html @@ -0,0 +1,485 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module SnippetsHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/snippets_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-lifetime_select_options">#lifetime_select_options</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module SnippetsHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-lifetime_select_options" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">lifetime_select_options</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="lifetime_select_options-source"> + <pre><span class="ruby-comment"># File app/helpers/snippets_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">lifetime_select_options</span> + <span class="ruby-identifier">options</span> = [ + [<span class="ruby-string">'forever'</span>, <span class="ruby-keyword">nil</span>], + [<span class="ruby-string">'1 day'</span>, <span class="ruby-node">"#{Date.current + 1.day}"</span>], + [<span class="ruby-string">'1 week'</span>, <span class="ruby-node">"#{Date.current + 1.week}"</span>], + [<span class="ruby-string">'1 month'</span>, <span class="ruby-node">"#{Date.current + 1.month}"</span>] + ] + <span class="ruby-identifier">options_for_select</span>(<span class="ruby-identifier">options</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- lifetime_select_options-source --> + + </div> + + + + + </div><!-- lifetime_select_options-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/StaticModel.html b/doc/app/StaticModel.html new file mode 100644 index 00000000000..9dd1617c6b5 --- /dev/null +++ b/doc/app/StaticModel.html @@ -0,0 +1,648 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module StaticModel - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/static_model.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-3D-3D">#==</a> + + <li><a href="#method-i-5B-5D">#[]</a> + + <li><a href="#method-i-destroyed-3F">#destroyed?</a> + + <li><a href="#method-i-new_record-3F">#new_record?</a> + + <li><a href="#method-i-persisted-3F">#persisted?</a> + + <li><a href="#method-i-to_param">#to_param</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module StaticModel</h1> + + <div id="description" class="description"> + +<p>Provides an ActiveRecord-like interface to a model whose data is not +persisted to a database.</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-3D-3D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">==</span><span + class="method-args">(other)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="3D-3D-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">other</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">is_a?</span> <span class="ruby-constant">StaticModel</span> + <span class="ruby-identifier">id</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">id</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">super</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- 3D-3D-source --> + + </div> + + + + + </div><!-- 3D-3D-method --> + + + <div id="method-i-5B-5D" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">[]</span><span + class="method-args">(key)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Used by AR for fetching attributes</p> + +<p>Pass it along if we respond to it.</p> + + + + <div class="method-source-code" id="5B-5D-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>) + <span class="ruby-identifier">send</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">key</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- 5B-5D-source --> + + </div> + + + + + </div><!-- 5B-5D-method --> + + + <div id="method-i-destroyed-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroyed?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroyed-3F-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroyed?</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroyed-3F-source --> + + </div> + + + + + </div><!-- destroyed-3F-method --> + + + <div id="method-i-new_record-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new_record?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new_record-3F-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 28</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new_record?</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new_record-3F-source --> + + </div> + + + + + </div><!-- new_record-3F-method --> + + + <div id="method-i-persisted-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">persisted?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="persisted-3F-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 32</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">persisted?</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- persisted-3F-source --> + + </div> + + + + + </div><!-- persisted-3F-method --> + + + <div id="method-i-to_param" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_param</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="to_param-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_param</span> + <span class="ruby-identifier">id</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_param-source --> + + </div> + + + + + </div><!-- to_param-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/StaticModel/ClassMethods.html b/doc/app/StaticModel/ClassMethods.html new file mode 100644 index 00000000000..27ee1373838 --- /dev/null +++ b/doc/app/StaticModel/ClassMethods.html @@ -0,0 +1,511 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module StaticModel::ClassMethods - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/static_model.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-base_class">#base_class</a> + + <li><a href="#method-i-primary_key">#primary_key</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module StaticModel::ClassMethods</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-base_class" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">base_class</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Used by ActiveRecord’s polymorphic association to set object_type</p> + + + + <div class="method-source-code" id="base_class-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">base_class</span> + <span class="ruby-keyword">self</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- base_class-source --> + + </div> + + + + + </div><!-- base_class-method --> + + + <div id="method-i-primary_key" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">primary_key</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Used by ActiveRecord’s polymorphic association to set object_id</p> + + + + <div class="method-source-code" id="primary_key-source"> + <pre><span class="ruby-comment"># File app/roles/static_model.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">primary_key</span> + <span class="ruby-string">'id'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- primary_key-source --> + + </div> + + + + + </div><!-- primary_key-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/SystemHook.html b/doc/app/SystemHook.html new file mode 100644 index 00000000000..8e35bf27294 --- /dev/null +++ b/doc/app/SystemHook.html @@ -0,0 +1,525 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class SystemHook - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/system_hook.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="WebHook.html">WebHook</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-all_hooks_fire">::all_hooks_fire</a> + + <li><a href="#method-i-async_execute">#async_execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class SystemHook</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-all_hooks_fire" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">all_hooks_fire</span><span + class="method-args">(data)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="all_hooks_fire-source"> + <pre><span class="ruby-comment"># File app/models/system_hook.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">all_hooks_fire</span>(<span class="ruby-identifier">data</span>) + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sh</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">sh</span>.<span class="ruby-identifier">async_execute</span> <span class="ruby-identifier">data</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- all_hooks_fire-source --> + + </div> + + + + + </div><!-- all_hooks_fire-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-async_execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">async_execute</span><span + class="method-args">(data)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="async_execute-source"> + <pre><span class="ruby-comment"># File app/models/system_hook.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">async_execute</span>(<span class="ruby-identifier">data</span>) + <span class="ruby-constant">Resque</span>.<span class="ruby-identifier">enqueue</span>(<span class="ruby-constant">SystemHookWorker</span>, <span class="ruby-identifier">id</span>, <span class="ruby-identifier">data</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- async_execute-source --> + + </div> + + + + + </div><!-- async_execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/SystemHookObserver.html b/doc/app/SystemHookObserver.html new file mode 100644 index 00000000000..20d819637d1 --- /dev/null +++ b/doc/app/SystemHookObserver.html @@ -0,0 +1,573 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class SystemHookObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/system_hook_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-after_destroy">#after_destroy</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class SystemHookObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(model)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/system_hook_observer.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span>(<span class="ruby-identifier">model</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Project</span> + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all_hooks_fire</span>({ + <span class="ruby-identifier">event_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"project_create"</span>, + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">path</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">path</span>, + <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">owner_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">owner</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">owner_email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">owner</span>.<span class="ruby-identifier">email</span>, + <span class="ruby-identifier">created_at</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">created_at</span> + }) + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">User</span> + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all_hooks_fire</span>({ + <span class="ruby-identifier">event_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"user_create"</span>, + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">email</span>, + <span class="ruby-identifier">created_at</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">created_at</span> + }) + + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">UsersProject</span> + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all_hooks_fire</span>({ + <span class="ruby-identifier">event_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"user_add_to_team"</span>, + <span class="ruby-identifier">project_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">project_path</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">path</span>, + <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">project_id</span>, + <span class="ruby-identifier">user_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">user_email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">email</span>, + <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">repo_access_human</span>, + <span class="ruby-identifier">created_at</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">created_at</span> + }) + + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + <div id="method-i-after_destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_destroy</span><span + class="method-args">(model)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_destroy-source"> + <pre><span class="ruby-comment"># File app/observers/system_hook_observer.rb, line 38</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_destroy</span>(<span class="ruby-identifier">model</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Project</span> + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all_hooks_fire</span>({ + <span class="ruby-identifier">event_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"project_destroy"</span>, + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">path</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">path</span>, + <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">owner_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">owner</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">owner_email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">owner</span>.<span class="ruby-identifier">email</span>, + }) + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">User</span> + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all_hooks_fire</span>({ + <span class="ruby-identifier">event_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"user_destroy"</span>, + <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">email</span> + }) + + <span class="ruby-keyword">elsif</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">UsersProject</span> + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">all_hooks_fire</span>({ + <span class="ruby-identifier">event_name</span><span class="ruby-operator">:</span> <span class="ruby-string">"user_remove_from_team"</span>, + <span class="ruby-identifier">project_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">project_path</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">path</span>, + <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">project_id</span>, + <span class="ruby-identifier">user_name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">name</span>, + <span class="ruby-identifier">user_email</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">email</span>, + <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-identifier">model</span>.<span class="ruby-identifier">repo_access_human</span> + }) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_destroy-source --> + + </div> + + + + + </div><!-- after_destroy-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/SystemHookWorker.html b/doc/app/SystemHookWorker.html new file mode 100644 index 00000000000..153eb5776fe --- /dev/null +++ b/doc/app/SystemHookWorker.html @@ -0,0 +1,485 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class SystemHookWorker - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/workers/system_hook_worker.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-perform">::perform</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class SystemHookWorker</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-perform" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">perform</span><span + class="method-args">(hook_id, data)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="perform-source"> + <pre><span class="ruby-comment"># File app/workers/system_hook_worker.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">perform</span>(<span class="ruby-identifier">hook_id</span>, <span class="ruby-identifier">data</span>) + <span class="ruby-constant">SystemHook</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">hook_id</span>).<span class="ruby-identifier">execute</span> <span class="ruby-identifier">data</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- perform-source --> + + </div> + + + + + </div><!-- perform-method --> + + + </section><!-- public-class-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/TabHelper.html b/doc/app/TabHelper.html new file mode 100644 index 00000000000..43cc08a4f53 --- /dev/null +++ b/doc/app/TabHelper.html @@ -0,0 +1,621 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module TabHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/tab_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-branches_tab_class">#branches_tab_class</a> + + <li><a href="#method-i-nav_link">#nav_link</a> + + <li><a href="#method-i-project_tab_class">#project_tab_class</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module TabHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-branches_tab_class" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">branches_tab_class</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="branches_tab_class-source"> + <pre><span class="ruby-comment"># File app/helpers/tab_helper.rb, line 80</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">branches_tab_class</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">current_page?</span>(<span class="ruby-identifier">branches_project_repository_path</span>(<span class="ruby-ivar">@project</span>)) <span class="ruby-operator">||</span> + <span class="ruby-identifier">current_controller?</span>(<span class="ruby-value">:protected_branches</span>) <span class="ruby-operator">||</span> + <span class="ruby-identifier">current_page?</span>(<span class="ruby-identifier">project_repository_path</span>(<span class="ruby-ivar">@project</span>)) + <span class="ruby-string">'active'</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- branches_tab_class-source --> + + </div> + + + + + </div><!-- branches_tab_class-method --> + + + <div id="method-i-nav_link" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">nav_link</span><span + class="method-args">(options = {}, &block)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Navigation link helper</p> + +<p>Returns an `li` element with an ‘active’ class if the supplied +controller(s) and/or action(s) are currently active. The content of the +element is the value passed to the block.</p> + +<p>options - The options hash used to determine if the element is “active” +(default: {})</p> + +<pre>:controller - One or more controller names to check (optional). +:action - One or more action names to check (optional). +:path - A shorthand path, such as 'dashboard#index', to check (optional). +:html_options - Extra options to be passed to the list element (optional).</pre> + +<p>block - An optional block that will become the contents of the returned</p> + +<pre>`li` element.</pre> + +<p>When both :controller and :action are specified, BOTH must match in order +to be marked as active. When only one is given, either can match.</p> + +<p>Examples</p> + +<pre class="ruby"><span class="ruby-comment"># Assuming we're on TreeController#show</span> + +<span class="ruby-comment"># Controller matches, but action doesn't</span> +<span class="ruby-identifier">nav_link</span>(<span class="ruby-identifier">controller</span><span class="ruby-operator">:</span> [:<span class="ruby-identifier">tree</span>, :<span class="ruby-identifier">refs</span>], <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> :<span class="ruby-identifier">edit</span>) { <span class="ruby-string">"Hello"</span> } +<span class="ruby-comment"># => '<li>Hello</li>'</span> + +<span class="ruby-comment"># Controller matches</span> +<span class="ruby-identifier">nav_link</span>(<span class="ruby-identifier">controller</span><span class="ruby-operator">:</span> [:<span class="ruby-identifier">tree</span>, :<span class="ruby-identifier">refs</span>]) { <span class="ruby-string">"Hello"</span> } +<span class="ruby-comment"># => '<li class="active">Hello</li>'</span> + +<span class="ruby-comment"># Shorthand path</span> +<span class="ruby-identifier">nav_link</span>(<span class="ruby-identifier">path</span><span class="ruby-operator">:</span> <span class="ruby-string">'tree#show'</span>) { <span class="ruby-string">"Hello"</span> } +<span class="ruby-comment"># => '<li class="active">Hello</li>'</span> + +<span class="ruby-comment"># Supplying custom options for the list element</span> +<span class="ruby-identifier">nav_link</span>(<span class="ruby-identifier">controller</span><span class="ruby-operator">:</span> :<span class="ruby-identifier">tree</span>, <span class="ruby-identifier">html_options</span><span class="ruby-operator">:</span> {<span class="ruby-keyword">class</span><span class="ruby-operator">:</span> <span class="ruby-string">'home'</span>}) { <span class="ruby-string">"Hello"</span> } +<span class="ruby-comment"># => '<li class="home active">Hello</li>'</span> +</pre> + +<p>Returns a list item element String</p> + + + + <div class="method-source-code" id="nav_link-source"> + <pre><span class="ruby-comment"># File app/helpers/tab_helper.rb, line 40</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">nav_link</span>(<span class="ruby-identifier">options</span> = {}, &<span class="ruby-identifier">block</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:path</span>) + <span class="ruby-identifier">c</span>, <span class="ruby-identifier">a</span>, <span class="ruby-identifier">_</span> = <span class="ruby-identifier">path</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">'#'</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">c</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:controller</span>) + <span class="ruby-identifier">a</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:action</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">c</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">a</span> + <span class="ruby-comment"># When given both options, make sure BOTH are active</span> + <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">current_controller?</span>(*<span class="ruby-identifier">c</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">current_action?</span>(*<span class="ruby-identifier">a</span>) <span class="ruby-operator">?</span> <span class="ruby-string">'active'</span> <span class="ruby-operator">:</span> <span class="ruby-string">''</span> + <span class="ruby-keyword">else</span> + <span class="ruby-comment"># Otherwise check EITHER option</span> + <span class="ruby-identifier">klass</span> = <span class="ruby-identifier">current_controller?</span>(*<span class="ruby-identifier">c</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">current_action?</span>(*<span class="ruby-identifier">a</span>) <span class="ruby-operator">?</span> <span class="ruby-string">'active'</span> <span class="ruby-operator">:</span> <span class="ruby-string">''</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-comment"># Add our custom class into the html_options, which may or may not exist</span> + <span class="ruby-comment"># and which may or may not already have a :class key</span> + <span class="ruby-identifier">o</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:html_options</span>) <span class="ruby-operator">||</span> {} + <span class="ruby-identifier">o</span>[<span class="ruby-value">:class</span>] <span class="ruby-operator">||=</span> <span class="ruby-string">''</span> + <span class="ruby-identifier">o</span>[<span class="ruby-value">:class</span>] <span class="ruby-operator">+=</span> <span class="ruby-string">' '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">klass</span> + <span class="ruby-identifier">o</span>[<span class="ruby-value">:class</span>].<span class="ruby-identifier">strip!</span> + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span> + <span class="ruby-identifier">content_tag</span>(<span class="ruby-value">:li</span>, <span class="ruby-identifier">capture</span>(&<span class="ruby-identifier">block</span>), <span class="ruby-identifier">o</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">content_tag</span>(<span class="ruby-value">:li</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">o</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- nav_link-source --> + + </div> + + + + + </div><!-- nav_link-method --> + + + <div id="method-i-project_tab_class" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_tab_class</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_tab_class-source"> + <pre><span class="ruby-comment"># File app/helpers/tab_helper.rb, line 70</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_tab_class</span> + [<span class="ruby-value">:show</span>, <span class="ruby-value">:files</span>, <span class="ruby-value">:edit</span>, <span class="ruby-value">:update</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">action</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">return</span> <span class="ruby-string">"active"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">current_page?</span>(<span class="ruby-identifier">controller</span><span class="ruby-operator">:</span> <span class="ruby-string">"projects"</span>, <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-identifier">action</span>, <span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@project</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">if</span> [<span class="ruby-string">'snippets'</span>, <span class="ruby-string">'hooks'</span>, <span class="ruby-string">'deploy_keys'</span>, <span class="ruby-string">'team_members'</span>].<span class="ruby-identifier">include?</span> <span class="ruby-identifier">controller</span>.<span class="ruby-identifier">controller_name</span> + <span class="ruby-string">"active"</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- project_tab_class-source --> + + </div> + + + + + </div><!-- project_tab_class-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/TagsHelper.html b/doc/app/TagsHelper.html new file mode 100644 index 00000000000..3a98d61f38d --- /dev/null +++ b/doc/app/TagsHelper.html @@ -0,0 +1,516 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module TagsHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/tags_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-tag_list">#tag_list</a> + + <li><a href="#method-i-tag_path">#tag_path</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module TagsHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-tag_list" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tag_list</span><span + class="method-args">(project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="tag_list-source"> + <pre><span class="ruby-comment"># File app/helpers/tags_helper.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tag_list</span> <span class="ruby-identifier">project</span> + <span class="ruby-identifier">html</span> = <span class="ruby-string">''</span> + <span class="ruby-identifier">project</span>.<span class="ruby-identifier">tag_list</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tag</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">html</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">link_to</span> <span class="ruby-identifier">tag</span>, <span class="ruby-identifier">tag_path</span>(<span class="ruby-identifier">tag</span>) + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">html</span>.<span class="ruby-identifier">html_safe</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- tag_list-source --> + + </div> + + + + + </div><!-- tag_list-method --> + + + <div id="method-i-tag_path" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tag_path</span><span + class="method-args">(tag)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="tag_path-source"> + <pre><span class="ruby-comment"># File app/helpers/tags_helper.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tag_path</span> <span class="ruby-identifier">tag</span> + <span class="ruby-node">"/tags/#{tag}"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- tag_path-source --> + + </div> + + + + + </div><!-- tag_path-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Team.html b/doc/app/Team.html new file mode 100644 index 00000000000..3a583694799 --- /dev/null +++ b/doc/app/Team.html @@ -0,0 +1,710 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Team - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/team.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-add_user_id_to_team">#add_user_id_to_team</a> + + <li><a href="#method-i-add_user_to_team">#add_user_to_team</a> + + <li><a href="#method-i-add_users_ids_to_team">#add_users_ids_to_team</a> + + <li><a href="#method-i-add_users_to_team">#add_users_to_team</a> + + <li><a href="#method-i-delete_users_ids_from_team">#delete_users_ids_from_team</a> + + <li><a href="#method-i-team_member_by_id">#team_member_by_id</a> + + <li><a href="#method-i-team_member_by_name_or_email">#team_member_by_name_or_email</a> + + <li><a href="#method-i-update_users_ids_to_role">#update_users_ids_to_role</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Team</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-add_user_id_to_team" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_user_id_to_team</span><span + class="method-args">(user_id, access_role)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Add user to project with passed access role by user id</p> + + + + <div class="method-source-code" id="add_user_id_to_team-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 26</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_user_id_to_team</span>(<span class="ruby-identifier">user_id</span>, <span class="ruby-identifier">access_role</span>) + <span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">create</span>( + <span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user_id</span>, + <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-identifier">access_role</span> + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- add_user_id_to_team-source --> + + </div> + + + + + </div><!-- add_user_id_to_team-method --> + + + <div id="method-i-add_user_to_team" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_user_to_team</span><span + class="method-args">(user, access_role)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Add user to project with passed access role</p> + + + + <div class="method-source-code" id="add_user_to_team-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_user_to_team</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">access_role</span>) + <span class="ruby-identifier">add_user_id_to_team</span>(<span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">access_role</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- add_user_to_team-source --> + + </div> + + + + + </div><!-- add_user_to_team-method --> + + + <div id="method-i-add_users_ids_to_team" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_users_ids_to_team</span><span + class="method-args">(users_ids, access_role)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Add multiple users to project with same access role by user ids</p> + + + + <div class="method-source-code" id="add_users_ids_to_team-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 35</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_users_ids_to_team</span>(<span class="ruby-identifier">users_ids</span>, <span class="ruby-identifier">access_role</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">bulk_import</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">users_ids</span>, <span class="ruby-identifier">access_role</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">update_repository</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- add_users_ids_to_team-source --> + + </div> + + + + + </div><!-- add_users_ids_to_team-method --> + + + <div id="method-i-add_users_to_team" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">add_users_to_team</span><span + class="method-args">(users, access_role)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Add multiple users to project with same access role</p> + + + + <div class="method-source-code" id="add_users_to_team-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">add_users_to_team</span>(<span class="ruby-identifier">users</span>, <span class="ruby-identifier">access_role</span>) + <span class="ruby-identifier">add_users_ids_to_team</span>(<span class="ruby-identifier">users</span>.<span class="ruby-identifier">map</span>(&<span class="ruby-value">:id</span>), <span class="ruby-identifier">access_role</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- add_users_to_team-source --> + + </div> + + + + + </div><!-- add_users_to_team-method --> + + + <div id="method-i-delete_users_ids_from_team" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">delete_users_ids_from_team</span><span + class="method-args">(users_ids)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Delete multiple users from project by user ids</p> + + + + <div class="method-source-code" id="delete_users_ids_from_team-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 48</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete_users_ids_from_team</span>(<span class="ruby-identifier">users_ids</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">bulk_delete</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">users_ids</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">update_repository</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- delete_users_ids_from_team-source --> + + </div> + + + + + </div><!-- delete_users_ids_from_team-method --> + + + <div id="method-i-team_member_by_id" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">team_member_by_id</span><span + class="method-args">(user_id)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Get <a href="Team.html">Team</a> Member record by user id</p> + + + + <div class="method-source-code" id="team_member_by_id-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">team_member_by_id</span>(<span class="ruby-identifier">user_id</span>) + <span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">find_by_user_id</span>(<span class="ruby-identifier">user_id</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- team_member_by_id-source --> + + </div> + + + + + </div><!-- team_member_by_id-method --> + + + <div id="method-i-team_member_by_name_or_email" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">team_member_by_name_or_email</span><span + class="method-args">(name = nil, email = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="team_member_by_name_or_email-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">team_member_by_name_or_email</span>(<span class="ruby-identifier">name</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">email</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">user</span> = <span class="ruby-identifier">users</span>.<span class="ruby-identifier">where</span>(<span class="ruby-string">"name like ? or email like ?"</span>, <span class="ruby-identifier">name</span>, <span class="ruby-identifier">email</span>).<span class="ruby-identifier">first</span> + <span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">user</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">user</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- team_member_by_name_or_email-source --> + + </div> + + + + + </div><!-- team_member_by_name_or_email-method --> + + + <div id="method-i-update_users_ids_to_role" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_users_ids_to_role</span><span + class="method-args">(users_ids, access_role)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Update multiple project users to same access role by user ids</p> + + + + <div class="method-source-code" id="update_users_ids_to_role-source"> + <pre><span class="ruby-comment"># File app/roles/team.rb, line 42</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_users_ids_to_role</span>(<span class="ruby-identifier">users_ids</span>, <span class="ruby-identifier">access_role</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">bulk_update</span>(<span class="ruby-keyword">self</span>, <span class="ruby-identifier">users_ids</span>, <span class="ruby-identifier">access_role</span>) + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">update_repository</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update_users_ids_to_role-source --> + + </div> + + + + + </div><!-- update_users_ids_to_role-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/TeamMembersController.html b/doc/app/TeamMembersController.html new file mode 100644 index 00000000000..46af7c9fd57 --- /dev/null +++ b/doc/app/TeamMembersController.html @@ -0,0 +1,698 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class TeamMembersController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/team_members_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-apply_import">#apply_import</a> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-index">#index</a> + + <li><a href="#method-i-new">#new</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class TeamMembersController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-apply_import" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">apply_import</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="apply_import-source"> + <pre><span class="ruby-comment"># File app/controllers/team_members_controller.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">apply_import</span> + <span class="ruby-identifier">giver</span> = <span class="ruby-constant">Project</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:source_project_id</span>]) + <span class="ruby-identifier">status</span> = <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">import_team</span>(<span class="ruby-identifier">giver</span>, <span class="ruby-identifier">project</span>) + <span class="ruby-identifier">notice</span> = <span class="ruby-identifier">status</span> <span class="ruby-operator">?</span> <span class="ruby-string">"Succesfully imported"</span> <span class="ruby-operator">:</span> <span class="ruby-string">"Import failed"</span> + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_team_members_path</span>(<span class="ruby-identifier">project</span>), <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-identifier">notice</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- apply_import-source --> + + </div> + + + + + </div><!-- apply_import-method --> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/team_members_controller.rb, line 18</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">add_users_ids_to_team</span>( + <span class="ruby-identifier">params</span>[<span class="ruby-value">:user_ids</span>], + <span class="ruby-identifier">params</span>[<span class="ruby-value">:project_access</span>] + ) + + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_team_index_path</span>(<span class="ruby-ivar">@project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/team_members_controller.rb, line 37</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@team_member</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@team_member</span>.<span class="ruby-identifier">destroy</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_team_index_path</span>(<span class="ruby-ivar">@project</span>) } + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">nothing</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-index" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">index</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="index-source"> + <pre><span class="ruby-comment"># File app/controllers/team_members_controller.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">index</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- index-source --> + + </div> + + + + + </div><!-- index-method --> + + + <div id="method-i-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/controllers/team_members_controller.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">new</span> + <span class="ruby-ivar">@team_member</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/team_members_controller.rb, line 9</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@team_member</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@events</span> = <span class="ruby-ivar">@team_member</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">recent_events</span>.<span class="ruby-identifier">where</span>(<span class="ruby-value">:project_id</span> =<span class="ruby-operator">></span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-value">7</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/team_members_controller.rb, line 27</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-ivar">@team_member</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-ivar">@team_member</span>.<span class="ruby-identifier">update_attributes</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:team_member</span>]) + + <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@team_member</span>.<span class="ruby-identifier">valid?</span> + <span class="ruby-identifier">flash</span>[<span class="ruby-value">:alert</span>] = <span class="ruby-string">"User should have at least one role"</span> + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_team_index_path</span>(<span class="ruby-ivar">@project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/TestHookContext.html b/doc/app/TestHookContext.html new file mode 100644 index 00000000000..e18701cb035 --- /dev/null +++ b/doc/app/TestHookContext.html @@ -0,0 +1,488 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class TestHookContext - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/contexts/test_hook_context.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="BaseContext.html">BaseContext</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class TestHookContext</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/contexts/test_hook_context.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span> + <span class="ruby-identifier">hook</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-identifier">commits</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">commits</span>(<span class="ruby-identifier">project</span>.<span class="ruby-identifier">default_branch</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-value">3</span>) + <span class="ruby-identifier">data</span> = <span class="ruby-identifier">project</span>.<span class="ruby-identifier">post_receive_data</span>(<span class="ruby-identifier">commits</span>.<span class="ruby-identifier">last</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">commits</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">id</span>, <span class="ruby-node">"refs/heads/#{project.default_branch}"</span>, <span class="ruby-identifier">current_user</span>) + <span class="ruby-identifier">hook</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-identifier">data</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Tree.html b/doc/app/Tree.html new file mode 100644 index 00000000000..f1f414a4f36 --- /dev/null +++ b/doc/app/Tree.html @@ -0,0 +1,663 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Tree - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/tree.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">Object + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><span class="include">Linguist::BlobHelper</span> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-new">::new</a> + + <li><a href="#method-i-empty-3F">#empty?</a> + + <li><a href="#method-i-invalid-3F">#invalid?</a> + + <li><a href="#method-i-is_blob-3F">#is_blob?</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Tree</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-path" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">path</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-project" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">project</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-ref" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">ref</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + <div id="attribute-i-tree" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">tree</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-new" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">new</span><span + class="method-args">(raw_tree, project, ref = nil, path = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="new-source"> + <pre><span class="ruby-comment"># File app/models/tree.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">raw_tree</span>, <span class="ruby-identifier">project</span>, <span class="ruby-identifier">ref</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">path</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>, <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">project</span>, <span class="ruby-identifier">ref</span>, <span class="ruby-identifier">path</span> + <span class="ruby-ivar">@tree</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">present?</span> + <span class="ruby-identifier">raw_tree</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">dup</span>.<span class="ruby-identifier">force_encoding</span>(<span class="ruby-string">'ascii-8bit'</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">raw_tree</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- new-source --> + + </div> + + + + + </div><!-- new-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-empty-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">empty?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="empty-3F-source"> + <pre><span class="ruby-comment"># File app/models/tree.rb, line 25</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">data</span>.<span class="ruby-identifier">blank?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- empty-3F-source --> + + </div> + + + + + </div><!-- empty-3F-method --> + + + <div id="method-i-invalid-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">invalid?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="invalid-3F-source"> + <pre><span class="ruby-comment"># File app/models/tree.rb, line 21</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">invalid?</span> + <span class="ruby-identifier">tree</span>.<span class="ruby-identifier">nil?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- invalid-3F-source --> + + </div> + + + + + </div><!-- invalid-3F-method --> + + + <div id="method-i-is_blob-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">is_blob?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="is_blob-3F-source"> + <pre><span class="ruby-comment"># File app/models/tree.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">is_blob?</span> + <span class="ruby-identifier">tree</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Blob</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- is_blob-3F-source --> + + </div> + + + + + </div><!-- is_blob-3F-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/TreeController.html b/doc/app/TreeController.html new file mode 100644 index 00000000000..1adba0ec4b2 --- /dev/null +++ b/doc/app/TreeController.html @@ -0,0 +1,583 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class TreeController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/tree_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="ExtractsPath.html">ExtractsPath</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-show">#show</a> + + <li><a href="#method-i-update">#update</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class TreeController</h1> + + <div id="description" class="description"> + +<p>Controller for viewing a repository’s file structure</p> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/tree_controller.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> + <span class="ruby-ivar">@last_commit</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">last_commit_for</span>(<span class="ruby-ivar">@ref</span>, <span class="ruby-ivar">@path</span>).<span class="ruby-identifier">sha</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/tree_controller.rb, line 13</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-ivar">@hex_path</span> = <span class="ruby-constant">Digest</span><span class="ruby-operator">::</span><span class="ruby-constant">SHA1</span>.<span class="ruby-identifier">hexdigest</span>(<span class="ruby-ivar">@path</span>) + <span class="ruby-ivar">@logs_path</span> = <span class="ruby-identifier">logs_file_project_ref_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>, <span class="ruby-ivar">@path</span>) + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> + <span class="ruby-comment"># Disable cache so browser history works</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">js</span> { <span class="ruby-identifier">no_cache_headers</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + <div id="method-i-update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update-source"> + <pre><span class="ruby-comment"># File app/controllers/tree_controller.rb, line 28</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span> + <span class="ruby-identifier">file_editor</span> = <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">FileEditor</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@ref</span>) + <span class="ruby-identifier">update_status</span> = <span class="ruby-identifier">file_editor</span>.<span class="ruby-identifier">update</span>( + <span class="ruby-ivar">@path</span>, + <span class="ruby-identifier">params</span>[<span class="ruby-value">:content</span>], + <span class="ruby-identifier">params</span>[<span class="ruby-value">:commit_message</span>], + <span class="ruby-identifier">params</span>[<span class="ruby-value">:last_commit</span>] + ) + + <span class="ruby-keyword">if</span> <span class="ruby-identifier">update_status</span> + <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_tree_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@id</span>), <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">"Your changes have been successfully commited"</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">flash</span>[<span class="ruby-value">:notice</span>] = <span class="ruby-string">"Your changes could not be commited, because the file has been changed"</span> + <span class="ruby-identifier">render</span> <span class="ruby-value">:edit</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update-source --> + + </div> + + + + + </div><!-- update-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/TreeDecorator.html b/doc/app/TreeDecorator.html new file mode 100644 index 00000000000..e6bdc0fa826 --- /dev/null +++ b/doc/app/TreeDecorator.html @@ -0,0 +1,597 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class TreeDecorator - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/decorators/tree_decorator.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ApplicationDecorator.html">ApplicationDecorator</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-breadcrumbs">#breadcrumbs</a> + + <li><a href="#method-i-readme">#readme</a> + + <li><a href="#method-i-up_dir-3F">#up_dir?</a> + + <li><a href="#method-i-up_dir_path">#up_dir_path</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class TreeDecorator</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-breadcrumbs" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">breadcrumbs</span><span + class="method-args">(max_links = 2) { |link_to("..", "| ... }</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="breadcrumbs-source"> + <pre><span class="ruby-comment"># File app/decorators/tree_decorator.rb, line 4</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">breadcrumbs</span>(<span class="ruby-identifier">max_links</span> = <span class="ruby-value">2</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span> + <span class="ruby-identifier">part_path</span> = <span class="ruby-string">""</span> + <span class="ruby-identifier">parts</span> = <span class="ruby-identifier">path</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">"\/"</span>) + + <span class="ruby-comment">#parts = parts[0...-1] if is_blob?</span> + + <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">h</span>.<span class="ruby-identifier">link_to</span>(<span class="ruby-string">".."</span>, <span class="ruby-node">"#"</span>, <span class="ruby-identifier">remote</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>)) <span class="ruby-keyword">if</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">></span> <span class="ruby-identifier">max_links</span> + + <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">part_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">part_path</span>, <span class="ruby-identifier">part</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">part_path</span>.<span class="ruby-identifier">empty?</span> + <span class="ruby-identifier">part_path</span> = <span class="ruby-identifier">part</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">part_path</span>.<span class="ruby-identifier">empty?</span> + + <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">last</span>(<span class="ruby-value">2</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">part</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">parts</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">></span> <span class="ruby-identifier">max_links</span> + <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">h</span>.<span class="ruby-identifier">link_to</span>(<span class="ruby-identifier">h</span>.<span class="ruby-identifier">truncate</span>(<span class="ruby-identifier">part</span>, <span class="ruby-identifier">length</span><span class="ruby-operator">:</span> <span class="ruby-value">40</span>), <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_tree_path</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">h</span>.<span class="ruby-identifier">tree_join</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">part_path</span>)), <span class="ruby-identifier">remote</span><span class="ruby-operator">:</span> <span class="ruby-keyword">true</span>)) + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- breadcrumbs-source --> + + </div> + + + + + </div><!-- breadcrumbs-method --> + + + <div id="method-i-readme" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">readme</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="readme-source"> + <pre><span class="ruby-comment"># File app/decorators/tree_decorator.rb, line 32</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">readme</span> + <span class="ruby-ivar">@readme</span> <span class="ruby-operator">||=</span> <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">find</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Blob</span>) <span class="ruby-keyword">and</span> <span class="ruby-identifier">c</span>.<span class="ruby-identifier">name</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">%r^readme/</span> } +<span class="ruby-keyword">end</span></pre> + </div><!-- readme-source --> + + </div> + + + + + </div><!-- readme-method --> + + + <div id="method-i-up_dir-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">up_dir?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="up_dir-3F-source"> + <pre><span class="ruby-comment"># File app/decorators/tree_decorator.rb, line 23</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">up_dir?</span> + <span class="ruby-identifier">path</span>.<span class="ruby-identifier">present?</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- up_dir-3F-source --> + + </div> + + + + + </div><!-- up_dir-3F-method --> + + + <div id="method-i-up_dir_path" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">up_dir_path</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="up_dir_path-source"> + <pre><span class="ruby-comment"># File app/decorators/tree_decorator.rb, line 27</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">up_dir_path</span> + <span class="ruby-identifier">file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-string">".."</span>) + <span class="ruby-identifier">h</span>.<span class="ruby-identifier">project_tree_path</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">h</span>.<span class="ruby-identifier">tree_join</span>(<span class="ruby-identifier">ref</span>, <span class="ruby-identifier">file</span>)) +<span class="ruby-keyword">end</span></pre> + </div><!-- up_dir_path-source --> + + </div> + + + + + </div><!-- up_dir_path-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/TreeHelper.html b/doc/app/TreeHelper.html new file mode 100644 index 00000000000..e185ba728ae --- /dev/null +++ b/doc/app/TreeHelper.html @@ -0,0 +1,736 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module TreeHelper - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/helpers/tree_helper.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-allowed_tree_edit-3F">#allowed_tree_edit?</a> + + <li><a href="#method-i-gitlab_markdown-3F">#gitlab_markdown?</a> + + <li><a href="#method-i-markup-3F">#markup?</a> + + <li><a href="#method-i-plain_text_readme-3F">#plain_text_readme?</a> + + <li><a href="#method-i-render_tree">#render_tree</a> + + <li><a href="#method-i-tree_hex_class">#tree_hex_class</a> + + <li><a href="#method-i-tree_icon">#tree_icon</a> + + <li><a href="#method-i-tree_join">#tree_join</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module TreeHelper</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-allowed_tree_edit-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">allowed_tree_edit?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="allowed_tree_edit-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 63</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">allowed_tree_edit?</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">protected_branch?</span> <span class="ruby-ivar">@ref</span> + <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:push_code_to_protected_branches</span>, <span class="ruby-ivar">@project</span>) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:push_code</span>, <span class="ruby-ivar">@project</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- allowed_tree_edit-3F-source --> + + </div> + + + + + </div><!-- allowed_tree_edit-3F-method --> + + + <div id="method-i-gitlab_markdown-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">gitlab_markdown?</span><span + class="method-args">(filename)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="gitlab_markdown-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 50</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">gitlab_markdown?</span>(<span class="ruby-identifier">filename</span>) + <span class="ruby-identifier">filename</span>.<span class="ruby-identifier">end_with?</span>(*<span class="ruby-node">%w(.mdown .md .markdown)</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- gitlab_markdown-3F-source --> + + </div> + + + + + </div><!-- gitlab_markdown-3F-method --> + + + <div id="method-i-markup-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">markup?</span><span + class="method-args">(filename)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Public: Determines if a given filename is compatible with GitHub::Markup.</p> + +<p>filename - Filename string to check</p> + +<p>Returns boolean</p> + + + + <div class="method-source-code" id="markup-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 45</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">markup?</span>(<span class="ruby-identifier">filename</span>) + <span class="ruby-identifier">filename</span>.<span class="ruby-identifier">end_with?</span>(*<span class="ruby-node">%w(.textile .rdoc .org .creole + .mediawiki .rst .asciidoc .pod)</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- markup-3F-source --> + + </div> + + + + + </div><!-- markup-3F-method --> + + + <div id="method-i-plain_text_readme-3F" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">plain_text_readme?</span><span + class="method-args">(filename)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="plain_text_readme-3F-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 54</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">plain_text_readme?</span> <span class="ruby-identifier">filename</span> + <span class="ruby-identifier">filename</span> <span class="ruby-operator">==</span> <span class="ruby-string">'README'</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- plain_text_readme-3F-source --> + + </div> + + + + + </div><!-- plain_text_readme-3F-method --> + + + <div id="method-i-render_tree" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">render_tree</span><span + class="method-args">(contents)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Sorts a repository’s tree so that folders are before files and renders +their corresponding partials</p> + +<p>contents - A Grit::Tree object for the current tree</p> + + + + <div class="method-source-code" id="render_tree-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">render_tree</span>(<span class="ruby-identifier">contents</span>) + <span class="ruby-comment"># Render Folders before Files/Submodules</span> + <span class="ruby-identifier">folders</span>, <span class="ruby-identifier">files</span> = <span class="ruby-identifier">contents</span>.<span class="ruby-identifier">partition</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Grit</span><span class="ruby-operator">::</span><span class="ruby-constant">Tree</span>) } + + <span class="ruby-identifier">tree</span> = <span class="ruby-string">""</span> + + <span class="ruby-comment"># Render folders if we have any</span> + <span class="ruby-identifier">tree</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">render</span> <span class="ruby-identifier">partial</span><span class="ruby-operator">:</span> <span class="ruby-string">'tree/tree_item'</span>, <span class="ruby-identifier">collection</span><span class="ruby-operator">:</span> <span class="ruby-identifier">folders</span>, <span class="ruby-identifier">locals</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">type</span><span class="ruby-operator">:</span> <span class="ruby-string">'folder'</span>} <span class="ruby-keyword">if</span> <span class="ruby-identifier">folders</span>.<span class="ruby-identifier">present?</span> + + <span class="ruby-identifier">files</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:url</span>) + <span class="ruby-comment"># Object is a Submodule</span> + <span class="ruby-identifier">tree</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">render</span> <span class="ruby-identifier">partial</span><span class="ruby-operator">:</span> <span class="ruby-string">'tree/submodule_item'</span>, <span class="ruby-identifier">object</span><span class="ruby-operator">:</span> <span class="ruby-identifier">f</span> + <span class="ruby-keyword">else</span> + <span class="ruby-comment"># Object is a Blob</span> + <span class="ruby-identifier">tree</span> <span class="ruby-operator">+=</span> <span class="ruby-identifier">render</span> <span class="ruby-identifier">partial</span><span class="ruby-operator">:</span> <span class="ruby-string">'tree/tree_item'</span>, <span class="ruby-identifier">object</span><span class="ruby-operator">:</span> <span class="ruby-identifier">f</span>, <span class="ruby-identifier">locals</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">type</span><span class="ruby-operator">:</span> <span class="ruby-string">'file'</span>} + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">tree</span>.<span class="ruby-identifier">html_safe</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- render_tree-source --> + + </div> + + + + + </div><!-- render_tree-method --> + + + <div id="method-i-tree_hex_class" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tree_hex_class</span><span + class="method-args">(content)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="tree_hex_class-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tree_hex_class</span>(<span class="ruby-identifier">content</span>) + <span class="ruby-node">"file_#{hexdigest(content.name)}"</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- tree_hex_class-source --> + + </div> + + + + + </div><!-- tree_hex_class-method --> + + + <div id="method-i-tree_icon" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tree_icon</span><span + class="method-args">(type)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Return an image icon depending on the file type</p> + +<p>type - String type of the tree item; either ‘folder’ or ‘file’</p> + + + + <div class="method-source-code" id="tree_icon-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tree_icon</span>(<span class="ruby-identifier">type</span>) + <span class="ruby-identifier">image</span> = <span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-string">'folder'</span> <span class="ruby-operator">?</span> <span class="ruby-string">'file_dir.png'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'file_txt.png'</span> + <span class="ruby-identifier">image_tag</span>(<span class="ruby-identifier">image</span>, <span class="ruby-identifier">size</span><span class="ruby-operator">:</span> <span class="ruby-string">'16x16'</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- tree_icon-source --> + + </div> + + + + + </div><!-- tree_icon-method --> + + + <div id="method-i-tree_join" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">tree_join</span><span + class="method-args">(*args)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Simple shortcut to File.join</p> + + + + <div class="method-source-code" id="tree_join-source"> + <pre><span class="ruby-comment"># File app/helpers/tree_helper.rb, line 59</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">tree_join</span>(*<span class="ruby-identifier">args</span>) + <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(*<span class="ruby-identifier">args</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- tree_join-source --> + + </div> + + + + + </div><!-- tree_join-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/User.html b/doc/app/User.html new file mode 100644 index 00000000000..513f96444b5 --- /dev/null +++ b/doc/app/User.html @@ -0,0 +1,755 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class User - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/user.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="Account.html">Account</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-create_from_omniauth">::create_from_omniauth</a> + + <li><a href="#method-c-filter">::filter</a> + + <li><a href="#method-c-find_for_ldap_auth">::find_for_ldap_auth</a> + + <li><a href="#method-c-find_or_new_for_omniauth">::find_or_new_for_omniauth</a> + + <li><a href="#method-c-gitlab_auth">::gitlab_auth</a> + + <li><a href="#method-c-search">::search</a> + + <li><a href="#method-c-without_projects">::without_projects</a> + + <li><a href="#method-i-generate_password">#generate_password</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class User</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + <!-- Attributes --> + <section id="attribute-method-details" class="method-section section"> + <h3 class="section-header">Attributes</h3> + + + <div id="attribute-i-force_random_password" class="method-detail"> + <div class="method-heading attribute-method-heading"> + <span class="method-name">force_random_password</span><span + class="attribute-access-type">[RW]</span> + </div> + + <div class="method-description"> + + + + </div> + </div> + + </section><!-- attribute-method-details --> + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-create_from_omniauth" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create_from_omniauth</span><span + class="method-args">(auth, ldap = false)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create_from_omniauth-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 55</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create_from_omniauth</span>(<span class="ruby-identifier">auth</span>, <span class="ruby-identifier">ldap</span> = <span class="ruby-keyword">false</span>) + <span class="ruby-identifier">gitlab_auth</span>.<span class="ruby-identifier">create_from_omniauth</span>(<span class="ruby-identifier">auth</span>, <span class="ruby-identifier">ldap</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- create_from_omniauth-source --> + + </div> + + + + + </div><!-- create_from_omniauth-method --> + + + <div id="method-c-filter" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">filter</span><span + class="method-args">(filter_name)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="filter-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 41</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">filter</span> <span class="ruby-identifier">filter_name</span> + <span class="ruby-keyword">case</span> <span class="ruby-identifier">filter_name</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"admins"</span>; <span class="ruby-keyword">self</span>.<span class="ruby-identifier">admins</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"blocked"</span>; <span class="ruby-keyword">self</span>.<span class="ruby-identifier">blocked</span> + <span class="ruby-keyword">when</span> <span class="ruby-string">"wop"</span>; <span class="ruby-keyword">self</span>.<span class="ruby-identifier">without_projects</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">active</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- filter-source --> + + </div> + + + + + </div><!-- filter-method --> + + + <div id="method-c-find_for_ldap_auth" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">find_for_ldap_auth</span><span + class="method-args">(auth, signed_in_resource = nil)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="find_for_ldap_auth-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 63</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_for_ldap_auth</span>(<span class="ruby-identifier">auth</span>, <span class="ruby-identifier">signed_in_resource</span> = <span class="ruby-keyword">nil</span>) + <span class="ruby-identifier">gitlab_auth</span>.<span class="ruby-identifier">find_for_ldap_auth</span>(<span class="ruby-identifier">auth</span>, <span class="ruby-identifier">signed_in_resource</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- find_for_ldap_auth-source --> + + </div> + + + + + </div><!-- find_for_ldap_auth-method --> + + + <div id="method-c-find_or_new_for_omniauth" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">find_or_new_for_omniauth</span><span + class="method-args">(auth)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="find_or_new_for_omniauth-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 59</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">find_or_new_for_omniauth</span>(<span class="ruby-identifier">auth</span>) + <span class="ruby-identifier">gitlab_auth</span>.<span class="ruby-identifier">find_or_new_for_omniauth</span>(<span class="ruby-identifier">auth</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- find_or_new_for_omniauth-source --> + + </div> + + + + + </div><!-- find_or_new_for_omniauth-method --> + + + <div id="method-c-gitlab_auth" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">gitlab_auth</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="gitlab_auth-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 67</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">gitlab_auth</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">Auth</span>.<span class="ruby-identifier">new</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- gitlab_auth-source --> + + </div> + + + + + </div><!-- gitlab_auth-method --> + + + <div id="method-c-search" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">search</span><span + class="method-args">(query)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="search-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 71</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">search</span> <span class="ruby-identifier">query</span> + <span class="ruby-identifier">where</span>(<span class="ruby-string">"name LIKE :query or email LIKE :query"</span>, <span class="ruby-identifier">query</span><span class="ruby-operator">:</span> <span class="ruby-node">"%#{query}%"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- search-source --> + + </div> + + + + + </div><!-- search-method --> + + + <div id="method-c-without_projects" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">without_projects</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="without_projects-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 51</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">without_projects</span> + <span class="ruby-identifier">where</span>(<span class="ruby-string">'id NOT IN (SELECT DISTINCT(user_id) FROM users_projects)'</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- without_projects-source --> + + </div> + + + + + </div><!-- without_projects-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-generate_password" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">generate_password</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="generate_password-source"> + <pre><span class="ruby-comment"># File app/models/user.rb, line 76</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">generate_password</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">force_random_password</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">password</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">password_confirmation</span> = <span class="ruby-constant">Devise</span>.<span class="ruby-identifier">friendly_token</span>.<span class="ruby-identifier">first</span>(<span class="ruby-value">8</span>) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- generate_password-source --> + + </div> + + + + + </div><!-- generate_password-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/UserObserver.html b/doc/app/UserObserver.html new file mode 100644 index 00000000000..95c7249d508 --- /dev/null +++ b/doc/app/UserObserver.html @@ -0,0 +1,557 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class UserObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/user_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-after_destroy">#after_destroy</a> + + <li><a href="#method-i-log_info">#log_info</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class UserObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/user_observer.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span>(<span class="ruby-identifier">user</span>) + <span class="ruby-identifier">log_info</span>(<span class="ruby-node">"User \"#{user.name}\" (#{user.email}) was created"</span>) + + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">new_user_email</span>(<span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">user</span>.<span class="ruby-identifier">password</span>).<span class="ruby-identifier">deliver</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + <div id="method-i-after_destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_destroy</span><span + class="method-args">(user)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_destroy-source"> + <pre><span class="ruby-comment"># File app/observers/user_observer.rb, line 8</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_destroy</span> <span class="ruby-identifier">user</span> + <span class="ruby-identifier">log_info</span>(<span class="ruby-node">"User \"#{user.name}\" (#{user.email}) was removed"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_destroy-source --> + + </div> + + + + + </div><!-- after_destroy-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-log_info" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">log_info</span><span + class="method-args">(message)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="log_info-source"> + <pre><span class="ruby-comment"># File app/observers/user_observer.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">log_info</span> <span class="ruby-identifier">message</span> + <span class="ruby-constant">Gitlab</span><span class="ruby-operator">::</span><span class="ruby-constant">AppLogger</span>.<span class="ruby-identifier">info</span> <span class="ruby-identifier">message</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- log_info-source --> + + </div> + + + + + </div><!-- log_info-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/UsersProject.html b/doc/app/UsersProject.html new file mode 100644 index 00000000000..f157832b492 --- /dev/null +++ b/doc/app/UsersProject.html @@ -0,0 +1,904 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class UsersProject - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/users_project.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><a class="include" href="GitHost.html">GitHost</a> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-access_roles">::access_roles</a> + + <li><a href="#method-c-bulk_delete">::bulk_delete</a> + + <li><a href="#method-c-bulk_import">::bulk_import</a> + + <li><a href="#method-c-bulk_update">::bulk_update</a> + + <li><a href="#method-c-import_team">::import_team</a> + + <li><a href="#method-c-user_bulk_import">::user_bulk_import</a> + + <li><a href="#method-c-without_repository_callback">::without_repository_callback</a> + + <li><a href="#method-i-project_access_human">#project_access_human</a> + + <li><a href="#method-i-repo_access_human">#repo_access_human</a> + + <li><a href="#method-i-role_access">#role_access</a> + + <li><a href="#method-i-update_repository">#update_repository</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class UsersProject</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + <!-- Constants --> + <section id="constants-list" class="section"> + <h3 class="section-header">Constants</h3> + <dl> + + <dt id="DEVELOPER">DEVELOPER + + <dd class="description"> + + + <dt id="GUEST">GUEST + + <dd class="description"> + + + <dt id="MASTER">MASTER + + <dd class="description"> + + + <dt id="REPORTER">REPORTER + + <dd class="description"> + + + </dl> + </section> + + + + + <!-- Methods --> + + <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Class Methods</h3> + + + <div id="method-c-access_roles" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">access_roles</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="access_roles-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 96</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">access_roles</span> + { + <span class="ruby-string">"Guest"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">GUEST</span>, + <span class="ruby-string">"Reporter"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">REPORTER</span>, + <span class="ruby-string">"Developer"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">DEVELOPER</span>, + <span class="ruby-string">"Master"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">MASTER</span> + } +<span class="ruby-keyword">end</span></pre> + </div><!-- access_roles-source --> + + </div> + + + + + </div><!-- access_roles-method --> + + + <div id="method-c-bulk_delete" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">bulk_delete</span><span + class="method-args">(project, user_ids)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="bulk_delete-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">bulk_delete</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">user_ids</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">where</span>(<span class="ruby-value">:user_id</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">user_ids</span>, <span class="ruby-value">:project_id</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">users_project</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">destroy</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- bulk_delete-source --> + + </div> + + + + + </div><!-- bulk_delete-method --> + + + <div id="method-c-bulk_import" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">bulk_import</span><span + class="method-args">(project, user_ids, project_access)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="bulk_import-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 70</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">bulk_import</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">user_ids</span>, <span class="ruby-identifier">project_access</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">user_ids</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">user_id</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">users_project</span> = <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">new</span>( + <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_access</span>, + <span class="ruby-identifier">user_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">user_id</span> + ) + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">project</span> = <span class="ruby-identifier">project</span> + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">save</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- bulk_import-source --> + + </div> + + + + + </div><!-- bulk_import-method --> + + + <div id="method-c-bulk_update" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">bulk_update</span><span + class="method-args">(project, user_ids, project_access)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="bulk_update-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 61</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">bulk_update</span>(<span class="ruby-identifier">project</span>, <span class="ruby-identifier">user_ids</span>, <span class="ruby-identifier">project_access</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">where</span>(<span class="ruby-value">:user_id</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">user_ids</span>, <span class="ruby-value">:project_id</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">project</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">users_project</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">project_access</span> = <span class="ruby-identifier">project_access</span> + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">save</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- bulk_update-source --> + + </div> + + + + + </div><!-- bulk_update-method --> + + + <div id="method-c-import_team" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">import_team</span><span + class="method-args">(source_project, target_project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="import_team-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 24</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">import_team</span>(<span class="ruby-identifier">source_project</span>, <span class="ruby-identifier">target_project</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">without_repository_callback</span> <span class="ruby-keyword">do</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">team</span> = <span class="ruby-identifier">source_project</span>.<span class="ruby-identifier">users_projects</span>.<span class="ruby-identifier">all</span> + + <span class="ruby-identifier">team</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">tm</span><span class="ruby-operator">|</span> + <span class="ruby-comment"># Skip if user already present in team</span> + <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">target_project</span>.<span class="ruby-identifier">users</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">tm</span>.<span class="ruby-identifier">user</span>) + + <span class="ruby-identifier">new_tm</span> = <span class="ruby-identifier">tm</span>.<span class="ruby-identifier">dup</span> + <span class="ruby-identifier">new_tm</span>.<span class="ruby-identifier">id</span> = <span class="ruby-keyword">nil</span> + <span class="ruby-identifier">new_tm</span>.<span class="ruby-identifier">project_id</span> = <span class="ruby-identifier">target_project</span>.<span class="ruby-identifier">id</span> + <span class="ruby-identifier">new_tm</span>.<span class="ruby-identifier">save</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">target_project</span>.<span class="ruby-identifier">update_repository</span> + <span class="ruby-keyword">true</span> +<span class="ruby-keyword">rescue</span> + <span class="ruby-keyword">false</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- import_team-source --> + + </div> + + + + + </div><!-- import_team-method --> + + + <div id="method-c-user_bulk_import" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">user_bulk_import</span><span + class="method-args">(user, project_ids, project_access)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="user_bulk_import-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 83</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">user_bulk_import</span>(<span class="ruby-identifier">user</span>, <span class="ruby-identifier">project_ids</span>, <span class="ruby-identifier">project_access</span>) + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">transaction</span> <span class="ruby-keyword">do</span> + <span class="ruby-identifier">project_ids</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">project_id</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">users_project</span> = <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">new</span>( + <span class="ruby-identifier">project_access</span><span class="ruby-operator">:</span> <span class="ruby-identifier">project_access</span>, + ) + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">project_id</span> = <span class="ruby-identifier">project_id</span> + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">user_id</span> = <span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span> + <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">save</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- user_bulk_import-source --> + + </div> + + + + + </div><!-- user_bulk_import-method --> + + + <div id="method-c-without_repository_callback" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">without_repository_callback</span><span + class="method-args">() { || ... }</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="without_repository_callback-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 47</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">without_repository_callback</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">skip_callback</span>(<span class="ruby-value">:destroy</span>, <span class="ruby-value">:after</span>, <span class="ruby-value">:update_repository</span>) + <span class="ruby-keyword">yield</span> + <span class="ruby-constant">UsersProject</span>.<span class="ruby-identifier">set_callback</span>(<span class="ruby-value">:destroy</span>, <span class="ruby-value">:after</span>, <span class="ruby-value">:update_repository</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- without_repository_callback-source --> + + </div> + + + + + </div><!-- without_repository_callback-method --> + + + </section><!-- public-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-project_access_human" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">project_access_human</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="project_access_human-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 114</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">project_access_human</span> + <span class="ruby-constant">Project</span>.<span class="ruby-identifier">access_options</span>.<span class="ruby-identifier">key</span>(<span class="ruby-keyword">self</span>.<span class="ruby-identifier">project_access</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- project_access_human-source --> + + </div> + + + + + </div><!-- project_access_human-method --> + + + <div id="method-i-repo_access_human" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">repo_access_human</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="repo_access_human-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 118</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">repo_access_human</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">access_roles</span>.<span class="ruby-identifier">invert</span>[<span class="ruby-keyword">self</span>.<span class="ruby-identifier">project_access</span>] +<span class="ruby-keyword">end</span></pre> + </div><!-- repo_access_human-source --> + + </div> + + + + + </div><!-- repo_access_human-method --> + + + <div id="method-i-role_access" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">role_access</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="role_access-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 106</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">role_access</span> + <span class="ruby-identifier">project_access</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- role_access-source --> + + </div> + + + + + </div><!-- role_access-method --> + + + <div id="method-i-update_repository" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">update_repository</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="update_repository-source"> + <pre><span class="ruby-comment"># File app/models/users_project.rb, line 110</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_repository</span> + <span class="ruby-identifier">git_host</span>.<span class="ruby-identifier">update_repository</span>(<span class="ruby-identifier">project</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- update_repository-source --> + + </div> + + + + + </div><!-- update_repository-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/UsersProjectObserver.html b/doc/app/UsersProjectObserver.html new file mode 100644 index 00000000000..7c7b90a09ca --- /dev/null +++ b/doc/app/UsersProjectObserver.html @@ -0,0 +1,558 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class UsersProjectObserver - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/observers/users_project_observer.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Observer + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-after_commit">#after_commit</a> + + <li><a href="#method-i-after_create">#after_create</a> + + <li><a href="#method-i-after_destroy">#after_destroy</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class UsersProjectObserver</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-after_commit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_commit</span><span + class="method-args">(users_project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_commit-source"> + <pre><span class="ruby-comment"># File app/observers/users_project_observer.rb, line 2</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_commit</span>(<span class="ruby-identifier">users_project</span>) + <span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">destroyed?</span> + <span class="ruby-constant">Notify</span>.<span class="ruby-identifier">project_access_granted_email</span>(<span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">id</span>).<span class="ruby-identifier">deliver</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- after_commit-source --> + + </div> + + + + + </div><!-- after_commit-method --> + + + <div id="method-i-after_create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_create</span><span + class="method-args">(users_project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_create-source"> + <pre><span class="ruby-comment"># File app/observers/users_project_observer.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_create</span>(<span class="ruby-identifier">users_project</span>) + <span class="ruby-constant">Event</span>.<span class="ruby-identifier">create</span>( + <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Joined</span>, + <span class="ruby-identifier">author_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span> + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_create-source --> + + </div> + + + + + </div><!-- after_create-method --> + + + <div id="method-i-after_destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">after_destroy</span><span + class="method-args">(users_project)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="after_destroy-source"> + <pre><span class="ruby-comment"># File app/observers/users_project_observer.rb, line 15</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">after_destroy</span>(<span class="ruby-identifier">users_project</span>) + <span class="ruby-constant">Event</span>.<span class="ruby-identifier">create</span>( + <span class="ruby-identifier">project_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">project</span>.<span class="ruby-identifier">id</span>, + <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-constant">Event</span><span class="ruby-operator">::</span><span class="ruby-constant">Left</span>, + <span class="ruby-identifier">author_id</span><span class="ruby-operator">:</span> <span class="ruby-identifier">users_project</span>.<span class="ruby-identifier">user</span>.<span class="ruby-identifier">id</span> + ) +<span class="ruby-keyword">end</span></pre> + </div><!-- after_destroy-source --> + + </div> + + + + + </div><!-- after_destroy-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Votes.html b/doc/app/Votes.html new file mode 100644 index 00000000000..9fa2a0b7f17 --- /dev/null +++ b/doc/app/Votes.html @@ -0,0 +1,615 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>module Votes - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="module"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/roles/votes.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-downvotes">#downvotes</a> + + <li><a href="#method-i-downvotes_in_percent">#downvotes_in_percent</a> + + <li><a href="#method-i-upvotes">#upvotes</a> + + <li><a href="#method-i-upvotes_in_percent">#upvotes_in_percent</a> + + <li><a href="#method-i-votes_count">#votes_count</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="module">module Votes</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-downvotes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">downvotes</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Return the number of -1 comments (downvotes)</p> + + + + <div class="method-source-code" id="downvotes-source"> + <pre><span class="ruby-comment"># File app/roles/votes.rb, line 16</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">downvotes</span> + <span class="ruby-identifier">notes</span>.<span class="ruby-identifier">select</span>(&<span class="ruby-value">:downvote?</span>).<span class="ruby-identifier">size</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- downvotes-source --> + + </div> + + + + + </div><!-- downvotes-method --> + + + <div id="method-i-downvotes_in_percent" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">downvotes_in_percent</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="downvotes_in_percent-source"> + <pre><span class="ruby-comment"># File app/roles/votes.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">downvotes_in_percent</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">votes_count</span>.<span class="ruby-identifier">zero?</span> + <span class="ruby-value">0</span> + <span class="ruby-keyword">else</span> + <span class="ruby-value">100.0</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">upvotes_in_percent</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- downvotes_in_percent-source --> + + </div> + + + + + </div><!-- downvotes_in_percent-method --> + + + <div id="method-i-upvotes" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">upvotes</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Return the number of +1 comments (upvotes)</p> + + + + <div class="method-source-code" id="upvotes-source"> + <pre><span class="ruby-comment"># File app/roles/votes.rb, line 3</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">upvotes</span> + <span class="ruby-identifier">notes</span>.<span class="ruby-identifier">select</span>(&<span class="ruby-value">:upvote?</span>).<span class="ruby-identifier">size</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- upvotes-source --> + + </div> + + + + + </div><!-- upvotes-method --> + + + <div id="method-i-upvotes_in_percent" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">upvotes_in_percent</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="upvotes_in_percent-source"> + <pre><span class="ruby-comment"># File app/roles/votes.rb, line 7</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">upvotes_in_percent</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">votes_count</span>.<span class="ruby-identifier">zero?</span> + <span class="ruby-value">0</span> + <span class="ruby-keyword">else</span> + <span class="ruby-value">100.0</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">votes_count</span> * <span class="ruby-identifier">upvotes</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- upvotes_in_percent-source --> + + </div> + + + + + </div><!-- upvotes_in_percent-method --> + + + <div id="method-i-votes_count" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">votes_count</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Return the total number of votes</p> + + + + <div class="method-source-code" id="votes_count-source"> + <pre><span class="ruby-comment"># File app/roles/votes.rb, line 29</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">votes_count</span> + <span class="ruby-identifier">upvotes</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">downvotes</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- votes_count-source --> + + </div> + + + + + </div><!-- votes_count-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/WebHook.html b/doc/app/WebHook.html new file mode 100644 index 00000000000..44a89adb8ad --- /dev/null +++ b/doc/app/WebHook.html @@ -0,0 +1,506 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class WebHook - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/web_hook.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + <!-- Included Modules --> +<nav id="includes-section" class="section"> + <h3 class="section-header">Included Modules</h3> + + <ul class="link-list"> + + + <li><span class="include">HTTParty</span> + + + </ul> +</nav> + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-execute">#execute</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class WebHook</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-execute" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">execute</span><span + class="method-args">(data)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="execute-source"> + <pre><span class="ruby-comment"># File app/models/web_hook.rb, line 12</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">execute</span>(<span class="ruby-identifier">data</span>) + <span class="ruby-identifier">parsed_url</span> = <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">url</span>) + <span class="ruby-keyword">if</span> <span class="ruby-identifier">parsed_url</span>.<span class="ruby-identifier">userinfo</span>.<span class="ruby-identifier">blank?</span> + <span class="ruby-constant">WebHook</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">url</span>, <span class="ruby-identifier">body</span><span class="ruby-operator">:</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_json</span>, <span class="ruby-identifier">headers</span><span class="ruby-operator">:</span> { <span class="ruby-string">"Content-Type"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"application/json"</span> }) + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">post_url</span> = <span class="ruby-identifier">url</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-node">"#{parsed_url.userinfo}@"</span>, <span class="ruby-string">""</span>) + <span class="ruby-constant">WebHook</span>.<span class="ruby-identifier">post</span>(<span class="ruby-identifier">post_url</span>, + <span class="ruby-identifier">body</span><span class="ruby-operator">:</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">to_json</span>, + <span class="ruby-identifier">headers</span><span class="ruby-operator">:</span> {<span class="ruby-string">"Content-Type"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"application/json"</span>}, + <span class="ruby-identifier">basic_auth</span><span class="ruby-operator">:</span> {<span class="ruby-identifier">username</span><span class="ruby-operator">:</span> <span class="ruby-identifier">parsed_url</span>.<span class="ruby-identifier">user</span>, <span class="ruby-identifier">password</span><span class="ruby-operator">:</span> <span class="ruby-identifier">parsed_url</span>.<span class="ruby-identifier">password</span>}) + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- execute-source --> + + </div> + + + + + </div><!-- execute-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/Wiki.html b/doc/app/Wiki.html new file mode 100644 index 00000000000..c2bf5b615b7 --- /dev/null +++ b/doc/app/Wiki.html @@ -0,0 +1,567 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class Wiki - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/models/wiki.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-c-regenerate_from">::regenerate_from</a> + + <li><a href="#method-i-set_slug">#set_slug</a> + + <li><a href="#method-i-to_param">#to_param</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class Wiki</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="protected-class-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Class Methods</h3> + + + <div id="method-c-regenerate_from" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">regenerate_from</span><span + class="method-args">(wiki)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="regenerate_from-source"> + <pre><span class="ruby-comment"># File app/models/wiki.rb, line 20</span> +<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">regenerate_from</span> <span class="ruby-identifier">wiki</span> + <span class="ruby-identifier">regenerated_field</span> = [<span class="ruby-value">:slug</span>, <span class="ruby-value">:content</span>, <span class="ruby-value">:title</span>] + + <span class="ruby-identifier">new_wiki</span> = <span class="ruby-constant">Wiki</span>.<span class="ruby-identifier">new</span> + <span class="ruby-identifier">regenerated_field</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">field</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">new_wiki</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">"#{field}="</span>, <span class="ruby-identifier">wiki</span>.<span class="ruby-identifier">send</span>(<span class="ruby-identifier">field</span>)) + <span class="ruby-keyword">end</span> + <span class="ruby-identifier">new_wiki</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- regenerate_from-source --> + + </div> + + + + + </div><!-- regenerate_from-method --> + + + </section><!-- protected-class-method-details --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-to_param" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">to_param</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="to_param-source"> + <pre><span class="ruby-comment"># File app/models/wiki.rb, line 14</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_param</span> + <span class="ruby-identifier">slug</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_param-source --> + + </div> + + + + + </div><!-- to_param-method --> + + + </section><!-- public-instance-method-details --> + + <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Protected Instance Methods</h3> + + + <div id="method-i-set_slug" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">set_slug</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="set_slug-source"> + <pre><span class="ruby-comment"># File app/models/wiki.rb, line 30</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">set_slug</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">slug</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">title</span>.<span class="ruby-identifier">parameterize</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- set_slug-source --> + + </div> + + + + + </div><!-- set_slug-method --> + + + </section><!-- protected-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/WikisController.html b/doc/app/WikisController.html new file mode 100644 index 00000000000..4a4e930cd5b --- /dev/null +++ b/doc/app/WikisController.html @@ -0,0 +1,676 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>class WikisController - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body id="top" class="class"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="file-metadata"> + <nav id="file-list-section" class="section"> + <h3 class="section-header">Defined In</h3> + <ul> + <li>app/controllers/wikis_controller.rb + </ul> +</nav> + + + </div> + + <div id="class-metadata"> + + <nav id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link"><a href="ProjectResourceController.html">ProjectResourceController</a> + +</nav> + + + <!-- Method Quickref --> +<nav id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + + <ul class="link-list"> + + <li><a href="#method-i-create">#create</a> + + <li><a href="#method-i-destroy">#destroy</a> + + <li><a href="#method-i-edit">#edit</a> + + <li><a href="#method-i-history">#history</a> + + <li><a href="#method-i-pages">#pages</a> + + <li><a href="#method-i-show">#show</a> + + </ul> +</nav> + + </div> + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation"> + <h1 class="class">class WikisController</h1> + + <div id="description" class="description"> + + </div><!-- description --> + + + + + <section id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="method-i-create" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">create</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="create-source"> + <pre><span class="ruby-comment"># File app/controllers/wikis_controller.rb, line 36</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">create</span> + <span class="ruby-ivar">@wiki</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:wiki</span>]) + <span class="ruby-ivar">@wiki</span>.<span class="ruby-identifier">user</span> = <span class="ruby-identifier">current_user</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@wiki</span>.<span class="ruby-identifier">save</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> [<span class="ruby-ivar">@project</span>, <span class="ruby-ivar">@wiki</span>], <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">'Wiki was successfully updated.'</span> } + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">render</span> <span class="ruby-identifier">action</span><span class="ruby-operator">:</span> <span class="ruby-string">"edit"</span> } + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- create-source --> + + </div> + + + + + </div><!-- create-method --> + + + <div id="method-i-destroy" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">destroy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="destroy-source"> + <pre><span class="ruby-comment"># File app/controllers/wikis_controller.rb, line 53</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span> + <span class="ruby-ivar">@wikis</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">slug</span><span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]).<span class="ruby-identifier">delete_all</span> + + <span class="ruby-identifier">respond_to</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">format</span>.<span class="ruby-identifier">html</span> { <span class="ruby-identifier">redirect_to</span> <span class="ruby-identifier">project_wiki_path</span>(<span class="ruby-ivar">@project</span>, <span class="ruby-value">:index</span>), <span class="ruby-identifier">notice</span><span class="ruby-operator">:</span> <span class="ruby-string">"Page was successfully deleted"</span> } + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- destroy-source --> + + </div> + + + + + </div><!-- destroy-method --> + + + <div id="method-i-edit" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">edit</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="edit-source"> + <pre><span class="ruby-comment"># File app/controllers/wikis_controller.rb, line 31</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">edit</span> + <span class="ruby-ivar">@wiki</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">slug</span><span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]).<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at"</span>).<span class="ruby-identifier">last</span> + <span class="ruby-ivar">@wiki</span> = <span class="ruby-constant">Wiki</span>.<span class="ruby-identifier">regenerate_from</span> <span class="ruby-ivar">@wiki</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- edit-source --> + + </div> + + + + + </div><!-- edit-method --> + + + <div id="method-i-history" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">history</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="history-source"> + <pre><span class="ruby-comment"># File app/controllers/wikis_controller.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">history</span> + <span class="ruby-ivar">@wikis</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">slug</span><span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]).<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- history-source --> + + </div> + + + + + </div><!-- history-method --> + + + <div id="method-i-pages" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">pages</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="pages-source"> + <pre><span class="ruby-comment"># File app/controllers/wikis_controller.rb, line 6</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">pages</span> + <span class="ruby-ivar">@wikis</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">group</span>(<span class="ruby-value">:slug</span>).<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at"</span>) +<span class="ruby-keyword">end</span></pre> + </div><!-- pages-source --> + + </div> + + + + + </div><!-- pages-method --> + + + <div id="method-i-show" class="method-detail "> + + <div class="method-heading"> + <span class="method-name">show</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + + + + + <div class="method-source-code" id="show-source"> + <pre><span class="ruby-comment"># File app/controllers/wikis_controller.rb, line 10</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">show</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:old_page_id</span>] + <span class="ruby-ivar">@wiki</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:old_page_id</span>]) + <span class="ruby-keyword">else</span> + <span class="ruby-ivar">@wiki</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">where</span>(<span class="ruby-identifier">slug</span><span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]).<span class="ruby-identifier">order</span>(<span class="ruby-string">"created_at"</span>).<span class="ruby-identifier">last</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-ivar">@note</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">notes</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">noteable</span><span class="ruby-operator">:</span> <span class="ruby-ivar">@wiki</span>) + + <span class="ruby-keyword">if</span> <span class="ruby-ivar">@wiki</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">'show'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-keyword">if</span> <span class="ruby-identifier">can?</span>(<span class="ruby-identifier">current_user</span>, <span class="ruby-value">:write_wiki</span>, <span class="ruby-ivar">@project</span>) + <span class="ruby-ivar">@wiki</span> = <span class="ruby-ivar">@project</span>.<span class="ruby-identifier">wikis</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">slug</span><span class="ruby-operator">:</span> <span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>]) + <span class="ruby-identifier">render</span> <span class="ruby-string">'edit'</span> + <span class="ruby-keyword">else</span> + <span class="ruby-identifier">render</span> <span class="ruby-string">'empty'</span> + <span class="ruby-keyword">end</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- show-source --> + + </div> + + + + + </div><!-- show-method --> + + + </section><!-- public-instance-method-details --> + + </section><!-- 5Buntitled-5D --> + +</div><!-- documentation --> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/created.rid b/doc/app/created.rid new file mode 100644 index 00000000000..972a7e6f5da --- /dev/null +++ b/doc/app/created.rid @@ -0,0 +1,135 @@ +Thu, 25 Oct 2012 11:45:21 +0300 +doc/README_FOR_APP Wed, 06 Jun 2012 13:56:49 +0300 +app/observers/issue_observer.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/observers/key_observer.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/observers/project_observer.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/observers/activity_observer.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/observers/user_observer.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/observers/merge_request_observer.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/observers/note_observer.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/observers/system_hook_observer.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/observers/users_project_observer.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/contexts/test_hook_context.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/contexts/commit_load_context.rb Mon, 22 Oct 2012 16:08:19 +0300 +app/contexts/notes/create_context.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/contexts/notes/load_context.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/contexts/search_context.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/contexts/issues_bulk_update_context.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/contexts/base_context.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/contexts/merge_requests_load_context.rb Mon, 22 Oct 2012 16:08:19 +0300 +app/contexts/issues_list_context.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/mailers/notify.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/roles/team.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/roles/push_event.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/roles/votes.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/roles/issue_commonality.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/roles/git_host.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/roles/authority.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/roles/push_observer.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/roles/account.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/roles/static_model.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/roles/repository.rb Wed, 24 Oct 2012 12:43:00 +0300 +app/workers/post_receive.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/workers/system_hook_worker.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/controllers/issues_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/labels_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/project_resource_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/dashboard_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/projects_controller.rb Tue, 23 Oct 2012 11:29:23 +0300 +app/controllers/repositories_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/milestones_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/hooks_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/blob_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/merge_requests_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/admin/logs_controller.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/controllers/admin/dashboard_controller.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/controllers/admin/projects_controller.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/controllers/admin/hooks_controller.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/controllers/admin/team_members_controller.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/controllers/admin/groups_controller.rb Wed, 24 Oct 2012 12:43:00 +0300 +app/controllers/admin/users_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/admin/resque_controller.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/controllers/blame_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/keys_controller.rb Wed, 26 Sep 2012 13:10:32 +0300 +app/controllers/admin_controller.rb Wed, 26 Sep 2012 13:10:32 +0300 +app/controllers/errors_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/help_controller.rb Wed, 06 Jun 2012 13:56:49 +0300 +app/controllers/profile_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/commits_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/team_members_controller.rb Wed, 24 Oct 2012 16:14:03 +0300 +app/controllers/omniauth_callbacks_controller.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/controllers/protected_branches_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/snippets_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/groups_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/compare_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/wikis_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/search_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/deploy_keys_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/tree_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/commit_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/refs_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/controllers/application_controller.rb Wed, 24 Oct 2012 14:17:22 +0300 +app/controllers/notes_controller.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/uploaders/attachment_uploader.rb Wed, 22 Aug 2012 14:52:27 +0300 +app/models/tree.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/project.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/issue.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/project_hook.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/group.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/key.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/snippet.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/user.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/note.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/wiki.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/users_project.rb Wed, 24 Oct 2012 16:14:03 +0300 +app/models/web_hook.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/ability.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/milestone.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/commit.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/protected_branch.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/merge_request.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/event.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/models/system_hook.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/decorators/commit_decorator.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/decorators/event_decorator.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/decorators/application_decorator.rb Fri, 21 Sep 2012 15:40:04 +0300 +app/decorators/tree_decorator.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/tags_helper.rb Wed, 06 Jun 2012 13:56:49 +0300 +app/helpers/application_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/gitlab_markdown_helper.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/helpers/notes_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/profile_helper.rb Fri, 21 Sep 2012 15:47:07 +0300 +app/helpers/tree_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/commits_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/projects_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/events_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/issues_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/tab_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +app/helpers/snippets_helper.rb Wed, 06 Jun 2012 13:56:49 +0300 +app/helpers/merge_requests_helper.rb Mon, 22 Oct 2012 16:08:18 +0300 +lib/file_size_validator.rb Wed, 22 Aug 2012 14:52:27 +0300 +lib/api.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/gitlab/encode.rb Wed, 22 Aug 2012 14:52:27 +0300 +lib/gitlab/graph_commit.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/gitlab/theme.rb Tue, 26 Jun 2012 16:08:37 +0300 +lib/gitlab/app_logger.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/gitlab/inline_diff.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/gitlab/merge.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/gitlab/backend/gitolite.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/gitlab/backend/grack_auth.rb Mon, 22 Oct 2012 19:02:02 +0300 +lib/gitlab/backend/gitolite_config.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/gitlab/git_logger.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/gitlab/markdown.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/gitlab/file_editor.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/gitlab/logger.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/gitlab/satellite.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/gitlab/auth.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/extracts_path.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/api/issues.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/api/projects.rb Mon, 22 Oct 2012 16:08:18 +0300 +lib/api/helpers.rb Mon, 22 Oct 2012 16:08:18 +0300 +lib/api/entities.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/api/session.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/api/users.rb Mon, 22 Oct 2012 16:08:19 +0300 +lib/api/milestones.rb Fri, 21 Sep 2012 15:47:07 +0300 +lib/redcarpet/render/gitlab_html.rb Wed, 22 Aug 2012 14:52:27 +0300 diff --git a/doc/app/doc/README_FOR_APP.html b/doc/app/doc/README_FOR_APP.html new file mode 100644 index 00000000000..9456512ebf3 --- /dev/null +++ b/doc/app/doc/README_FOR_APP.html @@ -0,0 +1,399 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>README_FOR_APP - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "../"; +</script> + +<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script> + + +<body class="file"> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="../index.html">Home</a> + <a href="../table_of_contents.html#classes">Classes</a> + <a href="../table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="../Gitlab.html">Gitlab</a> + + <li><a href="../Gitlab/API.html">Gitlab::API</a> + + <li><a href="../Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="../Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="../Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="../Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="../Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="../Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="../Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="../Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="../Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="../Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="../Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="../Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="../Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="../Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="../Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="../Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="../Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="../Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="../Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="../Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="../Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="../Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="../Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="../Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="../Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="../Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="../Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="../Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="../Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="../Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="../Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="../Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="../Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="../Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="../Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="../Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="../Admin.html">Admin</a> + + <li><a href="../Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="../Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="../Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="../Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="../Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="../Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="../Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="../Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="../Notes.html">Notes</a> + + <li><a href="../Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="../Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="../Redcarpet.html">Redcarpet</a> + + <li><a href="../Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="../Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="../ExtractsPath.html">ExtractsPath</a> + + <li><a href="../ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="../FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="../FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="../Grack.html">Grack</a> + + <li><a href="../Grack/Auth.html">Grack::Auth</a> + + <li><a href="../IssueCommonality.html">IssueCommonality</a> + + <li><a href="../IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="../StaticModel.html">StaticModel</a> + + <li><a href="../StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="../Ability.html">Ability</a> + + <li><a href="../Account.html">Account</a> + + <li><a href="../ActivityObserver.html">ActivityObserver</a> + + <li><a href="../AdminController.html">AdminController</a> + + <li><a href="../ApplicationController.html">ApplicationController</a> + + <li><a href="../ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="../ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="../AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="../Authority.html">Authority</a> + + <li><a href="../BaseContext.html">BaseContext</a> + + <li><a href="../BlameController.html">BlameController</a> + + <li><a href="../BlobController.html">BlobController</a> + + <li><a href="../Commit.html">Commit</a> + + <li><a href="../CommitController.html">CommitController</a> + + <li><a href="../CommitDecorator.html">CommitDecorator</a> + + <li><a href="../CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="../CommitsController.html">CommitsController</a> + + <li><a href="../CommitsHelper.html">CommitsHelper</a> + + <li><a href="../CompareController.html">CompareController</a> + + <li><a href="../DashboardController.html">DashboardController</a> + + <li><a href="../DeployKeysController.html">DeployKeysController</a> + + <li><a href="../ErrorsController.html">ErrorsController</a> + + <li><a href="../Event.html">Event</a> + + <li><a href="../EventDecorator.html">EventDecorator</a> + + <li><a href="../EventsHelper.html">EventsHelper</a> + + <li><a href="../GitHost.html">GitHost</a> + + <li><a href="../GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="../Group.html">Group</a> + + <li><a href="../GroupsController.html">GroupsController</a> + + <li><a href="../HelpController.html">HelpController</a> + + <li><a href="../HooksController.html">HooksController</a> + + <li><a href="../Issue.html">Issue</a> + + <li><a href="../IssueObserver.html">IssueObserver</a> + + <li><a href="../IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="../IssuesController.html">IssuesController</a> + + <li><a href="../IssuesHelper.html">IssuesHelper</a> + + <li><a href="../IssuesListContext.html">IssuesListContext</a> + + <li><a href="../Key.html">Key</a> + + <li><a href="../KeyObserver.html">KeyObserver</a> + + <li><a href="../KeysController.html">KeysController</a> + + <li><a href="../LabelsController.html">LabelsController</a> + + <li><a href="../MergeRequest.html">MergeRequest</a> + + <li><a href="../MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="../MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="../MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="../MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="../Milestone.html">Milestone</a> + + <li><a href="../MilestonesController.html">MilestonesController</a> + + <li><a href="../Note.html">Note</a> + + <li><a href="../NoteObserver.html">NoteObserver</a> + + <li><a href="../NotesController.html">NotesController</a> + + <li><a href="../NotesHelper.html">NotesHelper</a> + + <li><a href="../Notify.html">Notify</a> + + <li><a href="../OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="../PostReceive.html">PostReceive</a> + + <li><a href="../ProfileController.html">ProfileController</a> + + <li><a href="../ProfileHelper.html">ProfileHelper</a> + + <li><a href="../Project.html">Project</a> + + <li><a href="../ProjectHook.html">ProjectHook</a> + + <li><a href="../ProjectObserver.html">ProjectObserver</a> + + <li><a href="../ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="../ProjectsController.html">ProjectsController</a> + + <li><a href="../ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="../ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="../ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="../PushEvent.html">PushEvent</a> + + <li><a href="../PushObserver.html">PushObserver</a> + + <li><a href="../RefsController.html">RefsController</a> + + <li><a href="../RepositoriesController.html">RepositoriesController</a> + + <li><a href="../Repository.html">Repository</a> + + <li><a href="../SearchContext.html">SearchContext</a> + + <li><a href="../SearchController.html">SearchController</a> + + <li><a href="../Snippet.html">Snippet</a> + + <li><a href="../SnippetsController.html">SnippetsController</a> + + <li><a href="../SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="../SystemHook.html">SystemHook</a> + + <li><a href="../SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="../SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="../TabHelper.html">TabHelper</a> + + <li><a href="../TagsHelper.html">TagsHelper</a> + + <li><a href="../Team.html">Team</a> + + <li><a href="../TeamMembersController.html">TeamMembersController</a> + + <li><a href="../TestHookContext.html">TestHookContext</a> + + <li><a href="../Tree.html">Tree</a> + + <li><a href="../TreeController.html">TreeController</a> + + <li><a href="../TreeDecorator.html">TreeDecorator</a> + + <li><a href="../TreeHelper.html">TreeHelper</a> + + <li><a href="../User.html">User</a> + + <li><a href="../UserObserver.html">UserObserver</a> + + <li><a href="../UsersProject.html">UsersProject</a> + + <li><a href="../UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="../Votes.html">Votes</a> + + <li><a href="../WebHook.html">WebHook</a> + + <li><a href="../Wiki.html">Wiki</a> + + <li><a href="../WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<div id="documentation" class="description"> + +<p>Use this README file to introduce your application and point to useful +places in the API for learning more. Run “rake doc:app” to generate API +documentation for your models, controllers, helpers, and libraries.</p> + +</div> + + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/images/add.png b/doc/app/images/add.png Binary files differnew file mode 100755 index 00000000000..6332fefea4b --- /dev/null +++ b/doc/app/images/add.png diff --git a/doc/app/images/brick.png b/doc/app/images/brick.png Binary files differnew file mode 100644 index 00000000000..7851cf34c94 --- /dev/null +++ b/doc/app/images/brick.png diff --git a/doc/app/images/brick_link.png b/doc/app/images/brick_link.png Binary files differnew file mode 100644 index 00000000000..9ebf013a23a --- /dev/null +++ b/doc/app/images/brick_link.png diff --git a/doc/app/images/bug.png b/doc/app/images/bug.png Binary files differnew file mode 100644 index 00000000000..2d5fb90ec6e --- /dev/null +++ b/doc/app/images/bug.png diff --git a/doc/app/images/bullet_black.png b/doc/app/images/bullet_black.png Binary files differnew file mode 100644 index 00000000000..57619706d10 --- /dev/null +++ b/doc/app/images/bullet_black.png diff --git a/doc/app/images/bullet_toggle_minus.png b/doc/app/images/bullet_toggle_minus.png Binary files differnew file mode 100644 index 00000000000..b47ce55f685 --- /dev/null +++ b/doc/app/images/bullet_toggle_minus.png diff --git a/doc/app/images/bullet_toggle_plus.png b/doc/app/images/bullet_toggle_plus.png Binary files differnew file mode 100644 index 00000000000..9ab4a89664e --- /dev/null +++ b/doc/app/images/bullet_toggle_plus.png diff --git a/doc/app/images/date.png b/doc/app/images/date.png Binary files differnew file mode 100644 index 00000000000..783c83357fd --- /dev/null +++ b/doc/app/images/date.png diff --git a/doc/app/images/delete.png b/doc/app/images/delete.png Binary files differnew file mode 100755 index 00000000000..08f249365af --- /dev/null +++ b/doc/app/images/delete.png diff --git a/doc/app/images/find.png b/doc/app/images/find.png Binary files differnew file mode 100644 index 00000000000..15474796467 --- /dev/null +++ b/doc/app/images/find.png diff --git a/doc/app/images/loadingAnimation.gif b/doc/app/images/loadingAnimation.gif Binary files differnew file mode 100644 index 00000000000..82290f48334 --- /dev/null +++ b/doc/app/images/loadingAnimation.gif diff --git a/doc/app/images/macFFBgHack.png b/doc/app/images/macFFBgHack.png Binary files differnew file mode 100644 index 00000000000..c6473b324ee --- /dev/null +++ b/doc/app/images/macFFBgHack.png diff --git a/doc/app/images/package.png b/doc/app/images/package.png Binary files differnew file mode 100644 index 00000000000..da3c2a2d74b --- /dev/null +++ b/doc/app/images/package.png diff --git a/doc/app/images/page_green.png b/doc/app/images/page_green.png Binary files differnew file mode 100644 index 00000000000..de8e003f9fb --- /dev/null +++ b/doc/app/images/page_green.png diff --git a/doc/app/images/page_white_text.png b/doc/app/images/page_white_text.png Binary files differnew file mode 100644 index 00000000000..813f712f726 --- /dev/null +++ b/doc/app/images/page_white_text.png diff --git a/doc/app/images/page_white_width.png b/doc/app/images/page_white_width.png Binary files differnew file mode 100644 index 00000000000..1eb880947dd --- /dev/null +++ b/doc/app/images/page_white_width.png diff --git a/doc/app/images/plugin.png b/doc/app/images/plugin.png Binary files differnew file mode 100644 index 00000000000..6187b15aec0 --- /dev/null +++ b/doc/app/images/plugin.png diff --git a/doc/app/images/ruby.png b/doc/app/images/ruby.png Binary files differnew file mode 100644 index 00000000000..f763a168807 --- /dev/null +++ b/doc/app/images/ruby.png diff --git a/doc/app/images/tag_blue.png b/doc/app/images/tag_blue.png Binary files differnew file mode 100755 index 00000000000..3f02b5f8f8b --- /dev/null +++ b/doc/app/images/tag_blue.png diff --git a/doc/app/images/tag_green.png b/doc/app/images/tag_green.png Binary files differnew file mode 100644 index 00000000000..83ec984bd73 --- /dev/null +++ b/doc/app/images/tag_green.png diff --git a/doc/app/images/transparent.png b/doc/app/images/transparent.png Binary files differnew file mode 100644 index 00000000000..d665e179efd --- /dev/null +++ b/doc/app/images/transparent.png diff --git a/doc/app/images/wrench.png b/doc/app/images/wrench.png Binary files differnew file mode 100644 index 00000000000..5c8213fef5a --- /dev/null +++ b/doc/app/images/wrench.png diff --git a/doc/app/images/wrench_orange.png b/doc/app/images/wrench_orange.png Binary files differnew file mode 100644 index 00000000000..565a9330e0a --- /dev/null +++ b/doc/app/images/wrench_orange.png diff --git a/doc/app/images/zoom.png b/doc/app/images/zoom.png Binary files differnew file mode 100644 index 00000000000..908612e3945 --- /dev/null +++ b/doc/app/images/zoom.png diff --git a/doc/app/index.html b/doc/app/index.html new file mode 100644 index 00000000000..a46b4fbc03d --- /dev/null +++ b/doc/app/index.html @@ -0,0 +1,392 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body> +<nav id="metadata"> + <nav id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./table_of_contents.html#classes">Classes</a> + <a href="./table_of_contents.html#methods">Methods</a> + </h3> +</nav> + + + <nav id="search-section" class="section project-section" class="initially-hidden"> + <form action="#" method="get" accept-charset="utf-8"> + <h3 class="section-header"> + <input type="text" name="search" placeholder="Search" id="search-field" + title="Type to search, Up and Down to navigate, Enter to load"> + </h3> + </form> + + <ul id="search-results" class="initially-hidden"></ul> +</nav> + + + <div id="project-metadata"> + <nav id="fileindex-section" class="section project-section"> + <h3 class="section-header">Pages</h3> + + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a> + + </ul> +</nav> + + <nav id="classindex-section" class="section project-section"> + <h3 class="section-header">Class and Module Index</h3> + + <ul class="link-list"> + + <li><a href="./Gitlab.html">Gitlab</a> + + <li><a href="./Gitlab/API.html">Gitlab::API</a> + + <li><a href="./Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + + <li><a href="./Gitlab/AppLogger.html">Gitlab::AppLogger</a> + + <li><a href="./Gitlab/Auth.html">Gitlab::Auth</a> + + <li><a href="./Gitlab/Encode.html">Gitlab::Encode</a> + + <li><a href="./Gitlab/Entities.html">Gitlab::Entities</a> + + <li><a href="./Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + + <li><a href="./Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + + <li><a href="./Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + + <li><a href="./Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + + <li><a href="./Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + + <li><a href="./Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + + <li><a href="./Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + + <li><a href="./Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + + <li><a href="./Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + + <li><a href="./Gitlab/Entities/User.html">Gitlab::Entities::User</a> + + <li><a href="./Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + + <li><a href="./Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + + <li><a href="./Gitlab/FileEditor.html">Gitlab::FileEditor</a> + + <li><a href="./Gitlab/GitLogger.html">Gitlab::GitLogger</a> + + <li><a href="./Gitlab/Gitolite.html">Gitlab::Gitolite</a> + + <li><a href="./Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + + <li><a href="./Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + + <li><a href="./Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + + <li><a href="./Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + + <li><a href="./Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + + <li><a href="./Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + + <li><a href="./Gitlab/Issues.html">Gitlab::Issues</a> + + <li><a href="./Gitlab/Logger.html">Gitlab::Logger</a> + + <li><a href="./Gitlab/Markdown.html">Gitlab::Markdown</a> + + <li><a href="./Gitlab/Merge.html">Gitlab::Merge</a> + + <li><a href="./Gitlab/Milestones.html">Gitlab::Milestones</a> + + <li><a href="./Gitlab/Projects.html">Gitlab::Projects</a> + + <li><a href="./Gitlab/Satellite.html">Gitlab::Satellite</a> + + <li><a href="./Gitlab/Session.html">Gitlab::Session</a> + + <li><a href="./Gitlab/Theme.html">Gitlab::Theme</a> + + <li><a href="./Gitlab/Users.html">Gitlab::Users</a> + + <li><a href="./Admin.html">Admin</a> + + <li><a href="./Admin/DashboardController.html">Admin::DashboardController</a> + + <li><a href="./Admin/GroupsController.html">Admin::GroupsController</a> + + <li><a href="./Admin/HooksController.html">Admin::HooksController</a> + + <li><a href="./Admin/LogsController.html">Admin::LogsController</a> + + <li><a href="./Admin/ProjectsController.html">Admin::ProjectsController</a> + + <li><a href="./Admin/ResqueController.html">Admin::ResqueController</a> + + <li><a href="./Admin/TeamMembersController.html">Admin::TeamMembersController</a> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a> + + <li><a href="./Notes.html">Notes</a> + + <li><a href="./Notes/CreateContext.html">Notes::CreateContext</a> + + <li><a href="./Notes/LoadContext.html">Notes::LoadContext</a> + + <li><a href="./Redcarpet.html">Redcarpet</a> + + <li><a href="./Redcarpet/Render.html">Redcarpet::Render</a> + + <li><a href="./Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + + <li><a href="./ExtractsPath.html">ExtractsPath</a> + + <li><a href="./ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + + <li><a href="./FileSizeValidator.html">FileSizeValidator</a> + + <li><a href="./FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + + <li><a href="./Grack.html">Grack</a> + + <li><a href="./Grack/Auth.html">Grack::Auth</a> + + <li><a href="./IssueCommonality.html">IssueCommonality</a> + + <li><a href="./IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + + <li><a href="./StaticModel.html">StaticModel</a> + + <li><a href="./StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + + <li><a href="./Ability.html">Ability</a> + + <li><a href="./Account.html">Account</a> + + <li><a href="./ActivityObserver.html">ActivityObserver</a> + + <li><a href="./AdminController.html">AdminController</a> + + <li><a href="./ApplicationController.html">ApplicationController</a> + + <li><a href="./ApplicationDecorator.html">ApplicationDecorator</a> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a> + + <li><a href="./AttachmentUploader.html">AttachmentUploader</a> + + <li><a href="./Authority.html">Authority</a> + + <li><a href="./BaseContext.html">BaseContext</a> + + <li><a href="./BlameController.html">BlameController</a> + + <li><a href="./BlobController.html">BlobController</a> + + <li><a href="./Commit.html">Commit</a> + + <li><a href="./CommitController.html">CommitController</a> + + <li><a href="./CommitDecorator.html">CommitDecorator</a> + + <li><a href="./CommitLoadContext.html">CommitLoadContext</a> + + <li><a href="./CommitsController.html">CommitsController</a> + + <li><a href="./CommitsHelper.html">CommitsHelper</a> + + <li><a href="./CompareController.html">CompareController</a> + + <li><a href="./DashboardController.html">DashboardController</a> + + <li><a href="./DeployKeysController.html">DeployKeysController</a> + + <li><a href="./ErrorsController.html">ErrorsController</a> + + <li><a href="./Event.html">Event</a> + + <li><a href="./EventDecorator.html">EventDecorator</a> + + <li><a href="./EventsHelper.html">EventsHelper</a> + + <li><a href="./GitHost.html">GitHost</a> + + <li><a href="./GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + + <li><a href="./Group.html">Group</a> + + <li><a href="./GroupsController.html">GroupsController</a> + + <li><a href="./HelpController.html">HelpController</a> + + <li><a href="./HooksController.html">HooksController</a> + + <li><a href="./Issue.html">Issue</a> + + <li><a href="./IssueObserver.html">IssueObserver</a> + + <li><a href="./IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + + <li><a href="./IssuesController.html">IssuesController</a> + + <li><a href="./IssuesHelper.html">IssuesHelper</a> + + <li><a href="./IssuesListContext.html">IssuesListContext</a> + + <li><a href="./Key.html">Key</a> + + <li><a href="./KeyObserver.html">KeyObserver</a> + + <li><a href="./KeysController.html">KeysController</a> + + <li><a href="./LabelsController.html">LabelsController</a> + + <li><a href="./MergeRequest.html">MergeRequest</a> + + <li><a href="./MergeRequestObserver.html">MergeRequestObserver</a> + + <li><a href="./MergeRequestsController.html">MergeRequestsController</a> + + <li><a href="./MergeRequestsHelper.html">MergeRequestsHelper</a> + + <li><a href="./MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + + <li><a href="./Milestone.html">Milestone</a> + + <li><a href="./MilestonesController.html">MilestonesController</a> + + <li><a href="./Note.html">Note</a> + + <li><a href="./NoteObserver.html">NoteObserver</a> + + <li><a href="./NotesController.html">NotesController</a> + + <li><a href="./NotesHelper.html">NotesHelper</a> + + <li><a href="./Notify.html">Notify</a> + + <li><a href="./OmniauthCallbacksController.html">OmniauthCallbacksController</a> + + <li><a href="./PostReceive.html">PostReceive</a> + + <li><a href="./ProfileController.html">ProfileController</a> + + <li><a href="./ProfileHelper.html">ProfileHelper</a> + + <li><a href="./Project.html">Project</a> + + <li><a href="./ProjectHook.html">ProjectHook</a> + + <li><a href="./ProjectObserver.html">ProjectObserver</a> + + <li><a href="./ProjectResourceController.html">ProjectResourceController</a> + + <li><a href="./ProjectsController.html">ProjectsController</a> + + <li><a href="./ProjectsHelper.html">ProjectsHelper</a> + + <li><a href="./ProtectedBranch.html">ProtectedBranch</a> + + <li><a href="./ProtectedBranchesController.html">ProtectedBranchesController</a> + + <li><a href="./PushEvent.html">PushEvent</a> + + <li><a href="./PushObserver.html">PushObserver</a> + + <li><a href="./RefsController.html">RefsController</a> + + <li><a href="./RepositoriesController.html">RepositoriesController</a> + + <li><a href="./Repository.html">Repository</a> + + <li><a href="./SearchContext.html">SearchContext</a> + + <li><a href="./SearchController.html">SearchController</a> + + <li><a href="./Snippet.html">Snippet</a> + + <li><a href="./SnippetsController.html">SnippetsController</a> + + <li><a href="./SnippetsHelper.html">SnippetsHelper</a> + + <li><a href="./SystemHook.html">SystemHook</a> + + <li><a href="./SystemHookObserver.html">SystemHookObserver</a> + + <li><a href="./SystemHookWorker.html">SystemHookWorker</a> + + <li><a href="./TabHelper.html">TabHelper</a> + + <li><a href="./TagsHelper.html">TagsHelper</a> + + <li><a href="./Team.html">Team</a> + + <li><a href="./TeamMembersController.html">TeamMembersController</a> + + <li><a href="./TestHookContext.html">TestHookContext</a> + + <li><a href="./Tree.html">Tree</a> + + <li><a href="./TreeController.html">TreeController</a> + + <li><a href="./TreeDecorator.html">TreeDecorator</a> + + <li><a href="./TreeHelper.html">TreeHelper</a> + + <li><a href="./User.html">User</a> + + <li><a href="./UserObserver.html">UserObserver</a> + + <li><a href="./UsersProject.html">UsersProject</a> + + <li><a href="./UsersProjectObserver.html">UsersProjectObserver</a> + + <li><a href="./Votes.html">Votes</a> + + <li><a href="./WebHook.html">WebHook</a> + + <li><a href="./Wiki.html">Wiki</a> + + <li><a href="./WikisController.html">WikisController</a> + + </ul> +</nav> + + </div> +</nav> + +<p>This is the API documentation for Rails Application Documentation. + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + diff --git a/doc/app/js/darkfish.js b/doc/app/js/darkfish.js new file mode 100644 index 00000000000..4be722fac38 --- /dev/null +++ b/doc/app/js/darkfish.js @@ -0,0 +1,153 @@ +/** + * + * Darkfish Page Functions + * $Id: darkfish.js 53 2009-01-07 02:52:03Z deveiant $ + * + * Author: Michael Granger <mgranger@laika.com> + * + */ + +/* Provide console simulation for firebug-less environments */ +if (!("console" in window) || !("firebug" in console)) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", + "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"]; + + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +}; + + +/** + * Unwrap the first element that matches the given @expr@ from the targets and return them. + */ +$.fn.unwrap = function( expr ) { + return this.each( function() { + $(this).parents( expr ).eq( 0 ).after( this ).remove(); + }); +}; + + +function showSource( e ) { + var target = e.target; + var codeSections = $(target). + parents('.method-detail'). + find('.method-source-code'); + + $(target). + parents('.method-detail'). + find('.method-source-code'). + slideToggle(); +}; + +function hookSourceViews() { + $('.method-heading').click( showSource ); +}; + +function toggleDebuggingSection() { + $('.debugging-section').slideToggle(); +}; + +function hookDebuggingToggle() { + $('#debugging-toggle img').click( toggleDebuggingSection ); +}; + +function hookTableOfContentsToggle() { + $('.indexpage li .toc-toggle').each( function() { + $(this).click( function() { + $(this).toggleClass('open'); + }); + + var section = $(this).next(); + + $(this).click( function() { + section.slideToggle(); + }); + }); +} + +function hookSearch() { + var input = $('#search-field').eq(0); + var result = $('#search-results').eq(0); + $(result).show(); + + var search_section = $('#search-section').get(0); + $(search_section).show(); + + var search = new Search(search_data, input, result); + + search.renderItem = function(result) { + var li = document.createElement('li'); + var html = ''; + + // TODO add relative path to <script> per-page + html += '<p class="search-match"><a href="' + rdoc_rel_prefix + result.path + '">' + this.hlt(result.title); + if (result.params) + html += '<span class="params">' + result.params + '</span>'; + html += '</a>'; + + + if (result.namespace) + html += '<p class="search-namespace">' + this.hlt(result.namespace); + + if (result.snippet) + html += '<div class="search-snippet">' + result.snippet + '</div>'; + + li.innerHTML = html; + + return li; + } + + search.select = function(result) { + var result_element = result.get(0); + window.location.href = result_element.firstChild.firstChild.href; + } + + search.scrollIntoView = search.scrollInWindow; +}; + +function highlightTarget( anchor ) { + console.debug( "Highlighting target '%s'.", anchor ); + + $("a[name=" + anchor + "]").each( function() { + if ( !$(this).parent().parent().hasClass('target-section') ) { + console.debug( "Wrapping the target-section" ); + $('div.method-detail').unwrap( 'div.target-section' ); + $(this).parent().wrap( '<div class="target-section"></div>' ); + } else { + console.debug( "Already wrapped." ); + } + }); +}; + +function highlightLocationTarget() { + console.debug( "Location hash: %s", window.location.hash ); + if ( ! window.location.hash || window.location.hash.length == 0 ) return; + + var anchor = window.location.hash.substring(1); + console.debug( "Found anchor: %s; matching %s", anchor, "a[name=" + anchor + "]" ); + + highlightTarget( anchor ); +}; + +function highlightClickTarget( event ) { + console.debug( "Highlighting click target for event %o", event.target ); + try { + var anchor = $(event.target).attr( 'href' ).substring(1); + console.debug( "Found target anchor: %s", anchor ); + highlightTarget( anchor ); + } catch ( err ) { + console.error( "Exception while highlighting: %o", err ); + }; +}; + + +$(document).ready( function() { + hookSourceViews(); + hookDebuggingToggle(); + hookSearch(); + highlightLocationTarget(); + hookTableOfContentsToggle(); + + $('ul.link-list a').bind( "click", highlightClickTarget ); +}); diff --git a/doc/app/js/jquery.js b/doc/app/js/jquery.js new file mode 100644 index 00000000000..48590ecb96a --- /dev/null +++ b/doc/app/js/jquery.js @@ -0,0 +1,18 @@ +/*! + * jQuery JavaScript Library v1.6.2 + * http://jquery.com/ + * + * Copyright 2011, John Resig + * Dual licensed under the MIT or GPL Version 2 licenses. + * http://jquery.org/license + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * Copyright 2011, The Dojo Foundation + * Released under the MIT, BSD, and GPL Licenses. + * + * Date: Thu Jun 30 14:16:56 2011 -0400 + */ +(function(a,b){function cv(a){return f.isWindow(a)?a:a.nodeType===9?a.defaultView||a.parentWindow:!1}function cs(a){if(!cg[a]){var b=c.body,d=f("<"+a+">").appendTo(b),e=d.css("display");d.remove();if(e==="none"||e===""){ch||(ch=c.createElement("iframe"),ch.frameBorder=ch.width=ch.height=0),b.appendChild(ch);if(!ci||!ch.createElement)ci=(ch.contentWindow||ch.contentDocument).document,ci.write((c.compatMode==="CSS1Compat"?"<!doctype html>":"")+"<html><body>"),ci.close();d=ci.createElement(a),ci.body.appendChild(d),e=f.css(d,"display"),b.removeChild(ch)}cg[a]=e}return cg[a]}function cr(a,b){var c={};f.each(cm.concat.apply([],cm.slice(0,b)),function(){c[this]=a});return c}function cq(){cn=b}function cp(){setTimeout(cq,0);return cn=f.now()}function cf(){try{return new a.ActiveXObject("Microsoft.XMLHTTP")}catch(b){}}function ce(){try{return new a.XMLHttpRequest}catch(b){}}function b$(a,c){a.dataFilter&&(c=a.dataFilter(c,a.dataType));var d=a.dataTypes,e={},g,h,i=d.length,j,k=d[0],l,m,n,o,p;for(g=1;g<i;g++){if(g===1)for(h in a.converters)typeof h=="string"&&(e[h.toLowerCase()]=a.converters[h]);l=k,k=d[g];if(k==="*")k=l;else if(l!=="*"&&l!==k){m=l+" "+k,n=e[m]||e["* "+k];if(!n){p=b;for(o in e){j=o.split(" ");if(j[0]===l||j[0]==="*"){p=e[j[1]+" "+k];if(p){o=e[o],o===!0?n=p:p===!0&&(n=o);break}}}}!n&&!p&&f.error("No conversion from "+m.replace(" "," to ")),n!==!0&&(c=n?n(c):p(o(c)))}}return c}function bZ(a,c,d){var e=a.contents,f=a.dataTypes,g=a.responseFields,h,i,j,k;for(i in g)i in d&&(c[g[i]]=d[i]);while(f[0]==="*")f.shift(),h===b&&(h=a.mimeType||c.getResponseHeader("content-type"));if(h)for(i in e)if(e[i]&&e[i].test(h)){f.unshift(i);break}if(f[0]in d)j=f[0];else{for(i in d){if(!f[0]||a.converters[i+" "+f[0]]){j=i;break}k||(k=i)}j=j||k}if(j){j!==f[0]&&f.unshift(j);return d[j]}}function bY(a,b,c,d){if(f.isArray(b))f.each(b,function(b,e){c||bC.test(a)?d(a,e):bY(a+"["+(typeof e=="object"||f.isArray(e)?b:"")+"]",e,c,d)});else if(!c&&b!=null&&typeof b=="object")for(var e in b)bY(a+"["+e+"]",b[e],c,d);else d(a,b)}function bX(a,c,d,e,f,g){f=f||c.dataTypes[0],g=g||{},g[f]=!0;var h=a[f],i=0,j=h?h.length:0,k=a===bR,l;for(;i<j&&(k||!l);i++)l=h[i](c,d,e),typeof l=="string"&&(!k||g[l]?l=b:(c.dataTypes.unshift(l),l=bX(a,c,d,e,l,g)));(k||!l)&&!g["*"]&&(l=bX(a,c,d,e,"*",g));return l}function bW(a){return function(b,c){typeof b!="string"&&(c=b,b="*");if(f.isFunction(c)){var d=b.toLowerCase().split(bN),e=0,g=d.length,h,i,j;for(;e<g;e++)h=d[e],j=/^\+/.test(h),j&&(h=h.substr(1)||"*"),i=a[h]=a[h]||[],i[j?"unshift":"push"](c)}}}function bA(a,b,c){var d=b==="width"?a.offsetWidth:a.offsetHeight,e=b==="width"?bv:bw;if(d>0){c!=="border"&&f.each(e,function(){c||(d-=parseFloat(f.css(a,"padding"+this))||0),c==="margin"?d+=parseFloat(f.css(a,c+this))||0:d-=parseFloat(f.css(a,"border"+this+"Width"))||0});return d+"px"}d=bx(a,b,b);if(d<0||d==null)d=a.style[b]||0;d=parseFloat(d)||0,c&&f.each(e,function(){d+=parseFloat(f.css(a,"padding"+this))||0,c!=="padding"&&(d+=parseFloat(f.css(a,"border"+this+"Width"))||0),c==="margin"&&(d+=parseFloat(f.css(a,c+this))||0)});return d+"px"}function bm(a,b){b.src?f.ajax({url:b.src,async:!1,dataType:"script"}):f.globalEval((b.text||b.textContent||b.innerHTML||"").replace(be,"/*$0*/")),b.parentNode&&b.parentNode.removeChild(b)}function bl(a){f.nodeName(a,"input")?bk(a):"getElementsByTagName"in a&&f.grep(a.getElementsByTagName("input"),bk)}function bk(a){if(a.type==="checkbox"||a.type==="radio")a.defaultChecked=a.checked}function bj(a){return"getElementsByTagName"in a?a.getElementsByTagName("*"):"querySelectorAll"in a?a.querySelectorAll("*"):[]}function bi(a,b){var c;if(b.nodeType===1){b.clearAttributes&&b.clearAttributes(),b.mergeAttributes&&b.mergeAttributes(a),c=b.nodeName.toLowerCase();if(c==="object")b.outerHTML=a.outerHTML;else if(c!=="input"||a.type!=="checkbox"&&a.type!=="radio"){if(c==="option")b.selected=a.defaultSelected;else if(c==="input"||c==="textarea")b.defaultValue=a.defaultValue}else a.checked&&(b.defaultChecked=b.checked=a.checked),b.value!==a.value&&(b.value=a.value);b.removeAttribute(f.expando)}}function bh(a,b){if(b.nodeType===1&&!!f.hasData(a)){var c=f.expando,d=f.data(a),e=f.data(b,d);if(d=d[c]){var g=d.events;e=e[c]=f.extend({},d);if(g){delete e.handle,e.events={};for(var h in g)for(var i=0,j=g[h].length;i<j;i++)f.event.add(b,h+(g[h][i].namespace?".":"")+g[h][i].namespace,g[h][i],g[h][i].data)}}}}function bg(a,b){return f.nodeName(a,"table")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function W(a,b,c){b=b||0;if(f.isFunction(b))return f.grep(a,function(a,d){var e=!!b.call(a,d,a);return e===c});if(b.nodeType)return f.grep(a,function(a,d){return a===b===c});if(typeof b=="string"){var d=f.grep(a,function(a){return a.nodeType===1});if(R.test(b))return f.filter(b,d,!c);b=f.filter(b,d)}return f.grep(a,function(a,d){return f.inArray(a,b)>=0===c})}function V(a){return!a||!a.parentNode||a.parentNode.nodeType===11}function N(a,b){return(a&&a!=="*"?a+".":"")+b.replace(z,"`").replace(A,"&")}function M(a){var b,c,d,e,g,h,i,j,k,l,m,n,o,p=[],q=[],r=f._data(this,"events");if(!(a.liveFired===this||!r||!r.live||a.target.disabled||a.button&&a.type==="click")){a.namespace&&(n=new RegExp("(^|\\.)"+a.namespace.split(".").join("\\.(?:.*\\.)?")+"(\\.|$)")),a.liveFired=this;var s=r.live.slice(0);for(i=0;i<s.length;i++)g=s[i],g.origType.replace(x,"")===a.type?q.push(g.selector):s.splice(i--,1);e=f(a.target).closest(q,a.currentTarget);for(j=0,k=e.length;j<k;j++){m=e[j];for(i=0;i<s.length;i++){g=s[i];if(m.selector===g.selector&&(!n||n.test(g.namespace))&&!m.elem.disabled){h=m.elem,d=null;if(g.preType==="mouseenter"||g.preType==="mouseleave")a.type=g.preType,d=f(a.relatedTarget).closest(g.selector)[0],d&&f.contains(h,d)&&(d=h);(!d||d!==h)&&p.push({elem:h,handleObj:g,level:m.level})}}}for(j=0,k=p.length;j<k;j++){e=p[j];if(c&&e.level>c)break;a.currentTarget=e.elem,a.data=e.handleObj.data,a.handleObj=e.handleObj,o=e.handleObj.origHandler.apply(e.elem,arguments);if(o===!1||a.isPropagationStopped()){c=e.level,o===!1&&(b=!1);if(a.isImmediatePropagationStopped())break}}return b}}function K(a,c,d){var e=f.extend({},d[0]);e.type=a,e.originalEvent={},e.liveFired=b,f.event.handle.call(c,e),e.isDefaultPrevented()&&d[0].preventDefault()}function E(){return!0}function D(){return!1}function m(a,c,d){var e=c+"defer",g=c+"queue",h=c+"mark",i=f.data(a,e,b,!0);i&&(d==="queue"||!f.data(a,g,b,!0))&&(d==="mark"||!f.data(a,h,b,!0))&&setTimeout(function(){!f.data(a,g,b,!0)&&!f.data(a,h,b,!0)&&(f.removeData(a,e,!0),i.resolve())},0)}function l(a){for(var b in a)if(b!=="toJSON")return!1;return!0}function k(a,c,d){if(d===b&&a.nodeType===1){var e="data-"+c.replace(j,"$1-$2").toLowerCase();d=a.getAttribute(e);if(typeof d=="string"){try{d=d==="true"?!0:d==="false"?!1:d==="null"?null:f.isNaN(d)?i.test(d)?f.parseJSON(d):d:parseFloat(d)}catch(g){}f.data(a,c,d)}else d=b}return d}var c=a.document,d=a.navigator,e=a.location,f=function(){function J(){if(!e.isReady){try{c.documentElement.doScroll("left")}catch(a){setTimeout(J,1);return}e.ready()}}var e=function(a,b){return new e.fn.init(a,b,h)},f=a.jQuery,g=a.$,h,i=/^(?:[^<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,j=/\S/,k=/^\s+/,l=/\s+$/,m=/\d/,n=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,o=/^[\],:{}\s]*$/,p=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,q=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,r=/(?:^|:|,)(?:\s*\[)+/g,s=/(webkit)[ \/]([\w.]+)/,t=/(opera)(?:.*version)?[ \/]([\w.]+)/,u=/(msie) ([\w.]+)/,v=/(mozilla)(?:.*? rv:([\w.]+))?/,w=/-([a-z])/ig,x=function(a,b){return b.toUpperCase()},y=d.userAgent,z,A,B,C=Object.prototype.toString,D=Object.prototype.hasOwnProperty,E=Array.prototype.push,F=Array.prototype.slice,G=String.prototype.trim,H=Array.prototype.indexOf,I={};e.fn=e.prototype={constructor:e,init:function(a,d,f){var g,h,j,k;if(!a)return this;if(a.nodeType){this.context=this[0]=a,this.length=1;return this}if(a==="body"&&!d&&c.body){this.context=c,this[0]=c.body,this.selector=a,this.length=1;return this}if(typeof a=="string"){a.charAt(0)!=="<"||a.charAt(a.length-1)!==">"||a.length<3?g=i.exec(a):g=[null,a,null];if(g&&(g[1]||!d)){if(g[1]){d=d instanceof e?d[0]:d,k=d?d.ownerDocument||d:c,j=n.exec(a),j?e.isPlainObject(d)?(a=[c.createElement(j[1])],e.fn.attr.call(a,d,!0)):a=[k.createElement(j[1])]:(j=e.buildFragment([g[1]],[k]),a=(j.cacheable?e.clone(j.fragment):j.fragment).childNodes);return e.merge(this,a)}h=c.getElementById(g[2]);if(h&&h.parentNode){if(h.id!==g[2])return f.find(a);this.length=1,this[0]=h}this.context=c,this.selector=a;return this}return!d||d.jquery?(d||f).find(a):this.constructor(d).find(a)}if(e.isFunction(a))return f.ready(a);a.selector!==b&&(this.selector=a.selector,this.context=a.context);return e.makeArray(a,this)},selector:"",jquery:"1.6.2",length:0,size:function(){return this.length},toArray:function(){return F.call(this,0)},get:function(a){return a==null?this.toArray():a<0?this[this.length+a]:this[a]},pushStack:function(a,b,c){var d=this.constructor();e.isArray(a)?E.apply(d,a):e.merge(d,a),d.prevObject=this,d.context=this.context,b==="find"?d.selector=this.selector+(this.selector?" ":"")+c:b&&(d.selector=this.selector+"."+b+"("+c+")");return d},each:function(a,b){return e.each(this,a,b)},ready:function(a){e.bindReady(),A.done(a);return this},eq:function(a){return a===-1?this.slice(a):this.slice(a,+a+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(F.apply(this,arguments),"slice",F.call(arguments).join(","))},map:function(a){return this.pushStack(e.map(this,function(b,c){return a.call(b,c,b)}))},end:function(){return this.prevObject||this.constructor(null)},push:E,sort:[].sort,splice:[].splice},e.fn.init.prototype=e.fn,e.extend=e.fn.extend=function(){var a,c,d,f,g,h,i=arguments[0]||{},j=1,k=arguments.length,l=!1;typeof i=="boolean"&&(l=i,i=arguments[1]||{},j=2),typeof i!="object"&&!e.isFunction(i)&&(i={}),k===j&&(i=this,--j);for(;j<k;j++)if((a=arguments[j])!=null)for(c in a){d=i[c],f=a[c];if(i===f)continue;l&&f&&(e.isPlainObject(f)||(g=e.isArray(f)))?(g?(g=!1,h=d&&e.isArray(d)?d:[]):h=d&&e.isPlainObject(d)?d:{},i[c]=e.extend(l,h,f)):f!==b&&(i[c]=f)}return i},e.extend({noConflict:function(b){a.$===e&&(a.$=g),b&&a.jQuery===e&&(a.jQuery=f);return e},isReady:!1,readyWait:1,holdReady:function(a){a?e.readyWait++:e.ready(!0)},ready:function(a){if(a===!0&&!--e.readyWait||a!==!0&&!e.isReady){if(!c.body)return setTimeout(e.ready,1);e.isReady=!0;if(a!==!0&&--e.readyWait>0)return;A.resolveWith(c,[e]),e.fn.trigger&&e(c).trigger("ready").unbind("ready")}},bindReady:function(){if(!A){A=e._Deferred();if(c.readyState==="complete")return setTimeout(e.ready,1);if(c.addEventListener)c.addEventListener("DOMContentLoaded",B,!1),a.addEventListener("load",e.ready,!1);else if(c.attachEvent){c.attachEvent("onreadystatechange",B),a.attachEvent("onload",e.ready);var b=!1;try{b=a.frameElement==null}catch(d){}c.documentElement.doScroll&&b&&J()}}},isFunction:function(a){return e.type(a)==="function"},isArray:Array.isArray||function(a){return e.type(a)==="array"},isWindow:function(a){return a&&typeof a=="object"&&"setInterval"in a},isNaN:function(a){return a==null||!m.test(a)||isNaN(a)},type:function(a){return a==null?String(a):I[C.call(a)]||"object"},isPlainObject:function(a){if(!a||e.type(a)!=="object"||a.nodeType||e.isWindow(a))return!1;if(a.constructor&&!D.call(a,"constructor")&&!D.call(a.constructor.prototype,"isPrototypeOf"))return!1;var c;for(c in a);return c===b||D.call(a,c)},isEmptyObject:function(a){for(var b in a)return!1;return!0},error:function(a){throw a},parseJSON:function(b){if(typeof b!="string"||!b)return null;b=e.trim(b);if(a.JSON&&a.JSON.parse)return a.JSON.parse(b);if(o.test(b.replace(p,"@").replace(q,"]").replace(r,"")))return(new Function("return "+b))();e.error("Invalid JSON: "+b)},parseXML:function(b,c,d){a.DOMParser?(d=new DOMParser,c=d.parseFromString(b,"text/xml")):(c=new ActiveXObject("Microsoft.XMLDOM"),c.async="false",c.loadXML(b)),d=c.documentElement,(!d||!d.nodeName||d.nodeName==="parsererror")&&e.error("Invalid XML: "+b);return c},noop:function(){},globalEval:function(b){b&&j.test(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(w,x)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toUpperCase()===b.toUpperCase()},each:function(a,c,d){var f,g=0,h=a.length,i=h===b||e.isFunction(a);if(d){if(i){for(f in a)if(c.apply(a[f],d)===!1)break}else for(;g<h;)if(c.apply(a[g++],d)===!1)break}else if(i){for(f in a)if(c.call(a[f],f,a[f])===!1)break}else for(;g<h;)if(c.call(a[g],g,a[g++])===!1)break;return a},trim:G?function(a){return a==null?"":G.call(a)}:function(a){return a==null?"":(a+"").replace(k,"").replace(l,"")},makeArray:function(a,b){var c=b||[];if(a!=null){var d=e.type(a);a.length==null||d==="string"||d==="function"||d==="regexp"||e.isWindow(a)?E.call(c,a):e.merge(c,a)}return c},inArray:function(a,b){if(H)return H.call(b,a);for(var c=0,d=b.length;c<d;c++)if(b[c]===a)return c;return-1},merge:function(a,c){var d=a.length,e=0;if(typeof c.length=="number")for(var f=c.length;e<f;e++)a[d++]=c[e];else while(c[e]!==b)a[d++]=c[e++];a.length=d;return a},grep:function(a,b,c){var d=[],e;c=!!c;for(var f=0,g=a.length;f<g;f++)e=!!b(a[f],f),c!==e&&d.push(a[f]);return d},map:function(a,c,d){var f,g,h=[],i=0,j=a.length,k=a instanceof e||j!==b&&typeof j=="number"&&(j>0&&a[0]&&a[j-1]||j===0||e.isArray(a));if(k)for(;i<j;i++)f=c(a[i],i,d),f!=null&&(h[h.length]=f);else for(g in a)f=c(a[g],g,d),f!=null&&(h[h.length]=f);return h.concat.apply([],h)},guid:1,proxy:function(a,c){if(typeof c=="string"){var d=a[c];c=a,a=d}if(!e.isFunction(a))return b;var f=F.call(arguments,2),g=function(){return a.apply(c,f.concat(F.call(arguments)))};g.guid=a.guid=a.guid||g.guid||e.guid++;return g},access:function(a,c,d,f,g,h){var i=a.length;if(typeof c=="object"){for(var j in c)e.access(a,j,c[j],f,g,d);return a}if(d!==b){f=!h&&f&&e.isFunction(d);for(var k=0;k<i;k++)g(a[k],c,f?d.call(a[k],k,g(a[k],c)):d,h);return a}return i?g(a[0],c):b},now:function(){return(new Date).getTime()},uaMatch:function(a){a=a.toLowerCase();var b=s.exec(a)||t.exec(a)||u.exec(a)||a.indexOf("compatible")<0&&v.exec(a)||[];return{browser:b[1]||"",version:b[2]||"0"}},sub:function(){function a(b,c){return new a.fn.init(b,c)}e.extend(!0,a,this),a.superclass=this,a.fn=a.prototype=this(),a.fn.constructor=a,a.sub=this.sub,a.fn.init=function(d,f){f&&f instanceof e&&!(f instanceof a)&&(f=a(f));return e.fn.init.call(this,d,f,b)},a.fn.init.prototype=a.fn;var b=a(c);return a},browser:{}}),e.each("Boolean Number String Function Array Date RegExp Object".split(" "),function(a,b){I["[object "+b+"]"]=b.toLowerCase()}),z=e.uaMatch(y),z.browser&&(e.browser[z.browser]=!0,e.browser.version=z.version),e.browser.webkit&&(e.browser.safari=!0),j.test(" ")&&(k=/^[\s\xA0]+/,l=/[\s\xA0]+$/),h=e(c),c.addEventListener?B=function(){c.removeEventListener("DOMContentLoaded",B,!1),e.ready()}:c.attachEvent&&(B=function(){c.readyState==="complete"&&(c.detachEvent("onreadystatechange",B),e.ready())});return e}(),g="done fail isResolved isRejected promise then always pipe".split(" "),h=[].slice;f.extend({_Deferred:function(){var a=[],b,c,d,e={done:function(){if(!d){var c=arguments,g,h,i,j,k;b&&(k=b,b=0);for(g=0,h=c.length;g<h;g++)i=c[g],j=f.type(i),j==="array"?e.done.apply(e,i):j==="function"&&a.push(i);k&&e.resolveWith(k[0],k[1])}return this},resolveWith:function(e,f){if(!d&&!b&&!c){f=f||[],c=1;try{while(a[0])a.shift().apply(e,f)}finally{b=[e,f],c=0}}return this},resolve:function(){e.resolveWith(this,arguments);return this},isResolved:function(){return!!c||!!b},cancel:function(){d=1,a=[];return this}};return e},Deferred:function(a){var b=f._Deferred(),c=f._Deferred(),d;f.extend(b,{then:function(a,c){b.done(a).fail(c);return this},always:function(){return b.done.apply(b,arguments).fail.apply(this,arguments)},fail:c.done,rejectWith:c.resolveWith,reject:c.resolve,isRejected:c.isResolved,pipe:function(a,c){return f.Deferred(function(d){f.each({done:[a,"resolve"],fail:[c,"reject"]},function(a,c){var e=c[0],g=c[1],h;f.isFunction(e)?b[a](function(){h=e.apply(this,arguments),h&&f.isFunction(h.promise)?h.promise().then(d.resolve,d.reject):d[g](h)}):b[a](d[g])})}).promise()},promise:function(a){if(a==null){if(d)return d;d=a={}}var c=g.length;while(c--)a[g[c]]=b[g[c]];return a}}),b.done(c.cancel).fail(b.cancel),delete b.cancel,a&&a.call(b,b);return b},when:function(a){function i(a){return function(c){b[a]=arguments.length>1?h.call(arguments,0):c,--e||g.resolveWith(g,h.call(b,0))}}var b=arguments,c=0,d=b.length,e=d,g=d<=1&&a&&f.isFunction(a.promise)?a:f.Deferred();if(d>1){for(;c<d;c++)b[c]&&f.isFunction(b[c].promise)?b[c].promise().then(i(c),g.reject):--e;e||g.resolveWith(g,b)}else g!==a&&g.resolveWith(g,d?[a]:[]);return g.promise()}}),f.support=function(){var a=c.createElement("div"),b=c.documentElement,d,e,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u;a.setAttribute("className","t"),a.innerHTML=" <link/><table></table><a href='/a' style='top:1px;float:left;opacity:.55;'>a</a><input type='checkbox'/>",d=a.getElementsByTagName("*"),e=a.getElementsByTagName("a")[0];if(!d||!d.length||!e)return{};g=c.createElement("select"),h=g.appendChild(c.createElement("option")),i=a.getElementsByTagName("input")[0],k={leadingWhitespace:a.firstChild.nodeType===3,tbody:!a.getElementsByTagName("tbody").length,htmlSerialize:!!a.getElementsByTagName("link").length,style:/top/.test(e.getAttribute("style")),hrefNormalized:e.getAttribute("href")==="/a",opacity:/^0.55$/.test(e.style.opacity),cssFloat:!!e.style.cssFloat,checkOn:i.value==="on",optSelected:h.selected,getSetAttribute:a.className!=="t",submitBubbles:!0,changeBubbles:!0,focusinBubbles:!1,deleteExpando:!0,noCloneEvent:!0,inlineBlockNeedsLayout:!1,shrinkWrapBlocks:!1,reliableMarginRight:!0},i.checked=!0,k.noCloneChecked=i.cloneNode(!0).checked,g.disabled=!0,k.optDisabled=!h.disabled;try{delete a.test}catch(v){k.deleteExpando=!1}!a.addEventListener&&a.attachEvent&&a.fireEvent&&(a.attachEvent("onclick",function(){k.noCloneEvent=!1}),a.cloneNode(!0).fireEvent("onclick")),i=c.createElement("input"),i.value="t",i.setAttribute("type","radio"),k.radioValue=i.value==="t",i.setAttribute("checked","checked"),a.appendChild(i),l=c.createDocumentFragment(),l.appendChild(a.firstChild),k.checkClone=l.cloneNode(!0).cloneNode(!0).lastChild.checked,a.innerHTML="",a.style.width=a.style.paddingLeft="1px",m=c.getElementsByTagName("body")[0],o=c.createElement(m?"div":"body"),p={visibility:"hidden",width:0,height:0,border:0,margin:0},m&&f.extend(p,{position:"absolute",left:-1e3,top:-1e3});for(t in p)o.style[t]=p[t];o.appendChild(a),n=m||b,n.insertBefore(o,n.firstChild),k.appendChecked=i.checked,k.boxModel=a.offsetWidth===2,"zoom"in a.style&&(a.style.display="inline",a.style.zoom=1,k.inlineBlockNeedsLayout=a.offsetWidth===2,a.style.display="",a.innerHTML="<div style='width:4px;'></div>",k.shrinkWrapBlocks=a.offsetWidth!==2),a.innerHTML="<table><tr><td style='padding:0;border:0;display:none'></td><td>t</td></tr></table>",q=a.getElementsByTagName("td"),u=q[0].offsetHeight===0,q[0].style.display="",q[1].style.display="none",k.reliableHiddenOffsets=u&&q[0].offsetHeight===0,a.innerHTML="",c.defaultView&&c.defaultView.getComputedStyle&&(j=c.createElement("div"),j.style.width="0",j.style.marginRight="0",a.appendChild(j),k.reliableMarginRight=(parseInt((c.defaultView.getComputedStyle(j,null)||{marginRight:0}).marginRight,10)||0)===0),o.innerHTML="",n.removeChild(o);if(a.attachEvent)for(t in{submit:1,change:1,focusin:1})s="on"+t,u=s in a,u||(a.setAttribute(s,"return;"),u=typeof a[s]=="function"),k[t+"Bubbles"]=u;o=l=g=h=m=j=a=i=null;return k}(),f.boxModel=f.support.boxModel;var i=/^(?:\{.*\}|\[.*\])$/,j=/([a-z])([A-Z])/g;f.extend({cache:{},uuid:0,expando:"jQuery"+(f.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:!0,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:!0},hasData:function(a){a=a.nodeType?f.cache[a[f.expando]]:a[f.expando];return!!a&&!l(a)},data:function(a,c,d,e){if(!!f.acceptData(a)){var g=f.expando,h=typeof c=="string",i,j=a.nodeType,k=j?f.cache:a,l=j?a[f.expando]:a[f.expando]&&f.expando;if((!l||e&&l&&!k[l][g])&&h&&d===b)return;l||(j?a[f.expando]=l=++f.uuid:l=f.expando),k[l]||(k[l]={},j||(k[l].toJSON=f.noop));if(typeof c=="object"||typeof c=="function")e?k[l][g]=f.extend(k[l][g],c):k[l]=f.extend(k[l],c);i=k[l],e&&(i[g]||(i[g]={}),i=i[g]),d!==b&&(i[f.camelCase(c)]=d);if(c==="events"&&!i[c])return i[g]&&i[g].events;return h?i[f.camelCase(c)]||i[c]:i}},removeData:function(b,c,d){if(!!f.acceptData(b)){var e=f.expando,g=b.nodeType,h=g?f.cache:b,i=g?b[f.expando]:f.expando;if(!h[i])return;if(c){var j=d?h[i][e]:h[i];if(j){delete j[c];if(!l(j))return}}if(d){delete h[i][e];if(!l(h[i]))return}var k=h[i][e];f.support.deleteExpando||h!=a?delete h[i]:h[i]=null,k?(h[i]={},g||(h[i].toJSON=f.noop),h[i][e]=k):g&&(f.support.deleteExpando?delete b[f.expando]:b.removeAttribute?b.removeAttribute(f.expando):b[f.expando]=null)}},_data:function(a,b,c){return f.data(a,b,c,!0)},acceptData:function(a){if(a.nodeName){var b=f.noData[a.nodeName.toLowerCase()];if(b)return b!==!0&&a.getAttribute("classid")===b}return!0}}),f.fn.extend({data:function(a,c){var d=null;if(typeof a=="undefined"){if(this.length){d=f.data(this[0]);if(this[0].nodeType===1){var e=this[0].attributes,g;for(var h=0,i=e.length;h<i;h++)g=e[h].name,g.indexOf("data-")===0&&(g=f.camelCase(g.substring(5)),k(this[0],g,d[g]))}}return d}if(typeof a=="object")return this.each(function(){f.data(this,a)});var j=a.split(".");j[1]=j[1]?"."+j[1]:"";if(c===b){d=this.triggerHandler("getData"+j[1]+"!",[j[0]]),d===b&&this.length&&(d=f.data(this[0],a),d=k(this[0],a,d));return d===b&&j[1]?this.data(j[0]):d}return this.each(function(){var b=f(this),d=[j[0],c];b.triggerHandler("setData"+j[1]+"!",d),f.data(this,a,c),b.triggerHandler("changeData"+j[1]+"!",d)})},removeData:function(a){return this.each(function(){f.removeData(this,a)})}}),f.extend({_mark:function(a,c){a&&(c=(c||"fx")+"mark",f.data(a,c,(f.data(a,c,b,!0)||0)+1,!0))},_unmark:function(a,c,d){a!==!0&&(d=c,c=a,a=!1);if(c){d=d||"fx";var e=d+"mark",g=a?0:(f.data(c,e,b,!0)||1)-1;g?f.data(c,e,g,!0):(f.removeData(c,e,!0),m(c,d,"mark"))}},queue:function(a,c,d){if(a){c=(c||"fx")+"queue";var e=f.data(a,c,b,!0);d&&(!e||f.isArray(d)?e=f.data(a,c,f.makeArray(d),!0):e.push(d));return e||[]}},dequeue:function(a,b){b=b||"fx";var c=f.queue(a,b),d=c.shift(),e;d==="inprogress"&&(d=c.shift()),d&&(b==="fx"&&c.unshift("inprogress"),d.call(a,function(){f.dequeue(a,b)})),c.length||(f.removeData(a,b+"queue",!0),m(a,b,"queue"))}}),f.fn.extend({queue:function(a,c){typeof a!="string"&&(c=a,a="fx");if(c===b)return f.queue(this[0],a);return this.each(function(){var b=f.queue(this,a,c);a==="fx"&&b[0]!=="inprogress"&&f.dequeue(this,a)})},dequeue:function(a){return this.each(function(){f.dequeue(this,a)})},delay:function(a,b){a=f.fx?f.fx.speeds[a]||a:a,b=b||"fx";return this.queue(b,function(){var c=this;setTimeout(function(){f.dequeue(c,b)},a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,c){function m(){--h||d.resolveWith(e,[e])}typeof a!="string"&&(c=a,a=b),a=a||"fx";var d=f.Deferred(),e=this,g=e.length,h=1,i=a+"defer",j=a+"queue",k=a+"mark",l;while(g--)if(l=f.data(e[g],i,b,!0)||(f.data(e[g],j,b,!0)||f.data(e[g],k,b,!0))&&f.data(e[g],i,f._Deferred(),!0))h++,l.done(m);m();return d.promise()}});var n=/[\n\t\r]/g,o=/\s+/,p=/\r/g,q=/^(?:button|input)$/i,r=/^(?:button|input|object|select|textarea)$/i,s=/^a(?:rea)?$/i,t=/^(?:autofocus|autoplay|async|checked|controls|defer|disabled|hidden|loop|multiple|open|readonly|required|scoped|selected)$/i,u=/\:|^on/,v,w;f.fn.extend({attr:function(a,b){return f.access(this,a,b,!0,f.attr)},removeAttr:function(a){return this.each(function(){f.removeAttr(this,a)})},prop:function(a,b){return f.access(this,a,b,!0,f.prop)},removeProp:function(a){a=f.propFix[a]||a;return this.each(function(){try{this[a]=b,delete this[a]}catch(c){}})},addClass:function(a){var b,c,d,e,g,h,i;if(f.isFunction(a))return this.each(function(b){f(this).addClass(a.call(this,b,this.className))});if(a&&typeof a=="string"){b=a.split(o);for(c=0,d=this.length;c<d;c++){e=this[c];if(e.nodeType===1)if(!e.className&&b.length===1)e.className=a;else{g=" "+e.className+" ";for(h=0,i=b.length;h<i;h++)~g.indexOf(" "+b[h]+" ")||(g+=b[h]+" ");e.className=f.trim(g)}}}return this},removeClass:function(a){var c,d,e,g,h,i,j;if(f.isFunction(a))return this.each(function(b){f(this).removeClass(a.call(this,b,this.className))});if(a&&typeof a=="string"||a===b){c=(a||"").split(o);for(d=0,e=this.length;d<e;d++){g=this[d];if(g.nodeType===1&&g.className)if(a){h=(" "+g.className+" ").replace(n," ");for(i=0,j=c.length;i<j;i++)h=h.replace(" "+c[i]+" "," ");g.className=f.trim(h)}else g.className=""}}return this},toggleClass:function(a,b){var c=typeof a,d=typeof b=="boolean";if(f.isFunction(a))return this.each(function(c){f(this).toggleClass(a.call(this,c,this.className,b),b)});return this.each(function(){if(c==="string"){var e,g=0,h=f(this),i=b,j=a.split(o);while(e=j[g++])i=d?i:!h.hasClass(e),h[i?"addClass":"removeClass"](e)}else if(c==="undefined"||c==="boolean")this.className&&f._data(this,"__className__",this.className),this.className=this.className||a===!1?"":f._data(this,"__className__")||""})},hasClass:function(a){var b=" "+a+" ";for(var c=0,d=this.length;c<d;c++)if((" "+this[c].className+" ").replace(n," ").indexOf(b)>-1)return!0;return!1},val:function(a){var c,d,e=this[0];if(!arguments.length){if(e){c=f.valHooks[e.nodeName.toLowerCase()]||f.valHooks[e.type];if(c&&"get"in c&&(d=c.get(e,"value"))!==b)return d;d=e.value;return typeof d=="string"?d.replace(p,""):d==null?"":d}return b}var g=f.isFunction(a);return this.each(function(d){var e=f(this),h;if(this.nodeType===1){g?h=a.call(this,d,e.val()):h=a,h==null?h="":typeof h=="number"?h+="":f.isArray(h)&&(h=f.map(h,function(a){return a==null?"":a+""})),c=f.valHooks[this.nodeName.toLowerCase()]||f.valHooks[this.type];if(!c||!("set"in c)||c.set(this,h,"value")===b)this.value=h}})}}),f.extend({valHooks:{option:{get:function(a){var b=a.attributes.value;return!b||b.specified?a.value:a.text}},select:{get:function(a){var b,c=a.selectedIndex,d=[],e=a.options,g=a.type==="select-one";if(c<0)return null;for(var h=g?c:0,i=g?c+1:e.length;h<i;h++){var j=e[h];if(j.selected&&(f.support.optDisabled?!j.disabled:j.getAttribute("disabled")===null)&&(!j.parentNode.disabled||!f.nodeName(j.parentNode,"optgroup"))){b=f(j).val();if(g)return b;d.push(b)}}if(g&&!d.length&&e.length)return f(e[c]).val();return d},set:function(a,b){var c=f.makeArray(b);f(a).find("option").each(function(){this.selected=f.inArray(f(this).val(),c)>=0}),c.length||(a.selectedIndex=-1);return c}}},attrFn:{val:!0,css:!0,html:!0,text:!0,data:!0,width:!0,height:!0,offset:!0},attrFix:{tabindex:"tabIndex"},attr:function(a,c,d,e){var g=a.nodeType;if(!a||g===3||g===8||g===2)return b;if(e&&c in f.attrFn)return f(a)[c](d);if(!("getAttribute"in a))return f.prop(a,c,d);var h,i,j=g!==1||!f.isXMLDoc(a);j&&(c=f.attrFix[c]||c,i=f.attrHooks[c],i||(t.test(c)?i=w:v&&c!=="className"&&(f.nodeName(a,"form")||u.test(c))&&(i=v)));if(d!==b){if(d===null){f.removeAttr(a,c);return b}if(i&&"set"in i&&j&&(h=i.set(a,d,c))!==b)return h;a.setAttribute(c,""+d);return d}if(i&&"get"in i&&j&&(h=i.get(a,c))!==null)return h;h=a.getAttribute(c);return h===null?b:h},removeAttr:function(a,b){var c;a.nodeType===1&&(b=f.attrFix[b]||b,f.support.getSetAttribute?a.removeAttribute(b):(f.attr(a,b,""),a.removeAttributeNode(a.getAttributeNode(b))),t.test(b)&&(c=f.propFix[b]||b)in a&&(a[c]=!1))},attrHooks:{type:{set:function(a,b){if(q.test(a.nodeName)&&a.parentNode)f.error("type property can't be changed");else if(!f.support.radioValue&&b==="radio"&&f.nodeName(a,"input")){var c=a.value;a.setAttribute("type",b),c&&(a.value=c);return b}}},tabIndex:{get:function(a){var c=a.getAttributeNode("tabIndex");return c&&c.specified?parseInt(c.value,10):r.test(a.nodeName)||s.test(a.nodeName)&&a.href?0:b}},value:{get:function(a,b){if(v&&f.nodeName(a,"button"))return v.get(a,b);return b in a?a.value:null},set:function(a,b,c){if(v&&f.nodeName(a,"button"))return v.set(a,b,c);a.value=b}}},propFix:{tabindex:"tabIndex",readonly:"readOnly","for":"htmlFor","class":"className",maxlength:"maxLength",cellspacing:"cellSpacing",cellpadding:"cellPadding",rowspan:"rowSpan",colspan:"colSpan",usemap:"useMap",frameborder:"frameBorder",contenteditable:"contentEditable"},prop:function(a,c,d){var e=a.nodeType;if(!a||e===3||e===8||e===2)return b;var g,h,i=e!==1||!f.isXMLDoc(a);i&&(c=f.propFix[c]||c,h=f.propHooks[c]);return d!==b?h&&"set"in h&&(g=h.set(a,d,c))!==b?g:a[c]=d:h&&"get"in h&&(g=h.get(a,c))!==b?g:a[c]},propHooks:{}}),w={get:function(a,c){return f.prop(a,c)?c.toLowerCase():b},set:function(a,b,c){var d;b===!1?f.removeAttr(a,c):(d=f.propFix[c]||c,d in a&&(a[d]=!0),a.setAttribute(c,c.toLowerCase()));return c}},f.support.getSetAttribute||(f.attrFix=f.propFix,v=f.attrHooks.name=f.attrHooks.title=f.valHooks.button={get:function(a,c){var d;d=a.getAttributeNode(c);return d&&d.nodeValue!==""?d.nodeValue:b},set:function(a,b,c){var d=a.getAttributeNode(c);if(d){d.nodeValue=b;return b}}},f.each(["width","height"],function(a,b){f.attrHooks[b]=f.extend(f.attrHooks[b],{set:function(a,c){if(c===""){a.setAttribute(b,"auto");return c}}})})),f.support.hrefNormalized||f.each(["href","src","width","height"],function(a,c){f.attrHooks[c]=f.extend(f.attrHooks[c],{get:function(a){var d=a.getAttribute(c,2);return d===null?b:d}})}),f.support.style||(f.attrHooks.style={get:function(a){return a.style.cssText.toLowerCase()||b},set:function(a,b){return a.style.cssText=""+b}}),f.support.optSelected||(f.propHooks.selected=f.extend(f.propHooks.selected,{get:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}})),f.support.checkOn||f.each(["radio","checkbox"],function(){f.valHooks[this]={get:function(a){return a.getAttribute("value")===null?"on":a.value}}}),f.each(["radio","checkbox"],function(){f.valHooks[this]=f.extend(f.valHooks[this],{set:function(a,b){if(f.isArray(b))return a.checked=f.inArray(f(a).val(),b)>=0}})});var x=/\.(.*)$/,y=/^(?:textarea|input|select)$/i,z=/\./g,A=/ /g,B=/[^\w\s.|`]/g,C=function(a){return a.replace(B,"\\$&")};f.event={add:function(a,c,d,e){if(a.nodeType!==3&&a.nodeType!==8){if(d===!1)d=D;else if(!d)return;var g,h;d.handler&&(g=d,d=g.handler),d.guid||(d.guid=f.guid++);var i=f._data(a);if(!i)return;var j=i.events,k=i.handle;j||(i.events=j={}),k||(i.handle=k=function(a){return typeof f!="undefined"&&(!a||f.event.triggered!==a.type)?f.event.handle.apply(k.elem,arguments):b}),k.elem=a,c=c.split(" ");var l,m=0,n;while(l=c[m++]){h=g?f.extend({},g):{handler:d,data:e},l.indexOf(".")>-1?(n=l.split("."),l=n.shift(),h.namespace=n.slice(0).sort().join(".")):(n=[],h.namespace=""),h.type=l,h.guid||(h.guid=d.guid);var o=j[l],p=f.event.special[l]||{};if(!o){o=j[l]=[];if(!p.setup||p.setup.call(a,e,n,k)===!1)a.addEventListener?a.addEventListener(l,k,!1):a.attachEvent&&a.attachEvent("on"+l,k)}p.add&&(p.add.call(a,h),h.handler.guid||(h.handler.guid=d.guid)),o.push(h),f.event.global[l]=!0}a=null}},global:{},remove:function(a,c,d,e){if(a.nodeType!==3&&a.nodeType!==8){d===!1&&(d=D);var g,h,i,j,k=0,l,m,n,o,p,q,r,s=f.hasData(a)&&f._data(a),t=s&&s.events;if(!s||!t)return;c&&c.type&&(d=c.handler,c=c.type);if(!c||typeof c=="string"&&c.charAt(0)==="."){c=c||"";for(h in t)f.event.remove(a,h+c);return}c=c.split(" ");while(h=c[k++]){r=h,q=null,l=h.indexOf(".")<0,m=[],l||(m=h.split("."),h=m.shift(),n=new RegExp("(^|\\.)"+f.map(m.slice(0).sort(),C).join("\\.(?:.*\\.)?")+"(\\.|$)")),p=t[h];if(!p)continue;if(!d){for(j=0;j<p.length;j++){q=p[j];if(l||n.test(q.namespace))f.event.remove(a,r,q.handler,j),p.splice(j--,1)}continue}o=f.event.special[h]||{};for(j=e||0;j<p.length;j++){q=p[j];if(d.guid===q.guid){if(l||n.test(q.namespace))e==null&&p.splice(j--,1),o.remove&&o.remove.call(a,q);if(e!=null)break}}if(p.length===0||e!=null&&p.length===1)(!o.teardown||o.teardown.call(a,m)===!1)&&f.removeEvent(a,h,s.handle),g=null,delete t[h]}if(f.isEmptyObject(t)){var u=s.handle;u&&(u.elem=null),delete s.events,delete s.handle,f.isEmptyObject(s)&&f.removeData(a,b,!0)}}},customEvent:{getData:!0,setData:!0,changeData:!0},trigger:function(c,d,e,g){var h=c.type||c,i=[],j;h.indexOf("!")>=0&&(h=h.slice(0,-1),j=!0),h.indexOf(".")>=0&&(i=h.split("."),h=i. +shift(),i.sort());if(!!e&&!f.event.customEvent[h]||!!f.event.global[h]){c=typeof c=="object"?c[f.expando]?c:new f.Event(h,c):new f.Event(h),c.type=h,c.exclusive=j,c.namespace=i.join("."),c.namespace_re=new RegExp("(^|\\.)"+i.join("\\.(?:.*\\.)?")+"(\\.|$)");if(g||!e)c.preventDefault(),c.stopPropagation();if(!e){f.each(f.cache,function(){var a=f.expando,b=this[a];b&&b.events&&b.events[h]&&f.event.trigger(c,d,b.handle.elem)});return}if(e.nodeType===3||e.nodeType===8)return;c.result=b,c.target=e,d=d!=null?f.makeArray(d):[],d.unshift(c);var k=e,l=h.indexOf(":")<0?"on"+h:"";do{var m=f._data(k,"handle");c.currentTarget=k,m&&m.apply(k,d),l&&f.acceptData(k)&&k[l]&&k[l].apply(k,d)===!1&&(c.result=!1,c.preventDefault()),k=k.parentNode||k.ownerDocument||k===c.target.ownerDocument&&a}while(k&&!c.isPropagationStopped());if(!c.isDefaultPrevented()){var n,o=f.event.special[h]||{};if((!o._default||o._default.call(e.ownerDocument,c)===!1)&&(h!=="click"||!f.nodeName(e,"a"))&&f.acceptData(e)){try{l&&e[h]&&(n=e[l],n&&(e[l]=null),f.event.triggered=h,e[h]())}catch(p){}n&&(e[l]=n),f.event.triggered=b}}return c.result}},handle:function(c){c=f.event.fix(c||a.event);var d=((f._data(this,"events")||{})[c.type]||[]).slice(0),e=!c.exclusive&&!c.namespace,g=Array.prototype.slice.call(arguments,0);g[0]=c,c.currentTarget=this;for(var h=0,i=d.length;h<i;h++){var j=d[h];if(e||c.namespace_re.test(j.namespace)){c.handler=j.handler,c.data=j.data,c.handleObj=j;var k=j.handler.apply(this,g);k!==b&&(c.result=k,k===!1&&(c.preventDefault(),c.stopPropagation()));if(c.isImmediatePropagationStopped())break}}return c.result},props:"altKey attrChange attrName bubbles button cancelable charCode clientX clientY ctrlKey currentTarget data detail eventPhase fromElement handler keyCode layerX layerY metaKey newValue offsetX offsetY pageX pageY prevValue relatedNode relatedTarget screenX screenY shiftKey srcElement target toElement view wheelDelta which".split(" "),fix:function(a){if(a[f.expando])return a;var d=a;a=f.Event(d);for(var e=this.props.length,g;e;)g=this.props[--e],a[g]=d[g];a.target||(a.target=a.srcElement||c),a.target.nodeType===3&&(a.target=a.target.parentNode),!a.relatedTarget&&a.fromElement&&(a.relatedTarget=a.fromElement===a.target?a.toElement:a.fromElement);if(a.pageX==null&&a.clientX!=null){var h=a.target.ownerDocument||c,i=h.documentElement,j=h.body;a.pageX=a.clientX+(i&&i.scrollLeft||j&&j.scrollLeft||0)-(i&&i.clientLeft||j&&j.clientLeft||0),a.pageY=a.clientY+(i&&i.scrollTop||j&&j.scrollTop||0)-(i&&i.clientTop||j&&j.clientTop||0)}a.which==null&&(a.charCode!=null||a.keyCode!=null)&&(a.which=a.charCode!=null?a.charCode:a.keyCode),!a.metaKey&&a.ctrlKey&&(a.metaKey=a.ctrlKey),!a.which&&a.button!==b&&(a.which=a.button&1?1:a.button&2?3:a.button&4?2:0);return a},guid:1e8,proxy:f.proxy,special:{ready:{setup:f.bindReady,teardown:f.noop},live:{add:function(a){f.event.add(this,N(a.origType,a.selector),f.extend({},a,{handler:M,guid:a.handler.guid}))},remove:function(a){f.event.remove(this,N(a.origType,a.selector),a)}},beforeunload:{setup:function(a,b,c){f.isWindow(this)&&(this.onbeforeunload=c)},teardown:function(a,b){this.onbeforeunload===b&&(this.onbeforeunload=null)}}}},f.removeEvent=c.removeEventListener?function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c,!1)}:function(a,b,c){a.detachEvent&&a.detachEvent("on"+b,c)},f.Event=function(a,b){if(!this.preventDefault)return new f.Event(a,b);a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||a.returnValue===!1||a.getPreventDefault&&a.getPreventDefault()?E:D):this.type=a,b&&f.extend(this,b),this.timeStamp=f.now(),this[f.expando]=!0},f.Event.prototype={preventDefault:function(){this.isDefaultPrevented=E;var a=this.originalEvent;!a||(a.preventDefault?a.preventDefault():a.returnValue=!1)},stopPropagation:function(){this.isPropagationStopped=E;var a=this.originalEvent;!a||(a.stopPropagation&&a.stopPropagation(),a.cancelBubble=!0)},stopImmediatePropagation:function(){this.isImmediatePropagationStopped=E,this.stopPropagation()},isDefaultPrevented:D,isPropagationStopped:D,isImmediatePropagationStopped:D};var F=function(a){var b=a.relatedTarget,c=!1,d=a.type;a.type=a.data,b!==this&&(b&&(c=f.contains(this,b)),c||(f.event.handle.apply(this,arguments),a.type=d))},G=function(a){a.type=a.data,f.event.handle.apply(this,arguments)};f.each({mouseenter:"mouseover",mouseleave:"mouseout"},function(a,b){f.event.special[a]={setup:function(c){f.event.add(this,b,c&&c.selector?G:F,a)},teardown:function(a){f.event.remove(this,b,a&&a.selector?G:F)}}}),f.support.submitBubbles||(f.event.special.submit={setup:function(a,b){if(!f.nodeName(this,"form"))f.event.add(this,"click.specialSubmit",function(a){var b=a.target,c=b.type;(c==="submit"||c==="image")&&f(b).closest("form").length&&K("submit",this,arguments)}),f.event.add(this,"keypress.specialSubmit",function(a){var b=a.target,c=b.type;(c==="text"||c==="password")&&f(b).closest("form").length&&a.keyCode===13&&K("submit",this,arguments)});else return!1},teardown:function(a){f.event.remove(this,".specialSubmit")}});if(!f.support.changeBubbles){var H,I=function(a){var b=a.type,c=a.value;b==="radio"||b==="checkbox"?c=a.checked:b==="select-multiple"?c=a.selectedIndex>-1?f.map(a.options,function(a){return a.selected}).join("-"):"":f.nodeName(a,"select")&&(c=a.selectedIndex);return c},J=function(c){var d=c.target,e,g;if(!!y.test(d.nodeName)&&!d.readOnly){e=f._data(d,"_change_data"),g=I(d),(c.type!=="focusout"||d.type!=="radio")&&f._data(d,"_change_data",g);if(e===b||g===e)return;if(e!=null||g)c.type="change",c.liveFired=b,f.event.trigger(c,arguments[1],d)}};f.event.special.change={filters:{focusout:J,beforedeactivate:J,click:function(a){var b=a.target,c=f.nodeName(b,"input")?b.type:"";(c==="radio"||c==="checkbox"||f.nodeName(b,"select"))&&J.call(this,a)},keydown:function(a){var b=a.target,c=f.nodeName(b,"input")?b.type:"";(a.keyCode===13&&!f.nodeName(b,"textarea")||a.keyCode===32&&(c==="checkbox"||c==="radio")||c==="select-multiple")&&J.call(this,a)},beforeactivate:function(a){var b=a.target;f._data(b,"_change_data",I(b))}},setup:function(a,b){if(this.type==="file")return!1;for(var c in H)f.event.add(this,c+".specialChange",H[c]);return y.test(this.nodeName)},teardown:function(a){f.event.remove(this,".specialChange");return y.test(this.nodeName)}},H=f.event.special.change.filters,H.focus=H.beforeactivate}f.support.focusinBubbles||f.each({focus:"focusin",blur:"focusout"},function(a,b){function e(a){var c=f.event.fix(a);c.type=b,c.originalEvent={},f.event.trigger(c,null,c.target),c.isDefaultPrevented()&&a.preventDefault()}var d=0;f.event.special[b]={setup:function(){d++===0&&c.addEventListener(a,e,!0)},teardown:function(){--d===0&&c.removeEventListener(a,e,!0)}}}),f.each(["bind","one"],function(a,c){f.fn[c]=function(a,d,e){var g;if(typeof a=="object"){for(var h in a)this[c](h,d,a[h],e);return this}if(arguments.length===2||d===!1)e=d,d=b;c==="one"?(g=function(a){f(this).unbind(a,g);return e.apply(this,arguments)},g.guid=e.guid||f.guid++):g=e;if(a==="unload"&&c!=="one")this.one(a,d,e);else for(var i=0,j=this.length;i<j;i++)f.event.add(this[i],a,g,d);return this}}),f.fn.extend({unbind:function(a,b){if(typeof a=="object"&&!a.preventDefault)for(var c in a)this.unbind(c,a[c]);else for(var d=0,e=this.length;d<e;d++)f.event.remove(this[d],a,b);return this},delegate:function(a,b,c,d){return this.live(b,c,d,a)},undelegate:function(a,b,c){return arguments.length===0?this.unbind("live"):this.die(b,null,c,a)},trigger:function(a,b){return this.each(function(){f.event.trigger(a,b,this)})},triggerHandler:function(a,b){if(this[0])return f.event.trigger(a,b,this[0],!0)},toggle:function(a){var b=arguments,c=a.guid||f.guid++,d=0,e=function(c){var e=(f.data(this,"lastToggle"+a.guid)||0)%d;f.data(this,"lastToggle"+a.guid,e+1),c.preventDefault();return b[e].apply(this,arguments)||!1};e.guid=c;while(d<b.length)b[d++].guid=c;return this.click(e)},hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}});var L={focus:"focusin",blur:"focusout",mouseenter:"mouseover",mouseleave:"mouseout"};f.each(["live","die"],function(a,c){f.fn[c]=function(a,d,e,g){var h,i=0,j,k,l,m=g||this.selector,n=g?this:f(this.context);if(typeof a=="object"&&!a.preventDefault){for(var o in a)n[c](o,d,a[o],m);return this}if(c==="die"&&!a&&g&&g.charAt(0)==="."){n.unbind(g);return this}if(d===!1||f.isFunction(d))e=d||D,d=b;a=(a||"").split(" ");while((h=a[i++])!=null){j=x.exec(h),k="",j&&(k=j[0],h=h.replace(x,""));if(h==="hover"){a.push("mouseenter"+k,"mouseleave"+k);continue}l=h,L[h]?(a.push(L[h]+k),h=h+k):h=(L[h]||h)+k;if(c==="live")for(var p=0,q=n.length;p<q;p++)f.event.add(n[p],"live."+N(h,m),{data:d,selector:m,handler:e,origType:h,origHandler:e,preType:l});else n.unbind("live."+N(h,m),e)}return this}}),f.each("blur focus focusin focusout load resize scroll unload click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup error".split(" "),function(a,b){f.fn[b]=function(a,c){c==null&&(c=a,a=null);return arguments.length>0?this.bind(b,a,c):this.trigger(b)},f.attrFn&&(f.attrFn[b]=!0)}),function(){function u(a,b,c,d,e,f){for(var g=0,h=d.length;g<h;g++){var i=d[g];if(i){var j=!1;i=i[a];while(i){if(i.sizcache===c){j=d[i.sizset];break}if(i.nodeType===1){f||(i.sizcache=c,i.sizset=g);if(typeof b!="string"){if(i===b){j=!0;break}}else if(k.filter(b,[i]).length>0){j=i;break}}i=i[a]}d[g]=j}}}function t(a,b,c,d,e,f){for(var g=0,h=d.length;g<h;g++){var i=d[g];if(i){var j=!1;i=i[a];while(i){if(i.sizcache===c){j=d[i.sizset];break}i.nodeType===1&&!f&&(i.sizcache=c,i.sizset=g);if(i.nodeName.toLowerCase()===b){j=i;break}i=i[a]}d[g]=j}}}var a=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,d=0,e=Object.prototype.toString,g=!1,h=!0,i=/\\/g,j=/\W/;[0,0].sort(function(){h=!1;return 0});var k=function(b,d,f,g){f=f||[],d=d||c;var h=d;if(d.nodeType!==1&&d.nodeType!==9)return[];if(!b||typeof b!="string")return f;var i,j,n,o,q,r,s,t,u=!0,w=k.isXML(d),x=[],y=b;do{a.exec(""),i=a.exec(y);if(i){y=i[3],x.push(i[1]);if(i[2]){o=i[3];break}}}while(i);if(x.length>1&&m.exec(b))if(x.length===2&&l.relative[x[0]])j=v(x[0]+x[1],d);else{j=l.relative[x[0]]?[d]:k(x.shift(),d);while(x.length)b=x.shift(),l.relative[b]&&(b+=x.shift()),j=v(b,j)}else{!g&&x.length>1&&d.nodeType===9&&!w&&l.match.ID.test(x[0])&&!l.match.ID.test(x[x.length-1])&&(q=k.find(x.shift(),d,w),d=q.expr?k.filter(q.expr,q.set)[0]:q.set[0]);if(d){q=g?{expr:x.pop(),set:p(g)}:k.find(x.pop(),x.length===1&&(x[0]==="~"||x[0]==="+")&&d.parentNode?d.parentNode:d,w),j=q.expr?k.filter(q.expr,q.set):q.set,x.length>0?n=p(j):u=!1;while(x.length)r=x.pop(),s=r,l.relative[r]?s=x.pop():r="",s==null&&(s=d),l.relative[r](n,s,w)}else n=x=[]}n||(n=j),n||k.error(r||b);if(e.call(n)==="[object Array]")if(!u)f.push.apply(f,n);else if(d&&d.nodeType===1)for(t=0;n[t]!=null;t++)n[t]&&(n[t]===!0||n[t].nodeType===1&&k.contains(d,n[t]))&&f.push(j[t]);else for(t=0;n[t]!=null;t++)n[t]&&n[t].nodeType===1&&f.push(j[t]);else p(n,f);o&&(k(o,h,f,g),k.uniqueSort(f));return f};k.uniqueSort=function(a){if(r){g=h,a.sort(r);if(g)for(var b=1;b<a.length;b++)a[b]===a[b-1]&&a.splice(b--,1)}return a},k.matches=function(a,b){return k(a,null,null,b)},k.matchesSelector=function(a,b){return k(b,null,null,[a]).length>0},k.find=function(a,b,c){var d;if(!a)return[];for(var e=0,f=l.order.length;e<f;e++){var g,h=l.order[e];if(g=l.leftMatch[h].exec(a)){var j=g[1];g.splice(1,1);if(j.substr(j.length-1)!=="\\"){g[1]=(g[1]||"").replace(i,""),d=l.find[h](g,b,c);if(d!=null){a=a.replace(l.match[h],"");break}}}}d||(d=typeof b.getElementsByTagName!="undefined"?b.getElementsByTagName("*"):[]);return{set:d,expr:a}},k.filter=function(a,c,d,e){var f,g,h=a,i=[],j=c,m=c&&c[0]&&k.isXML(c[0]);while(a&&c.length){for(var n in l.filter)if((f=l.leftMatch[n].exec(a))!=null&&f[2]){var o,p,q=l.filter[n],r=f[1];g=!1,f.splice(1,1);if(r.substr(r.length-1)==="\\")continue;j===i&&(i=[]);if(l.preFilter[n]){f=l.preFilter[n](f,j,d,i,e,m);if(!f)g=o=!0;else if(f===!0)continue}if(f)for(var s=0;(p=j[s])!=null;s++)if(p){o=q(p,f,s,j);var t=e^!!o;d&&o!=null?t?g=!0:j[s]=!1:t&&(i.push(p),g=!0)}if(o!==b){d||(j=i),a=a.replace(l.match[n],"");if(!g)return[];break}}if(a===h)if(g==null)k.error(a);else break;h=a}return j},k.error=function(a){throw"Syntax error, unrecognized expression: "+a};var l=k.selectors={order:["ID","NAME","TAG"],match:{ID:/#((?:[\w\u00c0-\uFFFF\-]|\\.)+)/,CLASS:/\.((?:[\w\u00c0-\uFFFF\-]|\\.)+)/,NAME:/\[name=['"]*((?:[\w\u00c0-\uFFFF\-]|\\.)+)['"]*\]/,ATTR:/\[\s*((?:[\w\u00c0-\uFFFF\-]|\\.)+)\s*(?:(\S?=)\s*(?:(['"])(.*?)\3|(#?(?:[\w\u00c0-\uFFFF\-]|\\.)*)|)|)\s*\]/,TAG:/^((?:[\w\u00c0-\uFFFF\*\-]|\\.)+)/,CHILD:/:(only|nth|last|first)-child(?:\(\s*(even|odd|(?:[+\-]?\d+|(?:[+\-]?\d*)?n\s*(?:[+\-]\s*\d+)?))\s*\))?/,POS:/:(nth|eq|gt|lt|first|last|even|odd)(?:\((\d*)\))?(?=[^\-]|$)/,PSEUDO:/:((?:[\w\u00c0-\uFFFF\-]|\\.)+)(?:\((['"]?)((?:\([^\)]+\)|[^\(\)]*)+)\2\))?/},leftMatch:{},attrMap:{"class":"className","for":"htmlFor"},attrHandle:{href:function(a){return a.getAttribute("href")},type:function(a){return a.getAttribute("type")}},relative:{"+":function(a,b){var c=typeof b=="string",d=c&&!j.test(b),e=c&&!d;d&&(b=b.toLowerCase());for(var f=0,g=a.length,h;f<g;f++)if(h=a[f]){while((h=h.previousSibling)&&h.nodeType!==1);a[f]=e||h&&h.nodeName.toLowerCase()===b?h||!1:h===b}e&&k.filter(b,a,!0)},">":function(a,b){var c,d=typeof b=="string",e=0,f=a.length;if(d&&!j.test(b)){b=b.toLowerCase();for(;e<f;e++){c=a[e];if(c){var g=c.parentNode;a[e]=g.nodeName.toLowerCase()===b?g:!1}}}else{for(;e<f;e++)c=a[e],c&&(a[e]=d?c.parentNode:c.parentNode===b);d&&k.filter(b,a,!0)}},"":function(a,b,c){var e,f=d++,g=u;typeof b=="string"&&!j.test(b)&&(b=b.toLowerCase(),e=b,g=t),g("parentNode",b,f,a,e,c)},"~":function(a,b,c){var e,f=d++,g=u;typeof b=="string"&&!j.test(b)&&(b=b.toLowerCase(),e=b,g=t),g("previousSibling",b,f,a,e,c)}},find:{ID:function(a,b,c){if(typeof b.getElementById!="undefined"&&!c){var d=b.getElementById(a[1]);return d&&d.parentNode?[d]:[]}},NAME:function(a,b){if(typeof b.getElementsByName!="undefined"){var c=[],d=b.getElementsByName(a[1]);for(var e=0,f=d.length;e<f;e++)d[e].getAttribute("name")===a[1]&&c.push(d[e]);return c.length===0?null:c}},TAG:function(a,b){if(typeof b.getElementsByTagName!="undefined")return b.getElementsByTagName(a[1])}},preFilter:{CLASS:function(a,b,c,d,e,f){a=" "+a[1].replace(i,"")+" ";if(f)return a;for(var g=0,h;(h=b[g])!=null;g++)h&&(e^(h.className&&(" "+h.className+" ").replace(/[\t\n\r]/g," ").indexOf(a)>=0)?c||d.push(h):c&&(b[g]=!1));return!1},ID:function(a){return a[1].replace(i,"")},TAG:function(a,b){return a[1].replace(i,"").toLowerCase()},CHILD:function(a){if(a[1]==="nth"){a[2]||k.error(a[0]),a[2]=a[2].replace(/^\+|\s*/g,"");var b=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(a[2]==="even"&&"2n"||a[2]==="odd"&&"2n+1"||!/\D/.test(a[2])&&"0n+"+a[2]||a[2]);a[2]=b[1]+(b[2]||1)-0,a[3]=b[3]-0}else a[2]&&k.error(a[0]);a[0]=d++;return a},ATTR:function(a,b,c,d,e,f){var g=a[1]=a[1].replace(i,"");!f&&l.attrMap[g]&&(a[1]=l.attrMap[g]),a[4]=(a[4]||a[5]||"").replace(i,""),a[2]==="~="&&(a[4]=" "+a[4]+" ");return a},PSEUDO:function(b,c,d,e,f){if(b[1]==="not")if((a.exec(b[3])||"").length>1||/^\w/.test(b[3]))b[3]=k(b[3],null,null,c);else{var g=k.filter(b[3],c,d,!0^f);d||e.push.apply(e,g);return!1}else if(l.match.POS.test(b[0])||l.match.CHILD.test(b[0]))return!0;return b},POS:function(a){a.unshift(!0);return a}},filters:{enabled:function(a){return a.disabled===!1&&a.type!=="hidden"},disabled:function(a){return a.disabled===!0},checked:function(a){return a.checked===!0},selected:function(a){a.parentNode&&a.parentNode.selectedIndex;return a.selected===!0},parent:function(a){return!!a.firstChild},empty:function(a){return!a.firstChild},has:function(a,b,c){return!!k(c[3],a).length},header:function(a){return/h\d/i.test(a.nodeName)},text:function(a){var b=a.getAttribute("type"),c=a.type;return a.nodeName.toLowerCase()==="input"&&"text"===c&&(b===c||b===null)},radio:function(a){return a.nodeName.toLowerCase()==="input"&&"radio"===a.type},checkbox:function(a){return a.nodeName.toLowerCase()==="input"&&"checkbox"===a.type},file:function(a){return a.nodeName.toLowerCase()==="input"&&"file"===a.type},password:function(a){return a.nodeName.toLowerCase()==="input"&&"password"===a.type},submit:function(a){var b=a.nodeName.toLowerCase();return(b==="input"||b==="button")&&"submit"===a.type},image:function(a){return a.nodeName.toLowerCase()==="input"&&"image"===a.type},reset:function(a){var b=a.nodeName.toLowerCase();return(b==="input"||b==="button")&&"reset"===a.type},button:function(a){var b=a.nodeName.toLowerCase();return b==="input"&&"button"===a.type||b==="button"},input:function(a){return/input|select|textarea|button/i.test(a.nodeName)},focus:function(a){return a===a.ownerDocument.activeElement}},setFilters:{first:function(a,b){return b===0},last:function(a,b,c,d){return b===d.length-1},even:function(a,b){return b%2===0},odd:function(a,b){return b%2===1},lt:function(a,b,c){return b<c[3]-0},gt:function(a,b,c){return b>c[3]-0},nth:function(a,b,c){return c[3]-0===b},eq:function(a,b,c){return c[3]-0===b}},filter:{PSEUDO:function(a,b,c,d){var e=b[1],f=l.filters[e];if(f)return f(a,c,b,d);if(e==="contains")return(a.textContent||a.innerText||k.getText([a])||"").indexOf(b[3])>=0;if(e==="not"){var g=b[3];for(var h=0,i=g.length;h<i;h++)if(g[h]===a)return!1;return!0}k.error(e)},CHILD:function(a,b){var c=b[1],d=a;switch(c){case"only":case"first":while(d=d.previousSibling)if(d.nodeType===1)return!1;if(c==="first")return!0;d=a;case"last":while(d=d.nextSibling)if(d.nodeType===1)return!1;return!0;case"nth":var e=b[2],f=b[3];if(e===1&&f===0)return!0;var g=b[0],h=a.parentNode;if(h&&(h.sizcache!==g||!a.nodeIndex)){var i=0;for(d=h.firstChild;d;d=d.nextSibling)d.nodeType===1&&(d.nodeIndex=++i);h.sizcache=g}var j=a.nodeIndex-f;return e===0?j===0:j%e===0&&j/e>=0}},ID:function(a,b){return a.nodeType===1&&a.getAttribute("id")===b},TAG:function(a,b){return b==="*"&&a.nodeType===1||a.nodeName.toLowerCase()===b},CLASS:function(a,b){return(" "+(a.className||a.getAttribute("class"))+" ").indexOf(b)>-1},ATTR:function(a,b){var c=b[1],d=l.attrHandle[c]?l.attrHandle[c](a):a[c]!=null?a[c]:a.getAttribute(c),e=d+"",f=b[2],g=b[4];return d==null?f==="!=":f==="="?e===g:f==="*="?e.indexOf(g)>=0:f==="~="?(" "+e+" ").indexOf(g)>=0:g?f==="!="?e!==g:f==="^="?e.indexOf(g)===0:f==="$="?e.substr(e.length-g.length)===g:f==="|="?e===g||e.substr(0,g.length+1)===g+"-":!1:e&&d!==!1},POS:function(a,b,c,d){var e=b[2],f=l.setFilters[e];if(f)return f(a,c,b,d)}}},m=l.match.POS,n=function(a,b){return"\\"+(b-0+1)};for(var o in l.match)l.match[o]=new RegExp(l.match[o].source+/(?![^\[]*\])(?![^\(]*\))/.source),l.leftMatch[o]=new RegExp(/(^(?:.|\r|\n)*?)/.source+l.match[o].source.replace(/\\(\d+)/g,n));var p=function(a,b){a=Array.prototype.slice.call(a,0);if(b){b.push.apply(b,a);return b}return a};try{Array.prototype.slice.call(c.documentElement.childNodes,0)[0].nodeType}catch(q){p=function(a,b){var c=0,d=b||[];if(e.call(a)==="[object Array]")Array.prototype.push.apply(d,a);else if(typeof a.length=="number")for(var f=a.length;c<f;c++)d.push(a[c]);else for(;a[c];c++)d.push(a[c]);return d}}var r,s;c.documentElement.compareDocumentPosition?r=function(a,b){if(a===b){g=!0;return 0}if(!a.compareDocumentPosition||!b.compareDocumentPosition)return a.compareDocumentPosition?-1:1;return a.compareDocumentPosition(b)&4?-1:1}:(r=function(a,b){if(a===b){g=!0;return 0}if(a.sourceIndex&&b.sourceIndex)return a.sourceIndex-b.sourceIndex;var c,d,e=[],f=[],h=a.parentNode,i=b.parentNode,j=h;if(h===i)return s(a,b);if(!h)return-1;if(!i)return 1;while(j)e.unshift(j),j=j.parentNode;j=i;while(j)f.unshift(j),j=j.parentNode;c=e.length,d=f.length;for(var k=0;k<c&&k<d;k++)if(e[k]!==f[k])return s(e[k],f[k]);return k===c?s(a,f[k],-1):s(e[k],b,1)},s=function(a,b,c){if(a===b)return c;var d=a.nextSibling;while(d){if(d===b)return-1;d=d.nextSibling}return 1}),k.getText=function(a){var b="",c;for(var d=0;a[d];d++)c=a[d],c.nodeType===3||c.nodeType===4?b+=c.nodeValue:c.nodeType!==8&&(b+=k.getText(c.childNodes));return b},function(){var a=c.createElement("div"),d="script"+(new Date).getTime(),e=c.documentElement;a.innerHTML="<a name='"+d+"'/>",e.insertBefore(a,e.firstChild),c.getElementById(d)&&(l.find.ID=function(a,c,d){if(typeof c.getElementById!="undefined"&&!d){var e=c.getElementById(a[1]);return e?e.id===a[1]||typeof e.getAttributeNode!="undefined"&&e.getAttributeNode("id").nodeValue===a[1]?[e]:b:[]}},l.filter.ID=function(a,b){var c=typeof a.getAttributeNode!="undefined"&&a.getAttributeNode("id");return a.nodeType===1&&c&&c.nodeValue===b}),e.removeChild(a),e=a=null}(),function(){var a=c.createElement("div");a.appendChild(c.createComment("")),a.getElementsByTagName("*").length>0&&(l.find.TAG=function(a,b){var c=b.getElementsByTagName(a[1]);if(a[1]==="*"){var d=[];for(var e=0;c[e];e++)c[e].nodeType===1&&d.push(c[e]);c=d}return c}),a.innerHTML="<a href='#'></a>",a.firstChild&&typeof a.firstChild.getAttribute!="undefined"&&a.firstChild.getAttribute("href")!=="#"&&(l.attrHandle.href=function(a){return a.getAttribute("href",2)}),a=null}(),c.querySelectorAll&&function(){var a=k,b=c.createElement("div"),d="__sizzle__";b.innerHTML="<p class='TEST'></p>";if(!b.querySelectorAll||b.querySelectorAll(".TEST").length!==0){k=function(b,e,f,g){e=e||c;if(!g&&!k.isXML(e)){var h=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b);if(h&&(e.nodeType===1||e.nodeType===9)){if(h[1])return p(e.getElementsByTagName(b),f);if(h[2]&&l.find.CLASS&&e.getElementsByClassName)return p(e.getElementsByClassName(h[2]),f)}if(e.nodeType===9){if(b==="body"&&e.body)return p([e.body],f);if(h&&h[3]){var i=e.getElementById(h[3]);if(!i||!i.parentNode)return p([],f);if(i.id===h[3])return p([i],f)}try{return p(e.querySelectorAll(b),f)}catch(j){}}else if(e.nodeType===1&&e.nodeName.toLowerCase()!=="object"){var m=e,n=e.getAttribute("id"),o=n||d,q=e.parentNode,r=/^\s*[+~]/.test(b);n?o=o.replace(/'/g,"\\$&"):e.setAttribute("id",o),r&&q&&(e=e.parentNode);try{if(!r||q)return p(e.querySelectorAll("[id='"+o+"'] "+b),f)}catch(s){}finally{n||m.removeAttribute("id")}}}return a(b,e,f,g)};for(var e in a)k[e]=a[e];b=null}}(),function(){var a=c.documentElement,b=a.matchesSelector||a.mozMatchesSelector||a.webkitMatchesSelector||a.msMatchesSelector;if(b){var d=!b.call(c.createElement("div"),"div"),e=!1;try{b.call(c.documentElement,"[test!='']:sizzle")}catch(f){e=!0}k.matchesSelector=function(a,c){c=c.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!k.isXML(a))try{if(e||!l.match.PSEUDO.test(c)&&!/!=/.test(c)){var f=b.call(a,c);if(f||!d||a.document&&a.document.nodeType!==11)return f}}catch(g){}return k(c,null,null,[a]).length>0}}}(),function(){var a=c.createElement("div");a.innerHTML="<div class='test e'></div><div class='test'></div>";if(!!a.getElementsByClassName&&a.getElementsByClassName("e").length!==0){a.lastChild.className="e";if(a.getElementsByClassName("e").length===1)return;l.order.splice(1,0,"CLASS"),l.find.CLASS=function(a,b,c){if(typeof b.getElementsByClassName!="undefined"&&!c)return b.getElementsByClassName(a[1])},a=null}}(),c.documentElement.contains?k.contains=function(a,b){return a!==b&&(a.contains?a.contains(b):!0)}:c.documentElement.compareDocumentPosition?k.contains=function(a,b){return!!(a.compareDocumentPosition(b)&16)}:k.contains=function(){return!1},k.isXML=function(a){var b=(a?a.ownerDocument||a:0).documentElement;return b?b.nodeName!=="HTML":!1};var v=function(a,b){var c,d=[],e="",f=b.nodeType?[b]:b;while(c=l.match.PSEUDO.exec(a))e+=c[0],a=a.replace(l.match.PSEUDO,"");a=l.relative[a]?a+"*":a;for(var g=0,h=f.length;g<h;g++)k(a,f[g],d);return k.filter(e,d)};f.find=k,f.expr=k.selectors,f.expr[":"]=f.expr.filters,f.unique=k.uniqueSort,f.text=k.getText,f.isXMLDoc=k.isXML,f.contains=k.contains}();var O=/Until$/,P=/^(?:parents|prevUntil|prevAll)/,Q=/,/,R=/^.[^:#\[\.,]*$/,S=Array.prototype.slice,T=f.expr.match.POS,U={children:!0,contents:!0,next:!0,prev:!0};f.fn.extend({find:function(a){var b=this,c,d;if(typeof a!="string")return f(a).filter(function(){for(c=0,d=b.length;c<d;c++)if(f.contains(b[c],this))return!0});var e=this.pushStack("","find",a),g,h,i;for(c=0,d=this.length;c<d;c++){g=e.length,f.find(a,this[c],e);if(c>0)for(h=g;h<e.length;h++)for(i=0;i<g;i++)if(e[i]===e[h]){e.splice(h--,1);break}}return e},has:function(a){var b=f(a);return this.filter(function(){for(var a=0,c=b.length;a<c;a++)if(f.contains(this,b[a]))return!0})},not:function(a){return this.pushStack(W(this,a,!1),"not",a)},filter:function(a){return this.pushStack(W(this,a,!0),"filter",a)},is:function(a){return!!a&&(typeof a=="string"?f.filter(a,this).length>0:this.filter(a).length>0)},closest:function(a,b){var c=[],d,e,g=this[0];if(f.isArray(a)){var h,i,j={},k=1;if(g&&a.length){for(d=0,e=a.length;d<e;d++)i=a[d],j[i]||(j[i]=T.test(i)?f(i,b||this.context):i);while(g&&g.ownerDocument&&g!==b){for(i in j)h=j[i],(h.jquery?h.index(g)>-1:f(g).is(h))&&c.push({selector:i,elem:g,level:k});g=g.parentNode,k++}}return c}var l=T.test(a)||typeof a!="string"?f(a,b||this.context):0;for(d=0,e=this.length;d<e;d++){g=this[d];while(g){if(l?l.index(g)>-1:f.find.matchesSelector(g,a)){c.push(g);break}g=g.parentNode;if(!g||!g.ownerDocument||g===b||g.nodeType===11)break}}c=c.length>1?f.unique(c):c;return this.pushStack(c,"closest",a)},index:function(a){if(!a||typeof a=="string")return f.inArray(this[0],a?f(a):this.parent().children());return f.inArray(a.jquery?a[0]:a,this)},add:function(a,b){var c=typeof a=="string"?f(a,b):f.makeArray(a&&a.nodeType?[a]:a),d=f.merge(this.get(),c);return this.pushStack(V(c[0])||V(d[0])?d:f.unique(d))},andSelf:function(){return this.add(this.prevObject)}}),f.each({parent:function(a){var b=a.parentNode;return b&&b.nodeType!==11?b:null},parents:function(a){return f.dir(a,"parentNode")},parentsUntil:function(a,b,c){return f.dir(a,"parentNode",c)},next:function(a){return f.nth(a,2,"nextSibling")},prev:function(a){return f.nth(a,2,"previousSibling")},nextAll:function(a){return f.dir(a,"nextSibling")},prevAll:function(a){return f.dir(a,"previousSibling")},nextUntil:function(a,b,c){return f.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return f.dir(a,"previousSibling",c)},siblings:function(a){return f.sibling(a.parentNode.firstChild,a)},children:function(a){return f.sibling(a.firstChild)},contents:function(a){return f.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:f.makeArray(a.childNodes)}},function(a,b){f.fn[a]=function(c,d){var e=f.map(this,b,c),g=S.call(arguments);O.test(a)||(d=c),d&&typeof d=="string"&&(e=f.filter(d,e)),e=this.length>1&&!U[a]?f.unique(e):e,(this.length>1||Q.test(d))&&P.test(a)&&(e=e.reverse());return this.pushStack(e,a,g.join(","))}}),f.extend({filter:function(a,b,c){c&&(a=":not("+a+")");return b.length===1?f.find.matchesSelector(b[0],a)?[b[0]]:[]:f.find.matches(a,b)},dir:function(a,c,d){var e=[],g=a[c];while(g&&g.nodeType!==9&&(d===b||g.nodeType!==1||!f(g).is(d)))g.nodeType===1&&e.push(g),g=g[c];return e},nth:function(a,b,c,d){b=b||1;var e=0;for(;a;a=a[c])if(a.nodeType===1&&++e===b)break;return a},sibling:function(a,b){var c=[];for(;a;a=a.nextSibling)a.nodeType===1&&a!==b&&c.push(a);return c}});var X=/ jQuery\d+="(?:\d+|null)"/g,Y=/^\s+/,Z=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,$=/<([\w:]+)/,_=/<tbody/i,ba=/<|&#?\w+;/,bb=/<(?:script|object|embed|option|style)/i,bc=/checked\s*(?:[^=]|=\s*.checked.)/i,bd=/\/(java|ecma)script/i,be=/^\s*<!(?:\[CDATA\[|\-\-)/,bf={option:[1,"<select multiple='multiple'>","</select>"],legend:[1,"<fieldset>","</fieldset>"],thead:[1,"<table>","</table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],col:[2,"<table><tbody></tbody><colgroup>","</colgroup></table>"],area:[1,"<map>","</map>"],_default:[0,"",""]};bf.optgroup=bf.option,bf.tbody=bf.tfoot=bf.colgroup=bf.caption=bf.thead,bf.th=bf.td,f.support.htmlSerialize||(bf._default=[1,"div<div>","</div>"]),f.fn.extend({text:function(a){if(f.isFunction(a))return this.each(function(b){var c=f(this);c.text(a.call(this,b,c.text()))});if(typeof a!="object"&&a!==b)return this.empty().append((this[0]&&this[0].ownerDocument||c).createTextNode(a));return f.text(this)},wrapAll:function(a){if(f.isFunction(a))return this.each(function(b){f(this).wrapAll(a.call(this,b))});if(this[0]){var b=f(a,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstChild&&a.firstChild.nodeType===1)a=a.firstChild;return a}).append(this)}return this},wrapInner:function(a){if(f.isFunction(a))return this.each(function(b){f(this).wrapInner(a.call(this,b))});return this.each(function(){var b=f(this),c=b.contents();c.length?c.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){f(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){f.nodeName(this,"body")||f(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.appendChild(a)})},prepend:function(){return this.domManip(arguments,!0,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this)});if(arguments.length){var a=f(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,!1,function(a){this.parentNode.insertBefore(a,this.nextSibling)});if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,f(arguments[0]).toArray());return a}},remove:function(a,b){for(var c=0,d;(d=this[c])!=null;c++)if(!a||f.filter(a,[d]).length)!b&&d.nodeType===1&&(f.cleanData(d.getElementsByTagName("*")),f.cleanData([d])),d.parentNode&&d.parentNode.removeChild(d);return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++){b.nodeType===1&&f.cleanData(b.getElementsByTagName("*"));while(b.firstChild)b.removeChild(b.firstChild)}return this},clone:function(a,b){a=a==null?!1:a,b=b==null?a:b;return this.map(function(){return f.clone(this,a,b)})},html:function(a){if(a===b)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(X,""):null;if(typeof a=="string"&&!bb.test(a)&&(f.support.leadingWhitespace||!Y.test(a))&&!bf[($.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Z,"<$1></$2>");try{for(var c=0,d=this.length;c<d;c++)this[c].nodeType===1&&(f.cleanData(this[c].getElementsByTagName("*")),this[c].innerHTML=a)}catch(e){this.empty().append(a)}}else f.isFunction(a)?this.each(function(b){var c=f(this);c.html(a.call(this,b,c.html()))}):this.empty().append(a);return this},replaceWith:function(a){if(this[0]&&this[0].parentNode){if(f.isFunction(a))return this.each(function(b){var c=f(this),d=c.html();c.replaceWith(a.call(this,b,d))});typeof a!="string"&&(a=f(a).detach());return this.each(function(){var b=this.nextSibling,c=this.parentNode;f(this).remove(),b?f(b).before(a):f(c).append(a)})}return this.length?this.pushStack(f(f.isFunction(a)?a():a),"replaceWith",a):this},detach:function(a){return this.remove(a,!0)},domManip:function(a,c,d){var e,g,h,i,j=a[0],k=[];if(!f.support.checkClone&&arguments.length===3&&typeof j=="string"&&bc.test(j))return this.each(function(){f(this).domManip(a,c,d,!0)});if(f.isFunction(j))return this.each(function(e){var g=f(this);a[0]=j.call(this,e,c?g.html():b),g.domManip(a,c,d)});if(this[0]){i=j&&j.parentNode,f.support.parentNode&&i&&i.nodeType===11&&i.childNodes.length===this.length?e={fragment:i}:e=f.buildFragment(a,this,k),h=e.fragment,h.childNodes.length===1?g=h=h.firstChild:g=h.firstChild;if(g){c=c&&f.nodeName(g,"tr");for(var l=0,m=this.length,n=m-1;l<m;l++)d.call(c?bg(this[l],g):this[l],e.cacheable||m>1&&l<n?f.clone(h,!0,!0):h)}k.length&&f.each(k,bm)}return this}}),f.buildFragment=function(a,b,d){var e,g,h,i;b&&b[0]&&(i=b[0].ownerDocument||b[0]),i.createDocumentFragment||(i=c),a.length===1&&typeof a[0]=="string"&&a[0].length<512&&i===c&&a[0].charAt(0)==="<"&&!bb.test(a[0])&&(f.support.checkClone||!bc.test(a[0]))&&(g=!0,h=f.fragments[a[0]],h&&h!==1&&(e=h)),e||(e=i.createDocumentFragment(),f.clean(a,i,e,d)),g&&(f.fragments[a[0]]=h?e:1);return{fragment:e,cacheable:g}},f.fragments={},f.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){f.fn[a]=function(c){var d=[],e=f(c),g=this.length===1&&this[0].parentNode;if(g&&g.nodeType===11&&g.childNodes.length===1&&e.length===1){e[b](this[0]);return this}for(var h=0,i=e.length;h<i;h++){var j=(h>0?this.clone(!0):this).get();f(e[h])[b](j),d=d.concat(j +)}return this.pushStack(d,a,e.selector)}}),f.extend({clone:function(a,b,c){var d=a.cloneNode(!0),e,g,h;if((!f.support.noCloneEvent||!f.support.noCloneChecked)&&(a.nodeType===1||a.nodeType===11)&&!f.isXMLDoc(a)){bi(a,d),e=bj(a),g=bj(d);for(h=0;e[h];++h)bi(e[h],g[h])}if(b){bh(a,d);if(c){e=bj(a),g=bj(d);for(h=0;e[h];++h)bh(e[h],g[h])}}e=g=null;return d},clean:function(a,b,d,e){var g;b=b||c,typeof b.createElement=="undefined"&&(b=b.ownerDocument||b[0]&&b[0].ownerDocument||c);var h=[],i;for(var j=0,k;(k=a[j])!=null;j++){typeof k=="number"&&(k+="");if(!k)continue;if(typeof k=="string")if(!ba.test(k))k=b.createTextNode(k);else{k=k.replace(Z,"<$1></$2>");var l=($.exec(k)||["",""])[1].toLowerCase(),m=bf[l]||bf._default,n=m[0],o=b.createElement("div");o.innerHTML=m[1]+k+m[2];while(n--)o=o.lastChild;if(!f.support.tbody){var p=_.test(k),q=l==="table"&&!p?o.firstChild&&o.firstChild.childNodes:m[1]==="<table>"&&!p?o.childNodes:[];for(i=q.length-1;i>=0;--i)f.nodeName(q[i],"tbody")&&!q[i].childNodes.length&&q[i].parentNode.removeChild(q[i])}!f.support.leadingWhitespace&&Y.test(k)&&o.insertBefore(b.createTextNode(Y.exec(k)[0]),o.firstChild),k=o.childNodes}var r;if(!f.support.appendChecked)if(k[0]&&typeof (r=k.length)=="number")for(i=0;i<r;i++)bl(k[i]);else bl(k);k.nodeType?h.push(k):h=f.merge(h,k)}if(d){g=function(a){return!a.type||bd.test(a.type)};for(j=0;h[j];j++)if(e&&f.nodeName(h[j],"script")&&(!h[j].type||h[j].type.toLowerCase()==="text/javascript"))e.push(h[j].parentNode?h[j].parentNode.removeChild(h[j]):h[j]);else{if(h[j].nodeType===1){var s=f.grep(h[j].getElementsByTagName("script"),g);h.splice.apply(h,[j+1,0].concat(s))}d.appendChild(h[j])}}return h},cleanData:function(a){var b,c,d=f.cache,e=f.expando,g=f.event.special,h=f.support.deleteExpando;for(var i=0,j;(j=a[i])!=null;i++){if(j.nodeName&&f.noData[j.nodeName.toLowerCase()])continue;c=j[f.expando];if(c){b=d[c]&&d[c][e];if(b&&b.events){for(var k in b.events)g[k]?f.event.remove(j,k):f.removeEvent(j,k,b.handle);b.handle&&(b.handle.elem=null)}h?delete j[f.expando]:j.removeAttribute&&j.removeAttribute(f.expando),delete d[c]}}}});var bn=/alpha\([^)]*\)/i,bo=/opacity=([^)]*)/,bp=/([A-Z]|^ms)/g,bq=/^-?\d+(?:px)?$/i,br=/^-?\d/,bs=/^[+\-]=/,bt=/[^+\-\.\de]+/g,bu={position:"absolute",visibility:"hidden",display:"block"},bv=["Left","Right"],bw=["Top","Bottom"],bx,by,bz;f.fn.css=function(a,c){if(arguments.length===2&&c===b)return this;return f.access(this,a,c,!0,function(a,c,d){return d!==b?f.style(a,c,d):f.css(a,c)})},f.extend({cssHooks:{opacity:{get:function(a,b){if(b){var c=bx(a,"opacity","opacity");return c===""?"1":c}return a.style.opacity}}},cssNumber:{fillOpacity:!0,fontWeight:!0,lineHeight:!0,opacity:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":f.support.cssFloat?"cssFloat":"styleFloat"},style:function(a,c,d,e){if(!!a&&a.nodeType!==3&&a.nodeType!==8&&!!a.style){var g,h,i=f.camelCase(c),j=a.style,k=f.cssHooks[i];c=f.cssProps[i]||i;if(d===b){if(k&&"get"in k&&(g=k.get(a,!1,e))!==b)return g;return j[c]}h=typeof d;if(h==="number"&&isNaN(d)||d==null)return;h==="string"&&bs.test(d)&&(d=+d.replace(bt,"")+parseFloat(f.css(a,c)),h="number"),h==="number"&&!f.cssNumber[i]&&(d+="px");if(!k||!("set"in k)||(d=k.set(a,d))!==b)try{j[c]=d}catch(l){}}},css:function(a,c,d){var e,g;c=f.camelCase(c),g=f.cssHooks[c],c=f.cssProps[c]||c,c==="cssFloat"&&(c="float");if(g&&"get"in g&&(e=g.get(a,!0,d))!==b)return e;if(bx)return bx(a,c)},swap:function(a,b,c){var d={};for(var e in b)d[e]=a.style[e],a.style[e]=b[e];c.call(a);for(e in b)a.style[e]=d[e]}}),f.curCSS=f.css,f.each(["height","width"],function(a,b){f.cssHooks[b]={get:function(a,c,d){var e;if(c){if(a.offsetWidth!==0)return bA(a,b,d);f.swap(a,bu,function(){e=bA(a,b,d)});return e}},set:function(a,b){if(!bq.test(b))return b;b=parseFloat(b);if(b>=0)return b+"px"}}}),f.support.opacity||(f.cssHooks.opacity={get:function(a,b){return bo.test((b&&a.currentStyle?a.currentStyle.filter:a.style.filter)||"")?parseFloat(RegExp.$1)/100+"":b?"1":""},set:function(a,b){var c=a.style,d=a.currentStyle;c.zoom=1;var e=f.isNaN(b)?"":"alpha(opacity="+b*100+")",g=d&&d.filter||c.filter||"";c.filter=bn.test(g)?g.replace(bn,e):g+" "+e}}),f(function(){f.support.reliableMarginRight||(f.cssHooks.marginRight={get:function(a,b){var c;f.swap(a,{display:"inline-block"},function(){b?c=bx(a,"margin-right","marginRight"):c=a.style.marginRight});return c}})}),c.defaultView&&c.defaultView.getComputedStyle&&(by=function(a,c){var d,e,g;c=c.replace(bp,"-$1").toLowerCase();if(!(e=a.ownerDocument.defaultView))return b;if(g=e.getComputedStyle(a,null))d=g.getPropertyValue(c),d===""&&!f.contains(a.ownerDocument.documentElement,a)&&(d=f.style(a,c));return d}),c.documentElement.currentStyle&&(bz=function(a,b){var c,d=a.currentStyle&&a.currentStyle[b],e=a.runtimeStyle&&a.runtimeStyle[b],f=a.style;!bq.test(d)&&br.test(d)&&(c=f.left,e&&(a.runtimeStyle.left=a.currentStyle.left),f.left=b==="fontSize"?"1em":d||0,d=f.pixelLeft+"px",f.left=c,e&&(a.runtimeStyle.left=e));return d===""?"auto":d}),bx=by||bz,f.expr&&f.expr.filters&&(f.expr.filters.hidden=function(a){var b=a.offsetWidth,c=a.offsetHeight;return b===0&&c===0||!f.support.reliableHiddenOffsets&&(a.style.display||f.css(a,"display"))==="none"},f.expr.filters.visible=function(a){return!f.expr.filters.hidden(a)});var bB=/%20/g,bC=/\[\]$/,bD=/\r?\n/g,bE=/#.*$/,bF=/^(.*?):[ \t]*([^\r\n]*)\r?$/mg,bG=/^(?:color|date|datetime|email|hidden|month|number|password|range|search|tel|text|time|url|week)$/i,bH=/^(?:about|app|app\-storage|.+\-extension|file|widget):$/,bI=/^(?:GET|HEAD)$/,bJ=/^\/\//,bK=/\?/,bL=/<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi,bM=/^(?:select|textarea)/i,bN=/\s+/,bO=/([?&])_=[^&]*/,bP=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,bQ=f.fn.load,bR={},bS={},bT,bU;try{bT=e.href}catch(bV){bT=c.createElement("a"),bT.href="",bT=bT.href}bU=bP.exec(bT.toLowerCase())||[],f.fn.extend({load:function(a,c,d){if(typeof a!="string"&&bQ)return bQ.apply(this,arguments);if(!this.length)return this;var e=a.indexOf(" ");if(e>=0){var g=a.slice(e,a.length);a=a.slice(0,e)}var h="GET";c&&(f.isFunction(c)?(d=c,c=b):typeof c=="object"&&(c=f.param(c,f.ajaxSettings.traditional),h="POST"));var i=this;f.ajax({url:a,type:h,dataType:"html",data:c,complete:function(a,b,c){c=a.responseText,a.isResolved()&&(a.done(function(a){c=a}),i.html(g?f("<div>").append(c.replace(bL,"")).find(g):c)),d&&i.each(d,[c,b,a])}});return this},serialize:function(){return f.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?f.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||bM.test(this.nodeName)||bG.test(this.type))}).map(function(a,b){var c=f(this).val();return c==null?null:f.isArray(c)?f.map(c,function(a,c){return{name:b.name,value:a.replace(bD,"\r\n")}}):{name:b.name,value:c.replace(bD,"\r\n")}}).get()}}),f.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(a,b){f.fn[b]=function(a){return this.bind(b,a)}}),f.each(["get","post"],function(a,c){f[c]=function(a,d,e,g){f.isFunction(d)&&(g=g||e,e=d,d=b);return f.ajax({type:c,url:a,data:d,success:e,dataType:g})}}),f.extend({getScript:function(a,c){return f.get(a,b,c,"script")},getJSON:function(a,b,c){return f.get(a,b,c,"json")},ajaxSetup:function(a,b){b?f.extend(!0,a,f.ajaxSettings,b):(b=a,a=f.extend(!0,f.ajaxSettings,b));for(var c in{context:1,url:1})c in b?a[c]=b[c]:c in f.ajaxSettings&&(a[c]=f.ajaxSettings[c]);return a},ajaxSettings:{url:bT,isLocal:bH.test(bU[1]),global:!0,type:"GET",contentType:"application/x-www-form-urlencoded",processData:!0,async:!0,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":"*/*"},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":a.String,"text html":!0,"text json":f.parseJSON,"text xml":f.parseXML}},ajaxPrefilter:bW(bR),ajaxTransport:bW(bS),ajax:function(a,c){function w(a,c,l,m){if(s!==2){s=2,q&&clearTimeout(q),p=b,n=m||"",v.readyState=a?4:0;var o,r,u,w=l?bZ(d,v,l):b,x,y;if(a>=200&&a<300||a===304){if(d.ifModified){if(x=v.getResponseHeader("Last-Modified"))f.lastModified[k]=x;if(y=v.getResponseHeader("Etag"))f.etag[k]=y}if(a===304)c="notmodified",o=!0;else try{r=b$(d,w),c="success",o=!0}catch(z){c="parsererror",u=z}}else{u=c;if(!c||a)c="error",a<0&&(a=0)}v.status=a,v.statusText=c,o?h.resolveWith(e,[r,c,v]):h.rejectWith(e,[v,c,u]),v.statusCode(j),j=b,t&&g.trigger("ajax"+(o?"Success":"Error"),[v,d,o?r:u]),i.resolveWith(e,[v,c]),t&&(g.trigger("ajaxComplete",[v,d]),--f.active||f.event.trigger("ajaxStop"))}}typeof a=="object"&&(c=a,a=b),c=c||{};var d=f.ajaxSetup({},c),e=d.context||d,g=e!==d&&(e.nodeType||e instanceof f)?f(e):f.event,h=f.Deferred(),i=f._Deferred(),j=d.statusCode||{},k,l={},m={},n,o,p,q,r,s=0,t,u,v={readyState:0,setRequestHeader:function(a,b){if(!s){var c=a.toLowerCase();a=m[c]=m[c]||a,l[a]=b}return this},getAllResponseHeaders:function(){return s===2?n:null},getResponseHeader:function(a){var c;if(s===2){if(!o){o={};while(c=bF.exec(n))o[c[1].toLowerCase()]=c[2]}c=o[a.toLowerCase()]}return c===b?null:c},overrideMimeType:function(a){s||(d.mimeType=a);return this},abort:function(a){a=a||"abort",p&&p.abort(a),w(0,a);return this}};h.promise(v),v.success=v.done,v.error=v.fail,v.complete=i.done,v.statusCode=function(a){if(a){var b;if(s<2)for(b in a)j[b]=[j[b],a[b]];else b=a[v.status],v.then(b,b)}return this},d.url=((a||d.url)+"").replace(bE,"").replace(bJ,bU[1]+"//"),d.dataTypes=f.trim(d.dataType||"*").toLowerCase().split(bN),d.crossDomain==null&&(r=bP.exec(d.url.toLowerCase()),d.crossDomain=!(!r||r[1]==bU[1]&&r[2]==bU[2]&&(r[3]||(r[1]==="http:"?80:443))==(bU[3]||(bU[1]==="http:"?80:443)))),d.data&&d.processData&&typeof d.data!="string"&&(d.data=f.param(d.data,d.traditional)),bX(bR,d,c,v);if(s===2)return!1;t=d.global,d.type=d.type.toUpperCase(),d.hasContent=!bI.test(d.type),t&&f.active++===0&&f.event.trigger("ajaxStart");if(!d.hasContent){d.data&&(d.url+=(bK.test(d.url)?"&":"?")+d.data),k=d.url;if(d.cache===!1){var x=f.now(),y=d.url.replace(bO,"$1_="+x);d.url=y+(y===d.url?(bK.test(d.url)?"&":"?")+"_="+x:"")}}(d.data&&d.hasContent&&d.contentType!==!1||c.contentType)&&v.setRequestHeader("Content-Type",d.contentType),d.ifModified&&(k=k||d.url,f.lastModified[k]&&v.setRequestHeader("If-Modified-Since",f.lastModified[k]),f.etag[k]&&v.setRequestHeader("If-None-Match",f.etag[k])),v.setRequestHeader("Accept",d.dataTypes[0]&&d.accepts[d.dataTypes[0]]?d.accepts[d.dataTypes[0]]+(d.dataTypes[0]!=="*"?", */*; q=0.01":""):d.accepts["*"]);for(u in d.headers)v.setRequestHeader(u,d.headers[u]);if(d.beforeSend&&(d.beforeSend.call(e,v,d)===!1||s===2)){v.abort();return!1}for(u in{success:1,error:1,complete:1})v[u](d[u]);p=bX(bS,d,c,v);if(!p)w(-1,"No Transport");else{v.readyState=1,t&&g.trigger("ajaxSend",[v,d]),d.async&&d.timeout>0&&(q=setTimeout(function(){v.abort("timeout")},d.timeout));try{s=1,p.send(l,w)}catch(z){status<2?w(-1,z):f.error(z)}}return v},param:function(a,c){var d=[],e=function(a,b){b=f.isFunction(b)?b():b,d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(b)};c===b&&(c=f.ajaxSettings.traditional);if(f.isArray(a)||a.jquery&&!f.isPlainObject(a))f.each(a,function(){e(this.name,this.value)});else for(var g in a)bY(g,a[g],c,e);return d.join("&").replace(bB,"+")}}),f.extend({active:0,lastModified:{},etag:{}});var b_=f.now(),ca=/(\=)\?(&|$)|\?\?/i;f.ajaxSetup({jsonp:"callback",jsonpCallback:function(){return f.expando+"_"+b_++}}),f.ajaxPrefilter("json jsonp",function(b,c,d){var e=b.contentType==="application/x-www-form-urlencoded"&&typeof b.data=="string";if(b.dataTypes[0]==="jsonp"||b.jsonp!==!1&&(ca.test(b.url)||e&&ca.test(b.data))){var g,h=b.jsonpCallback=f.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,i=a[h],j=b.url,k=b.data,l="$1"+h+"$2";b.jsonp!==!1&&(j=j.replace(ca,l),b.url===j&&(e&&(k=k.replace(ca,l)),b.data===k&&(j+=(/\?/.test(j)?"&":"?")+b.jsonp+"="+h))),b.url=j,b.data=k,a[h]=function(a){g=[a]},d.always(function(){a[h]=i,g&&f.isFunction(i)&&a[h](g[0])}),b.converters["script json"]=function(){g||f.error(h+" was not called");return g[0]},b.dataTypes[0]="json";return"script"}}),f.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/javascript|ecmascript/},converters:{"text script":function(a){f.globalEval(a);return a}}}),f.ajaxPrefilter("script",function(a){a.cache===b&&(a.cache=!1),a.crossDomain&&(a.type="GET",a.global=!1)}),f.ajaxTransport("script",function(a){if(a.crossDomain){var d,e=c.head||c.getElementsByTagName("head")[0]||c.documentElement;return{send:function(f,g){d=c.createElement("script"),d.async="async",a.scriptCharset&&(d.charset=a.scriptCharset),d.src=a.url,d.onload=d.onreadystatechange=function(a,c){if(c||!d.readyState||/loaded|complete/.test(d.readyState))d.onload=d.onreadystatechange=null,e&&d.parentNode&&e.removeChild(d),d=b,c||g(200,"success")},e.insertBefore(d,e.firstChild)},abort:function(){d&&d.onload(0,1)}}}});var cb=a.ActiveXObject?function(){for(var a in cd)cd[a](0,1)}:!1,cc=0,cd;f.ajaxSettings.xhr=a.ActiveXObject?function(){return!this.isLocal&&ce()||cf()}:ce,function(a){f.extend(f.support,{ajax:!!a,cors:!!a&&"withCredentials"in a})}(f.ajaxSettings.xhr()),f.support.ajax&&f.ajaxTransport(function(c){if(!c.crossDomain||f.support.cors){var d;return{send:function(e,g){var h=c.xhr(),i,j;c.username?h.open(c.type,c.url,c.async,c.username,c.password):h.open(c.type,c.url,c.async);if(c.xhrFields)for(j in c.xhrFields)h[j]=c.xhrFields[j];c.mimeType&&h.overrideMimeType&&h.overrideMimeType(c.mimeType),!c.crossDomain&&!e["X-Requested-With"]&&(e["X-Requested-With"]="XMLHttpRequest");try{for(j in e)h.setRequestHeader(j,e[j])}catch(k){}h.send(c.hasContent&&c.data||null),d=function(a,e){var j,k,l,m,n;try{if(d&&(e||h.readyState===4)){d=b,i&&(h.onreadystatechange=f.noop,cb&&delete cd[i]);if(e)h.readyState!==4&&h.abort();else{j=h.status,l=h.getAllResponseHeaders(),m={},n=h.responseXML,n&&n.documentElement&&(m.xml=n),m.text=h.responseText;try{k=h.statusText}catch(o){k=""}!j&&c.isLocal&&!c.crossDomain?j=m.text?200:404:j===1223&&(j=204)}}}catch(p){e||g(-1,p)}m&&g(j,k,m,l)},!c.async||h.readyState===4?d():(i=++cc,cb&&(cd||(cd={},f(a).unload(cb)),cd[i]=d),h.onreadystatechange=d)},abort:function(){d&&d(0,1)}}}});var cg={},ch,ci,cj=/^(?:toggle|show|hide)$/,ck=/^([+\-]=)?([\d+.\-]+)([a-z%]*)$/i,cl,cm=[["height","marginTop","marginBottom","paddingTop","paddingBottom"],["width","marginLeft","marginRight","paddingLeft","paddingRight"],["opacity"]],cn,co=a.webkitRequestAnimationFrame||a.mozRequestAnimationFrame||a.oRequestAnimationFrame;f.fn.extend({show:function(a,b,c){var d,e;if(a||a===0)return this.animate(cr("show",3),a,b,c);for(var g=0,h=this.length;g<h;g++)d=this[g],d.style&&(e=d.style.display,!f._data(d,"olddisplay")&&e==="none"&&(e=d.style.display=""),e===""&&f.css(d,"display")==="none"&&f._data(d,"olddisplay",cs(d.nodeName)));for(g=0;g<h;g++){d=this[g];if(d.style){e=d.style.display;if(e===""||e==="none")d.style.display=f._data(d,"olddisplay")||""}}return this},hide:function(a,b,c){if(a||a===0)return this.animate(cr("hide",3),a,b,c);for(var d=0,e=this.length;d<e;d++)if(this[d].style){var g=f.css(this[d],"display");g!=="none"&&!f._data(this[d],"olddisplay")&&f._data(this[d],"olddisplay",g)}for(d=0;d<e;d++)this[d].style&&(this[d].style.display="none");return this},_toggle:f.fn.toggle,toggle:function(a,b,c){var d=typeof a=="boolean";f.isFunction(a)&&f.isFunction(b)?this._toggle.apply(this,arguments):a==null||d?this.each(function(){var b=d?a:f(this).is(":hidden");f(this)[b?"show":"hide"]()}):this.animate(cr("toggle",3),a,b,c);return this},fadeTo:function(a,b,c,d){return this.filter(":hidden").css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=f.speed(b,c,d);if(f.isEmptyObject(a))return this.each(e.complete,[!1]);a=f.extend({},a);return this[e.queue===!1?"each":"queue"](function(){e.queue===!1&&f._mark(this);var b=f.extend({},e),c=this.nodeType===1,d=c&&f(this).is(":hidden"),g,h,i,j,k,l,m,n,o;b.animatedProperties={};for(i in a){g=f.camelCase(i),i!==g&&(a[g]=a[i],delete a[i]),h=a[g],f.isArray(h)?(b.animatedProperties[g]=h[1],h=a[g]=h[0]):b.animatedProperties[g]=b.specialEasing&&b.specialEasing[g]||b.easing||"swing";if(h==="hide"&&d||h==="show"&&!d)return b.complete.call(this);c&&(g==="height"||g==="width")&&(b.overflow=[this.style.overflow,this.style.overflowX,this.style.overflowY],f.css(this,"display")==="inline"&&f.css(this,"float")==="none"&&(f.support.inlineBlockNeedsLayout?(j=cs(this.nodeName),j==="inline"?this.style.display="inline-block":(this.style.display="inline",this.style.zoom=1)):this.style.display="inline-block"))}b.overflow!=null&&(this.style.overflow="hidden");for(i in a)k=new f.fx(this,b,i),h=a[i],cj.test(h)?k[h==="toggle"?d?"show":"hide":h]():(l=ck.exec(h),m=k.cur(),l?(n=parseFloat(l[2]),o=l[3]||(f.cssNumber[i]?"":"px"),o!=="px"&&(f.style(this,i,(n||1)+o),m=(n||1)/k.cur()*m,f.style(this,i,m+o)),l[1]&&(n=(l[1]==="-="?-1:1)*n+m),k.custom(m,n,o)):k.custom(m,h,""));return!0})},stop:function(a,b){a&&this.queue([]),this.each(function(){var a=f.timers,c=a.length;b||f._unmark(!0,this);while(c--)a[c].elem===this&&(b&&a[c](!0),a.splice(c,1))}),b||this.dequeue();return this}}),f.each({slideDown:cr("show",1),slideUp:cr("hide",1),slideToggle:cr("toggle",1),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){f.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),f.extend({speed:function(a,b,c){var d=a&&typeof a=="object"?f.extend({},a):{complete:c||!c&&b||f.isFunction(a)&&a,duration:a,easing:c&&b||b&&!f.isFunction(b)&&b};d.duration=f.fx.off?0:typeof d.duration=="number"?d.duration:d.duration in f.fx.speeds?f.fx.speeds[d.duration]:f.fx.speeds._default,d.old=d.complete,d.complete=function(a){f.isFunction(d.old)&&d.old.call(this),d.queue!==!1?f.dequeue(this):a!==!1&&f._unmark(this)};return d},easing:{linear:function(a,b,c,d){return c+d*a},swing:function(a,b,c,d){return(-Math.cos(a*Math.PI)/2+.5)*d+c}},timers:[],fx:function(a,b,c){this.options=b,this.elem=a,this.prop=c,b.orig=b.orig||{}}}),f.fx.prototype={update:function(){this.options.step&&this.options.step.call(this.elem,this.now,this),(f.fx.step[this.prop]||f.fx.step._default)(this)},cur:function(){if(this.elem[this.prop]!=null&&(!this.elem.style||this.elem.style[this.prop]==null))return this.elem[this.prop];var a,b=f.css(this.elem,this.prop);return isNaN(a=parseFloat(b))?!b||b==="auto"?0:b:a},custom:function(a,b,c){function h(a){return d.step(a)}var d=this,e=f.fx,g;this.startTime=cn||cp(),this.start=a,this.end=b,this.unit=c||this.unit||(f.cssNumber[this.prop]?"":"px"),this.now=this.start,this.pos=this.state=0,h.elem=this.elem,h()&&f.timers.push(h)&&!cl&&(co?(cl=!0,g=function(){cl&&(co(g),e.tick())},co(g)):cl=setInterval(e.tick,e.interval))},show:function(){this.options.orig[this.prop]=f.style(this.elem,this.prop),this.options.show=!0,this.custom(this.prop==="width"||this.prop==="height"?1:0,this.cur()),f(this.elem).show()},hide:function(){this.options.orig[this.prop]=f.style(this.elem,this.prop),this.options.hide=!0,this.custom(this.cur(),0)},step:function(a){var b=cn||cp(),c=!0,d=this.elem,e=this.options,g,h;if(a||b>=e.duration+this.startTime){this.now=this.end,this.pos=this.state=1,this.update(),e.animatedProperties[this.prop]=!0;for(g in e.animatedProperties)e.animatedProperties[g]!==!0&&(c=!1);if(c){e.overflow!=null&&!f.support.shrinkWrapBlocks&&f.each(["","X","Y"],function(a,b){d.style["overflow"+b]=e.overflow[a]}),e.hide&&f(d).hide();if(e.hide||e.show)for(var i in e.animatedProperties)f.style(d,i,e.orig[i]);e.complete.call(d)}return!1}e.duration==Infinity?this.now=b:(h=b-this.startTime,this.state=h/e.duration,this.pos=f.easing[e.animatedProperties[this.prop]](this.state,h,0,1,e.duration),this.now=this.start+(this.end-this.start)*this.pos),this.update();return!0}},f.extend(f.fx,{tick:function(){for(var a=f.timers,b=0;b<a.length;++b)a[b]()||a.splice(b--,1);a.length||f.fx.stop()},interval:13,stop:function(){clearInterval(cl),cl=null},speeds:{slow:600,fast:200,_default:400},step:{opacity:function(a){f.style(a.elem,"opacity",a.now)},_default:function(a){a.elem.style&&a.elem.style[a.prop]!=null?a.elem.style[a.prop]=(a.prop==="width"||a.prop==="height"?Math.max(0,a.now):a.now)+a.unit:a.elem[a.prop]=a.now}}}),f.expr&&f.expr.filters&&(f.expr.filters.animated=function(a){return f.grep(f.timers,function(b){return a===b.elem}).length});var ct=/^t(?:able|d|h)$/i,cu=/^(?:body|html)$/i;"getBoundingClientRect"in c.documentElement?f.fn.offset=function(a){var b=this[0],c;if(a)return this.each(function(b){f.offset.setOffset(this,a,b)});if(!b||!b.ownerDocument)return null;if(b===b.ownerDocument.body)return f.offset.bodyOffset(b);try{c=b.getBoundingClientRect()}catch(d){}var e=b.ownerDocument,g=e.documentElement;if(!c||!f.contains(g,b))return c?{top:c.top,left:c.left}:{top:0,left:0};var h=e.body,i=cv(e),j=g.clientTop||h.clientTop||0,k=g.clientLeft||h.clientLeft||0,l=i.pageYOffset||f.support.boxModel&&g.scrollTop||h.scrollTop,m=i.pageXOffset||f.support.boxModel&&g.scrollLeft||h.scrollLeft,n=c.top+l-j,o=c.left+m-k;return{top:n,left:o}}:f.fn.offset=function(a){var b=this[0];if(a)return this.each(function(b){f.offset.setOffset(this,a,b)});if(!b||!b.ownerDocument)return null;if(b===b.ownerDocument.body)return f.offset.bodyOffset(b);f.offset.initialize();var c,d=b.offsetParent,e=b,g=b.ownerDocument,h=g.documentElement,i=g.body,j=g.defaultView,k=j?j.getComputedStyle(b,null):b.currentStyle,l=b.offsetTop,m=b.offsetLeft;while((b=b.parentNode)&&b!==i&&b!==h){if(f.offset.supportsFixedPosition&&k.position==="fixed")break;c=j?j.getComputedStyle(b,null):b.currentStyle,l-=b.scrollTop,m-=b.scrollLeft,b===d&&(l+=b.offsetTop,m+=b.offsetLeft,f.offset.doesNotAddBorder&&(!f.offset.doesAddBorderForTableAndCells||!ct.test(b.nodeName))&&(l+=parseFloat(c.borderTopWidth)||0,m+=parseFloat(c.borderLeftWidth)||0),e=d,d=b.offsetParent),f.offset.subtractsBorderForOverflowNotVisible&&c.overflow!=="visible"&&(l+=parseFloat(c.borderTopWidth)||0,m+=parseFloat(c.borderLeftWidth)||0),k=c}if(k.position==="relative"||k.position==="static")l+=i.offsetTop,m+=i.offsetLeft;f.offset.supportsFixedPosition&&k.position==="fixed"&&(l+=Math.max(h.scrollTop,i.scrollTop),m+=Math.max(h.scrollLeft,i.scrollLeft));return{top:l,left:m}},f.offset={initialize:function(){var a=c.body,b=c.createElement("div"),d,e,g,h,i=parseFloat(f.css(a,"marginTop"))||0,j="<div style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;'><div></div></div><table style='position:absolute;top:0;left:0;margin:0;border:5px solid #000;padding:0;width:1px;height:1px;' cellpadding='0' cellspacing='0'><tr><td></td></tr></table>";f.extend(b.style,{position:"absolute",top:0,left:0,margin:0,border:0,width:"1px",height:"1px",visibility:"hidden"}),b.innerHTML=j,a.insertBefore(b,a.firstChild),d=b.firstChild,e=d.firstChild,h=d.nextSibling.firstChild.firstChild,this.doesNotAddBorder=e.offsetTop!==5,this.doesAddBorderForTableAndCells=h.offsetTop===5,e.style.position="fixed",e.style.top="20px",this.supportsFixedPosition=e.offsetTop===20||e.offsetTop===15,e.style.position=e.style.top="",d.style.overflow="hidden",d.style.position="relative",this.subtractsBorderForOverflowNotVisible=e.offsetTop===-5,this.doesNotIncludeMarginInBodyOffset=a.offsetTop!==i,a.removeChild(b),f.offset.initialize=f.noop},bodyOffset:function(a){var b=a.offsetTop,c=a.offsetLeft;f.offset.initialize(),f.offset.doesNotIncludeMarginInBodyOffset&&(b+=parseFloat(f.css(a,"marginTop"))||0,c+=parseFloat(f.css(a,"marginLeft"))||0);return{top:b,left:c}},setOffset:function(a,b,c){var d=f.css(a,"position");d==="static"&&(a.style.position="relative");var e=f(a),g=e.offset(),h=f.css(a,"top"),i=f.css(a,"left"),j=(d==="absolute"||d==="fixed")&&f.inArray("auto",[h,i])>-1,k={},l={},m,n;j?(l=e.position(),m=l.top,n=l.left):(m=parseFloat(h)||0,n=parseFloat(i)||0),f.isFunction(b)&&(b=b.call(a,c,g)),b.top!=null&&(k.top=b.top-g.top+m),b.left!=null&&(k.left=b.left-g.left+n),"using"in b?b.using.call(a,k):e.css(k)}},f.fn.extend({position:function(){if(!this[0])return null;var a=this[0],b=this.offsetParent(),c=this.offset(),d=cu.test(b[0].nodeName)?{top:0,left:0}:b.offset();c.top-=parseFloat(f.css(a,"marginTop"))||0,c.left-=parseFloat(f.css(a,"marginLeft"))||0,d.top+=parseFloat(f.css(b[0],"borderTopWidth"))||0,d.left+=parseFloat(f.css(b[0],"borderLeftWidth"))||0;return{top:c.top-d.top,left:c.left-d.left}},offsetParent:function(){return this.map(function(){var a=this.offsetParent||c.body;while(a&&!cu.test(a.nodeName)&&f.css(a,"position")==="static")a=a.offsetParent;return a})}}),f.each(["Left","Top"],function(a,c){var d="scroll"+c;f.fn[d]=function(c){var e,g;if(c===b){e=this[0];if(!e)return null;g=cv(e);return g?"pageXOffset"in g?g[a?"pageYOffset":"pageXOffset"]:f.support.boxModel&&g.document.documentElement[d]||g.document.body[d]:e[d]}return this.each(function(){g=cv(this),g?g.scrollTo(a?f(g).scrollLeft():c,a?c:f(g).scrollTop()):this[d]=c})}}),f.each(["Height","Width"],function(a,c){var d=c.toLowerCase();f.fn["inner"+c]=function(){var a=this[0];return a&&a.style?parseFloat(f.css(a,d,"padding")):null},f.fn["outer"+c]=function(a){var b=this[0];return b&&b.style?parseFloat(f.css(b,d,a?"margin":"border")):null},f.fn[d]=function(a){var e=this[0];if(!e)return a==null?null:this;if(f.isFunction(a))return this.each(function(b){var c=f(this);c[d](a.call(this,b,c[d]()))});if(f.isWindow(e)){var g=e.document.documentElement["client"+c];return e.document.compatMode==="CSS1Compat"&&g||e.document.body["client"+c]||g}if(e.nodeType===9)return Math.max(e.documentElement["client"+c],e.body["scroll"+c],e.documentElement["scroll"+c],e.body["offset"+c],e.documentElement["offset"+c]);if(a===b){var h=f.css(e,d),i=parseFloat(h);return f.isNaN(i)?h:i}return this.css(d,typeof a=="string"?a:a+"px")}}),a.jQuery=a.$=f})(window);
\ No newline at end of file diff --git a/doc/app/js/navigation.js b/doc/app/js/navigation.js new file mode 100644 index 00000000000..e41268123ea --- /dev/null +++ b/doc/app/js/navigation.js @@ -0,0 +1,142 @@ +/* + * Navigation allows movement using the arrow keys through the search results. + * + * When using this library you will need to set scrollIntoView to the + * appropriate function for your layout. Use scrollInWindow if the container + * is not scrollable and scrollInElement if the container is a separate + * scrolling region. + */ +Navigation = new function() { + this.initNavigation = function() { + var _this = this; + + $(document).keydown(function(e) { + _this.onkeydown(e); + }).keyup(function(e) { + _this.onkeyup(e); + }); + + this.navigationActive = true; + } + + this.setNavigationActive = function(state) { + this.navigationActive = state; + this.clearMoveTimeout(); + } + + this.onkeyup = function(e) { + if (!this.navigationActive) return; + + switch(e.keyCode) { + case 37: //Event.KEY_LEFT: + case 38: //Event.KEY_UP: + case 39: //Event.KEY_RIGHT: + case 40: //Event.KEY_DOWN: + this.clearMoveTimeout(); + break; + } + } + + this.onkeydown = function(e) { + if (!this.navigationActive) return; + switch(e.keyCode) { + case 37: //Event.KEY_LEFT: + if (this.moveLeft()) e.preventDefault(); + break; + case 38: //Event.KEY_UP: + if (e.keyCode == 38 || e.ctrlKey) { + if (this.moveUp()) e.preventDefault(); + this.startMoveTimeout(false); + } + break; + case 39: //Event.KEY_RIGHT: + if (this.moveRight()) e.preventDefault(); + break; + case 40: //Event.KEY_DOWN: + if (e.keyCode == 40 || e.ctrlKey) { + if (this.moveDown()) e.preventDefault(); + this.startMoveTimeout(true); + } + break; + case 13: //Event.KEY_RETURN: + if (this.$current) + e.preventDefault(); + this.select(this.$current); + break; + } + if (e.ctrlKey && e.shiftKey) this.select(this.$current); + } + + this.clearMoveTimeout = function() { + clearTimeout(this.moveTimeout); + this.moveTimeout = null; + } + + this.startMoveTimeout = function(isDown) { + if (!$.browser.mozilla && !$.browser.opera) return; + if (this.moveTimeout) this.clearMoveTimeout(); + var _this = this; + + var go = function() { + if (!_this.moveTimeout) return; + _this[isDown ? 'moveDown' : 'moveUp'](); + _this.moveTimout = setTimeout(go, 100); + } + this.moveTimeout = setTimeout(go, 200); + } + + this.moveRight = function() { + } + + this.moveLeft = function() { + } + + this.move = function(isDown) { + } + + this.moveUp = function() { + return this.move(false); + } + + this.moveDown = function() { + return this.move(true); + } + + /* + * Scrolls to the given element in the scrollable element view. + */ + this.scrollInElement = function(element, view) { + var offset, viewHeight, viewScroll, height; + offset = element.offsetTop; + height = element.offsetHeight; + viewHeight = view.offsetHeight; + viewScroll = view.scrollTop; + + if (offset - viewScroll + height > viewHeight) { + view.scrollTop = offset - viewHeight + height; + } + if (offset < viewScroll) { + view.scrollTop = offset; + } + } + + /* + * Scrolls to the given element in the window. The second argument is + * ignored + */ + this.scrollInWindow = function(element, ignored) { + var offset, viewHeight, viewScroll, height; + offset = element.offsetTop; + height = element.offsetHeight; + viewHeight = window.innerHeight; + viewScroll = window.scrollY; + + if (offset - viewScroll + height > viewHeight) { + window.scrollTo(window.scrollX, offset - viewHeight + height); + } + if (offset < viewScroll) { + window.scrollTo(window.scrollX, offset); + } + } +} + diff --git a/doc/app/js/search.js b/doc/app/js/search.js new file mode 100644 index 00000000000..dbdfdcbc4cb --- /dev/null +++ b/doc/app/js/search.js @@ -0,0 +1,94 @@ +Search = function(data, input, result) { + this.data = data; + this.$input = $(input); + this.$result = $(result); + + this.$current = null; + this.$view = this.$result.parent(); + this.searcher = new Searcher(data.index); + this.init(); +} + +Search.prototype = $.extend({}, Navigation, new function() { + var suid = 1; + + this.init = function() { + var _this = this; + var observer = function() { + _this.search(_this.$input[0].value); + }; + this.$input.keyup(observer); + this.$input.click(observer); // mac's clear field + + this.searcher.ready(function(results, isLast) { + _this.addResults(results, isLast); + }) + + this.initNavigation(); + this.setNavigationActive(false); + } + + this.search = function(value, selectFirstMatch) { + value = jQuery.trim(value).toLowerCase(); + if (value) { + this.setNavigationActive(true); + } else { + this.setNavigationActive(false); + } + + if (value == '') { + this.lastQuery = value; + this.$result.empty(); + this.setNavigationActive(false); + } else if (value != this.lastQuery) { + this.lastQuery = value; + this.firstRun = true; + this.searcher.find(value); + } + } + + this.addResults = function(results, isLast) { + var target = this.$result.get(0); + if (this.firstRun && (results.length > 0 || isLast)) { + this.$current = null; + this.$result.empty(); + } + + for (var i=0, l = results.length; i < l; i++) { + target.appendChild(this.renderItem.call(this, results[i])); + }; + + if (this.firstRun && results.length > 0) { + this.firstRun = false; + this.$current = $(target.firstChild); + this.$current.addClass('current'); + } + if (jQuery.browser.msie) this.$element[0].className += ''; + } + + this.move = function(isDown) { + if (!this.$current) return; + var $next = this.$current[isDown ? 'next' : 'prev'](); + if ($next.length) { + this.$current.removeClass('current'); + $next.addClass('current'); + this.scrollIntoView($next[0], this.$view[0]); + this.$current = $next; + } + return true; + } + + this.hlt = function(html) { + return this.escapeHTML(html). + replace(/\u0001/g, '<em>'). + replace(/\u0002/g, '</em>'); + } + + this.escapeHTML = function(html) { + return html.replace(/[&<>]/g, function(c) { + return '&#' + c.charCodeAt(0) + ';'; + }); + } + +}); + diff --git a/doc/app/js/search_index.js b/doc/app/js/search_index.js new file mode 100644 index 00000000000..ca255747c11 --- /dev/null +++ b/doc/app/js/search_index.js @@ -0,0 +1 @@ +var search_data = {"index":{"searchIndex":["ability","account","activityobserver","admin","dashboardcontroller","groupscontroller","hookscontroller","logscontroller","projectscontroller","resquecontroller","teammemberscontroller","userscontroller","admincontroller","applicationcontroller","applicationdecorator","applicationhelper","attachmentuploader","authority","basecontext","blamecontroller","blobcontroller","commit","commitcontroller","commitdecorator","commitloadcontext","commitscontroller","commitshelper","comparecontroller","dashboardcontroller","deploykeyscontroller","errorscontroller","event","eventdecorator","eventshelper","extractspath","invalidpatherror","filesizevalidator","helper","githost","gitlab","api","apihelpers","applogger","auth","encode","entities","hook","issue","milestone","project","projectmember","projectsnippet","repocommit","repoobject","sshkey","user","userbasic","userlogin","fileeditor","gitlogger","gitolite","accessdenied","gitoliteconfig","pullerror","pusherror","graphcommit","inlinediff","issues","logger","markdown","merge","milestones","projects","satellite","session","theme","users","gitlabmarkdownhelper","grack","auth","group","groupscontroller","helpcontroller","hookscontroller","issue","issuecommonality","classmethods","issueobserver","issuesbulkupdatecontext","issuescontroller","issueshelper","issueslistcontext","key","keyobserver","keyscontroller","labelscontroller","mergerequest","mergerequestobserver","mergerequestscontroller","mergerequestshelper","mergerequestsloadcontext","milestone","milestonescontroller","note","noteobserver","notes","createcontext","loadcontext","notescontroller","noteshelper","notify","omniauthcallbackscontroller","postreceive","profilecontroller","profilehelper","project","projecthook","projectobserver","projectresourcecontroller","projectscontroller","projectshelper","protectedbranch","protectedbranchescontroller","pushevent","pushobserver","redcarpet","render","gitlabhtml","refscontroller","repositoriescontroller","repository","searchcontext","searchcontroller","snippet","snippetscontroller","snippetshelper","staticmodel","classmethods","systemhook","systemhookobserver","systemhookworker","tabhelper","tagshelper","team","teammemberscontroller","testhookcontext","tree","treecontroller","treedecorator","treehelper","user","userobserver","usersproject","usersprojectobserver","votes","webhook","wiki","wikiscontroller","==()","[]()","_indexes_of_changed_lines()","abilities()","abilities()","abilities()","access_denied!()","access_options()","access_roles()","action_name()","active()","active()","add_access()","add_project_abilities()","add_refs()","add_user_id_to_team()","add_user_to_team()","add_users_ids_to_team()","add_users_to_team()","admin_all_repo()","admin_all_repo!()","after_commit()","after_create()","after_create()","after_create()","after_create()","after_create()","after_create()","after_create()","after_create()","after_destroy()","after_destroy()","after_destroy()","after_destroy()","after_destroy()","after_save()","after_save()","after_save()","after_sign_in_path_for()","after_update()","after_update()","all_hooks_fire()","allow_read_for?()","allowed()","allowed?()","allowed_tree_edit?()","app_theme()","apply()","apply_import()","archive()","archive_repo()","assign_ref_vars()","async_execute()","attributes_for_keys()","authbutton()","authenticate!()","authenticate_admin!()","authenticated_as_admin!()","author()","author_email()","author_link()","author_name()","authorize!()","authorize_admin_issue!()","authorize_admin_merge_request!()","authorize_admin_milestone!()","authorize_admin_snippet!()","authorize_code_access!()","authorize_modify_issue!()","authorize_modify_merge_request!()","authorize_modify_snippet!()","authorize_project!()","automerge()","automerge!()","automerge_check()","base_class()","block()","block()","block_code()","branch?()","branch_from()","branch_name()","branch_names()","branch_to()","branches()","branches()","branches_tab_class()","breadcrumbs()","broken_diffs?()","build()","build_commit_note()","build_line_anchor()","bulk_delete()","bulk_import()","bulk_update()","bulk_update()","can?()","can?()","can?()","can_be_merged?()","can_be_merged?()","can_create_group?()","can_create_project?()","can_edit?()","cared_merge_requests()","changed_issue?()","changed_merge_request?()","check_if_can_be_merged()","check_limit()","check_validity!()","clear()","closed?()","closed_event()","commit()","commit()","commit_author()","commit_from()","commit_line_notes()","commit_notes()","commit_to()","commits()","commits()","commits()","commits()","commits_between()","commits_between()","commits_count()","commits_since()","commits_since()","commits_with_refs()","commits_with_refs()","committer_email()","committer_name()","common_notes()","compare()","config()","content_types()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create()","create_by_user()","create_from_omniauth()","create_from_omniauth()","create_repository()","create_status_change_note()","created_at()","css_class_by_id()","current_action?()","current_controller?()","current_ref()","current_user()","data()","define_show_vars()","define_tree_vars()","delete_users_ids_from_team()","description()","design()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy()","destroy_project()","destroy_project!()","destroy_repository()","destroyed?()","detect_encoding()","determine_action()","dev_access_for?()","dev_tools()","different_committer?()","diffs()","diffs()","discover_default_branch()","downvote?()","downvotes()","downvotes_in_percent()","each_diff_line()","edit()","edit()","edit()","edit()","edit()","edit()","edit()","edit()","edit()","edit()","edit()","emoji_autocomplete_source()","empty?()","empty_repo?()","enable_automerge()","error()","event_action_name()","event_image()","execute()","execute()","execute()","execute()","execute()","execute()","execute()","execute()","execute()","execute_hooks()","exists?()","expired?()","expires_at()","extract_ref()","failure_message()","feed_summary()","feed_title()","feed_url()","file_name()","file_name()","files()","filter()","find_all_by_branch()","find_for_ldap_auth()","find_for_ldap_auth()","find_free_space()","find_or_first()","find_or_new_for_omniauth()","find_or_new_for_omniauth()","fingerprintable_key()","first_name()","for_commit?()","for_diff_line?()","forbidden!()","format_message()","format_message()","fresh_commits()","fresh_commits()","generate_password()","gfm()","git_error?()","git_host()","git_not_found!()","githost()","gitlab_auth()","gitlab_markdown?()","graph()","gravatar_icon()","group()","grouped_options_refs()","grouper_project_members()","guest_access_for?()","has_commits?()","has_post_receive_file?()","heads()","help()","hexdigest()","history()","history()","http_url_to_repo()","human_state()","identification_type()","identifier()","image_diff_class()","import_team()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index()","index_commits()","info()","invalid?()","is_admin?()","is_assigned?()","is_being_closed?()","is_being_reassigned?()","is_being_reopened?()","is_blob?()","is_deploy_key()","issue()","issue()","issue?()","issue_css_classes()","issue_status_changed_email()","issue_tags()","issues()","issues()","issues_filter()","issues_filtered()","issues_labels()","joined?()","last_activity()","last_activity_date()","last_activity_project()","last_commit()","last_commit()","last_commit()","last_commit_for()","last_deploy?()","last_push_to_non_root?()","ldap()","ldap_enable?()","left?()","lifetime_select_options()","link_title()","link_to_author()","link_to_commit_diff_line_note()","link_to_gfm()","link_to_issue_assignee()","link_to_issue_author()","link_to_merge_request_assignee()","link_to_merge_request_author()","link_to_project()","loading_more_notes?()","loading_new_notes?()","log()","log()","log_info()","log_info()","logs_tree()","mark_as_merged!()","mark_as_unchecked()","mark_as_unmergable()","mark_reserved()","markdown()","markup?()","master_access_for?()","md_ref?()","membership_changed?()","merge!()","merge!()","merge_event()","merge_request()","merge_request()","merge_request?()","merge_requests()","merge_requests()","merged?()","merged?()","method_missing()","method_missing()","milestone()","mode()","module_enabled()","module_enabled()","module_enabled()","module_enabled()","mr_and_commit_notes()","mr_css_classes()","name()","nav_link()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new()","new?()","new_branch?()","new_issue?()","new_issue_email()","new_merge_request?()","new_merge_request_email()","new_mr_path_from_push_event()","new_record?()","new_ref?()","new_user_email()","no_cache_headers()","no_commit_message()","not_allowed!()","not_found!()","not_found!()","note_commit_email()","note_for_main_target?()","note_issue_email()","note_merge_request_email()","note_wall_email()","note_wiki_email()","noteable()","notes()","notify_only_author?()","notify_team()","oauth_active_class()","observe_push()","open?()","open_branches()","open_for()","pages()","paginate()","parent_commit()","parents_count()","participants()","password_update()","path()","path_to_repo()","people()","percent_complete()","perform()","perform()","persisted?()","place_chain()","plain_text_readme?()","post_receive_data()","postprocess()","prev_commit()","prev_commit_id()","preview()","primary_key()","private?()","probably_merged?()","processing()","project()","project_abilities()","project_access_granted_email()","project_access_human()","project_id()","project_ids()","project_ids()","project_issues_filter_path()","project_last_activity()","project_name()","project_tab_class()","project_update()","projects()","projects()","projects_limit_percent()","projects_with_events()","protected_branch?()","public?()","push?()","push_action_name()","push_with_commits?()","raw()","raw()","read_latest()","readme()","reassigned_issue_email()","reassigned_merge_request_email()","recent_push()","ref()","ref_name()","ref_names()","ref_type()","regenerate_from()","reject_blocked!()","reload_code()","reloaded_commits()","reloaded_diffs()","remove_from_team_message()","remove_key()","remove_project()","remove_repository()","render_404()","render_api_error!()","render_tree()","reopened?()","replace_markers()","repo()","repo_access_human()","repo_exists?()","repo_name()","report_access_for?()","repository_masters()","repository_readers()","repository_writers()","request_protocol()","require_non_empty_project()","require_ssh_key?()","reset_access()","reset_private_token()","result()","rm_key()","rm_ref?()","role_access()","root_ref()","root_ref?()","safe_message()","satellite()","saved?()","search()","search()","search()","search()","search()","search()","search_autocomplete_source()","send_notify_mails()","send_reassigned_email()","send_reassigned_email()","set_current_user_for_observers()","set_identifier()","set_key()","set_slug()","short_id()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show()","show_last_push_widget?()","size()","snippet()","sort()","ssh_url_to_repo()","store_dir()","strip_white_space()","switch()","tag?()","tag_list()","tag_name()","tag_names()","tag_path()","tags()","tags()","take_left_leaves()","target_title()","team_member_by_id()","team_member_by_name_or_email()","team_update()","team_update()","team_without_note_author()","test()","test()","title()","to_graph()","to_graph_hash()","to_param()","to_param()","to_param()","to_param()","to_raw()","today?()","token()","tree()","tree_hex_class()","tree_icon()","tree_join()","trigger_post_receive()","unassigned_filter()","unauthorized!()","unblock()","unchecked?()","unique_key()","unmerged_commits()","unmerged_diffs()","up_dir?()","up_dir_path()","update()","update()","update()","update()","update()","update()","update()","update()","update()","update()","update()","update()","update()","update_merge_requests()","update_project()","update_project!()","update_project_config()","update_projects()","update_repository()","update_repository()","update_repository()","update_repository()","update_users_ids_to_role()","upvote?()","upvotes()","upvotes_in_percent()","url_to_repo()","url_to_repo()","user_bulk_import()","user_project()","users()","utf8()","valid?()","valid_diffs?()","valid_push?()","valid_repo?()","validate_branches()","validate_each()","validate_get_request()","validate_post_request()","validates_merge_request()","votes_count()","wall()","web_app_url()","web_url()","wiki_notes()","without_projects()","without_repository_callback()","write_key()","readme_for_app"],"longSearchIndex":["ability","account","activityobserver","admin","admin::dashboardcontroller","admin::groupscontroller","admin::hookscontroller","admin::logscontroller","admin::projectscontroller","admin::resquecontroller","admin::teammemberscontroller","admin::userscontroller","admincontroller","applicationcontroller","applicationdecorator","applicationhelper","attachmentuploader","authority","basecontext","blamecontroller","blobcontroller","commit","commitcontroller","commitdecorator","commitloadcontext","commitscontroller","commitshelper","comparecontroller","dashboardcontroller","deploykeyscontroller","errorscontroller","event","eventdecorator","eventshelper","extractspath","extractspath::invalidpatherror","filesizevalidator","filesizevalidator::helper","githost","gitlab","gitlab::api","gitlab::apihelpers","gitlab::applogger","gitlab::auth","gitlab::encode","gitlab::entities","gitlab::entities::hook","gitlab::entities::issue","gitlab::entities::milestone","gitlab::entities::project","gitlab::entities::projectmember","gitlab::entities::projectsnippet","gitlab::entities::repocommit","gitlab::entities::repoobject","gitlab::entities::sshkey","gitlab::entities::user","gitlab::entities::userbasic","gitlab::entities::userlogin","gitlab::fileeditor","gitlab::gitlogger","gitlab::gitolite","gitlab::gitolite::accessdenied","gitlab::gitoliteconfig","gitlab::gitoliteconfig::pullerror","gitlab::gitoliteconfig::pusherror","gitlab::graphcommit","gitlab::inlinediff","gitlab::issues","gitlab::logger","gitlab::markdown","gitlab::merge","gitlab::milestones","gitlab::projects","gitlab::satellite","gitlab::session","gitlab::theme","gitlab::users","gitlabmarkdownhelper","grack","grack::auth","group","groupscontroller","helpcontroller","hookscontroller","issue","issuecommonality","issuecommonality::classmethods","issueobserver","issuesbulkupdatecontext","issuescontroller","issueshelper","issueslistcontext","key","keyobserver","keyscontroller","labelscontroller","mergerequest","mergerequestobserver","mergerequestscontroller","mergerequestshelper","mergerequestsloadcontext","milestone","milestonescontroller","note","noteobserver","notes","notes::createcontext","notes::loadcontext","notescontroller","noteshelper","notify","omniauthcallbackscontroller","postreceive","profilecontroller","profilehelper","project","projecthook","projectobserver","projectresourcecontroller","projectscontroller","projectshelper","protectedbranch","protectedbranchescontroller","pushevent","pushobserver","redcarpet","redcarpet::render","redcarpet::render::gitlabhtml","refscontroller","repositoriescontroller","repository","searchcontext","searchcontroller","snippet","snippetscontroller","snippetshelper","staticmodel","staticmodel::classmethods","systemhook","systemhookobserver","systemhookworker","tabhelper","tagshelper","team","teammemberscontroller","testhookcontext","tree","treecontroller","treedecorator","treehelper","user","userobserver","usersproject","usersprojectobserver","votes","webhook","wiki","wikiscontroller","staticmodel#==()","staticmodel#[]()","gitlab::inlinediff::_indexes_of_changed_lines()","applicationcontroller#abilities()","basecontext#abilities()","grack::auth#abilities()","applicationcontroller#access_denied!()","project::access_options()","usersproject::access_roles()","event#action_name()","milestone::active()","project::active()","authority#add_access()","applicationcontroller#add_project_abilities()","gitlab::graphcommit#add_refs()","team#add_user_id_to_team()","team#add_user_to_team()","team#add_users_ids_to_team()","team#add_users_to_team()","gitlab::gitoliteconfig#admin_all_repo()","gitlab::gitoliteconfig#admin_all_repo!()","usersprojectobserver#after_commit()","activityobserver#after_create()","issueobserver#after_create()","mergerequestobserver#after_create()","noteobserver#after_create()","projectobserver#after_create()","systemhookobserver#after_create()","userobserver#after_create()","usersprojectobserver#after_create()","keyobserver#after_destroy()","projectobserver#after_destroy()","systemhookobserver#after_destroy()","userobserver#after_destroy()","usersprojectobserver#after_destroy()","activityobserver#after_save()","keyobserver#after_save()","projectobserver#after_save()","applicationcontroller#after_sign_in_path_for()","issueobserver#after_update()","mergerequestobserver#after_update()","systemhook::all_hooks_fire()","authority#allow_read_for?()","ability::allowed()","event#allowed?()","treehelper#allowed_tree_edit?()","applicationhelper#app_theme()","gitlab::gitoliteconfig#apply()","teammemberscontroller#apply_import()","repositoriescontroller#archive()","repository#archive_repo()","extractspath#assign_ref_vars()","systemhook#async_execute()","gitlab::apihelpers#attributes_for_keys()","applicationhelper#authbutton()","gitlab::apihelpers#authenticate!()","admincontroller#authenticate_admin!()","gitlab::apihelpers#authenticated_as_admin!()","event#author()","commit#author_email()","commitdecorator#author_link()","commit#author_name()","gitlab::apihelpers#authorize!()","issuescontroller#authorize_admin_issue!()","mergerequestscontroller#authorize_admin_merge_request!()","milestonescontroller#authorize_admin_milestone!()","snippetscontroller#authorize_admin_snippet!()","applicationcontroller#authorize_code_access!()","issuescontroller#authorize_modify_issue!()","mergerequestscontroller#authorize_modify_merge_request!()","snippetscontroller#authorize_modify_snippet!()","applicationcontroller#authorize_project!()","mergerequestscontroller#automerge()","mergerequest#automerge!()","mergerequestscontroller#automerge_check()","staticmodel::classmethods#base_class()","account#block()","admin::userscontroller#block()","redcarpet::render::gitlabhtml#block_code()","pushevent#branch?()","mergerequestscontroller#branch_from()","pushevent#branch_name()","repository#branch_names()","mergerequestscontroller#branch_to()","repositoriescontroller#branches()","repository#branches()","tabhelper#branches_tab_class()","treedecorator#breadcrumbs()","mergerequest#broken_diffs?()","gitlab::logger::build()","project#build_commit_note()","commitshelper#build_line_anchor()","usersproject::bulk_delete()","usersproject::bulk_import()","issuescontroller#bulk_update()","usersproject::bulk_update()","applicationcontroller#can?()","basecontext#can?()","grack::auth#can?()","gitlab::merge#can_be_merged?()","mergerequest#can_be_merged?()","account#can_create_group?()","account#can_create_project?()","gitlab::fileeditor#can_edit?()","account#cared_merge_requests()","event#changed_issue?()","event#changed_merge_request?()","mergerequest#check_if_can_be_merged()","project#check_limit()","filesizevalidator#check_validity!()","gitlab::satellite#clear()","event#closed?()","mergerequest#closed_event()","protectedbranch#commit()","repository#commit()","note#commit_author()","pushevent#commit_from()","project#commit_line_notes()","project#commit_notes()","pushevent#commit_to()","commit::commits()","mergerequest#commits()","pushevent#commits()","repository#commits()","commit::commits_between()","repository#commits_between()","pushevent#commits_count()","commit::commits_since()","repository#commits_since()","commit::commits_with_refs()","repository#commits_with_refs()","commit#committer_email()","commit#committer_name()","project#common_notes()","commit::compare()","gitlab::gitolite#config()","snippet::content_types()","admin::groupscontroller#create()","admin::hookscontroller#create()","admin::projectscontroller#create()","admin::userscontroller#create()","comparecontroller#create()","deploykeyscontroller#create()","gitlab::satellite#create()","hookscontroller#create()","issuescontroller#create()","keyscontroller#create()","mergerequestscontroller#create()","milestonescontroller#create()","notescontroller#create()","projectscontroller#create()","protectedbranchescontroller#create()","snippetscontroller#create()","teammemberscontroller#create()","wikiscontroller#create()","project::create_by_user()","gitlab::auth#create_from_omniauth()","user::create_from_omniauth()","gitlab::gitolite#create_repository()","note::create_status_change_note()","commit#created_at()","gitlab::theme::css_class_by_id()","applicationhelper#current_action?()","applicationhelper#current_controller?()","grack::auth#current_ref()","gitlab::apihelpers#current_user()","snippet#data()","mergerequestscontroller#define_show_vars()","refscontroller#define_tree_vars()","team#delete_users_ids_from_team()","commitdecorator#description()","profilecontroller#design()","admin::groupscontroller#destroy()","admin::hookscontroller#destroy()","admin::projectscontroller#destroy()","admin::teammemberscontroller#destroy()","admin::userscontroller#destroy()","deploykeyscontroller#destroy()","hookscontroller#destroy()","issuescontroller#destroy()","keyscontroller#destroy()","mergerequestscontroller#destroy()","milestonescontroller#destroy()","notescontroller#destroy()","projectscontroller#destroy()","protectedbranchescontroller#destroy()","snippetscontroller#destroy()","teammemberscontroller#destroy()","wikiscontroller#destroy()","gitlab::gitoliteconfig#destroy_project()","gitlab::gitoliteconfig#destroy_project!()","repository#destroy_repository()","staticmodel#destroyed?()","gitlab::encode#detect_encoding()","event::determine_action()","authority#dev_access_for?()","applicationcontroller#dev_tools()","commit#different_committer?()","mergerequest#diffs()","mergerequestscontroller#diffs()","repository#discover_default_branch()","note#downvote?()","votes#downvotes()","votes#downvotes_in_percent()","commitshelper#each_diff_line()","admin::groupscontroller#edit()","admin::projectscontroller#edit()","admin::teammemberscontroller#edit()","admin::userscontroller#edit()","issuescontroller#edit()","mergerequestscontroller#edit()","milestonescontroller#edit()","projectscontroller#edit()","snippetscontroller#edit()","treecontroller#edit()","wikiscontroller#edit()","applicationhelper#emoji_autocomplete_source()","tree#empty?()","repository#empty_repo?()","gitlab::gitolite#enable_automerge()","gitlab::logger::error()","eventshelper#event_action_name()","eventshelper#event_image()","commitloadcontext#execute()","issuesbulkupdatecontext#execute()","issueslistcontext#execute()","mergerequestsloadcontext#execute()","notes::createcontext#execute()","notes::loadcontext#execute()","searchcontext#execute()","testhookcontext#execute()","webhook#execute()","pushobserver#execute_hooks()","gitlab::satellite#exists?()","snippet#expired?()","milestone#expires_at()","extractspath#extract_ref()","omniauthcallbackscontroller#failure_message()","eventdecorator#feed_summary()","eventdecorator#feed_title()","eventdecorator#feed_url()","gitlab::applogger::file_name()","gitlab::gitlogger::file_name()","projectscontroller#files()","user::filter()","mergerequest::find_all_by_branch()","gitlab::auth#find_for_ldap_auth()","user::find_for_ldap_auth()","gitlab::graphcommit::find_free_space()","commit::find_or_first()","gitlab::auth#find_or_new_for_omniauth()","user::find_or_new_for_omniauth()","key#fingerprintable_key()","account#first_name()","note#for_commit?()","note#for_diff_line?()","gitlab::apihelpers#forbidden!()","gitlab::applogger#format_message()","gitlab::gitlogger#format_message()","commit::fresh_commits()","repository#fresh_commits()","user#generate_password()","gitlab::markdown#gfm()","project#git_error?()","githost#git_host()","applicationcontroller#git_not_found!()","errorscontroller#githost()","user::gitlab_auth()","treehelper#gitlab_markdown?()","projectscontroller#graph()","applicationhelper#gravatar_icon()","groupscontroller#group()","applicationhelper#grouped_options_refs()","projectshelper#grouper_project_members()","authority#guest_access_for?()","repository#has_commits?()","repository#has_post_receive_file?()","repository#heads()","filesizevalidator#help()","applicationhelper#hexdigest()","profilecontroller#history()","wikiscontroller#history()","repository#http_url_to_repo()","mergerequest#human_state()","commitshelper#identification_type()","account#identifier()","commitshelper#image_diff_class()","usersproject::import_team()","admin::dashboardcontroller#index()","admin::groupscontroller#index()","admin::hookscontroller#index()","admin::projectscontroller#index()","admin::userscontroller#index()","comparecontroller#index()","dashboardcontroller#index()","deploykeyscontroller#index()","helpcontroller#index()","hookscontroller#index()","issuescontroller#index()","keyscontroller#index()","labelscontroller#index()","mergerequestscontroller#index()","milestonescontroller#index()","notescontroller#index()","protectedbranchescontroller#index()","snippetscontroller#index()","teammemberscontroller#index()","gitlab::graphcommit::index_commits()","gitlab::logger::info()","tree#invalid?()","account#is_admin?()","issuecommonality#is_assigned?()","issuecommonality#is_being_closed?()","issuecommonality#is_being_reassigned?()","issuecommonality#is_being_reopened?()","tree#is_blob?()","key#is_deploy_key()","event#issue()","issuescontroller#issue()","event#issue?()","issueshelper#issue_css_classes()","notify#issue_status_changed_email()","issueshelper#issue_tags()","dashboardcontroller#issues()","groupscontroller#issues()","issueshelper#issues_filter()","issuescontroller#issues_filtered()","project#issues_labels()","event#joined?()","project#last_activity()","project#last_activity_date()","account#last_activity_project()","applicationhelper#last_commit()","mergerequest#last_commit()","pushevent#last_commit()","repository#last_commit_for()","key#last_deploy?()","pushevent#last_push_to_non_root?()","omniauthcallbackscontroller#ldap()","applicationhelper#ldap_enable?()","event#left?()","snippetshelper#lifetime_select_options()","commitdecorator#link_title()","eventshelper#link_to_author()","noteshelper#link_to_commit_diff_line_note()","gitlabmarkdownhelper#link_to_gfm()","issueshelper#link_to_issue_assignee()","issueshelper#link_to_issue_author()","mergerequestshelper#link_to_merge_request_assignee()","mergerequestshelper#link_to_merge_request_author()","projectshelper#link_to_project()","noteshelper#loading_more_notes?()","noteshelper#loading_new_notes?()","gitlab::auth#log()","gitlab::gitoliteconfig#log()","projectobserver#log_info()","userobserver#log_info()","refscontroller#logs_tree()","mergerequest#mark_as_merged!()","mergerequest#mark_as_unchecked()","mergerequest#mark_as_unmergable()","gitlab::graphcommit::mark_reserved()","gitlabmarkdownhelper#markdown()","treehelper#markup?()","authority#master_access_for?()","pushevent#md_ref?()","event#membership_changed?()","gitlab::merge#merge!()","mergerequest#merge!()","mergerequest#merge_event()","event#merge_request()","mergerequestscontroller#merge_request()","event#merge_request?()","dashboardcontroller#merge_requests()","groupscontroller#merge_requests()","event#merged?()","mergerequest#merged?()","applicationcontroller#method_missing()","gitlab::graphcommit#method_missing()","milestonescontroller#milestone()","snippet#mode()","issuescontroller#module_enabled()","labelscontroller#module_enabled()","mergerequestscontroller#module_enabled()","milestonescontroller#module_enabled()","mergerequest#mr_and_commit_notes()","mergerequestshelper#mr_css_classes()","snippet#name()","tabhelper#nav_link()","admin::groupscontroller#new()","admin::projectscontroller#new()","admin::userscontroller#new()","basecontext::new()","commit::new()","deploykeyscontroller#new()","filesizevalidator::new()","gitlab::fileeditor::new()","gitlab::graphcommit::new()","gitlab::merge::new()","gitlab::satellite::new()","issuescontroller#new()","keyscontroller#new()","mergerequestscontroller#new()","milestonescontroller#new()","projectscontroller#new()","redcarpet::render::gitlabhtml::new()","searchcontext::new()","snippetscontroller#new()","teammemberscontroller#new()","tree::new()","issuecommonality#new?()","pushevent#new_branch?()","event#new_issue?()","notify#new_issue_email()","event#new_merge_request?()","notify#new_merge_request_email()","mergerequestshelper#new_mr_path_from_push_event()","staticmodel#new_record?()","pushevent#new_ref?()","notify#new_user_email()","applicationcontroller#no_cache_headers()","commitdecorator#no_commit_message()","gitlab::apihelpers#not_allowed!()","applicationcontroller#not_found!()","gitlab::apihelpers#not_found!()","notify#note_commit_email()","noteshelper#note_for_main_target?()","notify#note_issue_email()","notify#note_merge_request_email()","notify#note_wall_email()","notify#note_wiki_email()","note#noteable()","notescontroller#notes()","note#notify_only_author?()","noteobserver#notify_team()","profilehelper#oauth_active_class()","pushobserver#observe_push()","mergerequest#open?()","repository#open_branches()","issue::open_for()","wikiscontroller#pages()","gitlab::apihelpers#paginate()","pushevent#parent_commit()","commit#parents_count()","milestone#participants()","profilecontroller#password_update()","gitlab::satellite#path()","repository#path_to_repo()","groupscontroller#people()","milestone#percent_complete()","postreceive::perform()","systemhookworker::perform()","staticmodel#persisted?()","gitlab::graphcommit::place_chain()","treehelper#plain_text_readme?()","pushobserver#post_receive_data()","redcarpet::render::gitlabhtml#postprocess()","commit#prev_commit()","commit#prev_commit_id()","notescontroller#preview()","staticmodel::classmethods#primary_key()","project#private?()","mergerequest#probably_merged?()","gitlab::inlinediff::processing()","applicationcontroller#project()","ability::project_abilities()","notify#project_access_granted_email()","usersproject#project_access_human()","project#project_id()","account#project_ids()","groupscontroller#project_ids()","issueshelper#project_issues_filter_path()","applicationhelper#project_last_activity()","event#project_name()","tabhelper#project_tab_class()","admin::groupscontroller#project_update()","groupscontroller#projects()","key#projects()","account#projects_limit_percent()","account#projects_with_events()","repository#protected_branch?()","project#public?()","event#push?()","pushevent#push_action_name()","pushevent#push_with_commits?()","mergerequestscontroller#raw()","snippetscontroller#raw()","gitlab::logger::read_latest()","treedecorator#readme()","notify#reassigned_issue_email()","notify#reassigned_merge_request_email()","account#recent_push()","refscontroller#ref()","pushevent#ref_name()","repository#ref_names()","pushevent#ref_type()","wiki::regenerate_from()","applicationcontroller#reject_blocked!()","mergerequest#reload_code()","mergerequest#reloaded_commits()","mergerequest#reloaded_diffs()","projectshelper#remove_from_team_message()","gitlab::gitolite#remove_key()","admin::groupscontroller#remove_project()","gitlab::gitolite#remove_repository()","applicationcontroller#render_404()","gitlab::apihelpers#render_api_error!()","treehelper#render_tree()","event#reopened?()","gitlab::inlinediff::replace_markers()","repository#repo()","usersproject#repo_access_human()","repository#repo_exists?()","project#repo_name()","authority#report_access_for?()","authority#repository_masters()","authority#repository_readers()","authority#repository_writers()","applicationhelper#request_protocol()","applicationcontroller#require_non_empty_project()","account#require_ssh_key?()","authority#reset_access()","profilecontroller#reset_private_token()","searchcontext#result()","gitlab::gitoliteconfig#rm_key()","pushevent#rm_ref?()","usersproject#role_access()","repository#root_ref()","repository#root_ref?()","commit#safe_message()","repository#satellite()","project#saved?()","group::search()","groupscontroller#search()","issuecommonality::classmethods#search()","issuescontroller#search()","project::search()","user::search()","applicationhelper#search_autocomplete_source()","noteobserver#send_notify_mails()","issueobserver#send_reassigned_email()","mergerequestobserver#send_reassigned_email()","applicationcontroller#set_current_user_for_observers()","key#set_identifier()","gitlab::gitolite#set_key()","wiki#set_slug()","commit#short_id()","admin::groupscontroller#show()","admin::projectscontroller#show()","admin::resquecontroller#show()","admin::userscontroller#show()","blamecontroller#show()","blobcontroller#show()","commitcontroller#show()","commitscontroller#show()","comparecontroller#show()","deploykeyscontroller#show()","groupscontroller#show()","issuescontroller#show()","keyscontroller#show()","mergerequestscontroller#show()","milestonescontroller#show()","profilecontroller#show()","projectscontroller#show()","repositoriescontroller#show()","searchcontroller#show()","snippetscontroller#show()","teammemberscontroller#show()","treecontroller#show()","wikiscontroller#show()","applicationhelper#show_last_push_widget?()","snippet#size()","snippetscontroller#snippet()","issuescontroller#sort()","repository#ssh_url_to_repo()","attachmentuploader#store_dir()","key#strip_white_space()","refscontroller#switch()","pushevent#tag?()","tagshelper#tag_list()","pushevent#tag_name()","repository#tag_names()","tagshelper#tag_path()","repositoriescontroller#tags()","repository#tags()","gitlab::graphcommit::take_left_leaves()","event#target_title()","team#team_member_by_id()","team#team_member_by_name_or_email()","admin::projectscontroller#team_update()","admin::userscontroller#team_update()","noteobserver#team_without_note_author()","admin::hookscontroller#test()","hookscontroller#test()","commitdecorator#title()","gitlab::graphcommit::to_graph()","gitlab::graphcommit#to_graph_hash()","group#to_param()","project#to_param()","staticmodel#to_param()","wiki#to_param()","mergerequest#to_raw()","issuecommonality#today?()","profilecontroller#token()","repository#tree()","treehelper#tree_hex_class()","treehelper#tree_icon()","treehelper#tree_join()","pushobserver#trigger_post_receive()","issueshelper#unassigned_filter()","gitlab::apihelpers#unauthorized!()","admin::userscontroller#unblock()","mergerequest#unchecked?()","key#unique_key()","mergerequest#unmerged_commits()","mergerequest#unmerged_diffs()","treedecorator#up_dir?()","treedecorator#up_dir_path()","admin::groupscontroller#update()","admin::projectscontroller#update()","admin::teammemberscontroller#update()","admin::userscontroller#update()","gitlab::fileeditor#update()","issuescontroller#update()","mergerequestscontroller#update()","milestonescontroller#update()","profilecontroller#update()","projectscontroller#update()","snippetscontroller#update()","teammemberscontroller#update()","treecontroller#update()","pushobserver#update_merge_requests()","gitlab::gitoliteconfig#update_project()","gitlab::gitoliteconfig#update_project!()","gitlab::gitoliteconfig#update_project_config()","gitlab::gitoliteconfig#update_projects()","gitlab::gitolite#update_repository()","protectedbranch#update_repository()","repository#update_repository()","usersproject#update_repository()","team#update_users_ids_to_role()","note#upvote?()","votes#upvotes()","votes#upvotes_in_percent()","gitlab::gitolite#url_to_repo()","repository#url_to_repo()","usersproject::user_bulk_import()","gitlab::apihelpers#user_project()","group#users()","gitlab::encode#utf8()","grack::auth#valid?()","mergerequest#valid_diffs?()","pushevent#valid_push?()","repository#valid_repo?()","mergerequest#validate_branches()","filesizevalidator#validate_each()","grack::auth#validate_get_request()","grack::auth#validate_post_request()","mergerequestscontroller#validates_merge_request()","votes#votes_count()","projectscontroller#wall()","applicationhelper#web_app_url()","project#web_url()","project#wiki_notes()","user::without_projects()","usersproject::without_repository_callback()","gitlab::gitoliteconfig#write_key()",""],"info":[["Ability","","Ability.html","",""],["Account","","Account.html","",""],["ActivityObserver","","ActivityObserver.html","",""],["Admin","","Admin.html","",""],["Admin::DashboardController","","Admin/DashboardController.html","",""],["Admin::GroupsController","","Admin/GroupsController.html","",""],["Admin::HooksController","","Admin/HooksController.html","",""],["Admin::LogsController","","Admin/LogsController.html","",""],["Admin::ProjectsController","","Admin/ProjectsController.html","",""],["Admin::ResqueController","","Admin/ResqueController.html","",""],["Admin::TeamMembersController","","Admin/TeamMembersController.html","",""],["Admin::UsersController","","Admin/UsersController.html","",""],["AdminController","","AdminController.html","","<p>Provides a base class for Admin controllers to subclass\n<p>Automatically sets the layout and ensures an administrator …\n"],["ApplicationController","","ApplicationController.html","",""],["ApplicationDecorator","","ApplicationDecorator.html","",""],["ApplicationHelper","","ApplicationHelper.html","",""],["AttachmentUploader","","AttachmentUploader.html","",""],["Authority","","Authority.html","",""],["BaseContext","","BaseContext.html","",""],["BlameController","","BlameController.html","","<p>Controller for viewing a file’s blame\n"],["BlobController","","BlobController.html","","<p>Controller for viewing a file’s blame\n"],["Commit","","Commit.html","",""],["CommitController","","CommitController.html","","<p>Controller for a specific Commit\n<p>Not to be confused with CommitsController, plural.\n"],["CommitDecorator","","CommitDecorator.html","",""],["CommitLoadContext","","CommitLoadContext.html","",""],["CommitsController","","CommitsController.html","",""],["CommitsHelper","","CommitsHelper.html","",""],["CompareController","","CompareController.html","",""],["DashboardController","","DashboardController.html","",""],["DeployKeysController","","DeployKeysController.html","",""],["ErrorsController","","ErrorsController.html","",""],["Event","","Event.html","",""],["EventDecorator","","EventDecorator.html","",""],["EventsHelper","","EventsHelper.html","",""],["ExtractsPath","","ExtractsPath.html","","<p>Module providing methods for dealing with separating a tree-ish string and\na file path string when combined …\n"],["ExtractsPath::InvalidPathError","","ExtractsPath/InvalidPathError.html","","<p>Raised when given an invalid file path\n"],["FileSizeValidator","","FileSizeValidator.html","",""],["FileSizeValidator::Helper","","FileSizeValidator/Helper.html","",""],["GitHost","","GitHost.html","",""],["Gitlab","","Gitlab.html","",""],["Gitlab::API","","Gitlab/API.html","",""],["Gitlab::APIHelpers","","Gitlab/APIHelpers.html","",""],["Gitlab::AppLogger","","Gitlab/AppLogger.html","",""],["Gitlab::Auth","","Gitlab/Auth.html","",""],["Gitlab::Encode","","Gitlab/Encode.html","",""],["Gitlab::Entities","","Gitlab/Entities.html","",""],["Gitlab::Entities::Hook","","Gitlab/Entities/Hook.html","",""],["Gitlab::Entities::Issue","","Gitlab/Entities/Issue.html","",""],["Gitlab::Entities::Milestone","","Gitlab/Entities/Milestone.html","",""],["Gitlab::Entities::Project","","Gitlab/Entities/Project.html","",""],["Gitlab::Entities::ProjectMember","","Gitlab/Entities/ProjectMember.html","",""],["Gitlab::Entities::ProjectSnippet","","Gitlab/Entities/ProjectSnippet.html","",""],["Gitlab::Entities::RepoCommit","","Gitlab/Entities/RepoCommit.html","",""],["Gitlab::Entities::RepoObject","","Gitlab/Entities/RepoObject.html","",""],["Gitlab::Entities::SSHKey","","Gitlab/Entities/SSHKey.html","",""],["Gitlab::Entities::User","","Gitlab/Entities/User.html","",""],["Gitlab::Entities::UserBasic","","Gitlab/Entities/UserBasic.html","",""],["Gitlab::Entities::UserLogin","","Gitlab/Entities/UserLogin.html","",""],["Gitlab::FileEditor","","Gitlab/FileEditor.html","","<p>GitLab file editor\n<p>It gives you ability to make changes to files & commit this changes\nfrom GitLab …\n"],["Gitlab::GitLogger","","Gitlab/GitLogger.html","",""],["Gitlab::Gitolite","","Gitlab/Gitolite.html","",""],["Gitlab::Gitolite::AccessDenied","","Gitlab/Gitolite/AccessDenied.html","",""],["Gitlab::GitoliteConfig","","Gitlab/GitoliteConfig.html","",""],["Gitlab::GitoliteConfig::PullError","","Gitlab/GitoliteConfig/PullError.html","",""],["Gitlab::GitoliteConfig::PushError","","Gitlab/GitoliteConfig/PushError.html","",""],["Gitlab::GraphCommit","","Gitlab/GraphCommit.html","",""],["Gitlab::InlineDiff","","Gitlab/InlineDiff.html","",""],["Gitlab::Issues","","Gitlab/Issues.html","","<p>Issues API\n"],["Gitlab::Logger","","Gitlab/Logger.html","",""],["Gitlab::Markdown","","Gitlab/Markdown.html","","<p>Custom parser for GitLab-flavored Markdown\n<p>It replaces references in the text with links to the appropriate …\n"],["Gitlab::Merge","","Gitlab/Merge.html","",""],["Gitlab::Milestones","","Gitlab/Milestones.html","","<p>Milestones API\n"],["Gitlab::Projects","","Gitlab/Projects.html","","<p>Projects API\n"],["Gitlab::Satellite","","Gitlab/Satellite.html","",""],["Gitlab::Session","","Gitlab/Session.html","","<p>Users API\n"],["Gitlab::Theme","","Gitlab/Theme.html","",""],["Gitlab::Users","","Gitlab/Users.html","","<p>Users API\n"],["GitlabMarkdownHelper","","GitlabMarkdownHelper.html","",""],["Grack","","Grack.html","",""],["Grack::Auth","","Grack/Auth.html","",""],["Group","","Group.html","",""],["GroupsController","","GroupsController.html","",""],["HelpController","","HelpController.html","",""],["HooksController","","HooksController.html","",""],["Issue","","Issue.html","",""],["IssueCommonality","","IssueCommonality.html","","<p>Contains common functionality shared between Issues and MergeRequests\n"],["IssueCommonality::ClassMethods","","IssueCommonality/ClassMethods.html","",""],["IssueObserver","","IssueObserver.html","",""],["IssuesBulkUpdateContext","","IssuesBulkUpdateContext.html","",""],["IssuesController","","IssuesController.html","",""],["IssuesHelper","","IssuesHelper.html","",""],["IssuesListContext","","IssuesListContext.html","",""],["Key","","Key.html","",""],["KeyObserver","","KeyObserver.html","",""],["KeysController","","KeysController.html","",""],["LabelsController","","LabelsController.html","",""],["MergeRequest","","MergeRequest.html","",""],["MergeRequestObserver","","MergeRequestObserver.html","",""],["MergeRequestsController","","MergeRequestsController.html","",""],["MergeRequestsHelper","","MergeRequestsHelper.html","",""],["MergeRequestsLoadContext","","MergeRequestsLoadContext.html","",""],["Milestone","","Milestone.html","",""],["MilestonesController","","MilestonesController.html","",""],["Note","","Note.html","",""],["NoteObserver","","NoteObserver.html","",""],["Notes","","Notes.html","",""],["Notes::CreateContext","","Notes/CreateContext.html","",""],["Notes::LoadContext","","Notes/LoadContext.html","",""],["NotesController","","NotesController.html","",""],["NotesHelper","","NotesHelper.html","",""],["Notify","","Notify.html","",""],["OmniauthCallbacksController","","OmniauthCallbacksController.html","",""],["PostReceive","","PostReceive.html","",""],["ProfileController","","ProfileController.html","",""],["ProfileHelper","","ProfileHelper.html","",""],["Project","","Project.html","",""],["ProjectHook","","ProjectHook.html","",""],["ProjectObserver","","ProjectObserver.html","",""],["ProjectResourceController","","ProjectResourceController.html","",""],["ProjectsController","","ProjectsController.html","",""],["ProjectsHelper","","ProjectsHelper.html","",""],["ProtectedBranch","","ProtectedBranch.html","",""],["ProtectedBranchesController","","ProtectedBranchesController.html","",""],["PushEvent","","PushEvent.html","",""],["PushObserver","","PushObserver.html","","<p>Includes methods for handling Git Push events\n<p>Triggered by PostReceive job\n"],["Redcarpet","","Redcarpet.html","",""],["Redcarpet::Render","","Redcarpet/Render.html","",""],["Redcarpet::Render::GitlabHTML","","Redcarpet/Render/GitlabHTML.html","",""],["RefsController","","RefsController.html","",""],["RepositoriesController","","RepositoriesController.html","",""],["Repository","","Repository.html","",""],["SearchContext","","SearchContext.html","",""],["SearchController","","SearchController.html","",""],["Snippet","","Snippet.html","",""],["SnippetsController","","SnippetsController.html","",""],["SnippetsHelper","","SnippetsHelper.html","",""],["StaticModel","","StaticModel.html","","<p>Provides an ActiveRecord-like interface to a model whose data is not\npersisted to a database.\n"],["StaticModel::ClassMethods","","StaticModel/ClassMethods.html","",""],["SystemHook","","SystemHook.html","",""],["SystemHookObserver","","SystemHookObserver.html","",""],["SystemHookWorker","","SystemHookWorker.html","",""],["TabHelper","","TabHelper.html","",""],["TagsHelper","","TagsHelper.html","",""],["Team","","Team.html","",""],["TeamMembersController","","TeamMembersController.html","",""],["TestHookContext","","TestHookContext.html","",""],["Tree","","Tree.html","",""],["TreeController","","TreeController.html","","<p>Controller for viewing a repository’s file structure\n"],["TreeDecorator","","TreeDecorator.html","",""],["TreeHelper","","TreeHelper.html","",""],["User","","User.html","",""],["UserObserver","","UserObserver.html","",""],["UsersProject","","UsersProject.html","",""],["UsersProjectObserver","","UsersProjectObserver.html","",""],["Votes","","Votes.html","",""],["WebHook","","WebHook.html","",""],["Wiki","","Wiki.html","",""],["WikisController","","WikisController.html","",""],["==","StaticModel","StaticModel.html#method-i-3D-3D","(other)",""],["[]","StaticModel","StaticModel.html#method-i-5B-5D","(key)","<p>Used by AR for fetching attributes\n<p>Pass it along if we respond to it.\n"],["_indexes_of_changed_lines","Gitlab::InlineDiff","Gitlab/InlineDiff.html#method-c-_indexes_of_changed_lines","(diff_arr)",""],["abilities","ApplicationController","ApplicationController.html#method-i-abilities","()",""],["abilities","BaseContext","BaseContext.html#method-i-abilities","()",""],["abilities","Grack::Auth","Grack/Auth.html#method-i-abilities","()",""],["access_denied!","ApplicationController","ApplicationController.html#method-i-access_denied-21","()",""],["access_options","Project","Project.html#method-c-access_options","()",""],["access_roles","UsersProject","UsersProject.html#method-c-access_roles","()",""],["action_name","Event","Event.html#method-i-action_name","()",""],["active","Milestone","Milestone.html#method-c-active","()",""],["active","Project","Project.html#method-c-active","()",""],["add_access","Authority","Authority.html#method-i-add_access","(user, *access)","<p>Compatible with all access rights Should be rewrited for new access rights\n"],["add_project_abilities","ApplicationController","ApplicationController.html#method-i-add_project_abilities","()",""],["add_refs","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-i-add_refs","(ref_cache, repo)",""],["add_user_id_to_team","Team","Team.html#method-i-add_user_id_to_team","(user_id, access_role)","<p>Add user to project with passed access role by user id\n"],["add_user_to_team","Team","Team.html#method-i-add_user_to_team","(user, access_role)","<p>Add user to project with passed access role\n"],["add_users_ids_to_team","Team","Team.html#method-i-add_users_ids_to_team","(users_ids, access_role)","<p>Add multiple users to project with same access role by user ids\n"],["add_users_to_team","Team","Team.html#method-i-add_users_to_team","(users, access_role)","<p>Add multiple users to project with same access role\n"],["admin_all_repo","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-admin_all_repo","()","<p>Enable access to all repos for gitolite admin. We use it for accept merge\nrequest feature\n"],["admin_all_repo!","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-admin_all_repo-21","()",""],["after_commit","UsersProjectObserver","UsersProjectObserver.html#method-i-after_commit","(users_project)",""],["after_create","ActivityObserver","ActivityObserver.html#method-i-after_create","(record)",""],["after_create","IssueObserver","IssueObserver.html#method-i-after_create","(issue)",""],["after_create","MergeRequestObserver","MergeRequestObserver.html#method-i-after_create","(merge_request)",""],["after_create","NoteObserver","NoteObserver.html#method-i-after_create","(note)",""],["after_create","ProjectObserver","ProjectObserver.html#method-i-after_create","(project)",""],["after_create","SystemHookObserver","SystemHookObserver.html#method-i-after_create","(model)",""],["after_create","UserObserver","UserObserver.html#method-i-after_create","(user)",""],["after_create","UsersProjectObserver","UsersProjectObserver.html#method-i-after_create","(users_project)",""],["after_destroy","KeyObserver","KeyObserver.html#method-i-after_destroy","(key)",""],["after_destroy","ProjectObserver","ProjectObserver.html#method-i-after_destroy","(project)",""],["after_destroy","SystemHookObserver","SystemHookObserver.html#method-i-after_destroy","(model)",""],["after_destroy","UserObserver","UserObserver.html#method-i-after_destroy","(user)",""],["after_destroy","UsersProjectObserver","UsersProjectObserver.html#method-i-after_destroy","(users_project)",""],["after_save","ActivityObserver","ActivityObserver.html#method-i-after_save","(record)",""],["after_save","KeyObserver","KeyObserver.html#method-i-after_save","(key)",""],["after_save","ProjectObserver","ProjectObserver.html#method-i-after_save","(project)",""],["after_sign_in_path_for","ApplicationController","ApplicationController.html#method-i-after_sign_in_path_for","(resource)",""],["after_update","IssueObserver","IssueObserver.html#method-i-after_update","(issue)",""],["after_update","MergeRequestObserver","MergeRequestObserver.html#method-i-after_update","(merge_request)",""],["all_hooks_fire","SystemHook","SystemHook.html#method-c-all_hooks_fire","(data)",""],["allow_read_for?","Authority","Authority.html#method-i-allow_read_for-3F","(user)",""],["allowed","Ability","Ability.html#method-c-allowed","(object, subject)",""],["allowed?","Event","Event.html#method-i-allowed-3F","()","<p>Next events currently enabled for system\n\n<pre>- push\n- new issue\n- merge request</pre>\n"],["allowed_tree_edit?","TreeHelper","TreeHelper.html#method-i-allowed_tree_edit-3F","()",""],["app_theme","ApplicationHelper","ApplicationHelper.html#method-i-app_theme","()",""],["apply","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-apply","()",""],["apply_import","TeamMembersController","TeamMembersController.html#method-i-apply_import","()",""],["archive","RepositoriesController","RepositoriesController.html#method-i-archive","()",""],["archive_repo","Repository","Repository.html#method-i-archive_repo","(ref)","<p>Archive Project to .tar.gz\n<p>Already packed repo archives stored at\napp_root/tmp/repositories/project_name/project_name-commit-id.tag.gz …\n"],["assign_ref_vars","ExtractsPath","ExtractsPath.html#method-i-assign_ref_vars","()","<p>Assigns common instance variables for views working with Git tree-ish\nobjects\n<p>Assignments are:\n<p>@id …\n"],["async_execute","SystemHook","SystemHook.html#method-i-async_execute","(data)",""],["attributes_for_keys","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-attributes_for_keys","(keys)",""],["authbutton","ApplicationHelper","ApplicationHelper.html#method-i-authbutton","(provider, size = 64)",""],["authenticate!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-authenticate-21","()",""],["authenticate_admin!","AdminController","AdminController.html#method-i-authenticate_admin-21","()",""],["authenticated_as_admin!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-authenticated_as_admin-21","()",""],["author","Event","Event.html#method-i-author","()",""],["author_email","Commit","Commit.html#method-i-author_email","()",""],["author_link","CommitDecorator","CommitDecorator.html#method-i-author_link","(options)","<p>Returns a link to the commit author. If the author has a matching user and\nis a member of the current …\n"],["author_name","Commit","Commit.html#method-i-author_name","()",""],["authorize!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-authorize-21","(action, subject)",""],["authorize_admin_issue!","IssuesController","IssuesController.html#method-i-authorize_admin_issue-21","()",""],["authorize_admin_merge_request!","MergeRequestsController","MergeRequestsController.html#method-i-authorize_admin_merge_request-21","()",""],["authorize_admin_milestone!","MilestonesController","MilestonesController.html#method-i-authorize_admin_milestone-21","()",""],["authorize_admin_snippet!","SnippetsController","SnippetsController.html#method-i-authorize_admin_snippet-21","()",""],["authorize_code_access!","ApplicationController","ApplicationController.html#method-i-authorize_code_access-21","()",""],["authorize_modify_issue!","IssuesController","IssuesController.html#method-i-authorize_modify_issue-21","()",""],["authorize_modify_merge_request!","MergeRequestsController","MergeRequestsController.html#method-i-authorize_modify_merge_request-21","()",""],["authorize_modify_snippet!","SnippetsController","SnippetsController.html#method-i-authorize_modify_snippet-21","()",""],["authorize_project!","ApplicationController","ApplicationController.html#method-i-authorize_project-21","(action)",""],["automerge","MergeRequestsController","MergeRequestsController.html#method-i-automerge","()",""],["automerge!","MergeRequest","MergeRequest.html#method-i-automerge-21","(current_user)",""],["automerge_check","MergeRequestsController","MergeRequestsController.html#method-i-automerge_check","()",""],["base_class","StaticModel::ClassMethods","StaticModel/ClassMethods.html#method-i-base_class","()","<p>Used by ActiveRecord’s polymorphic association to set object_type\n"],["block","Account","Account.html#method-i-block","()","<p>Remove user from all projects and set blocked attribute to true\n"],["block","Admin::UsersController","Admin/UsersController.html#method-i-block","()",""],["block_code","Redcarpet::Render::GitlabHTML","Redcarpet/Render/GitlabHTML.html#method-i-block_code","(code, language)",""],["branch?","PushEvent","PushEvent.html#method-i-branch-3F","()",""],["branch_from","MergeRequestsController","MergeRequestsController.html#method-i-branch_from","()",""],["branch_name","PushEvent","PushEvent.html#method-i-branch_name","()",""],["branch_names","Repository","Repository.html#method-i-branch_names","()","<p>Returns an Array of branch names\n"],["branch_to","MergeRequestsController","MergeRequestsController.html#method-i-branch_to","()",""],["branches","RepositoriesController","RepositoriesController.html#method-i-branches","()",""],["branches","Repository","Repository.html#method-i-branches","()","<p>Returns an Array of Branches\n"],["branches_tab_class","TabHelper","TabHelper.html#method-i-branches_tab_class","()",""],["breadcrumbs","TreeDecorator","TreeDecorator.html#method-i-breadcrumbs","(max_links = 2)",""],["broken_diffs?","MergeRequest","MergeRequest.html#method-i-broken_diffs-3F","()",""],["build","Gitlab::Logger","Gitlab/Logger.html#method-c-build","()",""],["build_commit_note","Project","Project.html#method-i-build_commit_note","(commit)",""],["build_line_anchor","CommitsHelper","CommitsHelper.html#method-i-build_line_anchor","(index, line_new, line_old)",""],["bulk_delete","UsersProject","UsersProject.html#method-c-bulk_delete","(project, user_ids)",""],["bulk_import","UsersProject","UsersProject.html#method-c-bulk_import","(project, user_ids, project_access)",""],["bulk_update","IssuesController","IssuesController.html#method-i-bulk_update","()",""],["bulk_update","UsersProject","UsersProject.html#method-c-bulk_update","(project, user_ids, project_access)",""],["can?","ApplicationController","ApplicationController.html#method-i-can-3F","(object, action, subject)",""],["can?","BaseContext","BaseContext.html#method-i-can-3F","(object, action, subject)",""],["can?","Grack::Auth","Grack/Auth.html#method-i-can-3F","(object, action, subject)",""],["can_be_merged?","Gitlab::Merge","Gitlab/Merge.html#method-i-can_be_merged-3F","()",""],["can_be_merged?","MergeRequest","MergeRequest.html#method-i-can_be_merged-3F","()",""],["can_create_group?","Account","Account.html#method-i-can_create_group-3F","()",""],["can_create_project?","Account","Account.html#method-i-can_create_project-3F","()",""],["can_edit?","Gitlab::FileEditor","Gitlab/FileEditor.html#method-i-can_edit-3F","(path, last_commit)",""],["cared_merge_requests","Account","Account.html#method-i-cared_merge_requests","()",""],["changed_issue?","Event","Event.html#method-i-changed_issue-3F","()",""],["changed_merge_request?","Event","Event.html#method-i-changed_merge_request-3F","()",""],["check_if_can_be_merged","MergeRequest","MergeRequest.html#method-i-check_if_can_be_merged","()",""],["check_limit","Project","Project.html#method-i-check_limit","()",""],["check_validity!","FileSizeValidator","FileSizeValidator.html#method-i-check_validity-21","()",""],["clear","Gitlab::Satellite","Gitlab/Satellite.html#method-i-clear","()","<p>will be deleted all branches except PARKING_BRANCH\n"],["closed?","Event","Event.html#method-i-closed-3F","()",""],["closed_event","MergeRequest","MergeRequest.html#method-i-closed_event","()",""],["commit","ProtectedBranch","ProtectedBranch.html#method-i-commit","()",""],["commit","Repository","Repository.html#method-i-commit","(commit_id = nil)",""],["commit_author","Note","Note.html#method-i-commit_author","()",""],["commit_from","PushEvent","PushEvent.html#method-i-commit_from","()",""],["commit_line_notes","Project","Project.html#method-i-commit_line_notes","(commit)",""],["commit_notes","Project","Project.html#method-i-commit_notes","(commit)",""],["commit_to","PushEvent","PushEvent.html#method-i-commit_to","()",""],["commits","Commit","Commit.html#method-c-commits","(repo, ref, path = nil, limit = nil, offset = nil)",""],["commits","MergeRequest","MergeRequest.html#method-i-commits","()",""],["commits","PushEvent","PushEvent.html#method-i-commits","()","<p>Max 20 commits from push DESC\n"],["commits","Repository","Repository.html#method-i-commits","(ref, path = nil, limit = nil, offset = nil)",""],["commits_between","Commit","Commit.html#method-c-commits_between","(repo, from, to)",""],["commits_between","Repository","Repository.html#method-i-commits_between","(from, to)",""],["commits_count","PushEvent","PushEvent.html#method-i-commits_count","()",""],["commits_since","Commit","Commit.html#method-c-commits_since","(repo, date)",""],["commits_since","Repository","Repository.html#method-i-commits_since","(date)",""],["commits_with_refs","Commit","Commit.html#method-c-commits_with_refs","(repo, n = 20)",""],["commits_with_refs","Repository","Repository.html#method-i-commits_with_refs","(n = 20)",""],["committer_email","Commit","Commit.html#method-i-committer_email","()",""],["committer_name","Commit","Commit.html#method-i-committer_name","()",""],["common_notes","Project","Project.html#method-i-common_notes","()",""],["compare","Commit","Commit.html#method-c-compare","(project, from, to)",""],["config","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-config","()",""],["content_types","Snippet","Snippet.html#method-c-content_types","()",""],["create","Admin::GroupsController","Admin/GroupsController.html#method-i-create","()",""],["create","Admin::HooksController","Admin/HooksController.html#method-i-create","()",""],["create","Admin::ProjectsController","Admin/ProjectsController.html#method-i-create","()",""],["create","Admin::UsersController","Admin/UsersController.html#method-i-create","()",""],["create","CompareController","CompareController.html#method-i-create","()",""],["create","DeployKeysController","DeployKeysController.html#method-i-create","()",""],["create","Gitlab::Satellite","Gitlab/Satellite.html#method-i-create","()",""],["create","HooksController","HooksController.html#method-i-create","()",""],["create","IssuesController","IssuesController.html#method-i-create","()",""],["create","KeysController","KeysController.html#method-i-create","()",""],["create","MergeRequestsController","MergeRequestsController.html#method-i-create","()",""],["create","MilestonesController","MilestonesController.html#method-i-create","()",""],["create","NotesController","NotesController.html#method-i-create","()",""],["create","ProjectsController","ProjectsController.html#method-i-create","()",""],["create","ProtectedBranchesController","ProtectedBranchesController.html#method-i-create","()",""],["create","SnippetsController","SnippetsController.html#method-i-create","()",""],["create","TeamMembersController","TeamMembersController.html#method-i-create","()",""],["create","WikisController","WikisController.html#method-i-create","()",""],["create_by_user","Project","Project.html#method-c-create_by_user","(params, user)",""],["create_from_omniauth","Gitlab::Auth","Gitlab/Auth.html#method-i-create_from_omniauth","(auth, ldap = false)",""],["create_from_omniauth","User","User.html#method-c-create_from_omniauth","(auth, ldap = false)",""],["create_repository","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-create_repository","(project)",""],["create_status_change_note","Note","Note.html#method-c-create_status_change_note","(noteable, author, status)",""],["created_at","Commit","Commit.html#method-i-created_at","()",""],["css_class_by_id","Gitlab::Theme","Gitlab/Theme.html#method-c-css_class_by_id","(id)",""],["current_action?","ApplicationHelper","ApplicationHelper.html#method-i-current_action-3F","(*args)","<p>Check if a partcular action is the current one\n<p>args - One or more action names to check\n<p>Examples\n"],["current_controller?","ApplicationHelper","ApplicationHelper.html#method-i-current_controller-3F","(*args)","<p>Check if a particular controller is the current one\n<p>args - One or more controller names to check\n<p>Examples …\n"],["current_ref","Grack::Auth","Grack/Auth.html#method-i-current_ref","()",""],["current_user","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-current_user","()",""],["data","Snippet","Snippet.html#method-i-data","()",""],["define_show_vars","MergeRequestsController","MergeRequestsController.html#method-i-define_show_vars","()",""],["define_tree_vars","RefsController","RefsController.html#method-i-define_tree_vars","()",""],["delete_users_ids_from_team","Team","Team.html#method-i-delete_users_ids_from_team","(users_ids)","<p>Delete multiple users from project by user ids\n"],["description","CommitDecorator","CommitDecorator.html#method-i-description","()","<p>Returns the commits description\n<p>cut off, ellipses (`&hellp;`) are prepended to the commit message. …\n"],["design","ProfileController","ProfileController.html#method-i-design","()",""],["destroy","Admin::GroupsController","Admin/GroupsController.html#method-i-destroy","()",""],["destroy","Admin::HooksController","Admin/HooksController.html#method-i-destroy","()",""],["destroy","Admin::ProjectsController","Admin/ProjectsController.html#method-i-destroy","()",""],["destroy","Admin::TeamMembersController","Admin/TeamMembersController.html#method-i-destroy","()",""],["destroy","Admin::UsersController","Admin/UsersController.html#method-i-destroy","()",""],["destroy","DeployKeysController","DeployKeysController.html#method-i-destroy","()",""],["destroy","HooksController","HooksController.html#method-i-destroy","()",""],["destroy","IssuesController","IssuesController.html#method-i-destroy","()",""],["destroy","KeysController","KeysController.html#method-i-destroy","()",""],["destroy","MergeRequestsController","MergeRequestsController.html#method-i-destroy","()",""],["destroy","MilestonesController","MilestonesController.html#method-i-destroy","()",""],["destroy","NotesController","NotesController.html#method-i-destroy","()",""],["destroy","ProjectsController","ProjectsController.html#method-i-destroy","()",""],["destroy","ProtectedBranchesController","ProtectedBranchesController.html#method-i-destroy","()",""],["destroy","SnippetsController","SnippetsController.html#method-i-destroy","()",""],["destroy","TeamMembersController","TeamMembersController.html#method-i-destroy","()",""],["destroy","WikisController","WikisController.html#method-i-destroy","()",""],["destroy_project","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-destroy_project","(project)",""],["destroy_project!","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-destroy_project-21","(project)",""],["destroy_repository","Repository","Repository.html#method-i-destroy_repository","()",""],["destroyed?","StaticModel","StaticModel.html#method-i-destroyed-3F","()",""],["detect_encoding","Gitlab::Encode","Gitlab/Encode.html#method-i-detect_encoding","(message)",""],["determine_action","Event","Event.html#method-c-determine_action","(record)",""],["dev_access_for?","Authority","Authority.html#method-i-dev_access_for-3F","(user)",""],["dev_tools","ApplicationController","ApplicationController.html#method-i-dev_tools","()",""],["different_committer?","Commit","Commit.html#method-i-different_committer-3F","()","<p>Was this commit committed by a different person than the original author?\n"],["diffs","MergeRequest","MergeRequest.html#method-i-diffs","()",""],["diffs","MergeRequestsController","MergeRequestsController.html#method-i-diffs","()",""],["discover_default_branch","Repository","Repository.html#method-i-discover_default_branch","()","<p>Discovers the default branch based on the repository’s available branches\n<p>If no branches are present, …\n"],["downvote?","Note","Note.html#method-i-downvote-3F","()","<p>Returns true if this is a downvote note, otherwise false is returned\n"],["downvotes","Votes","Votes.html#method-i-downvotes","()","<p>Return the number of -1 comments (downvotes)\n"],["downvotes_in_percent","Votes","Votes.html#method-i-downvotes_in_percent","()",""],["each_diff_line","CommitsHelper","CommitsHelper.html#method-i-each_diff_line","(diff_arr, index)",""],["edit","Admin::GroupsController","Admin/GroupsController.html#method-i-edit","()",""],["edit","Admin::ProjectsController","Admin/ProjectsController.html#method-i-edit","()",""],["edit","Admin::TeamMembersController","Admin/TeamMembersController.html#method-i-edit","()",""],["edit","Admin::UsersController","Admin/UsersController.html#method-i-edit","()",""],["edit","IssuesController","IssuesController.html#method-i-edit","()",""],["edit","MergeRequestsController","MergeRequestsController.html#method-i-edit","()",""],["edit","MilestonesController","MilestonesController.html#method-i-edit","()",""],["edit","ProjectsController","ProjectsController.html#method-i-edit","()",""],["edit","SnippetsController","SnippetsController.html#method-i-edit","()",""],["edit","TreeController","TreeController.html#method-i-edit","()",""],["edit","WikisController","WikisController.html#method-i-edit","()",""],["emoji_autocomplete_source","ApplicationHelper","ApplicationHelper.html#method-i-emoji_autocomplete_source","()",""],["empty?","Tree","Tree.html#method-i-empty-3F","()",""],["empty_repo?","Repository","Repository.html#method-i-empty_repo-3F","()",""],["enable_automerge","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-enable_automerge","()",""],["error","Gitlab::Logger","Gitlab/Logger.html#method-c-error","(message)",""],["event_action_name","EventsHelper","EventsHelper.html#method-i-event_action_name","(event)",""],["event_image","EventsHelper","EventsHelper.html#method-i-event_image","(event)",""],["execute","CommitLoadContext","CommitLoadContext.html#method-i-execute","()",""],["execute","IssuesBulkUpdateContext","IssuesBulkUpdateContext.html#method-i-execute","()",""],["execute","IssuesListContext","IssuesListContext.html#method-i-execute","()",""],["execute","MergeRequestsLoadContext","MergeRequestsLoadContext.html#method-i-execute","()",""],["execute","Notes::CreateContext","Notes/CreateContext.html#method-i-execute","()",""],["execute","Notes::LoadContext","Notes/LoadContext.html#method-i-execute","()",""],["execute","SearchContext","SearchContext.html#method-i-execute","()",""],["execute","TestHookContext","TestHookContext.html#method-i-execute","()",""],["execute","WebHook","WebHook.html#method-i-execute","(data)",""],["execute_hooks","PushObserver","PushObserver.html#method-i-execute_hooks","(oldrev, newrev, ref, user)",""],["exists?","Gitlab::Satellite","Gitlab/Satellite.html#method-i-exists-3F","()",""],["expired?","Snippet","Snippet.html#method-i-expired-3F","()",""],["expires_at","Milestone","Milestone.html#method-i-expires_at","()",""],["extract_ref","ExtractsPath","ExtractsPath.html#method-i-extract_ref","(input)","<p>Given a string containing both a Git tree-ish, such as a branch or tag, and\na filesystem path joined …\n"],["failure_message","OmniauthCallbacksController","OmniauthCallbacksController.html#method-i-failure_message","()","<p>Extend the standard message generation to accept our custom exception\n"],["feed_summary","EventDecorator","EventDecorator.html#method-i-feed_summary","()",""],["feed_title","EventDecorator","EventDecorator.html#method-i-feed_title","()",""],["feed_url","EventDecorator","EventDecorator.html#method-i-feed_url","()",""],["file_name","Gitlab::AppLogger","Gitlab/AppLogger.html#method-c-file_name","()",""],["file_name","Gitlab::GitLogger","Gitlab/GitLogger.html#method-c-file_name","()",""],["files","ProjectsController","ProjectsController.html#method-i-files","()",""],["filter","User","User.html#method-c-filter","(filter_name)",""],["find_all_by_branch","MergeRequest","MergeRequest.html#method-c-find_all_by_branch","(branch_name)",""],["find_for_ldap_auth","Gitlab::Auth","Gitlab/Auth.html#method-i-find_for_ldap_auth","(auth, signed_in_resource = nil)",""],["find_for_ldap_auth","User","User.html#method-c-find_for_ldap_auth","(auth, signed_in_resource = nil)",""],["find_free_space","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-c-find_free_space","(time_range)",""],["find_or_first","Commit","Commit.html#method-c-find_or_first","(repo, commit_id = nil, root_ref)",""],["find_or_new_for_omniauth","Gitlab::Auth","Gitlab/Auth.html#method-i-find_or_new_for_omniauth","(auth)",""],["find_or_new_for_omniauth","User","User.html#method-c-find_or_new_for_omniauth","(auth)",""],["fingerprintable_key","Key","Key.html#method-i-fingerprintable_key","()",""],["first_name","Account","Account.html#method-i-first_name","()",""],["for_commit?","Note","Note.html#method-i-for_commit-3F","()",""],["for_diff_line?","Note","Note.html#method-i-for_diff_line-3F","()",""],["forbidden!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-forbidden-21","()","<p>error helpers\n"],["format_message","Gitlab::AppLogger","Gitlab/AppLogger.html#method-i-format_message","(severity, timestamp, progname, msg)",""],["format_message","Gitlab::GitLogger","Gitlab/GitLogger.html#method-i-format_message","(severity, timestamp, progname, msg)",""],["fresh_commits","Commit","Commit.html#method-c-fresh_commits","(repo, n = 10)",""],["fresh_commits","Repository","Repository.html#method-i-fresh_commits","(n = 10)",""],["generate_password","User","User.html#method-i-generate_password","()",""],["gfm","Gitlab::Markdown","Gitlab/Markdown.html#method-i-gfm","(text, html_options = {})","<p>Public: Parse the provided text with GitLab-Flavored Markdown\n<p>text - the source text html_options …\n"],["git_error?","Project","Project.html#method-i-git_error-3F","()",""],["git_host","GitHost","GitHost.html#method-i-git_host","()",""],["git_not_found!","ApplicationController","ApplicationController.html#method-i-git_not_found-21","()",""],["githost","ErrorsController","ErrorsController.html#method-i-githost","()",""],["gitlab_auth","User","User.html#method-c-gitlab_auth","()",""],["gitlab_markdown?","TreeHelper","TreeHelper.html#method-i-gitlab_markdown-3F","(filename)",""],["graph","ProjectsController","ProjectsController.html#method-i-graph","()",""],["gravatar_icon","ApplicationHelper","ApplicationHelper.html#method-i-gravatar_icon","(user_email = '', size = 40)",""],["group","GroupsController","GroupsController.html#method-i-group","()",""],["grouped_options_refs","ApplicationHelper","ApplicationHelper.html#method-i-grouped_options_refs","(destination = :tree)",""],["grouper_project_members","ProjectsHelper","ProjectsHelper.html#method-i-grouper_project_members","(project)",""],["guest_access_for?","Authority","Authority.html#method-i-guest_access_for-3F","(user)",""],["has_commits?","Repository","Repository.html#method-i-has_commits-3F","()",""],["has_post_receive_file?","Repository","Repository.html#method-i-has_post_receive_file-3F","()",""],["heads","Repository","Repository.html#method-i-heads","()",""],["help","FileSizeValidator","FileSizeValidator.html#method-i-help","()",""],["hexdigest","ApplicationHelper","ApplicationHelper.html#method-i-hexdigest","(string)",""],["history","ProfileController","ProfileController.html#method-i-history","()",""],["history","WikisController","WikisController.html#method-i-history","()",""],["http_url_to_repo","Repository","Repository.html#method-i-http_url_to_repo","()",""],["human_state","MergeRequest","MergeRequest.html#method-i-human_state","()",""],["identification_type","CommitsHelper","CommitsHelper.html#method-i-identification_type","(line)",""],["identifier","Account","Account.html#method-i-identifier","()","<p>Returns a string for use as a Gitolite user identifier\n<p>Note that Gitolite 2.x requires the following pattern …\n"],["image_diff_class","CommitsHelper","CommitsHelper.html#method-i-image_diff_class","(diff)",""],["import_team","UsersProject","UsersProject.html#method-c-import_team","(source_project, target_project)",""],["index","Admin::DashboardController","Admin/DashboardController.html#method-i-index","()",""],["index","Admin::GroupsController","Admin/GroupsController.html#method-i-index","()",""],["index","Admin::HooksController","Admin/HooksController.html#method-i-index","()",""],["index","Admin::ProjectsController","Admin/ProjectsController.html#method-i-index","()",""],["index","Admin::UsersController","Admin/UsersController.html#method-i-index","()",""],["index","CompareController","CompareController.html#method-i-index","()",""],["index","DashboardController","DashboardController.html#method-i-index","()",""],["index","DeployKeysController","DeployKeysController.html#method-i-index","()",""],["index","HelpController","HelpController.html#method-i-index","()",""],["index","HooksController","HooksController.html#method-i-index","()",""],["index","IssuesController","IssuesController.html#method-i-index","()",""],["index","KeysController","KeysController.html#method-i-index","()",""],["index","LabelsController","LabelsController.html#method-i-index","()",""],["index","MergeRequestsController","MergeRequestsController.html#method-i-index","()",""],["index","MilestonesController","MilestonesController.html#method-i-index","()",""],["index","NotesController","NotesController.html#method-i-index","()",""],["index","ProtectedBranchesController","ProtectedBranchesController.html#method-i-index","()",""],["index","SnippetsController","SnippetsController.html#method-i-index","()",""],["index","TeamMembersController","TeamMembersController.html#method-i-index","()",""],["index_commits","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-c-index_commits","(commits)","<p>Method is adding time and space on the list of commits. As well as returns\ndate list corelated with time …\n"],["info","Gitlab::Logger","Gitlab/Logger.html#method-c-info","(message)",""],["invalid?","Tree","Tree.html#method-i-invalid-3F","()",""],["is_admin?","Account","Account.html#method-i-is_admin-3F","()",""],["is_assigned?","IssueCommonality","IssueCommonality.html#method-i-is_assigned-3F","()",""],["is_being_closed?","IssueCommonality","IssueCommonality.html#method-i-is_being_closed-3F","()",""],["is_being_reassigned?","IssueCommonality","IssueCommonality.html#method-i-is_being_reassigned-3F","()",""],["is_being_reopened?","IssueCommonality","IssueCommonality.html#method-i-is_being_reopened-3F","()",""],["is_blob?","Tree","Tree.html#method-i-is_blob-3F","()",""],["is_deploy_key","Key","Key.html#method-i-is_deploy_key","()",""],["issue","Event","Event.html#method-i-issue","()",""],["issue","IssuesController","IssuesController.html#method-i-issue","()",""],["issue?","Event","Event.html#method-i-issue-3F","()",""],["issue_css_classes","IssuesHelper","IssuesHelper.html#method-i-issue_css_classes","(issue)",""],["issue_status_changed_email","Notify","Notify.html#method-i-issue_status_changed_email","(recipient_id, issue_id, status, updated_by_user_id)",""],["issue_tags","IssuesHelper","IssuesHelper.html#method-i-issue_tags","()",""],["issues","DashboardController","DashboardController.html#method-i-issues","()","<p>Get only assigned issues\n"],["issues","GroupsController","GroupsController.html#method-i-issues","()","<p>Get only assigned issues\n"],["issues_filter","IssuesHelper","IssuesHelper.html#method-i-issues_filter","()",""],["issues_filtered","IssuesController","IssuesController.html#method-i-issues_filtered","()",""],["issues_labels","Project","Project.html#method-i-issues_labels","()",""],["joined?","Event","Event.html#method-i-joined-3F","()",""],["last_activity","Project","Project.html#method-i-last_activity","()",""],["last_activity_date","Project","Project.html#method-i-last_activity_date","()",""],["last_activity_project","Account","Account.html#method-i-last_activity_project","()",""],["last_commit","ApplicationHelper","ApplicationHelper.html#method-i-last_commit","(project)",""],["last_commit","MergeRequest","MergeRequest.html#method-i-last_commit","()",""],["last_commit","PushEvent","PushEvent.html#method-i-last_commit","()",""],["last_commit_for","Repository","Repository.html#method-i-last_commit_for","(ref, path = nil)",""],["last_deploy?","Key","Key.html#method-i-last_deploy-3F","()",""],["last_push_to_non_root?","PushEvent","PushEvent.html#method-i-last_push_to_non_root-3F","()",""],["ldap","OmniauthCallbacksController","OmniauthCallbacksController.html#method-i-ldap","()",""],["ldap_enable?","ApplicationHelper","ApplicationHelper.html#method-i-ldap_enable-3F","()",""],["left?","Event","Event.html#method-i-left-3F","()",""],["lifetime_select_options","SnippetsHelper","SnippetsHelper.html#method-i-lifetime_select_options","()",""],["link_title","CommitDecorator","CommitDecorator.html#method-i-link_title","()","<p>Returns a string describing the commit for use in a link title\n<p>Example\n\n<pre>"Commit: Alex Denisov - Project ...</pre>\n"],["link_to_author","EventsHelper","EventsHelper.html#method-i-link_to_author","(event)",""],["link_to_commit_diff_line_note","NotesHelper","NotesHelper.html#method-i-link_to_commit_diff_line_note","(note)",""],["link_to_gfm","GitlabMarkdownHelper","GitlabMarkdownHelper.html#method-i-link_to_gfm","(body, url, html_options = {})","<p>Use this in places where you would normally use link_to(gfm(…), …).\n<p>It solves a problem occurring …\n"],["link_to_issue_assignee","IssuesHelper","IssuesHelper.html#method-i-link_to_issue_assignee","(issue)",""],["link_to_issue_author","IssuesHelper","IssuesHelper.html#method-i-link_to_issue_author","(issue)",""],["link_to_merge_request_assignee","MergeRequestsHelper","MergeRequestsHelper.html#method-i-link_to_merge_request_assignee","(merge_request)",""],["link_to_merge_request_author","MergeRequestsHelper","MergeRequestsHelper.html#method-i-link_to_merge_request_author","(merge_request)",""],["link_to_project","ProjectsHelper","ProjectsHelper.html#method-i-link_to_project","(project)",""],["loading_more_notes?","NotesHelper","NotesHelper.html#method-i-loading_more_notes-3F","()",""],["loading_new_notes?","NotesHelper","NotesHelper.html#method-i-loading_new_notes-3F","()",""],["log","Gitlab::Auth","Gitlab/Auth.html#method-i-log","()",""],["log","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-log","(message)",""],["log_info","ProjectObserver","ProjectObserver.html#method-i-log_info","(message)",""],["log_info","UserObserver","UserObserver.html#method-i-log_info","(message)",""],["logs_tree","RefsController","RefsController.html#method-i-logs_tree","()",""],["mark_as_merged!","MergeRequest","MergeRequest.html#method-i-mark_as_merged-21","()",""],["mark_as_unchecked","MergeRequest","MergeRequest.html#method-i-mark_as_unchecked","()",""],["mark_as_unmergable","MergeRequest","MergeRequest.html#method-i-mark_as_unmergable","()",""],["mark_reserved","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-c-mark_reserved","(time_range, space)",""],["markdown","GitlabMarkdownHelper","GitlabMarkdownHelper.html#method-i-markdown","(text)",""],["markup?","TreeHelper","TreeHelper.html#method-i-markup-3F","(filename)","<p>Public: Determines if a given filename is compatible with GitHub::Markup.\n<p>filename - Filename string to …\n"],["master_access_for?","Authority","Authority.html#method-i-master_access_for-3F","(user)",""],["md_ref?","PushEvent","PushEvent.html#method-i-md_ref-3F","()",""],["membership_changed?","Event","Event.html#method-i-membership_changed-3F","()",""],["merge!","Gitlab::Merge","Gitlab/Merge.html#method-i-merge-21","()","<p>Merges the source branch into the target branch in the satellite and pushes\nit back to Gitolite. It also …\n"],["merge!","MergeRequest","MergeRequest.html#method-i-merge-21","(user_id)",""],["merge_event","MergeRequest","MergeRequest.html#method-i-merge_event","()",""],["merge_request","Event","Event.html#method-i-merge_request","()",""],["merge_request","MergeRequestsController","MergeRequestsController.html#method-i-merge_request","()",""],["merge_request?","Event","Event.html#method-i-merge_request-3F","()",""],["merge_requests","DashboardController","DashboardController.html#method-i-merge_requests","()","<p>Get authored or assigned open merge requests\n"],["merge_requests","GroupsController","GroupsController.html#method-i-merge_requests","()","<p>Get authored or assigned open merge requests\n"],["merged?","Event","Event.html#method-i-merged-3F","()",""],["merged?","MergeRequest","MergeRequest.html#method-i-merged-3F","()",""],["method_missing","ApplicationController","ApplicationController.html#method-i-method_missing","(method_sym, *arguments, &block)",""],["method_missing","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-i-method_missing","(m, *args, &block)",""],["milestone","MilestonesController","MilestonesController.html#method-i-milestone","()",""],["mode","Snippet","Snippet.html#method-i-mode","()",""],["module_enabled","IssuesController","IssuesController.html#method-i-module_enabled","()",""],["module_enabled","LabelsController","LabelsController.html#method-i-module_enabled","()",""],["module_enabled","MergeRequestsController","MergeRequestsController.html#method-i-module_enabled","()",""],["module_enabled","MilestonesController","MilestonesController.html#method-i-module_enabled","()",""],["mr_and_commit_notes","MergeRequest","MergeRequest.html#method-i-mr_and_commit_notes","()",""],["mr_css_classes","MergeRequestsHelper","MergeRequestsHelper.html#method-i-mr_css_classes","(mr)",""],["name","Snippet","Snippet.html#method-i-name","()",""],["nav_link","TabHelper","TabHelper.html#method-i-nav_link","(options = {}, &block)","<p>Navigation link helper\n<p>Returns an `li` element with an ‘active’ class if the supplied\ncontroller(s) and/or …\n"],["new","Admin::GroupsController","Admin/GroupsController.html#method-i-new","()",""],["new","Admin::ProjectsController","Admin/ProjectsController.html#method-i-new","()",""],["new","Admin::UsersController","Admin/UsersController.html#method-i-new","()",""],["new","BaseContext","BaseContext.html#method-c-new","(project, user, params)",""],["new","Commit","Commit.html#method-c-new","(raw_commit, head = nil)",""],["new","DeployKeysController","DeployKeysController.html#method-i-new","()",""],["new","FileSizeValidator","FileSizeValidator.html#method-c-new","(options)",""],["new","Gitlab::FileEditor","Gitlab/FileEditor.html#method-c-new","(user, project, ref)",""],["new","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-c-new","(commit)",""],["new","Gitlab::Merge","Gitlab/Merge.html#method-c-new","(merge_request, user)",""],["new","Gitlab::Satellite","Gitlab/Satellite.html#method-c-new","(project)",""],["new","IssuesController","IssuesController.html#method-i-new","()",""],["new","KeysController","KeysController.html#method-i-new","()",""],["new","MergeRequestsController","MergeRequestsController.html#method-i-new","()",""],["new","MilestonesController","MilestonesController.html#method-i-new","()",""],["new","ProjectsController","ProjectsController.html#method-i-new","()",""],["new","Redcarpet::Render::GitlabHTML","Redcarpet/Render/GitlabHTML.html#method-c-new","(template, options = {})",""],["new","SearchContext","SearchContext.html#method-c-new","(project_ids, params)",""],["new","SnippetsController","SnippetsController.html#method-i-new","()",""],["new","TeamMembersController","TeamMembersController.html#method-i-new","()",""],["new","Tree","Tree.html#method-c-new","(raw_tree, project, ref = nil, path = nil)",""],["new?","IssueCommonality","IssueCommonality.html#method-i-new-3F","()",""],["new_branch?","PushEvent","PushEvent.html#method-i-new_branch-3F","()",""],["new_issue?","Event","Event.html#method-i-new_issue-3F","()",""],["new_issue_email","Notify","Notify.html#method-i-new_issue_email","(issue_id)","<p>Issue\n"],["new_merge_request?","Event","Event.html#method-i-new_merge_request-3F","()",""],["new_merge_request_email","Notify","Notify.html#method-i-new_merge_request_email","(merge_request_id)","<p>Merge Request\n"],["new_mr_path_from_push_event","MergeRequestsHelper","MergeRequestsHelper.html#method-i-new_mr_path_from_push_event","(event)",""],["new_record?","StaticModel","StaticModel.html#method-i-new_record-3F","()",""],["new_ref?","PushEvent","PushEvent.html#method-i-new_ref-3F","()",""],["new_user_email","Notify","Notify.html#method-i-new_user_email","(user_id, password)","<p>User\n"],["no_cache_headers","ApplicationController","ApplicationController.html#method-i-no_cache_headers","()",""],["no_commit_message","CommitDecorator","CommitDecorator.html#method-i-no_commit_message","()",""],["not_allowed!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-not_allowed-21","()",""],["not_found!","ApplicationController","ApplicationController.html#method-i-not_found-21","()",""],["not_found!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-not_found-21","(resource = nil)",""],["note_commit_email","Notify","Notify.html#method-i-note_commit_email","(recipient_id, note_id)","<p>Note\n"],["note_for_main_target?","NotesHelper","NotesHelper.html#method-i-note_for_main_target-3F","(note)","<p>Helps to distinguish e.g. commit notes in mr notes list\n"],["note_issue_email","Notify","Notify.html#method-i-note_issue_email","(recipient_id, note_id)",""],["note_merge_request_email","Notify","Notify.html#method-i-note_merge_request_email","(recipient_id, note_id)",""],["note_wall_email","Notify","Notify.html#method-i-note_wall_email","(recipient_id, note_id)",""],["note_wiki_email","Notify","Notify.html#method-i-note_wiki_email","(recipient_id, note_id)",""],["noteable","Note","Note.html#method-i-noteable","()","<p>override to return commits, which are not active record\n"],["notes","NotesController","NotesController.html#method-i-notes","()",""],["notify_only_author?","Note","Note.html#method-i-notify_only_author-3F","(user)","<p>Check if we can notify commit author with email about our comment\n<p>If commit author email exist in project …\n"],["notify_team","NoteObserver","NoteObserver.html#method-i-notify_team","(note)","<p>Notifies the whole team except the author of note\n"],["oauth_active_class","ProfileHelper","ProfileHelper.html#method-i-oauth_active_class","(provider)",""],["observe_push","PushObserver","PushObserver.html#method-i-observe_push","(oldrev, newrev, ref, user)",""],["open?","MergeRequest","MergeRequest.html#method-i-open-3F","()",""],["open_branches","Repository","Repository.html#method-i-open_branches","()",""],["open_for","Issue","Issue.html#method-c-open_for","(user)",""],["pages","WikisController","WikisController.html#method-i-pages","()",""],["paginate","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-paginate","(object)",""],["parent_commit","PushEvent","PushEvent.html#method-i-parent_commit","()",""],["parents_count","Commit","Commit.html#method-i-parents_count","()",""],["participants","Milestone","Milestone.html#method-i-participants","()",""],["password_update","ProfileController","ProfileController.html#method-i-password_update","()",""],["path","Gitlab::Satellite","Gitlab/Satellite.html#method-i-path","()",""],["path_to_repo","Repository","Repository.html#method-i-path_to_repo","()",""],["people","GroupsController","GroupsController.html#method-i-people","()",""],["percent_complete","Milestone","Milestone.html#method-i-percent_complete","()",""],["perform","PostReceive","PostReceive.html#method-c-perform","(reponame, oldrev, newrev, ref, identifier)",""],["perform","SystemHookWorker","SystemHookWorker.html#method-c-perform","(hook_id, data)",""],["persisted?","StaticModel","StaticModel.html#method-i-persisted-3F","()",""],["place_chain","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-c-place_chain","(commit, map, parent_time = nil)","<p>Add space mark on commit and its parents\n<p>@param [GraphCommit] the commit object. @param [Hash<String …\n"],["plain_text_readme?","TreeHelper","TreeHelper.html#method-i-plain_text_readme-3F","(filename)",""],["post_receive_data","PushObserver","PushObserver.html#method-i-post_receive_data","(oldrev, newrev, ref, user)",""],["postprocess","Redcarpet::Render::GitlabHTML","Redcarpet/Render/GitlabHTML.html#method-i-postprocess","(full_document)",""],["prev_commit","Commit","Commit.html#method-i-prev_commit","()",""],["prev_commit_id","Commit","Commit.html#method-i-prev_commit_id","()",""],["preview","NotesController","NotesController.html#method-i-preview","()",""],["primary_key","StaticModel::ClassMethods","StaticModel/ClassMethods.html#method-i-primary_key","()","<p>Used by ActiveRecord’s polymorphic association to set object_id\n"],["private?","Project","Project.html#method-i-private-3F","()",""],["probably_merged?","MergeRequest","MergeRequest.html#method-i-probably_merged-3F","()",""],["processing","Gitlab::InlineDiff","Gitlab/InlineDiff.html#method-c-processing","(diff_arr)",""],["project","ApplicationController","ApplicationController.html#method-i-project","()",""],["project_abilities","Ability","Ability.html#method-c-project_abilities","(user, project)",""],["project_access_granted_email","Notify","Notify.html#method-i-project_access_granted_email","(user_project_id)","<p>Project\n"],["project_access_human","UsersProject","UsersProject.html#method-i-project_access_human","()",""],["project_id","Project","Project.html#method-i-project_id","()",""],["project_ids","Account","Account.html#method-i-project_ids","()",""],["project_ids","GroupsController","GroupsController.html#method-i-project_ids","()",""],["project_issues_filter_path","IssuesHelper","IssuesHelper.html#method-i-project_issues_filter_path","(project, params = {})",""],["project_last_activity","ApplicationHelper","ApplicationHelper.html#method-i-project_last_activity","(project)",""],["project_name","Event","Event.html#method-i-project_name","()",""],["project_tab_class","TabHelper","TabHelper.html#method-i-project_tab_class","()",""],["project_update","Admin::GroupsController","Admin/GroupsController.html#method-i-project_update","()",""],["projects","GroupsController","GroupsController.html#method-i-projects","()",""],["projects","Key","Key.html#method-i-projects","()","<p>projects that has this key\n"],["projects_limit_percent","Account","Account.html#method-i-projects_limit_percent","()",""],["projects_with_events","Account","Account.html#method-i-projects_with_events","()",""],["protected_branch?","Repository","Repository.html#method-i-protected_branch-3F","(branch_name)","<p>Check if current branch name is marked as protected in the system\n"],["public?","Project","Project.html#method-i-public-3F","()",""],["push?","Event","Event.html#method-i-push-3F","()",""],["push_action_name","PushEvent","PushEvent.html#method-i-push_action_name","()",""],["push_with_commits?","PushEvent","PushEvent.html#method-i-push_with_commits-3F","()",""],["raw","MergeRequestsController","MergeRequestsController.html#method-i-raw","()",""],["raw","SnippetsController","SnippetsController.html#method-i-raw","()",""],["read_latest","Gitlab::Logger","Gitlab/Logger.html#method-c-read_latest","()",""],["readme","TreeDecorator","TreeDecorator.html#method-i-readme","()",""],["reassigned_issue_email","Notify","Notify.html#method-i-reassigned_issue_email","(recipient_id, issue_id, previous_assignee_id)",""],["reassigned_merge_request_email","Notify","Notify.html#method-i-reassigned_merge_request_email","(recipient_id, merge_request_id, previous_assignee_id)",""],["recent_push","Account","Account.html#method-i-recent_push","(project_id = nil)",""],["ref","RefsController","RefsController.html#method-i-ref","()",""],["ref_name","PushEvent","PushEvent.html#method-i-ref_name","()",""],["ref_names","Repository","Repository.html#method-i-ref_names","()","<p>Returns an Array of branch and tag names\n"],["ref_type","PushEvent","PushEvent.html#method-i-ref_type","()",""],["regenerate_from","Wiki","Wiki.html#method-c-regenerate_from","(wiki)",""],["reject_blocked!","ApplicationController","ApplicationController.html#method-i-reject_blocked-21","()",""],["reload_code","MergeRequest","MergeRequest.html#method-i-reload_code","()",""],["reloaded_commits","MergeRequest","MergeRequest.html#method-i-reloaded_commits","()",""],["reloaded_diffs","MergeRequest","MergeRequest.html#method-i-reloaded_diffs","()",""],["remove_from_team_message","ProjectsHelper","ProjectsHelper.html#method-i-remove_from_team_message","(project, member)",""],["remove_key","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-remove_key","(key_id, projects)",""],["remove_project","Admin::GroupsController","Admin/GroupsController.html#method-i-remove_project","()",""],["remove_repository","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-remove_repository","(project)",""],["render_404","ApplicationController","ApplicationController.html#method-i-render_404","()",""],["render_api_error!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-render_api_error-21","(message, status)",""],["render_tree","TreeHelper","TreeHelper.html#method-i-render_tree","(contents)","<p>Sorts a repository’s tree so that folders are before files and renders\ntheir corresponding partials\n<p>contents …\n"],["reopened?","Event","Event.html#method-i-reopened-3F","()",""],["replace_markers","Gitlab::InlineDiff","Gitlab/InlineDiff.html#method-c-replace_markers","(line)",""],["repo","Repository","Repository.html#method-i-repo","()",""],["repo_access_human","UsersProject","UsersProject.html#method-i-repo_access_human","()",""],["repo_exists?","Repository","Repository.html#method-i-repo_exists-3F","()",""],["repo_name","Project","Project.html#method-i-repo_name","()",""],["report_access_for?","Authority","Authority.html#method-i-report_access_for-3F","(user)",""],["repository_masters","Authority","Authority.html#method-i-repository_masters","()",""],["repository_readers","Authority","Authority.html#method-i-repository_readers","()",""],["repository_writers","Authority","Authority.html#method-i-repository_writers","()",""],["request_protocol","ApplicationHelper","ApplicationHelper.html#method-i-request_protocol","()",""],["require_non_empty_project","ApplicationController","ApplicationController.html#method-i-require_non_empty_project","()",""],["require_ssh_key?","Account","Account.html#method-i-require_ssh_key-3F","()",""],["reset_access","Authority","Authority.html#method-i-reset_access","(user)",""],["reset_private_token","ProfileController","ProfileController.html#method-i-reset_private_token","()",""],["result","SearchContext","SearchContext.html#method-i-result","()",""],["rm_key","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-rm_key","(user)",""],["rm_ref?","PushEvent","PushEvent.html#method-i-rm_ref-3F","()",""],["role_access","UsersProject","UsersProject.html#method-i-role_access","()",""],["root_ref","Repository","Repository.html#method-i-root_ref","()",""],["root_ref?","Repository","Repository.html#method-i-root_ref-3F","(branch)",""],["safe_message","Commit","Commit.html#method-i-safe_message","()",""],["satellite","Repository","Repository.html#method-i-satellite","()",""],["saved?","Project","Project.html#method-i-saved-3F","()",""],["search","Group","Group.html#method-c-search","(query)",""],["search","GroupsController","GroupsController.html#method-i-search","()",""],["search","IssueCommonality::ClassMethods","IssueCommonality/ClassMethods.html#method-i-search","(query)",""],["search","IssuesController","IssuesController.html#method-i-search","()",""],["search","Project","Project.html#method-c-search","(query)",""],["search","User","User.html#method-c-search","(query)",""],["search_autocomplete_source","ApplicationHelper","ApplicationHelper.html#method-i-search_autocomplete_source","()",""],["send_notify_mails","NoteObserver","NoteObserver.html#method-i-send_notify_mails","(note)",""],["send_reassigned_email","IssueObserver","IssueObserver.html#method-i-send_reassigned_email","(issue)",""],["send_reassigned_email","MergeRequestObserver","MergeRequestObserver.html#method-i-send_reassigned_email","(merge_request)",""],["set_current_user_for_observers","ApplicationController","ApplicationController.html#method-i-set_current_user_for_observers","()",""],["set_identifier","Key","Key.html#method-i-set_identifier","()",""],["set_key","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-set_key","(key_id, key_content, projects)",""],["set_slug","Wiki","Wiki.html#method-i-set_slug","()",""],["short_id","Commit","Commit.html#method-i-short_id","(length = 10)",""],["show","Admin::GroupsController","Admin/GroupsController.html#method-i-show","()",""],["show","Admin::ProjectsController","Admin/ProjectsController.html#method-i-show","()",""],["show","Admin::ResqueController","Admin/ResqueController.html#method-i-show","()",""],["show","Admin::UsersController","Admin/UsersController.html#method-i-show","()",""],["show","BlameController","BlameController.html#method-i-show","()",""],["show","BlobController","BlobController.html#method-i-show","()",""],["show","CommitController","CommitController.html#method-i-show","()",""],["show","CommitsController","CommitsController.html#method-i-show","()",""],["show","CompareController","CompareController.html#method-i-show","()",""],["show","DeployKeysController","DeployKeysController.html#method-i-show","()",""],["show","GroupsController","GroupsController.html#method-i-show","()",""],["show","IssuesController","IssuesController.html#method-i-show","()",""],["show","KeysController","KeysController.html#method-i-show","()",""],["show","MergeRequestsController","MergeRequestsController.html#method-i-show","()",""],["show","MilestonesController","MilestonesController.html#method-i-show","()",""],["show","ProfileController","ProfileController.html#method-i-show","()",""],["show","ProjectsController","ProjectsController.html#method-i-show","()",""],["show","RepositoriesController","RepositoriesController.html#method-i-show","()",""],["show","SearchController","SearchController.html#method-i-show","()",""],["show","SnippetsController","SnippetsController.html#method-i-show","()",""],["show","TeamMembersController","TeamMembersController.html#method-i-show","()",""],["show","TreeController","TreeController.html#method-i-show","()",""],["show","WikisController","WikisController.html#method-i-show","()",""],["show_last_push_widget?","ApplicationHelper","ApplicationHelper.html#method-i-show_last_push_widget-3F","(event)",""],["size","Snippet","Snippet.html#method-i-size","()",""],["snippet","SnippetsController","SnippetsController.html#method-i-snippet","()",""],["sort","IssuesController","IssuesController.html#method-i-sort","()",""],["ssh_url_to_repo","Repository","Repository.html#method-i-ssh_url_to_repo","()",""],["store_dir","AttachmentUploader","AttachmentUploader.html#method-i-store_dir","()","<p>Override the directory where uploaded files will be stored. This is a\nsensible default for uploaders …\n"],["strip_white_space","Key","Key.html#method-i-strip_white_space","()",""],["switch","RefsController","RefsController.html#method-i-switch","()",""],["tag?","PushEvent","PushEvent.html#method-i-tag-3F","()",""],["tag_list","TagsHelper","TagsHelper.html#method-i-tag_list","(project)",""],["tag_name","PushEvent","PushEvent.html#method-i-tag_name","()",""],["tag_names","Repository","Repository.html#method-i-tag_names","()","<p>Returns an Array of tag names\n"],["tag_path","TagsHelper","TagsHelper.html#method-i-tag_path","(tag)",""],["tags","RepositoriesController","RepositoriesController.html#method-i-tags","()",""],["tags","Repository","Repository.html#method-i-tags","()","<p>Returns an Array of Tags\n"],["take_left_leaves","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-c-take_left_leaves","(commit, map)","<p>Takes most left subtree branch of commits which don’t have space mark yet.\n<p>@param [GraphCommit] the commit …\n"],["target_title","Event","Event.html#method-i-target_title","()",""],["team_member_by_id","Team","Team.html#method-i-team_member_by_id","(user_id)","<p>Get Team Member record by user id\n"],["team_member_by_name_or_email","Team","Team.html#method-i-team_member_by_name_or_email","(name = nil, email = nil)",""],["team_update","Admin::ProjectsController","Admin/ProjectsController.html#method-i-team_update","()",""],["team_update","Admin::UsersController","Admin/UsersController.html#method-i-team_update","()",""],["team_without_note_author","NoteObserver","NoteObserver.html#method-i-team_without_note_author","(note)",""],["test","Admin::HooksController","Admin/HooksController.html#method-i-test","()",""],["test","HooksController","HooksController.html#method-i-test","()",""],["title","CommitDecorator","CommitDecorator.html#method-i-title","()","<p>Returns the commits title.\n<p>Usually, the commit title is the first line of the commit message. In case\n…\n"],["to_graph","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-c-to_graph","(project)",""],["to_graph_hash","Gitlab::GraphCommit","Gitlab/GraphCommit.html#method-i-to_graph_hash","()",""],["to_param","Group","Group.html#method-i-to_param","()",""],["to_param","Project","Project.html#method-i-to_param","()",""],["to_param","StaticModel","StaticModel.html#method-i-to_param","()",""],["to_param","Wiki","Wiki.html#method-i-to_param","()",""],["to_raw","MergeRequest","MergeRequest.html#method-i-to_raw","()",""],["today?","IssueCommonality","IssueCommonality.html#method-i-today-3F","()",""],["token","ProfileController","ProfileController.html#method-i-token","()",""],["tree","Repository","Repository.html#method-i-tree","(fcommit, path = nil)",""],["tree_hex_class","TreeHelper","TreeHelper.html#method-i-tree_hex_class","(content)",""],["tree_icon","TreeHelper","TreeHelper.html#method-i-tree_icon","(type)","<p>Return an image icon depending on the file type\n<p>type - String type of the tree item; either ‘folder’ or …\n"],["tree_join","TreeHelper","TreeHelper.html#method-i-tree_join","(*args)","<p>Simple shortcut to File.join\n"],["trigger_post_receive","PushObserver","PushObserver.html#method-i-trigger_post_receive","(oldrev, newrev, ref, user)","<p>This method will be called after each post receive and only if the provided\nuser is present in GitLab …\n"],["unassigned_filter","IssuesHelper","IssuesHelper.html#method-i-unassigned_filter","()","<p>Returns an OpenStruct object suitable for use by\n<code>options_from_collection_for_select</code> to allow filtering …\n"],["unauthorized!","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-unauthorized-21","()",""],["unblock","Admin::UsersController","Admin/UsersController.html#method-i-unblock","()",""],["unchecked?","MergeRequest","MergeRequest.html#method-i-unchecked-3F","()",""],["unique_key","Key","Key.html#method-i-unique_key","()",""],["unmerged_commits","MergeRequest","MergeRequest.html#method-i-unmerged_commits","()",""],["unmerged_diffs","MergeRequest","MergeRequest.html#method-i-unmerged_diffs","()",""],["up_dir?","TreeDecorator","TreeDecorator.html#method-i-up_dir-3F","()",""],["up_dir_path","TreeDecorator","TreeDecorator.html#method-i-up_dir_path","()",""],["update","Admin::GroupsController","Admin/GroupsController.html#method-i-update","()",""],["update","Admin::ProjectsController","Admin/ProjectsController.html#method-i-update","()",""],["update","Admin::TeamMembersController","Admin/TeamMembersController.html#method-i-update","()",""],["update","Admin::UsersController","Admin/UsersController.html#method-i-update","()",""],["update","Gitlab::FileEditor","Gitlab/FileEditor.html#method-i-update","(path, content, commit_message, last_commit)",""],["update","IssuesController","IssuesController.html#method-i-update","()",""],["update","MergeRequestsController","MergeRequestsController.html#method-i-update","()",""],["update","MilestonesController","MilestonesController.html#method-i-update","()",""],["update","ProfileController","ProfileController.html#method-i-update","()",""],["update","ProjectsController","ProjectsController.html#method-i-update","()",""],["update","SnippetsController","SnippetsController.html#method-i-update","()",""],["update","TeamMembersController","TeamMembersController.html#method-i-update","()",""],["update","TreeController","TreeController.html#method-i-update","()",""],["update_merge_requests","PushObserver","PushObserver.html#method-i-update_merge_requests","(oldrev, newrev, ref, user)",""],["update_project","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-update_project","(repo_name, project)","<p>update or create\n"],["update_project!","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-update_project-21","(repo_name, project)",""],["update_project_config","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-update_project_config","(project, conf)",""],["update_projects","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-update_projects","(projects)","<p>Updates many projects and uses project.path as the repo path An order of\nmagnitude faster than update_project …\n"],["update_repository","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-update_repository","(project)",""],["update_repository","ProtectedBranch","ProtectedBranch.html#method-i-update_repository","()",""],["update_repository","Repository","Repository.html#method-i-update_repository","()",""],["update_repository","UsersProject","UsersProject.html#method-i-update_repository","()",""],["update_users_ids_to_role","Team","Team.html#method-i-update_users_ids_to_role","(users_ids, access_role)","<p>Update multiple project users to same access role by user ids\n"],["upvote?","Note","Note.html#method-i-upvote-3F","()","<p>Returns true if this is an upvote note, otherwise false is returned\n"],["upvotes","Votes","Votes.html#method-i-upvotes","()","<p>Return the number of +1 comments (upvotes)\n"],["upvotes_in_percent","Votes","Votes.html#method-i-upvotes_in_percent","()",""],["url_to_repo","Gitlab::Gitolite","Gitlab/Gitolite.html#method-i-url_to_repo","(path)",""],["url_to_repo","Repository","Repository.html#method-i-url_to_repo","()",""],["user_bulk_import","UsersProject","UsersProject.html#method-c-user_bulk_import","(user, project_ids, project_access)",""],["user_project","Gitlab::APIHelpers","Gitlab/APIHelpers.html#method-i-user_project","()",""],["users","Group","Group.html#method-i-users","()",""],["utf8","Gitlab::Encode","Gitlab/Encode.html#method-i-utf8","(message)",""],["valid?","Grack::Auth","Grack/Auth.html#method-i-valid-3F","()",""],["valid_diffs?","MergeRequest","MergeRequest.html#method-i-valid_diffs-3F","()",""],["valid_push?","PushEvent","PushEvent.html#method-i-valid_push-3F","()",""],["valid_repo?","Repository","Repository.html#method-i-valid_repo-3F","()",""],["validate_branches","MergeRequest","MergeRequest.html#method-i-validate_branches","()",""],["validate_each","FileSizeValidator","FileSizeValidator.html#method-i-validate_each","(record, attribute, value)",""],["validate_get_request","Grack::Auth","Grack/Auth.html#method-i-validate_get_request","()",""],["validate_post_request","Grack::Auth","Grack/Auth.html#method-i-validate_post_request","()",""],["validates_merge_request","MergeRequestsController","MergeRequestsController.html#method-i-validates_merge_request","()",""],["votes_count","Votes","Votes.html#method-i-votes_count","()","<p>Return the total number of votes\n"],["wall","ProjectsController","ProjectsController.html#method-i-wall","()","<p>Wall\n"],["web_app_url","ApplicationHelper","ApplicationHelper.html#method-i-web_app_url","()",""],["web_url","Project","Project.html#method-i-web_url","()",""],["wiki_notes","Project","Project.html#method-i-wiki_notes","()",""],["without_projects","User","User.html#method-c-without_projects","()",""],["without_repository_callback","UsersProject","UsersProject.html#method-c-without_repository_callback","()",""],["write_key","Gitlab::GitoliteConfig","Gitlab/GitoliteConfig.html#method-i-write_key","(id, key)",""],["README_FOR_APP","","doc/README_FOR_APP.html","","<p>Use this README file to introduce your application and point to useful\nplaces in the API for learning …\n"]]}}
\ No newline at end of file diff --git a/doc/app/js/searcher.js b/doc/app/js/searcher.js new file mode 100644 index 00000000000..f854b541d03 --- /dev/null +++ b/doc/app/js/searcher.js @@ -0,0 +1,228 @@ +Searcher = function(data) { + this.data = data; + this.handlers = []; +} + +Searcher.prototype = new function() { + // search is performed in chunks of 1000 for non-blocking user input + var CHUNK_SIZE = 1000; + // do not try to find more than 100 results + var MAX_RESULTS = 100; + var huid = 1; + var suid = 1; + var runs = 0; + + this.find = function(query) { + var queries = splitQuery(query); + var regexps = buildRegexps(queries); + var highlighters = buildHilighters(queries); + var state = { from: 0, pass: 0, limit: MAX_RESULTS, n: suid++}; + var _this = this; + + this.currentSuid = state.n; + + if (!query) return; + + var run = function() { + // stop current search thread if new search started + if (state.n != _this.currentSuid) return; + + var results = + performSearch(_this.data, regexps, queries, highlighters, state); + var hasMore = (state.limit > 0 && state.pass < 4); + + triggerResults.call(_this, results, !hasMore); + if (hasMore) { + setTimeout(run, 2); + } + runs++; + }; + runs = 0; + + // start search thread + run(); + } + + /* ----- Events ------ */ + this.ready = function(fn) { + fn.huid = huid; + this.handlers.push(fn); + } + + /* ----- Utilities ------ */ + function splitQuery(query) { + return jQuery.grep(query.split(/(\s+|::?|\(\)?)/), function(string) { + return string.match(/\S/) + }); + } + + function buildRegexps(queries) { + return jQuery.map(queries, function(query) { + return new RegExp(query.replace(/(.)/g, '([$1])([^$1]*?)'), 'i') + }); + } + + function buildHilighters(queries) { + return jQuery.map(queries, function(query) { + return jQuery.map(query.split(''), function(l, i) { + return '\u0001$' + (i*2+1) + '\u0002$' + (i*2+2); + }).join(''); + }); + } + + // function longMatchRegexp(index, longIndex, regexps) { + // for (var i = regexps.length - 1; i >= 0; i--){ + // if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) return false; + // }; + // return true; + // } + + + /* ----- Mathchers ------ */ + + /* + * This record matches if the index starts with queries[0] and the record + * matches all of the regexps + */ + function matchPassBeginning(index, longIndex, queries, regexps) { + if (index.indexOf(queries[0]) != 0) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if the longIndex starts with queries[0] and the + * longIndex matches all of the regexps + */ + function matchPassLongIndex(index, longIndex, queries, regexps) { + if (longIndex.indexOf(queries[0]) != 0) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if the index contains queries[0] and the record + * matches all of the regexps + */ + function matchPassContains(index, longIndex, queries, regexps) { + if (index.indexOf(queries[0]) == -1) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + /* + * This record matches if regexps[0] matches the index and the record + * matches all of the regexps + */ + function matchPassRegexp(index, longIndex, queries, regexps) { + if (!index.match(regexps[0])) return false; + for (var i=1, l = regexps.length; i < l; i++) { + if (!index.match(regexps[i]) && !longIndex.match(regexps[i])) + return false; + }; + return true; + } + + + /* ----- Highlighters ------ */ + function highlightRegexp(info, queries, regexps, highlighters) { + var result = createResult(info); + for (var i=0, l = regexps.length; i < l; i++) { + result.title = result.title.replace(regexps[i], highlighters[i]); + result.namespace = result.namespace.replace(regexps[i], highlighters[i]); + }; + return result; + } + + function hltSubstring(string, pos, length) { + return string.substring(0, pos) + '\u0001' + string.substring(pos, pos + length) + '\u0002' + string.substring(pos + length); + } + + function highlightQuery(info, queries, regexps, highlighters) { + var result = createResult(info); + var pos = 0; + var lcTitle = result.title.toLowerCase(); + + pos = lcTitle.indexOf(queries[0]); + if (pos != -1) { + result.title = hltSubstring(result.title, pos, queries[0].length); + } + + result.namespace = result.namespace.replace(regexps[0], highlighters[0]); + for (var i=1, l = regexps.length; i < l; i++) { + result.title = result.title.replace(regexps[i], highlighters[i]); + result.namespace = result.namespace.replace(regexps[i], highlighters[i]); + }; + return result; + } + + function createResult(info) { + var result = {}; + result.title = info[0]; + result.namespace = info[1]; + result.path = info[2]; + result.params = info[3]; + result.snippet = info[4]; + return result; + } + + /* ----- Searching ------ */ + function performSearch(data, regexps, queries, highlighters, state) { + var searchIndex = data.searchIndex; + var longSearchIndex = data.longSearchIndex; + var info = data.info; + var result = []; + var i = state.from; + var l = searchIndex.length; + var togo = CHUNK_SIZE; + var matchFunc, hltFunc; + + while (state.pass < 4 && state.limit > 0 && togo > 0) { + if (state.pass == 0) { + matchFunc = matchPassBeginning; + hltFunc = highlightQuery; + } else if (state.pass == 1) { + matchFunc = matchPassLongIndex; + hltFunc = highlightQuery; + } else if (state.pass == 2) { + matchFunc = matchPassContains; + hltFunc = highlightQuery; + } else if (state.pass == 3) { + matchFunc = matchPassRegexp; + hltFunc = highlightRegexp; + } + + for (; togo > 0 && i < l && state.limit > 0; i++, togo--) { + if (info[i].n == state.n) continue; + if (matchFunc(searchIndex[i], longSearchIndex[i], queries, regexps)) { + info[i].n = state.n; + result.push(hltFunc(info[i], queries, regexps, highlighters)); + state.limit--; + } + }; + if (searchIndex.length <= i) { + state.pass++; + i = state.from = 0; + } else { + state.from = i; + } + } + return result; + } + + function triggerResults(results, isLast) { + jQuery.each(this.handlers, function(i, fn) { + fn.call(this, results, isLast) + }) + } +} + diff --git a/doc/app/rdoc.css b/doc/app/rdoc.css new file mode 100644 index 00000000000..755b5464de5 --- /dev/null +++ b/doc/app/rdoc.css @@ -0,0 +1,543 @@ +/* + * "Darkfish" Rdoc CSS + * $Id: rdoc.css 54 2009-01-27 01:09:48Z deveiant $ + * + * Author: Michael Granger <ged@FaerieMUD.org> + * + */ + +/* Base Green is: #6C8C22 */ + +* { padding: 0; margin: 0; } + +body { + background: #efefef; + font: 14px "Helvetica Neue", Helvetica, Tahoma, sans-serif; + margin-left: 40px; +} +body.file-popup { + font-size: 90%; + margin-left: 0; +} + +h1 { + font-size: 300%; + text-shadow: rgba(135,145,135,0.65) 2px 2px 3px; + color: #6C8C22; +} +h2,h3,h4 { margin-top: 1.5em; } + +:link, +:visited { + color: #6C8C22; + text-decoration: none; +} +:link:hover, +:visited:hover { + border-bottom: 1px dotted #6C8C22; +} + +pre { + background: #ddd; + padding: 0.5em 0; +} + +/* @group Generic Classes */ + +.initially-hidden { + display: none; +} + +#search-field { + width: 98%; + background: #eee; + border: none; + height: 1.5em; + -webkit-border-radius: 4px; +} +#search-field:focus { + background: #f1edba; +} +#search-field:-moz-placeholder, +#search-field::-webkit-input-placeholder { + font-weight: bold; + color: #666; +} + +.missing-docs { + font-size: 120%; + background: white url(images/wrench_orange.png) no-repeat 4px center; + color: #ccc; + line-height: 2em; + border: 1px solid #d00; + opacity: 1; + padding-left: 20px; + text-indent: 24px; + letter-spacing: 3px; + font-weight: bold; + -webkit-border-radius: 5px; + -moz-border-radius: 5px; +} + +.target-section { + border: 2px solid #dcce90; + border-left-width: 8px; + padding: 0 1em; + background: #fff3c2; +} + +/* @end */ + +/* @group Index Page, Standalone file pages */ +.indexpage ul { + line-height: 160%; + list-style: none; +} +.indexpage ul :link, +.indexpage ul :visited { + font-size: 16px; +} + +.indexpage li { + padding-left: 20px; +} + +.indexpage ul > li { + background: url(images/bullet_black.png) no-repeat left 4px; +} +.indexpage li.method { + background: url(images/plugin.png) no-repeat left 4px; +} +.indexpage li.module { + background: url(images/package.png) no-repeat left 4px; +} +.indexpage li.class { + background: url(images/ruby.png) no-repeat left 4px; +} +.indexpage li.file { + background: url(images/page_white_text.png) no-repeat left 4px; +} +.indexpage li li { + background: url(images/tag_blue.png) no-repeat left 4px; +} +.indexpage li .toc-toggle { + width: 16px; + height: 16px; + background: url(images/add.png) no-repeat; +} + +.indexpage li .toc-toggle.open { + background: url(images/delete.png) no-repeat; +} + +/* @end */ + +/* @group Top-Level Structure */ + +#metadata { + float: left; + width: 260px; +} + +#documentation { + margin: 2em 1em 5em 300px; + min-width: 340px; +} + +#validator-badges { + clear: both; + margin: 1em 1em 2em; + font-size: smaller; +} + +/* @end */ + +/* @group Metadata Section */ +#metadata .section { + background-color: #dedede; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border: 1px solid #aaa; + margin: 0 8px 8px; + font-size: 90%; + overflow: hidden; +} +#metadata h3.section-header { + margin: 0; + padding: 2px 8px; + background: #ccc; + color: #666; + -moz-border-radius-topleft: 4px; + -moz-border-radius-topright: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + border-bottom: 1px solid #aaa; +} +#metadata #home-section h3.section-header { + border-bottom: 0; +} + +#metadata ul, +#metadata dl, +#metadata p { + padding: 8px; + list-style: none; +} + +#file-metadata { + margin-top: 2em; +} + +#file-metadata ul { + padding-left: 28px; + list-style-image: url(images/page_green.png); +} + +dl.svninfo { + color: #666; + margin: 0; +} +dl.svninfo dt { + font-weight: bold; +} + +ul.link-list li { + white-space: nowrap; +} +ul.link-list .type { + font-size: 8px; + text-transform: uppercase; + color: white; + background: #969696; + padding: 2px 4px; + -webkit-border-radius: 5px; +} + +/* @end */ + +/* @group Class Metadata Section */ +#class-metadata { + margin-top: 2em; +} +/* @end */ + +/* @group Project Metadata Section */ +#project-metadata { + margin-top: 2em; +} + +#project-metadata .section { + border: 1px solid #aaa; +} +#project-metadata h3.section-header { + border-bottom: 1px solid #aaa; + position: relative; +} + +#project-metadata form { + color: #777; + background: #ccc; +} + +/* @end */ + +/* @group Documentation Section */ +.description { + font-size: 100%; + color: #333; +} + +.description p { + margin: 1em 0.4em; +} + +.description li p { + margin: 0; +} + +.description ol, +.description ul { + margin-left: 1.5em; +} +.description ol li, +.description ul li { + line-height: 1.4em; +} + +.note-list { + margin: 8px 0; +} + +.label-list { + margin: 8px 1.5em; + border: 1px solid #ccc; +} +.description .label-list { + font-size: 14px; +} + +.note-list dt { + font-weight: bold; +} +.note-list dd { + padding: 0 12px; +} + +.label-list dt { + padding: 2px 4px; + font-weight: bold; + background: #ddd; +} +.label-list dd { + padding: 2px 12px; +} +.label-list dd + dt, +.note-list dd + dt { + margin-top: 0.7em; +} + +#documentation .section { + font-size: 90%; +} + +#documentation h2.section-header { + margin-top: 1em; + padding: 0.25em 0.5em; + background: #ccc; + color: #333; + font-size: 175%; + border: 1px solid #bbb; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; +} + +.documentation-section-title { + position: relative; +} +.documentation-section-title .section-click-top { + position: absolute; + top: 6px; + right: 12px; + font-size: 10px; + color: #9b9877; + visibility: hidden; + padding-right: 0.5px; +} + +.documentation-section-title:hover .section-click-top { + visibility: visible; +} + +#documentation h3.section-header { + margin-top: 1em; + padding: 0.25em 0.5em; + background-color: #dedede; + color: #333; + font-size: 150%; + border: 1px solid #bbb; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; +} + +#constants-list > dl, +#attributes-list > dl { + margin: 1em 0 2em; + border: 0; +} +#constants-list > dl dt, +#attributes-list > dl dt { + padding-left: 0; + font-weight: bold; + font-family: Monaco, "Andale Mono"; + background: inherit; +} +#constants-list > dl dt a, +#attributes-list > dl dt a { + color: inherit; +} +#constants-list > dl dd, +#attributes-list > dl dd { + margin: 0 0 1em 0; + padding: 0; + color: #666; +} + +.documentation-section h2 { + position: relative; +} + +.documentation-section h2 a { + position: absolute; + top: 8px; + right: 10px; + font-size: 12px; + color: #9b9877; + visibility: hidden; +} + +.documentation-section h2:hover a { + visibility: visible; +} + +/* @group Method Details */ + +#documentation .method-source-code { + display: none; +} + +#documentation .method-detail { + margin: 0.5em 0; + padding: 0.5em 0; + cursor: pointer; +} +#documentation .method-detail:hover { + background-color: #f1edba; +} +#documentation .method-heading { + position: relative; + padding: 2px 4px 0 20px; + font-size: 125%; + font-weight: bold; + color: #333; + background: url(images/brick.png) no-repeat left bottom; +} +#documentation .method-heading :link, +#documentation .method-heading :visited { + color: inherit; +} +#documentation .method-click-advice { + position: absolute; + top: 2px; + right: 5px; + font-size: 10px; + color: #9b9877; + visibility: hidden; + padding-right: 20px; + line-height: 20px; + background: url(images/zoom.png) no-repeat right top; +} +#documentation .method-heading:hover .method-click-advice { + visibility: visible; +} + +#documentation .method-alias .method-heading { + color: #666; + background: url(images/brick_link.png) no-repeat left bottom; +} + +#documentation .method-description, +#documentation .aliases { + margin: 0 20px; + color: #666; +} + +#documentation .method-description p, +#documentation .aliases p { + line-height: 1.2em; +} + +#documentation .aliases { + padding-top: 4px; + font-style: italic; + cursor: default; +} +#documentation .method-description p { + margin-bottom: 0.5em; +} +#documentation .method-description ul { + margin-left: 1.5em; +} +pre { + margin: 0.5em 0; +} + +#documentation .attribute-method-heading { + background: url(images/tag_green.png) no-repeat left bottom; +} +#documentation #attribute-method-details .method-detail:hover { + background-color: transparent; + cursor: default; +} +#documentation .attribute-access-type { + font-size: 60%; + text-transform: uppercase; + vertical-align: super; + padding: 0 2px; +} +/* @end */ + +/* @end */ + +/* @group Source Code */ + +pre { + overflow: auto; + background: #262626; + color: white; + border: 1px dashed #999; + padding: 0.5em; +} + +.description pre { + margin: 0 0.4em; +} + +.ruby-constant { color: #7fffd4; background: transparent; } +.ruby-keyword { color: #00ffff; background: transparent; } +.ruby-ivar { color: #eedd82; background: transparent; } +.ruby-operator { color: #00ffee; background: transparent; } +.ruby-identifier { color: #ffdead; background: transparent; } +.ruby-node { color: #ffa07a; background: transparent; } +.ruby-comment { color: #dc0000; font-weight: bold; background: transparent; } +.ruby-regexp { color: #ffa07a; background: transparent; } +.ruby-value { color: #7fffd4; background: transparent; } + +/* @end */ + + +/* @group search results */ +#search-results h1 { + font-size: 1em; + font-weight: normal; + text-shadow: none; +} + +#search-results .current { + background: #ccc; + border-bottom: 1px solid transparent; +} + +#search-results li { + list-style: none; + border-bottom: 1px solid #aaa; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; + margin-bottom: 0.5em; +} + +#search-results li:last-child { + border-bottom: none; + margin-bottom: 0; +} + +#search-results li p { + padding: 0; + margin: 0.5em; +} + +#search-results .search-namespace { + font-weight: bold; +} + +#search-results li em { + background: yellow; + font-style: normal; +} + +#search-results pre { + margin: 0.5em; +} + +/* @end */ + diff --git a/doc/app/table_of_contents.html b/doc/app/table_of_contents.html new file mode 100644 index 00000000000..87a21cb4c97 --- /dev/null +++ b/doc/app/table_of_contents.html @@ -0,0 +1,1858 @@ +<!DOCTYPE html> + +<html> +<head> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> + +<title>Table of Contents - Rails Application Documentation</title> + +<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> + +<script type="text/javascript"> + var rdoc_rel_prefix = "./"; +</script> + +<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> +<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + + +<body class="indexpage"> +<h1>Table of Contents - Rails Application Documentation</h1> + +<h2>Pages</h2> +<ul> + <li class="file"> + <a href="doc/README_FOR_APP.html">README_FOR_APP</a> + </li> + +</ul> + +<h2 id="classes">Classes/Modules</h2> +<ul> + <li class="module"> + <a href="Gitlab.html">Gitlab</a> + </li> + <li class="class"> + <a href="Gitlab/API.html">Gitlab::API</a> + </li> + <li class="module"> + <a href="Gitlab/APIHelpers.html">Gitlab::APIHelpers</a> + </li> + <li class="class"> + <a href="Gitlab/AppLogger.html">Gitlab::AppLogger</a> + </li> + <li class="class"> + <a href="Gitlab/Auth.html">Gitlab::Auth</a> + </li> + <li class="module"> + <a href="Gitlab/Encode.html">Gitlab::Encode</a> + </li> + <li class="module"> + <a href="Gitlab/Entities.html">Gitlab::Entities</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/Hook.html">Gitlab::Entities::Hook</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/Issue.html">Gitlab::Entities::Issue</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/Milestone.html">Gitlab::Entities::Milestone</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/Project.html">Gitlab::Entities::Project</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/ProjectMember.html">Gitlab::Entities::ProjectMember</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/ProjectSnippet.html">Gitlab::Entities::ProjectSnippet</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/RepoCommit.html">Gitlab::Entities::RepoCommit</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/RepoObject.html">Gitlab::Entities::RepoObject</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/SSHKey.html">Gitlab::Entities::SSHKey</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/User.html">Gitlab::Entities::User</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/UserBasic.html">Gitlab::Entities::UserBasic</a> + </li> + <li class="class"> + <a href="Gitlab/Entities/UserLogin.html">Gitlab::Entities::UserLogin</a> + </li> + <li class="class"> + <a href="Gitlab/FileEditor.html">Gitlab::FileEditor</a> + </li> + <li class="class"> + <a href="Gitlab/GitLogger.html">Gitlab::GitLogger</a> + </li> + <li class="class"> + <a href="Gitlab/Gitolite.html">Gitlab::Gitolite</a> + </li> + <li class="class"> + <a href="Gitlab/Gitolite/AccessDenied.html">Gitlab::Gitolite::AccessDenied</a> + </li> + <li class="class"> + <a href="Gitlab/GitoliteConfig.html">Gitlab::GitoliteConfig</a> + </li> + <li class="class"> + <a href="Gitlab/GitoliteConfig/PullError.html">Gitlab::GitoliteConfig::PullError</a> + </li> + <li class="class"> + <a href="Gitlab/GitoliteConfig/PushError.html">Gitlab::GitoliteConfig::PushError</a> + </li> + <li class="class"> + <a href="Gitlab/GraphCommit.html">Gitlab::GraphCommit</a> + </li> + <li class="class"> + <a href="Gitlab/InlineDiff.html">Gitlab::InlineDiff</a> + </li> + <li class="class"> + <a href="Gitlab/Issues.html">Gitlab::Issues</a> + </li> + <li class="class"> + <a href="Gitlab/Logger.html">Gitlab::Logger</a> + </li> + <li class="module"> + <a href="Gitlab/Markdown.html">Gitlab::Markdown</a> + </li> + <li class="class"> + <a href="Gitlab/Merge.html">Gitlab::Merge</a> + </li> + <li class="class"> + <a href="Gitlab/Milestones.html">Gitlab::Milestones</a> + </li> + <li class="class"> + <a href="Gitlab/Projects.html">Gitlab::Projects</a> + </li> + <li class="class"> + <a href="Gitlab/Satellite.html">Gitlab::Satellite</a> + </li> + <li class="class"> + <a href="Gitlab/Session.html">Gitlab::Session</a> + </li> + <li class="class"> + <a href="Gitlab/Theme.html">Gitlab::Theme</a> + </li> + <li class="class"> + <a href="Gitlab/Users.html">Gitlab::Users</a> + </li> + <li class="module"> + <a href="Admin.html">Admin</a> + </li> + <li class="class"> + <a href="Admin/DashboardController.html">Admin::DashboardController</a> + </li> + <li class="class"> + <a href="Admin/GroupsController.html">Admin::GroupsController</a> + </li> + <li class="class"> + <a href="Admin/HooksController.html">Admin::HooksController</a> + </li> + <li class="class"> + <a href="Admin/LogsController.html">Admin::LogsController</a> + </li> + <li class="class"> + <a href="Admin/ProjectsController.html">Admin::ProjectsController</a> + </li> + <li class="class"> + <a href="Admin/ResqueController.html">Admin::ResqueController</a> + </li> + <li class="class"> + <a href="Admin/TeamMembersController.html">Admin::TeamMembersController</a> + </li> + <li class="class"> + <a href="Admin/UsersController.html">Admin::UsersController</a> + </li> + <li class="module"> + <a href="Notes.html">Notes</a> + </li> + <li class="class"> + <a href="Notes/CreateContext.html">Notes::CreateContext</a> + </li> + <li class="class"> + <a href="Notes/LoadContext.html">Notes::LoadContext</a> + </li> + <li class="module"> + <a href="Redcarpet.html">Redcarpet</a> + </li> + <li class="module"> + <a href="Redcarpet/Render.html">Redcarpet::Render</a> + </li> + <li class="class"> + <a href="Redcarpet/Render/GitlabHTML.html">Redcarpet::Render::GitlabHTML</a> + </li> + <li class="module"> + <a href="ExtractsPath.html">ExtractsPath</a> + </li> + <li class="class"> + <a href="ExtractsPath/InvalidPathError.html">ExtractsPath::InvalidPathError</a> + </li> + <li class="class"> + <a href="FileSizeValidator.html">FileSizeValidator</a> + </li> + <li class="class"> + <a href="FileSizeValidator/Helper.html">FileSizeValidator::Helper</a> + </li> + <li class="module"> + <a href="Grack.html">Grack</a> + </li> + <li class="class"> + <a href="Grack/Auth.html">Grack::Auth</a> + </li> + <li class="module"> + <a href="IssueCommonality.html">IssueCommonality</a> + </li> + <li class="module"> + <a href="IssueCommonality/ClassMethods.html">IssueCommonality::ClassMethods</a> + </li> + <li class="module"> + <a href="StaticModel.html">StaticModel</a> + </li> + <li class="module"> + <a href="StaticModel/ClassMethods.html">StaticModel::ClassMethods</a> + </li> + <li class="class"> + <a href="Ability.html">Ability</a> + </li> + <li class="module"> + <a href="Account.html">Account</a> + </li> + <li class="class"> + <a href="ActivityObserver.html">ActivityObserver</a> + </li> + <li class="class"> + <a href="AdminController.html">AdminController</a> + </li> + <li class="class"> + <a href="ApplicationController.html">ApplicationController</a> + </li> + <li class="class"> + <a href="ApplicationDecorator.html">ApplicationDecorator</a> + </li> + <li class="module"> + <a href="ApplicationHelper.html">ApplicationHelper</a> + </li> + <li class="class"> + <a href="AttachmentUploader.html">AttachmentUploader</a> + </li> + <li class="module"> + <a href="Authority.html">Authority</a> + </li> + <li class="class"> + <a href="BaseContext.html">BaseContext</a> + </li> + <li class="class"> + <a href="BlameController.html">BlameController</a> + </li> + <li class="class"> + <a href="BlobController.html">BlobController</a> + </li> + <li class="class"> + <a href="Commit.html">Commit</a> + </li> + <li class="class"> + <a href="CommitController.html">CommitController</a> + </li> + <li class="class"> + <a href="CommitDecorator.html">CommitDecorator</a> + </li> + <li class="class"> + <a href="CommitLoadContext.html">CommitLoadContext</a> + </li> + <li class="class"> + <a href="CommitsController.html">CommitsController</a> + </li> + <li class="module"> + <a href="CommitsHelper.html">CommitsHelper</a> + </li> + <li class="class"> + <a href="CompareController.html">CompareController</a> + </li> + <li class="class"> + <a href="DashboardController.html">DashboardController</a> + </li> + <li class="class"> + <a href="DeployKeysController.html">DeployKeysController</a> + </li> + <li class="class"> + <a href="ErrorsController.html">ErrorsController</a> + </li> + <li class="class"> + <a href="Event.html">Event</a> + </li> + <li class="class"> + <a href="EventDecorator.html">EventDecorator</a> + </li> + <li class="module"> + <a href="EventsHelper.html">EventsHelper</a> + </li> + <li class="module"> + <a href="GitHost.html">GitHost</a> + </li> + <li class="module"> + <a href="GitlabMarkdownHelper.html">GitlabMarkdownHelper</a> + </li> + <li class="class"> + <a href="Group.html">Group</a> + </li> + <li class="class"> + <a href="GroupsController.html">GroupsController</a> + </li> + <li class="class"> + <a href="HelpController.html">HelpController</a> + </li> + <li class="class"> + <a href="HooksController.html">HooksController</a> + </li> + <li class="class"> + <a href="Issue.html">Issue</a> + </li> + <li class="class"> + <a href="IssueObserver.html">IssueObserver</a> + </li> + <li class="class"> + <a href="IssuesBulkUpdateContext.html">IssuesBulkUpdateContext</a> + </li> + <li class="class"> + <a href="IssuesController.html">IssuesController</a> + </li> + <li class="module"> + <a href="IssuesHelper.html">IssuesHelper</a> + </li> + <li class="class"> + <a href="IssuesListContext.html">IssuesListContext</a> + </li> + <li class="class"> + <a href="Key.html">Key</a> + </li> + <li class="class"> + <a href="KeyObserver.html">KeyObserver</a> + </li> + <li class="class"> + <a href="KeysController.html">KeysController</a> + </li> + <li class="class"> + <a href="LabelsController.html">LabelsController</a> + </li> + <li class="class"> + <a href="MergeRequest.html">MergeRequest</a> + </li> + <li class="class"> + <a href="MergeRequestObserver.html">MergeRequestObserver</a> + </li> + <li class="class"> + <a href="MergeRequestsController.html">MergeRequestsController</a> + </li> + <li class="module"> + <a href="MergeRequestsHelper.html">MergeRequestsHelper</a> + </li> + <li class="class"> + <a href="MergeRequestsLoadContext.html">MergeRequestsLoadContext</a> + </li> + <li class="class"> + <a href="Milestone.html">Milestone</a> + </li> + <li class="class"> + <a href="MilestonesController.html">MilestonesController</a> + </li> + <li class="class"> + <a href="Note.html">Note</a> + </li> + <li class="class"> + <a href="NoteObserver.html">NoteObserver</a> + </li> + <li class="class"> + <a href="NotesController.html">NotesController</a> + </li> + <li class="module"> + <a href="NotesHelper.html">NotesHelper</a> + </li> + <li class="class"> + <a href="Notify.html">Notify</a> + </li> + <li class="class"> + <a href="OmniauthCallbacksController.html">OmniauthCallbacksController</a> + </li> + <li class="class"> + <a href="PostReceive.html">PostReceive</a> + </li> + <li class="class"> + <a href="ProfileController.html">ProfileController</a> + </li> + <li class="module"> + <a href="ProfileHelper.html">ProfileHelper</a> + </li> + <li class="class"> + <a href="Project.html">Project</a> + </li> + <li class="class"> + <a href="ProjectHook.html">ProjectHook</a> + </li> + <li class="class"> + <a href="ProjectObserver.html">ProjectObserver</a> + </li> + <li class="class"> + <a href="ProjectResourceController.html">ProjectResourceController</a> + </li> + <li class="class"> + <a href="ProjectsController.html">ProjectsController</a> + </li> + <li class="module"> + <a href="ProjectsHelper.html">ProjectsHelper</a> + </li> + <li class="class"> + <a href="ProtectedBranch.html">ProtectedBranch</a> + </li> + <li class="class"> + <a href="ProtectedBranchesController.html">ProtectedBranchesController</a> + </li> + <li class="module"> + <a href="PushEvent.html">PushEvent</a> + </li> + <li class="module"> + <a href="PushObserver.html">PushObserver</a> + </li> + <li class="class"> + <a href="RefsController.html">RefsController</a> + </li> + <li class="class"> + <a href="RepositoriesController.html">RepositoriesController</a> + </li> + <li class="module"> + <a href="Repository.html">Repository</a> + </li> + <li class="class"> + <a href="SearchContext.html">SearchContext</a> + </li> + <li class="class"> + <a href="SearchController.html">SearchController</a> + </li> + <li class="class"> + <a href="Snippet.html">Snippet</a> + </li> + <li class="class"> + <a href="SnippetsController.html">SnippetsController</a> + </li> + <li class="module"> + <a href="SnippetsHelper.html">SnippetsHelper</a> + </li> + <li class="class"> + <a href="SystemHook.html">SystemHook</a> + </li> + <li class="class"> + <a href="SystemHookObserver.html">SystemHookObserver</a> + </li> + <li class="class"> + <a href="SystemHookWorker.html">SystemHookWorker</a> + </li> + <li class="module"> + <a href="TabHelper.html">TabHelper</a> + </li> + <li class="module"> + <a href="TagsHelper.html">TagsHelper</a> + </li> + <li class="module"> + <a href="Team.html">Team</a> + </li> + <li class="class"> + <a href="TeamMembersController.html">TeamMembersController</a> + </li> + <li class="class"> + <a href="TestHookContext.html">TestHookContext</a> + </li> + <li class="class"> + <a href="Tree.html">Tree</a> + </li> + <li class="class"> + <a href="TreeController.html">TreeController</a> + </li> + <li class="class"> + <a href="TreeDecorator.html">TreeDecorator</a> + </li> + <li class="module"> + <a href="TreeHelper.html">TreeHelper</a> + </li> + <li class="class"> + <a href="User.html">User</a> + </li> + <li class="class"> + <a href="UserObserver.html">UserObserver</a> + </li> + <li class="class"> + <a href="UsersProject.html">UsersProject</a> + </li> + <li class="class"> + <a href="UsersProjectObserver.html">UsersProjectObserver</a> + </li> + <li class="module"> + <a href="Votes.html">Votes</a> + </li> + <li class="class"> + <a href="WebHook.html">WebHook</a> + </li> + <li class="class"> + <a href="Wiki.html">Wiki</a> + </li> + <li class="class"> + <a href="WikisController.html">WikisController</a> + </li> + +</ul> + +<h2 id="methods">Methods</h2> +<ul> + + <li class="method"><a href="Gitlab/InlineDiff.html#method-c-_indexes_of_changed_lines">::_indexes_of_changed_lines — Gitlab::InlineDiff</a> + + <li class="method"><a href="Project.html#method-c-access_options">::access_options — Project</a> + + <li class="method"><a href="UsersProject.html#method-c-access_roles">::access_roles — UsersProject</a> + + <li class="method"><a href="Milestone.html#method-c-active">::active — Milestone</a> + + <li class="method"><a href="Project.html#method-c-active">::active — Project</a> + + <li class="method"><a href="SystemHook.html#method-c-all_hooks_fire">::all_hooks_fire — SystemHook</a> + + <li class="method"><a href="Ability.html#method-c-allowed">::allowed — Ability</a> + + <li class="method"><a href="Gitlab/Logger.html#method-c-build">::build — Gitlab::Logger</a> + + <li class="method"><a href="UsersProject.html#method-c-bulk_delete">::bulk_delete — UsersProject</a> + + <li class="method"><a href="UsersProject.html#method-c-bulk_import">::bulk_import — UsersProject</a> + + <li class="method"><a href="UsersProject.html#method-c-bulk_update">::bulk_update — UsersProject</a> + + <li class="method"><a href="Commit.html#method-c-commits">::commits — Commit</a> + + <li class="method"><a href="Commit.html#method-c-commits_between">::commits_between — Commit</a> + + <li class="method"><a href="Commit.html#method-c-commits_since">::commits_since — Commit</a> + + <li class="method"><a href="Commit.html#method-c-commits_with_refs">::commits_with_refs — Commit</a> + + <li class="method"><a href="Commit.html#method-c-compare">::compare — Commit</a> + + <li class="method"><a href="Snippet.html#method-c-content_types">::content_types — Snippet</a> + + <li class="method"><a href="Project.html#method-c-create_by_user">::create_by_user — Project</a> + + <li class="method"><a href="User.html#method-c-create_from_omniauth">::create_from_omniauth — User</a> + + <li class="method"><a href="Note.html#method-c-create_status_change_note">::create_status_change_note — Note</a> + + <li class="method"><a href="Gitlab/Theme.html#method-c-css_class_by_id">::css_class_by_id — Gitlab::Theme</a> + + <li class="method"><a href="Event.html#method-c-determine_action">::determine_action — Event</a> + + <li class="method"><a href="Gitlab/Logger.html#method-c-error">::error — Gitlab::Logger</a> + + <li class="method"><a href="Gitlab/GitLogger.html#method-c-file_name">::file_name — Gitlab::GitLogger</a> + + <li class="method"><a href="Gitlab/AppLogger.html#method-c-file_name">::file_name — Gitlab::AppLogger</a> + + <li class="method"><a href="User.html#method-c-filter">::filter — User</a> + + <li class="method"><a href="MergeRequest.html#method-c-find_all_by_branch">::find_all_by_branch — MergeRequest</a> + + <li class="method"><a href="User.html#method-c-find_for_ldap_auth">::find_for_ldap_auth — User</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-c-find_free_space">::find_free_space — Gitlab::GraphCommit</a> + + <li class="method"><a href="Commit.html#method-c-find_or_first">::find_or_first — Commit</a> + + <li class="method"><a href="User.html#method-c-find_or_new_for_omniauth">::find_or_new_for_omniauth — User</a> + + <li class="method"><a href="Commit.html#method-c-fresh_commits">::fresh_commits — Commit</a> + + <li class="method"><a href="User.html#method-c-gitlab_auth">::gitlab_auth — User</a> + + <li class="method"><a href="UsersProject.html#method-c-import_team">::import_team — UsersProject</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-c-index_commits">::index_commits — Gitlab::GraphCommit</a> + + <li class="method"><a href="Gitlab/Logger.html#method-c-info">::info — Gitlab::Logger</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-c-mark_reserved">::mark_reserved — Gitlab::GraphCommit</a> + + <li class="method"><a href="Redcarpet/Render/GitlabHTML.html#method-c-new">::new — Redcarpet::Render::GitlabHTML</a> + + <li class="method"><a href="FileSizeValidator.html#method-c-new">::new — FileSizeValidator</a> + + <li class="method"><a href="BaseContext.html#method-c-new">::new — BaseContext</a> + + <li class="method"><a href="SearchContext.html#method-c-new">::new — SearchContext</a> + + <li class="method"><a href="Tree.html#method-c-new">::new — Tree</a> + + <li class="method"><a href="Commit.html#method-c-new">::new — Commit</a> + + <li class="method"><a href="Gitlab/Merge.html#method-c-new">::new — Gitlab::Merge</a> + + <li class="method"><a href="Gitlab/FileEditor.html#method-c-new">::new — Gitlab::FileEditor</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-c-new">::new — Gitlab::GraphCommit</a> + + <li class="method"><a href="Gitlab/Satellite.html#method-c-new">::new — Gitlab::Satellite</a> + + <li class="method"><a href="Issue.html#method-c-open_for">::open_for — Issue</a> + + <li class="method"><a href="PostReceive.html#method-c-perform">::perform — PostReceive</a> + + <li class="method"><a href="SystemHookWorker.html#method-c-perform">::perform — SystemHookWorker</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-c-place_chain">::place_chain — Gitlab::GraphCommit</a> + + <li class="method"><a href="Gitlab/InlineDiff.html#method-c-processing">::processing — Gitlab::InlineDiff</a> + + <li class="method"><a href="Ability.html#method-c-project_abilities">::project_abilities — Ability</a> + + <li class="method"><a href="Gitlab/Logger.html#method-c-read_latest">::read_latest — Gitlab::Logger</a> + + <li class="method"><a href="Wiki.html#method-c-regenerate_from">::regenerate_from — Wiki</a> + + <li class="method"><a href="Gitlab/InlineDiff.html#method-c-replace_markers">::replace_markers — Gitlab::InlineDiff</a> + + <li class="method"><a href="Group.html#method-c-search">::search — Group</a> + + <li class="method"><a href="Project.html#method-c-search">::search — Project</a> + + <li class="method"><a href="User.html#method-c-search">::search — User</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-c-take_left_leaves">::take_left_leaves — Gitlab::GraphCommit</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-c-to_graph">::to_graph — Gitlab::GraphCommit</a> + + <li class="method"><a href="UsersProject.html#method-c-user_bulk_import">::user_bulk_import — UsersProject</a> + + <li class="method"><a href="User.html#method-c-without_projects">::without_projects — User</a> + + <li class="method"><a href="UsersProject.html#method-c-without_repository_callback">::without_repository_callback — UsersProject</a> + + <li class="method"><a href="StaticModel.html#method-i-3D-3D">#== — StaticModel</a> + + <li class="method"><a href="StaticModel.html#method-i-5B-5D">#[] — StaticModel</a> + + <li class="method"><a href="Grack/Auth.html#method-i-abilities">#abilities — Grack::Auth</a> + + <li class="method"><a href="BaseContext.html#method-i-abilities">#abilities — BaseContext</a> + + <li class="method"><a href="ApplicationController.html#method-i-abilities">#abilities — ApplicationController</a> + + <li class="method"><a href="ApplicationController.html#method-i-access_denied-21">#access_denied! — ApplicationController</a> + + <li class="method"><a href="Event.html#method-i-action_name">#action_name — Event</a> + + <li class="method"><a href="Authority.html#method-i-add_access">#add_access — Authority</a> + + <li class="method"><a href="ApplicationController.html#method-i-add_project_abilities">#add_project_abilities — ApplicationController</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-i-add_refs">#add_refs — Gitlab::GraphCommit</a> + + <li class="method"><a href="Team.html#method-i-add_user_id_to_team">#add_user_id_to_team — Team</a> + + <li class="method"><a href="Team.html#method-i-add_user_to_team">#add_user_to_team — Team</a> + + <li class="method"><a href="Team.html#method-i-add_users_ids_to_team">#add_users_ids_to_team — Team</a> + + <li class="method"><a href="Team.html#method-i-add_users_to_team">#add_users_to_team — Team</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-admin_all_repo">#admin_all_repo — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-admin_all_repo-21">#admin_all_repo! — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="UsersProjectObserver.html#method-i-after_commit">#after_commit — UsersProjectObserver</a> + + <li class="method"><a href="IssueObserver.html#method-i-after_create">#after_create — IssueObserver</a> + + <li class="method"><a href="SystemHookObserver.html#method-i-after_create">#after_create — SystemHookObserver</a> + + <li class="method"><a href="ActivityObserver.html#method-i-after_create">#after_create — ActivityObserver</a> + + <li class="method"><a href="UsersProjectObserver.html#method-i-after_create">#after_create — UsersProjectObserver</a> + + <li class="method"><a href="NoteObserver.html#method-i-after_create">#after_create — NoteObserver</a> + + <li class="method"><a href="MergeRequestObserver.html#method-i-after_create">#after_create — MergeRequestObserver</a> + + <li class="method"><a href="UserObserver.html#method-i-after_create">#after_create — UserObserver</a> + + <li class="method"><a href="ProjectObserver.html#method-i-after_create">#after_create — ProjectObserver</a> + + <li class="method"><a href="UserObserver.html#method-i-after_destroy">#after_destroy — UserObserver</a> + + <li class="method"><a href="ProjectObserver.html#method-i-after_destroy">#after_destroy — ProjectObserver</a> + + <li class="method"><a href="SystemHookObserver.html#method-i-after_destroy">#after_destroy — SystemHookObserver</a> + + <li class="method"><a href="KeyObserver.html#method-i-after_destroy">#after_destroy — KeyObserver</a> + + <li class="method"><a href="UsersProjectObserver.html#method-i-after_destroy">#after_destroy — UsersProjectObserver</a> + + <li class="method"><a href="KeyObserver.html#method-i-after_save">#after_save — KeyObserver</a> + + <li class="method"><a href="ActivityObserver.html#method-i-after_save">#after_save — ActivityObserver</a> + + <li class="method"><a href="ProjectObserver.html#method-i-after_save">#after_save — ProjectObserver</a> + + <li class="method"><a href="ApplicationController.html#method-i-after_sign_in_path_for">#after_sign_in_path_for — ApplicationController</a> + + <li class="method"><a href="IssueObserver.html#method-i-after_update">#after_update — IssueObserver</a> + + <li class="method"><a href="MergeRequestObserver.html#method-i-after_update">#after_update — MergeRequestObserver</a> + + <li class="method"><a href="Authority.html#method-i-allow_read_for-3F">#allow_read_for? — Authority</a> + + <li class="method"><a href="Event.html#method-i-allowed-3F">#allowed? — Event</a> + + <li class="method"><a href="TreeHelper.html#method-i-allowed_tree_edit-3F">#allowed_tree_edit? — TreeHelper</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-app_theme">#app_theme — ApplicationHelper</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-apply">#apply — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="TeamMembersController.html#method-i-apply_import">#apply_import — TeamMembersController</a> + + <li class="method"><a href="RepositoriesController.html#method-i-archive">#archive — RepositoriesController</a> + + <li class="method"><a href="Repository.html#method-i-archive_repo">#archive_repo — Repository</a> + + <li class="method"><a href="ExtractsPath.html#method-i-assign_ref_vars">#assign_ref_vars — ExtractsPath</a> + + <li class="method"><a href="SystemHook.html#method-i-async_execute">#async_execute — SystemHook</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-attributes_for_keys">#attributes_for_keys — Gitlab::APIHelpers</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-authbutton">#authbutton — ApplicationHelper</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-authenticate-21">#authenticate! — Gitlab::APIHelpers</a> + + <li class="method"><a href="AdminController.html#method-i-authenticate_admin-21">#authenticate_admin! — AdminController</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-authenticated_as_admin-21">#authenticated_as_admin! — Gitlab::APIHelpers</a> + + <li class="method"><a href="Event.html#method-i-author">#author — Event</a> + + <li class="method"><a href="Commit.html#method-i-author_email">#author_email — Commit</a> + + <li class="method"><a href="CommitDecorator.html#method-i-author_link">#author_link — CommitDecorator</a> + + <li class="method"><a href="Commit.html#method-i-author_name">#author_name — Commit</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-authorize-21">#authorize! — Gitlab::APIHelpers</a> + + <li class="method"><a href="IssuesController.html#method-i-authorize_admin_issue-21">#authorize_admin_issue! — IssuesController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-authorize_admin_merge_request-21">#authorize_admin_merge_request! — MergeRequestsController</a> + + <li class="method"><a href="MilestonesController.html#method-i-authorize_admin_milestone-21">#authorize_admin_milestone! — MilestonesController</a> + + <li class="method"><a href="SnippetsController.html#method-i-authorize_admin_snippet-21">#authorize_admin_snippet! — SnippetsController</a> + + <li class="method"><a href="ApplicationController.html#method-i-authorize_code_access-21">#authorize_code_access! — ApplicationController</a> + + <li class="method"><a href="IssuesController.html#method-i-authorize_modify_issue-21">#authorize_modify_issue! — IssuesController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-authorize_modify_merge_request-21">#authorize_modify_merge_request! — MergeRequestsController</a> + + <li class="method"><a href="SnippetsController.html#method-i-authorize_modify_snippet-21">#authorize_modify_snippet! — SnippetsController</a> + + <li class="method"><a href="ApplicationController.html#method-i-authorize_project-21">#authorize_project! — ApplicationController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-automerge">#automerge — MergeRequestsController</a> + + <li class="method"><a href="MergeRequest.html#method-i-automerge-21">#automerge! — MergeRequest</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-automerge_check">#automerge_check — MergeRequestsController</a> + + <li class="method"><a href="StaticModel/ClassMethods.html#method-i-base_class">#base_class — StaticModel::ClassMethods</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-block">#block — Admin::UsersController</a> + + <li class="method"><a href="Account.html#method-i-block">#block — Account</a> + + <li class="method"><a href="Redcarpet/Render/GitlabHTML.html#method-i-block_code">#block_code — Redcarpet::Render::GitlabHTML</a> + + <li class="method"><a href="PushEvent.html#method-i-branch-3F">#branch? — PushEvent</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-branch_from">#branch_from — MergeRequestsController</a> + + <li class="method"><a href="PushEvent.html#method-i-branch_name">#branch_name — PushEvent</a> + + <li class="method"><a href="Repository.html#method-i-branch_names">#branch_names — Repository</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-branch_to">#branch_to — MergeRequestsController</a> + + <li class="method"><a href="Repository.html#method-i-branches">#branches — Repository</a> + + <li class="method"><a href="RepositoriesController.html#method-i-branches">#branches — RepositoriesController</a> + + <li class="method"><a href="TabHelper.html#method-i-branches_tab_class">#branches_tab_class — TabHelper</a> + + <li class="method"><a href="TreeDecorator.html#method-i-breadcrumbs">#breadcrumbs — TreeDecorator</a> + + <li class="method"><a href="MergeRequest.html#method-i-broken_diffs-3F">#broken_diffs? — MergeRequest</a> + + <li class="method"><a href="Project.html#method-i-build_commit_note">#build_commit_note — Project</a> + + <li class="method"><a href="CommitsHelper.html#method-i-build_line_anchor">#build_line_anchor — CommitsHelper</a> + + <li class="method"><a href="IssuesController.html#method-i-bulk_update">#bulk_update — IssuesController</a> + + <li class="method"><a href="BaseContext.html#method-i-can-3F">#can? — BaseContext</a> + + <li class="method"><a href="Grack/Auth.html#method-i-can-3F">#can? — Grack::Auth</a> + + <li class="method"><a href="ApplicationController.html#method-i-can-3F">#can? — ApplicationController</a> + + <li class="method"><a href="Gitlab/Merge.html#method-i-can_be_merged-3F">#can_be_merged? — Gitlab::Merge</a> + + <li class="method"><a href="MergeRequest.html#method-i-can_be_merged-3F">#can_be_merged? — MergeRequest</a> + + <li class="method"><a href="Account.html#method-i-can_create_group-3F">#can_create_group? — Account</a> + + <li class="method"><a href="Account.html#method-i-can_create_project-3F">#can_create_project? — Account</a> + + <li class="method"><a href="Gitlab/FileEditor.html#method-i-can_edit-3F">#can_edit? — Gitlab::FileEditor</a> + + <li class="method"><a href="Account.html#method-i-cared_merge_requests">#cared_merge_requests — Account</a> + + <li class="method"><a href="Event.html#method-i-changed_issue-3F">#changed_issue? — Event</a> + + <li class="method"><a href="Event.html#method-i-changed_merge_request-3F">#changed_merge_request? — Event</a> + + <li class="method"><a href="MergeRequest.html#method-i-check_if_can_be_merged">#check_if_can_be_merged — MergeRequest</a> + + <li class="method"><a href="Project.html#method-i-check_limit">#check_limit — Project</a> + + <li class="method"><a href="FileSizeValidator.html#method-i-check_validity-21">#check_validity! — FileSizeValidator</a> + + <li class="method"><a href="Gitlab/Satellite.html#method-i-clear">#clear — Gitlab::Satellite</a> + + <li class="method"><a href="Event.html#method-i-closed-3F">#closed? — Event</a> + + <li class="method"><a href="MergeRequest.html#method-i-closed_event">#closed_event — MergeRequest</a> + + <li class="method"><a href="ProtectedBranch.html#method-i-commit">#commit — ProtectedBranch</a> + + <li class="method"><a href="Repository.html#method-i-commit">#commit — Repository</a> + + <li class="method"><a href="Note.html#method-i-commit_author">#commit_author — Note</a> + + <li class="method"><a href="PushEvent.html#method-i-commit_from">#commit_from — PushEvent</a> + + <li class="method"><a href="Project.html#method-i-commit_line_notes">#commit_line_notes — Project</a> + + <li class="method"><a href="Project.html#method-i-commit_notes">#commit_notes — Project</a> + + <li class="method"><a href="PushEvent.html#method-i-commit_to">#commit_to — PushEvent</a> + + <li class="method"><a href="PushEvent.html#method-i-commits">#commits — PushEvent</a> + + <li class="method"><a href="MergeRequest.html#method-i-commits">#commits — MergeRequest</a> + + <li class="method"><a href="Repository.html#method-i-commits">#commits — Repository</a> + + <li class="method"><a href="Repository.html#method-i-commits_between">#commits_between — Repository</a> + + <li class="method"><a href="PushEvent.html#method-i-commits_count">#commits_count — PushEvent</a> + + <li class="method"><a href="Repository.html#method-i-commits_since">#commits_since — Repository</a> + + <li class="method"><a href="Repository.html#method-i-commits_with_refs">#commits_with_refs — Repository</a> + + <li class="method"><a href="Commit.html#method-i-committer_email">#committer_email — Commit</a> + + <li class="method"><a href="Commit.html#method-i-committer_name">#committer_name — Commit</a> + + <li class="method"><a href="Project.html#method-i-common_notes">#common_notes — Project</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-config">#config — Gitlab::Gitolite</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-create">#create — Admin::ProjectsController</a> + + <li class="method"><a href="Gitlab/Satellite.html#method-i-create">#create — Gitlab::Satellite</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-create">#create — Admin::UsersController</a> + + <li class="method"><a href="SnippetsController.html#method-i-create">#create — SnippetsController</a> + + <li class="method"><a href="ProtectedBranchesController.html#method-i-create">#create — ProtectedBranchesController</a> + + <li class="method"><a href="MilestonesController.html#method-i-create">#create — MilestonesController</a> + + <li class="method"><a href="Admin/HooksController.html#method-i-create">#create — Admin::HooksController</a> + + <li class="method"><a href="CompareController.html#method-i-create">#create — CompareController</a> + + <li class="method"><a href="TeamMembersController.html#method-i-create">#create — TeamMembersController</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-create">#create — Admin::GroupsController</a> + + <li class="method"><a href="IssuesController.html#method-i-create">#create — IssuesController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-create">#create — MergeRequestsController</a> + + <li class="method"><a href="DeployKeysController.html#method-i-create">#create — DeployKeysController</a> + + <li class="method"><a href="NotesController.html#method-i-create">#create — NotesController</a> + + <li class="method"><a href="HooksController.html#method-i-create">#create — HooksController</a> + + <li class="method"><a href="KeysController.html#method-i-create">#create — KeysController</a> + + <li class="method"><a href="ProjectsController.html#method-i-create">#create — ProjectsController</a> + + <li class="method"><a href="WikisController.html#method-i-create">#create — WikisController</a> + + <li class="method"><a href="Gitlab/Auth.html#method-i-create_from_omniauth">#create_from_omniauth — Gitlab::Auth</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-create_repository">#create_repository — Gitlab::Gitolite</a> + + <li class="method"><a href="Commit.html#method-i-created_at">#created_at — Commit</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-current_action-3F">#current_action? — ApplicationHelper</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-current_controller-3F">#current_controller? — ApplicationHelper</a> + + <li class="method"><a href="Grack/Auth.html#method-i-current_ref">#current_ref — Grack::Auth</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-current_user">#current_user — Gitlab::APIHelpers</a> + + <li class="method"><a href="Snippet.html#method-i-data">#data — Snippet</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-define_show_vars">#define_show_vars — MergeRequestsController</a> + + <li class="method"><a href="RefsController.html#method-i-define_tree_vars">#define_tree_vars — RefsController</a> + + <li class="method"><a href="Team.html#method-i-delete_users_ids_from_team">#delete_users_ids_from_team — Team</a> + + <li class="method"><a href="CommitDecorator.html#method-i-description">#description — CommitDecorator</a> + + <li class="method"><a href="ProfileController.html#method-i-design">#design — ProfileController</a> + + <li class="method"><a href="NotesController.html#method-i-destroy">#destroy — NotesController</a> + + <li class="method"><a href="HooksController.html#method-i-destroy">#destroy — HooksController</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-destroy">#destroy — Admin::UsersController</a> + + <li class="method"><a href="DeployKeysController.html#method-i-destroy">#destroy — DeployKeysController</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-destroy">#destroy — Admin::ProjectsController</a> + + <li class="method"><a href="ProtectedBranchesController.html#method-i-destroy">#destroy — ProtectedBranchesController</a> + + <li class="method"><a href="Admin/HooksController.html#method-i-destroy">#destroy — Admin::HooksController</a> + + <li class="method"><a href="TeamMembersController.html#method-i-destroy">#destroy — TeamMembersController</a> + + <li class="method"><a href="ProjectsController.html#method-i-destroy">#destroy — ProjectsController</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-destroy">#destroy — Admin::GroupsController</a> + + <li class="method"><a href="SnippetsController.html#method-i-destroy">#destroy — SnippetsController</a> + + <li class="method"><a href="MilestonesController.html#method-i-destroy">#destroy — MilestonesController</a> + + <li class="method"><a href="Admin/TeamMembersController.html#method-i-destroy">#destroy — Admin::TeamMembersController</a> + + <li class="method"><a href="WikisController.html#method-i-destroy">#destroy — WikisController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-destroy">#destroy — MergeRequestsController</a> + + <li class="method"><a href="IssuesController.html#method-i-destroy">#destroy — IssuesController</a> + + <li class="method"><a href="KeysController.html#method-i-destroy">#destroy — KeysController</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-destroy_project">#destroy_project — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-destroy_project-21">#destroy_project! — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="Repository.html#method-i-destroy_repository">#destroy_repository — Repository</a> + + <li class="method"><a href="StaticModel.html#method-i-destroyed-3F">#destroyed? — StaticModel</a> + + <li class="method"><a href="Gitlab/Encode.html#method-i-detect_encoding">#detect_encoding — Gitlab::Encode</a> + + <li class="method"><a href="Authority.html#method-i-dev_access_for-3F">#dev_access_for? — Authority</a> + + <li class="method"><a href="ApplicationController.html#method-i-dev_tools">#dev_tools — ApplicationController</a> + + <li class="method"><a href="Commit.html#method-i-different_committer-3F">#different_committer? — Commit</a> + + <li class="method"><a href="MergeRequest.html#method-i-diffs">#diffs — MergeRequest</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-diffs">#diffs — MergeRequestsController</a> + + <li class="method"><a href="Repository.html#method-i-discover_default_branch">#discover_default_branch — Repository</a> + + <li class="method"><a href="Note.html#method-i-downvote-3F">#downvote? — Note</a> + + <li class="method"><a href="Votes.html#method-i-downvotes">#downvotes — Votes</a> + + <li class="method"><a href="Votes.html#method-i-downvotes_in_percent">#downvotes_in_percent — Votes</a> + + <li class="method"><a href="CommitsHelper.html#method-i-each_diff_line">#each_diff_line — CommitsHelper</a> + + <li class="method"><a href="TreeController.html#method-i-edit">#edit — TreeController</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-edit">#edit — Admin::ProjectsController</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-edit">#edit — Admin::GroupsController</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-edit">#edit — Admin::UsersController</a> + + <li class="method"><a href="SnippetsController.html#method-i-edit">#edit — SnippetsController</a> + + <li class="method"><a href="Admin/TeamMembersController.html#method-i-edit">#edit — Admin::TeamMembersController</a> + + <li class="method"><a href="ProjectsController.html#method-i-edit">#edit — ProjectsController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-edit">#edit — MergeRequestsController</a> + + <li class="method"><a href="WikisController.html#method-i-edit">#edit — WikisController</a> + + <li class="method"><a href="MilestonesController.html#method-i-edit">#edit — MilestonesController</a> + + <li class="method"><a href="IssuesController.html#method-i-edit">#edit — IssuesController</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-emoji_autocomplete_source">#emoji_autocomplete_source — ApplicationHelper</a> + + <li class="method"><a href="Tree.html#method-i-empty-3F">#empty? — Tree</a> + + <li class="method"><a href="Repository.html#method-i-empty_repo-3F">#empty_repo? — Repository</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-enable_automerge">#enable_automerge — Gitlab::Gitolite</a> + + <li class="method"><a href="EventsHelper.html#method-i-event_action_name">#event_action_name — EventsHelper</a> + + <li class="method"><a href="EventsHelper.html#method-i-event_image">#event_image — EventsHelper</a> + + <li class="method"><a href="WebHook.html#method-i-execute">#execute — WebHook</a> + + <li class="method"><a href="SearchContext.html#method-i-execute">#execute — SearchContext</a> + + <li class="method"><a href="CommitLoadContext.html#method-i-execute">#execute — CommitLoadContext</a> + + <li class="method"><a href="Notes/CreateContext.html#method-i-execute">#execute — Notes::CreateContext</a> + + <li class="method"><a href="Notes/LoadContext.html#method-i-execute">#execute — Notes::LoadContext</a> + + <li class="method"><a href="IssuesBulkUpdateContext.html#method-i-execute">#execute — IssuesBulkUpdateContext</a> + + <li class="method"><a href="MergeRequestsLoadContext.html#method-i-execute">#execute — MergeRequestsLoadContext</a> + + <li class="method"><a href="TestHookContext.html#method-i-execute">#execute — TestHookContext</a> + + <li class="method"><a href="IssuesListContext.html#method-i-execute">#execute — IssuesListContext</a> + + <li class="method"><a href="PushObserver.html#method-i-execute_hooks">#execute_hooks — PushObserver</a> + + <li class="method"><a href="Gitlab/Satellite.html#method-i-exists-3F">#exists? — Gitlab::Satellite</a> + + <li class="method"><a href="Snippet.html#method-i-expired-3F">#expired? — Snippet</a> + + <li class="method"><a href="Milestone.html#method-i-expires_at">#expires_at — Milestone</a> + + <li class="method"><a href="ExtractsPath.html#method-i-extract_ref">#extract_ref — ExtractsPath</a> + + <li class="method"><a href="OmniauthCallbacksController.html#method-i-failure_message">#failure_message — OmniauthCallbacksController</a> + + <li class="method"><a href="EventDecorator.html#method-i-feed_summary">#feed_summary — EventDecorator</a> + + <li class="method"><a href="EventDecorator.html#method-i-feed_title">#feed_title — EventDecorator</a> + + <li class="method"><a href="EventDecorator.html#method-i-feed_url">#feed_url — EventDecorator</a> + + <li class="method"><a href="ProjectsController.html#method-i-files">#files — ProjectsController</a> + + <li class="method"><a href="Gitlab/Auth.html#method-i-find_for_ldap_auth">#find_for_ldap_auth — Gitlab::Auth</a> + + <li class="method"><a href="Gitlab/Auth.html#method-i-find_or_new_for_omniauth">#find_or_new_for_omniauth — Gitlab::Auth</a> + + <li class="method"><a href="Key.html#method-i-fingerprintable_key">#fingerprintable_key — Key</a> + + <li class="method"><a href="Account.html#method-i-first_name">#first_name — Account</a> + + <li class="method"><a href="Note.html#method-i-for_commit-3F">#for_commit? — Note</a> + + <li class="method"><a href="Note.html#method-i-for_diff_line-3F">#for_diff_line? — Note</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-forbidden-21">#forbidden! — Gitlab::APIHelpers</a> + + <li class="method"><a href="Gitlab/GitLogger.html#method-i-format_message">#format_message — Gitlab::GitLogger</a> + + <li class="method"><a href="Gitlab/AppLogger.html#method-i-format_message">#format_message — Gitlab::AppLogger</a> + + <li class="method"><a href="Repository.html#method-i-fresh_commits">#fresh_commits — Repository</a> + + <li class="method"><a href="User.html#method-i-generate_password">#generate_password — User</a> + + <li class="method"><a href="Gitlab/Markdown.html#method-i-gfm">#gfm — Gitlab::Markdown</a> + + <li class="method"><a href="Project.html#method-i-git_error-3F">#git_error? — Project</a> + + <li class="method"><a href="GitHost.html#method-i-git_host">#git_host — GitHost</a> + + <li class="method"><a href="ApplicationController.html#method-i-git_not_found-21">#git_not_found! — ApplicationController</a> + + <li class="method"><a href="ErrorsController.html#method-i-githost">#githost — ErrorsController</a> + + <li class="method"><a href="TreeHelper.html#method-i-gitlab_markdown-3F">#gitlab_markdown? — TreeHelper</a> + + <li class="method"><a href="ProjectsController.html#method-i-graph">#graph — ProjectsController</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-gravatar_icon">#gravatar_icon — ApplicationHelper</a> + + <li class="method"><a href="GroupsController.html#method-i-group">#group — GroupsController</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-grouped_options_refs">#grouped_options_refs — ApplicationHelper</a> + + <li class="method"><a href="ProjectsHelper.html#method-i-grouper_project_members">#grouper_project_members — ProjectsHelper</a> + + <li class="method"><a href="Authority.html#method-i-guest_access_for-3F">#guest_access_for? — Authority</a> + + <li class="method"><a href="Repository.html#method-i-has_commits-3F">#has_commits? — Repository</a> + + <li class="method"><a href="Repository.html#method-i-has_post_receive_file-3F">#has_post_receive_file? — Repository</a> + + <li class="method"><a href="Repository.html#method-i-heads">#heads — Repository</a> + + <li class="method"><a href="FileSizeValidator.html#method-i-help">#help — FileSizeValidator</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-hexdigest">#hexdigest — ApplicationHelper</a> + + <li class="method"><a href="WikisController.html#method-i-history">#history — WikisController</a> + + <li class="method"><a href="ProfileController.html#method-i-history">#history — ProfileController</a> + + <li class="method"><a href="Repository.html#method-i-http_url_to_repo">#http_url_to_repo — Repository</a> + + <li class="method"><a href="MergeRequest.html#method-i-human_state">#human_state — MergeRequest</a> + + <li class="method"><a href="CommitsHelper.html#method-i-identification_type">#identification_type — CommitsHelper</a> + + <li class="method"><a href="Account.html#method-i-identifier">#identifier — Account</a> + + <li class="method"><a href="CommitsHelper.html#method-i-image_diff_class">#image_diff_class — CommitsHelper</a> + + <li class="method"><a href="MilestonesController.html#method-i-index">#index — MilestonesController</a> + + <li class="method"><a href="CompareController.html#method-i-index">#index — CompareController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-index">#index — MergeRequestsController</a> + + <li class="method"><a href="IssuesController.html#method-i-index">#index — IssuesController</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-index">#index — Admin::GroupsController</a> + + <li class="method"><a href="HelpController.html#method-i-index">#index — HelpController</a> + + <li class="method"><a href="ProtectedBranchesController.html#method-i-index">#index — ProtectedBranchesController</a> + + <li class="method"><a href="SnippetsController.html#method-i-index">#index — SnippetsController</a> + + <li class="method"><a href="Admin/DashboardController.html#method-i-index">#index — Admin::DashboardController</a> + + <li class="method"><a href="DashboardController.html#method-i-index">#index — DashboardController</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-index">#index — Admin::ProjectsController</a> + + <li class="method"><a href="Admin/HooksController.html#method-i-index">#index — Admin::HooksController</a> + + <li class="method"><a href="LabelsController.html#method-i-index">#index — LabelsController</a> + + <li class="method"><a href="KeysController.html#method-i-index">#index — KeysController</a> + + <li class="method"><a href="HooksController.html#method-i-index">#index — HooksController</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-index">#index — Admin::UsersController</a> + + <li class="method"><a href="DeployKeysController.html#method-i-index">#index — DeployKeysController</a> + + <li class="method"><a href="NotesController.html#method-i-index">#index — NotesController</a> + + <li class="method"><a href="TeamMembersController.html#method-i-index">#index — TeamMembersController</a> + + <li class="method"><a href="Tree.html#method-i-invalid-3F">#invalid? — Tree</a> + + <li class="method"><a href="Account.html#method-i-is_admin-3F">#is_admin? — Account</a> + + <li class="method"><a href="IssueCommonality.html#method-i-is_assigned-3F">#is_assigned? — IssueCommonality</a> + + <li class="method"><a href="IssueCommonality.html#method-i-is_being_closed-3F">#is_being_closed? — IssueCommonality</a> + + <li class="method"><a href="IssueCommonality.html#method-i-is_being_reassigned-3F">#is_being_reassigned? — IssueCommonality</a> + + <li class="method"><a href="IssueCommonality.html#method-i-is_being_reopened-3F">#is_being_reopened? — IssueCommonality</a> + + <li class="method"><a href="Tree.html#method-i-is_blob-3F">#is_blob? — Tree</a> + + <li class="method"><a href="Key.html#method-i-is_deploy_key">#is_deploy_key — Key</a> + + <li class="method"><a href="IssuesController.html#method-i-issue">#issue — IssuesController</a> + + <li class="method"><a href="Event.html#method-i-issue">#issue — Event</a> + + <li class="method"><a href="Event.html#method-i-issue-3F">#issue? — Event</a> + + <li class="method"><a href="IssuesHelper.html#method-i-issue_css_classes">#issue_css_classes — IssuesHelper</a> + + <li class="method"><a href="Notify.html#method-i-issue_status_changed_email">#issue_status_changed_email — Notify</a> + + <li class="method"><a href="IssuesHelper.html#method-i-issue_tags">#issue_tags — IssuesHelper</a> + + <li class="method"><a href="DashboardController.html#method-i-issues">#issues — DashboardController</a> + + <li class="method"><a href="GroupsController.html#method-i-issues">#issues — GroupsController</a> + + <li class="method"><a href="IssuesHelper.html#method-i-issues_filter">#issues_filter — IssuesHelper</a> + + <li class="method"><a href="IssuesController.html#method-i-issues_filtered">#issues_filtered — IssuesController</a> + + <li class="method"><a href="Project.html#method-i-issues_labels">#issues_labels — Project</a> + + <li class="method"><a href="Event.html#method-i-joined-3F">#joined? — Event</a> + + <li class="method"><a href="Project.html#method-i-last_activity">#last_activity — Project</a> + + <li class="method"><a href="Project.html#method-i-last_activity_date">#last_activity_date — Project</a> + + <li class="method"><a href="Account.html#method-i-last_activity_project">#last_activity_project — Account</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-last_commit">#last_commit — ApplicationHelper</a> + + <li class="method"><a href="PushEvent.html#method-i-last_commit">#last_commit — PushEvent</a> + + <li class="method"><a href="MergeRequest.html#method-i-last_commit">#last_commit — MergeRequest</a> + + <li class="method"><a href="Repository.html#method-i-last_commit_for">#last_commit_for — Repository</a> + + <li class="method"><a href="Key.html#method-i-last_deploy-3F">#last_deploy? — Key</a> + + <li class="method"><a href="PushEvent.html#method-i-last_push_to_non_root-3F">#last_push_to_non_root? — PushEvent</a> + + <li class="method"><a href="OmniauthCallbacksController.html#method-i-ldap">#ldap — OmniauthCallbacksController</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-ldap_enable-3F">#ldap_enable? — ApplicationHelper</a> + + <li class="method"><a href="Event.html#method-i-left-3F">#left? — Event</a> + + <li class="method"><a href="SnippetsHelper.html#method-i-lifetime_select_options">#lifetime_select_options — SnippetsHelper</a> + + <li class="method"><a href="CommitDecorator.html#method-i-link_title">#link_title — CommitDecorator</a> + + <li class="method"><a href="EventsHelper.html#method-i-link_to_author">#link_to_author — EventsHelper</a> + + <li class="method"><a href="NotesHelper.html#method-i-link_to_commit_diff_line_note">#link_to_commit_diff_line_note — NotesHelper</a> + + <li class="method"><a href="GitlabMarkdownHelper.html#method-i-link_to_gfm">#link_to_gfm — GitlabMarkdownHelper</a> + + <li class="method"><a href="IssuesHelper.html#method-i-link_to_issue_assignee">#link_to_issue_assignee — IssuesHelper</a> + + <li class="method"><a href="IssuesHelper.html#method-i-link_to_issue_author">#link_to_issue_author — IssuesHelper</a> + + <li class="method"><a href="MergeRequestsHelper.html#method-i-link_to_merge_request_assignee">#link_to_merge_request_assignee — MergeRequestsHelper</a> + + <li class="method"><a href="MergeRequestsHelper.html#method-i-link_to_merge_request_author">#link_to_merge_request_author — MergeRequestsHelper</a> + + <li class="method"><a href="ProjectsHelper.html#method-i-link_to_project">#link_to_project — ProjectsHelper</a> + + <li class="method"><a href="NotesHelper.html#method-i-loading_more_notes-3F">#loading_more_notes? — NotesHelper</a> + + <li class="method"><a href="NotesHelper.html#method-i-loading_new_notes-3F">#loading_new_notes? — NotesHelper</a> + + <li class="method"><a href="Gitlab/Auth.html#method-i-log">#log — Gitlab::Auth</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-log">#log — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="ProjectObserver.html#method-i-log_info">#log_info — ProjectObserver</a> + + <li class="method"><a href="UserObserver.html#method-i-log_info">#log_info — UserObserver</a> + + <li class="method"><a href="RefsController.html#method-i-logs_tree">#logs_tree — RefsController</a> + + <li class="method"><a href="MergeRequest.html#method-i-mark_as_merged-21">#mark_as_merged! — MergeRequest</a> + + <li class="method"><a href="MergeRequest.html#method-i-mark_as_unchecked">#mark_as_unchecked — MergeRequest</a> + + <li class="method"><a href="MergeRequest.html#method-i-mark_as_unmergable">#mark_as_unmergable — MergeRequest</a> + + <li class="method"><a href="GitlabMarkdownHelper.html#method-i-markdown">#markdown — GitlabMarkdownHelper</a> + + <li class="method"><a href="TreeHelper.html#method-i-markup-3F">#markup? — TreeHelper</a> + + <li class="method"><a href="Authority.html#method-i-master_access_for-3F">#master_access_for? — Authority</a> + + <li class="method"><a href="PushEvent.html#method-i-md_ref-3F">#md_ref? — PushEvent</a> + + <li class="method"><a href="Event.html#method-i-membership_changed-3F">#membership_changed? — Event</a> + + <li class="method"><a href="Gitlab/Merge.html#method-i-merge-21">#merge! — Gitlab::Merge</a> + + <li class="method"><a href="MergeRequest.html#method-i-merge-21">#merge! — MergeRequest</a> + + <li class="method"><a href="MergeRequest.html#method-i-merge_event">#merge_event — MergeRequest</a> + + <li class="method"><a href="Event.html#method-i-merge_request">#merge_request — Event</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-merge_request">#merge_request — MergeRequestsController</a> + + <li class="method"><a href="Event.html#method-i-merge_request-3F">#merge_request? — Event</a> + + <li class="method"><a href="GroupsController.html#method-i-merge_requests">#merge_requests — GroupsController</a> + + <li class="method"><a href="DashboardController.html#method-i-merge_requests">#merge_requests — DashboardController</a> + + <li class="method"><a href="MergeRequest.html#method-i-merged-3F">#merged? — MergeRequest</a> + + <li class="method"><a href="Event.html#method-i-merged-3F">#merged? — Event</a> + + <li class="method"><a href="ApplicationController.html#method-i-method_missing">#method_missing — ApplicationController</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-i-method_missing">#method_missing — Gitlab::GraphCommit</a> + + <li class="method"><a href="MilestonesController.html#method-i-milestone">#milestone — MilestonesController</a> + + <li class="method"><a href="Snippet.html#method-i-mode">#mode — Snippet</a> + + <li class="method"><a href="IssuesController.html#method-i-module_enabled">#module_enabled — IssuesController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-module_enabled">#module_enabled — MergeRequestsController</a> + + <li class="method"><a href="LabelsController.html#method-i-module_enabled">#module_enabled — LabelsController</a> + + <li class="method"><a href="MilestonesController.html#method-i-module_enabled">#module_enabled — MilestonesController</a> + + <li class="method"><a href="MergeRequest.html#method-i-mr_and_commit_notes">#mr_and_commit_notes — MergeRequest</a> + + <li class="method"><a href="MergeRequestsHelper.html#method-i-mr_css_classes">#mr_css_classes — MergeRequestsHelper</a> + + <li class="method"><a href="Snippet.html#method-i-name">#name — Snippet</a> + + <li class="method"><a href="TabHelper.html#method-i-nav_link">#nav_link — TabHelper</a> + + <li class="method"><a href="KeysController.html#method-i-new">#new — KeysController</a> + + <li class="method"><a href="TeamMembersController.html#method-i-new">#new — TeamMembersController</a> + + <li class="method"><a href="SnippetsController.html#method-i-new">#new — SnippetsController</a> + + <li class="method"><a href="MilestonesController.html#method-i-new">#new — MilestonesController</a> + + <li class="method"><a href="ProjectsController.html#method-i-new">#new — ProjectsController</a> + + <li class="method"><a href="IssuesController.html#method-i-new">#new — IssuesController</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-new">#new — Admin::UsersController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-new">#new — MergeRequestsController</a> + + <li class="method"><a href="DeployKeysController.html#method-i-new">#new — DeployKeysController</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-new">#new — Admin::GroupsController</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-new">#new — Admin::ProjectsController</a> + + <li class="method"><a href="IssueCommonality.html#method-i-new-3F">#new? — IssueCommonality</a> + + <li class="method"><a href="PushEvent.html#method-i-new_branch-3F">#new_branch? — PushEvent</a> + + <li class="method"><a href="Event.html#method-i-new_issue-3F">#new_issue? — Event</a> + + <li class="method"><a href="Notify.html#method-i-new_issue_email">#new_issue_email — Notify</a> + + <li class="method"><a href="Event.html#method-i-new_merge_request-3F">#new_merge_request? — Event</a> + + <li class="method"><a href="Notify.html#method-i-new_merge_request_email">#new_merge_request_email — Notify</a> + + <li class="method"><a href="MergeRequestsHelper.html#method-i-new_mr_path_from_push_event">#new_mr_path_from_push_event — MergeRequestsHelper</a> + + <li class="method"><a href="StaticModel.html#method-i-new_record-3F">#new_record? — StaticModel</a> + + <li class="method"><a href="PushEvent.html#method-i-new_ref-3F">#new_ref? — PushEvent</a> + + <li class="method"><a href="Notify.html#method-i-new_user_email">#new_user_email — Notify</a> + + <li class="method"><a href="ApplicationController.html#method-i-no_cache_headers">#no_cache_headers — ApplicationController</a> + + <li class="method"><a href="CommitDecorator.html#method-i-no_commit_message">#no_commit_message — CommitDecorator</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-not_allowed-21">#not_allowed! — Gitlab::APIHelpers</a> + + <li class="method"><a href="ApplicationController.html#method-i-not_found-21">#not_found! — ApplicationController</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-not_found-21">#not_found! — Gitlab::APIHelpers</a> + + <li class="method"><a href="Notify.html#method-i-note_commit_email">#note_commit_email — Notify</a> + + <li class="method"><a href="NotesHelper.html#method-i-note_for_main_target-3F">#note_for_main_target? — NotesHelper</a> + + <li class="method"><a href="Notify.html#method-i-note_issue_email">#note_issue_email — Notify</a> + + <li class="method"><a href="Notify.html#method-i-note_merge_request_email">#note_merge_request_email — Notify</a> + + <li class="method"><a href="Notify.html#method-i-note_wall_email">#note_wall_email — Notify</a> + + <li class="method"><a href="Notify.html#method-i-note_wiki_email">#note_wiki_email — Notify</a> + + <li class="method"><a href="Note.html#method-i-noteable">#noteable — Note</a> + + <li class="method"><a href="NotesController.html#method-i-notes">#notes — NotesController</a> + + <li class="method"><a href="Note.html#method-i-notify_only_author-3F">#notify_only_author? — Note</a> + + <li class="method"><a href="NoteObserver.html#method-i-notify_team">#notify_team — NoteObserver</a> + + <li class="method"><a href="ProfileHelper.html#method-i-oauth_active_class">#oauth_active_class — ProfileHelper</a> + + <li class="method"><a href="PushObserver.html#method-i-observe_push">#observe_push — PushObserver</a> + + <li class="method"><a href="MergeRequest.html#method-i-open-3F">#open? — MergeRequest</a> + + <li class="method"><a href="Repository.html#method-i-open_branches">#open_branches — Repository</a> + + <li class="method"><a href="WikisController.html#method-i-pages">#pages — WikisController</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-paginate">#paginate — Gitlab::APIHelpers</a> + + <li class="method"><a href="PushEvent.html#method-i-parent_commit">#parent_commit — PushEvent</a> + + <li class="method"><a href="Commit.html#method-i-parents_count">#parents_count — Commit</a> + + <li class="method"><a href="Milestone.html#method-i-participants">#participants — Milestone</a> + + <li class="method"><a href="ProfileController.html#method-i-password_update">#password_update — ProfileController</a> + + <li class="method"><a href="Gitlab/Satellite.html#method-i-path">#path — Gitlab::Satellite</a> + + <li class="method"><a href="Repository.html#method-i-path_to_repo">#path_to_repo — Repository</a> + + <li class="method"><a href="GroupsController.html#method-i-people">#people — GroupsController</a> + + <li class="method"><a href="Milestone.html#method-i-percent_complete">#percent_complete — Milestone</a> + + <li class="method"><a href="StaticModel.html#method-i-persisted-3F">#persisted? — StaticModel</a> + + <li class="method"><a href="TreeHelper.html#method-i-plain_text_readme-3F">#plain_text_readme? — TreeHelper</a> + + <li class="method"><a href="PushObserver.html#method-i-post_receive_data">#post_receive_data — PushObserver</a> + + <li class="method"><a href="Redcarpet/Render/GitlabHTML.html#method-i-postprocess">#postprocess — Redcarpet::Render::GitlabHTML</a> + + <li class="method"><a href="Commit.html#method-i-prev_commit">#prev_commit — Commit</a> + + <li class="method"><a href="Commit.html#method-i-prev_commit_id">#prev_commit_id — Commit</a> + + <li class="method"><a href="NotesController.html#method-i-preview">#preview — NotesController</a> + + <li class="method"><a href="StaticModel/ClassMethods.html#method-i-primary_key">#primary_key — StaticModel::ClassMethods</a> + + <li class="method"><a href="Project.html#method-i-private-3F">#private? — Project</a> + + <li class="method"><a href="MergeRequest.html#method-i-probably_merged-3F">#probably_merged? — MergeRequest</a> + + <li class="method"><a href="ApplicationController.html#method-i-project">#project — ApplicationController</a> + + <li class="method"><a href="Notify.html#method-i-project_access_granted_email">#project_access_granted_email — Notify</a> + + <li class="method"><a href="UsersProject.html#method-i-project_access_human">#project_access_human — UsersProject</a> + + <li class="method"><a href="Project.html#method-i-project_id">#project_id — Project</a> + + <li class="method"><a href="GroupsController.html#method-i-project_ids">#project_ids — GroupsController</a> + + <li class="method"><a href="Account.html#method-i-project_ids">#project_ids — Account</a> + + <li class="method"><a href="IssuesHelper.html#method-i-project_issues_filter_path">#project_issues_filter_path — IssuesHelper</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-project_last_activity">#project_last_activity — ApplicationHelper</a> + + <li class="method"><a href="Event.html#method-i-project_name">#project_name — Event</a> + + <li class="method"><a href="TabHelper.html#method-i-project_tab_class">#project_tab_class — TabHelper</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-project_update">#project_update — Admin::GroupsController</a> + + <li class="method"><a href="GroupsController.html#method-i-projects">#projects — GroupsController</a> + + <li class="method"><a href="Key.html#method-i-projects">#projects — Key</a> + + <li class="method"><a href="Account.html#method-i-projects_limit_percent">#projects_limit_percent — Account</a> + + <li class="method"><a href="Account.html#method-i-projects_with_events">#projects_with_events — Account</a> + + <li class="method"><a href="Repository.html#method-i-protected_branch-3F">#protected_branch? — Repository</a> + + <li class="method"><a href="Project.html#method-i-public-3F">#public? — Project</a> + + <li class="method"><a href="Event.html#method-i-push-3F">#push? — Event</a> + + <li class="method"><a href="PushEvent.html#method-i-push_action_name">#push_action_name — PushEvent</a> + + <li class="method"><a href="PushEvent.html#method-i-push_with_commits-3F">#push_with_commits? — PushEvent</a> + + <li class="method"><a href="SnippetsController.html#method-i-raw">#raw — SnippetsController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-raw">#raw — MergeRequestsController</a> + + <li class="method"><a href="TreeDecorator.html#method-i-readme">#readme — TreeDecorator</a> + + <li class="method"><a href="Notify.html#method-i-reassigned_issue_email">#reassigned_issue_email — Notify</a> + + <li class="method"><a href="Notify.html#method-i-reassigned_merge_request_email">#reassigned_merge_request_email — Notify</a> + + <li class="method"><a href="Account.html#method-i-recent_push">#recent_push — Account</a> + + <li class="method"><a href="RefsController.html#method-i-ref">#ref — RefsController</a> + + <li class="method"><a href="PushEvent.html#method-i-ref_name">#ref_name — PushEvent</a> + + <li class="method"><a href="Repository.html#method-i-ref_names">#ref_names — Repository</a> + + <li class="method"><a href="PushEvent.html#method-i-ref_type">#ref_type — PushEvent</a> + + <li class="method"><a href="ApplicationController.html#method-i-reject_blocked-21">#reject_blocked! — ApplicationController</a> + + <li class="method"><a href="MergeRequest.html#method-i-reload_code">#reload_code — MergeRequest</a> + + <li class="method"><a href="MergeRequest.html#method-i-reloaded_commits">#reloaded_commits — MergeRequest</a> + + <li class="method"><a href="MergeRequest.html#method-i-reloaded_diffs">#reloaded_diffs — MergeRequest</a> + + <li class="method"><a href="ProjectsHelper.html#method-i-remove_from_team_message">#remove_from_team_message — ProjectsHelper</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-remove_key">#remove_key — Gitlab::Gitolite</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-remove_project">#remove_project — Admin::GroupsController</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-remove_repository">#remove_repository — Gitlab::Gitolite</a> + + <li class="method"><a href="ApplicationController.html#method-i-render_404">#render_404 — ApplicationController</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-render_api_error-21">#render_api_error! — Gitlab::APIHelpers</a> + + <li class="method"><a href="TreeHelper.html#method-i-render_tree">#render_tree — TreeHelper</a> + + <li class="method"><a href="Event.html#method-i-reopened-3F">#reopened? — Event</a> + + <li class="method"><a href="Repository.html#method-i-repo">#repo — Repository</a> + + <li class="method"><a href="UsersProject.html#method-i-repo_access_human">#repo_access_human — UsersProject</a> + + <li class="method"><a href="Repository.html#method-i-repo_exists-3F">#repo_exists? — Repository</a> + + <li class="method"><a href="Project.html#method-i-repo_name">#repo_name — Project</a> + + <li class="method"><a href="Authority.html#method-i-report_access_for-3F">#report_access_for? — Authority</a> + + <li class="method"><a href="Authority.html#method-i-repository_masters">#repository_masters — Authority</a> + + <li class="method"><a href="Authority.html#method-i-repository_readers">#repository_readers — Authority</a> + + <li class="method"><a href="Authority.html#method-i-repository_writers">#repository_writers — Authority</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-request_protocol">#request_protocol — ApplicationHelper</a> + + <li class="method"><a href="ApplicationController.html#method-i-require_non_empty_project">#require_non_empty_project — ApplicationController</a> + + <li class="method"><a href="Account.html#method-i-require_ssh_key-3F">#require_ssh_key? — Account</a> + + <li class="method"><a href="Authority.html#method-i-reset_access">#reset_access — Authority</a> + + <li class="method"><a href="ProfileController.html#method-i-reset_private_token">#reset_private_token — ProfileController</a> + + <li class="method"><a href="SearchContext.html#method-i-result">#result — SearchContext</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-rm_key">#rm_key — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="PushEvent.html#method-i-rm_ref-3F">#rm_ref? — PushEvent</a> + + <li class="method"><a href="UsersProject.html#method-i-role_access">#role_access — UsersProject</a> + + <li class="method"><a href="Repository.html#method-i-root_ref">#root_ref — Repository</a> + + <li class="method"><a href="Repository.html#method-i-root_ref-3F">#root_ref? — Repository</a> + + <li class="method"><a href="Commit.html#method-i-safe_message">#safe_message — Commit</a> + + <li class="method"><a href="Repository.html#method-i-satellite">#satellite — Repository</a> + + <li class="method"><a href="Project.html#method-i-saved-3F">#saved? — Project</a> + + <li class="method"><a href="GroupsController.html#method-i-search">#search — GroupsController</a> + + <li class="method"><a href="IssueCommonality/ClassMethods.html#method-i-search">#search — IssueCommonality::ClassMethods</a> + + <li class="method"><a href="IssuesController.html#method-i-search">#search — IssuesController</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-search_autocomplete_source">#search_autocomplete_source — ApplicationHelper</a> + + <li class="method"><a href="NoteObserver.html#method-i-send_notify_mails">#send_notify_mails — NoteObserver</a> + + <li class="method"><a href="MergeRequestObserver.html#method-i-send_reassigned_email">#send_reassigned_email — MergeRequestObserver</a> + + <li class="method"><a href="IssueObserver.html#method-i-send_reassigned_email">#send_reassigned_email — IssueObserver</a> + + <li class="method"><a href="ApplicationController.html#method-i-set_current_user_for_observers">#set_current_user_for_observers — ApplicationController</a> + + <li class="method"><a href="Key.html#method-i-set_identifier">#set_identifier — Key</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-set_key">#set_key — Gitlab::Gitolite</a> + + <li class="method"><a href="Wiki.html#method-i-set_slug">#set_slug — Wiki</a> + + <li class="method"><a href="Commit.html#method-i-short_id">#short_id — Commit</a> + + <li class="method"><a href="RepositoriesController.html#method-i-show">#show — RepositoriesController</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-show">#show — Admin::UsersController</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-show">#show — Admin::GroupsController</a> + + <li class="method"><a href="GroupsController.html#method-i-show">#show — GroupsController</a> + + <li class="method"><a href="SearchController.html#method-i-show">#show — SearchController</a> + + <li class="method"><a href="SnippetsController.html#method-i-show">#show — SnippetsController</a> + + <li class="method"><a href="Admin/ResqueController.html#method-i-show">#show — Admin::ResqueController</a> + + <li class="method"><a href="MilestonesController.html#method-i-show">#show — MilestonesController</a> + + <li class="method"><a href="WikisController.html#method-i-show">#show — WikisController</a> + + <li class="method"><a href="ProjectsController.html#method-i-show">#show — ProjectsController</a> + + <li class="method"><a href="IssuesController.html#method-i-show">#show — IssuesController</a> + + <li class="method"><a href="BlobController.html#method-i-show">#show — BlobController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-show">#show — MergeRequestsController</a> + + <li class="method"><a href="KeysController.html#method-i-show">#show — KeysController</a> + + <li class="method"><a href="CommitController.html#method-i-show">#show — CommitController</a> + + <li class="method"><a href="TeamMembersController.html#method-i-show">#show — TeamMembersController</a> + + <li class="method"><a href="ProfileController.html#method-i-show">#show — ProfileController</a> + + <li class="method"><a href="TreeController.html#method-i-show">#show — TreeController</a> + + <li class="method"><a href="CompareController.html#method-i-show">#show — CompareController</a> + + <li class="method"><a href="CommitsController.html#method-i-show">#show — CommitsController</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-show">#show — Admin::ProjectsController</a> + + <li class="method"><a href="BlameController.html#method-i-show">#show — BlameController</a> + + <li class="method"><a href="DeployKeysController.html#method-i-show">#show — DeployKeysController</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-show_last_push_widget-3F">#show_last_push_widget? — ApplicationHelper</a> + + <li class="method"><a href="Snippet.html#method-i-size">#size — Snippet</a> + + <li class="method"><a href="SnippetsController.html#method-i-snippet">#snippet — SnippetsController</a> + + <li class="method"><a href="IssuesController.html#method-i-sort">#sort — IssuesController</a> + + <li class="method"><a href="Repository.html#method-i-ssh_url_to_repo">#ssh_url_to_repo — Repository</a> + + <li class="method"><a href="AttachmentUploader.html#method-i-store_dir">#store_dir — AttachmentUploader</a> + + <li class="method"><a href="Key.html#method-i-strip_white_space">#strip_white_space — Key</a> + + <li class="method"><a href="RefsController.html#method-i-switch">#switch — RefsController</a> + + <li class="method"><a href="PushEvent.html#method-i-tag-3F">#tag? — PushEvent</a> + + <li class="method"><a href="TagsHelper.html#method-i-tag_list">#tag_list — TagsHelper</a> + + <li class="method"><a href="PushEvent.html#method-i-tag_name">#tag_name — PushEvent</a> + + <li class="method"><a href="Repository.html#method-i-tag_names">#tag_names — Repository</a> + + <li class="method"><a href="TagsHelper.html#method-i-tag_path">#tag_path — TagsHelper</a> + + <li class="method"><a href="RepositoriesController.html#method-i-tags">#tags — RepositoriesController</a> + + <li class="method"><a href="Repository.html#method-i-tags">#tags — Repository</a> + + <li class="method"><a href="Event.html#method-i-target_title">#target_title — Event</a> + + <li class="method"><a href="Team.html#method-i-team_member_by_id">#team_member_by_id — Team</a> + + <li class="method"><a href="Team.html#method-i-team_member_by_name_or_email">#team_member_by_name_or_email — Team</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-team_update">#team_update — Admin::UsersController</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-team_update">#team_update — Admin::ProjectsController</a> + + <li class="method"><a href="NoteObserver.html#method-i-team_without_note_author">#team_without_note_author — NoteObserver</a> + + <li class="method"><a href="Admin/HooksController.html#method-i-test">#test — Admin::HooksController</a> + + <li class="method"><a href="HooksController.html#method-i-test">#test — HooksController</a> + + <li class="method"><a href="CommitDecorator.html#method-i-title">#title — CommitDecorator</a> + + <li class="method"><a href="Gitlab/GraphCommit.html#method-i-to_graph_hash">#to_graph_hash — Gitlab::GraphCommit</a> + + <li class="method"><a href="Group.html#method-i-to_param">#to_param — Group</a> + + <li class="method"><a href="Project.html#method-i-to_param">#to_param — Project</a> + + <li class="method"><a href="Wiki.html#method-i-to_param">#to_param — Wiki</a> + + <li class="method"><a href="StaticModel.html#method-i-to_param">#to_param — StaticModel</a> + + <li class="method"><a href="MergeRequest.html#method-i-to_raw">#to_raw — MergeRequest</a> + + <li class="method"><a href="IssueCommonality.html#method-i-today-3F">#today? — IssueCommonality</a> + + <li class="method"><a href="ProfileController.html#method-i-token">#token — ProfileController</a> + + <li class="method"><a href="Repository.html#method-i-tree">#tree — Repository</a> + + <li class="method"><a href="TreeHelper.html#method-i-tree_hex_class">#tree_hex_class — TreeHelper</a> + + <li class="method"><a href="TreeHelper.html#method-i-tree_icon">#tree_icon — TreeHelper</a> + + <li class="method"><a href="TreeHelper.html#method-i-tree_join">#tree_join — TreeHelper</a> + + <li class="method"><a href="PushObserver.html#method-i-trigger_post_receive">#trigger_post_receive — PushObserver</a> + + <li class="method"><a href="IssuesHelper.html#method-i-unassigned_filter">#unassigned_filter — IssuesHelper</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-unauthorized-21">#unauthorized! — Gitlab::APIHelpers</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-unblock">#unblock — Admin::UsersController</a> + + <li class="method"><a href="MergeRequest.html#method-i-unchecked-3F">#unchecked? — MergeRequest</a> + + <li class="method"><a href="Key.html#method-i-unique_key">#unique_key — Key</a> + + <li class="method"><a href="MergeRequest.html#method-i-unmerged_commits">#unmerged_commits — MergeRequest</a> + + <li class="method"><a href="MergeRequest.html#method-i-unmerged_diffs">#unmerged_diffs — MergeRequest</a> + + <li class="method"><a href="TreeDecorator.html#method-i-up_dir-3F">#up_dir? — TreeDecorator</a> + + <li class="method"><a href="TreeDecorator.html#method-i-up_dir_path">#up_dir_path — TreeDecorator</a> + + <li class="method"><a href="ProjectsController.html#method-i-update">#update — ProjectsController</a> + + <li class="method"><a href="ProfileController.html#method-i-update">#update — ProfileController</a> + + <li class="method"><a href="Admin/ProjectsController.html#method-i-update">#update — Admin::ProjectsController</a> + + <li class="method"><a href="TreeController.html#method-i-update">#update — TreeController</a> + + <li class="method"><a href="Admin/GroupsController.html#method-i-update">#update — Admin::GroupsController</a> + + <li class="method"><a href="IssuesController.html#method-i-update">#update — IssuesController</a> + + <li class="method"><a href="Admin/UsersController.html#method-i-update">#update — Admin::UsersController</a> + + <li class="method"><a href="Gitlab/FileEditor.html#method-i-update">#update — Gitlab::FileEditor</a> + + <li class="method"><a href="MilestonesController.html#method-i-update">#update — MilestonesController</a> + + <li class="method"><a href="Admin/TeamMembersController.html#method-i-update">#update — Admin::TeamMembersController</a> + + <li class="method"><a href="TeamMembersController.html#method-i-update">#update — TeamMembersController</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-update">#update — MergeRequestsController</a> + + <li class="method"><a href="SnippetsController.html#method-i-update">#update — SnippetsController</a> + + <li class="method"><a href="PushObserver.html#method-i-update_merge_requests">#update_merge_requests — PushObserver</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-update_project">#update_project — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-update_project-21">#update_project! — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-update_project_config">#update_project_config — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-update_projects">#update_projects — Gitlab::GitoliteConfig</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-update_repository">#update_repository — Gitlab::Gitolite</a> + + <li class="method"><a href="ProtectedBranch.html#method-i-update_repository">#update_repository — ProtectedBranch</a> + + <li class="method"><a href="Repository.html#method-i-update_repository">#update_repository — Repository</a> + + <li class="method"><a href="UsersProject.html#method-i-update_repository">#update_repository — UsersProject</a> + + <li class="method"><a href="Team.html#method-i-update_users_ids_to_role">#update_users_ids_to_role — Team</a> + + <li class="method"><a href="Note.html#method-i-upvote-3F">#upvote? — Note</a> + + <li class="method"><a href="Votes.html#method-i-upvotes">#upvotes — Votes</a> + + <li class="method"><a href="Votes.html#method-i-upvotes_in_percent">#upvotes_in_percent — Votes</a> + + <li class="method"><a href="Repository.html#method-i-url_to_repo">#url_to_repo — Repository</a> + + <li class="method"><a href="Gitlab/Gitolite.html#method-i-url_to_repo">#url_to_repo — Gitlab::Gitolite</a> + + <li class="method"><a href="Gitlab/APIHelpers.html#method-i-user_project">#user_project — Gitlab::APIHelpers</a> + + <li class="method"><a href="Group.html#method-i-users">#users — Group</a> + + <li class="method"><a href="Gitlab/Encode.html#method-i-utf8">#utf8 — Gitlab::Encode</a> + + <li class="method"><a href="Grack/Auth.html#method-i-valid-3F">#valid? — Grack::Auth</a> + + <li class="method"><a href="MergeRequest.html#method-i-valid_diffs-3F">#valid_diffs? — MergeRequest</a> + + <li class="method"><a href="PushEvent.html#method-i-valid_push-3F">#valid_push? — PushEvent</a> + + <li class="method"><a href="Repository.html#method-i-valid_repo-3F">#valid_repo? — Repository</a> + + <li class="method"><a href="MergeRequest.html#method-i-validate_branches">#validate_branches — MergeRequest</a> + + <li class="method"><a href="FileSizeValidator.html#method-i-validate_each">#validate_each — FileSizeValidator</a> + + <li class="method"><a href="Grack/Auth.html#method-i-validate_get_request">#validate_get_request — Grack::Auth</a> + + <li class="method"><a href="Grack/Auth.html#method-i-validate_post_request">#validate_post_request — Grack::Auth</a> + + <li class="method"><a href="MergeRequestsController.html#method-i-validates_merge_request">#validates_merge_request — MergeRequestsController</a> + + <li class="method"><a href="Votes.html#method-i-votes_count">#votes_count — Votes</a> + + <li class="method"><a href="ProjectsController.html#method-i-wall">#wall — ProjectsController</a> + + <li class="method"><a href="ApplicationHelper.html#method-i-web_app_url">#web_app_url — ApplicationHelper</a> + + <li class="method"><a href="Project.html#method-i-web_url">#web_url — Project</a> + + <li class="method"><a href="Project.html#method-i-wiki_notes">#wiki_notes — Project</a> + + <li class="method"><a href="Gitlab/GitoliteConfig.html#method-i-write_key">#write_key — Gitlab::GitoliteConfig</a> + +</ul> + + +<footer id="validator-badges"> + <p><a href="http://validator.w3.org/check/referer">[Validate]</a> + <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12. + <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. +</footer> + |
