files/SubmitService.html

SubmitService.html 

  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::SubmitService
  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/SubmitService.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 (S)</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">SubmitService</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::SubmitService
  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::SubmitService</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/submit_service.rb</dd>
  98.   
  99. </dl>
  100. <div class="clear"></div>
  101.  
  102.  
  103.  
  104.  
  105.  
  106.   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  107.   <ul class="summary">
  108.     
  109.       <li class="public ">
  110.   <span class="summary_signature">
  111.     
  112.       <a href="#env-instance_method" title="#env (instance method)">- (Object) <strong>env</strong> </a>
  113.     
  114.  
  115.     
  116.   </span>
  117.   
  118.   
  119.   
  120.     
  121.     
  122.   
  123.   
  124.   
  125.   
  126.   
  127.  
  128.   
  129.     <span class="summary_desc"><div class='inline'>
  130. <p>Existing Rack environment.</p>
  131. </div></span>
  132.   
  133. </li>
  134.  
  135.     
  136.       <li class="public ">
  137.   <span class="summary_signature">
  138.     
  139.       <a href="#p4-instance_method" title="#p4 (instance method)">- (Object) <strong>p4</strong> </a>
  140.     
  141.  
  142.     
  143.   </span>
  144.   
  145.   
  146.   
  147.     
  148.     
  149.   
  150.   
  151.   
  152.   
  153.   
  154.  
  155.   
  156.     <span class="summary_desc"><div class='inline'>
  157. <p>Require the p4 connection decided by our middleware.</p>
  158. </div></span>
  159.   
  160. </li>
  161.  
  162.     
  163.   </ul>
  164.  
  165.  
  166.  
  167.  
  168.   
  169.     <h2>
  170.       Instance Method Summary
  171.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  172.     </h2>
  173.  
  174.     <ul class="summary">
  175.       
  176.         <li class="public ">
  177.   <span class="summary_signature">
  178.     
  179.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (SubmitService) <strong>initialize</strong>(p4: nil, env: nil) </a>
  180.     
  181.  
  182.     
  183.   </span>
  184.   
  185.   
  186.     <span class="note title constructor">constructor</span>
  187.   
  188.   
  189.   
  190.   
  191.   
  192.   
  193.  
  194.   
  195.     <span class="summary_desc"><div class='inline'>
  196. <p>A new instance of SubmitService.</p>
  197. </div></span>
  198.   
  199. </li>
  200.  
  201.       
  202.         <li class="public ">
  203.   <span class="summary_signature">
  204.     
  205.       <a href="#stream_client_for-instance_method" title="#stream_client_for (instance method)">- (Object) <strong>stream_client_for</strong>(change) </a>
  206.     
  207.  
  208.     
  209.   </span>
  210.   
  211.   
  212.   
  213.   
  214.   
  215.   
  216.   
  217.  
  218.   
  219.     <span class="summary_desc"><div class='inline'>
  220. <p>Returns true if the changelist is associated with a Streams-based client.</p>
  221. </div></span>
  222.   
  223. </li>
  224.  
  225.       
  226.         <li class="public ">
  227.   <span class="summary_signature">
  228.     
  229.       <a href="#submit_shelf-instance_method" title="#submit_shelf (instance method)">- (Object) <strong>submit_shelf</strong>(change) </a>
  230.     
  231.  
  232.     
  233.   </span>
  234.   
  235.   
  236.   
  237.   
  238.   
  239.   
  240.   
  241.  
  242.   
  243.     <span class="summary_desc"><div class='inline'>
  244. <p>Perform a &#39;p4 submit -e change&#39;.</p>
  245. </div></span>
  246.   
  247. </li>
  248.  
  249.       
  250.     </ul>
  251.   
  252.  
  253. <div id="constructor_details" class="method_details_list">
  254.   <h2>Constructor Details</h2>
  255.   
  256.     <div class="method_details first">
  257.   <h3 class="signature first" id="initialize-instance_method">
  258.   
  259.     - (<tt><span class='object_link'><a href="" title="HelixVersioningEngine::SubmitService (class)">SubmitService</a></span></tt>) <strong>initialize</strong>(p4: nil, env: nil) 
  260.   
  261.  
  262.   
  263.  
  264.   
  265. </h3><div class="docstring">
  266.   <div class="discussion">
  267.     
  268. <p>Returns a new instance of SubmitService</p>
  269.  
  270.  
  271.   </div>
  272. </div>
  273. <div class="tags">
  274.   
  275.  
  276. </div><table class="source_code">
  277.   <tr>
  278.     <td>
  279.       <pre class="lines">
  280.  
  281.  
  282. 11
  283. 12
  284. 13
  285. 14
  286. 15
  287. 16
  288. 17</pre>
  289.     </td>
  290.     <td>
  291.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/submit_service.rb', line 11</span>
  292.  
  293. <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'>env:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  294.   <span class='ivar'>@p4</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span>
  295.   <span class='ivar'>@env</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</span>
  296.  
  297.   <span class='comment'># This is created by `submit_shelf`
  298. </span>  <span class='ivar'>@p4_root</span> <span class='op'>=</span> <span class='kw'>nil</span>
  299. <span class='kw'>end</span></pre>
  300.     </td>
  301.   </tr>
  302. </table>
  303. </div>
  304.   
  305. </div>
  306.  
  307.   <div id="instance_attr_details" class="attr_details">
  308.     <h2>Instance Attribute Details</h2>
  309.     
  310.       
  311.       <span id="env=-instance_method"></span>
  312.       <div class="method_details first">
  313.   <h3 class="signature first" id="env-instance_method">
  314.   
  315.     - (<tt>Object</tt>) <strong>env</strong> 
  316.   
  317.  
  318.   
  319.  
  320.   
  321. </h3><div class="docstring">
  322.   <div class="discussion">
  323.     
  324. <p>Existing Rack environment</p>
  325.  
  326.  
  327.   </div>
  328. </div>
  329. <div class="tags">
  330.   
  331.  
  332. </div><table class="source_code">
  333.   <tr>
  334.     <td>
  335.       <pre class="lines">
  336.  
  337.  
  338. 9
  339. 10
  340. 11</pre>
  341.     </td>
  342.     <td>
  343.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/submit_service.rb', line 9</span>
  344.  
  345. <span class='kw'>def</span> <span class='id identifier rubyid_env'>env</span>
  346.   <span class='ivar'>@env</span>
  347. <span class='kw'>end</span></pre>
  348.     </td>
  349.   </tr>
  350. </table>
  351. </div>
  352.     
  353.       
  354.       <span id="p4=-instance_method"></span>
  355.       <div class="method_details ">
  356.   <h3 class="signature " id="p4-instance_method">
  357.   
  358.     - (<tt>Object</tt>) <strong>p4</strong> 
  359.   
  360.  
  361.   
  362.  
  363.   
  364. </h3><div class="docstring">
  365.   <div class="discussion">
  366.     
  367. <p>Require the p4 connection decided by our middleware</p>
  368.  
  369.  
  370.   </div>
  371. </div>
  372. <div class="tags">
  373.   
  374.  
  375. </div><table class="source_code">
  376.   <tr>
  377.     <td>
  378.       <pre class="lines">
  379.  
  380.  
  381. 6
  382. 7
  383. 8</pre>
  384.     </td>
  385.     <td>
  386.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/submit_service.rb', line 6</span>
  387.  
  388. <span class='kw'>def</span> <span class='id identifier rubyid_p4'>p4</span>
  389.   <span class='ivar'>@p4</span>
  390. <span class='kw'>end</span></pre>
  391.     </td>
  392.   </tr>
  393. </table>
  394. </div>
  395.     
  396.   </div>
  397.  
  398.  
  399.   <div id="instance_method_details" class="method_details_list">
  400.     <h2>Instance Method Details</h2>
  401.  
  402.     
  403.       <div class="method_details first">
  404.   <h3 class="signature first" id="stream_client_for-instance_method">
  405.   
  406.     - (<tt>Object</tt>) <strong>stream_client_for</strong>(change) 
  407.   
  408.  
  409.   
  410.  
  411.   
  412. </h3><div class="docstring">
  413.   <div class="discussion">
  414.     
  415. <p>Returns true if the changelist is associated with a Streams-based client.</p>
  416.  
  417.  
  418.   </div>
  419. </div>
  420. <div class="tags">
  421.   
  422.  
  423. </div><table class="source_code">
  424.   <tr>
  425.     <td>
  426.       <pre class="lines">
  427.  
  428.  
  429. 36
  430. 37
  431. 38
  432. 39
  433. 40
  434. 41
  435. 42</pre>
  436.     </td>
  437.     <td>
  438.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/submit_service.rb', line 36</span>
  439.  
  440. <span class='kw'>def</span> <span class='id identifier rubyid_stream_client_for'>stream_client_for</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  441.   <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><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  442.  
  443.   <span class='id identifier rubyid_client_spec'>client_spec</span> <span class='op'>=</span> <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_fetch_client'>fetch_client</span><span class='lparen'>(</span><span class='id identifier rubyid_change_spec'>change_spec</span><span class='period'>.</span><span class='id identifier rubyid__client'>_client</span><span class='rparen'>)</span>
  444.  
  445.   <span class='id identifier rubyid_client_spec'>client_spec</span><span class='period'>.</span><span class='id identifier rubyid__stream'>_stream</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='id identifier rubyid_client_spec'>client_spec</span>
  446. <span class='kw'>end</span></pre>
  447.     </td>
  448.   </tr>
  449. </table>
  450. </div>
  451.     
  452.       <div class="method_details ">
  453.   <h3 class="signature " id="submit_shelf-instance_method">
  454.   
  455.     - (<tt>Object</tt>) <strong>submit_shelf</strong>(change) 
  456.   
  457.  
  458.   
  459.  
  460.   
  461. </h3><div class="docstring">
  462.   <div class="discussion">
  463.     
  464. <p>Perform a &#39;p4 submit -e change&#39;</p>
  465.  
  466. <p>This will need to detect the correct kind of temporary client to create,
  467. create that, and then perform the submission.</p>
  468.  
  469.  
  470.   </div>
  471. </div>
  472. <div class="tags">
  473.   
  474.  
  475. </div><table class="source_code">
  476.   <tr>
  477.     <td>
  478.       <pre class="lines">
  479.  
  480.  
  481. 23
  482. 24
  483. 25
  484. 26
  485. 27
  486. 28
  487. 29
  488. 30
  489. 31
  490. 32
  491. 33</pre>
  492.     </td>
  493.     <td>
  494.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/submit_service.rb', line 23</span>
  495.  
  496. <span class='kw'>def</span> <span class='id identifier rubyid_submit_shelf'>submit_shelf</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  497.   <span class='id identifier rubyid_stream_client'>stream_client</span> <span class='op'>=</span> <span class='id identifier rubyid_stream_client_for'>stream_client_for</span><span class='lparen'>(</span><span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  498.   <span class='kw'>if</span> <span class='id identifier rubyid_stream_client'>stream_client</span>
  499.     <span class='ivar'>@p4_root</span> <span class='op'>=</span> <span class='const'>P4Util</span><span class='period'>.</span><span class='id identifier rubyid_create_temp_stream_client_duplicate'>create_temp_stream_client_duplicate</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='comma'>,</span> <span class='id identifier rubyid_stream_client'>stream_client</span><span class='rparen'>)</span>
  500.     <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4_root</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@p4_root</span>
  501.   <span class='kw'>else</span>
  502.     <span class='ivar'>@p4_root</span> <span class='op'>=</span> <span class='const'>P4Util</span><span class='period'>.</span><span class='id identifier rubyid_create_temp_client'>create_temp_client</span><span class='lparen'>(</span><span class='id identifier rubyid_p4'>p4</span><span class='rparen'>)</span>
  503.     <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>p4_root</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='ivar'>@p4_root</span>
  504.   <span class='kw'>end</span>
  505.   <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'>-e</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_change'>change</span><span class='rparen'>)</span>
  506. <span class='kw'>end</span></pre>
  507.     </td>
  508.   </tr>
  509. </table>
  510. </div>
  511.     
  512.   </div>
  513.  
  514. </div>
  515.  
  516.     <div id="footer">
  517.   Generated on Mon Oct 12 22:20:53 2015 by
  518.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  519.   0.8.7.6 (ruby-2.2.3).
  520. </div>
  521.  
  522.   </body>
  523. </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 10 years ago
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services/HelixVersioningEngine/SubmitService.html
#22 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205 10 years ago
#21 15589 tjuricek Update path to test output and update docs. 10 years ago
#20 15542 tjuricek 10 years ago
#19 15517 tjuricek Do not require changelist ID for submitting Helix Sync pending changelists. 10 years ago
#18 15499 tjuricek Naive implementation of helix sync project submit for "helix versioning engine projects". 10 years ago
#17 15487 tjuricek Add basic ability to create pending changelists for helix sync projects. 10 years ago
#16 15479 tjuricek Added a basic "HVE project" implementation for creating clients. 10 years ago
#15 15447 tjuricek 10 years ago
#14 15240 tjuricek 10 years ago
#13 15228 tjuricek Revise triggers implementation, tests, and documentation. 10 years ago
#12 15227 tjuricek 10 years ago
#11 15225 tjuricek 10 years ago
#10 15222 tjuricek 10 years ago
#9 15211 tjuricek Implement tests and documentation for label spec management. 10 years ago
#8 15210 tjuricek Implement tests and documentation for job spec management. 10 years ago
#7 15209 tjuricek Implement tests and documentation for group spec management. 10 years ago
#6 15208 tjuricek 10 years ago
#5 15205 tjuricek Implemented tests and documentation for depot spec editing. 10 years ago
#4 15189 tjuricek Update files implementation, testing, and documentation. 10 years ago
#3 15185 tjuricek Update user spec management implementation, tests, and documentation. 10 years ago
#2 15144 tjuricek 10 years ago
#1 15132 tjuricek Provde a basic submit -e mechanism on classic perforce workspaces. 10 years ago