diff options
Diffstat (limited to 'doc/app/Revision.html')
| -rw-r--r-- | doc/app/Revision.html | 524 |
1 files changed, 524 insertions, 0 deletions
diff --git a/doc/app/Revision.html b/doc/app/Revision.html new file mode 100644 index 0000000..a8d7364 --- /dev/null +++ b/doc/app/Revision.html @@ -0,0 +1,524 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <meta content="text/html; charset=utf-8" http-equiv="Content-Type" /> + + <title>Class: Revision</title> + + <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" /> + + <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script> + <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script> + <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script> + <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script> + +</head> +<body id="top" class="class"> + + <div id="metadata"> + <div id="home-metadata"> + <div id="home-section" class="section"> + <h3 class="section-header"> + <a href="./index.html">Home</a> + <a href="./index.html#classes">Classes</a> + <a href="./index.html#methods">Methods</a> + </h3> + </div> + </div> + + <div id="file-metadata"> + <div id="file-list-section" class="section"> + <h3 class="section-header">In Files</h3> + <div class="section-body"> + <ul> + + <li><a href="./app/models/revision_rb.html?TB_iframe=true&height=550&width=785" + class="thickbox" title="app/models/revision.rb">app/models/revision.rb</a></li> + + </ul> + </div> + </div> + + + </div> + + <div id="class-metadata"> + + <!-- Parent Class --> + <div id="parent-class-section" class="section"> + <h3 class="section-header">Parent</h3> + + <p class="link">ActiveRecord::Base</p> + + </div> + + + + + + + + <!-- Method Quickref --> + <div id="method-list-section" class="section"> + <h3 class="section-header">Methods</h3> + <ul class="link-list"> + + <li><a href="#method-i-bug_ready-3F">#bug_ready?</a></li> + + <li><a href="#method-i-deep_copy">#deep_copy</a></li> + + <li><a href="#method-i-get_linked_bugs">#get_linked_bugs</a></li> + + <li><a href="#method-i-packages_by_atom">#packages_by_atom</a></li> + + <li><a href="#method-i-to_s">#to_s</a></li> + + <li><a href="#method-i-update_cached_bug_metadata">#update_cached_bug_metadata</a></li> + + </ul> + </div> + + + + </div> + + <div id="project-metadata"> + + + <div id="fileindex-section" class="section project-section"> + <h3 class="section-header">Files</h3> + <ul> + + <li class="file"><a href="./doc/README_FOR_APP.html">README_FOR_APP</a></li> + + </ul> + </div> + + + <div id="classindex-section" class="section project-section"> + <h3 class="section-header">Class/Module Index + <span class="search-toggle"><img src="./images/find.png" + height="16" width="16" alt="[+]" + title="show/hide quicksearch" /></span></h3> + <form action="#" method="get" accept-charset="utf-8" class="initially-hidden"> + <fieldset> + <legend>Quicksearch</legend> + <input type="text" name="quicksearch" value="" + class="quicksearch-field" /> + </fieldset> + </form> + + <ul class="link-list"> + + <li><a href="./Glsamaker.html">Glsamaker</a></li> + + <li><a href="./Glsamaker/Bugs.html">Glsamaker::Bugs</a></li> + + <li><a href="./Glsamaker/Bugs/ArchesMixin.html">Glsamaker::Bugs::ArchesMixin</a></li> + + <li><a href="./Glsamaker/Bugs/Bug.html">Glsamaker::Bugs::Bug</a></li> + + <li><a href="./Glsamaker/Bugs/BugReadyMixin.html">Glsamaker::Bugs::BugReadyMixin</a></li> + + <li><a href="./Glsamaker/Bugs/Status.html">Glsamaker::Bugs::Status</a></li> + + <li><a href="./Glsamaker/Bugs/StatusMixin.html">Glsamaker::Bugs::StatusMixin</a></li> + + <li><a href="./Glsamaker/Diff.html">Glsamaker::Diff</a></li> + + <li><a href="./Glsamaker/HTTP.html">Glsamaker::HTTP</a></li> + + <li><a href="./Glsamaker/Helper.html">Glsamaker::Helper</a></li> + + <li><a href="./Glsamaker/Mail.html">Glsamaker::Mail</a></li> + + <li><a href="./Glsamaker/Portage.html">Glsamaker::Portage</a></li> + + <li><a href="./Glsamaker/Portage/Description.html">Glsamaker::Portage::Description</a></li> + + <li><a href="./Glsamaker/XML.html">Glsamaker::XML</a></li> + + <li><a href="./Admin.html">Admin</a></li> + + <li><a href="./Admin/IndexController.html">Admin::IndexController</a></li> + + <li><a href="./Admin/IndexHelper.html">Admin::IndexHelper</a></li> + + <li><a href="./Admin/TemplatesController.html">Admin::TemplatesController</a></li> + + <li><a href="./Admin/TemplatesHelper.html">Admin::TemplatesHelper</a></li> + + <li><a href="./Admin/UsersController.html">Admin::UsersController</a></li> + + <li><a href="./Admin/UsersHelper.html">Admin::UsersHelper</a></li> + + <li><a href="./Bugzilla.html">Bugzilla</a></li> + + <li><a href="./Bugzilla/Bug.html">Bugzilla::Bug</a></li> + + <li><a href="./Bugzilla/Bugzilla.html">Bugzilla::Bugzilla</a></li> + + <li><a href="./Bugzilla/Bugzilla/Bugzilla.html">Bugzilla::Bugzilla::Bugzilla</a></li> + + <li><a href="./Bugzilla/Bugzilla/Bugzilla/Change.html">Bugzilla::Bugzilla::Bugzilla::Change</a></li> + + <li><a href="./Bugzilla/Comment.html">Bugzilla::Comment</a></li> + + <li><a href="./Bugzilla/History.html">Bugzilla::History</a></li> + + <li><a href="./Comment.html">Comment</a></li> + + <li><a href="./Comment/CommentValidator.html">Comment::CommentValidator</a></li> + + <li><a href="./ApplicationController.html">ApplicationController</a></li> + + <li><a href="./ApplicationHelper.html">ApplicationHelper</a></li> + + <li><a href="./Authentication.html">Authentication</a></li> + + <li><a href="./Authorization.html">Authorization</a></li> + + <li><a href="./Bug.html">Bug</a></li> + + <li><a href="./BugController.html">BugController</a></li> + + <li><a href="./BugHelper.html">BugHelper</a></li> + + <li><a href="./BugsController.html">BugsController</a></li> + + <li><a href="./BugsHelper.html">BugsHelper</a></li> + + <li><a href="./CommentsController.html">CommentsController</a></li> + + <li><a href="./CommentsHelper.html">CommentsHelper</a></li> + + <li><a href="./Cpe.html">Cpe</a></li> + + <li><a href="./Cve.html">Cve</a></li> + + <li><a href="./CveAssignment.html">CveAssignment</a></li> + + <li><a href="./CveChange.html">CveChange</a></li> + + <li><a href="./CveComment.html">CveComment</a></li> + + <li><a href="./CveController.html">CveController</a></li> + + <li><a href="./CveHelper.html">CveHelper</a></li> + + <li><a href="./CveReference.html">CveReference</a></li> + + <li><a href="./GLSAReleaseError.html">GLSAReleaseError</a></li> + + <li><a href="./Glsa.html">Glsa</a></li> + + <li><a href="./GlsaController.html">GlsaController</a></li> + + <li><a href="./GlsaHelper.html">GlsaHelper</a></li> + + <li><a href="./GlsaMailer.html">GlsaMailer</a></li> + + <li><a href="./IndexController.html">IndexController</a></li> + + <li><a href="./IndexHelper.html">IndexHelper</a></li> + + <li><a href="./Package.html">Package</a></li> + + <li><a href="./Reference.html">Reference</a></li> + + <li><a href="./Revision.html">Revision</a></li> + + <li><a href="./SearchController.html">SearchController</a></li> + + <li><a href="./SearchHelper.html">SearchHelper</a></li> + + <li><a href="./String.html">String</a></li> + + <li><a href="./Template.html">Template</a></li> + + <li><a href="./ToolsController.html">ToolsController</a></li> + + <li><a href="./ToolsHelper.html">ToolsHelper</a></li> + + <li><a href="./User.html">User</a></li> + + </ul> + <div id="no-class-search-results" style="display: none;">No matching classes.</div> + </div> + + + </div> + </div> + + <div id="documentation"> + <h1 class="class">Revision</h1> + + <div id="description" class="description"> + +<p><a href="Revision.html">Revision</a> model</p> + + </div><!-- description --> + + + + + <div id="5Buntitled-5D" class="documentation-section"> + + + + + + + + + <!-- Methods --> + + <div id="public-instance-method-details" class="method-section section"> + <h3 class="section-header">Public Instance Methods</h3> + + + <div id="bug_ready-3F-method" class="method-detail "> + <a name="method-i-bug_ready-3F"></a> + + + <div class="method-heading"> + <span class="method-name">bug_ready?</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Checks all assigned bugs for bug ready status</p> + + + + <div class="method-source-code" id="bug_ready-3F-source"> +<pre> +<span class="ruby-comment"># File app/models/revision.rb, line 56</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">bug_ready?</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">bugs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">b</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">b</span>.<span class="ruby-identifier">bug_ready?</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- bug_ready-3F-source --> + + </div> + + + + + </div><!-- bug_ready-3F-method --> + + + <div id="deep_copy-method" class="method-detail "> + <a name="method-i-deep_copy"></a> + + + <div class="method-heading"> + <span class="method-name">deep_copy</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Creates a deep copy of a previous revision, copying all bugs, references +and packages, incrementing the revision ID by one. <b>The caller must take +care of deleting this revision again in case any error occurs later.</b></p> + + + + <div class="method-source-code" id="deep_copy-source"> +<pre> +<span class="ruby-comment"># File app/models/revision.rb, line 74</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">deep_copy</span> + <span class="ruby-identifier">new_rev</span> = <span class="ruby-identifier">dup</span> + <span class="ruby-identifier">new_rev</span>.<span class="ruby-identifier">revid</span> = <span class="ruby-identifier">glsa</span>.<span class="ruby-identifier">next_revid</span> + + <span class="ruby-identifier">references</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">reference</span><span class="ruby-operator">|</span> <span class="ruby-identifier">new_rev</span>.<span class="ruby-identifier">references</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">reference</span>.<span class="ruby-identifier">dup</span> } + <span class="ruby-identifier">packages</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">package</span><span class="ruby-operator">|</span> <span class="ruby-identifier">new_rev</span>.<span class="ruby-identifier">packages</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">package</span>.<span class="ruby-identifier">dup</span> } + <span class="ruby-identifier">bugs</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">bug</span><span class="ruby-operator">|</span> <span class="ruby-identifier">new_rev</span>.<span class="ruby-identifier">bugs</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">bug</span>.<span class="ruby-identifier">dup</span> } + + <span class="ruby-identifier">new_rev</span>.<span class="ruby-identifier">save!</span> + <span class="ruby-identifier">new_rev</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- deep_copy-source --> + + </div> + + + + + </div><!-- deep_copy-method --> + + + <div id="get_linked_bugs-method" class="method-detail "> + <a name="method-i-get_linked_bugs"></a> + + + <div class="method-heading"> + <span class="method-name">get_linked_bugs</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 Integers of the bugs linked to this revision</p> + + + + <div class="method-source-code" id="get_linked_bugs-source"> +<pre> +<span class="ruby-comment"># File app/models/revision.rb, line 49</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_linked_bugs</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">bugs</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">bug</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">bug</span>.<span class="ruby-identifier">bug_id</span>.<span class="ruby-identifier">to_i</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- get_linked_bugs-source --> + + </div> + + + + + </div><!-- get_linked_bugs-method --> + + + <div id="packages_by_atom-method" class="method-detail "> + <a name="method-i-packages_by_atom"></a> + + + <div class="method-heading"> + <span class="method-name">packages_by_atom</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Returns the packages linked to this revision grouped by atoms</p> + + + + <div class="method-source-code" id="packages_by_atom-source"> +<pre> +<span class="ruby-comment"># File app/models/revision.rb, line 87</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">packages_by_atom</span> + <span class="ruby-identifier">packages_list</span> = {} + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">packages</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-identifier">packages_list</span>[<span class="ruby-identifier">p</span>[<span class="ruby-value">:atom</span>]] <span class="ruby-operator">||=</span> {} + (<span class="ruby-identifier">packages_list</span>[<span class="ruby-identifier">p</span>[<span class="ruby-value">:atom</span>]][<span class="ruby-identifier">p</span>[<span class="ruby-value">:my_type</span>]] <span class="ruby-operator">||=</span> []) <span class="ruby-operator"><<</span> <span class="ruby-identifier">p</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">packages_list</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- packages_by_atom-source --> + + </div> + + + + + </div><!-- packages_by_atom-method --> + + + <div id="to_s-method" class="method-detail "> + <a name="method-i-to_s"></a> + + + <div class="method-heading"> + <span class="method-name">to_s</span><span + class="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_s-source"> +<pre> +<span class="ruby-comment"># File app/models/revision.rb, line 97</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span> + <span class="ruby-identifier">s</span> = <span class="ruby-node">"r#{self.revid}"</span> + <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">is_release?</span> + <span class="ruby-identifier">s</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" (release #{self.release_revision})"</span> + <span class="ruby-keyword">end</span> + + <span class="ruby-identifier">s</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- to_s-source --> + + </div> + + + + + </div><!-- to_s-method --> + + + <div id="update_cached_bug_metadata-method" class="method-detail "> + <a name="method-i-update_cached_bug_metadata"></a> + + + <div class="method-heading"> + <span class="method-name">update_cached_bug_metadata</span><span + class="method-args">()</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + + <div class="method-description"> + + <p>Updates the cached metadata of all assigned bugs</p> + + + + <div class="method-source-code" id="update_cached_bug_metadata-source"> +<pre> +<span class="ruby-comment"># File app/models/revision.rb, line 65</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier">update_cached_bug_metadata</span> + <span class="ruby-keyword">self</span>.<span class="ruby-identifier">bugs</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">b</span><span class="ruby-operator">|</span> + <span class="ruby-identifier">b</span>.<span class="ruby-identifier">update_cached_metadata</span> + <span class="ruby-keyword">end</span> +<span class="ruby-keyword">end</span></pre> + </div><!-- update_cached_bug_metadata-source --> + + </div> + + + + + </div><!-- update_cached_bug_metadata-method --> + + + </div><!-- public-instance-method-details --> + + </div><!-- 5Buntitled-5D --> + + + </div><!-- documentation --> + + <div id="validator-badges"> + <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> + <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish + Rdoc Generator</a> 2</small>.</p> + </div> + +</body> +</html> + |