Helix SwarmHelix Swarm
Loading...

OpenModel.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services_client_ruby/
  • OpenModel.html #11
  • View
  • Commits
  • Open Download .zip Download (25 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: OpenModel
  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#!OpenModel.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 (O)</a> &raquo;
  35.     
  36.     
  37.     <span class="title">OpenModel</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: OpenModel
  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">OpenStruct</span>
  77.       
  78.         <ul class="fullTree">
  79.           <li>Object</li>
  80.           
  81.             <li class="next">OpenStruct</li>
  82.           
  83.             <li class="next">OpenModel</li>
  84.           
  85.         </ul>
  86.         <a href="#" class="inheritanceTree">show all</a>
  87.       
  88.       </dd>
  89.     
  90.   
  91.   
  92.     
  93.   
  94.     
  95.   
  96.   
  97.   
  98.     <dt class="r2 last">Defined in:</dt>
  99.     <dd class="r2 last">lib/helix_web_services_client/open_model.rb</dd>
  100.   
  101. </dl>
  102. <div class="clear"></div>
  103.  
  104. <h2>Overview</h2><div class="docstring">
  105.   <div class="discussion">
  106.     
  107. <p>A lot of our data coming out of the server has a couple of issues:</p>
  108. <ul><li>
  109. <p>The ID of an object might be referenced by different cases, or different 
  110. field names</p>
  111. </li><li>
  112. <p>Dates are sometimes as returned as timestamp strings (e.g., "1437153920") 
  113. and sometimes as rendered strings (e.g., "2015/07/17 10:36:38")</p>
  114. </li></ul>
  115.  
  116. <p>This is intended to be mixed in with an OpenStruct class to let your code
  117. handle conversion as needed.</p>
  118.  
  119. <p>You have a couple of rules:</p>
  120. <ol><li>
  121. <p>For [name], if a capitalized version exists we return that</p>
  122. </li><li>
  123. <p>For [name], if a camel case version of the name exists we return that</p>
  124. </li><li>
  125. <p>You can use an "[method]_as_time" to try to detect the format and return 
  126. it as a ruby Time instance.</p>
  127. <ul><li>
  128. <p>You must provide an &#39;offset&#39; parameter here based on the serverTime
  129. value from p4 info.</p>
  130. </li></ul>
  131. </li><li>
  132. <p>You can use an "[<a href="name">name]or</a>" to fallback to a different
  133. symbols.</p>
  134.  
  135. <p>rev_or_revision desc_or_description</p>
  136. </li></ol>
  137.  
  138. <p>For example, say you have the Hash</p>
  139.  
  140. <pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span>
  141.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>branch</span><span class='label_end'>&#39;:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>my_branch</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
  142.   <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Update</span><span class='label_end'>&#39;:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1437153920</span><span class='tstring_end'>&quot;</span></span>
  143. <span class='rbrace'>}</span>
  144. </code></pre>
  145.  
  146. <p>Then your object should both respond to:</p>
  147.  
  148. <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_branch'>branch</span><span class='period'>.</span><span class='id identifier rubyid_branch'>branch</span>
  149. <span class='id identifier rubyid_branch'>branch</span><span class='period'>.</span><span class='id identifier rubyid_update_as_time'>update_as_time</span><span class='lparen'>(</span><span class='id identifier rubyid_offset'>offset</span><span class='rparen'>)</span>
  150. </code></pre>
  151.  
  152. <p>This only affects “read” methods. Your code should probably only use the
  153. Singular format for “write” methods, and rarely should it ever need to
  154. create dates.</p>
  155.  
  156.  
  157.   </div>
  158. </div>
  159. <div class="tags">
  160.   
  161.  
  162. </div>
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.   
  170.     <h2>
  171.       Class Method Summary
  172.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  173.     </h2>
  174.  
  175.     <ul class="summary">
  176.       
  177.         <li class="public ">
  178.   <span class="summary_signature">
  179.     
  180.       <a href="#camelize-class_method" title="camelize (class method)">+ (Object) <strong>camelize</strong>(sym) </a>
  181.     
  182.  
  183.     
  184.   </span>
  185.   
  186.   
  187.   
  188.   
  189.   
  190.   
  191.   
  192.  
  193.   
  194.     <span class="summary_desc"><div class='inline'></div></span>
  195.   
  196. </li>
  197.  
  198.       
  199.         <li class="public ">
  200.   <span class="summary_signature">
  201.     
  202.       <a href="#capitalize-class_method" title="capitalize (class method)">+ (Object) <strong>capitalize</strong>(sym) </a>
  203.     
  204.  
  205.     
  206.   </span>
  207.   
  208.   
  209.   
  210.   
  211.   
  212.   
  213.   
  214.  
  215.   
  216.     <span class="summary_desc"><div class='inline'></div></span>
  217.   
  218. </li>
  219.  
  220.       
  221.         <li class="public ">
  222.   <span class="summary_signature">
  223.     
  224.       <a href="#date_str%3F-class_method" title="date_str? (class method)">+ (Boolean) <strong>date_str?</strong>(str) </a>
  225.     
  226.  
  227.     
  228.   </span>
  229.   
  230.   
  231.   
  232.   
  233.   
  234.   
  235.   
  236.  
  237.   
  238.     <span class="summary_desc"><div class='inline'></div></span>
  239.   
  240. </li>
  241.  
  242.       
  243.     </ul>
  244.   
  245.     <h2>
  246.       Instance Method Summary
  247.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  248.     </h2>
  249.  
  250.     <ul class="summary">
  251.       
  252.         <li class="public ">
  253.   <span class="summary_signature">
  254.     
  255.       <a href="#method_missing-instance_method" title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(sym, *args) </a>
  256.     
  257.  
  258.     
  259.   </span>
  260.   
  261.   
  262.   
  263.   
  264.   
  265.   
  266.   
  267.  
  268.   
  269.     <span class="summary_desc"><div class='inline'></div></span>
  270.   
  271. </li>
  272.  
  273.       
  274.     </ul>
  275.   
  276.  
  277.  
  278.   <div id="method_missing_details" class="method_details_list">
  279.   <h2>Dynamic Method Handling</h2>
  280.   <p class="notice this">
  281.     This class handles dynamic methods through the <tt>method_missing</tt> method
  282.     
  283.   </p>
  284.   
  285.     <div class="method_details first">
  286.   <h3 class="signature first" id="method_missing-instance_method">
  287.   
  288.     - (<tt>Object</tt>) <strong>method_missing</strong>(sym, *args) 
  289.   
  290.  
  291.   
  292.  
  293.   
  294. </h3><table class="source_code">
  295.   <tr>
  296.     <td>
  297.       <pre class="lines">
  298.  
  299.  
  300. 63
  301. 64
  302. 65
  303. 66
  304. 67
  305. 68
  306. 69
  307. 70
  308. 71
  309. 72
  310. 73
  311. 74
  312. 75
  313. 76
  314. 77
  315. 78
  316. 79
  317. 80
  318. 81
  319. 82
  320. 83
  321. 84
  322. 85
  323. 86
  324. 87
  325. 88
  326. 89
  327. 90
  328. 91
  329. 92
  330. 93
  331. 94
  332. 95
  333. 96
  334. 97
  335. 98
  336. 99
  337. 100
  338. 101
  339. 102
  340. 103
  341. 104
  342. 105
  343. 106
  344. 107
  345. 108
  346. 109
  347. 110
  348. 111
  349. 112</pre>
  350.     </td>
  351.     <td>
  352.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/open_model.rb', line 63</span>
  353.  
  354. <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='rparen'>)</span>
  355.   <span class='id identifier rubyid_match_time'>match_time</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^(.*)_as_time$</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_sym'>sym</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
  356.   <span class='kw'>if</span> <span class='id identifier rubyid_match_time'>match_time</span>
  357.     <span class='id identifier rubyid_val'>val</span> <span class='op'>=</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_match_time'>match_time</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span>
  358.  
  359.     <span class='kw'>if</span> <span class='id identifier rubyid_val'>val</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>
  360.       <span class='kw'>return</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='rparen'>)</span>
  361.     <span class='kw'>elsif</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_date_str?'>date_str?</span><span class='lparen'>(</span><span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>0</span>
  362.       <span class='id identifier rubyid_offset'>offset</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
  363.       <span class='kw'>return</span> <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_val'>val</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>
  364.     <span class='kw'>end</span>
  365.   <span class='kw'>end</span>
  366.  
  367.   <span class='id identifier rubyid_mname'>mname</span> <span class='op'>=</span> <span class='id identifier rubyid_sym'>sym</span><span class='period'>.</span><span class='id identifier rubyid_id2name'>id2name</span>
  368.  
  369.   <span class='id identifier rubyid_is_assign'>is_assign</span> <span class='op'>=</span> <span class='id identifier rubyid_mname'>mname</span><span class='period'>.</span><span class='id identifier rubyid_chomp!'>chomp!</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>
  370.  
  371.   <span class='kw'>if</span> <span class='id identifier rubyid_mname'>mname</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'>_or_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span> <span class='op'>&gt;</span> <span class='int'>1</span>
  372.     <span class='id identifier rubyid_syms'>syms</span> <span class='op'>=</span> <span class='id identifier rubyid_mname'>mname</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</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'>_or_</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  373.     <span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='id identifier rubyid_syms'>syms</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_s'>s</span><span class='op'>|</span> <span class='ivar'>@table</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  374.     <span class='kw'>if</span> <span class='id identifier rubyid_s'>s</span>
  375.       <span class='id identifier rubyid_mname'>mname</span> <span class='op'>=</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
  376.     <span class='kw'>else</span>
  377.       <span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='id identifier rubyid_syms'>syms</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_s'>s</span><span class='op'>|</span> <span class='ivar'>@table</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='id identifier rubyid_s'>s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
  378.       <span class='id identifier rubyid_mname'>mname</span> <span class='op'>=</span> <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_s'>s</span>
  379.     <span class='kw'>end</span>
  380.   <span class='kw'>end</span>
  381.  
  382.   <span class='kw'>if</span> <span class='ivar'>@table</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='lparen'>(</span><span class='id identifier rubyid_mname'>mname</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
  383.     <span class='id identifier rubyid_mname'>mname</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='lparen'>(</span><span class='id identifier rubyid_mname'>mname</span><span class='rparen'>)</span>
  384.   <span class='kw'>end</span>
  385.  
  386.   <span class='kw'>if</span> <span class='ivar'>@table</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='id identifier rubyid_mname'>mname</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rparen'>)</span>
  387.     <span class='id identifier rubyid_mname'>mname</span> <span class='op'>=</span> <span class='const'>OpenModel</span><span class='period'>.</span><span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='id identifier rubyid_mname'>mname</span><span class='rparen'>)</span>
  388.   <span class='kw'>end</span>
  389.  
  390.   <span class='id identifier rubyid_len'>len</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_length'>length</span>
  391.   <span class='kw'>if</span> <span class='id identifier rubyid_is_assign'>is_assign</span>
  392.     <span class='kw'>if</span> <span class='id identifier rubyid_len'>len</span> <span class='op'>!=</span> <span class='int'>1</span>
  393.       <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>wrong number of arguments (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_len'>len</span><span class='embexpr_end'>}</span><span class='tstring_content'> for 1)</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_caller'>caller</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
  394.     <span class='kw'>end</span>
  395.     <span class='id identifier rubyid_modifiable'>modifiable</span><span class='lbracket'>[</span><span class='id identifier rubyid_new_ostruct_member'>new_ostruct_member</span><span class='lparen'>(</span><span class='id identifier rubyid_mname'>mname</span><span class='rparen'>)</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
  396.   <span class='kw'>elsif</span> <span class='id identifier rubyid_len'>len</span> <span class='op'>==</span> <span class='int'>0</span>
  397.     <span class='ivar'>@table</span><span class='lbracket'>[</span><span class='id identifier rubyid_mname'>mname</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='rbracket'>]</span>
  398.   <span class='kw'>else</span>
  399.     <span class='id identifier rubyid_err'>err</span> <span class='op'>=</span> <span class='const'>NoMethodError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>undefined method `</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_mname'>mname</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39; for </span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_mname'>mname</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span> <span class='id identifier rubyid_args'>args</span>
  400.     <span class='id identifier rubyid_err'>err</span><span class='period'>.</span><span class='id identifier rubyid_set_backtrace'>set_backtrace</span> <span class='id identifier rubyid_caller'>caller</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span>
  401.     <span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_err'>err</span>
  402.   <span class='kw'>end</span>
  403. <span class='kw'>end</span></pre>
  404.     </td>
  405.   </tr>
  406. </table>
  407. </div>
  408.   
  409. </div>
  410.  
  411.  
  412.   <div id="class_method_details" class="method_details_list">
  413.     <h2>Class Method Details</h2>
  414.  
  415.     
  416.       <div class="method_details first">
  417.   <h3 class="signature first" id="camelize-class_method">
  418.   
  419.     + (<tt>Object</tt>) <strong>camelize</strong>(sym) 
  420.   
  421.  
  422.   
  423.  
  424.   
  425. </h3><table class="source_code">
  426.   <tr>
  427.     <td>
  428.       <pre class="lines">
  429.  
  430.  
  431. 54
  432. 55
  433. 56</pre>
  434.     </td>
  435.     <td>
  436.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/open_model.rb', line 54</span>
  437.  
  438. <span class='kw'>def</span> <span class='id identifier rubyid_camelize'>camelize</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span>
  439.   <span class='id identifier rubyid_sym'>sym</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</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='period'>.</span><span class='id identifier rubyid_inject'>inject</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_buffer'>buffer</span><span class='comma'>,</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='id identifier rubyid_buffer'>buffer</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='id identifier rubyid_buffer'>buffer</span><span class='period'>.</span><span class='id identifier rubyid_empty?'>empty?</span> <span class='op'>?</span> <span class='id identifier rubyid_e'>e</span> <span class='op'>:</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span>
  440. <span class='kw'>end</span></pre>
  441.     </td>
  442.   </tr>
  443. </table>
  444. </div>
  445.     
  446.       <div class="method_details ">
  447.   <h3 class="signature " id="capitalize-class_method">
  448.   
  449.     + (<tt>Object</tt>) <strong>capitalize</strong>(sym) 
  450.   
  451.  
  452.   
  453.  
  454.   
  455. </h3><table class="source_code">
  456.   <tr>
  457.     <td>
  458.       <pre class="lines">
  459.  
  460.  
  461. 50
  462. 51
  463. 52</pre>
  464.     </td>
  465.     <td>
  466.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/open_model.rb', line 50</span>
  467.  
  468. <span class='kw'>def</span> <span class='id identifier rubyid_capitalize'>capitalize</span><span class='lparen'>(</span><span class='id identifier rubyid_sym'>sym</span><span class='rparen'>)</span>
  469.   <span class='id identifier rubyid_sym'>sym</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</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='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_capitalize'>capitalize</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span>
  470. <span class='kw'>end</span></pre>
  471.     </td>
  472.   </tr>
  473. </table>
  474. </div>
  475.     
  476.       <div class="method_details ">
  477.   <h3 class="signature " id="date_str?-class_method">
  478.   
  479.     + (<tt>Boolean</tt>) <strong>date_str?</strong>(str) 
  480.   
  481.  
  482.   
  483.  
  484.   
  485. </h3><div class="docstring">
  486.   <div class="discussion">
  487.     
  488.  
  489.   </div>
  490. </div>
  491. <div class="tags">
  492.   
  493. <p class="tag_title">Returns:</p>
  494. <ul class="return">
  495.   
  496.     <li>
  497.       
  498.       
  499.         <span class='type'>(<tt>Boolean</tt>)</span>
  500.       
  501.       
  502.       
  503.     </li>
  504.   
  505. </ul>
  506.  
  507. </div><table class="source_code">
  508.   <tr>
  509.     <td>
  510.       <pre class="lines">
  511.  
  512.  
  513. 58
  514. 59
  515. 60</pre>
  516.     </td>
  517.     <td>
  518.       <pre class="code"><span class="info file"># File 'lib/helix_web_services_client/open_model.rb', line 58</span>
  519.  
  520. <span class='kw'>def</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>
  521.   <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>
  522. <span class='kw'>end</span></pre>
  523.     </td>
  524.   </tr>
  525. </table>
  526. </div>
  527.     
  528.   </div>
  529.  
  530. </div>
  531.  
  532.     <div id="footer">
  533.   Generated on Mon Oct 12 22:20:47 2015 by
  534.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  535.   0.8.7.6 (ruby-2.2.3).
  536. </div>
  537.  
  538.   </body>
  539. </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_client_ruby/OpenModel.html
#28 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205 10 years ago
#27 15589 tjuricek Update path to test output and update docs. 10 years ago
#26 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
#25 15517 tjuricek Do not require changelist ID for submitting Helix Sync pending changelists. 10 years ago
#24 15499 tjuricek Naive implementation of helix sync project submit for "helix versioning engine projects". 10 years ago
#23 15487 tjuricek Add basic ability to create pending changelists for helix sync projects. 10 years ago
#22 15479 tjuricek Added a basic "HVE project" implementation for creating clients. 10 years ago
#21 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
#20 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
#19 15228 tjuricek Revise triggers implementation, tests, and documentation. 10 years ago
#18 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
#17 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
#16 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
#15 15211 tjuricek Implement tests and documentation for label spec management. 10 years ago
#14 15210 tjuricek Implement tests and documentation for job spec management. 10 years ago
#13 15209 tjuricek Implement tests and documentation for group spec management. 10 years ago
#12 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
#11 15205 tjuricek Implemented tests and documentation for depot spec editing. 10 years ago
#10 15189 tjuricek Update files implementation, testing, and documentation. 10 years ago
#9 15185 tjuricek Update user spec management implementation, tests, and documentation. 10 years ago
#8 15144 tjuricek Setup stream spec tests and documentation.

Also revised the documentation folder http_p...4_web_api -> helix_versioning_engine «		 10 years ago
#7 15132 tjuricek Provde a basic submit -e mechanism on classic perforce workspaces. 10 years ago
#6 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
#5 15099 tjuricek Revise project services to be our simple 'container' for other systems. 10 years ago
#4 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
#3 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
#2 15078 tjuricek clients spec method revisions

Updated some other documentation. 		10 years ago
#1 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