From 96d49bf04ce77c975fe500f4d961e4a1ffed4c26 Mon Sep 17 00:00:00 2001 From: Dmitriy Zaporozhets Date: Sun, 30 Dec 2012 14:43:00 +0200 Subject: Use sdoc to generate application code documentation --- doc/code/classes/TreeHelper.html | 541 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 541 insertions(+) create mode 100644 doc/code/classes/TreeHelper.html (limited to 'doc/code/classes/TreeHelper.html') diff --git a/doc/code/classes/TreeHelper.html b/doc/code/classes/TreeHelper.html new file mode 100644 index 00000000000..a9ca79494de --- /dev/null +++ b/doc/code/classes/TreeHelper.html @@ -0,0 +1,541 @@ + + + + + TreeHelper + + + + + + + + + + + + + +
+
+ + + + + + + + + + + + + + + +
Methods
+
+ +
A
+
+ +
+ +
B
+
+ +
+ +
G
+
+ +
+ +
M
+
+ +
+ +
P
+
+ +
+ +
R
+
+ +
+ +
T
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + +
Instance Public methods
+ +
+
+ + allowed_tree_edit?() + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 63
+def allowed_tree_edit?
+  if @project.protected_branch? @ref
+    can?(current_user, :push_code_to_protected_branches, @project)
+  else
+    can?(current_user, :push_code, @project)
+  end
+end
+
+
+ +
+ +
+
+ + breadcrumbs() + + +
+ + +
+

Breadcrumb links for a Project and, if +applicable, a tree path

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 72
+def breadcrumbs
+  return unless @project && @ref
+
+  # Add the root project link and the arrow icon
+  crumbs = content_tag(:li) do
+    content_tag(:span, nil, class: 'arrow') +
+    link_to(@project.name, project_commits_path(@project, @ref))
+  end
+
+  if @path
+    parts = @path.split('/')
+
+    parts.each_with_index do |part, i|
+      crumbs += content_tag(:span, '/', class: 'divider')
+      crumbs += content_tag(:li) do
+        # The text is just the individual part, but the link needs all the parts before it
+        link_to part, project_commits_path(@project, tree_join(@ref, parts[0..i].join('/')))
+      end
+    end
+  end
+
+  crumbs.html_safe
+end
+
+
+ +
+ +
+
+ + gitlab_markdown?(filename) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 50
+def gitlab_markdown?(filename)
+  filename.end_with?(*%w(.mdown .md .markdown))
+end
+
+
+ +
+ +
+
+ + markup?(filename) + + +
+ + +
+

Public: Determines if a given filename is compatible with GitHub::Markup.

+ +

filename - Filename string to check

+ +

Returns boolean

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 45
+def markup?(filename)
+  filename.end_with?(*%w(.textile .rdoc .org .creole
+                         .mediawiki .rst .asciidoc .pod))
+end
+
+
+ +
+ +
+
+ + plain_text_readme?(filename) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 54
+def plain_text_readme? filename
+  filename == 'README'
+end
+
+
+ +
+ +
+
+ + render_tree(contents) + + +
+ + +
+

Sorts a repository’s tree so that folders are before files and renders +their corresponding partials

+ +

contents - A Grit::Tree object for the current tree

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 6
+def render_tree(contents)
+  # Render Folders before Files/Submodules
+  folders, files = contents.partition { |v| v.kind_of?(Grit::Tree) }
+
+  tree = ""
+
+  # Render folders if we have any
+  tree += render partial: 'tree/tree_item', collection: folders, locals: {type: 'folder'} if folders.present?
+
+  files.each do |f|
+    if f.respond_to?(:url)
+      # Object is a Submodule
+      tree += render partial: 'tree/submodule_item', object: f
+    else
+      # Object is a Blob
+      tree += render partial: 'tree/tree_item', object: f, locals: {type: 'file'}
+    end
+  end
+
+  tree.html_safe
+end
+
+
+ +
+ +
+
+ + tree_hex_class(content) + + +
+ + +
+ +
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 36
+def tree_hex_class(content)
+  "file_#{hexdigest(content.name)}"
+end
+
+
+ +
+ +
+
+ + tree_icon(type) + + +
+ + +
+

Return an image icon depending on the file type

+ +

type - String type of the tree item; either ‘folder’ or ‘file’

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 31
+def tree_icon(type)
+  image = type == 'folder' ? 'file_dir.png' : 'file_txt.png'
+  image_tag(image, size: '16x16')
+end
+
+
+ +
+ +
+
+ + tree_join(*args) + + +
+ + +
+

Simple shortcut to File.join

+
+ + + + + + +
+ +

+ Source: + show + +

+
+ 
# File app/helpers/tree_helper.rb, line 59
+def tree_join(*args)
+  File.join(*args)
+end
+
+
+ +
+
+ +
+ + \ No newline at end of file -- cgit v1.2.1