Helix SwarmHelix Swarm
Loading...

Util.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services/
  • HelixVersioningEngine/
  • Util.html #11
  • View
  • Commits
  • Open Download .zip Download (111 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: HelixVersioningEngine::Util
  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#!HelixVersioningEngine/Util.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 (U)</a> &raquo;
  35.     <span class='title'><span class='object_link'><a href="../HelixVersioningEngine.html" title="HelixVersioningEngine (module)">HelixVersioningEngine</a></span></span>
  36.      &raquo; 
  37.     <span class="title">Util</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: HelixVersioningEngine::Util
  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/helix_versioning_engine/util.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>TODO most of the methods in this module should probably be removed</p>
  91.  
  92. <p>Namespace for p4ruby conventions used in the P4 Web API.</p>
  93.  
  94.  
  95.   </div>
  96. </div>
  97. <div class="tags">
  98.   
  99.  
  100. </div>
  101.   <h2>Constant Summary</h2>
  102.   
  103.     <dl class="constants">
  104.       
  105.         <dt id="PROPERTIES-constant" class="">PROPERTIES =
  106.           
  107.         </dt>
  108.         <dd><pre class="code"><span class='lbracket'>[</span>
  109.   <span class='symbol'>:password</span><span class='comma'>,</span> <span class='symbol'>:port</span><span class='comma'>,</span> <span class='symbol'>:user</span><span class='comma'>,</span> <span class='symbol'>:api_level</span><span class='comma'>,</span> <span class='symbol'>:charset</span><span class='comma'>,</span> <span class='symbol'>:client</span><span class='comma'>,</span>
  110.   <span class='symbol'>:host</span><span class='comma'>,</span> <span class='symbol'>:handler</span><span class='comma'>,</span> <span class='symbol'>:maxlocktime</span><span class='comma'>,</span> <span class='symbol'>:maxresults</span><span class='comma'>,</span> <span class='symbol'>:maxscanrows</span><span class='comma'>,</span> <span class='symbol'>:prog</span><span class='comma'>,</span>
  111.   <span class='symbol'>:ticketfile</span>
  112. <span class='rbracket'>]</span></pre></dd>
  113.       
  114.         <dt id="BRANCHES_MAP-constant" class="">BRANCHES_MAP =
  115.           <div class="docstring">
  116.   <div class="discussion">
  117.     
  118. <p>Data &#39;normalization&#39;</p>
  119.  
  120. <p>A very annoying aspect of our tagged output is that it often is
  121. <em>slightly</em> different between &#39;plural&#39; and spec forms. This
  122. logic is made available as an option in this API</p>
  123.  
  124.  
  125.   </div>
  126. </div>
  127. <div class="tags">
  128.   
  129.  
  130. </div>
  131.         </dt>
  132.         <dd><pre class="code"><span class='lbrace'>{</span>
  133.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>branch</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Branch</span><span class='tstring_end'>&#39;</span></span>
  134. <span class='rbrace'>}</span></pre></dd>
  135.       
  136.         <dt id="BRANCHES_DATES-constant" class="">BRANCHES_DATES =
  137.           
  138.         </dt>
  139.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>Update</span><span class='words_sep'> </span><span class='tstring_content'>Access</span><span class='words_sep'>)</span></pre></dd>
  140.       
  141.         <dt id="CHANGES_MAP-constant" class="">CHANGES_MAP =
  142.           
  143.         </dt>
  144.         <dd><pre class="code"><span class='lbrace'>{</span>
  145.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>path</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Path</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  146.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>change</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Change</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  147.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>time</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Date</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  148.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>client</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Client</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  149.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  150.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>status</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Status</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  151.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  152.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>changeType</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  153.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Description</span><span class='tstring_end'>&#39;</span></span>
  154. <span class='rbrace'>}</span></pre></dd>
  155.       
  156.         <dt id="CHANGES_DATES-constant" class="">CHANGES_DATES =
  157.           
  158.         </dt>
  159.         <dd><pre class="code"><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Date</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span></pre></dd>
  160.       
  161.         <dt id="CLIENTS_MAP-constant" class="">CLIENTS_MAP =
  162.           
  163.         </dt>
  164.         <dd><pre class="code"><span class='lbrace'>{</span>
  165.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>client</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Client</span><span class='tstring_end'>&#39;</span></span>
  166. <span class='rbrace'>}</span></pre></dd>
  167.       
  168.         <dt id="CLIENTS_DATES-constant" class="">CLIENTS_DATES =
  169.           
  170.         </dt>
  171.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>Update</span><span class='words_sep'> </span><span class='tstring_content'>Access</span><span class='words_sep'>)</span></pre></dd>
  172.       
  173.         <dt id="DEPOTS_MAP-constant" class="">DEPOTS_MAP =
  174.           
  175.         </dt>
  176.         <dd><pre class="code"><span class='lbrace'>{</span>
  177.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Depot</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  178.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>time</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Date</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  179.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  180.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>map</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Map</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  181.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Description</span><span class='tstring_end'>&#39;</span></span>
  182. <span class='rbrace'>}</span></pre></dd>
  183.       
  184.         <dt id="DEPOTS_DATES-constant" class="">DEPOTS_DATES =
  185.           
  186.         </dt>
  187.         <dd><pre class="code"><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Date</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span></pre></dd>
  188.       
  189.         <dt id="DESCRIBE_MAP-constant" class="">DESCRIBE_MAP =
  190.           <div class="docstring">
  191.   <div class="discussion">
  192.     
  193. <p>Note that individual files are handled differently, since the keys are
  194. prefixed</p>
  195.  
  196.  
  197.   </div>
  198. </div>
  199. <div class="tags">
  200.   
  201.  
  202. </div>
  203.         </dt>
  204.         <dd><pre class="code"><span class='const'>CHANGES_MAP</span></pre></dd>
  205.       
  206.         <dt id="DESCRIBE_DATES-constant" class="">DESCRIBE_DATES =
  207.           
  208.         </dt>
  209.         <dd><pre class="code"><span class='const'>CHANGES_DATES</span></pre></dd>
  210.       
  211.         <dt id="DIRS_MAP-constant" class="">DIRS_MAP =
  212.           
  213.         </dt>
  214.         <dd><pre class="code"><span class='lbrace'>{</span>
  215.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dir</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Dir</span><span class='tstring_end'>&#39;</span></span>
  216. <span class='rbrace'>}</span></pre></dd>
  217.       
  218.         <dt id="FILES_MAP-constant" class="">FILES_MAP =
  219.           
  220.         </dt>
  221.         <dd><pre class="code"><span class='lbrace'>{</span>
  222.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depotFile</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DepotFile</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  223.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rev</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Revision</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  224.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>change</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Change</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  225.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>action</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Action</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  226.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>type</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Type</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  227.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>time</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Date</span><span class='tstring_end'>&#39;</span></span>
  228. <span class='rbrace'>}</span></pre></dd>
  229.       
  230.         <dt id="FILES_DATES-constant" class="">FILES_DATES =
  231.           
  232.         </dt>
  233.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>Date</span><span class='words_sep'>)</span></pre></dd>
  234.       
  235.         <dt id="GROUPS_MAP-constant" class="">GROUPS_MAP =
  236.           
  237.         </dt>
  238.         <dd><pre class="code"><span class='lbrace'>{</span>
  239.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>group</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Group</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  240.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>maxResults</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>MaxResults</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  241.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>maxScanRows</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>MaxScanRows</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  242.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>maxLockTime</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>MaxLockTime</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  243.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>timeout</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Timeout</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  244.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Description</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  245.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  246.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>isSubGroup</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>IsSubGroup</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  247.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>isOwner</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>IsOwner</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  248.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>isUser</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>IsUser</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  249.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>passTimeout</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>PasswordTimeout</span><span class='tstring_end'>&#39;</span></span>
  250. <span class='rbrace'>}</span></pre></dd>
  251.       
  252.         <dt id="JOBS_MAP-constant" class="">JOBS_MAP =
  253.           
  254.         </dt>
  255.         <dd><pre class="code"><span class='lbrace'>{</span><span class='rbrace'>}</span></pre></dd>
  256.       
  257.         <dt id="JOBS_DATES-constant" class="">JOBS_DATES =
  258.           
  259.         </dt>
  260.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>Date</span><span class='words_sep'>)</span></pre></dd>
  261.       
  262.         <dt id="LABELS_MAP-constant" class="">LABELS_MAP =
  263.           
  264.         </dt>
  265.         <dd><pre class="code"><span class='lbrace'>{</span>
  266.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>label</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Label</span><span class='tstring_end'>&#39;</span></span>
  267. <span class='rbrace'>}</span></pre></dd>
  268.       
  269.         <dt id="LABELS_DATES-constant" class="">LABELS_DATES =
  270.           
  271.         </dt>
  272.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>Update</span><span class='words_sep'> </span><span class='tstring_content'>Access</span><span class='words_sep'>)</span></pre></dd>
  273.       
  274.         <dt id="STREAMS_MAP-constant" class="">STREAMS_MAP =
  275.           <div class="docstring">
  276.   <div class="discussion">
  277.     
  278. <p>This isn&#39;t supported but kept here for reference. We <em>might</em>
  279. support this. OPENED_MAP = {  &#39;change&#39; =&gt; &#39;Change&#39;, 
  280. &#39;client&#39; =&gt; &#39;Client&#39;,  &#39;user&#39; =&gt;
  281. &#39;User&#39; }</p>
  282.  
  283.  
  284.   </div>
  285. </div>
  286. <div class="tags">
  287.   
  288.  
  289. </div>
  290.         </dt>
  291.         <dd><pre class="code"><span class='lbrace'>{</span>
  292.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>desc</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Description</span><span class='tstring_end'>&#39;</span></span>
  293. <span class='rbrace'>}</span></pre></dd>
  294.       
  295.         <dt id="STREAMS_DATES-constant" class="">STREAMS_DATES =
  296.           
  297.         </dt>
  298.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>Update</span><span class='words_sep'> </span><span class='tstring_content'>Access</span><span class='words_sep'>)</span></pre></dd>
  299.       
  300.         <dt id="USERS_MAP-constant" class="">USERS_MAP =
  301.           
  302.         </dt>
  303.         <dd><pre class="code"><span class='lbrace'>{</span>
  304.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>passwordChange</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>PasswordChange</span><span class='tstring_end'>&#39;</span></span>
  305. <span class='rbrace'>}</span></pre></dd>
  306.       
  307.         <dt id="USERS_DATES-constant" class="">USERS_DATES =
  308.           
  309.         </dt>
  310.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>Update</span><span class='words_sep'> </span><span class='tstring_content'>Access</span><span class='words_sep'> </span><span class='tstring_content'>PasswordChange</span><span class='words_sep'>)</span></pre></dd>
  311.       
  312.         <dt id="GROUP_PROPERTIES-constant" class="">GROUP_PROPERTIES =
  313.           <div class="docstring">
  314.   <div class="discussion">
  315.     
  316. <p>These are &#39;single values&#39; of properties of Group objects we use
  317. while collating them.</p>
  318.  
  319.  
  320.   </div>
  321. </div>
  322. <div class="tags">
  323.   
  324.  
  325. </div>
  326.         </dt>
  327.         <dd><pre class="code"><span class='qwords_beg'>%w(
  328. </span><span class='tstring_content'>Group</span><span class='words_sep'> </span><span class='tstring_content'>MaxResults</span><span class='words_sep'> </span><span class='tstring_content'>MaxScanRows</span><span class='words_sep'> </span><span class='tstring_content'>MaxLockTime</span><span class='words_sep'> </span><span class='tstring_content'>Timeout</span><span class='words_sep'> </span><span class='tstring_end'>PasswordTimeout</span></span></pre></dd>
  329.       
  330.         <dt id="FILE_KEYS-constant" class="">FILE_KEYS =
  331.           
  332.         </dt>
  333.         <dd><pre class="code"><span class='qwords_beg'>%w(</span><span class='tstring_content'>depotFile</span><span class='words_sep'> </span><span class='tstring_content'>action</span><span class='words_sep'> </span><span class='tstring_content'>type</span><span class='words_sep'> </span><span class='tstring_content'>rev</span><span class='words_sep'> </span><span class='tstring_content'>digest</span><span class='words_sep'> </span><span class='tstring_content'>fileSize</span><span class='words_sep'>)</span></pre></dd>
  334.       
  335.     </dl>
  336.   
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.   
  345.     <h2>
  346.       Class Method Summary
  347.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  348.     </h2>
  349.  
  350.     <ul class="summary">
  351.       
  352.         <li class="public ">
  353.   <span class="summary_signature">
  354.     
  355.       <a href="#assert_no_special_paths-class_method" title="assert_no_special_paths (class method)">+ (Object) <strong>assert_no_special_paths</strong>(paths) </a>
  356.     
  357.  
  358.     
  359.   </span>
  360.   
  361.   
  362.   
  363.   
  364.   
  365.   
  366.   
  367.  
  368.   
  369.     <span class="summary_desc"><div class='inline'>
  370. <p>Assert that no relative directory or Perforce wildcard is in use for each
  371. string in the <code>paths</code> array.</p>
  372. </div></span>
  373.   
  374. </li>
  375.  
  376.       
  377.         <li class="public ">
  378.   <span class="summary_signature">
  379.     
  380.       <a href="#collate_group_results-class_method" title="collate_group_results (class method)">+ (Object) <strong>collate_group_results</strong>(results) </a>
  381.     
  382.  
  383.     
  384.   </span>
  385.   
  386.   
  387.   
  388.   
  389.   
  390.   
  391.   
  392.  
  393.   
  394.     <span class="summary_desc"><div class='inline'>
  395. <p>Will apply the normalizer to set up a consistent field naming and date
  396. format, but then &#39;collates&#39; the output into a single list of
  397. &#39;groups&#39;.</p>
  398. </div></span>
  399.   
  400. </li>
  401.  
  402.       
  403.         <li class="public ">
  404.   <span class="summary_signature">
  405.     
  406.       <a href="#date_str%3F-class_method" title="date_str? (class method)">+ (Boolean) <strong>date_str?</strong>(str) </a>
  407.     
  408.  
  409.     
  410.   </span>
  411.   
  412.   
  413.   
  414.   
  415.   
  416.   
  417.   
  418.  
  419.   
  420.     <span class="summary_desc"><div class='inline'>
  421. <p>Returns true if we can parse the string as a date.</p>
  422. </div></span>
  423.   
  424. </li>
  425.  
  426.       
  427.         <li class="public ">
  428.   <span class="summary_signature">
  429.     
  430.       <a href="#error%3F-class_method" title="error? (class method)">+ (Boolean) <strong>error?</strong>(p4) </a>
  431.     
  432.  
  433.     
  434.   </span>
  435.   
  436.   
  437.   
  438.   
  439.   
  440.   
  441.   
  442.  
  443.   
  444.     <span class="summary_desc"><div class='inline'>
  445. <p>Check for P4 errors.</p>
  446. </div></span>
  447.   
  448. </li>
  449.  
  450.       
  451.         <li class="public ">
  452.   <span class="summary_signature">
  453.     
  454.       <a href="#existing_path%3F-class_method" title="existing_path? (class method)">+ (Boolean) <strong>existing_path?</strong>(existing_results, depot_path) </a>
  455.     
  456.  
  457.     
  458.   </span>
  459.   
  460.   
  461.   
  462.   
  463.   
  464.   
  465.   
  466.  
  467.   
  468.     <span class="summary_desc"><div class='inline'></div></span>
  469.   
  470. </li>
  471.  
  472.       
  473.         <li class="public ">
  474.   <span class="summary_signature">
  475.     
  476.       <a href="#i%3F-class_method" title="i? (class method)">+ (Boolean) <strong>i?</strong>(str) </a>
  477.     
  478.  
  479.     
  480.   </span>
  481.   
  482.   
  483.   
  484.   
  485.   
  486.   
  487.   
  488.  
  489.   
  490.     <span class="summary_desc"><div class='inline'>
  491. <p>Returns true if .to_i will actually convert this string to an integer.</p>
  492. </div></span>
  493.   
  494. </li>
  495.  
  496.       
  497.         <li class="public ">
  498.   <span class="summary_signature">
  499.     
  500.       <a href="#init_changelist-class_method" title="init_changelist (class method)">+ (Object) <strong>init_changelist</strong>(p4, description) </a>
  501.     
  502.  
  503.     
  504.   </span>
  505.   
  506.   
  507.   
  508.   
  509.   
  510.   
  511.   
  512.  
  513.   
  514.     <span class="summary_desc"><div class='inline'></div></span>
  515.   
  516. </li>
  517.  
  518.       
  519.         <li class="public ">
  520.   <span class="summary_signature">
  521.     
  522.       <a href="#local_path-class_method" title="local_path (class method)">+ (Object) <strong>local_path</strong>(depot_path, root) </a>
  523.     
  524.  
  525.     
  526.   </span>
  527.   
  528.   
  529.   
  530.   
  531.   
  532.   
  533.   
  534.  
  535.   
  536.     <span class="summary_desc"><div class='inline'></div></span>
  537.   
  538. </li>
  539.  
  540.       
  541.         <li class="public ">
  542.   <span class="summary_signature">
  543.     
  544.       <a href="#make_normalizer-class_method" title="make_normalizer (class method)">+ (Object) <strong>make_normalizer</strong>(field_map, offset, date_fields = nil) </a>
  545.     
  546.  
  547.     
  548.   </span>
  549.   
  550.   
  551.   
  552.   
  553.   
  554.   
  555.   
  556.  
  557.   
  558.     <span class="summary_desc"><div class='inline'></div></span>
  559.   
  560. </li>
  561.  
  562.       
  563.         <li class="public ">
  564.   <span class="summary_signature">
  565.     
  566.       <a href="#map_describe_file_key-class_method" title="map_describe_file_key (class method)">+ (Object) <strong>map_describe_file_key</strong>(key) </a>
  567.     
  568.  
  569.     
  570.   </span>
  571.   
  572.   
  573.   
  574.   
  575.   
  576.   
  577.   
  578.  
  579.   
  580.     <span class="summary_desc"><div class='inline'></div></span>
  581.   
  582. </li>
  583.  
  584.       
  585.         <li class="public ">
  586.   <span class="summary_signature">
  587.     
  588.       <a href="#mark_change-class_method" title="mark_change (class method)">+ (Object) <strong>mark_change</strong>(type, p4, change_id, root, depot_path) </a>
  589.     
  590.  
  591.     
  592.   </span>
  593.   
  594.   
  595.   
  596.   
  597.   
  598.   
  599.   
  600.  
  601.   
  602.     <span class="summary_desc"><div class='inline'></div></span>
  603.   
  604. </li>
  605.  
  606.       
  607.         <li class="public ">
  608.   <span class="summary_signature">
  609.     
  610.       <a href="#normalize_describe_files-class_method" title="normalize_describe_files (class method)">+ (Object) <strong>normalize_describe_files</strong>(results) </a>
  611.     
  612.  
  613.     
  614.   </span>
  615.   
  616.   
  617.   
  618.   
  619.   
  620.   
  621.   
  622.  
  623.   
  624.     <span class="summary_desc"><div class='inline'>
  625. <p>Each file entry in the base describe tagged output contains several fields,
  626. suffixed with an index value.</p>
  627. </div></span>
  628.   
  629. </li>
  630.  
  631.       
  632.         <li class="public ">
  633.   <span class="summary_signature">
  634.     
  635.       <a href="#normalizer-class_method" title="normalizer (class method)">+ (Object) <strong>normalizer</strong>(spec_type, offset) </a>
  636.     
  637.  
  638.     
  639.   </span>
  640.   
  641.   
  642.   
  643.   
  644.   
  645.   
  646.   
  647.  
  648.   
  649.     <span class="summary_desc"><div class='inline'>
  650. <p>For each &#39;spec type&#39; returns a function that will ensure that: -
  651. case is consistent between different return calls, prefer &#39;spec&#39;
  652. types - dates are returned.</p>
  653. </div></span>
  654.   
  655. </li>
  656.  
  657.       
  658.         <li class="public ">
  659.   <span class="summary_signature">
  660.     
  661.       <a href="#open-class_method" title="open (class method)">+ (Object) <strong>open</strong>(options = {}) </a>
  662.     
  663.  
  664.     
  665.   </span>
  666.   
  667.   
  668.   
  669.   
  670.   
  671.   
  672.   
  673.  
  674.   
  675.     <span class="summary_desc"><div class='inline'>
  676. <p>Creates your p4 connection using some common forms.</p>
  677. </div></span>
  678.   
  679. </li>
  680.  
  681.       
  682.         <li class="public ">
  683.   <span class="summary_signature">
  684.     
  685.       <a href="#p4_date_offset-class_method" title="p4_date_offset (class method)">+ (Object) <strong>p4_date_offset</strong>(str) </a>
  686.     
  687.  
  688.     
  689.   </span>
  690.   
  691.   
  692.   
  693.   
  694.   
  695.   
  696.   
  697.  
  698.   
  699.     <span class="summary_desc"><div class='inline'></div></span>
  700.   
  701. </li>
  702.  
  703.       
  704.         <li class="public ">
  705.   <span class="summary_signature">
  706.     
  707.       <a href="#p4_date_to_i-class_method" title="p4_date_to_i (class method)">+ (Object) <strong>p4_date_to_i</strong>(offset, p4date) </a>
  708.     
  709.  
  710.     
  711.   </span>
  712.   
  713.   
  714.   
  715.   
  716.   
  717.   
  718.   
  719.  
  720.   
  721.     <span class="summary_desc"><div class='inline'>
  722. <p>In general we get dates without any offset information, which has to be
  723. retrieved via the serverDate field from &#39;p4 info&#39;.</p>
  724. </div></span>
  725.   
  726. </li>
  727.  
  728.       
  729.         <li class="public ">
  730.   <span class="summary_signature">
  731.     
  732.       <a href="#p4_ticket%3F-class_method" title="p4_ticket? (class method)">+ (Boolean) <strong>p4_ticket?</strong>(str) </a>
  733.     
  734.  
  735.     
  736.   </span>
  737.   
  738.   
  739.   
  740.   
  741.   
  742.   
  743.   
  744.  
  745.   
  746.     <span class="summary_desc"><div class='inline'>
  747. <p>Returns true if the string looks like a Perforce authentication ticket.</p>
  748. </div></span>
  749.   
  750. </li>
  751.  
  752.       
  753.         <li class="public ">
  754.   <span class="summary_signature">
  755.     
  756.       <a href="#raise_error-class_method" title="raise_error (class method)">+ (Object) <strong>raise_error</strong>(p4) </a>
  757.     
  758.  
  759.     
  760.   </span>
  761.   
  762.   
  763.   
  764.   
  765.   
  766.   
  767.   
  768.  
  769.   
  770.     <span class="summary_desc"><div class='inline'>
  771. <p>Raise an exception if necessary on a P4 Error.</p>
  772. </div></span>
  773.   
  774. </li>
  775.  
  776.       
  777.         <li class="public ">
  778.   <span class="summary_signature">
  779.     
  780.       <a href="#relative_dir%3F-class_method" title="relative_dir? (class method)">+ (Boolean) <strong>relative_dir?</strong>(str) </a>
  781.     
  782.  
  783.     
  784.   </span>
  785.   
  786.   
  787.   
  788.   
  789.   
  790.   
  791.   
  792.  
  793.   
  794.     <span class="summary_desc"><div class='inline'>
  795. <p>Returns true if str is &#39;.&#39; or &#39;..&#39;.</p>
  796. </div></span>
  797.   
  798. </li>
  799.  
  800.       
  801.         <li class="public ">
  802.   <span class="summary_signature">
  803.     
  804.       <a href="#replace_unset_with_0-class_method" title="replace_unset_with_0 (class method)">+ (Object) <strong>replace_unset_with_0</strong>(results) </a>
  805.     
  806.  
  807.     
  808.   </span>
  809.   
  810.   
  811.   
  812.   
  813.   
  814.   
  815.   
  816.  
  817.   
  818.     <span class="summary_desc"><div class='inline'></div></span>
  819.   
  820. </li>
  821.  
  822.       
  823.         <li class="public ">
  824.   <span class="summary_signature">
  825.     
  826.       <a href="#resolve_charset-class_method" title="resolve_charset (class method)">+ (Object) <strong>resolve_charset</strong>(env, settings) </a>
  827.     
  828.  
  829.     
  830.   </span>
  831.   
  832.   
  833.   
  834.   
  835.   
  836.   
  837.   
  838.  
  839.   
  840.     <span class="summary_desc"><div class='inline'></div></span>
  841.   
  842. </li>
  843.  
  844.       
  845.         <li class="public ">
  846.   <span class="summary_signature">
  847.     
  848.       <a href="#resolve_host-class_method" title="resolve_host (class method)">+ (Object) <strong>resolve_host</strong>(env, settings) </a>
  849.     
  850.  
  851.     
  852.   </span>
  853.   
  854.   
  855.   
  856.   
  857.   
  858.   
  859.   
  860.  
  861.   
  862.     <span class="summary_desc"><div class='inline'></div></span>
  863.   
  864. </li>
  865.  
  866.       
  867.         <li class="public ">
  868.   <span class="summary_signature">
  869.     
  870.       <a href="#resolve_password-class_method" title="resolve_password (class method)">+ (Object) <strong>resolve_password</strong>(env, settings) </a>
  871.     
  872.  
  873.     
  874.   </span>
  875.   
  876.   
  877.   
  878.   
  879.   
  880.   
  881.   
  882.  
  883.   
  884.     <span class="summary_desc"><div class='inline'></div></span>
  885.   
  886. </li>
  887.  
  888.       
  889.         <li class="public ">
  890.   <span class="summary_signature">
  891.     
  892.       <a href="#resolve_port-class_method" title="resolve_port (class method)">+ (Object) <strong>resolve_port</strong>(env, settings) </a>
  893.     
  894.  
  895.     
  896.   </span>
  897.   
  898.   
  899.   
  900.   
  901.   
  902.   
  903.   
  904.  
  905.   
  906.     <span class="summary_desc"><div class='inline'></div></span>
  907.   
  908. </li>
  909.  
  910.       
  911.         <li class="public ">
  912.   <span class="summary_signature">
  913.     
  914.       <a href="#save_content-class_method" title="save_content (class method)">+ (Object) <strong>save_content</strong>(root, depot_path, content) </a>
  915.     
  916.  
  917.     
  918.   </span>
  919.   
  920.   
  921.   
  922.   
  923.   
  924.   
  925.   
  926.  
  927.   
  928.     <span class="summary_desc"><div class='inline'></div></span>
  929.   
  930. </li>
  931.  
  932.       
  933.         <li class="public ">
  934.   <span class="summary_signature">
  935.     
  936.       <a href="#singular-class_method" title="singular (class method)">+ (Object) <strong>singular</strong>(plural) </a>
  937.     
  938.  
  939.     
  940.   </span>
  941.   
  942.   
  943.   
  944.   
  945.   
  946.   
  947.   
  948.  
  949.   
  950.     <span class="summary_desc"><div class='inline'></div></span>
  951.   
  952. </li>
  953.  
  954.       
  955.         <li class="public ">
  956.   <span class="summary_signature">
  957.     
  958.       <a href="#uuid%3F-class_method" title="uuid? (class method)">+ (Boolean) <strong>uuid?</strong>(str) </a>
  959.     
  960.  
  961.     
  962.   </span>
  963.   
  964.   
  965.   
  966.   
  967.   
  968.   
  969.   
  970.  
  971.   
  972.     <span class="summary_desc"><div class='inline'>
  973. <p>We only count uuids that were returned via SecureRandom.uuid used to
  974. generate internal security tokens.</p>
  975. </div></span>
  976.   
  977. </li>
  978.  
  979.       
  980.         <li class="public ">
  981.   <span class="summary_signature">
  982.     
  983.       <a href="#wildcard%3F-class_method" title="wildcard? (class method)">+ (Boolean) <strong>wildcard?</strong>(str) </a>
  984.     
  985.  
  986.     
  987.   </span>
  988.   
  989.   
  990.   
  991.   
  992.   
  993.   
  994.   
  995.  
  996.   
  997.     <span class="summary_desc"><div class='inline'>
  998. <p>Returns true when <code>str</code> contains a Perforce wildcard.</p>
  999. </div></span>
  1000.   
  1001. </li>
  1002.  
  1003.       
  1004.     </ul>
  1005.   
  1006.  
  1007.  
  1008.  
  1009.   <div id="class_method_details" class="method_details_list">
  1010.     <h2>Class Method Details</h2>
  1011.  
  1012.     
  1013.       <div class="method_details first">
  1014.   <h3 class="signature first" id="assert_no_special_paths-class_method">
  1015.   
  1016.     + (<tt>Object</tt>) <strong>assert_no_special_paths</strong>(paths) 
  1017.   
  1018.  
  1019.   
  1020.  
  1021.   
  1022. </h3><div class="docstring">
  1023.   <div class="discussion">
  1024.     
  1025. <p>Assert that no relative directory or Perforce wildcard is in use for each
  1026. string in the <code>paths</code> array.</p>
  1027.  
  1028.  
  1029.   </div>
  1030. </div>
  1031. <div class="tags">
  1032.   
  1033.  
  1034. </div><table class="source_code">
  1035.   <tr>
  1036.     <td>
  1037.       <pre class="lines">
  1038.  
  1039.  
  1040. 67
  1041. 68
  1042. 69
  1043. 70
  1044. 71
  1045. 72
  1046. 73
  1047. 74
  1048. 75
  1049. 76
  1050. 77
  1051. 78</pre>
  1052.     </td>
  1053.     <td>
  1054.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 67</span>
  1055.  
  1056. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_assert_no_special_paths'>assert_no_special_paths</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
  1057.   <span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
  1058.     <span class='kw'>if</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_wildcard?'>wildcard?</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  1059.       <span class='id identifier rubyid_fail'>fail</span> <span class='const'>P4Error</span><span class='period'>.</span><span class='id identifier rubyid_default_error'>default_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The path &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; contains a Perforce </span><span class='tstring_end'>&quot;</span></span>\
  1060.         <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>wildcard, which is not allowed</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  1061.     <span class='kw'>end</span>
  1062.     <span class='kw'>if</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_relative_dir?'>relative_dir?</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
  1063.       <span class='id identifier rubyid_fail'>fail</span> <span class='const'>P4Error</span><span class='period'>.</span><span class='id identifier rubyid_default_error'>default_error</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The path &#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; is a relative </span><span class='tstring_end'>&quot;</span></span> \
  1064.         <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>directory, which is not allowed</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  1065.     <span class='kw'>end</span>
  1066.   <span class='kw'>end</span>
  1067. <span class='kw'>end</span></pre>
  1068.     </td>
  1069.   </tr>
  1070. </table>
  1071. </div>
  1072.     
  1073.       <div class="method_details ">
  1074.   <h3 class="signature " id="collate_group_results-class_method">
  1075.   
  1076.     + (<tt>Object</tt>) <strong>collate_group_results</strong>(results) 
  1077.   
  1078.  
  1079.   
  1080.  
  1081.   
  1082. </h3><div class="docstring">
  1083.   <div class="discussion">
  1084.     
  1085. <p>Will apply the normalizer to set up a consistent field naming and date
  1086. format, but then &#39;collates&#39; the output into a single list of
  1087. &#39;groups&#39;.</p>
  1088.  
  1089. <p>The groups output is kind of funny, because it basically lists users, with
  1090. group access fields. It&#39;s very non-obvious, and in the end, most
  1091. clients will need to run logic like this anyway.</p>
  1092.  
  1093.  
  1094.   </div>
  1095. </div>
  1096. <div class="tags">
  1097.   
  1098.  
  1099. </div><table class="source_code">
  1100.   <tr>
  1101.     <td>
  1102.       <pre class="lines">
  1103.  
  1104.  
  1105. 334
  1106. 335
  1107. 336
  1108. 337
  1109. 338
  1110. 339
  1111. 340
  1112. 341
  1113. 342
  1114. 343
  1115. 344
  1116. 345
  1117. 346
  1118. 347
  1119. 348
  1120. 349
  1121. 350
  1122. 351
  1123. 352
  1124. 353
  1125. 354
  1126. 355
  1127. 356
  1128. 357
  1129. 358</pre>
  1130.     </td>
  1131.     <td>
  1132.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 334</span>
  1133.  
  1134. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_collate_group_results'>collate_group_results</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  1135.   <span class='id identifier rubyid_collated'>collated</span> <span class='op'>=</span> <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_group_by'>group_by</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Group</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
  1136.   <span class='id identifier rubyid_updated'>updated</span> <span class='op'>=</span> <span class='id identifier rubyid_collated'>collated</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__key'>_key</span><span class='comma'>,</span> <span class='id identifier rubyid_items'>items</span><span class='op'>|</span>
  1137.     <span class='comment'># The first item sets most of the values, we then figure out array
  1138. </span>    <span class='comment'># subvalues
  1139. </span>
  1140.     <span class='id identifier rubyid_group'>group</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
  1141.     <span class='const'>GROUP_PROPERTIES</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span>
  1142.       <span class='id identifier rubyid_group'>group</span><span class='lbracket'>[</span><span class='id identifier rubyid_p'>p</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='lbracket'>[</span><span class='id identifier rubyid_p'>p</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='rparen'>)</span>
  1143.     <span class='kw'>end</span>
  1144.  
  1145.     <span class='id identifier rubyid_group'>group</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Users</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span>
  1146.         <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_find_all'>find_all</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>IsUser</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
  1147.  
  1148.     <span class='id identifier rubyid_group'>group</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Subgroups</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span>
  1149.         <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_find_all'>find_all</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>IsSubGroup</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
  1150.  
  1151.     <span class='id identifier rubyid_group'>group</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Owners</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span>
  1152.         <span class='id identifier rubyid_items'>items</span><span class='period'>.</span><span class='id identifier rubyid_find_all'>find_all</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>IsOwner</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>1</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_x'>x</span><span class='op'>|</span> <span class='id identifier rubyid_x'>x</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>User</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
  1153.  
  1154.     <span class='id identifier rubyid_group'>group</span>
  1155.   <span class='kw'>end</span>
  1156.  
  1157.   <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_replace'>replace</span><span class='lparen'>(</span><span class='id identifier rubyid_updated'>updated</span><span class='rparen'>)</span>
  1158. <span class='kw'>end</span></pre>
  1159.     </td>
  1160.   </tr>
  1161. </table>
  1162. </div>
  1163.     
  1164.       <div class="method_details ">
  1165.   <h3 class="signature " id="date_str?-class_method">
  1166.   
  1167.     + (<tt>Boolean</tt>) <strong>date_str?</strong>(str) 
  1168.   
  1169.  
  1170.   
  1171.  
  1172.   
  1173. </h3><div class="docstring">
  1174.   <div class="discussion">
  1175.     
  1176. <p>Returns true if we can parse the string as a date</p>
  1177.  
  1178.  
  1179.   </div>
  1180. </div>
  1181. <div class="tags">
  1182.   
  1183. <p class="tag_title">Returns:</p>
  1184. <ul class="return">
  1185.   
  1186.     <li>
  1187.       
  1188.       
  1189.         <span class='type'>(<tt>Boolean</tt>)</span>
  1190.       
  1191.       
  1192.       
  1193.     </li>
  1194.   
  1195. </ul>
  1196.  
  1197. </div><table class="source_code">
  1198.   <tr>
  1199.     <td>
  1200.       <pre class="lines">
  1201.  
  1202.  
  1203. 418
  1204. 419
  1205. 420</pre>
  1206.     </td>
  1207.     <td>
  1208.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 418</span>
  1209.  
  1210. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_date_str?'>date_str?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  1211.   <span class='const'>Date</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span> <span class='kw'>rescue</span> <span class='kw'>false</span>
  1212. <span class='kw'>end</span></pre>
  1213.     </td>
  1214.   </tr>
  1215. </table>
  1216. </div>
  1217.     
  1218.       <div class="method_details ">
  1219.   <h3 class="signature " id="error?-class_method">
  1220.   
  1221.     + (<tt>Boolean</tt>) <strong>error?</strong>(p4) 
  1222.   
  1223.  
  1224.   
  1225.  
  1226.   
  1227. </h3><div class="docstring">
  1228.   <div class="discussion">
  1229.     
  1230. <p>Check for P4 errors</p>
  1231.  
  1232.  
  1233.   </div>
  1234. </div>
  1235. <div class="tags">
  1236.   
  1237. <p class="tag_title">Returns:</p>
  1238. <ul class="return">
  1239.   
  1240.     <li>
  1241.       
  1242.       
  1243.         <span class='type'>(<tt>Boolean</tt>)</span>
  1244.       
  1245.       
  1246.       
  1247.     </li>
  1248.   
  1249. </ul>
  1250.  
  1251. </div><table class="source_code">
  1252.   <tr>
  1253.     <td>
  1254.       <pre class="lines">
  1255.  
  1256.  
  1257. 55
  1258. 56
  1259. 57</pre>
  1260.     </td>
  1261.     <td>
  1262.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 55</span>
  1263.  
  1264. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_error?'>error?</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='rparen'>)</span>
  1265.   <span class='op'>!</span><span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span>
  1266. <span class='kw'>end</span></pre>
  1267.     </td>
  1268.   </tr>
  1269. </table>
  1270. </div>
  1271.     
  1272.       <div class="method_details ">
  1273.   <h3 class="signature " id="existing_path?-class_method">
  1274.   
  1275.     + (<tt>Boolean</tt>) <strong>existing_path?</strong>(existing_results, depot_path) 
  1276.   
  1277.  
  1278.   
  1279.  
  1280.   
  1281. </h3><div class="docstring">
  1282.   <div class="discussion">
  1283.     
  1284.  
  1285.   </div>
  1286. </div>
  1287. <div class="tags">
  1288.   
  1289. <p class="tag_title">Returns:</p>
  1290. <ul class="return">
  1291.   
  1292.     <li>
  1293.       
  1294.       
  1295.         <span class='type'>(<tt>Boolean</tt>)</span>
  1296.       
  1297.       
  1298.       
  1299.     </li>
  1300.   
  1301. </ul>
  1302.  
  1303. </div><table class="source_code">
  1304.   <tr>
  1305.     <td>
  1306.       <pre class="lines">
  1307.  
  1308.  
  1309. 117
  1310. 118
  1311. 119
  1312. 120
  1313. 121</pre>
  1314.     </td>
  1315.     <td>
  1316.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 117</span>
  1317.  
  1318. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_existing_path?'>existing_path?</span><span class='lparen'>(</span><span class='id identifier rubyid_existing_results'>existing_results</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_path'>depot_path</span><span class='rparen'>)</span>
  1319.   <span class='id identifier rubyid_existing_results'>existing_results</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_result'>result</span><span class='op'>|</span>
  1320.     <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depotFile</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_depot_path'>depot_path</span>
  1321.   <span class='kw'>end</span>
  1322. <span class='kw'>end</span></pre>
  1323.     </td>
  1324.   </tr>
  1325. </table>
  1326. </div>
  1327.     
  1328.       <div class="method_details ">
  1329.   <h3 class="signature " id="i?-class_method">
  1330.   
  1331.     + (<tt>Boolean</tt>) <strong>i?</strong>(str) 
  1332.   
  1333.  
  1334.   
  1335.  
  1336.   
  1337. </h3><div class="docstring">
  1338.   <div class="discussion">
  1339.     
  1340. <p>Returns true if .to_i will actually convert this string to an integer</p>
  1341.  
  1342.  
  1343.   </div>
  1344. </div>
  1345. <div class="tags">
  1346.   
  1347. <p class="tag_title">Returns:</p>
  1348. <ul class="return">
  1349.   
  1350.     <li>
  1351.       
  1352.       
  1353.         <span class='type'>(<tt>Boolean</tt>)</span>
  1354.       
  1355.       
  1356.       
  1357.     </li>
  1358.   
  1359. </ul>
  1360.  
  1361. </div><table class="source_code">
  1362.   <tr>
  1363.     <td>
  1364.       <pre class="lines">
  1365.  
  1366.  
  1367. 413
  1368. 414
  1369. 415</pre>
  1370.     </td>
  1371.     <td>
  1372.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 413</span>
  1373.  
  1374. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_i?'>i?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  1375.   <span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\A[-+]?\d+\z</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
  1376. <span class='kw'>end</span></pre>
  1377.     </td>
  1378.   </tr>
  1379. </table>
  1380. </div>
  1381.     
  1382.       <div class="method_details ">
  1383.   <h3 class="signature " id="init_changelist-class_method">
  1384.   
  1385.     + (<tt>Object</tt>) <strong>init_changelist</strong>(p4, description) 
  1386.   
  1387.  
  1388.   
  1389.  
  1390.   
  1391. </h3><table class="source_code">
  1392.   <tr>
  1393.     <td>
  1394.       <pre class="lines">
  1395.  
  1396.  
  1397. 102
  1398. 103
  1399. 104
  1400. 105
  1401. 106
  1402. 107</pre>
  1403.     </td>
  1404.     <td>
  1405.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 102</span>
  1406.  
  1407. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_init_changelist'>init_changelist</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='comma'>,</span> <span class='id identifier rubyid_description'>description</span><span class='rparen'>)</span>
  1408.   <span class='id identifier rubyid_change_spec'>change_spec</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_fetch_change'>fetch_change</span>
  1409.   <span class='id identifier rubyid_change_spec'>change_spec</span><span class='period'>.</span><span class='id identifier rubyid__description'>_description</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span>
  1410.   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_save_change'>save_change</span><span class='lparen'>(</span><span class='id identifier rubyid_change_spec'>change_spec</span><span class='rparen'>)</span>
  1411.   <span class='id identifier rubyid_results'>results</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^Change (\d+) created.</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>\1</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  1412. <span class='kw'>end</span></pre>
  1413.     </td>
  1414.   </tr>
  1415. </table>
  1416. </div>
  1417.     
  1418.       <div class="method_details ">
  1419.   <h3 class="signature " id="local_path-class_method">
  1420.   
  1421.     + (<tt>Object</tt>) <strong>local_path</strong>(depot_path, root) 
  1422.   
  1423.  
  1424.   
  1425.  
  1426.   
  1427. </h3><table class="source_code">
  1428.   <tr>
  1429.     <td>
  1430.       <pre class="lines">
  1431.  
  1432.  
  1433. 128
  1434. 129
  1435. 130
  1436. 131</pre>
  1437.     </td>
  1438.     <td>
  1439.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 128</span>
  1440.  
  1441. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_local_path'>local_path</span><span class='lparen'>(</span><span class='id identifier rubyid_depot_path'>depot_path</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span>
  1442.   <span class='id identifier rubyid_stripped'>stripped</span> <span class='op'>=</span> <span class='id identifier rubyid_depot_path'>depot_path</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\/+</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  1443.   <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_root'>root</span><span class='comma'>,</span> <span class='id identifier rubyid_stripped'>stripped</span><span class='rparen'>)</span>
  1444. <span class='kw'>end</span></pre>
  1445.     </td>
  1446.   </tr>
  1447. </table>
  1448. </div>
  1449.     
  1450.       <div class="method_details ">
  1451.   <h3 class="signature " id="make_normalizer-class_method">
  1452.   
  1453.     + (<tt>Object</tt>) <strong>make_normalizer</strong>(field_map, offset, date_fields = nil) 
  1454.   
  1455.  
  1456.   
  1457.  
  1458.   
  1459. </h3><table class="source_code">
  1460.   <tr>
  1461.     <td>
  1462.       <pre class="lines">
  1463.  
  1464.  
  1465. 298
  1466. 299
  1467. 300
  1468. 301
  1469. 302
  1470. 303
  1471. 304
  1472. 305
  1473. 306
  1474. 307
  1475. 308
  1476. 309
  1477. 310
  1478. 311
  1479. 312
  1480. 313
  1481. 314
  1482. 315
  1483. 316
  1484. 317
  1485. 318
  1486. 319
  1487. 320</pre>
  1488.     </td>
  1489.     <td>
  1490.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 298</span>
  1491.  
  1492. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='id identifier rubyid_field_map'>field_map</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='id identifier rubyid_date_fields'>date_fields</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  1493.   <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_results'>results</span><span class='op'>|</span>
  1494.     <span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_results'>results</span>
  1495.  
  1496.     <span class='comment'># We need to ignore any instances of P4::Spec since that will &#39;validate&#39;
  1497. </span>    <span class='comment'># fields on it&#39;s accessor methods
  1498. </span>    <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_result'>result</span><span class='op'>|</span>
  1499.       <span class='kw'>if</span> <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>&lt;=</span> <span class='const'>P4</span><span class='op'>::</span><span class='const'>Spec</span>
  1500.         <span class='id identifier rubyid_spec'>spec</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
  1501.         <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
  1502.         <span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='id identifier rubyid_spec'>spec</span><span class='rparen'>)</span>
  1503.       <span class='kw'>else</span>
  1504.         <span class='id identifier rubyid_result'>result</span>
  1505.       <span class='kw'>end</span>
  1506.     <span class='kw'>end</span>
  1507.  
  1508.     <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_result'>result</span><span class='op'>|</span>
  1509.       <span class='id identifier rubyid_update_fields'>update_fields</span><span class='lparen'>(</span><span class='id identifier rubyid_field_map'>field_map</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
  1510.       <span class='id identifier rubyid_update_dates'>update_dates</span><span class='lparen'>(</span><span class='id identifier rubyid_date_fields'>date_fields</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  1511.     <span class='kw'>end</span>
  1512.     <span class='id identifier rubyid_results'>results</span>
  1513.   <span class='kw'>end</span>
  1514. <span class='kw'>end</span></pre>
  1515.     </td>
  1516.   </tr>
  1517. </table>
  1518. </div>
  1519.     
  1520.       <div class="method_details ">
  1521.   <h3 class="signature " id="map_describe_file_key-class_method">
  1522.   
  1523.     + (<tt>Object</tt>) <strong>map_describe_file_key</strong>(key) 
  1524.   
  1525.  
  1526.   
  1527.  
  1528.   
  1529. </h3><table class="source_code">
  1530.   <tr>
  1531.     <td>
  1532.       <pre class="lines">
  1533.  
  1534.  
  1535. 395
  1536. 396
  1537. 397
  1538. 398
  1539. 399
  1540. 400
  1541. 401
  1542. 402
  1543. 403
  1544. 404
  1545. 405
  1546. 406
  1547. 407
  1548. 408
  1549. 409
  1550. 410</pre>
  1551.     </td>
  1552.     <td>
  1553.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 395</span>
  1554.  
  1555. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_map_describe_file_key'>map_describe_file_key</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
  1556.   <span class='kw'>case</span> <span class='id identifier rubyid_key'>key</span>
  1557.   <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^depotFile$</span><span class='regexp_end'>/</span></span>
  1558.     <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>DepotFile</span><span class='tstring_end'>&#39;</span></span>
  1559.   <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^action$</span><span class='regexp_end'>/</span></span>
  1560.     <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Action</span><span class='tstring_end'>&#39;</span></span>
  1561.   <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^type$</span><span class='regexp_end'>/</span></span>
  1562.     <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Type</span><span class='tstring_end'>&#39;</span></span>
  1563.   <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^rev$</span><span class='regexp_end'>/</span></span>
  1564.     <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Revision</span><span class='tstring_end'>&#39;</span></span>
  1565.   <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^fileSize$</span><span class='regexp_end'>/</span></span>
  1566.     <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>FileSize</span><span class='tstring_end'>&#39;</span></span>
  1567.   <span class='kw'>when</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^digest$</span><span class='regexp_end'>/</span></span>
  1568.     <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Digest</span><span class='tstring_end'>&#39;</span></span>
  1569.   <span class='kw'>end</span>
  1570. <span class='kw'>end</span></pre>
  1571.     </td>
  1572.   </tr>
  1573. </table>
  1574. </div>
  1575.     
  1576.       <div class="method_details ">
  1577.   <h3 class="signature " id="mark_change-class_method">
  1578.   
  1579.     + (<tt>Object</tt>) <strong>mark_change</strong>(type, p4, change_id, root, depot_path) 
  1580.   
  1581.  
  1582.   
  1583.  
  1584.   
  1585. </h3><table class="source_code">
  1586.   <tr>
  1587.     <td>
  1588.       <pre class="lines">
  1589.  
  1590.  
  1591. 123
  1592. 124
  1593. 125
  1594. 126</pre>
  1595.     </td>
  1596.     <td>
  1597.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 123</span>
  1598.  
  1599. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_mark_change'>mark_change</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_p4'>p4</span><span class='comma'>,</span> <span class='id identifier rubyid_change_id'>change_id</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_path'>depot_path</span><span class='rparen'>)</span>
  1600.   <span class='id identifier rubyid_local_file'>local_file</span> <span class='op'>=</span> <span class='id identifier rubyid_local_path'>local_path</span><span class='lparen'>(</span><span class='id identifier rubyid_depot_path'>depot_path</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span>
  1601.   <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-c</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_change_id'>change_id</span><span class='comma'>,</span> <span class='id identifier rubyid_local_file'>local_file</span><span class='rparen'>)</span>
  1602. <span class='kw'>end</span></pre>
  1603.     </td>
  1604.   </tr>
  1605. </table>
  1606. </div>
  1607.     
  1608.       <div class="method_details ">
  1609.   <h3 class="signature " id="normalize_describe_files-class_method">
  1610.   
  1611.     + (<tt>Object</tt>) <strong>normalize_describe_files</strong>(results) 
  1612.   
  1613.  
  1614.   
  1615.  
  1616.   
  1617. </h3><div class="docstring">
  1618.   <div class="discussion">
  1619.     
  1620. <p>Each file entry in the base describe tagged output contains several fields,
  1621. suffixed with an index value.</p>
  1622.  
  1623. <p>P4 Ruby returns the individual &#39;index fields&#39; already collated by
  1624. the key type.</p>
  1625.  
  1626.  
  1627.   </div>
  1628. </div>
  1629. <div class="tags">
  1630.   
  1631.  
  1632. </div><table class="source_code">
  1633.   <tr>
  1634.     <td>
  1635.       <pre class="lines">
  1636.  
  1637.  
  1638. 373
  1639. 374
  1640. 375
  1641. 376
  1642. 377
  1643. 378
  1644. 379
  1645. 380
  1646. 381
  1647. 382
  1648. 383
  1649. 384
  1650. 385
  1651. 386
  1652. 387
  1653. 388
  1654. 389
  1655. 390
  1656. 391
  1657. 392
  1658. 393</pre>
  1659.     </td>
  1660.     <td>
  1661.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 373</span>
  1662.  
  1663. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_normalize_describe_files'>normalize_describe_files</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  1664.   <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span>
  1665.     <span class='comment'># We have to collect each index we discover as we iterate over the keys
  1666. </span>    <span class='id identifier rubyid_idx_2_file'>idx_2_file</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
  1667.  
  1668.     <span class='const'>FILE_KEYS</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
  1669.       <span class='kw'>if</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
  1670.         <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each_index'>each_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_idx'>idx</span><span class='op'>|</span>
  1671.           <span class='id identifier rubyid_mapped_key'>mapped_key</span> <span class='op'>=</span> <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_map_describe_file_key'>map_describe_file_key</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
  1672.  
  1673.           <span class='id identifier rubyid_idx_2_file'>idx_2_file</span><span class='lbracket'>[</span><span class='id identifier rubyid_idx'>idx</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span> <span class='kw'>unless</span> <span class='id identifier rubyid_idx_2_file'>idx_2_file</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='id identifier rubyid_idx'>idx</span><span class='rparen'>)</span>
  1674.           <span class='id identifier rubyid_idx_2_file'>idx_2_file</span><span class='lbracket'>[</span><span class='id identifier rubyid_idx'>idx</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_mapped_key'>mapped_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='id identifier rubyid_idx'>idx</span><span class='rbracket'>]</span>
  1675.         <span class='kw'>end</span>
  1676.         <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
  1677.       <span class='kw'>end</span>
  1678.     <span class='kw'>end</span>
  1679.  
  1680.     <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Files</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_idx_2_file'>idx_2_file</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span>
  1681.   <span class='kw'>end</span>
  1682.   <span class='id identifier rubyid_results'>results</span>
  1683. <span class='kw'>end</span></pre>
  1684.     </td>
  1685.   </tr>
  1686. </table>
  1687. </div>
  1688.     
  1689.       <div class="method_details ">
  1690.   <h3 class="signature " id="normalizer-class_method">
  1691.   
  1692.     + (<tt>Object</tt>) <strong>normalizer</strong>(spec_type, offset) 
  1693.   
  1694.  
  1695.   
  1696.  
  1697.   
  1698. </h3><div class="docstring">
  1699.   <div class="discussion">
  1700.     
  1701. <p>For each &#39;spec type&#39; returns a function that will ensure that: -
  1702. case is consistent between different return calls, prefer &#39;spec&#39;
  1703. types - dates are returned</p>
  1704.  
  1705. <p>Parameters: - spec_type is the &#39;plural&#39; form of spec class, e.g.,
  1706. &#39;users&#39;, &#39;clients&#39; - offset is the current server offset,
  1707. retrieve this via &#39;p4 info&#39; command</p>
  1708.  
  1709. <p>rubocop:disable Metrics/CyclomaticComplexity</p>
  1710.  
  1711.  
  1712.   </div>
  1713. </div>
  1714. <div class="tags">
  1715.   
  1716.  
  1717. </div><table class="source_code">
  1718.   <tr>
  1719.     <td>
  1720.       <pre class="lines">
  1721.  
  1722.  
  1723. 255
  1724. 256
  1725. 257
  1726. 258
  1727. 259
  1728. 260
  1729. 261
  1730. 262
  1731. 263
  1732. 264
  1733. 265
  1734. 266
  1735. 267
  1736. 268
  1737. 269
  1738. 270
  1739. 271
  1740. 272
  1741. 273
  1742. 274
  1743. 275
  1744. 276
  1745. 277
  1746. 278
  1747. 279
  1748. 280
  1749. 281
  1750. 282
  1751. 283
  1752. 284
  1753. 285
  1754. 286
  1755. 287
  1756. 288
  1757. 289
  1758. 290
  1759. 291
  1760. 292
  1761. 293
  1762. 294
  1763. 295
  1764. 296</pre>
  1765.     </td>
  1766.     <td>
  1767.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 255</span>
  1768.  
  1769. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_normalizer'>normalizer</span><span class='lparen'>(</span><span class='id identifier rubyid_spec_type'>spec_type</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  1770.   <span class='kw'>case</span> <span class='id identifier rubyid_spec_type'>spec_type</span>
  1771.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>branches</span><span class='tstring_end'>&#39;</span></span>
  1772.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>BRANCHES_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>BRANCHES_DATES</span><span class='rparen'>)</span>
  1773.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>changes</span><span class='tstring_end'>&#39;</span></span>
  1774.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>CHANGES_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>CHANGES_DATES</span><span class='rparen'>)</span>
  1775.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>clients</span><span class='tstring_end'>&#39;</span></span>
  1776.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>CLIENTS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>CLIENTS_DATES</span><span class='rparen'>)</span>
  1777.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depots</span><span class='tstring_end'>&#39;</span></span>
  1778.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>DEPOTS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>DEPOTS_DATES</span><span class='rparen'>)</span>
  1779.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>describe</span><span class='tstring_end'>&#39;</span></span>
  1780.     <span class='comment'># This only affects &#39;base&#39; fields, not fields related to each file
  1781. </span>    <span class='id identifier rubyid_base_normalize'>base_normalize</span> <span class='op'>=</span> <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>DESCRIBE_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>DESCRIBE_DATES</span><span class='rparen'>)</span>
  1782.     <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_results'>results</span><span class='op'>|</span>
  1783.       <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_base_normalize'>base_normalize</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  1784.       <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_normalize_describe_files'>normalize_describe_files</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  1785.       <span class='id identifier rubyid_results'>results</span>
  1786.     <span class='kw'>end</span>
  1787.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>dirs</span><span class='tstring_end'>&#39;</span></span>
  1788.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>DIRS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  1789.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>files</span><span class='tstring_end'>&#39;</span></span>
  1790.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>FILES_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>FILES_DATES</span><span class='rparen'>)</span>
  1791.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>groups</span><span class='tstring_end'>&#39;</span></span>
  1792.     <span class='id identifier rubyid_date_and_case'>date_and_case</span> <span class='op'>=</span> <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>GROUPS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  1793.     <span class='id identifier rubyid_lambda'>lambda</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_results'>results</span><span class='op'>|</span>
  1794.       <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='id identifier rubyid_date_and_case'>date_and_case</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  1795.       <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_replace_unset_with_0'>replace_unset_with_0</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  1796.       <span class='id identifier rubyid_results'>results</span>
  1797.     <span class='kw'>end</span>
  1798.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>jobs</span><span class='tstring_end'>&#39;</span></span>
  1799.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>JOBS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>JOBS_DATES</span><span class='rparen'>)</span>
  1800.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>labels</span><span class='tstring_end'>&#39;</span></span>
  1801.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>LABELS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>LABELS_DATES</span><span class='rparen'>)</span>
  1802.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>streams</span><span class='tstring_end'>&#39;</span></span>
  1803.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>STREAMS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>STREAMS_DATES</span><span class='rparen'>)</span>
  1804.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>users</span><span class='tstring_end'>&#39;</span></span>
  1805.     <span class='id identifier rubyid_make_normalizer'>make_normalizer</span><span class='lparen'>(</span><span class='const'>USERS_MAP</span><span class='comma'>,</span> <span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='const'>USERS_DATES</span><span class='rparen'>)</span>
  1806.   <span class='kw'>else</span>
  1807.     <span class='comment'># By default, do no translation
  1808. </span>    <span class='kw'>return</span> <span class='tlambda'>-&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span> <span class='tlambeg'>{</span> <span class='id identifier rubyid_x'>x</span> <span class='rbrace'>}</span>
  1809.   <span class='kw'>end</span>
  1810. <span class='kw'>end</span></pre>
  1811.     </td>
  1812.   </tr>
  1813. </table>
  1814. </div>
  1815.     
  1816.       <div class="method_details ">
  1817.   <h3 class="signature " id="open-class_method">
  1818.   
  1819.     + (<tt>Object</tt>) <strong>open</strong>(options = {}) 
  1820.   
  1821.  
  1822.   
  1823.  
  1824.   
  1825. </h3><div class="docstring">
  1826.   <div class="discussion">
  1827.     
  1828. <p>Creates your p4 connection using some common forms.</p>
  1829.  
  1830. <p>If you call open with a block, this will call connect before your block
  1831. executes, and disconnect afterwards.</p>
  1832.  
  1833. <p>If you do not call open with a block, it is up to the caller to connect and
  1834. disconnect. (It&#39;s assumed you are calling w/o a block because you want
  1835. to manage when the connection actually needs to happen.)</p>
  1836.  
  1837.  
  1838.   </div>
  1839. </div>
  1840. <div class="tags">
  1841.   
  1842.  
  1843. </div><table class="source_code">
  1844.   <tr>
  1845.     <td>
  1846.       <pre class="lines">
  1847.  
  1848.  
  1849. 34
  1850. 35
  1851. 36
  1852. 37
  1853. 38
  1854. 39
  1855. 40
  1856. 41
  1857. 42
  1858. 43
  1859. 44
  1860. 45
  1861. 46
  1862. 47
  1863. 48
  1864. 49
  1865. 50
  1866. 51
  1867. 52</pre>
  1868.     </td>
  1869.     <td>
  1870.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 34</span>
  1871.  
  1872. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
  1873.   <span class='id identifier rubyid_p4'>p4</span> <span class='op'>=</span> <span class='id identifier rubyid_create_p4'>create_p4</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
  1874.  
  1875.   <span class='comment'># Again, if we&#39;re calling using the block, we&#39;ll connect and disconnect.
  1876. </span>  <span class='comment'># Otherwise, just return the created p4 object.
  1877. </span>  <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
  1878.     <span class='kw'>begin</span>
  1879.       <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_connect'>connect</span>
  1880.       <span class='kw'>yield</span> <span class='id identifier rubyid_p4'>p4</span>
  1881.     <span class='kw'>rescue</span> <span class='const'>P4Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_ex'>ex</span>
  1882.       <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Util.open ex </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ex'>ex</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  1883.       <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_make_p4_error'>make_p4_error</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='rparen'>)</span>
  1884.     <span class='kw'>end</span>
  1885.   <span class='kw'>else</span>
  1886.     <span class='kw'>return</span> <span class='id identifier rubyid_p4'>p4</span>
  1887.   <span class='kw'>end</span>
  1888. <span class='kw'>ensure</span>
  1889.   <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_block_given?'>block_given?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_p4'>p4</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_connected?'>connected?</span>
  1890. <span class='kw'>end</span></pre>
  1891.     </td>
  1892.   </tr>
  1893. </table>
  1894. </div>
  1895.     
  1896.       <div class="method_details ">
  1897.   <h3 class="signature " id="p4_date_offset-class_method">
  1898.   
  1899.     + (<tt>Object</tt>) <strong>p4_date_offset</strong>(str) 
  1900.   
  1901.  
  1902.   
  1903.  
  1904.   
  1905. </h3><table class="source_code">
  1906.   <tr>
  1907.     <td>
  1908.       <pre class="lines">
  1909.  
  1910.  
  1911. 428
  1912. 429
  1913. 430</pre>
  1914.     </td>
  1915.     <td>
  1916.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 428</span>
  1917.  
  1918. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_p4_date_offset'>p4_date_offset</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  1919.   <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_zone'>zone</span>
  1920. <span class='kw'>end</span></pre>
  1921.     </td>
  1922.   </tr>
  1923. </table>
  1924. </div>
  1925.     
  1926.       <div class="method_details ">
  1927.   <h3 class="signature " id="p4_date_to_i-class_method">
  1928.   
  1929.     + (<tt>Object</tt>) <strong>p4_date_to_i</strong>(offset, p4date) 
  1930.   
  1931.  
  1932.   
  1933.  
  1934.   
  1935. </h3><div class="docstring">
  1936.   <div class="discussion">
  1937.     
  1938. <p>In general we get dates without any offset information, which has to be
  1939. retrieved via the serverDate field from &#39;p4 info&#39;</p>
  1940.  
  1941.  
  1942.   </div>
  1943. </div>
  1944. <div class="tags">
  1945.   
  1946.  
  1947. </div><table class="source_code">
  1948.   <tr>
  1949.     <td>
  1950.       <pre class="lines">
  1951.  
  1952.  
  1953. 424
  1954. 425
  1955. 426</pre>
  1956.     </td>
  1957.     <td>
  1958.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 424</span>
  1959.  
  1960. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_p4_date_to_i'>p4_date_to_i</span><span class='lparen'>(</span><span class='id identifier rubyid_offset'>offset</span><span class='comma'>,</span> <span class='id identifier rubyid_p4date'>p4date</span><span class='rparen'>)</span>
  1961.   <span class='const'>DateTime</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_p4date'>p4date</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_offset'>offset</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_time'>to_time</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
  1962. <span class='kw'>end</span></pre>
  1963.     </td>
  1964.   </tr>
  1965. </table>
  1966. </div>
  1967.     
  1968.       <div class="method_details ">
  1969.   <h3 class="signature " id="p4_ticket?-class_method">
  1970.   
  1971.     + (<tt>Boolean</tt>) <strong>p4_ticket?</strong>(str) 
  1972.   
  1973.  
  1974.   
  1975.  
  1976.   
  1977. </h3><div class="docstring">
  1978.   <div class="discussion">
  1979.     
  1980. <p>Returns true if the string looks like a Perforce authentication ticket.</p>
  1981.  
  1982.  
  1983.   </div>
  1984. </div>
  1985. <div class="tags">
  1986.   
  1987. <p class="tag_title">Returns:</p>
  1988. <ul class="return">
  1989.   
  1990.     <li>
  1991.       
  1992.       
  1993.         <span class='type'>(<tt>Boolean</tt>)</span>
  1994.       
  1995.       
  1996.       
  1997.     </li>
  1998.   
  1999. </ul>
  2000.  
  2001. </div><table class="source_code">
  2002.   <tr>
  2003.     <td>
  2004.       <pre class="lines">
  2005.  
  2006.  
  2007. 91
  2008. 92
  2009. 93</pre>
  2010.     </td>
  2011.     <td>
  2012.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 91</span>
  2013.  
  2014. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_p4_ticket?'>p4_ticket?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  2015.   <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[a-zA-Z0-9]{32,}$</span><span class='regexp_end'>/</span></span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='kw'>nil</span>
  2016. <span class='kw'>end</span></pre>
  2017.     </td>
  2018.   </tr>
  2019. </table>
  2020. </div>
  2021.     
  2022.       <div class="method_details ">
  2023.   <h3 class="signature " id="raise_error-class_method">
  2024.   
  2025.     + (<tt>Object</tt>) <strong>raise_error</strong>(p4) 
  2026.   
  2027.  
  2028.   
  2029.  
  2030.   
  2031. </h3><div class="docstring">
  2032.   <div class="discussion">
  2033.     
  2034. <p>Raise an exception if necessary on a P4 Error</p>
  2035.  
  2036.  
  2037.   </div>
  2038. </div>
  2039. <div class="tags">
  2040.   
  2041.  
  2042. </div><table class="source_code">
  2043.   <tr>
  2044.     <td>
  2045.       <pre class="lines">
  2046.  
  2047.  
  2048. 60
  2049. 61
  2050. 62
  2051. 63</pre>
  2052.     </td>
  2053.     <td>
  2054.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 60</span>
  2055.  
  2056. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='rparen'>)</span>
  2057.   <span class='id identifier rubyid_err'>err</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_messages'>messages</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_m'>m</span><span class='op'>|</span> <span class='id identifier rubyid_m'>m</span><span class='period'>.</span><span class='id identifier rubyid_severity'>severity</span> <span class='op'>&gt;</span> <span class='int'>2</span> <span class='rbrace'>}</span>
  2058.   <span class='id identifier rubyid_fail'>fail</span> <span class='const'>Perforce</span><span class='op'>::</span><span class='const'>P4Error</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_msgid'>msgid</span><span class='comma'>,</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_severity'>severity</span><span class='comma'>,</span> <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
  2059. <span class='kw'>end</span></pre>
  2060.     </td>
  2061.   </tr>
  2062. </table>
  2063. </div>
  2064.     
  2065.       <div class="method_details ">
  2066.   <h3 class="signature " id="relative_dir?-class_method">
  2067.   
  2068.     + (<tt>Boolean</tt>) <strong>relative_dir?</strong>(str) 
  2069.   
  2070.  
  2071.   
  2072.  
  2073.   
  2074. </h3><div class="docstring">
  2075.   <div class="discussion">
  2076.     
  2077. <p>Returns true if str is &#39;.&#39; or &#39;..&#39;</p>
  2078.  
  2079.  
  2080.   </div>
  2081. </div>
  2082. <div class="tags">
  2083.   
  2084. <p class="tag_title">Returns:</p>
  2085. <ul class="return">
  2086.   
  2087.     <li>
  2088.       
  2089.       
  2090.         <span class='type'>(<tt>Boolean</tt>)</span>
  2091.       
  2092.       
  2093.       
  2094.     </li>
  2095.   
  2096. </ul>
  2097.  
  2098. </div><table class="source_code">
  2099.   <tr>
  2100.     <td>
  2101.       <pre class="lines">
  2102.  
  2103.  
  2104. 86
  2105. 87
  2106. 88</pre>
  2107.     </td>
  2108.     <td>
  2109.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 86</span>
  2110.  
  2111. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_relative_dir?'>relative_dir?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  2112.   <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.</span><span class='tstring_end'>&#39;</span></span> <span class='op'>||</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>..</span><span class='tstring_end'>&#39;</span></span>
  2113. <span class='kw'>end</span></pre>
  2114.     </td>
  2115.   </tr>
  2116. </table>
  2117. </div>
  2118.     
  2119.       <div class="method_details ">
  2120.   <h3 class="signature " id="replace_unset_with_0-class_method">
  2121.   
  2122.     + (<tt>Object</tt>) <strong>replace_unset_with_0</strong>(results) 
  2123.   
  2124.  
  2125.   
  2126.  
  2127.   
  2128. </h3><table class="source_code">
  2129.   <tr>
  2130.     <td>
  2131.       <pre class="lines">
  2132.  
  2133.  
  2134. 360
  2135. 361
  2136. 362
  2137. 363
  2138. 364</pre>
  2139.     </td>
  2140.     <td>
  2141.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 360</span>
  2142.  
  2143. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_replace_unset_with_0'>replace_unset_with_0</span><span class='lparen'>(</span><span class='id identifier rubyid_results'>results</span><span class='rparen'>)</span>
  2144.   <span class='id identifier rubyid_results'>results</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span>
  2145.     <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_each_key'>each_key</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_k'>k</span><span class='op'>|</span> <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_r'>r</span><span class='lbracket'>[</span><span class='id identifier rubyid_k'>k</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>unset</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
  2146.   <span class='kw'>end</span>
  2147. <span class='kw'>end</span></pre>
  2148.     </td>
  2149.   </tr>
  2150. </table>
  2151. </div>
  2152.     
  2153.       <div class="method_details ">
  2154.   <h3 class="signature " id="resolve_charset-class_method">
  2155.   
  2156.     + (<tt>Object</tt>) <strong>resolve_charset</strong>(env, settings) 
  2157.   
  2158.  
  2159.   
  2160.  
  2161.   
  2162. </h3><table class="source_code">
  2163.   <tr>
  2164.     <td>
  2165.       <pre class="lines">
  2166.  
  2167.  
  2168. 448
  2169. 449
  2170. 450
  2171. 451
  2172. 452
  2173. 453
  2174. 454</pre>
  2175.     </td>
  2176.     <td>
  2177.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 448</span>
  2178.  
  2179. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_resolve_charset'>resolve_charset</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
  2180.   <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_CHARSET</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_allow_env_p4_config'>allow_env_p4_config</span>
  2181.     <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_CHARSET</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  2182.   <span class='kw'>else</span>
  2183.     <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_p4'>p4</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>charset</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_p4'>p4</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'>charset</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  2184.   <span class='kw'>end</span>
  2185. <span class='kw'>end</span></pre>
  2186.     </td>
  2187.   </tr>
  2188. </table>
  2189. </div>
  2190.     
  2191.       <div class="method_details ">
  2192.   <h3 class="signature " id="resolve_host-class_method">
  2193.   
  2194.     + (<tt>Object</tt>) <strong>resolve_host</strong>(env, settings) 
  2195.   
  2196.  
  2197.   
  2198.  
  2199.   
  2200. </h3><table class="source_code">
  2201.   <tr>
  2202.     <td>
  2203.       <pre class="lines">
  2204.  
  2205.  
  2206. 432
  2207. 433
  2208. 434
  2209. 435
  2210. 436
  2211. 437
  2212. 438</pre>
  2213.     </td>
  2214.     <td>
  2215.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 432</span>
  2216.  
  2217. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_resolve_host'>resolve_host</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
  2218.   <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_HOST</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_allow_env_p4_config'>allow_env_p4_config</span>
  2219.     <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_HOST</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  2220.   <span class='kw'>else</span>
  2221.     <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_p4'>p4</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>host</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  2222.   <span class='kw'>end</span>
  2223. <span class='kw'>end</span></pre>
  2224.     </td>
  2225.   </tr>
  2226. </table>
  2227. </div>
  2228.     
  2229.       <div class="method_details ">
  2230.   <h3 class="signature " id="resolve_password-class_method">
  2231.   
  2232.     + (<tt>Object</tt>) <strong>resolve_password</strong>(env, settings) 
  2233.   
  2234.  
  2235.   
  2236.  
  2237.   
  2238. </h3><table class="source_code">
  2239.   <tr>
  2240.     <td>
  2241.       <pre class="lines">
  2242.  
  2243.  
  2244. 456
  2245. 457
  2246. 458
  2247. 459
  2248. 460
  2249. 461
  2250. 462
  2251. 463</pre>
  2252.     </td>
  2253.     <td>
  2254.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 456</span>
  2255.  
  2256. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_resolve_password'>resolve_password</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
  2257.   <span class='id identifier rubyid_password'>password</span> <span class='op'>=</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'>AUTH_CREDENTIALS</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span>
  2258.   <span class='kw'>if</span> <span class='op'>!</span><span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_uuid?'>uuid?</span><span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span><span class='rparen'>)</span>
  2259.     <span class='id identifier rubyid_password'>password</span>
  2260.   <span class='kw'>else</span>
  2261.     <span class='const'>Auth</span><span class='period'>.</span><span class='id identifier rubyid_read_token'>read_token</span><span class='lparen'>(</span><span class='id identifier rubyid_password'>password</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ticket</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  2262.   <span class='kw'>end</span>
  2263. <span class='kw'>end</span></pre>
  2264.     </td>
  2265.   </tr>
  2266. </table>
  2267. </div>
  2268.     
  2269.       <div class="method_details ">
  2270.   <h3 class="signature " id="resolve_port-class_method">
  2271.   
  2272.     + (<tt>Object</tt>) <strong>resolve_port</strong>(env, settings) 
  2273.   
  2274.  
  2275.   
  2276.  
  2277.   
  2278. </h3><table class="source_code">
  2279.   <tr>
  2280.     <td>
  2281.       <pre class="lines">
  2282.  
  2283.  
  2284. 440
  2285. 441
  2286. 442
  2287. 443
  2288. 444
  2289. 445
  2290. 446</pre>
  2291.     </td>
  2292.     <td>
  2293.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 440</span>
  2294.  
  2295. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_resolve_port'>resolve_port</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_settings'>settings</span><span class='rparen'>)</span>
  2296.   <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_PORT</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_allow_env_p4_config'>allow_env_p4_config</span>
  2297.     <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_PORT</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  2298.   <span class='kw'>else</span>
  2299.     <span class='id identifier rubyid_settings'>settings</span><span class='period'>.</span><span class='id identifier rubyid_p4'>p4</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>port</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
  2300.   <span class='kw'>end</span>
  2301. <span class='kw'>end</span></pre>
  2302.     </td>
  2303.   </tr>
  2304. </table>
  2305. </div>
  2306.     
  2307.       <div class="method_details ">
  2308.   <h3 class="signature " id="save_content-class_method">
  2309.   
  2310.     + (<tt>Object</tt>) <strong>save_content</strong>(root, depot_path, content) 
  2311.   
  2312.  
  2313.   
  2314.  
  2315.   
  2316. </h3><table class="source_code">
  2317.   <tr>
  2318.     <td>
  2319.       <pre class="lines">
  2320.  
  2321.  
  2322. 109
  2323. 110
  2324. 111
  2325. 112
  2326. 113
  2327. 114
  2328. 115</pre>
  2329.     </td>
  2330.     <td>
  2331.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 109</span>
  2332.  
  2333. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_save_content'>save_content</span><span class='lparen'>(</span><span class='id identifier rubyid_root'>root</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_path'>depot_path</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  2334.   <span class='id identifier rubyid_local_file'>local_file</span> <span class='op'>=</span> <span class='id identifier rubyid_local_path'>local_path</span><span class='lparen'>(</span><span class='id identifier rubyid_depot_path'>depot_path</span><span class='comma'>,</span> <span class='id identifier rubyid_root'>root</span><span class='rparen'>)</span>
  2335.   <span class='id identifier rubyid_dir'>dir</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='id identifier rubyid_local_file'>local_file</span><span class='rparen'>)</span>
  2336.   <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_mkpath'>mkpath</span><span class='lparen'>(</span><span class='id identifier rubyid_dir'>dir</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='id identifier rubyid_dir'>dir</span><span class='rparen'>)</span>
  2337.  
  2338.   <span class='const'>IO</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span><span class='id identifier rubyid_local_file'>local_file</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  2339. <span class='kw'>end</span></pre>
  2340.     </td>
  2341.   </tr>
  2342. </table>
  2343. </div>
  2344.     
  2345.       <div class="method_details ">
  2346.   <h3 class="signature " id="singular-class_method">
  2347.   
  2348.     + (<tt>Object</tt>) <strong>singular</strong>(plural) 
  2349.   
  2350.  
  2351.   
  2352.  
  2353.   
  2354. </h3><table class="source_code">
  2355.   <tr>
  2356.     <td>
  2357.       <pre class="lines">
  2358.  
  2359.  
  2360. 133
  2361. 134
  2362. 135
  2363. 136
  2364. 137
  2365. 138
  2366. 139
  2367. 140
  2368. 141
  2369. 142
  2370. 143
  2371. 144
  2372. 145
  2373. 146
  2374. 147
  2375. 148</pre>
  2376.     </td>
  2377.     <td>
  2378.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 133</span>
  2379.  
  2380. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_singular'>singular</span><span class='lparen'>(</span><span class='id identifier rubyid_plural'>plural</span><span class='rparen'>)</span>
  2381.   <span class='id identifier rubyid_matches'>matches</span> <span class='op'>=</span> <span class='lbrace'>{</span>
  2382.     <span class='label'>branches:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>branch</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2383.     <span class='label'>clients:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>client</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2384.     <span class='label'>depots:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>depot</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2385.     <span class='label'>groups:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>group</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2386.     <span class='label'>jobs:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>job</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2387.     <span class='label'>labels:</span>  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>label</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2388.     <span class='label'>protects:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>protect</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2389.     <span class='label'>servers:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>server</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2390.     <span class='label'>streams:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>stream</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2391.     <span class='label'>triggers:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>trigger</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  2392.     <span class='label'>users:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>user</span><span class='tstring_end'>&#39;</span></span>
  2393.   <span class='rbrace'>}</span>
  2394.   <span class='id identifier rubyid_matches'>matches</span><span class='lbracket'>[</span><span class='id identifier rubyid_plural'>plural</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span>
  2395. <span class='kw'>end</span></pre>
  2396.     </td>
  2397.   </tr>
  2398. </table>
  2399. </div>
  2400.     
  2401.       <div class="method_details ">
  2402.   <h3 class="signature " id="uuid?-class_method">
  2403.   
  2404.     + (<tt>Boolean</tt>) <strong>uuid?</strong>(str) 
  2405.   
  2406.  
  2407.   
  2408.  
  2409.   
  2410. </h3><div class="docstring">
  2411.   <div class="discussion">
  2412.     
  2413. <p>We only count uuids that were returned via SecureRandom.uuid used to
  2414. generate internal security tokens.</p>
  2415.  
  2416.  
  2417.   </div>
  2418. </div>
  2419. <div class="tags">
  2420.   
  2421. <p class="tag_title">Returns:</p>
  2422. <ul class="return">
  2423.   
  2424.     <li>
  2425.       
  2426.       
  2427.         <span class='type'>(<tt>Boolean</tt>)</span>
  2428.       
  2429.       
  2430.       
  2431.     </li>
  2432.   
  2433. </ul>
  2434.  
  2435. </div><table class="source_code">
  2436.   <tr>
  2437.     <td>
  2438.       <pre class="lines">
  2439.  
  2440.  
  2441. 97
  2442. 98
  2443. 99
  2444. 100</pre>
  2445.     </td>
  2446.     <td>
  2447.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 97</span>
  2448.  
  2449. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_uuid?'>uuid?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  2450.   <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$</span><span class='regexp_end'>/</span></span>
  2451.     <span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  2452. <span class='kw'>end</span></pre>
  2453.     </td>
  2454.   </tr>
  2455. </table>
  2456. </div>
  2457.     
  2458.       <div class="method_details ">
  2459.   <h3 class="signature " id="wildcard?-class_method">
  2460.   
  2461.     + (<tt>Boolean</tt>) <strong>wildcard?</strong>(str) 
  2462.   
  2463.  
  2464.   
  2465.  
  2466.   
  2467. </h3><div class="docstring">
  2468.   <div class="discussion">
  2469.     
  2470. <p>Returns true when <code>str</code> contains a Perforce wildcard</p>
  2471.  
  2472.  
  2473.   </div>
  2474. </div>
  2475. <div class="tags">
  2476.   
  2477. <p class="tag_title">Returns:</p>
  2478. <ul class="return">
  2479.   
  2480.     <li>
  2481.       
  2482.       
  2483.         <span class='type'>(<tt>Boolean</tt>)</span>
  2484.       
  2485.       
  2486.       
  2487.     </li>
  2488.   
  2489. </ul>
  2490.  
  2491. </div><table class="source_code">
  2492.   <tr>
  2493.     <td>
  2494.       <pre class="lines">
  2495.  
  2496.  
  2497. 81
  2498. 82
  2499. 83</pre>
  2500.     </td>
  2501.     <td>
  2502.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/util.rb', line 81</span>
  2503.  
  2504. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_wildcard?'>wildcard?</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='rparen'>)</span>
  2505.   <span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.\.\.</span><span class='regexp_end'>/</span></span> <span class='op'>||</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\*</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span> <span class='op'>!=</span> <span class='kw'>nil</span>
  2506. <span class='kw'>end</span></pre>
  2507.     </td>
  2508.   </tr>
  2509. </table>
  2510. </div>
  2511.     
  2512.   </div>
  2513.  
  2514. </div>
  2515.  
  2516.     <div id="footer">
  2517.   Generated on Mon Oct 12 22:20:51 2015 by
  2518.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  2519.   0.8.7.6 (ruby-2.2.3).
  2520. </div>
  2521.  
  2522.   </body>
  2523. </html>
# Change User Description Committed
#11 16275 Doug Scheirer Merge from main 9 years ago
#10 16196 Doug Scheirer Merge from main 9 years ago
#9 16148 Doug Scheirer Merge from main 9 years ago
#8 16114 Doug Scheirer Merge from main 9 years ago
#7 16079 Doug Scheirer Merge from main 9 years ago
#6 16014 Doug Scheirer Merge down from main 9 years ago
#5 15884 Doug Scheirer Merge from main 9 years ago
#4 15868 Doug Scheirer Merge from main 9 years ago
#3 15845 Doug Scheirer Integ from main 9 years ago
#2 15715 Doug Scheirer merge changes from main 10 years ago
#1 15688 Doug Scheirer Populate -o //guest/perforce_software/helix-web-services/...
//guest/doug_scheirer/helix-...web-services/.... «		 10 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/HelixVersioningEngine/Util.html
#32 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205 10 years ago
#31 15589 tjuricek Update path to test output and update docs. 10 years ago
#30 15542 tjuricek Add spaces to our basic 'component encode' mechanism, and use it for HVE project IDs.

I...n general, this will make the HVE IDs a bit more readable. «		 10 years ago
#29 15517 tjuricek Do not require changelist ID for submitting Helix Sync pending changelists. 10 years ago
#28 15499 tjuricek Naive implementation of helix sync project submit for "helix versioning engine projects". 10 years ago
#27 15487 tjuricek Add basic ability to create pending changelists for helix sync projects. 10 years ago
#26 15479 tjuricek Added a basic "HVE project" implementation for creating clients. 10 years ago
#25 15447 tjuricek Add simple Example application to list "projects" in a HVE instance.

Qt's a little weir...d to follow, so I may have to find a different kind of example to write. It does work, however. «		 10 years ago
#24 15240 tjuricek Set api level via request path on all Helix Versioning Engine methods.

This will allow... migration of applications to different P4D versions. Our internal methods (like project API) should attempt to handle backward compatibility similarly.

P4WEBAPI-118 «		 10 years ago
#23 15228 tjuricek Revise triggers implementation, tests, and documentation. 10 years ago
#22 15227 tjuricek Revise implementation, tests, and documentation for protections management.

Remove some... specs I will not be revising from the helix_web_services project. «		 10 years ago
#21 15225 tjuricek Revise counter implementation, tests, and documentation

Wasn't available in the Ruby cl...ient before, so, it's now available. «		 10 years ago
#20 15222 tjuricek Revise server specs testing and documentation.

Note: also fixed issues with setting P4P...ORT via headers. For whatever reason, the host setting doesn't seem to work like I expect it to, though P4PORT works just fine. «		 10 years ago
#19 15211 tjuricek Implement tests and documentation for label spec management. 10 years ago
#18 15210 tjuricek Implement tests and documentation for job spec management. 10 years ago
#17 15209 tjuricek Implement tests and documentation for group spec management. 10 years ago
#16 15208 tjuricek Revise 'command' implementation, tests, and documentaiton.

This includes a change from... a command blacklist to a whitelist. See P4WEBAPI-21 «		 10 years ago
#15 15205 tjuricek Implemented tests and documentation for depot spec editing. 10 years ago
#14 15189 tjuricek Update files implementation, testing, and documentation. 10 years ago
#13 15185 tjuricek Update user spec management implementation, tests, and documentation. 10 years ago
#12 15144 tjuricek Setup stream spec tests and documentation.

Also revised the documentation folder http_p...4_web_api -> helix_versioning_engine «		 10 years ago
#11 15132 tjuricek Provde a basic submit -e mechanism on classic perforce workspaces. 10 years ago
#10 15110 tjuricek Revise changes methods for new p4 connection handling, add server specs, remove model refe...rences in client, and update asciidoc documentation. « 10 years ago
#9 15099 tjuricek Revise project services to be our simple 'container' for other systems. 10 years ago
#8 15098 tjuricek Revised project services to GET-only forms.

With Helix Sync revising to integrate purel...y with Helix Cloud, this is the only thing we can reasonably define. «		 10 years ago
#7 15090 tjuricek Update _proposed_ API for project services.

This is *very likely* to change, and will n...ot be implemented until reviewed. «		 10 years ago
#6 15078 tjuricek clients spec method revisions

Updated some other documentation. 		10 years ago
#5 15077 tjuricek Add new 'model' technique, revised branch spec operations, test Auth::Middleware.

The R...uby client now does *not* strictly type anything, but extends OpenStruct with helper methods to help deal with inconsistent data formats.
See the OpenModel class documentation for more details.

The Auth::Middleware class is also *finally* implemented as well. This does not take into account all possible variations of server behavior (yet), but that will happen in follow-up work. «		 10 years ago
#4 15073 tjuricek Update Auth::Middleware and add spec 10 years ago
#3 15053 tjuricek Revise the client API to use the new login method.

The current specs will need to be re...vised since data normalization is moving out of the server and into the client. «		 10 years ago
#2 15038 tjuricek Document 'login' auth method and client programming overview. 10 years ago
#1 15032 tjuricek Starting config and doc revisions.
System is now broken while revisions underway.

Conf...iguration of the p4d connection is now done via a single HWSSettings middleware object injected into the Rack env.

The HWSP4Cleanup middleware now cleans up any p4 injected into the Rack env.

The Auth::App class now mostly just contains one method to generate a p4 ticket. /auth/v1/login.

Added yard documentation for the main project.

Yard docs have been reconfigured to dump into build/ directories. This should probably be done with each release. Hm...

The top level rake file contains a task, 'all:doc', to update our documentation. This should probably be run for each checkin. Hm...

Specs are now using Rack::Test on top of a 'live' p4d. I'd suggest you still use the p4util mechanism, which now dumps to a /tmp folder, so we can safely add P4IGNORE rules back into your local .p4config file.

Old 'perforce' application now called 'helix_versioning_engine'.

Removing cache data. Helix Sync may be slow. It may also get axed. We'll see. «		 10 years ago