Loading...
Helix SwarmHelix Swarm
Loading...

HWSHelpers.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • HWSHelpers.html #1
  • View
  • Commits
  • Open Download .zip Download (7 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.   Module: HWSHelpers
  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#!HWSHelpers.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">HWSHelpers</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>Module: HWSHelpers
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.   
  75.     
  76.   
  77.     
  78.   
  79.   
  80.   
  81.     <dt class="r1 last">Defined in:</dt>
  82.     <dd class="r1 last">lib/hws_helpers.rb</dd>
  83.   
  84. </dl>
  85. <div class="clear"></div>
  86.  
  87. <h2>Overview</h2><div class="docstring">
  88.   <div class="discussion">
  89.     
  90. <p>These are helper methods that should be common to most modular
  91. &#39;Apps&#39; in Helix Web Services.</p>
  92.  
  93.  
  94.   </div>
  95. </div>
  96. <div class="tags">
  97.   
  98.  
  99. </div>
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.   
  107.     <h2>
  108.       Instance Method Summary
  109.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  110.     </h2>
  111.  
  112.     <ul class="summary">
  113.       
  114.         <li class="public ">
  115.   <span class="summary_signature">
  116.     
  117.       <a href="#require_p4-instance_method" title="#require_p4 (instance method)">- (Object) <strong>require_p4</strong> </a>
  118.     
  119.  
  120.     
  121.   </span>
  122.   
  123.   
  124.   
  125.   
  126.   
  127.   
  128.   
  129.  
  130.   
  131.     <span class="summary_desc"><div class='inline'>
  132. <p>This will ensure that the environment contains a p4 handle that is
  133. configured using our typical <code>hws_settings</code> options.</p>
  134. </div></span>
  135.   
  136. </li>
  137.  
  138.       
  139.         <li class="public ">
  140.   <span class="summary_signature">
  141.     
  142.       <a href="#require_p4_with_temp_client-instance_method" title="#require_p4_with_temp_client (instance method)">- (Object) <strong>require_p4_with_temp_client</strong> </a>
  143.     
  144.  
  145.     
  146.   </span>
  147.   
  148.   
  149.   
  150.   
  151.   
  152.   
  153.   
  154.  
  155.   
  156.     <span class="summary_desc"><div class='inline'>
  157. <p>This ensures that the <code>p4</code> handle has an associated temporary
  158. client workspace.</p>
  159. </div></span>
  160.   
  161. </li>
  162.  
  163.       
  164.     </ul>
  165.   
  166.  
  167.  
  168.  
  169.   <div id="instance_method_details" class="method_details_list">
  170.     <h2>Instance Method Details</h2>
  171.  
  172.     
  173.       <div class="method_details first">
  174.   <h3 class="signature first" id="require_p4-instance_method">
  175.   
  176.     - (<tt>Object</tt>) <strong>require_p4</strong> 
  177.   
  178.  
  179.   
  180.  
  181.   
  182. </h3><div class="docstring">
  183.   <div class="discussion">
  184.     
  185. <p>This will ensure that the environment contains a p4 handle that is
  186. configured using our typical <code>hws_settings</code> options.</p>
  187.  
  188. <p>It should be rare to actually require using this method. This is typically
  189. generated by authentication middleware.</p>
  190.  
  191. <p>The p4 is possibly <em>not</em> connected or logged in.</p>
  192.  
  193.  
  194.   </div>
  195. </div>
  196. <div class="tags">
  197.   
  198.  
  199. </div><table class="source_code">
  200.   <tr>
  201.     <td>
  202.       <pre class="lines">
  203.  
  204.  
  205. 16
  206. 17
  207. 18
  208. 19
  209. 20
  210. 21
  211. 22</pre>
  212.     </td>
  213.     <td>
  214.       <pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 16</span>
  215.  
  216. <span class='kw'>def</span> <span class='id identifier rubyid_require_p4'>require_p4</span>
  217.   <span class='kw'>unless</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>
  218.     <span class='id identifier rubyid_p4'>p4</span> <span class='op'>=</span> <span class='const'>P4Util</span><span class='period'>.</span><span class='id identifier rubyid_open_from_env'>open_from_env</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
  219.     <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
  220.     <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='op'>=</span> <span class='id identifier rubyid_p4'>p4</span>
  221.   <span class='kw'>end</span>
  222. <span class='kw'>end</span></pre>
  223.     </td>
  224.   </tr>
  225. </table>
  226. </div>
  227.     
  228.       <div class="method_details ">
  229.   <h3 class="signature " id="require_p4_with_temp_client-instance_method">
  230.   
  231.     - (<tt>Object</tt>) <strong>require_p4_with_temp_client</strong> 
  232.   
  233.  
  234.   
  235.  
  236.   
  237. </h3><div class="docstring">
  238.   <div class="discussion">
  239.     
  240. <p>This ensures that the <code>p4</code> handle has an associated temporary
  241. client workspace.</p>
  242.  
  243. <p>The local temporary directory is saved under &#39;p4_root&#39;.</p>
  244.  
  245.  
  246.   </div>
  247. </div>
  248. <div class="tags">
  249.   
  250.  
  251. </div><table class="source_code">
  252.   <tr>
  253.     <td>
  254.       <pre class="lines">
  255.  
  256.  
  257. 28
  258. 29
  259. 30
  260. 31</pre>
  261.     </td>
  262.     <td>
  263.       <pre class="code"><span class="info file"># File 'lib/hws_helpers.rb', line 28</span>
  264.  
  265. <span class='kw'>def</span> <span class='id identifier rubyid_require_p4_with_temp_client'>require_p4_with_temp_client</span>
  266.   <span class='id identifier rubyid_require_p4'>require_p4</span>
  267.   <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='op'>=</span> <span class='const'>P4Util</span><span class='period'>.</span><span class='id identifier rubyid_create_temp_client'>create_temp_client</span><span class='lparen'>(</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='rparen'>)</span>
  268. <span class='kw'>end</span></pre>
  269.     </td>
  270.   </tr>
  271. </table>
  272. </div>
  273.     
  274.   </div>
  275.  
  276. </div>
  277.  
  278.     <div id="footer">
  279.   Generated on Tue Sep 15 01:20:28 2015 by
  280.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  281.   0.8.7.6 (ruby-2.2.3).
  282. </div>
  283.  
  284.   </body>
  285. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago