Loading...
Helix SwarmHelix Swarm
Loading...

ChangeService.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • HelixVersioningEngine/
  • ChangeService.html #1
  • View
  • Commits
  • Open Download .zip Download (16 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Class: HelixVersioningEngine::ChangeService
  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/ChangeService.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 (C)</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">ChangeService</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="../class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="../method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="../file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Class: HelixVersioningEngine::ChangeService
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.     <dt class="r1">Inherits:</dt>
  75.     <dd class="r1">
  76.       <span class="inheritName">Object</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">HelixVersioningEngine::ChangeService</li>
  82.           
  83.         </ul>
  84.         <a href="#" class="inheritanceTree">show all</a>
  85.       
  86.       </dd>
  87.     
  88.   
  89.   
  90.     
  91.   
  92.     
  93.   
  94.   
  95.   
  96.     <dt class="r2 last">Defined in:</dt>
  97.     <dd class="r2 last">lib/helix_versioning_engine/change_service.rb</dd>
  98.   
  99. </dl>
  100. <div class="clear"></div>
  101.  
  102. <h2>Overview</h2><div class="docstring">
  103.   <div class="discussion">
  104.     
  105. <p>This class assists in creating changelists based on an array of file
  106. changes, some of which may be file uploads.</p>
  107.  
  108. <p>This is the implementation for file uploads and change creation.</p>
  109.  
  110.  
  111.   </div>
  112. </div>
  113. <div class="tags">
  114.   
  115.  
  116. </div><h2>Defined Under Namespace</h2>
  117. <p class="children">
  118.   
  119.     
  120.   
  121.     
  122.       <strong class="classes">Classes:</strong> <span class='object_link'><a href="ChangeService/File.html" title="HelixVersioningEngine::ChangeService::File (class)">File</a></span>
  123.     
  124.   
  125. </p>
  126.  
  127.  
  128.  
  129.  
  130.   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  131.   <ul class="summary">
  132.     
  133.       <li class="public ">
  134.   <span class="summary_signature">
  135.     
  136.       <a href="#client_name-instance_method" title="#client_name (instance method)">- (Object) <strong>client_name</strong> </a>
  137.     
  138.  
  139.     
  140.   </span>
  141.   
  142.   
  143.   
  144.     
  145.       <span class="note title readonly">readonly</span>
  146.     
  147.     
  148.   
  149.   
  150.   
  151.   
  152.   
  153.  
  154.   
  155.     <span class="summary_desc"><div class='inline'>
  156. <p>The name of the temporary client.</p>
  157. </div></span>
  158.   
  159. </li>
  160.  
  161.     
  162.       <li class="public ">
  163.   <span class="summary_signature">
  164.     
  165.       <a href="#client_root-instance_method" title="#client_root (instance method)">- (Object) <strong>client_root</strong> </a>
  166.     
  167.  
  168.     
  169.   </span>
  170.   
  171.   
  172.   
  173.     
  174.       <span class="note title readonly">readonly</span>
  175.     
  176.     
  177.   
  178.   
  179.   
  180.   
  181.   
  182.  
  183.   
  184.     <span class="summary_desc"><div class='inline'>
  185. <p>The root directory of the temporary client.</p>
  186. </div></span>
  187.   
  188. </li>
  189.  
  190.     
  191.       <li class="public ">
  192.   <span class="summary_signature">
  193.     
  194.       <a href="#p4-instance_method" title="#p4 (instance method)">- (Object) <strong>p4</strong> </a>
  195.     
  196.  
  197.     
  198.   </span>
  199.   
  200.   
  201.   
  202.     
  203.       <span class="note title readonly">readonly</span>
  204.     
  205.     
  206.   
  207.   
  208.   
  209.   
  210.   
  211.  
  212.   
  213.     <span class="summary_desc"><div class='inline'>
  214. <p>The P4 connection we&#39;re using, that should already be logged in for a
  215. particular user.</p>
  216. </div></span>
  217.   
  218. </li>
  219.  
  220.     
  221.   </ul>
  222.  
  223.  
  224.  
  225.  
  226.   
  227.     <h2>
  228.       Instance Method Summary
  229.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  230.     </h2>
  231.  
  232.     <ul class="summary">
  233.       
  234.         <li class="public ">
  235.   <span class="summary_signature">
  236.     
  237.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (ChangeService) <strong>initialize</strong>(p4: nil, client_name: nil, client_root: nil) </a>
  238.     
  239.  
  240.     
  241.   </span>
  242.   
  243.   
  244.     <span class="note title constructor">constructor</span>
  245.   
  246.   
  247.   
  248.   
  249.   
  250.   
  251.  
  252.   
  253.     <span class="summary_desc"><div class='inline'>
  254. <p>A new instance of ChangeService.</p>
  255. </div></span>
  256.   
  257. </li>
  258.  
  259.       
  260.         <li class="public ">
  261.   <span class="summary_signature">
  262.     
  263.       <a href="#submit-instance_method" title="#submit (instance method)">- (Object) <strong>submit</strong>(files: [], description: &#39;Updating files&#39;) </a>
  264.     
  265.  
  266.     
  267.   </span>
  268.   
  269.   
  270.   
  271.   
  272.   
  273.   
  274.   
  275.  
  276.   
  277.     <span class="summary_desc"><div class='inline'></div></span>
  278.   
  279. </li>
  280.  
  281.       
  282.     </ul>
  283.   
  284.  
  285. <div id="constructor_details" class="method_details_list">
  286.   <h2>Constructor Details</h2>
  287.   
  288.     <div class="method_details first">
  289.   <h3 class="signature first" id="initialize-instance_method">
  290.   
  291.     - (<tt><span class='object_link'><a href="" title="HelixVersioningEngine::ChangeService (class)">ChangeService</a></span></tt>) <strong>initialize</strong>(p4: nil, client_name: nil, client_root: nil) 
  292.   
  293.  
  294.   
  295.  
  296.   
  297. </h3><div class="docstring">
  298.   <div class="discussion">
  299.     
  300. <p>Returns a new instance of ChangeService</p>
  301.  
  302.  
  303.   </div>
  304. </div>
  305. <div class="tags">
  306.   
  307.  
  308. </div><table class="source_code">
  309.   <tr>
  310.     <td>
  311.       <pre class="lines">
  312.  
  313.  
  314. 21
  315. 22
  316. 23
  317. 24
  318. 25</pre>
  319.     </td>
  320.     <td>
  321.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 21</span>
  322.  
  323. <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>p4:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>client_name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>client_root:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  324.   <span class='ivar'>@p4</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span>
  325.   <span class='ivar'>@client_name</span> <span class='op'>=</span> <span class='id identifier rubyid_client_name'>client_name</span>
  326.   <span class='ivar'>@client_root</span> <span class='op'>=</span> <span class='id identifier rubyid_client_root'>client_root</span>
  327. <span class='kw'>end</span></pre>
  328.     </td>
  329.   </tr>
  330. </table>
  331. </div>
  332.   
  333. </div>
  334.  
  335.   <div id="instance_attr_details" class="attr_details">
  336.     <h2>Instance Attribute Details</h2>
  337.     
  338.       
  339.       <span id=""></span>
  340.       <div class="method_details first">
  341.   <h3 class="signature first" id="client_name-instance_method">
  342.   
  343.     - (<tt>Object</tt>) <strong>client_name</strong>  <span class="extras">(readonly)</span>
  344.   
  345.  
  346.   
  347.  
  348.   
  349. </h3><div class="docstring">
  350.   <div class="discussion">
  351.     
  352. <p>The name of the temporary client</p>
  353.  
  354.  
  355.   </div>
  356. </div>
  357. <div class="tags">
  358.   
  359.  
  360. </div><table class="source_code">
  361.   <tr>
  362.     <td>
  363.       <pre class="lines">
  364.  
  365.  
  366. 16
  367. 17
  368. 18</pre>
  369.     </td>
  370.     <td>
  371.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 16</span>
  372.  
  373. <span class='kw'>def</span> <span class='id identifier rubyid_client_name'>client_name</span>
  374.   <span class='ivar'>@client_name</span>
  375. <span class='kw'>end</span></pre>
  376.     </td>
  377.   </tr>
  378. </table>
  379. </div>
  380.     
  381.       
  382.       <span id=""></span>
  383.       <div class="method_details ">
  384.   <h3 class="signature " id="client_root-instance_method">
  385.   
  386.     - (<tt>Object</tt>) <strong>client_root</strong>  <span class="extras">(readonly)</span>
  387.   
  388.  
  389.   
  390.  
  391.   
  392. </h3><div class="docstring">
  393.   <div class="discussion">
  394.     
  395. <p>The root directory of the temporary client</p>
  396.  
  397.  
  398.   </div>
  399. </div>
  400. <div class="tags">
  401.   
  402.  
  403. </div><table class="source_code">
  404.   <tr>
  405.     <td>
  406.       <pre class="lines">
  407.  
  408.  
  409. 19
  410. 20
  411. 21</pre>
  412.     </td>
  413.     <td>
  414.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 19</span>
  415.  
  416. <span class='kw'>def</span> <span class='id identifier rubyid_client_root'>client_root</span>
  417.   <span class='ivar'>@client_root</span>
  418. <span class='kw'>end</span></pre>
  419.     </td>
  420.   </tr>
  421. </table>
  422. </div>
  423.     
  424.       
  425.       <span id=""></span>
  426.       <div class="method_details ">
  427.   <h3 class="signature " id="p4-instance_method">
  428.   
  429.     - (<tt>Object</tt>) <strong>p4</strong>  <span class="extras">(readonly)</span>
  430.   
  431.  
  432.   
  433.  
  434.   
  435. </h3><div class="docstring">
  436.   <div class="discussion">
  437.     
  438. <p>The P4 connection we&#39;re using, that should already be logged in for a
  439. particular user.</p>
  440.  
  441.  
  442.   </div>
  443. </div>
  444. <div class="tags">
  445.   
  446.  
  447. </div><table class="source_code">
  448.   <tr>
  449.     <td>
  450.       <pre class="lines">
  451.  
  452.  
  453. 13
  454. 14
  455. 15</pre>
  456.     </td>
  457.     <td>
  458.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 13</span>
  459.  
  460. <span class='kw'>def</span> <span class='id identifier rubyid_p4'>p4</span>
  461.   <span class='ivar'>@p4</span>
  462. <span class='kw'>end</span></pre>
  463.     </td>
  464.   </tr>
  465. </table>
  466. </div>
  467.     
  468.   </div>
  469.  
  470.  
  471.   <div id="instance_method_details" class="method_details_list">
  472.     <h2>Instance Method Details</h2>
  473.  
  474.     
  475.       <div class="method_details first">
  476.   <h3 class="signature first" id="submit-instance_method">
  477.   
  478.     - (<tt>Object</tt>) <strong>submit</strong>(files: [], description: &#39;Updating files&#39;) 
  479.   
  480.  
  481.   
  482.  
  483.   
  484. </h3><table class="source_code">
  485.   <tr>
  486.     <td>
  487.       <pre class="lines">
  488.  
  489.  
  490. 27
  491. 28
  492. 29
  493. 30
  494. 31
  495. 32
  496. 33
  497. 34
  498. 35
  499. 36
  500. 37
  501. 38
  502. 39
  503. 40
  504. 41
  505. 42
  506. 43
  507. 44
  508. 45
  509. 46
  510. 47
  511. 48
  512. 49</pre>
  513.     </td>
  514.     <td>
  515.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 27</span>
  516.  
  517. <span class='kw'>def</span> <span class='id identifier rubyid_submit'>submit</span><span class='lparen'>(</span><span class='label'>files:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Updating files</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  518.   <span class='id identifier rubyid_change_id'>change_id</span> <span class='op'>=</span> <span class='const'>Util</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>
  519.  
  520.   <span class='kw'>begin</span>
  521.     <span class='id identifier rubyid_files'>files</span> <span class='op'>=</span> <span class='id identifier rubyid_files'>files</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_f'>f</span><span class='op'>|</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>ChangeService</span><span class='op'>::</span><span class='const'>File</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_f'>f</span> <span class='op'>:</span> <span class='const'>ChangeService</span><span class='op'>::</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  522.  
  523.     <span class='id identifier rubyid_collect_file_results'>collect_file_results</span><span class='lparen'>(</span><span class='id identifier rubyid_files'>files</span><span class='rparen'>)</span>
  524.  
  525.     <span class='id identifier rubyid_files'>files</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_f'>f</span><span class='op'>|</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</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_client_root'>client_root</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  526.  
  527.     <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_submit'>run_submit</span><span class='lparen'>(</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='rparen'>)</span>
  528.  
  529.   <span class='kw'>rescue</span> <span class='const'>StandardError</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_ex'>ex</span>
  530.     <span class='comment'># Delete the changelist
  531. </span>    <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_at_exception_level'>at_exception_level</span><span class='lparen'>(</span><span class='const'>P4</span><span class='op'>::</span><span class='const'>RAISE_NONE</span><span class='rparen'>)</span> <span class='kw'>do</span>
  532.       <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_change'>run_change</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-d</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>-f</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_change_id'>change_id</span><span class='rparen'>)</span>
  533.       <span class='kw'>if</span> <span class='const'>Util</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>
  534.         <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>possible issues deleting change </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_change_id'>change_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_messages'>messages</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  535.       <span class='kw'>end</span>
  536.     <span class='kw'>end</span>
  537.     <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_ex'>ex</span>
  538.   <span class='kw'>end</span>
  539. <span class='kw'>end</span></pre>
  540.     </td>
  541.   </tr>
  542. </table>
  543. </div>
  544.     
  545.   </div>
  546.  
  547. </div>
  548.  
  549.     <div id="footer">
  550.   Generated on Tue Sep 15 01:20:30 2015 by
  551.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  552.   0.8.7.6 (ruby-2.2.3).
  553. </div>
  554.  
  555.   </body>
  556. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago