doc/code/classes/Tree.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6     <title>Tree</title>
   7     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   8     <link rel="stylesheet" href="../css/reset.css" type="text/css" media="screen" />
   9 <link rel="stylesheet" href="../css/main.css" type="text/css" media="screen" />
  10 <link rel="stylesheet" href="../css/github.css" type="text/css" media="screen" />
  11 <script src="../js/jquery-1.3.2.min.js" type="text/javascript" charset="utf-8"></script>
  12 <script src="../js/jquery-effect.js" type="text/javascript" charset="utf-8"></script>
  13 <script src="../js/main.js" type="text/javascript" charset="utf-8"></script>
  14 <script src="../js/highlight.pack.js" type="text/javascript" charset="utf-8"></script>
  15
  16 </head>
  17
  18 <body>
  19     <div class="banner">
  20
  21         <h1>
  22             <span class="type">Class</span>
  23             Tree
  24
  25                 <span class="parent">&lt;
  26
  27                     Object
  28
  29                 </span>
  30
  31         </h1>
  32         <ul class="files">
  33
  34             <li><a href="../files/app/models/tree_rb.html">app/models/tree.rb</a></li>
  35
  36         </ul>
  37     </div>
  38     <div id="bodyContent">
  39         <div id="content">
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54     <!-- Method ref -->
  55     <div class="sectiontitle">Methods</div>
  56     <dl class="methods">
  57
  58         <dt>E</dt>
  59         <dd>
  60           <ul>
  61
  62
  63               <li>
  64                 <a href="#method-i-empty-3F">empty?</a>
  65               </li>
  66
  67           </ul>
  68         </dd>
  69
  70         <dt>I</dt>
  71         <dd>
  72           <ul>
  73
  74
  75               <li>
  76                 <a href="#method-i-invalid-3F">invalid?</a>,
  77               </li>
  78
  79
  80               <li>
  81                 <a href="#method-i-is_blob-3F">is_blob?</a>
  82               </li>
  83
  84           </ul>
  85         </dd>
  86
  87         <dt>N</dt>
  88         <dd>
  89           <ul>
  90
  91
  92               <li>
  93                 <a href="#method-c-new">new</a>
  94               </li>
  95
  96           </ul>
  97         </dd>
  98
  99     </dl>
 100
 101
 102
 103     <!-- Includes -->
 104     <div class="sectiontitle">Included Modules</div>
 105     <ul>
 106
 107         <li>
 108
 109             Linguist::BlobHelper
 110
 111         </li>
 112
 113     </ul>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128       <!-- Section attributes -->
 129       <div class="sectiontitle">Attributes</div>
 130       <table border='0' cellpadding='5'>
 131
 132           <tr valign='top'>
 133             <td class='attr-rw'>
 134               [RW]
 135             </td>
 136             <td class='attr-name'>path</td>
 137             <td class='attr-desc'></td>
 138           </tr>
 139
 140           <tr valign='top'>
 141             <td class='attr-rw'>
 142               [RW]
 143             </td>
 144             <td class='attr-name'>project</td>
 145             <td class='attr-desc'></td>
 146           </tr>
 147
 148           <tr valign='top'>
 149             <td class='attr-rw'>
 150               [RW]
 151             </td>
 152             <td class='attr-name'>ref</td>
 153             <td class='attr-desc'></td>
 154           </tr>
 155
 156           <tr valign='top'>
 157             <td class='attr-rw'>
 158               [RW]
 159             </td>
 160             <td class='attr-name'>tree</td>
 161             <td class='attr-desc'></td>
 162           </tr>
 163
 164       </table>
 165
 166
 167
 168     <!-- Methods -->
 169
 170       <div class="sectiontitle">Class Public methods</div>
 171
 172         <div class="method">
 173           <div class="title method-title" id="method-c-new">
 174
 175               <b>new</b>(raw_tree, project, ref = nil, path = nil)
 176
 177             <a href="../classes/Tree.html#method-c-new" name="method-c-new" class="permalink">Link</a>
 178           </div>
 179
 180
 181             <div class="description">
 182
 183             </div>
 184
 185
 186
 187
 188
 189
 190             <div class="sourcecode">
 191
 192               <p class="source-link">
 193                 Source:
 194                 <a href="javascript:toggleSource('method-c-new_source')" id="l_method-c-new_source">show</a>
 195
 196               </p>
 197               <div id="method-c-new_source" class="dyn-source">
 198                 <pre><span class="ruby-comment"># File app/models/tree.rb, line 8</span>
 199 <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">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>)
 200   <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>
 201   <span class="ruby-ivar">@tree</span> = <span class="ruby-keyword">if</span> <span class="ruby-identifier">path</span>.<span class="ruby-identifier">present?</span>
 202             <span class="ruby-identifier">raw_tree</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">path</span>
 203           <span class="ruby-keyword">else</span>
 204             <span class="ruby-identifier">raw_tree</span>
 205           <span class="ruby-keyword">end</span>
 206 <span class="ruby-keyword">end</span></pre>
 207               </div>
 208             </div>
 209
 210           </div>
 211
 212       <div class="sectiontitle">Instance Public methods</div>
 213
 214         <div class="method">
 215           <div class="title method-title" id="method-i-empty-3F">
 216
 217               <b>empty?</b>()
 218
 219             <a href="../classes/Tree.html#method-i-empty-3F" name="method-i-empty-3F" class="permalink">Link</a>
 220           </div>
 221
 222
 223             <div class="description">
 224
 225             </div>
 226
 227
 228
 229
 230
 231
 232             <div class="sourcecode">
 233
 234               <p class="source-link">
 235                 Source:
 236                 <a href="javascript:toggleSource('method-i-empty-3F_source')" id="l_method-i-empty-3F_source">show</a>
 237
 238               </p>
 239               <div id="method-i-empty-3F_source" class="dyn-source">
 240                 <pre><span class="ruby-comment"># File app/models/tree.rb, line 25</span>
 241 <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">empty?</span>
 242   <span class="ruby-identifier">data</span>.<span class="ruby-identifier">blank?</span>
 243 <span class="ruby-keyword">end</span></pre>
 244               </div>
 245             </div>
 246
 247           </div>
 248
 249         <div class="method">
 250           <div class="title method-title" id="method-i-invalid-3F">
 251
 252               <b>invalid?</b>()
 253
 254             <a href="../classes/Tree.html#method-i-invalid-3F" name="method-i-invalid-3F" class="permalink">Link</a>
 255           </div>
 256
 257
 258             <div class="description">
 259
 260             </div>
 261
 262
 263
 264
 265
 266
 267             <div class="sourcecode">
 268
 269               <p class="source-link">
 270                 Source:
 271                 <a href="javascript:toggleSource('method-i-invalid-3F_source')" id="l_method-i-invalid-3F_source">show</a>
 272
 273               </p>
 274               <div id="method-i-invalid-3F_source" class="dyn-source">
 275                 <pre><span class="ruby-comment"># File app/models/tree.rb, line 21</span>
 276 <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">invalid?</span>
 277   <span class="ruby-identifier">tree</span>.<span class="ruby-identifier">nil?</span>
 278 <span class="ruby-keyword">end</span></pre>
 279               </div>
 280             </div>
 281
 282           </div>
 283
 284         <div class="method">
 285           <div class="title method-title" id="method-i-is_blob-3F">
 286
 287               <b>is_blob?</b>()
 288
 289             <a href="../classes/Tree.html#method-i-is_blob-3F" name="method-i-is_blob-3F" class="permalink">Link</a>
 290           </div>
 291
 292
 293             <div class="description">
 294
 295             </div>
 296
 297
 298
 299
 300
 301
 302             <div class="sourcecode">
 303
 304               <p class="source-link">
 305                 Source:
 306                 <a href="javascript:toggleSource('method-i-is_blob-3F_source')" id="l_method-i-is_blob-3F_source">show</a>
 307
 308               </p>
 309               <div id="method-i-is_blob-3F_source" class="dyn-source">
 310                 <pre><span class="ruby-comment"># File app/models/tree.rb, line 17</span>
 311 <span class="ruby-keyword">def</span> <span class="ruby-keyword ruby-title">is_blob?</span>
 312   <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>)
 313 <span class="ruby-keyword">end</span></pre>
 314               </div>
 315             </div>
 316
 317           </div>
 318                     </div>
 319
 320     </div>
 321   </body>
 322 </html>