<!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>