Loading...
Helix SwarmHelix Swarm
Loading...

File.html

  • //
  • guest/
  • ptomiak/
  • hws/
  • build/
  • doc/
  • helix_web_services/
  • HelixVersioningEngine/
  • ChangeService/
  • File.html #1
  • View
  • Commits
  • Open Download .zip Download (36 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::File
  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/File.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 (F)</a> &raquo;
  35.     <span class='title'><span class='object_link'><a href="../../HelixVersioningEngine.html" title="HelixVersioningEngine (module)">HelixVersioningEngine</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../ChangeService.html" title="HelixVersioningEngine::ChangeService (class)">ChangeService</a></span></span>
  36.      &raquo; 
  37.     <span class="title">File</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::File
  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::File</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>Handles tracking &#39;file modification&#39; operations on a single file
  106. for a change.</p>
  107.  
  108. <p>One important aspect of initializing these files is assigning a
  109. &#39;files&#39; result. The ChangeHelper pretty much grabs the output of
  110. &#39;p4 files&#39; for all file changes, which lets us know if a file
  111. exists or not in the system, which changes downstream behavior during an
  112. upload process.</p>
  113.  
  114.  
  115.   </div>
  116. </div>
  117. <div class="tags">
  118.   
  119.  
  120. </div>
  121.  
  122.  
  123.  
  124.   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
  125.   <ul class="summary">
  126.     
  127.       <li class="public ">
  128.   <span class="summary_signature">
  129.     
  130.       <a href="#action-instance_method" title="#action (instance method)">- (Object) <strong>action</strong> </a>
  131.     
  132.  
  133.     
  134.   </span>
  135.   
  136.   
  137.   
  138.     
  139.     
  140.   
  141.   
  142.   
  143.   
  144.   
  145.  
  146.   
  147.     <span class="summary_desc"><div class='inline'>
  148. <p>Returns the value of attribute action.</p>
  149. </div></span>
  150.   
  151. </li>
  152.  
  153.     
  154.       <li class="public ">
  155.   <span class="summary_signature">
  156.     
  157.       <a href="#content-instance_method" title="#content (instance method)">- (Object) <strong>content</strong> </a>
  158.     
  159.  
  160.     
  161.   </span>
  162.   
  163.   
  164.   
  165.     
  166.     
  167.   
  168.   
  169.   
  170.   
  171.   
  172.  
  173.   
  174.     <span class="summary_desc"><div class='inline'>
  175. <p>Returns the value of attribute content.</p>
  176. </div></span>
  177.   
  178. </li>
  179.  
  180.     
  181.       <li class="public ">
  182.   <span class="summary_signature">
  183.     
  184.       <a href="#depot_file-instance_method" title="#depot_file (instance method)">- (Object) <strong>depot_file</strong> </a>
  185.     
  186.  
  187.     
  188.   </span>
  189.   
  190.   
  191.   
  192.     
  193.     
  194.   
  195.   
  196.   
  197.   
  198.   
  199.  
  200.   
  201.     <span class="summary_desc"><div class='inline'>
  202. <p>Returns the value of attribute depot_file.</p>
  203. </div></span>
  204.   
  205. </li>
  206.  
  207.     
  208.       <li class="public ">
  209.   <span class="summary_signature">
  210.     
  211.       <a href="#file_result-instance_method" title="#file_result (instance method)">- (Object) <strong>file_result</strong> </a>
  212.     
  213.  
  214.     
  215.   </span>
  216.   
  217.   
  218.   
  219.     
  220.     
  221.   
  222.   
  223.   
  224.   
  225.   
  226.  
  227.   
  228.     <span class="summary_desc"><div class='inline'>
  229. <p>The output of p4 files on this depot_file path, if it exists.</p>
  230. </div></span>
  231.   
  232. </li>
  233.  
  234.     
  235.       <li class="public ">
  236.   <span class="summary_signature">
  237.     
  238.       <a href="#from_depot_file-instance_method" title="#from_depot_file (instance method)">- (Object) <strong>from_depot_file</strong> </a>
  239.     
  240.  
  241.     
  242.   </span>
  243.   
  244.   
  245.   
  246.     
  247.     
  248.   
  249.   
  250.   
  251.   
  252.   
  253.  
  254.   
  255.     <span class="summary_desc"><div class='inline'>
  256. <p>For <em>some</em> actions, like a move, we need this indicated by the user.</p>
  257. </div></span>
  258.   
  259. </li>
  260.  
  261.     
  262.       <li class="public ">
  263.   <span class="summary_signature">
  264.     
  265.       <a href="#require_version-instance_method" title="#require_version (instance method)">- (Object) <strong>require_version</strong> </a>
  266.     
  267.  
  268.     
  269.   </span>
  270.   
  271.   
  272.   
  273.     
  274.     
  275.   
  276.   
  277.   
  278.   
  279.   
  280.  
  281.   
  282.     <span class="summary_desc"><div class='inline'>
  283. <p>If set, this should be the version number we require before running.</p>
  284. </div></span>
  285.   
  286. </li>
  287.  
  288.     
  289.   </ul>
  290.  
  291.  
  292.  
  293.  
  294.   
  295.     <h2>
  296.       Class Method Summary
  297.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  298.     </h2>
  299.  
  300.     <ul class="summary">
  301.       
  302.         <li class="public ">
  303.   <span class="summary_signature">
  304.     
  305.       <a href="#from_json-class_method" title="from_json (class method)">+ (Object) <strong>from_json</strong>(obj) </a>
  306.     
  307.  
  308.     
  309.   </span>
  310.   
  311.   
  312.   
  313.   
  314.   
  315.   
  316.   
  317.  
  318.   
  319.     <span class="summary_desc"><div class='inline'>
  320. <p>The “external” JSON representation uses a CamelCase style string.</p>
  321. </div></span>
  322.   
  323. </li>
  324.  
  325.       
  326.     </ul>
  327.   
  328.     <h2>
  329.       Instance Method Summary
  330.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  331.     </h2>
  332.  
  333.     <ul class="summary">
  334.       
  335.         <li class="public ">
  336.   <span class="summary_signature">
  337.     
  338.       <a href="#call-instance_method" title="#call (instance method)">- (Object) <strong>call</strong>(p4, change_id, client_root) </a>
  339.     
  340.  
  341.     
  342.   </span>
  343.   
  344.   
  345.   
  346.   
  347.   
  348.   
  349.   
  350.  
  351.   
  352.     <span class="summary_desc"><div class='inline'>
  353. <p>This really should only be called by ChangeHelper::call to do work once we
  354. have associated any file_result and from_file properties.</p>
  355. </div></span>
  356.   
  357. </li>
  358.  
  359.       
  360.         <li class="public ">
  361.   <span class="summary_signature">
  362.     
  363.       <a href="#exists%3F-instance_method" title="#exists? (instance method)">- (Boolean) <strong>exists?</strong> </a>
  364.     
  365.  
  366.     
  367.   </span>
  368.   
  369.   
  370.   
  371.   
  372.   
  373.   
  374.   
  375.  
  376.   
  377.     <span class="summary_desc"><div class='inline'></div></span>
  378.   
  379. </li>
  380.  
  381.       
  382.         <li class="public ">
  383.   <span class="summary_signature">
  384.     
  385.       <a href="#initialize-instance_method" title="#initialize (instance method)">- (File) <strong>initialize</strong>(depot_file: nil, action: nil, content: nil, from_depot_file: nil, require_version: nil) </a>
  386.     
  387.  
  388.     
  389.   </span>
  390.   
  391.   
  392.     <span class="note title constructor">constructor</span>
  393.   
  394.   
  395.   
  396.   
  397.   
  398.   
  399.  
  400.   
  401.     <span class="summary_desc"><div class='inline'>
  402. <p>Notice how the file <em>must</em> be specified using our &#39;external
  403. normalized&#39; data style.</p>
  404. </div></span>
  405.   
  406. </li>
  407.  
  408.       
  409.         <li class="public ">
  410.   <span class="summary_signature">
  411.     
  412.       <a href="#integrate_file-instance_method" title="#integrate_file (instance method)">- (Object) <strong>integrate_file</strong>(p4, change_id) </a>
  413.     
  414.  
  415.     
  416.   </span>
  417.   
  418.   
  419.   
  420.   
  421.   
  422.   
  423.   
  424.  
  425.   
  426.     <span class="summary_desc"><div class='inline'></div></span>
  427.   
  428. </li>
  429.  
  430.       
  431.         <li class="public ">
  432.   <span class="summary_signature">
  433.     
  434.       <a href="#move_file-instance_method" title="#move_file (instance method)">- (Object) <strong>move_file</strong>(p4, change_id) </a>
  435.     
  436.  
  437.     
  438.   </span>
  439.   
  440.   
  441.   
  442.   
  443.   
  444.   
  445.   
  446.  
  447.   
  448.     <span class="summary_desc"><div class='inline'></div></span>
  449.   
  450. </li>
  451.  
  452.       
  453.         <li class="public ">
  454.   <span class="summary_signature">
  455.     
  456.       <a href="#upload_file-instance_method" title="#upload_file (instance method)">- (Object) <strong>upload_file</strong>(p4, change_id, client_root) </a>
  457.     
  458.  
  459.     
  460.   </span>
  461.   
  462.   
  463.   
  464.   
  465.   
  466.   
  467.   
  468.  
  469.   
  470.     <span class="summary_desc"><div class='inline'></div></span>
  471.   
  472. </li>
  473.  
  474.       
  475.     </ul>
  476.   
  477.  
  478. <div id="constructor_details" class="method_details_list">
  479.   <h2>Constructor Details</h2>
  480.   
  481.     <div class="method_details first">
  482.   <h3 class="signature first" id="initialize-instance_method">
  483.   
  484.     - (<tt><span class='object_link'><a href="" title="HelixVersioningEngine::ChangeService::File (class)">File</a></span></tt>) <strong>initialize</strong>(depot_file: nil, action: nil, content: nil, from_depot_file: nil, require_version: nil) 
  485.   
  486.  
  487.   
  488.  
  489.   
  490. </h3><div class="docstring">
  491.   <div class="discussion">
  492.     
  493. <p>Notice how the file <em>must</em> be specified using our &#39;external
  494. normalized&#39; data style.</p>
  495.  
  496.  
  497.   </div>
  498. </div>
  499. <div class="tags">
  500.   
  501.  
  502. </div><table class="source_code">
  503.   <tr>
  504.     <td>
  505.       <pre class="lines">
  506.  
  507.  
  508. 78
  509. 79
  510. 80
  511. 81
  512. 82
  513. 83
  514. 84
  515. 85
  516. 86
  517. 87</pre>
  518.     </td>
  519.     <td>
  520.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 78</span>
  521.  
  522. <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>depot_file:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>action:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>content:</span> <span class='kw'>nil</span><span class='comma'>,</span>
  523.                <span class='label'>from_depot_file:</span> <span class='kw'>nil</span><span class='comma'>,</span>
  524.                <span class='label'>require_version:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
  525.  
  526.   <span class='ivar'>@depot_file</span> <span class='op'>=</span> <span class='id identifier rubyid_depot_file'>depot_file</span>
  527.   <span class='ivar'>@action</span> <span class='op'>=</span> <span class='id identifier rubyid_action'>action</span>
  528.   <span class='ivar'>@content</span> <span class='op'>=</span> <span class='id identifier rubyid_content'>content</span>
  529.   <span class='ivar'>@from_depot_file</span> <span class='op'>=</span> <span class='id identifier rubyid_from_depot_file'>from_depot_file</span>
  530.   <span class='ivar'>@require_version</span> <span class='op'>=</span> <span class='id identifier rubyid_require_version'>require_version</span>
  531. <span class='kw'>end</span></pre>
  532.     </td>
  533.   </tr>
  534. </table>
  535. </div>
  536.   
  537. </div>
  538.  
  539.   <div id="instance_attr_details" class="attr_details">
  540.     <h2>Instance Attribute Details</h2>
  541.     
  542.       
  543.       <span id="action=-instance_method"></span>
  544.       <div class="method_details first">
  545.   <h3 class="signature first" id="action-instance_method">
  546.   
  547.     - (<tt>Object</tt>) <strong>action</strong> 
  548.   
  549.  
  550.   
  551.  
  552.   
  553. </h3><div class="docstring">
  554.   <div class="discussion">
  555.     
  556. <p>Returns the value of attribute action</p>
  557.  
  558.  
  559.   </div>
  560. </div>
  561. <div class="tags">
  562.   
  563.  
  564. </div><table class="source_code">
  565.   <tr>
  566.     <td>
  567.       <pre class="lines">
  568.  
  569.  
  570. 61
  571. 62
  572. 63</pre>
  573.     </td>
  574.     <td>
  575.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 61</span>
  576.  
  577. <span class='kw'>def</span> <span class='id identifier rubyid_action'>action</span>
  578.   <span class='ivar'>@action</span>
  579. <span class='kw'>end</span></pre>
  580.     </td>
  581.   </tr>
  582. </table>
  583. </div>
  584.     
  585.       
  586.       <span id="content=-instance_method"></span>
  587.       <div class="method_details ">
  588.   <h3 class="signature " id="content-instance_method">
  589.   
  590.     - (<tt>Object</tt>) <strong>content</strong> 
  591.   
  592.  
  593.   
  594.  
  595.   
  596. </h3><div class="docstring">
  597.   <div class="discussion">
  598.     
  599. <p>Returns the value of attribute content</p>
  600.  
  601.  
  602.   </div>
  603. </div>
  604. <div class="tags">
  605.   
  606.  
  607. </div><table class="source_code">
  608.   <tr>
  609.     <td>
  610.       <pre class="lines">
  611.  
  612.  
  613. 63
  614. 64
  615. 65</pre>
  616.     </td>
  617.     <td>
  618.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 63</span>
  619.  
  620. <span class='kw'>def</span> <span class='id identifier rubyid_content'>content</span>
  621.   <span class='ivar'>@content</span>
  622. <span class='kw'>end</span></pre>
  623.     </td>
  624.   </tr>
  625. </table>
  626. </div>
  627.     
  628.       
  629.       <span id="depot_file=-instance_method"></span>
  630.       <div class="method_details ">
  631.   <h3 class="signature " id="depot_file-instance_method">
  632.   
  633.     - (<tt>Object</tt>) <strong>depot_file</strong> 
  634.   
  635.  
  636.   
  637.  
  638.   
  639. </h3><div class="docstring">
  640.   <div class="discussion">
  641.     
  642. <p>Returns the value of attribute depot_file</p>
  643.  
  644.  
  645.   </div>
  646. </div>
  647. <div class="tags">
  648.   
  649.  
  650. </div><table class="source_code">
  651.   <tr>
  652.     <td>
  653.       <pre class="lines">
  654.  
  655.  
  656. 59
  657. 60
  658. 61</pre>
  659.     </td>
  660.     <td>
  661.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 59</span>
  662.  
  663. <span class='kw'>def</span> <span class='id identifier rubyid_depot_file'>depot_file</span>
  664.   <span class='ivar'>@depot_file</span>
  665. <span class='kw'>end</span></pre>
  666.     </td>
  667.   </tr>
  668. </table>
  669. </div>
  670.     
  671.       
  672.       <span id="file_result=-instance_method"></span>
  673.       <div class="method_details ">
  674.   <h3 class="signature " id="file_result-instance_method">
  675.   
  676.     - (<tt>Object</tt>) <strong>file_result</strong> 
  677.   
  678.  
  679.   
  680.  
  681.   
  682. </h3><div class="docstring">
  683.   <div class="discussion">
  684.     
  685. <p>The output of p4 files on this depot_file path, if it exists.</p>
  686.  
  687.  
  688.   </div>
  689. </div>
  690. <div class="tags">
  691.   
  692.  
  693. </div><table class="source_code">
  694.   <tr>
  695.     <td>
  696.       <pre class="lines">
  697.  
  698.  
  699. 69
  700. 70
  701. 71</pre>
  702.     </td>
  703.     <td>
  704.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 69</span>
  705.  
  706. <span class='kw'>def</span> <span class='id identifier rubyid_file_result'>file_result</span>
  707.   <span class='ivar'>@file_result</span>
  708. <span class='kw'>end</span></pre>
  709.     </td>
  710.   </tr>
  711. </table>
  712. </div>
  713.     
  714.       
  715.       <span id="from_depot_file=-instance_method"></span>
  716.       <div class="method_details ">
  717.   <h3 class="signature " id="from_depot_file-instance_method">
  718.   
  719.     - (<tt>Object</tt>) <strong>from_depot_file</strong> 
  720.   
  721.  
  722.   
  723.  
  724.   
  725. </h3><div class="docstring">
  726.   <div class="discussion">
  727.     
  728. <p>For <em>some</em> actions, like a move, we need this indicated by the user.</p>
  729.  
  730.  
  731.   </div>
  732. </div>
  733. <div class="tags">
  734.   
  735.  
  736. </div><table class="source_code">
  737.   <tr>
  738.     <td>
  739.       <pre class="lines">
  740.  
  741.  
  742. 66
  743. 67
  744. 68</pre>
  745.     </td>
  746.     <td>
  747.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 66</span>
  748.  
  749. <span class='kw'>def</span> <span class='id identifier rubyid_from_depot_file'>from_depot_file</span>
  750.   <span class='ivar'>@from_depot_file</span>
  751. <span class='kw'>end</span></pre>
  752.     </td>
  753.   </tr>
  754. </table>
  755. </div>
  756.     
  757.       
  758.       <span id="require_version=-instance_method"></span>
  759.       <div class="method_details ">
  760.   <h3 class="signature " id="require_version-instance_method">
  761.   
  762.     - (<tt>Object</tt>) <strong>require_version</strong> 
  763.   
  764.  
  765.   
  766.  
  767.   
  768. </h3><div class="docstring">
  769.   <div class="discussion">
  770.     
  771. <p>If set, this should be the version number we require before running. If you
  772. want to require a new file, this should be set to 0. Otherwise specify the
  773. version directly.</p>
  774.  
  775.  
  776.   </div>
  777. </div>
  778. <div class="tags">
  779.   
  780.  
  781. </div><table class="source_code">
  782.   <tr>
  783.     <td>
  784.       <pre class="lines">
  785.  
  786.  
  787. 74
  788. 75
  789. 76</pre>
  790.     </td>
  791.     <td>
  792.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 74</span>
  793.  
  794. <span class='kw'>def</span> <span class='id identifier rubyid_require_version'>require_version</span>
  795.   <span class='ivar'>@require_version</span>
  796. <span class='kw'>end</span></pre>
  797.     </td>
  798.   </tr>
  799. </table>
  800. </div>
  801.     
  802.   </div>
  803.  
  804.  
  805.   <div id="class_method_details" class="method_details_list">
  806.     <h2>Class Method Details</h2>
  807.  
  808.     
  809.       <div class="method_details first">
  810.   <h3 class="signature first" id="from_json-class_method">
  811.   
  812.     + (<tt>Object</tt>) <strong>from_json</strong>(obj) 
  813.   
  814.  
  815.   
  816.  
  817.   
  818. </h3><div class="docstring">
  819.   <div class="discussion">
  820.     
  821. <p>The “external” JSON representation uses a CamelCase style string.</p>
  822.  
  823.  
  824.   </div>
  825. </div>
  826. <div class="tags">
  827.   
  828.  
  829. </div><table class="source_code">
  830.   <tr>
  831.     <td>
  832.       <pre class="lines">
  833.  
  834.  
  835. 90
  836. 91
  837. 92
  838. 93
  839. 94
  840. 95
  841. 96
  842. 97
  843. 98
  844. 99
  845. 100
  846. 101
  847. 102</pre>
  848.     </td>
  849.     <td>
  850.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 90</span>
  851.  
  852. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_from_json'>from_json</span><span class='lparen'>(</span><span class='id identifier rubyid_obj'>obj</span><span class='rparen'>)</span>
  853.   <span class='id identifier rubyid_args'>args</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
  854.  
  855.   <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:depot_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</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='kw'>if</span> <span class='id identifier rubyid_obj'>obj</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'>DepotFile</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  856.   <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:action</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</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='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</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'>Action</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  857.   <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:from_depot_file</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>FromDepotFile</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</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'>FromDepotFile</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  858.   <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:require_version</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>RequireVersion</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</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'>RequireVersion</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  859.  
  860.   <span class='id identifier rubyid_content_base64'>content_base64</span> <span class='op'>=</span> <span class='id identifier rubyid_obj'>obj</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Content</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_obj'>obj</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'>Content</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  861.   <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='symbol'>:content</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Base64</span><span class='period'>.</span><span class='id identifier rubyid_decode64'>decode64</span><span class='lparen'>(</span><span class='id identifier rubyid_content_base64'>content_base64</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_content_base64'>content_base64</span>
  862.  
  863.   <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
  864. <span class='kw'>end</span></pre>
  865.     </td>
  866.   </tr>
  867. </table>
  868. </div>
  869.     
  870.   </div>
  871.  
  872.   <div id="instance_method_details" class="method_details_list">
  873.     <h2>Instance Method Details</h2>
  874.  
  875.     
  876.       <div class="method_details first">
  877.   <h3 class="signature first" id="call-instance_method">
  878.   
  879.     - (<tt>Object</tt>) <strong>call</strong>(p4, change_id, client_root) 
  880.   
  881.  
  882.   
  883.  
  884.   
  885. </h3><div class="docstring">
  886.   <div class="discussion">
  887.     
  888. <p>This really should only be called by ChangeHelper::call to do work once we
  889. have associated any file_result and from_file properties.</p>
  890.  
  891.  
  892.   </div>
  893. </div>
  894. <div class="tags">
  895.   
  896.  
  897. </div><table class="source_code">
  898.   <tr>
  899.     <td>
  900.       <pre class="lines">
  901.  
  902.  
  903. 111
  904. 112
  905. 113
  906. 114
  907. 115
  908. 116
  909. 117
  910. 118
  911. 119
  912. 120</pre>
  913.     </td>
  914.     <td>
  915.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 111</span>
  916.  
  917. <span class='kw'>def</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>
  918.   <span class='kw'>case</span> <span class='id identifier rubyid_action'>action</span>
  919.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>upload</span><span class='tstring_end'>&#39;</span></span>
  920.     <span class='id identifier rubyid_upload_file'>upload_file</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>
  921.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>branch</span><span class='tstring_end'>&#39;</span></span>
  922.     <span class='id identifier rubyid_integrate_file'>integrate_file</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='rparen'>)</span>
  923.   <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>move</span><span class='tstring_end'>&#39;</span></span>
  924.     <span class='id identifier rubyid_move_file'>move_file</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='rparen'>)</span>
  925.   <span class='kw'>end</span>
  926. <span class='kw'>end</span></pre>
  927.     </td>
  928.   </tr>
  929. </table>
  930. </div>
  931.     
  932.       <div class="method_details ">
  933.   <h3 class="signature " id="exists?-instance_method">
  934.   
  935.     - (<tt>Boolean</tt>) <strong>exists?</strong> 
  936.   
  937.  
  938.   
  939.  
  940.   
  941. </h3><div class="docstring">
  942.   <div class="discussion">
  943.     
  944.  
  945.   </div>
  946. </div>
  947. <div class="tags">
  948.   
  949. <p class="tag_title">Returns:</p>
  950. <ul class="return">
  951.   
  952.     <li>
  953.       
  954.       
  955.         <span class='type'>(<tt>Boolean</tt>)</span>
  956.       
  957.       
  958.       
  959.     </li>
  960.   
  961. </ul>
  962.  
  963. </div><table class="source_code">
  964.   <tr>
  965.     <td>
  966.       <pre class="lines">
  967.  
  968.  
  969. 104
  970. 105
  971. 106</pre>
  972.     </td>
  973.     <td>
  974.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 104</span>
  975.  
  976. <span class='kw'>def</span> <span class='id identifier rubyid_exists?'>exists?</span>
  977.   <span class='op'>!</span><span class='id identifier rubyid_file_result'>file_result</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_file_result'>file_result</span><span class='lbracket'>[</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='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>delete</span><span class='tstring_end'>&#39;</span></span>
  978. <span class='kw'>end</span></pre>
  979.     </td>
  980.   </tr>
  981. </table>
  982. </div>
  983.     
  984.       <div class="method_details ">
  985.   <h3 class="signature " id="integrate_file-instance_method">
  986.   
  987.     - (<tt>Object</tt>) <strong>integrate_file</strong>(p4, change_id) 
  988.   
  989.  
  990.   
  991.  
  992.   
  993. </h3><table class="source_code">
  994.   <tr>
  995.     <td>
  996.       <pre class="lines">
  997.  
  998.  
  999. 151
  1000. 152
  1001. 153</pre>
  1002.     </td>
  1003.     <td>
  1004.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 151</span>
  1005.  
  1006. <span class='kw'>def</span> <span class='id identifier rubyid_integrate_file'>integrate_file</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='rparen'>)</span>
  1007.   <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_integrate'>run_integrate</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='comma'>,</span> <span class='id identifier rubyid_from_depot_file'>from_depot_file</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_file'>depot_file</span><span class='rparen'>)</span>
  1008. <span class='kw'>end</span></pre>
  1009.     </td>
  1010.   </tr>
  1011. </table>
  1012. </div>
  1013.     
  1014.       <div class="method_details ">
  1015.   <h3 class="signature " id="move_file-instance_method">
  1016.   
  1017.     - (<tt>Object</tt>) <strong>move_file</strong>(p4, change_id) 
  1018.   
  1019.  
  1020.   
  1021.  
  1022.   
  1023. </h3><table class="source_code">
  1024.   <tr>
  1025.     <td>
  1026.       <pre class="lines">
  1027.  
  1028.  
  1029. 155
  1030. 156
  1031. 157</pre>
  1032.     </td>
  1033.     <td>
  1034.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 155</span>
  1035.  
  1036. <span class='kw'>def</span> <span class='id identifier rubyid_move_file'>move_file</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='rparen'>)</span>
  1037.   <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_move'>run_move</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='comma'>,</span> <span class='id identifier rubyid_from_depot_file'>from_depot_file</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_file'>depot_file</span><span class='rparen'>)</span>
  1038. <span class='kw'>end</span></pre>
  1039.     </td>
  1040.   </tr>
  1041. </table>
  1042. </div>
  1043.     
  1044.       <div class="method_details ">
  1045.   <h3 class="signature " id="upload_file-instance_method">
  1046.   
  1047.     - (<tt>Object</tt>) <strong>upload_file</strong>(p4, change_id, client_root) 
  1048.   
  1049.  
  1050.   
  1051.  
  1052.   
  1053. </h3><table class="source_code">
  1054.   <tr>
  1055.     <td>
  1056.       <pre class="lines">
  1057.  
  1058.  
  1059. 122
  1060. 123
  1061. 124
  1062. 125
  1063. 126
  1064. 127
  1065. 128
  1066. 129
  1067. 130
  1068. 131
  1069. 132
  1070. 133
  1071. 134
  1072. 135
  1073. 136
  1074. 137
  1075. 138
  1076. 139
  1077. 140
  1078. 141
  1079. 142
  1080. 143
  1081. 144
  1082. 145
  1083. 146
  1084. 147
  1085. 148
  1086. 149</pre>
  1087.     </td>
  1088.     <td>
  1089.       <pre class="code"><span class="info file"># File 'lib/helix_versioning_engine/change_service.rb', line 122</span>
  1090.  
  1091. <span class='kw'>def</span> <span class='id identifier rubyid_upload_file'>upload_file</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>
  1092.   <span class='const'>Util</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='ivar'>@depot_file</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
  1093.  
  1094.   <span class='kw'>if</span> <span class='op'>!</span><span class='id identifier rubyid_require_version'>require_version</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
  1095.     <span class='kw'>if</span> <span class='id identifier rubyid_require_version'>require_version</span> <span class='op'>==</span> <span class='int'>0</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_exists?'>exists?</span>
  1096.       <span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>assertion failed: file </span><span class='embexpr_beg'>#{</span><span class='ivar'>@depot_file</span><span class='embexpr_end'>}</span><span class='tstring_content'> exists</span><span class='tstring_end'>&quot;</span></span>
  1097.       <span class='id identifier rubyid_raise'>raise</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='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
  1098.     <span class='kw'>end</span>
  1099.  
  1100.     <span class='id identifier rubyid_cur_version'>cur_version</span> <span class='op'>=</span> <span class='int'>0</span>
  1101.     <span class='id identifier rubyid_cur_version'>cur_version</span> <span class='op'>=</span> <span class='id identifier rubyid_file_result'>file_result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>rev</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='kw'>if</span> <span class='id identifier rubyid_exists?'>exists?</span>
  1102.     <span class='kw'>if</span> <span class='id identifier rubyid_cur_version'>cur_version</span> <span class='op'>!=</span> <span class='id identifier rubyid_require_version'>require_version</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
  1103.       <span class='id identifier rubyid_msg'>msg</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>assertion failed: file </span><span class='embexpr_beg'>#{</span><span class='ivar'>@depot_file</span><span class='embexpr_end'>}</span><span class='tstring_content'> not at required </span><span class='tstring_end'>&quot;</span></span> \
  1104.             <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>version </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_require_version'>require_version</span><span class='embexpr_end'>}</span><span class='tstring_content'>, </span><span class='tstring_end'>&quot;</span></span> \
  1105.             <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>current version is </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cur_version'>cur_version</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
  1106.       <span class='id identifier rubyid_raise'>raise</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='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
  1107.     <span class='kw'>end</span>
  1108.   <span class='kw'>end</span>
  1109.  
  1110.   <span class='kw'>if</span> <span class='id identifier rubyid_exists?'>exists?</span>
  1111.     <span class='id identifier rubyid_p4'>p4</span><span class='period'>.</span><span class='id identifier rubyid_run_sync'>run_sync</span><span class='lparen'>(</span><span class='id identifier rubyid_depot_file'>depot_file</span><span class='rparen'>)</span>
  1112.     <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_mark_change'>mark_change</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>edit</span><span class='tstring_end'>&#39;</span></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_client_root'>client_root</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_file'>depot_file</span><span class='rparen'>)</span>
  1113.     <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_save_content'>save_content</span><span class='lparen'>(</span><span class='id identifier rubyid_client_root'>client_root</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_file'>depot_file</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  1114.   <span class='kw'>else</span>
  1115.     <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_save_content'>save_content</span><span class='lparen'>(</span><span class='id identifier rubyid_client_root'>client_root</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_file'>depot_file</span><span class='comma'>,</span> <span class='id identifier rubyid_content'>content</span><span class='rparen'>)</span>
  1116.     <span class='const'>Util</span><span class='period'>.</span><span class='id identifier rubyid_mark_change'>mark_change</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>add</span><span class='tstring_end'>&#39;</span></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_client_root'>client_root</span><span class='comma'>,</span> <span class='id identifier rubyid_depot_file'>depot_file</span><span class='rparen'>)</span>
  1117.   <span class='kw'>end</span>
  1118. <span class='kw'>end</span></pre>
  1119.     </td>
  1120.   </tr>
  1121. </table>
  1122. </div>
  1123.     
  1124.   </div>
  1125.  
  1126. </div>
  1127.  
  1128.     <div id="footer">
  1129.   Generated on Tue Sep 15 01:20:30 2015 by
  1130.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  1131.   0.8.7.6 (ruby-2.2.3).
  1132. </div>
  1133.  
  1134.   </body>
  1135. </html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use. 10 years ago