doc/classes/Git/Status.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html
   3      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   4      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   5
   6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   7 <head>
   8   <title>Class: Git::Status</title>
   9   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  10   <meta http-equiv="Content-Script-Type" content="text/javascript" />
  11   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
  12   <script type="text/javascript">
  13   // <![CDATA[
  14
  15   function popupCode( url ) {
  16     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  17   }
  18
  19   function toggleCode( id ) {
  20     if ( document.getElementById )
  21       elem = document.getElementById( id );
  22     else if ( document.all )
  23       elem = eval( "document.all." + id );
  24     else
  25       return false;
  26
  27     elemStyle = elem.style;
  28
  29     if ( elemStyle.display != "block" ) {
  30       elemStyle.display = "block"
  31     } else {
  32       elemStyle.display = "none"
  33     }
  34
  35     return true;
  36   }
  37
  38   // Make codeblocks hidden by default
  39   document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  40
  41   // ]]>
  42   </script>
  43
  44 </head>
  45 <body>
  46
  47
  48
  49     <div id="classHeader">
  50         <table class="header-table">
  51         <tr class="top-aligned-row">
  52           <td><strong>Class</strong></td>
  53           <td class="class-name-in-header">Git::Status</td>
  54         </tr>
  55         <tr class="top-aligned-row">
  56             <td><strong>In:</strong></td>
  57             <td>
  58                 <a href="../../files/lib/git/status_rb.html">
  59                 lib/git/status.rb
  60                 </a>
  61         <br />
  62             </td>
  63         </tr>
  64
  65         <tr class="top-aligned-row">
  66             <td><strong>Parent:</strong></td>
  67             <td>
  68                 <a href="Object.html">
  69                 Object
  70                </a>
  71             </td>
  72         </tr>
  73         </table>
  74     </div>
  75   <!-- banner header -->
  76
  77   <div id="bodyContent">
  78
  79
  80
  81   <div id="contextContent">
  82
  83
  84
  85    </div>
  86
  87     <div id="method-list">
  88       <h3 class="section-bar">Methods</h3>
  89
  90       <div class="name-list">
  91       <a href="#M000011">[]</a>&nbsp;&nbsp;
  92       <a href="#M000007">added</a>&nbsp;&nbsp;
  93       <a href="#M000006">changed</a>&nbsp;&nbsp;
  94       <a href="#M000008">deleted</a>&nbsp;&nbsp;
  95       <a href="#M000012">each</a>&nbsp;&nbsp;
  96       <a href="#M000005">new</a>&nbsp;&nbsp;
  97       <a href="#M000010">pretty</a>&nbsp;&nbsp;
  98       <a href="#M000009">untracked</a>&nbsp;&nbsp;
  99       </div>
 100     </div>
 101
 102   </div>
 103
 104
 105     <!-- if includes -->
 106     <div id="includes">
 107       <h3 class="section-bar">Included Modules</h3>
 108
 109       <div id="includes-list">
 110         <span class="include-name">Enumerable</span>
 111       </div>
 112     </div>
 113
 114     <div id="section">
 115
 116     <div id="class-list">
 117       <h3 class="section-bar">Classes and Modules</h3>
 118
 119       Class <a href="Status/StatusFile.html" class="link">Git::Status::StatusFile</a><br />
 120
 121     </div>
 122
 123
 124
 125
 126
 127
 128
 129     <!-- if method_list -->
 130     <div id="methods">
 131       <h3 class="section-bar">Public Class methods</h3>
 132
 133       <div id="method-M000005" class="method-detail">
 134         <a name="M000005"></a>
 135
 136         <div class="method-heading">
 137           <a href="#M000005" class="method-signature">
 138           <span class="method-name">new</span><span class="method-args">(base)</span>
 139           </a>
 140         </div>
 141
 142         <div class="method-description">
 143           <p><a class="source-toggle" href="#"
 144             onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
 145           <div class="method-source-code" id="M000005-source">
 146 <pre>
 147 <span class="ruby-comment cmt"># File lib/git/status.rb, line 9</span>
 148     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>)
 149       <span class="ruby-ivar">@base</span> = <span class="ruby-identifier">base</span>
 150       <span class="ruby-identifier">construct_status</span>
 151     <span class="ruby-keyword kw">end</span>
 152 </pre>
 153           </div>
 154         </div>
 155       </div>
 156
 157       <h3 class="section-bar">Public Instance methods</h3>
 158
 159       <div id="method-M000011" class="method-detail">
 160         <a name="M000011"></a>
 161
 162         <div class="method-heading">
 163           <a href="#M000011" class="method-signature">
 164           <span class="method-name">[]</span><span class="method-args">(file)</span>
 165           </a>
 166         </div>
 167
 168         <div class="method-description">
 169           <p>
 170 enumerable method
 171 </p>
 172           <p><a class="source-toggle" href="#"
 173             onclick="toggleCode('M000011-source');return false;">[Source]</a></p>
 174           <div class="method-source-code" id="M000011-source">
 175 <pre>
 176 <span class="ruby-comment cmt"># File lib/git/status.rb, line 47</span>
 177     <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">file</span>)
 178       <span class="ruby-ivar">@files</span>[<span class="ruby-identifier">file</span>]
 179     <span class="ruby-keyword kw">end</span>
 180 </pre>
 181           </div>
 182         </div>
 183       </div>
 184
 185       <div id="method-M000007" class="method-detail">
 186         <a name="M000007"></a>
 187
 188         <div class="method-heading">
 189           <a href="#M000007" class="method-signature">
 190           <span class="method-name">added</span><span class="method-args">()</span>
 191           </a>
 192         </div>
 193
 194         <div class="method-description">
 195           <p><a class="source-toggle" href="#"
 196             onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
 197           <div class="method-source-code" id="M000007-source">
 198 <pre>
 199 <span class="ruby-comment cmt"># File lib/git/status.rb, line 18</span>
 200     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">added</span>
 201       <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'A'</span> }
 202     <span class="ruby-keyword kw">end</span>
 203 </pre>
 204           </div>
 205         </div>
 206       </div>
 207
 208       <div id="method-M000006" class="method-detail">
 209         <a name="M000006"></a>
 210
 211         <div class="method-heading">
 212           <a href="#M000006" class="method-signature">
 213           <span class="method-name">changed</span><span class="method-args">()</span>
 214           </a>
 215         </div>
 216
 217         <div class="method-description">
 218           <p><a class="source-toggle" href="#"
 219             onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
 220           <div class="method-source-code" id="M000006-source">
 221 <pre>
 222 <span class="ruby-comment cmt"># File lib/git/status.rb, line 14</span>
 223     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">changed</span>
 224       <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'M'</span> }
 225     <span class="ruby-keyword kw">end</span>
 226 </pre>
 227           </div>
 228         </div>
 229       </div>
 230
 231       <div id="method-M000008" class="method-detail">
 232         <a name="M000008"></a>
 233
 234         <div class="method-heading">
 235           <a href="#M000008" class="method-signature">
 236           <span class="method-name">deleted</span><span class="method-args">()</span>
 237           </a>
 238         </div>
 239
 240         <div class="method-description">
 241           <p><a class="source-toggle" href="#"
 242             onclick="toggleCode('M000008-source');return false;">[Source]</a></p>
 243           <div class="method-source-code" id="M000008-source">
 244 <pre>
 245 <span class="ruby-comment cmt"># File lib/git/status.rb, line 22</span>
 246     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">deleted</span>
 247       <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">type</span> <span class="ruby-operator">==</span> <span class="ruby-value str">'D'</span> }
 248     <span class="ruby-keyword kw">end</span>
 249 </pre>
 250           </div>
 251         </div>
 252       </div>
 253
 254       <div id="method-M000012" class="method-detail">
 255         <a name="M000012"></a>
 256
 257         <div class="method-heading">
 258           <a href="#M000012" class="method-signature">
 259           <span class="method-name">each</span><span class="method-args">() {|file| ...}</span>
 260           </a>
 261         </div>
 262
 263         <div class="method-description">
 264           <p><a class="source-toggle" href="#"
 265             onclick="toggleCode('M000012-source');return false;">[Source]</a></p>
 266           <div class="method-source-code" id="M000012-source">
 267 <pre>
 268 <span class="ruby-comment cmt"># File lib/git/status.rb, line 51</span>
 269     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each</span>
 270       <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
 271         <span class="ruby-keyword kw">yield</span> <span class="ruby-identifier">file</span>
 272       <span class="ruby-keyword kw">end</span>
 273     <span class="ruby-keyword kw">end</span>
 274 </pre>
 275           </div>
 276         </div>
 277       </div>
 278
 279       <div id="method-M000010" class="method-detail">
 280         <a name="M000010"></a>
 281
 282         <div class="method-heading">
 283           <a href="#M000010" class="method-signature">
 284           <span class="method-name">pretty</span><span class="method-args">()</span>
 285           </a>
 286         </div>
 287
 288         <div class="method-description">
 289           <p><a class="source-toggle" href="#"
 290             onclick="toggleCode('M000010-source');return false;">[Source]</a></p>
 291           <div class="method-source-code" id="M000010-source">
 292 <pre>
 293 <span class="ruby-comment cmt"># File lib/git/status.rb, line 30</span>
 294     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">pretty</span>
 295       <span class="ruby-identifier">out</span> = <span class="ruby-value str">''</span>
 296       <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
 297         <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">path</span>
 298         <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n\tsha(r) &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">sha_repo</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">' '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">mode_repo</span>.<span class="ruby-identifier">to_s</span>
 299         <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n\tsha(i) &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">sha_index</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-value str">' '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">mode_index</span>.<span class="ruby-identifier">to_s</span>
 300         <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n\ttype   &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_s</span>
 301         <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n\tstage  &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">stage</span>.<span class="ruby-identifier">to_s</span>
 302         <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n\tuntrac &quot;</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">file</span>.<span class="ruby-identifier">untracked</span>.<span class="ruby-identifier">to_s</span>
 303         <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n&quot;</span>
 304       <span class="ruby-keyword kw">end</span>
 305       <span class="ruby-identifier">out</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n&quot;</span>
 306       <span class="ruby-identifier">out</span>
 307     <span class="ruby-keyword kw">end</span>
 308 </pre>
 309           </div>
 310         </div>
 311       </div>
 312
 313       <div id="method-M000009" class="method-detail">
 314         <a name="M000009"></a>
 315
 316         <div class="method-heading">
 317           <a href="#M000009" class="method-signature">
 318           <span class="method-name">untracked</span><span class="method-args">()</span>
 319           </a>
 320         </div>
 321
 322         <div class="method-description">
 323           <p><a class="source-toggle" href="#"
 324             onclick="toggleCode('M000009-source');return false;">[Source]</a></p>
 325           <div class="method-source-code" id="M000009-source">
 326 <pre>
 327 <span class="ruby-comment cmt"># File lib/git/status.rb, line 26</span>
 328     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">untracked</span>
 329       <span class="ruby-ivar">@files</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">untracked</span> }
 330     <span class="ruby-keyword kw">end</span>
 331 </pre>
 332           </div>
 333         </div>
 334       </div>
 335
 336
 337     </div>
 338
 339
 340   </div>
 341
 342
 343 <div id="validator-badges">
 344   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 345 </div>
 346
 347 </body>
 348 </html>