Loading...
Helix SwarmHelix Swarm
Loading...

HWSP4Cleanup.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • HWSP4Cleanup.html #1
  • View
  • Commits
  • Open Download .zip Download (11 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Class: HWSP4Cleanup
  8.   
  9.     &mdash; Documentation by YARD 0.8.7.6
  10.   
  11. </title>
  12.  
  13.   <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
  14.  
  15.   <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
  16.  
  17. <script type="text/javascript" charset="utf-8">
  18.   hasFrames = window.top.frames.main ? true : false;
  19.   relpath = '';
  20.   framesUrl = "frames.html#!HWSP4Cleanup.html";
  21. </script>
  22.  
  23.  
  24.   <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
  25.  
  26.   <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
  27.  
  28.  
  29.   </head>
  30.   <body>
  31.     <div id="header">
  32.       <div id="menu">
  33.   
  34.     <a href="_index.html">Index (H)</a> &raquo;
  35.     
  36.     
  37.     <span class="title">HWSP4Cleanup</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Class: HWSP4Cleanup
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.     <dt class="r1">Inherits:</dt>
  75.     <dd class="r1">
  76.       <span class="inheritName">Object</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">HWSP4Cleanup</li>
  82.           
  83.         </ul>
  84.         <a href="#" class="inheritanceTree">show all</a>
  85.       
  86.       </dd>
  87.     
  88.   
  89.   
  90.     
  91.   
  92.     
  93.   
  94.   
  95.   
  96.     <dt class="r2 last">Defined in:</dt>
  97.     <dd class="r2 last">lib/hws_p4_cleanup.rb</dd>
  98.   
  99. </dl>
  100. <div class="clear"></div>
  101.  
  102. <h2>Overview</h2><div class="docstring">
  103.   <div class="discussion">
  104.     
  105. <p>Rack middleware that cleans up any &#39;p4&#39; handle added to the
  106. environment during processing.</p>
  107.  
  108. <p>This should always run, even in the face of exceptions. Make sure any
  109. middleware configured after this step does <em>NOT</em> swallow exceptions.</p>
  110.  
  111. <p>This expects that if a temporary workspace was generated, the
  112. &#39;p4_root&#39; variable was also added into the environment. See
  113. P4Helpers.</p>
  114.  
  115.  
  116.   </div>
  117. </div>
  118. <div class="tags">
  119.   
  120.  
  121. </div>
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.   
  129.     <h2>
  130.       Instance Method Summary
  131.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  132.     </h2>
  133.  
  134.     <ul class="summary">
  135.       
  136.         <li class="public ">
  137.   <span class="summary_signature">
  138.     
  139.       <a href="#call-instance_method" title="#call (instance method)">- (Object) <strong>call</strong>(env) </a>
  140.     
  141.  
  142.     
  143.   </span>
  144.   
  145.   
  146.   
  147.   
  148.   
  149.   
  150.   
  151.  
  152.   
  153.     <span class="summary_desc"><div class='inline'></div></span>
  154.   
  155. </li>
  156.  
  157.       
  158.         <li class="public ">
  159.   <span class="summary_signature">
  160.     
  161.       <a href="#cleanup_p4-instance_method" title="#cleanup_p4 (instance method)">- (Object) <strong>cleanup_p4</strong>(p4: nil, p4_root: nil) </a>
  162.     
  163.  
  164.     
  165.   </span>
  166.   
  167.   
  168.   
  169.   
  170.   
  171.   
  172.   
  173.  
  174.   
  175.     <span class="summary_desc"><div class='inline'></div></span>
  176.   
  177. </li>
  178.  
  179.       
  180.         <li class="public ">
  181.   <span class="summary_signature">
  182.     
  183.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (HWSP4Cleanup) <strong>initialize</strong>(app) </a>
  184.     
  185.  
  186.     
  187.   </span>
  188.   
  189.   
  190.     <span class="note title constructor">constructor</span>
  191.   
  192.   
  193.   
  194.   
  195.   
  196.   
  197.  
  198.   
  199.     <span class="summary_desc"><div class='inline'>
  200. <p>A new instance of HWSP4Cleanup.</p>
  201. </div></span>
  202.   
  203. </li>
  204.  
  205.       
  206.     </ul>
  207.   
  208.  
  209. <div id="constructor_details" class="method_details_list">
  210.   <h2>Constructor Details</h2>
  211.   
  212.     <div class="method_details first">
  213.   <h3 class="signature first" id="initialize-instance_method">
  214.   
  215.     - (<tt><span class='object_link'><a href="" title="HWSP4Cleanup (class)">HWSP4Cleanup</a></span></tt>) <strong>initialize</strong>(app) 
  216.   
  217.  
  218.   
  219.  
  220.   
  221. </h3><div class="docstring">
  222.   <div class="discussion">
  223.     
  224. <p>Returns a new instance of HWSP4Cleanup</p>
  225.  
  226.  
  227.   </div>
  228. </div>
  229. <div class="tags">
  230.   
  231.  
  232. </div><table class="source_code">
  233.   <tr>
  234.     <td>
  235.       <pre class="lines">
  236.  
  237.  
  238. 13
  239. 14
  240. 15</pre>
  241.     </td>
  242.     <td>
  243.       <pre class="code"><span class="info file"># File 'lib/hws_p4_cleanup.rb', line 13</span>
  244.  
  245. <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='rparen'>)</span>
  246.   <span class='ivar'>@app</span> <span class='op'>=</span> <span class='id identifier rubyid_app'>app</span>
  247. <span class='kw'>end</span></pre>
  248.     </td>
  249.   </tr>
  250. </table>
  251. </div>
  252.   
  253. </div>
  254.  
  255.  
  256.   <div id="instance_method_details" class="method_details_list">
  257.     <h2>Instance Method Details</h2>
  258.  
  259.     
  260.       <div class="method_details first">
  261.   <h3 class="signature first" id="call-instance_method">
  262.   
  263.     - (<tt>Object</tt>) <strong>call</strong>(env) 
  264.   
  265.  
  266.   
  267.  
  268.   
  269. </h3><table class="source_code">
  270.   <tr>
  271.     <td>
  272.       <pre class="lines">
  273.  
  274.  
  275. 17
  276. 18
  277. 19
  278. 20
  279. 21
  280. 22
  281. 23
  282. 24
  283. 25
  284. 26
  285. 27
  286. 28
  287. 29
  288. 30
  289. 31
  290. 32
  291. 33
  292. 34
  293. 35
  294. 36
  295. 37
  296. 38
  297. 39
  298. 40</pre>
  299.     </td>
  300.     <td>
  301.       <pre class="code"><span class="info file"># File 'lib/hws_p4_cleanup.rb', line 17</span>
  302.  
  303. <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
  304.   <span class='id identifier rubyid_ex'>ex</span> <span class='op'>=</span> <span class='kw'>nil</span>
  305.   <span class='kw'>begin</span>
  306.     <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='ivar'>@app</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
  307.   <span class='kw'>rescue</span> <span class='const'>StandardError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
  308.     <span class='id identifier rubyid_ex'>ex</span> <span class='op'>=</span> <span class='id identifier rubyid_e'>e</span>
  309.   <span class='kw'>end</span>
  310.  
  311.   <span class='comment'># We need to convert any exception before attempting to delete,
  312. </span>  <span class='comment'># otherwise the p4.messages and p4.errors will get reset at the next
  313. </span>  <span class='comment'># method call.
  314. </span>  <span class='kw'>if</span> <span class='id identifier rubyid_ex'>ex</span><span class='period'>.</span><span class='id identifier rubyid_instance_of?'>instance_of?</span><span class='lparen'>(</span><span class='const'>P4Exception</span><span class='rparen'>)</span>
  315.     <span class='comment'># TODO define common error classes and replace this
  316. </span>    <span class='comment'># ex = Util.make_p4_error(p4)
  317. </span>  <span class='kw'>end</span>
  318.  
  319.   <span class='kw'>if</span> <span class='id identifier rubyid_env'>env</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  320.     <span class='id identifier rubyid_cleanup_p4'>cleanup_p4</span><span class='lparen'>(</span><span class='label'>p4:</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>p4_root:</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4_root</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
  321.   <span class='kw'>end</span>
  322.  
  323.   <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_ex'>ex</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ex'>ex</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
  324.  
  325.   <span class='id identifier rubyid_results'>results</span>
  326. <span class='kw'>end</span></pre>
  327.     </td>
  328.   </tr>
  329. </table>
  330. </div>
  331.     
  332.       <div class="method_details ">
  333.   <h3 class="signature " id="cleanup_p4-instance_method">
  334.   
  335.     - (<tt>Object</tt>) <strong>cleanup_p4</strong>(p4: nil, p4_root: nil) 
  336.   
  337.  
  338.   
  339.  
  340.   
  341. </h3><table class="source_code">
  342.   <tr>
  343.     <td>
  344.       <pre class="lines">
  345.  
  346.  
  347. 43
  348. 44
  349. 45
  350. 46
  351. 47
  352. 48
  353. 49</pre>
  354.     </td>
  355.     <td>
  356.       <pre class="code"><span class="info file"># File 'lib/hws_p4_cleanup.rb', line 43</span>
  357.  
  358. <span class='kw'>def</span> <span class='id identifier rubyid_cleanup_p4'>cleanup_p4</span><span class='lparen'>(</span><span class='label'>p4:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>p4_root:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  359.   <span class='kw'>if</span> <span class='id identifier rubyid_p4'>p4</span> <span class='kw'>and</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>INVALID</span><span class='tstring_end'>&#39;</span></span>
  360.     <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_client'>run_client</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-d</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_client'>client</span><span class='rparen'>)</span>
  361.     <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_rmtree'>rmtree</span><span class='lparen'>(</span><span class='id identifier rubyid_p4_root'>p4_root</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_p4_root'>p4_root</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
  362.   <span class='kw'>end</span>
  363.   <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_disconnect'>disconnect</span> <span class='kw'>if</span> <span class='id identifier rubyid_p4'>p4</span> <span class='kw'>and</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
  364. <span class='kw'>end</span></pre>
  365.     </td>
  366.   </tr>
  367. </table>
  368. </div>
  369.     
  370.   </div>
  371.  
  372. </div>
  373.  
  374.     <div id="footer">
  375.   Generated on Tue Sep 15 01:20:29 2015 by
  376.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  377.   0.8.7.6 (ruby-2.2.3).
  378. </div>
  379.  
  380.   </body>
  381. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago